currencyconversion 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 742fb1242ed3b5d18241f1b5252e3ab9128fbae2
-  data.tar.gz: e697972261c45e4d07ff35f272d507664eb24966
+  metadata.gz: f4d6706dc2b6be7510db89b46a566b1ad90ea384
+  data.tar.gz: 51abba7ca76ff4c5b98ba5482b38ff019acca66f
 SHA512:
-  metadata.gz: 0a9c708b8a4eeff4027a238dc2c071ae87ba9a58bcdee9b46e598a189561487a17da1851e03368467055ce701730656af30dbd0f773971b2c42fb5f18ca1fdf8
-  data.tar.gz: 72fe80764a6e5a8437e56e68f747991c07565e0a9c856bba2d4afcbdbf41941b8ea3f8d7844cf9078c8c4ccc19729f6f2a1df4ba53a9d3670c9703ebe27d6c3b
+  metadata.gz: 65e046b53545d6e75ad441f1670d4a6021689e7bf07be8d4ec005ce057bc0fe9ee4015ef365dcfa43c5f2a9ccbb0cc8a72a4f134b6b0b3b3887dd94cab4c5940
+  data.tar.gz: 9f556b29ae6e4745ecbca16a46589524f89c3a4e4ccbd40de2bb0bbb90bd9d2a78a34fbffcb2b04cb03727a197980cdeb978e120300bad098f8f4d8c95d67ec6

data/example/example_change.rb

@@ -0,0 +1,32 @@
+require 'dotenv'
+require 'currency_conversion'
+require 'currency_conversion/timeframe/timeframe_options'
+
+# Load Environment Variables
+Dotenv.load
+
+begin
+
+  # Declare the Client instance passing in the authentication parameters
+  @client = CurrencyLayer::Client.new(ENV['ACCESS_KEY'])
+
+  # Set the arguments
+  start_date = '2010-03-01'
+  end_date = '2010-04-01'
+  currencies = 'USD,GBP,EUR'
+
+  # We declare the options
+  options = CurrencyLayer::TimeframeOptions.new()
+
+  # We make the call to fetch the live currencies
+  response = @client.timeframe(start_date, end_date, currencies, options)
+
+  # If its a success, we print a message to the user
+  if !response.nil?
+    puts 'SUCCESS : Timeframe Fetched...' << response.to_s
+  end
+
+rescue => e
+  puts e.inspect
+
+end

data/example/example_timeframe.rb

@@ -0,0 +1,32 @@
+require 'dotenv'
+require 'currency_conversion'
+require 'currency_conversion/timeframe/timeframe_options'
+
+# Load Environment Variables
+Dotenv.load
+
+begin
+
+  # Declare the Client instance passing in the authentication parameters
+  @client = CurrencyLayer::Client.new(ENV['ACCESS_KEY'])
+
+  # Set the arguments
+  start_date = '2010-03-01'
+  end_date = '2010-04-01'
+  currencies = 'USD,GBP,EUR'
+
+  # We declare the options
+  options = CurrencyLayer::TimeframeOptions.new()
+
+  # We make the call to fetch the live currencies
+  response = @client.timeframe(start_date, end_date, currencies, options)
+
+  # If its a success, we print a message to the user
+  if !response.nil?
+    puts 'SUCCESS : Timeframe Fetched...' << response.to_s
+  end
+
+rescue => e
+  puts e.inspect
+
+end

data/lib/currency_conversion.rb

@@ -3,8 +3,22 @@ require "hashable"
 require "currency_conversion/version"
 require "currency_conversion/live/live_request"
 require "currency_conversion/live/live_response"
+require "currency_conversion/live/live_exception"
 require "currency_conversion/list/list_request"
 require "currency_conversion/list/list_response"
+require "currency_conversion/list/list_exception"
+require "currency_conversion/historical/historical_request"
+require "currency_conversion/historical/historical_response"
+require "currency_conversion/historical/historical_exception"
+require "currency_conversion/convert/convert_request"
+require "currency_conversion/convert/convert_response"
+require "currency_conversion/convert/convert_exception"
+require "currency_conversion/timeframe/timeframe_request"
+require "currency_conversion/timeframe/timeframe_response"
+require "currency_conversion/timeframe/timeframe_exception"
+require "currency_conversion/change/change_request"
+require "currency_conversion/change/change_response"
+require "currency_conversion/change/change_exception"
 
 module CurrencyLayer
 
