affirm-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4208863e40741f394c027dd416dd1a170ba2b1a
+  data.tar.gz: cce5e6bc2320398a1ceb86e25236752a883d7ff6
+SHA512:
+  metadata.gz: e96e16fc8fcccae57a39622b4349bf7c1e327ebb01816dca846fd1274719709d39cbc0fbc7d8d6cb6670d9acfd85790ecf5799c00141e6d8ea89647db9efc2ff
+  data.tar.gz: 0ca26687b5b56f9340beb1d2bae268a66d955cca443c93742e70a45c7a7ea3dd9a7676fbdff1b3e592758e200ec1b80ea01548498983f1953a8b38e1707d12ef

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in affirm.gemspec
+gemspec
+
+gem "bundler", "~> 1.7"
+gem "rake",    "~> 10.0"
+gem "rspec",   "~> 3.2.0"
+gem "byebug"

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    affirm-ruby (0.0.1)
+      faraday (~> 0.9.1)
+      faraday_middleware (~> 0.9.1)
+      virtus (~> 1.0, >= 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    byebug (5.0.0)
+      columnize (= 0.9.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    columnize (0.9.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    equalizer (0.0.11)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
+    ice_nine (0.11.1)
+    multipart-post (2.0.0)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    thread_safe (0.3.5)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  affirm-ruby!
+  bundler (~> 1.7)
+  byebug
+  rake (~> 10.0)
+  rspec (~> 3.2.0)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Yury Velikanau
+
+MIT License
+
+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,108 @@
+[![Build Status](https://travis-ci.org/spectator/affirm.svg?branch=master)](http://travis-ci.org/spectator/affirm)
+[![Code Climate](https://codeclimate.com/github/spectator/affirm/badges/gpa.svg)](https://codeclimate.com/github/spectator/affirm)
+
+# Affirm
+
+Affirm gem is a simple Ruby wrapper for Affirm.com API. Please check Affirm API
+[documentation](http://docs.affirm.com/v2/api/#sandbox-api-keys) for more
+details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'affirm'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install affirm
+
+## Configuration
+
+```ruby
+Affirm.configure do |config|
+  config.public_api_key  = "ABC"
+  config.private_api_key = "XYZ"
+  config.environment     = :sandbox # or :production (default if not specified)
+end
+```
+
+## Usage
+
+To authorize a charge `checkout_token` is required. This token gets `POST`ed to
+`user_confirmation_url` that is setup in Checkout JavaScript object.
+
+```ruby
+Affirm::Charge.authorize(checkout_token)
+```
+
+The rest of the API uses `charge_id` which is received as `id` after charge is
+authorized.
+
+#### Read charge
+
+```ruby
+Affirm::Charge.find("TEST-AL04-UVGR")
+```
+
+#### Capture charge
+
+```ruby
+Affirm::Charge.capture("TEST-ALO4-UVGR")
+```
+
+#### Void charge
+
+```ruby
+Affirm::Charge.void("TEST-ALO4-UVGR")
+```
+
+#### Refund charge
+
+```ruby
+Affirm::Charge.refund("TEST-ALO4-UVGR", amount: 500)
+```
+
+#### Update charge
+
+```ruby
+Affirm::Charge.update("TEST-ALO4-UVGR",
+  order_id: "CUSTOM_ORDER_ID",
+  shipping_carrier: "USPS",
+  shipping_confirmation: "1Z23223"
+)
+```
+
+Failed response will return [error
+object](http://docs.affirm.com/v2/api/errors/#error-object) as a plain ruby
+object with values coerced in corresponding types.
+
+The same will happen for all successful responses described (not in full) in
+[server integration](http://docs.affirm.com/v2/api/charges/#authentication)
+guide.
+
+#### Example
+
+```ruby
+response = Affirm::Charge.authorize(checkout_token)
+if response.success?
+  charge_id = response.id
+  # save charge_id
+else
+  puts response.error.message
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/spectator/affirm/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run specs"
+RSpec::Core::RakeTask.new("spec") do |task|
+  task.verbose = false
+end
+
+desc "Console"
+task :console do
+  require "irb"
+  require "irb/completion"
+  require "affirm"
+  require "byebug"
+  ARGV.clear
+  IRB.start
+end
+
+task default: :spec

data/affirm.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'affirm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "affirm-ruby"
+  spec.version       = Affirm::VERSION
+  spec.authors       = ["Yury Velikanau", "Igor Pstyga"]
+  spec.email         = ["yury.velikanau@gmail.com"]
+  spec.summary       = %q{Ruby wrapper for Affirm.com API}
+  spec.description   = %q{Ruby client library for Affirm.com API}
+  spec.homepage      = "https://github.com/spectator/affirm"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = "~> 2.1"
+  spec.add_dependency "faraday", "~> 0.9.1"
+  spec.add_dependency "faraday_middleware", "~> 0.9.1"
+  spec.add_dependency "virtus", "~> 1.0", ">= 1.0.0"
+end

data/lib/affirm.rb

@@ -0,0 +1,27 @@
+require "forwardable"
+
+require "faraday"
+require "faraday_middleware"
+require "virtus"
+
+require "affirm/client"
+require "affirm/charge"
+require "affirm/configuration"
+require "affirm/success_result"
+require "affirm/failure_result"
+require "affirm/objects/event"
+require "affirm/objects/contact"
+require "affirm/objects/address"
+require "affirm/objects/billing"
+require "affirm/objects/shipping"
+require "affirm/objects/discount"
+require "affirm/objects/item"
+require "affirm/objects/order"
+require "affirm/responses/auth"
+require "affirm/responses/capture"
+require "affirm/responses/void"
+require "affirm/responses/refund"
+require "affirm/responses/update"
+require "affirm/responses/error"
+
+require "affirm/version"

data/lib/affirm/charge.rb

@@ -0,0 +1,45 @@
+module Affirm
+  module Charge
+    extend self
+
+    def authorize(token)
+      respond Client.request(:post, "charges", checkout_token: token)
+    end
+
+    def find(charge_id)
+      respond Client.request(:get, "charges/#{charge_id}")
+    end
+
+    def capture(charge_id)
+      respond Client.request(:post, "charges/#{charge_id}/capture")
+    end
+
+    def void(charge_id)
+      respond Client.request(:post, "charges/#{charge_id}/void")
+    end
+
+    def refund(charge_id, amount:)
+      respond Client.request(:post, "charges/#{charge_id}/refund", amount: amount)
+    end
+
+    def update(charge_id, **updates)
+      respond Client.request(:post, "charges/#{charge_id}/update", updates)
+    end
+
+    private
+
+    def respond(response)
+      return FailureResult.new(response) unless response.success?
+
+      type  = response.body["type"]
+      klass = case type
+      when *%w(capture void refund update)
+        Object.const_get("Affirm::Responses::#{type.capitalize}")
+      else
+        Affirm::Responses::Auth
+      end
+
+      SuccessResult.new(klass.new(response.body))
+    end
+  end
+end

data/lib/affirm/client.rb

@@ -0,0 +1,50 @@
+module Affirm
+  class Client
+    attr_reader :connection
+
+    attr_reader :url_prefix
+    private :url_prefix
+
+    class << self
+      def request(method, path, **data)
+        new.public_send(method, path, data)
+      end
+    end
+
+    def initialize
+      @url_prefix = "/api/v2"
+      @connection = Faraday.new(Affirm.configuration.endpoint) do |conn|
+        conn.basic_auth(basic_auth_user, basic_auth_password)
+        conn.request  :json
+        conn.response :json, content_type: /\bjson$/
+        conn.adapter  Faraday.default_adapter
+      end
+    end
+
+    def get(path, **data)
+      connection.get(normalized_path(path), data)
+    end
+
+    def post(path, **data)
+      connection.post(normalized_path(path), data)
+    end
+
+    private
+
+    def basic_auth_user
+      Affirm.configuration.public_api_key
+    end
+
+    def basic_auth_password
+      Affirm.configuration.private_api_key
+    end
+
+    def normalized_path(path)
+      url_prefix + normalize_path(path)
+    end
+
+    def normalize_path(path)
+      Faraday::Utils.normalize_path(path)
+    end
+  end
+end

data/lib/affirm/configuration.rb

@@ -0,0 +1,34 @@
+module Affirm
+  class Configuration
+    attr_accessor :public_api_key
+    attr_accessor :private_api_key
+    attr_accessor :environment
+
+    ENDPOINTS = {
+      production: "api.affirm.com",
+      sandbox:    "sandbox.affirm.com"
+    }
+
+    def initialize
+      @environment = :production
+    end
+
+    def endpoint
+      "https://#{ENDPOINTS[environment]}"
+    end
+  end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configuration=(config)
+      @configuration = config
+    end
+
+    def configure
+      yield configuration
+    end
+  end
+end

data/lib/affirm/failure_result.rb

@@ -0,0 +1,16 @@
+module Affirm
+  class FailureResult
+    extend Forwardable
+    def_delegators :response, :status, :success?
+
+    attr_reader :error
+
+    attr_reader :response
+    private :response
+
+    def initialize(response)
+      @response = response
+      @error    = Affirm::Responses::Error.new(response.body)
+    end
+  end
+end