apilayer 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b78b1270c33ed6f9b1a8879031dcb80fa82bee9b
-  data.tar.gz: b1349cc942a471919e688af35cf447a60d955296
+  metadata.gz: ece8c553f9af332d873b2c0577caf0ae7f899fab
+  data.tar.gz: 0fb25263dfad5bf7d1444f47d88b022cb173b216
 SHA512:
-  metadata.gz: 2a247fd53c936004185f43a3e67b3bef676718ca6df248d33032f50d5a4a44e6f1fa8a1657e2f0400179230d2a31a20887ec6c8bd2716d2b95454df3586787de
-  data.tar.gz: dd6fc9340d265b22c5542717496e67b9fff07339f602704bfe8a55358b3016403a393c7c9bc698c5fe19ad9ea8a538adcb6544b8df294db9ef7dba9b6db7e323
+  metadata.gz: bd5b9cd11fb91ca457ffbf67d21e4140504da160dcf1091ddfb0df5b035cbb098a934b75ad630d053ffccce7f9be2d5771af4d69ff4b2af0775e34902f7a6537
+  data.tar.gz: 7d955d30a368d56a418666651727c5f3c7d084c4aa4ce5d3ad5402b71059d6c2c26ca29aca896a49a1109e496eab086a6c3bb4a0b069905d829a4c77b11e24c6

data/README.rdoc

@@ -1,17 +1,26 @@
 == apilayer {<img src="https://secure.travis-ci.org/actfong/apilayer.png"/>}[http://travis-ci.org/actfong/apilayer] {<img src="https://codeclimate.com/github/actfong/apilayer.png"/>}[https://codeclimate.com/github/actfong/apilayer] {<img src="https://badge.fury.io/rb/apilayer.svg" alt="Gem Version" />}[https://badge.fury.io/rb/apilayer] 
 
-Ruby wrapper for various services of apilayer.
+With the release of version 2.0, the apilayer gem now act as a dependency for the *currency_layer* and *vat_layer* gems.
+
+Please see https://github.com/actfong/currency_layer and https://github.com/actfong/vat_layer
+
+*apilayer* provides a common-interface to configure and create connections to apilayer.net
 See http://apilayer.com for more details.
 
+=== Version 2.0
+Removed all code related to currencylayer (Apilayer::Currency) and vatlayer (Apilayer::Vat).
+Now act as a dependency to currency_layer and vat_layer gems. 
+ConnectionHelper contains all code related to configuring and creating connections to apilayer.net
+
 === Version 1.5
-Improved reconfiguration-mechanism in Apilayer.
-Added HTTPS-option in Apilayer module.
-With this release, all paid-features of vatlayer and currencylayer are fully covered.
+- Improved reconfiguration-mechanism in Apilayer.
+- Added HTTPS-option in Apilayer module.
+- With this release, all paid-features of vatlayer and currencylayer are fully covered.
 
 === Version 1.2 - 1.4
-Added .change and .list to Apilayer::Currency
-Added .timeframe to Apilayer::Currency
-Added .convert to Apilayer::Currency
+- Added .change and .list to Apilayer::Currency
+- Added .timeframe to Apilayer::Currency
+- Added .convert to Apilayer::Currency
 
 === Version 1.1
 - Major change to how .live and .historical in Apilayer::Currency are invoked.
@@ -30,78 +39,5 @@ Run the following in your console:
 
   $ bundle install
   
-=== Usage
-
-==== Set up Apilayer
-Once you sign up for a service of *apilayer*, you will receive an access_key. Please pay attention that different services of apilayer (such as *vatlayer* and *currencylayer*) have different access keys.
-
-Then you can use your access_key(s) to configure your Apilayer module like this:
-
-  Apilayer.configure do |configs|
-    configs.vat_key = "my_vatlayer_access_key_123"
-    configs.currency_key = "my_currencylayer_access_key_123"
-    configs.vat_https = false
-    configs.currency_https = true
-  end
-
-Please note that you only need to set the access keys and https connections that you need.
-If unset, these values are just nil.
-
-You can always review you configurations with:
-
-  Apilayer.configs
-
-Once your configurations are set, 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.list
-
-  Apilayer::Currency.live
-  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", :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")
-
-  Apilayer::Currency.convert("EUR", "CHF", 100) # convert 100 EUR to CHF
-  Apilayer::Currency.convert("EUR", "CHF", 100, "2015-06-01") # based on specific date
-
-  Apilayer::Currency.timeframe("2016-01-01", "2016-06-01")
-  Apilayer::Currency.timeframe("2016-01-01", "2016-06-01", :currencies => %w[GBP CHF])
-  Apilayer::Currency.timeframe("2016-01-01", "2016-06-01", :source => "EUR")
-  Apilayer::Currency.timeframe("2016-01-01", "2016-06-01", :currencies => %w[GBP CHF], :source => "EUR")
-
-  Apilayer::Currency.change
-  Apilayer::Currency.change("2016-01-01", "2016-03-01")
-  Apilayer::Currency.change("2016-01-01", "2016-03-01", :source => "EUR")
-  Apilayer::Currency.change("2016-01-01", "2016-03-01", :currencies => %w[GBP CHF])
-  Apilayer::Currency.change("2016-01-01", "2016-03-01", :source => "EUR", :currencies => %w[GBP CHF])
-  Apilayer::Currency.change(nil, nil, {:source => "EUR"})
-  Apilayer::Currency.change(nil, nil, {:currencies => %w[GBP CHF]})
-  Apilayer::Currency.change(nil, nil, {:source => "EUR", :currencies => %w[GBP CHF]})
-
-==== vatlayer
-After setting the access_key for *vatlayer*, you can use Apilayer::Vat to call *vatlayer*'s API
-
-  Apilayer::Vat.validate("LU26375245")
-  Apilayer::Vat.rate(:country_code, "NL")
-  Apilayer::Vat.rate(:ip_address, "176.249.153.36")
-  Apilayer::Vat.rate_list
-  Apilayer::Vat.price(100, :country, "NL")
-  Apilayer::Vat.price(100, :ip_address, "176.249.153.36")
-  
-==== Re-Configure Apilayer
-If you happened to have forgotten to set or entered an incorrect value, you can re-configure your Apilayer module by:
 
-  # Example: reconfigure https for vatlayer
-  Apilayer.configure do |configs|
-    configs.vat_https = true
-  end
 
-The action above will not affect the other Apilayer configurations you have set previously. 
-When you try to connect to Apilayer again, it will create a new connection based on the values you provided.
-  

data/lib/apilayer.rb

@@ -2,39 +2,5 @@ require 'rubygems'
 require "faraday"
 require "json"
 
-module Apilayer
-  class << self
-    attr_writer :configs
-  end
-
-  def self.init_configs
-    keys = Struct.new(:currency_key, :vat_key, :currency_https, :vat_https)
-    keys.new
-  end
-
-  def self.configs
-    @configs ||= init_configs
-  end
-
-  def self.reset!
-    @configs = init_configs
-  end
-
-  def self.configure
-    reset_observers_connections
-    yield(configs)
-  end
-end
-
 require "apilayer/connection_helper"
-require "apilayer/currency"
-require "apilayer/vat"
-
-module Apilayer
-  OBSERVERS = [Apilayer::Currency, Apilayer::Vat]
-  def self.reset_observers_connections
-    OBSERVERS.each(&:reset_connection)
-  end  
-end
-
 require "apilayer/error"

data/lib/apilayer/connection_helper.rb

@@ -1,18 +1,36 @@
 module Apilayer
   module ConnectionHelper
 
+    def init_configs
+      keys = Struct.new(:access_key, :https)
+      keys.new
+    end
+
+    def configs
+      @configs ||= init_configs
+    end
+
+    def reset_configs!
+      @configs = init_configs
+    end
+
+    def configure(&block)
+      self.reset_connection
+      yield(configs)
+    end
+
     ##
     # Creates a connection for the extended module to an apilayer-service, such as currencylayer and vatlayer.
     # Uses access_key(s) configured with Apilayer module.
     def connection
       @connection ||= ::Faraday.new(
         :url => "#{protocol}://apilayer.net",
-        :params => {"access_key" => Apilayer.configs[self.const_get(:APILAYER_CONFIG_KEY)]}
+        :params => {"access_key" => self.configs[:access_key]}
       )
     end
 
     def protocol
-      Apilayer.configs[self.const_get(:APILAYER_SECURE)] ? "https" : "http"
+      self.configs[:https] ? "https" : "http"
     end
     ##
     # Resets the connection for the extended module. Used when the user needs to re-enter his/her access_key(s)
@@ -29,10 +47,10 @@ module Apilayer
 
     ##
     # Makes a get-request to apilayer's service
-    def get_request(url, params={})
+    def get_request(slug, params={})
       # calls connection method on the extended module
       connection.get do |req|
-        req.url "api/#{url}"
+        req.url "api/#{slug}"
         params.each_pair do |k,v|
           req.params[k] = v
         end
@@ -44,10 +62,6 @@ module Apilayer
     # When errors are returned by apilayer, the 'info' and 'code' from its error will be used to raise an Apilayer::Error
     def parse_response(resp)
       body = JSON.parse(resp.body)
