figshare_api_v2 0.9.2 → 0.9.6

data/lib/private_projects.rb

@@ -1,5 +1,4 @@
 module Figshare
-
   # Figshare private project api
   #
   class PrivateProjects < Base
@@ -13,11 +12,11 @@ module Figshare
     # @yield [Hash] {role, storage, url, published_date, id, title}
     def list(storage: nil, roles: nil, order: 'published_date', order_direction: 'desc', impersonate: nil, &block)
       args = {}
-      args['storage'] = storage if ! storage.nil?
-      args['roles'] = roles if ! roles.nil?
-      args['order'] = order if ! order.nil?
-      args['order_direction'] = order_direction if ! order_direction.nil?
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['storage'] = storage unless storage.nil?
+      args['roles'] = roles unless roles.nil?
+      args['order'] = order unless order.nil?
+      args['order_direction'] = order_direction unless order_direction.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       get_paginate(api_query: 'account/projects', args: args, &block)
     end
 
@@ -31,20 +30,24 @@ module Figshare
     # @param order_direction [String] "desc" Default, "asc"
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
     # @yield [Hash] {id, title, doi, handle, url, published_date}
-    def search(institute: false, group_id: nil, impersonate: nil, 
-                        published_since: nil, modified_since: nil, 
-                        order: 'published_date', order_direction: 'desc',
-                        search_for:,
-                        &block
-                       )
+    def search( search_for:,
+                institute: false,
+                group_id: nil,
+                impersonate: nil,
+                published_since: nil,
+                modified_since: nil,
+                order: 'published_date',
+                order_direction: 'desc',
+                &block
+              )
       args = { 'search_for' => search_for }
-      args['institution'] = @institute_id if ! institute.nil?
-      args['group'] = group_id if ! group_id.nil?
-      args["impersonate"] = impersonate  if ! impersonate.nil?
-      args['published_since'] = published_since if ! published_since.nil?
-      args['modified_since'] = modified_since if ! modified_since.nil?
-      args['order'] = order if ! order.nil?
-      args['order_direction'] = order_direction if ! order_direction.nil?
+      args['institution'] = @institute_id unless institute.nil?
+      args['group'] = group_id unless group_id.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
+      args['published_since'] = published_since unless published_since.nil?
+      args['modified_since'] = modified_since unless modified_since.nil?
+      args['order'] = order unless order.nil?
+      args['order_direction'] = order_direction unless order_direction.nil?
       post(api_query: 'account/projects/search', args: args, &block)
     end
 
@@ -57,27 +60,27 @@ module Figshare
     # #param group_id [Integer] Figshare group the project falls under.
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
     # @yield [Hash] { location }
