piwigo-api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5051a29ebbe23995bb4c2d6436d6534b197f1b3794f7f857e0678e612d544501
-  data.tar.gz: f0c5dc53eede301abf914eb04fecb42e3c607281786939ef51db3dc50a6c8e98
+  metadata.gz: 1108a31f234ef9bb5c9f99091378eb6d6d114eedd26b4e64329e2f803554b612
+  data.tar.gz: c30f56e0cb40c0b93cba86bffcd3d14d5f00d0aec28bd861707f8d8e8ef1406d
 SHA512:
-  metadata.gz: 0fa2225cd04231a474299be116ff723a7ecbc70f44ada895041adfa2e47131663d08f60b399dd2ca98eb5e8f24ebf403195f2ff8aaf929d2e17e63bb7345c7cb
-  data.tar.gz: 4dfb369883eadfe868eaa6853a9c3c70661fef1ad9fd01b57011cf6e30454c5c56caf559f855465939ec9a2c9ab11f7c21a01eb99d6c0c063129441cdef340c1
+  metadata.gz: 71c2c6bd8420c15e1590339612c512e5c589819d005fd0b569f850b8ab7adcdc407d852aadff78cb28d97e6976f1941a232c508dbf1204a42c9691234ab56b52
+  data.tar.gz: c248f198a9d17fa71e29d7e53cd98e89087cb756898139fef94ddcd7ae30956d52c4ecc67fc9efd8a6cc2a93ed7c6c265a0f6deb8e47f85bd2237cf45e37f19e

data/.github/workflows/ruby.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby 2.6
+      uses: actions/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

data/CHANGELOG.md

@@ -6,8 +6,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+0.3.0 - 2019-11-17
+- Added a documentation URL pointing to rubydoc.info
+- Added build badges
+- Added ability to page though the images in an album
+
 0.2.0 - 2019-11-17
-- Refactored the Session to make iteasier to use
+- Refactored the Session to make it easier to use
 - Support adding/deleting & listing albums
 
 0.1.1 - 2019-11-16 

data/README.md

@@ -1,6 +1,8 @@
 # Piwigo-API
 
