spree_paypal 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c44aa6b48b0b4ef9f937916498f5890a2221eb1bb7e9f69382092993b033e4b
+  data.tar.gz: b64a324cdf696202c0b9782a7ce23a2c6a2b4fea683f14a74a858e7b825c887a
+SHA512:
+  metadata.gz: 94f1a022234a00dc62007faf7aa2ebc95eb0765f1daa7499c4619d60f8fa6d401a8d43cc7d1cf5b77f5eb7949d9c15ea9c25bf2162b3060c5fba431f3cb005ce
+  data.tar.gz: 40339fa11cd431815139a8c0abca74ee1d0cd9e919cbbf1f180cca32403407c9600184937a76bf6390378a5387e8f8ba68ce8dfdea500c1f2b5cbcbab3fe4f64

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-09-05
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at ksbek112@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 ksbek
+
+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/README.md

@@ -0,0 +1,40 @@
+# SpreePaypal
+
+SpreePaypal is a gem that integrates PayPal's REST API with the Spree eCommerce platform. It creates a new PayPal payment method, supports the PayPal JavaScript SDK for frontend payment processing, and allows you to configure sandbox or live modes for testing and production.
+
+
+## Installation
+
+1. Add this line to your application's Gemfile:
+
+    ```ruby
+    gem 'spree_paypal', github: 'vitkx/spree_paypal', branch: 'master'
+    ```
+
+2. Install the gem by running:
+
+    ```bash
+    bundle install
+    ```
+
+3. Copy & run migrations
+
+    ```bash
+    bundle exec rails g spree_paypal:install
+    ```
+
+4. Restart your server
+
+
+## Usage
+
+After installation, configure PayPal by adding your `client_id`, `client_secret`, and sandbox settings in the Spree admin panel under **Payment Methods**.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vitkx/spree_paypal.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/app/controllers/spree/paypal_controller.rb

@@ -0,0 +1,63 @@
+module Spree
+  class PaypalController < Spree::StoreController
+    protect_from_forgery with: :null_session
+
+    def create_order
+      order = current_order
+      payment_method = Spree::PaymentMethod.find(params[:payment_method_id])
+
+      service = SpreePaypal::PaypalService.new(payment_method)
+      response = service.create_order(order)
+
+      if response['id']
+        render json: { orderID: response['id'] }, status: :ok
+      else
+        render json: { error: response['message'] }, status: :unprocessable_entity
+      end
+    end
+
+    def capture_order
+      order = current_order
+      payment_method = Spree::PaymentMethod.find(params[:payment_method_id])
+      service = SpreePaypal::PaypalService.new(payment_method)
+      response = service.capture_order(params[:orderID])
+
+      if response['status'] == 'COMPLETED'
+        process_spree_payment(order, payment_method, response)
+        render json: { status: 'success', details: response }, status: :ok
+      else
+        render json: { error: 'Capture failed' }, status: :unprocessable_entity
+      end
+    end
+
+    private
+
+    def process_spree_payment(order, payment_method, paypal_response)
+      payer_info = paypal_response.dig('payer', 'name') || {}
+
+      paypal_source = Spree::Paypal.create!(
+        payer_id: paypal_response['payer']['payer_id'],
+        first_name: payer_info['given_name'],
+        last_name: payer_info['surname'],
+        email: paypal_response['payer']['email_address'],
+        payment_method_id: payment_method.id,
+        transaction_id: paypal_response['id']
+      )
+
+      payment = order.payments.create!(
+        payment_method: payment_method,
+        amount: order.total,
+        state: 'completed',
+        response_code: paypal_response['id'],
+        source: paypal_source, # You could create a PayPal-specific payment source if necessary
+        avs_response: paypal_response['payer']['payer_id']
+      )
+
+      # Only transition the order if it's not already completed
+      if order.state != 'complete'
+        order.next! if order.state == 'payment'
+      end
+      payment.complete! unless payment.completed?
+    end
+  end
+end

data/app/models/spree/payment_method/paypal.rb

@@ -0,0 +1,39 @@
+module Spree
+  class PaymentMethod::Paypal < PaymentMethod
+    preference :client_id, :string
+    preference :client_secret, :string
+    preference :sandbox, :boolean, default: true # Default to sandbox mode
+
+    def payment_source_class
+      Spree::Paypal
+    end
+
+    def actions
+      %w{capture void}
+    end
+
+    def auto_capture?
+      true
+    end
+
+    def supports?(source)
+      source.payment_method.is_a?(Spree::PaymentMethod::Paypal)
+    end
+
+    def provider_class
+      ::PaypalService
+    end
+
+    def client_id
+      preferred_client_id
+    end
+
+    def client_secret
+      preferred_client_secret
+    end
+
+    def sandbox?
+      preferred_sandbox
+    end
+  end
+end

