momo_pay 2.0 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 643839942d3b6571ca400f5039952dfc3918d7013585c33e16bdadf09d1109a1
-  data.tar.gz: a2b1534be8afd77c8d435e9a95826711195133d70e0e5c6dd4493b18613eca18
+  metadata.gz: 5fb9540eb6689ec86f35720577a724d00af3d778582bfdab5760e0c66cf4c290
+  data.tar.gz: 65d356ef22b59cb92b24be5e35bde13d1d51979841e06ba6b48367c10fc2a6ba
 SHA512:
-  metadata.gz: bf0332013009c0ea9697e86940935375386b24569ef81759100f2a12ecccedd814dbdef54c7cb97b2b14c0dd7c878e945e0ef44b3f7d8a64b45ff2c8bfafd630
-  data.tar.gz: 645384cf12afc022848982110418ae316d2277123b6f8f77753e326525b3e020a9028f87beb748674c8592b534f88e7cb3e88cebfb10d16bf037d8e4af6f921c
+  metadata.gz: dd643be78c06462a2937d5854698d5cc1525ffaa5a57de41e1f49908a6e9b6c2c038d1be3e45d555b291b7fcce70c907e2daa897efd545aa00882ec71834c100
+  data.tar.gz: 3a7fe520788c9431ded03273b7d93b394cfb7974dd0a8b03c285bfeb6983ada02fa238ee62028f97715428149ae50f81b1c1179464ed1b8d9d37083e097442c2

data/README.md

@@ -1,8 +1,5 @@
-# MomoPay
-
-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/momo_pay`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+# API Caller for https://momo.vn
+- API documentation: https://developers.momo.vn
 
 ## Installation
 
@@ -21,23 +18,50 @@ Or install it yourself as:
     $ gem install momo_pay
 
 ## Usage
+#### Setup:
+Add `config/initializers/momo.rb` file with content
+```ruby
+MomoPay.setup do |config|
+  config.domain = Rails.application.secrets.momo_domain
+  config.public_key = Rails.application.secrets.momo_public_key
+  config.secret_key = Rails.application.secrets.momo_secret_key
+  config.partner_code = Rails.application.secrets.momo_partner_code
+  config.partner_name = Rails.application.secrets.momo_partner_name
+end
+```
+#### 1. App-In-App:
+**Request to process transaction:** [detail from Momo](https://developers.momo.vn/#/docs/app_in_app?id=x%e1%bb%ad-l%c3%bd-thanh-to%c3%a1n)
+```ruby
+    response = MomoPay::Mobile.process(
+      partnerRefId: order_number,
+      amount: order_value,
+      appData: momo_token_from_app,
+      customerNumber: momo_phone_from_app
+    )
+```
+=> Example response data
+```ruby
+     {
+       "status"=>0,
+       "message"=>"Thành công",
+       "amount"=>100000,
+       "transid"=>"230.....289",
+       "feeMoMo"=>0,
+       "signature"=>"2ab844bc9ae52.....0d04d85aef836e9"
+     }
+```
+- How to verify response by HMAC-SHA256
+```ruby
+    MomoPay::Signature.verify!(response)
+```
+It will raise `MomoPay::SignatureError` exception when response data is not verified!
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/momo_pay. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
+**Request to confirm transaction:** [detail from Momo](https://developers.momo.vn/#/docs/app_in_app?id=x%c3%a1c-nh%e1%ba%adn-giao-d%e1%bb%8bch)
+```ruby
+    response = MomoPay::Transaction.confirm(
+      partnerRefId: order_number,
+      momoTransId: transid_from_process_output,
+    )
+```
 
-Everyone interacting in the MomoPay project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/momo_pay/blob/master/CODE_OF_CONDUCT.md).
+### To be continued...

data/lib/momo_pay/config.rb

@@ -3,12 +3,15 @@ module MomoPay
 
     attr_accessor :domain
     attr_accessor :public_key
+    attr_accessor :access_key
     attr_accessor :secret_key
     attr_accessor :partner_code
     attr_accessor :partner_name
 
-    attr_accessor :signature_verify_keys
+    attr_accessor :verify_keys
     attr_accessor :signature_confirm_keys
+    attr_accessor :signature_qr_code_keys
+    attr_accessor :signature_one_time_payment_keys
 
     def public_key_pem
       @public_key_pem ||= [
@@ -18,9 +21,21 @@ module MomoPay
       ].join("\n")
     end
 
+    def get_verify_keys!(type)
+      keys = self.verify_keys[type]
+      return keys if keys.is_a?(Array)
+      raise MomoPay::SignatureError, "Verify type `#{type}` is not in #{self.verify_keys.keys.join(', ')}"
+    end
+
     def initialize
-      self.signature_verify_keys = MomoPay::Default::SIGNATURE_VERIFY_KEYS
       self.signature_confirm_keys = MomoPay::Default::SIGNATURE_CONFIRM_KEYS
+      self.signature_qr_code_keys = MomoPay::Default::SIGNATURE_QR_CODE_KEYS
+      self.signature_one_time_payment_keys = MomoPay::Default::SIGNATURE_ONE_TIME_PAYMENT_KEYS
+      self.verify_keys = {
+        mobile: MomoPay::Default::SIGNATURE_MOBILE_VERIFY_KEYS,
+        ipn: MomoPay::Default::SIGNATURE_IPN_VERIFY_KEYS,
+        one_time_payment: MomoPay::Default::SIGNATURE_ONE_TIME_PAYMENT_VERIFY_KEYS,
+      }
     end
 
   end

data/lib/momo_pay/default.rb

@@ -1,8 +1,77 @@
 module MomoPay
   class Default
 
-    SIGNATURE_VERIFY_KEYS = %w(status message amount transid)
-    SIGNATURE_CONFIRM_KEYS = %w(partnerCode partnerRefId requestType requestId momoTransId)
+    SIGNATURE_MOBILE_VERIFY_KEYS = [
+      'status',
+      'message',
+      'amount',
+      'transid',
+    ]
 
+    SIGNATURE_IPN_VERIFY_KEYS = [
+      'partnerCode',
+      'accessKey',
+      'requestId',
+      'amount',
+      'orderId',
+      'orderInfo',
+      'orderType',
+      'transId',
+      'message',
+      'localMessage',
+      'responseTime',
+      'errorCode',
+      'payType',
+      'extraData',
+    ]
+
+    SIGNATURE_CONFIRM_KEYS = [
+      'partnerCode',
+      'partnerRefId',
+      'requestType',
+      'requestId',
+      'momoTransId',
+    ]
+
+    SIGNATURE_QR_CODE_KEYS = [
+      'partnerCode',
+      'accessKey',
+      'requestId',
+      'amount',
+      'orderId',
+      'orderInfo',
+      'returnUrl',
+      'notifyUrl',
+      'extraData',
+    ]
+
+    SIGNATURE_ONE_TIME_PAYMENT_VERIFY_KEYS = [
+      'accessKey',
+      'amount',
+      'extraData',
+      'message',
+      'orderId',
+      'orderInfo',
+      'orderType',
+      'partnerCode',
+      'payType',
+      'requestId',
+      'responseTime',
+      'resultCode',
+      'transId'
+    ]
+
+    SIGNATURE_ONE_TIME_PAYMENT_KEYS = [
+      'accessKey',
+      'amount',
+      'extraData',
+      'ipnUrl',
+      'orderId',
+      'orderInfo',
+      'partnerCode',
+      'redirectUrl',
+      'requestId',
+      'requestType'
+    ]
   end
 end

data/lib/momo_pay/one_time_payment.rb

@@ -0,0 +1,18 @@
+module MomoPay
+  class OneTimePayment
+
+    def self.request(data)
+      data.merge!({
+        requestType: 'captureWallet',
+        accessKey: MomoPay.setup.access_key,
+        partnerCode: MomoPay.setup.partner_code,
+        partnerName: MomoPay.setup.partner_name,
+      })
+      signature = MomoPay::Signature.new(data, MomoPay.setup.signature_one_time_payment_keys).to_s
+      data.merge!(signature: signature)
+
+      MomoPay::Request.post('/v2/gateway/api/create', data)
+    end
+
+  end
+end

