figshare_api_v2 0.9.1

data/lib/figshare_api_v2.rb

@@ -0,0 +1,121 @@
+module Figshare
+  VERSION = '0.9.1'
+
+  require_relative 'base.rb'
+  require_relative 'authors.rb'
+  require_relative 'institutions.rb'
+  require_relative 'other.rb'
+  require_relative 'private_articles.rb'
+  require_relative 'private_collections.rb'
+  require_relative 'private_projects.rb'
+  require_relative 'public_articles.rb'
+  require_relative 'public_collections.rb'
+  require_relative 'public_projects.rb'
+  require_relative 'upload.rb'
+  require_relative 'stats.rb'
+  require_relative 'oai_pmh.rb'
+  
+  # Hack :) to do a lazy initialization of the Figshare subclasses. i.e. only if they get called.
+  # Usage:
+  #  @figshare = Figshare::Init.new(figshare_user: 'figshare_admin', conf_dir: "#{__dir__}/conf")
+  #
+  #  @figshare.authors.detail(author_id: 12345) { |a| puts a }
+  #  @figshare.institutions.private_articles { |article| puts article }
+  #  ...
+  #
+  class Init
+    # Intitialize the Init class, so it can dynamically initialize the Figshare subclasses
+    #
+    # @param figshare_user [String] figshare user, in the figshare_keys.json
+    # @param conf_dir [String] directory for figshare_keys.json and figshare_site_params.json
+    def initialize(figshare_user:, conf_dir:)
+      @figshare_user = figshare_user
+      @conf_dir = conf_dir
+    end
+    
+    # Create Figshare::Authors, if it doesn't exist. Initialized with @figshare_user and @conf_dir
+    #
+    # @return [Figshare::Authors]
+    def authors
+      @authors ||= Authors.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+    end
+
+    # Create Figshare::Institutions, if it doesn't exist. Initialized with @figshare_user and @conf_dir
+    #
+    # @return [Figshare::Institutions]
+    def institutions
+      @institutions ||= Institutions.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+    end
+    
+    # Create Figshare::Other, if it doesn't exist. Initialized with @figshare_user and @conf_dir
+    #
+    # @return [Figshare::Other]
+    def other
+      @other ||= Other.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+    end
+    
+    # Create Figshare::PrivateArticles, if it doesn't exist. Initialized with @figshare_user and @conf_dir
+    #
+    # @return [Figshare::PrivateArticles]
+    def private_articles
+      @private_articles ||= PrivateArticles.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+    end
+    
+    # Create Figshare::PrivateCollections, if it doesn't exist. Initialized with @figshare_user and @conf_dir
+    #
+    # @return [Figshare::PrivateCollections]
+    def private_collections
+      @private_collections ||= PrivateCollections.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+    end
+    
+    # Create Figshare::PrivateProjects, if it doesn't exist. Initialized with @figshare_user and @conf_dir
+    #
+    # @return [Figshare::PrivateProjects]
+    def private_projects
+      @private_projects ||= PrivateProjects.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+    end
+    
+    # Create Figshare::PublicArticles, if it doesn't exist. Initialized with @figshare_user and @conf_dir
+    #
+    # @return [Figshare::PublicArticles]
+    def public_articles
+      @public_articles ||= PublicArticles.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+    end
+    
+    # Create Figshare::PublicCollections, if it doesn't exist. Initialized with @figshare_user and @conf_dir
+    #
+    # @return [Figshare::PublicCollections]
+    def public_collections
+      @public_collections ||= PublicCollections.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+    end
+    
+    # Create Figshare::PublicProjects, if it doesn't exist. Initialized with @figshare_user and @conf_dir
+    #
+    # @return [Figshare::PublicProjects]
+    def public_projects
+      @public_projects ||= PublicProjects.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+    end
+
+    # Create Figshare::Upload, if it doesn't exist. Initialized with @figshare_user and @conf_dir
+    #
+    # @return [Figshare::Upload]
+    def upload
+      @upload ||= Upload.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+    end
+    
+    # Create Figshare::Stats, if it doesn't exist. Initialized with @figshare_user and @conf_dir
+    #
+    # @return [Figshare::Stats]
+    def stats
+      @stats ||= Stats.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+    end
+    
+    # Create Figshare::OAI_PMH, if it doesn't exist. Initialized with @figshare_user and @conf_dir
+    #
+    # @return [Figshare::OAI_PMH]
+    def oai_pmh
+      @oai_pmh ||= OAI_PMH.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
+    end
+    
+  end
+end # module

