figshare_api_v2 0.9.7 → 0.9.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a86e2853e1c2c18bf91ac4c3bd5052969bdf6924ea5fb3c7e89c47e6b3269c17
-  data.tar.gz: 4a27f7e8c20b0e9bbdc6227b7f0a0d85ab68f66e8ff8870c9d62754976dddc12
+  metadata.gz: 1b02d428dc8877f75c9bf9ba05d54b1465944745ec2ff1ca0c962bc6803cdc0a
+  data.tar.gz: 6095dffd50dbd105b0ccadeffd3f9243c0434f44cb79bcec32872008add97fab
 SHA512:
-  metadata.gz: dc319835c9ce246e14d9b221bff575af8aa05b70e782b12d674b17f858ff2cfd309f1535ca0e371dea3f5ce23b33d26d64721dd786eb2085cde995aa213d370d
-  data.tar.gz: '01970e2696c5a5f969463d38446a7a658e12f0e8cabad2704fc5fb00202058891ef7748d5993540e7da24da6ebea4081f8322917493141bd491329608c98800a'
+  metadata.gz: 59456d19b2df1624bd7f276c6672326ce888fa967f51ff8aace4b8317ac67990e579aaa85affcd098f4b390b46073353df479d50cd9a65b1b690e04d2a96fcc1
+  data.tar.gz: c06980357bed4295c410ae9f08a04de00108620647268445990c8d7c5a82221d4d824c0a32e1baa08918f9be9c628057afce07dca3c5da2b0013258f1258e485

data/History.txt

@@ -1,3 +1,69 @@
+robertburrowes	Fri May 13 08:40:05 2022 +1200
+	Bumped minor version
+robertburrowes	Thu May 12 17:25:07 2022 +1200
+	Moved the accounts_wrapper() into institution.accounts(), less the debugging stuff
+robertburrowes	Thu May 12 17:06:48 2022 +1200
+	Comment
+robertburrowes	Thu May 12 16:52:57 2022 +1200
+	Check returned account IDs are in order (they do seem to be)
+robertburrowes	Thu May 12 16:32:58 2022 +1200
+	Incorporate the new id_gte into institute.accounts, as page/page_size pagination has a 9000 record limit.
+robertburrowes	Thu May 12 16:22:48 2022 +1200
+	return earlier, in _paginate, to not set 'page'
+robertburrowes	Thu May 12 15:56:44 2022 +1200
+	Added 'once_only' to the post and get _pagination calls, so we don't automatically move onto the next page.
+robertburrowes	Thu May 12 11:18:45 2022 +1200
+	Refactored _pagination response code to see if it helped fix the duplicate record issue. It didn't.
+robertburrowes	Thu May 12 09:43:45 2022 +1200
+	Added debug output of updated Figshare API.
+robertburrowes	Wed May 11 09:07:42 2022 +1200
+	update comments
+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

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

@@ -71,32 +71,53 @@ 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 get_paginate(api_query:, args: {}, debug: false, by_offset: false, &block)
+    private def get_paginate(api_query:, args: {}, debug: false, by_offset: false, once_only: 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' unless args.is_a?(Hash)
+
+      by_offset = true if args['page'].nil? && ! args['offset'].nil?
+      if by_offset
+        # Loop variables, if we are using offsets
+        offset = args['offset'].nil? ? 0 : args['offset']
+        limit = args['limit'].nil? ? 100 : args['limit']
+        args['offset'] = offset
+        args['limit'] = limit
+      else
+        page = args['page'].nil? ? 1 : args['page']
+        page_size = args['page_size'].nil? ? 100 : args['page_size']
+        args['page'] = page
+        args['page_size'] = page_size
       end
 
-      offset = 0
-      page = 1
-      limit = page_size = 100
+      # 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 }
         WIKK::WebBrowser.https_session( host: @hostname, verify_cert: false ) do |ws|
           response = ws.get_page( query: "#{@api_url}#{api_query}",
                                   authorization: "token #{@auth_token}",
-                                  form_values: form_args.merge(args)
+                                  form_values: args
                                 )
           content_type = ws.header_value(key: 'Content-Type')
         end
+        # File.write("/tmp/debug_#{args['id_gte']}_#{page}.json", response)
         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, then mor
+        return result_count if once_only
+
+        if by_offset
+          break if page_count < limit # Got less results than we asked for, so it was the last page
+
+          offset += limit # if we use offset
+          args['offset'] = offset
+        else
+          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
+          args['page'] = page
+        end
       end
 
       return result_count
@@ -147,34 +168,54 @@ 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)
-      page = 1
-      offset = 0
-      limit = page_size = 100
-      result_count = 0
-
+    private def post_paginate(api_query:, args: {}, debug: false, by_offset: false, once_only: false, &block)
+      # Loop variables, if we are using pages
       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' unless args.is_a?(Hash)
+
+      by_offset = true if args['page'].nil? && ! args['offset'].nil?
+      if by_offset
+        # Loop variables, if we are using offsets
+        offset = args['offset'].nil? ? 0 : args['offset']
+        limit = args['limit'].nil? ? 100 : args['limit']
+        args['offset'] = offset
+        args['limit'] = limit
+      else
+        page = args['page'].nil? ? 1 : args['page']
+        page_size = args['page_size'].nil? ? 100 : args['page_size']
+        args['page'] = page
+        args['page_size'] = page_size
       end
 
+      # 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 }
         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
+                                    data: 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
+        return result_count if once_only
+
+        if by_offset
+          break if page_count < limit # Got less results than we asked for, so it was the last page
+
+          offset += limit # if we use offset
+          args['offset'] = offset
+        else
+          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
+          args['page'] = page
+        end
       end
       return result_count
     end
@@ -214,6 +255,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.7'
+  VERSION = '0.9.10'
 
   require 'wikk_webbrowser'
   require 'wikk_json'