upi 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71e0504743eed34e876973cbef51a82d05d0f0c2281ec993e0ae40c7af4a161d
-  data.tar.gz: b52d3e506c1f20e52ae4e18403871cae5768d1614d94ab452476e21e809a3593
+  metadata.gz: f8cb1d258db77f6218b9b67f03028bd3d6331d92404cf76f4771af573b3aced4
+  data.tar.gz: 70db7b684507b4323cc783755de003ea6539cca0e96d5618a0b5877da16d280f
 SHA512:
-  metadata.gz: 8c9aad17178913426a3479b69e6bdaa9e7a2fc7384786397b276f8d306716a542b7547c72b5a8ccaac9e6cddb8b402aae59d2eb91aadd4153ea885af201a8970
-  data.tar.gz: 93fd0b0408baf19189852db59044f9119f0529ebd54895cc6deb1da27edad0167b03f7d003ff6d71c6b837ebd647ce9b6c20c8fb533e1079b454d4eaa4683b72
+  metadata.gz: 0430ba92e31a82fc6675d55359e7a07df82ae300c8b9d94bf0a487a900984e768a1f17cb86b40283c63c2fc9d90a11d984244216702b3f84845e1c695277d5e0
+  data.tar.gz: d0c18435b56755bef11c5ee1c177b1826a9f91b19992b04f6d824866d3aab4ac46e459bc349281f2940162daf2ea37b3188037ffdaecdd44df8d5a70395d137e

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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    upi (1.0.2)
+    upi (2.0.0)
       chunky_png
       rqrcode (~> 1.1)
 

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.0'
 end

data/lib/upi.rb

@@ -44,27 +44,28 @@ module Upi
   #   svg_content = generator.generate_qr(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 +93,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.0
 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
@@ -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