piwigo-api 0.5.6 → 0.5.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e294ca5c0e121278c55fbf48bc66f044d3784f24dcf269a65823ef553922ce1c
-  data.tar.gz: 0c7008a070ed0382cf241c37d6ecfade4281d0416b3affe371254acb3969d49b
+  metadata.gz: c0a99204c5afaf20cc4487138db8ac03f610b3599b2c67cd07885d0ee12c2150
+  data.tar.gz: d2e3017eedba2439a241b79db9c7ecd5f8e2ab273136fea450d49286724b5b93
 SHA512:
-  metadata.gz: b45371d658f0f88dddf087a7c1d870ead3b254c07de7378272a905d0999560ea871d57e64795c0970ca63c53e86136faecc6063f4db4435bf95f22e5c7f536e5
-  data.tar.gz: 2c99cea7f5a416a18e46fe5fc08984220476c82354785c6967384959278a4243c71a256bcaf24835f59f2fe8d4742d3bfd913a6fa1c19205f813165ced02aab7
+  metadata.gz: 9c5bf3103979e5a1e68a5e687e35bae8232c7a1e83a5a732d7952c85c8d0d5cd65b555e50e617162c5805c64f91d5e61d87c33c58a5844ff365a8f91eb5ffb6a
+  data.tar.gz: ebf38478a69894d10ed41b89e6b1e46b5fce6a97c6cf16c0a29c01debe96b7e8473b62e7852bf789583f29e034c7021ff3fcefa27c4a6ceb894c9ef737943de9

data/.github/workflows/gempush.yml

@@ -1,36 +1,35 @@
 name: Ruby Gem
 
 on:
-  pull_request:
-    branches:
-      - master
   push:
-    branches:
-      - master
+    branches: [ master ]
 
 jobs:
   build:
     name: Build + Publish
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
 
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v2
     - name: Set up Ruby 2.6
       uses: actions/setup-ruby@v1
       with:
-        version: 2.6.x
+        ruby-version: 2.6.x
 
     - name: Publish to GPR
       run: |
         mkdir -p $HOME/.gem
         touch $HOME/.gem/credentials
         chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
         gem build *.gemspec
         gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
       env:
-        GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}}
-        OWNER: KKDad
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
 
     - name: Publish to RubyGems
       run: |
@@ -41,4 +40,4 @@ jobs:
         gem build *.gemspec
         gem push *.gem
       env:
-        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/ruby.yml

@@ -1,20 +1,26 @@
+
 name: Ruby
 
-on: [push]
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
 
 jobs:
-  build:
+  test:
 
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
 
     steps:
-    - uses: actions/checkout@v1
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
-    - name: Build and test with Rake
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3
-        bundle exec rake
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -4,7 +4,20 @@ 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.6 - 2020-03/01
+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
+
+0.5.8 - 2021-07-13 
+- Update dependencies address CVE-2021-32740
+
+0.5.7 - 2020-03-01
+- Fixed open-ended dependency on codecov
+
+0.5.6 - 2020-03-01
 - Update dependencies to address security vulnerability
 
 0.5.5 - 2019-11-26

data/Gemfile.lock

@@ -1,74 +1,73 @@
 PATH
   remote: .
   specs:
-    piwigo-api (0.5.5)
+    piwigo-api (0.5.10)
       exifr (~> 1.3)
-      http (~> 4.2)
-      logger (~> 1.4)
+      http (~> 5.0)
+      logger (~> 1.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ansi (1.5.0)
-    builder (3.2.3)
-    codecov (0.1.16)
-      json
-      simplecov
-      url
-    docile (1.3.2)
+    builder (3.2.4)
+    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.6)
-    ffi (1.11.3)
-    ffi (1.11.3-x64-mingw32)
+    exifr (1.3.9)
+    ffi (1.15.5)
+    ffi (1.15.5-x64-mingw32)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
-    http (4.2.0)
-      addressable (~> 2.3)
+    http (5.0.4)
+      addressable (~> 2.8)
       http-cookie (~> 1.0)
-      http-form_data (~> 2.0)
-      http-parser (~> 1.2.0)
-    http-cookie (1.0.3)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.4.0)
+    http-cookie (1.0.4)
       domain_name (~> 0.5)
-    http-form_data (2.1.1)
-    http-parser (1.2.1)
-      ffi-compiler (>= 1.0, < 2.0)
-    json (2.2.0)
-    logger (1.4.1)
-    minitest (5.13.0)
-    minitest-reporters (1.4.2)
+    http-form_data (2.3.0)
+    llhttp-ffi (0.4.0)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    logger (1.5.0)
+    minitest (5.15.0)
+    minitest-reporters (1.5.0)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    public_suffix (4.0.1)
-    rake (13.0.1)
-    ruby-progressbar (1.10.1)
-    simplecov (0.17.1)
+    public_suffix (4.0.6)
+    rake (13.0.6)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.6)
-    url (0.3.2)
+    unf_ext (0.0.8)
+    unf_ext (0.0.8-x64-mingw32)
 
 PLATFORMS
   ruby
   x64-mingw32
 
 DEPENDENCIES
-  bundler (~> 2.0)
-  codecov (>= 0.1.10)
-  minitest (~> 5.0)
-  minitest-reporters (~> 1.4)
+  bundler (~> 2.3)
+  codecov (~> 0.6)
+  minitest (~> 5.15)
+  minitest-reporters (~> 1.5)
   piwigo-api!
   rake (~> 13.0)
-  simplecov (~> 0.17)
+  simplecov (~> 0.21)
 
 BUNDLED WITH
-   2.0.2
+   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.6'.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.0'
-  spec.add_development_dependency 'codecov', '>= 0.1.10'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  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.17'
+  spec.add_development_dependency 'simplecov', '~> 0.21'
 
-  spec.add_runtime_dependency 'http', '~>4.2'
-  spec.add_runtime_dependency 'logger', '~>1.4'
+  spec.add_runtime_dependency 'http', '~>5.0'
+  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.6
+  version: 0.5.10
 platform: ruby
 authors:
 - Adrian Gilbert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-01 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.0'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        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
@@ -86,42 +86,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
     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
@@ -193,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Gem to interact with the Piwigo API