upi 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0e39f9a2fd875f3180e609a85f83ff9655615b6d7a488c7e6c429cf8c13116c
-  data.tar.gz: b022628db4f744f477049ea8dfa9f57359948ff0e55b6c5c02a68ffd16e52855
+  metadata.gz: 9a37c055bc91cf1e03c77c5f34e4faf6d4ab3c9a36040b35666f8852bfb2a393
+  data.tar.gz: 04af7b5a7bbdd2e5de3f6373b81d07f2249f1fedd6c25dedc8f1da126c007abb
 SHA512:
-  metadata.gz: f6d835ac551a922fea2b3b24e3f18f95277895e69953c3516bf80be3e2fe9f0ff38a228e12f9eca7029ad68712d933af78b7fdfe4f40cb1262cbdc21b3cc6c88
-  data.tar.gz: f95200673d9726028e5ed770b6def9dee46ae7f1cdb743f46bbf45a2fb6348dbce129c8a7cd92779d333ab565ec8d5a7d90ea3861d21cd77bdb30c6b1bf12777
+  metadata.gz: 90a0302d1e18d5db151b47d05ea36ee7a4c5b393d2ecfba7fd9ed9dee02eeda464e2f6f021dbe25d9cf2a75e843d523caf3b5950f839917907f7927e408a559f
+  data.tar.gz: fa8833dbdd9ea34ab2cad64af8657d4f088302926cf27119a0b5548111d5874d0f7845ecc3b5ebb8ee260f0426f336e75df8c89ce7e98e1094f16de67b0043bb

data/.rubocop.yml

@@ -3,11 +3,20 @@ AllCops:
 
 Style/StringLiterals:
   Enabled: true
-  EnforcedStyle: double_quotes
+  EnforcedStyle: single_quotes
 
 Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
 Layout/LineLength:
-  Max: 120
+  Max: 300
+
+Metrics/MethodLength:
+  Max: 60
+
+Metrics/BlockLength:
+  Max: 150
+
+Metrics/ParameterLists:
+  Max: 15

data/Gemfile

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in upi.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem 'rake', '~> 13.0'
 
-gem "rspec", "~> 3.0"
+gem 'rspec', '~> 3.0'
 
-gem "rubocop", "~> 1.21"
+gem 'rubocop', '~> 1.21'
 
-gem "rqrcode", "~> 1.1"
+gem 'rqrcode', '~> 1.1'
 
 gem 'chunky_png'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    upi (1.0.0)
+    upi (1.0.1)
       chunky_png
       rqrcode (~> 1.1)
 
@@ -55,6 +55,8 @@ GEM
 
 PLATFORMS
   arm64-darwin-23
+  x86_64-darwin-23
+  x86_64-linux
 
 DEPENDENCIES
   chunky_png

data/README.md

@@ -1,8 +1,6 @@
-# Upi
+# UPI
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/upi`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+The `upi` gem allows you to generate UPI QR codes for user-to-user payments. It supports both PNG and SVG formats for QR codes.
 
 ## Installation
 
@@ -22,7 +20,87 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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
+
+```ruby
+require 'upi'
+```
+
+### Create a new UPI QR code generator instance
+```ruby
+generator = Upi::Generator.new(
+  upi_id: 'test@upi',
+  name: 'Test Name',
+  amount: 100,
+  note: 'Test Description'
+)
+
+```
+
+### Generate QR code in SVG format
+```ruby
+svg_content = generator.generate_qr(mode: :svg)
+File.write('qr_code.svg', svg_content)
+```
+
+### Generate QR code in PNG format
+```ruby
+png_content = generator.generate_qr(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
+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'
+    ) 
+
+# Generate UPI payment URL
+payment_url = generator.generate_url
+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>
+```
+
+#### In the example above:
+
+* Replace `'test@upi'` with the UPI ID of the recipient.
+* Replace `'Test Name'` with the recipient's name.
+* The `amount` parameter specifies the payment amount.
+* `note` is an optional field to include additional information.
+Parameters
+* upi_id: The UPI ID of the recipient.
+* name: The name of the recipient.
+* amount: The amount for the payment (required for UPI transactions).
+* currency: Currency code (default is 'INR').
+* note: Additional note or description for the payment.
+* merchant_code: Optional merchant code.
+* transaction_ref_id: Optional transaction reference ID.
+* transaction_id: Optional transaction ID.
+* url: Optional URL for additional information or payment redirect.
+
+#### Handling PNG and SVG
+You can specify the format of the QR code by using the mode parameter:
+
+* mode: :svg generates an SVG format QR code.
+* mode: :png generates a PNG format QR code.
 
 ## Development
 
@@ -32,7 +110,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/upi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/upi/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/stingrayzboy/upi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/upi/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "upi"
+require 'bundler/setup'
+require 'upi'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require "upi"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/upi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Upi
-  VERSION = "1.0.0"
+  VERSION = '1.0.1'
 end

data/lib/upi.rb

@@ -1,9 +1,48 @@
 # frozen_string_literal: true
 
 require 'rqrcode'
-require_relative "upi/version"
+require_relative 'upi/version'
 
 module Upi
+  # The Generator class is responsible for creating UPI QR codes and payment URLs.
+  #
+  # You can generate a QR code for a UPI payment in either SVG or PNG format,
+  # and also create a UPI payment URL for use in HTML links.
+  #
+  # Example usage:
+  #
+  #   generator = Upi::Generator.new(
+  #     upi_id: 'test@upi',
+  #     name: 'Test Name',
+  #     amount: 100,
+  #     note: 'Test Description'
+  #   )
+  #
+  #   svg_content = generator.generate_qr(mode: :svg)
+  #   png_content = generator.generate_qr(mode: :png)
+  #   payment_url = generator.generate_url
+  #
+  # Parameters:
+  # - `upi_id`: The UPI ID of the recipient.
+  # - `name`: The name of the recipient.
+  # - `amount`: The payment amount (required for UPI transactions).
+  # - `currency`: The currency code (default is 'INR').
+  # - `note`: An optional note or description for the payment.
+  # - `merchant_code`: An optional merchant code.
+  # - `transaction_ref_id`: An optional transaction reference ID.
+  # - `transaction_id`: An optional transaction ID.
+  # - `url`: An optional URL for additional information or payment redirect.
+  #
+  # @example
+  #   generator = Upi::Generator.new(
+  #     upi_id: 'test@upi',
+  #     name: 'Test Name',
+  #     amount: 100
+  #   )
+  #   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
   class Generator
     attr_reader :params
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: upi
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Faraz Noor
@@ -11,33 +11,33 @@ cert_chain: []
 date: 2024-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rqrcode
+  name: chunky_png
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: chunky_png
+  name: rqrcode
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 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.