ccy_convertor 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZTYwZTU1NWIzNTZkOTE3N2EwMjdiYjllOTQ3ZjQzM2IzZWE1NmQxZA==
-  data.tar.gz: !binary |-
-    ZWYyN2JmMjU3M2QxMTM4ZTRmZWU3OTNkMDBlNDg0OTkxMTM0MTVhMw==
+SHA1:
+  metadata.gz: 6cd5bc29c2df00a8629ba57024c388232494f90c
+  data.tar.gz: a4ef3c9b93ae1f0ce86987f110f964f81a610dbd
 SHA512:
-  metadata.gz: !binary |-
-    NGJhMjAzYWJiMWQzYTcxM2ZlZDA4NDI0MjZkZDVmOTRmNzYxN2U3N2EzMTM4
-    ODdiOTEzMTUzZTdiYjk1NWZhNTRhNTEyYTk0ZjI5ZTg3OWQ4ZmM0MmYyNDc0
-    NDY0YTBkYjBjZmE1ZTkzOTBhMjEwODM1Y2FkOTU4NGE4Y2M0MmI=
-  data.tar.gz: !binary |-
-    MjRkODRkN2Q0NjFiMDYxNDRmMDE3MDZiNzg0ZTQwZmQ4MDY4ZTA3ZDY5NGEx
-    OWYyYWIxN2JkYWFiNzNjNThkZTVmNTk0OGQ2OGEzZWNjOGM3MGYwYWJmNjMz
-    NTgzMmFmMDNmNzk4NGI5ODEzYjljODczZjBmMzY4M2I2ZWI4Mzc=
+  metadata.gz: 96976f7e8d1aa9f0e9acbe5251a631a43197d11ea058d660ec252f2298767b4a1a7ce063bc6d569fbd4692e0a8677f329d36d0cbc00a87695757aa0c852ce322
+  data.tar.gz: bea4e021e2bacef892d284c63321ab6d75fdec76913bba22695e155f14e3ffbd7343069d8aa9646d7118a54d42fd7cb9bad268e4d2cb488f14f34fb363a66ad4

data/README.md

@@ -29,20 +29,20 @@ Note:  Default rate provider is CcyConvertor::YahooFinance. You can change defau
 Rate provider can also be provided as a parameter. Rate provider is a class which provides rate by using rest_api
 ```ruby
 CcyConvertor.rate(from_ccy: 'USD', to_ccy: 'NZD', rate_provider: CcyConvertor::OpenExchangeRate)
-CcyConvertor.rate(from_ccy: 'USD', to_ccy: 'NZD', rate_provider: CcyConvertor::JSONRates)
+CcyConvertor.rate(from_ccy: 'USD', to_ccy: 'NZD', rate_provider: CcyConvertor::CurrencyLayer)
 ```
 You can also directly use rate provider class as follows.
 ```ruby
 CcyConvertor::OpenExchangeRate.rate('USD', 'INR') # will return USD/INR rate
 ```
-Note: CcyConvertor::OpenExchangeRate and CcyConvertor::JSONRate requires api_key. You can register at respective websites to get a api key
+Note: CcyConvertor::OpenExchangeRate and CcyConvertor::CurrencyLayer requires api_key. You can register at respective websites to get a api key
 
 #### Rate Providers
 | Rate provider class name  | rest api source  | Api key required   |
 |---|---|---|
 |  CcyConvertor::YahooFinance | 'yahoo.finance.xchange' table yql  | no  |
 | CcyConvertor::OpenExchangeRate  | www.openexchangerates.org  | yes  |
-| CcyConvertor::JSONRate  | www.jsonrates.com  | yes  |
+| CcyConvertor::CurrencyLayer  | www.currencylayer.com  | yes  |
 
 Api key can be provided individually to this classes as
 
@@ -65,18 +65,21 @@ Below code will use default rate provider. Default rate provider is configurable
 CcyConvertor.convert(from_ccy: 'USD', to_ccy: 'NZD', amount: 10)
 10.usd.to_nzd
 ```
-You can also get all the rates of currency with respect to particular base currency
+You can also get all currency rate  (rate matrix) with respect to USD in single request for OpenExchangeRate and CurrencyLayer rate provider
 ```ruby
 Ccyconvertor::OpenExchangeRate.rate_matrix
+Ccyconvertor::CurrencyLayer.rate_matrix
 ```
 Above method will return hash with currency code as key and rate as value. All rates would be with respect to USD. OpenExchangeRate do not allow us to specify other base currency and USD is always the base currency.
 
-For Ccyconvertor::JSONRate we can specify the base currency
+While For Ccyconvertor::CurrencyLayer we can specify the base currency
 ```ruby
-Ccyconvertor::OpenExchangeRate.rate_matrix('NZD')
+Ccyconvertor::CurrencyLayer.rate_matrix('NZD')
 ```
  All rates returned would be with respect to NZD. If no parameter is given then base currency is USD by default
- Note: Ccyconvertor::YahooFinance do not support rate_matrix method
+ 
+ Note:
+ You cannot provide base currency for free account at currencylayer.com. By defualt base currency will be USD. You need a paid account at currencylayer.com to supply base currency. And Ccyconvertor::YahooFinance do not support rate_matrix method
 
 ## Configuration
 
@@ -84,7 +87,7 @@ You can configure following parameters
 
 1. default_rate-provider: Default rate provider is the rate provider which is used when no rate provider is species. Rate provider is a api service that this gem uses to provide rate. By default default rate provider is CcyConvertor::YahooFinance. Check rate providers details [here](#rate-providers)
 
-2. api_keys: CcyConvertor::OpenExchangeRate and CcyConvertor::JSONRate provider requires api_key. You can register at there respective sites to get the api_key
+2. api_keys: CcyConvertor::OpenExchangeRate and CcyConvertor::CurrencyLayer provider requires api_key. You can register at there respective sites to get the api_key
 
 3. cache_duration: specifies the time for which the response would be cached. By default this time is zero seconds i.e no caching is done by default. If cache_duration is 60 seconds and if you want a exchange rate of USD/INR multiple times in your application, request to rate provider would be made only once in 60 seconds and after 60 seconds next request would be made.
 ActiveSupport::Cache is used for caching
@@ -98,15 +101,15 @@ Sample configuration:
 CcyConvertor.configure do |config|
   config.round_up_rate = 4
   config.round_up_amount = 4
-  config.default_rate_provider = CcyConvertor::JSONRate
+  config.default_rate_provider = CcyConvertor::CurrencyLayer
   config.api_keys = {
     open_exchange_rate: 'XXXXXXXXX',
-    json_rate: 'XXXXXX'
+    currency_layer: 'XXXXXX'
   }
   config.cache_duration = {
     open_exchange_rate: 20,
     yahoo_finance: 30,
-    json_rate: 20
+    currency_layer: 20
   }
 end
 ```
@@ -151,7 +154,7 @@ Above method should return url for geting exchange rate between from_ccy and to_
 ```ruby
 rate(from_ccy, to_ccy)
 ```
-Above method should return exchange rate(Numeric type) between from_ccy and to_ccy. You can call ```rate_response(from_ccy, to_ccy)``` inside ```rate(from_ccy, to_ccy)``` to get response from url returned by ```rest_url_for_rate(from_ccy, to_ccy)``` 
+Above method should return exchange rate(Numeric type) between from_ccy and to_ccy. You can call ```rate_response(from_ccy, to_ccy)``` inside ```rate(from_ccy, to_ccy)``` to get response from url returned by ```rest_url_for_rate(from_ccy, to_ccy)```
 
 Now you can directly use new rate provider added by you as an existing rate provider present in the gem. You can also use all the cofiguration present for th rate provider. If rate provider added by you require api_key, you can provide it as metioned in configurtion section.
 If you want to use api_key inside you rate provider class, you can use class method api_key to access it.

data/lib/ccy_convertor/rate_providers/currency_layer.rb

@@ -0,0 +1,14 @@
+module CcyConvertor
+  class CurrencyLayer < CcyConvertor::RateProvider
+    class << self
+      def rest_url_for_rate_matrix(base_ccy)
+        "http://apilayer.net/api/live?access_key=#{api_key}&source=#{base_ccy || 'USD'}&format=1"
+      end
+
+      def rate_matrix(base_ccy = nil)
+        rates = rate_matrix_response(base_ccy)['quotes']
+        rates.inject({}) { |acc, (k, v)| acc[k[3, 3]] = v; acc }
+      end
+    end
+  end
+end

data/lib/ccy_convertor/rate_providers/rate_provider.rb

@@ -27,11 +27,11 @@ module CcyConvertor
         cache_key = cache_key(request_url)
         return cache.read(cache_key) if cache.exist?(cache_key)
         response = HTTParty.get(request_url).parsed_response
-        puts cache.write(cache_key, response, expires_in: cache_duration)
+        cache.write(cache_key, response, expires_in: cache_duration)
         response
       end
 
-      def rate_matrix_response(base_ccy = nil)
+      def rate_matrix_response(base_ccy=nil)
         response_hash(rest_url_for_rate_matrix(base_ccy))
       end
 

data/lib/ccy_convertor/version.rb

@@ -1,3 +1,3 @@
 module CcyConvertor
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/ccy_convertor.rb

@@ -14,7 +14,7 @@ require 'ccy_convertor/process_and_validate_option'
 require 'ccy_convertor/rate_providers/rate_provider'
 require 'ccy_convertor/rate_providers/yahoo_finance'
 require 'ccy_convertor/rate_providers/open_exchange_rate'
-require 'ccy_convertor/rate_providers/json_rate'
+require 'ccy_convertor/rate_providers/currency_layer'
 
 module CcyConvertor
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ccy_convertor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Rohan Pujari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2015-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,28 +42,28 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: CcyConvertor provides live currency rate for various currencies and allows
@@ -89,7 +89,7 @@ files:
 - lib/ccy_convertor/money.rb
 - lib/ccy_convertor/process_and_validate_option.rb
 - lib/ccy_convertor/rate_cache.rb
-- lib/ccy_convertor/rate_providers/json_rate.rb
+- lib/ccy_convertor/rate_providers/currency_layer.rb
 - lib/ccy_convertor/rate_providers/open_exchange_rate.rb
 - lib/ccy_convertor/rate_providers/rate_provider.rb
 - lib/ccy_convertor/rate_providers/yahoo_finance.rb
@@ -104,19 +104,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: CcyConvertor provides live currency rate for various currencies and allows
   to convert money from one currency to other
 test_files: []
+has_rdoc: 

data/lib/ccy_convertor/rate_providers/json_rate.rb

@@ -1,13 +0,0 @@
-module CcyConvertor
-  class JSONRate < CcyConvertor::RateProvider
-    class << self
-      def rest_url_for_rate_matrix(base_ccy)
-        "http://jsonrates.com/get/?apiKey=#{api_key}&base=#{base_ccy || 'USD'}"
-      end
-
-      def rate_matrix(base_ccy = nil)
-        JSON.parse(rate_matrix_response(base_ccy))['rates']
-      end
-    end
-  end
-end