beanstreamy 0.1.0 → 0.2.0

data/Rakefile

@@ -31,6 +31,7 @@ begin
     gemspec.email = "jeff@stage2.ca"
     gemspec.homepage = "http://github.com/jdsiegel/beanstreamy"
     gemspec.authors = ["Jeff Siegel"]
+    gemspec.add_dependency('activemerchant', '>= 1.5.1')
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: gem install jeweler"

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/beanstreamy.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{beanstreamy}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeff Siegel"]
-  s.date = %q{2010-06-16}
+  s.date = %q{2010-07-09}
   s.description = %q{Currently provides a helper method for rendering forms that will submit to the beanstream hosted payment gateway}
   s.email = %q{jeff@stage2.ca}
   s.extra_rdoc_files = [
@@ -27,7 +27,9 @@ Gem::Specification.new do |s|
      "generators/beanstreamy/templates/beanstreamy.rb",
      "init.rb",
      "lib/beanstreamy.rb",
+     "lib/beanstreamy/gateway.rb",
      "lib/beanstreamy/hosted_payment_helper.rb",
+     "lib/beanstreamy/util.rb",
      "lib/tasks/beanstreamy.rake",
      "test/beanstreamy_test.rb",
      "test/test_helper.rb"
@@ -47,9 +49,12 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activemerchant>, [">= 1.5.1"])
     else
+      s.add_dependency(%q<activemerchant>, [">= 1.5.1"])
     end
   else
+    s.add_dependency(%q<activemerchant>, [">= 1.5.1"])
   end
 end
 

data/generators/beanstreamy/templates/beanstreamy.rb

@@ -17,3 +17,6 @@ Beanstreamy.config.hash_key    = ""
 
 # If you use your own declined page, you can set that here:
 # Beanstreamy.config.declined_url = "/some/path"
+
+# If you use your own error page, you can set that here:
+# Beanstreamy.config.error_url = "/some/path"

data/lib/beanstreamy.rb

@@ -1,6 +1,6 @@
 module Beanstreamy
   class Config
-    attr_accessor :payment_url, :merchant_id, :hash_key, :approved_url, :declined_url
+    attr_accessor :payment_url, :merchant_id, :hash_key, :approved_url, :declined_url, :error_url
 
     def initialize
       @payment_url = "https://www.beanstream.com/scripts/payment/payment.asp"
@@ -11,6 +11,13 @@ module Beanstreamy
   @@config = Config.new
 end
 
-require 'beanstreamy/hosted_payment_helper'
+require 'active_merchant'
 
-ActionView::Base.send :include, Beanstreamy::HostedPaymentHelper
+require 'beanstreamy/util'
+require 'beanstreamy/gateway'
+
+if defined?(ActionView)
+  require 'beanstreamy/hosted_payment_helper'
+
+  ActionView::Base.send :include, Beanstreamy::HostedPaymentHelper
+end

data/lib/beanstreamy/gateway.rb

@@ -0,0 +1,59 @@
+require 'active_merchant/billing/gateways/beanstream'
+
+module Beanstreamy
+  module QueryAction
+    EXTRA_TRANSACTIONS = { :query => 'Q' }
+
+    CVD_CODES = ActiveMerchant::Billing::BeanstreamCore::CVD_CODES
+    AVS_CODES = ActiveMerchant::Billing::BeanstreamCore::AVS_CODES
+
+    def response_from_query(query_string)
+      response = parse(query_string)
+      build_response(success?(response), message_from(response), response,
+        :test => test? || response[:authCode] == "TEST",
+        :authorization => authorization_from(response),
+        :cvv_result => CVD_CODES[response[:cvdId]],
+        :avs_result => { :code => (AVS_CODES.include? response[:avsId]) ? AVS_CODES[response[:avsId]] : response[:avsId] }
+      )
+    end
+
+    def query(amount, options={})
+      requires!(options, :order_id)
+      
+      post = {}
+      add_order_number(post, options[:order_id])
+      add_amount(post, amount)
+      add_transaction_type(post, :query)
+      commit(post)
+    end
+
+    private
+
+    def add_transaction_type(post, action)
+      post[:trnType] = EXTRA_TRANSACTIONS[action] || super
+    end
+
+    def add_order_number(post, order_id)
+      post[:trnOrderNumber] = order_id
+    end
+  end
+
+  module HashValidation
+    private
+
+    def post_data(params)
+      params = super
+
+      hash_key = @options[:hash_key]
+      if hash_key
+        params += "&hashValue=#{CGI.escape(Util.hash_value(hash_key, params))}"
+      end
+      params
+    end
+  end
+
+  ActiveMerchant::Billing::BeanstreamGateway.class_eval do
+    include QueryAction
+    include HashValidation
+  end
+end

data/lib/beanstreamy/hosted_payment_helper.rb

@@ -12,34 +12,42 @@ module Beanstreamy
       hash_key = options.delete(:hash_key) || config.hash_key
       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)
+      extra_params = options.delete(:params)
+
+      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?
+      hashed_params << ["errorPage", error_url] if error_url.present?
+
+      if expire_at = options.delete(:expire_at)
+        hashed_params << ["hashExpiry", Util.hash_expiry(expire_at)]
+      end
+
+      hashed_params += Array(extra_params)
 
       form = content_tag(:form, options.merge(:action => config.payment_url, :method => "post")) do
-        concat hidden_field_tag("merchant_id", merchant_id)
-        concat hidden_field_tag("trnOrderNumber", order_id)
-        concat hidden_field_tag("trnAmount", amount)
-        if approved_url.present?
-          concat hidden_field_tag("approvedPage", approved_url)
-        end
-        if declined_url.present?
-          concat hidden_field_tag("declinedPage", declined_url)
+        hashed_params.each do |key, value|
+          concat hidden_field_tag(key, value)
         end
 
-        # 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_params = [
-          ["merchant_id", merchant_id],
-          ["trnOrderNumber", order_id],
-          ["trnAmount", amount],
-          ["approvedPage", approved_url],
-          ["declinedPage", declined_url]
-        ]
-        query_string = query_params.reject { |k,v| v.blank? }.map { |k,v| v.to_query(k) }.join('&')
-        hash_value = Digest::SHA1.hexdigest(query_string + hash_key)
+        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('&')
+          hash_value = Util.hash_value(hash_key, query_string)
 
-        concat hidden_field_tag("hashValue", hash_value)
+          concat hidden_field_tag("hashValue", hash_value)
+        end
 
         block.call(:hash_value => hash_value, :query_string => query_string)
       end
+
       concat form
     end
   end

data/lib/beanstreamy/util.rb

@@ -0,0 +1,13 @@
+module Beanstreamy
+  module Util
+    def self.hash_value(key, message)
+      Digest::SHA1.hexdigest(message + key)
+    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
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jeff Siegel
@@ -14,10 +14,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-16 00:00:00 -06:00
+date: 2010-07-09 00:00:00 -06:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activemerchant
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :runtime
+  version_requirements: *id001
 description: Currently provides a helper method for rendering forms that will submit to the beanstream hosted payment gateway
 email: jeff@stage2.ca
 executables: []
@@ -38,7 +51,9 @@ files:
 - generators/beanstreamy/templates/beanstreamy.rb
 - init.rb
 - lib/beanstreamy.rb
+- lib/beanstreamy/gateway.rb
 - lib/beanstreamy/hosted_payment_helper.rb
+- lib/beanstreamy/util.rb
 - lib/tasks/beanstreamy.rake
 - test/beanstreamy_test.rb
 - test/test_helper.rb