exchange_rate_jt 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66e1fb6a123341314b19f4911176fc17e79262cc
+  data.tar.gz: 0b09caa0e5ff4658dd67fcca983e65fc379c0727
+SHA512:
+  metadata.gz: cba3207db64b8d3b09c8359ad3e3caf9dc37ba5d72293d4e434d10bf03cd66a8b404d41da5127084725b00008d6206175f049a6e2c9dd8c7a9bd4bc784836a48
+  data.tar.gz: 74a76e2bb388abf10f9035a6eecb25ae82c0b4320f6814d18e17a11570794ffc7ae18a79b6eb5eacce76b606c38e5a5339ccbbe05c8efefb84820a9f6c9a62ac

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.15.4

data/ExchangeRateJt.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "exchange_rate_jt/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "exchange_rate_jt"
+  spec.version       = ExchangeRateJt::VERSION
+  spec.authors       = ["Joshua Toper"]
+  spec.email         = ["work@joshtoper.co.uk"]
+
+  spec.summary       = %q{Minimal gem for calculating exchange rates.}
+  spec.description   = %q{This is a self-contained gem which calculates exchange rates from a variety of sources. The gem caches all requests so that lookups can be performant.}
+  spec.homepage      = "http://www.joshtoper.co.uk"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_runtime_dependency 'nokogiri', '1.6.8'
+end

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in exchange_rate_jt.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Joshua Toper
+
+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,39 @@
+# ExchangeRateJt
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/exchange_rate_jt`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'exchange_rate_jt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exchange_rate_jt
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/JoshToper/exchange_rate_jt.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  exec "irb -r exchange_rate_jt -I ./lib"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "exchange_rate_jt"
+
+# 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/exchange_rate_jt/configuration.rb

@@ -0,0 +1,12 @@
+module ExchangeRateJt
+  class Configuration
+    attr_accessor :data_store, :data_store_type, :source, :default_currency
+
+    def initialize
+      @data_store = nil
+      @data_store_type = nil
+      @source = nil
+      @default_currency = nil
+    end
+  end
+end

data/lib/exchange_rate_jt/data_store/p_store_adaptor.rb

@@ -0,0 +1,32 @@
+require 'pstore'
+
+module ExchangeRateJt
+  module DataStore
+    class InvalidConnectionTypeError < StandardError; end
+    class DataNotFoundError < StandardError; end
+
+    class PStoreAdaptor
+      attr_reader :data_store
+
+      def initialize(data_store)
+        unless data_store.is_a?(PStore)
+          raise InvalidConnectionTypeError, 'Invalid connection type'
+        end
+        @data_store = data_store
+      end
+
+      def persist(key, value)
+        data_store.transaction do
+          data_store[key] = value
+          data_store.commit
+        end
+      end
+
+      def fetch(key, value)
+        data = data_store.transaction { data_store[key][value] }
+        raise DataNotFoundError, 'Data not found' if data.nil?
+        data
+      end
+    end
+  end
+end

data/lib/exchange_rate_jt/data_store_factory.rb

@@ -0,0 +1,18 @@
+require_relative 'data_store/p_store_adaptor'
+
+module ExchangeRateJt
+  class InvalidDataStoreTypeError < StandardError; end
+
+  # DataStoreFactory builds and returns an instance of the
+  # appropriate data store handler for the defined data store type
+  class DataStoreFactory
+    MAPS = { pstore: DataStore::PStoreAdaptor }.freeze
+    
+    def self.build(data_store_type, data_store)
+      MAPS[data_store_type].new(data_store)
+    rescue
+      raise InvalidDataStoreTypeError, 
+            'Invalid or no data store type specified'
+    end
+  end
+end

data/lib/exchange_rate_jt/exchange_rates.rb

@@ -0,0 +1,61 @@
+require 'bigdecimal'
+
+module ExchangeRateJt
+  class LookupError < StandardError; end
+  class UpdateError < StandardError; end
+  class InvalidDateError < StandardError; end
+  class FutureDateError < StandardError; end
+  class NoExchangeRateDataError < StandardError; end
+  class RateNotFoundError < StandardError; end
+
+  class ExchangeRates
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def update
+      rates = RatesSourceFactory.build(configuration.source).fetch_rates
+      rates.each { |date, values| data_store.persist(date, values) }
+      true
+    rescue => exception
+      raise UpdateError, exception.message
+    end
+
+    def at(date, base, counter)
+      validate_date(date)
+      date = date.strftime('%b_%d_%Y').to_sym.downcase
+
+      base = fetch_rate(date, base)
+      counter = fetch_rate(date, counter)
+
+      rate = counter / base
+
+      { status: :success, rate: BigDecimal.new(rate, 5) }
+    end
+
+    private
+
+    attr_reader :configuration
+
+    def data_store
+      @data_store ||= build_data_store
+    end
+
+    def build_data_store
+      DataStoreFactory
+        .build(configuration.data_store_type, configuration.data_store)
+    end
+
+    def fetch_rate(date, currency)
+      return 1 if currency.to_s == configuration.default_currency.to_s
+      data_store.fetch(date, currency)
+    rescue DataStore::DataNotFoundError
+      raise RateNotFoundError, 'Exchange rate data not found'
+    end
+
+    def validate_date(date)
+      raise InvalidDateError, 'Invalid date specified' unless date.is_a?(Date)
+      raise FutureDateError, 'Date cannot be in the future' if date > Date.today
+    end
+  end
+end

data/lib/exchange_rate_jt/rates_source/ecb.rb

@@ -0,0 +1,53 @@
+require 'nokogiri'
+require 'open-uri'
+
+module ExchangeRateJt
+  module RatesSource
+    class CouldNotFetchDataError < StandardError; end
+    class ParseError < StandardError; end
+
+    class ECB
+      REPOSITORY_URL = 'http://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist-90d.xml'.freeze
+
+      def fetch_rates
+        doc = fetch_source
+        parse(doc)
+      end
+
+      private
+
+      def fetch_source
+        Nokogiri::XML(open(REPOSITORY_URL, read_timeout: 5000))
+      rescue Timeout::Error
+        handle_fetch_error('the request timed out')
+      rescue OpenURI::HTTPError => error
+        handle_fetch_error(error)
+      end
+
+      def parse(doc)
+        daily_updates = doc.xpath('gesmes:Envelope/xmlns:Cube/xmlns:Cube')
+        daily_updates.each_with_object({}) do |daily_update, results_hash|
+          strtime = daily_update.attribute('time').value
+          date = format_date(strtime)
+          results_hash[date] = {}
+          daily_update.children.each do |rate|
+            curr = rate.attribute('currency').value
+            results_hash[date][curr] = rate.attribute('rate').value
+          end
+        end
+      rescue
+        raise ParseError, 'There was an error parsing the document'
+      end
+
+      def format_date(time_as_string)
+        DateTime.parse(time_as_string).strftime('%b_%d_%Y').downcase.to_sym
+      end
+
+      def handle_fetch_error(error)
+        response = error.io
+        code = response.status[0]
+        raise CouldNotFetchDataError, "There was an problem fetching the data from the source - #{code}"
+      end
+    end
+  end
+end

data/lib/exchange_rate_jt/rates_source_factory.rb

@@ -0,0 +1,11 @@
+require_relative 'rates_source/ecb'
+
+module ExchangeRateJt
+  class RatesSourceFactory
+    MAPS = { ecb: RatesSource::ECB }.freeze
+    
+    def self.build(source)
+      MAPS[source].new
+    end
+  end
+end

data/lib/exchange_rate_jt/version.rb

@@ -0,0 +1,3 @@
+module ExchangeRateJt
+  VERSION = "0.1.7"
+end

data/lib/exchange_rate_jt.rb

@@ -0,0 +1,32 @@
+require 'exchange_rate_jt/version'
+require 'exchange_rate_jt/configuration'
+require 'exchange_rate_jt/exchange_rates'
+require 'exchange_rate_jt/data_store_factory'
+require 'exchange_rate_jt/rates_source_factory'
+
+module ExchangeRateJt
+  class << self
+    attr_accessor :configuration
+    attr_accessor :exchange_rates
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.exchange_rates
+    @exchange_rates ||= ExchangeRates.new(configuration)
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.update_exchange_rates
+    exchange_rates.update
+  end
+
+  def self.at(date, base, counter)
+    exchange_rates.at(date, base, counter)
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: exchange_rate_jt
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+platform: ruby
+authors:
+- Joshua Toper
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+description: This is a self-contained gem which calculates exchange rates from a variety
+  of sources. The gem caches all requests so that lookups can be performant.
+email:
+- work@joshtoper.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ExchangeRateJt.gemspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exchange_rate_jt-0.1.0.gem
+- lib/exchange_rate_jt.rb
+- lib/exchange_rate_jt/configuration.rb
+- lib/exchange_rate_jt/data_store/p_store_adaptor.rb
+- lib/exchange_rate_jt/data_store_factory.rb
+- lib/exchange_rate_jt/exchange_rates.rb
+- lib/exchange_rate_jt/rates_source/ecb.rb
+- lib/exchange_rate_jt/rates_source_factory.rb
+- lib/exchange_rate_jt/version.rb
+homepage: http://www.joshtoper.co.uk
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Minimal gem for calculating exchange rates.
+test_files: []