beanstreamy 0.2.1 → 0.2.2

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/beanstreamy.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{beanstreamy}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeff Siegel"]
-  s.date = %q{2010-07-09}
+  s.date = %q{2010-07-12}
   s.description = %q{Adds activemerchant gateway support for hash validation, querying transactions, and submitting payment via hosted forms}
   s.email = %q{jeff@stage2.ca}
   s.extra_rdoc_files = [

data/lib/beanstreamy/gateway.rb

@@ -29,6 +29,18 @@ module Beanstreamy
 
     private
 
+    def parse(body)
+      results = super
+
+      if results[:errorMessage]
+        results[:errorMessage].gsub!(/<LI>/, "")
+        results[:errorMessage].gsub!(/(\.)?<br>/, ". ")
+        results[:errorMessage].strip!
+      end
+
+      results
+    end
+
     def add_transaction_type(post, action)
       post[:trnType] = EXTRA_TRANSACTIONS[action] || super
     end

data/lib/beanstreamy/hosted_payment_helper.rb

@@ -4,21 +4,86 @@ module Beanstreamy
     mattr_accessor :config
     @@config = Beanstreamy.config
 
-    def beanstream_hosted_payment_form(options = {}, &block)
+    # Generate a form that will submit payment information to Beanstream's payment gateway 
+    # using the http POST method.
+    #
+    # === Hash Validation
+    #
+    # It's highly recommended you enable hash validation. Otherwise end-users will be able 
+    # to modify any information submitted to Beanstream, including the amount to be charged.
+    # You can specify the hash key with the +:hash_key+ option.
+    #
+    # (*Note*: Currently only SHA1 hashing is supported.)
+    #
+    # The +amount+ argument is expected to be an +Integer+ in cents, just like in ActiveMerchant.
+    #
+    # === Options
+    #
+    # [:merchant_id]
+    #   The merchant id of your Beanstream account. This is required. You can specify this in 
+    #   the beanstreamy initializer file
+    # [:hash_key]
+    #   The key used for SHA1 hash validation. You can specify this in the beanstreamy initializer file
+    # [:skip_hash]
+    #   If +true+, turn off hash validation. Default is +false+.
+    # [:approved_url]
+    #   The url that beanstream will redirect to for approved transactions
+    # [:declined_url]
+    #   The url that beanstream will redirect to for declined transactions
+    # [:error_url]
+    #   The url that beanstream will redirect to when there's validation errors with any of the submitted fields
+    # [:options]
+    #   A hash of extra gateway parameters such as billing address and subtotals. Uses the same 
+    #   format as gateway options in ActiveMerchant. You'll most likely want to specify the +:order_id+ option 
+    #   at a minimum.
+    #
+    # === Example
+    #
+    # <%= beanstream_hosted_payment_form 3456, :merchant_id => 454353534, :hash_key => "FK49Clk34Jd",
+    #                                          :options => {
+    #                                            :order_id => "R5564396848",
+    #                                            :email => "customer@example.com",
+    #                                            :billing_address => {
+    #                                              :name => "Reginald DeBillings",
+    #                                              :address1 => "15 Over There Rd",
+    #                                              :city => "Somecity",
+    #                                              :province => "AB",
+    #                                              :country => "CA",
+    #                                              :postal_code => "T6G1K7"
+    #                                            }
+    #                                          } %>
+    #   # Render fields needed for CC info
+    # <% end -%>
+    #
+    # In this example, it is assumed the billing information has been captured in a previous step. If you wanted to
+    # capture both billing information along with the CC info in one step, you would exclude it from the +:options+
+    # and render the appropriate fields.
+    #
+    # === TODO
+    #
+    # For rendered inputs, you need to specify the exact parameter names that Beanstream 
+    # expects (e.g. +trnCardNumber+). There should be some extra helper methods that abstracts these to be
+    # similar to the +options+ hash.
+    def beanstream_hosted_payment_form(amount, options = {}, &block)
+      amount = Util.amount(amount) # convert from cents to dollars
 
-      order_id = options.delete(:order_id) or raise("Missing order id")
-      amount = options.delete(:amount) or raise("Missing amount")
       merchant_id = options.delete(:merchant_id) || config.merchant_id
       hash_key = options.delete(:hash_key) || config.hash_key
+      skip_hash = options.delete(:skip_hash)
+
       approved_url = options.delete(:approved_url) || config.approved_url
       declined_url = options.delete(:declined_url) || config.declined_url
       error_url = options.delete(:error_url)
 
-      skip_hash = options.delete(:skip_hash)
+      gateway_options = options.delete(:options) || {}
+      gateway_params = {}
+      Util.add_address(gateway_params, gateway_options)
+      Util.add_invoice(gateway_params, gateway_options)
+
       extra_params = options.delete(:params)
 
+      # construct the parameter list
       hashed_params = [["merchant_id", merchant_id],
-                       ["trnOrderNumber", order_id],
                        ["trnAmount", amount]]
       hashed_params << ["approvedPage", approved_url] if approved_url.present?
       hashed_params << ["declinedPage", declined_url] if declined_url.present?
@@ -28,18 +93,19 @@ module Beanstreamy
         hashed_params << ["hashExpiry", Util.hash_expiry(expire_at)]
       end
 
+      hashed_params += Array(gateway_params)
       hashed_params += Array(extra_params)
 
       form = content_tag(:form, options.merge(:action => config.payment_url, :method => "post")) do
         hashed_params.each do |key, value|
-          concat hidden_field_tag(key, value)
+          concat hidden_field_tag(key, value) if value
         end
 
         hash_value = nil
         if hash_key.present? && !skip_hash
           # Beansream's hosted page uses hash validation to prevent price modification. This hash is computed from
           # the url encoded string of the above inputs
-          query_string = hashed_params.reject { |k,v| v.blank? }.map { |k,v| v.to_query(k) }.join('&')
+          query_string = hashed_params.reject { |k,v| !v }.map { |k,v| v.to_query(k) }.join('&')
           hash_value = Util.hash_value(hash_key, query_string)
 
           concat hidden_field_tag("hashValue", hash_value)

data/lib/beanstreamy/util.rb

@@ -1,13 +1,67 @@
 module Beanstreamy
   module Util
+
     def self.hash_value(key, message)
       Digest::SHA1.hexdigest(message + key)
     end
 
+    def self.amount(cents)
+      sprintf("%.2f", cents.to_f / 100)
+    end
+
     def self.hash_expiry(expire_at)
       # Beanstream uses PST/PDT for all their timestamps. Time stamps only have minute resolution,
       # so the seconds need chopping off.
       expire_at.in_time_zone("Pacific Time (US & Canada)").to_s(:number)[0..-3]
     end
+
+    def self.add_address(params, options)
+      prepare_address_for_non_american_countries(options)
+      
+      if billing_address = options[:billing_address] || options[:address]
+        params[:ordName]          = billing_address[:name]
+        params[:ordEmailAddress]  = options[:email]
+        params[:ordPhoneNumber]   = billing_address[:phone]
+        params[:ordAddress1]      = billing_address[:address1]
+        params[:ordAddress2]      = billing_address[:address2]
+        params[:ordCity]          = billing_address[:city]
+        params[:ordProvince]      = billing_address[:province]    || billing_address[:state]
+        params[:ordPostalCode]    = billing_address[:postal_code] || billing_address[:zip]
+        params[:ordCountry]       = billing_address[:country]
+      end
+
+      if shipping_address = options[:shipping_address]
+        params[:shipName]         = shipping_address[:name]
+        params[:shipEmailAddress] = options[:email]
+        params[:shipPhoneNumber]  = shipping_address[:phone]
+        params[:shipAddress1]     = shipping_address[:address1]
+        params[:shipAddress2]     = shipping_address[:address2]
+        params[:shipCity]         = shipping_address[:city]
+        params[:shipProvince]     = shipping_address[:province]    || shipping_address[:state]
+        params[:shipPostalCode]   = shipping_address[:postal_code] || shipping_address[:zip]
+        params[:shipCountry]      = shipping_address[:country]
+        params[:shippingMethod]   = shipping_address[:shipping_method]
+        params[:deliveryEstimate] = shipping_address[:delivery_estimate]
+      end
+    end
+
+    def self.prepare_address_for_non_american_countries(options)
+      [ options[:billing_address], options[:shipping_address] ].compact.each do |address|
+        unless ['US', 'CA'].include?(address[:country])
+          address[:province] = '--'
+          address[:postal_code]   = '000000' unless address[:postal_code] || address[:zip]
+        end
+      end
+    end
+
+    def self.add_invoice(params, options)
+      params[:trnOrderNumber]   = options[:order_id]
+      params[:trnComments]      = options[:description]
+      params[:ordItemPrice]     = amount(options[:subtotal])
+      params[:ordShippingPrice] = amount(options[:shipping])
+      params[:ordTax1Price]     = amount(options[:tax1] || options[:tax])
+      params[:ordTax2Price]     = amount(options[:tax2])
+      params[:ref1]             = options[:custom]
+    end
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Jeff Siegel
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-09 00:00:00 -06:00
+date: 2010-07-12 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency