figshare_api_v2 0.9.2 → 0.9.6

data/lib/private_collections.rb

@@ -1,9 +1,7 @@
 module Figshare
-
   # Figshare Private Collections API
   #
   class PrivateCollections < Base
-  
     # Requests a list of own (or institute's) collections
     #
     # @param order [String] "published_date" Default, "modified_date", "views", "cites", "shares"
@@ -12,9 +10,9 @@ module Figshare
     # @yield [Hash] {id, title, doi, handle, url, published_date}
     def list(order: 'published_date', order_direction: 'desc', impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
-      args['order'] = order if ! order.nil?
-      args['order_direction'] = order_direction if ! order_direction.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
+      args['order'] = order unless order.nil?
+      args['order_direction'] = order_direction unless order_direction.nil?
       get_paginate(api_query: 'account/collections', args: args, &block)
     end
 
@@ -31,35 +29,41 @@ 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, 
-                              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,
+                impersonate: nil,
+                published_since: nil,
+                modified_since: nil,
+                resource_doi: nil,
+                doi: nil,
+                handle: nil,
+                order: 'published_date',
+                order_direction: 'desc',
+                &block
+              )
       args = { 'search_for' => search_for }
-      args["impersonate"] = impersonate  if ! impersonate.nil?
-      args['institution'] = @institute_id if ! institute.nil?
-      args['group_id'] = group_id if ! group_id.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['impersonate'] = impersonate unless impersonate.nil?
+      args['institution'] = @institute_id unless institute.nil?
+      args['group_id'] = group_id unless group_id.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: 'account/collections/search', args: args, &block)
     end
