piwigo-api 0.5.10 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0a99204c5afaf20cc4487138db8ac03f610b3599b2c67cd07885d0ee12c2150
-  data.tar.gz: d2e3017eedba2439a241b79db9c7ecd5f8e2ab273136fea450d49286724b5b93
+  metadata.gz: 7fc5b8141101c1b604876f7d5bf09effc43bbb016fc1a41b46541e8d3b743553
+  data.tar.gz: bde9f990a5d2dc96577094a89677fdc5d013edd75d77be152dd51e1cb8eeab82
 SHA512:
-  metadata.gz: 9c5bf3103979e5a1e68a5e687e35bae8232c7a1e83a5a732d7952c85c8d0d5cd65b555e50e617162c5805c64f91d5e61d87c33c58a5844ff365a8f91eb5ffb6a
-  data.tar.gz: ebf38478a69894d10ed41b89e6b1e46b5fce6a97c6cf16c0a29c01debe96b7e8473b62e7852bf789583f29e034c7021ff3fcefa27c4a6ceb894c9ef737943de9
+  metadata.gz: e073d758652e9f9bba60b7de66d1025b22c03cbf5b051692c4187b9ea9c3b88fe1c308d449bc2df047960604ec0e6d507f68a316024acc0fd7e9cf4fc0fe7e58
+  data.tar.gz: 3b0375000c48966b96d67a51b79f49e3958493390087854eaa1b629c6438c4587e1a3b08ba0d0d838e272a8d77f46d91a245de62487219467da3da8c0ced6b2e

data/.gitignore

@@ -8,4 +8,5 @@
 /tmp/
 *.gem
 main.rb
-settings.json
+settings.json
+/.idea/

data/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+0.6.0 - 2022-01-17
+- Added support for specifying the port to connect to Piwigo on, and added an example
+- Fixed a regression bug from updating EXITF gem
+- Additional spelling fixes
+
 0.5.10 - 2022-01-16
 - Update Gemfile dependencies
 - Code and documentation cleanups
@@ -24,8 +29,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix another encoding issue when synchronizing folder with accented characters.
 
 0.5.4 - 2019-11-26
-- Fix crash in sniff_attributes when the image dosn't contain a valid EXIF data
-- Fix parent albums when syncronizing a folder-tree of albums into Piwigo
+- Fix crash in sniff_attributes when the image doesn't contain a valid EXIF data
+- Fix parent albums when synchronizing a folder-tree of albums into Piwigo
 
 0.5.3 - 2019-11-25
 - Fixed to coverage reports
@@ -38,10 +43,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 0.5.0 - 2019-11-23
 - Added a directory of example scripts
-- Added a folder-album syncronization methods
+- Added a folder-album synchronization methods
 
 0.4.0 - 2019-11-20
-- Add methods to check for the existance of a specific image and to upload images
+- Add methods to check for the existence of a specific image and to upload images
 
 0.3.1 - 2019-11-20
 - Add a codecov.yaml for coverage reports

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    piwigo-api (0.5.10)
+    piwigo-api (0.6.0)
       exifr (~> 1.3)
       http (~> 5.0)
       logger (~> 1.5)

data/examples/Different_Port.md

