exchangerate_host 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2b733284dbe5f7ac5c8a2319d805f045441b8584dd6ef32ab949bb872313ca2d
+  data.tar.gz: 0c32fc76a35080bb289fccc759c5a48f9de752508ae78198a7fafe2705306241
+SHA512:
+  metadata.gz: d19e19648209895fb2e998550487e71df88b961702ac2be96847200ca0b181824fb9d41f197990842976b21647fa49e44cffa27ad5f3104342e919279a4da18b
+  data.tar.gz: 25b9af691b46c5d06474e04d65fef70b30b34439df2390509825310abff16e04db2155302aa09d28af5a9966f2b327ec5eedf3d336ad4d78c8b3f18b588f5f22

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,200 @@
+AllCops:
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+Layout/ClosingHeredocIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+# Align if else statements.
+Layout/ElseAlignment:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+# Leave a line after frozenstring comment.
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+# Leave a line before access modifiers.
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: true
+  EnforcedStyle: only_before
+
+# In a regular block, no empty lines around the body.
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+Layout/FirstArgumentIndentation:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: indented_internal_methods
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAfterSemicolon:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+  Enabled: true
+
+Layout/SpaceBeforeComment:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/RedundantFreeze:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyleForEmptyBraces: space
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# TODO: What quote style????
+# Check quotes usage according to lint rule below.
+# Style/StringLiterals:
+#   Enabled: true
+#   EnforcedStyle: single_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/IndentationStyle:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/RedundantPercentQ:
+  Enabled: true
+
+Lint/AmbiguousOperator:
+  Enabled: true
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: true
+
+Lint/ErbNewArguments:
+  Enabled: true
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+# Check for outer and inner local block barivales sharing a name.
+# https://www.rubydoc.info/github/bbatsov/RuboCop/RuboCop/Cop/Lint/ShadowingOuterLocalVariable
+Lint/ShadowingOuterLocalVariable:
+  Enabled: true
+
+Lint/RedundantStringCoercion:
+  Enabled: true
+
+Lint/UriEscapeUnescape:
+  Enabled: true
+
+Lint/UselessAssignment:
+  Enabled: true
+
+# Checks for depricated ruby class methods.
+# https://www.rubydoc.info/github/bbatsov/RuboCop/RuboCop/Cop/Lint/DeprecatedClassMethods
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Style/ParenthesesAroundCondition:
+  Enabled: true
+
+Style/RedundantBegin:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+# Prefer Foo.method over Foo::method
+Style/ColonMethodCall:
+  Enabled: true
+
+Style/TrivialAccessors:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in exchangerate_host.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+gem 'httparty'

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    exchangerate_host (0.0.1)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0704)
+    multi_xml (0.6.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  exchangerate_host!
+  httparty
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,136 @@
+# ExchangerateHost
+
+ExchangerateHost is a very simple gem to integrate your ruby application with [exchangerate.host](https://exchangerate.host) 🚀  
+[exchangerate.host](https://exchangerate.host) is a great service that provide us completely free curreny exhange rates APIs (you don't even need to make an account & api key!! Really easy to get started 🙂 ).  
+  
+Let's [support](https://exchangerate.host/#/donate) their mission if you're happy with the service and willing to donate 👼
+
+## Installation
+Install with the following command:
+
+    $ gem install exchangerate_host
+
+For rails appliactions, add this line to your application's Gemfile:
+
+```ruby
+gem 'exchangerate_host'
+```
+
+And then execute:
+
+    $ bundle install
+    
+## Supported services
+| Service | Descriptoin | Supported |
+| ------------- | ------ |:-------------:|
+| Latest rates | The latest exchage rate data updated on daily basis | ✔️ |
+| Convert currency | Convert any amount from one currency to another | ✔️ |
+| Historical rates | Currency rates histrical data all the way back to the year of `1999` | ✔️ |
+| Time-Series data | Historical rates between two dates of your choic. (maximum time frame of `366 days`) | ✔️ |
+| Fluctuation data | Historical data about how currencies fluctuate on a day-to-day basis (maximum time frame of `366 days`) | ✔️ |
+| Supported symbols | All available currencies | ✔️ |
+| EU VAT Rates | Request a single by country code or entire set EU VAT rates | WIP |
+
+You can find details about services in [here](https://exchangerate.host/#/#our-services)
+## Parameters
+| Parameter | Description | Example | Note |
+| ------------- |:-------------:| :---: | :-----: |
+| base | Your preferred base currency | JPY | non case sensitive |
+| symbols | Currency codes to limit output currencies | [:JPY, :AUD, :USD] | non case sensitive |
+| amount | The amount to be converted | 123.45 | - |
+| places | Decimal places | 2 | - |
+| format | Output format | CSV | CSV, TSV or XML |
+| from | The currecny you would like to convert from | JPY | non case sensitive |
+| to | The currecny you would like to convert to | AUD | non case sensitive |
+| date | Historical exchange rate date | 2020-12-21 | format YYYY-MM-DD |
+| start_date | The start date of your preferred timeframe | 2020-12-21 | format YYYY-MM-DD |
+| end_date | The end date of your preferred timeframe | 2020-12-21 | format YYYY-MM-DD |
+
+## Service Paramters 
+🟢 _optional_  🔴 _required_
+| Service | base | symbols | amount | places | format | from | to | date | start_date | end_date |
+|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|
+| Latest rates | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | - | - | - | - | - |
+| Convert currency | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | - | - |
+| Historical rates | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | - | - | 🔴 | - | - |
+| Time-Series data | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | - | - | - | 🔴 | 🔴 |
+| Fluctuation data | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | - | - | - | 🔴 | 🔴 |
+| Supported symbols | - | - | - | - | 🟢 | - | - | - | - | - |
+  
+  
+If `base` option is not given, `EUR` will be assigned  
+If `amount` option is not given, `1` will be assigned  
+  
+## Usage
+You can make call supporetd survices with following APIs
+| Service | method | arguments |
+| ------------- |:-------------:| :-------------:|
+| Latest rates | ExchangerateHost.latest_rates(options) | options: Hash |
+| Convert currency | ExchangerateHost.convert_currency(options) | options: Hash |
+| Historical rates | ExchangerateHost.historical_rates(options) | options: Hash |
+| Time-Series data | ExchangerateHost.time_series(options) | options: Hash |
+| Fluctuation data | ExchangerateHost.fluctuation(options) | options: Hash |
+| Supported symbols |ExchangerateHost.supported_symbols(options) | options: Hash |
+   
+  
+  
+_exmaples_
+```ruby
+  # Decimal place 2
+  ExchangerateHost.configurations.places = 2
+
+  # How much is 1000 yen in AUD and USD with the latest currency rates
+  res = ExchangerateHost.latest_rates({ base: :JPY, amount: 1000, symbols: [:AUD, :USD] })
+  res['rates'] #=> {"AUD"=>12.59, "USD"=>9.1}
+    
+  # How much is 150 AUD in JPY on 2015 December 21st
+  res = ExchangerateHost.convert_currency({ from: :AUD, to: :JPY, date: '2015-12-21', amount: 150 })
+  res['result'] #=> 13038.47
+    
+  # What were the all supported currency rates for 1 AUD on 2020 December 21st
+  res = ExchangerateHost.historical_rates({date: '2020-12-21', base: :USD })
+  res['rates'] #=> { "AED"=>3.69, "AFN"=>77.4, "ALL"=>101.52... }
+    
+  # What were the JPY and USD rates based on 1 AUD between 2021 January 1st ~ 2021 Febrary 1st
+  res = ExchangerateHost.time_series({ base: :AUD, symbols: [:JPY, :USD], start_date: '2021-01-01', end_date: '2021-02-01' })
+  res['rates'] #=> {"2021-01-01"=>{"JPY"=>79.56, "USD"=>0.77}, "2021-01-02"=>{"JPY"=>79.29, "USD"=>0.77}, "2021-01-03"=>{"JPY"=>79.42, "USD"=>0.77},... }
+    
+  # How much JPY and USD rates based on 1 AUD fluctuated between 2020 January 1st ~ 2020 October 1st
+  res = ExchangerateHost.fluctuation({ base: :AUD, symbols: [:JPY, :USD], start_date: '2020-01-01', end_date: '2020-10-01' })
+  res['rates'] #=> {"USD"=>{"start_rate"=>0.7, "end_rate"=>0.72, "change"=>-0.02, "change_pct"=>-0.03}, "JPY"=>{... }
+    
+  # What are the suported currencies
+  res = ExchangerateHost.supported_symbols
+  res['symbols'] #=> {"AED"=>{"description"=>"United Arab Emirates Dirham", "code"=>"AED"}, "AFN"=>{"description"=>"Afghan Afghani", "code"=>"AFN"}... }
+```
+
+## Setup default parameter options
+You can set default parameter options so that you don't need to pass the same options everytime.  
+```ruby
+  ExchangerateHost.configure do |conf|
+    conf.base = :JPY
+    conf.symbols = [:AUD, :USD]
+  end
+  # or
+  ExchangerateHost.configurations.base = :JPY
+    
+  # print currernt configuratoins
+  ExchangerateHost.configurations.to_options_hash #=> {:base=>:JPY, :symbols=>[:AUD, :USD]}
+      
+  # reset configurations
+  ExchangerateHost.reset_configurations
+  ExchangerateHost.configurations.to_options_hash #=> {}
+    
+  # default options will be overwritten by the passed option value
+  ExchangerateHost.configurations.base = :JPY
+  
+  ExchangerateHost.latest_rates #=> the base option for the request is JPY
+  ExchangerateHost.latest_rates({ base: :AUD }) #=> the base option for the request is now AUD
+```
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/MizukiZ/exchangerate_host. 🙏
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "exchangerate_host"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exchangerate_host.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/exchangerate_host/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "exchangerate_host"
+  spec.version       = ExchangerateHost::VERSION
+  spec.authors       = ["Mizuki Zenta"]
+  spec.email         = ["mizukisb@gmail.com"]
+
+  spec.summary       = 'A Ruby library to integrate ruby application with exchangerate.host'
+  spec.description   = 'A Ruby library to integrate ruby application with exchangerate.host'
+  spec.homepage      = 'https://github.com/MizukiZ/exchangerate_host'
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.license       = 'MIT'
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = 'https://github.com/MizukiZ/exchangerate_host'
+  spec.metadata["changelog_uri"] = 'https://github.com/MizukiZ/exchangerate_host'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty"
+end

data/lib/exchangerate_host/configurations.rb

@@ -0,0 +1,16 @@
+module ExchangerateHost
+  class Configurations
+    attr_accessor :base, :symbols, :places, :amount, :format, :from, :to, :date, :start_date, :end_date
+
+    def initialize
+      # Default value can be set here.
+      # @places = 2
+    end
+
+    def to_options_hash
+      self.instance_variables.map do |var|
+        [var[1..-1].to_sym, self.instance_variable_get(var)]
+      end.to_h
+    end
+  end
+end

data/lib/exchangerate_host/endpoints/base.rb

@@ -0,0 +1,54 @@
+require 'httparty'
+require 'date'
+require 'exchangerate_host/endpoints/validation'
+
+module ExchangerateHost
+  module Endpoints
+    class Base
+      include HTTParty
+      extend Endpoints::Validation
+
+      base_uri 'https://api.exchangerate.host'
+
+      class << self
+        def available_options
+          required_options + optional_options
+        end
+
+        def endpoint_path
+          ''
+        end
+
+        def optional_options
+          raise NotImplementedError
+        end
+
+        def required_options
+          []
+        end
+
+        def request(options)
+          @query = query_options(options)
+          res = get(
+            "/#{endpoint_path}",
+            { query: @query }
+          )
+          .body
+
+          res = JSON.parse(res) unless @query[:format]
+          res
+        end
+
+        def query_options(options)
+          config_options = ExchangerateHost.configurations.to_options_hash.slice(*available_options)
+          merged_options = config_options.merge(options)
+
+          validate(merged_options)
+          merged_options[:symbols] = to_upcase_csv(merged_options[:symbols]) if merged_options.key?(:symbols)
+
+          merged_options
+        end
+      end
+    end
+  end
+end

data/lib/exchangerate_host/endpoints/convert_currency.rb

@@ -0,0 +1,20 @@
+require 'exchangerate_host/endpoints/base'
+module ExchangerateHost
+  module Endpoints
+    class ConvertCurrency < Base
+      class << self
+        def optional_options
+          [:base, :symbols, :places, :amount, :format, :date]
+        end
+
+        def required_options
+          [:from, :to]
+        end
+
+        def endpoint_path
+          'convert'
+        end
+      end
+    end
+  end
+end

data/lib/exchangerate_host/endpoints/fluctuation.rb

@@ -0,0 +1,20 @@
+require 'exchangerate_host/endpoints/base'
+module ExchangerateHost
+  module Endpoints
+    class Fluctuation < Base
+      class << self
+        def optional_options
+          [:base, :symbols, :places, :amount, :format]
+        end
+
+        def required_options
+          [:start_date, :end_date]
+        end
+
+        def endpoint_path
+          'fluctuation'
+        end
+      end
+    end
+  end
+end

data/lib/exchangerate_host/endpoints/historical_rates.rb

@@ -0,0 +1,20 @@
+require 'exchangerate_host/endpoints/base'
+module ExchangerateHost
+  module Endpoints
+    class HistoricalRates < Base
+      class << self
+        def optional_options
+          [:base, :symbols, :places, :amount, :format]
+        end
+
+        def required_options
+          [:date]
+        end
+
+        def endpoint_path
+          @query[:date]
+        end
+      end
+    end
+  end
+end

data/lib/exchangerate_host/endpoints/latest_rates.rb

@@ -0,0 +1,16 @@
+require 'exchangerate_host/endpoints/base'
+module ExchangerateHost
+  module Endpoints
+    class LatestRates < Base
+      class << self
+        def optional_options
+          [:base, :symbols, :places, :amount, :format]
+        end
+
+        def endpoint_path
+          'latest'
+        end
+      end
+    end
+  end
+end

data/lib/exchangerate_host/endpoints/supported_symbols.rb

@@ -0,0 +1,16 @@
+require 'exchangerate_host/endpoints/base'
+module ExchangerateHost
+  module Endpoints
+    class SupportedSymbols < Base
+      class << self
+        def optional_options
+          [:format]
+        end
+
+        def endpoint_path
+          'symbols'
+        end
+      end
+    end
+  end
+end

data/lib/exchangerate_host/endpoints/time_series.rb

@@ -0,0 +1,20 @@
+require 'exchangerate_host/endpoints/base'
+module ExchangerateHost
+  module Endpoints
+    class TimeSeries < Base
+      class << self
+        def optional_options
+          [:base, :symbols, :places, :amount, :format]
+        end
+
+        def required_options
+          [:start_date, :end_date]
+        end
+
+        def endpoint_path
+          'timeseries'
+        end
+      end
+    end
+  end
+end

data/lib/exchangerate_host/endpoints/validation.rb

@@ -0,0 +1,106 @@
+module ExchangerateHost
+  module Endpoints
+    module Validation
+      ACCEPTABLE_DATE_FORMAT = /^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$/.freeze
+
+      VALID_SYMBOLS = [
+        :AED, :AFN, :ALL, :AMD, :ANG, :AOA, :ARS, :AUD, :AWG, :AZN, :BAM, :BBD,
+        :BDT, :BGN, :BHD, :BIF, :BMD, :BND, :BOB, :BRL, :BSD, :BTC, :BTN, :BWP,
+        :BYN, :BZD, :CAD, :CDF, :CHF, :CLF, :CLP, :CNH, :CNY, :COP, :CRC, :CUC,
+        :CUP, :CVE, :CZK, :DJF, :DKK, :DOP, :DZD, :EGP, :ERN, :ETB, :EUR, :FJD,
+        :FKP, :GBP, :GEL, :GGP, :GHS, :GIP, :GMD, :GNF, :GTQ, :GYD, :HKD, :HNL,
+        :HRK, :HTG, :HUF, :IDR, :ILS, :IMP, :INR, :IQD, :IRR, :ISK, :JEP, :JMD,
+        :JOD, :JPY, :KES, :KGS, :KHR, :KMF, :KPW, :KRW, :KWD, :KYD, :KZT, :LAK,
+        :LBP, :LKR, :LRD, :LSL, :LYD, :MAD, :MDL, :MGA, :MKD, :MMK, :MNT, :MOP,
+        :MRO, :MRU, :MUR, :MVR, :MWK, :MXN, :MYR, :MZN, :NAD, :NGN, :NIO, :NOK,
+        :NPR, :NZD, :OMR, :PAB, :PEN, :PGK, :PHP, :PKR, :PLN, :PYG, :QAR, :RON,
+        :RSD, :RUB, :RWF, :SAR, :SBD, :SCR, :SDG, :SEK, :SGD, :SHP, :SLL, :SOS,
+        :SRD, :SSP, :STD, :STN, :SVC, :SYP, :SZL, :THB, :TJS, :TMT, :TND, :TOP,
+        :TRY, :TTD, :TWD, :TZS, :UAH, :UGX, :USD, :UYU, :UZS, :VEF, :VES, :VND,
+        :VUV, :WST, :XAF, :XAG, :XAU, :XCD, :XDR, :XOF, :XPD, :XPF, :XPT, :YER,
+        :ZAR, :ZMW, :ZWL].freeze
+
+      VALID_FORMAT = [:CSV, :TSV, :XML].freeze
+
+      ALL_OPTIONS_WITH_VALIDATE_METHODS = {
+        from: { validate_with: VALID_SYMBOLS, action: :subset },
+        to: { validate_with: VALID_SYMBOLS, action: :subset },
+        date: { validate_with: ACCEPTABLE_DATE_FORMAT, action: :date },
+        start_date: { validate_with: ACCEPTABLE_DATE_FORMAT, action: :date },
+        end_date: { validate_with: ACCEPTABLE_DATE_FORMAT, action: :date },
+        base: { validate_with: VALID_SYMBOLS, action: :subset },
+        symbols: { validate_with: VALID_SYMBOLS, action: :subset },
+        places: { validate_with: :PositiveInteger, action: :type },
+        amount: { validate_with: :Numeric, action: :type },
+        format: { validate_with: VALID_FORMAT, action: :subset },
+      }.freeze
+
+      def to_upcase_csv(array)
+        return '' unless array
+
+        array.map(&:upcase).join(',')
+      end
+
+      def validate_with_type(option, validate_with, v)
+        if validate_with == :PositiveInteger
+          raise "#{option} must be a positive whole number" unless is_positive_integer?(v)
+        elsif validate_with == :Numeric
+          raise "#{option} must be a number" unless v.is_a?(Numeric)
+        end
+      end
+
+      def is_positive_integer?(v)
+        v.is_a?(Integer) && v > 0
+      end
+
+      def non_subset_values(array, original_array)
+        array.map(&:to_sym) - original_array
+      end
+
+      def validate_subset(array, original_array)
+        invalid_values = non_subset_values(array, original_array)
+        raise "Invalid options/values detected: #{invalid_values.join(', ')}" if invalid_values.any?
+      end
+
+      def validate_date(date)
+        raise 'Invalid date format. Please use YYYY-MM-DD' unless date =~ ACCEPTABLE_DATE_FORMAT
+        Date.parse(date) # this is only for validation purpose
+      end
+
+      def validate(options)
+        validate_options(options)
+
+        options.each do |option, value|
+          validate_option_values(option, value)
+        end
+      end
+
+      def validate_options(options)
+        option_keys = options.keys
+
+        validate_required_options(option_keys) if required_options.any?
+
+        return if option_keys.empty?
+        validate_subset(option_keys, available_options)
+      end
+
+      def validate_option_values(option, v)
+        validate_with = ALL_OPTIONS_WITH_VALIDATE_METHODS[option][:validate_with]
+        validate_action = ALL_OPTIONS_WITH_VALIDATE_METHODS[option][:action]
+
+        if validate_action == :subset
+          validate_subset(Array(v).map(&:upcase), validate_with)
+        elsif validate_action == :type
+          validate_with_type(option, validate_with, v)
+        elsif validate_action == :date
+          validate_date(v)
+        end
+      end
+
+      def validate_required_options(option_keys)
+        missing_required_options = required_options - option_keys
+        raise "Missing required options: #{missing_required_options.join(', ')}" if missing_required_options.any?
+      end
+    end
+  end
+end

data/lib/exchangerate_host/version.rb

@@ -0,0 +1,3 @@
+module ExchangerateHost
+  VERSION = "0.0.1"
+end

data/lib/exchangerate_host.rb

@@ -0,0 +1,50 @@
+require 'exchangerate_host/endpoints/latest_rates'
+require 'exchangerate_host/endpoints/supported_symbols'
+require 'exchangerate_host/endpoints/convert_currency'
+require 'exchangerate_host/endpoints/historical_rates'
+require 'exchangerate_host/endpoints/time_series'
+require 'exchangerate_host/endpoints/fluctuation'
+require 'exchangerate_host/version'
+require 'exchangerate_host/configurations'
+
+module ExchangerateHost
+  class << self
+    attr_accessor :configurations
+
+    def configurations
+      @configurations ||= Configurations.new
+    end
+
+    def configure
+      yield(configurations)
+    end
+
+    def reset_configurations
+      @configurations = Configurations.new
+    end
+
+    def latest_rates(options = {})
+      Endpoints::LatestRates.request(options)
+    end
+
+    def convert_currency(options = {})
+      Endpoints::ConvertCurrency.request(options)
+    end
+
+    def historical_rates(options = {})
+      Endpoints::HistoricalRates.request(options)
+    end
+
+    def time_series(options = {})
+      Endpoints::TimeSeries.request(options)
+    end
+
+    def fluctuation(options = {})
+      Endpoints::Fluctuation.request(options)
+    end
+
+    def supported_symbols(options = {})
+      Endpoints::SupportedSymbols.request(options)
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: exchangerate_host
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mizuki Zenta
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: A Ruby library to integrate ruby application with exchangerate.host
+email:
+- mizukisb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exchangerate_host.gemspec
+- lib/exchangerate_host.rb
+- lib/exchangerate_host/configurations.rb
+- lib/exchangerate_host/endpoints/base.rb
+- lib/exchangerate_host/endpoints/convert_currency.rb
+- lib/exchangerate_host/endpoints/fluctuation.rb
+- lib/exchangerate_host/endpoints/historical_rates.rb
+- lib/exchangerate_host/endpoints/latest_rates.rb
+- lib/exchangerate_host/endpoints/supported_symbols.rb
+- lib/exchangerate_host/endpoints/time_series.rb
+- lib/exchangerate_host/endpoints/validation.rb
+- lib/exchangerate_host/version.rb
+homepage: https://github.com/MizukiZ/exchangerate_host
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/MizukiZ/exchangerate_host
+  source_code_uri: https://github.com/MizukiZ/exchangerate_host
+  changelog_uri: https://github.com/MizukiZ/exchangerate_host
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: A Ruby library to integrate ruby application with exchangerate.host
+test_files: []