class Figshare::Init

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 } …

Public Class Methods

new(figshare_user:, conf_dir:) click to toggle source

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

# File lib/figshare_api_v2.rb, line 35
def initialize(figshare_user:, conf_dir:)
  @figshare_user = figshare_user
  @conf_dir = conf_dir
end

Public Instance Methods

authors() click to toggle source

Create Figshare::Authors, if it doesn't exist. Initialized with @figshare_user and @conf_dir

@return [Figshare::Authors]

# File lib/figshare_api_v2.rb, line 43
def authors
  @authors ||= Authors.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end
institutions() click to toggle source

Create Figshare::Institutions, if it doesn't exist. Initialized with @figshare_user and @conf_dir

@return [Figshare::Institutions]

# File lib/figshare_api_v2.rb, line 50
def institutions
  @institutions ||= Institutions.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end
oai_pmh() click to toggle source

Create Figshare::OAI_PMH, if it doesn't exist. Initialized with @figshare_user and @conf_dir

@return [Figshare::OAI_PMH]

# File lib/figshare_api_v2.rb, line 120
def oai_pmh
  @oai_pmh ||= OAI_PMH.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end
other() click to toggle source

Create Figshare::Other, if it doesn't exist. Initialized with @figshare_user and @conf_dir

@return [Figshare::Other]

# File lib/figshare_api_v2.rb, line 57
def other
  @other ||= Other.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end
private_articles() click to toggle source

Create Figshare::PrivateArticles, if it doesn't exist. Initialized with @figshare_user and @conf_dir

@return [Figshare::PrivateArticles]

# File lib/figshare_api_v2.rb, line 64
def private_articles
  @private_articles ||= PrivateArticles.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end
private_collections() click to toggle source

Create Figshare::PrivateCollections, if it doesn't exist. Initialized with @figshare_user and @conf_dir

@return [Figshare::PrivateCollections]

# File lib/figshare_api_v2.rb, line 71
def private_collections
  @private_collections ||= PrivateCollections.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end
private_projects() click to toggle source

Create Figshare::PrivateProjects, if it doesn't exist. Initialized with @figshare_user and @conf_dir

@return [Figshare::PrivateProjects]

# File lib/figshare_api_v2.rb, line 78
def private_projects
  @private_projects ||= PrivateProjects.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end
public_articles() click to toggle source

Create Figshare::PublicArticles, if it doesn't exist. Initialized with @figshare_user and @conf_dir

@return [Figshare::PublicArticles]

# File lib/figshare_api_v2.rb, line 85
def public_articles
  @public_articles ||= PublicArticles.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end
public_collections() click to toggle source

Create Figshare::PublicCollections, if it doesn't exist. Initialized with @figshare_user and @conf_dir

@return [Figshare::PublicCollections]

# File lib/figshare_api_v2.rb, line 92
def public_collections
  @public_collections ||= PublicCollections.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end
public_projects() click to toggle source

Create Figshare::PublicProjects, if it doesn't exist. Initialized with @figshare_user and @conf_dir

@return [Figshare::PublicProjects]

# File lib/figshare_api_v2.rb, line 99
def public_projects
  @public_projects ||= PublicProjects.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end
stats() click to toggle source

Create Figshare::Stats, if it doesn't exist. Initialized with @figshare_user and @conf_dir

@return [Figshare::Stats]

# File lib/figshare_api_v2.rb, line 113
def stats
  @stats ||= Stats.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end
upload() click to toggle source

Create Figshare::Upload, if it doesn't exist. Initialized with @figshare_user and @conf_dir

@return [Figshare::Upload]

# File lib/figshare_api_v2.rb, line 106
def upload
  @upload ||= Upload.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end