forex 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7113e7419c77329d14770c81a3aee7ee3b3b792
-  data.tar.gz: d4999403674df0b8248ec33dd88d809ce446af18
+  metadata.gz: 1abccfe13090f31cf101ec855aae312fdd2d9280
+  data.tar.gz: c81106b0304c9a62456eb34f9b5fdfc110daac3b
 SHA512:
-  metadata.gz: d55666dd2afd131d112134362d072dcdd0f296d7505f759390d927e14528f95940d46be25edfead59b15a9ac3d7fd6cd24b3a0b0fa9d53a15f6da212c4dce05b
-  data.tar.gz: bb0d817c5d8f98528297470338f1b26179bfd4e97d942e3c0f95e5a540b1246ce6b387cc93477bd915c627f3c384d7308d5982e0575964ca53f9dcc8b3f6cb4c
+  metadata.gz: da32e3bd6c127bd657f3fcfe2c24df6078a2b404b4e6b6e0df345c03660cc897727cc5156733b785e328710b20c9bfe56028d2251ea090201d4462164cfd5271
+  data.tar.gz: 9536d87fd001523776de9eb9c808237750f643c6e1cffba215c1ebc53470a386aa717ef83acf9182403759279f11295eb981448253a1db7afd1087616a85f359

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec cucumber && bundle exec rspec

data/README.md

@@ -1,6 +1,7 @@
 # Forex
 
-TODO: Write a gem description
+Provides a simple DSL for managing Foreign Exchange rates (forex) for various
+traders.
 
 ## Installation
 
