currencyconversion 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fe4a97084675d6729a0c4122fcd20226595fdac
-  data.tar.gz: 48ffc10f099769d133836d9183303944df122d12
+  metadata.gz: e1f1d4f491e70656b3d318aafb32206d79a20b52
+  data.tar.gz: 1505c844a7bf804c90a85faead45c9f51ed3c695
 SHA512:
-  metadata.gz: 20bf4fa23f2cfed99874dcacbe3a15cbbac0c8e7c7311bf21a04e30235ab4350438e0158f9ac1a4174fb1d1f88a484187e52ad2bfe7114babfa66a1980aa4f72
-  data.tar.gz: f996a6c5d28d03cc760158081dc9ee6e26b28a37f5452a88f9a9600746fb83e034b814b41a65c448682597095b2d50b9450c57a58e581c2a9a22ffb3aca59e47
+  metadata.gz: 17fd0b7b3a393485b6149d1c309310e45981388e77c03959bf5fde429302661de60994d3eab64e6d25033188eb18645799e619831437ef7ed6262f4ce37bdec4
+  data.tar.gz: b0577d35d7c3c6c743c732d1a2e5171129b5afc15024ddffcb1a3022c8977030947a431f8c3fb8af5d77c158fda0bd61ddc04e8cc4d90320fc0ab38d185ba211

data/currency_conversion.gemspec

@@ -12,8 +12,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Peter Andreas Moelgaard"]
   spec.email         = ["github@petermolgaard.com"]
 
-  spec.summary       = "currency_conversion"
-  spec.description   = "currency_conversion"
+  spec.description   = "Ruby Library for the currencylayer API, Reliable Exchange Rates & Currency Conversion, https://currencylayer.com/"
+  spec.summary       = "Free and startup-friendly currency converter JSON API for real-time and historical exchange rates - reliable and accurate, supporting 168 world currencies."
   spec.homepage      = "https://github.com/pmoelgaard/currency_conversion"
   spec.license       = "MIT"
 
@@ -22,7 +22,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_runtime_dependency "httparty"
+  spec.add_runtime_dependency "hashable"
+
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "bump"
 end

data/example/example_live.rb

@@ -0,0 +1,30 @@
+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()
+
+  # 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
+
+rescue => e
+  puts e.inspect
+
+end

data/example/example_live_w_currencies_as_array.rb

@@ -0,0 +1,35 @@
+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()
+
+  # 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
+
+rescue => e
+  puts e.inspect
+
+end

data/example/example_live_w_source.rb

@@ -0,0 +1,34 @@
+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'
+
+  # Set the source of the conversion
+  source = 'SGD'
+
+  # We declare the options
+  options = CurrencyLayer::LiveOptions.new()
+  options.source = source
+
+  # 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 w. source...' << response.to_s
+  end
+
+rescue => e
+  puts e.inspect
+
+end

data/lib/currency_conversion/live/live_exception.rb

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

data/lib/currency_conversion/live/live_options.rb

@@ -0,0 +1,18 @@
+module CurrencyLayer
+
+  class LiveOptions
+
+    include Hashable
+
+    attr_accessor :access_key
+
+    attr_accessor :currencies
+    attr_accessor :source
+
+    def initialize()
+      @query = nil
+    end
+
+  end
+
+end

data/lib/currency_conversion/live/live_request.rb

@@ -0,0 +1,21 @@
+require "hashable"
+
+module CurrencyLayer
+
+  class LiveRequest
+
+    include Hashable
+
+    attr_accessor :query
+
+    def initialize(query = {})
+
+      # 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(',')
+
+      self.query = query
+
+    end
+
+  end
+end

data/lib/currency_conversion/live/live_response.rb

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

data/lib/currency_conversion/missing_argument_exception.rb

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

data/lib/currency_conversion/version.rb

@@ -1,3 +1,3 @@
 module CurrencyLayer
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/currency_conversion.rb

@@ -1,5 +1,68 @@
+require "httparty"
+require "hashable"
 require "currency_conversion/version"
+require "currency_conversion/live/live_request"
+require "currency_conversion/live/live_response"
 
 module CurrencyLayer
-  # Your code goes here...
+
+  class Client
+
+    include HTTParty
+
+    base_uri 'apilayer.net/api'
+
+    def initialize(access_key)
+
+      if access_key.nil?
+        raise CurrencyLayer::MissingArgumentException.new 'access_key'
+      end
+
+      @access_key = access_key
+
+    end
+
+    def live(currencies, options = {})
+
+      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.currencies = currencies
+
+      # We then create the Request
+      req = CurrencyLayer::LiveRequest.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('/live', req_dto)
+
+        # We ensure that we tap the response so we can use the results
+        res.inspect
+
+        if (res[CurrencyLayer::LiveResponse::ERROR_EXPR])
+          raise CurrencyLayer::LiveException.new res[CurrencyLayer::LiveResponse::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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: currencyconversion
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Peter Andreas Moelgaard
@@ -10,6 +10,34 @@ bindir: exe
 cert_chain: []
 date: 2016-02-20 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
@@ -52,7 +80,36 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
-description: currency_conversion
+- !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
+  Conversion, https://currencylayer.com/
 email:
 - github@petermolgaard.com
 executables: []
@@ -69,7 +126,15 @@ files:
 - bin/console
 - bin/setup
 - currency_conversion.gemspec
+- example/example_live.rb
+- example/example_live_w_currencies_as_array.rb
+- example/example_live_w_source.rb
 - lib/currency_conversion.rb
+- lib/currency_conversion/live/live_exception.rb
+- lib/currency_conversion/live/live_options.rb
+- lib/currency_conversion/live/live_request.rb
+- lib/currency_conversion/live/live_response.rb
+- lib/currency_conversion/missing_argument_exception.rb
 - lib/currency_conversion/version.rb
 homepage: https://github.com/pmoelgaard/currency_conversion
 licenses:
@@ -83,7 +148,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -94,5 +159,6 @@ rubyforge_project:
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: currency_conversion
+summary: Free and startup-friendly currency converter JSON API for real-time and historical
+  exchange rates - reliable and accurate, supporting 168 world currencies.
 test_files: []