-Piwigo is open source web application to manage your collection of photos, and other medias. Piwigo provides an API for interacting with it. 
+![](https://github.com/kkdad/piwigo-api/workflows/Ruby/badge.svg) ![](https://github.com/kkdad/piwigo-api/workflows/Ruby%20Gem/badge.svg) [![Gem Version](https://badge.fury.io/rb/piwigo-api.svg)](https://badge.fury.io/rb/piwigo-api)
+
+[Piwigo](https://piwigo.org/) 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.
 
@@ -26,8 +28,7 @@ Just include 'piwigo/session' and the related classes, then querying Piwigo is f
 
 # Get the second album and all of it's children
 
-
-```
+```ruby
 require 'piwigo/session'
 require 'piwigo/albums'
 
@@ -39,8 +40,11 @@ end
 ```
 
 # Add a new album
-```
-session = Piwigo::Session.login('10.100.230.78', 'Adrian', 'secret', https: false) 
+```ruby
+require 'piwigo/session'
+require 'piwigo/albums'
+
+session = Piwigo::Session.login('10.100.230.78', 'Adrian', 'mypassword', https: false) 
 unless session.nil? 
     album = Piwigo::Albums::Album.new
     album.name = "My First Album"
@@ -48,6 +52,19 @@ unless session.nil?
 end
 ```
 
+# List the Contents of an Album
+
+```ruby
+require 'piwigo/session'
+require 'piwigo/images'
+
+session = Piwigo::Session.login('mypiwigo.fqdn', 'Adrian', 'mypassword', https: false) 
+unless session.nil? 
+    results = Piwigo::Images.getImages(session, album_id: 4)
+   
+    results[:images].each { |image| p "#{image.id}, #{image.name} - #{image.element_url}" }
+end
+```
 
 ## Development
 

data/lib/piwigo/albums.rb

@@ -180,8 +180,6 @@ module Piwigo
                 logger.error "Album delete: #{e.messages}"
                 false
             end            
-        end         
-
-
+        end        
     end
 end    

data/lib/piwigo/images.rb

@@ -0,0 +1,117 @@
+require 'net/http'
+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.
+module Piwigo
+    class Images
+        class Image
+            # @return [Number] Unique ID idenifying this ie
+            attr_accessor :id
+
+            # @return [Number] Width of the image in pixels
+            attr_accessor :width
+
+            # @return [Number] Height of the image in pixels
+            attr_accessor :height
+
+            # @return [Number] Number of times the image has been viewed
+            attr_accessor :hit
+
+            # @return [String] Filename for the image
+            attr_accessor :file
+
+            # @return [String] Name of the image
+            attr_accessor :name
+
+            # @return [String] Comments about the image
+            attr_accessor :comment
+
+            # @return [DateTime] DateTime when the image was taken
+            attr_accessor :date_creation
+
+            # @return [DateTime] DateTime when the image was uploaded to Piwigo
+            attr_accessor :date_available
+
+            # @return [String] URL to the image page
+            attr_accessor :page_url
+
+            # @return [String] URL to the image itself
+            attr_accessor :element_url
+
+            # @return [Array<String>] Links to different sizes of the image
+            attr_accessor :derivatives
+
+            # @return [<Type>] List of all of the Albums this image is in
+            attr_accessor :categories
+
+            def initialize(hash: nil)                
+                hash.each { |key, value| send("#{key}=", value) } unless hash.nil?
+            end            
+        end
+
+        class Paging
+            # @return [Number] Page number of the results
+            attr_accessor :page
+
+            # @return [Number] Number of images requesed per page
+            attr_accessor :per_page
+
+            # @return [Number] Number of Images on this page. When this is less then the number per page, then there are no more results.
+            attr_accessor :count
+            
+            # @return [Number] Total number of images across all pages
+            attr_accessor :total_count 
+
+            def initialize(hash: nil)                
+                hash.each { |key, value| send("#{key}=", value) } unless hash.nil?
+            end                     
+        end
+        
+        # Returns elements for the corresponding categories.
+        # order comma separated fields for sorting
+        #
+        # @param [Session] session 
+        # @param [Number] album_id - Can be empty if recursive is true.
+        # @param [Boolean] recursive - Include images from child albums
+        # @param [Number] per_page - Number of items to include per page
+        # @param [Number] page - Page to retrieve
+        # @param [String] order - One or more of id, file, name, hit, rating_score, date_creation, date_available or random
+        # @param [Logger] logger logger to output debug messages to (Optional)        
+        #
+        # @return [Hash] <description>
+        def self.getImages(session, album_id: nil, recursive: nil, per_page: 100, page: 0, order: nil, logger: nil)
+            raise "Invalid session" if session.uri.nil?
+            logger = logger || Logger.new(STDOUT)     
+
+            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.getImages"
+                request.body.concat "&cat_id=#{album_id}" unless album_id.nil?
+                request.body.concat "&recursive=#{recursive}" unless recursive.nil?
+                request.body.concat "&per_page=#{per_page}" unless album_id.nil?
+                request.body.concat "&order=#{order}" unless order.nil?
+                request['Cookie'] = [session.id]
+                
+                # Send the request
+                response = http.request(request) 
+                if response.code == '200'
+                    data = JSON.parse(response.body)
+                    paging = Paging.new hash: data['result']['paging']
+                    images = data['result']['images'].map{ |hash| Image.new(hash: hash) }
+                    logger.info "Image List succeeded: #{images.size} images retrieved."
+                    { :paging => paging, :images => images }
+                else                
+                    nil
+                end                      
+            rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+                logger.error "Image List failed: #{e.messages}"
+                nil
+            end            
+        end          
+
+    end
+end

data/lib/piwigo/version.rb

@@ -1,3 +1,3 @@
 module Piwigo
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/piwigo-api.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/kkdad/piwigo-api"
   spec.metadata["changelog_uri"] = "https://github.com/kkdad/piwigo-api/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "https://rubydoc.info/github/KKDad/piwigo-api/master"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: piwigo-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Adrian Gilbert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-17 00:00:00.000000000 Z
+date: 2019-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,6 +90,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/gempush.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".travis.yml"
 - ".vscode/launch.json"
@@ -103,6 +104,7 @@ files:
 - bin/setup
 - lib/piwigo.rb
 - lib/piwigo/albums.rb
+- lib/piwigo/images.rb
 - lib/piwigo/session.rb
 - lib/piwigo/version.rb
 - piwigo-api.gemspec
@@ -113,6 +115,7 @@ metadata:
   homepage_uri: https://github.com/kkdad/piwigo-api
   source_code_uri: https://github.com/kkdad/piwigo-api
   changelog_uri: https://github.com/kkdad/piwigo-api/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/github/KKDad/piwigo-api/master
 post_install_message: 
 rdoc_options: []
 require_paths: