oanda_bank 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 225b610a4b164f13d07652c05d10a287d3ed9118
+  data.tar.gz: 850de2fddc116b1ad31284d4d9614d75bfd3e26e
+SHA512:
+  metadata.gz: 5a73a3a3a34199069de1862d4e71302ebac9915831c8ae4b2f4bd979e895a627311803d2b0907eecbe86dba6ac4fc30158ccc57fc5e15ef18681efe74df9e3c0
+  data.tar.gz: d03f427678b4b0300be316db24a22c1c77de04c3910bc6f708ab4a407c686d0a532cebf952b593b41bec0217b09abd719cb39859f3153760caf53e6d34bdd0d0

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.env

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    oanda_bank (1.0.0)
+      money (~> 6.0)
+      oauth2 (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    i18n (0.6.11)
+    jwt (1.0.0)
+    money (6.1.1)
+      i18n (~> 0.6.4)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.3)
+    safe_yaml (1.0.3)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    vcr (2.9.2)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  oanda_bank!
+  rspec (~> 3.0)
+  simplecov (~> 0.7)
+  vcr (~> 2.9)
+  webmock (~> 1.18)

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Alex Ianus
+
+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,53 @@
+oanda_bank
+==========
+
+Ruby Money::Bank interface for OANDA currency rate data
+
+This gem extends Money::Bank::VariableExchange with Money::Bank::OANDA to give you access to OANDA fxTrade exchange rates.
+
+## What rates are available?
+
+Any pair of currencies that are both part of the money gem and part of a tradeable instrument in your fxTrade account. In addition, if there is no tradeable instrument containing both of your currencies the gem will attempt to go through USD. For example, CAD -> SEK is supported because although there is no CAD/SEK instrument, there exist both USD/CAD and USD/SEK instruments.
+
+## Usage
+
+``` ruby
+require 'oanda_bank'
+
+oanda_bank = Money::Bank::OANDA(ENV['FXTRADE_ACCOUNT_ID'], ENV['FXTRADE_ACCESS_TOKEN'])
+
+# Call this before calculating exchange rates
+# This will download the rates from OANDA
+oanda_bank.update_rates!
+
+# Exchange 100 USD to CAD
+# API is the same as the money gem
+oanda_bank.exchange_with(Money.new(10000, :USD), :CAD)
+
+# Set as default bank to do arithmetic and comparisons on Money objects
+Money.default_bank = oanda_bank
+money1 = Money.new(10)
+money1.bank # oanda_bank
+
+Money.us_dollar(10000).exchange_to(:CAD)
+'1'.to_money(:USD) > '1'.to_money(:CAD) # true
+
+# Refresh rates after some number of seconds (by default, rates are only updated when you call update_rates!)
+oanda_bank.ttl_in_seconds = 3600 # Cache rates for one hour
+```
+
+## Testing
+
+If you'd like to contribute code or modify this gem, you can run the test suite with:
+
+```ruby
+gem install oanda_bank --dev
+bundle exec rspec
+```
+
+## Contributing
+
+1. Fork this repo and make changes in your own copy
+2. Add a test if applicable and run the existing tests with `rspec` to make sure they pass
+3. Commit your changes and push to your fork `git push origin master`
+4. Create a new pull request and submit it back to me

data/lib/oanda_bank.rb

