apilayer-ruby-3 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 4be427b50c58b5f75b513479be59b9c81c251a3bf84f9eca91de11b3ff8f4cd0
4
+ data.tar.gz: ebce46b5bf4a5fb5b31a10877dc1526f51312c426cd6674eb3a07dd41136668d
5
+ SHA512:
6
+ metadata.gz: 816a258eafbd51943b8415f8cfc62c18904a1597d41624e874a675d57ab08d598327ba2605e3764cc1e2453a7914295e6ca65fb15d824cf4e5fabd5e5510ccd1
7
+ data.tar.gz: '0855be7c750223716b9868e76c5c1cb23988decaddc60424bde47ed97cdec261421fc4b9c39390d19c9c9141383c3f468f18a9ea0cfeba9e66e613c158da4f0d'
data/Gemfile ADDED
@@ -0,0 +1,2 @@
1
+ source 'https://rubygems.org'
2
+ gemspec
data/LICENSE ADDED
@@ -0,0 +1,19 @@
1
+ Copyright (C) 2016 Alex Fong http://www.github.com/actfong
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy of
4
+ this software and associated documentation files (the "Software"), to deal in
5
+ the Software without restriction, including without limitation the rights to
6
+ use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
7
+ of the Software, and to permit persons to whom the Software is furnished to do
8
+ so, subject to the following conditions:
9
+
10
+ The above copyright notice and this permission notice shall be included in all
11
+ copies or substantial portions of the Software.
12
+
13
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19
+ SOFTWARE.
data/README.rdoc ADDED
@@ -0,0 +1,54 @@
1
+ == apilayer
2
+
3
+ {<img src="https://dl.circleci.com/status-badge/img/gh/tbrammar/apilayer-ruby3/tree/master.svg?style=svg" alt="CircleCI" />}[https://dl.circleci.com/status-badge/redirect/gh/tbrammar/apilayer-ruby3/tree/master]
4
+
5
+ With the release of version 2.0, the apilayer gem now act as a dependency for the *currency_layer* and *vat_layer* gems.
6
+
7
+ Please see https://github.com/actfong/currency_layer and https://github.com/actfong/vat_layer
8
+
9
+ *apilayer* provides a common-interface to configure and create connections to apilayer.net
10
+ See http://apilayer.com for more details.
11
+
12
+ === Version 3.0
13
+ Upgraded dependencies to run against Ruby 3.0 and above.
14
+
15
+ === Version 2.0
16
+ Removed all code related to currencylayer (Apilayer::Currency) and vatlayer (Apilayer::Vat).
17
+ Now act as a dependency to currency_layer and vat_layer gems.
18
+ ConnectionHelper contains all code related to configuring and creating connections to apilayer.net
19
+
20
+ === Version 1.5
21
+ - Improved reconfiguration-mechanism in Apilayer.
22
+ - Added HTTPS-option in Apilayer module.
23
+ - With this release, all paid-features of vatlayer and currencylayer are fully covered.
24
+
25
+ === Version 1.2 - 1.4
26
+ - Added .change and .list to Apilayer::Currency
27
+ - Added .timeframe to Apilayer::Currency
28
+ - Added .convert to Apilayer::Currency
29
+
30
+ === Version 1.1
31
+ - Major change to how .live and .historical in Apilayer::Currency are invoked.
32
+ - Added :source option to Apilayer::Currency.live and Apilayer::Currency.historical methods. This option is only available to paid users of currencylayer.
33
+
34
+
35
+ === Installation
36
+
37
+ ==== Using Bundler
38
+
39
+ Add apilayer in your <tt>Gemfile</tt>:
40
+
41
+ For Ruby 3.0 and above
42
+
43
+ gem "apilayer", "~> 3.0"
44
+
45
+ For < Ruby 3.0
46
+
47
+ gem "apilayer", "~> 2.0"
48
+
49
+ Run the following in your console:
50
+
51
+ $ bundle install
52
+
53
+
54
+
data/Rakefile ADDED
@@ -0,0 +1,5 @@
1
+ require 'rspec/core/rake_task'
2
+ task :default => :spec
3
+ desc 'Run test suite'
4
+
5
+ RSpec::Core::RakeTask.new(:spec)
@@ -0,0 +1,75 @@
1
+ module Apilayer
2
+ module ConnectionHelper
3
+
4
+ def init_configs
5
+ keys = Struct.new(:access_key, :https)
6
+ keys.new
7
+ end
8
+
9
+ def configs
10
+ @configs ||= init_configs
11
+ end
12
+
13
+ def reset_configs!
14
+ @configs = init_configs
15
+ end
16
+
17
+ def configure(&block)
18
+ self.reset_connection
19
+ yield(configs)
20
+ end
21
+
22
+ ##
23
+ # Creates a connection for the extended module to an apilayer-service, such as currencylayer and vatlayer.
24
+ # Uses access_key(s) configured with Apilayer module.
25
+ def connection
26
+ @connection ||= ::Faraday.new(
27
+ :url => "#{protocol}://apilayer.net",
28
+ :params => {"access_key" => self.configs[:access_key]}
29
+ )
30
+ end
31
+
32
+ def protocol
33
+ self.configs[:https] ? "https" : "http"
34
+ end
35
+ ##
36
+ # Resets the connection for the extended module. Used when the user needs to re-enter his/her access_key(s)
37
+ def reset_connection
38
+ @connection = nil
39
+ end
40
+
41
+ ##
42
+ # Makes a get-request to apilayer's service and parses the JSON response into a Hash
43
+ def get_and_parse(url, params={})
44
+ resp = get_request(url, params)
45
+ parse_response(resp)
46
+ end
47
+
48
+ ##
49
+ # Makes a get-request to apilayer's service
50
+ def get_request(slug, params={})
51
+ # calls connection method on the extended module
52
+ connection.get do |req|
53
+ req.url "api/#{slug}"
54
+ params.each_pair do |k,v|
55
+ req.params[k] = v
56
+ end
57
+ end
58
+ end
59
+
60
+ ##
61
+ # Parses the JSON response from apilayer into a Hash
62
+ # When errors are returned by apilayer, the 'info' and 'code' from its error will be used to raise an Apilayer::Error
63
+ def parse_response(resp)
64
+ body = JSON.parse(resp.body)
65
+ if body['error']
66
+ raise Apilayer::Error.new(
67
+ body['error']['info'],
68
+ body['error']['code']
69
+ )
70
+ else
71
+ body
72
+ end
73
+ end
74
+ end
75
+ end
@@ -0,0 +1,12 @@
1
+ ##
2
+ # Error-class for errors that are returned by apilayer's services
3
+ module Apilayer
4
+ class Error < StandardError
5
+ attr_reader :code
6
+
7
+ def initialize(message, code=nil)
8
+ super(message)
9
+ @code = code
10
+ end
11
+ end
12
+ end
data/lib/apilayer.rb ADDED
@@ -0,0 +1,6 @@
1
+ require 'rubygems'
2
+ require "faraday"
3
+ require "json"
4
+
5
+ require "apilayer/connection_helper"
6
+ require "apilayer/error"
metadata ADDED
@@ -0,0 +1,206 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: apilayer-ruby-3
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Alex Fong, Tom Brammar
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2023-10-01 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: json
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '2.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '2.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: faraday
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '2.0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '2.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '12.1'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '12.1'
55
+ - !ruby/object:Gem::Dependency
56
+ name: pry
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '0.14'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '0.14'
69
+ - !ruby/object:Gem::Dependency
70
+ name: bundler
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '2.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '2.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rspec
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '3.12'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '3.12'
97
+ - !ruby/object:Gem::Dependency
98
+ name: simplecov
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '0.22'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '0.22'
111
+ - !ruby/object:Gem::Dependency
112
+ name: vcr
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '6.0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: '6.0'
125
+ - !ruby/object:Gem::Dependency
126
+ name: webmock
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: '3.19'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: '3.19'
139
+ - !ruby/object:Gem::Dependency
140
+ name: rexml
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - "~>"
144
+ - !ruby/object:Gem::Version
145
+ version: '3.2'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - "~>"
151
+ - !ruby/object:Gem::Version
152
+ version: '3.2'
153
+ - !ruby/object:Gem::Dependency
154
+ name: rspec_junit_formatter
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - "~>"
158
+ - !ruby/object:Gem::Version
159
+ version: 0.6.0
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - "~>"
165
+ - !ruby/object:Gem::Version
166
+ version: 0.6.0
167
+ description: Acts as a dependency for the currency_layer and vat_layer gems. See https://apilayer.com/
168
+ for more details. This fork is updated to support Ruby 3.
169
+ email:
170
+ - rubygems-org@premiacapital.com
171
+ executables: []
172
+ extensions: []
173
+ extra_rdoc_files: []
174
+ files:
175
+ - Gemfile
176
+ - LICENSE
177
+ - README.rdoc
178
+ - Rakefile
179
+ - lib/apilayer.rb
180
+ - lib/apilayer/connection_helper.rb
181
+ - lib/apilayer/error.rb
182
+ homepage: https://github.com/tbrammar/apilayer-ruby3
183
+ licenses:
184
+ - MIT
185
+ metadata: {}
186
+ post_install_message:
187
+ rdoc_options: []
188
+ require_paths:
189
+ - lib
190
+ required_ruby_version: !ruby/object:Gem::Requirement
191
+ requirements:
192
+ - - ">="
193
+ - !ruby/object:Gem::Version
194
+ version: '0'
195
+ required_rubygems_version: !ruby/object:Gem::Requirement
196
+ requirements:
197
+ - - ">="
198
+ - !ruby/object:Gem::Version
199
+ version: '0'
200
+ requirements: []
201
+ rubygems_version: 3.2.3
202
+ signing_key:
203
+ specification_version: 4
204
+ summary: Acts as a dependency for the currency_layer and vat_layer gems. See https://apilayer.com/
205
+ for more details. This fork is updated to support Ruby 3.
206
+ test_files: []