@@ -102,5 +116,209 @@ module CurrencyLayer
       end
     end
 
+    def historical(date, options = {})
+
+      if date.nil?
+        raise CurrencyLayer::MissingArgumentException.new 'date'
+        return
+      end
+
+      # Create a shallow copy so we don't manipulate the original reference
+      q = options.dup
+
+      # Populate the Query
+      q.access_key = @access_key
+      q.date = date
+
+      # We then create the Request
+      req = CurrencyLayer::HistoricalRequest.new(q)
+
+      #  We create a Hash of the request so we can send it via HTTP
+      req_dto = req.to_dh
+
+      begin
+
+        # We make the actual request
+        res = self.class.get('/historical', req_dto)
+
+        # We ensure that we tap the response so we can use the results
+        res.inspect
+
+        if (res[CurrencyLayer::HistoricalResponse::ERROR_EXPR])
+          raise CurrencyLayer::HistoricalException.new res[CurrencyLayer::HistoricalResponse::ERROR_EXPR]
+        end
+
+        # We just return the parsed binary response
+        return res.parsed_response
+
+      rescue => e
+        puts e.inspect
+        return e
+
+      end
+    end
+
+    def convert(from, to, amount, options = {})
+
+      if from.nil?
+        raise CurrencyLayer::MissingArgumentException.new 'from'
+        return
+      end
+
+      if to.nil?
+        raise CurrencyLayer::MissingArgumentException.new 'to'
+        return
+      end
+
+      if amount.nil?
+        raise CurrencyLayer::MissingArgumentException.new 'amount'
+        return
+      end
+
+      # Create a shallow copy so we don't manipulate the original reference
+      q = options.dup
+
+      # Populate the Query
+      q.access_key = @access_key
+      q.from = from
+      q.to = to
+      q.amount = amount
+
+      # We then create the Request
+      req = CurrencyLayer::ConvertRequest.new(q)
+
+      #  We create a Hash of the request so we can send it via HTTP
+      req_dto = req.to_dh
+
+      begin
+
+        # We make the actual request
+        res = self.class.get('/convert', req_dto)
+
+        # We ensure that we tap the response so we can use the results
+        res.inspect
+
+        if (res[CurrencyLayer::ConvertResponse::ERROR_EXPR])
+          raise CurrencyLayer::ConvertException.new res[CurrencyLayer::ConvertResponse::ERROR_EXPR]
+        end
+
+        # We just return the parsed binary response
+        return res.parsed_response
+
+      rescue => e
+        puts e.inspect
+        return e
+
+      end
+    end
+
+    def timeframe(start_date, end_date, currencies, options = {})
+
+      if start_date.nil?
+        raise CurrencyLayer::MissingArgumentException.new 'start_date'
+        return
+      end
+
+      if end_date.nil?
+        raise CurrencyLayer::MissingArgumentException.new 'end_date'
+        return
+      end
+
+      if currencies.nil?
+        raise CurrencyLayer::MissingArgumentException.new 'currencies'
+        return
+      end
+
+      # Create a shallow copy so we don't manipulate the original reference
+      q = options.dup
+
+      # Populate the Query
+      q.access_key = @access_key
+      q.start_date = start_date
+      q.end_date = end_date
+      q.currencies = currencies
+
+      # We then create the Request
+      req = CurrencyLayer::TimeframeRequest.new(q)
+
+      #  We create a Hash of the request so we can send it via HTTP
+      req_dto = req.to_dh
+
+      begin
+
+        # We make the actual request
+        res = self.class.get('/timeframe', req_dto)
+
+        # We ensure that we tap the response so we can use the results
+        res.inspect
+
+        if (res[CurrencyLayer::TimeframeResponse::ERROR_EXPR])
+          raise CurrencyLayer::TimeframeException.new res[CurrencyLayer::TimeframeResponse::ERROR_EXPR]
+        end
+
+        # We just return the parsed binary response
+        return res.parsed_response
+
+      rescue => e
+        puts e.inspect
+        return e
+
+      end
+    end
+
+    def change(start_date, end_date, currencies, options = {})
+
+      if start_date.nil?
+        raise CurrencyLayer::MissingArgumentException.new 'start_date'
+        return
+      end
+
+      if end_date.nil?
+        raise CurrencyLayer::MissingArgumentException.new 'end_date'
+        return
+      end
+
+      if currencies.nil?
+        raise CurrencyLayer::MissingArgumentException.new 'currencies'
+        return
+      end
+
+      # Create a shallow copy so we don't manipulate the original reference
+      q = options.dup
+
+      # Populate the Query
+      q.access_key = @access_key
+      q.start_date = start_date
+      q.end_date = end_date
+      q.currencies = currencies
+
+      # We then create the Request
+      req = CurrencyLayer::ChangeRequest.new(q)
+
+      #  We create a Hash of the request so we can send it via HTTP
+      req_dto = req.to_dh
+
+      begin
+
+        # We make the actual request
+        res = self.class.get('/change', req_dto)
+
+        # We ensure that we tap the response so we can use the results
+        res.inspect
+
+        if (res[CurrencyLayer::ChangeResponse::ERROR_EXPR])
+          raise CurrencyLayer::ChangeException.new res[CurrencyLayer::ChangeResponse::ERROR_EXPR]
+        end
+
+        # We just return the parsed binary response
+        return res.parsed_response
+
+      rescue => e
+        puts e.inspect
+        return e
+
+      end
+    end
+
   end
 end