@@ -0,0 +1,137 @@
+require 'oauth2'
+require 'money'
+require 'bigdecimal'
+require 'bigdecimal/util'
+
+class Money
+  module Bank
+    class OANDA < VariableExchange
+
+      # Raised when there is an unexpected error in extracting exchange rates
+      # from OANDA
+      class FetchError < StandardError; end
+
+      INSTRUMENTS_URL = "https://api-fxtrade.oanda.com/v1/instruments"
+      RATES_URL       = "https://api-fxtrade.oanda.com/v1/prices"
+
+      # @return [Integer] Returns the Time To Live (TTL) in seconds.
+      attr_reader :ttl_in_seconds
+
+      # @return [Time] Returns the time when the rates expire.
+      attr_reader :rates_expiration
+
+      def initialize(account_id, access_token, opts={})
+        @client = OAuth2::Client.new(nil, nil)
+        @access_token = OAuth2::AccessToken.new(@client, access_token)
+        @account_id = account_id
+        @updating_mutex = Mutex.new
+        setup
+      end
+
+      def update_rates!
+        begin
+          new_rates = fetch_rates
+          @mutex.synchronize do
+            @rates = new_rates
+            refresh_rates_expiration!
+          end
+        rescue
+          raise FetchError.new
+        end
+      end
+
+      def get_rate(from, to, opts = {})
+        expire_rates
+        fn = Proc.new do
+          straight_through = @rates[rate_key_for(from, to)]
+          if straight_through
+            straight_through
+          else
+            to_usd   = @rates[rate_key_for(from, 'USD')]
+            from_usd = @rates[rate_key_for('USD', to)]
+            if (to_usd && from_usd)
+              to_usd * from_usd
+            else
+              nil
+            end
+          end
+        end
+        if opts[:without_mutex]
+          fn.call
+        else
+          @mutex.synchronize { fn.call }
+        end
+      end
+
+      def expire_rates
+        if @ttl_in_seconds && @rates_expiration <= Time.now
+          if @updating_mutex.try_lock
+            begin
+              update_rates!
+              true
+            ensure
+              @updating_mutex.unlock
+            end
+          end
+        else
+          false
+        end
+      end
+
+      ##
+      # Set the Time To Live (TTL) in seconds.
+      #
+      # @param [Integer] the seconds between an expiration and another.
+      def ttl_in_seconds=(value)
+        @ttl_in_seconds = value
+        refresh_rates_expiration! if ttl_in_seconds
+      end
+
+    protected
+
+      def fetch_rates
+        instruments = @access_token.get("#{INSTRUMENTS_URL}?accountId=#{@account_id}")
+        instruments = JSON.parse(instruments.body)
+
+        instrument_codes = instruments['instruments'].map do |instrument|
+          instrument['instrument']
+        end
+
+        instruments_argument = instrument_codes.join('%2C')
+
+        rates = @access_token.get("#{RATES_URL}?instruments=#{instruments_argument}")
+        rates = JSON.parse(rates.body)
+        rates = rates['prices']
+
+        result = {}
+        rates.each do |rate|
+          match = /(?<base>[A-Z0-9]+)_(?<quote>[A-Z0-9]+)/.match(rate['instrument'])
+
+          if !match
+            next
+          end
+
+          from  = match[:base].upcase
+          to    = match[:quote].upcase
+
+          if !Money::Currency.find(from) || !Money::Currency.find(to)
+            next
+          end
+
+          result[rate_key_for(from, to)] = rate['bid'].to_d
+          result[rate_key_for(to, from)] = (1/rate['ask']).to_d
+        end
+        result
+      end
+
+    private
+
+      def refresh_rates_expiration!
+        if @ttl_in_seconds
+          @rates_expiration = Time.now + @ttl_in_seconds
+        end
+      end
+
+    end # /OANDA
+  end # /Bank
+end # /Money

data/oanda_bank.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |gem|
+  gem.name          = 'oanda_bank'
+  gem.version       = '1.0.0'
+  gem.authors       = ['Alex Ianus']
+  gem.email         = ['hire@alexianus.com']
+  gem.description   = ['Ruby Money::Bank interface for OANDA currency rate data']
+  gem.summary       = ['Ruby Money::Bank interface for OANDA currency rate data']
+  gem.homepage      = 'https://github.com/aianus/oanda_bank'
+  gem.licenses      = ['MIT']
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'vcr', '~> 2.9'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'webmock', '~> 1.18'
+  gem.add_development_dependency 'simplecov', '~> 0.7'
+
+  gem.add_dependency 'oauth2', '~> 1.0'
+  gem.add_dependency 'money', '~> 6.0'
+end