figshare_api_v2 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36c39b92b903060de17387c48901a4fe606938a50361549c3981013c962ebae6
-  data.tar.gz: d67537244545182b7d7075b8dbe1ce19480aad7ad13af441289f5a7b7959ffd1
+  metadata.gz: 1a7584ac8d8eb3bd0c1750eccfd3568eef74781b1bb3c5d3c3cce12fe17affab
+  data.tar.gz: 3d10aed08ec5bbb2b4f9534510e478d70c4ec3f20b2674e073c33249d9e6b56e
 SHA512:
-  metadata.gz: ca3d9efee24f0e8a4d07573e46d35c1518b4461506093a75d73f0179fd90185e1a311704420ee74dcea5f70b4a900bbc434eac187978a323c310799683f13b6b
-  data.tar.gz: 20e43ce7f22338c3dcf96c8fe371f4c5c66a020b21bd0bd5ac23e04718039c619aeceb81ecfb73ff02261cae5220ef21a94871a1f174d329ef3cd29b1d66279c
+  metadata.gz: 141ffdc6d2487e5febd08fd547f2836efadd0b3d55907ba9e025f61846efed48c6e8382c52c0729b85093c5916a5c9569f5fa1adcc08d8650ef132f450ddc46f
+  data.tar.gz: cf73c9713e16b66e782ef79246a8f7422166d8ae8f06318d34f9fff2bd8bd517af9b1116050604c4ce4e58841b62590f87f4706384578f0f0b808726bc7d3373

data/History.txt

@@ -1,3 +1,39 @@
+robertburrowes	Mon Sep 20 12:31:26 2021 +1200
+	Test for listing all institutional accounts, and getting individual account quota.
+robertburrowes	Mon Sep 20 12:30:34 2021 +1200
+	Ran through Rubocop to clean up formatting, picking up a few error in quote usage; extra args; and other misc errors.
+robertburrowes	Thu Sep 2 16:26:24 2021 +1200
+	Reserve DOIs
+robertburrowes	Thu Sep 2 16:22:36 2021 +1200
+	Reworked, to check if articles already exist and to reserve DOIs.
+robertburrowes	Thu Sep 2 16:20:53 2021 +1200
+	Look for duplicate files in the source directories.
+robertburrowes	Thu Sep 2 16:17:02 2021 +1200
+	Fetch article IDs, if the conf file has them set to 0
+robertburrowes	Sat Apr 24 09:17:14 2021 +1200
+	check local dir against figshare
+robertburrowes	Thu Apr 22 12:31:17 2021 +1200
+	exclude sub test dir
+robertburrowes	Thu Apr 22 12:31:06 2021 +1200
+	missing ,
+robertburrowes	Thu Apr 22 12:30:49 2021 +1200
+	delete tmp test scripts
+robertburrowes	Fri Mar 19 13:54:58 2021 +1300
+	tests of creation of articles, and upload, using config file
+robertburrowes	Fri Mar 19 13:54:18 2021 +1300
+	Iterate across just last upload
+robertburrowes	Fri Mar 19 13:51:08 2021 +1300
+	Look for duplicate files within upload set, as defined by upload config file
+robertburrowes	Fri Mar 19 13:26:46 2021 +1300
+	hash to json naming changes
+robertburrowes	Fri Mar 19 13:24:00 2021 +1300
+	changes from hash to json naming
+robertburrowes	Fri Mar 19 13:17:26 2021 +1300
+	run from json config file, to test this works
+robertburrowes	Fri Mar 19 13:15:52 2021 +1300
+	Creating generic upload, that uses json config
+robertburrowes	Thu Mar 18 11:59:15 2021 +1300
+	Testing with Peter and Danes articles
 robertburrowes	Tue Mar 16 14:08:00 2021 +1300
 	private articles create was broken: Added private article body method
 robertburrowes	Tue Dec 1 14:43:50 2020 +1300

data/lib/authors.rb

@@ -12,23 +12,27 @@ module Figshare
     # @param order [String] "published_date" Default, "modified_date", "views", "cites", "shares"
     # @param order_direction [String] "desc" Default, "asc"
     # @yield [Hash] {id, first_name, last_name, full_name, url_name, is_active, is_public, orcid_id, institution_id, group_id, job_title}
-    def search(institute: false, group_id: nil, orcid: nil,
-                is_active: true, is_public: true,  
-                order: 'published_date', order_direction: 'desc',
-                search_for:,
+    def search( search_for:,
+                institute: false,
+                group_id: nil,
+                orcid: nil,
+                is_active: true,
+                is_public: true,
+                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['is_active'] = is_active if ! is_active.nil?
-      args['is_public'] = is_public if ! is_public.nil?
-      args['orcid'] = orcid if ! orcid.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['is_active'] = is_active unless is_active.nil?
+      args['is_public'] = is_public unless is_public.nil?
+      args['orcid'] = orcid unless orcid.nil?
+      args['order'] = order unless order.nil?
+      args['order_direction'] = order_direction unless order_direction.nil?
       post(api_query: 'account/authors/search', args: args, &block)
     end
-    
+
     # Get an authors details
     #
     # @param author_id [Integer] Figshare Author ID
@@ -37,5 +41,4 @@ module Figshare
       get(api_query: "account/authors/#{author_id}",  &block)
     end
   end
-
 end

data/lib/base.rb

@@ -1,4 +1,4 @@
-module Figshare  
+module Figshare
   # Supporting web calls to the API
   #
   class Base
@@ -8,7 +8,7 @@ module Figshare
     attr_accessor :hostname
     attr_accessor :api_url
     attr_accessor :institute_id
-  
+
     # Init reads the Json configuration files, setting @course_codes_to_faculty and @academic_department_code_to_faculty
     # Opens a connection to the LDAP server, setting @ldap for other methods to use.
     #
@@ -17,14 +17,14 @@ module Figshare
     def initialize(figshare_user:, conf_dir:)
       figshare_token = load_json_file("#{conf_dir}/figshare_keys.json")
       @auth_token = figshare_token[figshare_user]
-    
+
       figshare_site_params = load_json_file("#{conf_dir}/figshare_site_params.json")
-    
+
       @hostname = figshare_site_params['host']
       @api_url = figshare_site_params['api_url']
       @institute_id = figshare_site_params['institute_id']
     end
-  
+
     # Parse the config file
     #
     # @param filename [String] config file name to parse
@@ -32,7 +32,7 @@ module Figshare
     private def load_json_file(filename)
       JSON.parse(File.read(filename))
     end
-  
+
     # get iterates through the API response, yielding each value to the passed block
     # When Figshare API usually has no paging option.
     # If there is no block, then the results are printed (useful for debugging)
@@ -67,16 +67,16 @@ module Figshare
     private def get_paginate(api_query:, args: {}, debug: false, by_offset: false, &block)
       args = {} if args.nil?
       if ! args.is_a?(Hash)
-      raise "get_paginate(): Expecting args to be a Hash"
+        raise 'get_paginate(): Expecting args to be a Hash'
       end
- 
+
       offset = 0
       page = 1
       limit = page_size = 100
       result_count = 0
       loop do
         content_type = response = nil
-        form_args = by_offset ? {"limit"=>limit, "offset"=>offset} : {"page_size"=>page_size, "page"=>page}
+        form_args = by_offset ? { 'limit' => limit, 'offset' => offset } : { 'page_size' => page_size, 'page' => page }
         WIKK::WebBrowser.https_session( host: @hostname, verify_cert: false ) do |ws|
           response = ws.get_page( query: "#{@api_url}#{api_query}",
                                   authorization: "token #{@auth_token}",
@@ -88,10 +88,10 @@ module Figshare
         result_count += page_count
         break if page_count < page_size # Got less results than we asked for, so it was the last page
 
-        page += 1 #Ready to fetch next page
-        offset += limit #if we use offset, then mor
+        page += 1 # Ready to fetch next page
+        offset += limit # if we use offset, then mor
       end
-      
+
       return result_count
     end
 
@@ -105,26 +105,26 @@ module Figshare
     # @param content_type [String] Assuming Json, but might need binary ('application/octet-stream')
     # @yield [String] if given a block, iterates through the result from figshare
     # @return [Integer] number of results.
-    private def post(api_query:, args: {}, data: nil, debug: false, content_type: 'application/json; charset=UTF-8', &block)      
+    private def post(api_query:, args: {}, data: nil, debug: false, content_type: 'application/json; charset=UTF-8', &block)
       body = nil
-      if data.is_a?(Hash)
-        # Convert hash to json, and merge in additional args
-        body = data.merge(args).to_j
-      elsif data.nil? && ! args.empty?
-        # No data, but args, so just use the args
-        body = args.to_j
-      else
-        # Data isn't a Hash, so just pass it through (might be nil)
-        body = data
-      end
-      
-      content_type = response = nil
+      body = if data.is_a?(Hash)
+               # Convert hash to json, and merge in additional args
+               data.merge(args).to_j
+             elsif data.nil? && ! args.empty?
+               # No data, but args, so just use the args
+               args.to_j
+             else
+               # Data isn't a Hash, so just pass it through (might be nil)
+               data
+             end
+
+      response = nil
       WIKK::WebBrowser.https_session( host: @hostname, verify_cert: false ) do |ws|
         response = ws.post_page(  query: "#{@api_url}#{api_query}",
                                   content_type: content_type,
                                   authorization: "token #{@auth_token}",
                                   data: body
-                              )
+                               )
         content_type = ws.header_value(key: 'Content-Type')
       end
       return iterate_json_response(response: response, content_type: content_type, debug: debug, &block)
@@ -140,34 +140,34 @@ module Figshare
     # @param by_offset [Boolean] use offset/limit rather than page/page_size in API calls
     # @yield [String] if given a block, iterates through the result from figshare
     # @return [Integer] number of results.
-    private def post_paginate(api_query:, args: {}, debug: false, by_offset: false,  &block)
+    private def post_paginate(api_query:, args: {}, debug: false, by_offset: false, &block)
       page = 1
       offset = 0
       limit = page_size = 100
       result_count = 0
-      
+
       args = {} if args.nil?
       if ! args.is_a?(Hash)
-       raise "post_paginate(): Expecting args to be a Hash"
+        raise 'post_paginate(): Expecting args to be a Hash'
       end
-      
+
       loop do
         content_type = response = nil
-        form_args = by_offset ? {"limit"=>limit, "offset"=>offset} : {"page_size"=>page_size, "page"=>page}
+        form_args = by_offset ? { 'limit' => limit, 'offset' => offset } : { 'page_size' => page_size, 'page' => page }
         WIKK::WebBrowser.https_session( host: @hostname, verify_cert: false ) do |ws|
           response = ws.post_page(  query: "#{@api_url}#{api_query}",
                                     content_type: 'application/json; charset=UTF-8',
                                     authorization: "token #{@auth_token}",
                                     data: args.merge(form_args).to_j
-                                  )
+                                 )
           content_type = ws.header_value(key: 'Content-Type')
         end
         page_count = iterate_json_response(response: response, content_type: content_type, debug: debug, &block)
         result_count += page_count
         break if page_count < page_size # Got less results than we asked for, so it was the last page
 
-        page += 1 #Ready to fetch next page
-        offset += limit #if we use offset
+        page += 1 # Ready to fetch next page
+        offset += limit # if we use offset
       end
       return result_count
     end
@@ -181,27 +181,27 @@ module Figshare
     # @param debug [Boolean] print result to stdout
     # @param content_type [String] Assuming Json, but might need binary ('application/octet-stream')
     # @yield [String] if given a block, iterates through the result from figshare
-    # @return [Integer] number of results 
+    # @return [Integer] number of results
     private def put(api_query:, args: {}, data: nil, debug: false, content_type: 'application/json; charset=UTF-8', &block)
       body = nil
-      if data.is_a?(Hash)
-        # Convert hash to json, and merge in additional args
-        body = data.merge(args).to_j
-      elsif data.nil? && ! args.empty?
-        # No data, but args, so just use the args
-        body = args.to_j
-      else
-        # Data isn't a Hash, so just pass it through (might be nil)
-        body = data
-      end
+      body = if data.is_a?(Hash)
+               # Convert hash to json, and merge in additional args
+               data.merge(args).to_j
+             elsif data.nil? && ! args.empty?
+               # No data, but args, so just use the args
+               args.to_j
+             else
+               # Data isn't a Hash, so just pass it through (might be nil)
+               data
+             end
 
-      content_type = response = nil
+      response = nil
       WIKK::WebBrowser.https_session( host: @hostname, verify_cert: false ) do |ws|
-        response = ws.put_page( query: "#{@api_url}#{api_query}",
-                                content_type: content_type,
-                                authorization: "token #{@auth_token}",
-                                data: body
-                              )
+        response = ws.put_req( query: "#{@api_url}#{api_query}",
+                               content_type: content_type,
+                               authorization: "token #{@auth_token}",
+                               data: body
+                             )
         content_type = ws.header_value(key: 'Content-Type')
       end
       return iterate_json_response(response: response, content_type: content_type, debug: debug, &block)
@@ -214,18 +214,18 @@ module Figshare
     # @param debug [Boolean] print result to stdout
     # @yield [Hash] Unlikely to have a result from delete calls, but if we do, we see it here
     # @return [Integer] number of results (usually 0)
-    private def delete(api_query:, args: {}, debug: false, &block)
-      #ignoring args for the moment. Not sure what to do with them, if we do get them.
-      content_type = response = nil
+    private def delete(api_query:, args: {}, debug: false, content_type: 'application/json; charset=UTF-8', &block)
+      response = nil
       WIKK::WebBrowser.https_session( host: @hostname, verify_cert: false ) do |ws|
         response = ws.delete_req( query: "#{@api_url}#{api_query}",
-                                authorization: "token #{@auth_token}"
-                              )
+                                  authorization: "token #{@auth_token}",
+                                  form_values: args
+                                )
         content_type = ws.header_value(key: 'Content-Type')
       end
       return iterate_json_response(response: response, content_type: content_type, debug: debug, &block)
     end
