currencyconversion 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4d6706dc2b6be7510db89b46a566b1ad90ea384
-  data.tar.gz: 51abba7ca76ff4c5b98ba5482b38ff019acca66f
+  metadata.gz: 23f88ea545e7e270059fc20236b07b749f9d9a1c
+  data.tar.gz: 1b764bda6dcbbf85bc673536dac419df2145eecf
 SHA512:
-  metadata.gz: 65e046b53545d6e75ad441f1670d4a6021689e7bf07be8d4ec005ce057bc0fe9ee4015ef365dcfa43c5f2a9ccbb0cc8a72a4f134b6b0b3b3887dd94cab4c5940
-  data.tar.gz: 9f556b29ae6e4745ecbca16a46589524f89c3a4e4ccbd40de2bb0bbb90bd9d2a78a34fbffcb2b04cb03727a197980cdeb978e120300bad098f8f4d8c95d67ec6
+  metadata.gz: 13bed63f674dde2fbd4a1c55f2dd096dc03f88d31768be7e6f65a1ecf11f5dcf27010538dba3087d9d0201f7a2c93023d4de225fbc292deeffc3765680c71e1f
+  data.tar.gz: 591cebb8a6bc80647c35d847726b110f23baa8d4d04db99a0686a552e14ec185c4d32f469ebcd10fe9c92383832a1e1feac1c83093f4af5df397074b374c5c9e

data/README.md

@@ -95,6 +95,10 @@ options = CurrencyLayer::LiveOptions.new()
 response = @client.live(currencies, options)
   
 ```
+### Etag & Date (If-None-Match, If-Modified-Since)
+The ```live``` endpoint supports these headers to minimise unnecessary traffic and load on systems.
+This library internally sets these headers and manages a local cache, so whenever the library receives a 304 (no changes) response from the server, it will return the last response it received. This way this library will always return a response.
+
 
 ## List
 Fetches the list of currencies.

data/example/example_live_w_interval.rb

@@ -0,0 +1,36 @@
+require 'dotenv'
+require 'currency_conversion'
+require 'currency_conversion/live/live_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 currencies to fetch
+  currencies = 'AUD,EUR,GBP,PLN'
+
+  # We declare the options
+  options = CurrencyLayer::LiveOptions.new()
+
+  while true
+
+    # We make the call to fetch the live currencies
+    response = @client.live(currencies, options)
+
+    # If its a success, we print a message to the user
+    if !response.nil?
+      puts 'SUCCESS : Live Currencies Fetched...' << response.to_s
+    end
+
+    sleep 5
+
+  end
+
+rescue => e
+  puts e.inspect
+
+end

data/lib/currency_conversion/live/live_request.rb

@@ -6,9 +6,12 @@ module CurrencyLayer
 
     include Hashable
 
+    attr_accessor :headers
     attr_accessor :query
 
-    def initialize(query = {})
+    def initialize(query = {}, headers = {})
+
+      self.headers = headers
 
       # Ruby passes by reference, so we can manipulate the object, and we check if the currencies is an array, and if so, we convert to string according to API
       query.currencies = query.currencies.kind_of?(String) ? query.currencies : query.currencies.join(',')

data/lib/currency_conversion/version.rb

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

data/lib/currency_conversion.rb

@@ -38,7 +38,11 @@ module CurrencyLayer
 
     end
 
-    def live(currencies, options = {})
+
+    attr_accessor :live_last_response
+    attr_accessor :live_last_response_headers
+
+    def live(currencies, options = {}, headers = {})
 
       if currencies.nil?
         raise CurrencyLayer::MissingArgumentException.new 'currencies'
@@ -52,8 +56,14 @@ module CurrencyLayer
       q.access_key = @access_key
       q.currencies = currencies
 
+      # Set the cache options
+      if (self.live_last_response_headers)
+        headers['If-None-Match'] = self.live_last_response_headers['etag']
+        headers['If-Modified-Since'] = self.live_last_response_headers['date']
+      end
+
       # We then create the Request
-      req = CurrencyLayer::LiveRequest.new(q)
+      req = CurrencyLayer::LiveRequest.new(q, headers)
 
       #  We create a Hash of the request so we can send it via HTTP
       req_dto = req.to_dh
@@ -66,10 +76,19 @@ module CurrencyLayer
         # We ensure that we tap the response so we can use the results
         res.inspect
 
+        # We have struck a 304, and we just return the last_response
+        if(res.nil? && ! self.live_last_response.nil?)
+          return self.live_last_response
+        end
+
         if (res[CurrencyLayer::LiveResponse::ERROR_EXPR])
           raise CurrencyLayer::LiveException.new res[CurrencyLayer::LiveResponse::ERROR_EXPR]
         end
 
+        # To facilitate we set the cache arguments
+        self.live_last_response = res.parsed_response
+        self.live_last_response_headers = res.headers
+
         # We just return the parsed binary response
         return res.parsed_response
 

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: currencyconversion
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Peter Andreas Moelgaard
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-20 00:00:00.000000000 Z
+date: 2016-02-22 00:00:00.000000000 Z
 dependencies:
 - !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'
 - !ruby/object:Gem::Dependency
   name: hashable
   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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby Library for the currencylayer API, Reliable Exchange Rates & Currency
@@ -116,8 +116,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .rspec
-- .travis.yml
+- ".rspec"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -130,6 +130,7 @@ files:
 - example/example_list.rb
 - example/example_live.rb
 - example/example_live_w_currencies_as_array.rb
+- example/example_live_w_interval.rb
 - example/example_live_w_source.rb
 - example/example_timeframe.rb
 - lib/currency_conversion.rb
@@ -169,12 +170,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []