tangolicious 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a19a42061cf3ca4d92ad3f387c0209224d3bfb96
+  data.tar.gz: ccc45eaebde3731b4147c19eb0af6429760cf7d4
+SHA512:
+  metadata.gz: b8b971f9cdc40e87e8ca04272317c26a680c9dfdfe71383de9167ad189ee78c350ee2bb60c58c1da979155256e0288f0718d834699fe96e395e000cb545cf522
+  data.tar.gz: c9c358ac3a45e1a378646432cf04f3037b264e016408a7f0391c3d5f4bc28588082a9ef0cdb0f2b76a94423c26b1c21de4a41d965ea1de6cd5899d64ec70897b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea
+.DS_Store
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tangolicious.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Aaron Davis
+
+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,190 @@
+# Tangolicious
+
+Wrapper for Tangocard RAAS API v2
+
+*This gem is currently in development*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tangolicious'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tangolicious
+
+## Usage
+
+Set your path and platform name and key:
+
+```ruby
+Tangolicious.platform_name = PLATFORM_NAME
+Tangolicious.platform_key = PLATFORM_KEY
+```
+
+Optionally, you can set a default `account_identifier` and `customer_identifier` to avoid having to pass these in every post request.
+
+```ruby
+Tangolicious.account_identifier = ACCOUNT_IDENTIFIER
+Tangolicious.customer_identifier = CUSTOMER_IDENTIFIER
+```
+
+See https://integration-www.tangocard.com/raas_api_console/v2/ for more detailed documentation about request and response parameters.
+
+#### Customers
+
+List all customers
+
+```ruby
+Tangolicious::Customer.list
+```
+
+Create a customer
+
+```ruby
+Tangolicious::Customer.create(customer_identifier: 'my_customer', display_name: 'My Customer')
+```
+
+
+Retrieve a customer
+
+```ruby
+Tangolicious::Customer.retrieve('my_customer')
+```
+
+List all accounts for a customer
+
+```ruby
+Tangolicious::Customer.accounts('my_customer')
+```
+
+
+Create an account for a customer
+
+```ruby
+Tangolicious::Customer.create_account('my_customer', account_identifier: 'my_account', contact_email: 'email', display_name: 'My Account')
+```
+
+#### Accounts
+
+List all accounts
+
+```ruby
+Tangolicious::Account.list
+```
+
+Retrieve an account
+
+```ruby
+Tangolicious::Account.retrieve('my_account')
+```
+
+#### Fund
+
+Fund an account with a credit card
+
+```ruby
+Tangolicious::CreditCard.fund(amount: 100, credit_card_token: 'cc_token', account_identifier: 'my_account')
+```
+
+Unregister a credit card
+
+```ruby
+Tangolicious::CreditCard.unregister(credit_card_token: 'cc_token')
+```
+
+List all credit cards
+
+```ruby
+Tangolicious::CreditCard.list
+```
+
+Register a credit card
+
+```ruby
+Tangolicious::CreditCard.register(
+  billing_address: {
+    address_line_1: '123 Main Street',
+    city: 'Denver',
+    country: 'USA',
+    email_address: 'me@example.com',
+    first_name: 'Bob',
+    last_name: 'Smith',
+    postal_code: '12345',
+    state: 'CO'
+  },
+  credit_card: {
+    expiration: '2020-01',
+    number: '4007000000027',
+    verification_number: '123'
+  },
+  ip_address: '192.168.0.1',
+  label: 'my_card'
+)
+```
+
+Retrieve a credit card
+
+```ruby
+Tangolicious::CreditCard.retrieve('cc_token')
+```
+
+#### Catalog
+
+List all catalog brands
+
+```ruby
+response = Tangolicious::Catalog.list
+brands = response[:brands]
+```
+
+#### Orders
+
+List all orders
+
+```ruby
+response = Tangolicious::Order.list
+orders = response[:orders]
+```
+
+Create an order
+
+```ruby
+Tangolicious::Order.create(amount: 100, utid: 'U791917')
+```
+
+Retrieve an order
+
+```ruby
+Tangolicious::Order.retrieve('reference_order_id')
+```
+
+Resend the email for an order
+
+```ruby
+Tangolicious::Order.resend('reference_order_id')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+You can run the console with your development credentials by running `PLATFORM_NAME=[name] PLATFORM_KEY=[key] bin/console`.
+
+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 at https://github.com/bonusly/tangolicious.
+
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'tangolicious'
+require 'pp'
+require 'pry'
+require 'irb'
+
+Tangolicious.platform_name = ENV['PLATFORM_NAME']
+Tangolicious.platform_key = ENV['PLATFORM_KEY']
+
+IRB.start(__FILE__)

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/tangolicious/account.rb

@@ -0,0 +1,10 @@
+require 'tangolicious/request'
+require 'tangolicious/resource'
+
+module Tangolicious
+  class Account < Resource
+    def self.endpoint
+      'accounts'
+    end
+  end
+end

data/lib/tangolicious/brand.rb

@@ -0,0 +1,4 @@
+module Tangolicious
+  class Brand < Resource
+  end
+end

data/lib/tangolicious/catalog.rb

@@ -0,0 +1,15 @@
+require 'tangolicious/request'
+require 'tangolicious/resource'
+
+module Tangolicious
+  class Catalog < Resource
+    def self.list
+      response = request.get(endpoint)
+      { brands: Brand.wrap(response['brands']), catalog_name: response['catalogName'] }
+    end
+
+    def self.endpoint
+      'catalogs'
+    end
+  end
+end

data/lib/tangolicious/credit_card.rb

@@ -0,0 +1,22 @@
+require 'tangolicious/request'
+require 'tangolicious/resource'
+
+module Tangolicious
+  class CreditCard < Resource
+    def self.register(params)
+      new(request.post(endpoint, params))
+    end
+
+    def self.unregister(params)
+      request.post('creditCardUnregisters', params)
+    end
+
+    def self.fund(params)
+      request.post('creditCardDeposits', params)
+    end
+
+    def self.endpoint
+      'creditCards'
+    end
+  end
+end

data/lib/tangolicious/customer.rb

@@ -0,0 +1,22 @@
+require 'tangolicious/request'
+require 'tangolicious/resource'
+
+module Tangolicious
+  class Customer < Resource
+    def self.accounts(id)
+      Account.wrap(request.get("#{endpoint}/#{id}/accounts"))
+    end
+
+    def self.create(params)
+      new(request.post(endpoint, params))
+    end
+
+    def self.create_account(id, params)
+      Account.new(request.post("#{endpoint}/#{id}/accounts", params))
+    end
+
+    def self.endpoint
+      'customers'
+    end
+  end
+end

data/lib/tangolicious/exceptions.rb

@@ -0,0 +1,11 @@
+module Tangolicious
+  module Exceptions
+    class BadRequest < StandardError; end
+    class Unauthorized < StandardError; end
+    class InsufficientFunds < StandardError; end
+    class Forbidden < StandardError; end
+    class NotFound < StandardError; end
+    class UnprocessableEntity < StandardError; end
+    class ServiceUnavailable < StandardError; end
+  end
+end

data/lib/tangolicious/order.rb

@@ -0,0 +1,23 @@
+require 'tangolicious/request'
+require 'tangolicious/resource'
+
+module Tangolicious
+  class Order < Resource
+    def self.list
+      response = request.get(endpoint)
+      { page: response['page'], orders: self.wrap(response['orders']) }
+    end
+
+    def self.resend(id)
+      request.post("#{endpoint}/#{id}/resends")
+    end
+
+    def self.create(params)
+      new(request.post(endpoint, params))
+    end
+
+    def self.endpoint
+      'orders'
+    end
+  end
+end

data/lib/tangolicious/request.rb

@@ -0,0 +1,68 @@
+require 'httparty'
+require 'active_support/inflector'
+require 'tangolicious/util'
+require 'tangolicious/exceptions'
+
+module Tangolicious
+  class Request
+    include Util
+
+    def get(endpoint)
+      response = parsed_response(HTTParty.get("#{Tangolicious.api_base}#{endpoint}",
+                                              basic_auth: basic_auth))
+      check_errors(response)
+    end
+
+    def post(endpoint, params = {})
+      response = parsed_response(HTTParty.post("#{Tangolicious.api_base}#{endpoint}",
+                                               basic_auth: basic_auth,
+                                               body: camelize_keys(default_params.merge(params)).to_json,
+                                               headers: headers))
+      check_errors(response)
+    end
+
+    private
+
+    def check_errors(response)
+      return response if response.is_a?(Array)
+      raise Exceptions::BadRequest.new(response) if response.fetch('httpCode', nil) == 400
+      raise Exceptions::Unauthorized.new(response) if response.fetch('httpCode', nil) == 401
+      raise Exceptions::InsufficientFunds.new(response) if response.fetch('httpCode', nil) == 402
+      raise Exceptions::Forbidden.new(response) if response.fetch('httpCode', nil) == 403
+      raise Exceptions::NotFound.new(response) if response.fetch('httpCode', nil) == 404
+      raise Exceptions::UnprocessableEntity.new(response) if response.fetch('httpCode', nil) == 422
+      raise Exceptions::ServiceUnavailable.new(response) if response.fetch('httpCode', nil) == 503
+      response
+    end
+
+    def default_params
+      {
+        account_identifier: Tangolicious.account_identifier,
+        customer_identifier: Tangolicious.customer_identifier
+      }.compact
+    end
+
+    def camelize_keys(attributes)
+      call_recursively(attributes, :tangocard_camelize)
+    end
+
+    def tangocard_camelize(s)
+      s.to_s.camelize(:lower).gsub(/Id$/, 'ID')
+    end
+
+    def parsed_response(response)
+      JSON.parse(response.body)
+    end
+
+    def headers
+      {
+        'Accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+    end
+
+    def basic_auth
+      { username: Tangolicious.platform_name, password: Tangolicious.platform_key }
+    end
+  end
+end

data/lib/tangolicious/resource.rb

@@ -0,0 +1,41 @@
+require 'tangolicious/request'
+require 'tangolicious/util'
+require 'active_support'
+require 'active_support/inflector'
+
+module Tangolicious
+  class Resource < OpenStruct
+    include Util
+
+    def self.wrap(resources)
+      resources.map { |resource| new(resource) }
+    end
+
+    def self.list
+      wrap(request.get(endpoint))
+    end
+
+    def self.retrieve(id)
+      new(request.get("#{endpoint}/#{id}"))
+    end
+
+    def self.request
+      @request ||= Request.new
+    end
+
+    def initialize(attributes = {})
+      super(underscorize_keys(attributes))
+    end
+
+    private
+
+    def underscorize_keys(attributes)
+      call_recursively(attributes, :rubyize)
+    end
+
+    def rubyize(s)
+      s.to_s.underscore.downcase.to_sym
+    end
+  end
+end
+

data/lib/tangolicious/util.rb

@@ -0,0 +1,16 @@
+module Tangolicious
+  module Util
+    def call_recursively(hash, method)
+      hash.each_with_object({}) do |item, h|
+        key, value = item
+        h[send(method, key)] = if value.is_a?(Hash)
+                                 call_recursively(value, method)
+                               elsif value.is_a?(Array)
+                                 value.map { |el| el.is_a?(Hash) ? call_recursively(el, method) : el }
+                               else
+                                 value
+                               end
+      end
+    end
+  end
+end

data/lib/tangolicious/version.rb

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

data/lib/tangolicious.rb

@@ -0,0 +1,16 @@
+require 'tangolicious/version'
+require 'tangolicious/customer'
+require 'tangolicious/account'
+require 'tangolicious/credit_card'
+require 'tangolicious/catalog'
+require 'tangolicious/order'
+require 'tangolicious/brand'
+
+module Tangolicious
+
+  @api_base = 'https://integration-api.tangocard.com/raas/v2/'
+
+  class << self
+    attr_accessor :platform_name, :platform_key, :api_base, :account_identifier, :customer_identifier
+  end
+end

data/tangolicious.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tangolicious/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tangolicious'
+  spec.version       = Tangolicious::VERSION
+  spec.authors       = ['Aaron Davis']
+  spec.email         = ['aaron@bonus.ly']
+
+  spec.summary       = 'Tangocard Raas API v2'
+  spec.homepage      = 'https://github.com/bonusly/tangolicious'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock'
+
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'httparty'
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: tangolicious
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Davis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: pry
+  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: 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: webmock
+  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: activesupport
+  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: 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'
+description: 
+email:
+- aaron@bonus.ly
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tangolicious.rb
+- lib/tangolicious/account.rb
+- lib/tangolicious/brand.rb
+- lib/tangolicious/catalog.rb
+- lib/tangolicious/credit_card.rb
+- lib/tangolicious/customer.rb
+- lib/tangolicious/exceptions.rb
+- lib/tangolicious/order.rb
+- lib/tangolicious/request.rb
+- lib/tangolicious/resource.rb
+- lib/tangolicious/util.rb
+- lib/tangolicious/version.rb
+- tangolicious.gemspec
+homepage: https://github.com/bonusly/tangolicious
+licenses:
+- MIT
+metadata: {}
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Tangocard Raas API v2
+test_files: []