Class: Figshare::Init

Inherits:
Object
  • Object
show all
Defined in:
lib/figshare_api_v2.rb

Overview

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

Instance Method Summary collapse

Constructor Details

#initialize(figshare_user:, conf_dir:) ⇒ Init

Intitialize the Init class, so it can dynamically initialize the Figshare subclasses

Parameters:

  • figshare_user (String) —

    figshare user, in the figshare_keys.json

  • conf_dir (String) —

    directory for figshare_keys.json and figshare_site_params.json



31
32
33
34
 
# File 'lib/figshare_api_v2.rb', line 31

def initialize(figshare_user:, conf_dir:)
  @figshare_user = figshare_user
  @conf_dir = conf_dir
end

Instance Method Details

#authors ⇒ Figshare::Authors

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

Returns:



39
40
41
 
# File 'lib/figshare_api_v2.rb', line 39

def authors
  @authors ||= Authors.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end

#institutions ⇒ Figshare::Institutions

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

Returns:



46
47
48
 
# File 'lib/figshare_api_v2.rb', line 46

def institutions
  @institutions ||= Institutions.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end

#oai_pmh ⇒ Figshare::OAI_PMH

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

Returns:



116
117
118
 
# File 'lib/figshare_api_v2.rb', line 116

def oai_pmh
  @oai_pmh ||= OAI_PMH.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end

#other ⇒ Figshare::Other

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

Returns:



53
54
55
 
# File 'lib/figshare_api_v2.rb', line 53

def other
  @other ||= Other.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end

#private_articles ⇒ Figshare::PrivateArticles

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

Returns:



60
61
62
 
# File 'lib/figshare_api_v2.rb', line 60

def private_articles
  @private_articles ||= PrivateArticles.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end

#private_collections ⇒ Figshare::PrivateCollections

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

Returns:



67
68
69
 
# File 'lib/figshare_api_v2.rb', line 67

def private_collections
  @private_collections ||= PrivateCollections.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end

#private_projects ⇒ Figshare::PrivateProjects

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

Returns:



74
75
76
 
# File 'lib/figshare_api_v2.rb', line 74

def private_projects
  @private_projects ||= PrivateProjects.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end

#public_articles ⇒ Figshare::PublicArticles

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

Returns:



81
82
83
 
# File 'lib/figshare_api_v2.rb', line 81

def public_articles
  @public_articles ||= PublicArticles.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end

#public_collections ⇒ Figshare::PublicCollections

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

Returns:



88
89
90
 
# File 'lib/figshare_api_v2.rb', line 88

def public_collections
  @public_collections ||= PublicCollections.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end

#public_projects ⇒ Figshare::PublicProjects

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

Returns:



95
96
97
 
# File 'lib/figshare_api_v2.rb', line 95

def public_projects
  @public_projects ||= PublicProjects.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end

#stats ⇒ Figshare::Stats

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

Returns:



109
110
111
 
# File 'lib/figshare_api_v2.rb', line 109

def stats
  @stats ||= Stats.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end

#upload ⇒ Figshare::Upload

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

Returns:



102
103
104
 
# File 'lib/figshare_api_v2.rb', line 102

def upload
  @upload ||= Upload.new(figshare_user: @figshare_user, conf_dir: @conf_dir)
end