money-currencylayer-bank 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57c027e5e05e294bcaa1d9d8c62660a9b88dd164
-  data.tar.gz: 8ea8e257ea4fde758ab909d53955bba5d165a149
+  metadata.gz: f30609c06313fb218edbad89627da0d1bb7bc66d
+  data.tar.gz: 8a1ffe4d046a32e3942b67cf89977ef3d8c2c0f5
 SHA512:
-  metadata.gz: e67f41efcd22a9e3d388a8ab4c315e634ee9cc7e1b28344521dbbc52bdb65614fe05e28a6b538576ed7bac4c3433d39104d97c37482bc713d3b81513f368112a
-  data.tar.gz: 250b29148bf6119e1a22b8d58f9a9cd3d0b4b3e5812e65db7cfa1f8443482565edf786c290c6eb9c98c12a3183520814189b8543b3c8034855834767177fba01
+  metadata.gz: 546c3541ae100259af247726d04e17fdb8e86a011e19d3f8d378f8eef8d373f11f3479a703f68876d38a82bfdbf8a26784e25009d7b51178dfea0b07b14e8418
+  data.tar.gz: 11ccf7440dbf5d076578cce0e6cc591c70217ec5481c97caa2f1a32bc4ab03cdffe35fcbbf7a8193151f2687ca512c83e683b44deee1eb0200b36b53be6d4f66

data/README.md

