currency-rate 0.4.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79218290bd3f6500ee88e69ccdc23821c6adb75c
-  data.tar.gz: 456f45fce8cf8c35b4cb37eabeda9036b9059028
+  metadata.gz: a3676983c63a5f579c68cde5320507f1ae2865e8
+  data.tar.gz: da1012848a17db8f389d10201d26e66aed2ac93b
 SHA512:
-  metadata.gz: e8f7ea0bd8b66fac3d31b891d75c3b5dcda6c1d772f9362ca2ea17092508f4be58986918e31ee0eca365b0480fc2e8df1e9b3b790c94f5921f167d94dca75f28
-  data.tar.gz: fc34de9e4638d599bd8a5710fe5c6aa847591c9c15a8172cb15509afc31521364d81cc3a299445e806d8bc31d7d66725e13a26e3fed4e0e3e46714baf12cda79
+  metadata.gz: d5b015e4587fee54369ecaa39345485f2c9acdb81581fcd4f62655ec235472ef3158dd774c52a5f66b8dadcc2e49206e8c1036017c0421d6ac591aa7785448dd
+  data.tar.gz: 707067690373ce67e6cb2cd6697ac1271e7f615ff533bb73d25c196fcc987054258092524621a9773df62043408107f2b9c598da95da91352c32664b674a126f

data/Gemfile

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

data/README.md

@@ -1,7 +1,7 @@
 currency-rate
 =============
 
-Converter for fiat and crypto currencies
+Converter for fiat and crypto currencies. Currently supports BTC and LTC.
 
 Installation
 ------------
@@ -12,66 +12,54 @@ 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')
-
-You can also use `#get` method to get just the rate. It basically works as `#convert`, but only returns the rate and the method signature (attributes passed) is different - attributes are not named:
+Configuration
+-------------
+```ruby
+CurrencyRate.configure do |config|
+    # Now only ForgeAdapter requires api key to fetch rates
+    # Empty array by default
+    config.api_keys["ForgeAdapter"] = "forge_api_key"
 
-    CurrencyRate.get('Bitstamp', 'BTC', 'USD') # => 750
-    CurrencyRate.get('Bitstamp', 'USD', 'BTC') # => 0.001818182
+    # CurrencyRate::FileStorage configuration has only 'path' attribute
+    config.file_storage[:path] = "/home/user/data" # default: ""
 
-In the second case, we are trying to get the exchange rate for USD/BTC pair, which literally means
-"how much in BTC would 1 USD be?". If the source (Bitstamp, in this case) doesn't provide the
-inverted rate, the Adapter inverts the rate itself using the exchange rate for BTC/USD.
+    # CurrencyRate uses default Logger from Ruby core library
+    # It can be replaced with any compatible object
+    # All logger values listed below are default
+    config.logger[:device] = $stdout
+    config.logger[:level] = :info
+    config.logger[:formatter] = nil
 
-You can also use `anchor_currency` argument with `#get`:
+    # Cryptocurrency exchange adapters to fetch
+    config.crypto_adapters = ["Kraken", "Localbitcoins"]
 
-    CurrencyRate.get('Bitstamp', 'USD', 'EUR', anchor_currency: 'BTC')
+    # Fiat exchange adapters to fetch
+    config.fiat_adapters = ["Yahoo"]
+end
+```
 
-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.
+Usage
+-----
 
-Caching and Storage
--------------------
+To fetch rates from exchanges into file storage (the only supported at this moment):
+```ruby
+CurrencyRate.sync!
+```
+This method will load all available data from exchanges and put into `yml` files. Failed exchanges will not create new / update exsisting files.
 
-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.
+To get rates for Crypto/Fiat currency pair use:
+```ruby
+CurrencyRate.fetch_crypto("Bitstamp", "BTC", "USD")
+```
 
-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.
+For fetching Fiat/Fiat pair:
+```ruby
+CurrencyRate.fetch_fiat("CNY", "USD")
+```
 
-Credits
+Details
 -------
-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.
-
-TODO
-----
-
-1. Remove code duplication in Adapters, specifically for
-   `#rate_for`, `#invert_rate` and `#currency_pair_rate` methods.
-
-2. Allow both lower case and upper case currency codes.
-
-3. Clean up tests, I have a feeling there some completely useless ones.
 
