spreedly 1.4.0 → 2.0.0

data/lib/spreedly/transactions/gateway_transaction.rb

@@ -0,0 +1,31 @@
+module Spreedly
+
+  class GatewayTransaction < Transaction
+
+    field :order_id, :ip, :description, :gateway_token
+    field :merchant_name_descriptor, :merchant_location_descriptor
+    field :on_test_gateway, type: :boolean
+
+    attr_reader :response
+
+    def initialize(xml_doc)
+      super
+      @response = Response.new(xml_doc.at_xpath('.//response'))
+    end
+
+  end
+
+  class Response
+    include Fields
+
+    field :success, :pending, :cancelled, type: :boolean
+    field :created_at, :updated_at, type: :date_time
+    field :message, :avs_code, :avs_message, :cvv_code, :cvv_message, :error_code, :error_detail
+
+    def initialize(xml_doc)
+      initialize_fields(xml_doc)
+    end
+
+  end
+
+end

data/lib/spreedly/transactions/purchase.rb

@@ -0,0 +1,7 @@
+module Spreedly
+
+  class Purchase < AuthPurchase
+
+  end
+
+end

data/lib/spreedly/transactions/redact_payment_method.rb

@@ -0,0 +1,14 @@
+module Spreedly
+
+  class RedactPaymentMethod < Transaction
+
+    attr_reader :payment_method
+
+    def initialize(xml_doc)
+      super
+      @payment_method = PaymentMethod.new_from(xml_doc.at_xpath('.//payment_method'))
+    end
+
+  end
+
+end

data/lib/spreedly/transactions/refund.rb

@@ -0,0 +1,14 @@
+module Spreedly
+
+  class Refund < GatewayTransaction
+
+    field :currency_code, :reference_token
+    field :amount, type: :integer
+
+    def initialize(xml_doc)
+      super
+    end
+
+  end
+
+end

data/lib/spreedly/transactions/retain_payment_method.rb

@@ -0,0 +1,14 @@
+module Spreedly
+
+  class RetainPaymentMethod < Transaction
+
+    attr_reader :payment_method
+
+    def initialize(xml_doc)
+      super
+      @payment_method = PaymentMethod.new_from(xml_doc.at_xpath('.//payment_method'))
+    end
+
+  end
+
+end

data/lib/spreedly/transactions/transaction.rb

@@ -0,0 +1,41 @@
+
+module Spreedly
+
+  class Transaction < Model
+
+    field :state, :message
+    field :succeeded, type: :boolean
+
+    def self.new_from(xml_doc)
+      case xml_doc.at_xpath('.//transaction_type').inner_text
+      when 'AddPaymentMethod'
+        return AddPaymentMethod.new(xml_doc)
+      when 'Purchase'
+        return Purchase.new(xml_doc)
+      when 'Authorization'
+        return Authorization.new(xml_doc)
+      when 'Capture'
+        return Capture.new(xml_doc)
+      when 'Credit'
+        return Refund.new(xml_doc)
+      when 'Void'
+        return Void.new(xml_doc)
+      when 'RetainPaymentMethod'
+        return RetainPaymentMethod.new(xml_doc)
+      when 'RedactPaymentMethod'
+        return RedactPaymentMethod.new(xml_doc)
+      else
+        Transaction.new(xml_doc)
+      end
+    end
+
+    def self.new_list_from(xml_doc)
+      transactions = xml_doc.xpath('.//transactions/transaction')
+      transactions.map do |each|
+        self.new_from(each)
+      end
+    end
+
+  end
+
+end

data/lib/spreedly/transactions/void.rb

@@ -0,0 +1,9 @@
+module Spreedly
+
+  class Void < GatewayTransaction
+
+    field :reference_token
+
+  end
+
+end

data/lib/spreedly/urls.rb

@@ -0,0 +1,64 @@
+module Spreedly
+
+  module Urls
+
+    def base_url
+      "https://core.spreedly.com"
+    end
+
+    def find_payment_method_url(token)
+      "#{base_url}/v1/payment_methods/#{token}.xml"
+    end
+
+    def find_transaction_url(token)
+      "#{base_url}/v1/transactions/#{token}.xml"
+    end
+
+    def find_gateway_url(token)
+      "#{base_url}/v1/gateways/#{token}.xml"
+    end
+
+    def purchase_url(gateway_token)
+      "#{base_url}/v1/gateways/#{gateway_token}/purchase.xml"
+    end
+
+    def authorize_url(gateway_token)
+      "#{base_url}/v1/gateways/#{gateway_token}/authorize.xml"
+    end
+
+    def capture_url(authorization_token)
+      "#{base_url}/v1/transactions/#{authorization_token}/capture.xml"
+    end
+
+    def void_transaction_url(token)
+      "#{base_url}/v1/transactions/#{token}/void.xml"
+    end
+
+    def refund_transaction_url(token)
+      "#{base_url}/v1/transactions/#{token}/credit.xml"
+    end
+
+    def retain_payment_method_url(payment_method_token)
+      "#{base_url}/v1/payment_methods/#{payment_method_token}/retain.xml"
+    end
+
+    def redact_payment_method_url(payment_method_token)
+      "#{base_url}/v1/payment_methods/#{payment_method_token}/redact.xml"
+    end
+
+    def list_transactions_url(since_token)
+      since_param = "?since_token=#{since_token}" if since_token
+      "#{base_url}/v1/transactions.xml#{since_param}"
+    end
+
+    def add_gateway_url
+      "#{base_url}/v1/gateways.xml"
+    end
+
+    def add_payment_method_url
+      "#{base_url}/v1/payment_methods.xml"
+    end
+
+  end
+
+end

data/lib/spreedly/version.rb

@@ -1,3 +1,3 @@
 module Spreedly
-  VERSION = "1.4.0"
+  VERSION = "2.0.0"
 end

data/spreedly.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spreedly/version'
+
+
+Gem::Specification.new do |s|
+  s.name          = "spreedly"
+  s.version       = Spreedly::VERSION
+  s.authors       = ["Spreedly"]
+  s.email         = ["duff@spreedly.com"]
+  s.summary       = "Provides a Ruby wrapper for the Spreedly API."
+  s.description   = "The Spreedly gem provides a convenient Ruby wrapper for the Spreedly API."
+  s.homepage      = "https://github.com/spreedly/spreedly-gem"
+  s.license       = "MIT"
+
+  s.files         = `git ls-files`.split($/)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'nokogiri'
+
+  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'log_buddy'
+  s.add_development_dependency 'awesome_print'
+end
+

data/test/credentials/credentials.yml

@@ -0,0 +1,9 @@
+# This file contains the Spreedly credentials to use when running remote tests.
+# They're working credentials so the remote tests should simply run.
+
+# You may instead choose to use your own credentials for your own Spreedly
+# test environment by copying this file to the gitignored file named
+# personal_credentials.yml located in the same directory as this file.
+
+environment_key: "R7lHscqcYkZeDGGbthKp6GKMu15"
+access_secret: "8sefxO5Q44sLWpmZpalQS3Qlqo03JbCemsqsWJR3YOLCuigOFRlaLSAn0WaL5dWU"

data/test/credentials/test_credentials.rb

@@ -0,0 +1,43 @@
+module Spreedly
+  module TestCredentials
+
+    def remote_test_environment_key
+      remote_creds["environment_key"]
+    end
+
+    def remote_test_access_secret
+      remote_creds["access_secret"]
+    end
+
+    private
+    def remote_creds
+      @@remote_creds ||= load_creds
+    end
+
+    def load_creds
+      load_default_creds.merge(load_personal_creds)
+    end
+
+    def load_default_creds
+      YAML.load(File.read(default_creds_file))
+    end
+
+    def load_personal_creds
+      return {} unless File.exists?(personal_creds_file)
+
+      personal_creds = YAML.load(File.read(personal_creds_file))
+      return {} unless personal_creds
+      raise("The file '#{personal_creds_file}' has an invalid format.\nIt should have the same format as '#{default_creds_file}'.") unless personal_creds.kind_of?(Hash)
+      personal_creds
+    end
+
+    def default_creds_file
+      File.join(File.dirname(__FILE__), 'credentials.yml')
+    end
+
+    def personal_creds_file
+      File.join(File.dirname(__FILE__), 'personal_credentials.yml')
+    end
+
+  end
+end

data/test/helpers/assertions.rb

@@ -0,0 +1,29 @@
+module Spreedly
+
+  module Assertions
+
+    def assert_raise_with_message(expected_exception_type, expected_message)
+      error = assert_raises(expected_exception_type) do
+        yield
+      end
+      assert_equal expected_message, error.message, "Exception message is incorrect"
+    end
+
+    def assert_invalid_login
+      environment = Spreedly::Environment.new("UnknownEnvironmentKey", "UnknownAccessSecret")
+
+      assert_raise_with_message(Spreedly::AuthenticationError, "Unable to authenticate using the given environment_key and access_token.  Please check your credentials.") do
+        yield(environment)
+      end
+    end
+
+    def assert_xpaths_in(xml_doc, *xpaths)
+      xpaths.each do |xpath, expected_text|
+        assert_equal expected_text, xml_doc.xpath(xpath).text, "Looking for the text of the following xpath: #{xpath}"
+      end
+    end
+
+  end
+
+
+end