data/lib/momo_pay/one_time_payment_signature.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module MomoPay
+  class OneTimePaymentSignature < Signature
+
+    def initialize(data, keys)
+      data.merge!({
+        accessKey: MomoPay.setup.access_key,
+      })
+      @query_string = MomoPay::QueryString.new(data).to_s(keys)
+    end
+
+    def to_s
+      OpenSSL::HMAC.hexdigest("SHA256", MomoPay.setup.secret_key, query_string)
+    end
+
+    private
+
+    attr_reader :query_string
+
+  end
+end
+

data/lib/momo_pay/qr_code.rb

@@ -0,0 +1,17 @@
+module MomoPay
+  class QrCode
+
+    def self.request(data)
+      data.merge!({
+        requestType: 'captureMoMoWallet',
+        accessKey: MomoPay.setup.access_key,
+        partnerCode: MomoPay.setup.partner_code,
+        partnerName: MomoPay.setup.partner_name,
+      })
+      data.merge!(signature: MomoPay::Signature.new(data, MomoPay.setup.signature_qr_code_keys).to_s)
+
+      MomoPay::Request.post('/gw_payment/transactionProcessor', data)
+    end
+
+  end
+end

data/lib/momo_pay/request.rb

@@ -10,5 +10,9 @@ module MomoPay
       response.parse
     end
 
+    def self.random_id
+      "#{Time.now.strftime("%Y%m%d%H%M%S")}#{SecureRandom.hex(2)}"
+    end
+
   end
 end

data/lib/momo_pay/signature.rb

@@ -1,12 +1,11 @@
 module MomoPay
   class Signature
 
-    def self.verify!(data)
-      momo_signature = self.new(data, MomoPay.setup.signature_verify_keys).to_s
+    def self.verify!(data, type)
+      momo_signature = self.new(data, MomoPay.setup.get_verify_keys!(type)).to_s
       data_signature = data['signature'] || data[:signature]
-      if momo_signature != data_signature
-        raise MomoPay::SignatureError.new("#{momo_signature} vs #{data_signature}")
-      end
+      return true if momo_signature == data_signature
+      raise MomoPay::SignatureError, "Gem:#{momo_signature || 'nil'} vs Data:#{data_signature || 'nil'}"
     end
 
     def initialize(data, keys)

data/lib/momo_pay/version.rb

@@ -1,3 +1,3 @@
 module MomoPay
-  VERSION = "2.0"
+  VERSION = "2.0.3"
 end

data/lib/momo_pay.rb

@@ -2,6 +2,7 @@ require "http"
 require 'openssl'
 require 'base64'
 require 'json'
+require 'securerandom'
 
 require "momo_pay/version"
 require "momo_pay/config"
@@ -9,12 +10,15 @@ require "momo_pay/default"
 require "momo_pay/error"
 require "momo_pay/http"
 require "momo_pay/mobile"
+require "momo_pay/qr_code"
 require "momo_pay/query_status"
 require "momo_pay/query_string"
 require "momo_pay/request"
 require "momo_pay/rsa"
 require "momo_pay/signature"
 require "momo_pay/transaction"
+require "momo_pay/one_time_payment"
+require "momo_pay/one_time_payment_signature"
 
 module MomoPay
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: momo_pay
 version: !ruby/object:Gem::Version
-  version: '2.0'
+  version: 2.0.3
 platform: ruby
 authors:
 - KhoaRB
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-01 00:00:00.000000000 Z
+date: 2024-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,6 +73,9 @@ files:
 - lib/momo_pay/error.rb
 - lib/momo_pay/http.rb
 - lib/momo_pay/mobile.rb
+- lib/momo_pay/one_time_payment.rb
+- lib/momo_pay/one_time_payment_signature.rb
+- lib/momo_pay/qr_code.rb
 - lib/momo_pay/query_status.rb
 - lib/momo_pay/query_string.rb
 - lib/momo_pay/request.rb
@@ -88,7 +91,7 @@ metadata:
   homepage_uri: https://github.com/ThanhKhoaIT/momo
   source_code_uri: https://github.com/ThanhKhoaIT/momo
   changelog_uri: https://github.com/ThanhKhoaIT/momo
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,8 +106,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Momo wallet SDK for RUBY
 test_files: []