-4. Adapters should have a default "to" currency. For example, everyone knows Bitfinex trades BTC for USD mostly.
+`CurrencyRate` contains two parts that can work independently: Synchronizer and Fetcher.
+`CurrencyRate::Synchronizer` loads data from selected exchanges using adapters and saves it into FileStorage in normalized format.
+`CurrencyRate::Fetch` reads data from FileStorage and returns rate for requested pair and exchange.

data/VERSION

@@ -1 +1 @@
-0.4.1
+1.0.0

data/currency-rate.gemspec

@@ -2,18 +2,18 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: currency-rate 0.3.8 ruby lib
+# stub: currency-rate 1.0.0 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = "currency-rate"
-  s.version = "0.3.8"
+  s.name = "currency-rate".freeze
+  s.version = "1.0.0"
 
-  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 = "2017-08-24"
-  s.description = "Fetches exchange rates from various sources and does the conversion"
-  s.email = "roman.snitko@gmail.com"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Roman Snitko".freeze]
+  s.date = "2017-10-30"
+  s.description = "Fetches exchange rates from various sources and does the conversion".freeze
+  s.email = "roman.snitko@gmail.com".freeze
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -22,91 +22,105 @@ Gem::Specification.new do |s|
     ".document",
     ".rspec",
     "Gemfile",
-    "Gemfile.lock",
     "LICENSE.txt",
     "README.md",
     "Rakefile",
     "VERSION",
     "currency-rate.gemspec",
     "lib/adapter.rb",
