Edit your Integrations settings!
<%= form_for :settings, url: settings_path, method: :patch, data: { turbo_method: :patch, turbo: false } do |f| %>
<%= f.label :immich_url %>
@@ -15,6 +15,16 @@
<%= f.label :immich_api_key %>
<%= f.text_field :immich_api_key, value: current_user.settings['immich_api_key'], class: "input input-bordered", placeholder: 'xxxxxxxxxxxxxx' %>
+
+
+ <%= f.label :photoprism_url %>
+ <%= f.text_field :photoprism_url, value: current_user.settings['photoprism_url'], class: "input input-bordered", placeholder: 'http://192.168.0.1:2342' %>
+
+
+ <%= f.label :photoprism_api_key %>
+ <%= f.text_field :photoprism_api_key, value: current_user.settings['photoprism_api_key'], class: "input input-bordered", placeholder: 'xxxxxxxxxxxxxx' %>
+
+
<%= f.submit "Update", class: "btn btn-primary" %>
diff --git a/spec/factories/users.rb b/spec/factories/users.rb
index 2d4e654f..f3fe9d7b 100644
--- a/spec/factories/users.rb
+++ b/spec/factories/users.rb
@@ -23,7 +23,7 @@ FactoryBot.define do
admin { true }
end
- trait :with_immich_credentials do
+ trait :with_immich_integration do
settings do
{
immich_url: 'https://immich.example.com',
@@ -31,5 +31,14 @@ FactoryBot.define do
}
end
end
+
+ trait :with_photoprism_integration do
+ settings do
+ {
+ photoprism_url: 'https://photoprism.example.com',
+ photoprism_api_key: '1234567890'
+ }
+ end
+ end
end
end
diff --git a/spec/models/import_spec.rb b/spec/models/import_spec.rb
index 3ac6130d..2e04a91d 100644
--- a/spec/models/import_spec.rb
+++ b/spec/models/import_spec.rb
@@ -17,7 +17,8 @@ RSpec.describe Import, type: :model do
google_phone_takeout: 3,
gpx: 4,
immich_api: 5,
- geojson: 6
+ geojson: 6,
+ photoprism_api: 7
)
end
end
diff --git a/spec/requests/api/v1/photos_spec.rb b/spec/requests/api/v1/photos_spec.rb
index d15a5342..8c8811b6 100644
--- a/spec/requests/api/v1/photos_spec.rb
+++ b/spec/requests/api/v1/photos_spec.rb
@@ -4,40 +4,68 @@ require 'rails_helper'
RSpec.describe 'Api::V1::Photos', type: :request do
describe 'GET /index' do
- let(:user) { create(:user) }
+ context 'when the integration is configured' do
+ let(:user) { create(:user, :with_photoprism_integration) }
- let(:photo_data) do
- [
- {
- 'id' => '123',
- 'latitude' => 35.6762,
- 'longitude' => 139.6503,
- 'localDateTime' => '2024-01-01T00:00:00.000Z',
- 'type' => 'photo'
- },
- {
- 'id' => '456',
- 'latitude' => 40.7128,
- 'longitude' => -74.0060,
- 'localDateTime' => '2024-01-02T00:00:00.000Z',
- 'type' => 'photo'
- }
- ]
+ let(:photo_data) do
+ [
+ {
+ 'id' => 1,
+ 'latitude' => 35.6762,
+ 'longitude' => 139.6503,
+ 'localDateTime' => '2024-01-01T00:00:00.000Z',
+ 'originalFileName' => 'photo1.jpg',
+ 'city' => 'Tokyo',
+ 'state' => 'Tokyo',
+ 'country' => 'Japan',
+ 'type' => 'photo',
+ 'source' => 'photoprism'
+ },
+ {
+ 'id' => 2,
+ 'latitude' => 40.7128,
+ 'longitude' => -74.0060,
+ 'localDateTime' => '2024-01-02T00:00:00.000Z',
+ 'originalFileName' => 'photo2.jpg',
+ 'city' => 'New York',
+ 'state' => 'New York',
+ 'country' => 'USA',
+ 'type' => 'photo',
+ 'source' => 'immich'
+ }
+ ]
+ end
+
+ context 'when the request is successful' do
+ before do
+ allow_any_instance_of(Photos::Search).to receive(:call).and_return(photo_data)
+
+ get '/api/v1/photos', params: { api_key: user.api_key }
+ end
+
+ it 'returns http success' do
+ expect(response).to have_http_status(:success)
+ end
+
+ it 'returns photos data as JSON' do
+ expect(JSON.parse(response.body)).to eq(photo_data)
+ end
+ end
end
- context 'when the request is successful' do
+ context 'when the integration is not configured' do
+ let(:user) { create(:user) }
+
before do
- allow_any_instance_of(Immich::RequestPhotos).to receive(:call).and_return(photo_data)
-
- get '/api/v1/photos', params: { api_key: user.api_key }
+ get '/api/v1/photos', params: { api_key: user.api_key, source: 'immich' }
end
- it 'returns http success' do
- expect(response).to have_http_status(:success)
+ it 'returns http unauthorized' do
+ expect(response).to have_http_status(:unauthorized)
end
- it 'returns photos data as JSON' do
- expect(JSON.parse(response.body)).to eq(photo_data)
+ it 'returns an error message' do
+ expect(JSON.parse(response.body)).to eq({ 'error' => 'Immich integration not configured' })
end
end
end
diff --git a/spec/serializers/api/photo_serializer_spec.rb b/spec/serializers/api/photo_serializer_spec.rb
new file mode 100644
index 00000000..3dad077a
--- /dev/null
+++ b/spec/serializers/api/photo_serializer_spec.rb
@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Api::PhotoSerializer do
+ describe '#call' do
+ subject(:serialized_photo) { described_class.new(photo, source).call }
+
+ context 'when photo is from immich' do
+ let(:source) { 'immich' }
+ let(:photo) do
+ {
+ "id": '7fe486e3-c3ba-4b54-bbf9-1281b39ed15c',
+ "deviceAssetId": 'IMG_9913.jpeg-1168914',
+ "ownerId": 'f579f328-c355-438c-a82c-fe3390bd5f08',
+ "deviceId": 'CLI',
+ "libraryId": nil,
+ "type": 'IMAGE',
+ "originalPath": 'upload/library/admin/2023/2023-06-08/IMG_9913.jpeg',
+ "originalFileName": 'IMG_9913.jpeg',
+ "originalMimeType": 'image/jpeg',
+ "thumbhash": '4RgONQaZqYaH93g3h3p3d6RfPPrG',
+ "fileCreatedAt": '2023-06-08T07:58:45.637Z',
+ "fileModifiedAt": '2023-06-08T09:58:45.000Z',
+ "localDateTime": '2023-06-08T09:58:45.637Z',
+ "updatedAt": '2024-08-24T18:20:47.965Z',
+ "isFavorite": false,
+ "isArchived": false,
+ "isTrashed": false,
+ "duration": '0:00:00.00000',
+ "exifInfo": {
+ "make": 'Apple',
+ "model": 'iPhone 12 Pro',
+ "exifImageWidth": 4032,
+ "exifImageHeight": 3024,
+ "fileSizeInByte": 1_168_914,
+ "orientation": '6',
+ "dateTimeOriginal": '2023-06-08T07:58:45.637Z',
+ "modifyDate": '2023-06-08T07:58:45.000Z',
+ "timeZone": 'Europe/Berlin',
+ "lensModel": 'iPhone 12 Pro back triple camera 4.2mm f/1.6',
+ "fNumber": 1.6,
+ "focalLength": 4.2,
+ "iso": 320,
+ "exposureTime": '1/60',
+ "latitude": 52.11,
+ "longitude": 13.22,
+ "city": 'Johannisthal',
+ "state": 'Berlin',
+ "country": 'Germany',
+ "description": '',
+ "projectionType": nil,
+ "rating": nil
+ },
+ "livePhotoVideoId": nil,
+ "people": [],
+ "checksum": 'aL1edPVg4ZpEnS6xCRWNUY0pUS8=',
+ "isOffline": false,
+ "hasMetadata": true,
+ "duplicateId": '88a34bee-783d-46e4-aa52-33b75ffda375',
+ "resized": true
+ }
+ end
+
+ it 'serializes the photo correctly' do
+ expect(serialized_photo).to eq(
+ id: '7fe486e3-c3ba-4b54-bbf9-1281b39ed15c',
+ latitude: 52.11,
+ longitude: 13.22,
+ localDateTime: '2023-06-08T09:58:45.637Z',
+ originalFileName: 'IMG_9913.jpeg',
+ city: 'Johannisthal',
+ state: 'Berlin',
+ country: 'Germany',
+ type: 'image',
+ source: 'immich'
+ )
+ end
+ end
+
+ context 'when photo is from photoprism' do
+ let(:source) { 'photoprism' }
+ let(:photo) do
+ {
+ 'ID' => '102',
+ 'UID' => 'psnver0s3x7wxfnh',
+ 'Type' => 'image',
+ 'TypeSrc' => '',
+ 'TakenAt' => '2023-10-10T16:04:33Z',
+ 'TakenAtLocal' => '2023-10-10T16:04:33Z',
+ 'TakenSrc' => 'name',
+ 'TimeZone' => '',
+ 'Path' => '2023/10',
+ 'Name' => '20231010_160433_91981432',
+ 'OriginalName' => 'photo_2023-10-10 16.04.33',
+ 'Title' => 'Photo / 2023',
+ 'Description' => '',
+ 'Year' => 2023,
+ 'Month' => 10,
+ 'Day' => 10,
+ 'Country' => 'zz',
+ 'Stack' => 0,
+ 'Favorite' => false,
+ 'Private' => false,
+ 'Iso' => 0,
+ 'FocalLength' => 0,
+ 'FNumber' => 0,
+ 'Exposure' => '',
+ 'Quality' => 1,
+ 'Resolution' => 1,
+ 'Color' => 4,
+ 'Scan' => false,
+ 'Panorama' => false,
+ 'CameraID' => 1,
+ 'CameraModel' => 'Unknown',
+ 'LensID' => 1,
+ 'LensModel' => 'Unknown',
+ 'Lat' => 11,
+ 'Lng' => 22,
+ 'CellID' => 'zz',
+ 'PlaceID' => 'zz',
+ 'PlaceSrc' => '',
+ 'PlaceLabel' => 'Unknown',
+ 'PlaceCity' => 'Unknown',
+ 'PlaceState' => 'Unknown',
+ 'PlaceCountry' => 'zz',
+ 'InstanceID' => '',
+ 'FileUID' => 'fsnver0clrfzatmz',
+ 'FileRoot' => '/',
+ 'FileName' => '2023/10/20231010_160433_91981432.jpeg',
+ 'Hash' => 'ce1849fd7cf6a50eb201fbb669ab78c7ac13263b',
+ 'Width' => 1280,
+ 'Height' => 908,
+ 'Portrait' => false,
+ 'Merged' => false,
+ 'CreatedAt' => '2024-12-02T14:25:48Z',
+ 'UpdatedAt' => '2024-12-02T14:36:45Z',
+ 'EditedAt' => '0001-01-01T00:00:00Z',
+ 'CheckedAt' => '2024-12-02T14:36:45Z',
+ 'Files' => nil
+ }
+ end
+
+ it 'serializes the photo correctly' do
+ expect(serialized_photo).to eq(
+ id: 'ce1849fd7cf6a50eb201fbb669ab78c7ac13263b',
+ latitude: 11,
+ longitude: 22,
+ localDateTime: '2023-10-10T16:04:33Z',
+ originalFileName: 'photo_2023-10-10 16.04.33',
+ city: 'Unknown',
+ state: 'Unknown',
+ country: 'zz',
+ type: 'image',
+ source: 'photoprism'
+ )
+ end
+ end
+ end
+end
diff --git a/spec/services/immich/request_photos_spec.rb b/spec/services/immich/request_photos_spec.rb
index 255e6cd0..041ed4fd 100644
--- a/spec/services/immich/request_photos_spec.rb
+++ b/spec/services/immich/request_photos_spec.rb
@@ -9,7 +9,7 @@ RSpec.describe Immich::RequestPhotos do
let(:user) do
create(:user, settings: { 'immich_url' => 'http://immich.app', 'immich_api_key' => '123456' })
end
- let(:immich_data) do
+ let(:mock_immich_data) do
{
"albums": {
"total": 0,
@@ -134,11 +134,11 @@ RSpec.describe Immich::RequestPhotos do
stub_request(
:any,
'http://immich.app/api/search/metadata'
- ).to_return(status: 200, body: immich_data, headers: {})
+ ).to_return(status: 200, body: mock_immich_data, headers: {})
end
it 'returns images and videos' do
- expect(service.map { _1['type'] }.uniq).to eq(['IMAGE', 'VIDEO'])
+ expect(service.map { _1['type'] }.uniq).to eq(%w[IMAGE VIDEO])
end
end
diff --git a/spec/services/imports/create_spec.rb b/spec/services/imports/create_spec.rb
new file mode 100644
index 00000000..d35e1898
--- /dev/null
+++ b/spec/services/imports/create_spec.rb
@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Imports::Create do
+ let(:user) { create(:user) }
+ let(:service) { described_class.new(user, import) }
+
+ describe '#call' do
+ context 'when source is google_semantic_history' do
+ let(:import) { create(:import, source: 'google_semantic_history') }
+
+ it 'calls the GoogleMaps::SemanticHistoryParser' do
+ expect(GoogleMaps::SemanticHistoryParser).to receive(:new).with(import, user.id).and_return(double(call: true))
+ service.call
+ end
+ end
+
+ context 'when source is google_phone_takeout' do
+ let(:import) { create(:import, source: 'google_phone_takeout') }
+
+ it 'calls the GoogleMaps::PhoneTakeoutParser' do
+ expect(GoogleMaps::PhoneTakeoutParser).to receive(:new).with(import, user.id).and_return(double(call: true))
+ service.call
+ end
+ end
+
+ context 'when source is owntracks' do
+ let(:import) { create(:import, source: 'owntracks') }
+
+ it 'calls the OwnTracks::ExportParser' do
+ expect(OwnTracks::ExportParser).to receive(:new).with(import, user.id).and_return(double(call: true))
+ service.call
+ end
+
+ context 'when import is successful' do
+ it 'creates a finished notification' do
+ service.call
+
+ expect(user.notifications.last.kind).to eq('info')
+ end
+
+ it 'schedules stats creating' do
+ Sidekiq::Testing.inline! do
+ expect { service.call }.to have_enqueued_job(Stats::CalculatingJob)
+ end
+ end
+
+ it 'schedules visit suggesting' do
+ Sidekiq::Testing.inline! do
+ expect { service.call }.to have_enqueued_job(VisitSuggestingJob)
+ end
+ end
+ end
+
+ context 'when import fails' do
+ before do
+ allow(OwnTracks::ExportParser).to receive(:new).with(import, user.id).and_return(double(call: false))
+ end
+
+ it 'creates a failed notification' do
+ service.call
+
+ expect(user.notifications.last.kind).to eq('error')
+ end
+ end
+ end
+
+ context 'when source is gpx' do
+ let(:import) { create(:import, source: 'gpx') }
+
+ it 'calls the Gpx::TrackParser' do
+ expect(Gpx::TrackParser).to receive(:new).with(import, user.id).and_return(double(call: true))
+ service.call
+ end
+ end
+
+ context 'when source is geojson' do
+ let(:import) { create(:import, source: 'geojson') }
+
+ it 'calls the Geojson::ImportParser' do
+ expect(Geojson::ImportParser).to receive(:new).with(import, user.id).and_return(double(call: true))
+ service.call
+ end
+ end
+
+ context 'when source is immich_api' do
+ let(:import) { create(:import, source: 'immich_api') }
+
+ it 'calls the Photos::ImportParser' do
+ expect(Photos::ImportParser).to receive(:new).with(import, user.id).and_return(double(call: true))
+ service.call
+ end
+ end
+
+ context 'when source is photoprism_api' do
+ let(:import) { create(:import, source: 'photoprism_api') }
+
+ it 'calls the Photos::ImportParser' do
+ expect(Photos::ImportParser).to receive(:new).with(import, user.id).and_return(double(call: true))
+ service.call
+ end
+ end
+ end
+end
diff --git a/spec/services/photoprism/cache_preview_token_spec.rb b/spec/services/photoprism/cache_preview_token_spec.rb
new file mode 100644
index 00000000..298aee98
--- /dev/null
+++ b/spec/services/photoprism/cache_preview_token_spec.rb
@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Photoprism::CachePreviewToken, type: :service do
+ let(:user) { double('User', id: 1) }
+ let(:preview_token) { 'sample_token' }
+ let(:service) { described_class.new(user, preview_token) }
+
+ describe '#call' do
+ it 'writes the preview token to the cache with the correct key' do
+ expect(Rails.cache).to receive(:write).with(
+ "dawarich/photoprism_preview_token_#{user.id}", preview_token
+ )
+
+ service.call
+ end
+ end
+end
diff --git a/spec/services/photoprism/import_geodata_spec.rb b/spec/services/photoprism/import_geodata_spec.rb
new file mode 100644
index 00000000..341348fc
--- /dev/null
+++ b/spec/services/photoprism/import_geodata_spec.rb
@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Photoprism::ImportGeodata do
+ describe '#call' do
+ subject(:service) { described_class.new(user).call }
+
+ let(:user) do
+ create(:user, settings: { 'photoprism_url' => 'http://photoprism.app', 'photoprism_api_key' => '123456' })
+ end
+ let(:photoprism_data) do
+ [
+ {
+ 'ID' => '82',
+ 'UID' => 'psnveqq089xhy1c3',
+ 'Type' => 'image',
+ 'TypeSrc' => '',
+ 'TakenAt' => '2024-08-18T14:11:05Z',
+ 'TakenAtLocal' => '2024-08-18T16:11:05Z',
+ 'TakenSrc' => 'meta',
+ 'TimeZone' => 'Europe/Prague',
+ 'Path' => '2024/08',
+ 'Name' => '20240818_141105_44E61AED',
+ 'OriginalName' => 'PXL_20240818_141105789',
+ 'Title' => 'Moment / Karlovy Vary / 2024',
+ 'Description' => '',
+ 'Year' => 2024,
+ 'Month' => 8,
+ 'Day' => 18,
+ 'Country' => 'cz',
+ 'Stack' => 0,
+ 'Favorite' => false,
+ 'Private' => false,
+ 'Iso' => 37,
+ 'FocalLength' => 21,
+ 'FNumber' => 2.2,
+ 'Exposure' => '1/347',
+ 'Quality' => 4,
+ 'Resolution' => 10,
+ 'Color' => 2,
+ 'Scan' => false,
+ 'Panorama' => false,
+ 'CameraID' => 8,
+ 'CameraSrc' => 'meta',
+ 'CameraMake' => 'Google',
+ 'CameraModel' => 'Pixel 7 Pro',
+ 'LensID' => 11,
+ 'LensMake' => 'Google',
+ 'LensModel' => 'Pixel 7 Pro front camera 2.74mm f/2.2',
+ 'Altitude' => 423,
+ 'Lat' => 50.11,
+ 'Lng' => 12.12,
+ 'CellID' => 's2:47a09944f33c',
+ 'PlaceID' => 'cz:ciNqTjWuq6NN',
+ 'PlaceSrc' => 'meta',
+ 'PlaceLabel' => 'Karlovy Vary, Severozápad, Czech Republic',
+ 'PlaceCity' => 'Karlovy Vary',
+ 'PlaceState' => 'Severozápad',
+ 'PlaceCountry' => 'cz',
+ 'InstanceID' => '',
+ 'FileUID' => 'fsnveqqeusn692qo',
+ 'FileRoot' => '/',
+ 'FileName' => '2024/08/20240818_141105_44E61AED.jpg',
+ 'Hash' => 'cc5d0f544e52b288d7c8460d2e1bb17fa66e6089',
+ 'Width' => 2736,
+ 'Height' => 3648,
+ 'Portrait' => true,
+ 'Merged' => false,
+ 'CreatedAt' => '2024-12-02T14:25:38Z',
+ 'UpdatedAt' => '2024-12-02T14:25:38Z',
+ 'EditedAt' => '0001-01-01T00:00:00Z',
+ 'CheckedAt' => '2024-12-02T14:36:45Z',
+ 'Files' => nil
+ },
+ {
+ 'ID' => '81',
+ 'UID' => 'psnveqpl96gcfdzf',
+ 'Type' => 'image',
+ 'TypeSrc' => '',
+ 'TakenAt' => '2024-08-18T14:11:04Z',
+ 'TakenAtLocal' => '2024-08-18T16:11:04Z',
+ 'TakenSrc' => 'meta',
+ 'TimeZone' => 'Europe/Prague',
+ 'Path' => '2024/08',
+ 'Name' => '20240818_141104_E9949CD4',
+ 'OriginalName' => 'PXL_20240818_141104633',
+ 'Title' => 'Portrait / Karlovy Vary / 2024',
+ 'Description' => '',
+ 'Year' => 2024,
+ 'Month' => 8,
+ 'Day' => 18,
+ 'Country' => 'cz',
+ 'Stack' => 0,
+ 'Favorite' => false,
+ 'Private' => false,
+ 'Iso' => 43,
+ 'FocalLength' => 21,
+ 'FNumber' => 2.2,
+ 'Exposure' => '1/356',
+ 'Faces' => 1,
+ 'Quality' => 4,
+ 'Resolution' => 10,
+ 'Color' => 2,
+ 'Scan' => false,
+ 'Panorama' => false,
+ 'CameraID' => 8,
+ 'CameraSrc' => 'meta',
+ 'CameraMake' => 'Google',
+ 'CameraModel' => 'Pixel 7 Pro',
+ 'LensID' => 11,
+ 'LensMake' => 'Google',
+ 'LensModel' => 'Pixel 7 Pro front camera 2.74mm f/2.2',
+ 'Altitude' => 423,
+ 'Lat' => 50.21,
+ 'Lng' => 12.85,
+ 'CellID' => 's2:47a09944f33c',
+ 'PlaceID' => 'cz:ciNqTjWuq6NN',
+ 'PlaceSrc' => 'meta',
+ 'PlaceLabel' => 'Karlovy Vary, Severozápad, Czech Republic',
+ 'PlaceCity' => 'Karlovy Vary',
+ 'PlaceState' => 'Severozápad',
+ 'PlaceCountry' => 'cz',
+ 'InstanceID' => '',
+ 'FileUID' => 'fsnveqp9xsl7onsv',
+ 'FileRoot' => '/',
+ 'FileName' => '2024/08/20240818_141104_E9949CD4.jpg',
+ 'Hash' => 'd5dfadc56a0b63051dfe0b5dec55ff1d81f033b7',
+ 'Width' => 2736,
+ 'Height' => 3648,
+ 'Portrait' => true,
+ 'Merged' => false,
+ 'CreatedAt' => '2024-12-02T14:25:37Z',
+ 'UpdatedAt' => '2024-12-02T14:25:37Z',
+ 'EditedAt' => '0001-01-01T00:00:00Z',
+ 'CheckedAt' => '2024-12-02T14:36:45Z',
+ 'Files' => nil
+ }
+ ].to_json
+ end
+
+ before do
+ stub_request(:get, %r{http://photoprism\.app/api/v1/photos}).with(
+ headers: {
+ 'Accept' => 'application/json',
+ 'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+ 'Authorization' => 'Bearer 123456',
+ 'User-Agent' => 'Ruby'
+ }
+ ).to_return(status: 200, body: photoprism_data, headers: {})
+ end
+
+ it 'creates import' do
+ expect { service }.to change { Import.count }.by(1)
+ end
+
+ it 'enqueues ImportJob' do
+ expect(ImportJob).to receive(:perform_later)
+
+ service
+ end
+
+ context 'when import already exists' do
+ before { service }
+
+ it 'does not create new import' do
+ expect { service }.not_to(change { Import.count })
+ end
+
+ it 'does not enqueue ImportJob' do
+ expect(ImportJob).to_not receive(:perform_later)
+
+ service
+ end
+ end
+ end
+end
diff --git a/spec/services/photoprism/request_photos_spec.rb b/spec/services/photoprism/request_photos_spec.rb
new file mode 100644
index 00000000..a4461151
--- /dev/null
+++ b/spec/services/photoprism/request_photos_spec.rb
@@ -0,0 +1,287 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Photoprism::RequestPhotos do
+ let(:user) do
+ create(
+ :user,
+ settings: {
+ 'photoprism_url' => 'http://photoprism.local',
+ 'photoprism_api_key' => 'test_api_key'
+ }
+ )
+ end
+
+ let(:start_date) { '2024-01-01' }
+ let(:end_date) { '2024-12-31' }
+ let(:service) { described_class.new(user, start_date: start_date, end_date: end_date) }
+
+ let(:mock_photo_response) do
+ [
+ {
+ 'ID' => '82',
+ 'UID' => 'psnveqq089xhy1c3',
+ 'Type' => 'image',
+ 'TypeSrc' => '',
+ 'TakenAt' => '2024-08-18T14:11:05Z',
+ 'TakenAtLocal' => '2024-08-18T16:11:05Z',
+ 'TakenSrc' => 'meta',
+ 'TimeZone' => 'Europe/Prague',
+ 'Path' => '2024/08',
+ 'Name' => '20240818_141105_44E61AED',
+ 'OriginalName' => 'PXL_20240818_141105789',
+ 'Title' => 'Moment / Karlovy Vary / 2024',
+ 'Description' => '',
+ 'Year' => 2024,
+ 'Month' => 8,
+ 'Day' => 18,
+ 'Country' => 'cz',
+ 'Stack' => 0,
+ 'Favorite' => false,
+ 'Private' => false,
+ 'Iso' => 37,
+ 'FocalLength' => 21,
+ 'FNumber' => 2.2,
+ 'Exposure' => '1/347',
+ 'Quality' => 4,
+ 'Resolution' => 10,
+ 'Color' => 2,
+ 'Scan' => false,
+ 'Panorama' => false,
+ 'CameraID' => 8,
+ 'CameraSrc' => 'meta',
+ 'CameraMake' => 'Google',
+ 'CameraModel' => 'Pixel 7 Pro',
+ 'LensID' => 11,
+ 'LensMake' => 'Google',
+ 'LensModel' => 'Pixel 7 Pro front camera 2.74mm f/2.2',
+ 'Altitude' => 423,
+ 'Lat' => 50.11,
+ 'Lng' => 12.12,
+ 'CellID' => 's2:47a09944f33c',
+ 'PlaceID' => 'cz:ciNqTjWuq6NN',
+ 'PlaceSrc' => 'meta',
+ 'PlaceLabel' => 'Karlovy Vary, Severozápad, Czech Republic',
+ 'PlaceCity' => 'Karlovy Vary',
+ 'PlaceState' => 'Severozápad',
+ 'PlaceCountry' => 'cz',
+ 'InstanceID' => '',
+ 'FileUID' => 'fsnveqqeusn692qo',
+ 'FileRoot' => '/',
+ 'FileName' => '2024/08/20240818_141105_44E61AED.jpg',
+ 'Hash' => 'cc5d0f544e52b288d7c8460d2e1bb17fa66e6089',
+ 'Width' => 2736,
+ 'Height' => 3648,
+ 'Portrait' => true,
+ 'Merged' => false,
+ 'CreatedAt' => '2024-12-02T14:25:38Z',
+ 'UpdatedAt' => '2024-12-02T14:25:38Z',
+ 'EditedAt' => '0001-01-01T00:00:00Z',
+ 'CheckedAt' => '2024-12-02T14:36:45Z',
+ 'Files' => nil
+ },
+ {
+ 'ID' => '81',
+ 'UID' => 'psnveqpl96gcfdzf',
+ 'Type' => 'image',
+ 'TypeSrc' => '',
+ 'TakenAt' => '2024-08-18T14:11:04Z',
+ 'TakenAtLocal' => '2024-08-18T16:11:04Z',
+ 'TakenSrc' => 'meta',
+ 'TimeZone' => 'Europe/Prague',
+ 'Path' => '2024/08',
+ 'Name' => '20240818_141104_E9949CD4',
+ 'OriginalName' => 'PXL_20240818_141104633',
+ 'Title' => 'Portrait / Karlovy Vary / 2024',
+ 'Description' => '',
+ 'Year' => 2024,
+ 'Month' => 8,
+ 'Day' => 18,
+ 'Country' => 'cz',
+ 'Stack' => 0,
+ 'Favorite' => false,
+ 'Private' => false,
+ 'Iso' => 43,
+ 'FocalLength' => 21,
+ 'FNumber' => 2.2,
+ 'Exposure' => '1/356',
+ 'Faces' => 1,
+ 'Quality' => 4,
+ 'Resolution' => 10,
+ 'Color' => 2,
+ 'Scan' => false,
+ 'Panorama' => false,
+ 'CameraID' => 8,
+ 'CameraSrc' => 'meta',
+ 'CameraMake' => 'Google',
+ 'CameraModel' => 'Pixel 7 Pro',
+ 'LensID' => 11,
+ 'LensMake' => 'Google',
+ 'LensModel' => 'Pixel 7 Pro front camera 2.74mm f/2.2',
+ 'Altitude' => 423,
+ 'Lat' => 50.21,
+ 'Lng' => 12.85,
+ 'CellID' => 's2:47a09944f33c',
+ 'PlaceID' => 'cz:ciNqTjWuq6NN',
+ 'PlaceSrc' => 'meta',
+ 'PlaceLabel' => 'Karlovy Vary, Severozápad, Czech Republic',
+ 'PlaceCity' => 'Karlovy Vary',
+ 'PlaceState' => 'Severozápad',
+ 'PlaceCountry' => 'cz',
+ 'InstanceID' => '',
+ 'FileUID' => 'fsnveqp9xsl7onsv',
+ 'FileRoot' => '/',
+ 'FileName' => '2024/08/20240818_141104_E9949CD4.jpg',
+ 'Hash' => 'd5dfadc56a0b63051dfe0b5dec55ff1d81f033b7',
+ 'Width' => 2736,
+ 'Height' => 3648,
+ 'Portrait' => true,
+ 'Merged' => false,
+ 'CreatedAt' => '2024-12-02T14:25:37Z',
+ 'UpdatedAt' => '2024-12-02T14:25:37Z',
+ 'EditedAt' => '0001-01-01T00:00:00Z',
+ 'CheckedAt' => '2024-12-02T14:36:45Z',
+ 'Files' => nil
+ }
+ ]
+ end
+
+ describe '#call' do
+ context 'with valid credentials' do
+ before do
+ stub_request(
+ :any,
+ "#{user.settings['photoprism_url']}/api/v1/photos?after=#{start_date}&before=#{end_date}&count=1000&public=true&q=&quality=3"
+ ).with(
+ headers: {
+ 'Accept' => 'application/json',
+ 'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+ 'Authorization' => 'Bearer test_api_key',
+ 'User-Agent' => 'Ruby'
+ }
+ ).to_return(
+ status: 200,
+ body: mock_photo_response.to_json,
+ headers: { 'Content-Type' => 'application/json' }
+ )
+
+ stub_request(
+ :any,
+ "#{user.settings['photoprism_url']}/api/v1/photos?after=#{start_date}&before=#{end_date}&count=1000&public=true&q=&quality=3&offset=1000"
+ ).to_return(status: 200, body: [].to_json)
+ end
+
+ it 'returns photos within the specified date range' do
+ result = service.call
+
+ expect(result).to be_an(Array)
+ expect(result.first['Title']).to eq('Moment / Karlovy Vary / 2024')
+ end
+ end
+
+ context 'with missing credentials' do
+ let(:user) { create(:user, settings: {}) }
+
+ it 'raises error when Photoprism URL is missing' do
+ expect { service.call }.to raise_error(ArgumentError, 'Photoprism URL is missing')
+ end
+
+ it 'raises error when API key is missing' do
+ user.update(settings: { 'photoprism_url' => 'http://photoprism.local' })
+
+ expect { service.call }.to raise_error(ArgumentError, 'Photoprism API key is missing')
+ end
+ end
+
+ context 'when API returns an error' do
+ before do
+ stub_request(
+ :get,
+ "#{user.settings['photoprism_url']}/api/v1/photos?after=#{start_date}&before=#{end_date}&count=1000&public=true&q=&quality=3"
+ ).to_return(status: 400, body: { status: 400, error: 'Unable to do that' }.to_json)
+ end
+
+ it 'logs the error' do
+ expect(Rails.logger).to \
+ receive(:error).with('Photoprism API returned 400: {"status":400,"error":"Unable to do that"}')
+ expect(Rails.logger).to \
+ receive(:debug).with(
+ "Photoprism API request params: #{{ q: '', public: true, quality: 3, after: start_date, count: 1000,
+before: end_date }}"
+ )
+
+ service.call
+ end
+ end
+
+ context 'with pagination' do
+ let(:first_page) { [{ 'TakenAtLocal' => "#{start_date}T14:30:00Z" }] }
+ let(:second_page) { [{ 'TakenAtLocal' => "#{start_date}T14:30:00Z" }] }
+ let(:empty_page) { [] }
+ let(:common_headers) do
+ {
+ 'Accept' => 'application/json',
+ 'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+ 'Authorization' => 'Bearer test_api_key',
+ 'User-Agent' => 'Ruby'
+ }
+ end
+
+ before do
+ # First page
+ stub_request(:any, "#{user.settings['photoprism_url']}/api/v1/photos")
+ .with(
+ headers: common_headers,
+ query: {
+ after: start_date,
+ before: end_date,
+ count: '1000',
+ public: 'true',
+ q: '',
+ quality: '3'
+ }
+ )
+ .to_return(status: 200, body: first_page.to_json)
+
+ # Second page
+ stub_request(:any, "#{user.settings['photoprism_url']}/api/v1/photos")
+ .with(
+ headers: common_headers,
+ query: {
+ after: start_date,
+ before: end_date,
+ count: '1000',
+ public: 'true',
+ q: '',
+ quality: '3',
+ offset: '1000'
+ }
+ )
+ .to_return(status: 200, body: second_page.to_json)
+
+ # Last page (empty)
+ stub_request(:any, "#{user.settings['photoprism_url']}/api/v1/photos")
+ .with(
+ headers: common_headers,
+ query: {
+ after: start_date,
+ before: end_date,
+ count: '1000',
+ public: 'true',
+ q: '',
+ quality: '3',
+ offset: '2000'
+ }
+ )
+ .to_return(status: 200, body: empty_page.to_json)
+ end
+
+ it 'fetches all pages until empty result' do
+ result = service.call
+
+ expect(result.size).to eq(2)
+ end
+ end
+ end
+end
diff --git a/spec/services/immich/import_parser_spec.rb b/spec/services/photos/import_parser_spec.rb
similarity index 97%
rename from spec/services/immich/import_parser_spec.rb
rename to spec/services/photos/import_parser_spec.rb
index cefa4dc6..33460398 100644
--- a/spec/services/immich/import_parser_spec.rb
+++ b/spec/services/photos/import_parser_spec.rb
@@ -2,7 +2,7 @@
require 'rails_helper'
-RSpec.describe Immich::ImportParser do
+RSpec.describe Photos::ImportParser do
describe '#call' do
subject(:service) { described_class.new(import, user.id).call }
diff --git a/spec/services/photos/search_spec.rb b/spec/services/photos/search_spec.rb
new file mode 100644
index 00000000..0ce34613
--- /dev/null
+++ b/spec/services/photos/search_spec.rb
@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Photos::Search do
+ let(:user) { create(:user) }
+ let(:start_date) { '2024-01-01' }
+ let(:end_date) { '2024-03-01' }
+ let(:service) { described_class.new(user, start_date: start_date, end_date: end_date) }
+
+ describe '#call' do
+ context 'when user has no integrations configured' do
+ before do
+ allow(user).to receive(:immich_integration_configured?).and_return(false)
+ allow(user).to receive(:photoprism_integration_configured?).and_return(false)
+ end
+
+ it 'returns an empty array' do
+ expect(service.call).to eq([])
+ end
+ end
+
+ context 'when user has Immich integration configured' do
+ let(:immich_photo) { { 'type' => 'image', 'id' => '1' } }
+ let(:serialized_photo) { { id: '1', source: 'immich' } }
+
+ before do
+ allow(user).to receive(:immich_integration_configured?).and_return(true)
+ allow(user).to receive(:photoprism_integration_configured?).and_return(false)
+
+ allow_any_instance_of(Immich::RequestPhotos).to receive(:call)
+ .and_return([immich_photo])
+
+ allow_any_instance_of(Api::PhotoSerializer).to receive(:call)
+ .and_return(serialized_photo)
+ end
+
+ it 'fetches and transforms Immich photos' do
+ expect(service.call).to eq([serialized_photo])
+ end
+ end
+
+ context 'when user has Photoprism integration configured' do
+ let(:photoprism_photo) { { 'Type' => 'image', 'id' => '2' } }
+ let(:serialized_photo) { { id: '2', source: 'photoprism' } }
+
+ before do
+ allow(user).to receive(:immich_integration_configured?).and_return(false)
+ allow(user).to receive(:photoprism_integration_configured?).and_return(true)
+
+ allow_any_instance_of(Photoprism::RequestPhotos).to receive(:call)
+ .and_return([photoprism_photo])
+
+ allow_any_instance_of(Api::PhotoSerializer).to receive(:call)
+ .and_return(serialized_photo)
+ end
+
+ it 'fetches and transforms Photoprism photos' do
+ expect(service.call).to eq([serialized_photo])
+ end
+ end
+
+ context 'when user has both integrations configured' do
+ let(:immich_photo) { { 'type' => 'image', 'id' => '1' } }
+ let(:photoprism_photo) { { 'Type' => 'image', 'id' => '2' } }
+ let(:serialized_immich) do
+ {
+ id: '1',
+ latitude: nil,
+ longitude: nil,
+ localDateTime: nil,
+ originalFileName: nil,
+ city: nil,
+ state: nil,
+ country: nil,
+ type: 'image',
+ source: 'immich'
+ }
+ end
+ let(:serialized_photoprism) do
+ {
+ id: '2',
+ latitude: nil,
+ longitude: nil,
+ localDateTime: nil,
+ originalFileName: nil,
+ city: nil,
+ state: nil,
+ country: nil,
+ type: 'image',
+ source: 'photoprism'
+ }
+ end
+
+ before do
+ allow(user).to receive(:immich_integration_configured?).and_return(true)
+ allow(user).to receive(:photoprism_integration_configured?).and_return(true)
+
+ allow_any_instance_of(Immich::RequestPhotos).to receive(:call)
+ .and_return([immich_photo])
+ allow_any_instance_of(Photoprism::RequestPhotos).to receive(:call)
+ .and_return([photoprism_photo])
+ end
+
+ it 'fetches and transforms photos from both services' do
+ expect(service.call).to eq([serialized_immich, serialized_photoprism])
+ end
+ end
+
+ context 'when filtering out videos' do
+ let(:immich_photo) { { 'type' => 'video', 'id' => '1' } }
+
+ before do
+ allow(user).to receive(:immich_integration_configured?).and_return(true)
+ allow(user).to receive(:photoprism_integration_configured?).and_return(false)
+
+ allow_any_instance_of(Immich::RequestPhotos).to receive(:call)
+ .and_return([immich_photo])
+ end
+
+ it 'excludes video assets' do
+ expect(service.call).to eq([])
+ end
+ end
+ end
+
+ describe '#initialize' do
+ context 'with default parameters' do
+ let(:service_default) { described_class.new(user) }
+
+ it 'sets default start_date' do
+ expect(service_default.start_date).to eq('1970-01-01')
+ end
+
+ it 'sets default end_date to nil' do
+ expect(service_default.end_date).to be_nil
+ end
+ end
+
+ context 'with custom parameters' do
+ it 'sets custom dates' do
+ expect(service.start_date).to eq(start_date)
+ expect(service.end_date).to eq(end_date)
+ end
+ end
+ end
+end
diff --git a/spec/services/photos/thumbnail_spec.rb b/spec/services/photos/thumbnail_spec.rb
new file mode 100644
index 00000000..c687e370
--- /dev/null
+++ b/spec/services/photos/thumbnail_spec.rb
@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Photos::Thumbnail do
+ let(:user) { create(:user) }
+ let(:id) { 'photo123' }
+
+ describe '#call' do
+ subject { described_class.new(user, source, id).call }
+
+ context 'with immich source' do
+ let(:source) { 'immich' }
+ let(:api_key) { 'immich_key_123' }
+ let(:base_url) { 'https://photos.example.com' }
+ let(:expected_url) { "#{base_url}/api/assets/#{id}/thumbnail?size=preview" }
+ let(:expected_headers) do
+ {
+ 'accept' => 'application/octet-stream',
+ 'X-Api-Key' => api_key
+ }
+ end
+
+ before do
+ allow(user).to receive(:settings).and_return(
+ 'immich_url' => base_url,
+ 'immich_api_key' => api_key
+ )
+ end
+
+ it 'fetches thumbnail with correct parameters' do
+ expect(HTTParty).to receive(:get)
+ .with(expected_url, headers: expected_headers)
+ .and_return('thumbnail_data')
+
+ expect(subject).to eq('thumbnail_data')
+ end
+ end
+
+ context 'with photoprism source' do
+ let(:source) { 'photoprism' }
+ let(:base_url) { 'https://photoprism.example.com' }
+ let(:preview_token) { 'preview_token_123' }
+ let(:expected_url) { "#{base_url}/api/v1/t/#{id}/#{preview_token}/tile_500" }
+ let(:expected_headers) do
+ {
+ 'accept' => 'application/octet-stream'
+ }
+ end
+
+ before do
+ allow(user).to receive(:settings).and_return(
+ 'photoprism_url' => base_url
+ )
+ allow(Rails.cache).to receive(:read)
+ .with("#{Photoprism::CachePreviewToken::TOKEN_CACHE_KEY}_#{user.id}")
+ .and_return(preview_token)
+ end
+
+ it 'fetches thumbnail with correct parameters' do
+ expect(HTTParty).to receive(:get)
+ .with(expected_url, headers: expected_headers)
+ .and_return('thumbnail_data')
+
+ expect(subject).to eq('thumbnail_data')
+ end
+ end
+
+ context 'with unsupported source' do
+ let(:source) { 'unsupported' }
+
+ it 'raises an error' do
+ expect { subject }.to raise_error(RuntimeError, 'Unsupported source: unsupported')
+ end
+ end
+ end
+end
diff --git a/spec/swagger/api/v1/photos_controller_spec.rb b/spec/swagger/api/v1/photos_controller_spec.rb
index eb3cb737..eef5d9a5 100644
--- a/spec/swagger/api/v1/photos_controller_spec.rb
+++ b/spec/swagger/api/v1/photos_controller_spec.rb
@@ -3,7 +3,7 @@
require 'swagger_helper'
RSpec.describe 'Api::V1::PhotosController', type: :request do
- let(:user) { create(:user, :with_immich_credentials) }
+ let(:user) { create(:user, :with_immich_integration) }
let(:api_key) { user.api_key }
let(:start_date) { '2024-01-01' }
let(:end_date) { '2024-01-02' }
@@ -103,59 +103,17 @@ RSpec.describe 'Api::V1::PhotosController', type: :request do
type: :object,
properties: {
id: { type: :string },
- deviceAssetId: { type: :string },
- ownerId: { type: :string },
- type: { type: :string },
- originalPath: { type: :string },
- originalFileName: { type: :string },
- originalMimeType: { type: :string },
- thumbhash: { type: :string },
- fileCreatedAt: { type: :string, format: 'date-time' },
- fileModifiedAt: { type: :string, format: 'date-time' },
+ latitude: { type: :number, format: :float },
+ longitude: { type: :number, format: :float },
localDateTime: { type: :string, format: 'date-time' },
- updatedAt: { type: :string, format: 'date-time' },
- isFavorite: { type: :boolean },
- isArchived: { type: :boolean },
- isTrashed: { type: :boolean },
- duration: { type: :string },
- exifInfo: {
- type: :object,
- properties: {
- make: { type: :string },
- model: { type: :string },
- exifImageWidth: { type: :integer },
- exifImageHeight: { type: :integer },
- fileSizeInByte: { type: :integer },
- orientation: { type: :string },
- dateTimeOriginal: { type: :string, format: 'date-time' },
- modifyDate: { type: :string, format: 'date-time' },
- timeZone: { type: :string },
- lensModel: { type: :string },
- fNumber: { type: :number, format: :float },
- focalLength: { type: :number, format: :float },
- iso: { type: :integer },
- exposureTime: { type: :string },
- latitude: { type: :number, format: :float },
- longitude: { type: :number, format: :float },
- city: { type: :string },
- state: { type: :string },
- country: { type: :string },
- description: { type: :string },
- projectionType: { type: %i[string null] },
- rating: { type: %i[integer null] }
- }
- },
- checksum: { type: :string },
- isOffline: { type: :boolean },
- hasMetadata: { type: :boolean },
- duplicateId: { type: :string },
- resized: { type: :boolean }
+ originalFileName: { type: :string },
+ city: { type: :string },
+ state: { type: :string },
+ country: { type: :string },
+ type: { type: :string },
+ source: { type: :string }
},
- required: %w[id deviceAssetId ownerId type originalPath
- originalFileName originalMimeType thumbhash
- fileCreatedAt fileModifiedAt localDateTime
- updatedAt isFavorite isArchived isTrashed duration
- exifInfo checksum isOffline hasMetadata duplicateId resized]
+ required: %w[id latitude longitude localDateTime originalFileName city state country type source]
}
run_test! do |response|
@@ -172,61 +130,24 @@ RSpec.describe 'Api::V1::PhotosController', type: :request do
produces 'application/json'
parameter name: :id, in: :path, type: :string, required: true
parameter name: :api_key, in: :query, type: :string, required: true
-
+ parameter name: :source, in: :query, type: :string, required: true
response '200', 'photo found' do
schema type: :object,
properties: {
id: { type: :string },
- deviceAssetId: { type: :string },
- ownerId: { type: :string },
- type: { type: :string },
- originalPath: { type: :string },
- originalFileName: { type: :string },
- originalMimeType: { type: :string },
- thumbhash: { type: :string },
- fileCreatedAt: { type: :string, format: 'date-time' },
- fileModifiedAt: { type: :string, format: 'date-time' },
+ latitude: { type: :number, format: :float },
+ longitude: { type: :number, format: :float },
localDateTime: { type: :string, format: 'date-time' },
- updatedAt: { type: :string, format: 'date-time' },
- isFavorite: { type: :boolean },
- isArchived: { type: :boolean },
- isTrashed: { type: :boolean },
- duration: { type: :string },
- exifInfo: {
- type: :object,
- properties: {
- make: { type: :string },
- model: { type: :string },
- exifImageWidth: { type: :integer },
- exifImageHeight: { type: :integer },
- fileSizeInByte: { type: :integer },
- orientation: { type: :string },
- dateTimeOriginal: { type: :string, format: 'date-time' },
- modifyDate: { type: :string, format: 'date-time' },
- timeZone: { type: :string },
- lensModel: { type: :string },
- fNumber: { type: :number, format: :float },
- focalLength: { type: :number, format: :float },
- iso: { type: :integer },
- exposureTime: { type: :string },
- latitude: { type: :number, format: :float },
- longitude: { type: :number, format: :float },
- city: { type: :string },
- state: { type: :string },
- country: { type: :string },
- description: { type: :string },
- projectionType: { type: %i[string null] },
- rating: { type: %i[integer null] }
- }
- },
- checksum: { type: :string },
- isOffline: { type: :boolean },
- hasMetadata: { type: :boolean },
- duplicateId: { type: :string },
- resized: { type: :boolean }
+ originalFileName: { type: :string },
+ city: { type: :string },
+ state: { type: :string },
+ country: { type: :string },
+ type: { type: :string },
+ source: { type: :string }
}
let(:id) { '7fe486e3-c3ba-4b54-bbf9-1281b39ed15c' }
+ let(:source) { 'immich' }
run_test! do |response|
data = JSON.parse(response.body)
@@ -238,6 +159,7 @@ RSpec.describe 'Api::V1::PhotosController', type: :request do
response '404', 'photo not found' do
let(:id) { 'nonexistent' }
let(:api_key) { user.api_key }
+ let(:source) { 'immich' }
run_test! do |response|
data = JSON.parse(response.body)
diff --git a/swagger/v1/swagger.yaml b/swagger/v1/swagger.yaml
index 3ecfb855..6657aebf 100644
--- a/swagger/v1/swagger.yaml
+++ b/swagger/v1/swagger.yaml
@@ -347,130 +347,38 @@ paths:
properties:
id:
type: string
- deviceAssetId:
- type: string
- ownerId:
- type: string
- type:
- type: string
- originalPath:
- type: string
- originalFileName:
- type: string
- originalMimeType:
- type: string
- thumbhash:
- type: string
- fileCreatedAt:
- type: string
- format: date-time
- fileModifiedAt:
- type: string
- format: date-time
+ latitude:
+ type: number
+ format: float
+ longitude:
+ type: number
+ format: float
localDateTime:
type: string
format: date-time
- updatedAt:
+ originalFileName:
type: string
- format: date-time
- isFavorite:
- type: boolean
- isArchived:
- type: boolean
- isTrashed:
- type: boolean
- duration:
+ city:
type: string
- exifInfo:
- type: object
- properties:
- make:
- type: string
- model:
- type: string
- exifImageWidth:
- type: integer
- exifImageHeight:
- type: integer
- fileSizeInByte:
- type: integer
- orientation:
- type: string
- dateTimeOriginal:
- type: string
- format: date-time
- modifyDate:
- type: string
- format: date-time
- timeZone:
- type: string
- lensModel:
- type: string
- fNumber:
- type: number
- format: float
- focalLength:
- type: number
- format: float
- iso:
- type: integer
- exposureTime:
- type: string
- latitude:
- type: number
- format: float
- longitude:
- type: number
- format: float
- city:
- type: string
- state:
- type: string
- country:
- type: string
- description:
- type: string
- projectionType:
- type:
- - string
- - 'null'
- rating:
- type:
- - integer
- - 'null'
- checksum:
+ state:
type: string
- isOffline:
- type: boolean
- hasMetadata:
- type: boolean
- duplicateId:
+ country:
+ type: string
+ type:
+ type: string
+ source:
type: string
- resized:
- type: boolean
required:
- id
- - deviceAssetId
- - ownerId
- - type
- - originalPath
- - originalFileName
- - originalMimeType
- - thumbhash
- - fileCreatedAt
- - fileModifiedAt
+ - latitude
+ - longitude
- localDateTime
- - updatedAt
- - isFavorite
- - isArchived
- - isTrashed
- - duration
- - exifInfo
- - checksum
- - isOffline
- - hasMetadata
- - duplicateId
- - resized
+ - originalFileName
+ - city
+ - state
+ - country
+ - type
+ - source
"/api/v1/photos/{id}/thumbnail":
get:
summary: Retrieves a photo
@@ -487,6 +395,11 @@ paths:
required: true
schema:
type: string
+ - name: source
+ in: query
+ required: true
+ schema:
+ type: string
responses:
'200':
description: photo found
@@ -497,107 +410,27 @@ paths:
properties:
id:
type: string
- deviceAssetId:
- type: string
- ownerId:
- type: string
- type:
- type: string
- originalPath:
- type: string
- originalFileName:
- type: string
- originalMimeType:
- type: string
- thumbhash:
- type: string
- fileCreatedAt:
- type: string
- format: date-time
- fileModifiedAt:
- type: string
- format: date-time
+ latitude:
+ type: number
+ format: float
+ longitude:
+ type: number
+ format: float
localDateTime:
type: string
format: date-time
- updatedAt:
+ originalFileName:
type: string
- format: date-time
- isFavorite:
- type: boolean
- isArchived:
- type: boolean
- isTrashed:
- type: boolean
- duration:
+ city:
type: string
- exifInfo:
- type: object
- properties:
- make:
- type: string
- model:
- type: string
- exifImageWidth:
- type: integer
- exifImageHeight:
- type: integer
- fileSizeInByte:
- type: integer
- orientation:
- type: string
- dateTimeOriginal:
- type: string
- format: date-time
- modifyDate:
- type: string
- format: date-time
- timeZone:
- type: string
- lensModel:
- type: string
- fNumber:
- type: number
- format: float
- focalLength:
- type: number
- format: float
- iso:
- type: integer
- exposureTime:
- type: string
- latitude:
- type: number
- format: float
- longitude:
- type: number
- format: float
- city:
- type: string
- state:
- type: string
- country:
- type: string
- description:
- type: string
- projectionType:
- type:
- - string
- - 'null'
- rating:
- type:
- - integer
- - 'null'
- checksum:
+ state:
type: string
- isOffline:
- type: boolean
- hasMetadata:
- type: boolean
- duplicateId:
+ country:
+ type: string
+ type:
+ type: string
+ source:
type: string
- resized:
- type: boolean
'404':
description: photo not found
"/api/v1/points":