figshare_api_v2 0.9.5 → 0.9.6

data/lib/public_collections.rb

@@ -1,9 +1,7 @@
 module Figshare
-
   # Figshare public colections api calls
   #
   class PublicCollections < Base
-
     # Requests a list of public collections
     #
     # @param institution [Boolean] Just our institution
@@ -16,25 +14,30 @@ module Figshare
     # @param order [String] "published_date" Default, "modified_date", "views", "cites", "shares"
     # @param order_direction [String] "desc" Default, "asc"
     # @yield [Hash] {id, title, doi, handle, url, published_date}
-    def list(institution: false, group_id: nil,
-                    published_since: nil, modified_since: nil, 
-                    resource_doi: nil, doi: nil, handle: nil,  
-                    order: 'published_date', order_direction: 'desc',
-                    &block
-                  )
+    def list( institution: false,
+              group_id: nil,
+              published_since: nil,
+              modified_since: nil,
+              resource_doi: nil,
+              doi: nil,
+              handle: nil,
+              order: 'published_date',
+              order_direction: 'desc',
+              &block
+            )
       args = {}
-      args['institution'] = @institute_id  if ! institution.nil?
-      args['group'] = group_id if ! group_id.nil?
-      args['resource_doi'] = resource_doi if ! resource_doi.nil?
-      args['doi'] = doi if ! doi.nil?
-      args['handle'] = handle if ! handle.nil?
-      args['published_since'] = published_since if ! published_since.nil?
-      args['modified_since'] = modified_since if ! modified_since.nil?
-      args['order'] = order if ! order.nil?
-      args['order_direction'] = order_direction if ! order_direction.nil?
+      args['institution'] = @institute_id unless institution.nil?
+      args['group'] = group_id unless group_id.nil?
+      args['resource_doi'] = resource_doi unless resource_doi.nil?
+      args['doi'] = doi unless doi.nil?
+      args['handle'] = handle unless handle.nil?
+      args['published_since'] = published_since unless published_since.nil?
+      args['modified_since'] = modified_since unless modified_since.nil?
+      args['order'] = order unless order.nil?
+      args['order_direction'] = order_direction unless order_direction.nil?
       get_paginate(api_query: 'collections', args: args, &block)
     end
-    
+
     # Search within the public collections
     #
     # @param institution [Boolean] Just our institution
@@ -47,24 +50,30 @@ module Figshare
     # @param order [String] "published_date" Default, "modified_date", "views", "cites", "shares"
     # @param order_direction [String] "desc" Default, "asc"
     # @yield [Hash] {id, title, doi, handle, url, published_date}
-    def search( institute: false, group_id: nil,
-                            published_since: nil, modified_since: nil, 
-                            item_type: nil, resource_doi: nil, doi: nil, handle: nil,  
-                            order: 'published_date', order_direction: 'desc',
-                            search_for:,
-                            &block
-                          )
+    def search( search_for:,
+                institute: false,
+                group_id: nil,
+                published_since: nil,
+                modified_since: nil,
+                item_type: nil,
+                resource_doi: nil,
+                doi: nil,
+                handle: nil,
+                order: 'published_date',
+                order_direction: 'desc',
+                &block
+              )
       args = { 'search_for' => search_for }
-      args['institution'] = @institute_id if ! institute.nil?
-      args['group_id'] = group_id if ! group_id.nil?
-      args['item_type'] = item_type if ! item_type.nil?
-      args['resource_doi'] = resource_doi if ! resource_doi.nil?
-      args['doi'] = doi if ! doi.nil?
-      args['handle'] = handle if ! handle.nil?
-      args['published_since'] = published_since if ! published_since.nil?
-      args['modified_since'] = modified_since if ! modified_since.nil?
-      args['order'] = order if ! order.nil?
-      args['order_direction'] = order_direction if ! order_direction.nil?
+      args['institution'] = @institute_id unless institute.nil?
+      args['group_id'] = group_id unless group_id.nil?
+      args['item_type'] = item_type unless item_type.nil?
+      args['resource_doi'] = resource_doi unless resource_doi.nil?
+      args['doi'] = doi unless doi.nil?
+      args['handle'] = handle unless handle.nil?
+      args['published_since'] = published_since unless published_since.nil?
+      args['modified_since'] = modified_since unless modified_since.nil?
+      args['order'] = order unless order.nil?
+      args['order_direction'] = order_direction unless order_direction.nil?
       post(api_query: 'account/articles/search', args: args, &block)
     end
 
@@ -73,7 +82,7 @@ module Figshare
     # @param collection_id [Integer] Figshare id of the collection
     # @yield [Hash] See figshare api docs
     def detail(collection_id:, &block)
