forex 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c17d5904df7323d11c5d76a221f0f184c7f1361
-  data.tar.gz: ce15542872d6db044a109c58aaea2c2d53ff4538
+  metadata.gz: 0805a3b1ecebdfe37fb068a85dc133dd9e500007
+  data.tar.gz: 735001cf921eeeda36f4c1235adce750aff8000b
 SHA512:
-  metadata.gz: 1f041c9670792ec5a29135c96f00bc3ef8791c563d451820ac797b7c5253e8af04b1c45804022c15f9442984da55f4715faaaaaedb1e4bb6d64712e2f333f2af
-  data.tar.gz: 1fbc4be31fc08d22072c54a1ed0edf4a73b3f956a3091a4972569ec149feab9e966ddf99db31ec131971090e824d209a33a6e4f0aabb5372a640dccff5784748
+  metadata.gz: 5cca23e919fe8b9745119b06430c644e7c33d4c5867bd9e844db861984f9a8d405661a0d3a3c2f2d560a19917a88198ac025e5e8b7e23c30fd6ae12c0cd2b23f
+  data.tar.gz: 5e7980edf74dd90a048f833ee74c1c3c280c26bcb223f6137fe45333aa1e6d83df87e5e8324e5c8b99daa6485c9f2b61d307282b05983b429fa72e26e35b3570

data/.travis.yml

@@ -1,4 +1,10 @@
 language: ruby
 rvm:
   - 2.0.0
-script: bundle exec cucumber && bundle exec rspec
+cache: bundler
+branches:
+  only:
+    - master
+script:
+  - bundle exec cucumber -f Fivemat
+  - bundle exec rspec -f Fivemat

data/README.md

@@ -1,7 +1,12 @@
 # Forex
 