-    def create(title:, description:, funding: '', funding_list: [], group_id:, impersonate: nil, &block)
-      args = { "title" => title, 
-               "description" => description, 
-               "group_id" => group_id,
-               "funding" => funding,
-               "funding_list" => funding_list
+    def create(title:, description:, group_id:, funding: '', funding_list: [], impersonate: nil, &block)
+      args = { 'title' => title,
+               'description' => description,
+               'group_id' => group_id,
+               'funding' => funding,
+               'funding_list' => funding_list
              }
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       post(api_query: 'account/projects', args: args, &block)
     end
-    
+
     # Delete an existing project
     #
     # @param project_id [Integer] Figshare project ID
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
     def project_delete(project_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
-      delete(api_query: 'account/projects/#{project_id}', args: args, &block)
+      args['impersonate'] = impersonate unless impersonate.nil?
+      delete(api_query: "account/projects/#{project_id}", args: args, &block)
     end
-    
+
     # Return details of specific private project
     #
     # @param project_id [Integer] Figshare id of the project_id
@@ -85,8 +88,8 @@ module Figshare
     # @yield [Hash] See figshare api docs
     def detail(project_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
-      get(api_query: "account/projects/#{project_id}",  args: args, &block)
+      args['impersonate'] = impersonate unless impersonate.nil?
+      get(api_query: "account/projects/#{project_id}", args: args, &block)
     end
 
     # Update an existing project
@@ -100,14 +103,14 @@ module Figshare
     # @yield [Hash] { location }
     def update(project_id:, title: nil, description: nil, funding: nil, funding_list: nil, impersonate: nil, &block)
       args = {}
-      args["title"] = title if ! title.nil? 
-      args["description"] = description if ! description.nil? 
-      args["funding"] = funding if ! funding.nil? 
-      args["funding_list"] = funding_list if ! funding_list.nil? 
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['title'] = title unless title.nil?
+      args['description'] = description unless description.nil?
+      args['funding'] = funding unless funding.nil?
+      args['funding_list'] = funding_list unless funding_list.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       put(api_query: "account/projects/#{project_id}", args: args, &block)
     end
-    
+
     # Publish a project
     #
     # @param project_id [Integer] Figshare id of the project
@@ -115,10 +118,10 @@ module Figshare
     # @yield [Hash] Message
     def publish(project_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       post(api_query: "account/projects/#{project_id}/publish", args: args, &block)
     end
-    
+
     # List projects notes
     #
     # @param project_id [Integer] Figshare id of the project
@@ -126,10 +129,10 @@ module Figshare
     # @yield [Hash] {id, user_id, abstract, user_name, created_date, modified_date}
     def notes(project_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       get_paginate(api_query: "account/projects/#{project_id}/notes", args: args, &block)
     end
-    
+
     # Create a project note
     #
     # @param project_id [Integer] Figshare id of the project
@@ -138,10 +141,10 @@ module Figshare
     # @yield [Hash] { location }
     def note_create(project_id:, text:, impersonate: nil, &block)
       args = { 'text' => text }
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       post(api_query: "account/projects/#{project_id}/notes", args: args, &block)
     end
-    
+
     # Delete a project note
     #
     # @param project_id [Integer] Figshare id of the project
@@ -149,10 +152,10 @@ module Figshare
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
     def note_delete(project_id:, note_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       delete(api_query: "account/projects/#{project_id}/notes/#{note_id}", args: args, &block)
     end
-    
+
     # Get a note's text
     #
     # @param project_id [Integer] Figshare id of the project
@@ -161,31 +164,31 @@ module Figshare
     # @yield [Hash] { text }
     def note_detail(impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       get(api_query: "account/projects/#{project_id}/notes/#{note_id}", args: args, &block)
     end
-    
+
     # update a project note
     #
     # @param project_id [Integer] Figshare id of the project
     # @param note_id [Integer] Figshare id of the note
     # @param text [String] The note
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
-    def note_create(project_id:, note_id:, text:, impersonate: nil, &block)
+    def note_update(project_id:, note_id:, text:, impersonate: nil, &block)
       args = { 'text' => text }
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       put(api_query: "account/projects/#{project_id}/notes/#{note_id}", args: args, &block)
     end
-    
+
     # Leave a project (Please note: project's owner cannot leave the project.)
     #
     # @param project_id [Integer] Figshare id of the project_id
     def private_project_collaborators_leave(project_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       post(api_query: "account/projects/#{project_id}/leave", args: args, &block)
     end
-    
+
     # Get the project collaborators
     #
     # @param project_id [Integer] Figshare id of the project_id
@@ -193,10 +196,10 @@ module Figshare
     # @yield [Hash] { status, role_name, user_id, name }
     def collaborators(project_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       get(api_query: "account/projects/#{project_id}/collaborators", args: args, &block)
     end
-    
+
     # Invite a new collaborators to the project
     #
     # @param project_id [Integer] Figshare id of the project_id
@@ -205,7 +208,7 @@ module Figshare
     # @param email [String] Used, if user_id is nil
     # @param comment [String]
     # @yield [String] { message }
-    def collaborator_invite(project_id:, role_name:, user_id: nil, email: nil, comment:, impersonate: nil, &block)
+    def collaborator_invite(project_id:, role_name:, comment:, user_id: nil, email: nil, impersonate: nil, &block)
       args = {
         'role_name' => role_name,
         'comment' => comment
@@ -215,13 +218,13 @@ module Figshare
       elsif ! email.nil?
         args['email'] = email
       else
-        raise "collaborator_invite(): Need a user_id or an email address" 
+        raise 'collaborator_invite(): Need a user_id or an email address'
       end
-      args["impersonate"] = impersonate  if ! impersonate.nil?
-      collaborator = { "role_name" => role_name, "user_id" => user_id, "email" => email, "comment" => comment }
+      args['impersonate'] = impersonate unless impersonate.nil?
+      collaborator = { 'role_name' => role_name, 'user_id' => user_id, 'email' => email, 'comment' => comment }
       post(api_query: "account/project/#{project_id}/collaborators", args: args, data: collaborator, &block)
     end
-    
+
     # Leave a project (Please note: project's owner cannot leave the project.)
     #
     # @param project_id [Integer] Figshare id of the project_id
@@ -229,10 +232,10 @@ module Figshare
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
     def collaborator_remove(project_id:, user_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       delete(api_query: "account/project/#{project_id}/collaborators/#{user_id}", args: args, &block)
     end
-    
+
     # Return details of list of articles for a specific project
     #
     # @param project_id [Integer] Figshare id of the project
@@ -240,23 +243,22 @@ module Figshare
     # @yield [Hash] See Figshare API Doc
     def articles(project_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       get_paginate(api_query: "account/projects/#{project_id}/articles", args: args, &block)
     end
-    
+
     # Create a new Article and associate it with this project
     #
     # @param project_id [Integer] Figshare id of the project
-    # @param article [Hash] See figshare API docs
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
     # @yield [Hash] { location }
-    def article_create(project_id:, article:, impersonate: nil, &block)
+    def article_create(project_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       # Figshare Docs say this should be post_paginate, but that makes no sense. Will have to test
       post_paginate(api_query: "account/projects/#{project_id}/articles", args: args, &block)
     end
-    
+
     # delete an article from a project
     #
     # @param project_id [Integer] Figshare id of the project
@@ -264,10 +266,10 @@ module Figshare
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
     def article_delete(project_id:, article_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       delete(api_query: "account/projects/#{project_id}/articles/#{article_id}", args: args, &block)
     end
-    
+
     # Get the details of an artilcle in a project
     #
     # @param project_id [Integer] Figshare id of the project
@@ -276,10 +278,10 @@ module Figshare
     # @yield [Hash] See Fishare API docs for article hash
     def article_detail(project_id:, article_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       get(api_query: "account/projects/#{project_id}/articles/#{article_id}", args: args, &block)
     end
-    
+
     # Get the files associated with an artilcle in a project
     #
     # @param project_id [Integer] Figshare id of the project
@@ -288,10 +290,10 @@ module Figshare
     # @yield [Hash] See Fishare API docs for article hash
     def artilce_files(project_id:, article_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       get(api_query: "account/projects/#{project_id}/articles/#{article_id}/files", args: args, &block)
     end
-    
+
     # Get the files associated with an artilcle in a project
     #
     # @param project_id [Integer] Figshare id of the project
@@ -300,9 +302,8 @@ module Figshare
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
     def artilce_file_detail(project_id:, article_id:, file_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       delete(api_query: "account/projects/#{project_id}/articles/#{article_id}/files/#{file_id}", args: args, &block)
     end
-    
-  end # End of class
-end # End of Module
+  end
+end

data/lib/public_articles.rb

@@ -1,9 +1,7 @@
 module Figshare
-
   # Figshare Public Articles API
   #
   class PublicArticles < Base
-  
     # Requests a list of public articles
     #
     # @param institution [Boolean] Just our institution
@@ -17,23 +15,29 @@ module Figshare
     # @param order [String] "published_date" Default, "modified_date", "views", "cites", "shares"
     # @param order_direction [String] "desc" Default, "asc"
     # @yield [Hash] {id, title, doi, handle, url, published_date}
-    def list(institute: false, group_id: nil,
-                        published_since: nil, modified_since: nil, 
-                        item_type: nil, resource_doi: nil, doi: nil, handle: nil,  
-                        order: 'published_date', order_direction: 'desc',
-                        &block
-                        )
+    def list( institute: false,
+              group_id: nil,
+              published_since: nil,
+              modified_since: nil,
+              item_type: nil,
+              resource_doi: nil,
+              doi: nil,
+              handle: nil,
+              order: 'published_date',
+              order_direction: 'desc',
+              &block
+            )
       args = {}
-      args['institution'] = @institute_id  if ! institute.nil?
-      args['group_id'] = group_id if ! group_id.nil?
-      args['item_type'] = item_type if ! item_type.nil?
-      args['resource_doi'] = resource_doi if ! resource_doi.nil?
-      args['doi'] = doi if ! doi.nil?
-      args['handle'] = handle if ! handle.nil?
-      args['published_since'] = published_since if ! published_since.nil?
-      args['modified_since'] = modified_since if ! modified_since.nil?
-      args['order'] = order if ! order.nil?
-      args['order_direction'] = order_direction if ! order_direction.nil?
+      args['institution'] = @institute_id unless institute.nil?
+      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?
+      args['doi'] = doi unless doi.nil?
+      args['handle'] = handle unless handle.nil?
+      args['published_since'] = published_since unless published_since.nil?
+      args['modified_since'] = modified_since unless modified_since.nil?
+      args['order'] = order unless order.nil?
+      args['order_direction'] = order_direction unless order_direction.nil?
       get_paginate(api_query: 'articles', args: args, &block)
     end
 
@@ -50,24 +54,30 @@ module Figshare
     # @param order [String] "published_date" Default, "modified_date", "views", "cites", "shares"
     # @param order_direction [String] "desc" Default, "asc"
     # @yield [Hash] {id, title, doi, handle, url, published_date}
-    def search(institute: false, group_id: nil,
-                              published_since: nil, modified_since: nil, 
-                              item_type: nil, resource_doi: nil, doi: nil, handle: nil,  
-                              order: 'published_date', order_direction: 'desc',
-                              search_for:,
-                              &block
-                             )
+    def search( search_for:,
+                institute: false,
+                group_id: nil,
+                published_since: nil,
+                modified_since: nil,
+                item_type: nil,
+                resource_doi: nil,
+                doi: nil,
+                handle: nil,
+                order: 'published_date',
+                order_direction: 'desc',
+                &block
+              )
       args = { 'search_for' => search_for }
-      args['institution'] = @institute_id if ! institute.nil?
-      args['group_id'] = group_id if ! group_id.nil?
-      args['item_type'] = item_type if ! item_type.nil?
-      args['resource_doi'] = resource_doi if ! resource_doi.nil?
-      args['doi'] = doi if ! doi.nil?
-      args['handle'] = handle if ! handle.nil?
-      args['published_since'] = published_since if ! published_since.nil?
-      args['modified_since'] = modified_since if ! modified_since.nil?
-      args['order'] = order if ! order.nil?
-      args['order_direction'] = order_direction if ! order_direction.nil?
+      args['institution'] = @institute_id unless institute.nil?
+      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?
+      args['doi'] = doi unless doi.nil?
+      args['handle'] = handle unless handle.nil?
+      args['published_since'] = published_since unless published_since.nil?
+      args['modified_since'] = modified_since unless modified_since.nil?
+      args['order'] = order unless order.nil?
+      args['order_direction'] = order_direction unless order_direction.nil?
       post(api_query: 'articles/search', args: args, &block)
     end
 
@@ -76,17 +86,17 @@ module Figshare
     # @param article_id [Integer] Figshare id of the article
     # @yield [Hash] See figshare api docs
     def detail(article_id:, &block)
-      get(api_query: "articles/#{article_id}",  &block)
+      get(api_query: "articles/#{article_id}", &block)
     end
-  
+
     # Return details of list of versions for a specific article
     #
     # @param article_id [Integer] Figshare id of the artcle
     # @yield [Hash] See figshare api docs
     def versions(article_id:, &block)
-      get(api_query: "articles/#{article_id}/versions",  &block)
+      get(api_query: "articles/#{article_id}/versions", &block)
     end
-  
+
     # Return details of specific article version
     #
     # @param article_id [Integer] Figshare id of the article
@@ -94,16 +104,16 @@ module Figshare
     # @param embargo [Boolean] Include only embargoed items
     # @param confidentiality [Boolean] Include only confidential items
     # @yield [Hash] See figshare api docs
-    def version_detail(article_id:, version_id: , embargo: false, confidentiality: false, &block)
-        if embargo
-          get(api_query: "articles/#{article_id}/versions/#{version_id}/embargo",  &block)
-        elsif confidentiality
-          get(api_query: "articles/#{article_id}/versions/#{version_id}/confidentiality",  &block)
-        else
-          get(api_query: "articles/#{article_id}/versions/#{version_id}",  &block)
-        end
+    def version_detail(article_id:, version_id:, embargo: false, confidentiality: false, &block)
+      if embargo
+        get(api_query: "articles/#{article_id}/versions/#{version_id}/embargo", &block)
+      elsif confidentiality
+        get(api_query: "articles/#{article_id}/versions/#{version_id}/confidentiality", &block)
+      else
+        get(api_query: "articles/#{article_id}/versions/#{version_id}", &block)
+      end
     end
-  
+
     # Return details of list of files for a specific articles
     #
     # @param article_id [Integer] Figshare id of the article
@@ -111,7 +121,7 @@ module Figshare
     def files(article_id:)
       get(api_query: "articles/#{article_id}/files", &block)
     end
-  
+
     # Return details of a specific file for a specific articles
     #
     # @param article_id [Integer] Figshare id of the article
@@ -120,6 +130,5 @@ module Figshare
     def file_detail(article_id:, file_id:)
       get(api_query: "articles/#{article_id}/files/#{file_id}", &block)
     end
- 
   end
-end
+end