xe_client 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fdaeee0666ddaa0e81f9425aad6e689dd5853570
-  data.tar.gz: 7b10ff686963faebee6dbd019c0726e9599c94c4
+SHA256:
+  metadata.gz: d57a5857429d30d7aa2ab687b7a5d4fc467e18ee1ab10ebf415c914d27f149a9
+  data.tar.gz: d0cb8810a53660ac5a45d55d14be341aa8a0876ce6dff1381521a8b9f21af367
 SHA512:
-  metadata.gz: a7328447e7f2bd6871fbf40f0613a5eb4591b169cc1008ac9fbecdbdbef9d78c84de04d21b3737a07f4686e1359cfc0e770f26aae6ba66293d1247c61c1d2dbe
-  data.tar.gz: 50d146942dd556d3606ba348404c70f08b46990e4cecac8596023ff5f7f5ab0820227857f6cbc717e4b71d3c7cb7ddb8df4d7c04af5bb142a208d2a3efd1c31b
+  metadata.gz: 55a0a14eee2432daca0c88c9e404453f22c738b6ff6a08d5e44218c349b6536d9fbdf04dbf9ac42a00c65b2a5ba91dd2eaf41bc6a782a9931b08d9f5607da75d
+  data.tar.gz: 9868ff4f6350dfed96c509be481595ef17867a9eaa8db0d63399d46a7da3a23610acbc3b069f60afbb2d08470deeb6e895f07666ca032be6ba27be306a95fd5d

data/.github/workflows/ruby.yml

@@ -0,0 +1,37 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Setup spec config
+      run: cp spec/config.yml{.sample,}
+    - name: Run tests
+      run: bundle exec rspec

data/CHANGELOG.md

@@ -2,6 +2,34 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.1.0] - 2021-06-15
+### Added
+- Update `dry-validation` to 1.x
+
+## [1.0.1] - 2020-06-30
+### Fixed
+- `#historic_rate_period`: Do not blow up if no rates
+
+## [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
+
+## [0.2.0] - 2016-06-30
+### Added
+- Raise XEClient::AuthenticationError when there's an auth issue
+- Raise XEClient::Error for all other errors
+
 ## [0.1.0] - 2016-06-22
 ### Added
 - Add initial working version (`#convert_from`)

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,22 +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.new(raw_response: 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/errors/authentication_error.rb

@@ -0,0 +1,4 @@
+module XEClient
+  class AuthenticationError < Error
+  end
+end

data/lib/xe_client/errors/error.rb

@@ -0,0 +1,22 @@
+module XEClient
+  class Error < StandardError
+
+    CODE_ERROR_MAP = {
+      1 => "AuthenticationError",
+    }
+    attr_accessor :code
+
+    def self.new_from_response(response)
+      return nil if response.code.nil?
+      klass = if class_name = CODE_ERROR_MAP[response.code]
+                XEClient.const_get(class_name)
+              else
+                self
+              end
+      error = klass.new(response.message)
+      error.code = response.code
+      error
+    end
+
+  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,37 @@
 module XEClient
   class BaseResponse
 
-    include Virtus.model
+    include APIClientBase::Response.module
+    attribute :raw_response
+    attribute(:response_body, IndifferentHash, {
+      lazy: true,
+      default: :default_response_body,
+    })
+    attribute :code, Integer, lazy: true, default: :default_code
+    attribute :message, String, lazy: true, default: :default_message
+    attribute :error, Object, lazy: true, default: :default_error
+
+    private
+
+    def default_code
+      response_body[:code]
+    end
+
+    def default_message
+      response_body[:message]
+    end
+
+    def default_error
+      Error.new_from_response(self)
+    end
+
+    def default_response_body
+      JSON.parse(raw_response.body)
+    end
+
+    def default_success
+      error.blank?
+    end
 
   end
 end

data/lib/xe_client/responses/convert_from_response.rb

@@ -3,16 +3,15 @@ module XEClient
 
     attribute :from, String, lazy: true, default: :default_from
     attribute :to, Array, lazy: true, default: :default_to
-    attribute :raw_response, IndifferentHash
 
     private
 
     def default_from
-      raw_response[:from]
+      response_body[:from]
     end
 
     def default_to
-      raw_response[:to].map do |quote_hash|
+      response_body[:to].map do |quote_hash|
         Quote.new(quote_hash)
       end
     end

data/lib/xe_client/responses/historic_rate_period_response.rb

@@ -0,0 +1,26 @@
+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
+      to = response_body[:to]
+
+      return [] if to.blank?
+
+      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,11 @@
+module MyGem
+  class ConvertFromRequestSchema < Dry::Validation::Contract
+
+    params do
+      required(:account_id).filled(:str?)
+      required(:api_key).filled(:str?)
+      required(:host).filled(:str?)
+    end
+
+  end
+end

data/lib/xe_client/version.rb

@@ -1,3 +1,3 @@
 module XEClient
-  VERSION = "0.1.0"
+  VERSION = "1.1.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", "< 2"
+  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.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ramon Tayag
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-06-22 00:00:00.000000000 Z
+date: 2021-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,20 +66,68 @@ 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'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !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 +198,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 
+description:
 email:
 - ramon.tayag@gmail.com
 executables: []
@@ -158,9 +206,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".envrc"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -171,20 +219,25 @@ files:
 - bin/setup
 - lib/xe_client.rb
 - lib/xe_client/client.rb
+- lib/xe_client/errors/authentication_error.rb
+- lib/xe_client/errors/error.rb
 - lib/xe_client/indifferent_hash.rb
 - 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
@@ -199,9 +252,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.1.6
+signing_key:
 specification_version: 4
 summary: Ruby wrapper for XE's REST API
 test_files: []

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.12.5