figshare_api_v2 0.9.10 → 0.9.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b02d428dc8877f75c9bf9ba05d54b1465944745ec2ff1ca0c962bc6803cdc0a
-  data.tar.gz: 6095dffd50dbd105b0ccadeffd3f9243c0434f44cb79bcec32872008add97fab
+  metadata.gz: 1dc7e3baa60bb192090e8237e1439c3ad7100450ce253707f61b13a1fae0f3cf
+  data.tar.gz: d1890373d6110f860a42ea2f21c2cd2a698df7bcc0aa9d9de60f813768745d09
 SHA512:
-  metadata.gz: 59456d19b2df1624bd7f276c6672326ce888fa967f51ff8aace4b8317ac67990e579aaa85affcd098f4b390b46073353df479d50cd9a65b1b690e04d2a96fcc1
-  data.tar.gz: c06980357bed4295c410ae9f08a04de00108620647268445990c8d7c5a82221d4d824c0a32e1baa08918f9be9c628057afce07dca3c5da2b0013258f1258e485
+  metadata.gz: 7c920fbae1eae2d5a84c072c2ff1e4eaa0e7b480314bc6333e2e3e5ebd34bdc5d8bc4b793284a8564ba410cdbe5d989324202e29857d93b85b673bceff4d51a8
+  data.tar.gz: 60ac5fdf5584a90966d8512701b61a2baace0d23f6889ee21213f6d6428d65f3120cf66589818b336693cc6a1f33f898c80af06e8b770c37d47cedf5d3148a35

data/History.txt

@@ -1,3 +1,19 @@
+robertburrowes	Tue Sep 27 15:24:24 2022 +1300
+	Added in collection handling. Shifted author processing to figshare library
+robertburrowes	Tue Sep 27 14:39:31 2022 +1300
+	Authors shoud be an array of Hash records.
+robertburrowes	Tue Sep 27 14:39:06 2022 +1300
+	Added body() for creating the body Hash needed for creating a new Collection
+robertburrowes	Tue Sep 27 14:38:25 2022 +1300
+	typo in name
+robertburrowes	Tue Sep 27 12:11:20 2022 +1300
+	Bumped version for 'institute' needing to be an Integer in json
+robertburrowes	Tue Sep 27 12:09:20 2022 +1300
+	institute has to be an Integer. A string now generates an exception
+robertburrowes	Tue Sep 27 09:04:43 2022 +1300
+	Debugging bulk user info request. Still getting inconsistent numbers of users being returned.
+robertburrowes	Tue Sep 27 09:03:55 2022 +1300
+	Testing what comes back
 robertburrowes	Fri May 13 08:40:05 2022 +1200
 	Bumped minor version
 robertburrowes	Thu May 12 17:25:07 2022 +1200

data/lib/authors.rb

@@ -31,7 +31,7 @@ module Figshare
                 &block
               )
       args = { 'search_for' => search_for }
-      args['institution'] = @institute_id unless institute.nil?
+      args['institution'] = @institute_id.to_i if institute
       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?

data/lib/figshare_api_v2.rb

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

data/lib/private_articles.rb

@@ -67,7 +67,7 @@ module Figshare
               )
       args = { 'search_for' => search_for }
       args['impersonate'] = impersonate unless impersonate.nil?
-      args['institution'] = @institute_id unless institute.nil? # Inconsistent use. Other calls use institute_id
+      args['institution'] = @institute_id.to_i if institute # Inconsistent use. Other calls use institute_id
       args['group'] = group_id unless group_id.nil? # Not sure if this changed from group_id to group
       args['item_type'] = item_type unless item_type.nil?
       args['resource_id'] = resource_id unless resource_id.nil?
@@ -138,7 +138,17 @@ module Figshare
       body_['references'] = references unless references.nil?
       body_['categories'] = categories unless categories.nil?
       body_['categories_by_source_id'] = categories_by_source_id unless categories_by_source_id.nil?
-      body_['authors'] = authors unless authors.nil?
+      authors_array = []
+      if authors.instance_of?(Array)
+        authors.each do |author|
+          authors_array << if author.instance_of?(Hash)
+                             author
+                           else
+                             { 'name' => author }
+                           end
+        end
+      end
+      body_['authors'] = authors_array
       body_['custom_fields'] = custom_fields unless custom_fields.nil?
       body_['custom_fields_list'] = custom_fields_list unless custom_fields_list.nil?
       body_['defined_type'] = defined_type unless defined_type.nil?

data/lib/private_collections.rb

@@ -70,7 +70,7 @@ module Figshare
               )
       args = { 'search_for' => search_for }
       args['impersonate'] = impersonate unless impersonate.nil?