-      # According to documentation, currencylayer has a "success" field 
-      # while vatlayer has a "valid" field to indicate whether the request was succesful or not.
-      # However, for both layers, an unsuccesful request would contain an "error" field.
-      # That's why the presence of "error" is chosen to determine whether we should raise an error or not.
       if body['error']
         raise Apilayer::Error.new(
           body['error']['info'],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apilayer
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Alex Fong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-31 00:00:00.000000000 Z
+date: 2016-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -190,7 +190,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.1
-description: Ruby wrapper for currencylayer and vatlayer from apilayer.com. See https://apilayer.com/
+description: Acts as a dependency for the currency_layer and vat_layer gems. See https://apilayer.com/
   for more details.
 email:
 - actfong@gmail.com
@@ -204,9 +204,7 @@ files:
 - Rakefile
 - lib/apilayer.rb
 - lib/apilayer/connection_helper.rb
-- lib/apilayer/currency.rb
 - lib/apilayer/error.rb
-- lib/apilayer/vat.rb
 homepage: https://github.com/actfong/apilayer
 licenses:
 - MIT
@@ -230,6 +228,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Ruby wrapper for currencylayer and vatlayer from apilayer.com. See https://apilayer.com/
+summary: Acts as a dependency for the currency_layer and vat_layer gems. See https://apilayer.com/
   for more details.
 test_files: []

data/lib/apilayer/currency.rb

@@ -1,158 +0,0 @@
-##
-# Ruby wrapper for currencylayer. See https://currencylayer.com/documentation for more info
-module Apilayer
-  module Currency
-    extend ConnectionHelper
-
-    ##
-    # The following constants determine which values in Apilayer.configs to be used
-    # in order to to make a connection to currencylayer
-    APILAYER_CONFIG_KEY = :currency_key
-    APILAYER_SECURE = :currency_https
-
-    INVALID_OPTIONS_MSG = "You have provided an invalid option. Allowed options are :currencies and :source"
-    INVALID_TIMEFRAME_MSG = "start_date and end_date must be either provided together or left out together."
-    LIVE_SLUG = "live"
-    HISTORICAL_SLUG = "historical"
-    CONVERT_SLUG = "convert"
-    TIMEFRAME_SLUG = "timeframe"
-    CHANGE_SLUG = "change"
-    LIST_SLUG = "list"
-
-    ## 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
-
-    def self.validate_timeframe_completeness(start_date,end_date)
-      if [start_date,end_date].compact.size == 1
-        raise Apilayer::Error.new(INVALID_TIMEFRAME_MSG)
-      end
-    end
-    ### API methods
-    #
-
-    ##
-    # Api-Method: Calls the /list endpoint to display all supported currencies
-    def self.list
-      get_and_parse LIST_SLUG
-    end
-
-    ##
-    # Api-Method: Calls the /live endpoint to get real-time exchange rates.
-    # When no currency-codes are specified, it will return all exchange rates for your source-currency.
-    # Examples:
-    #   Apilayer::Currency.live
-    #   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_with_options(LIVE_SLUG, opts)
-      end
-    end
-
-    ##
-    # Api-Method: Calls the /historical endpoint to get exchange rates for a specific date.
-    # When no currency-codes are specified, it will return all exchange rates for your source-currency.
-    # Examples:
-    #   Apilayer::Currency.historical("2016-01-01")
-    #   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}
-
-      if opts.empty?
-        get_and_parse(HISTORICAL_SLUG, params)
-      else
-        get_and_parse_with_options(HISTORICAL_SLUG, opts, params)
-      end
-    end
-
-    ##
-    # Api-Method: Calls the /convert endpoint, requires :from, :to and :amount
-    # When :date hasn't been passed, the latest available exchange rates will be used for your conversion.
-    # Examples:
-    #   Apilayer::Currency.convert("EUR", "CHF", 100)
-    #   Apilayer::Currency.convert("EUR", "CHF", 100, "2015-03-01")
-    def self.convert(from, to, amount, date=nil)
-      params = {:from => from, :to => to, :amount => amount}
-      params.merge!(:date => date) if date
-      get_and_parse(CONVERT_SLUG, params)
-    end
-
-    ##
-    # Api-Method: Calls the /timeframe endpoint. Requires :start_date and :end_date
-    # If :currencies hasn't been provided as an option, it will return all exchange-rates for that period of your source-currency
-    # :source can be provided as option to change the source-currency, which is USD by default
-    # The difference between start_date and end_date can be maximum 365 days
-    # Examples:
-    #   Apilayer::Currency.timeframe("2016-01-01", "2016-03-01")
-    #   Apilayer::Currency.timeframe("2016-01-01", "2016-03-01", :currencies => %w[GBP CHF])
-    #   Apilayer::Currency.timeframe("2016-01-01", "2016-03-01", :currencies => %w[GBP CHF], :source => "EUR")
-    def self.timeframe(start_date, end_date, opts={})
-      validate_options(opts)
-      params = {:start_date => start_date, :end_date => end_date}
-      get_and_parse_with_options(TIMEFRAME_SLUG, opts, params)
-    end
-
-    ##
-    # Api-Method: Calls the /change endpoint.
-    # start_date and end_date are optional, but can't provide one without the other
-    # :currencies and :source are optional
-    # Examples:
-    #   Apilayer::Currency.change
-    #   Apilayer::Currency.change("2016-01-01", "2016-03-01")
-    #   Apilayer::Currency.change("2016-01-01", "2016-03-01", :source => "EUR")
-    #   Apilayer::Currency.change("2016-01-01", "2016-03-01", :currencies => %w[GBP CHF])
-    #   Apilayer::Currency.change("2016-01-01", "2016-03-01", :source => "EUR", :currencies => %w[GBP CHF])
-    #   Apilayer::Currency.change(nil, nil, {:source => "EUR"})
-    #   Apilayer::Currency.change(nil, nil, {:currencies => %w[GBP CHF]})
-    #   Apilayer::Currency.change(nil, nil, {:source => "EUR", :currencies => %w[GBP CHF]})
-    def self.change(start_date=nil, end_date=nil, opts={})
-      validate_options(opts)
-      validate_timeframe_completeness(start_date,end_date)
-      params = {:start_date => start_date, 
-        :end_date => end_date
-      }.reject{ |k,v| v.nil? }
-      get_and_parse_with_options(CHANGE_SLUG, opts, params)
-    end    
-
-    ## 
-    # 
-    def self.get_and_parse_with_options(slug, opts, params={})
-      params = add_options_to_params(opts, params)
-      get_and_parse(slug, params)
-    end
-
-    ##
-    # Adds currencies and source to query string if they have been provided with options-hash
-    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)
-      currencies.map(&:strip).join(",")
-    end
-
-  end
-end

