fafx 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93feca2af8fb931f0c8e62b0f3aea2bf24eaaf9c
-  data.tar.gz: 4bcdfbf6645958ed69b014d6d5f737728b6e36b0
+  metadata.gz: 00740a9067c4044fd55665b0c61059c090cb1657
+  data.tar.gz: 61dc5c53fc2d376d850efe43e3397d43f5ab6be5
 SHA512:
-  metadata.gz: 1e52c5a8b4c5c7895ff69da56cb93c8807e8fd8b47dbcbc8636254e9772c99c216b7518eb05295ed02750e34a6202c303de81e3518d598ed4d5676a99e393f9f
-  data.tar.gz: 240f24101ace83b8f0829d77bfb14896490b227ac4e8aa61a38b8374f38d464dfc14c60c3e877f44596d60e7b76b92bf3e778477e0e7e34ce048fc00cb50f0c6
+  metadata.gz: 7c3a0cea20e949601b2115f9fd533922d5a81565f576a9903a6d62d0fa237553645d5d423d88f1b4000f172462342560baec3225dccf37d6698dd2cd9c4dda70
+  data.tar.gz: b22882852ddb68ce273973f90e17b67be2ecfdfcd7a23d8543c048c63193d64ffca22ce9e801a1b9cef71cd0f2252aaea388c289acb810926a5180e778a26b21

data/README.md

@@ -2,13 +2,15 @@
 
 [![Build Status](https://travis-ci.org/FrankKair/fafx.svg?branch=master)](https://travis-ci.org/FrankKair/fafx)
 
-### Installation
+FAFX fetches data from the 90 day European Central Bank (ECB) feed and offers a simple CLI and API to interect with.
 
-`$ gem install fafx`
+## Installation
 
-### CLI
+    $ gem install fafx
 
-`$ fafx`
+## CLI
+
+    $ fafx
 
 ```
 Usage: fafx [options]
@@ -18,42 +20,47 @@ Usage: fafx [options]
         --update      Fetches new data from the web
 ```
 
-### Example of client usage
+## 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
-```
+Fafx::ExchangeRate.at(Date.today, 'GBP', 'USD')
+# => 1.2951645399597045
+
+Fafx::ExchangeRate.currencies_available
+# => ["USD", "JPY", "BGN", "CZK", ...]
 
-This code outputs:
+Fafx::ExchangeRate.dates_available
+# => ["2018-09-10", "2018-09-07", "2018-09-06", "2018-09-05", ...]
 
+Fafx::ExchangeRate.most_recent
+# => {"USD"=>1.1571, "JPY"=>128.54, "BGN"=>1.9558, "CZK"=>25.648, ...}
 ```
-1.2951995012468827
 
-USD
-JPY
-BGN
-CZK
-...
+The `at` function may raise a `KeyError` exception, should the date or currency be unavailable.
+
+## Updating the exchange rates data
+
+You can update the exchange rates values either via the **CLI**, **Rake task** or **programmatically**:
+
+    $ fafx --update
 
-2018-09-07
-2018-09-06
-2018-09-05
-2018-09-04
-...
+    $ rake update_data
 
-{"USD"=>1.1615, "JPY"=>128.74, "BGN"=>1.9558, "CZK"=>25.697 ... }
+```ruby
+require 'fafx'
+
+Fafx::ExchangeRate.fetch_data_and_save_to_disk
 ```
 
-### Updating the exchange rates data
+---
 
-You can update the exchange rates values via the CLI using:
+One can also schedule a **cron job** (the following example fetches the data every minute):
 
-`$ fafx --update`
+```
+* * * * * . ~/.zshrc; fafx -u
+```
 
-One can also use the `$ rake update_data` task as well.
+Note: `. ~/.zshrc` is used to load the environment with the Ruby gems path, because cron uses `PATH=/usr/bin:/usr/sbin` and `SHELL=/usr/bin/sh by default`. Fonts: [here](http://man7.org/linux/man-pages/man5/crontab.5.html) and [here](http://www.adminschoice.com/crontab-quick-reference)

data/Rakefile

@@ -7,5 +7,6 @@ RSpec::Core::RakeTask.new(:spec)
 task default: :spec
 
 task :update_data do
-  Fafx::DataFetcher.save_to_disk
+  Fafx::ExchangeRate.fetch_data_and_save_to_disk
+  puts 'Exchange rates data updated!'
 end

data/bin/fafx

@@ -3,14 +3,24 @@ require 'optparse'
 require 'fafx'
 
 ARGV[0] = '--help' if ARGV.empty?
-puts "invalid option: #{ARGV[0]}" unless ARGV[0].include?('--') || ARGV[0].include?('-')
+unless ARGV[0].include?('--') || ARGV[0].include?('-')
+  puts "invalid option: #{ARGV[0]}"
+end
 
 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 }
+  opt.on('--recent', 'Lists most recent rates') do |o|
+    options[:recent] = o
+  end
+  opt.on('--currencies', 'Lists available currencies') do |o|
+    options[:currencies] = o
+  end
+  opt.on('--dates', 'Lists available dates') do |o|
+    options[:dates] = o
+  end
+  opt.on('--update', 'Fetches new data from the web') do |o|
+    options[:update] = o
+  end
 end
 
 begin
@@ -26,9 +36,10 @@ begin
     when :dates
       puts Fafx::ExchangeRate.dates_available
     when :update
-      Fafx::DataFetcher.save_to_disk
+      Fafx::ExchangeRate.fetch_data_and_save_to_disk
+      puts 'Exchange rates data updated!'
     end
   end
-rescue Exception => e
+rescue StandardError => e
   puts e.to_s unless e.message == 'exit'
 end

data/fafx.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fafx/version'
@@ -11,23 +10,12 @@ Gem::Specification.new do |spec|
 
   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.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']
 

data/lib/fafx/data_fetcher.rb

@@ -1,31 +1,28 @@
 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
+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
+  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
+  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|
+        rates[time][currency[:currency]] = currency[:rate].to_f
       end
-      rates
     end
-
-    module_function :save_to_disk, :process_currencies_xml
+    rates
   end
+
+  module_function :save_to_disk, :process_currencies_xml
 end

data/lib/fafx/er.rb

@@ -1,29 +1,25 @@
 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
+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
+  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
+  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
+  def load_data
+    rates = "#{File.join(File.dirname(__FILE__))}/rates.yaml"
+    Fafx::ExchangeRate.fetch_data_and_save_to_disk unless File.exist?(rates)
+    YAML.load_file(rates)
   end
 end

data/lib/fafx/exchange_rate.rb

@@ -1,9 +1,9 @@
 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)
+      ex_rates = ER.new
+      base = ex_rates.rates_at(date.to_s, base)
+      other = ex_rates.rates_at(date.to_s, other)
       other / base
     end
 
@@ -16,10 +16,18 @@ module Fafx
     end
 
     def most_recent
-      er = ER.new
-      k = er.dates.first
-      er.rates[k]
+      ex_rates = ER.new
+      first_date = ex_rates.dates.first
+      ex_rates.rates[first_date]
     end
-    module_function :at, :currencies_available, :dates_available, :most_recent
+
+    def fetch_data_and_save_to_disk
+      DataFetcher.save_to_disk
+    end
+    module_function :at,
+                    :currencies_available,
+                    :dates_available,
+                    :most_recent,
+                    :fetch_data_and_save_to_disk
   end
 end

data/lib/fafx/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fafx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Frank Kair
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-11 00:00:00.000000000 Z
+date: 2018-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler