freecurrencyapi-official 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 33c3fc7888dcff09e8afc8154a26ec19dfd8d682dc871fb2745e9fbc18ccf889
+  data.tar.gz: 1bab90ba7b948ef5c8c1918f56d56dca89c77f3de296d850c45f310d03221ceb
+SHA512:
+  metadata.gz: 023b6d81b920d9dacae5bc190a39deb5f738842a17e3adb60fa5f5afb639eeb13802f3d8ff58da13a0645f109e3cb031d2adc4de788fbf599994e30d874bad96
+  data.tar.gz: a07434efddff4f84562a3c7ff51819d6b00ed599eaa2c72b47e270a174cdac18b3eb7206e658e86a393660d97395c48e97ce1ca22c403899520b870b7abcae1d

data/README.md

@@ -0,0 +1,97 @@
+<p align="center">
+<img src="https://app.freecurrencyapi.com/img/logo/freecurrencyapi.png" width="300"/>
+</p>
+
+# freecurrencyapi-ruby
+
+freecurrencyapi-ruby is the official Ruby Wrapper around the [freecurrencyapi](https://app.freecurrencyapi.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'freecurrencyapi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install freecurrencyapi
+
+## Configuration
+
+You will need your apikey to use freecurrencyapi, you can get
+one [https://app.freecurrencyapi.com/register](https://app.freecurrencyapi.com/register) here.
+
+Create an instance and pass your api key like here:
+
+    fx = freecurrencyapi::Endpoints.new(:apikey => 'APIKEY')
+
+## Usage & Endpoints
+
+Use the instance to call the endpoints
+
+#### Status
+
+Returns your current quota
+
+    fx.status()
+
+#### Currencies
+
+Returns all our supported currencies
+
+    fx.currencies(currencies)
+
+| Parameter  | Data type | Mandatory | Description |
+------------| --- | ----------- | --- | ----------- |
+| 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 |
+
+#### Latest Exchange Rates
+
+Returns the latest exchange rates. The default base currency is USD.
+
+    fx.latest(base_currency, currencies)    
+
+| Parameter     | Data type | Mandatory | Description                                                                                                                     |
+|---------------|-----------|-----------|---------------------------------------------------------------------------------------------------------------------------------|
+| base_currency | string    | no        | By default all values are based on USD. By default all values are based on USD                                                  |
+| 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 |
+
+#### Historical Exchange Rates
+
+Returns the latest exchange rates. The default base currency is USD.
+
+    fx.historical(date, base_currency, currencies)    
+
+| Parameter     | Data type | Mandatory | Description                                                                                                                     |
+|---------------|-----------|-----------|---------------------------------------------------------------------------------------------------------------------------------|
+| date          | string    | yes       | Date to retrieve historical rates from (format: 2021-12-31)                                                                     |
+| base_currency | string    | no        | By default all values are based on USD. By default all values are based on USD                                                  |
+| 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 |
+
+
+You can find further information on https://freecurrencyapi.com/docs/
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/everapihq/freecurrencyapi. 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/freecurrencyapi-ruby/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the freecurrencyapi project's codebases, issue trackers, chat rooms and mailing lists is expected to
+follow the [code of conduct](https://github.com/everapihq/freecurrencyapi-ruby/blob/master/CODE_OF_CONDUCT.md).

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: freecurrencyapi-official
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dominik Kukacka
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The perfect tool to handle your exchange rate conversions. Our API helps
+  you with realtime & historical foreign currency exchanges rates. Stop worrying about
+  uptime & outdated exchange rate data.
+email:
+- office@everapi.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+homepage: https://freecurrencyapi.com/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://freecurrencyapi.com/
+  source_code_uri: https://github.com/everapihq/freecurrencyapi-ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper for freecurrencyapi.com's free currency API
+test_files: []