spree_razorpay_checkout 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f71f43333d77534af765494a0d72324630e204947c938dc7a2c06eac9d425ed5
-  data.tar.gz: 257468fb6b633fb4ccae4600b9eab70749af86f9ee20a32c000480ebf18b67a3
+  metadata.gz: be049ea4932e3bfa3b1cfd7b0026c99bdcf09b505228259ff2a79873e7ab593e
+  data.tar.gz: 9716bca9cf17adb7dc8ae6f37d3355f1ab3836c8b5e39aa2ea63d69d074b40e7
 SHA512:
-  metadata.gz: f02acede19264ffe8af40ca4f94fb93a4093d61a9916fd13179a98bbd14e90e57bf0f9860464e28a4f0b0e18d1b986bfaf1674092c8824ad57bd1bc6a687bc79
-  data.tar.gz: 9e71c4612138732e35869d82d96721deaca8448dfe19b0bc365d3c7d40a808d295566237d0e23115a7bfa617dabde0307b574621e1c57d43d832aed6525e50d3
+  metadata.gz: cf5f5dd3b13b9f464ab3c94c57ef87ad3c05f201a2dfd98fa4b870361a06a46b8c3cb5040962223056eac59c7d4bf35de37558aa7c7fda106daf2e84e8ba8ae1
+  data.tar.gz: f4703d072832f950dec7bd4edb5c6ab29c2190d40abb597e96dab882f6d239736b9cc07c94d89e85d151563f732abefbf0bbd317872b000eab0c54d5b6e92300

data/README.md

