vpos 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff2cd9a72fe1b6d4f15620e7301b5872f535be5892209bdd4eb55cdc66c0e9aa
-  data.tar.gz: 7ddfa1be6078bf1411d6d8805bdff893aa8c34c93d904616461796aee4d6efb2
+  metadata.gz: 89cc2923597e888adbd3b0ed950546c4aa62e91912cceff1406de414452f2b1c
+  data.tar.gz: de0949ee1d315d7e8f000320c0b28bfa4dc7b0127fe7fd715a502225e515209d
 SHA512:
-  metadata.gz: f8a2b905f9ae393f69a8697f6de8d9de09f11b24ee9eee47f7e1e990e17940a4247a7688f7a1a0af70acd0bf14a05e60d3a5f29045bfed5782a3cc221e8d2a40
-  data.tar.gz: 7bb873d2b2644f4f0f0074ea98619ba268ebd9120f4807cabb80f86c9e62b4bc18b12985f14c69fff1a4b72dc418782c957f3214aaa70aa1c5a134b1c0fa3ac6
+  metadata.gz: 27485c1d09f1f010d6499e081dd39a86c18241dbc9d2c105795f58c636df36f6e550543397be28f4180dcb52f94883f7fc55bf32e9575989983503d4c30ea121
+  data.tar.gz: 7199d91f1e2e7421770f2f1f07c692761ed090cec9f84e795ea645348e6647e54dce341ca7f3e66dfed703e8f2049725b7cf57189e952610f191b4d9a18f8294

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vpos (0.1.2)
+    vpos (0.1.3)
       httparty (~> 0.18.1)
       rspec (~> 3.9.0)
 
@@ -14,7 +14,7 @@ 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.2020.1104)
     multi_xml (0.6.0)
     rake (10.5.0)
     rspec (3.9.0)
@@ -23,13 +23,13 @@ GEM
       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

data/README.md

@@ -1,6 +1,7 @@
 # vPOS Ruby
 
-![Azure Build](https://dev.azure.com/next-solutions/vpos/_apis/build/status/vpos%20-%20sdk%20-%20ruby?branchName=main)
+![Ruby](https://github.com/nextbss/vpos-ruby/workflows/Ruby/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/vpos.svg)](https://badge.fury.io/rb/vpos)
 [![](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,
@@ -23,27 +24,27 @@ See our documentation on [developer.vpos.ao](https://developer.vpos.ao)
 
 ## Installation
 ```ruby
-gem 'vpos'
+gem 'vpos', '~> 0.1.2'
 ```
 
 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`.  |
+| 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 |
+| `VPOS_ENVIRONMENT` | The vPOS environment, leave empty for `sandbox` mode and use `"prd"` for `production`.  | false |
 
 Don't have this information? [Talk to us](suporte@vpos.ao)
 

data/lib/vpos.rb

@@ -1,102 +1,5 @@
-require "vpos/version"
-require "httparty"
-require "securerandom"
+require_relative "vpos_module"
 
-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
+class Vpos 
+  include VposModule
 end

data/lib/vpos/version.rb

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

data/lib/vpos_module.rb

@@ -0,0 +1,102 @@
+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: 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 = HTTParty.post("#{host}/transactions", content)
+    return_vpos_object(request)
+  end
+
+  def 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 = 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(request)
+    if request[:location].nil?
+      HTTParty.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 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: 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 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 default_pos_id
+      pos_id = ENV["GPO_POS_ID"]
+      return "#{pos_id}".to_i
+    end
+
+    def default_supervisor_card
+      supervisor_card = ENV["GPO_SUPERVISOR_CARD"]
+      return "#{supervisor_card}"
+    end
+    
+    def set_token
+      token = ENV["MERCHANT_VPOS_TOKEN"]
+      return "Bearer #{token}"
+    end
+
+    def default_payment_callback_url
+      url = ENV["PAYMENT_CALLBACK_URL"]
+      return url
+    end
+
+    def default_refund_callback_url
+      url = ENV["REFUND_CALLBACK_URL"]
+      return url
+    end
+
+    def 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/vpos.gemspec

@@ -4,12 +4,12 @@ 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.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.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/nextbss/vpos-ruby"
   spec.license       = "MIT"
 
@@ -22,7 +22,7 @@ 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 "bundler", "~> 2.2.3"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_dependency "httparty", "~> 0.18.1"
   spec.add_dependency "rspec", "~> 3.9.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vpos
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Sergio Maziano
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2020-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        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.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,8 +66,8 @@ dependencies:
     - - "~>"
       - !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
 executables: []
@@ -81,11 +81,11 @@ files:
 - 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

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'