seven_bank_fx_rate 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 27785e430ec8ad56d4f8a8e15eb1b549a5a0158596e50ad44f31feff6cf9b7d1
+  data.tar.gz: c68def2502e4a0d4155d4e6c787acafc4d871b12cc1ea6f07678d6a151e5dfa3
+SHA512:
+  metadata.gz: d9470dda92c3bcd91e129b6d6f826eb92395296360551207ef939eff9bcb95526734e7fc55b10aa173ef4e415f6f924aab0913885029d21aa9900c7a275b7a46
+  data.tar.gz: 074d973f412d82ac61eb5b1d103ba827824bfb66ddcd744a048487af74afb3430b78e4594b56537b3d4cc1e773216257ad856be792d43dcbd2f904a89ab21151

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+### v1.0.0
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andy.jiang@appier.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in seven_bank_fx_rate.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Andy Jiang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# SevenBankFxRate
+
+Easier access to the foreign exchange rate data of Seven Bank international
+money transfer service in Japan, with JPY1.00 as the base currency and unit.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'seven_bank_fx_rate'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install seven_bank_fx_rate
+
+## Usage
+
+- Require the module
+```ruby
+require 'seven_bank_fx_rate'
+```
+
+- Get meta information:
+```ruby
+SevenBankFxRate.create_date
+SevenBankFxRate.apply_date
+SevenBankFxRate.apply_time
+SevenBankFxRate.data_count
+```
+
+- Get exchange rate with specific country code and currency code:
+```ruby
+# methods:
+SevenBankFxRate.for :xx, :yyy
+SevenBankFxRate.find 'xx', 'yyy'
+SevenBankFxRate.country_xx_currency_yyy
+
+# examples:
+SevenBankFxRate.for :cn, :cny
+SevenBankFxRate.for 'cn', 'usd'
+SevenBankFxRate.for :cn, :CNY
+SevenBankFxRate.for :CN, :usd
+SevenBankFxRate.find :cn, :cny
+SevenBankFxRate.find 'cn', 'usd'
+SevenBankFxRate.country_cn_currency_cny
+SevenBankFxRate.country_CN_currency_USD
+
+# notes:
+# * xx standards for country code and yyy standards for currency code
+# * both symbol and string formats can be used for either code
+# * both country code and currency code are case insensitive
+# * country code reference: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
+# * currency code reference: https://en.wikipedia.org/wiki/ISO_4217
+```
+
+- Get an array of exchange rate for all available countries and currencies:
+```ruby
+SevenBankFxRate.all
+```
+
+- Forcibly update latest data:
+```ruby
+SevenBankFxRate.update!
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yuan-jiang/seven_bank_fx_rate. 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/yuan-jiang/seven_bank_fx_rate/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 SevenBankFxRate project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yuan-jiang/seven_bank_fx_rate/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'seven_bank_fx_rate'
+
+# 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/lib/seven_bank_fx_rate.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Easier access to the foreign exchange rate data of Seven Bank international
+# money transfer service in Japan, with JPY1.00 as the base currency and unit.
+#
+# Example of usage:
+#
+# - Get meta information:
+#   SevenBankFxRate.create_date
+#   SevenBankFxRate.apply_date
+#   SevenBankFxRate.apply_time
+#   SevenBankFxRate.data_count
+#
+# - Get exchange rate with specific country code and currency code:
+# Method patterns:
+#   SevenBankFxRate.for :xx, :yyy
+#   SevenBankFxRate.find 'xx', 'yyy'
+#   SevenBankFxRate.country_xx_currency_yyy
+# where xx is country code and yyy is currency code; both symbol and
+# string can be used for either code with case-insensitive formats:
+# e.g.
+#   SevenBankFxRate.for :cn, :cny
+#   SevenBankFxRate.for 'cn', 'usd'
+#   SevenBankFxRate.for :cn, :CNY
+#   SevenBankFxRate.for :CN, :usd
+#   SevenBankFxRate.find :cn, :cny
+#   SevenBankFxRate.find 'cn', 'usd'
+#   SevenBankFxRate.country_cn_currency_cny
+#   SevenBankFxRate.country_CN_currency_USD
+#
+# Country codes reference:
+#   https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
+# Currency codes reference:
+#   https://en.wikipedia.org/wiki/ISO_4217
+#
+# - Get an array of exchange rate for all available countries and currencies:
+#   SevenBankFxRate.all
+#
+# - Forcibly update latest data:
+#   SevenBankFxRate.update!
+#
+module SevenBankFxRate
+  require 'seven_bank_fx_rate/version'
+  require 'seven_bank_fx_rate/agent'
+  require 'seven_bank_fx_rate/parser'
+  require 'seven_bank_fx_rate/elements/meta'
+  require 'seven_bank_fx_rate/elements/country'
+  require 'seven_bank_fx_rate/elements/currency'
+  require 'seven_bank_fx_rate/seven_bank_fx_rate'
+end

data/lib/seven_bank_fx_rate/agent.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'net/http'
+
+module SevenBankFxRate
+  SOURCE_URL = 'https://www.sevenbank.co.jp/t/html/file/CurrentFXList.xml'
+
+  # Sends http request to fetch the latest exchange rate data
+  class Agent
+    # Fetches the latest data as Net::HTTPResponse object
+    # @return the body of Net::HTTPResponse
+    #
+    # @raise errors if response code is not '200', or any network failure
+    def self.response
+      puts "Sending http request to: #{SOURCE_URL}" if $DEBUG
+      response = Net::HTTP.get_response URI.parse(SOURCE_URL)
+      unless response.code == '200'
+        puts response.body if $DEBUG
+        raise StandardError,
+              "Unexpected response from fetching latest data: #{response.code}"
+      end
+      response.body
+    end
+  end
+end

data/lib/seven_bank_fx_rate/elements/country.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SevenBankFxRate
+  module Elements
+    # Corresponds to the country tag in xml:
+    # <country>
+    #   <countrycode>CN</countrycode>
+    #   <countryname>China</countryname>
+    #   <currency>
+    #     <currencycode>CNY</currencycode>
+    #     <currencyname>Chinese Yuan Renminbi</currencyname>
+    #     <fxrate>0.0636548</fxrate>
+    #   </currency>
+    #   <currency>
+    #     <currencycode>USD</currencycode>
+    #     <currencyname>US Dollar</currencyname>
+    #     <fxrate>0.0093211</fxrate>
+    #   </currency>
+    # </country>
+    class Country
+      attr_accessor :country_code, :country_name, :currencies
+    end
+  end
+end

data/lib/seven_bank_fx_rate/elements/currency.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SevenBankFxRate
+  module Elements
+    # Corresponds to the currency tag in xml:
+    # <currency>
+    #   <currencycode>USD</currencycode>
+    #   <currencyname>US Dollar</currencyname>
+    #   <fxrate>0.0090386</fxrate>
+    # </currency>
+    class Currency
+      attr_accessor :currency_code, :currency_name, :fx_rate
+    end
+  end
+end

data/lib/seven_bank_fx_rate/elements/meta.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SevenBankFxRate
+  module Elements
+    # Corresponds to the header tag in xml:
+    # <header>
+    #   <createdate>20200903</createdate>
+    #   <applydate>20200903</applydate>
+    #   <applytime>0800</applytime>
+    #   <datacount>0288</datacount>
+    # </header>
+    class Meta
+      attr_accessor :create_date, :apply_date, :apply_time, :data_count
+    end
+  end
+end

data/lib/seven_bank_fx_rate/parser.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'rexml/document'
+
+module SevenBankFxRate
+  # Parses xml response content and convert to ruby objects
+  class Parser
+    # @param response the body of Net::HTTPResponse
+    def initialize(response)
+      @root = REXML::Document.new(response).root
+      @meta = Elements::Meta.new
+      @countries = []
+    end
+
+    # Parses the <header> section in original xml response
+    # @return instance of SevenBankFxRate::Elements::Meta
+    def meta
+      return @meta unless @root
+
+      %w[create_date apply_date apply_time data_count].each do |attr|
+        @root.elements.each("header/#{attr.split('_').join}") do |e|
+          @meta.send("#{attr}=".to_sym, e.text.strip)
+        end
+      end
+      @meta
+    end
+
+    # Parses the <countries> section in original xml response
+    # @return an array of SevenBankFxRate::Elements::Country
+    def countries
+      return @countries unless @root
+
+      @root.elements.each('countries/country') do |country_tag|
+        country = Elements::Country.new
+        %w[country_code country_name].each do |attr|
+          country_tag.elements.each(attr.split('_').join) do |e|
+            country.send("#{attr}=".to_sym, e.text.strip)
+          end
+        end
+        country.currencies = currencies country_tag
+        @countries << country
+      end
+      @countries
+    end
+
+    private
+
+    # Parses the <currencies> section in original xml response
+    # @return an array of SevenBankFxRate::Elements::Currency
+    def currencies(country_tag)
+      currencies = []
+      country_tag.elements.each('currency') do |currency_tag|
+        currency = Elements::Currency.new
+        %w[currency_code currency_name fx_rate].each do |attr|
+          currency_tag.elements.each(attr.split('_').join) do |e|
+            currency.send("#{attr}=".to_sym, e.text.strip)
+          end
+        end
+        currencies << currency
+      end
+      currencies
+    end
+  end
+end

data/lib/seven_bank_fx_rate/seven_bank_fx_rate.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module SevenBankFxRate
+  class << self
+    # Methods to access meta attributes of the latest exchange rate data
+    %i[create_date apply_date apply_time data_count].each do |attr|
+      define_method attr do
+        data.meta.send attr
+      end
+    end
+
+    # @return exchange rate for given country code and currency code or nil
+    #
+    # if either country or currency code is invalid or when there is no
+    # exchange rate data available for the country and currency combination
+    def for(country_code, currency_code)
+      country = all.find do |c|
+        c.country_code == country_code.to_s.upcase
+      end
+      return unless country
+
+      currency = country.currencies.find do |c|
+        c.currency_code == currency_code.to_s.upcase
+      end
+      currency&.fx_rate
+    end
+
+    alias find for
+
+    # @return exchange rate data for all available countries
+    #
+    # as an array of SevenBankFxRate::Elements::Country
+    def all
+      data.countries
+    end
+
+    # Upon accessing of any of the public methods, the exchange rate data are
+    # fetched once and then cached for the lifetime of the module, because the
+    # remote xml source is updated only 3 times a day based on the website.
+    #
+    # However, this method still allows fetching the latest data when needed.
+    def update!
+      @data = Data.new
+      true
+    end
+
+    private
+
+    def data
+      @data ||= Data.new
+    end
+
+    def method_missing(method_name, *arguments, &block)
+      if /\Acountry_[A-Za-z]{2}_currency_[A-Za-z]{3}\z/ =~ method_name.to_s
+        _, country_code, _, currency_code = method_name.to_s.split('_')
+        send :for, country_code, currency_code
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      method_name.to_s.start_with?('country_') || super
+    end
+  end
+
+  # Holds the parsed exchange rate data represented by
+  # ruby objects converted from original xml content
+  class Data
+    attr_reader :meta, :countries
+
+    def initialize
+      parser = Parser.new Agent.response
+      @meta = parser.meta
+      @countries = parser.countries
+    end
+  end
+end

data/lib/seven_bank_fx_rate/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SevenBankFxRate
+  VERSION = '1.0.0'
+end

data/seven_bank_fx_rate.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/seven_bank_fx_rate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'seven_bank_fx_rate'
+  spec.version       = SevenBankFxRate::VERSION
+  spec.authors       = ['Andy Jiang']
+  spec.email         = ['yuanjiang@outlook.com']
+
+  spec.summary       = 'Easier access to the foreign exchange rate data of Seven Bank international money transfer service in Japan.'
+  spec.homepage      = 'https://github.com/yuan-jiang/seven_bank_fx_rate'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/yuan-jiang/seven_bank_fx_rate/blob/master/CHANGELOG.md'
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.0'
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: seven_bank_fx_rate
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andy Jiang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- yuanjiang@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/seven_bank_fx_rate.rb
+- lib/seven_bank_fx_rate/agent.rb
+- lib/seven_bank_fx_rate/elements/country.rb
+- lib/seven_bank_fx_rate/elements/currency.rb
+- lib/seven_bank_fx_rate/elements/meta.rb
+- lib/seven_bank_fx_rate/parser.rb
+- lib/seven_bank_fx_rate/seven_bank_fx_rate.rb
+- lib/seven_bank_fx_rate/version.rb
+- seven_bank_fx_rate.gemspec
+homepage: https://github.com/yuan-jiang/seven_bank_fx_rate
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/yuan-jiang/seven_bank_fx_rate
+  source_code_uri: https://github.com/yuan-jiang/seven_bank_fx_rate
+  changelog_uri: https://github.com/yuan-jiang/seven_bank_fx_rate/blob/master/CHANGELOG.md
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Easier access to the foreign exchange rate data of Seven Bank international
+  money transfer service in Japan.
+test_files: []