piwigo-api 0.5.9 → 0.5.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fa77269c47c5c3de051986ac36f97764f5e766f14b7ab428401229a67ab2a78
-  data.tar.gz: e8a53e47119346c003463835983b2ce287c42a272f36d4aa143017f77559891d
+  metadata.gz: c0a99204c5afaf20cc4487138db8ac03f610b3599b2c67cd07885d0ee12c2150
+  data.tar.gz: d2e3017eedba2439a241b79db9c7ecd5f8e2ab273136fea450d49286724b5b93
 SHA512:
-  metadata.gz: ef857c2959b2f5090f0ccf3f3ffe3e9b2ff70a8a7e45ab96ea2bbcbf81ece8b9379b67fcc6f54ad0f78c24b6eb29f92314463604b2cb754a20d4cb123eac777a
-  data.tar.gz: 0347faaf186d2e005a86fbb598b35f79d373026f123adc9e1fcfd5f8f164fa94983e2aec0628d8748f42931eeb2af62dfd72b1f48dec8e1f3d6198121155886e
+  metadata.gz: 9c5bf3103979e5a1e68a5e687e35bae8232c7a1e83a5a732d7952c85c8d0d5cd65b555e50e617162c5805c64f91d5e61d87c33c58a5844ff365a8f91eb5ffb6a
+  data.tar.gz: ebf38478a69894d10ed41b89e6b1e46b5fce6a97c6cf16c0a29c01debe96b7e8473b62e7852bf789583f29e034c7021ff3fcefa27c4a6ceb894c9ef737943de9

data/CHANGELOG.md

@@ -4,6 +4,10 @@ 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.5.10 - 2022-01-16
+- Update Gemfile dependencies
+- Code and documentation cleanups
+
 0.5.9 - 2021-07-13 
 - Update version to fix github actions
 

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    piwigo-api (0.5.9)
+    piwigo-api (0.5.10)
       exifr (~> 1.3)
       http (~> 5.0)
-      logger (~> 1.4)
+      logger (~> 1.5)
 
 GEM
   remote: https://rubygems.org/
@@ -13,31 +13,31 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     ansi (1.5.0)
     builder (3.2.4)
-    codecov (0.5.2)
+    codecov (0.6.0)
       simplecov (>= 0.15, < 0.22)
     docile (1.4.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     exifr (1.3.9)
-    ffi (1.15.3)
-    ffi (1.15.3-x64-mingw32)
+    ffi (1.15.5)
+    ffi (1.15.5-x64-mingw32)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
-    http (5.0.1)
-      addressable (~> 2.3)
+    http (5.0.4)
+      addressable (~> 2.8)
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
-      llhttp-ffi (~> 0.3.0)
+      llhttp-ffi (~> 0.4.0)
     http-cookie (1.0.4)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
-    llhttp-ffi (0.3.1)
+    llhttp-ffi (0.4.0)
       ffi-compiler (~> 1.0)
       rake (~> 13.0)
-    logger (1.4.3)
-    minitest (5.14.4)
-    minitest-reporters (1.4.3)
+    logger (1.5.0)
+    minitest (5.15.0)
+    minitest-reporters (1.5.0)
       ansi
       builder
       minitest (>= 5.0)
@@ -53,21 +53,21 @@ GEM
     simplecov_json_formatter (0.1.3)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.7)
-    unf_ext (0.0.7.7-x64-mingw32)
+    unf_ext (0.0.8)
+    unf_ext (0.0.8-x64-mingw32)
 
 PLATFORMS
   ruby
   x64-mingw32
 
 DEPENDENCIES
-  bundler (~> 2.2)
-  codecov (~> 0.5)
-  minitest (~> 5.14)
-  minitest-reporters (~> 1.4)
+  bundler (~> 2.3)
+  codecov (~> 0.6)
+  minitest (~> 5.15)
+  minitest-reporters (~> 1.5)
   piwigo-api!
   rake (~> 13.0)
   simplecov (~> 0.21)
 
 BUNDLED WITH
-   2.2.15
+   2.3.5

data/lib/piwigo/albums.rb

@@ -3,8 +3,8 @@ require 'uri'
 require 'json'
 require 'logger'
 
-# Piwigo organizes images by albums. The album tree has unlimted depth and each photo can belong to multiple albums. The Piwigo API
-# refers to a Album as a Category.
+# Piwigo organizes images by albums. The album tree has unlimited depth and each photo can belong to multiple albums.
+# The Piwigo API refers to a Album as a Category.
 module Piwigo
   class Albums
     class Album
