currency-rate 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f65d7412d5bdf082fb39bc670010cf88aaf83ace
+  data.tar.gz: 7fc7e9af03abb1747d6f1fc01c6f880d64433a31
+SHA512:
+  metadata.gz: 1844ba52a93f9cdf1d5c3d6b2ecc7b8516ef8678f32771499fdb3c3c52785b3c5ed2dd3d9b1215e38256308ad19a58bc4e85d05cd87eab7cb9e92ed9c4586ac9
+  data.tar.gz: bc1a32af222d5555c8b7d1fe6cac660df64a512dee62c6ce7fd6d8995b7abd29bea28169edfbbe5dc8a6c17b5b81399143e57100eb73f6d85ac699aaf31ec632

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gem 'satoshi-unit'
+
+group :development do
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.1.1", git: 'git@github.com:technicalpickles/jeweler.git'
+  gem "rspec"
+  gem 'webmock'
+  gem 'vcr'
+end

data/Gemfile.lock

@@ -0,0 +1,91 @@
+GIT
+  remote: git@github.com:technicalpickles/jeweler.git
+  revision: ec91e05d06f2835ee30568fa42b5fa7d451444b6
+  specs:
+    jeweler (2.1.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+      semver
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    builder (3.2.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.3.0)
+    github_api (0.14.0)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      oauth2
+    hashdiff (0.3.0)
+    hashie (3.4.4)
+    highline (1.7.8)
+    json (1.8.3)
+    jwt (1.5.1)
+    mini_portile2 (2.0.0)
+    multi_json (1.12.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    oauth2 (1.1.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0, < 1.5.2)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    rack (1.6.4)
+    rake (11.1.2)
+    rdoc (4.2.2)
+      json (~> 1.4)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    safe_yaml (1.0.4)
+    satoshi-unit (0.1.8)
+    semver (1.0.1)
+    thread_safe (0.3.5)
+    vcr (3.0.3)
+    webmock (2.0.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.1.1)!
+  rspec
+  satoshi-unit
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.12.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Roman Snitko
+
+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,52 @@
+currency-rate
+=============
+
+Converter for fiat and crypto currencies
+
+Installation
+------------
+
+    gem install currency-rate
+
+or in Gemfile
+
+    gem "currency-rate"
+
+Usage
+-----
+Basically, all you'll need is to use the top level class to fetch any rates you want.
+For example:
+
+    CurrencyRate.convert('Bitstamp', amount: 5, from: 'BTC', to: 'USD')
+    CurrencyRate.convert('Bitstamp', amount: 2750, from: 'USD', to: 'BTC')
+    CurrencyRate.convert('Bitstamp', amount: 1000, from: 'USD', to: 'EUR')
+
+In the third case, because Bitstamp doesn't really support direct conversion from
+USD to EUR, the 1000 will first be converted to BTC, then the BTC amount will be converted to EUR.
+
+This introduced the concept of anchor currency. For all Btc adapters in this lib, it's set to BTC
+by default. For all Fiat adapters it's set to USD by default. To specify anchor currency manually,
+simply pass it as another argument, for example:
+
+    CurrencyRate.convert('Bitstamp', amount: 1000, from: 'USD', to: 'EUR', anchor_currency: 'BTC')
+
+For a list of available adapters, please see
+[lib/btc_adapters](https://github.com/snitko/currency-rate/tree/master/lib/btc_adapters)
+and [lib/fiat_adapters](https://github.com/snitko/currency-rate/tree/master/lib/fiat_adapters).
+To specify an adapter for `#convert` or `#get`, remove the last `Adapter` part from its name.
+
+Caching and Storage
+-------------------
+
+By default, a simple in-memory caching mechanism with a timeout of 1800 seconds is set.
+To change the default timeout and also implement your very own caching mechanism you can
+try reloading `CurrencyRate::Storage` methods and writing your own functionality,
+storing data in Redis, for example.
+
+While I agree it'd be nicer to have the timeout set somewhere in `CurrencyRate` class,
+for simplicity reasons I've avoided that. It also makes sense that the `Storage` class is responsible
+for how and when to store/fetch data, not other classes.
+
+Credits
+-------
+This gem was extracted from [straight gem](https://github.com/MyceliumGear/straight), thanks to all the people who added various exchange rate adapters and contributed code.

data/Rakefile

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "currency-rate"
+  gem.homepage = "http://github.com/snitko/currency-rate"
+  gem.license = "MIT"
+  gem.summary = %Q{Converter for fiat and crypto currencies}
+  gem.description = %Q{Fetches exchange rates from various sources and does the conversion}
+  gem.email = "roman.snitko@gmail.com"
+  gem.authors = ["Roman Snitko"]
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/currency-rate.gemspec

@@ -0,0 +1,95 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: currency-rate 0.1.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "currency-rate"
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Roman Snitko"]
+  s.date = "2016-06-18"
+  s.description = "Fetches exchange rates from various sources and does the conversion"
+  s.email = "roman.snitko@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "currency-rate.gemspec",
+    "lib/adapter.rb",
+    "lib/btc_adapter.rb",
+    "lib/btc_adapters/average_rate_adapter.rb",
+    "lib/btc_adapters/bitpay_adapter.rb",
+    "lib/btc_adapters/bitstamp_adapter.rb",
+    "lib/btc_adapters/btce_adapter.rb",
+    "lib/btc_adapters/coinbase_adapter.rb",
+    "lib/btc_adapters/kraken_adapter.rb",
+    "lib/btc_adapters/localbitcoins_adapter.rb",
+    "lib/btc_adapters/okcoin_adapter.rb",
+    "lib/core_ext/classify.rb",
+    "lib/core_ext/deep_get.rb",
+    "lib/currency_rate.rb",
+    "lib/fiat_adapter.rb",
+    "lib/fiat_adapters/fixer_adapter.rb",
+    "lib/fiat_adapters/yahoo_adapter.rb",
+    "lib/storage.rb",
+    "spec/currency_rate_spec.rb",
+    "spec/lib/btc_adapter_spec.rb",
+    "spec/lib/btc_adapters/average_rate_adapter_spec.rb",
+    "spec/lib/btc_adapters/bitpay_adapter_spec.rb",
+    "spec/lib/btc_adapters/bitstamp_adapter_spec.rb",
+    "spec/lib/btc_adapters/btce_adapter_spec.rb",
+    "spec/lib/btc_adapters/coinbase_adapter_spec.rb",
+    "spec/lib/btc_adapters/kraken_adapter_spec.rb",
+    "spec/lib/btc_adapters/localbitcoins_adapter_spec.rb",
+    "spec/lib/btc_adapters/okcoin_adapter_spec.rb",
+    "spec/lib/fiat_adapters/fixer_adapter_spec.rb",
+    "spec/lib/fiat_adapters/yahoo_adapter_spec.rb",
+    "spec/lib/storage_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/snitko/currency-rate"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.5.1"
+  s.summary = "Converter for fiat and crypto currencies"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<satoshi-unit>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.1.1"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+      s.add_development_dependency(%q<vcr>, [">= 0"])
+    else
+      s.add_dependency(%q<satoshi-unit>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.1.1"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+      s.add_dependency(%q<vcr>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<satoshi-unit>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.1.1"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+    s.add_dependency(%q<vcr>, [">= 0"])
+  end
+end
+

data/lib/adapter.rb

@@ -0,0 +1,42 @@
+module CurrencyRate
+  class Adapter
+    include Singleton
+
+    class FetchingFailed       < Exception; end
+    class CurrencyNotSupported < Exception; end
+
+    def initialize
+      @storage = Storage.new
+    end
+
+    def fetch_rates!
+      raise "FETCH_URL is not defined!" unless self.class::FETCH_URL
+      uri = URI.parse(self.class::FETCH_URL)
+      begin
+        @rates            = JSON.parse(uri.read(read_timeout: 4))
+        @rates_updated_at = Time.now
+      rescue OpenURI::HTTPError => e
+        raise FetchingFailed
+      end
+    end
+
+    def rate_for(currency_code)
+      @storage.fetch(self.class.to_s) do
+        self.fetch_rates!
+      end
+      nil # this should be changed in descendant classes
+    end
+
+    # This method will get value we are interested in from hash and
+    # prevent failing with 'undefined method [] for Nil' if at some point hash doesn't have such key value pair
+    def get_rate_value_from_hash(rates_hash, *keys)
+      rates_hash.deep_get(*keys) || raise(CurrencyNotSupported)
+    end
+
+    # We dont want to have false positive rate, because nil.to_f is 0.0
+    # This method checks that rate value is not nil
+    def rate_to_f(rate)
+      rate ? rate.to_f : raise(CurrencyNotSupported)
+    end
+  end
+end

data/lib/btc_adapter.rb

@@ -0,0 +1,17 @@
+module CurrencyRate
+
+  class BtcAdapter < Adapter
+
+    def convert_from_currency(amount_in_currency, btc_denomination: :satoshi, currency: 'USD')
+      btc_amount = amount_in_currency.to_f/rate_for(currency)
+      Satoshi.new(btc_amount, from_unit: :btc, to_unit: btc_denomination).to_unit
+    end
+
+    def convert_to_currency(amount, btc_denomination: :satoshi, currency: 'USD')
+      amount_in_btc = Satoshi.new(amount.to_f, from_unit: btc_denomination).to_btc
+      amount_in_btc*rate_for(currency)
+    end
+
+  end
+
+end

data/lib/btc_adapters/average_rate_adapter.rb

@@ -0,0 +1,50 @@
+module CurrencyRate
+  class AverageRateAdapter < BtcAdapter
+
+    # Takes exchange rate adapters instances or classes as arguments
+    def self.instance(*adapters)
+      instance = super()
+      instance.instance_variable_set(:@adapters, adapters.map { |adapter| adapter.respond_to?(:instance) ? adapter.instance : adapter })
+      instance
+    end
+
+    def fetch_rates!
+      failed_fetches = 0
+      @adapters.each do |adapter|
+        begin
+          adapter.fetch_rates!
+        rescue FetchingFailed => e
+          failed_fetches += 1
+          raise e if failed_fetches == @adapters.size
+        end
+      end
+    end
+
+    def rate_for(currency_code)
+      rates = []
+      @adapters.each do |adapter|
+        begin
+          rates << adapter.rate_for(currency_code)
+        rescue CurrencyNotSupported
+          rates << nil
+        end
+      end
+
+      unless rates.select(&:nil?).size == @adapters.size
+        rates.compact!
+        rates.inject {|sum, rate| sum + rate} / rates.size
+      else
+        raise CurrencyNotSupported
+      end
+    end
+
+    def get_rate_value_from_hash(rates_hash, *keys)
+      raise "This method is not supposed to be used in #{self.class}."
+    end
+
+    def rate_to_f(rate)
+      raise "This method is not supposed to be used in #{self.class}."
+    end
+
+  end
+end

data/lib/btc_adapters/bitpay_adapter.rb

@@ -0,0 +1,18 @@
+module CurrencyRate
+  class BitpayAdapter < BtcAdapter
+
+    FETCH_URL = 'https://bitpay.com/api/rates'
+
+    def rate_for(currency_code)
+      super
+      @rates.each do |rt|
+        if rt['code'] == currency_code
+          rate = get_rate_value_from_hash(rt, 'rate')
+          return rate_to_f(rate)
+        end
+      end
+      raise CurrencyNotSupported
+    end
+
+  end
+end