spreedly-core-ruby 0.1.0 → 0.1.2

data/lib/{spreedly_core.rb → spreedly-core-ruby.rb}

@@ -1,12 +1,14 @@
 require 'set'
 
 require 'httparty'
+require 'active_support/core_ext/hash/conversions'
 
-require 'spreedly_core/base'
-require 'spreedly_core/payment_method'
-require 'spreedly_core/gateway'
-require 'spreedly_core/test_gateway'
-require 'spreedly_core/transactions'
+require 'spreedly-core-ruby/base'
+require 'spreedly-core-ruby/payment_method'
+require 'spreedly-core-ruby/gateway'
+require 'spreedly-core-ruby/test_gateway'
+require 'spreedly-core-ruby/transactions'
+require 'active_support/core_ext/hash/conversions'
 
 module SpreedlyCore
   # Hash of user friendly credit card name to SpreedlyCore API name
@@ -18,6 +20,7 @@ module SpreedlyCore
   }
 
   class Error < RuntimeError; end
+  
   # Custom exception which occurs when a request to SpreedlyCore times out
   # See SpreedlyCore::Base.default_timeout 
   class TimeOutError < Error; end
@@ -27,6 +30,13 @@ module SpreedlyCore
     end
   end
 
+  class UnprocessableRequest < Error
+    def initialize(errors)
+      errors = [errors] unless errors.is_a?(Array)
+      super(errors.join("\n"))
+    end
+  end
+
   # Configure SpreedlyCore with a particular account.
   # Strongly prefers environment variables for credentials
   # and will issue a stern warning should they not be present.
@@ -60,6 +70,10 @@ module SpreedlyCore
     Base.gateway_token = gateway_token
   end
 
+  def self.gateway_token
+    Base.gateway_token
+  end
+
   # returns the configured SpreedlyCore login
   def self.login; Base.login; end
 

data/lib/{spreedly_core → spreedly-core-ruby}/base.rb

@@ -5,15 +5,16 @@ module SpreedlyCore
     
     # Net::HTTP::Options is configured to not have a body.
     # Lets give it the body it's always dreamed of
+    old_verbose, $VERBOSE = $VERBOSE, nil
     Net::HTTP::Options::RESPONSE_HAS_BODY = true
+    $VERBOSE = old_verbose
     
     format :xml
 
     # timeout requests after 10 seconds
     default_timeout 10
 
-    #base_uri "https://spreedlycore.com/#{API_VERSION}"
-    base_uri "http://core.spreedly.dev:11001/#{API_VERSION}"
+    base_uri "https://www.spreedlycore.com/#{API_VERSION}"
 
     def self.configure(login, secret, options = {})
       @@login = login
@@ -34,7 +35,7 @@ module SpreedlyCore
     # make a put request to path
     # If the request succeeds, provide the respones to the &block
     def self.verify_put(path, options={}, &block)
-      verify_request(:put, path, options,  &block)
+      verify_request(:put, path, options, 200, 422, &block)
     end
 
     # make a get request to path
@@ -70,6 +71,10 @@ module SpreedlyCore
         raise InvalidResponse.new(response, "Expected parsed response to contain key '#{options[:has_key]}'")
       end
 
+      if (response.code == 422 && !response.parsed_response.nil? && response.parsed_response.has_key?("errors"))
+        raise UnprocessableRequest.new(response.parsed_response["errors"]["error"])
+      end
+
       block.call(response).tap do |obj|
         obj.instance_variable_set("@http_code", response.code)
       end

data/lib/spreedly-core-ruby/gateway.rb