@@ -59,7 +59,7 @@ module Piwigo
       def initialize(hash: nil)
         hash&.each do |key, value|
           # Bug: If the encoding is Windows-1252, then Piwigo will blowup when creating the album
-          value = value.encode('UTF-8', 'Windows-1252') if value.class == String && value.encoding.to_s == 'Windows-1252'
+          value = value.encode('UTF-8', 'Windows-1252') if value.instance_of?(String) && value.encoding.to_s == 'Windows-1252'
           send("#{key}=", value)
         end
       end
@@ -73,10 +73,10 @@ module Piwigo
     #
     # @param [Session] session - Session
     # @param [Number] album_id - Album to fetch, Optional
-    # @param [Boolean] recursive - Include subalbums, Optional
+    # @param [Boolean] recursive - Include sub albums, Optional
     # @param [Boolean] public - Only include public albums, Optional
     # @param [Boolean] fullname - ???, Optional
-    # @param [String] thumbnail_size - Size of thumbname to return, One of: square, thumb, 2small, xsmall, small, medium, large, xlarge, xxlarge. Optional
+    # @param [String] thumbnail_size - Size of thumbnail to return, One of: square, thumb, 2small, xsmall, small, medium, large, xlarge, xxlarge. Optional
     # @param [Logger] logger logger to output debug messages to (Optional)
     #
     # @return [Array<Album>] All albums that match the criteria, or nil there were no matches

data/lib/piwigo/folder_sync.rb

@@ -5,7 +5,7 @@ require_relative 'albums'
 require_relative 'image_uploader'
 
 module Piwigo
-  # Syncronize a folder with Piwigo
+  # Synchronize a folder with Piwigo
   #    - Album name will be the same as the folder name
   #    - Will be created as a top-level folder unless specified
   class FolderSync
@@ -27,11 +27,11 @@ module Piwigo
       FolderSync.new(session, logger: logger).synchronize(directory)
     end
 
-    # Syncronize a folder with Piwigo
+    # Synchronize a folder with Piwigo
     #
-    # @param [String] directory - directory to  syncronize.
+    # @param [String] directory - directory to  synchronize.
     def synchronize(directory)
-      if ['originals', '.picasaoriginals'].include? File.basename(directory.downcase)
+      if %w[originals .picasaoriginals].include? File.basename(directory.downcase)
         @logger.info "Skipping special directory: #{directory}"
         return
       else
@@ -75,7 +75,7 @@ module Piwigo
 
     def process_file(directory_entry)
       # Only attempt to import images
-      return unless ['.jpg', '.png', '.gif'].include? File.extname(directory_entry).downcase
+      return unless %w[.jpg .png .gif].include? File.extname(directory_entry).downcase
 
       @logger.info "Processing Image: '#{directory_entry}' in album '#{@current_album}'"
       image = Piwigo::Images.lookup(@session, directory_entry)

data/lib/piwigo/image_uploader.rb

@@ -7,7 +7,7 @@ require 'base64'
 
 # Add a photo.
 #
-# To avoid limitations on HTTP POST maximum size, the piwigo requires the image to be splitted into several calls to pwg.images.addChunk 
+# To avoid limitations on HTTP POST maximum size, the piwigo requires the image to be splitted into several calls to pwg.images.addChunk
 # and then a single call to pwg.images.add.
 #
 # Reference: https://piwigo.org/doc/doku.php?id=dev:webapi:pwg.images.add
@@ -17,8 +17,6 @@ module Piwigo
       MEGABYTE = 1024 * 1024
 
       # Create a new ImageUploader
-      #
-      # @param [Session] session - session to a piwigo instance
       def initialize(logger: nil)
         @logger = logger || Logger.new(STDOUT)
       end
@@ -126,10 +124,11 @@ module Piwigo
         request['Cookie'] = [@session.id]
 
         response = http.request(request)
-        if response.code == '500'
+        case response.code
+        when '500'
           @logger.error "Image Add failed: #{response.message}"
           false
-        elsif response.code == '200'
+        when '200'
           data = JSON.parse(response.body)
           p data
           @logger.info 'Image Add succeeded.'
@@ -144,7 +143,7 @@ module Piwigo
 
       def sniff_attributes(filename, album: nil)
         attributes = {}
-        begin         
+        begin
           info = EXIFR::JPEG.new(filename)
           @logger.info "--> GPS: #{info.gps.latitude}, #{info.gps.longitude}" unless info.gps.nil?
           exif = info.exif.first.to_hash if info.exif?

data/lib/piwigo/images.rb

