historic_bank_rates 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec4e067c61d7a2a2019467a7fe7d4a67e5ebcd6b
+  data.tar.gz: b3c08906e498dfd73398d22c13d516ddac679ad3
+SHA512:
+  metadata.gz: 1d1b4b51374c3da98e47ee018f9179d86de3400dd2c7b2392f7f3683c41a273d8cba9aa3d9814cef8fb7c81c75f78afa6e0851380534f72845a5c310a3555cba
+  data.tar.gz: 87782f7295536eeda089bccc0363e45db7745c0f6f3561d0e0553206cee76d9dd10a76ef444e36c76f73facf5a2179215e1828cc3a6f44c1adc27a0de546eed0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 mobisol 
+
+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,72 @@
+# Historic Bank Rates
+[![Build Status](https://travis-ci.org/plugintheworld/historic_bank_rates.svg?branch=master)](https://travis-ci.org/plugintheworld/historic_bank_rates)
+
+Wraps a simple scraper to retrieve the historic exchange rates. Returns the average rates for yesterday or any day specified and supported by the Central Bank of Kenya.
+
+## Install
+
+Add this line to your application's Gemfile:
+
+  ```ruby
+  gem 'historic_bank_rates'
+  ```
+
+And then execute:
+
+  ```ruby
+  $ bundle
+  ```
+
+Or install it yourself as:
+
+  ```ruby
+  $ gem install historic_bank_rates
+  ```
+
+## Usage
+
+### Initialize (NOTE: the date used can affect the success of the import! method)
+
+  ```ruby
+  scraper = HistoricBankRates::BankScraper::CentralBankOfKenya.new
+  hbr = HistoricBankRates::Rates.new(scraper, Date.new(2016, 05, 30))
+  hbr.import! # => true
+  ```
+
+import! returns true if rates have been found. Might also throw HTTP errors. It will also return false when requesting rates for weekend days.
+
+Update an instance's import_date and rerun the import process:
+
+  ```ruby
+  hbr.import!(Date.new(2015, 06, 30)) # => true
+  ```
+
+### Retrieve a specific rate
+
+  ```ruby
+  hbr.rate('KES', 'EUR') # => 112.2322
+  ```
+
+Get all available currencies:
+
+  ```ruby
+  hbr.currencies # => ['ZAR', 'USD', 'EUR', 'RWF'… ]
+  ```
+
+Get all rates
+
+  ```ruby
+  hbr.rates # => { 'ZAR'=>6.4373, 'USD'=>100.6606, … }
+  ```
+
+## Legal
+
+The author of this gem is not affiliated with any of the banks referenced/scraped by the gem.
+
+### License
+
+MIT, see LICENSE file
+
+### No Warranty
+
+The Software is provided "as is" without warranty of any kind, either express or implied, including without limitation any implied warranties of condition, uninterrupted use, merchantability, fitness for a particular purpose, or non-infringement.

data/lib/historic_bank_rates/bank_scrapers/bank_of_tanzania.rb

@@ -0,0 +1,75 @@
+require_relative 'rate_scraper.rb'
+module HistoricBankRates
+  module BankScrapers
+    class BankOfTanzania < HistoricBankRates::BankScrapers::RateScraper
+      TRANSLATE = { 'Kenya SHS'         => 'KES',
+                    'Uganda SHS'        => 'UGX',
+                    'Rwandan Franc'     => 'RWF',
+                    'Burundi Franc'     => 'BFI',
+                    'USD'               => 'USD',
+                    'Pound STG'         => 'GBP',
+                    'EURO'              => 'EUR',
+                    'Canadian $'        => 'CAD',
+                    'Switz. Franc'      => 'CHF',
+                    'Japanese YEN'      => 'JPY',
+                    'Swedish Kronor'    => 'SEK',
+                    'Norweg. Kronor'    => 'NOK',
+                    'Danish Kronor'     => 'DKK',
+                    'Australian $'      => 'AUD',
+                    'Indian RPS'        => 'INR',
+                    'Pakistan RPS'      => 'PKR',
+                    'Zambian Kwacha'    => 'ZAK',
+                    'Malawian Kwacha'   => 'MWK',
+                    'Mozambique-MET'    => 'MZN',
+                    'Zimbabwe $'        => 'ZWD',
+                    'SDR'               => 'XDR',
+                    'S. African Rand'   => 'ZAR',
+                    'UAE Dirham'        => 'AED',
+                    'Singapore $'       => 'SGD',
+                    'Honk Kong $'       => 'HKD',
+                    'Saud Arabian Rial' => 'SAR',
+                    'Kuwait Dinar'      => 'KWD',
+                    'Botswana Pula'     => 'BWP',
+                    'Chinese Yuan'      => 'CNY',
+                    'Malaysia Ringgit'  => 'MYR',
+                    'South Korea Won'   => 'KRW',
+                    'Newzealand'        => 'NZD' }
+
+      def base_currency
+        'TZS'
+      end
+
+      private
+
+      def rates
+        response = Net::HTTP.post_form(URI(form_url), form_params)
+        dom = Nokogiri::HTML(response.body)
+        rows = dom.css(element_matcher)
+
+        Hash[rows.map do |row|
+               currency = TRANSLATE[row.css(':nth-child(1) font').text.split.join(' ')]
+               buy = Float(row.css(':nth-child(3) font').text.delete(',', '')) rescue nil
+               sell = Float(row.css(':nth-child(4) font').text.delete(',', '')) rescue nil
+               next if currency.nil? || buy.nil? || sell.nil?
+
+               # average of by and sell, divide by 100 b/c conversion is given in 100 units
+               [currency, (buy + sell) / 200]
+        end.compact]
+      end
+
+      def form_url
+        @form_url ||= 'http://www.bot-tz.org/FinancialMarkets/ExchangeRates/ShowExchangeRates.asp'
+      end
+
+      def form_params
+        {
+          'SelectedExchandeDate' => start_date.strftime('%m/%d/%y')
+        }
+      end
+
+      def element_matcher
+        '#table1 > tr > td > table > tr > td > div > table > tr > td > table > tr'
+      end
+    end
+  end
+end

data/lib/historic_bank_rates/bank_scrapers/central_bank_of_kenya.rb

@@ -0,0 +1,73 @@
+require_relative 'rate_scraper.rb'
+
+module HistoricBankRates
+  module BankScrapers
+    class CentralBankOfKenya < HistoricBankRates::BankScrapers::RateScraper
+      TRANSLATE = { 'US DOLLAR'         => 'USD',
+                    'STG POUND'         => 'GBP',
+                    'EURO'              => 'EUR',
+                    'SA RAND'           => 'ZAR',
+                    'KES / USHS'        => 'UGX',
+                    'KES / TSHS'        => 'TZS',
+                    'KES / RWF'         => 'RWF',
+                    'KES / BIF'         => 'BIF',
+                    'AE DIRHAM'         => 'AED',
+                    'CAN $'             => 'CAD',
+                    'S FRANC'           => 'CHF',
+                    'JPY (100)'         => 'JPY',
+                    'SW KRONER'         => 'SEK',
+                    'NOR KRONER'        => 'NOK',
+                    'DAN KRONER'        => 'DKK',
+                    'IND RUPEE'         => 'INR',
+                    'HONGKONG DOLLAR'   => 'HKD',
+                    'SINGAPORE DOLLAR'  => 'SGD',
+                    'SAUDI RIYAL'       => 'SAR',
+                    'CHINESE YUAN'      => 'CNY',
+                    'AUSTRALIAN $'      => 'AUD' }
+
+      def base_currency
+        'KES'
+      end
+
+      private
+
+      def rates
+        response = Net::HTTP.post_form(URI(form_url), form_params)
+        dom = Nokogiri::HTML(response.body)
+        rows = dom.css(element_matcher)
+
+        Hash[rows.map do |row|
+               currency = TRANSLATE[row.css(':nth-child(2)').text]
+               next if currency.nil?
+               next if currency.empty?
+               avrg = row.css(':nth-child(5)').text
+               next if avrg.nil?
+               next if avrg.empty?
+
+               [currency, Float(avrg)] rescue nil
+        end.compact]
+      end
+
+      def form_url
+        @form_url ||= 'https://www.centralbank.go.ke/index.php/rate-and-statistics/exchange-rates-2'
+      end
+
+      def form_params
+        {
+          'date'    => start_date.strftime('%d'),
+          'month'   => start_date.strftime('%m').upcase,
+          'year'    => start_date.strftime('%Y'),
+          'tdate'   => start_date.strftime('%d'),
+          'tmonth'  => start_date.strftime('%m').upcase,
+          'tyear'   => start_date.strftime('%Y'),
+          'currency' => '',
+          'searchForex' => 'Search'
+        }
+      end
+
+      def element_matcher
+        '#cont1 > #cont3 > div.item-page > #interbank > table > tr > td > table > tr'
+      end
+    end
+  end
+end

data/lib/historic_bank_rates/bank_scrapers/rate_scraper.rb

@@ -0,0 +1,50 @@
+require 'nokogiri'
+require 'uri'
+require 'net/http'
+
+module HistoricBankRates
+  module BankScrapers
+    class RateScraper
+      TRANSLATE = {}
+
+      attr_reader :start_date
+      attr_accessor :form_url
+
+      def initialize
+      end
+
+      def call start_date
+        @start_date = start_date
+
+        rates
+      end
+
+      def base_currency
+        # Must implement
+        raise NotImplementedError
+      end
+
+      private
+
+      def rates
+        # Must implement
+        raise NotImplementedError
+      end
+
+      def form_url
+        # Must implement
+        raise NotImplementedError
+      end
+
+      def form_params
+        # Must implement
+        raise NotImplementedError
+      end
+
+      def element_matcher
+        # Must implement
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/historic_bank_rates/rates.rb

@@ -0,0 +1,60 @@
+require 'date'
+require_relative 'bank_scrapers/central_bank_of_kenya'
+require_relative 'bank_scrapers/bank_of_tanzania'
+
+module HistoricBankRates
+  class MissingRates < StandardError; end
+  class Rates
+    attr_reader :start_date
+    attr_accessor :rate_scraper
+
+    def initialize rate_scraper, start_date=nil
+      @rate_scraper = rate_scraper
+      @start_date = start_date || date_yesterday
+    end
+
+    def rate(iso_from, iso_to)
+      case rate_scraper.base_currency
+      when iso_from
+        rates[iso_to] ? 1/rates[iso_to] : nil
+      when iso_to
+        rates[iso_from]
+      else
+        fail_if_rates_missing
+      end
+    end
+
+    # Returns a list of ISO currencies
+    def currencies
+      rates.keys
+    end
+
+    # Returns all rates imported
+    def rates
+      fail_if_rates_missing
+      @rates
+    end
+
+    # Returns true when reading the website was successful
+    def has_rates?
+      @rates && @rates.any?
+    end
+
+    # Triggers the scraping
+    def import! import_date=nil
+      @start_date = import_date unless import_date.nil?
+      @rates = rate_scraper.call(start_date)
+      has_rates?
+    end
+
+    private
+
+    def date_yesterday
+      Date.today - 1
+    end
+
+    def fail_if_rates_missing
+      fail MissingRates unless has_rates?
+    end
+  end
+end

data/lib/historic_bank_rates.rb

@@ -0,0 +1,5 @@
+require_relative 'historic_bank_rates/rates'
+
+module HistoricBankRates
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: historic_bank_rates
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Alexander Donkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: nyan-cat-formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Wraps a simple scraper to retrieve the historic exchange
+                      rates of specific banks. Returns the average (between buy
+                      and sell) rates for any day specified (if date isn't
+                      specified it defaults to yesterday).
+email:
+- alexander_donkin@yahoo.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/historic_bank_rates.rb
+- lib/historic_bank_rates/bank_scrapers/bank_of_tanzania.rb
+- lib/historic_bank_rates/bank_scrapers/central_bank_of_kenya.rb
+- lib/historic_bank_rates/bank_scrapers/rate_scraper.rb
+- lib/historic_bank_rates/rates.rb
+homepage: http://github.com/plugintheworld/historic_bank_rates
+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.8
+signing_key: 
+specification_version: 4
+summary: Scrapes various bank websites to generate a list of currencies and their
+  historic rates.
+test_files: []