currency_layer 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e86057cf2480a4d84c5ce402739a83faa1610c97
+  data.tar.gz: 37ce1a95d27e9983fd8959168ac453ab5f354c73
+SHA512:
+  metadata.gz: dfb4d2b61462cb5364197de0a965dbf3a6eedfa127dfc1d858ffb6a457ed1ad8fd5cb4d37778ae2fef5b7128df8aec4513a283df5b3896698e5e2fe0397da9d2
+  data.tar.gz: 9c968459751b9021d406e395aabed0728377b928efcb8aa9bca5c4dd5baf0e917e556929c8350344f69cb942e3bf7ca5f4572345b94ad6b115d67fb98e2da27d

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+gem "apilayer", :git => 'https://github.com/actfong/apilayer.git', :branch => 'refactor/separate_gems'

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/README.rdoc

@@ -0,0 +1,78 @@
+== currency_layer {<img src="https://secure.travis-ci.org/actfong/currency_layer.png"/>}[http://travis-ci.org/actfong/currency_layer] {<img src="https://codeclimate.com/github/actfong/currency_layer.png"/>}[https://codeclimate.com/github/actfong/currency_layer] {<img src="https://badge.fury.io/rb/currency_layer.svg" alt="Gem Version" />}[https://badge.fury.io/rb/currency_layer] 
+
+Ruby wrapper for currencylayer of apilayer.
+See https://currencylayer.com/ and http://apilayer.com for more details.
+
+=== Introduction
+This gem is extracted from the previous version of apilayer gem. The currency_layer gem depends on the apilayer gem to configure and create connections to apilayer.net
+
+=== Installation
+
+==== Using Bundler
+
+Add apilayer in your <tt>Gemfile</tt>:
+
+  gem "currency_layer"
+
+Run the following in your console:
+
+  $ bundle install
+  
+=== Usage
+
+==== Set up currency_layer
+Once you have signed up for *currencylayer.com*, you will receive an access_key. 
+Then configure your Apilayer::Currency module like this:
+
+  Apilayer::Currency.configure do |configs|
+    configs.access_key = "my_access_key_123"
+    configs.https = true
+  end
+
+Please note that the https configuration is optional and only available to paid-accounts.
+If unset, these configuration-values are just nil.
+
+You can always review you configurations with:
+
+  Apilayer::Currency.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]})
+  
+==== Re-Configure access_key and https
+If you happened to have forgotten to set or entered an incorrect value, you can re-configure your Apilayer module by:
+
+  # Example: reconfigure https
+  Apilayer::Currency.configure do |configs|
+    configs.https = true
+  end

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/currency.rb

@@ -0,0 +1,152 @@
+##
+# Ruby wrapper for currencylayer. See https://currencylayer.com/documentation for more info
+module Apilayer
+  module Currency
+    extend Apilayer::ConnectionHelper
+
+    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/currencylayer.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'apilayer'
+
+require "apilayer/currency"

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: currency_layer
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alex Fong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.9
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: Ruby wrapper for currencylayer by apilayer. This gem depends on the apilayer
+  gem, which provides a common connection-interface to various services of apilayer.net
+  (such as currencylayer and vatlayer). See https://currencylayer.com/ and https://apilayer.com/
+  for more details.
+email:
+- actfong@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/apilayer/currency.rb
+- lib/currencylayer.rb
+homepage: https://github.com/actfong/currency_layer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for currencylayer by apilayer. See https://currencylayer.com/
+  for more details.
+test_files: []