-      get(api_query: "collections/#{collection_id}",  &block)
+      get(api_query: "collections/#{collection_id}", &block)
     end
 
     # Return details of a list of public collection Versions
@@ -81,7 +90,7 @@ module Figshare
     # @param collection_id [Integer] Figshare id of the collection
     # @yield [Hash] See figshare api docs
     def versions(collection_id:, &block)
-      get(api_query: "collections/#{collection_id}/versions",  &block)
+      get(api_query: "collections/#{collection_id}/versions", &block)
     end
 
     # Get details of specific collection version
@@ -90,9 +99,9 @@ module Figshare
     # @param version_id [Integer] Figshare id of the collection's version
     # @yield [Hash] See figshare api docs
     def version_detail(collection_id:, version_id:, &block)
-      get(api_query: "collections/#{collection_id}/versions/#{version_id}",  &block)
+      get(api_query: "collections/#{collection_id}/versions/#{version_id}", &block)
     end
-    
+
     # Get details of list of articles for a specific collection
     #
     # @param collection_id [Integer] Figshare id of the collection
@@ -100,6 +109,5 @@ module Figshare
     def articles(collection_id:, &block)
       get_paginate(api_query: "collections/#{collection_id}/articles", &block)
     end
-  end #of class
-  
-end #of module
+  end
+end

data/lib/public_projects.rb

@@ -1,5 +1,4 @@
 module Figshare
-
   # Figshare public projects api
   #
   class PublicProjects < Base
@@ -11,13 +10,13 @@ module Figshare
     # @param order [String] "published_date" Default, "modified_date", "views", "cites", "shares"
     # @param order_direction [String] "desc" Default, "asc"
     # @yield [Hash] {url, published_date, id, title}
-    def list(institute: false,group_id: nil, published_since: nil, order: 'published_date', order_direction: 'desc', &block)
+    def list(institute: false, group_id: nil, published_since: nil, order: 'published_date', order_direction: 'desc', &block)
       args = {}
-      args['institution'] = @institute_id if ! institute.nil?
-      args['group'] = group_id if ! group_id.nil?
-      args['published_since'] = published_since if ! published_since.nil?
-      args['order'] = order if ! order.nil?
-      args['order_direction'] = order_direction if ! order_direction.nil?
+      args['institution'] = @institute_id unless institute.nil?
+      args['group'] = group_id unless group_id.nil?
+      args['published_since'] = published_since unless published_since.nil?
+      args['order'] = order unless order.nil?
+      args['order_direction'] = order_direction unless order_direction.nil?
       get_paginate(api_query: 'projects', args: args, &block)
     end
 
@@ -30,19 +29,22 @@ module Figshare
     # @param order [String] "published_date" Default, "modified_date", "views", "cites", "shares"
     # @param order_direction [String] "desc" Default, "asc"
     # @yield [Hash] {id, title, doi, handle, url, published_date}
-    def search(institute: false, group_id: nil,
-                        published_since: nil, modified_since: nil, 
-                        order: 'published_date', order_direction: 'desc',
-                        search_for:,
-                        &block
-                       )
+    def search( search_for:,
+                institute: false,
+                group_id: nil,
+                published_since: nil,
+                modified_since: nil,
+                order: 'published_date',
+                order_direction: 'desc',
+                &block
+              )
       args = { 'search_for' => search_for }
-      args['institution'] = @institute_id if ! institute.nil?
-      args['group'] = group_id if ! group_id.nil?
-      args['published_since'] = published_since if ! published_since.nil?
-      args['modified_since'] = modified_since if ! modified_since.nil?
-      args['order'] = order if ! order.nil?
-      args['order_direction'] = order_direction if ! order_direction.nil?
+      args['institution'] = @institute_id unless institute.nil?
+      args['group'] = group_id unless group_id.nil?
+      args['published_since'] = published_since unless published_since.nil?
+      args['modified_since'] = modified_since unless modified_since.nil?
+      args['order'] = order unless order.nil?
+      args['order_direction'] = order_direction unless order_direction.nil?
       post(api_query: 'account/projects/search', args: args, &block)
     end
 
@@ -51,7 +53,7 @@ module Figshare
     # @param project_id [Integer] Figshare id of the project_id
     # @yield [Hash] See figshare api docs
     def detail(project_id:, &block)
-      get(api_query: "projects/#{project_id}",  &block)
+      get(api_query: "projects/#{project_id}", &block)
     end
 
     # Get list of articles for a specific project
@@ -61,6 +63,5 @@ module Figshare
     def articles(project_id:, &block)
       get_paginate(api_query: "projects/#{project_id}/articles", &block)
     end
-
-  end # of class
-end # of module
+  end
+end

data/lib/upload.rb

@@ -1,27 +1,27 @@
-module Figshare
+module Figshare # :nodoc:
   require 'digest'
   require 'dir_r'
 
   # Upload files to figshare
   # Nb. This can sometimes fail, so you need to check the md5 to ensure the file got there
   #     It can take a short while for the md5 to be calculated, so upload, wait, then check for a computed_md5.
-  #     The status will show as "ic_checking",  "moving_to_final" then to "available", 
+  #     The status will show as "ic_checking",  "moving_to_final" then to "available",
   #     I have seen it stuck at "moving_to_final", but with the right computed_md5.
   #
   class Upload < PrivateArticles
     CHUNK_SIZE = 1048576
-    attr_accessor :file_info, :upload_query, :upload_host, :upload_parts_detail , :file_id, :article_id, :file_name
+    attr_accessor :file_info, :upload_query, :upload_host, :upload_parts_detail, :file_id, :article_id, :file_name
     attr_accessor :new_count, :bad_count
-  
+
     # Calculate a local files MD5.
     #
     # @param filename [String] Path/name of local file to MD5
     # @return [String,Integer] MD5 as a Hex String, Size of the file in bytes.
     def self.get_file_check_data(filename)
-      stat_record =  File.stat(filename)
+      stat_record = File.stat(filename)
       md5 = Digest::MD5.new
       File.open(filename, 'rb') do |fd|
-        while(buffer = fd.read(CHUNK_SIZE)) 
+        while (buffer = fd.read(CHUNK_SIZE))
           md5.update(buffer)
         end
       end
@@ -37,31 +37,31 @@ module Figshare
       @article_id = article_id
       @file_name = file_name
       @trace = trace
-      
+
       @file_id = nil
       @file_info = nil
       @upload_query = nil
       @upload_host = nil
-      @upload_parts_detail  = nil
-      
-      initiate_new_upload() 
+      @upload_parts_detail = nil
+
+      initiate_new_upload
       puts "New File_id: #{@file_id}\n\n" if @trace > 1
-      
-      get_file_info()
+
+      get_file_info
       puts "@file_info: #{@file_info.to_j}\n\n" if @trace > 1
-      
-      get_upload_parts_details()
+
+      get_upload_parts_details
       puts "@upload_parts_detail: #{@upload_parts_detail.to_j}\n\n" if @trace > 1
-      
-      upload_the_parts()
-      
-      complete_upload()
+
+      upload_the_parts
+
+      complete_upload
       if @trace > 1
         status
         puts "Final Status: #{@file_info.to_j}\n\n"
       end
     end
-    
+
     # Upload all files in a directory, into one article.
     # Check checksums, and only upload changed or new files
     # Does not recurse through sub-directories, as figshare has a flat file structure.
@@ -73,16 +73,17 @@ module Figshare
     def upload_dir(article_id:, directory:, delete_extras: false, exclude_dot_files: true, trace: 0)
       @new_count = 0
       @bad_count = 0
-      
+
       files = {}
       cache_article_file_md5(article_id: article_id)
-      
-      DirR.walk_dir(directory: directory, walk_sub_directories: false) do |d,f|
+
+      DirR.walk_dir(directory: directory, walk_sub_directories: false) do |d, f|
         next if exclude_dot_files && f =~ /^\..*/
-        files[f] = true  #note that we have seen this filename
-        if @md5_cache[f] #check to see if it has already been uploaded
-          md5, size = Upload.get_file_check_data("#{d}/#{f}")
-          if @md5_cache[f][:md5] != md5 #file is there, but has changed, or previously failed to upload.
+
+        files[f] = true  # NOTE: that we have seen this filename
+        if @md5_cache[f] # check to see if it has already been uploaded
+          md5, _size = Upload.get_file_check_data("#{d}/#{f}")
+          if @md5_cache[f][:md5] != md5 # file is there, but has changed, or previously failed to upload.
             puts "Deleting: #{article_id} << #{d}/#{f} #{@md5_cache[f][:id]} MISMATCH '#{@md5_cache[f]}' != '#{md5}'" if trace > 0
             file_delete(article_id: article_id, file_id: @md5_cache[f][:id])
             @bad_count += 1
@@ -98,16 +99,16 @@ module Figshare
           @new_count += 1
         end
       end
-      
+
       # Print out filename of files in the Figshare article, that weren't in the directory.
-      @md5_cache.each do |fn,v|
-        if ! files[fn]  
-          #File exists on Figshare, but not on the local disk
+      @md5_cache.each do |fn, v|
+        if ! files[fn]
+          # File exists on Figshare, but not on the local disk
           if delete_extras
             puts "Deleteing EXTRA: #{article_id} << #{fn} #{v[:id]}" if trace > 0
