fafx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93feca2af8fb931f0c8e62b0f3aea2bf24eaaf9c
+  data.tar.gz: 4bcdfbf6645958ed69b014d6d5f737728b6e36b0
+SHA512:
+  metadata.gz: 1e52c5a8b4c5c7895ff69da56cb93c8807e8fd8b47dbcbc8636254e9772c99c216b7518eb05295ed02750e34a6202c303de81e3518d598ed4d5676a99e393f9f
+  data.tar.gz: 240f24101ace83b8f0829d77bfb14896490b227ac4e8aa61a38b8374f38d464dfc14c60c3e877f44596d60e7b76b92bf3e778477e0e7e34ce048fc00cb50f0c6

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/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.16.1
+script:
+  - bundle exec rspec

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 fafx.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    fafx (0.1.0)
+      nokogiri (~> 1.8.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  fafx!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Frank Kair
+
+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,59 @@
+# FAFX
+
+[![Build Status](https://travis-ci.org/FrankKair/fafx.svg?branch=master)](https://travis-ci.org/FrankKair/fafx)
+
+### Installation
+
+`$ gem install fafx`
+
+### CLI
+
+`$ fafx`
+
+```
+Usage: fafx [options]
+        --recent      Lists most recent rates
+        --currencies  Lists available currencies
+        --dates       Lists available dates
+        --update      Fetches new data from the web
+```
+
+### Example of client usage
+
+```ruby
+require 'Date'
+require 'fafx'
+
+puts Fafx::ExchangeRate.at(Date.today, 'GBP', 'USD')
+puts Fafx::ExchangeRate.currencies_available
+puts Fafx::ExchangeRate.dates_available
+puts Fafx::ExchangeRate.most_recent
+```
+
+This code outputs:
+
+```
+1.2951995012468827
+
+USD
+JPY
+BGN
+CZK
+...
+
+2018-09-07
+2018-09-06
+2018-09-05
+2018-09-04
+...
+
+{"USD"=>1.1615, "JPY"=>128.74, "BGN"=>1.9558, "CZK"=>25.697 ... }
+```
+
+### Updating the exchange rates data
+
+You can update the exchange rates values via the CLI using:
+
+`$ fafx --update`
+
+One can also use the `$ rake update_data` task as well.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'fafx'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :update_data do
+  Fafx::DataFetcher.save_to_disk
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'fafx'
+
+# 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/fafx

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'fafx'
+
+ARGV[0] = '--help' if ARGV.empty?
+puts "invalid option: #{ARGV[0]}" unless ARGV[0].include?('--') || ARGV[0].include?('-')
+
+options = {}
+opt_parser = OptionParser.new do |opt|
+  opt.on('--recent', 'Lists most recent rates') { |o| options[:recent] = o }
+  opt.on('--currencies', 'Lists available currencies') { |o| options[:currencies] = o }
+  opt.on('--dates', 'Lists available dates') { |o| options[:dates] = o }
+  opt.on('--update', 'Fetches new data from the web') { |o| options[:update] = o }
+end
+
+begin
+  opt_parser.parse!
+  options.keys.each do |k|
+    case k
+    when :recent
+      Fafx::ExchangeRate.most_recent.each_pair do |pair|
+        puts "#{pair.first} #{pair.last}"
+      end
+    when :currencies
+      puts Fafx::ExchangeRate.currencies_available
+    when :dates
+      puts Fafx::ExchangeRate.dates_available
+    when :update
+      Fafx::DataFetcher.save_to_disk
+    end
+  end
+rescue Exception => e
+  puts e.to_s unless e.message == 'exit'
+end

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/fafx.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fafx/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fafx'
+  spec.version       = Fafx::VERSION
+  spec.authors       = ['Frank Kair']
+  spec.email         = ['frankkair@gmail.com']
+
+  spec.summary       = 'Exchange Rates from the European Central Bank'
+  spec.description   = 'Lib and CLI to get exchange rates from the European Central Bank'
+  spec.homepage      = "https://github.com/frankkair/fafx"
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #     'public gem pushes.'
+  # end
+
+  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.executables   = ['fafx']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.8.2'
+end

data/lib/fafx.rb

@@ -0,0 +1,4 @@
+require 'fafx/version'
+require 'fafx/data_fetcher'
+require 'fafx/er'
+require 'fafx/exchange_rate'

data/lib/fafx/data_fetcher.rb

@@ -0,0 +1,31 @@
+require 'open-uri'
+require 'nokogiri'
+
+module Fafx
+  module DataFetcher
+    def save_to_disk
+      url = 'https://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist-90d.xml'
+      doc = Nokogiri::XML(open(url))
+      rates = process_currencies_xml(doc)
+      dir = "#{File.join(File.dirname(__FILE__))}/rates.yaml"
+      File.open(dir, 'w') { |f| f << rates.to_yaml }
+    end
+
+    private
+
+    def process_currencies_xml(doc)
+      rates = {}
+      doc.css('Cube>Cube[time]').each do |day|
+        time = day[:time]
+        rates[time] = {}
+        day.css('Cube').each do |currency|
+          # TODO: Think about float value - type safety
+          rates[time][currency[:currency]] = currency[:rate].to_f
+        end
+      end
+      rates
+    end
+
+    module_function :save_to_disk, :process_currencies_xml
+  end
+end

data/lib/fafx/er.rb

@@ -0,0 +1,29 @@
+require 'yaml'
+
+# TODO: Create a currency class?
+module Fafx
+  class ER
+    attr_reader :rates, :dates, :currencies
+    def initialize
+      data = load_data
+      @rates = data
+      @dates = data.keys
+      @currencies = @rates[@dates.first].keys
+    end
+
+    def rates_at(date, curr)
+      raise KeyError, 'Date not available' unless @dates.include?(date)
+      raise KeyError, "#{curr} not found" unless @currencies.include?(curr)
+      @rates[date][curr]
+    end
+
+    private
+
+    # -> Hash[String => Float]
+    def load_data
+      rates = "#{File.join(File.dirname(__FILE__))}/rates.yaml"
+      DataFetcher.save_to_disk unless File.exist?(rates)
+      YAML.load_file(rates)
+    end
+  end
+end

data/lib/fafx/exchange_rate.rb

@@ -0,0 +1,25 @@
+module Fafx
+  module ExchangeRate
+    def at(date, base, other)
+      er = ER.new
+      base = er.rates_at(date.to_s, base)
+      other = er.rates_at(date.to_s, other)
+      other / base
+    end
+
+    def currencies_available
+      ER.new.currencies
+    end
+
+    def dates_available
+      ER.new.dates
+    end
+
+    def most_recent
+      er = ER.new
+      k = er.dates.first
+      er.rates[k]
+    end
+    module_function :at, :currencies_available, :dates_available, :most_recent
+  end
+end

data/lib/fafx/version.rb

@@ -0,0 +1,3 @@
+module Fafx
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: fafx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Frank Kair
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+description: Lib and CLI to get exchange rates from the European Central Bank
+email:
+- frankkair@gmail.com
+executables:
+- fafx
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/fafx
+- bin/setup
+- fafx.gemspec
+- lib/fafx.rb
+- lib/fafx/data_fetcher.rb
+- lib/fafx/er.rb
+- lib/fafx/exchange_rate.rb
+- lib/fafx/version.rb
+homepage: https://github.com/frankkair/fafx
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Exchange Rates from the European Central Bank
+test_files: []