-  
+
     # Create a new private Collection by sending collection information
     #
     # @param body [Hash] See Figshare API docs
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
     def create(body:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
-      post(api_query: "account/collections", args: args, data: body, &block)
+      args['impersonate'] = impersonate unless impersonate.nil?
+      post(api_query: 'account/collections', args: args, data: body, &block)
     end
 
     # Delete a private collection
@@ -68,7 +72,7 @@ module Figshare
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
     def collection_delete(collection_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       delete( api_query: "account/collections/#{collection_id}/files/#{file_id}", args: args, &block )
     end
 
@@ -79,10 +83,10 @@ module Figshare
     # @yield [Hash] See figshare api docs
     def detail(collection_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       get(api_query: "account/collections/#{collection_id}", args: args, &block)
     end
-  
+
     # Create a new private Collection by sending collection information
     #
     # @param collection_id [Integer] Figshare id of the collection
@@ -90,10 +94,10 @@ module Figshare
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
     def update(collection_id:, body:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
-      put(api_query: "account/collections", args: args, data: body, &block)
-    end  
-    
+      args['impersonate'] = impersonate unless impersonate.nil?
+      put(api_query: "account/collections/#{collection_id}", args: args, data: body, &block)
+    end
+
     # Reserve DOI for collection
     #
     # @param collection_id [Integer] Figshare id of the collection
@@ -101,8 +105,8 @@ module Figshare
     # @yield [Hash] { doi }
     def reserve_doi(collection_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
-      post(api_query: 'account/collections/#{collection_id}/reserve_doi', args: args, &block)
+      args['impersonate'] = impersonate unless impersonate.nil?
+      post(api_query: "account/collections/#{collection_id}/reserve_doi", args: args, &block)
     end
 
     # Reserve Handle for collection
@@ -112,12 +116,12 @@ module Figshare
     # @yield [Hash] { handle }
     def reserve_handle(collection_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
-      post(api_query: 'account/collections/#{collection_id}/reserve_handle', args: args, &block)
+      args['impersonate'] = impersonate unless impersonate.nil?
+      post(api_query: "account/collections/#{collection_id}/reserve_handle", args: args, &block)
     end
 
-    # When a collection is published, a new public version will be generated. 
-    # Any further updates to the collection will affect the private collection data. 
+    # When a collection is published, a new public version will be generated.
+    # Any further updates to the collection will affect the private collection data.
     # In order to make these changes publicly visible, an explicit publish operation is needed.
     #
     # @param collection_id [Integer] Figshare id of the collection
@@ -125,8 +129,8 @@ module Figshare
     # @yield [Hash] { location }
     def publish(collection_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
-      post(api_query: 'account/collections/#{collection_id}/publish', args: args, &block)
+      args['impersonate'] = impersonate unless impersonate.nil?
+      post(api_query: "account/collections/#{collection_id}/publish", args: args, &block)
     end
 
     # Yield collections authors
@@ -134,9 +138,9 @@ 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] {id, full_name, is_active, url_name, orcid_id}
-    def authors(article_id, impersonate: nil, &block)
+    def authors(_article_id, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       get(api_query: "account/collections/#{collection_id}/authors", args: args, &block)
     end
 
@@ -146,34 +150,34 @@ module Figshare
     # @param authors [Array] Can be a mix of { id } and/or { name }
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
     # @yield [Hash] { location }
-    def authors_add(article_id, impersonate: nil, authors:)
+    def authors_add(_article_id, authors:, impersonate: nil)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
-      post(api_query: "account/collections/#{collection_id}/authors", args: args, data: {"authors" => authors}, &block)
+      args['impersonate'] = impersonate unless impersonate.nil?
+      post(api_query: "account/collections/#{collection_id}/authors", args: args, data: { 'authors' => authors }, &block)
     end
-    
+
     # Replace existing authors list with a new list
     #
     # @param collection_id [Integer] Figshare id of the collection
     # @param authors [Array] Can be a mix of { id } and/or { name }
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
-    def authors_replace(article_id, impersonate: nil, authors:)
+    def authors_replace(_article_id, authors:, impersonate: nil)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
-      put(api_query: "account/collections/#{collection_id}/authors", args: args, data: {"authors" => authors}, &block)
+      args['impersonate'] = impersonate unless impersonate.nil?
+      put(api_query: "account/collections/#{collection_id}/authors", args: args, data: { 'authors' => authors }, &block)
     end
-    
+
     # Remove author from the collection
     #
     # @param collection_id [Integer] Figshare id of the collection
     # @param author_id [Integer] Figshare id for the author
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
-    def author_delete(collection_id:, impersonate: nil, author_id:)
+    def author_delete(collection_id:, author_id:, impersonate: nil)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       delete(api_query: "account/collections/#{collection_id}/authors/#{author_id}", args: args, &block)
     end
-  
+
     # Yield collection categories
     #
     # @param collection_id [Integer] Figshare id of the collection
@@ -181,11 +185,11 @@ module Figshare
     # @yield [Hash] {parent_id, id, title}
     def categories(collection_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
-      get(api_query: 'account/collections/#{collection_id}/categories', args: args, &block)
+      args['impersonate'] = impersonate unless impersonate.nil?
+      get(api_query: "account/collections/#{collection_id}/categories", args: args, &block)
     end
-    
-    # Associate new categories with the collection. 
+
+    # Associate new categories with the collection.
     # This will add new categories to the list of already associated categories
     #
     # @param collection_id [Integer] Figshare id of the collection
@@ -194,7 +198,7 @@ module Figshare
     # @yield [Hash] { location }
     def categories_add(collection_id:, categories:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       post(api_query: "account/collections/#{collection_id}/categories", args: args, data: { 'categories' => categories }, &block)
     end
 
@@ -205,7 +209,7 @@ module Figshare
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
     def categories_replace(collection_id:, categories:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       put(api_query: "account/collections/#{collection_id}/categories", args: args, data: { 'categories' => categories }, &block)
     end
 
@@ -216,7 +220,7 @@ module Figshare
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
     def categories_delete(collection_id:, category_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       delete(api_query: "account/collections/#{collection_id}/categories/#{category_id}", args: args, &block)
     end
 
@@ -227,17 +231,17 @@ module Figshare
     # @yield [Hash] See Figshare API docs
     def articles(collection_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       get(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)
     #
     # @param article_id [Integer] Figshare id of the article
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
     def article_detail(article_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       get(api_query: "account/articles/#{article_id}", args: args, &block)
     end
 
@@ -245,14 +249,14 @@ module Figshare
     #
     # @param collection_id [Integer] Figshare id of the collection
     # @param articles [Array] array of Figshare article ids
- # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @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)
+    def articles_add(collection_id:, articles:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
-      post( api_query: "account/collections/#{collection_id}/articles/#{article_id}", args: args, data: { "articles": articles}, &block)
+      args['impersonate'] = impersonate unless impersonate.nil?
+      post( api_query: "account/collections/#{collection_id}/articles", args: args, data: { articles: articles }, &block)
     end
-    
+
     # Get a private article's details (Not a figshare API call. Duplicates PrivateArticles:article_detail)
     #
     # @param collection_id [Integer] Figshare id of the collection
@@ -260,21 +264,21 @@ module Figshare
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
     def articles_replace(collection_id:, articles:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
-      put( api_query: "account/collections/#{collection_id}/articles/#{article_id}", args: args, data: { "articles": articles}, &block)
+      args['impersonate'] = impersonate unless impersonate.nil?
+      put( api_query: "account/collections/#{collection_id}/articles/#{article_id}", args: args, data: { articles: articles }, &block)
     end
-    
+
     # Get a private article's details (Not a figshare API call. Duplicates PrivateArticles:article_detail)
     #
     # @param collection_id [Integer] Figshare id of the collection
     # @param article_id [Integer] Figshare id of the article
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
-    def article_delete(collection_id:, article_id: , impersonate: nil, &block)
+    def article_delete(collection_id:, article_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       delete( api_query: "account/collections/#{collection_id}/articles/#{article_id}", args: args, &block)
     end
-    
+
     # List private links
     #
     # @param collection_id [Integer] Figshare id of the collection
@@ -282,10 +286,10 @@ module Figshare
     # @yield [Hash] {id, is_active, expires_date}
     def links(collection_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       get(api_query: "account/collections/#{collection_id}/private_links", args: args, &block)
     end
-  
+
     # Create new private link for this collection
     #
     # @param collection_id [Integer] Figshare id of the collection
@@ -294,21 +298,21 @@ module Figshare
     # @yield [Hash] { location }
     def link_create(collection_id:, private_link:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       post(api_query: "account/collections/#{collection_id}/private_links", args: args, data: private_link, &block)
     end
 
     # Disable/delete private link for this collection
     #
     # @param collection_id [Integer] Figshare id of the collection
-    # @param link_id [Integer] 
+    # @param link_id [Integer]
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
-    def link_delete(collection_id:, link:, impersonate: nil, &block)
+    def link_delete(collection_id:, link_id:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       delete(api_query: "account/collections/#{collection_id}/private_links/#{link_id}", args: args, &block)
     end
-  
+
     # Update private link for this collection
     #
     # @param collection_id [Integer] Figshare id of the collection
@@ -316,9 +320,8 @@ module Figshare
     # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
     def link_update(collection_id:, link_id:, private_link:, impersonate: nil, &block)
       args = {}
-      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['impersonate'] = impersonate unless impersonate.nil?
       put(api_query: "account/collections/#{collection_id}/private_links/#{link_id}", args: args, data: private_link, &block)
     end
-    
   end
-end
+end