piwigo-api 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b631bbf1feb2e43cdc914db7f8ae0e839739951a99bbf00d1789c65f64524d1
-  data.tar.gz: 460e4d390cc2362865f0b9f168bd821f0b0451599daceaa8afaceca137ebc71e
+  metadata.gz: 25b24077502730104d7ff8bb0fc3e4de59c1de1de94157936dd80846da1ee876
+  data.tar.gz: ecc50b004fc354d5f45599c745ccec83a5f77293eed1fd41d4ab34280e23cde9
 SHA512:
-  metadata.gz: 68fe0e10a5ccfc1522b8fdef5c0f964e7702ff0d676282d406aa811d5f39bf29fb4893be125a8143ce9033f077043c3277fc6d871c23374060bab506bac687b3
-  data.tar.gz: 9e42d435b2c00cd85db2ebc2d77511497f9f7ba7ec7d2deb7b1e61d08434566a31d844fa80a864a2bbe92431fb81bbc545eaa1277c4eb51518ee650b8ac83549
+  metadata.gz: 7de1e335ce5f1a13e912cce73fe2cd3312876d687a64cc3ae488f419c11849b9484ba70d60393215566c3de8c6e9f489d9fdc1099d755c6f7670234a46ce83f6
+  data.tar.gz: 8cbc75ee1512e858c9190263c1c4a741ffccf0d71249c8813e7c501c73785534db59eefb85de8ddd472d6d519dd890a7609e41e7a4374d1fd9c869011cc6e6cb

data/.rubocop.yaml

@@ -1,3 +1,11 @@
+AllCops:
+  Exclude:
+    - 'tests/*.rb'    
+  TargetRubyVersion: 2.6
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
 Style/Encoding:
   Enabled: false
 
@@ -11,8 +19,4 @@ Metrics/AbcSize:
   Max: 40
 
 Metrics/MethodLength:
-  Max: 40
-
-AllCops:
-  Exclude:
-    - 'tests/*.rb'  
+  Max: 40

data/.vscode/launch.json

