figshare_api_v2 0.9.6 → 0.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a7584ac8d8eb3bd0c1750eccfd3568eef74781b1bb3c5d3c3cce12fe17affab
-  data.tar.gz: 3d10aed08ec5bbb2b4f9534510e478d70c4ec3f20b2674e073c33249d9e6b56e
+  metadata.gz: 5a59303e131674b6b915f07bf0e0aa317a3d5d594c8e87586fe273d8ed83697d
+  data.tar.gz: b8bdb004509e69e295b110f60f98ac6da83ea2ea3c5d2bf72e9d46ec041d274a
 SHA512:
-  metadata.gz: 141ffdc6d2487e5febd08fd547f2836efadd0b3d55907ba9e025f61846efed48c6e8382c52c0729b85093c5916a5c9569f5fa1adcc08d8650ef132f450ddc46f
-  data.tar.gz: cf73c9713e16b66e782ef79246a8f7422166d8ae8f06318d34f9fff2bd8bd517af9b1116050604c4ce4e58841b62590f87f4706384578f0f0b808726bc7d3373
+  metadata.gz: ebdcee71baa8b80d0c434c9c041255a8843c897574c00725c60c288670854c0d3bce3e404805f03201951b981148ea8bfc49acf465b686af75cabd2bd47655f9
+  data.tar.gz: 5cdd11942289e5cb75e4e09afd730ebd12209b161fc68221aa5dadc347a90fc04370d9af464c419b69ed7cb794097254d796cd318ffc9957402cd3736728328b

data/History.txt

@@ -1,3 +1,57 @@
+robertburrowes	Tue May 10 10:42:27 2022 +1200
+	Comment
+robertburrowes	Tue May 10 10:40:02 2022 +1200
+	Left out the pagination args
+robertburrowes	Tue May 10 10:27:57 2022 +1200
+	API changes
+robertburrowes	Tue May 10 10:21:39 2022 +1200
+	API changes
+robertburrowes	Tue May 10 10:11:50 2022 +1200
+	API changes Added missed &block
+robertburrowes	Tue May 10 09:27:50 2022 +1200
+	Api changes
+robertburrowes	Tue May 10 09:27:27 2022 +1200
+	Missed adding _paginate
+robertburrowes	Tue May 10 09:26:58 2022 +1200
+	Use offset for paginatioon, if only the offset is passed in.
+robertburrowes	Mon May 9 17:06:07 2022 +1200
+	Add an HTML PATCH wrapper
+robertburrowes	Mon May 9 16:57:06 2022 +1200
+	Readme update
+robertburrowes	Mon May 9 16:54:56 2022 +1200
+	Bump version for new Figshare APIs.
+robertburrowes	Mon May 9 16:53:27 2022 +1200
+	API changes Fixed URL collection article
+robertburrowes	Mon May 9 16:52:47 2022 +1200
+	fixed param type
+robertburrowes	Mon May 9 16:17:56 2022 +1200
+	API changes
+robertburrowes	Mon May 9 14:55:40 2022 +1200
+	Ignore test script
+robertburrowes	Mon May 9 14:54:41 2022 +1200
+	+x
+robertburrowes	Mon May 9 14:54:11 2022 +1200
+	Include tags pushing to github
+robertburrowes	Mon May 9 14:52:11 2022 +1200
+	API updates
+robertburrowes	Mon May 9 14:39:15 2022 +1200
+	API additions/response changes. Added page/page_size Fixed some string quotes Fixed URL mistypings
+robertburrowes	Mon May 9 12:36:08 2022 +1200
+	Added setting pagination params from the args
+robertburrowes	Mon May 9 11:46:21 2022 +1200
+	Search has pagination
+robertburrowes	Thu Dec 23 12:20:05 2021 +1300
+	Fixed Institutions::hr_upload
+robertburrowes	Tue Nov 2 14:49:47 2021 +1300
+	hr upload is post, not put
+robertburrowes	Tue Nov 2 13:12:30 2021 +1300
+	Saner initialization option :)
+robertburrowes	Tue Sep 21 13:03:44 2021 +1200
+	Experimenting with fetching user accounts. Finding a 9000 limit on the total responses, resulting in odd differences in the numbers between  fetching everyone, just active, and just inactive accounts. None of which match using the figshare admin web pages
+robertburrowes	Tue Sep 21 13:01:16 2021 +1200
+	Rubocop'd
+robertburrowes	Tue Sep 21 13:00:57 2021 +1200
+	Rubocop'd Added chdir, so Atom starts in the right dir
 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

data/README.md

@@ -7,7 +7,9 @@
 
 ## DESCRIPTION:
 
-Figshare version 2 API. 
+Figshare version 2 API.
+
+Actually the second version of the version 2 APIs. Lots of changes have been made by Figshare, mostly expanding what is returned from the API calls, but they also added some fields. Looks mostly backwards compatible.
 
 ## FEATURES/PROBLEMS:
 
@@ -71,4 +73,3 @@ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

data/lib/authors.rb

@@ -4,13 +4,17 @@ module Figshare
   class Authors < Base
     # Search authors
     #
-    # @param institution [Boolean] Just our institution
-    # @param group_id [Integer] Only return this group's collections
+    # @param institution [Boolean] Just our institution. We have already stored the institute_id.
     # @param orcid [String] Matches this orcid
+    # @param group_id [Integer] Only return this group's collections
     # @param is_active [Boolean]
     # @param is_public [Boolean]
     # @param order [String] "published_date" Default, "modified_date", "views", "cites", "shares"
     # @param order_direction [String] "desc" Default, "asc"
+    # @param page [Numeric] Pages start at 1. Page and Page size go together
+    # @param page_size [Numeric]
+    # @param offset [Numeric] offset is 0 based.  Offset and Limit go together
+    # @param limit [Numeric]
     # @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( search_for:,
                 institute: false,
@@ -20,6 +24,10 @@ module Figshare
                 is_public: true,
                 order: 'published_date',
                 order_direction: 'desc',
+                page: nil,
+                page_size: nil,
+                offset: nil,
+                limit: nil,
                 &block
               )
       args = { 'search_for' => search_for }
@@ -30,7 +38,11 @@ module Figshare
       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)
+      args['page'] = page unless page.nil?
+      args['page_size'] = page_size unless page_size.nil?
+      args['offset'] = offset unless offset.nil?
+      args['limit'] = limit unless limit.nil?
+      post_paginate(api_query: 'account/authors/search', args: args, &block)
     end
 
     # Get an authors details
@@ -38,7 +50,7 @@ module Figshare
     # @param author_id [Integer] Figshare Author ID
     # @yield [Hash] {id, first_name, last_name, full_name, url_name, is_active, is_public, orcid_id, institution_id, group_id, job_title}
     def detail(author_id:, &block)
-      get(api_query: "account/authors/#{author_id}",  &block)
+      get(api_query: "account/authors/#{author_id}", &block)
     end
   end
 end

data/lib/base.rb

@@ -13,12 +13,19 @@ module Figshare
     # Opens a connection to the LDAP server, setting @ldap for other methods to use.
     #
     # @param figshare_user [String] figshare user, in the figshare_keys.json
-    # @param conf_dir [String] directory for figshare_keys.json and figshare_site_params.json
-    def initialize(figshare_user:, conf_dir:)
-      figshare_token = load_json_file("#{conf_dir}/figshare_keys.json")
+    # @param conf_dir [String|nil] directory for figshare_keys.json and figshare_site_params.json
+    # @param key_file [String|nil] conf_dir/figshare_keys.json if nil
+    # @param conf_file [String|nil] conf_dir/figshare_site_params.json if nil
+    def initialize(figshare_user:, conf_dir: nil, key_file: nil, conf_file: nil)
+      raise 'Figshare_api_v2.initialize: Need to specify the conf_dir if key_file or conf_file are nil' if conf_dir.nil? && (key_file.nil? || conf_file.nil?)
+
+      conf_file ||= "#{conf_dir}/figshare_site_params.json"
+      key_file ||= "#{conf_dir}/figshare_keys.json"
+
+      figshare_token = load_json_file(key_file)
       @auth_token = figshare_token[figshare_user]
 
-      figshare_site_params = load_json_file("#{conf_dir}/figshare_site_params.json")
+      figshare_site_params = load_json_file(conf_file)
 
       @hostname = figshare_site_params['host']
       @api_url = figshare_site_params['api_url']
@@ -70,10 +77,19 @@ module Figshare
         raise 'get_paginate(): Expecting args to be a Hash'
       end
 
-      offset = 0
-      page = 1
-      limit = page_size = 100
+      # Loop variables, if we are using pages
+      page = args['page'].nil? ? 1 : args['page']
+      page_size = args['page_size'].nil? ? 100 : args['page_size']
+
+      # Loop variables, if we are using offsets
+      offset = args['offset'].nil? ? 0 : args['offset']
+      limit = args['limit'].nil? ? 100 : args['limit']
+
+      by_offset = true if args['page'].nil? && ! args['offset'].nil?
+
+      # How many results so far.
       result_count = 0
+
       loop do
         content_type = response = nil
         form_args = by_offset ? { 'limit' => limit, 'offset' => offset } : { 'page_size' => page_size, 'page' => page }
@@ -141,11 +157,19 @@ module Figshare
     # @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)
-      page = 1
-      offset = 0
-      limit = page_size = 100
+      # Loop variables, if we are using pages
+      page = args['page'].nil? ? 1 : args['page']
+      page_size = args['page_size'].nil? ? 100 : args['page_size']
+
+      # Loop variables, if we are using offsets
+      offset = args['offset'].nil? ? 0 : args['offset']
+      limit = args['limit'].nil? ? 100 : args['limit']
+
+      # How many results so far.
       result_count = 0
 
+      by_offset = true if args['page'].nil? && ! args['offset'].nil?
+
       args = {} if args.nil?
       if ! args.is_a?(Hash)
         raise 'post_paginate(): Expecting args to be a Hash'
@@ -207,6 +231,41 @@ module Figshare
       return iterate_json_response(response: response, content_type: content_type, debug: debug, &block)
     end
 
+    # Patch 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)
+    #
+    # @param api_query [String] base figshare api call, to which we add parameters defined in args
+    # @param args [Hash] Key, value pairs which get converted to ?key=arg&key=arg...
+    # @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
+    private def patch(api_query:, args: {}, data: nil, debug: false, content_type: 'application/json; charset=UTF-8', &block)
+      body = 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.patch_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)
+    end
+
     # delete sends an HTML DELETE request.
     # We don't expect to get a response to this call.
     #

data/lib/figshare_api_v2.rb

@@ -1,7 +1,7 @@
 module Figshare # :nodoc:
   # Figshare module initialization
   #
-  VERSION = '0.9.6'
+  VERSION = '0.9.9'
 
   require 'wikk_webbrowser'
   require 'wikk_json'
@@ -33,94 +33,98 @@ module Figshare # :nodoc:
     # Intitialize the Init class, so it can dynamically initialize the Figshare subclasses
     #
     # @param figshare_user [String] figshare user, in the figshare_keys.json
-    # @param conf_dir [String] directory for figshare_keys.json and figshare_site_params.json
-    def initialize(figshare_user:, conf_dir:)
+    # @param conf_dir [String|nil] directory for figshare_keys.json and figshare_site_params.json
+    # @param key_file [String|nil] conf_dir/figshare_keys.json if nil
+    # @param conf_file [String|nil] conf_dir/figshare_site_params.json if nil
+    def initialize(figshare_user:, conf_dir: nil, key_file: nil, conf_file: nil)
       @figshare_user = figshare_user
       @conf_dir = conf_dir
+      @key_file = key_file
+      @conf_file = conf_file
     end
 
     # Create Figshare::Authors, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::Authors]
     def authors
-      @authors ||= Authors.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+      @authors ||= Authors.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     end
 
     # Create Figshare::Institutions, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::Institutions]
     def institutions
-      @institutions ||= Institutions.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+      @institutions ||= Institutions.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     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)
+      @other ||= Other.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     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)
+      @private_articles ||= PrivateArticles.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     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)
+      @private_collections ||= PrivateCollections.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     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)
+      @private_projects ||= PrivateProjects.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     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)
+      @public_articles ||= PublicArticles.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     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)
+      @public_collections ||= PublicCollections.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     end
 
     # Create Figshare::PublicProjects, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::PublicProjects]
     def public_projects
-      @public_projects ||= PublicProjects.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+      @public_projects ||= PublicProjects.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     end
 
     # Create Figshare::Upload, if it doesn't exist. Initialized with @figshare_user and @conf_dir
     #
     # @return [Figshare::Upload]
     def upload
-      @upload ||= Upload.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+      @upload ||= Upload.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     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)
+      @stats ||= Stats.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     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)
+      @oai_pmh ||= OAI_PMH.new(figshare_user: @figshare_user, conf_dir: @conf_dir, key_file: @key_file, conf_file: @conf_file)
     end
   end
 end