Class: Colrapi::Request

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Request

Returns a new instance of Request.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/colrapi/request.rb', line 14

def initialize(**args)
  @endpoint = args[:endpoint]
  @verbose = args[:verbose]
  @url = args[:url]
  @q = Array(args[:q]) if args[:q]
  @id = args[:id]
  @attempt = args[:attempt]
  @format = args[:format]
  @regexp = args[:regexp]
  @content = Array(args[:content]) if args[:content]
  @name = args[:name]
  @authorship = args[:authorship]
  @code = args[:code]
  @type = Array(args[:type]) if args[:type]
  @rank = Array(args[:rank]) if args[:rank]
  @facet = Array(args[:facet]) if args[:facet]
  @min_rank = args[:min_rank]
  @max_rank = args[:max_rank]
  @parent_rank = args[:parent_rank]
  @root_id = Array(args[:root_id]) if args[:root_id]
  @root2_id = Array(args[:root2_id]) if args[:root2_id]
  @include_parent = args[:include_parent]
  @include_synonyms = args[:include_synonyms]
  @dataset_id_filter = args[:dataset_id_filter]
  @project_id = args[:project_id]
  @short_title = args[:short_title]
  @private = args[:private]
  @released_from = args[:released_from]
  @contributes_to = args[:contributes_to]
  @has_source_dataset = args[:has_source_dataset]
  @has_gbif_id = args[:has_gbif_id]
  @gbif_id = args[:gbif_id]
  @gbif_publisher_id = args[:gbif_publisher_id]
  @editor = args[:editor]
  @reviewer = args[:reviewer]
  @modified_by = args[:modified_by]
  @origin = Array(args[:origin]) if args[:origin]
  @original = args[:original]
  @not_current_only = args[:not_current_only]
  @license = Array(args[:license]) if args[:license]
  @row_type = Array(args[:row_type]) if args[:row_type]
  @created_after = args[:created_after]
  @created_before = args[:created_before]
  @issue = Array(args[:issue]) if args[:issue]
  @term = Array(args[:term]) if args[:term]
  @term_operator = args[:term_operator]
  @issued = args[:issued]
  @issued_before = args[:issued]
  @modified_after =  args[:modified_after]
  @modified_before = args[:modified_before]
  @last_synced_before = args[:last_synced_before]
  @min = args[:min]
  @max = args[:max]
  @min_size = args[:min_size]
  @size = args[:size]
  @within_superkingdom = args[:within_superkingdom]
  @within_kingdom = args[:within_kingdom]
  @within_subkingdom = args[:within_subkingdom]
  @within_superphylum = args[:within_superphylum]
  @within_phylum = args[:within_phylum]
  @within_subphylum = args[:within_subphylum]
  @within_superclass = args[:within_superclass]
  @within_class = args[:within_class]
  @within_subclass = args[:within_subclass]
  @within_superorder = args[:within_superorder]
  @within_order = args[:within_order]
  @within_suborder = args[:within_suborder]
  @within_superfamily = args[:within_superfamily]
  @within_family = args[:within_family]
  @within_subfamily = args[:within_subfamily]
  @within_tribe = args[:within_tribe]
  @within_subtribe = args[:within_subtribe]
  @within_genus = args[:within_genus]
  @within_subgenus = args[:within_subgenus]
  @within_section = args[:within_section]
  @within_species = args[:within_species]
  @without_data = args[:without_data]
  @broken = args[:broken]
  @subject_dataset_id = args[:subject_dataset_id]
  @mode = args[:mode]
  @decision_mode = args[:decision_mode]
  @subject = args[:subject]
  @nidx_id = args[:nidx_id]
  @sort_by = args[:sort_by]
  @reverse = args[:reverse]
  @limit = args[:limit]
  @offset = args[:offset]
  @status = args[:status]
  @state = Array(args[:state]) if args[:state]
  @running = args[:running]
  @user = args[:user]
  @password = args[:password]
  @token = args[:token]
  @options = args[:options] # TODO: not added at colrapi.rb
end

Instance Attribute Details

#endpoint ⇒ Object

Returns the value of attribute endpoint.



8
9
10
 
# File 'lib/colrapi/request.rb', line 8

def endpoint
  @endpoint
end

#options ⇒ Object

Returns the value of attribute options.



12
13
14
 
# File 'lib/colrapi/request.rb', line 12

def options
  @options
end

#q ⇒ Object

Returns the value of attribute q.



9
10
11
 
# File 'lib/colrapi/request.rb', line 9

def q
  @q
end

#verbose ⇒ Object

Returns the value of attribute verbose.



10
11
12
 
# File 'lib/colrapi/request.rb', line 10

def verbose
  @verbose
end

Instance Method Details

#perform ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/colrapi/request.rb', line 110

def perform

  args = { q: @q, regex: @regexp, attempt: @attempt, content: @content, name: @name, authorship: @authorship, code: @code, type: @type,
           rank: @rank, minRank: @min_rank, maxRank: @max_rank, parentRank: @parent_rank, projectKey: @project_id,
           term: @term, termOp: @term_operator, status: @status, decisionMode: @decision_mode,
           alias: @short_title, private: @private, releasedFrom: @released_from, contributesTo: @contributes_to,
           hasSourceDataset: @has_source_dataset, hasGbifKey: @has_gbif_id, gbifKey: @gbif_id,
           gbifPublisherKey: @gbif_publisher_id, editor: @editor, reviewer: @reviewer, modifiedBy: @modified_by,
           id: @id, format: @format, root: @root_id, root2: @root2_id, synonyms: @include_synonyms,
           showParent: @include_parent, origin: @origin, original: @original, license: @license, rowType: @row_type,
           created: @created_after, createdBefore: @created_before, issued: @issued, issuedBefore: @issued_before,
           modified: @modified_after, modifiedBefore: @modified_before, lastSync: @last_synced_before,
           minSize: @min_size, size: @size, issue: @issue, min: @min, max: @max, datasetKey: @dataset_id_filter,
           withoutData: @without_data, superkingdom: @within_superkingdom, kingdom: @within_kingdom,
           subkingdom: @within_subkingdom, superphylum: @within_superphylum, phylum: @within_phylum,
           subphylum: @within_subphylum, superclass: @within_superclass, class: @within_class,
           subclass: @within_subclass, superorder: @within_superorder, order: @within_order,
           suborder: @within_suborder, superfamily: @within_superfamily,
           family: @within_family, subfamily: @within_subfamily,
           tribe: @within_tribe, subtribe: @within_subtribe, genus: @within_genus,
           subgenus: @within_subgenus, section: @within_section, species: @within_species,
           nidx: @nidx_id, state: @state, running: @running, notCurrentOnly: @not_current_only,
           broken: @broken, subjectDatasetKey: @subject_dataset_id, mode: @mode, subject: @subject,
           sortBy: @sort_by, reverse: @reverse, url: @url, offset: @offset, limit: @limit}
  opts = args.delete_if { |_k, v| v.nil? }

  conn = if verbose
           Faraday.new(url: Colrapi.base_url, request: { params_encoder: Faraday::FlatParamsEncoder }) do |f|
             if !@user.nil? and !@password.nil?
               f.request(:basic_auth, @user, @password)
             end
             f.response :logger
             f.use Faraday::ColrapiErrors::Middleware
             f.adapter Faraday.default_adapter
           end
         else
           Faraday.new(url: Colrapi.base_url, request: { params_encoder: Faraday::FlatParamsEncoder }) do |f|
             if !@user.nil? and !@password.nil?
               f.request(:basic_auth, @user, @password)
             end
             f.use Faraday::ColrapiErrors::Middleware
             f.adapter Faraday.default_adapter
           end
         end

  conn.headers['Authorization'] = "Bearer #{@token}" unless @token.nil?
  conn.headers['Accept'] = 'application/json,*/*'
  conn.headers[:user_agent] = make_user_agent
  conn.headers["X-USER-AGENT"] = make_user_agent

  res = conn.get endpoint, opts

  # Handles ChecklistBank endpoints that do not return JSON
  begin
    MultiJson.load(res.body)
  rescue MultiJson::ParseError
    res.body
  end
  
end