@@ -0,0 +1,59 @@
+module SpreedlyCore
+  class Gateway < Base
+    attr_reader(:name, :token, :gateway_type, :auth_modes, :supports_capture,
+                :supports_authorize, :supports_purchase, :supports_void,
+                :supports_credit, :redacted)
+
+    # returns an array of Gateway which are supported
+    def self.supported_gateways
+      verify_options("/gateways.xml") do |response|
+        response.parsed_response["gateways"]["gateway"].map{|h| new(h) }
+      end
+    end
+
+    # returns an array of all the Gateways owned by the account
+    def self.all
+      verify_get("/gateways.xml") do |response|
+        # will return Hash if only 1 gateways->gateway, Array otherwise
+        gateways =  begin
+                      response.parsed_response["gateways"]["gateway"]
+                    rescue
+                      nil
+                    end
+        if gateways
+          gateways = [gateways] unless gateways.is_a?(Array)
+          
+          return gateways.collect{|gateway_hash| new gateway_hash}
+        end
+      end
+
+      return []
+    end
+
+    def self.create(gateway_options)
+      raise ArgumentError.new("gateway_options must be a hash") unless gateway_options.is_a?(Hash)
+      
+      opts = {
+        :headers => {"Content-Type" => "application/xml"},
+        :body => gateway_options.to_xml(:root => :gateway, :dasherize => false),
+      }
+
+      verify_post("/gateways.xml", opts) do |response|
+        return new response.parsed_response["gateway"]
+      end
+    end
+
+    def initialize(attrs={})
+      attrs.merge!(attrs.delete("characteristics") || {})
+      super(attrs)
+    end
+
+    def use!
+      self.class.gateway_token = self.token
+    end
+
+    def ==(other)
+      self.token == other.token
+    end
+  end
+end

data/lib/{spreedly_core → spreedly-core-ruby}/payment_method.rb

@@ -25,6 +25,12 @@ module SpreedlyCore
       end
     end
 
+    def self.create(credit_card)
+      verify_post("/payment_methods.xml", :body => {:credit_card => credit_card}) do |response|
+        AddPaymentMethodTransaction.new(response.parsed_response["transaction"])
+      end
+    end
+
     # Create a new PaymentMethod based on the attrs hash and then validate
     def initialize(attrs={})
       super(attrs)
@@ -33,14 +39,14 @@ module SpreedlyCore
 
     # Retain the payment method
     def retain
-      verify_put("/payment_methods/#{token}/retain.xml", :body => {}, :has_key => "transaction") do |response|
+      self.class.verify_put("/payment_methods/#{token}/retain.xml", :body => {}, :has_key => "transaction") do |response|
         RetainTransaction.new(response.parsed_response["transaction"])
       end
     end
 
     # Redact the payment method
     def redact
-      verify_put("/payment_methods/#{token}/redact.xml", :body => {}, :has_key => "transaction") do |response|
+      self.class.verify_put("/payment_methods/#{token}/redact.xml", :body => {}, :has_key => "transaction") do |response|
         RedactTransaction.new(response.parsed_response["transaction"])
       end
     end
@@ -55,6 +61,18 @@ module SpreedlyCore
       purchase_or_authorize(:authorize, amount, currency, _gateway_token, ip_address)
     end
 
+    # Update the attributes of a payment method
+    def update(attributes)
+      opts = {
+        :headers => {"Content-Type" => "application/xml"},
+        :body => attributes.to_xml(:root => "payment_method", :dasherize => false)
+      }
+
+      self.class.verify_put("/payment_methods/#{token}.xml", opts) do |response|
+        PaymentMethod.new(response.parsed_response["payment_method"])
+      end
+    end
+
     # Returns the URL that CC data should be submitted to.
     def self.submit_url
       Base.base_uri + '/payment_methods'

data/lib/{spreedly_core → spreedly-core-ruby}/test_extensions.rb

@@ -38,24 +38,26 @@ module SpreedlyCore
   end
 
   class PaymentMethod
-
     # Call spreedly core to create a test token.
     # pass_through_data will be added as the "data" field.
     # 
-    def self.create_test_token(cc_data={}, pass_through_data=nil)
-      data = cc_data.merge(:redirect_url => "http://example.com",
-                           :api_login => SpreedlyCore::Base.login,
-                           :data => pass_through_data)
-      
-      response = self.post("/payment_methods", :body => data, :no_follow => true)
-    rescue HTTParty::RedirectionTooDeep => e
-      if e.response.body =~ /href="(.*?)"/
-        # rescuing the RedirectionTooDeep exception is apparently the way to
-        # handle redirect following
-        token = CGI::parse(URI.parse($1).query)["token"].first
+    def self.create_test_token(cc_overrides = {})
+      card = {
+        :first_name => "John",
+        :last_name => "Foo",
+        :card_type => :visa,
+        :number => '4111111111111111',
+        :verification_value => 123,
+        :month => 4,
+        :year => Time.now.year + 1
+      }
+      if cc_overrides.is_a?(Hash)
+        overrides = cc_overrides[:credit_card] || cc_overrides["credit_card"] || cc_overrides
+        card.merge!(overrides)
       end
