tango-client 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.yardopts

@@ -0,0 +1 @@
+--no-private --protected lib/**/*.rb - README.md

data/Gemfile

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

data/README.md

@@ -0,0 +1,76 @@
+# Tango::Client
+
+HTTP client to ease using Tango API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tango-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tango-client
+
+## Usage
+
+### Use Tango class methods
+
+```ruby
+
+require 'tango'
+
+Tango.get_available_balance
+# => 539694976
+
+Tango.purchase_card(cardSku: 'tango-card',
+                    cardValue: 100,
+                    tcSend: false,
+                    recipientName: nil,
+                    recipientEmail: nil,
+                    giftMessage: nil,
+                    giftFrom: nil)
+# => {
+#   :referenceOrderId=>"112-12226603-04",
+#   :cardToken=>"50bdb8ce341848.92673903",
+#   :cardNumber=>"7001-5040-0198-7543-015",
+#   :cardPin=>"971642",
+#   :claimUrl=>nil,
+#   :challengeKey=>"7001504001987543015"
+# }
+
+```
+
+### Use Client instance
+
+```ruby
+require 'tango'
+
+client = Tango::Client.new(:username => 'myaccount', :password => 'mypassword')
+
+client.get_available_balance
+client.purchase_card({})
+```
+
+### Configuration
+
+-   `Tango` class methods are delegated to `Tango.client`, which options can
+    be changed by updating `Tango.options`. The changes are applied since next
+    request.
+-   `Tango::Client` instances are configured by initialization argument.
+-   Default username, password and endpoint can be configured by environment variable
+    `TANGO_USERNAME`, `TANGO_PASSWORD` and `TANGO_ENDPOINT`.
+-   Changes to `Tango::Default.options` will applied to following created new client
+    instance as default values.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/tango.rb

@@ -0,0 +1,47 @@
+require "tango/version"
+require "tango/default"
+require "tango/client"
+
+module Tango
+  class << self
+
+    # Delegates to a client. The client is re-initialized after any
+    # configuration option is changed.
+    #
+    # @return [Tango::Client]
+    def client
+      unless defined?(@client) && @client.options.hash == options.hash
+        @client = ::Tango::Client.new(options)
+      end
+
+      @client
+    end
+
+    # Global options. New created {Tango::Client} instances observe options here.
+    #
+    # The {#client} instance is re-initialized after options are changed.
+    #
+    # @return [Hash]
+    def options
+      @options ||= ::Tango::Default.options.dup
+    end
+
+    if RUBY_VERSION >= "1.9"
+      def respond_to_missing?(method_name, include_private=false)
+        client.respond_to?(method_name, include_private)
+      end
+    else
+      def respond_to?(method_name, include_private=false)
+        client.respond_to?(method_name, include_private) || super
+      end
+    end
+
+    private
+
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
+
+  end
+end

data/lib/tango/client.rb

@@ -0,0 +1,91 @@
+require 'tango/default'
+require 'tango/error'
+
+require 'uri'
+require 'faraday'
+
+module Tango
+  class Client
+    # @return [Hash]
+    attr_accessor :options
+
+    # Initialize an instance with specified options. Unless an option is
+    # specified, the corresponding value from {Tango::Default.options} is used.
+    #
+    # @param [Hash] options
+    # @option options
+    # @option options [String] username Tango account username
+    # @option options [String] password Tango account password
+    # @option options [String] endpoint API endpoint, the whole API URL prefix
+    #   is "endpoint/version".
+    # @option options [String] version version part of API URL
+    # @option options [Faraday::Builder] middleware Faraday's middleware stack
+    # @option options [Hash] connection_options Further options for Faraday connection
+    def initialize(options = {})
+      @options = ::Tango::Default.options.merge(options)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, params = {})
+      request(:post, path, params)
+    end
+
+    # Get user available balance
+    # @return [Integer] balance in cents (100 = $1.00)
+    # @see https://github.com/tangocarddev/General/blob/master/Tango_Card_Service_API.md#getavailablebalance
+    def get_available_balance
+      response = post 'GetAvailableBalance'
+      balance = response[:body][:availableBalance]
+    end
+
+    # Purchase a card
+    # @params params [Hash] Request parameters. Parameter username and
+    #                password are not used, specify them through client options.
+    # @return [Hash] "response" part of the returned JSON. All keys are symbols.
+    # @see https://github.com/tangocarddev/General/blob/master/Tango_Card_Service_API.md#purchasecard
+    def purchase_card(params = {})
+      response = post 'PurchaseCard', params
+      response[:body]
+    end
+
+    # Returns a Faraday::Connection object
+    #
+    # @return [Faraday::Connection]
+    def connection
+      @connection ||= Faraday.new(endpoint, connection_options)
+    end
+
+    # Constructs endpoint from options
+    #
+    # @return [String]
+    def endpoint
+      options.values_at(:endpoint, :version).join('/')
+    end
+
+    private
+
+    def request(method, path, params = {})
+      path = path.sub(/^\//, '')
+      params = params.merge credentials
+      connection.send(method.to_sym, path, params).env
+    rescue Faraday::Error::ClientError
+      raise Tango::Error::ClientError
+    rescue MultiJson::DecodeError
+      raise Tango::Error::DecodeError
+    end
+
+    # Account credentials.
+    #
+    # @return [Hash] Account credentials
+    def credentials
+      {
+        :username => options[:username],
+        :password => options[:password]
+      }
+    end
+
+    def connection_options
+      options[:connection_options].merge(:builder => options[:middleware])
+    end
+  end
+end

data/lib/tango/default.rb

@@ -0,0 +1,56 @@
+require 'tango/version'
+require 'tango/error'
+require 'tango/request/json_encoded'
+require 'tango/response/parse_json'
+require 'tango/response/raise_error'
+require 'faraday'
+
+module Tango
+  module Default
+    INTEGRATION_ENDPOINT = 'https://int.tangocard.com' unless defined?(::Tango::Default::INTEGRATION_ENDPOINT)
+    PRODUCTION_ENDPOINT = 'https://api.tangocard.com' unless defined?(::Tango::Default::PRODUCTION_ENDPOINT)
+
+    ENDPOINT = INTEGRATION_ENDPOINT unless defined?(::Tango::Default::ENDPOINT)
+
+    MIDDLEWARE = Faraday::Builder.new do |builder|
+      # Encode request params into JSON for PUT/POST requests
+      builder.use ::Tango::Request::JsonEncoded
+
+      builder.use ::Tango::Response::RaiseError, ::Tango::Error::ClientError
+
+      # Parse response JSON
+      builder.use ::Tango::Response::ParseJson
+
+      builder.use ::Tango::Response::RaiseError, ::Tango::Error::ServerError
+
+      builder.adapter Faraday.default_adapter
+
+    end unless defined?(::Tango::Default::MIDDLEWARE)
+
+    CONNECTION_OPTIONS = {
+      :headers => {
+        :accept => 'application/json',
+        :user_agent => "TangoClient Ruby Gem #{::Tango::VERSION}"
+      },
+      :open_timeout => 5,
+      :raw => true,
+      :ssl => {
+        :ca_file => File.expand_path('../ssl/cacert.pem')
+      },
+      :timeout => 10,
+    } unless defined?(::Tango::Default::CONNECTION_OPTIONS)
+
+    VERSION = 'Version2' unless defined?(::Tango::Default::VERSION)
+
+    def self.options
+      @options ||= {
+        :username => ENV['TANGO_USERNAME'] || 'third_party_int@tangocard.com',
+        :password => ENV['TANGO_PASSWORD'] || 'integrateme',
+        :endpoint => ENV['TANGO_ENDPOINT'] || ENDPOINT,
+        :version => VERSION,
+        :middleware => MIDDLEWARE.dup,
+        :connection_options => CONNECTION_OPTIONS.clone
+      }
+    end
+  end
+end

data/lib/tango/error.rb

@@ -0,0 +1,78 @@
+module Tango
+  class Error < StandardError
+    attr_accessor :status_code
+
+    # Creates a new Error object from status_code
+    #
+    # @param status_code [Integer] HTTP response status code
+    # @return [Tango::Error]
+    def self.from_status_code(status_code)
+      ex = new("Error: #{status_code}")
+      ex.status_code = status_code
+      ex
+    end
+
+    # Initializes a new Error object
+    #
+    # @param exception [Exception, String]
+    # @return [Tango::Error]
+    def initialize(exception = $!)
+      @wrapped_exception = exception
+      exception.respond_to?(:backtrace) ? super(exception.message) : super(exception.to_s)
+    end
+
+    def backtrace
+      @wrapped_exception.respond_to?(:backtrace) ? @wrapped_exception.backtrace : super
+    end
+
+    class ClientError < Tango::Error
+      def self.raise_on?(status_code)
+        400 <= status_code && status_code < 500
+      end
+    end
+
+    class ServerError < Tango::Error;
+      def self.raise_on?(status_code)
+        500 <= status_code && status_code < 600
+      end
+
+      attr_accessor :response
+
+      # Fetches value from response by key
+      #
+      # @param key [Symbol]
+      def [](key)
+        response[key] if response
+      end
+
+      # Convert response type to class name
+      def self.response_type_to_class_name(type)
+        type.split('_').collect(&:capitalize).join('')
+      end
+
+      def self.from_response(body)
+        if body.is_a?(Hash) && body[:responseType]
+          type = body[:responseType]
+          class_name = response_type_to_class_name(type)
+          if Tango::Error.const_defined?(class_name)
+            ex = Tango::Error.const_get(class_name).new(body[:response])
+          else
+            ex = new(body[:response])
+          end
+          ex.response = body[:response]
+          ex
+        else
+          new("Invalid response: #{body.to_s}")
+        end
+      end
+    end
+
+    class InvCredential < ServerError; end
+    class InvInput < ServerError; end
+    class InsInv < ServerError; end
+    class InsFunds < ServerError; end
+    class SysError < ServerError; end
+
+    class DecodeError < Tango::Error; end
+  end
+end

data/lib/tango/request/json_encoded.rb

@@ -0,0 +1,41 @@
+require 'faraday'
+require 'multi_json'
+
+module Tango
+  module Request
+    class JsonEncoded < Faraday::Response::Middleware
+      CONTENT_TYPE = 'Content-Type'.freeze
+
+      class << self
+        attr_accessor :mime_type
+      end
+      self.mime_type = 'application/json'.freeze
+
+      def call(env)
+        match_content_type(env) do |data|
+          env[:body] = MultiJson.dump data
+        end
+        @app.call env
+      end
+
+      def match_content_type(env)
+        if process_request?(env)
+          env[:request_headers][CONTENT_TYPE] ||= self.class.mime_type
+          yield env[:body] unless env[:body].respond_to?(:to_str)
+        end
+      end
+
+      def process_request?(env)
+        type = request_type(env)
+        env[:body] and (type.empty? or type == self.class.mime_type)
+      end
+
+      def request_type(env)
+        type = env[:request_headers][CONTENT_TYPE].to_s
+        type = type.split(';', 2).first if type.index(';')
+        type
+      end
+
+    end
+  end
+end

data/lib/tango/response/parse_json.rb

@@ -0,0 +1,32 @@
+require 'faraday'
+require 'multi_json'
+
+require 'tango/error'
+
+module Tango
+  module Response
+    class ParseJson < Faraday::Response::Middleware
+
+      def parse(body)
+        case body
+        when /\A^\s*$\z/, nil
+          nil
+        else
+          json = MultiJson.load(body, :symbolize_keys => true)
+          unless json.is_a?(Hash) && json[:response].is_a?(Hash) && json[:responseType] == 'SUCCESS'
+            raise ::Tango::Error::ServerError.from_response(json)
+          end
+
+          json[:response]
+        end
+      end
+
+      def on_complete(env)
+        if respond_to?(:parse)
+          env[:body] = parse(env[:body])
+        end
+      end
+
+    end
+  end
+end