freecurrencyapi-official 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/README.md +97 -0
- metadata +77 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 33c3fc7888dcff09e8afc8154a26ec19dfd8d682dc871fb2745e9fbc18ccf889
|
4
|
+
data.tar.gz: 1bab90ba7b948ef5c8c1918f56d56dca89c77f3de296d850c45f310d03221ceb
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 023b6d81b920d9dacae5bc190a39deb5f738842a17e3adb60fa5f5afb639eeb13802f3d8ff58da13a0645f109e3cb031d2adc4de788fbf599994e30d874bad96
|
7
|
+
data.tar.gz: a07434efddff4f84562a3c7ff51819d6b00ed599eaa2c72b47e270a174cdac18b3eb7206e658e86a393660d97395c48e97ce1ca22c403899520b870b7abcae1d
|
data/README.md
ADDED
@@ -0,0 +1,97 @@
|
|
1
|
+
<p align="center">
|
2
|
+
<img src="https://app.freecurrencyapi.com/img/logo/freecurrencyapi.png" width="300"/>
|
3
|
+
</p>
|
4
|
+
|
5
|
+
# freecurrencyapi-ruby
|
6
|
+
|
7
|
+
freecurrencyapi-ruby is the official Ruby Wrapper around the [freecurrencyapi](https://app.freecurrencyapi.com).
|
8
|
+
|
9
|
+
## Installation
|
10
|
+
|
11
|
+
Add this line to your application's Gemfile:
|
12
|
+
|
13
|
+
gem 'freecurrencyapi'
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install freecurrencyapi
|
22
|
+
|
23
|
+
## Configuration
|
24
|
+
|
25
|
+
You will need your apikey to use freecurrencyapi, you can get
|
26
|
+
one [https://app.freecurrencyapi.com/register](https://app.freecurrencyapi.com/register) here.
|
27
|
+
|
28
|
+
Create an instance and pass your api key like here:
|
29
|
+
|
30
|
+
fx = freecurrencyapi::Endpoints.new(:apikey => 'APIKEY')
|
31
|
+
|
32
|
+
## Usage & Endpoints
|
33
|
+
|
34
|
+
Use the instance to call the endpoints
|
35
|
+
|
36
|
+
#### Status
|
37
|
+
|
38
|
+
Returns your current quota
|
39
|
+
|
40
|
+
fx.status()
|
41
|
+
|
42
|
+
#### Currencies
|
43
|
+
|
44
|
+
Returns all our supported currencies
|
45
|
+
|
46
|
+
fx.currencies(currencies)
|
47
|
+
|
48
|
+
| Parameter | Data type | Mandatory | Description |
|
49
|
+
------------| --- | ----------- | --- | ----------- |
|
50
|
+
| currencies | string | no | A list of comma seperated currency codes which you want to get (EUR,USD,CAD). By default all available currencies will be shown |
|
51
|
+
|
52
|
+
#### Latest Exchange Rates
|
53
|
+
|
54
|
+
Returns the latest exchange rates. The default base currency is USD.
|
55
|
+
|
56
|
+
fx.latest(base_currency, currencies)
|
57
|
+
|
58
|
+
| Parameter | Data type | Mandatory | Description |
|
59
|
+
|---------------|-----------|-----------|---------------------------------------------------------------------------------------------------------------------------------|
|
60
|
+
| base_currency | string | no | By default all values are based on USD. By default all values are based on USD |
|
61
|
+
| currencies | string | no | A list of comma seperated currency codes which you want to get (EUR,USD,CAD). By default all available currencies will be shown |
|
62
|
+
|
63
|
+
#### Historical Exchange Rates
|
64
|
+
|
65
|
+
Returns the latest exchange rates. The default base currency is USD.
|
66
|
+
|
67
|
+
fx.historical(date, base_currency, currencies)
|
68
|
+
|
69
|
+
| Parameter | Data type | Mandatory | Description |
|
70
|
+
|---------------|-----------|-----------|---------------------------------------------------------------------------------------------------------------------------------|
|
71
|
+
| date | string | yes | Date to retrieve historical rates from (format: 2021-12-31) |
|
72
|
+
| base_currency | string | no | By default all values are based on USD. By default all values are based on USD |
|
73
|
+
| currencies | string | no | A list of comma seperated currency codes which you want to get (EUR,USD,CAD). By default all available currencies will be shown |
|
74
|
+
|
75
|
+
|
76
|
+
You can find further information on https://freecurrencyapi.com/docs/
|
77
|
+
|
78
|
+
## Contributing
|
79
|
+
|
80
|
+
1. Fork it
|
81
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
82
|
+
3. Commit your changes (`git commit -am 'Added some feature'`)
|
83
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
84
|
+
5. Create new Pull Request
|
85
|
+
|
86
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/everapihq/freecurrencyapi. This project is intended to
|
87
|
+
be a safe, welcoming space for collaboration, and contributors are expected to adhere to
|
88
|
+
the [code of conduct](https://github.com/everapihq/freecurrencyapi-ruby/blob/master/CODE_OF_CONDUCT.md).
|
89
|
+
|
90
|
+
## License
|
91
|
+
|
92
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
93
|
+
|
94
|
+
## Code of Conduct
|
95
|
+
|
96
|
+
Everyone interacting in the freecurrencyapi project's codebases, issue trackers, chat rooms and mailing lists is expected to
|
97
|
+
follow the [code of conduct](https://github.com/everapihq/freecurrencyapi-ruby/blob/master/CODE_OF_CONDUCT.md).
|
metadata
ADDED
@@ -0,0 +1,77 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: freecurrencyapi-official
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Dominik Kukacka
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2023-05-31 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: rest-client
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: json
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
description: The perfect tool to handle your exchange rate conversions. Our API helps
|
42
|
+
you with realtime & historical foreign currency exchanges rates. Stop worrying about
|
43
|
+
uptime & outdated exchange rate data.
|
44
|
+
email:
|
45
|
+
- office@everapi.com
|
46
|
+
executables: []
|
47
|
+
extensions: []
|
48
|
+
extra_rdoc_files:
|
49
|
+
- README.md
|
50
|
+
files:
|
51
|
+
- README.md
|
52
|
+
homepage: https://freecurrencyapi.com/
|
53
|
+
licenses:
|
54
|
+
- MIT
|
55
|
+
metadata:
|
56
|
+
homepage_uri: https://freecurrencyapi.com/
|
57
|
+
source_code_uri: https://github.com/everapihq/freecurrencyapi-ruby
|
58
|
+
post_install_message:
|
59
|
+
rdoc_options: []
|
60
|
+
require_paths:
|
61
|
+
- lib
|
62
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
63
|
+
requirements:
|
64
|
+
- - ">="
|
65
|
+
- !ruby/object:Gem::Version
|
66
|
+
version: 2.6.0
|
67
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
68
|
+
requirements:
|
69
|
+
- - ">="
|
70
|
+
- !ruby/object:Gem::Version
|
71
|
+
version: '0'
|
72
|
+
requirements: []
|
73
|
+
rubygems_version: 3.0.3.1
|
74
|
+
signing_key:
|
75
|
+
specification_version: 4
|
76
|
+
summary: A ruby wrapper for freecurrencyapi.com's free currency API
|
77
|
+
test_files: []
|