paypal-business 0.0.3

data/Manifest.txt

@@ -0,0 +1,15 @@
+CHANGELOG.txt
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+setup.rb
+lib/paypal-business.rb
+lib/paypal-business/version.rb
+lib/paypal-business/PayPalAPIInterfaceServiceClient.rb
+lib/paypal-business/api_cert_chain.crt
+lib/paypal-business/api_cert_chain.pem
+lib/paypal-business/default.rb
+lib/paypal-business/defaultDriver.rb
+lib/paypal-business/paypal.rb
+test/test_helper.rb

data/README.txt

@@ -0,0 +1,212 @@
+Ruby on Rails PayPal Plugin v1.4
+  by Andre Price and David Stevenson, ELC Technologies
+Based off of the PayPal Web Services Example by Will C
+PayPal Business Gem-
+----------------------
+This package implements various paypal merchant actions.  They are intended to e used at a level transparent to parent applications.  Therefore the express check out and other actions that link to and back from paypal's site are curently not implemented.  These actions return a response packet that the user can process as they see fit.
+
+
+Requirements-
+----------------------
+Valid PayPal Business Account ( or Developer account for testing) -- Instructions for setting up developer account below.
+Soap4r -- Install the latest from http://dev.ctor.org/soap4r.
+
+
+Getting Developer Account and needed certificates
+----------------------
+  Visit https://developer.paypal.com
+  Create an account( remember name and password)
+  Login and select the sandbox
+  Select Create an Account and follow the steps to create a premier account (remember name and password)
+  Once created launch the account via the sandbox site
+  Click on the Profile tab in the My Account section
+  CLick on API Access and request a direct access certificate
+  Download and install certificats as indicated below.
+
+Installation-
+----------------------
+  1) Install GEM 
+
+  4) Obtain the api chain cert from PayPal. Save this to:
+     lib/api_cert_chain.crt
+     This file is obtainable through their SDK downloads at http://developer.paypal.com.
+  
+  5) Obtain a crt/key pair for your sandbox account and save to:
+	sandbox_api.crt
+	sandbox_api.key
+
+  6) Obtain a crt/key pair for your live account and save to:
+	live_api.crt
+	live_api.key
+
+  7) Edit paypal/lib/paypal.rb. Replace 'SANDBOX_ACCOUNT_NAME' with the account 
+     name that was created  for your sandbox account api access.
+
+  8) Edit paypal/lib/paypal.rb. Replace 'SANDBOX_ACCOUNT_PASS' with the account 
+     password for the sandbox api.
+ 
+  9) Repeat the for live account and password:
+	change 'LIVE_ACCOUNT_NAME' and 'LIVE_ACCOUNT_PASSWD'
+
+
+  10) Edit paypal/test/paypal_test.rb.
+    a) Replace the variables in good_params with known good parameters
+        i)Credit card numbers can be "genereated" trough paypal by using the
+           sandbox to add credit cards to your test account. 
+           (see http://paypaltech.com/Patrick/testAcctOpt/) for more info
+
+    b) Replace the variables in bad_params with known invalid values. 
+
+  11) From within /vendor/plugins/paypal, run:
+    rake
+	this will do dummy operations with the sandbox account
+    You should see the following output:
+
+/usr/bin/ruby -Ilib:lib "/usr/lib/ruby/gems/1.8/gems/rake-0.7.0/lib/rake/rake_test_loader.rb" "test/paypal_test.rb"
+Loaded suite /usr/lib/ruby/gems/1.8/gems/rake-0.7.0/lib/rake/rake_test_loader
+Started
+.......
+Finished in 10.361749 seconds.
+
+7 tests, 7 assertions, 0 failures, 0 errors
+
+  11) Success! If you do have had troubles along the way, see the troubleshooting section below.
+      
+
+
+Usage:
+-----------------
+	Each function in the Paypal suite have two ways of calling it one for
+         test or dummy charges.  And one for live acions.
+	testing,sandbox:	Paypal.directcharge(params)
+        live           :        Paypal.directcharge(params,true)
+
+Function: directcharge
+  This function performs a doDirectCharge action.  Transfering funds from the parameter's account to your paypal merchant account. 
+
+  The return value of this function is the response object from paypal.
+  For instance:
+         res = Paypal.directcharge(params)
+         res.ack == Success   // true if action was succesful
+         res.ack == Failure   // true if action failed
+  The directcharge method takes a hash argument (params).
+  The method expects the hash to be in the form of:
+               :firstName => "<FIRST_NAME_VALUE>",
+               :lastName => "<LAST_NAME_VALUE>",
+               :ip => "<BUYERS_IP_ADDRESS",
+               :ammount => "<AMOUNT_TO_CHARGE>",    //This value has a maximum of 10,000.00
+               :itemName => "<ITEM_THAT_IS_BEING_SOLD",
+               :addressName => "Billing",
+               :street1 => "<FIRST LINE OF STREET ADDRESS>",
+               :street2 => "<SECOND LINE OF STREET ADDRESS>",
+               :cityName => "<CITY OF BILLING ADDRESS OF CARD>",
+               :postalCode =>  "<ZIPCODE OF BILLING ADDRESS OF CARD>",
+               :stateOrProvince => "<STATECODE OF BILLING ADDRESS>",
+               :country => "<COUNTRY CODE OF BILLING ADDRESS>",
+               :creditCardType => "Visa or MasterCard or Amex or Discover",
+               :creditCardNumber => "<VALID CREDIT CARD NUMBER",
+               :cVV2 => "<CVV2 AUTHORIZATION NUMBER FROM CARD"
+               :expMonth => 1  ,  //Expiration month in numerical form not string
+               :expYear => 2006     ///Expiration year in numerical form
+
+Function: directauth
+  This function performs a directcharge in authorization mode.  This means no actual funds are 
+  transfered upon comletetion of this action.
+
+
+  The return value of this function is the response object from paypal.
+  For instance:
+         res = Paypal.directauth(params)
+         res.ack == Success   // true if action was succesful
+         res.ack == Failure   // true if action failed
+
+  The transactionID is needed if you intend to capture the funds authroized by this function.  
+  The method expects the param hash to be in the form of : 
+               :firstName => "<FIRST_NAME_VALUE>",
+               :lastName => "<LAST_NAME_VALUE>",
+               :ip => "<BUYERS_IP_ADDRESS",
+               :ammount => "<AMOUNT_TO_CHARGE>",    //This value has a maximum of 10,000.00
+               :itemName => "<ITEM_THAT_IS_BEING_SOLD",
+               :addressName => "Billing",
+               :street1 => "<FIRST LINE OF STREET ADDRESS>",
+               :street2 => "<SECOND LINE OF STREET ADDRESS>",
+               :cityName => "<CITY OF BILLING ADDRESS OF CARD>",
+               :postalCode =>  "<ZIPCODE OF BILLING ADDRESS OF CARD>",
+               :stateOrProvince => "<STATECODE OF BILLING ADDRESS>",
+               :country => "<COUNTRY CODE OF BILLING ADDRESS>",
+               :creditCardType => "Visa or MasterCard or Amex or Discover",
+               :creditCardNumber => "<VALID CREDIT CARD NUMBER",
+               :cVV2 => "<CVV2 AUTHORIZATION NUMBER FROM CARD"
+               :expMonth => 1  ,  //Expiration month in numerical form not string
+               :expYear => 2006     ///Expiration year in numerical form 
+
+
+ 
+Function: capture
+
+  This funcion performs a doCapture.  It captures or collects the charge from a previously authorized
+  transaction.  This transaction is referenced by the transactionID returned from directauth.
+ 
+
+  The return value of this function is the response object from paypal.
+  For instance:
+         res = Paypal.capture(params)
+         res.ack == Success   // true if action was succesful
+         res.ack == Failure   // true if action failed
+
+  The parameter hash for this function is to be in the following form:
+              :transactionID => "<transactionID  FROM PREVIOUS DIRECT AUTH return object>"
+              :amount = > "<AMOUNT TO CHARGE>" //should be less than or equal to
+	                                       //auth's amount
+Function: void
+
+  This funcion performs a DoVoid.  It voids the charge from a previously authorized
+  transaction.  This transaction is referenced by the transactionID value of the return object from directauth.
+
+
+  The return value of this function is the response object from paypal.
+  For instance:
+         res = Paypal.void(params)
+         res.ack == Success   // true if action was succesful
+         res.ack == Failure   // true if action failed
+
+  The parameter hash for this function is to be in the following form:
+              :transactionID => "<transactionID  FROM PREVIOUS DIRECT AUTH return object>"
+
+
+You can run test charges through the console and get an idea on how to use the class by:
+./script/console
+paypal.directcharge( {
+               :firstName => "Justin",
+          --- SNIP ---
+               :expYear => 2008 } )
+
+You should see a bunch of data relating to the response object from paypal.  
+For more information on what specific data is given/useful please refer to the PayPal developer api.  
+
+If things go well and the charge should show in your sandbox. To run the charge live, just add a second parameter of true.
+
+paypal.directcharge( {...}, true )
+
+If your certificates are all setup correctly, you'll see a credit on your live paypal account.
+
+Please direct any questions or comments to: aprice@elctech.com or ds@elctech.com
+
+
+
+Troubleshooting
+-----------------------
+Put the command line to run the test in debug mode.
+/usr/bin/ruby -d -Ilib:lib "/usr/lib/ruby/gems/1.8/gems/rake-0.6.2/lib/rake/rake_test_loader.rb" "test/paypal_test.rb"
+
+This will give you lots of information. Look for errors in the XML response. Often passwords with '<' or other non-XML unencoded friendly characters will cause ruby to fail due to the Web Service support being incomplete at this time.
+
+
+If you are recieving a "NoMethodError: for each..." when trying to perform a capture.  Your soap version may need to be updated.
+If this does not work please refer to the following pages which concern this bug in soap4r.
+  bug link : http://dev.ctor.org/soap4r/ticket/184
+  code fix: http://dev.ctor.org/soap4r/changeset/1674
+
+Upgrading Soap4r-
+  Please see the following site for more information on upgrading soap4r
+http://www.pranavbihari.com/articles/2005/12/02/testing-paypal-web-services-with-ruby-soap4r

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'paypal-business', 'version')
+
+AUTHOR = ["Andre Price", "David Stevenson"]  # can also be an array of Authors
+EMAIL = "paypal_business@elctech.com"
+DESCRIPTION = "Ruby-friendly paypal API.  Works for both sandbox and live methods."
+GEM_NAME = "paypal-business" # what ppl will type to install your gem
+RUBYFORGE_PROJECT = "paypal-business" # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+RELEASE_TYPES = %w( gem ) # can use: gem, tar, zip
+
+
+NAME = "paypal-business"
+REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+VERS = ENV['VERSION'] || (Paypal_business::VERSION::STRING + (REV ? ".#{REV}" : ""))
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', "paypal-business documentation",
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/*_test.rb"]
+  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  #p.changes        - A description of the release's latest changes.
+  #p.extra_deps     - An array of rubygem dependencies.
+  #p.spec_extras    - A hash of extra values to set in the gemspec.
+end
+          

data/lib/paypal-business.rb

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__), "paypal-business/paypal.rb")
+#Dir[File.join(File.dirname(__FILE__), 'paypal-business/**/*.rb')].sort.each { |lib| require lib }

data/lib/paypal-business/PayPalAPIInterfaceServiceClient.rb

@@ -0,0 +1,221 @@
+#!/usr/bin/env ruby
+require 'defaultDriver.rb'
+
+endpoint_url = ARGV.shift
+obj = PayPalAPIInterface.new(endpoint_url)
+
+# run ruby with -d to see SOAP wiredumps.
+obj.wiredump_dev = STDERR if $DEBUG
+
+# SYNOPSIS
+#   RefundTransaction(refundTransactionRequest)
+#
+# ARGS
+#   refundTransactionRequest RefundTransactionReq - {urn:ebay:api:PayPalAPI}RefundTransactionReq
+#
+# RETURNS
+#   refundTransactionResponse RefundTransactionResponse - {urn:ebay:api:PayPalAPI}RefundTransactionResponse
+#
+refundTransactionRequest = nil
+puts obj.refundTransaction(refundTransactionRequest)
+
+# SYNOPSIS
+#   GetTransactionDetails(getTransactionDetailsRequest)
+#
+# ARGS
+#   getTransactionDetailsRequest GetTransactionDetailsReq - {urn:ebay:api:PayPalAPI}GetTransactionDetailsReq
+#
+# RETURNS
+#   getTransactionDetailsResponse GetTransactionDetailsResponse - {urn:ebay:api:PayPalAPI}GetTransactionDetailsResponse
+#
+getTransactionDetailsRequest = nil
+puts obj.getTransactionDetails(getTransactionDetailsRequest)
+
+# SYNOPSIS
+#   BillUser(billUserRequest)
+#
+# ARGS
+#   billUserRequest BillUserReq - {urn:ebay:api:PayPalAPI}BillUserReq
+#
+# RETURNS
+#   billUserResponse BillUserResponse - {urn:ebay:api:PayPalAPI}BillUserResponse
+#
+billUserRequest = nil
+puts obj.billUser(billUserRequest)
+
+# SYNOPSIS
+#   TransactionSearch(transactionSearchRequest)
+#
+# ARGS
+#   transactionSearchRequest TransactionSearchReq - {urn:ebay:api:PayPalAPI}TransactionSearchReq
+#
+# RETURNS
+#   transactionSearchResponse TransactionSearchResponse - {urn:ebay:api:PayPalAPI}TransactionSearchResponse
+#
+transactionSearchRequest = nil
+puts obj.transactionSearch(transactionSearchRequest)
+
+# SYNOPSIS
+#   MassPay(massPayRequest)
+#
+# ARGS
+#   massPayRequest  MassPayReq - {urn:ebay:api:PayPalAPI}MassPayReq
+#
+# RETURNS
+#   massPayResponse MassPayResponse - {urn:ebay:api:PayPalAPI}MassPayResponse
+#
+massPayRequest = nil
+puts obj.massPay(massPayRequest)
+
+# SYNOPSIS
+#   BillAgreementUpdate(billAgreementUpdateRequest)
+#
+# ARGS
+#   billAgreementUpdateRequest BillAgreementUpdateReq - {urn:ebay:api:PayPalAPI}BillAgreementUpdateReq
+#
+# RETURNS
+#   body            BAUpdateResponse - {urn:ebay:api:PayPalAPI}BAUpdateResponse
+#
+billAgreementUpdateRequest = nil
+puts obj.billAgreementUpdate(billAgreementUpdateRequest)
+
+# SYNOPSIS
+#   AddressVerify(addressVerifyRequest)
+#
+# ARGS
+#   addressVerifyRequest AddressVerifyReq - {urn:ebay:api:PayPalAPI}AddressVerifyReq
+#
+# RETURNS
+#   addressVerifyResponse AddressVerifyResponse - {urn:ebay:api:PayPalAPI}AddressVerifyResponse
+#
+addressVerifyRequest = nil
+puts obj.addressVerify(addressVerifyRequest)
+
+# SYNOPSIS
+#   EnterBoarding(enterBoardingRequest)
+#
+# ARGS
+#   enterBoardingRequest EnterBoardingReq - {urn:ebay:api:PayPalAPI}EnterBoardingReq
+#
+# RETURNS
+#   enterBoardingResponse EnterBoardingResponse - {urn:ebay:api:PayPalAPI}EnterBoardingResponse
+#
+enterBoardingRequest = nil
+puts obj.enterBoarding(enterBoardingRequest)
+
+# SYNOPSIS
+#   GetBoardingDetails(getBoardingDetailsRequest)
+#
+# ARGS
+#   getBoardingDetailsRequest GetBoardingDetailsReq - {urn:ebay:api:PayPalAPI}GetBoardingDetailsReq
+#
+# RETURNS
+#   getBoardingDetailsResponse GetBoardingDetailsResponse - {urn:ebay:api:PayPalAPI}GetBoardingDetailsResponse
+#
+getBoardingDetailsRequest = nil
+puts obj.getBoardingDetails(getBoardingDetailsRequest)
+
+
+endpoint_url = ARGV.shift
+obj = PayPalAPIAAInterface.new(endpoint_url)
+
+# run ruby with -d to see SOAP wiredumps.
+obj.wiredump_dev = STDERR if $DEBUG
+
+# SYNOPSIS
+#   DoExpressCheckoutPayment(doExpressCheckoutPaymentRequest)
+#
+# ARGS
+#   doExpressCheckoutPaymentRequest DoExpressCheckoutPaymentReq - {urn:ebay:api:PayPalAPI}DoExpressCheckoutPaymentReq
+#
+# RETURNS
+#   doExpressCheckoutPaymentResponse DoExpressCheckoutPaymentResponse - {urn:ebay:api:PayPalAPI}DoExpressCheckoutPaymentResponse
+#
+doExpressCheckoutPaymentRequest = nil
+puts obj.doExpressCheckoutPayment(doExpressCheckoutPaymentRequest)
+
+# SYNOPSIS
+#   SetExpressCheckout(setExpressCheckoutRequest)
+#
+# ARGS
+#   setExpressCheckoutRequest SetExpressCheckoutReq - {urn:ebay:api:PayPalAPI}SetExpressCheckoutReq
+#
+# RETURNS
+#   setExpressCheckoutResponse SetExpressCheckoutResponse - {urn:ebay:api:PayPalAPI}SetExpressCheckoutResponse
+#
+setExpressCheckoutRequest = nil
+puts obj.setExpressCheckout(setExpressCheckoutRequest)
+
+# SYNOPSIS
+#   GetExpressCheckoutDetails(getExpressCheckoutDetailsRequest)
+#
+# ARGS
+#   getExpressCheckoutDetailsRequest GetExpressCheckoutDetailsReq - {urn:ebay:api:PayPalAPI}GetExpressCheckoutDetailsReq
+#
+# RETURNS
+#   getExpressCheckoutDetailsResponse GetExpressCheckoutDetailsResponse - {urn:ebay:api:PayPalAPI}GetExpressCheckoutDetailsResponse
+#
+getExpressCheckoutDetailsRequest = nil
+puts obj.getExpressCheckoutDetails(getExpressCheckoutDetailsRequest)
+
+# SYNOPSIS
+#   DoDirectPayment(doDirectPaymentRequest)
+#
+# ARGS
+#   doDirectPaymentRequest DoDirectPaymentReq - {urn:ebay:api:PayPalAPI}DoDirectPaymentReq
+#
+# RETURNS
+#   doDirectPaymentResponse DoDirectPaymentResponse - {urn:ebay:api:PayPalAPI}DoDirectPaymentResponse
+#
+doDirectPaymentRequest = nil
+puts obj.doDirectPayment(doDirectPaymentRequest)
+
+# SYNOPSIS
+#   DoCapture(doCaptureRequest)
+#
+# ARGS
+#   doCaptureRequest DoCaptureReq - {urn:ebay:api:PayPalAPI}DoCaptureReq
+#
+# RETURNS
+#   doCaptureResponse DoCaptureResponse - {urn:ebay:api:PayPalAPI}DoCaptureResponse
+#
+doCaptureRequest = nil
+puts obj.doCapture(doCaptureRequest)
+
+# SYNOPSIS
+#   DoReauthorization(doReauthorizationRequest)
+#
+# ARGS
+#   doReauthorizationRequest DoReauthorizationReq - {urn:ebay:api:PayPalAPI}DoReauthorizationReq
+#
+# RETURNS
+#   doReauthorizationResponse DoReauthorizationResponse - {urn:ebay:api:PayPalAPI}DoReauthorizationResponse
+#
+doReauthorizationRequest = nil
+puts obj.doReauthorization(doReauthorizationRequest)
+
+# SYNOPSIS
+#   DoVoid(doVoidRequest)
+#
+# ARGS
+#   doVoidRequest   DoVoidReq - {urn:ebay:api:PayPalAPI}DoVoidReq
+#
+# RETURNS
+#   doVoidResponse  DoVoidResponse - {urn:ebay:api:PayPalAPI}DoVoidResponse
+#
+doVoidRequest = nil
+puts obj.doVoid(doVoidRequest)
+
+# SYNOPSIS
+#   DoAuthorization(doAuthorizationRequest)
+#
+# ARGS
+#   doAuthorizationRequest DoAuthorizationReq - {urn:ebay:api:PayPalAPI}DoAuthorizationReq
+#
+# RETURNS
+#   doAuthorizationResponse DoAuthorizationResponse - {urn:ebay:api:PayPalAPI}DoAuthorizationResponse
+#
+doAuthorizationRequest = nil
+puts obj.doAuthorization(doAuthorizationRequest)
+
+