apilayer 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2659b5c043a8d8a4d2a436946ade66aa15abaf2
-  data.tar.gz: 55ca2767cfde675b299e4e0e72528d80666c9070
+  metadata.gz: 4b96da80c728f03b13491f9a4d7f24dc8b445c90
+  data.tar.gz: 4ae80aaded90734d72100e480ab120ec25025f05
 SHA512:
-  metadata.gz: b315c3af07f87e5e46cffe3f0df6621a95b6e12f6f399846d33de65ea7ea608c73e8dec39e93a16d29a839bebfa0450bce7607458a033072ecdbdd3355fe0d6d
-  data.tar.gz: ef460e9457bf224fb2f5f2462223a0ba9df83c06697e398d707b240710d09f50363abc38e20358ccfc76fb0defbbac1d864806244f3e8cbe6ee23e09a903072d
+  metadata.gz: 7353484a6d9eefc43d098f1853a0bf4c27aa121d0f2785d493f4870b1cde71ecbd429d2da00de0bd568f8870f958a22dfeab4f51244ee8d5f1ed79130a92a3b6
+  data.tar.gz: 4a95462f310c84991796fa576558809369ed6f8f74f6d3905c65cf063fb1264bc649d9c9ff6b5c56886cd91d789ab719c25940f5ca178100b05fafc984e8b0d4

data/README.rdoc

@@ -3,8 +3,10 @@
 Ruby wrapper for various services of apilayer.
 See http://apilayer.com for more details.
 
-=== Version 1.0
-For this version, only the API-features that are available to the free accounts are supported. See the documentation of http://currencylayer.com and http://vatlayer.com for more details.
+=== Version 1.1
+- Major change to how .live and .historical in Apilayer::Currency are invoked.
+- Added :source option to Apilayer::Currency.live and Apilayer::Currency.historical methods. This option is only available to paid users of currencylayer.
+
 
 === Installation
 
@@ -37,13 +39,16 @@ Once that is done, you are ready to go
 ==== currencylayer
 After setting the access_key for *currencylayer*, you can use Apilayer::Currency to call *currencylayer*'s API
   Apilayer::Currency.live
-  Apilayer::Currency.live("EUR", "GBP", "CHF")
-  
+  Apilayer::Currency.live(:currencies => %w[GBP, CHF])
+  Apilayer::Currency.live(:source => "EUR") # source-currency is USD by default
+  Apilayer::Currency.live(:source => "EUR", :currencies => %w[GBP, CHF])
+
   Apilayer::Currency.historical("2016-01-01")
-  Apilayer::Currency.historical("2016-01-01", "EUR", "GBP", "CHF")
+  Apilayer::Currency.historical("2016-01-01", :currencies => %w[GBP CHF])
+  Apilayer::Currency.historical(:source => "EUR") # source-currency is USD by default
+  Apilayer::Currency.historical("2016-01-01", :currencies => %w[GBP CHF], :source => "EUR")
 
 ==== vatlayer
-
 After setting the access_key for *vatlayer*, you can use Apilayer::Vat to call *vatlayer*'s API
 
   Apilayer::Vat.validate("LU26375245")

data/lib/apilayer/currency.rb

@@ -8,6 +8,19 @@ module Apilayer
     # Determines which access_key in Apilayer.configs to use 
     # in order to to make a connection to currencylayer
     APILAYER_CONFIG_KEY = :currency_key
+    INVALID_OPTIONS_MSG = "You have provided an invalid option. Allowed options are :currencies and :source"
+    LIVE_SLUG = "live"
+    HISTORICAL_SLUG = "historical"
+
+    ## Validations 
+    # 
+    def self.validate_options(options)
+      options.keys.each do |key|
+        unless [:currencies, :source].include? key
+          raise Apilayer::Error.new(INVALID_OPTIONS_MSG)
+        end
+      end
+    end
 
     ### API methods
     #
@@ -17,14 +30,16 @@ module Apilayer
     # When no currency-codes are specified, it will return all exchange rates for your source-currency.
     # Example:
     #   Apilayer::Currency.live
-    #   Apilayer::Currency.live("EUR", "GBP", "CHF")
-    def self.live(*currencies)
-      if currencies.any?
-        currencies_str = join_by_commas(currencies)
-        params = {:currencies => currencies_str}
-        get_and_parse("live", params)
+    #   Apilayer::Currency.live(:currencies => %w[GBP, CHF])
+    #   Apilayer::Currency.live(:source => "EUR")
+    #   Apilayer::Currency.live(:source => "EUR", :currencies => %w[GBP, CHF])
+    def self.live(opts={})
+      validate_options(opts)
+
+      if opts.empty?
+        get_and_parse LIVE_SLUG
       else
-        get_and_parse("live")
+        get_and_parse_with_options(LIVE_SLUG, opts)
       end
     end
 
@@ -33,13 +48,34 @@ module Apilayer
     # When no currency-codes are specified, it will return all exchange rates for your source-currency.
     # Example:
     #   Apilayer::Currency.historical("2016-01-01")
-    #   Apilayer::Currency.historical("2016-01-01", "EUR", "GBP", "CHF")
-    def self.historical(date, *currencies)      
+    #   Apilayer::Currency.historical("2016-01-01", :currencies => %w[GBP CHF])
+    #   Apilayer::Currency.historical(:source => "EUR")
+    #   Apilayer::Currency.historical("2016-01-01", :currencies => %w[GBP CHF], :source => "EUR")
+    def self.historical(date, opts={})
+      validate_options(opts)
       params = {:date => date}
-      params.merge!(:currencies => join_by_commas(currencies)) if currencies.any?
-      get_and_parse("historical", params)
+
+      if opts.empty?
+        get_and_parse(HISTORICAL_SLUG, params)
+      else
+        get_and_parse_with_options(HISTORICAL_SLUG, opts, params)
+      end
+    end
+
+    def self.get_and_parse_with_options(slug, opts, params={})
+      params = add_options_to_params(opts, params)
+      get_and_parse(slug, params)
     end
 
+    def self.add_options_to_params(opts, params)
+      if opts[:currencies] && opts[:currencies].any?
+        params[:currencies] = join_by_commas(opts[:currencies])
+      end
+      if opts[:source]
+        params[:source] = opts[:source]
+      end
+      params
+    end
     ##
     # Joins currencies in an array as a comma-separated-string
     def self.join_by_commas(currencies)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apilayer
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Alex Fong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2016-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -191,7 +191,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.0.1
 description: Ruby wrapper for currencylayer and vatlayer from apilayer.com. Currently
-  supporting the free API-functions only. See https://apilayer.com/ for more details.
+  not supporting all paid-features yet. See https://apilayer.com/ for more details.
 email:
 - actfong@gmail.com
 executables: []