-            file_delete(article_id: article_id, file_id: @md5_cache[f][:id]) 
+            file_delete(article_id: article_id, file_id: @md5_cache[f][:id])
           elsif trace > 0
-            puts "EXTRA: #{article_id} << #{fn} #{v[:id]}" 
+            puts "EXTRA: #{article_id} << #{fn} #{v[:id]}"
           end
         end
       end
@@ -115,16 +116,16 @@ module Figshare
 
     # Retrieve md5 sums of the existing files in the figshare article
     # Sets @md5_cache[filename] => figshare.computed_md5
-    # 
+    #
     # @param article_id [Integer] Figshare article ID
     private def cache_article_file_md5(article_id:)
       @md5_cache = {}
       files(article_id: article_id) do |f|
-        @md5_cache[f['name']] = {:article_id => article_id, :id => f['id'], :md5 => f[ 'computed_md5']}
+        @md5_cache[f['name']] = { article_id: article_id, id: f['id'], md5: f['computed_md5'] }
       end
     end
-    
-    # Get status of the current upload. 
+
+    # Get status of the current upload.
     # Just fetches the file record from figshare.
     # Of interest is the status field, and the computed_md5 field
     #
@@ -134,33 +135,35 @@ module Figshare
       file_detail(article_id: @article_id, file_id: @file_id) do |f|
         @file_info = f
       end
-      raise "Upload::status(): Failed to get figshare file record" if @file_info.nil?
+      raise 'Upload::status(): Failed to get figshare file record' if @file_info.nil?
     end
-   
+
     # Creates a new Figshare file record, in the figshare article, and we get the file_id from the upload URL
     # file status == 'created'
     #
     private def initiate_new_upload
       md5, size = Upload.get_file_check_data(@file_name)
-      args = {'name' => File.basename(@file_name),
-              'md5' => md5,
-              'size'=> size
+      args = { 'name' => File.basename(@file_name),
+               'md5' => md5,
+               'size' => size
              }
       post( api_query: "account/articles/#{@article_id}/files", args: args ) do |f|
         @file_id = f['location'].gsub(/^.*\/([0-9]+)$/, '\1')
       end
-      raise "Upload::initiate_new_upload(): failed to create Figshare file record" if @file_id.nil?
+      raise 'Upload::initiate_new_upload(): failed to create Figshare file record' if @file_id.nil?
     end
-   
+
     # Gets the Figshare file info
     # We need the upload URLs to continue
     #
+    # rubocop:disable Naming/AccessorMethodName This isn't an accessor method.
     private def get_file_info
       status
       @upload_host = @file_info['upload_url'].gsub(/^http.*\/\/(.*)\/upload.*$/, '\1')
       @upload_query = @file_info['upload_url'].gsub(/^http.*\/\/(.*)\/(upload.*)$/, '\2')
       puts "Upload_host: #{@upload_host} URL: #{@upload_query}" if @trace > 1
     end
+    # rubocop:enable Naming/AccessorMethodName This isn't an accessor method.
 
     # Completes the upload.
     # Figshare then calculates the md5 in the background, which may take a while to complete
@@ -168,24 +171,27 @@ module Figshare
     #
     private def complete_upload
       post( api_query: "account/articles/#{@article_id}/files/#{@file_id}" )
-      puts "complete_upload" if @trace > 1
+      puts 'complete_upload' if @trace > 1
     end
 
     # Get the upload settings
     #
+    # rubocop:disable Naming/AccessorMethodName This isn't an accessor method.
     private def get_upload_parts_details
       @upload_parts_detail = nil
       result = nil
       WIKK::WebBrowser.https_session( host: @upload_host, verify_cert: false ) do |ws|
         result = ws.get_page( query: @upload_query,
-                              authorization: "token #{@auth_token}",
+                              authorization: "token #{@auth_token}"
                             )
       end
       raise "get_upload_parts_detail(#{@article_id}) failed to get upload URL" if result.nil?
+
       @upload_parts_detail = JSON.parse(result)
-      
+
       puts "Part URL #{@upload_parts_detail['parts']}" if @trace > 1
     end
+    # rubocop:enable Naming/AccessorMethodName This isn't an accessor method.
 
     # Upload the file in parts
     #
@@ -210,6 +216,5 @@ module Figshare
                   )
       end
     end
-
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: figshare_api_v2
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors:
 - Rob Burrowes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-16 00:00:00.000000000 Z
+date: 2021-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wikk_json
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.22'
+        version: '3.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.22'
+        version: '3.23'
 description: Figshare version 2 API.
 email:
 - r.burrowes@auckland.ac.nz