offsite_payments_latipay 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ecf683c3c4de93947bb41644d46081b0a9bf637f78262140b1af9f0abacd4259
+  data.tar.gz: 53e6339b948cf9476a49fb2c15f6b6f459260a8f86776d950048829095683f33
+SHA512:
+  metadata.gz: 67d8fbe0faef544cb5a0c6d214e6bc78ecdc956feaf102c9680e9f3505a822f51f9cb9566cae509075c14e7c05a1ee28407764dd261eb65ad946adc01c137478
+  data.tar.gz: 636ee0f0d2cfb1f20b25d332f50546f20960d1eedc5ff859c0664ca2cfe6e8245333c9eee62065b3435793d9fa6201c471b42e6a58c937c11b3d67e7e8375f3f

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 SeaLink
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# Offsite Payments
+
+[![Gem Version](https://badge.fury.io/rb/offsite_payments_latipay.svg)](http://badge.fury.io/rb/offsite_payments_latipay)
+[![Build Status](https://github.com/sealink/offsite_payments_latipay/workflows/Build%20and%20Test/badge.svg?branch=master)](https://github.com/sealink/offsite_payments_latipay/actions)
+
+
+Offsite Payments is an extraction from the ecommerce system [Shopify](http://www.shopify.com). Shopify's requirements for a simple and unified API to handle dozens of different offsite payment pages (often called hosted payment pages) with very different exposed APIs was the chief principle in designing the library.
+
+It was developed for usage in Ruby on Rails web applications and integrates seamlessly
+as a Rails plugin. It should also work as a stand alone Ruby library, but much of the benefit is in the ActionView helpers which are Rails-specific.
+
+This gem provides integration for [Latipay Payments](https://www.latipay.net/)
+through the Offsite Payments gem.
+
+## Installation
+
+### From Git
+
+You can check out the latest source from git:
+
+    git clone https://github.com/sealink/offsite_payments_latipay.git
+
+### From RubyGems
+
+Installation from RubyGems:
+
+    gem install offsite_payments_latipay
+
+Or, if you're using Bundler, just add the following to your Gemfile:
+
+    gem 'offsite_payments_latipay'
+
+## Misc.
+
+- This library is MIT licensed.
+
+## Release
+
+To publish a new version of this gem the following steps must be taken.
+
+- Update the version in the following files
+  ```
+    CHANGELOG.md
+    lib/offsite_payments_latipay/version.rb
+  ```
+- Create a tag using the format v0.1.0
+- Follow build progress in GitHub actions

data/lib/offsite_payments/integrations/latipay.rb

@@ -0,0 +1,247 @@
+module OffsitePayments
+  module Integrations
+    module Latipay
+
+      def self.notification(post, options = {})
+        Notification.new(post, options)
+      end
+
+      def self.return(query_string, options = {})
+        Return.new(query_string, options)
+      end
+
+      class Interface
+        include ActiveUtils::PostsData # ssl_get/post
+
+        def self.base_url
+          "https://api.latipay.net/v2"
+        end
+
+        def initialize(api_key, user_id)
+          @api_key = api_key
+          @user_id = user_id
+        end
+
+        def sign(fields)
+          message = fields.compact.sort.map{ |k,v| "#{k.to_s}=#{v}" }.join('&').concat(@api_key)
+          OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA256.new, @api_key, message)
+        end
+  
+        def verify_signature(message, signature)
+          signature == OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA256.new, @api_key, message)
+        end
+
+        private
+
+        def standard_headers
+          {
+            'Content-Type' => 'application/json'
+          }
+        end
+
+        def parse_response(raw_response)
+          JSON.parse(raw_response)
+        end
+
+        class RequestError < StandardError
+          attr_reader :exception, :message, :response_code
+
+          def initialize(response)
+            @response      = response
+            @response_code = @response['code']
+            @success       = @response_code == '0'
+            @message       = @response['message']
+          end
+
+          # Latipay doesn't provide error codes for each interface, this is the only list for all the errors.
+          ERRORS = {
+            '201' => 'order not exist',
+            '204' => 'Some fields from input are null',
+            '205' => 'Cannot find out corresponding key for the user code or user is disabled or user is not activity',
+            '206' => 'Signature from Merchant request is wrong',
+            '207' => 'Param is wrong',
+            '300' => 'Gateway not exist',
+            '301' => 'Wrong account info or currency info',
+            '302' => 'Paycompany not exist',
+            '303' => 'Wrong pay type from merchant',
+            '304' => 'Wallet does not support this payment method',
+            '305' => 'No margin plan for the merchant',
+            '450' => 'Wallet not assign to user',
+            '1'   => 'FAIL'
+          }
+
+          def success?
+            !!@success
+          end
+
+          def errors
+            fail NotImplementedError, "This method must be implemented on the subclass"
+          end
+
+          def error_code_text
+            errors[@response_code]
+          end
+        end
+      end
+
+      class TransactionInterface < Interface
+        def self.url
+          "#{base_url}/transaction"
+        end
+
+        def call(options)
+          options[:signature] = self.sign(options)
+          raw_response = ssl_post(self.class.url, options.to_json, standard_headers)
+          parsed_response = parse_response(raw_response)
+          validate_response(parsed_response)
+          "#{parsed_response['host_url']}/#{parsed_response['nonce']}"
+        end
+
+        def validate_response(parsed_response)
+          raise TransactionRequestError, parsed_response unless parsed_response['code'] == 0
+          message = parsed_response['nonce'] + parsed_response['host_url']
+          signature = parsed_response['signature']
+          raise StandardError, 'Invalid Signature in response' unless verify_signature(message, signature)
+        end
+
+        class TransactionRequestError < RequestError
+          def errors
+            ERRORS
+          end
+        end
+      end
+
+      class QueryInterface < Interface
+        def self.url(merchant_reference)
+          "#{base_url}/transaction/#{CGI.escape(merchant_reference)}"
+        end
+
+        def call(merchant_reference)
+          options = { user_id: @user_id }
+          signature = self.sign(options.merge({ merchant_reference: merchant_reference }))
+          options[:signature] = signature
+
+          raise ArgumentError, "Merchant reference must be specified" if merchant_reference.blank?
+          url = "#{self.class.url(merchant_reference)}?#{options.to_query}"
+          raw_response = ssl_get(url, standard_headers)
+          parsed_response = parse_response(raw_response)
+          validate_response(parsed_response)
+          parsed_response
+        end
+
+        def validate_response(parsed_response)
+          raise QueryRequestError, parsed_response unless parsed_response['code'] == 0
+          message = "#{parsed_response['merchant_reference']}#{parsed_response['payment_method']}#{parsed_response['status']}#{parsed_response['currency']}#{parsed_response['amount']}"
+          signature = parsed_response['signature']
+          raise StandardError, 'Invalid Signature in response' unless verify_signature(message, signature)
+        end
+
+        class QueryRequestError < RequestError
+          def errors
+            ERRORS
+          end
+        end
+      end
+
+      class RefundInterface < Interface
+        def self.url
+          # according to latipay doc, this url does not have a version part.
+          "https://api.latipay.net/refund"
+        end
+
+        def call(order_id, refund_amount, reference = '')
+          raise ArgumentError, "Order ID must be specified" if order_id.blank?
+          raise ArgumentError, "Refund amount must be specified" if refund_amount.blank?
+          options = { refund_amount: refund_amount, reference: reference, user_id: @user_id, order_id: order_id }
+          options[:signature] = self.sign(options)
+          raw_response = ssl_post(self.class.url, options.to_json, standard_headers)
+          parsed_response = parse_response(raw_response)
+          validate_response(parsed_response)
+          parsed_response['message']
+        end
+
+        def validate_response(parsed_response)
+          raise RefundRequestError, parsed_response unless parsed_response['code'] == 0
+        end
+
+        class RefundRequestError < RequestError
+          def errors
+            ERRORS
+          end
+        end
+      end
+
+      class Helper < OffsitePayments::Helper
+        def initialize(order, credentials, options = {})
+          @api_key = credentials.fetch(:api_key)
+          @user_id = credentials.fetch(:user_id)
+          super(order, credentials.fetch(:user_id), options.except(
+            :payment_method, :ip, :product_name
+          ))
+
+          add_field 'version', '2.0'
+          add_field 'payment_method', options.fetch(:payment_method)
+          add_field 'ip', options.fetch(:ip)
+          add_field 'product_name', options.fetch(:product_name)
+          add_field 'callback_url', options.fetch(:callback_url) { options.fetch(:return_url) }
+          add_field 'wallet_id', credentials.fetch(:wallet_id)
+          add_field 'amount', options.fetch(:amount)
+          add_field 'return_url', options.fetch(:return_url)
+        end
+
+        mapping :order, 'merchant_reference'
+        mapping :account, 'user_id'
+
+
+        def transaction_url
+          if form_fields['payment_method'] == 'wechat'
+            form_fields.merge!({ 'present_qr' => '1' })
+          end
+          TransactionInterface.new(@api_key, @user_id).call(form_fields)
+        end
+      end
+
+      class Notification < OffsitePayments::Notification
+        def initialize(params, credentials = {})
+          token = params.fetch('Token') { params.fetch('token') }
+          @params = QueryInterface.new(credentials.fetch(:api_key), credentials.fetch(:user_id)).call(token)
+        end
+
+        def complete?
+          params['status'] == 'paid'
+        end
+
+        def transaction_id
+          params['order_id']
+        end
+
+        # the money amount we received in X.2 decimal.
+        def gross
+          params['amount']
+        end
+
+        def status
+          params['status']
+        end
+
+        # Acknowledge the transaction to Latipay. This method has to be called after a new
+        # apc arrives. Latipay will verify that all the information we received are correct and will return a
+        # ok or a fail.
+        #
+        # Example:
+        #
+        #   def ipn
+        #     notify = LatipayNotification.new(request.raw_post)
+        #
+        #     if notify.acknowledge
+        #       ... process order ... if notify.complete?
+        #     else
+        #       ... log possible hacking attempt ...
+        #     end
+        def acknowledge(authcode = nil)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/offsite_payments/version.rb

@@ -0,0 +1,7 @@
+module OffsitePayments
+  module Integration
+    module Latipay
+      VERSION = '0.2.0'
+    end
+  end
+end

data/lib/offsite_payments_latipay.rb

@@ -0,0 +1,4 @@
+class OffsitePaymentsLatipay
+  require 'offsite_payments'
+  require_relative 'offsite_payments/integrations/latipay'
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: offsite_payments_latipay
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Zheng Jing
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: offsite_payments
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem extends the activemerchant offsite_payments gem providing integration
+  of Latipay.
+email: zheng.jing@sealink.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/offsite_payments/integrations/latipay.rb
+- lib/offsite_payments/version.rb
+- lib/offsite_payments_latipay.rb
+homepage: https://github.com/sealink/offsite_payments_latipay
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Latipay integration for the activemerchant offsite_payments gem.
+test_files: []