data/app/models/spree/paypal.rb

@@ -0,0 +1,7 @@
+module Spree
+  class Paypal < ApplicationRecord
+    belongs_to :payment_method, class_name: 'Spree::PaymentMethod'
+
+    validates :payer_id, :first_name, :last_name, :email, presence: true
+  end
+end

data/app/views/spree/admin/payments/source_views/_paypal.html.erb

@@ -0,0 +1,25 @@
+<fieldset data-hook="paypal">
+  <legend>Paypal</legend>
+  <table class="table table-condensed table-bordered">
+    <tr>
+      <th width="20%"><%= Spree.t(:transaction_id) %>:</th>
+      <td><%= payment.source.transaction_id %></td>
+    </tr>
+    <tr>
+      <th width="20%"><%= Spree.t(:email_address) %>:</th>
+      <td><%= payment.source.email %></td>
+    </tr>
+    <tr>
+      <th width="20%"><%= Spree.t(:first_name) %>:</th>
+      <td><%= payment.source.first_name %></td>
+    </tr>
+    <tr>
+      <th width="20%"><%= Spree.t(:last_name) %>:</th>
+      <td><%= payment.source.last_name %></td>
+    </tr>
+    <tr>
+      <th><%= Spree.t(:state) %>:</th>
+      <td><%= payment.state %></td>
+    </tr>
+  </table>
+</fieldset>

data/app/views/spree/checkout/payment/_paypal.html.erb

@@ -0,0 +1,56 @@
+<script src="https://www.paypal.com/sdk/js?client-id=<%= payment_method.preferred_client_id %>"></script>
+
+<div id="paypal-button-container"></div>
+
+<script>
+  paypal.Buttons({
+    createOrder: async function(data, actions) {
+      try {
+        const response = await fetch('/paypal/create_order', {
+          method: 'POST',
+          headers: {
+            'Content-Type': 'application/json',
+            'X-CSRF-Token': '<%= form_authenticity_token %>'
+          },
+          body: JSON.stringify({
+            payment_method_id: '<%= payment_method.id %>'
+          })
+        });
+    
+        if (!response.ok) {
+          throw new Error(`Server error: ${response.statusText}`);
+        }
+    
+        const orderData = await response.json();
+    
+        if (!orderData.orderID) {
+          throw new Error('Order ID not found in response');
+        }
+    
+        return orderData.orderID;
+    
+      } catch (error) {
+        console.error('Error creating PayPal order:', error);
+        alert('There was an issue creating the PayPal order. Please try again later.');
+        return null;
+      }
+    },
+    onApprove: function(data, actions) {
+      return fetch('/paypal/capture_order', {
+        method: 'post',
+        headers: {
+          'Content-Type': 'application/json',
+          'X-CSRF-Token': '<%= form_authenticity_token %>'
+        },
+        body: JSON.stringify({
+          orderID: data.orderID,
+          payment_method_id: '<%= payment_method.id %>'
+        })
+      }).then(function(res) {
+        return res.json();
+      }).then(function(details) {
+        window.location.href = '<%= spree.order_path(@order) %>';
+      });
+    }
+  }).render('#paypal-button-container');
+</script>

data/config/routes.rb

@@ -0,0 +1,4 @@
+Spree::Core::Engine.routes.draw do
+  post '/paypal/create_order', to: 'paypal#create_order'
+  post '/paypal/capture_order', to: 'paypal#capture_order'
+end

data/db/migrate/20240905052951_create_spree_paypal.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# This migration comes from spree_paypal_express (originally 20130723042610)
+class CreateSpreePaypal < SpreeExtension::Migration[4.2]
+  def change
+    unless table_exists?(:spree_paypals)
+      create_table :spree_paypals do |t|
+        t.string :email
+        t.string :first_name
+        t.string :last_name
+        t.string :payer_id
+        t.string :transaction_id
+        t.bigint :payment_method_id
+      end
+    end
+  end
+end

data/lib/generators/spree_paypal/install/install_generator.rb

@@ -0,0 +1,20 @@
+module SpreePaypal
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_paypal'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_paypal/engine.rb

@@ -0,0 +1,13 @@
+module SpreePaypal
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_paypal'
+
+    config.after_initialize do |app|
+      app.config.spree.payment_methods += [
+        Spree::PaymentMethod::Paypal,
+      ]
+    end
+  end
+end

data/lib/spree_paypal/services/paypal_service.rb

