figshare_api_v2 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e35222cd91463f8b07d07968964587e8d979c937d82f8910f6975b3d57d9934
-  data.tar.gz: b6a7f81dc93cae897a554071106b3eed9827e1f2fc8dc5b7fede1c04c9ed0081
+  metadata.gz: 36c39b92b903060de17387c48901a4fe606938a50361549c3981013c962ebae6
+  data.tar.gz: d67537244545182b7d7075b8dbe1ce19480aad7ad13af441289f5a7b7959ffd1
 SHA512:
-  metadata.gz: bfaf7209932807418f286899b17b7bbbd8f289f2835a2b6bb4c0eafd67aae9f1b8b9f5b7dcbaa5f348cc97eb2d35ab86a502c82cf739637f2578801e0cf8e8d6
-  data.tar.gz: f601643c473fa166e6cd47942943a3933dc266669b977232fcbcdd249c9d97b71f39a03cb9499b763cfcab704f5bc3c1cd024e3d6360b7ee2dccf3a02cb334fb
+  metadata.gz: ca3d9efee24f0e8a4d07573e46d35c1518b4461506093a75d73f0179fd90185e1a311704420ee74dcea5f70b4a900bbc434eac187978a323c310799683f13b6b
+  data.tar.gz: 20e43ce7f22338c3dcf96c8fe371f4c5c66a020b21bd0bd5ac23e04718039c619aeceb81ecfb73ff02261cae5220ef21a94871a1f174d329ef3cd29b1d66279c

data/History.txt

@@ -1,3 +1,7 @@
+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
+	more testing
 robertburrowes	Tue Dec 1 13:19:01 2020 +1300
 	bump build version
 robertburrowes	Tue Dec 1 13:18:27 2020 +1300

data/lib/figshare_api_v2.rb

@@ -1,5 +1,5 @@
 module Figshare
-  VERSION = '0.9.4'
+  VERSION = '0.9.5'
 
   require "wikk_webbrowser"
   require "wikk_json"

data/lib/institutions.rb

@@ -176,9 +176,9 @@ module Figshare
     # @param institution_user_id [String] As set in the HR upload
     # @param email [String] as set in the HR upload
     # @yield [Hash] {id, first_name, last_name, institution_id, email, active, institution_user_id}
-    def account_search(search_for:, is_active: nil, institution_user_id: nil, email: nil, &block)
+    def account_search(search_for: nil, is_active: nil, institution_user_id: nil, email: nil, &block)
       args = {}
-      args['search_for'] = search_for
+      args['search_for'] = search_for unless search_for.nil?
       args['is_active'] = is_active  if ! is_active.nil?
       args['institution_user_id'] = institution_user_id if ! institution_user_id.nil?
       args['email'] = email if ! email.nil?

data/lib/private_articles.rb

@@ -51,14 +51,59 @@ module Figshare
       post(api_query: 'account/articles/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 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 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 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, keywords: nil, references: nil, categories: nil, authors: nil, custom_fields: 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, contact: nil)
+      _body = {
+        'title' => title
+      }
+      _body['description'] = description unless description.nil? 
+      _body['keywords'] = keywords unless keywords.nil? 
+      _body['references'] = references unless references.nil? 
+      _body['categories'] = categories unless categories.nil? 
+      _body['authors'] = authors unless authors.nil? 
+      _body['custom_fields'] = custom_fields unless custom_fields.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 Article by sending article information
+    # The user calling the API (or impersonated user) looks to be added as an author, even if they aren't. 
+    # A duplicate "Author" entry occurs when adding them explicitly
     #
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
     # @yield [Hash] { location }
-    def create(impersonate: nil, &block)
+    def create(body:, impersonate: nil, &block)
       args = {}
       args["impersonate"] = impersonate  if ! impersonate.nil?
-      post(api_query: "account/articles/#{article_id}", args: args, &block)
+      post(api_query: "account/articles", args: args, data: body, &block)
     end
 
     # Delete an article (WARNING!!!!!)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: figshare_api_v2
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - Rob Burrowes
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-01 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wikk_json
@@ -112,7 +112,7 @@ homepage: https://UoA-eResearch.github.io/figshare_api_v2/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--markup"
 - markdown
@@ -133,8 +133,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Figshare version 2 API.
 test_files: []