-      args['institution'] = @institute_id unless institute.nil?
+      args['institution'] = @institute_id.to_i if institute
       args['group'] = group_id unless group_id.nil?
       args['resource_id'] = resource_id unless resource_id.nil?
       args['resource_doi'] = resource_doi unless resource_doi.nil?
@@ -87,6 +87,89 @@ module Figshare
       post_paginate(api_query: 'account/collections/search', args: args, &block)
     end
 
+    # Create a body for use with create and update methods
+    #
+    # @param title [String] Required
+    # @param description [String] The article description. In a publisher case, usually this is the remote article description
+    # @param tags [Array] List of tags (strings) to be associated with the article. Tags can be used instead
+    # @param keywords [Array] List of tags (strings) to be associated with the article. Tags can be used instead
+    # @param references [Array] List of links to be associated with the article (e.g ["http://link1", "http://link2", "http://link3"])
+    # @param categories [Array] List of category ids to be associated with the article(e.g [1, 23, 33, 66])
+    # @param categories_by_source_id [Array] List of category ids to be associated with the article(e.g ["300204", "400207"])
+    # @param authors [Array] List of authors to be associated with the article. The list can contain the following fields: id, name, first_name, last_name, email, orcid_id. If an id is supplied, it will take priority and everything else will be ignored. No more than 10 authors. For adding more authors use the specific authors endpoint. e.g. { "name" => "Joe X"} and or { "id" => 123 }
+    # @param custom_fields [Hash] List of key, values pairs to be associated with the article. eg. { "key" => "value"}
+    # @param custom_fields_list [Array] List of key, values pairs to be associated with the article. eg. [{ "key" => "value"}]
+    # @param defined_type [String] one of "figshare","media","dataset","poster","journal contribution", "presentation", "thesis", "software", "online resource", "preprint", "book", "conference contribution", "chapter", "peer review", "educational resource", "report", "standard", "composition", "funding", "physical object", "data management plan", "workflow", "monograph", "performance", "event", "service", "model", "registration"
+    # @param funding [String] Grant number or funding authority
+    # @param funding_list [Array] Funding creation / update items. eg {"id" => 0, "title" => "string"}
+    # @param license [Integer] License id for this article.
+    # @param doi [String] Not applicable for regular users. In an institutional case, make sure your group supports setting DOIs. This setting is applied by figshare via opening a ticket through our support/helpdesk system.
+    # @param handle [String] Not applicable for regular users. In an institutional case, make sure your group supports setting Handles. This setting is applied by figshare via opening a ticket through our support/helpdesk system.
+    # @param resource_doi [String] Not applicable to regular users. In a publisher case, this is the publisher article DOI.
+    # @param resource_title [String] Not applicable to regular users. In a publisher case, this is the publisher article title.
+    # @param timeline [Hash] Various timeline dates ie. { "firstOnline" => "date_string", "publisherPublication" => "date_string", "publisherAcceptance" => "date_string"},
+    # @param group_id [Integer] Not applicable to regular users. This field is reserved to institutions/publishers with access to assign to specific groups
+    def body( title:,
+              description: nil,
+              is_metadata_record: nil,
+              metadata_reason: nil,
+              tags: nil,
+              keywords: nil,
+              references: nil,
+              categories: nil,
+              categories_by_source_id: nil,
+              authors: nil,
+              custom_fields: nil,
+              custom_fields_list: nil,
+              defined_type: nil,
+              funding: nil,
+              funding_list: nil,
+              license: nil,
+              doi: nil,
+              handle: nil,
+              resource_doi: nil,
+              resource_title: nil,
+              timeline: nil,
+              group_id: nil
+            )
+      body_ = {
+        'title' => title
+      }
+      body_['description'] = description unless description.nil?
+      body_['is_metadata_record'] = is_metadata_record unless is_metadata_record.nil?
+      body_['metadata_reason'] = metadata_reason unless metadata_reason.nil?
+      body_['tags'] = tags unless tags.nil?
+      body_['keywords'] = keywords unless keywords.nil?
+      body_['references'] = references unless references.nil?
+      body_['categories'] = categories unless categories.nil?
+      body_['categories_by_source_id'] = categories_by_source_id unless categories_by_source_id.nil?
+      authors_array = []
+      if authors.instance_of?(Array)
+        authors.each do |author|
+          authors_array << if author.instance_of?(Hash)
+                             author
+                           else
+                             { 'name' => author }
+                           end
+        end
+      end
+      body_['authors'] = authors_array
+      body_['custom_fields'] = custom_fields unless custom_fields.nil?
+      body_['custom_fields_list'] = custom_fields_list unless custom_fields_list.nil?
+      body_['defined_type'] = defined_type unless defined_type.nil?
+      body_['funding'] = funding unless funding.nil?
+      body_['funding_list'] = funding_list unless funding_list.nil?
+      body_['license'] = license unless license.nil?
+      body_['doi'] = doi unless doi.nil?
+      body_['handle'] = handle unless handle.nil?
+      body_['resource_doi'] = resource_doi unless resource_doi.nil?
+      body_['resource_title'] = resource_title unless resource_title.nil?
+      body_['timeline'] = timeline unless timeline.nil?
+      body_['group_id'] = group_id unless group_id.nil?
+
+      return body_
+    end
+
     # Create a new private Collection by sending collection information
     #
     # @param body [Hash] See Figshare API docs
@@ -133,7 +216,7 @@ module Figshare
     #
     # @param collection_id [Integer] Figshare id of the collection
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
-    # @yield [Hash] { doi }
+    # @yield [Hash] { "doi" => "the_doi" }
     def reserve_doi(collection_id:, impersonate: nil, &block)
       args = {}
       args['impersonate'] = impersonate unless impersonate.nil?

data/lib/private_projects.rb

@@ -63,7 +63,7 @@ module Figshare
                 &block
               )
       args = { 'search_for' => search_for }
-      args['institution'] = @institute_id unless institute.nil?
+      args['institution'] = @institute_id.to_i if institute
       args['group'] = group_id unless group_id.nil?
       args['impersonate'] = impersonate unless impersonate.nil?
       args['published_since'] = published_since unless published_since.nil?

data/lib/public_articles.rb

@@ -36,7 +36,7 @@ module Figshare
               &block
             )
       args = {}
-      args['institution'] = @institute_id unless institute.nil?
+      args['institution'] = @institute_id.to_i if institute
       args['group_id'] = group_id unless group_id.nil?  # Not sure if this should be 'group' or 'group_id'. API has conflicting info
       args['item_type'] = item_type unless item_type.nil?
       args['resource_doi'] = resource_doi unless resource_doi.nil?
@@ -80,7 +80,7 @@ module Figshare
                 &block
               )
       args = { 'search_for' => search_for }
-      args['institution'] = @institute_id unless institute.nil?
+      args['institution'] = @institute_id.to_i if institute
       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?

data/lib/public_collections.rb

@@ -4,7 +4,7 @@ module Figshare
   class PublicCollections < Base
     # Requests a list of public collections
     #
-    # @param institution [Boolean] Just our institution
+    # @param institute [Boolean] Just our institution
     # @param group_id [Integer] Only return this group's collections
     # @param published_since [Time] Return results if published after this time
     # @param modified_since [Time] Return results if modified after this time
@@ -18,7 +18,7 @@ module Figshare
     # @param offset [Numeric] offset is 0 based.  Offset and Limit go together
     # @param limit [Numeric]
     # @yield [Hash] {id, title, doi, handle, url, published_date}
-    def list( institution: false,
+    def list( institute: false,
               group_id: nil,
               published_since: nil,
               modified_since: nil,
@@ -34,7 +34,7 @@ module Figshare
               &block
             )
       args = {}
-      args['institution'] = @institute_id unless institution.nil?
+      args['institution'] = @institute_id.to_i if institute
       args['group'] = group_id unless group_id.nil?
       args['resource_doi'] = resource_doi unless resource_doi.nil?
       args['doi'] = doi unless doi.nil?
@@ -76,7 +76,7 @@ module Figshare
                 &block
               )
       args = { 'search_for' => search_for }
-      args['institution'] = @institute_id unless institute.nil?
+      args['institution'] = @institute_id.to_i if institute
       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?

data/lib/public_projects.rb

@@ -26,7 +26,7 @@ module Figshare
               &block
             )
       args = {}
-      args['institution'] = @institute_id unless institute.nil?
+      args['institution'] = @institute_id.to_i if institute
       args['group'] = group_id unless group_id.nil?
       args['published_since'] = published_since unless published_since.nil?
       args['order'] = order unless order.nil?
@@ -57,7 +57,7 @@ module Figshare
                 &block
               )
       args = { 'search_for' => search_for }
-      args['institution'] = @institute_id unless institute.nil?
+      args['institution'] = @institute_id.to_i if institute
       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?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: figshare_api_v2
 version: !ruby/object:Gem::Version
-  version: 0.9.10
+  version: 0.9.11
 platform: ruby
 authors:
 - Rob Burrowes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-12 00:00:00.000000000 Z
+date: 2022-09-27 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.23'
+        version: '3.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.23'
+        version: '3.25'
 description: |-
   Figshare version 2 API.
 
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Figshare version 2 API