data/lib/currency_conversion/change/change_exception.rb

@@ -0,0 +1,13 @@
+module CurrencyLayer
+
+  class ChangeException < Exception
+
+    attr_accessor :error
+
+    def initialize(error)
+      self.error = error
+    end
+
+  end
+
+end

data/lib/currency_conversion/change/change_options.rb

@@ -0,0 +1,19 @@
+module CurrencyLayer
+
+  class ChangeOptions
+
+    include Hashable
+
+    attr_accessor :access_key
+
+    attr_accessor :start_date
+    attr_accessor :end_date
+    attr_accessor :currencies
+
+    def initialize()
+      @query = nil
+    end
+
+  end
+
+end

data/lib/currency_conversion/change/change_request.rb

@@ -0,0 +1,18 @@
+require "hashable"
+
+module CurrencyLayer
+
+  class ChangeRequest
+
+    include Hashable
+
+    attr_accessor :query
+
+    def initialize(query = {})
+
+      self.query = query
+
+    end
+
+  end
+end

data/lib/currency_conversion/change/change_response.rb

@@ -0,0 +1,15 @@
+module CurrencyLayer
+
+  class ChangeResponse
+
+    SUCCESS_EXPR = 'success'
+    ERROR_EXPR = 'error'
+
+    def bar
+      SUCCESS_EXPR
+      ERROR_EXPR
+    end
+
+  end
+
+end

data/lib/currency_conversion/convert/convert_exception.rb

@@ -0,0 +1,13 @@
+module CurrencyLayer
+
+  class ConvertException < Exception
+
+    attr_accessor :error
+
+    def initialize(error)
+      self.error = error
+    end
+
+  end
+
+end

data/lib/currency_conversion/convert/convert_options.rb

@@ -0,0 +1,19 @@
+module CurrencyLayer
+
+  class ConvertOptions
+
+    include Hashable
+
+    attr_accessor :access_key
+
+    attr_accessor :from
+    attr_accessor :to
+    attr_accessor :amount
+
+    def initialize()
+      @query = nil
+    end
+
+  end
+
+end

data/lib/currency_conversion/convert/convert_request.rb

@@ -0,0 +1,18 @@
+require "hashable"
+
+module CurrencyLayer
+
+  class ConvertRequest
+
+    include Hashable
+
+    attr_accessor :query
+
+    def initialize(query = {})
+
+      self.query = query
+
+    end
+
+  end
+end

data/lib/currency_conversion/convert/convert_response.rb

@@ -0,0 +1,15 @@
+module CurrencyLayer
+
+  class ConvertResponse
+
+    SUCCESS_EXPR = 'success'
+    ERROR_EXPR = 'error'
+
+    def bar
+      SUCCESS_EXPR
+      ERROR_EXPR
+    end
+
+  end
+
+end

data/lib/currency_conversion/historical/historical_exception.rb

@@ -0,0 +1,13 @@
+module CurrencyLayer
+
+  class HistoricalException < Exception
+
+    attr_accessor :error
+
+    def initialize(error)
+      self.error = error
+    end
+
+  end
+
+end

data/lib/currency_conversion/historical/historical_options.rb

