piwigo-api 0.5.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43b32bd1bcf777d69dc54b99ec4f3ab2b104ca59af264fa1dfc5724d40bdc221
-  data.tar.gz: 7d7b80f00e3a9733bdb8202d1489570f8bc163ceb3a3176ef97ff478437aade7
+  metadata.gz: d1f218541e0a4b20b9e6b3656b29d8930864b07131fd0dbd1f9951c96a6fec4a
+  data.tar.gz: b9857102f2e6b5c8ea8fd746f0de90ed4316d76b3b98d3223a09954e10f9d67e
 SHA512:
-  metadata.gz: 0e05d77f7f5a347ac7fb10bf046704c2367411417b26714966fe82a4b1514292edcb0225af52b87998a57b69e3449976b64ad1bcbb14f3f9bf2a20eac12b962a
-  data.tar.gz: e1d071144af4c9fa1f9786f71f25d91f971a764dcc22dc6bbec67cbb0fc6ac4a5e3a9d94a2c73b548c6ea33a7044ba6b3d90e5faa069531a47f37fb8ab7caf85
+  metadata.gz: 3b1753972858ddcf68ba352b49f42d7a683aee2d08d6cbcf2b4ba6b3ef795d70d4de33c81aca6c098be0b95126bacdd1f7d8519c310c46eba88a082f37d1789e
+  data.tar.gz: 41588632e509053b1188d8797db04dc30cfd1ce04bdbdf1e1dc82f4932c11ad995010e146c38219efdec4847156997e1f0d740396bb70bfaed7f187432bd941f

data/.rubocop.yaml

@@ -1,6 +1,6 @@
 AllCops:
   Exclude:
-    - 'tests/*.rb'    
+    - 'test/**/*.rb'    
   TargetRubyVersion: 2.6
 
 Style/FrozenStringLiteralComment:

data/CHANGELOG.md

@@ -4,8 +4,14 @@ 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.3 - 2019-11-25
+- Fixed to coverage reports
+- Only generate coverage reports during CI build
+- codecov.io seems to be ignoring some test files in the coverage report
+- Use EXIF data to pull out the original image date when uploading to Piwigo
+
 0.5.1 - 2019-11-23
-- Fixed image.lookup
+- Fixed minor bug in image.lookup
 
 0.5.0 - 2019-11-23
 - Added a directory of example scripts

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    piwigo-api (0.5.1)
+    piwigo-api (0.5.3)
+      exifr (~> 1.3)
       http (~> 4.2)
       logger (~> 1.4)
 
@@ -10,6 +11,8 @@ GEM
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
+    ansi (1.5.0)
+    builder (3.2.3)
     codecov (0.1.16)
       json
       simplecov
@@ -17,7 +20,9 @@ GEM
     docile (1.3.2)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    ffi (1.11.2-x64-mingw32)
+    exifr (1.3.6)
+    ffi (1.11.3)
+    ffi (1.11.3-x64-mingw32)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
@@ -34,8 +39,14 @@ GEM
     json (2.2.0)
     logger (1.4.1)
     minitest (5.13.0)
+    minitest-reporters (1.4.2)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
     public_suffix (4.0.1)
     rake (10.5.0)
+    ruby-progressbar (1.10.1)
     simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -54,8 +65,10 @@ DEPENDENCIES
   bundler (~> 2.0)
   codecov (>= 0.1.10)
   minitest (~> 5.0)
+  minitest-reporters (~> 1.4)
   piwigo-api!
   rake (~> 10.0)
+  simplecov (~> 0.17)
 
 BUNDLED WITH
    2.0.2

data/Rakefile

@@ -1,10 +1,13 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'minitest'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
   t.libs << 'lib'
+  t.libs << 'test'
   t.test_files = FileList['test/**/*_test.rb']
+  t.pattern = 'test/**test.rb'
+  t.verbose = true
 end
 
 task default: :test

data/lib/piwigo/albums.rb

@@ -59,6 +59,10 @@ module Piwigo
       def initialize(hash: nil)
         hash&.each { |key, value| send("#{key}=", value) }
       end
+
+      def to_s
+        "#{name}(#{id})"
+      end
     end
 
     # Returns a list of albums

data/lib/piwigo/folder_sync.rb

@@ -1,5 +1,6 @@
 require 'logger'
 require 'find'
+require 'exifr/jpeg'
 require_relative 'albums'
 require_relative 'image_uploader'
 
@@ -32,27 +33,44 @@ module Piwigo
     def synchronize(directory)
       @logger.info "Processing Directory: #{directory}"
 
-      Find.find(directory) do |directory_entry|
-        next unless directory_entry != directory
+      Dir.entries(directory).reject { |entry| entry =~ /^.{1,2}$/ }.each do |directory_entry|
+        item_to_process = File.join directory, directory_entry
 
-        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
+        if File.directory? item_to_process
+          process_directory item_to_process
         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
+          process_file item_to_process
         end
       end
     end
+
+    private
+
+    def process_directory(directory_entry)
+      @logger.info "Processing #{directory_entry}"
+      @parent_album = @current_album
+      # Look to see if we have previously created an Album in Piwogo with this name
+      @current_album = Piwigo::Albums.lookup(@session, File.basename(directory_entry))
+
+      if @current_album.nil?
+        # Album doesn't exist, create one
+        new_album = { 'name' => File.basename(directory_entry),
+                      'id_uppercat' => @parent_album.nil? ? nil : @parent_album.id }
+        album = Piwigo::Albums::Album.new(hash: new_album)
+        @current_album = Piwigo::Albums.add @session, album
+      end
+
+      # Recursively process all of the entries in this album
+      @logger.info "Recursing into #{directory_entry}"
+      synchronize directory_entry
+    end
+
+    def process_file(directory_entry)
+      @logger.info "Processing Image: '#{directory_entry}' in album '#{@current_album}'"
+      image = Piwigo::Images.lookup(@session, directory_entry)
+      return unless image.nil?
+
+      Piwigo::Images::ImageUploader.new(logger: @logger).upload(@session, directory_entry, File.basename(directory_entry), album: @current_album)
+    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, album: null)
         @session = session
         raise 'Invalid session' if @session.uri.nil?
 
@@ -48,7 +48,8 @@ module Piwigo
           addChunk(chunk, original_sum, chunk_num)
           chunk_num += 1
         end
-        add(original_sum, filename, name)
+        attributes = sniff_attributes(filename, album: album)
+        add(original_sum, filename, name, attributes: attributes)
       end
 
       private
@@ -90,17 +91,20 @@ module Piwigo
       # @param [<Type>] original_sum - md5sum that makes the photo unique
       # @param [<Type>] original_filename
       # @param [<Type>] name
-      # @param [<Type>] author
-      # @param [Number] level - 0 (—-), 1 (Contacts), 2 (Friends), 4 (Family), 8 (Admins)
-      # @param [String] date_creation - formatted as 2009-03-26
-      # @param [<Type>] comment -
-      # @param [<Type>] categories - list of category identifiers where you want the photo to be shown. Optionaly, you can set a rank inside the each category.
-      #                              Example : '19,3;16,0;134' will associate the photo to category 19 at rank 3, to category 16 at rank 0 (first position) and
-      #                                        to category 134 with an automatic rank (last position).
-      # @param [<Type>] image_id - give an image_id if you want to update an existing photo
+      # @param [Hash] attributes - attributes to include with image add. Include:
+      #    author
+      #    level - 0 (—-), 1 (Contacts), 2 (Friends), 4 (Family), 8 (Admins)
+      #    date_creation - formatted as 2009-03-26
+      #    comment -
+      #    categories - list of category identifiers where you want the photo to be shown. Optionaly, you can set a rank inside the each category.
+      #                 Example : '19,3;16,0;134' will associate the photo to category 19 at rank 3, to category 16 at rank 0 (first position) and
+      #                           to category 134 with an automatic rank (last position).
+      #    image_id - give an image_id if you want to update an existing photo
       #
       # @return [Boolean] True if successful
-      def add(original_sum, original_filename, name, author: nil, level: nil, date_creation: nil, comment: nil, categories: nil, image_id: nil)
+      def add(original_sum, original_filename, name, attributes: {})
+
+        # name, author: nil, level: nil, date_creation: nil, comment: nil, categories: nil, image_id: nil
 
         http = Net::HTTP.new(@session.uri.host, @session.uri.port)
         request = Net::HTTP::Post.new(@session.uri.request_uri)
@@ -111,12 +115,12 @@ module Piwigo
           name: name
         }
 
-        form[:author] = author unless author.nil?
-        form[:level] = level unless level.nil?
-        form[:date_creation] = date_creation unless date_creation.nil?
-        form[:comment] = comment unless comment.nil?
-        form[:categories] = categories unless categories.nil?
-        form[:image_id] = image_id unless image_id.nil?
+        form[:author] = attributes[:author] if attributes.key? :author
+        form[:level] = attributes[:level] if attributes.key? :level
+        form[:date_creation] = attributes[:date_creation] if attributes.key? :date_creation
+        form[:comment] = comment attributes[:comment] if attributes.key? :comment
+        form[:categories] = attributes[:categories] if attributes.key? :categories
+        form[:image_id] = attributes[:image_id] if attributes.key? :image_id
         request.set_form_data(form)
 
         request['Cookie'] = [@session.id]
@@ -137,6 +141,30 @@ module Piwigo
         @logger.error "Image Add failed: #{e.message}"
         false
       end
+
+      def sniff_attributes(filename, album: nil)
+        attributes = {}
+
+        info = EXIFR::JPEG.new(filename)
+        @logger.info "--> GPS: #{info.gps.latitude}, #{info.gps.longitude}"
+        exif = info.exif.first.to_hash if info.exif?
+        if exif.nil?
+          # No EXIF data, use the file ctime as the date_creation
+          fs = File::Stat.new(filename)
+          attributes[:date_creation] = fs.ctime.strftime('%Y-%m-%d')
+        else
+          # We have EXIF data, pull out the date_time_original for the date_creation
+          attributes[:date_creation] = exif[:date_time_original].strftime('%Y-%m-%d')
+          # exif.each do |item|
+          #   @logger.info "--> #{item[0]}: #{item[1]}"
+          # end
+        end
+
+        attributes[:categories] = album.id unless album.nil?
+        attributes
+      end
     end
+
+
   end
 end

data/lib/piwigo/images.rb

@@ -154,7 +154,6 @@ module Piwigo
         }
         request.set_form_data(form)
         request['Cookie'] = [session.id]
-        p file_sum
 
         # Send the request
         response = http.request(request)

data/lib/piwigo/version.rb

@@ -1,3 +1,3 @@
 module Piwigo
-  VERSION = '0.5.1'.freeze
+  VERSION = '0.5.3'.freeze
 end

data/piwigo-api.gemspec

@@ -30,8 +30,11 @@ Gem::Specification.new do |spec|
   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 'rake', '~> 10.0'
-  
+  spec.add_development_dependency 'simplecov', '~> 0.17'
+
   spec.add_runtime_dependency 'http', '~>4.2'
   spec.add_runtime_dependency 'logger', '~>1.4'
+  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.1
+  version: 0.5.3
 platform: ruby
 authors:
 - Adrian Gilbert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-23 00:00:00.000000000 Z
+date: 2019-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: exifr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: Piwigo is open source web application to manage your collection of photos,
   and other medias. Piwigo provides an API for interacting with it. This is a ruby-based
   client for interacting with a Piwigo instance using the Piwigo API.