@@ -0,0 +1,42 @@
+## Specify a URL with a port
+
+If you are running Piwigo on a non-standard port in docker, you can specify the port when connecting:
+
+```ruby
+require 'piwigo/session'
+require 'piwigo/images'
+
+
+session = Piwigo::Session.login('localhost', 'root', 'piwigo', port: 8083, https: false)
+unless session.nil?
+  require 'piwigo/session'
+  require 'piwigo/albums'
+
+  album = Piwigo::Albums::Album.new
+  album.name = "Chippy"
+  album = Piwigo::Albums.add(session, album)
+
+  filename = 'C:\Photos\chippy.jpg'
+  if Piwigo::Images.lookup(session, filename).nil?
+    Piwigo::Images.upload(session, filename, album, 'apple-pie-bars')
+  end
+end
+```
+
+Example output:
+~~~
+$ ruby main.rb
+I, [2022-01-16T20:40:27.437987 #13428]  INFO -- : Login succeeded: {"stat":"ok","result":true}
+I, [2022-01-16T20:40:27.471733 #13428]  INFO -- : Status succeeded
+I, [2022-01-16T20:40:27.475731 #13428]  INFO -- : Encoding: Chippy - UTF-8
+I, [2022-01-16T20:40:27.534389 #13428]  INFO -- : Album Add succeeded: Chippy(1) created.
+I, [2022-01-16T20:40:27.589282 #13428]  INFO -- : Image lookup succeeded: {"e49804192ae97cd09460e09fddb8187a"=>nil}
+I, [2022-01-16T20:40:27.702908 #13428]  INFO -- : Image AddChunk #0 succeeded: {"stat"=>"ok", "result"=>nil}
+I, [2022-01-16T20:40:27.817544 #13428]  INFO -- : Image AddChunk #1 succeeded: {"stat"=>"ok", "result"=>nil}
+I, [2022-01-16T20:40:27.901301 #13428]  INFO -- : Image AddChunk #2 succeeded: {"stat"=>"ok", "result"=>nil}
+I, [2022-01-16T20:40:27.902947 #13428]  INFO -- : --> GPS: 45.33110277777778, -75.79546111111111
+I, [2022-01-16T20:40:27.903224 #13428]  INFO -- : {:date_creation=>"2022-01-16", :categories=>1}
+{"stat"=>"ok", "result"=>{"image_id"=>1, "url"=>"http://localhost:8083:8000/picture.php?/1/category/1"}}
+I, [2022-01-16T20:40:27.980021 #13428]  INFO -- : Image Add succeeded.
+
+~~~

data/examples/Syncronize_Folder.md

@@ -1,6 +1,6 @@
-## Syncronize a Directory with Piwigo
+## Synchronize a Directory with Piwigo
 
-To syncronize a folder-tree of im ages with Piwigo:
+To synchronize a folder-tree of im ages with Piwigo:
 
 ```ruby
 require 'piwigo/session'
@@ -14,7 +14,7 @@ unless session.nil?
 end
 ```
 
-Call the script with the directory to syncronize. Eg:
+Call the script with the directory to synchronize. Eg:
 
 ```ruby
 ruby main.rb //DISKSTATION/photos/

data/examples/Upload_Image.md

@@ -9,9 +9,13 @@ require 'piwigo/images'
 
 session = Piwigo::Session.login('10.100.230.78', 'Adrian', 'mypassword', https: false)
 unless session.nil?
+  album = Piwigo::Albums::Album.new
+  album.name = "Recipes"
+  album = Piwigo::Albums.add(session, album)
+
   filename = 'C:\photos\apple-pie-bars-articleLarge.jpg'
-  if Piwigo::Images.Lookup(session, filename).nil?
-    Piwigo::Images.Upload(session, filename, 'apple-pie-bars')
+  if Piwigo::Images.lookup(session, filename).nil?
+    Piwigo::Images.upload(session, filename, album, 'apple-pie-bars')
   end
 end
 ```

data/lib/piwigo/image_uploader.rb

@@ -4,6 +4,7 @@ require 'json'
 require 'logger'
 require 'digest'
 require 'base64'
+require 'exifr/jpeg'
 
 # Add a photo.
 #
@@ -28,7 +29,7 @@ module Piwigo
       # @param [<Type>] name of the image
       #
       # @return [Boolean] True if successful
-      def upload(session, filename, name, album: null)
+      def upload(session, filename, name, album: nil)
         @session = session
         raise 'Invalid session' if @session.uri.nil?
 
@@ -134,6 +135,7 @@ module Piwigo
           @logger.info 'Image Add succeeded.'
           true
         else
+          @logger.error "Unexpected error: #{response.code}"
           false
         end
       rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e

data/lib/piwigo/images.rb

@@ -131,11 +131,12 @@ module Piwigo
     #
     # @param [<Type>] session
     # @param [<Type>] filename of the file to upload
-    # @param [<Type>] name of the image
+    # @param [Album] album to place tge image in
+    # @param [String] name of the image
     #
     # @return [Boolean] True if successful
-    def self.upload(session, file, name)
-      ImageUploader.new(session, file, name).upload
+    def self.upload(session, file, album, name)
+      ImageUploader.new.upload(session, file, name, album: album)
     end
 
     # Checks existence of images

data/lib/piwigo/session.rb

@@ -78,9 +78,10 @@ module Piwigo
     # @param [string] piwigo - host to connect to. Can be fqdn or ip.
     # @param [string] username - user to connect as
     # @param [string] password - password for user
-    # @param [boolean] https - Use HTTPS?
+    # @param [boolean] https -
+    # @param [port] Optional port. If not specified, then http connections will use 80, https 443
     # @param [Logger] logger logger to output debug messages to (Optional)
-    def self.login(host, username, password, https: true, logger: nil)
+    def self.login(host, username, password, https: true, port: nil, logger: nil)
       raise 'host should not be nil' if host.nil?
       raise 'username should not be nil' if username.nil?
 
@@ -88,9 +89,9 @@ module Piwigo
 
       begin
         uri = if https
-                URI::HTTPS.build(host: host, path: '/ws.php', query: 'format=json')
+                URI::HTTPS.build(host: host, port: port.nil? ? 443 : port, path: '/ws.php', query: 'format=json')
               else
-                URI::HTTP.build(host: host, path: '/ws.php', query: 'format=json')
+                URI::HTTP.build(host: host, port: port.nil? ? 80 : port, path: '/ws.php', query: 'format=json')
               end
 
         # Create the HTTP objects
@@ -108,7 +109,7 @@ module Piwigo
 
         if response.code == '200'
           logger.info "Login succeeded: #{response.body}"
-          pwg_id = response.response['set-cookie'].split(';').select { |i| i.strip.start_with? 'pwg_id' }.first
+          pwg_id = response.response['set-cookie'].split(/[;,\,]/).select { |i| i.strip.start_with? 'pwg_id' }.first
           return Session.new(pwg_id, uri)
         else
           logger.error "Login failed: #{response.body}"

data/lib/piwigo/version.rb

@@ -1,3 +1,3 @@
 module Piwigo
-  VERSION = '0.5.10'.freeze
+  VERSION = '0.6.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: piwigo-api
 version: !ruby/object:Gem::Version
-  version: 0.5.10
+  version: 0.6.0
 platform: ruby
 authors:
 - Adrian Gilbert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-16 00:00:00.000000000 Z
+date: 2022-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -160,6 +160,7 @@ files:
 - bin/console
 - bin/setup
 - codecov.yml
+- examples/Different_Port.md
 - examples/Syncronize_Folder.md
 - examples/Upload_Image.md
 - lib/piwigo.rb