@@ -0,0 +1,119 @@
+<img 
+  src="https://github.com/user-attachments/assets/3bcca1bd-5d70-4f0e-9c6d-4f99104d0e93" 
+  alt="razorpay" 
+  style="height: 100px; border-radius: 12em;"
+/>
+
+## Razorpay Extension for Spree Commerce v5
+RazorPay is the only payments solution in India that allows businesses to accept, process and disburse payments with its product suite.
+
+## Installation (Traditional)
+
+1. Add this to your Gemfile with this line:
+
+    ```ruby
+    gem 'spree_razorpay_checkout'
+    ```
+
+2. Install the Gem using Bundle Install:
+
+    ```ruby
+    bundle install
+    ```
+
+3. Copy & Run Migrations:
+
+    ```ruby
+    bundle exec rails g spree_razorpay_checkout:install
+    ```
+
+4. Compile Assests for Proper Images & JS loading:
+   
+    ```ruby
+    RAILS_ENV=development bin/rails assets:precompile
+    ```
+    
+5. Start Server:
+
+    ```ruby
+    foreman start -f Procfile.dev
+    ```
+
+## Installation (For Docker)
+
+1. Add this your Gemfile with this line:
+
+    ```ruby
+    gem 'spree_razorpay_checkout'
+    ```
+
+2. Install the Gem using Docker's Bundle Install:
+
+    ```ruby
+    docker compose run web bundle install
+    ```
+
+3. Run Install Generator to Copy Migrations in Docker way:
+
+    ```ruby
+    docker compose run web bundle exec rails g spree_razorpay_checkout:install
+    ```
+
+4. Compile Assests for Razorpay logo & assets (Recommended):
+   
+    ```ruby
+    docker compose run web bundle exec rails assets:precompile
+    ```
+    
+5. Re-Start Server (Recommended):
+
+    ```ruby
+    docker compose down
+    docker compose up -d
+    ```
+
+## Plugin Configuration
+6. Get keys from Razorpay Dashboard [here](https://dashboard.razorpay.com/app/website-app-settings/api-keys).
+
+   <img width="1186" height="735" alt="razorpay dashboard" src="https://github.com/user-attachments/assets/f390685d-550b-4814-8785-4fcc32746f15" />
+
+7. Make Sure to include both Razorpay Live & Test Keys from Razorpay Dashboard:
+
+<img width="1121" height="736" alt="Admin Dashboard - Razorpay Plugin" src="https://github.com/user-attachments/assets/f45efc43-b1db-4c79-9ad3-e3d672014676" />
+
+
+8. Drag Razorpay to Top in Payment Methods to make it Default:
+
+<img width="1121" height="726" alt="Payment Methods - Razorpay Plugin" src="https://github.com/user-attachments/assets/8e39086d-85a6-42a2-b9fb-75299044e6d6" />
+
+## Checkout View
+
+9. Checkout Page:
+   
+<img width="507" height="639" alt="Razorpay Checkout Page" src="https://github.com/user-attachments/assets/ddca8536-fa94-4502-96fa-4cd2219f3c17" />
+
+10. Razorpay Modal to Capture Payments:
+
+<img width="767" height="728" alt="Razorpay Modal" src="https://github.com/user-attachments/assets/da83105f-8510-44ae-ac7c-28960cf3a0b3" />
+
+11. Order Page (Customer View):
+
+<img width="863" height="733" alt="Razorpay in Order Page Client" src="https://github.com/user-attachments/assets/51b80fe6-4007-4223-b978-8ce65a3238de" />
+
+12. Order Page (Admin View):
+
+<img width="820" height="543" alt="Admin Orders Page Razorpay" src="https://github.com/user-attachments/assets/6d95d1ab-83a0-4ad8-9528-353cc7315630" />
+
+Thankyou for supporting this plugin. if you find any issues related to plugin you are open to contribute and support which can help more Spree users in India.
+
+## Gem Info
+
+- [RubyGems Page](https://rubygems.org/gems/spree_razorpay_checkout)
+- [Source Code](https://github.com/umeshravani/spree_razorpay)
+- [Bug Reports](https://github.com/umeshravani/spree_razorpay/issues)
+
+---
+
+### Contributing
+
+Contributions are welcome! Please open issues or submit pull requests to help improve this plugin for the Spree + Razorpay community in India.

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

@@ -0,0 +1,25 @@
+module SpreeRazorpayCheckout
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__) # if you use templates
+      class_option :migrate, type: :boolean, default: true
+
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/spree_razorpay\n"
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/process_razorpay\n"
+      end
+
+      def add_migrations
+        run 'bin/rails railties:install:migrations FROM=spree_razorpay_checkout'
+      end
+
+      def run_migrations
+        if options[:migrate]
+          run 'bin/rails db:migrate'
+        else
+          say_status :skip, "Skipped running migrations. You can run them later with `bin/rails db:migrate`.", :yellow
+        end
+      end
+    end
+  end
+end

data/lib/spree_razorpay_checkout/engine.rb

@@ -0,0 +1,29 @@
+module SpreeRazorpayCheckout
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_razorpay'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    config.after_initialize do |_app|
+      SpreeRazorpayCheckout::Config = SpreeRazorpay::Configuration.new
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.after_initialize do |app|
+      app.config.spree.payment_methods ||= []
+      app.config.spree.payment_methods << ::Spree::Gateway::RazorpayGateway
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/spree_razorpay_checkout/factories.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'spree_razorpay/factories'
+end

data/lib/spree_razorpay_checkout/version.rb

@@ -0,0 +1,11 @@
+module SpreeRazorpayCheckout
+  VERSION = '0.0.4'.freeze
+
+  module_function
+
+  # Returns the version of the currently loaded SpreeRazorpay as a
+  # <tt>Gem::Version</tt>.
+  def version
+    Gem::Version.new VERSION
+  end
+end

data/lib/spree_razorpay_checkout.rb

@@ -0,0 +1,4 @@
+require 'spree_core'
+require 'spree_extension'
+require 'spree_razorpay_checkout/engine'
+require 'spree_razorpay_checkout/version'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_razorpay_checkout
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Umesh Ravani
@@ -100,7 +100,13 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- README.md
+- lib/generators/spree_razorpay_checkout/install/install_generator.rb
+- lib/spree_razorpay_checkout.rb
+- lib/spree_razorpay_checkout/engine.rb
+- lib/spree_razorpay_checkout/factories.rb
+- lib/spree_razorpay_checkout/version.rb
 homepage: https://github.com/umeshravani/spree_razorpay
 licenses:
 - BSD-3-Clause