data/lib/institutions.rb

@@ -0,0 +1,238 @@
+module Figshare
+  
+  # Figshare Institutions API
+  #
+  class Institutions < Base
+      
+    # Upload hr file
+    #
+    # @param hr_xml [String] See https://docs.figshare.com/#hr_feed_hr_feed_private_endpoint
+    # @yield [Hash] { message:, data: null, errcode:}
+    def hr_upload(hr_xml:, &block)
+      put(api_query: "institution/hrfeed/upload", data: hr_xml, content_type: 'multipart/form-data' &block)
+    end
+
+    # Get the institional account details
+    #
+    # @yield [Hash] 
+    def account(&block)
+      get(api_query: "account/institution", &block)
+    end
+  
+    # Requests a list of private institute articles
+    #
+    # @param status [Integer] Only return items with this status
+    # @param published_since [Time] Return results if published after this time
+    # @param modified_since [Time] Return results if modified after this time
+    # @param resource_doi [String] Matches this resource doi
+    # @param item_type [String] Matches this item_type. See Figshare API docs for list (https://docs.figshare.com/#articles_list)
+    # @param order [String] "published_date" Default, "modified_date", "views", "cites", "shares"
+    # @param order_direction [String] "desc" Default, "asc"
+    # @yield [Hash] {id, title, doi, handle, group_id, url, url_public_html, url_public_api, url_private_htm, 
+    #                url_private_api, published_date, timeline {...}, thumb, defined_type, defined_name }
+    def private_articles(status: nil, 
+                        published_since: nil, modified_since: nil, 
+                        item_type: nil, resource_doi: nil, 
+                        order: 'published_date', order_direction: 'desc',
+                        &block
+                        )
+      args = {}
+      args['status'] = status  if ! status.nil?
+      args['item_type'] = item_type if ! item_type.nil?
+      args['resource_doi'] = resource_doi if ! resource_doi.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?
+      get_paginate(api_query: 'account/institution/articles', args: args, &block)
+    end
+
+    # Requests an institute file
+    #
+    # @param resource_id [Integer] Figshare resource_id (publisher ID?)
+    # @param filename [String] Figshare file name
+    # @yield [Hash] {id, title, doi, handle, group_id, url, url_public_html, url_public_api, url_private_htm, 
+    #                url_private_api, published_date, timeline {...}, thumb, defined_type, defined_name }
+    def articles_filter_by(resource_id: nil, filename: nil, &block )
+      args = {}
+      args['resource_id'] = resource_id  if ! resource_id.nil?
+      args['filename'] = filename if ! filename.nil?
+      get(api_query: "institutions/{@institute_id}/articles/filter-by", args: args, &block)
+    end
+
+    # Get institution categories (including parent Categories)
+    #
+    # @yield [Hash] { parent_id, id, title }
+    def categories(&block)
+      get(api_query: "account/categories", &block)
+    end
+
+    # Get the groups for which the account has administrative privileges (assigned and inherited).
+    #
+    # @yield [Hash] { id, name, resource_id, parent_id, association_criteria }
+    def groups(&block)
+      get(api_query: "account/groups", &block)
+    end
+
+    # Get the roles available for groups and the institution group.
+    #
+    # @yield [Hash] { id, name, category, description }
+    def roles(&block)
+      get(api_query: "account/roles", &block)
+    end
+  
+    # Get the accounts for which the account has administrative privileges (assigned and inherited).
+    #
+    # @param is_active [Boolean] user account is active
+    # @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 accounts(is_active: nil, institution_user_id: nil, email: nil, &block)
+      args = {}
+      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?
+      get_paginate(api_query: "account/institution/accounts", args: args, &block)
+    end
+    
+    # Create new Institution Account
+    #
+    # @param email [String] 
+    # @param first_name [String]
+    # @param last_name [String]
+    # @param group_id [Integer] Figshare group ID
+    # @param institution_user_id [string]
+    # @param symplectic_user_id [string]
+    # @param quota [Integer] Figshare user quota
+    # @param is_active [Boolean]
+    def account_create(email:, first_name:, last_name:, group_id:, institution_user_id: nil, symplectic_user_id: nil, quota: nil, is_active: true, &block)
+      args = {}
+      args['email'] = email if ! email.nil?
+      args['first_name'] = first_name if ! first_name.nil?
+      args['last_name'] = last_name if ! last_name.nil?
+      args['group_id'] = group_id if ! group_id.nil?
+      args['institution_user_id'] = institution_user_id if ! institution_user_id.nil?
+      args['symplectic_user_id'] = symplectic_user_id if ! symplectic_user_id.nil?
+      args['quota'] = quota if ! quota.nil?
+      args['is_active'] = is_active  if ! is_active.nil?
+      post(api_query: "account/institution/accounts/#{account_id}", args: args, &block)
+    end
+
+    # Update Institution Account
+    #
+    # @param email [String] 
+    # @param first_name [String]
+    # @param last_name [String]
+    # @param group_id [Integer] Figshare group ID
+    # @param institution_user_id [string]
+    # @param symplectic_user_id [string]
+    # @param quota [Integer] Figshare user quota
+    # @param is_active [Boolean]
+    def account_update(email:, first_name:, last_name:, group_id:, institution_user_id: nil, symplectic_user_id: nil, quota: nil, is_active: true, &block)
+      args = {}
+      args['email'] = email if ! email.nil?
+      args['first_name'] = first_name if ! first_name.nil?
+      args['last_name'] = last_name if ! last_name.nil?
+      args['group_id'] = group_id if ! group_id.nil?
+      args['institution_user_id'] = institution_user_id if ! institution_user_id.nil?
+      args['symplectic_user_id'] = symplectic_user_id if ! symplectic_user_id.nil?
+      args['quota'] = quota if ! quota.nil?
+      args['is_active'] = is_active  if ! is_active.nil?
+      put(api_query: "account/institution/accounts/#{account_id}", args: args, &block)
+    end
+        
+    # Get institution Account Group Roles
+    #
+    # @param account_id [Integer] Figshare user account id
+    # @yield [Hash] { role_id [ { category, id, name }, ... ], ... }
+    def group_roles(account_id:, &block)
+      get(api_query: "account/institution/roles/{account_id}", &block)
+    end
+  
+    # Add Institution Account Group Roles
+    #
+    # @param account_id [Integer] Figshare user account id
+    # @param body [Hash] see figshare api docs
+    def group_roles_add(account_id:, body:, &block)
+      post(api_query: "account/institution/roles/{account_id}", args: body, &block)
+    end
+    
+    # Delete Institution Account Group Role
+    #
+    # @param account_id [Integer] Figshare user account id
+    # @param role_id [Integer] Figshare role id
+    # @param group_id [Integer] Figshare group id
+    def group_role_delete( role_id, group_id, account_id:, &block)
+      args = {}
+      args['account_id'] = account_id  if ! account_id.nil?
+      args['role_id'] = role_id if ! role_id.nil?
+      args['group_id'] = group_id if ! group_id.nil?
+      delete(api_query: "account/institution/roles/{account_id}", args: args, &block)
+    end
+
+    # Get the accounts for which the account has administrative privileges (assigned and inherited).
+    #
+    # @param is_active [Boolean] user account is active
+    # @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)
+      args = {}
+      args['search_for'] = search_for
+      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?
+      post(api_query: "account/institution/accounts/search", args: args, &block)
+    end
+  
+    # Get institution user information using the account_id
+    #
+    # @param account_id [Integer] Figshare user account id
+    # @yield [Hash] { id, first_name, last_name, name, is_active, url_name, is_public, job_title, orcid_id }
+    def user(account_id:, &block)
+      get(api_query: "account/institution/users/#{account_id}", &block)
+    end
+    
+    # Get a list of curation reviews for this institution
+    #
+    # @param group_id [Integer] Figshare group ID
+    # @param article_id [Integer] Figshare article ID
+    # @param status [String] pending, approved, rejected, closed
+    # @yield [Hash] {id, group_id, account_id, assigned_to, article_id, version, comment_count, status, created_date. modified_date }
+    def curation_review(group_id: nil, article_id: nil, status: nil, &block)
+      args = {}
+      args['group_id'] = group_id if ! group_id.nil?
+      args['article_id'] = article_id  if ! article_id.nil?
+      args['status'] = status if ! status.nil?
+      #Odd one, as has offset,limit not page,page_size
+      get_paginate(api_query: "account/institution/reviews", args: args, by_offset: true, &block)
+    end
+    
+    # Get a curation review record
+    #
+    # @param curation_id [Integer] Figshare curation ID
+    # @yield [Hash] see Figshare API docs for response sample
+    def curation_detail(curation_id: , &block)
+      get(api_query: "account/institution/review/#{curation_id}",  &block)
+    end
+
+    # Get a certain curation review's comments.
+    #
+    # @param curation_id [Integer] Figshare curation ID
+    # @yield [Hash] { id, account_id, type, text}
+    def curation_comments(curation_id: , &block)
+      #Odd one, as has offset,limit not page,page_size.
+      get_paginate(api_query: "account/institution/reviews/#{curation_id}/comments", by_offset: true, &block)
+    end
+
+    # Add a new comment to the review.
+    #
+    # @param curation_id [Integer] Figshare curation ID
+    # @param comment [String] Comment text
+    def curation_comments(curation_id: , &block)
+      #Odd one, as has offset,limit not page,page_size.
+      post(api_query: "account/institution/reviews/#{curation_id}/comments", args: { "text" => comment }, &block)
+    end
+    
+  end #of class
+end #of module