@@ -0,0 +1,17 @@
+module CurrencyLayer
+
+  class HistoricalOptions
+
+    include Hashable
+
+    attr_accessor :access_key
+
+    attr_accessor :date
+
+    def initialize()
+      @query = nil
+    end
+
+  end
+
+end

data/lib/currency_conversion/historical/historical_request.rb

@@ -0,0 +1,18 @@
+require "hashable"
+
+module CurrencyLayer
+
+  class HistoricalRequest
+
+    include Hashable
+
+    attr_accessor :query
+
+    def initialize(query = {})
+
+      self.query = query
+
+    end
+
+  end
+end

data/lib/currency_conversion/historical/historical_response.rb

@@ -0,0 +1,15 @@
+module CurrencyLayer
+
+  class HistoricalResponse
+
+    SUCCESS_EXPR = 'success'
+    ERROR_EXPR = 'error'
+
+    def bar
+      SUCCESS_EXPR
+      ERROR_EXPR
+    end
+
+  end
+
+end

data/lib/currency_conversion/timeframe/timeframe_exception.rb

@@ -0,0 +1,13 @@
+module CurrencyLayer
+
+  class TimeframeException < Exception
+
+    attr_accessor :error
+
+    def initialize(error)
+      self.error = error
+    end
+
+  end
+
+end

data/lib/currency_conversion/timeframe/timeframe_options.rb

@@ -0,0 +1,19 @@
+module CurrencyLayer
+
+  class TimeframeOptions
+
+    include Hashable
+
+    attr_accessor :access_key
+
+    attr_accessor :start_date
+    attr_accessor :end_date
+    attr_accessor :currencies
+
+    def initialize()
+      @query = nil
+    end
+
+  end
+
+end

data/lib/currency_conversion/timeframe/timeframe_request.rb

@@ -0,0 +1,18 @@
+require "hashable"
+
+module CurrencyLayer
+
+  class TimeframeRequest
+
+    include Hashable
+
+    attr_accessor :query
+
+    def initialize(query = {})
+
+      self.query = query
+
+    end
+
+  end
+end

data/lib/currency_conversion/timeframe/timeframe_response.rb

@@ -0,0 +1,15 @@
+module CurrencyLayer
+
+  class TimeframeResponse
+
+    SUCCESS_EXPR = 'success'
+    ERROR_EXPR = 'error'
+
+    def bar
+      SUCCESS_EXPR
+      ERROR_EXPR
+    end
+
+  end
+
+end

data/lib/currency_conversion/version.rb

@@ -1,3 +1,3 @@
 module CurrencyLayer
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: currencyconversion
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Peter Andreas Moelgaard
@@ -126,11 +126,25 @@ files:
 - bin/console
 - bin/setup
 - currency_conversion.gemspec
+- example/example_change.rb
 - example/example_list.rb
 - example/example_live.rb
 - example/example_live_w_currencies_as_array.rb
 - example/example_live_w_source.rb
+- example/example_timeframe.rb
 - lib/currency_conversion.rb
+- lib/currency_conversion/change/change_exception.rb
+- lib/currency_conversion/change/change_options.rb
+- lib/currency_conversion/change/change_request.rb
+- lib/currency_conversion/change/change_response.rb
+- lib/currency_conversion/convert/convert_exception.rb
+- lib/currency_conversion/convert/convert_options.rb
+- lib/currency_conversion/convert/convert_request.rb
+- lib/currency_conversion/convert/convert_response.rb
+- lib/currency_conversion/historical/historical_exception.rb
+- lib/currency_conversion/historical/historical_options.rb
+- lib/currency_conversion/historical/historical_request.rb
+- lib/currency_conversion/historical/historical_response.rb
 - lib/currency_conversion/list/list_exception.rb
 - lib/currency_conversion/list/list_options.rb
 - lib/currency_conversion/list/list_request.rb
@@ -140,6 +154,10 @@ files:
 - lib/currency_conversion/live/live_request.rb
 - lib/currency_conversion/live/live_response.rb
 - lib/currency_conversion/missing_argument_exception.rb
+- lib/currency_conversion/timeframe/timeframe_exception.rb
+- lib/currency_conversion/timeframe/timeframe_options.rb
+- lib/currency_conversion/timeframe/timeframe_request.rb
+- lib/currency_conversion/timeframe/timeframe_response.rb
 - lib/currency_conversion/version.rb
 homepage: https://github.com/pmoelgaard/currency_conversion
 licenses: