global_collect 0.4.0 → 0.5.0

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/examples/recurring_do_payment.rb

@@ -70,15 +70,14 @@ puts "This is a multi-stage example. Please read the source for instructions."
 # response  = client.make_request(
 #   GlobalCollect::Requests::DoPayment.new(
 #     [
-#       GlobalCollect::RequestModels::DoPayment::RecurringPayment.new(
+#       GlobalCollect::RequestModels::DoPayment::RecurringCreditCardOnlinePayment.new(
 #         "MERCHANTREFERENCE" => "1231147777",
 #         "ORDERID"           => "7777",
 #         "EFFORTID"          => "2", # increment implied EFFORTID of 1 from IOWP
-#         "PAYMENTPRODUCTID"  => "3",
-#         "AMOUNT"            => "50",
-#         "CURRENCYCODE"      => "GBP"
+#         "AMOUNT"            => "1400",
+#         "CURRENCYCODE"      => "USD"
 #       ),
-#       GlobalCollect::Builders::DoPayment::RecurringPayment
+#       GlobalCollect::Builders::DoPayment::RecurringCreditCardOnlinePayment
 #     ]
 #   )
 # )

data/global_collect.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{global_collect}
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Timon Karnezos"]
-  s.date = %q{2010-09-23}
+  s.date = %q{2010-09-27}
   s.description = %q{Gives minimally intrusive access to Global Collect's payment processing API. 
 Currently implements a very small segment of the full API but is built with 
 extensibility in mind.
@@ -41,6 +41,7 @@ extensibility in mind.
      "lib/global_collect.rb",
      "lib/global_collect/api_client.rb",
      "lib/global_collect/builders/do_payment/payment.rb",
+     "lib/global_collect/builders/do_payment/recurring_credit_card_online_payment.rb",
      "lib/global_collect/builders/do_payment/recurring_payment.rb",
      "lib/global_collect/builders/do_refund/credit_card_payment.rb",
      "lib/global_collect/builders/do_refund/payment.rb",
@@ -64,6 +65,7 @@ extensibility in mind.
      "lib/global_collect/log_parsing/payment_report/report_file.rb",
      "lib/global_collect/request_models/base.rb",
      "lib/global_collect/request_models/do_payment/payment.rb",
+     "lib/global_collect/request_models/do_payment/recurring_credit_card_online_payment.rb",
      "lib/global_collect/request_models/do_payment/recurring_payment.rb",
      "lib/global_collect/request_models/do_refund/credit_card_payment.rb",
      "lib/global_collect/request_models/do_refund/payment.rb",
@@ -118,6 +120,7 @@ extensibility in mind.
      "spec/log_parsing/payment_report/parser_spec.rb",
      "spec/log_parsing/payment_report/report_file_spec.rb",
      "spec/request_models/base_spec.rb",
+     "spec/request_models/do_payment/recurring_credit_card_online_payment_spec.rb",
      "spec/request_models/do_payment/recurring_payment_spec.rb",
      "spec/request_models/do_refund/paypal_payment_spec.rb",
      "spec/request_models/insert_order_with_payment/hosted_credit_card_online_payment_spec.rb",
@@ -185,6 +188,7 @@ extensibility in mind.
      "spec/log_parsing/payment_report/parser_spec.rb",
      "spec/log_parsing/payment_report/report_file_spec.rb",
      "spec/request_models/base_spec.rb",
+     "spec/request_models/do_payment/recurring_credit_card_online_payment_spec.rb",
      "spec/request_models/do_payment/recurring_payment_spec.rb",
      "spec/request_models/do_refund/paypal_payment_spec.rb",
      "spec/request_models/insert_order_with_payment/hosted_credit_card_online_payment_spec.rb",

data/lib/global_collect/builders/do_payment/recurring_credit_card_online_payment.rb

@@ -0,0 +1,4 @@
+module GlobalCollect::Builders::DoPayment
+  class RecurringCreditCardOnlinePayment < RecurringPayment
+  end
+end

data/lib/global_collect/request_models/do_payment/recurring_credit_card_online_payment.rb

@@ -0,0 +1,22 @@
+module GlobalCollect::RequestModels::DoPayment
+  class RecurringCreditCardOnlinePayment < RecurringPayment
+    def initialize(attributes)
+      super(attributes)
+      @attributes["CVVINDICATOR"] = "8"
+    end
+    def suggested_response_mixins
+      super + [GlobalCollect::Responses::DoPayment::CreditCardResponseMethods]
+    end
+    def fields
+      #
+      # Per # WDL §5.13 "Create Additional Payments" section, the CVVINDICATOR
+      # must be 8 for recurring payments.
+      #
+      super.merge({
+        "CVVINDICATOR" => ["N1", "R"]
+      })
+    end
+  end
+end
+
+

data/lib/global_collect/request_models/do_payment/recurring_payment.rb

@@ -1,13 +1,15 @@
 module GlobalCollect::RequestModels::DoPayment
   class RecurringPayment < Payment
-    def suggested_response_mixins
-      super + [GlobalCollect::Responses::DoPayment::CreditCardResponseMethods]
-    end
     def fields
       # A recurring payment will never have the default EFFORTID of '1', hence
       # it is a required field.
+      #
+      # Also, a recurring payment recalls the existing payment information on
+      # the order, thus does not require a PAYMENTPRODUCTID, per # WDL §5.13
+      # "Variable amount recurring order payments" section.
       super.merge({
-        "EFFORTID" => ["N5", "R"]
+        "EFFORTID"         => ["N5", "R"],
+        "PAYMENTPRODUCTID" => ["N5", "O"]
       })
     end
   end

data/lib/global_collect/request_models/insert_order_with_payment/recurring_order.rb

@@ -4,6 +4,14 @@ module GlobalCollect::RequestModels::InsertOrderWithPayment
       super(attributes)
       # WDL Appendix F specifies the recurring order type as '4'
       @attributes["ORDERTYPE"] = "4"
+      # WDL Appendix F specifies the recurring order should have STEPMONTH
+      # set to a filler value. They say a default of "120" is fine.
+      @attributes["STEPMONTH"] ||= "120"
+    end
+    def fields
+      super.merge({
+        "STEPMONTH" => ["N5", "R"]
+      })
     end
   end
 end

data/lib/global_collect.rb

@@ -18,6 +18,7 @@ lib_dir = File.dirname(__FILE__)
   %w[api_client]                                                                          ,
   %w[builders do_payment payment]                                                         ,
   %w[builders do_payment recurring_payment]                                               ,
+  %w[builders do_payment recurring_credit_card_online_payment]                            ,
   %w[builders do_refund payment]                                                          ,
   %w[builders do_refund credit_card_payment]                                              ,
   %w[builders insert_order_with_payment order]                                            ,
@@ -47,6 +48,7 @@ lib_dir = File.dirname(__FILE__)
   %w[request_models insert_order_with_payment recurring_hosted_credit_card_online_payment],
   %w[request_models do_payment payment]                                                   ,
   %w[request_models do_payment recurring_payment]                                         ,
+  %w[request_models do_payment recurring_credit_card_online_payment]                      ,
   %w[request_models do_refund payment]                                                    ,
   %w[request_models do_refund credit_card_payment]                                        ,
   %w[request_models do_refund paypal_payment]                                             ,

data/spec/request_models/do_payment/recurring_credit_card_online_payment_spec.rb

@@ -0,0 +1,39 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe "the DO_PAYMENT recurring credit card online payment model" do
+  it "should force CVVINDICATOR to '8' when not provided" do
+    model = GlobalCollect::RequestModels::DoPayment::RecurringCreditCardOnlinePayment.new({
+      "MERCHANTREFERENCE" => "aasfd",
+      "ORDERID"           => "123",
+      "PAYMENTPRODUCTID"  => "1",
+      "AMOUNT"            => "123",
+      "EFFORTID"          => "2",
+      "CURRENCYCODE"      => "USD"
+    })
+    model['CVVINDICATOR'].should == "8"
+  end
+  it "should force CVVINDICATOR to '8' when something invalid is provided" do
+    model = GlobalCollect::RequestModels::DoPayment::RecurringCreditCardOnlinePayment.new({
+      "MERCHANTREFERENCE" => "aasfd",
+      "ORDERID"           => "123",
+      "PAYMENTPRODUCTID"  => "1",
+      "AMOUNT"            => "123",
+      "EFFORTID"          => "2",
+      "CURRENCYCODE"      => "USD",
+      "CVVINDICATOR"      => "11111111111111"
+    })
+    model['CVVINDICATOR'].should == "8"
+  end
+  it "should force CVVINDICATOR to '8' when something wrong is provided" do
+    model = GlobalCollect::RequestModels::DoPayment::RecurringCreditCardOnlinePayment.new({
+      "MERCHANTREFERENCE" => "aasfd",
+      "ORDERID"           => "123",
+      "PAYMENTPRODUCTID"  => "1",
+      "AMOUNT"            => "123",
+      "EFFORTID"          => "2",
+      "CURRENCYCODE"      => "USD",
+      "CVVINDICATOR"      => "1"
+    })
+    model['CVVINDICATOR'].should == "8"
+  end
+end

data/spec/request_models/do_payment/recurring_payment_spec.rb

@@ -1,7 +1,7 @@
 require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
 
 describe "the DO_PAYMENT recurring payment model" do
-  it "should not allow blank EFFORT_ID" do
+  it "should not allow blank EFFORTID" do
     GlobalCollect::RequestModels::DoPayment::RecurringPayment.new({
       "MERCHANTREFERENCE" => "aasfd",
       "ORDERID"           => "123",
@@ -10,4 +10,13 @@ describe "the DO_PAYMENT recurring payment model" do
       "CURRENCYCODE"      => "USD"
     }).validate.should be_false
   end
+  it "should allow blank PAYMENTPRODUCTID" do
+    GlobalCollect::RequestModels::DoPayment::RecurringPayment.new({
+      "MERCHANTREFERENCE" => "aasfd",
+      "ORDERID"           => "123",
+      "EFFORTID"          => "2",
+      "AMOUNT"            => "123",
+      "CURRENCYCODE"      => "USD"
+    }).validate.should be_true
+  end
 end

data/spec/request_models/insert_order_with_payment/recurring_order_spec.rb

@@ -35,4 +35,27 @@ describe GlobalCollect::RequestModels::InsertOrderWithPayment::RecurringOrder do
     )
     model["ORDERTYPE"].should == "4"
   end
+
+  it "should set STEPMONTH to '120' when not provided" do
+    model = GlobalCollect::RequestModels::InsertOrderWithPayment::RecurringOrder.new(
+      "ORDERID"      => "1",
+      "AMOUNT"       => "1",
+      "CURRENCYCODE" => "USD",
+      "LANGUAGECODE" => "en",
+      "COUNTRYCODE"  => "US"
+    )
+    model["STEPMONTH"].should == "120"
+  end
+
+  it "should not overwrite STEPMONTH whe provided" do
+    model = GlobalCollect::RequestModels::InsertOrderWithPayment::RecurringOrder.new(
+      "ORDERID"      => "1",
+      "AMOUNT"       => "1",
+      "CURRENCYCODE" => "USD",
+      "LANGUAGECODE" => "en",
+      "COUNTRYCODE"  => "US",
+      "STEPMONTH"    => "1"
+    )
+    model["STEPMONTH"].should == "1"
+  end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Timon Karnezos
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-23 00:00:00 -07:00
+date: 2010-09-27 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -118,6 +118,7 @@ files:
 - lib/global_collect.rb
 - lib/global_collect/api_client.rb
 - lib/global_collect/builders/do_payment/payment.rb
+- lib/global_collect/builders/do_payment/recurring_credit_card_online_payment.rb
 - lib/global_collect/builders/do_payment/recurring_payment.rb
 - lib/global_collect/builders/do_refund/credit_card_payment.rb
 - lib/global_collect/builders/do_refund/payment.rb