-    "lib/core_ext/deep_get.rb",
-    "lib/crypto_adapter.rb",
-    "lib/crypto_adapters/average_rate_adapter.rb",
-    "lib/crypto_adapters/bitfinex_adapter.rb",
-    "lib/crypto_adapters/bitpay_adapter.rb",
-    "lib/crypto_adapters/bitstamp_adapter.rb",
-    "lib/crypto_adapters/btcchina_adapter.rb",
-    "lib/crypto_adapters/btce_adapter.rb",
-    "lib/crypto_adapters/coinbase_adapter.rb",
-    "lib/crypto_adapters/huobi_adapter.rb",
-    "lib/crypto_adapters/kraken_adapter.rb",
-    "lib/crypto_adapters/localbitcoins_adapter.rb",
-    "lib/crypto_adapters/okcoin_adapter.rb",
+    "lib/adapters/crypto/bitfinex_adapter.rb",
+    "lib/adapters/crypto/bitpay_adapter.rb",
+    "lib/adapters/crypto/bitstamp_adapter.rb",
+    "lib/adapters/crypto/btc_china_adapter.rb",
+    "lib/adapters/crypto/btc_e_adapter.rb",
+    "lib/adapters/crypto/coinbase_adapter.rb",
+    "lib/adapters/crypto/huobi_adapter.rb",
+    "lib/adapters/crypto/kraken_adapter.rb",
+    "lib/adapters/crypto/localbitcoins_adapter.rb",
+    "lib/adapters/crypto/okcoin_adapter.rb",
+    "lib/adapters/fiat/fixer_adapter.rb",
+    "lib/adapters/fiat/forge_adapter.rb",
+    "lib/adapters/fiat/yahoo_adapter.rb",
+    "lib/configuration.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/fixtures/vcr/exchange_rate_adapters/btc_adapters/average_rate_adapter.yml",
-    "spec/fixtures/vcr/exchange_rate_adapters/btc_adapters/bitfinex_adapter.yml",
-    "spec/fixtures/vcr/exchange_rate_adapters/btc_adapters/bitpay_adapter.yml",
-    "spec/fixtures/vcr/exchange_rate_adapters/btc_adapters/btcchina_adapter.yml",
-    "spec/fixtures/vcr/exchange_rate_adapters/btc_adapters/btce_adapter.yml",
-    "spec/fixtures/vcr/exchange_rate_adapters/btc_adapters/coinbase_adapter.yml",
-    "spec/fixtures/vcr/exchange_rate_adapters/btc_adapters/huobi_adapter.yml",
-    "spec/fixtures/vcr/exchange_rate_adapters/btc_adapters/kraken_adapter.yml",
-    "spec/fixtures/vcr/exchange_rate_adapters/btc_adapters/localbitcoins_adapter.yml",
-    "spec/fixtures/vcr/exchange_rate_adapters/btc_adapters/okcoin_adapter.yml",
-    "spec/fixtures/vcr/exchange_rate_adapters/fiat_adapters/fixer_adapter.yml",
-    "spec/fixtures/vcr/exchange_rate_adapters/fiat_adapters/yahoo_adapter.yml",
-    "spec/lib/crypto_adapter_spec.rb",
-    "spec/lib/crypto_adapters/average_rate_adapter_spec.rb",
-    "spec/lib/crypto_adapters/bitfinex_adapter_spec.rb",
-    "spec/lib/crypto_adapters/bitpay_adapter_spec.rb",
-    "spec/lib/crypto_adapters/bitstamp_adapter_spec.rb",
-    "spec/lib/crypto_adapters/btcchina_adapter_spec.rb",
-    "spec/lib/crypto_adapters/btce_adapter_spec.rb",
-    "spec/lib/crypto_adapters/coinbase_adapter_spec.rb",
-    "spec/lib/crypto_adapters/huobi_adapter_spec.rb",
-    "spec/lib/crypto_adapters/kraken_adapter_spec.rb",
-    "spec/lib/crypto_adapters/localbitcoins_adapter_spec.rb",
-    "spec/lib/crypto_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"
+    "lib/fetcher.rb",
+    "lib/storage/file_storage.rb",
+    "lib/storage/serializers/yaml_serializer.rb",
+    "lib/synchronizer.rb",
+    "spec/fixtures/adapters/bitfinex_adapter.yml",
+    "spec/fixtures/adapters/bitpay_adapter.yml",
+    "spec/fixtures/adapters/bitstamp_adapter.yml",
+    "spec/fixtures/adapters/btc_china_adapter.yml",
+    "spec/fixtures/adapters/btce_adapter.yml",
+    "spec/fixtures/adapters/coinbase_adapter.yml",
+    "spec/fixtures/adapters/fixer_adapter.yml",
+    "spec/fixtures/adapters/forge_adapter.yml",
+    "spec/fixtures/adapters/huobi_adapter.yml",
+    "spec/fixtures/adapters/kraken_adapter.yml",
+    "spec/fixtures/adapters/localbitcoins_adapter.yml",
+    "spec/fixtures/adapters/normalized/bitfinex_adapter.yml",
+    "spec/fixtures/adapters/normalized/bitpay_adapter.yml",
+    "spec/fixtures/adapters/normalized/bitstamp_adapter.yml",
+    "spec/fixtures/adapters/normalized/btc_china_adapter.yml",
+    "spec/fixtures/adapters/normalized/btce_adapter.yml",
+    "spec/fixtures/adapters/normalized/coinbase_adapter.yml",
+    "spec/fixtures/adapters/normalized/fixer_adapter.yml",
+    "spec/fixtures/adapters/normalized/forge_adapter.yml",
+    "spec/fixtures/adapters/normalized/huobi_adapter.yml",
+    "spec/fixtures/adapters/normalized/kraken_adapter.yml",
+    "spec/fixtures/adapters/normalized/localbitcoins_adapter.yml",
+    "spec/fixtures/adapters/normalized/okcoin_adapter.yml",
+    "spec/fixtures/adapters/normalized/yahoo_adapter.yml",
+    "spec/fixtures/adapters/okcoin_adapter.yml",
+    "spec/fixtures/adapters/yahoo_adapter.yml",
+    "spec/lib/adapter_spec.rb",
+    "spec/lib/adapters/crypto/bitfinex_adapter_spec.rb",
+    "spec/lib/adapters/crypto/bitpay_adapter_spec.rb",
+    "spec/lib/adapters/crypto/bitstamp_adapter_spec.rb",
+    "spec/lib/adapters/crypto/btc_china_adapter_spec.rb",
+    "spec/lib/adapters/crypto/btc_e_adapter_spec.rb",
+    "spec/lib/adapters/crypto/coinbase_adapter_spec.rb",
+    "spec/lib/adapters/crypto/huobi_adapter_spec.rb",
+    "spec/lib/adapters/crypto/kraken_adapter_spec.rb",
+    "spec/lib/adapters/crypto/localbitcoins_adapter_spec.rb",
+    "spec/lib/adapters/crypto/okcoin_adapter_spec.rb",
+    "spec/lib/adapters/fiat/fixer_adapter_spec.rb",
+    "spec/lib/adapters/fiat/forge_adapter_spec.rb",
+    "spec/lib/adapters/fiat/yahoo_adapter_spec.rb",
+    "spec/lib/currency_rate_spec.rb",
+    "spec/lib/fetcher_spec.rb",
+    "spec/lib/storage/file_storage_spec.rb",
+    "spec/lib/synchronizer_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/matchers/eq_any_of.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"
+  s.homepage = "http://github.com/snitko/currency-rate".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "2.6.14".freeze
+  s.summary = "Converter for fiat and crypto currencies".freeze
 
   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.3.7"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<webmock>, [">= 0"])