data/lib/oai_pmh.rb

@@ -0,0 +1,6 @@
+module Figshare
+  # OAI PMH API (not implemented yet)
+  #
+  class OAI_PMH
+  end #class
+end # module

data/lib/other.rb

@@ -0,0 +1,51 @@
+module Figshare
+  
+  # Misc Figshare API calls that they have classified as Other.
+  #
+  class Other < Base
+    
+    # Search from funding records
+    #
+    # @param search_for [String] string to search for
+    # @yield [Hash] {id, title, grant_code, funder_name, is_user_defined, url}
+    def search_funding(search_for:, &block)
+      post(api_query: "account/funding/search", args: { "search_for" => search_for }, &block)
+    end
+    
+    # Get Account information for current user
+    #
+    # @yield [Hash] {id, first_name, ...} see figshare API docs
+    def private_account_info
+      get(api_query: "account", &block)
+    end
+    
+    # Get public categories
+    #
+    # @yield [Hash] {parent_id, id, title}
+    def public_categories
+      get(api_query: "categories", &block)
+    end
+    
+    # Get public licenses
+    #
+    # @yield [Hash] {value, name, url}
+    def public_licenses
+      get(api_query: "licenses", &block)
+    end
+    
+    # Get private licenses
+    #
+    # @yield [Hash] {value, name, url}
+    def private_account_licenses
+      get(api_query: "account/licenses", &block)
+    end
+    
+    # Download a file
+    #
+    # @param file_id [Integer] Figshare file id
+    # @yield [Data] Binary data
+    def public_file_download(file_id:, &block)
+      get(api_query: "file/download/#{file_id}", &block)
+    end
+  end
+end

