xe_client 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f1177833638b0c28803459d8331025da54f2fae6
-  data.tar.gz: 57b01c71dcfdae7394d4d7b1f175c8f27d435166
+SHA256:
+  metadata.gz: faccd61a405fbd11dfb9873a31a602e8b6b088500d420061318d8dd4525eae9a
+  data.tar.gz: ad0f22f7e5fd44f582a81250ef7415db193b0ccc066ac6de540e0a1f98a22463
 SHA512:
-  metadata.gz: a7db6850029ca84dd8df1d9e0f604d512dd6dc930f1d7a975ede64d42fe068c8b1beae4c9cfd8b945258cdd85089e624b7f62a4f85b7529469152b78bf7adaa9
-  data.tar.gz: 2883328f43a6d02323be5341ceb5f04728b8fa20f78c8ab060a3f1bec8e74f3d7f1b5bd11957d97e76ec47c3c64295d6eaf5acf7d20d16f67d0652577b5f452f
+  metadata.gz: e6d9a02af3aeee2f477861297ea8a5f7b26dc3b6f35a09c1c11cd9de0b8e3566a4a14f1203ef5c6e03819c6ddaab0131ecdab8d942c14d5732725ccc1e268653
+  data.tar.gz: 45335dc7e9974c01744871f769043c4e4ef00bb9daf1301207c9c280217b8b3d7a90271c3a9e67f7ddefb76fbf7ab787d06446eb30d314ee8c23301719facf15

data/.travis.yml

@@ -1,5 +1,7 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.12.5
+  - 2.6.3
+before_install: gem install bundler:2.0
+before_script:
+  - cp spec/config.yml{.sample,}

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.0.0] - 2020-06-30
+### Changed
+- Changed `url` to `host` fot the XE API host (defaults to https://xecdapi.xe.com)
+- Changed `#convert_from` to accept keyword args named more like the API's param names:
+  - `from` instead of the first argument aka `base_currency`
+  - `to` instead of the second argument aka `counter_currencies`
+  - `amount` instead of the third argument
+- No longer raise exception when XE's response contains an error. Developer should use `#success?` on the response instead and inspect `#error` to see details.
+### Added
+- `historic_rate_period` call to get historic rates over a period
+
 ## [0.2.1] - 2016-08-11
 ### Fixed
 - Fix issue when accessing ConvertFromResponse#to and error was raised

data/README.md

@@ -30,7 +30,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on [GitHub](https://github.com/imacchiato/xe_client-ruby). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on [GitHub](https://github.com/bloom-solutions/xe_client-ruby). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/xe_client.rb

@@ -1,24 +1,35 @@
 require "xe_client/version"
+require "api_client_base"
 require "active_model"
+require "dry-validation"
 require "virtus"
 require "httparty"
 require "active_support/core_ext/hash/indifferent_access"
+require "active_support/core_ext/date_time"
+require "active_support/core_ext/string/conversions"
 require "xe_client/indifferent_hash"
 require "xe_client/models/quote"
 require "xe_client/client"
 require "xe_client/requests/base_request"
 require "xe_client/requests/convert_from_request"
+require "xe_client/requests/historic_rate_period_request"
 require "xe_client/responses/base_response"
 require "xe_client/responses/convert_from_response"
+require "xe_client/responses/historic_rate_period_response"
+require "xe_client/schemas/convert_from_request_schema"
 require "xe_client/errors/error"
 require "xe_client/errors/authentication_error"
 
 module XEClient
 
-  def self.new(opts)
-    client = Client.new(opts)
-    raise ArgumentError, client.errors.full_messages if client.invalid?
-    client
+  include APIClientBase::Base.module
+
+  DEFAULT_HOST = "https://xecdapi.xe.com"
+
+  with_configuration do
+    has :host, classes: String, default: DEFAULT_HOST
+    has :account_id, classes: String
+    has :api_key, classes: String
   end
 
 end

data/lib/xe_client/client.rb

@@ -1,30 +1,18 @@
 module XEClient
   class Client
 
-    DEFAULT_URL = "https://xecdapi.xe.com"
-
-    include Virtus.model
+    include APIClientBase::Client.module(default_opts: :default_opts)
+    attribute :host, String
     attribute :account_id, String
     attribute :api_key, String
-    attribute :url, String, default: DEFAULT_URL
-
-    include ActiveModel::Validations
-    validates :account_id, :api_key, presence: true
 
-    def convert_from(base_currency, counter_currencies, amount)
-      args = default_args.merge(
-        base_currency: base_currency,
-        counter_currencies: counter_currencies,
-        amount: amount,
-      )
-      raw_response = ConvertFromRequest.(args)
-      ConvertFromResponse.(raw_response)
-    end
+    api_action :convert_from
+    api_action :historic_rate_period
 
     private
 
-    def default_args
-      attributes.slice(:account_id, :api_key, :url)
+    def default_opts
+      { host: host, account_id: account_id, api_key: api_key }
     end
 
   end

data/lib/xe_client/models/quote.rb

@@ -4,6 +4,7 @@ module XEClient
     include Virtus.model
     attribute :quotecurrency, String
     attribute :mid, Float
+    attribute :timestamp, DateTime
 
   end
 end

data/lib/xe_client/requests/base_request.rb

@@ -1,16 +1,13 @@
 module XEClient
   class BaseRequest
 
-    include Virtus.model
+    include APIClientBase::Request.module
+    attribute :host, String
     attribute :account_id, String
     attribute :api_key, String
-    attribute :url, String
 
-    include ActiveModel::Validations
-    validates :account_id, :api_key, :url, presence: true
-
-    def self.call(opts)
-      self.new(opts).call
+    def typhoeus_options
+      { userpwd: [account_id, api_key].join(":") }
     end
 
   end

data/lib/xe_client/requests/convert_from_request.rb

@@ -1,37 +1,20 @@
 module XEClient
   class ConvertFromRequest < BaseRequest
 
-    DEFAULT_PATH = "/v1/convert_from.json"
-    attribute :base_currency, String
-    attribute :counter_currencies, Array[String]
+    attribute :from, String
+    attribute :to, Array[String]
     attribute :amount, Float
-    attribute :endpoint, String, lazy: true, default: :default_endpoint
 
-    validates(
-      :base_currency,
-      :counter_currencies,
-      :amount,
-      presence: true,
-    )
-
-    def call
-      HTTParty.get(
-        endpoint,
-        query: {
-          from: base_currency,
-          to: counter_currencies.join(","),
-          amount: amount,
-        },
-        basic_auth: { username: account_id, password: api_key },
-      )
+    def path
+      "/v1/convert_from.json"
     end
 
-    private
-
-    def default_endpoint
-      uri = URI.parse(url)
-      uri.path = DEFAULT_PATH
-      uri.to_s
+    def params
+      {
+        from: from,
+        to: to.join(","),
+        amount: amount,
+      }
     end
 
   end

data/lib/xe_client/requests/historic_rate_period_request.rb

@@ -0,0 +1,29 @@
+module XEClient
+  class HistoricRatePeriodRequest < BaseRequest
+
+    attribute :from, String
+    attribute :to, Array[String]
+    attribute :start_timestamp, DateTime
+    attribute :end_timestamp, DateTime
+    attribute :interval, String
+    attribute :per_page, Integer
+    attribute :page, Integer
+
+    def path
+      "/v1/historic_rate/period.json"
+    end
+
+    def params
+      {
+        from: from,
+        to: to.join(","),
+        start_timestamp: start_timestamp,
+        end_timestamp: end_timestamp,
+        interval: interval,
+        per_page: per_page,
+        page: page,
+      }
+    end
+
+  end
+end

data/lib/xe_client/responses/base_response.rb

@@ -1,7 +1,7 @@
 module XEClient
   class BaseResponse
 
-    include Virtus.model
+    include APIClientBase::Response.module
     attribute :raw_response
     attribute(:response_body, IndifferentHash, {
       lazy: true,
@@ -11,12 +11,6 @@ module XEClient
     attribute :message, String, lazy: true, default: :default_message
     attribute :error, Object, lazy: true, default: :default_error
 
-    def self.call(raw_response)
-      response = self.new(raw_response: raw_response)
-      raise response.error if response.error.present?
-      response
-    end
-
     private
 
     def default_code
@@ -35,5 +29,9 @@ module XEClient
       JSON.parse(raw_response.body)
     end
 
+    def default_success
+      error.blank?
+    end
+
   end
 end

data/lib/xe_client/responses/historic_rate_period_response.rb

@@ -0,0 +1,22 @@
+module XEClient
+  class HistoricRatePeriodResponse < BaseResponse
+
+    attribute :from, String, lazy: true, default: :default_from
+    attribute :to, Array, lazy: true, default: :default_to
+
+    private
+
+    def default_from
+      response_body[:from]
+    end
+
+    def default_to
+      response_body[:to].each_with_object([]) do |(currency, quote_args), arr|
+        quote_args.each do |quote_arg|
+          arr << Quote.new(quote_arg.merge(quotecurrency: currency))
+        end
+      end
+    end
+
+  end
+end

data/lib/xe_client/schemas/convert_from_request_schema.rb

@@ -0,0 +1,7 @@
+module MyGem
+  ConvertFromRequestSchema = Dry::Validation.Schema do
+    required(:account_id).filled(:str?)
+    required(:api_key).filled(:str?)
+    required(:host).filled(:str?)
+  end
+end

data/lib/xe_client/version.rb

@@ -1,3 +1,3 @@
 module XEClient
-  VERSION = "0.2.1"
+  VERSION = "1.0.0"
 end

data/xe_client.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["ramon.tayag@gmail.com"]
 
   spec.summary       = %q{Ruby wrapper for XE's REST API}
-  spec.homepage      = "https://github.com/imacchiato/xe_client-ruby"
+  spec.homepage      = "https://github.com/bloom-solutions/xe_client-ruby"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -30,8 +30,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activemodel", ">= 3.0"
   spec.add_dependency "virtus", "~> 1.0"
   spec.add_dependency "httparty"
+  spec.add_dependency "api_client_base", "~> 1.9"
+  spec.add_dependency "dry-validation", "< 1.0"
+  spec.add_dependency "typhoeus", "~> 1.0"
 
-  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "shoulda-matchers", "~> 3.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xe_client
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Ramon Tayag
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-08-11 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,20 +66,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: api_client_base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +192,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 
+description:
 email:
 - ramon.tayag@gmail.com
 executables: []
@@ -177,16 +219,19 @@ files:
 - lib/xe_client/models/quote.rb
 - lib/xe_client/requests/base_request.rb
 - lib/xe_client/requests/convert_from_request.rb
+- lib/xe_client/requests/historic_rate_period_request.rb
 - lib/xe_client/responses/base_response.rb
 - lib/xe_client/responses/convert_from_response.rb
+- lib/xe_client/responses/historic_rate_period_response.rb
+- lib/xe_client/schemas/convert_from_request_schema.rb
 - lib/xe_client/version.rb
 - xe_client.gemspec
-homepage: https://github.com/imacchiato/xe_client-ruby
+homepage: https://github.com/bloom-solutions/xe_client-ruby
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -201,9 +246,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Ruby wrapper for XE's REST API
 test_files: []