@@ -0,0 +1,96 @@
+require 'net/http'
+require 'uri'
+require 'json'
+require 'base64'
+
+module SpreePaypal
+  class PaypalService
+    SANDBOX_API_URL = "https://api.sandbox.paypal.com"
+    LIVE_API_URL = "https://api.paypal.com"
+
+    def initialize(payment_method)
+      @client_id = payment_method.preferred_client_id
+      @client_secret = payment_method.preferred_client_secret
+      @api_base_url = payment_method.sandbox? ? SANDBOX_API_URL : LIVE_API_URL
+    end
+
+    def create_order(order)
+      auth_token = authenticate
+      purchase_units = build_purchase_units(order)
+      uri = URI.parse("#{@api_base_url}/v2/checkout/orders")
+      request = Net::HTTP::Post.new(uri)
+      request["Authorization"] = "Bearer #{auth_token}"
+      request["Content-Type"] = "application/json"
+      request.body = {
+        intent: 'CAPTURE',
+        purchase_units: purchase_units
+      }.to_json
+
+      response = send_request(uri, request)
+      JSON.parse(response.body)
+    end
+
+    def capture_order(order_id)
+      auth_token = authenticate
+      
+      uri = URI.parse("#{@api_base_url}/v2/checkout/orders/#{order_id}/capture")
+      request = Net::HTTP::Post.new(uri)
+      request["Authorization"] = "Bearer #{auth_token}"
+      request["Content-Type"] = "application/json"
+
+      response = send_request(uri, request)
+      JSON.parse(response.body)
+    end
+
+    private
+
+    def authenticate
+      uri = URI.parse("#{@api_base_url}/v1/oauth2/token")
+      request = Net::HTTP::Post.new(uri)
+      request["Authorization"] = "Basic #{Base64.strict_encode64("#{@client_id}:#{@client_secret}")}"
+      request["Content-Type"] = "application/x-www-form-urlencoded"
+      request.body = URI.encode_www_form(grant_type: 'client_credentials')
+
+      response = send_request(uri, request)
+      JSON.parse(response.body)['access_token']
+    end
+
+    def build_purchase_units(order)
+      items = order.line_items.map do |line_item|
+        {
+          name: line_item.product.name,
+          quantity: line_item.quantity.to_s,
+          unit_amount: {
+            currency_code: order.currency || 'USD',
+            value: line_item.price.to_s
+          }
+        }
+      end
+
+      [{
+        reference_id: order.id,
+        amount: {
+          currency_code: order.currency || 'USD',
+          value: order.total.to_s,
+          breakdown: {
+            item_total: {
+              currency_code: order.currency || 'USD',
+              value: order.item_total.to_s
+            },
+            shipping: {
+              currency_code: order.currency || 'USD',
+              value: order.shipment_total.to_s
+            }
+          }
+        },
+        items: items
+      }]
+    end
+
+    def send_request(uri, request)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = (uri.scheme == 'https')
+      http.request(request)
+    end
+  end
+end

data/lib/spree_paypal/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SpreePaypal
+  VERSION = "1.0.0"
+end

data/lib/spree_paypal.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'spree_extension'
+require 'spree_paypal/version'
+require 'spree_paypal/engine'
+require 'spree_paypal/services/paypal_service'

data/sig/spree_paypal.rbs

@@ -0,0 +1,4 @@
+module SpreePaypal
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/spree_paypal.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/spree_paypal/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "spree_paypal"
+  spec.version = SpreePaypal::VERSION
+  spec.authors = ["vitkx"]
+  spec.email = ["vitoxxx1206@gmail.com"]
+  spec.homepage      = "https://github.com/vitkx/spree_paypal"
+
+  spec.summary = "Paypal integration for spree"
+  spec.description = "Provides Paypal payment integration for spree"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.add_dependency "spree", "~> 4.9"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: spree_paypal
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- vitkx
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.9'
+description: Provides Paypal payment integration for spree
+email:
+- vitoxxx1206@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/spree/paypal_controller.rb
+- app/models/spree/payment_method/paypal.rb
+- app/models/spree/paypal.rb
+- app/views/spree/admin/payments/source_views/_paypal.html.erb
+- app/views/spree/checkout/payment/_paypal.html.erb
+- config/routes.rb
+- db/migrate/20240905052951_create_spree_paypal.rb
+- lib/generators/spree_paypal/install/install_generator.rb
+- lib/spree_paypal.rb
+- lib/spree_paypal/engine.rb
+- lib/spree_paypal/services/paypal_service.rb
+- lib/spree_paypal/version.rb
+- sig/spree_paypal.rbs
+- spree_paypal.gemspec
+homepage: https://github.com/vitkx/spree_paypal
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key: 
+specification_version: 4
+summary: Paypal integration for spree
+test_files: []