-      s.add_development_dependency(%q<vcr>, [">= 0"])
+      s.add_runtime_dependency(%q<http>.freeze, [">= 0"])
+      s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.3.7"])
+      s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
+      s.add_development_dependency(%q<webmock>.freeze, [">= 0"])
+      s.add_development_dependency(%q<byebug>.freeze, [">= 0"])
     else
-      s.add_dependency(%q<satoshi-unit>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 2.3.7"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<webmock>, [">= 0"])
-      s.add_dependency(%q<vcr>, [">= 0"])
+      s.add_dependency(%q<http>.freeze, [">= 0"])
+      s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.7"])
+      s.add_dependency(%q<rspec>.freeze, [">= 0"])
+      s.add_dependency(%q<webmock>.freeze, [">= 0"])
+      s.add_dependency(%q<byebug>.freeze, [">= 0"])
     end
   else
-    s.add_dependency(%q<satoshi-unit>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 2.3.7"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<webmock>, [">= 0"])
-    s.add_dependency(%q<vcr>, [">= 0"])
+    s.add_dependency(%q<http>.freeze, [">= 0"])
+    s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.7"])
+    s.add_dependency(%q<rspec>.freeze, [">= 0"])
+    s.add_dependency(%q<webmock>.freeze, [">= 0"])
+    s.add_dependency(%q<byebug>.freeze, [">= 0"])
   end
 end
 

data/lib/adapter.rb

@@ -2,105 +2,59 @@ module CurrencyRate
   class Adapter
     include Singleton
 
-    class FetchingFailed       < StandardError; end
-    class CurrencyNotSupported < StandardError; end
+    FETCH_URL = nil
+    API_KEY_PARAM = nil
 
-    DECIMAL_PRECISION = nil
+    def name
+      self.class.name.gsub /^.*::/, ""
+    end
 
-    attr_accessor :try_storage_on_fetching_failed
-    attr_reader   :storage
+    def fetch_rates
+      begin
+        normalize exchange_data
+      rescue StandardError => e
+        CurrencyRate.logger.error("Error in #{self.name}#fetch_rates")
+        CurrencyRate.logger.error(e)
+        nil
+      end
+    end
 
-    def initialize
-      @storage = Storage.new(adapter_name: self.class.to_s)
+    def normalize(data)
+      if data.nil?
+        CurrencyRate.logger.warn("#{self.name}#normalize: data is nil")
+        return nil
+      end
+      true
     end
 
-    def fetch_rates!
+    def exchange_data
       raise "FETCH_URL is not defined!" unless self.class::FETCH_URL
+
       begin
         if self.class::FETCH_URL.kind_of?(Hash)
-          @rates = {}
-          self.class::FETCH_URL.each do |name, url|
-            uri = URI.parse(url)
-            @rates[name] = JSON.parse(uri.read(read_timeout: 4))
+          self.class::FETCH_URL.reduce({}) do |result, (name, url)|
+            result[name] = request url
+            result
           end
         else
-          uri = URI.parse(self.class::FETCH_URL)
-          @rates = JSON.parse(uri.read(read_timeout: 4))
+          request self.class::FETCH_URL
         end
-        @rates_updated_at = Time.now
-        @rates
-      rescue Exception => e
-        raise FetchingFailed
+      rescue StandardError => e
+        CurrencyRate.logger.error("Error in #{self.name}#exchange_data")
+        CurrencyRate.logger.error(e)
+        nil
       end
     end
 
-    def rate_for(from,to)
-      begin
-        @rates = self.storage.fetch(self.class.to_s) { self.fetch_rates! }
-      rescue FetchingFailed => e
-        if @try_storage_on_fetching_failed
-          @rates = self.storage.data[self.class.to_s][:content]
-        else
-          raise e
-        end
-      end
-
-      unless supports_currency_pair?(from,to)
-        raise CurrencyNotSupported, "Unsupported currencies (one or both) are: #{from} -> #{to}"
+    def request(url)
+      fetch_url = url
+      if self.class::API_KEY_PARAM
+        api_key = CurrencyRate.configuration.api_keys[self.name]
+        fetch_url << "&#{self.class::API_KEY_PARAM}=#{api_key}" if api_key
       end
-
-      # This method is further reloaded in Adapter classes, that's why
-      # here it doesn't really return anything useful!
-
+      http_client = HTTP.timeout(connect: 4, read: 4)
+      JSON.parse(http_client.get(fetch_url).to_s)
     end
 
-    def supports_currency_pair?(c1,c2)
-      supported_currency_pairs.include?("#{c1}/#{c2}".upcase) || supported_currency_pairs.include?("#{c2}/#{c1}".upcase)
-    end
-
-    # This method is supposed to be implemented for each individual adapter because the format of
-    # the contents of the @rate variable is specific to each adapter. It would parse @rates and
-    # extract currency pairs. Returns an array of supported currency pairs: ["USD/BTC", "EUR/BTC"]
-    #
-    # If you're implementing this method please note that you don't need to return a reversed pair
-    # that is ["USD/BTC", "BTC/USD"] would be excessive and just ["USD/BTC"] would work,
-    # because it is assumed that the adapter supports a reverse pair (see #rate_for implementation above).
-    #
-    # It would also be wise to use caching when implementing, that is:
-    #
-    #   return @supported_currency_pairs if @supported_currency_pairs
-    #
-    # Which would make this method parse @rates only once.
-    def supported_currency_pairs
-      raise "Please implement #supported_currency_pairs in your Adapter"
-    end
-
-    def cache_supported_currency_pairs
-      return @supported_currency_pairs if @supported_currency_pairs
-      @supported_currency_pairs = []
-      yield
-      @supported_currency_pairs
-    end
-
-    # Must be implemented inside every descendant class
-    # because storage format may be completely different
-    def get_rate_value_from_source(rates_hash, *keys)
-      raise "Please implement this method in your Adapter"
-    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
-
-
-    private
-
-      def _invert_rate(rate)
-        r = (BigDecimal.new('1')/BigDecimal.new(rate.to_s))
-        r = r.round(self.class::DECIMAL_PRECISION) if self.class::DECIMAL_PRECISION
-        r
-      end
   end
 end