shoppe-paypal 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f1813df55015dfeec5bdca0267c32cf77dc9f493
+  data.tar.gz: a0ba3fd1776c4dee76d2e4390fb4222ada3e5450
+SHA512:
+  metadata.gz: b73e4c91731564567a67b33b77b547e9faf40668fb7f31f4eb5524f399d462e6dd4649d8e573de3e62fa610370f744eadeff7ea1b6c68853b6a58af4e179dedd
+  data.tar.gz: b3bc80129b546e5fede96d68814450c4726cbd6c04b0bd5b8221aa5af56609543cd100e12b08fd2bb59fbf47e167564c55dd828581faf4ebe8f39ac655e18cfd

data/README.md

@@ -0,0 +1,28 @@
+# PayPal Shoppe Module
+
+This module helps with including PayPal within your Shoppe application.
+The information below explains how to get this module installed within your Rails application.
+
+## Installing
+
+Add the gem to your Gemfile and run `bundle install`
+
+`gem "shoppe-paypal"`
+
+For the latest up to date documentation, please see the [Shoppe tutorial page](http://tryshoppe.com/docs/payment-gateways/paypal).
+
+## Workflow
+
++ Start an order
++ Give the user the decision of payment
++ Create a PayPal payment
++ Redirect the user to PayPal using the previous URL
++ User logs in & accepts payment
++ Redirected to success URL and payment details are stored with the order
++ Complete order
++ When the order is accepted in the Shoppe admin, the payment will be executed/captured
+
+## To Do
+
++ Tests!
++ When rejecting an order, payment is not refunded

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/shoppe/paypal/engine.rb

@@ -0,0 +1,16 @@
+module Shoppe
+  module Paypal
+    class Engine < Rails::Engine
+      
+      initializer "shoppe.paypal.initializer" do
+        Shoppe::Paypal.setup
+      end
+
+      config.to_prepare do
+        Shoppe::Order.send :include, Shoppe::Paypal::OrderExtensions
+        Shoppe::Payment.send :include, Shoppe::Paypal::PaymentExtensions
+      end
+      
+    end
+  end
+end

data/lib/shoppe/paypal/order_extensions.rb

@@ -0,0 +1,40 @@
+module Shoppe
+  module Paypal
+    module OrderExtensions
+      
+      # Create a PayPal payment and respond with the approval URL
+      # Requires return_url and cancel_url parameters
+      def redirect_to_paypal(return_url, cancel_url)
+        @payment = PayPal::SDK::REST::Payment.new({
+          :intent => "sale",
+          :payer => {
+            :payment_method => "paypal" },
+          :redirect_urls => {
+            :return_url => return_url,
+            :cancel_url => cancel_url },
+          :transactions => [ {
+            :amount => {
+              :total => '%.2f' % self.total,
+              :currency => Shoppe::Paypal.currency },
+            :description => "Order #{self.number}" } ] } )
+
+        if @payment.create
+          @payment.links.find{|v| v.method == "REDIRECT" }.href
+        elsif @payment.error
+          raise Shoppe::Errors::PaymentDeclined, "There was an error contacting the payment processor"
+        end
+      end
+
+      # Accept a PayPal payment after redirected back to the Rails app
+      def accept_paypal_payment(payment_id, token, payer_id)
+        self.payments.create(amount: self.total, method: "PayPal", reference: payment_id, refundable: true, confirmed: false)
+
+        self.properties["paypal_payment_id"] = payment_id
+        self.properties["paypal_payment_token"] = token
+        self.properties["paypal_payer_id"] = payer_id
+        self.save
+      end
+
+    end
+  end
+end

data/lib/shoppe/paypal/payment_extensions.rb

@@ -0,0 +1,23 @@
+module Shoppe
+  module Paypal
+    module PaymentExtensions
+
+      # Get the PayPal payment information from the API
+      def paypal_payment
+        return false unless self.method == "PayPal"
+
+        @paypal_payment ||= PayPal::SDK::REST::Payment.find(self.reference)
+      end
+
+      # The PayPal transaction URL
+      def transaction_url
+        if Rails.env.production?
+          "https://history.paypal.com/uk/cgi-bin/webscr?cmd=_history-details-from-hub&id=#{reference}"
+        else
+          "https://www.sandbox.paypal.com/uk/cgi-bin/webscr?cmd=_history-details-from-hub&id=#{reference}"
+        end
+      end
+
+    end
+  end
+end

data/lib/shoppe/paypal/version.rb

@@ -0,0 +1,5 @@
+module Shoppe
+  module Paypal
+    VERSION = "1.0.0"
+  end
+end

data/lib/shoppe/paypal.rb

@@ -0,0 +1,56 @@
+require 'shoppe/paypal/version'
+require 'shoppe/paypal/engine'
+
+require 'shoppe/paypal/order_extensions'
+require 'shoppe/paypal/payment_extensions'
+
+module Shoppe
+  module Paypal
+    
+    class << self
+      
+      def client_id
+        Shoppe.settings.paypal_client_id
+      end
+
+      def client_secret
+        Shoppe.settings.paypal_secret_id
+      end
+
+      def currency
+        Shoppe.settings.paypal_currency
+      end
+      
+      def setup
+        # Set the configuration
+        Shoppe.add_settings_group :paypal, [:paypal_client_id, :paypal_secret_id, :currency]
+
+        # Require the PayPal library
+        require 'paypal-sdk-rest'
+        
+        include PayPal::SDK::REST
+
+        # Configure the PayPal library
+        PayPal::SDK.configure({
+          mode:          (Rails.env.production? ? "live" : "sandbox"),
+          client_id:     Shoppe.settings.paypal_client_id,
+          client_secret: Shoppe.settings.paypal_secret_id
+        })
+
+        # When an order is accepted, attempt to capture/execute the payment
+        Shoppe::Order.before_acceptance do
+          self.payments.where(confirmed: false, method: "PayPal").each do |payment|
+            begin
+              payment.paypal_payment.execute(payer_id: payment.order.properties["paypal_payer_id"])
+              payment.update_attribute(:confirmed, true)
+            rescue
+              raise Shoppe::Errors::PaymentDeclined, "Payment ##{payment.id} could not be captured by PayPal. Investigate with PayPal. Do not accept the order."
+            end
+          end
+        end
+
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: shoppe-paypal
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dean Perry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoppe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: paypal-sdk-rest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Shoppe module to assist with the integration of PayPal.
+email:
+- dean@voupe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/shoppe/paypal.rb
+- lib/shoppe/paypal/engine.rb
+- lib/shoppe/paypal/order_extensions.rb
+- lib/shoppe/paypal/payment_extensions.rb
+- lib/shoppe/paypal/version.rb
+homepage: http://voupe.com
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A PayPal payment module for Shoppe.
+test_files: []
+has_rdoc: