vpos 0.1.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff2cd9a72fe1b6d4f15620e7301b5872f535be5892209bdd4eb55cdc66c0e9aa
-  data.tar.gz: 7ddfa1be6078bf1411d6d8805bdff893aa8c34c93d904616461796aee4d6efb2
+  metadata.gz: 4afd795dda51f97e50f6cd03781acca39a4f5d36619bddfe55d4515ad8506f5f
+  data.tar.gz: 3f7553fc7b5705c86c074c0e76fce57528683cb81ca1c3ec1192e6ef6f00e9c0
 SHA512:
-  metadata.gz: f8a2b905f9ae393f69a8697f6de8d9de09f11b24ee9eee47f7e1e990e17940a4247a7688f7a1a0af70acd0bf14a05e60d3a5f29045bfed5782a3cc221e8d2a40
-  data.tar.gz: 7bb873d2b2644f4f0f0074ea98619ba268ebd9120f4807cabb80f86c9e62b4bc18b12985f14c69fff1a4b72dc418782c957f3214aaa70aa1c5a134b1c0fa3ac6
+  metadata.gz: d1d4d000a8aa386223660b120a015dd0bb45a7092355d22d7ad097a4add8bd31314891f976faca280c07c88bc2f8b234d0ce07db68265bb244331ca926ba10f2
+  data.tar.gz: 817be562e7dfcacaf0bbad89a71bbd6a2e9f5c0b2385b360803795cb0d1293f3d0dcfb01ac3a55b11d4052af74dea307fa58ef56841426dbbd3377c6eb8be5ba

data/.github/workflows/ruby.yml

@@ -30,7 +30,7 @@ jobs:
     - name: Install dependencies
       run: bundle install
     - name: Run tests
-      run: bundle exec rake
+      run: rspec
       env:
         MERCHANT_VPOS_TOKEN: ${{ secrets.MERCHANT_VPOS_TOKEN }}
         GPO_POS_ID: ${{ secrets.GPO_POS_ID }}

data/.gitignore

@@ -23,3 +23,4 @@ test/tmp
 test/version_tmp
 tmp
 example.rb
+.idea

data/.ruby-version

@@ -0,0 +1 @@
+2.5.8

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    vpos (0.1.2)
+    vpos (1.0.3)
       httparty (~> 0.18.1)
-      rspec (~> 3.9.0)
+      rspec (~> 3.9, >= 3.9.0)
 
 GEM
   remote: https://rubygems.org/
@@ -14,30 +14,30 @@ GEM
       multi_xml (>= 0.5.2)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.0512)
+    mime-types-data (3.2021.0225)
     multi_xml (0.6.0)