+[![Code Climate](https://codeclimate.com/github/mcmorgan/forex.png)](https://codeclimate.com/github/mcmorgan/forex)
+[![Build Status](https://api.travis-ci.org/mcmorgan/forex.png)](https://travis-ci.org/mcmorgan/forex)
+[![Dependency Status](https://gemnasium.com/mcmorgan/forex.png)](https://gemnasium.com/mcmorgan/forex)
+[![Gem Version](https://badge.fury.io/rb/forex.png)](http://rubygems.org/gems/forex)
+
 Provides a simple DSL for managing Foreign Exchange rates (forex) for various
-traders.
+traders (Inspired by [CurrrencyJA](https://github.com/kenrick/currencyja)).
 
 ## Installation
 
@@ -30,7 +35,7 @@ Forex::Trader.define "NCB" do |t|
   t.name          = "National Commercial Bank"
   t.endpoint      = "http://www.jncb.com/rates/foreignexchangerates"
 
-  t.rates_parser = Proc.new do |doc| # doc is a nokogiri document
+  t.rates_parser = ->(doc) do # doc is a nokogiri document
     # process the doc and return rates hash in the following format
 
     # {
@@ -46,18 +51,46 @@ end
 
 # Rates may be fetched for a specific trader
 Forex::Trader.all['BNS'].fetch
+```
 
-# Or all traders and yielded to the block given
-Forex::Trader.fetch_all do |trader|
-  # Save or do some other processing on the rates ``trader.rates`` hash.
-end
+### TabularRates
+
+`TabularRates` allows you to simplify the process of parsing a table of rates.
+Simply find the table and pass it along with options of what values are in which
+columns (zero indexed).
+
+For example:
+
+```ruby
+  #...
+  
+  translations = {
+    'US$' => 'USD',
+    'TT$' => 'TTD',
+  }
+
+  t.rates_parser = ->(doc) do # doc is a nokogiri document
+
+    options = {
+      currency_code: 1,
+      sell_cash: 2,
+      buy_cash: 4,
+      buy_draft: 3,
+    }
+
+    table = doc.css(".rates table").first
+
+    # translations is optional
+    Forex::TabularRates.new(table, options).parse_rates(translations)
+  end
+
+  #...
 ```
 
-## Code Status
+## TODO
 
-* [![Code Climate](https://codeclimate.com/github/mcmorgan/forex.png)](https://codeclimate.com/github/mcmorgan/forex)
-* [![Build Status](https://api.travis-ci.org/mcmorgan/forex.png)](https://travis-ci.org/mcmorgan/forex)
-* [![Dependency Status](https://gemnasium.com/mcmorgan/forex.png)](https://gemnasium.com/mcmorgan/forex)
+* Make it possible to have the same trader in multiple countries
+* Add other traders in Jamaica
 
 ## Contributing
 

data/features/step_definitions/tabular_rates_steps.rb

@@ -7,7 +7,7 @@ When(/^the column options exist for the tabular rates parser:$/) do |options_tab
 end
 
 Then(/^parsing the table should return the following rates:$/) do |table|
-  ensure_rates_are_equal_to table
+  assert_rates_are_equal_to table
 end
 
 Then(/^parsing the table should raise an exception with the message:$/) do |table|
@@ -15,20 +15,49 @@ Then(/^parsing the table should raise an exception with the message:$/) do |tabl
   expect { parse_rates }.to raise_error(message)
 end
 
-def parse_rates
-  Forex::TabularRates.new(@table, @options).parse_rates
+When(/^the currency translations:$/) do |table|
+  @translations = table.raw.each_with_object({}) do |translation, h|
+    key, value = translation
+    h[key] = value
+  end
 end
 
-def ensure_rates_are_equal_to(table)
-  formatted_rates = table.hashes.each_with_object({}) do |table_hash, currencies|
-    table_hash.symbolize_keys!
+module KnowsTabularRates
+  include Forex
+
+  def translations
+    @translations || {}
+  end
 
-    currencies[table_hash.delete(:currency_code)] =
-      table_hash.each_with_object({}) do |currency_rate, rates|
-        currency, rate = *currency_rate
-        rates[currency] = rate.to_f == 0 ? nil : rate.to_f
-      end
+  def parse_rates
+    TabularRates.new(@table, @options).parse_rates(translations)
   end
 
-  parse_rates.should == formatted_rates
-end
+  def assert_rates_are_equal_to(table)
+    table = table.dup # because we modify it below
+
+    convert_rates! table
+
+    formatted_rates = table.hashes.each_with_object({}) do |table_hash, currencies|
+      table_hash.symbolize_keys!
+
+      currencies[table_hash.delete(:currency_code)] =
+        table_hash.each_with_object({}) do |currency_rate, rates|
+          currency, rate = *currency_rate
+          rates[currency] = rate
+        end
+    end
+
+    parse_rates.should == formatted_rates
+  end
+
+  def convert_rates!(table)
+    zero_to_nil = ->(value) { value == 0 ? nil : value }
+
+    TabularRates::COLUMN_LABELS.each do |column_label|
+      table.map_column!(column_label) { |value| zero_to_nil.(value.to_f) }
+    end
+  end
+end
+
+World(KnowsTabularRates)

data/features/support/env.rb

@@ -1 +1,2 @@
 require 'forex'
+require 'pry'

data/features/tabular_rates.feature

@@ -9,12 +9,12 @@ Feature: Tabular Rates
     Given the tabular rates table:
       """
       <table>
-        <tr><td>   </td> <td>Cash  </td> <td>Cheque</td> <td>Cash & Cheque</td></tr>
-        <tr><td>   </td> <td>BUY   </td> <td>BUY   </td> <td>SELL  </td> </tr>
-        <tr><td>USD</td> <td>101.30</td> <td>103.30</td> <td>105.00</td> </tr>
-        <tr><td>GBP</td> <td>166.20</td> <td>169.63</td> <td>173.30</td> </tr>
-        <tr><td>CAD</td> <td> 94.51</td> <td> 96.92</td> <td> 99.72</td> </tr>
-        <tr><td>EUR</td> <td>      </td> <td>137.42</td> <td>143.16</td> </tr>
+        <tr><td>    </td> <td>Cash  </td> <td>Cheque</td> <td>Cash & Cheque</td></tr>
+        <tr><td>    </td> <td>BUY   </td> <td>BUY   </td> <td>SELL  </td> </tr>
+        <tr><td>US$ </td> <td>101.30</td> <td>103.30</td> <td>105.00</td> </tr>
+        <tr><td>GBP </td> <td>166.20</td> <td>169.63</td> <td>173.30</td> </tr>
+        <tr><td>CAD </td> <td> 94.51</td> <td> 96.92</td> <td> 99.72</td> </tr>
+        <tr><td>EURO</td> <td>      </td> <td>137.42</td> <td>143.16</td> </tr>
       </table>
       """
 
@@ -22,6 +22,9 @@ Feature: Tabular Rates
     When the column options exist for the tabular rates parser:
       | currency_code | buy_cash | buy_draft | sell_cash | sell_draft |
       | 0             | 1        | 2         | 3         | 3          |
+    And the currency translations:
+      | US$  | USD |
+      | EURO | EUR |
     Then parsing the table should return the following rates:
       | currency_code | buy_cash | buy_draft | sell_cash | sell_draft |
       | USD           | 101.30   | 103.30    | 105.00    | 105.00     |

data/forex.gemspec

@@ -26,6 +26,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "cucumber"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "fivemat"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/forex.rb

@@ -7,4 +7,5 @@ require "forex/tabular_rates"
 require "forex/trader"
 
 # Traders are automatically loaded
-Dir[File.dirname(__FILE__) + '/forex/traders/**/*.rb'].each { |t| require t }
+traders_path = File.join(File.dirname(__FILE__), 'forex', 'traders', '**', '*.rb')
+Dir[traders_path].each { |file| require file }

data/lib/forex/tabular_rates.rb

@@ -4,31 +4,34 @@ module Forex
 
     attr_accessor :table, :options
 
+    COLUMN_LABELS = [
+      :buy_cash,
+      :buy_draft,
+      :sell_cash,
+      :sell_draft
+    ]
+
     DEFAULT_OPTIONS = {
       currency_code: 0,
-      buy_cash: 1,
-      buy_draft: 2,
-      sell_cash: 3,
-      sell_draft: 4,
-    }
+    }.merge(Hash[(COLUMN_LABELS).zip(1..COLUMN_LABELS.size)])
 
     def initialize(table, options = DEFAULT_OPTIONS)
       @table = table
       @options = options.symbolize_keys
     end
 
-    def parse_rates
+    def parse_rates(translations = {})
       currency = options.delete(:currency_code) || 0
 
       table.css('tr').each_with_object({}) do |tr, currencies|
         cells = tr.css('td')
         next if cells.empty?
 
-        currency_code = CurrencyCode.new(cells[currency.to_i].content)
+        currency_code = CurrencyCode.new(cells[currency.to_i].content, translations)
 
         next if currencies.has_key?(currency_code.to_s) || currency_code.invalid?
 
-        currencies[currency_code.to_s] = column_labels.each_with_object({}) do |column_label, rates|
+        currencies[currency_code.to_s] = COLUMN_LABELS.each_with_object({}) do |column_label, rates|
           next unless rate_column = options[column_label]
 
           rate_node = cells[rate_column.to_i]
@@ -39,35 +42,28 @@ module Forex
       end
     end
 
-    def column_labels
-      [:buy_cash, :buy_draft, :sell_cash, :sell_draft]
-    end
-
   end
 
-  class Currency
-
-    def initialize(string)
-      @string = string
-    end
+  class Currency < Struct.new(:string)
 
     # converts the currency to it's storage representation
     def value
-      value = @string.strip.to_f
-      value == 0.0 ? nil : value
+      converted == 0.0 ? nil : converted
     end
 
-  end
+    private
 
-  class CurrencyCode
-    def initialize(string)
-      @string = string
+    def converted
+      @converted ||= string.strip.to_f
     end
 
+  end
+
+  class CurrencyCode < Struct.new(:string, :translations)
+
     # TODO validate the currency codes via http://www.xe.com/iso4217.php
     def valid?
-      @string = to_s # hack
-      !@string.blank? && @string.length == 3
+      !translated.blank? && translated.length == 3
     end
 
     def invalid?
@@ -75,14 +71,17 @@ module Forex
     end
 
     def to_s
-      @string.strip.
-        # Replace currency symbols with letter equivalent
-        # TODO go crazy and add the rest http://www.xe.com/symbols.php
-        gsub('$', 'D').
+      translated
+    end
+
+    private
 
-        # Remove all non word charactes ([^A-Za-z0-9_])
-        gsub(/\W/,'')
+    def translated
+      @translated ||= translations[converted] || converted
+    end
 
+    def converted
+      @converted ||= string.strip
     end
   end
 end

data/lib/forex/traders/jm/bns.rb

@@ -3,7 +3,7 @@ Forex::Trader.define "BNS" do |t|
   t.name          = "Bank of Nova Scotia"
   t.endpoint      = "http://www4.scotiabank.com/cgi-bin/ratesTool/depdisplay.cgi?pid=56"
 
-  t.rates_parser = Proc.new do |doc| # doc is a nokogiri document
+  t.rates_parser = ->(doc) do # doc is a nokogiri document
 
     options = {
       currency_code: 0,

data/lib/forex/traders/jm/cok.rb

@@ -0,0 +1,24 @@
+Forex::Trader.define "COK" do |t|
+  t.base_currency = "JMD"
+  t.name          = "City Of Kingston Credit Union"
+  t.endpoint      = "http://www.cokcu.com/otherservices/cambio/"
+
+  t.rates_parser = ->(doc) do # doc is a nokogiri document
+
+    options = {
+      currency_code: 0,
+      buy_cash: 3,
+      buy_draft: 2,
+      sell_cash: 1,
+    }
+
+    table = doc.css(".table-bordered").first
+
+    translations = {
+      'CI'    => 'KYD',
+      'Euro'  => 'EUR',
+    }
+
+    Forex::TabularRates.new(table, options).parse_rates(translations)
+  end
+end

data/lib/forex/traders/jm/fgb.rb

@@ -3,7 +3,7 @@ Forex::Trader.define "FGB" do |t|
   t.name          = "First Global Bank"
   t.endpoint      = "http://www.firstglobal-bank.com/"
 
-  t.rates_parser = Proc.new do |doc| # doc is a nokogiri document
+  t.rates_parser = ->(doc) do # doc is a nokogiri document
     options = {
       currency_code: 0,
       buy_cash: 1,

data/lib/forex/traders/jm/fxtraders.rb

@@ -3,7 +3,7 @@ Forex::Trader.define "FXTRADERS" do |t|
   t.name          = "FX Traders"
   t.endpoint      = "http://www.fxtrader.gkmsonline.com/rates"
 
-  t.rates_parser = Proc.new do |doc| # doc is a nokogiri document
+  t.rates_parser = ->(doc) do # doc is a nokogiri document
 
     content_for = ->(type, n, part = nil) do
       doc.css(
@@ -11,10 +11,15 @@ Forex::Trader.define "FXTRADERS" do |t|
       ).first.content
     end
 
+    translations = {
+      'EURO' => 'EUR',
+    }
+
     (1..5).each_with_object({}) do |n, currencies|
-      country_code = content_for.(:currency, n)
+      currency_code = content_for.(:currency, n)
+      currency_code = translations[currency_code] || currency_code
 
-      currencies[country_code] = {
+      currencies[currency_code] = {
         buy_cash:   content_for.(:buying, n).to_f,
         buy_draft:  content_for.(:buying, n, :b).to_f,
         sell_cash:  content_for.(:selling, n).to_f,

data/lib/forex/traders/jm/jmmb.rb

@@ -3,7 +3,7 @@ Forex::Trader.define "JMMB" do |t|
   t.name          = "Jamaica Money Market Brokers"
   t.endpoint      = "http://www.jmmb.com/full_rates.php"
 
-  t.rates_parser = Proc.new do |doc| # doc is a nokogiri document
+  t.rates_parser = ->(doc) do # doc is a nokogiri document
 
     options = {
       currency_code: 0,
@@ -13,12 +13,17 @@ Forex::Trader.define "JMMB" do |t|
       sell_draft: 4
     }
 
+    translations = {
+      'US$' => 'USD',
+      'TT$' => 'TTD',
+    }
+
     table =
       doc.search("[text()*='FX Trading Rates']").first.  # Section with rates
        ancestors('table').first.                         # Root table for section
        css("table").first                                # Rates table
 
-    Forex::TabularRates.new(table, options).parse_rates
+    Forex::TabularRates.new(table, options).parse_rates(translations)
   end
 end
 

data/lib/forex/traders/jm/jnbs.rb

@@ -3,10 +3,9 @@ Forex::Trader.define "JNBS" do |t|
   t.name          = "Jamaica National Building Society"
   t.endpoint      = "http://www.jnbs.com/fx-rates-2"
 
-  t.rates_parser = Proc.new do |doc| # doc is a nokogiri document
+  t.rates_parser = ->(doc) do # doc is a nokogiri document
 
     options = {
-      currency_code: 0,
       sell_cash: 4,
       buy_cash: 2,
       buy_draft: 1,