fxapi 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: de16850970c298a58429459c7964a5d428d744e3f5be98636a41d387798d702f
4
+ data.tar.gz: a1dc477c694f2f00c79d70eded70e145c3947b023820f6614496623d1fe0127a
5
+ SHA512:
6
+ metadata.gz: 5bc154665109999fec92a8bd7f9105e2959bc1678d575e3b30e936219bd78007405c95433b70673c71cd85998dee03d0446dcef2ad76e31556ca024b32a0e15c
7
+ data.tar.gz: '0158c021a7dfe18cb0ec65a08230fd4c2a07ebdc266849e6b1bdb86a05f24219d394fd49809d1265eb926812566d398f48bffe8d3a8f3a0bd8c05bf3db8ec46f'
data/.idea/.gitignore ADDED
@@ -0,0 +1,8 @@
1
+ # Default ignored files
2
+ /shelf/
3
+ /workspace.xml
4
+ # Editor-based HTTP Client requests
5
+ /httpRequests/
6
+ # Datasource local storage ignored files
7
+ /dataSources/
8
+ /dataSources.local.xml
@@ -0,0 +1,8 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <module type="WEB_MODULE" version="4">
3
+ <component name="NewModuleRootManager">
4
+ <content url="file://$MODULE_DIR$" />
5
+ <orderEntry type="inheritedJdk" />
6
+ <orderEntry type="sourceFolder" forTests="false" />
7
+ </component>
8
+ </module>
data/.idea/modules.xml ADDED
@@ -0,0 +1,8 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <project version="4">
3
+ <component name="ProjectModuleManager">
4
+ <modules>
5
+ <module fileurl="file://$PROJECT_DIR$/.idea/fxapi-ruby.iml" filepath="$PROJECT_DIR$/.idea/fxapi-ruby.iml" />
6
+ </modules>
7
+ </component>
8
+ </project>
data/.idea/php.xml ADDED
@@ -0,0 +1,19 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <project version="4">
3
+ <component name="MessDetectorOptionsConfiguration">
4
+ <option name="transferred" value="true" />
5
+ </component>
6
+ <component name="PHPCSFixerOptionsConfiguration">
7
+ <option name="transferred" value="true" />
8
+ </component>
9
+ <component name="PHPCodeSnifferOptionsConfiguration">
10
+ <option name="highlightLevel" value="WARNING" />
11
+ <option name="transferred" value="true" />
12
+ </component>
13
+ <component name="PhpStanOptionsConfiguration">
14
+ <option name="transferred" value="true" />
15
+ </component>
16
+ <component name="PsalmOptionsConfiguration">
17
+ <option name="transferred" value="true" />
18
+ </component>
19
+ </project>
data/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ ## [Unreleased]
2
+
3
+ ## [0.1.0] - 2022-08-29
4
+
5
+ - Initial release
@@ -0,0 +1,84 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8
+
9
+ ## Our Standards
10
+
11
+ Examples of behavior that contributes to a positive environment for our community include:
12
+
13
+ * Demonstrating empathy and kindness toward other people
14
+ * Being respectful of differing opinions, viewpoints, and experiences
15
+ * Giving and gracefully accepting constructive feedback
16
+ * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17
+ * Focusing on what is best not just for us as individuals, but for the overall community
18
+
19
+ Examples of unacceptable behavior include:
20
+
21
+ * The use of sexualized language or imagery, and sexual attention or
22
+ advances of any kind
23
+ * Trolling, insulting or derogatory comments, and personal or political attacks
24
+ * Public or private harassment
25
+ * Publishing others' private information, such as a physical or email
26
+ address, without their explicit permission
27
+ * Other conduct which could reasonably be considered inappropriate in a
28
+ professional setting
29
+
30
+ ## Enforcement Responsibilities
31
+
32
+ Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
33
+
34
+ Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
35
+
36
+ ## Scope
37
+
38
+ This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
39
+
40
+ ## Enforcement
41
+
42
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at benedikt.stoy@everapi.com. All complaints will be reviewed and investigated promptly and fairly.
43
+
44
+ All community leaders are obligated to respect the privacy and security of the reporter of any incident.
45
+
46
+ ## Enforcement Guidelines
47
+
48
+ Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
49
+
50
+ ### 1. Correction
51
+
52
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
53
+
54
+ **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
55
+
56
+ ### 2. Warning
57
+
58
+ **Community Impact**: A violation through a single incident or series of actions.
59
+
60
+ **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
61
+
62
+ ### 3. Temporary Ban
63
+
64
+ **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
65
+
66
+ **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
67
+
68
+ ### 4. Permanent Ban
69
+
70
+ **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
71
+
72
+ **Consequence**: A permanent ban from any sort of public interaction within the community.
73
+
74
+ ## Attribution
75
+
76
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
77
+ available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
78
+
79
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
80
+
81
+ [homepage]: https://www.contributor-covenant.org
82
+
83
+ For answers to common questions about this code of conduct, see the FAQ at
84
+ https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
data/Gemfile ADDED
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ source "https://rubygems.org"
4
+
5
+ # Specify your gem's dependencies in fxapi.gemspec
6
+ gemspec
7
+
8
+ gem "rake", "~> 13.0"
9
+
10
+ gem "rest-client", "~> 2.1"
11
+
12
+ gem "json", "~> 2.6"
data/Gemfile.lock ADDED
@@ -0,0 +1,39 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ currencyapi (0.1.0)
5
+
6
+ GEM
7
+ remote: https://rubygems.org/
8
+ specs:
9
+ domain_name (0.5.20190701)
10
+ unf (>= 0.0.5, < 1.0.0)
11
+ http-accept (1.7.0)
12
+ http-cookie (1.0.5)
13
+ domain_name (~> 0.5)
14
+ json (2.6.2)
15
+ mime-types (3.4.1)
16
+ mime-types-data (~> 3.2015)
17
+ mime-types-data (3.2022.0105)
18
+ netrc (0.11.0)
19
+ rake (13.0.6)
20
+ rest-client (2.1.0)
21
+ http-accept (>= 1.7.0, < 2.0)
22
+ http-cookie (>= 1.0.2, < 2.0)
23
+ mime-types (>= 1.16, < 4.0)
24
+ netrc (~> 0.8)
25
+ unf (0.1.4)
26
+ unf_ext
27
+ unf_ext (0.0.8.2)
28
+
29
+ PLATFORMS
30
+ x86_64-darwin-21
31
+
32
+ DEPENDENCIES
33
+ currencyapi!
34
+ json (~> 2.6)
35
+ rake (~> 13.0)
36
+ rest-client (~> 2.1)
37
+
38
+ BUNDLED WITH
39
+ 2.3.21
data/LICENSE.md ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2022 Everapi
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,119 @@
1
+ <p align="center">
2
+ <img src="https://app.fxapi.com/img/logo/fxapi.png" width="300"/>
3
+ </p>
4
+
5
+ # fxapi-ruby
6
+
7
+ fxapi-ruby is the official Ruby Wrapper around the [fxapi](https://app.fxapi.com).
8
+
9
+
10
+
11
+ ## Installation
12
+
13
+ Add this line to your application's Gemfile:
14
+
15
+ gem 'fxapi'
16
+
17
+ And then execute:
18
+
19
+ $ bundle
20
+
21
+ Or install it yourself as:
22
+
23
+ $ gem install fxapi
24
+
25
+ ## Configuration
26
+
27
+ You will need your apikey to use fxapi, you can get one [https://app.fxapi.com/register](https://app.fxapi.com/register) here.
28
+
29
+ Create an instance and pass your api key like here:
30
+
31
+ fx = Fxapi::Endpoints.new(:apikey => 'APIKEY')
32
+
33
+ ## Usage & Endpoints
34
+
35
+ Use the instance to call the endpoints
36
+
37
+ #### Status
38
+ Returns your current quota
39
+
40
+ fx.status()
41
+
42
+ #### Currencies
43
+ Returns all our supported currencies
44
+
45
+ fx.currencies(currencies)
46
+
47
+ | Parameter | Data type | Mandatory | Description |
48
+ | --- | ----------- | --- | ----------- |
49
+ | 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 |
50
+
51
+
52
+ #### Latest Exchange Rates
53
+ Returns the latest exchange rates. The default base currency is USD.
54
+
55
+ fx.latest(base_currency, currencies)
56
+
57
+ | Parameter | Data type | Mandatory | Description |
58
+ | --- | ----------- | --- | ----------- |
59
+ | base_currency | string | no | By default all values are based on USD. By default all values are based on USD |
60
+ | 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 |
61
+
62
+ #### Historical Exchange Rates
63
+ Returns the latest exchange rates. The default base currency is USD.
64
+
65
+ fx.historical(date, base_currency, currencies)
66
+
67
+ | Parameter | Data type | Mandatory | Description |
68
+ | --- | ----------- | --- | ----------- |
69
+ | date | string | yes | Date to retrieve historical rates from (format: 2021-12-31) |
70
+ | base_currency | string | no | By default all values are based on USD. By default all values are based on USD |
71
+ | 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 |
72
+
73
+
74
+ #### Range Historical Exchange Rates
75
+ Returns a range of exchange rates. Generally, we provide data going back to 1999.
76
+
77
+ fx.range(datetime_start, datetime_end, accuracy, baseCurrency, currencies)
78
+
79
+ | Parameter | Data type | Mandatory | Description |
80
+ | --- | ----------- | --- | ----------- |
81
+ | datetime_start | string | yes | Datetime for the start of your requested range (format: 2021-12-31T23:59:59Z / ISO8601 Datetime)
82
+ | datetime_end | string | yes | Datetime for the start of your requested range (format: 2021-12-31T23:59:59Z / ISO8601 Datetime) |
83
+ | accuracy | string | no | The accuracy you want to receive. Possible Values: day, hour, quarter_hour, minute Default: day For valid time ranges see below |
84
+ | base_currency | string | no | By default all values are based on USD. By default all values are based on USD |
85
+ | 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 |
86
+
87
+
88
+ #### Convert Exchange Rates
89
+ Returns calculated values for today or any given date for all currencies.
90
+
91
+ fx.convert(value, date, baseCurrency, currencies)
92
+
93
+ | Parameter | Data type | Mandatory | Description |
94
+ | --- | ----------- | --- | ----------- |
95
+ | value | string | yes | The value you want to convert |
96
+ | date | string | no | Date to retrieve historical rates from (format: 2021-12-31) |
97
+ | base_currency | string | no | By default all values are based on USD. By default all values are based on USD |
98
+ | 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 |
99
+
100
+
101
+ You can find further information on https://fxapi.com/docs/
102
+
103
+ ## Contributing
104
+
105
+ 1. Fork it
106
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
107
+ 3. Commit your changes (`git commit -am 'Added some feature'`)
108
+ 4. Push to the branch (`git push origin my-new-feature`)
109
+ 5. Create new Pull Request
110
+
111
+ Bug reports and pull requests are welcome on GitHub at https://github.com/everapihq/fxapi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/everapihq/fxapi-ruby/blob/master/CODE_OF_CONDUCT.md).
112
+
113
+ ## License
114
+
115
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
116
+
117
+ ## Code of Conduct
118
+
119
+ Everyone interacting in the fxapi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/everapihq/fxapi-ruby/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,4 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "bundler/gem_tasks"
4
+ task default: %i[]
Binary file
@@ -0,0 +1,5 @@
1
+ module Fxapi
2
+ class Configuration
3
+ attr_accessor :apikey
4
+ end
5
+ end
@@ -0,0 +1,42 @@
1
+ module Fxapi
2
+ class Endpoints
3
+
4
+ attr_writer :apikey
5
+
6
+ def initialize(options = {})
7
+ @apikey = options[:apikey] || Fxapi.configuration.apikey
8
+ end
9
+
10
+ def status()
11
+ @result = call_api('status?type=quota')
12
+ end
13
+
14
+ def currencies(currencies = '')
15
+ @result = call_api(sprintf('currencies?currencies=%s', currencies))
16
+ end
17
+
18
+ def latest(baseCurrency = 'USD', currencies = '')
19
+ @result = call_api(sprintf('latest?base_currency=%s&currencies=%s', baseCurrency, currencies))
20
+ end
21
+
22
+ def historical(date, baseCurrency = 'USD', currencies = '')
23
+ @result = call_api(sprintf('historical?date=%s&base_currency=%s&currencies=%s', date, baseCurrency, currencies))
24
+ end
25
+
26
+ def range(datetime_start, datetime_end, accuracy = 'day', baseCurrency = 'USD', currencies = '')
27
+ @result = call_api(sprintf('range?datetime_start=%s&datetime_end=%s&accuracy=%s&base_currency=%s&currencies=%s', datetime_start, datetime_end, accuracy, baseCurrency, currencies))
28
+ end
29
+
30
+ def convert(value, date = '', baseCurrency = 'USD', currencies = '')
31
+ @result = call_api(sprintf('convert?value=%s&date=%s&base_currency=%s&currencies=%s', value, date, baseCurrency, currencies))
32
+ end
33
+
34
+ def call_api(route)
35
+ begin
36
+ @response = RestClient.get "#{Fxapi::BASE_URL}#{route}&apikey=#{@apikey}", { 'Accept' => 'application/json' }
37
+ rescue RestClient::ExceptionWithResponse => e
38
+ @data = e.response
39
+ end
40
+ end
41
+ end
42
+ end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Fxapi
4
+ VERSION = "1.0.0"
5
+ end
data/lib/fxapi.rb ADDED
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'rest-client'
4
+ require 'json'
5
+ require_relative "fxapi/version"
6
+ require_relative 'fxapi/endpoints'
7
+ require_relative 'fxapi/configuration'
8
+
9
+ module Fxapi
10
+ BASE_URL = 'https://api.fxapi.com/v1/'
11
+
12
+ class << self
13
+ attr_accessor :configuration
14
+ end
15
+
16
+ def self.configure
17
+ self.configuration ||= Fxapi::Configuration.new
18
+ yield(configuration)
19
+ end
20
+ end
@@ -0,0 +1,4 @@
1
+ module Currencyapi
2
+ VERSION: String
3
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
4
+ end
metadata ADDED
@@ -0,0 +1,93 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: fxapi
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-23 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 current and historical foreign currency exchanges rates. Stop worrying
43
+ about 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
+ - ".idea/.gitignore"
52
+ - ".idea/fxapi-ruby.iml"
53
+ - ".idea/modules.xml"
54
+ - ".idea/php.xml"
55
+ - CHANGELOG.md
56
+ - CODE_OF_CONDUCT.md
57
+ - Gemfile
58
+ - Gemfile.lock
59
+ - LICENSE.md
60
+ - README.md
61
+ - Rakefile
62
+ - currencyapi-1.0.0.gem
63
+ - lib/fxapi.rb
64
+ - lib/fxapi/configuration.rb
65
+ - lib/fxapi/endpoints.rb
66
+ - lib/fxapi/version.rb
67
+ - sig/currencyapi.rbs
68
+ homepage: https://fxapi.com/
69
+ licenses:
70
+ - MIT
71
+ metadata:
72
+ homepage_uri: https://fxapi.com/
73
+ source_code_uri: https://github.com/everapihq/fxapi-ruby
74
+ post_install_message:
75
+ rdoc_options: []
76
+ require_paths:
77
+ - lib
78
+ required_ruby_version: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: 2.6.0
83
+ required_rubygems_version: !ruby/object:Gem::Requirement
84
+ requirements:
85
+ - - ">="
86
+ - !ruby/object:Gem::Version
87
+ version: '0'
88
+ requirements: []
89
+ rubygems_version: 3.0.3.1
90
+ signing_key:
91
+ specification_version: 4
92
+ summary: A ruby wrapper for fxapi.com's API
93
+ test_files: []