figshare_api_v2 0.9.12 → 0.9.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdacc011cb5878841de9954d291c86f59aaf164910ec3435a83e60358711e36f
-  data.tar.gz: 18c20792bb04c21295fb32bfd71d512c6f3a5b35388980bbfd777cbb6b6e8995
+  metadata.gz: 11b25c0bb0934846555f86845975c0fd5f7c55db5313ec260324ec66ab77d476
+  data.tar.gz: 8391657d5ab14ba6220e842a23fbd844a9e04c97a4b0734008ba631f713d3a04
 SHA512:
-  metadata.gz: 37a5583b512ca3379a78b826ef527f7e77822420c3d37a2eaa643b0674c029fa5305e4f347ef095e29757fb2d2e6294c52cf6c53fb4f2fe017420715d8e5508b
-  data.tar.gz: 17080406e6798cd8c746017bbb13fd3c96d93aae932ae293ae847d6e23a92a8d646da1495fa945b51924dad2c2346c04f95cceabdcaf2ac95d3ea16799f853bb
+  metadata.gz: c5e2b07cf5169b4ba5576ef9d26e64ef31f156d72509a4ef008cdaa2be59e8b1b2ff9b673416fdf9b340c3939847c8cc7991370174f5105ca8c031e3ea13bf66
+  data.tar.gz: 06a9dcbf5756ac282afb02d3eb6505a3fb9bb3710a5ee3678dd65034802b6fcc23a57e95ddcf8f4766ffeb01ef5f4b6d31f99cce357f68cbdfa8731ce4191e53

data/History.txt

@@ -1,3 +1,13 @@
+robertburrowes	Wed Sep 28 16:01:03 2022 +1300
+	New version number, after several bug fixes
+robertburrowes	Wed Sep 28 15:59:22 2022 +1300
+	Need to add in blocks of 10 articles, or we get an exception.
+robertburrowes	Wed Sep 28 14:45:16 2022 +1300
+	missed block param
+robertburrowes	Wed Sep 28 14:42:14 2022 +1300
+	missed block param
+robertburrowes	Wed Sep 28 11:33:57 2022 +1300
+	added pagination to GET articles. This isn't documented in the API, but is needed when there are more than 10 results.
 robertburrowes	Tue Sep 27 15:40:52 2022 +1300
 	Files all g+r,o+r
 robertburrowes	Tue Sep 27 15:24:24 2022 +1300

data/lib/figshare_api_v2.rb

@@ -1,7 +1,7 @@
 module Figshare # :nodoc:
   # Figshare module initialization
   #
-  VERSION = '0.9.12'
+  VERSION = '0.9.13'
 
   require 'wikk_webbrowser'
   require 'wikk_json'

data/lib/other.rb

@@ -30,7 +30,8 @@ module Figshare
     # Get public categories
     #
     # @yield [Array] [{parent_id:, id:, title:, path:, source_id:, taxonomy_id:}]
-    def public_categories
+    def public_categories(&block)
+      args = {}
       get(api_query: 'categories', &block)
     end
 

data/lib/private_collections.rb

@@ -369,7 +369,9 @@ module Figshare
     def articles(collection_id:, impersonate: nil, &block)
       args = {}
       args['impersonate'] = impersonate unless impersonate.nil?
-      get(api_query: "account/collections/#{collection_id}/articles", args: args, &block)
+      args['offset'] = 0
+      args['limit'] = 100 # Looks to respect this. The default is 10!
+      get_paginate(api_query: "account/collections/#{collection_id}/articles", args: args, &block)
     end
 
     # Get a private article's details (Not a figshare API call. Duplicates PrivateArticles:article_detail)
@@ -389,9 +391,20 @@ module Figshare
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
     # @yield [Hash] { location }
     def articles_add(collection_id:, articles:, impersonate: nil, &block)
+      # Adding articles that are already in the collection causes an error, so we remove the duplicates
+      existing_articles = []
+      self.articles(collection_id: collection_id, impersonate: impersonate) { |a| existing_articles << a['id'] }
+      insert_list = []
+      articles.each { |article| insert_list << article unless existing_articles.include?(article) }
+
       args = {}
       args['impersonate'] = impersonate unless impersonate.nil?
-      post( api_query: "account/collections/#{collection_id}/articles", args: args, data: { articles: articles }, &block)
+      # There is a 10 article limit, for one add. No idea why
+      (0...insert_list.length).step(10) do |offset|
+        eor = offset + 10  # end of range
+        eor = articles.length if eor > articles.length # Truncate range, if beyond end of the array
+        post( api_query: "account/collections/#{collection_id}/articles", args: args, data: { articles: insert_list[offset...eor] }, &block)
+      end
     end
 
     # Get a private article's details (Not a figshare API call. Duplicates PrivateArticles:article_detail)

data/lib/public_articles.rb

@@ -130,7 +130,7 @@ module Figshare
     #
     # @param article_id [Integer] Figshare id of the article
     # @yield [Hash] {id, title, doi, handle, url, published_date}
-    def files(article_id:)
+    def files(article_id:, &block)
       get(api_query: "articles/#{article_id}/files", &block)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: figshare_api_v2
 version: !ruby/object:Gem::Version
-  version: 0.9.12
+  version: 0.9.13
 platform: ruby
 authors:
 - Rob Burrowes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-27 00:00:00.000000000 Z
+date: 2022-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wikk_json