@@ -6,12 +6,12 @@ require 'logger'
 require 'digest'
 require_relative 'image_uploader'
 
-# Piwigo organizes images by albums. The album tree has unlimted depth and each photo can belong to multiple albums. The Piwigo API
+# Piwigo organizes images by albums. The album tree has unlimited depth and each photo can belong to multiple albums. The Piwigo API
 # refers to a Album as a Category.
 module Piwigo
   class Images
     class Image
-      # @return [Number] Unique ID idenifying this ie
+      # @return [Number] Unique ID identifying this ie
       attr_accessor :id
 
       # @return [Number] Width of the image in pixels
@@ -53,7 +53,7 @@ module Piwigo
       def initialize(hash: nil)
         hash&.each do |key, value|
           # Bug: If the encoding is Windows-1252, then Piwigo will blowup when creating the album
-          value = value.encode('UTF-8', 'Windows-1252') if value.class == String && value.encoding.to_s == 'Windows-1252'
+          value = value.encode('UTF-8', 'Windows-1252') if value.instance_of?(String) && value.encoding.to_s == 'Windows-1252'
           send("#{key}=", value)
         end
       end
@@ -75,7 +75,7 @@ module Piwigo
       def initialize(hash: nil)
         hash&.each do |key, value|
           # Bug: If the encoding is Windows-1252, then Piwigo will blowup when creating the album
-          value = value.encode('UTF-8', 'Windows-1252') if value.class == String && value.encoding.to_s == 'Windows-1252'
+          value = value.encode('UTF-8', 'Windows-1252') if value.instance_of?(String) && value.encoding.to_s == 'Windows-1252'
           send("#{key}=", value)
         end
       end

data/lib/piwigo/session.rb

@@ -28,7 +28,7 @@ module Piwigo
     # Gets information about the current session. Also provides a token useable with admin methods.
     # @return [<Type>] <description>
     def status
-      logger ||= Logger.new(STDOUT)
+      logger ||= Logger.new($stdout)
 
       begin
         # Create the HTTP objects
@@ -60,11 +60,11 @@ module Piwigo
     def logout(logger: nil)
       raise 'This session has already been logged out' if uri.nil?
 
-      logger ||= Logger.new(STDOUT)
+      logger ||= Logger.new($stdout)
 
       # Create the HTTP objects
       http = Net::HTTP.new(uri.host, uri.port)
-      request = Net::HTTP::Get.new(uri.request_uri + '&method=pwg.session.logout')
+      request = Net::HTTP::Get.new("#{uri.request_uri}&method=pwg.session.logout")
       request['Cookie'] = id
 
       # Send the request
@@ -84,11 +84,14 @@ module Piwigo
       raise 'host should not be nil' if host.nil?
       raise 'username should not be nil' if username.nil?
 
-      logger ||= Logger.new(STDOUT)
+      logger ||= Logger.new($stdout)
 
       begin
-        uri = https ? URI::HTTPS.build(host: host, path: '/ws.php', query: 'format=json') :
-                      URI::HTTP.build(host: host, path: '/ws.php', query: 'format=json')
+        uri = if https
+                URI::HTTPS.build(host: host, path: '/ws.php', query: 'format=json')
+              else
+                URI::HTTP.build(host: host, path: '/ws.php', query: 'format=json')
+              end
 
         # Create the HTTP objects
         http = Net::HTTP.new(uri.host, uri.port)

data/lib/piwigo/version.rb

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

data/piwigo-api.gemspec

@@ -27,14 +27,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 2.2'
-  spec.add_development_dependency 'codecov', '~> 0.5'
-  spec.add_development_dependency 'minitest', '~> 5.14'
-  spec.add_development_dependency 'minitest-reporters', '~>1.4'
+  spec.add_development_dependency 'bundler', '~> 2.3'
+  spec.add_development_dependency 'codecov', '~> 0.6'
+  spec.add_development_dependency 'minitest', '~> 5.15'
+  spec.add_development_dependency 'minitest-reporters', '~>1.5'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'simplecov', '~> 0.21'
 
   spec.add_runtime_dependency 'http', '~>5.0'
-  spec.add_runtime_dependency 'logger', '~>1.4'
+  spec.add_runtime_dependency 'logger', '~>1.5'
   spec.add_runtime_dependency 'exifr', '~>1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: piwigo-api
 version: !ruby/object:Gem::Version
-  version: 0.5.9
+  version: 0.5.10
 platform: ruby
 authors:
 - Adrian Gilbert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-13 00:00:00.000000000 Z
+date: 2022-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.15'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: exifr
   requirement: !ruby/object:Gem::Requirement