-    rake (10.5.0)
+    rake (12.3.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
     rspec-core (3.9.3)
       rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec-expectations (3.9.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+    rspec-support (3.9.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.1.4)
-  rake (~> 10.0)
+  bundler (~> 2.2, >= 2.2.3)
+  rake (~> 12.3, >= 12.3.3)
   vpos!
 
 BUNDLED WITH
-   2.1.4
+   2.2.6

data/README.md

@@ -1,14 +1,14 @@
 # vPOS Ruby
-
-![Azure Build](https://dev.azure.com/next-solutions/vpos/_apis/build/status/vpos%20-%20sdk%20-%20ruby?branchName=main)
-[![](https://img.shields.io/badge/nextbss-opensource-blue.svg)](https://www.nextbss.co.ao)
+[![Ruby](https://github.com/v-pos/vpos-ruby/actions/workflows/ruby.yml/badge.svg?branch=main)](https://github.com/v-pos/vpos-ruby/actions/workflows/ruby.yml)
+[![Gem Version](https://badge.fury.io/rb/vpos.svg)](https://badge.fury.io/rb/vpos)
+[![](https://img.shields.io/badge/vPOS-OpenSource-blue.svg)](https://www.nextbss.co.ao)
 
 This ruby library helps you easily interact with the vPOS API,
 Allowing merchants apps/services to request a payment from a client through his/her mobile phone number.
 
 The service currently works for solutions listed below:
 
-EMIS (Multicaixa Express)
+- EMIS GPO (Multicaixa Express)
 
 Want to know more about how we are empowering merchants in Angola? See our [website](https://vpos.ao)
 
@@ -23,50 +23,74 @@ See our documentation on [developer.vpos.ao](https://developer.vpos.ao)
 
 ## Installation
 ```ruby
-gem 'vpos'
+gem 'vpos', '~> 1.0.0'
 ```
 
 or 
 
 ```ruby
-gem install `vpos`
+gem install vpos
 ```
 
 ### Configuration
-This ruby library requires you set up the following environment variables on your machine before
-interacting with the API using this library:
-
-| Variable | Description
-| --- | --- | 
-| `GPO_POS_ID` | The Point of Sale ID provided by EMIS |
-| `GPO_SUPERVISOR_CARD` | The Supervisor card ID provided by EMIS |
-| `MERCHANT_VPOS_TOKEN` | The API token provided by vPOS |
-| `PAYMENT_CALLBACK_URL` | The URL that will handle payment notifications |
-| `REFUND_CALLBACK_URL` | The URL that will handle refund notifications |
-| `VPOS_ENVIRONMENT` | The vPOS environment, leave empty for `sandbox` mode and use `"prd"` for `production`.  |
+This ruby library requires you to have:
+- POS_ID provided by EMIS that can be requested through your support bank.
+- Supervisor Card provided by EMIS that can be requested through your support bank.
+- Token provided by vPOS that can be generated through vPOS [merchant](https://merchant.vpos.ao) portal.
 
 Don't have this information? [Talk to us](suporte@vpos.ao)
 
-Given you have set up all the environment variables above with the correct information, you will now
+Given you have all the requirements above, you will now
 be able to authenticate and communicate effectively with our API using this library. 
 
-The next section will show the various payment actions that can be performed by you, the merchant.
+The next section will show the various actions that can be performed by you, the merchant.
+
+## Use
+### Create Instance
+
+```ruby
+require 'vpos'
+
+# use the default environment variables option
+merchant = Vpos.new
+
+# or use optional arguments option
+merchant = Vpos.new(token: 'your_token_here', environment: 'PRD')
+```
+
+#### Environment variables
+| Variable | Description | Required |
+| --- | --- | --- |
+| `GPO_POS_ID` | The Point of Sale ID provided by EMIS | true |
+| `GPO_SUPERVISOR_CARD` | The Supervisor card ID provided by EMIS | true |
+| `MERCHANT_VPOS_TOKEN` | The API token provided by vPOS | true |
+| `PAYMENT_CALLBACK_URL` | The URL that will handle payment notifications | false |
+| `REFUND_CALLBACK_URL` | The URL that will handle refund notifications | false |
+
+or using one of the optional arguments
+
+#### Optional Arguments
+| Argument | Description | Type |
+| --- | --- | --- |
+| `token` | Token generated at [vPOS](https://merchant.vpos.ao) dashboard | `string`
+| `pos_id` | Merchant POS ID provided by EMIS | `string`
+| `supervisor_card` | Merchant Supervisor Card number provided by EMIS | `string`
+| `payment_callback_url` | Merchant application JSON endpoint to accept the callback payment response | `string`
+| `refund_callback_url` | Merchant application JSON endpoint to accept the callback refund response | `string`
+| `environment` | The vPOS environment, leave empty for `sandbox` mode and use `"PRD"` for `production`.  | `string` |
 
 ### Get all Transactions
 This endpoint retrieves all transactions.
 
 ```ruby
-require 'vpos'
-transactions = Vpos.get_transactions
+transaction = merchant.get_transactions
 ```
 
 ### Get a specific Transaction
 Retrieves a transaction given a valid transaction ID.
 
-
 ```ruby
-require 'vpos'
-transactions = Vpos.get_transaction("1jHbXEbRTIbbwaoJ6w06nLcRG7X")
+transaction = merchant.get_transaction('1jHbXEbRTIbbwaoJ6w06nLcRG7X')
 ```
 
 | Argument | Description | Type |
@@ -78,22 +102,19 @@ Creates a new payment transaction given a valid mobile number associated with a
 and a valid amount.
 
 ```ruby
-require 'vpos'
-payment = Vpos.new_payment("900111222", "123.45")
+payment = merchant.new_payment('900111222', '123.45')
 ```
 
 | Argument | Description | Type |
 | --- | --- | --- |
 | `mobile` | The mobile number of the client who will pay | `string`
-| `amount` | The amount the client should pay, eg. "259.99", "259,000.00" | `string`
+| `amount` | The amount the client should pay, eg. "259.99", "259000.00" | `string`
 
 ### Request Refund
 Given an existing `parent_transaction_id`, request a refund.
 
 ```ruby
-require 'vpos'
-
-refund = Vpos.new_refund("1kTFGhJH8i58uD9MdJpMjWnoE")
+refund = merchant.new_refund('1kTFGhJH8i58uD9MdJpMjWnoE')
 ```
 
 | Argument | Description | Type |
@@ -106,19 +127,17 @@ Poll the status of a transaction given a valid `request_id`.
 Note: The `request_id` in this context is essentially the `transaction_id` of an existing request. 
 
 ```ruby
-require 'vpos'
-transactions = Vpos.get_request("1jHbXEbRTIbbwaoJ6w06nLcRG7X")
+transaction = merchant.get_request('1jHbXEbRTIbbwaoJ6w06nLcRG7X')
 ```
 
 | Argument | Description | Type |
 | --- | --- | --- |
 | `request_id` | The ID of transaction you wish to poll | `string`
 
-
 ### Have any doubts?
 In case of any doubts, bugs, or the like, please leave an issue. We would love to help.
 
 License
 ----------------
 
-The library is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The library is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/vpos/version.rb

@@ -1,3 +1,3 @@
-module Vpos
-  VERSION = "0.1.2"
+module VposModule
+  VERSION = "1.0.4"
 end

data/lib/vpos.rb

@@ -1,102 +1,38 @@
-require "vpos/version"
-require "httparty"
-require "securerandom"
+require_relative "vpos_module"
 
-module Vpos
-  class Error < StandardError; end
-  include HTTParty
-  follow_redirects false
+class Vpos
+  include VposModule
 
-  def self.new_payment(customer, amount, pos_id: default_pos_id, callback_url: default_payment_callback_url)
-    content = set_headers
-    content[:body] = {type:"payment", pos_id: pos_id, mobile: customer, amount: amount, callback_url: callback_url}.to_json
-    request = post("#{host}/transactions", content)
-    return_vpos_object(request)
+  def initialize(token: set_token, pos_id: default_pos_id, supervisor_card: default_supervisor_card, payment_callback_url: default_payment_callback_url, refund_callback_url: default_refund_callback_url)
+    @token = token
+    @pos_id = pos_id
+    @supervisor_card = supervisor_card
+    @payment_callback_url = payment_callback_url
+    @refund_callback_url = refund_callback_url
   end
 
-  def self.new_refund(transaction_id, supervisor_card: default_supervisor_card, callback_url: default_refund_callback_url)
-    content = set_headers
-    content[:body] = {type: "refund", parent_transaction_id: transaction_id, supervisor_card: supervisor_card, callback_url: callback_url}.to_json
-    request = post("#{host}/transactions", content)
-    return_vpos_object(request)
-  end
+  private
 
-  def self.get_transaction(transaction_id)
-    request = get("#{host}/transactions/#{transaction_id}", set_headers)
-    return_vpos_object(request)
+  def default_pos_id
+    pos_id = ENV['GPO_POS_ID']
+    "#{pos_id}".to_i
   end
 
-  def self.get_transactions
-    request = get("#{host}/transactions", set_headers)
-    return_vpos_object(request)
+  def default_supervisor_card
+    supervisor_card = ENV['GPO_SUPERVISOR_CARD']
+    "#{supervisor_card}"
   end
 
-  def self.get_request_id(request)
-    if request[:location].nil?
-      get("#{host}/references/invalid", set_headers)
-    else
-      if request[:status] == 202
-        request[:location].gsub("/api/v1/requests/", "")
-      else
-        request[:location].gsub("/api/v1/transactions/", "")
-      end
-    end
+  def set_token
+    token = ENV['MERCHANT_VPOS_TOKEN']
+    "Bearer #{token}"
   end
 
-  def self.get_request(request_id)
-    request = get("#{host}/requests/#{request_id}", set_headers)
-    return_vpos_object(request)
+  def default_payment_callback_url
+    ENV['PAYMENT_CALLBACK_URL']
   end
 
-  private
-    def self.return_vpos_object(request)
-      case request.response.code.to_i
-      when 200, 201
-        return {status: request.response.code.to_i, message: request.response.message, data: request.parsed_response}
-      when 202, 303
-        return {status: request.response.code.to_i, message: request.response.message, location: request.headers["location"]}
-      else
-        return {status: request.response.code.to_i, message: request.response.message, details: request.parsed_response["errors"]}
-      end
-    end
-
-    def self.set_headers
-      content = {}
-      headers = {'Content-Type' => "application/json", 'Accept' => "application/json", 'Authorization' => set_token, 'Idempotency-Key' => SecureRandom.uuid}
-      content[:headers] = headers
-      return content
-    end
-
-    def self.default_pos_id
-      pos_id = ENV["GPO_POS_ID"]
-      return "#{pos_id}".to_i
-    end
-
-    def self.default_supervisor_card
-      supervisor_card = ENV["GPO_SUPERVISOR_CARD"]
-      return "#{supervisor_card}"
-    end
-    
-    def self.set_token
-      token = ENV["MERCHANT_VPOS_TOKEN"]
-      return "Bearer #{token}"
-    end
-
-    def self.default_payment_callback_url
-      url = ENV["PAYMENT_CALLBACK_URL"]
-      return url
-    end
-
-    def self.default_refund_callback_url
-      url = ENV["REFUND_CALLBACK_URL"]
-      return url
-    end
-
-    def self.host
-      if ENV["VPOS_ENVIRONMENT"] == "prd"
-        return "https://api.vpos.ao/api/v1"
-      else
-        return "https://sandbox.vpos.ao/api/v1"
-      end
-    end
+  def default_refund_callback_url
+    ENV['REFUND_CALLBACK_URL']
+  end
 end

data/lib/vpos_module.rb

@@ -0,0 +1,73 @@
+require "vpos/version"
+require "httparty"
+require "securerandom"
+
+module VposModule
+  class Error < StandardError; end
+  include HTTParty
+  follow_redirects false
+
+  def new_payment(customer, amount, pos_id: @pos_id, callback_url: @payment_callback_url)
+    content = set_headers
+    content[:body] = {type:"payment", pos_id: pos_id, mobile: customer, amount: amount, callback_url: callback_url}.to_json
+    request = HTTParty.post("#{host}/transactions", content)
+    return_vpos_object(request)
+  end
+
+  def new_refund(transaction_id, supervisor_card: @supervisor_card, callback_url: @refund_callback_url)
+    content = set_headers
+    content[:body] = {type: "refund", parent_transaction_id: transaction_id, supervisor_card: supervisor_card, callback_url: callback_url}.to_json
+    request = HTTParty.post("#{host}/transactions", content)
+    return_vpos_object(request)
+  end
+
+  def get_transaction(transaction_id)
+    request = HTTParty.get("#{host}/transactions/#{transaction_id}", set_headers)
+    return_vpos_object(request)
+  end
+
+  def get_transactions
+    request = HTTParty.get("#{host}/transactions", set_headers)
+    return_vpos_object(request)
+  end
+
+  def get_request_id(response)
+    if response[:location].nil?
+      HTTParty.get("#{host}/references/invalid", set_headers)
+    else
+      if response[:status_code] == 202
+        response[:location].gsub("/api/v1/requests/", "")
+      else
+        response[:location].gsub("/api/v1/transactions/", "")
+      end
+    end
+  end
+
+  def get_request(request_id)
+    request = HTTParty.get("#{host}/requests/#{request_id}", set_headers)
+    return_vpos_object(request)
+  end
+
+  private
+    def return_vpos_object(request)
+      case request.response.code.to_i
+      when 200, 201
+        return {status_code: request.response.code.to_i, message: request.response.message, data: request.parsed_response}
+      when 202, 303
+        return {status_code: request.response.code.to_i, message: request.response.message, location: request.headers["location"]}
+      else
+        return {status_code: request.response.code.to_i, message: request.response.message, details: request.parsed_response["errors"]}
+      end
+    end
+
+    def set_headers
+      content = {}
+      headers = {'Content-Type' => "application/json", 'Accept' => "application/json", 'Authorization' => @token, 'Idempotency-Key' => SecureRandom.uuid}
+      content[:headers] = headers
+      content
+    end
+
+    def host
+      "https://vpos.ao/api/v1"
+    end
+end

data/vpos.gemspec

@@ -4,13 +4,13 @@ require "vpos/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "vpos"
-  spec.version       = Vpos::VERSION
+  spec.version       = VposModule::VERSION
   spec.authors       = ["Sergio Maziano"]
-  spec.email         = ["sergio@nextbss.co.ao"]
+  spec.email         = ["sergio.maziano@vpos.ao"]
 
   spec.summary       = %q{The one stop shop for online payments in Angola.}
-  spec.description   = %q{The one stop shop for online payments in Angola. This gem allows you process payments requests from EMIS GPO through vPOS.}
-  spec.homepage      = "https://github.com/nextbss/vpos-ruby"
+  spec.description   = %q{The one stop shop for online payments in Angola, allowing you to process payments requests from EMIS GPO through vPOS.}
+  spec.homepage      = "https://github.com/v-pos/vpos-ruby"
   spec.license       = "MIT"
 
   # Specify which files should be added to the gem when it is released.
@@ -22,8 +22,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 2.1.4"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", '~> 2.2', '>= 2.2.3'
+  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
   spec.add_dependency "httparty", "~> 0.18.1"
-  spec.add_dependency "rspec", "~> 3.9.0"
-end
+  spec.add_dependency "rspec", '~> 3.9', ">= 3.9.0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vpos
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Sergio Maziano
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -57,6 +69,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.9.0
   type: :runtime
@@ -64,31 +79,35 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.9.0
-description: The one stop shop for online payments in Angola. This gem allows you
-  process payments requests from EMIS GPO through vPOS.
+description: The one stop shop for online payments in Angola, allowing you to process
+  payments requests from EMIS GPO through vPOS.
 email:
-- sergio@nextbss.co.ao
+- sergio.maziano@vpos.ao
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- azure-pipelines.yml
 - bin/console
 - bin/setup
 - lib/vpos.rb
 - lib/vpos/version.rb
+- lib/vpos_module.rb
 - tags
 - vpos.gemspec
-homepage: https://github.com/nextbss/vpos-ruby
+homepage: https://github.com/v-pos/vpos-ruby
 licenses:
 - MIT
 metadata: {}
@@ -107,7 +126,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: The one stop shop for online payments in Angola.

data/azure-pipelines.yml

@@ -1,26 +0,0 @@
-# Ruby
-# Package your Ruby project.
-# Add steps that install rails, analyze code, save build artifacts, deploy, and more:
-# https://docs.microsoft.com/azure/devops/pipelines/languages/ruby
-
-trigger:
-- main
-
-pool:
-  vmImage: 'ubuntu-latest'
-
-steps:
-- task: UseRubyVersion@0
-  inputs:
-    versionSpec: '>= 2.5'
-
-- script: |
-    gem install bundler
-    bundle install --retry=3 --jobs=4
-  displayName: 'Install Bundler'
-
-- script: |
-    gem install rspec
-
-- script: bundle exec rspec
-  displayName: 'Run Tests'