-      raise "Could not find token in body: #{e.response.body}" if token.nil?
-      return token
+
+      pm = PaymentMethod.create(card)
+      pm.payment_method["token"]
     end
   end
 end

data/lib/spreedly-core-ruby/test_gateway.rb

@@ -0,0 +1,16 @@
+module SpreedlyCore
+  class TestGateway < Gateway
+    # gets a test gateway, creates if necessary
+    def self.get_or_create
+      # get the list of gateways and return the first test gateway
+      # if none exist, create one
+      gateways = Gateway.all
+      gateways.each do |g|
+        return g if g.gateway_type == "test" && g.redacted == false
+      end
+
+      # no test gateway yet, let's create one
+      return Gateway.create(:gateway_type => "test")
+    end
+  end
+end

data/lib/{spreedly_core → spreedly-core-ruby}/transactions.rb

@@ -138,5 +138,12 @@ module SpreedlyCore
     handles "Credit"
     attr_reader :reference_token
   end
+
+  class AddPaymentMethodTransaction < Transaction
+    include HasIpAddress
+
+    handles "AddPaymentMethod"
+    attr_reader :payment_method
+  end
   
 end

data/lib/{spreedly_core → spreedly-core-ruby}/version.rb

@@ -1,4 +1,4 @@
 module SpreedlyCore
-  Version = VERSION = "0.1.0"
+  Version = VERSION = "0.1.2"
   ApiVersion = API_VERSION = "v1"
 end

data/test/configuration_test.rb

@@ -4,23 +4,31 @@ module SpreedlyCore
   class ConfigureTest < Test::Unit::TestCase
 
     def test_configure
-      SpreedlyCore.configure :login => "test",
-                             :secret => "secret",
-                             :gateway_token => "token"
-  
-      SpreedlyCore.configure 'login' => 'test',
-                             'secret' => 'secret',
-                             'gateway_token' => 'token'
-  
-      SpreedlyCore.configure 'test', 'secret', 'token'
+      old_verbose, $VERBOSE = $VERBOSE, nil
+
+      old_login = ENV['SPREEDLYCORE_API_LOGIN']
+      old_secret = ENV['SPREEDLYCORE_API_SECRET']
+      ENV['SPREEDLYCORE_API_LOGIN'] = nil
+      ENV['SPREEDLYCORE_API_SECRET'] = nil
+
+      assert_nothing_raised ArgumentError do
+        SpreedlyCore.configure :api_login => "test",
+                               :api_secret => "secret",
+                               :gateway_token => "token"
+      end
   
       assert_raises ArgumentError do
         SpreedlyCore.configure
       end
 
-      assert_raises ArgumentError do
-        SpreedlyCore.configure {}
+      ENV['SPREEDLYCORE_API_LOGIN'] = old_login
+      ENV['SPREEDLYCORE_API_SECRET'] = old_secret
+
+      assert_nothing_raised ArgumentError do
+        SpreedlyCore.configure
       end
+    ensure
+      $VERBOSE = old_verbose
     end
     
   end

data/test/gateway_test.rb

@@ -0,0 +1,23 @@
+require 'test_common'
+
+module SpreedlyCore
+  class GatewayTest < Test::Unit::TestCase
+    include TestCommon
+
+    def test_gets_all
+      tg1 = TestGateway.get_or_create
+      all = Gateway.all
+      assert all.include?(tg1)
+
+      tg2 = Gateway.create(:gateway_type => 'test')
+      all = Gateway.all
+      [tg1, tg2].each{|g| assert all.include?(g)}
+    end
+    
+    def test_create_succeeds_for_test
+      assert_nothing_raised InvalidResponse do
+        Gateway.create(:gateway_type => 'test')
+      end
+    end
+  end
+end

data/test/spreedly_core_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test_common'
 
 
 # In order to run tests
@@ -6,14 +6,7 @@ require 'test_helper'
 #  2. Add your spreedly core credentials to test/config/spreedly_core.yml
 module SpreedlyCore
   class SpreedlyCoreTest < Test::Unit::TestCase
-    include TestHelper
-    include TestFactory
-  
-    def setup
-      config = YAML.load(File.read(File.dirname(__FILE__) + '/config/spreedly_core.yml'))
-      SpreedlyCore.configure(config)
-      PaymentMethod.reset_additional_required_cc_fields
-    end
+    include TestCommon
 
     def test_mocked_500_error
       with_disabled_network do

data/test/test_common.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+module SpreedlyCore
+  module TestCommon
+    include TestHelper
+    include TestFactory
+
+    def setup
+      raise "environment variables for SPREEDLYCORE_API_LOGIN and SPREEDLYCORE_API_SECRET must be set" unless ENV['SPREEDLYCORE_API_LOGIN'] && ENV['SPREEDLYCORE_API_SECRET']
+
+      SpreedlyCore.configure
+      unless SpreedlyCore.gateway_token
+        gateway = SpreedlyCore::TestGateway.get_or_create
+        gateway.use!
+      end
+
+      PaymentMethod.reset_additional_required_cc_fields
+    end
+  end
+end

data/test/test_factory.rb

@@ -1,9 +1,8 @@
 module SpreedlyCore
   module TestFactory
     def given_a_payment_method(cc_card=:master, card_options={})
-      token = PaymentMethod.create_test_token cc_data(cc_card, card_options), "customer-42"
-      assert payment_method = PaymentMethod.find(token)
-      assert_equal "customer-42", payment_method.data
+      token = PaymentMethod.create_test_token cc_data(cc_card, card_options)
+      assert payment_method = PaymentMethod.find(token), "Couldn't find payment method with token(#{token})"
       assert_equal token, payment_method.token
       payment_method
     end
@@ -92,7 +91,7 @@ module SpreedlyCore
       assert_equal credit_amount, credit.amount
       assert_equal ip_address, credit.ip
       assert credit.succeeded?
-      assert CreditTransaction, credit.class
+      assert_equal CreditTransaction, credit.class
       credit
     end
   end

data/test/test_helper.rb

@@ -8,8 +8,8 @@ Bundler.setup(:default, :development)
 Bundler.require(:default, :development)
 
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
-require 'spreedly_core'
-require 'spreedly_core/test_extensions'
+require 'spreedly-core-ruby'
+require 'spreedly-core-ruby/test_extensions'
 require 'test_factory'
 
 require 'webmock/test_unit'
@@ -20,6 +20,7 @@ require 'webmock'
 
 class Test::Unit::TestCase
   def assert_false(test, failure_message=nil)
+    failure_message = "" if failure_message.nil?
     assert(!test, failure_message)
   end
 

data/test/transaction_test.rb

@@ -1,15 +1,8 @@
-require 'test_helper'
+require 'test_common'
 
 module SpreedlyCore
   class TransactionTest < Test::Unit::TestCase
-    include TestHelper
-    include TestFactory
-  
-    def setup
-      config = YAML.load(File.read(File.dirname(__FILE__) + '/config/spreedly_core.yml'))
-      SpreedlyCore.configure(config)
-      PaymentMethod.reset_additional_required_cc_fields
-    end
+    include TestCommon
 
     def test_not_found_transaction
       assert_raises InvalidResponse do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spreedly-core-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-14 00:00:00.000000000Z
+date: 2012-03-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70176154487420 !ruby/object:Gem::Requirement
+  requirement: &70142956731160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -22,10 +22,32 @@ dependencies:
         version: 0.7.7
   type: :runtime
   prerelease: false
