spreedly-core-ruby 0.2.0 → 0.2.1

data/lib/spreedly-core-ruby.rb

@@ -21,9 +21,9 @@ module SpreedlyCore
   }
 
   class Error < RuntimeError; end
-  
+
   # Custom exception which occurs when a request to SpreedlyCore times out
-  # See SpreedlyCore::Base.default_timeout 
+  # See SpreedlyCore::Base.default_timeout
   class TimeOutError < Error; end
   class InvalidResponse < Error
     def initialize(response, message)
@@ -37,7 +37,7 @@ module SpreedlyCore
     def initialize(errors)
       errors = [errors] unless errors.is_a?(Array)
       @errors = errors
-      
+
       super(errors.join("\n"))
     end
   end
@@ -75,6 +75,9 @@ module SpreedlyCore
     if login.nil? || secret.nil?
       raise ArgumentError.new("You must provide a login and a secret. Gem will look for ENV['SPREEDLYCORE_API_LOGIN'] and ENV['SPREEDLYCORE_API_SECRET'], but you may also pass in a hash with :api_login and :api_secret keys.")
     end
+
+    options[:endpoint] ||= "https://spreedlycore.com/#{SpreedlyCore::API_VERSION}"
+
     Base.configure(login, secret, options)
   end
 
@@ -93,6 +96,6 @@ module SpreedlyCore
   class Response < Base
     attr_reader(:success, :message, :avs_code, :avs_message, :cvv_code,
                 :cvv_message, :error_code, :error_detail, :created_at,
-                :updated_at) 
+                :updated_at)
   end
 end

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

@@ -4,23 +4,22 @@ module SpreedlyCore
   # Base class for all SpreedlyCore API requests
   class Base
     include HTTParty
-    
+
     # 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/#{SpreedlyCore::API_VERSION}"
-
     def self.configure(login, secret, options = {})
       @@login = login
       self.basic_auth(@@login, secret)
+      base_uri options[:endpoint]
       @@gateway_token = options.delete(:gateway_token)
     end
 
@@ -31,7 +30,7 @@ module SpreedlyCore
     # make a post request to path
     # If the request succeeds, provide the respones to the &block
     def self.verify_post(path, options={}, &block)
-      verify_request(:post, path, options, 200, 201, 422, &block)
+      verify_request(:post, path, options, 200, 201, 202, 422, &block)
     end
 
     # make a put request to path
@@ -58,12 +57,12 @@ module SpreedlyCore
     # If *allowed_codes is empty, don't check the response code, but set an instance
     # variable on the object created in the block containing the response code.
     def self.verify_request(request_type, path, options, *allowed_codes, &block)
-      begin 
+      begin
         response = self.send(request_type, path, options)
       rescue Timeout::Error, Errno::ETIMEDOUT => e
         raise TimeOutError.new("Request to #{path} timed out. Is Spreedly Core down?")
       end
-        
+
       if allowed_codes.any? && !allowed_codes.include?(response.code)
         raise InvalidResponse.new(response, "Error retrieving #{path}. Got status of #{response.code}. Expected status to be in #{allowed_codes.join(",")}")
       end
@@ -89,7 +88,7 @@ module SpreedlyCore
       attrs.each do |k, v|
         instance_variable_set("@#{k}", v)
       end
-      # errors may be nil, empty, a string, or an array of strings. 
+      # errors may be nil, empty, a string, or an array of strings.
       @errors = if @errors.nil? || @errors["error"].blank?
                   []
                 elsif @errors["error"].is_a?(String)

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

@@ -1,9 +1,9 @@
 module SpreedlyCore
   class PaymentMethod < Base
-    attr_reader( :address1, :address2, :card_type, :city, :country, :created_at,
-                 :data, :email, :errors, :first_name, :last_four_digits,
-                 :last_name, :month, :number, :payment_method_type, :phone_number,
-                 :state, :token, :updated_at, :verification_value, :year, :zip)
+    attr_reader :address1, :address2, :card_type, :city, :country, :created_at,
+                :data, :email, :errors, :first_name, :last_four_digits,
+                :last_name, :month, :number, :payment_method_type, :phone_number,
+                :state, :token, :updated_at, :verification_value, :year, :zip
 
     # configure additional required fiels. Like :address1, :city, :state
     def self.additional_required_cc_fields *fields
@@ -18,7 +18,7 @@ module SpreedlyCore
 
     # Lookup the PaymentMethod by token
     def self.find(token)
-      return nil if token.nil? 
+      return nil if token.nil?
       verify_get("/payment_methods/#{token}.xml",
                  :has_key => "payment_method") do |response|
         new(response.parsed_response["payment_method"])
@@ -26,7 +26,7 @@ module SpreedlyCore
     end
 
     def self.create(credit_card)
-      verify_post("/payment_methods.xml", :body => {:credit_card => credit_card}) do |response|
+      verify_post("/payment_methods.xml", :body => {:payment_method => { :credit_card => credit_card }}) do |response|
         AddPaymentMethodTransaction.new(response.parsed_response["transaction"])
       end
     end
@@ -52,13 +52,13 @@ module SpreedlyCore
     end
 
     # Make a purchase against the payment method
-    def purchase(amount, currency=nil, _gateway_token=nil, ip_address=nil)
-      purchase_or_authorize(:purchase, amount, currency, _gateway_token, ip_address)
+    def purchase(amount, *args)
+      purchase_or_authorize(:purchase, amount, *args)
     end
 
     # Make an authorize against payment method. You can then later capture against the authorize
-    def authorize(amount, currency=nil,  _gateway_token=nil, ip_address=nil)
-      purchase_or_authorize(:authorize, amount, currency, _gateway_token, ip_address)
+    def authorize(amount, *args)
+      purchase_or_authorize(:authorize, amount, *args)
     end
 
     # Update the attributes of a payment method
@@ -82,13 +82,7 @@ module SpreedlyCore
       @errors.empty?
     end
 
-
-
-
-protected
-
-
-
+    protected
 
     # Validate additional cc fields like first_name, last_name, etc when
     # configured to do so
@@ -103,27 +97,39 @@ protected
                           else
                             str_field.split("_").join(" ")
                           end
-                            
+
           @errors << "#{friendly_name.capitalize} can't be blank"
         end
       end
       @errors = @errors.sort
     end
 
-    def purchase_or_authorize(tran_type, amount, currency, _gateway_token, ip_address)
+    def purchase_or_authorize(tran_type, amount, *args)
+      options = if(args.size == 1 && args.first.kind_of?(Hash))
+        args.first
+      else
+        {
+          :currency => args[0],
+          :gateway_token => args[1],
+          :ip_address => args[2]
+        }
+      end
+
       transaction_type = tran_type.to_s
       raise "Unknown transaction type" unless %w{purchase authorize}.include?(transaction_type)
 
-      currency ||= "USD"
-      _gateway_token ||= self.class.gateway_token
-      path = "/gateways/#{_gateway_token}/#{transaction_type}.xml"
+      currency = (options[:currency] || "USD")
+      gateway_token = (options[:gateway_token] || self.class.gateway_token)
+      path = "/gateways/#{gateway_token}/#{transaction_type}.xml"
       data = {
         :transaction => {
-          :transaction_type => transaction_type, 
+          :transaction_type => transaction_type,
           :payment_method_token => token,
           :amount => amount,
           :currency_code => currency,
-          :ip => ip_address
+          :ip => options[:ip_address],
+          :redirect_url => options[:redirect_url],
+          :callback_url => options[:callback_url]
         }
       }
       self.class.verify_post(path, :body => data,

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

@@ -3,7 +3,7 @@ module SpreedlyCore
   class Transaction < Base
     attr_reader(:amount, :on_test_gateway, :created_at, :updated_at, :currency_code,
                 :succeeded, :token, :message, :transaction_type, :gateway_token,
-                :response)
+                :response, :signed, :state, :checkout_url)
     alias :succeeded? :succeeded
 
     # Breaks enacapsulation a bit, but allow subclasses to register the 'transaction_type'
@@ -15,35 +15,65 @@ module SpreedlyCore
 
     # Lookup the transaction by its token. Returns the correct subclass
     def self.find(token)
-      return nil if token.nil? 
+      return nil if token.nil?
       verify_get("/transactions/#{token}.xml", :has_key => "transaction") do |response|
         attrs = response.parsed_response["transaction"]
         klass = @@transaction_type_to_class[attrs["transaction_type"]] || self
-        klass.new(attrs)
+        klass.new(attrs).tap do |transaction|
+          transaction.verified!
+        end
       end
     end
+
+    def initialize(attrs={})
+      super
+      if(valid_signature?)
+        verified!
+      end
+    end
+
+    def verified!
+      @verified = true
+    end
+
+    def verified?
+      @verified
+    end
+
+    def pending?
+      state == "pending"
+    end
+
+    def valid_signature?
+      return false unless signed
+      fields = signed["fields"]
+      data = fields.collect do |field|
+        self.instance_variable_get("@#{field}")
+      end.join("|")
+      (OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new(signed["algorithm"], SpreedlyCore::Base.secret, data)) == signed["signature"])
+    end
   end
 
   class RetainTransaction < Transaction
     handles "RetainPaymentMethod"
     attr_reader :payment_method
-    
+
     def initialize(attrs={})
       @payment_method = PaymentMethod.new(attrs.delete("payment_method") || {})
       super(attrs)
     end
   end
-  
+
   class RedactTransaction < Transaction
     handles "RedactPaymentMethod"
     attr_reader :payment_method
-    
+
     def initialize(attrs={})
       @payment_method = PaymentMethod.new(attrs.delete("payment_method") || {})
       super(attrs)
     end
   end
-  
+
   module NullifiableTransaction
     # Void is used to cancel out authorizations and, with some gateways, to
     # cancel actual payment transactions within the first 24 hours
@@ -52,13 +82,13 @@ module SpreedlyCore
       self.class.verify_post("/transactions/#{token}/void.xml",
                              :body => body, :has_key => "transaction") do |response|
         VoidedTransaction.new(response.parsed_response["transaction"])
-      end      
+      end
     end
 
     # Credit amount. If amount is nil, then credit the entire previous purchase
-    # or captured amount 
+    # or captured amount
     def credit(amount=nil, ip_address=nil)
-      body = if amount.nil? 
+      body = if amount.nil?
                {:ip => ip_address}
              else
                {:transaction => {:amount => amount, :ip => ip_address}}
@@ -76,10 +106,10 @@ module SpreedlyCore
 
   class AuthorizeTransaction < Transaction
     include HasIpAddress
-    
+
     handles "Authorization"
     attr_reader :payment_method
-    
+
     def initialize(attrs={})
       @payment_method = PaymentMethod.new(attrs.delete("payment_method") || {})
       @response = Response.new(attrs.delete("response") || {})
@@ -120,21 +150,21 @@ module SpreedlyCore
   class CaptureTransaction < Transaction
     include NullifiableTransaction
     include HasIpAddress
-    
+
     handles "Capture"
     attr_reader :reference_token
   end
 
   class VoidedTransaction < Transaction
     include HasIpAddress
-    
+
     handles "Void"
     attr_reader :reference_token
   end
 
   class CreditTransaction < Transaction
     include HasIpAddress
-    
+
     handles "Credit"
     attr_reader :reference_token
   end
@@ -145,5 +175,5 @@ module SpreedlyCore
     handles "AddPaymentMethod"
     attr_reader :payment_method
   end
-  
+
 end

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spreedly-core-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-26 00:00:00.000000000 Z
+date: 2012-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70095372683980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,15 @@ dependencies:
         version: '0.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70095372683980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70095372705660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +38,15 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70095372705660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &70095372702860 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +54,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70095372702860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &70095372715820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,21 +70,31 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70095372715820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70095372761540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *70095372761540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70095372768840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,7 +102,12 @@ dependencies:
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *70095372768840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.2
 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.
@@ -117,15 +147,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3960261074814685909
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3960261074814685909
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby interface for Spreedly Core