data/lib/apilayer/vat.rb

@@ -1,68 +0,0 @@
-##
-# Ruby wrapper for vatlayer. See https://vatlayer.com/documentation for more info
-module Apilayer
-  module Vat
-    extend ConnectionHelper
-
-    COUNTRY_CRITERIA_MISSING_MSG = "You must provide either :country_code or :ip_address"
-
-    ##
-    # The following constants determine which values in Apilayer.configs to be used
-    # in order to make a connection to vatlayer
-    APILAYER_CONFIG_KEY = :vat_key
-    APILAYER_SECURE = :vat_https
-    ##
-    # Validates whether a supported criteria has been provided to .rate and .price
-    def self.validate_country_criteria(criteria)
-      unless [:country_code, :ip_address].include? criteria
-        raise Apilayer::Error.new COUNTRY_CRITERIA_MISSING_MSG
-      end
-    end
-
-    ### API methods
-    #
-
-    ##
-    # Api-Method: Calls the /validate endpoint to validate a given VAT-number.
-    # Example:
-    #   Apilayer::Vat.validate("LU26375245")
-    def self.validate(vat_number)
-      params = {:vat_number => vat_number}
-      get_and_parse("validate", params)
-    end
-
-    ##
-    # Api-Method: Calls the /rate endpoint to get the VAT-rate of a given country, 
-    # based on country-code or ip-address.
-    # Example:
-    #   Apilayer::Vat.rate(:country_code, "NL")
-    #   Apilayer::Vat.rate(:ip_address, "176.249.153.36")
-    def self.rate(criteria, value)
-      validate_country_criteria(criteria)
-      params = {criteria.to_sym => value}
-      get_and_parse("rate", params)
-    end
-
-    ##
-    # Api-Method: Calls the /rate_list endpoint to get the standard and reduced VAT-rates
-    # for all EU countries.
-    # Example:
-    #   Apilayer::Vat.rate_list
-    def self.rate_list
-      get_and_parse("rate_list")
-    end
-
-    ##
-    # Api-Method: Calls the /price endpoint to get price including and excluding VAT 
-    # for a given price and country. It also returns the VAT rate for that country
-    # Example:
-    #   Apilayer::Vat.price(100, :country, "NL")
-    #   Apilayer::Vat.price(100, :ip_address, "176.249.153.36")
-    def self.price(price, criteria, value)
-      validate_country_criteria(criteria)
-      params = {:amount => price, criteria.to_sym => value}
-      get_and_parse("price", params)
-    end
-
-  end
-end