-  version_requirements: *70176154487420
+  version_requirements: *70142956731160
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70142956730560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70142956730560
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: &70142956730120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70142956730120
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &70176154486600 !ruby/object:Gem::Requirement
+  requirement: &70142956729500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70176154486600
+  version_requirements: *70142956729500
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70176154411740 !ruby/object:Gem::Requirement
+  requirement: &70142956728940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -44,10 +66,10 @@ dependencies:
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *70176154411740
+  version_requirements: *70142956728940
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70176154410180 !ruby/object:Gem::Requirement
+  requirement: &70142956728360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,8 +77,10 @@ dependencies:
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *70176154410180
-description: 
+  version_requirements: *70142956728360
+description: Spreedly Core is a cloud service that allows you to store credit cards
+  and run transactions against them, enabling you to accept payments on your website
+  while avoiding all liability and PCI compliance requirements.
 email: support@spreedly.com
 executables: []
 extensions: []
@@ -65,18 +89,19 @@ files:
 - README.md
 - Rakefile
 - LICENSE
-- lib/spreedly_core/base.rb
-- lib/spreedly_core/gateway.rb
-- lib/spreedly_core/payment_method.rb
-- lib/spreedly_core/test_extensions.rb
-- lib/spreedly_core/test_gateway.rb
-- lib/spreedly_core/transactions.rb
-- lib/spreedly_core/version.rb
-- lib/spreedly_core.rb
-- test/config/spreedly_core.yml.example
+- lib/spreedly-core-ruby/base.rb
+- lib/spreedly-core-ruby/gateway.rb
+- lib/spreedly-core-ruby/payment_method.rb
+- lib/spreedly-core-ruby/test_extensions.rb
+- lib/spreedly-core-ruby/test_gateway.rb
+- lib/spreedly-core-ruby/transactions.rb
+- lib/spreedly-core-ruby/version.rb
+- lib/spreedly-core-ruby.rb
 - test/configuration_test.rb
 - test/factories.rb
+- test/gateway_test.rb
 - test/spreedly_core_test.rb
+- test/test_common.rb
 - test/test_factory.rb
 - test/test_helper.rb
 - test/transaction_test.rb
@@ -92,22 +117,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2785672719963464473
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2785672719963464473
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
-summary: Ruby API for Spreedly Core
+summary: Ruby interface for Spreedly Core
 test_files: []
+has_rdoc: 

data/lib/spreedly_core/gateway.rb

@@ -1,23 +0,0 @@
-module SpreedlyCore
-  class Gateway < Base
-    attr_reader(:name, :token, :gateway_type, :auth_modes, :supports_capture,
-                :supports_authorize, :supports_purchase, :supports_void,
-                :supports_credit, :redacted)
-
-    # returns an array of Gateway which are supported
-    def self.supported_gateways
-      verify_options("/gateways.xml") do |response|
-        response.parsed_response["gateways"]["gateway"].map{|h| new(h) }
-      end
-    end
-
-    def initialize(attrs={})
-      attrs.merge!(attrs.delete("characteristics") || {})
-      super(attrs)
-    end
-
-    def use!
-      self.class.gateway_token = self.token
-    end
-  end
-end

data/lib/spreedly_core/test_gateway.rb

@@ -1,32 +0,0 @@
-module SpreedlyCore
-  class TestGateway < Gateway
-    # gets a test gateway, creates if necessary
-    def self.get_or_create
-      # get the list of gateways and return the first test gateway
-      # if none exist, create one
-      verify_get("/gateways.xml") do |response|
-        # will return Hash if only 1 gateways->gateway, Array otherwise
-        gateways = response.parsed_response["gateways"]["gateway"]
-        gateways = [gateways] unless gateways.is_a?(Array)
-        
-        gateways.each do |gateway_hash|
-          g = new gateway_hash
-          return g if g.gateway_type == "test" && g.redacted == false
-        end unless gateways.nil?
-      end
-
-      # no test gateway yet, let's create one
-      opts = {
-        :headers => {"Content-Type" => "application/xml"},
-        :body => '<gateway><gateway_type>test</gateway_type></gateway>'
-      }
-
-      verify_post("/gateways.xml", opts) do |response|
-        return new response.parsed_response["gateway"]
-      end
-
-      # HTTP 724
-      return nil
-    end
-  end
-end

data/test/config/spreedly_core.yml.example

@@ -1,3 +0,0 @@
-login: <Login Key>
-secret: <Secret Key>
-gateway_token: 'JncEWj22g59t3CRB1VnPXmUUgKc' # test gateway