data/lib/private_articles.rb

@@ -0,0 +1,354 @@
+module Figshare
+
+  # Figshare private articles API
+  #
+  class PrivateArticles < Base
+  
+    # Get Own Articles (or private articles of others if institute is true)
+    #
+    # @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 list(impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get_paginate(api_query: 'account/articles', args: args, &block)
+    end
+
+    # Search within the private articles (our own, or the institutes)
+    #
+    # @param institution [Boolean] Just our institution
+    # @param group_id [Integer] Only return this group's collections
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @param published_since [Time] Return results if published after this time
+    # @param modified_since [Time] Return results if modified after this time
+    # @param resource_doi [String] Matches this resource doi
+    # @param item_type [String] Matches this item_type. See Figshare API docs for list (https://docs.figshare.com/#articles_list)
+    # @param doi [String] Matches this doi
+    # @param handle [String] Matches this handle
+    # @param order [String] "published_date" Default, "modified_date", "views", "cites", "shares"
+    # @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, 
+                              item_type: nil, resource_doi: nil, doi: nil, handle: nil,  
+                              order: 'published_date', order_direction: 'desc',
+                              search_for:,
+                              &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['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?
+      post(api_query: 'account/articles/search', args: args, &block)
+    end
+  
+    # Create a new Article by sending article information
+    #
+    # @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)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      post(api_query: "account/articles/#{article_id}", args: args, &block)
+    end
+
+    # Delete an article (WARNING!!!!!)
+    #
+    # @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(article_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      delete(api_query: "account/articles/#{article_id}",  args: args, &block)
+    end
+
+    # Get a private article's details
+    #
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @param article_id [Integer] Figshare id of the article
+    def detail(article_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get(api_query: "account/articles/#{article_id}",  args: args, &block)
+    end
+  
+    # Updating an article by passing body parameters
+    #
+    # @param article_id [Integer] Figshare id of the article
+    # @param body [Hash] See API docs.
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def update(article_id:, body:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      put(api_query: "account/articles/#{article_id}", args: args, data: body, &block)
+    end
+  
+    # Will lift the embargo for the specified article
+    #
+    # @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 embargo_delete(article_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      delete(api_query: "account/articles/#{article_id}/embargo", args: args, &block)
+    end
+  
+    # Get a private article embargo details
+    #
+    # @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
+    # @yield [Hash] {is_embargoed, embargo_date, embargo_reason}
+    def embargo_detail(article_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get(api_query: "account/articles/#{article_id}/embargo", args: args, &block)
+    end
+  
+    # Updates an article embargo status.
+    # Does not imply that the article will be published when the embargo will expire. 
+    # You must explicitly call the publish endpoint to enable this functionality.
+    #
+    # @param article_id [Integer] Figshare id of the article
+    # @param is_embargoed [Boolean]
+    # @param embargo_data [Time] Still needs to be published, after this date
+    # @param embargo_type [Integer]
+    # @param embargo_reason [String]
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def embargo_update(article_id:, is_embargoed: true, embargo_date: , embargo_type: 'file', embargo_reason:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      embargo_record = {"is_embargoed" => is_embargoed,
+                        "embargo_date" => embargo_date.strftime("%Y-%m-%dT%H:%M:%S"),
+                        "embargo_type" => embargo_type,
+                        "embargo_reason" => embargo_reason
+                      }
+      put(api_query: "account/articles/#{article_id}/embargo", args: args, data: embargo_record, &block)
+    end
+
+    # Publish an article
+    # If the whole article is under embargo, it will not be published immediately, but when the embargo expires or is lifted.
+    # When an article is published, a new public version will be generated. 
+    # Any further updates to the article will affect the private article data. 
+    # In order to make these changes publicly visible, an explicit publish operation is needed.
+    #
+    # @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 publish(article_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      post(api_query: "account/articles/#{article_id}/publish", args: args, &block)
+    end
+    
+    # Reserve DOI for article
+    #
+    # @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 reserve_doi(article_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      post(api_query: "account/articles/#{article_id}/reserve_doi", args: args, &block)
+    end
+  
+    # Reserve Handle for article
+    #
+    # @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 reserve_handle(article_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      post(api_query: "account/articles/#{article_id}/reserve_handle", args: args, &block)
+    end
+  
+    # Yield articles authors
+    #
+    # @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
+    # @yield [Hash] {id, full_name, is_active, url_name, orcid_id}
+    def authors(article_id, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get(api_query: "account/articles/#{article_id}/authors", args: args, &block)
+    end
+
+    # Associate new authors with the article. This will add new authors to the list of already associated authors
+    #
+    # @param article_id [Integer] Figshare id of the article
+    # @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_add(article_id:, authors:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      post(api_query: "account/articles/#{article_id}/authors", args: args, data: {"authors" => authors}, &block)
+    end
+    
+    # Replace existing authors list with a new list
+    #
+    # @param article_id [Integer] Figshare id of the article
+    # @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:, authors:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      put(api_query: "account/articles/#{article_id}/authors", args: args, data: {"authors" => authors}, &block)
+    end
+    
+    # Remove author from the article
+    #
+    # @param article_id [Integer] Figshare id of the article
+    # @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(article_id:, author_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      delete(api_query: "account/articles/#{article_id}/authors/#{author_id}", args: args, &block)
+    end
+    
+    # List categories for a specific article
+    #
+    # @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
+    # yield [Hash] { parent_id, id, title }
+    def categories(article_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get(api_query: "account/articles/#{article_id}/categories",  args: args, &block)
+    end
+  
+    # Associate new categories with the article. 
+    # This will add new categories to the list of already associated categories
+    #
+    # @param article_id [Integer] Figshare id of the article
+    # @param categories [Array] [ categorie_id, ... ]
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def categories_add(article_id:, categories:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      post(api_query: "account/articles/#{article_id}/categories", args: args, data: { 'categories' => categories }, &block)
+    end
+  
+    # Associate new categories with the article. This will remove all already associated categories and add these new ones
+    #
+    # @param article_id [Integer] Figshare id of the article
+    # @param categories [Array] [ categorie_id, ... ]
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def categories_replace(article_id:, categories:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      put(api_query: "account/articles/#{article_id}/categories", args: args, data: { 'categories' => categories }, &block)
+    end
+  
+    #  Delete category from article's categories
+    #
+    # @param article_id [Integer] Figshare id of the article
+    # @param category_id [Integer] Figshare id of the category
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def categories_delete(article_id:, category_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      delete(api_query: "account/articles/#{article_id}/categories/#{category_id}", args: args, &block)
+    end
+  
+    # List private links
+    #
+    # @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
+    # @yield [Hash] {id, is_active, expires_date}
+    def links(article_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get(api_query: "account/articles/#{article_id}/private_links", args: args, &block)
+    end
+  
+    # Create new private link for this article
+    #
+    # @param article_id [Integer] Figshare id of the article
+    # @param private_link [Hash] { expires_date }
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] { location }
+    def link_create(article_id:, private_link:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      post(api_query: "account/articles/#{article_id}/private_links", data: private_link, args: args, &block)
+    end
+
+    # Disable/delete private link for this article
+    #
+    # @param article_id [Integer] Figshare id of the article
+    # @param link_id [Integer] 
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def link_delete(article_id:, link:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      delete(api_query: "account/articles/#{article_id}/private_links/#{link_id}", args: args, &block)
+    end
+  
+    # Update private link for this article
+    #
+    # @param article_id [Integer] Figshare id of the article
+    # @param expires_date [Time] 
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def link_update(article_id:, link_id:, expires_date:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      put(api_query: "account/articles/#{article_id}/private_links/#{link_id}", args: args, data: { "expires_date" => expires_date.iso8601 }, &block)
+    end
+
+    # List private files in an article
+    #
+    # @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
+    # @yield [Hash] {status, viewer_type, preview_state, upload_url, upload_token, id, name, size, is_link_only, 
+    #                 download_url, supplied_md5, computed_md5}
+    def files(article_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get(api_query: "account/articles/#{article_id}/files", args: args, &block)
+    end
+  
+    # Single file detail
+    #
+    # @param article_id [Integer] Figshare id of the article
+    # @param file_id [Integer] Figshare id of the file
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] {status, viewer_type, preview_state, upload_url, upload_token, id, name, size, is_link_only, 
+    #                 download_url, supplied_md5, computed_md5}
+    def file_detail(article_id:, file_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get(api_query: "account/articles/#{article_id}/files/#{file_id}", args: args, &block)
+    end
+
+    # Delete a file from an article
+    #
+    # @param article_id [Integer] Figshare id of the article
+    # @param file_id [Integer] Figshare id of the file
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def file_delete(article_id:, file_id: , impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      delete( api_query: "account/articles/#{article_id}/files/#{file_id}", args: args, &block )
+    end
+
+    # WARNING!!!! Delete every file in an article
+    #
+    # @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
+    # @yield [Hash] Figshare file record of each file being deleted (if block_given?)
+    def delete_all_files(article_id:, impersonate: nil)
+      article_files(article_id: article_id, impersonate: impersonate) do |f| 
+        yield f if block_given?
+        article_file_delete(article_id: article_id, file_id: f['id'], impersonate: impersonate)
+      end
+    end
+    
+  end
+end