upi 1.0.2 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71e0504743eed34e876973cbef51a82d05d0f0c2281ec993e0ae40c7af4a161d
-  data.tar.gz: b52d3e506c1f20e52ae4e18403871cae5768d1614d94ab452476e21e809a3593
+  metadata.gz: fbc938b77f542923739627acea2a7b852324d4e1facc7abc9e110fb57d6a468f
+  data.tar.gz: cb6e4d8010da2c1cec18469c08edef3a4349807033fd68d04a6d209042443a64
 SHA512:
-  metadata.gz: 8c9aad17178913426a3479b69e6bdaa9e7a2fc7384786397b276f8d306716a542b7547c72b5a8ccaac9e6cddb8b402aae59d2eb91aadd4153ea885af201a8970
-  data.tar.gz: 93fd0b0408baf19189852db59044f9119f0529ebd54895cc6deb1da27edad0167b03f7d003ff6d71c6b837ebd647ce9b6c20c8fb533e1079b454d4eaa4683b72
+  metadata.gz: 10bd3fdca2b006501ae4166c96443217ddd3bf72dc8c12d5474aeee346e5b56f48339bd413fca25c33aada355069b53021337930b33bd04b5de1e41007d9b5fa
+  data.tar.gz: 17475c5118a332063e18d4547e021dccce597922c589f7e9c819e494b869881e2eaea5ec82b54a364ccfd4b729069e07e02e1593f114ba712f1da2cfbf872394

data/.idea/upi.iml