@@ -9,6 +9,36 @@
 A gem that calculates the exchange rate using published rates from
 [currencylayer.com](https://currencylayer.com/)
 
+## Currencylayer API
+
+~~~ json
+{
+  "timestamp": 1441101909,
+  "source": "USD",
+  "quotes": {
+      /* 168 currencies */
+      "USDAUD": 1.413637,
+      "USDCAD": 1.316495,
+      "USDCHF": 0.96355,
+      "USDEUR": 0.888466,
+      "USDBTC": 0.004322, /* Includes Bitcoin currency! */
+      ...
+      }
+}
+~~~
+
+See more about Currencylayer product plans on https://currencylayer.com/product.
+
+## Features
+
+* supports 168 currencies
+* includes [Bitcoin](https://en.wikipedia.org/wiki/Bitcoin) virtual currency
+* precision of rates up to 6 digits after point
+* uses fast and reliable json api
+* average response time < 20ms
+* supports caching currency rates
+* calculates every pair rate calculating inverse rate or using base currency rate
+
 ## Usage
 
 ~~~ ruby
@@ -45,6 +75,43 @@ mclb.cache = 'path/to/file/cache'
 Money.default_bank = mclb
 ~~~
 
+### More methods
+
+~~~ ruby
+mclb = Money::Bank::CurrencylayerBank.new
+
+# Returns the base currency set for all rates.
+mclb.source
+
+# Expires rates if the expiration time is reached.
+mclb.expire_rates!
+
+# Return true if the expiration time is reached.
+mclb.expired?
+
+# Get the API source url.
+mclb.source_url
+
+# Get the rates timestamp of the last API request.
+mclb.rates_timestamp
+~~~
+
+### How to exchange
+
+~~~ ruby
+# Exchange 1000 cents (10.0 USD) to EUR
+Money.new(1000, 'USD').exchange_to('EUR')        # => #<Money fractional:89 currency:EUR>
+Money.new(1000, 'USD').exchange_to('EUR').to_f   # => 8.9
+
+# Format
+Money.new(1000, 'USD').exchange_to('EUR').format # => €8.90
+
+# Get the rate
+Money.default_bank.get_rate('USD', 'CAD')        # => 0.9
+~~~
+
+See more on https://github.com/RubyMoney/money.
+
 ### Using gem money-rails
 
 You can also use it in Rails with the gem [money-rails](https://github.com/RubyMoney/money-rails).
@@ -92,14 +159,32 @@ bundle exec rake
 
 ## Refs
 
-* <https://github.com/RubyMoney/money>
-* <https://github.com/currencybot/open-exchange-rates>
+* Gem [money](https://github.com/RubyMoney/money)
+* Gem [money-open-exchange-rates](https://github.com/spk/money-open-exchange-rates)
+* Gem [money-historical-bank](https://github.com/atwam/money-historical-bank)
+
+## Other Implementations
+
+* Gem [currencylayer](https://github.com/askuratovsky/currencylayer)
+* Gem [money-open-exchange-rates](https://github.com/spk/money-open-exchange-rates)
+* Gem [money-historical-bank](https://github.com/atwam/money-historical-bank)
+* Gem [eu_central_bank](https://github.com/RubyMoney/eu_central_bank)
+* Gem [nordea](https://github.com/matiaskorhonen/nordea)
+* Gem [google_currency](https://github.com/RubyMoney/google_currency)
 
 ## Contributors
 
 * See [github.com/phlegx/money-currencylayer-bank](https://github.com/phlegx/money-currencylayer-bank/graphs/contributors).
 * Inspired by [github.com/spk/money-open-exchange-rates](https://github.com/spk/money-open-exchange-rates/graphs/contributors).
 
+## Contributing
+
+1. Fork it ( https://github.com/[your-username]/money-currencylayer-bank/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
 ## License
 
 The MIT License

data/lib/money/bank/currencylayer_bank.rb

@@ -52,13 +52,13 @@ class Money
       #
       # @param value [String] Currency code, ISO 3166-1 alpha-3
       #
-      # @return [String] Setted base currency
+      # @return [String] chosen base currency
       def source=(value)
         @source = Money::Currency.find(value.to_s).try(:iso_code) || CL_SOURCE
       end
 
       # Get the base currency for all rates. By default, USD is used.
-      # @return [String] Base currency
+      # @return [String] base currency
       def source
         @source ||= CL_SOURCE
       end
@@ -69,9 +69,9 @@ class Money
       # @example
       #   ttl_in_seconds = 86400 # will expire the rates in one day
       #
-      # @param value [Integer] Time to live in seconds
+      # @param value [Integer] time to live in seconds
       #
-      # @return [Integer] Setted time to live in seconds
+      # @return [Integer] chosen time to live in seconds
       def ttl_in_seconds=(value)
         @ttl_in_seconds = value
         refresh_rates_expiration! if ttl_in_seconds
@@ -79,14 +79,14 @@ class Money
       end
 
       # Update all rates from CurrencylayerBank JSON
-      # @return [Array] Array of exchange rates
+      # @return [Array] array of exchange rates
       def update_rates(straight = false)
         exchange_rates(straight).each do |exchange_rate|
           currency = exchange_rate.first[3..-1]
           rate = exchange_rate.last
           next unless Money::Currency.find(currency)
-          set_rate(source, currency, rate)
-          set_rate(currency, source, 1.0 / rate)
+          add_rate(source, currency, rate)
+          add_rate(currency, source, 1.0 / rate)
         end
       end
 
@@ -95,25 +95,57 @@ class Money
       # @param [String] to_currency Currency ISO code. ex. 'CAD'
       #
       # @return [Numeric] rate.
-      def get_rate(from_currency, to_currency, opts = {})
+      def get_rate(from_currency, to_currency, opts = {}) # rubocop:disable all
         expire_rates!
-        super
+        rate = super
+        unless rate
+          # Tries to calculate an inverse rate
+          inverse_rate = super(to_currency, from_currency, opts)
+          if inverse_rate
+            rate = 1.0 / inverse_rate
+            add_rate(from_currency, to_currency, rate)
+          end
+        end
+        unless rate
+          # Tries to calculate a pair rate using base currency rate
+          from_base_rate = super(source, from_currency, opts)
+          unless from_base_rate
+            from_inverse_rate = super(from_currency, source, opts)
+            from_base_rate = 1.0 / from_inverse_rate if from_inverse_rate
+          end
+          to_base_rate = super(source, to_currency, opts)
+          unless to_base_rate
+            to_inverse_rate = super(to_currency, source, opts)
+            to_base_rate = 1.0 / to_inverse_rate if to_inverse_rate
+          end
+          if to_base_rate && from_base_rate
+            rate = to_base_rate / from_base_rate
+            add_rate(from_currency, to_currency, rate)
+          end
+        end
+        rate
       end
 
-      # Expire rates when expired
+      # Fetch new rates if cached rates are expired
+      # @return [Boolean] true if rates are expired and updated from remote
       def expire_rates!
-        return unless expired?
-        update_rates(true)
+        if expired?
+          update_rates(true)
+          true
+        else
+          false
+        end
       end
 
-      # Check if time is expired
-      # @return [Boolean] is the time expired.
+      # Check if rates are expired
+      # @return [Boolean] true if rates are expired
       def expired?
-        !ttl_in_seconds.nil? && rates_expiration < Time.now
+        !ttl_in_seconds.nil? && rates_expiration <= Time.now
       end
 
       # Source url of CurrencylayerBank
       # defined with access_key and secure_connection
+      # @return [String] the remote API url
       def source_url
         fail NoAccessKey if access_key.nil? || access_key.empty?
         cl_url = CL_URL
@@ -122,7 +154,7 @@ class Money
       end
 
       # Get the timestamp of rates
-      # @return [Time] Time object or nil
+      # @return [Time] time object or nil
       def rates_timestamp
         parsed = raw_rates_careful
         parsed.key?('timestamp') ? Time.at(parsed['timestamp']) : nil
@@ -136,7 +168,7 @@ class Money
       # @example
       #   store_in_cache("{\"quotes\": {\"USDAED\": 3.67304}}")
       #
-      # @param text [String] String to cache
+      # @param text [String] unparsed JSON content
       # @return [String,Integer]
       def store_in_cache(text)
         if cache.is_a?(Proc)
@@ -147,7 +179,7 @@ class Money
       end
 
       # Writes content to file cache
-      # @param text [String] String to cache
+      # @param text [String] unparsed JSON content
       # @return [String,Integer]
       def write_to_file(text)
         open(cache, 'w') do |f|
@@ -158,7 +190,7 @@ class Money
       end
 
       # Read from cache when exist
-      # @return [Proc,String] JSON content
+      # @return [Proc,String] unparsed JSON content
       def read_from_cache
         if cache.is_a?(Proc)
           cache.call(nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: money-currencylayer-bank
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Egon Zemmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-31 00:00:00.000000000 Z
+date: 2015-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money