@@ -4,8 +4,8 @@
     // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
     "version": "0.2.0",
     "configurations": [
-    
-    
+
+        
         {
             "name": "Debug Local File",
             "type": "Ruby",

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.0 - 2019-11-23
+- Added a directory of example scripts
+- Added a folder-album syncronization methods
+
 0.4.0 - 2019-11-20
 - Add methods to check for the existance of a specific image and to upload images
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    piwigo-api (0.4.0)
+    piwigo-api (0.5.0)
       http (~> 4.2)
       logger (~> 1.4)
 
@@ -14,9 +14,11 @@ GEM
       json
       simplecov
       url
+    diff-lcs (1.3)
     docile (1.3.2)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    ffi (1.11.2)
     ffi (1.11.2-x64-mingw32)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
@@ -36,6 +38,19 @@ GEM
     minitest (5.13.0)
     public_suffix (4.0.1)
     rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
     simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -56,6 +71,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   piwigo-api!
   rake (~> 10.0)
+  rspec (~> 3.9)
 
 BUNDLED WITH
    2.0.2

data/examples/Upload_Image.md

@@ -0,0 +1,15 @@
+## Upload a single image
+
+Upload a single image if it doesn't already exist. Image is not associated with any Albums. The image will named apple-pie-bars
+
+```ruby
+session = Piwigo::Session.login('10.100.230.78', 'Adrian', 'mypassword', https: false)
+unless session.nil?
+  filename = 'C:\photos\apple-pie-bars-articleLarge.jpg'
+  if Piwigo::Images.Lookup(session, filename).nil?
+    Piwigo::Images.Upload(session, filename, 'apple-pie-bars')
+  end
+end
+```
+
+Piwigo will automatically associate the Author of the image as `Adrian` matching the session login id.

data/lib/piwigo/albums.rb

@@ -72,7 +72,7 @@ module Piwigo
     # @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
-    def self.list(session, album_id: nil, recursive: false, public: false, fullname: false, thumbnail_size: 'thumb', logger: nil)
+    def self.list(session, album_id: nil, recursive: nil, public: nil, fullname: nil, thumbnail_size: nil, logger: nil)
       raise 'Invalid session' if session.uri.nil?
 
       logger ||= Logger.new(STDOUT)
@@ -80,7 +80,15 @@ module Piwigo
       begin
         http = Net::HTTP.new(session.uri.host, session.uri.port)
         request = Net::HTTP::Post.new(session.uri.request_uri)
-        request.body = "method=pwg.categories.getList&cat_id=#{album_id}&recursive=#{recursive}&public=#{public}&fullname=#{fullname}&thumbnail_size=#{thumbnail_size}"
+        form = {
+          method: 'pwg.categories.getList'
+        }
+        form[:cat_id] = album_id unless album_id.nil?
+        form[:recursive] = recursive unless recursive.nil?
+        form[:public] = public unless public.nil?
+        form[:fullname] = fullname unless fullname.nil?
+        form[:thumbnail_size] = thumbnail_size unless thumbnail_size.nil?
+        request.set_form_data(form)
         request['Cookie'] = [session.id]
 
         # Send the request
@@ -97,6 +105,21 @@ module Piwigo
       end
     end
 
+    # lookup a specific Album from a list of albums
+    #
+    # @param [<Type>] session
+    # @param [<Type>] album_name - Name of the album to locate
+    # @param [<Type>] logger <description>
+    #
+    # @return [<Type>] Album if located, nil otherwise
+    def self.lookup(session, album_name, logger: nil)
+      albums = list(session, recursive: true, fullname: false, logger: logger)
+      filtered = albums.select do |album|
+        album.name == album_name
+      end
+      filtered.size == 1 ? filtered[0] : nil
+    end
+
     # Adds an album.
     #
     # @param [Session] session to interact with Piwigo
@@ -113,10 +136,14 @@ module Piwigo
       begin
         http = Net::HTTP.new(session.uri.host, session.uri.port)
         request = Net::HTTP::Post.new(session.uri.request_uri)
-        request.body = "method=pwg.categories.add&name=#{album.name}"
-        request.body.concat "&parent=#{album.id_uppercat}" unless album.id_uppercat.nil?
-        request.body.concat "&comment=#{album.comment}" unless album.comment.nil?
-        request.body.concat "&status=#{album.status}" unless album.status.nil?
+        form = {
+          method: 'pwg.categories.add',
+          name: album.name
+        }
+        form[:parent] = album.id_uppercat unless album.id_uppercat.nil?
+        form[:comment] = album.comment unless album.comment.nil?
+        form[:status] = album.status unless album.status.nil?
+        request.set_form_data(form)
         request['Cookie'] = [session.id]
 
         # Send the request

data/lib/piwigo/folder_sync.rb

@@ -0,0 +1,58 @@
+require 'logger'
+require 'find'
+require_relative 'albums'
+require_relative 'image_uploader'
+
+module Piwigo
+  # Syncronize 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
+    # Create a new ImageUploader
+    #
+    # @param [Session] session - session to a piwigo instance
+    def initialize(session, logger: nil)
+      @logger = logger || Logger.new(STDOUT)
+      @session = session
+      @current_album = nil
+      @parent_album = nil
+    end
+
+    def self.synchronize(session, directory, logger: nil)
+      unless File.directory?(directory)
+        @Logger.error "No such directory: #{directory}"
+        return false
+      end
+      FolderSync.new(session, logger: logger).synchronize(directory)
+    end
+
+    # Syncronize a folder with Piwigo
+    #
+    # @param [String] directory - directory to  syncronize.
+    def synchronize(directory)
+      @logger.info "Processing Directory: #{directory}"
+
+      Find.find(directory) do |directory_entry|
+        next unless directory_entry != directory
+
+        if directory != directory_entry && File.directory?(directory_entry)
+          @parent_album = @current_album
+          @current_album = Piwigo::Albums::lookup(@session, File.basename(directory_entry))
+            if @current_album.nil?
+              album = Piwigo::Albums::Album.new(hash: { 'name' =>  File.basename(directory_entry), 
+                                                        'id_uppercat' => @parent_album.nil? ? nil : @parent_album.id })
+              @current_album = Piwigo::Albums.add @session, album
+            end
+
+          synchronize directory_entry
+        else
+          @logger.info "Processing Image: #{directory_entry} in album '#{@current_album}''"
+          image = Piwigo::Images::lookup(@session, directory_entry)
+          if image.nil?
+            Piwigo::Images::ImageUploader.new(logger: @logger).upload(@session, directory_entry, File.basename(directory_entry))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/piwigo/image_uploader.rb

@@ -30,7 +30,7 @@ module Piwigo
       # @param [<Type>] name of the image
       #
       # @return [Boolean] True if successful
-      def Upload(session, filename, name)
+      def upload(session, filename, name)
         @session = session
         raise 'Invalid session' if @session.uri.nil?
 
@@ -41,7 +41,7 @@ module Piwigo
         chunk_num = 0
         image_content = File.binread(filename)
         original_sum = Digest::MD5.hexdigest(image_content)
-        encoded_content = Base64.encode64(image_content)
+        encoded_content = image_content
         io = StringIO.new(encoded_content)
         until io.eof?
           chunk = io.read(MEGABYTE)
@@ -67,7 +67,7 @@ module Piwigo
           method: 'pwg.images.addChunk',
           original_sum: original_sum,
           position: position,
-          data: data
+          data: Base64.encode64(data)
         }
         request.set_form_data(form)
         request['Cookie'] = [@session.id]
@@ -81,7 +81,7 @@ module Piwigo
           false
         end
       rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
-        @logger.error "Image AddChunk failed: #{e.messages}"
+        @logger.error "Image AddChunk failed: #{e.message}"
         false
       end
 
@@ -123,7 +123,7 @@ module Piwigo
 
         response = http.request(request)
         if response.code == '500'
-          @logger.error "Image Add failed: #{response.messages}"
+          @logger.error "Image Add failed: #{response.message}"
           false
         elsif response.code == '200'
           data = JSON.parse(response.body)
@@ -134,7 +134,7 @@ module Piwigo
           false
         end
       rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
-        @logger.error "Image Add failed: #{e.messages}"
+        @logger.error "Image Add failed: #{e.message}"
         false
       end
     end

data/lib/piwigo/images.rb

@@ -100,6 +100,7 @@ module Piwigo
         form[:recursive] = recursive unless recursive.nil?
         form[:per_page] = per_page unless per_page.nil?
         form[:order] = order unless order.nil?
+        form[:page] = page unless page.nil?
         request.set_form_data(form)
         request['Cookie'] = [session.id]
 
@@ -113,7 +114,7 @@ module Piwigo
           { paging: paging, images: images }
         end
       rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
-        logger.error "Image List failed: #{e.messages}"
+        logger.error "Image List failed: #{e.message}"
         nil
       end
     end
@@ -125,8 +126,8 @@ module Piwigo
     # @param [<Type>] 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, name)
+      ImageUploader.new(session, file, name).upload
     end
 
     # Checks existence of images
@@ -136,7 +137,7 @@ module Piwigo
     # @param [Logger] logger
     #
     # @return [Number] Piwigo image_id if matched, nil if not present
-    def self.Lookup(session, file, logger: nil)
+    def self.lookup(session, file, logger: nil)
       raise 'Invalid session' if session.uri.nil?
 
       logger ||= Logger.new(STDOUT)
@@ -158,11 +159,12 @@ module Piwigo
         response = http.request(request)
         if response.code == '200'
           data = JSON.parse(response.body)
-          logger.info "Image Lookup succeeded: #{data['result']}"
-          data['result'][file_sum]
+          logger.info "Image lookup succeeded: #{data['result']}"
+          result = data['result'][file_sum]
+          result.nil? ? nil : result[file_sum]
         end
       rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
-        logger.error "Image Lookup failed: #{e.messages}"
+        logger.error "Image lookup failed: #{e.message}"
         nil
       end
     end

data/lib/piwigo/version.rb

@@ -1,3 +1,3 @@
 module Piwigo
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'.freeze
 end

data/piwigo-api.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'codecov', '>= 0.1.10'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 10.0'
-
+  
   spec.add_runtime_dependency 'http', '~>4.2'
   spec.add_runtime_dependency 'logger', '~>1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: piwigo-api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Adrian Gilbert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-20 00:00:00.000000000 Z
+date: 2019-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,8 +118,10 @@ files:
 - bin/console
 - bin/setup
 - codecov.yml
+- examples/Upload_Image.md
 - lib/piwigo.rb
 - lib/piwigo/albums.rb
+- lib/piwigo/folder_sync.rb
 - lib/piwigo/image_uploader.rb
 - lib/piwigo/images.rb
 - lib/piwigo/session.rb