vpos 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff2cd9a72fe1b6d4f15620e7301b5872f535be5892209bdd4eb55cdc66c0e9aa
+  data.tar.gz: 7ddfa1be6078bf1411d6d8805bdff893aa8c34c93d904616461796aee4d6efb2
+SHA512:
+  metadata.gz: f8a2b905f9ae393f69a8697f6de8d9de09f11b24ee9eee47f7e1e990e17940a4247a7688f7a1a0af70acd0bf14a05e60d3a5f29045bfed5782a3cc221e8d2a40
+  data.tar.gz: 7bb873d2b2644f4f0f0074ea98619ba268ebd9120f4807cabb80f86c9e62b4bc18b12985f14c69fff1a4b72dc418782c957f3214aaa70aa1c5a134b1c0fa3ac6

data/.github/workflows/ruby.yml

@@ -0,0 +1,39 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@21351ecc0a7c196081abca5dc55b08f085efe09a
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake
+      env:
+        MERCHANT_VPOS_TOKEN: ${{ secrets.MERCHANT_VPOS_TOKEN }}
+        GPO_POS_ID: ${{ secrets.GPO_POS_ID }}
+        GPO_SUPERVISOR_CARD: ${{ secrets.GPO_SUPERVISOR_CARD }}
+        VPOS_PAYMENT_CALLBACK_URL: ${{ secrets.VPOS_PAYMENT_CALLBACK_URL }}
+        VPOS_REFUND_CALLBACK_URL: ${{ secrets.VPOS_REFUND_CALLBACK_URL }}

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+*.sassc
+.bundle
+.config
+.yardoc
+.rvmrc
+.rspec
+.sass-cache
+.DS_Store
+Gemfile.lock # gem projects only!
+InstalledFiles
+_yardoc
+doc/
+coverage
+lib/bundler/man
+capybara-*.html
+pkg
+rdoc
+spec/reports
+spec/tmp
+test/tmp
+test/version_tmp
+tmp
+example.rb

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in vpos.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    vpos (0.1.2)
+      httparty (~> 0.18.1)
+      rspec (~> 3.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    multi_xml (0.6.0)
+    rake (10.5.0)
+    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)
+      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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1.4)
+  rake (~> 10.0)
+  vpos!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Sergio Maziano
+
+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,124 @@
+# 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)
+
+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)
+
+Want to know more about how we are empowering merchants in Angola? See our [website](https://vpos.ao)
+
+### Features
+- Simple interface
+- Uniform plain old objects are returned by all official libraries, so you don't have
+to serialize/deserialize the JSON returned by our API.
+
+### Documentation
+Does interacting directly with our API service sound better to you? 
+See our documentation on [developer.vpos.ao](https://developer.vpos.ao)
+
+## Installation
+```ruby
+gem 'vpos'
+```
+
+or 
+
+```ruby
+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`.  |
+
+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
+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.
+
+### Get all Transactions
+This endpoint retrieves all transactions.
+
+```ruby
+require 'vpos'
+transactions = Vpos.get_transactions
+```
+
+### Get a specific Transaction
+Retrieves a transaction given a valid transaction ID.
+
+
+```ruby
+require 'vpos'
+transactions = Vpos.get_transaction("1jHbXEbRTIbbwaoJ6w06nLcRG7X")
+```
+
+| Argument | Description | Type |
+| --- | --- | --- |
+| `id` | An existing Transaction ID | `string`
+
+### New Payment Transaction
+Creates a new payment transaction given a valid mobile number associated with a `MULTICAIXA` account
+and a valid amount.
+
+```ruby
+require 'vpos'
+payment = Vpos.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`
+
+### Request Refund
+Given an existing `parent_transaction_id`, request a refund.
+
+```ruby
+require 'vpos'
+
+refund = Vpos.new_refund("1kTFGhJH8i58uD9MdJpMjWnoE")
+```
+
+| Argument | Description | Type |
+| --- | --- | --- |
+| `parent_transaction_id` | The ID of transaction you wish to refund | `string`
+
+### Poll Transaction Status
+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")
+```
+
+| 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).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/azure-pipelines.yml

@@ -0,0 +1,26 @@
+# 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'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vpos"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/vpos.rb

@@ -0,0 +1,102 @@
+require "vpos/version"
+require "httparty"
+require "securerandom"
+
+module Vpos
+  class Error < StandardError; end
+  include HTTParty
+  follow_redirects false
+
+  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)
+  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
+
+  def self.get_transaction(transaction_id)
+    request = get("#{host}/transactions/#{transaction_id}", set_headers)
+    return_vpos_object(request)
+  end
+
+  def self.get_transactions
+    request = get("#{host}/transactions", set_headers)
+    return_vpos_object(request)
+  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
+  end
+
+  def self.get_request(request_id)
+    request = get("#{host}/requests/#{request_id}", set_headers)
+    return_vpos_object(request)
+  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
+end

data/lib/vpos/version.rb

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

data/tags

@@ -0,0 +1,20 @@
+!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
+!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
+!_TAG_PROGRAM_AUTHOR	Darren Hiebert	/dhiebert@users.sourceforge.net/
+!_TAG_PROGRAM_NAME	Exuberant Ctags	//
+!_TAG_PROGRAM_URL	http://ctags.sourceforge.net	/official site/
+!_TAG_PROGRAM_VERSION	5.9~svn20110310	//
+Error	lib/vpos.rb	/^  class Error < StandardError; end$/;"	c	class:Vpos
+Vpos	lib/vpos.rb	/^module Vpos$/;"	m
+Vpos	lib/vpos/version.rb	/^module Vpos$/;"	m
+default_payment_callback_url	lib/vpos.rb	/^    def self.default_payment_callback_url$/;"	F	class:Vpos
+default_pos_id	lib/vpos.rb	/^    def self.default_pos_id$/;"	F	class:Vpos
+default_refund_callback_url	lib/vpos.rb	/^    def self.default_refund_callback_url$/;"	F	class:Vpos
+default_supervisor_card	lib/vpos.rb	/^    def self.default_supervisor_card$/;"	F	class:Vpos
+get_request	lib/vpos.rb	/^  def self.get_request(location)$/;"	F	class:Vpos
+get_transaction	lib/vpos.rb	/^  def self.get_transaction(transaction_id)$/;"	F	class:Vpos
+get_transactions	lib/vpos.rb	/^  def self.get_transactions$/;"	F	class:Vpos
+new_payment	lib/vpos.rb	/^  def self.new_payment(customer, amount, pos_id: default_pos_id, callback_url: default_payment_callback_url)$/;"	F	class:Vpos
+new_refund	lib/vpos.rb	/^  def self.new_refund(transaction_id, supervisor_card: default_supervisor_card, callback_url: default_refund_callback_url)$/;"	F	class:Vpos
+set_headers	lib/vpos.rb	/^    def self.set_headers$/;"	F	class:Vpos
+set_token	lib/vpos.rb	/^    def self.set_token$/;"	F	class:Vpos

data/vpos.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "vpos/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "vpos"
+  spec.version       = Vpos::VERSION
+  spec.authors       = ["Sergio Maziano"]
+  spec.email         = ["sergio@nextbss.co.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.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  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_dependency "httparty", "~> 0.18.1"
+  spec.add_dependency "rspec", "~> 3.9.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: vpos
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Sergio Maziano
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.
+email:
+- sergio@nextbss.co.ao
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- azure-pipelines.yml
+- bin/console
+- bin/setup
+- lib/vpos.rb
+- lib/vpos/version.rb
+- tags
+- vpos.gemspec
+homepage: https://github.com/nextbss/vpos-ruby
+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.0.3
+signing_key: 
+specification_version: 4
+summary: The one stop shop for online payments in Angola.
+test_files: []