data/test/helpers/communication_helper.rb

@@ -0,0 +1,31 @@
+module Spreedly
+
+  module CommunicationHelper
+
+    def get_request_body(response)
+      remembered_body = nil
+
+      @environment.define_singleton_method(:raw_ssl_request) do |method, enpoint, body, headers|
+        remembered_body = body
+        response
+      end
+
+      yield
+      Nokogiri::XML(remembered_body)
+    end
+
+    def get_request_url(response)
+      remembered_url = nil
+
+      @environment.define_singleton_method(:raw_ssl_request) do |method, endpoint, body, headers|
+        remembered_url = endpoint
+        response
+      end
+
+      yield
+      remembered_url
+    end
+
+  end
+
+end

data/test/helpers/creation_helper.rb

@@ -0,0 +1,26 @@
+
+module Spreedly
+
+  module CreationHelper
+
+    def create_card_on(environment, options = {})
+      deets = default_card_deets.merge(options)
+      environment.add_credit_card(deets).payment_method
+    end
+
+    def create_failed_card_on(environment, options = {})
+      deets = default_card_deets.merge(number: '4012888888881881').merge(options)
+      environment.add_credit_card(deets).payment_method
+    end
+
+
+    private
+    def default_card_deets
+      {
+        email: 'perrin@wot.com', number: '5555555555554444', month: 1, year: 2019,
+        last_name: 'Aybara', first_name: 'Perrin', retained: true
+      }
+    end
+  end
+
+end

data/test/helpers/stub_response.rb

@@ -0,0 +1,18 @@
+class StubResponse
+  attr_reader :code, :body
+  def self.succeeded(xml)
+    StubResponse.new(200, xml)
+  end
+
+  def self.failed(xml)
+    StubResponse.new(422, xml)
+  end
+
+  def initialize(code, body, headers={})
+    @code, @body, @headers = code, body, headers
+  end
+
+  def [](header)
+    @headers[header]
+  end
+end

data/test/remote/remote_add_credit_card_test.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+
+class RemoteAddCreditCardTest < Test::Unit::TestCase
+
+  def setup
+    @environment = Spreedly::Environment.new(remote_test_environment_key, remote_test_access_secret)
+  end
+
+  def test_invalid_login
+    assert_invalid_login do |environment|
+      environment.add_credit_card(card_deets)
+    end
+  end
+
+  def test_failed_with_validation_errors
+    error = assert_raises(Spreedly::TransactionCreationError) do
+      @environment.add_credit_card(card_deets(last_name: '', first_name: ' '))
+    end
+
+    expected_errors = [
+      { attribute: "first_name", key: "errors.blank", message: "First name can't be blank" },
+      { attribute: "last_name", key: "errors.blank", message: "Last name can't be blank" }
+    ]
+
+    assert_equal expected_errors, error.errors
+    assert_equal "First name can't be blank\nLast name can't be blank", error.message
+  end
+
+  def test_payment_required
+    assert_raise_with_message(Spreedly::PaymentRequiredError, "Your account has not been activated for real transactions. Please update your subscription settings.") do
+      @environment.add_credit_card(card_deets(number: '343'))
+    end
+  end
+
+  def test_successful_add_card
+    t = @environment.add_credit_card(card_deets)
+
+    assert t.succeeded?
+    assert_equal 'Aybara', t.payment_method.last_name
+    assert !t.retained
+    assert_equal 'cached', t.payment_method.storage_state
+    assert_equal 'occupation: Blacksmith', t.payment_method.data
+  end
+
+  def test_successfully_retain_on_create
+    t = @environment.add_credit_card(card_deets(retained: true))
+
+    assert t.succeeded?
+    assert t.retained
+    assert_equal 'retained', t.payment_method.storage_state
+  end
+
+
+  private
+  def card_deets(options = {})
+    {
+      email: 'perrin@wot.com', number: '5555555555554444', month: 1, year: 2019,
+      last_name: 'Aybara', first_name: 'Perrin', data: "occupation: Blacksmith"
+    }.merge(options)
+  end
+
+end