xe_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fdaeee0666ddaa0e81f9425aad6e689dd5853570
+  data.tar.gz: 7b10ff686963faebee6dbd019c0726e9599c94c4
+SHA512:
+  metadata.gz: a7328447e7f2bd6871fbf40f0613a5eb4591b169cc1008ac9fbecdbdbef9d78c84de04d21b3737a07f4686e1359cfc0e770f26aae6ba66293d1247c61c1d2dbe
+  data.tar.gz: 50d146942dd556d3606ba348404c70f08b46990e4cecac8596023ff5f7f5ab0820227857f6cbc717e4b71d3c7cb7ddb8df4d7c04af5bb142a208d2a3efd1c31b

data/.envrc

@@ -0,0 +1 @@
+export PATH=./bin:$PATH

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/config.yml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.1.0] - 2016-06-22
+### Added
+- Add initial working version (`#convert_from`)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at ramon.tayag@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xe_client.gemspec
+gemspec
+
+gem "virtus-matchers", github: "g5/virtus-matchers"
+gem "pry"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ramon Tayag
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# XEClient
+
+Ruby wrapper for XE's REST API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xe_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xe_client
+
+## Usage
+
+See `spec/functional`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xe_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/xe_client.rb

@@ -0,0 +1,22 @@
+require "xe_client/version"
+require "active_model"
+require "virtus"
+require "httparty"
+require "active_support/core_ext/hash/indifferent_access"
+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/responses/base_response"
+require "xe_client/responses/convert_from_response"
+
+module XEClient
+
+  def self.new(opts)
+    client = Client.new(opts)
+    raise ArgumentError, client.errors.full_messages if client.invalid?
+    client
+  end
+
+end

data/lib/xe_client/client.rb

@@ -0,0 +1,31 @@
+module XEClient
+  class Client
+
+    DEFAULT_URL = "https://xecdapi.xe.com"
+
+    include Virtus.model
+    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
+
+    private
+
+    def default_args
+      attributes.slice(:account_id, :api_key, :url)
+    end
+
+  end
+end

data/lib/xe_client/indifferent_hash.rb

@@ -0,0 +1,7 @@
+module XEClient
+  class IndifferentHash < Virtus::Attribute
+    def coerce(value)
+      value.is_a?(::Hash) ? value.with_indifferent_access : value
+    end
+  end
+end

data/lib/xe_client/models/quote.rb

@@ -0,0 +1,9 @@
+module XEClient
+  class Quote
+
+    include Virtus.model
+    attribute :quotecurrency, String
+    attribute :mid, Float
+
+  end
+end

data/lib/xe_client/requests/base_request.rb

@@ -0,0 +1,17 @@
+module XEClient
+  class BaseRequest
+
+    include Virtus.model
+    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
+    end
+
+  end
+end

data/lib/xe_client/requests/convert_from_request.rb

@@ -0,0 +1,38 @@
+module XEClient
+  class ConvertFromRequest < BaseRequest
+
+    DEFAULT_PATH = "/v1/convert_from.json"
+    attribute :base_currency, String
+    attribute :counter_currencies, 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 },
+      )
+    end
+
+    private
+
+    def default_endpoint
+      uri = URI.parse(url)
+      uri.path = DEFAULT_PATH
+      uri.to_s
+    end
+
+  end
+end

data/lib/xe_client/responses/base_response.rb

@@ -0,0 +1,7 @@
+module XEClient
+  class BaseResponse
+
+    include Virtus.model
+
+  end
+end

data/lib/xe_client/responses/convert_from_response.rb

@@ -0,0 +1,21 @@
+module XEClient
+  class ConvertFromResponse < BaseResponse
+
+    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]
+    end
+
+    def default_to
+      raw_response[:to].map do |quote_hash|
+        Quote.new(quote_hash)
+      end
+    end
+
+  end
+end

data/lib/xe_client/version.rb

@@ -0,0 +1,3 @@
+module XEClient
+  VERSION = "0.1.0"
+end

data/xe_client.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xe_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "xe_client"
+  spec.version       = XEClient::VERSION
+  spec.authors       = ["Ramon Tayag"]
+  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.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 3.0"
+  spec.add_dependency "activemodel", ">= 3.0"
+  spec.add_dependency "virtus", "~> 1.0"
+  spec.add_dependency "httparty"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "shoulda-matchers", "~> 3.0"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.0"
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: xe_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ramon Tayag
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  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: 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: shoulda-matchers
+  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: vcr
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- ramon.tayag@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/xe_client.rb
+- lib/xe_client/client.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/responses/base_response.rb
+- lib/xe_client/responses/convert_from_response.rb
+- lib/xe_client/version.rb
+- xe_client.gemspec
+homepage: https://github.com/imacchiato/xe_client-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for XE's REST API
+test_files: []