paypal-payment 0.1.2

data/.gitignore

@@ -0,0 +1,19 @@
+.DS_Store
+pkg
+tmp
+examples
+.bundle
+db/*.sqlite3*
+log/*.log
+*.log
+tmp/**/*
+tmp/*
+doc/api
+doc/app
+*.swp
+*~
+.DS_Store
+.rvmrc
+Gemfile.lock
+.ruby-version
+.rbenv-version

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+gem 'curb'
+gem 'oj'
+gem 'multi_json'
+
+group :development, :test do
+  gem 'rspec'
+  gem 'guard-rspec'
+  gem 'rb-fsevent', '~> 0.9'
+  gem 'rake'
+  gem 'vcr'
+  gem 'fakeweb'
+  gem 'webmock', '1.8.11'
+  gem 'pry'
+  gem 'awesome_print'
+  gem 'activesupport'
+end

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+  
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/README.rdoc

@@ -0,0 +1,107 @@
+= PayPal Payment
+
+PayPal API Client for Adaptive Payments, Invoice and Express Checkout.
+
+== Installation (Gemfile)
+
+  gem 'paypal-payment', :git => 'https://github.com/chardy/paypal-payment.git'
+
+== Usage
+
+First, you need to set up your credentials:
+
+  require "paypal-payment"
+
+  PayPal::Api.configure do |config|
+    config.sandbox    = true
+    config.username   = "chardy_api1.gmail.com"
+    config.password   = "8DTSWBZC7GDR3T4X"
+    config.signature  = "AG-8mOpuFhFyFOYHlaTUYn3Syf15AWJKRnfHMVsmCtC3DK51-ENEPqLS"
+  end
+
+== Adaptive Payments
+
+You can request a new preapproval authorization:
+  pa = PayPal::AdaptivePayments::Preapproval.new(
+    :client_details => {
+      :ip_address => "234.8.8.18",
+      :device_id => "123456",
+      :application_id => "PP"
+    },
+    :starting_date => Date.today,
+    :currency_code => 'USD',
+    :max_total_amount_of_all_payments => 2000.0,
+    :cancel_url => 'http://yoursite.com/preapproval/cancel?preapprovalkey=${preapprovalkey}',
+    :return_url => 'http://yoursite.com/preapproval/accepted?preapprovalkey=${preapprovalkey}'
+  )
+
+  response = pa.create
+  puts response.preapproval_url if response.valid?
+
+You need to redirect your user to the url returned by <tt>response.approval_url</tt>.
+After the user accepts or rejects your preapproval request, he will be redirected to one of those urls you specified.
+Note that you need to append "preapprovalkey=${preapprovalkey}" to the urls if you want PayPal to redirect with preapprovalkey
+You can use the <tt>preapprovalkey</tt> parameter to query for the approval details.
+
+If you need to retrieve information about your buyer, like address or e-mail, you can use the
+<tt>details()</tt> method.
+
+  pa = PayPal::AdaptivePayments::Preapproval.new(:preapproval_key => "PA-89578182UL033944H")
+  response = pa.details
+
+When you need to request payment, create a new Payment with the preapproval key.
+
+  pp = PayPal::AdaptivePayments::Payment.new(
+    :preapproval_key => "PA-89578182UL033944H",
+    :receiver => {:email => "seller@example.com", :amount => 10.0},
+    :currency_code => 'USD',
+    :cancel_url => 'http://example.com/cancel',
+    :return_url => 'http://example.com/thank_you'
+  )
+
+  response = pp.pay
+  response.success?
+  response.completed?
+
+You can manage your preapproval.
+
+  pa = PayPal::AdaptivePayments::Preapproval.new(:preapproval_key => "PA-89578182UL033944H")
+  pa.cancel
+
+=== What information do I need to keep?
+
+You should save two paramaters to your database: <tt>TOKEN</tt> and <tt>PROFILEID</tt>.
+<tt>TOKEN</tt> is required when user returns to your website after he authorizes (or not) the billing process. You
+need to save it so you can find him later. You can remove this info after payment and recurring profile are set.
+
+The <tt>PROFILEID</tt> allows you to manage the recurring profile, like cancelling billing when an user don't
+want to use your service anymore.
+
+<b>NOTE:</b> TOKEN will expire after approximately 3 hours.
+
+== Maintainer
+
+* Chardy Wang
+
+== License
+
+(The MIT License)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new

data/docs/AdaptivePayments.rdoc

@@ -0,0 +1,84 @@
+= PayPal Payment
+
+PayPal API Client for Adaptive Payments, Invoice and Express Checkout.
+
+== Installation (Gemfile)
+
+  gem 'paypal-payment', :git => 'git://vendor@appcepted.com:/home/vendor/pp_paypal'
+
+== Usage
+
+First, you need to set up your credentials:
+
+  require "paypal-payment"
+
+  PayPal::Api.configure do |config|
+    config.sandbox    = true
+    config.username   = "chardy_api1.gmail.com"
+    config.password   = "8DTSWBZC7GDR3T4X"
+    config.signature  = "AG-8mOpuFhFyFOYHlaTUYn3Syf15AWJKRnfHMVsmCtC3DK51-ENEPqLS"
+  end
+
+== Adaptive Payments
+
+You can request a new preapproval authorization:
+  pa = PayPal::AdaptivePayments::Preapproval.new(
+    :client_details => {
+      :ip_address => "234.8.8.18",
+      :device_id => "123456",
+      :application_id => "PP"
+    },
+    :starting_date => Date.today,
+    :currency_code => 'USD',
+    :max_total_amount_of_all_payments => 2000.0,
+    :cancel_url => 'http://yoursite.com/preapproval/cancel?preapprovalkey=${preapprovalkey}',
+    :return_url => 'http://yoursite.com/preapproval/accepted?preapprovalkey=${preapprovalkey}'
+  )
+
+  response = pa.create
+  puts response.approval_url if response.valid?
+
+You need to redirect your user to the url returned by <tt>response.approval_url</tt>.
+After the user accepts or rejects your preapproval request, he will be redirected to one of those urls you specified.
+Note that you need to append "preapprovalkey=${preapprovalkey}" to the urls if you want PayPal to redirect with preapprovalkey
+You can use the <tt>preapprovalkey</tt> parameter to query for the approval details.
+
+If you need to retrieve information about your buyer, like address or e-mail, you can use the
+<tt>details()</tt> method.
+
+  pa = PayPal::AdaptivePayments::Preapproval.new(:preapproval_key => "PA-89578182UL033944H")
+  response = pa.details
+
+When you need to request payment, create a new Payment with the preapproval key.
+
+  pp = PayPal::AdaptivePayments::Payment.new(
+    :preapproval_key => "PA-89578182UL033944H",
+    :receiver => {:email => "seller@example.com", :amount => 10.0},
+    :currency_code => 'USD',
+    :cancel_url => 'http://example.com/cancel',
+    :return_url => 'http://example.com/thank_you'
+  )
+
+  response = pp.pay
+  response.success?
+  response.completed?
+
+You can manage your preapproval.
+
+  pa = PayPal::AdaptivePayments::Preapproval.new(:preapproval_key => "PA-89578182UL033944H")
+  pa.cancel
+
+=== What information do I need to keep?
+
+You should save two paramaters to your database: <tt>TOKEN</tt> and <tt>PROFILEID</tt>.
+<tt>TOKEN</tt> is required when user returns to your website after he authorizes (or not) the billing process. You
+need to save it so you can find him later. You can remove this info after payment and recurring profile are set.
+
+The <tt>PROFILEID</tt> allows you to manage the recurring profile, like cancelling billing when an user don't
+want to use your service anymore.
+
+<b>NOTE:</b> TOKEN will expire after approximately 3 hours.
+
+== Maintainer
+
+* Chardy Wang

data/docs/adaptive_payments.md

@@ -0,0 +1,55 @@
+# How to Set Up a Payment Preapproval Using Adaptive Payments
+
+https://www.x.com/developers/paypal/documentation-tools/adaptive-payments/how-to/ht_ap-basicPreapproval-curl-etc
+
+Setting up a payment preapproval using Adaptive Payments requires:
+
+  1. Setting up the preapproval.
+  2. Redirecting the customer to PayPal for authorization.
+  3. Optionally, retrieving data about the preapproval.
+  4. Optionally, capturing a future payment.
+
+When you use Adaptive Payments to set up payment preapprovals, the payment amounts can vary frequently.
+
+Step 1: Set Up the Preapproval
+
+  pp = PayPal::AdaptivePayments::Preapproval.new(
+    :starting_date => Date.today,
+    :ending_date => Date.today >> 12,
+    :max_amount_per_payment => 35.0,
+    :max_number_of_payments => 20,
+    :max_total_amount_of_all_payments => 2000.0,
+    :cancel_url => 'http://www.yourdomain.com/success.html',
+    :return_url => 'http://www.yourdomain.com/cancel.html',
+    :currency_code => 'USD'
+  )
+
+  response = pp.create
+
+Step 2: Redirect the Customer to PayPal for Authorization
+
+To get the preapproval url
+
+  response.preapproval_url
+
+Step 3: Retrieve Data about the Preapproval (Optional)
+
+  details = pp.details
+
+  Or
+
+  details = PayPal::AdaptivePayments::Preapproval.new(:preapproval_key => pp.preapproval_key).details
+
+Step 4: Capture a Future Payment (Optional)
+
+  pp = PayPal::AdaptivePayments::Payment.new(
+    :preapproval_key => preapproval_key,
+    :receiver => { :amount => 10.0, :email => "test@example.com" },
+    :currency_code => 'USD',
+    :cancel_url => 'http://www.yourdomain.com/success.html',
+    :return_url => 'http://www.yourdomain.com/cancel.html'
+  )
+
+  pp.pay
+
+

data/docs/api.txt

@@ -0,0 +1,67 @@
+Express Checkout
+================
+
+Implemented
+===========
+AddressVerify
+BillOutstandingAmount
+DoAuthorization
+DoCapture
+DoReauthorization
+DoVoid
+GetPalDetails
+GetBalance
+ManagePendingTransactionStatus
+TransactionSearch
+GetTransactionDetails
+DoReferenceTransaction
+Callback
+
+Deprecated
+==========
+CreateBillingAgreement
+GetBillingAgreementCustomerDetails
+SetCustomerBillingAgreement
+
+* CreateRecurringPaymentsProfile
+* DoExpressCheckoutPayment
+* GetExpressCheckoutDetails
+* GetRecurringPaymentsProfileDetails
+* ManageRecurringPaymentsProfileStatus
+* RefundTransaction
+* SetExpressCheckout
+* UpdateRecurringPaymentsProfile
+
+:checkout       => "SetExpressCheckout",
+:payment        => "DoExpressCheckoutPayment",
+:details        => "GetExpressCheckoutDetails",
+:create_profile => "CreateRecurringPaymentsProfile",
+:profile        => "GetRecurringPaymentsProfileDetails",
+:manage_profile => "ManageRecurringPaymentsProfileStatus",
+:update_profile => "UpdateRecurringPaymentsProfile",
+:refund         => "RefundTransaction"
+
+Endpoints
+---------
+https://api-3t.paypal.com/nvp
+https://api-3t.sandbox.paypal.com/nvp
+
+Adaptive Payments
+=================
+CancelPreapproval
+ConvertCurrency
+ExecutePayment
+GetFundingPlans
+GetPaymentOptions
+GetShippingAddresses
+Pay
+PaymentDetails
+Preapproval
+PreapprovalDetails
+Refund
+SetPaymentOptions
+
+Endpoints
+---------
+https://svcs.paypal.com/AdaptivePayments/<API_operation>
+https://svcs.sandbox.paypal.com/AdaptivePayments/<API_operation>

data/docs/design.txt

@@ -0,0 +1,38 @@
+Pay
+===
+ap = AdaptivePayments::Payment.new()
+ap.cancel_url = ""
+ap.return_url = ""
+ap.receivers << Receiver.new(email: '', amount: 10.00)
+ap.receivers << PrimaryReceiver.new()
+ap.create (action_type = :create)
+ap.options = (SetPaymentOptions)
+ap.options (GetPaymentOptions)
+ap.pay (pay_key ? ExecutePayment : action_type = :pay)
+ap.details (PaymentDetails)
+ap.funding_plans (GetFundingPlans)
+ap.shipping_addresses (GetShippingAddresses)
+ap.refund (Refund)
+
+PaymentDetails
+==============
+ap = AdaptivePayments::Payment.new(pay_key => '123456')
+ap.details (returns PaymentDetail)
+
+PaymentOptions
+===============
+ap = AdaptivePayments::Payment.new(pay_key => '123456')
+ap.options (GetPaymentOptions)
+ap.options =
+
+Preapproval
+===========
+app = AdaptivePayments::Preapproval.new()
+app.create
+app.details
+app.cancel
+
+Refund
+======
+ap = AdaptivePayments::Payment.new(pay_key => '123456')
+ap.refund

data/docs/express_checkout.md

@@ -0,0 +1,172 @@
+= PayPal Payment
+
+PayPal API Client for Adaptive Payments, Invoice and Express Checkout.
+
+== Installation (Gemfile)
+
+  gem 'paypal-payment', :git => 'vendor@appcepted.com:/home/vendor/pp_paypal'
+
+== Usage
+
+First, you need to set up your credentials:
+
+  require "paypal-payment"
+
+  PayPal::Api.configure do |config|
+    config.sandbox    = true
+    config.username   = "chardy_api1.gmail.com"
+    config.password   = "8DTSWBZC7GDR3T4X"
+    config.signature  = "AG-8mOpuFhFyFOYHlaTUYn3Syf15AWJKRnfHMVsmCtC3DK51-ENEPqLS"
+  end
+
+== Ref: https://www.x.com/developers/paypal/documentation-tools/express-checkout/how-to/ht_ec-recurringPaymentProfile-curl-etc
+
+== 1. Express Checkout - Recurring (authorization)
+
+  payment = PayPal::ExpressCheckout::Payment.new(
+    :payment_action     => "Authorization",
+    :description        => "Awesome - Monthly Subscription",
+    :notify_url         => "http://example.com/paypal/ipn",
+    :amount             => "9.00", # not bill yet
+    :currency           => "USD"
+  )
+
+  billing = PayPal::ExpressCheckout::Billing.new(
+    :type               => 'RecurringPayments',
+    :description        => "Awesome - Monthly Subscription"
+  )
+
+  ppc = PayPal::ExpressCheckout::Checkout.new({
+    :return_url         => "http://example.com/thank_you?app_name=camera_app",
+    :cancel_url         => "http://example.com/canceled",
+    :billings           => [ billing ],
+    :payments           => [ payment ]
+  })
+
+  response = ppc.checkout
+
+  response.valid?
+  response.checkout_url
+  # https://www.sandbox.paypal.com/webscr?cmd=_express-checkout&token=InsertTokenHere
+
+  token = response.token
+  payer_id = response.details.payer_id
+
+  rco = PayPal::ExpressCheckout::Checkout.new(:token => token)
+  payer_id = rco.details.payer_id
+
+== 1.a after click the checkout_url, make payment, redirect to return_url and paypal will return 
+
+  TOKEN=token_value
+  &BILLINGAGREEMENTACCEPTEDSTATUS=1
+  &ACK=Success
+  &PAYERID=3TXTXECKF1234
+
+== 2. Express Checkout - Recurring
+
+  ppr = PayPal::ExpressCheckout::Recurring.new({
+    :amount                         => "9.00",
+    :initial_amount                 => "9.00",
+    :failed_initial_action          => :cancel,
+    :currency                       => "USD",
+    :description                    => "Awesome - Monthly Subscription",
+    :frequency                      => 1,
+    :token                          => token,
+    :period                         => :monthly,
+    :reference                      => "1234",
+    :payer_id                       => payer_id,
+    :start_at                       => Time.now,
+    :max_failed_payments            => 1,
+    :auto_bill_outstanding          => :next_billing
+  })
+
+  ppr.create_profile
+  ppr.profile_status
+  ppr.profile_id
+
+== 3. Express Checkout - Recurring - manage profile
+  
+  ppr = PayPal::ExpressCheckout::Recurring.new(:profile_id => "I-1RFWFFS16BF4")
+  ppr.suspend
+  ppr.success?
+
+  ppr.profile # see profile_spec.rb
+
+  ppr.reactivate
+
+  ppr.cancel # cannot reactivate
+
+== 4. Express Checkout - Recurring - update profile
+
+  ppr = PayPal::ExpressCheckout::Recurring.new(:profile_id => "I-1RFWFFS16BF4")
+
+  PayPal::ExpressCheckout::Recurring.new({
+    :description => "Awesome - Monthly Subscription (Updated)",
+    :amount      => "10.00",
+    :currency    => "BRL",
+    :note        => "Changed Plan",
+    :profile_id  => profile_id
+  })
+
+=====
+
+== 1. Express Checkout - Sale
+
+  payment = PayPal::ExpressCheckout::Payment.new(
+    :payment_action     => "Sale",
+    :description        => "Awesome - Sale",
+    :notify_url         => "http://example.com/paypal/ipn",
+    :amount             => "9.00",
+    :currency           => "USD"
+  )
+
+  ppc = PayPal::ExpressCheckout::Checkout.new({
+    :return_url         => "http://example.com/thank_you",
+    :cancel_url         => "http://example.com/canceled",
+    :payments           => [ payment ]
+  })
+
+  response = ppc.checkout
+  response.valid?
+  response.checkout_url
+
+== 1.a after click the checkout_url, make payment, redirect to return_url and paypal will return 
+
+  TOKEN=token_value
+  &ACK=Success
+
+== 2. Express Checkout - Sale
+
+  payment = PayPal::ExpressCheckout::Payment.new(
+    :payment_action     => "Sale",
+    :description        => "Awesome - Sale",
+    :notify_url         => "http://example.com/paypal/ipn",
+    :amount             => "9.00",
+    :currency           => "USD"
+  )
+
+  checkout = PayPal::ExpressCheckout::Checkout.new(:token => token)
+  payer_id = checkout.details.payer_id
+
+  checkout = PayPal::ExpressCheckout::Checkout.new(
+    :token              => token,
+    :payer_id           => payer_id,
+    :payments           => [payment]
+  )
+  checkout.pay
+
+== 3. Express Checkout - Sale - Manage
+
+  payment = PayPal::ExpressCheckout::Payment.new(:transaction_id => transaction_id)
+
+
+
+
+
+
+
+
+
+
+
+