@@ -23,8 +23,8 @@
     <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.1.1, RVM: ruby-3.1.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rake (v13.2.1, RVM: ruby-3.1.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="regexp_parser (v2.9.2, RVM: ruby-3.1.0) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rqrcode (v1.2.0, RVM: ruby-3.1.0) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rqrcode_core (v0.2.0, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rqrcode (v2.2.0, RVM: ruby-3.1.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rqrcode_core (v1.2.0, RVM: ruby-3.1.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rspec (v3.13.0, RVM: ruby-3.1.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.13.1, RVM: ruby-3.1.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.13.2, RVM: ruby-3.1.0) [gem]" level="application" />
@@ -39,21 +39,21 @@
     <option name="myRootTask">
       <RakeTaskImpl id="rake">
         <subtasks>
-          <RakeTaskImpl description="Build upi-0.1.0.gem into the pkg directory" fullCommand="build" id="build" />
+          <RakeTaskImpl description="Build upi-2.0.0.gem into the pkg directory" fullCommand="build" id="build" />
           <RakeTaskImpl id="build">
             <subtasks>
-              <RakeTaskImpl description="Generate SHA512 checksum if upi-0.1.0.gem into the checksums directory" fullCommand="build:checksum" id="checksum" />
+              <RakeTaskImpl description="Generate SHA512 checksum if upi-2.0.0.gem into the checksums directory" fullCommand="build:checksum" id="checksum" />
             </subtasks>
           </RakeTaskImpl>
           <RakeTaskImpl description="Remove any temporary products" fullCommand="clean" id="clean" />
           <RakeTaskImpl description="Remove any generated files" fullCommand="clobber" id="clobber" />
-          <RakeTaskImpl description="Build and install upi-0.1.0.gem into system gems" fullCommand="install" id="install" />
+          <RakeTaskImpl description="Build and install upi-2.0.0.gem into system gems" fullCommand="install" id="install" />
           <RakeTaskImpl id="install">
             <subtasks>
-              <RakeTaskImpl description="Build and install upi-0.1.0.gem into system gems without network access" fullCommand="install:local" id="local" />
+              <RakeTaskImpl description="Build and install upi-2.0.0.gem into system gems without network access" fullCommand="install:local" id="local" />
             </subtasks>
           </RakeTaskImpl>
-          <RakeTaskImpl description="Create tag v0.1.0 and build and push upi-0.1.0.gem to TODO: Set to your gem server 'https://example.com'" fullCommand="release[remote]" id="release[remote]" />
+          <RakeTaskImpl description="Create tag v2.0.0 and build and push upi-2.0.0.gem to https://rubygems.org" fullCommand="release[remote]" id="release[remote]" />
           <RakeTaskImpl description="Run RuboCop" fullCommand="rubocop" id="rubocop" />
           <RakeTaskImpl id="rubocop">
             <subtasks>

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [2.0.0] - 2024-09-06
+- Add support for changing amounts after initialization
+- Make Merchant Code default 0000 for individual users
+
+## [1.0.2] - 2024-09-05
+- Fixed `generate_qr` method to return the QR code as a string instead of writing it to a file.
+- Updated README with new usage instructions.
+
 ## [1.0.1] - 2024-09-05
 - Linting Fixes
 

data/Gemfile

@@ -11,6 +11,6 @@ gem 'rspec', '~> 3.0'
 
 gem 'rubocop', '~> 1.21'
 
-gem 'rqrcode', '~> 1.1'
+gem 'rqrcode', '2.2.0'
 
 gem 'chunky_png'

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    upi (1.0.2)
+    upi (2.0.1)
       chunky_png
-      rqrcode (~> 1.1)
+      rqrcode (= 2.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -21,10 +21,10 @@ GEM
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.9.2)
-    rqrcode (1.2.0)
+    rqrcode (2.2.0)
       chunky_png (~> 1.0)
-      rqrcode_core (~> 0.2)
-    rqrcode_core (0.2.0)
+      rqrcode_core (~> 1.0)
+    rqrcode_core (1.2.0)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -61,7 +61,7 @@ PLATFORMS
 DEPENDENCIES
   chunky_png
   rake (~> 13.0)
-  rqrcode (~> 1.1)
+  rqrcode (= 2.2.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
   upi!

data/README.md

@@ -20,56 +20,89 @@ Or install it yourself as:
 
 ## Usage
 
-Usage
 Generating a QR Code
 To generate a UPI QR code, you need to initialize the Upi::Generator class with the required parameters and call the generate_qr method.
 
-Example
+### Example
 
-```ruby
-require 'upi'
-```
+Individual Mode:
 
 ### Create a new UPI QR code generator instance
 ```ruby
+require 'upi'
+
 generator = Upi::Generator.new(
   upi_id: 'test@upi',
-  name: 'Test Name',
-  amount: 100,
-  note: 'Test Description'
+  name: 'Test Name'
 )
 
+# NOTE: For Individual Mode the Merchant Code is always 0000 which the code handles by default
+
 ```
 
 ### Generate QR code in SVG format
 ```ruby
-svg_content = generator.generate_qr(mode: :svg)
+svg_content = generator.generate_qr(100, 'Personal Payment', mode: :svg)
 File.write('qr_code.svg', svg_content)
 ```
 
 ### Generate QR code in PNG format
 ```ruby
-png_content = generator.generate_qr(mode: :png)
+png_content = generator.generate_qr(100, 'Personal Payment', mode: :png)
 File.binwrite('qr_code.png', png_content)
 ```
 
 ### Generating a Payment URL
 You can generate a UPI payment URL suitable for use in HTML links by using the generate_url method. This URL can be used as the href attribute in a "Pay Now" button or link.
 
-Example
+```ruby
+# Generate UPI payment URL
+payment_url = generator.upi_content(100, 'Personal Payment')
+puts payment_url
+
+# The generate_url method returns a UPI URI string that can be used as a link in your HTML:
+```
+
+```html
+<a href="<%= payment_url %>">Pay Now</a>
+```
+
+Merchant Mode:
+
+### Create a new UPI QR code generator instance
 ```ruby
 require 'upi'
 
-# Create a new UPI URL generator instance
 generator = Upi::Generator.new(
-    upi_id: 'test@upi',
-    name: 'Test Name',
-    amount: 100,
-    note: 'Test Description'
-    ) 
+  upi_id: 'test@upi',
+  name: 'Test Name',
+  merchant_code: '1234',
+  currency: 'INR'
+)
+
+# NOTE: For Merchant Mode the Merchant Code needs to be set explicitly
+
+```
+
+### Generate QR code in SVG format
+```ruby
+svg_content = generator.generate_qr(500, 'Payment for Goods', transaction_ref_id: 'REF123', transaction_id: 'TXN456', url: 'https://merchant.com/payment', mode: :svg)
+File.write('qr_code_merchant.svg', svg_content)
+```
 
+### Generate QR code in PNG format
+```ruby
+png_content = generator.generate_qr(500, 'Payment for Goods', transaction_ref_id: 'REF123', transaction_id: 'TXN456', url: 'https://merchant.com/payment', mode: :png)
+File.binwrite('qr_code_merchant.png', png_content)
+```
+
+### Generating a Payment URL
+You can generate a UPI payment URL suitable for use in HTML links by using the generate_url method. This URL can be used as the href attribute in a "Pay Now" button or link.
+
+
+```ruby
 # Generate UPI payment URL
-payment_url = generator.generate_url
+payment_url = generator.upi_content(500, 'Payment for Goods', transaction_ref_id: 'REF123', transaction_id: 'TXN456', url: 'https://merchant.com/payment')
 puts payment_url
 
 # The generate_url method returns a UPI URI string that can be used as a link in your HTML:
@@ -118,4 +151,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Upi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/upi/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Upi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/stingrayzboy/upi/blob/master/CODE_OF_CONDUCT.md).

data/lib/upi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Upi
-  VERSION = '1.0.2'
+  VERSION = '2.0.1'
 end

data/lib/upi.rb

@@ -15,14 +15,12 @@ module Upi
   #
   #   generator = Upi::Generator.new(
   #     upi_id: 'test@upi',
-  #     name: 'Test Name',
-  #     amount: 100,
-  #     note: 'Test Description'
+  #     name: 'Test Name'
   #   )
   #
-  #   svg_content = generator.generate_qr(mode: :svg)
-  #   png_content = generator.generate_qr(mode: :png)
-  #   payment_url = generator.generate_url
+  #   svg_content = generator.generate_qr(100, 'Personal Payment', mode: :svg)
+  #   png_content = generator.generate_qr(100, 'Personal Payment', mode: :png)
+  #   payment_url = generator.upi_content(100, 'Personal Payment')
   #
   # Parameters:
   # - `upi_id`: The UPI ID of the recipient.
@@ -38,33 +36,33 @@ module Upi
   # @example
   #   generator = Upi::Generator.new(
   #     upi_id: 'test@upi',
-  #     name: 'Test Name',
-  #     amount: 100
+  #     name: 'Test Name'
   #   )
-  #   svg_content = generator.generate_qr(mode: :svg)
+  #   svg_content = generator.generate_qr(100, 'Personal Payment', mode: :svg)
   #   File.write('qr_code.svg', svg_content)
   #
-  # @see https://www.upi.gov.in/ for more details on UPI protocol
+  # @see https://www.npci.org.in/what-we-do/upi/product-overview for more details on UPI protocol
   class Generator
     attr_reader :params
 
-    def initialize(upi_id:, name:, amount: nil, currency: 'INR', note: '', merchant_code: nil, transaction_ref_id: nil, transaction_id: nil, url: nil)
+    def initialize(upi_id:, name:, currency: 'INR', merchant_code: '0000')
       @params = {
         pa: upi_id,
         pn: name,
-        am: amount,
+        am: '',
         cu: currency,
-        tn: note,
+        tn: '',
         mc: merchant_code,
-        tr: transaction_ref_id,
-        tid: transaction_id,
-        url: url
+        tr: nil,
+        tid: nil,
+        url: nil
       }.compact
     end
 
-    def generate_qr(mode: :svg)
-      content = upi_content
+    def generate_qr(amount = '0', note = '', transaction_ref_id: nil, transaction_id: nil, url: nil, mode: :svg)
+      content = upi_content(amount, note, transaction_ref_id: transaction_ref_id, transaction_id: transaction_id, url: url)
       qrcode = RQRCode::QRCode.new(content)
+      generate_transaction(amount, note, transaction_id, transaction_ref_id, url)
 
       case mode
       when :svg
@@ -92,11 +90,24 @@ module Upi
       end
     end
 
-    def upi_content
+    def upi_content(amount = '0', note = '', transaction_ref_id: nil, transaction_id: nil, url: nil)
+      generate_transaction(amount, note, transaction_id, transaction_ref_id, url)
+
       # Manually construct the UPI URI string without URI::UPI
-      query_string = URI.encode_www_form(params)
+      query_string = URI.encode_www_form(params.reject { |_k, v| v.nil? })
       "upi://pay?#{query_string}"
     end
+
+    private
+
+    def generate_transaction(amount, note, transaction_id, transaction_ref_id, url)
+      @params[:am] = amount
+      @params[:tn] = note
+      @params[:tr] = transaction_ref_id
+      @params[:tid] = transaction_id
+      @params[:url] = url
+      @params
+    end
   end
 
   class Error < StandardError; end

data/sig/upi/generator.rbs

@@ -0,0 +1,15 @@
+module Upi
+  class Generator
+    @params: Hash[Symbol, String]
+
+    attr_reader params: Hash[Symbol, String]
+
+    def generate_qr: -> String
+
+    def upi_content: -> String
+
+    private
+
+    def generate_transaction: -> Hash[Symbol, String]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upi
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.1
 platform: ruby
 authors:
 - Faraz Noor
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-05 00:00:00.000000000 Z
+date: 2024-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chunky_png
@@ -28,16 +28,16 @@ dependencies:
   name: rqrcode
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 2.2.0
 description: This gem generates UPI QR codes for payments. It can be used in e-commerce
   applications to generate QR codes for payments. The QR codes can be scanned by UPI
   apps to make payments. The gem uses the rqrcode gem to generate the QR codes.
@@ -66,6 +66,7 @@ files:
 - lib/upi.rb
 - lib/upi/version.rb
 - sig/upi.rbs
+- sig/upi/generator.rbs
 homepage: https://github.com/stingrayzboy/upi
 licenses:
 - MIT