@@ -18,7 +19,45 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To add a new trader, create a new file at
+``lib/forex/traders/<country-code>/<trader-name>.rb`` with the following
+contents:
+
+```ruby
+
+Forex::Trader.define "NCB" do |t|
+  t.base_currency = "JMD"
+  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
+    # process the doc and return rates hash in the following format
+
+    # {
+    #   "USD" => {
+    #     :buy_cash => 102.0,
+    #     :buy_draft => 103.3,
+    #     :sell_cash => 105.0
+    #   },
+    #   # ...
+    # }
+  end
+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
+```
+
+## Code Status
+
+* [![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)
 
 ## Contributing
 

data/features/step_definitions/tabular_rates_steps.rb

@@ -0,0 +1,34 @@
+Given(/^the tabular rates table:$/) do |table|
+  @table = Nokogiri::HTML(table)
+end
+
+When(/^the column options exist for the tabular rates parser:$/) do |options_table|
+  @options = options_table.hashes.first
+end
+
+Then(/^parsing the table should return the following rates:$/) do |table|
+  ensure_rates_are_equal_to table
+end
+
+Then(/^parsing the table should raise an exception with the message:$/) do |table|
+  message = table.raw.first.first
+  expect { parse_rates }.to raise_error(message)
+end
+
+def parse_rates
+  Forex::TabularRates.new(@table, @options).parse_rates
+end
+
+def ensure_rates_are_equal_to(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.to_f
+      end
+  end
+
+  parse_rates.should == formatted_rates
+end

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'forex'

data/features/tabular_rates.feature

@@ -0,0 +1,37 @@
+Feature: Tabular Rates
+
+  As a developer,
+  In order to easily retrieve tabular rates,
+  I want to be able to use the TabularRates to retrive rates formatted in a table
+
+
+  Background:
+    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>
+      </table>
+      """
+
+  Scenario: Parsing a table with the correct options
+    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          |
+    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     |
+      | GBP           | 166.20   | 169.63    | 173.30    | 173.30     |
+      | CAD           | 94.51    | 96.92     | 99.72     | 99.72      |
+      | EUR           |          | 137.42    | 143.16    | 143.16     |
+
+  Scenario: Parsing a table with invalid options
+    When the column options exist for the tabular rates parser:
+      | currency_code | buy_cash | buy_draft | sell_cash | sell_draft |
+      | 0             | 1        | 2         | 3         | 4          |
+    Then parsing the table should raise an exception with the message:
+      | sell_draft (4) does not exist in table |

data/forex.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["marcel.morgan@codedry.com"]
   spec.description   = %q{Forex Rates for traders using a simple DSL for parsing}
   spec.summary       = %q{Forex Rates for traders}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/mcmorgan/forex"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -18,6 +18,15 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "json"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 end

data/lib/forex.rb

@@ -1,5 +1,10 @@
+require 'nokogiri'
+require 'net/http'
+require 'active_support/core_ext/string'
+
 require "forex/version"
+require "forex/tabular_rates"
+require "forex/trader"
 
-module Forex
-  # Your code goes here...
-end
+# Traders are automatically loaded
+Dir[File.dirname(__FILE__) + '/forex/traders/**/*.rb'].each { |t| require t }

data/lib/forex/tabular_rates.rb

@@ -0,0 +1,80 @@
+module Forex
+  class TabularRates
+    NoSuchColumn = Class.new(StandardError)
+
+    attr_accessor :table, :options
+
+    def initialize(table, options)
+      @table = table
+      @options = options.symbolize_keys
+    end
+
+    def parse_rates
+      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)
+
+        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|
+          next unless rate_column = options[column_label]
+
+          rate_node = cells[rate_column.to_i]
+          raise NoSuchColumn, "#{column_label} (#{rate_column}) does not exist in table" unless rate_node
+
+          rates[column_label.to_sym] = Currency.new(rate_node.content).value
+        end
+      end
+    end
+
+    def column_labels
+      [:buy_cash, :buy_draft, :sell_cash, :sell_draft]
+    end
+
+  end
+
+  class Currency
+
+    def initialize(string)
+      @string = string
+    end
+
+    # converts the currency to it's storage representation
+    def value
+      @currency_code ||= @string.strip.to_f
+    end
+
+  end
+
+  class CurrencyCode
+    def initialize(string)
+      @string = string
+    end
+
+    # TODO validate the currency codes via http://www.xe.com/iso4217.php
+    def valid?
+      @string = to_s # hack
+      !@string.blank? && @string.length == 3
+    end
+
+    def invalid?
+      !valid?
+    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').
+
+        # Remove all non word charactes ([^A-Za-z0-9_])
+        gsub(/\W/,'')
+
+    end
+  end
+end
+

data/lib/forex/trader.rb

@@ -0,0 +1,47 @@
+module Forex
+  CannotRedefineTrader = Class.new(StandardError)
+
+  class Trader
+    attr_accessor :short_name,
+                  :name,
+                  :base_currency,
+                  :endpoint,
+                  :rates_parser,
+                  :rates
+
+    class << self
+      attr_accessor :all
+
+      def define(short_name)
+        raise CannotRedefineTrader, short_name if all[short_name]
+
+        t = Forex::Trader.new(short_name)
+        yield t if block_given?
+        @all[short_name] = t
+      end
+
+      def reset
+        @all = Hash.new
+      end
+    end
+
+    def initialize(short_name)
+      @short_name = short_name
+    end
+
+    def fetch
+      @rates = rates_parser.(doc)
+    end
+
+    private
+
+    # doc built from the endpoint
+    def doc
+      markup = Net::HTTP.get(URI(endpoint))
+      Nokogiri::HTML(markup)
+    end
+
+    reset
+  end
+end
+

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

@@ -0,0 +1,20 @@
+Forex::Trader.define "BNS" do |t|
+  t.base_currency = "JMD"
+  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
+
+    options = {
+      currency_code: 0,
+      buy_cash: 1,
+      buy_draft: 2,
+      sell_cash: 3,
+      sell_draft: 3, # yes, it's the same rate
+    }
+
+    table = doc.css("table").first
+
+    Forex::TabularRates.new(table, options).parse_rates
+  end
+end

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

@@ -0,0 +1,26 @@
+Forex::Trader.define "FXTRADERS" do |t|
+  t.base_currency = "JMD"
+  t.name          = "FX Traders"
+  t.endpoint      = "http://www.fxtrader.gkmsonline.com/rates"
+
+  t.rates_parser = Proc.new do |doc| # doc is a nokogiri document
+
+    content_for = ->(type, n, part = nil) do
+      doc.css(
+        ['.views-field-field-fx-trader', type, n, part, 'value span'].compact.join('-')
+      ).first.content
+    end
+
+    (1..5).each_with_object({}) do |n, currencies|
+      country_code = content_for.(:currency, n)
+
+      currencies[country_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,
+        sell_draft: content_for.(:selling, n, :b).to_f,
+      }
+    end
+  end
+end
+

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

@@ -0,0 +1,24 @@
+Forex::Trader.define "JMMB" do |t|
+  t.base_currency = "JMD"
+  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
+
+    options = {
+      currency_code: 0,
+      buy_cash: 1,
+      buy_draft: 3,
+      sell_cash: 2,
+      sell_draft: 4
+    }
+
+    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
+  end
+end
+

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

@@ -0,0 +1,20 @@
+Forex::Trader.define "JNBS" do |t|
+  t.base_currency = "JMD"
+  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
+
+    options = {
+      currency_code: 0,
+      sell_cash: 4,
+      buy_cash: 2,
+      buy_draft: 1,
+    }
+
+    table = doc.css(".fx-full").first
+
+    Forex::TabularRates.new(table, options).parse_rates
+  end
+end
+

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

@@ -0,0 +1,19 @@
+Forex::Trader.define "NCB" do |t|
+  t.base_currency = "JMD"
+  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
+
+    options = {
+      currency_code: 1,
+      sell_cash: 2,
+      buy_cash: 4,
+      buy_draft: 3,
+    }
+
+    table = doc.css(".rates table").first
+
+    Forex::TabularRates.new(table, options).parse_rates
+  end
+end

data/lib/forex/version.rb

@@ -1,3 +1,3 @@
 module Forex
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end