@@ -141,6 +142,7 @@ files:
 - lib/global_collect/log_parsing/payment_report/report_file.rb
 - lib/global_collect/request_models/base.rb
 - lib/global_collect/request_models/do_payment/payment.rb
+- lib/global_collect/request_models/do_payment/recurring_credit_card_online_payment.rb
 - lib/global_collect/request_models/do_payment/recurring_payment.rb
 - lib/global_collect/request_models/do_refund/credit_card_payment.rb
 - lib/global_collect/request_models/do_refund/payment.rb
@@ -195,6 +197,7 @@ files:
 - spec/log_parsing/payment_report/parser_spec.rb
 - spec/log_parsing/payment_report/report_file_spec.rb
 - spec/request_models/base_spec.rb
+- spec/request_models/do_payment/recurring_credit_card_online_payment_spec.rb
 - spec/request_models/do_payment/recurring_payment_spec.rb
 - spec/request_models/do_refund/paypal_payment_spec.rb
 - spec/request_models/insert_order_with_payment/hosted_credit_card_online_payment_spec.rb
@@ -286,6 +289,7 @@ test_files:
 - spec/log_parsing/payment_report/parser_spec.rb
 - spec/log_parsing/payment_report/report_file_spec.rb
 - spec/request_models/base_spec.rb
+- spec/request_models/do_payment/recurring_credit_card_online_payment_spec.rb
 - spec/request_models/do_payment/recurring_payment_spec.rb
 - spec/request_models/do_refund/paypal_payment_spec.rb
 - spec/request_models/insert_order_with_payment/hosted_credit_card_online_payment_spec.rb