-    
+
     # For iterate through the api response
     #
     # @param response [String] response from the API call
@@ -234,25 +234,25 @@ module Figshare
     # @yield [Hash] each array member in the response (or the entire response, if not iteratable)
     private def iterate_json_response(response:, content_type:, debug: false )
       return 0 if response.nil? # got no responses
-      
+
       if content_type =~ /application\/json/
         response_array = JSON.parse(response)
-        #If we don't have an Array, turn the response into an Array so we can iterate over this one response.
-        response_array = [ response_array ] if ! (response_array.class == Array)
+        # If we don't have an Array, turn the response into an Array so we can iterate over this one response.
+        response_array = [ response_array ] unless response_array.instance_of?(Array)
         return 0 if response_array.empty? # got empty array of responses
-            
+
         count = 0
         response_array.each do |r|
           yield r if block_given?
           p r if debug
           count += 1
         end
-    
+
         return count
-      else #just dump the entire response on the caller :)
-        yield response  if block_given?
+      else # just dump the entire response on the caller :)
+        yield response if block_given?
         return response.length
       end
     end
   end
-end
+end

data/lib/figshare_api_v2.rb

@@ -1,8 +1,10 @@
-module Figshare
-  VERSION = '0.9.5'
+module Figshare # :nodoc:
+  # Figshare module initialization
+  #
+  VERSION = '0.9.6'
 
-  require "wikk_webbrowser"
-  require "wikk_json"
+  require 'wikk_webbrowser'
+  require 'wikk_json'
   require 'time'
 
   require_relative 'base.rb'
@@ -18,8 +20,8 @@ module Figshare
   require_relative 'upload.rb'
   require_relative 'stats.rb'
   require_relative 'oai_pmh.rb'
-  
-  # Hack :) to do a lazy initialization of the Figshare subclasses. i.e. only if they get called.
+
+  # HACK: to do a lazy initialization of the Figshare subclasses. i.e. only if they get called.
   # Usage:
   #  @figshare = Figshare::Init.new(figshare_user: 'figshare_admin', conf_dir: "#{__dir__}/conf")
   #
@@ -36,7 +38,7 @@ module Figshare
       @figshare_user = figshare_user
       @conf_dir = conf_dir
     end
-    
+
     # Create Figshare::Authors, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::Authors]
@@ -50,49 +52,49 @@ module Figshare
     def institutions
       @institutions ||= Institutions.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
     end
-    
+
     # Create Figshare::Other, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::Other]
     def other
       @other ||= Other.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
     end
-    
+
     # Create Figshare::PrivateArticles, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::PrivateArticles]
     def private_articles
       @private_articles ||= PrivateArticles.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
     end
-    
+
     # Create Figshare::PrivateCollections, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::PrivateCollections]
     def private_collections
       @private_collections ||= PrivateCollections.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
     end
-    
+
     # Create Figshare::PrivateProjects, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::PrivateProjects]
     def private_projects
       @private_projects ||= PrivateProjects.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
     end
-    
+
     # Create Figshare::PublicArticles, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::PublicArticles]
     def public_articles
       @public_articles ||= PublicArticles.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
     end
-    
+
     # Create Figshare::PublicCollections, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::PublicCollections]
     def public_collections
       @public_collections ||= PublicCollections.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
     end
-    
+
     # Create Figshare::PublicProjects, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::PublicProjects]
@@ -106,20 +108,19 @@ module Figshare
     def upload
       @upload ||= Upload.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
     end
-    
+
     # Create Figshare::Stats, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::Stats]
     def stats
       @stats ||= Stats.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
     end
-    
+
     # Create Figshare::OAI_PMH, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::OAI_PMH]
     def oai_pmh
       @oai_pmh ||= OAI_PMH.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
     end
-    
   end
-end # module
+end