apilayer 0.0.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c74d7ef9158c6816618bfdefc24b46add14a17f
-  data.tar.gz: 0925e5677d3797905b3904681c05c68da90b38f9
+  metadata.gz: 2c90421964d0e4f1e87b8dd237cc9fd9829828d4
+  data.tar.gz: 0d134f0f06cfa93e4c1aeb7bab7cebf2b48f4d4c
 SHA512:
-  metadata.gz: 072fe6a9874a9c5bf297fddc8fd78d6f45d07e88aa97fd19fef7795ac24cdcc9350d8013a41afabe34bd12924073b6bb9729b35e8eb0a2e5cccd3a8fa157ce55
-  data.tar.gz: 204aeaf2ee0049706999a04d31e516f420254ac54cf35333d91c6aa66bfda0a9fdd16f8bc17bdc27d213760aa2c6d23cfe1316d56ea457909a5763a414d23090
+  metadata.gz: cc9197e568e72415aca957bff9eebcdcac94be67a5e17c5b6d78822808c4828675eadbf1efb1726693fd309d1cbce578cc43746ef5905fce46924a90681cbdc3
+  data.tar.gz: 5559cc9b38fbdf4f34b92727b58c3d03f6b3222b5ade671a25708596e2f573a1a938c45786af2f77fc3a9871bfb1260a33f7f8bd62bd64b5204b51545fb122d0

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2016 Alex Fong http://www.github.com/actfong
+
+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/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+task :default => :spec
+desc 'Run test suite'
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/apilayer.rb

@@ -16,7 +16,7 @@ module Apilayer
     @configs ||= init_configs
   end
 
-  def self.reset
+  def self.reset!
     @configs = init_configs
   end
 
@@ -25,6 +25,7 @@ module Apilayer
   end
 end
 
+require "apilayer/connection_helper"
 require "apilayer/currency"
 require "apilayer/vat"
-require "apilayer/error"
+require "apilayer/error"

data/lib/apilayer/connection_helper.rb

@@ -0,0 +1,39 @@
+module Apilayer
+  module ConnectionHelper
+
+    def reset_connection
+      @connection = nil
+    end
+
+    def get_and_parse(url, params={})
+      resp = get_request(url, params)
+      parse_response(resp)
+    end
+
+    def get_request(url, params={})
+      # calls connection method on the extended module
+      connection.get do |req|
+        req.url "api/#{url}"
+        params.each_pair do |k,v|
+          req.params[k] = v
+        end
+      end
+    end
+
+    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'],
+          body['error']['code']
+        )
+      else
+        body
+      end      
+    end
+  end
+end

data/lib/apilayer/currency.rb

@@ -1,42 +1,40 @@
 module Apilayer
-
   module Currency
+    extend ConnectionHelper
+
+    CURRENCYLAYER_KEY_MISSING_MSG = "Please configure access_key for currency_layer first!"
 
     def self.connection
-      if Apilayer.configs[:currency_key].nil?
-        raise Apilayer::Error.new "Please configure access_key for currency_layer first!"
-      else
-        @connection ||= ::Faraday.new(:url => 'http://apilayer.net', 
-                                      :params => {"access_key" => Apilayer.configs[:currency_key]})
-      end
+      @connection ||= ::Faraday.new(:url => 'http://apilayer.net', 
+                                    :params => {"access_key" => Apilayer.configs[:currency_key]})
     end
 
     def self.live(*currencies)
-      resp = connection.get do |req|
-        req.url 'api/live' 
-        req.params['currencies'] = currencies.map(&:strip).join(",")
+      if currencies.any?
+        currencies_str = join_by_commas(currencies)
+        params = {:currencies => currencies_str}
+        get_and_parse("live", params)
+      else
+        get_and_parse("live")
       end
-      JSON.parse(resp.body)
     end
 
-    def self.historical(date, *currencies)
-      resp = connection.get do |req|
-        req.url 'api/historical' 
-        req.params['date'] = date
-        req.params['currencies'] = currencies.map(&:strip).join(",") if currencies.any?
-      end
-      JSON.parse(resp.body)
+    def self.historical(date, *currencies)      
+      params = {:date => date}
+      params.merge!(:currencies => join_by_commas(currencies)) if currencies.any?
+      get_and_parse("historical", params)
     end
 
+=begin
     def self.convert(from, to, amount, date=nil)
-      resp = connection.get do |req|
-        req.url 'api/convert' # static
-        req.params['from'] = from
-        req.params['to'] = to
-        req.params['amount'] = amount
-        req.params['date'] = date if date
-      end
-      JSON.parse(resp.body)
+      params = {:from => from, :to => to, :amount => amount}
+      params.merge!(:date => date) if date
+      get_and_parse("convert", params)
     end
+=end
+    def self.join_by_commas(currencies)
+      currencies.map(&:strip).join(",")
+    end
+
   end
 end

data/lib/apilayer/error.rb

@@ -0,0 +1,10 @@
+module Apilayer
+  class Error < StandardError
+    attr_reader :code
+
+    def initialize(message, code=nil)
+      super(message)
+      @code = code
+    end
+  end
+end

data/lib/apilayer/vat.rb

@@ -1,51 +1,41 @@
 module Apilayer
-
   module Vat
+    extend ConnectionHelper
+
+    COUNTRY_CRITERIA_MISSING_MSG = "You must provide either :country_code or :ip_address"
+    VATLAYER_KEY_MISSING_MSG = "Please configure access_key for vat_layer first!"
+
     def self.connection
-      if Apilayer.configs[:vat_key].nil?
-        raise Apilayer::Error.new "Please configure access_key for vat_layer first!"
-      else
-        @connection ||= ::Faraday.new(:url => 'http://apilayer.net',
-                                      :params => {"access_key" => Apilayer.configs[:vat_key]})
+      @connection ||= ::Faraday.new(:url => 'http://apilayer.net',
+                                    :params => {"access_key" => Apilayer.configs[:vat_key]})
+    end
+
+    def self.validate_country_criteria(criteria)
+      unless [:country_code, :ip_address].include? criteria
+        raise Apilayer::Error.new COUNTRY_CRITERIA_MISSING_MSG
       end
     end
 
     def self.validate(vat_number)
-      resp = connection.get do |req|
-        req.url 'api/validate'
-        req.params['vat_number'] = vat_number
-      end
-      JSON.parse(resp.body)
+      params = {:vat_number => vat_number}
+      get_and_parse("validate", params)
     end
 
     def self.rate(criteria, value)
-      unless [:country_code, :ip_address].include? criteria
-        raise Apilayer::Error.new("You must provide either :country_code or :ip_address")
-      end      
-      resp = connection.get do |req|
-        req.url 'api/rate'
-        req.params[criteria.to_s] = value
-      end
-      JSON.parse(resp.body)
+      validate_country_criteria(criteria)
+      params = {criteria.to_sym => value}
+      get_and_parse("rate", params)
     end
 
     def self.rate_list
-      resp = connection.get do |req|
-        req.url 'api/rate_list'
-      end
-      JSON.parse(resp.body)
+      get_and_parse("rate_list")
     end
 
     def self.price(price, criteria, value)
-      unless [:country_code, :ip_address].include? criteria
-        raise Apilayer::Error.new("You must provide either :country_code or :ip_address")
-      end
-      resp = connection.get do |req|
-        req.url 'api/price'
-        req.params['amount'] = price
-        req.params[criteria.to_s] = value
-      end
-      JSON.parse(resp.body)
+      validate_country_criteria(criteria)
+      params = {:amount => price, criteria.to_sym => value}
+      get_and_parse("price", params)
     end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apilayer
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Alex Fong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2016-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -158,8 +158,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- LICENSE
+- README.rdoc
+- 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: