vpos 1.0.5 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4750800d8256bc530a0fb7ca21e03346c8e87088a7d808ee49e69904d2c199f3
-  data.tar.gz: 492e1c3dd74ad007b37104220fc22cdc17e489ce809da07ddfca2f6ff4d2db82
+  metadata.gz: ae324e2a78d84e4cf8cca1967734ea03719b8ff46946564ec0f7c8228653fa71
+  data.tar.gz: 061aff774b1b88b38449ac1b9c522a461bec2c54369bc028002579af4430b653
 SHA512:
-  metadata.gz: 4af2aaafef72291b47a8523925bde9868e63a16d39aedac137d73d4fd3382cd903af108f0a589a334d6850affc71cc487f58cd6b218aef599b146d87cf14ef2b
-  data.tar.gz: 68c2abbd7e6e8cf39fa0ebcd462ebe34997362fec74538da9f6aa5c2d9b15079a08fdd95edf24f126f1db16a5196e6483cc8b2c530c458edd2b4682e5c77460c
+  metadata.gz: bb720f3a72e627b84f46b0019bc5d1b3c625597a75265d69dae8e8c6367d81e52f0a76481cba71099c17c2e54324395fd0a19ea8f5284f2d497b5da9a9cf4d3f
+  data.tar.gz: c4643e9b2131c53b33d8662811bed43529173fcc3c6f0bfb3fa18288819f47ec8e23ffaff65e7d5403f10db1d0c6db35a7c18b0f23fc4be3d61261528430cec7

data/.ruby-version

@@ -1 +1 @@
-2.5.8
+3.0.2

data/Gemfile.lock

@@ -1,35 +1,33 @@
 PATH
   remote: .
   specs:
-    vpos (1.0.4)
-      httparty (~> 0.18.1)
-      rspec (~> 3.9, >= 3.9.0)
+    vpos (2.0.0)
+      faraday (~> 2.3)
+      rspec (~> 3.11, >= 3.11.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.2021.0225)
-    multi_xml (0.6.0)
+    diff-lcs (1.5.0)
+    faraday (2.3.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.3)
     rake (12.3.3)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    ruby2_keywords (0.0.5)
 
 PLATFORMS
   ruby

data/README.md

@@ -23,7 +23,7 @@ See our documentation on [developer.vpos.ao](https://developer.vpos.ao)
 
 ## Installation
 ```ruby
-gem 'vpos', '~> 1.0.4'
+gem 'vpos', '~> 2.0.0'
 ```
 
 or 
@@ -37,6 +37,7 @@ 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.
+- Ruby 2.6 or higher
 
 Don't have this information? [Talk to us](suporte@vpos.ao)
 
@@ -52,17 +53,16 @@ The next section will show the various actions that can be performed by you, the
 require 'vpos'
 
 # use the default environment variables option
-merchant = Vpos.new
+vpos = Vpos.new
 
 # or use optional arguments option
-merchant = Vpos.new(token: 'your_token_here', environment: 'PRD')
+vpos = Vpos.new(token: 'your_token_here')
 ```
 
 #### 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 |
@@ -74,57 +74,156 @@ or using one of the optional arguments
 | --- | --- | --- |
 | `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`
 
 ### Get a specific Transaction
-Retrieves a transaction given a valid transaction ID.
+Retrieves a transaction given a valid transaction ID:
 
 ```ruby
-transaction = merchant.get_transaction('1jHbXEbRTIbbwaoJ6w06nLcRG7X')
+# Using a env variable token MERCHANT_VPOS_TOKEN
+transaction = vpos.get_transaction(transaction_id: '1jHbXEbRTIbbwaoJ6w06nLcRG7X')
+# Or using a explicitly stated token
+transaction = vpos.get_transaction(transaction_id: '1jHbXEbRTIbbwaoJ6w06nLcRG7X', token: 'EbRTIbb1jHbXEbRTIbbwaoJ6w06nLcRG7X')
+# {
+#   :status_code=>200,
+#   :message=>"OK",
+#   :data=> {
+#      :amount=>"1.23",
+#      :clearing_period=>156,
+#      :id=>"29fTRtkFaf8cQklRuHTvGDaecj4",
+#      :mobile=>"900000000",
+#      :parent_transaction_id=>nil,
+#      :pos_id=>111,
+#      :status=>"accepted",
+#      :status_datetime=>"2022-05-25T18:25:39Z",
+#      :status_reason=>nil,
+#      :type=>"payment"
+#    }
+# }
 ```
 
-| Argument | Description | Type |
-| --- | --- | --- |
-| `id` | An existing Transaction ID | `string`
+| Argument | Description | Type | Required |
+| --- | --- | --- | --- |
+| `transaction_id` | An existing Transaction ID | `string` | Yes |
+| `token` | Merchant token generated at vPOS merchant portal | `string` | No (if set as env variable) |
 
 ### New Payment Transaction
 Creates a new payment transaction given a valid mobile number associated with a `MULTICAIXA` account
-and a valid amount.
+and a valid amount:
 
 ```ruby
-payment = merchant.new_payment('900111222', '123.45')
+# Using a env variable token MERCHANT_VPOS_TOKEN
+request = vpos.new_payment(customer: '900111222', amount: '123.45')
+# Or using a explicitly stated token
+request = vpos.new_payment(customer: '900111222', amount: '123.45', token: 'EbRTIbb1jHbXEbRTIbbwaoJ6w06nLcRG7X')
+# {:status_code=>202, :message=>"ACCEPTED", :location=>"/api/v1/requests/29fTRtkFaf8cQklRuHTvGDaecj4"}
+
+request_id = vpos.get_request_id(request)
+# "29fTRtkFaf8cQklRuHTvGDaecj4"
+
+transaction = vpos.get_transaction(transaction_id: "29fTRtkFaf8cQklRuHTvGDaecj4")
+# {
+#   :status_code=>200,
+#   :message=>"OK",
+#   :data=> {
+#      :amount=>"1.23",
+#      :clearing_period=>156,
+#      :id=>"29fTRtkFaf8cQklRuHTvGDaecj4",
+#      :mobile=>"900000000",
+#      :parent_transaction_id=>nil,
+#      :pos_id=>111,
+#      :status=>"accepted",
+#      :status_datetime=>"2022-05-25T18:25:39Z",
+#      :status_reason=>nil,
+#      :type=>"payment"
+#    }
+# }
 ```
 
-| Argument | Description | Type |
-| --- | --- | --- |
-| `mobile` | The mobile number of the client who will pay | `string`
-| `amount` | The amount the client should pay, eg. "259.99", "259000.00" | `string`
+| Argument | Description | Type | Required |
+| --- | --- | --- | --- |
+| `customer` | The mobile number of the client who will pay | `string` | Yes |
+| `amount` | The amount the client should pay, eg. "259.99", "259000.00" | `string` | Yes |
+| `token` | Merchant token generated at vPOS merchant portal | `string` | No (if set as env variable) |
+| `callback_url` | A valid https url where vPOS is going to callback as soon he finishes to process | `string` | No |
 
 ### Request Refund
-Given an existing `parent_transaction_id`, request a refund.
+Given an existing `parent_transaction_id`, request a refund using a env variable token.
 
 ```ruby
-refund = merchant.new_refund('1kTFGhJH8i58uD9MdJpMjWnoE')
+# Using a env variable token MERCHANT_VPOS_TOKEN
+request = vpos.new_refund(parent_transaction_id: '29fTRtkFaf8cQklRuHTvGDaecj4')
+# Or using a explicitly stated token
+request = vpos.new_refund(parent_transaction_id: '29fTRtkFaf8cQklRuHTvGDaecj4', token: 'EbRTIbb1jHbXEbRTIbbwaoJ6w06nLcRG7X')
+# {:status_code=>202, :message=>"ACCEPTED", :location=>"/api/v1/requests/29fTRtkFaf8cQklRuHTvGDaecj3"}
+
+request_id = vpos.get_request_id(request)
+# "29fTRtkFaf8cQklRuHTvGDaecj3"
+
+transaction = vpos.get_transaction(transaction_id: "29fTRtkFaf8cQklRuHTvGDaecj3")
+# {
+#   :status_code=>200,
+#   :message=>"OK",
+#   :data=> {
+#      :amount=>"1.23",
+#      :clearing_period=>156,
+#      :id=>"29fTRtkFaf8cQklRuHTvGDaecj3",
+#      :mobile=>nil,
+#      :parent_transaction_id=>29fTRtkFaf8cQklRuHTvGDaecj4,
+#      :pos_id=>nil,
+#      :status=>"accepted",
+#      :status_datetime=>"2022-05-25T18:25:39Z",
+#      :status_reason=>nil,
+#      :type=>"refund"
+#    }
+# }
 ```
 
-| Argument | Description | Type |
-| --- | --- | --- |
+| Argument | Description | Type | Required |
+| --- | --- | --- | --- |
 | `parent_transaction_id` | The ID of transaction you wish to refund | `string`
+| `token` | Merchant token generated at vPOS merchant portal | `string` | No (if set as env variable) |
+| `callback_url` | A valid https url where vPOS is going to callback as soon he finishes to process | `string` | No |
 
 ### Poll Transaction Status
-Poll the status of a transaction given a valid `request_id`. 
+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
-transaction = merchant.get_request('1jHbXEbRTIbbwaoJ6w06nLcRG7X')
+# Using a env variable token
+request = vpos.get_request(request_id: '29fTRtkFaf8cQklRuHTvGDaecj5')
+# Or using a explicitly stated token
+request = vpos.get_request(request_id: '29fTRtkFaf8cQklRuHTvGDaecj5', token: 'EbRTIbb1jHbXEbRTIbbwaoJ6w06nLcRG7X')
+# {:status_code=>303, :message=>"ACCEPTED", :location=>"/api/v1/transactions/29fTRtkFaf8cQklRuHTvGDaecj5"}
+
+request_id = vpos.get_request_id(request)
+# "29fTRtkFaf8cQklRuHTvGDaecj5"
+
+transaction = vpos.get_transaction(transaction_id: "29fTRtkFaf8cQklRuHTvGDaecj5")
+# {
+#   :status_code=>200,
+#   :message=>"OK",
+#   :data=> {
+#      :amount=>"1.23",
+#      :clearing_period=>156,
+#      :id=>"29fTRtkFaf8cQklRuHTvGDaecj5",
+#      :mobile=>nil,
+#      :parent_transaction_id=>29fTRtkFaf8cQklRuHTvGDaecj4,
+#      :pos_id=>nil,
+#      :status=>"accepted",
+#      :status_datetime=>"2022-05-25T18:25:39Z",
+#      :status_reason=>nil,
+#      :type=>"refund"
+#    }
+# }
 ```
 
-| Argument | Description | Type |
-| --- | --- | --- |
-| `request_id` | The ID of transaction you wish to poll | `string`
+| Argument | Description | Type | Required? |
+| --- | --- | --- | --- |
+| `request_id` | The ID of transaction you wish to poll | `string` | Yes |
+| `token` | Merchant token generated at vPOS merchant portal | `string` | No (if set as env variable) |
 
 ### Have any doubts?
 In case of any doubts, bugs, or the like, please leave an issue. We would love to help.

data/bin/.ruby-version

@@ -0,0 +1 @@
+3.0.2

data/lib/vpos/version.rb

@@ -1,3 +1,3 @@
 module VposModule
-  VERSION = "1.0.5"
+  VERSION = "2.0.2"
 end

data/lib/vpos.rb

@@ -3,36 +3,38 @@ require_relative "vpos_module"
 class Vpos
   include VposModule
 
-  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)
+  def initialize(token: set_token, pos_id: default_pos_id, 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
 
   private
-
-  def default_pos_id
-    pos_id = ENV['GPO_POS_ID']
-    "#{pos_id}".to_i
-  end
-
-  def default_supervisor_card
-    supervisor_card = ENV['GPO_SUPERVISOR_CARD']
-    "#{supervisor_card}"
-  end
-
-  def set_token
-    token = ENV['MERCHANT_VPOS_TOKEN']
-    "Bearer #{token}"
-  end
-
-  def default_payment_callback_url
-    ENV['PAYMENT_CALLBACK_URL']
-  end
-
-  def default_refund_callback_url
-    ENV['REFUND_CALLBACK_URL']
-  end
+    def default_pos_id
+      pos_id = ENV['GPO_POS_ID']
+      unless !pos_id.nil?
+        return 111
+      end
+      "#{pos_id}".to_i
+    end
+
+    def set_token
+      token = ENV['MERCHANT_VPOS_TOKEN']
+      "#{token}"
+    end
+
+    def default_payment_callback_url
+      url = ENV['PAYMENT_CALLBACK_URL']
+      unless !url.nil?
+        return ""
+      end
+    end
+
+    def default_refund_callback_url
+      url = ENV['REFUND_CALLBACK_URL']
+      unless !url.nil?
+        return ""
+      end
+    end
 end

data/lib/vpos_module.rb

@@ -1,34 +1,49 @@
 require "vpos/version"
-require "httparty"
+require "faraday"
+require "json"
 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)
+  def new_payment(
+    customer: required,
+    amount: required,
+    pos_id: @pos_id,
+    callback_url: @payment_callback_url,
+    token: @token
+  )
+    conn = connection
+    response = conn.post('transactions') do |req|
+      req.headers['Authorization'] = "Bearer #{token}"
+      req.body = { type: "payment", pos_id: pos_id, mobile: customer, amount: amount, callback_url: callback_url }.to_json
+    end
+    return_vpos_object(response)
   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)
+  def new_refund(parent_transaction_id: required, token: @token, callback_url: @refund_callback_url)
+    conn = connection
+    response = conn.post('transactions') do |req|
+      req.headers['Authorization'] = "Bearer #{token}"
+      req.body = { type: "refund", parent_transaction_id: parent_transaction_id, callback_url: callback_url }.to_json
+    end
+    return_vpos_object(response)
   end
 
-  def get_transaction(transaction_id)
-    request = HTTParty.get("#{host}/transactions/#{transaction_id}", set_headers)
-    return_vpos_object(request)
+  def get_transaction(transaction_id: required, token: @token)
+    conn = connection
+    response = conn.get("transactions/#{transaction_id}") do |req|
+      req.headers['Authorization'] = "Bearer #{token}"
+    end
+    return_vpos_object(response)
   end
 
   def get_request_id(response)
     if response[:location].nil?
-      HTTParty.get("#{host}/references/invalid", set_headers)
+      conn = connection
+      response = conn.get("references/invalid") do |req|
+        req.headers['Authorization'] = "Bearer #{token}"
+      end
     else
       if response[:status_code] == 202
         response[:location].gsub("/api/v1/requests/", "")
@@ -38,31 +53,55 @@ module VposModule
     end
   end
 
-  def get_request(request_id)
-    request = HTTParty.get("#{host}/requests/#{request_id}", set_headers)
-    return_vpos_object(request)
+  def get_request(request_id: required, token: @token)
+    conn = connection
+    response = conn.get("requests/#{request_id}") do |req|
+      req.headers['Authorization'] = "Bearer #{token}"
+    end
+    return_vpos_object(response)
   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}
+    def return_vpos_object(response)
+      case response.status
+      when 200
+        return { status_code: response.status, message: 'OK', data: JSON.parse(response.body).transform_keys(&:to_sym) }
+      when 201
+        return { status_code: response.status, message: 'CREATED', data: response.body }
       when 202, 303
-        return {status_code: request.response.code.to_i, message: request.response.message, location: request.headers["location"]}
+        return { status_code: response.status, message: 'ACCEPTED', location: response.headers["location"]}
+      when 401
+        return { status_code: response.status, message: 'UNAUTHORIZED' }
+      when 404
+        return { status_code: response.status, message: 'NOT FOUND' }
       else
-        return {status_code: request.response.code.to_i, message: request.response.message, details: request.parsed_response["errors"]}
+        return { status_code: response.status, message: response.status, details: JSON.parse(response.body).transform_keys(&:to_sym) }
       end
     end
 
     def set_headers
-      content = {}
-      headers = {'Content-Type' => "application/json", 'Accept' => "application/json", 'Authorization' => @token, 'Idempotency-Key' => SecureRandom.uuid}
-      content[:headers] = headers
-      content
+      headers = {'Content-Type' => "application/json", 'Accept' => "application/json", 'Idempotency-Key' => SecureRandom.uuid}
     end
 
     def host
       "https://vpos.ao/api/v1"
     end
+
+    def params
+      params = {}
+    end
+
+    def connection
+      conn = Faraday.new(
+        url: host,
+        params: params,
+        headers: set_headers
+      )
+    end
+
+    def required
+      method = caller_locations(1,1)[0].label
+      raise ArgumentError,
+        "A required keyword argument was not specified when calling '#{method}'"
+    end
 end

data/vpos.gemspec

@@ -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.2', '>= 2.2.3'
+  spec.add_development_dependency 'bundler', '~> 2.2', '>= 2.3.14'
   spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
-  spec.add_dependency 'httparty', '~> 0.18.1'
+  spec.add_dependency 'faraday', '~> 2.3'
   spec.add_dependency 'rspec', '~> 3.11', ">= 3.11.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vpos
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 2.0.2
 platform: ruby
 authors:
 - Sergio Maziano
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-04 00:00:00.000000000 Z
+date: 2022-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -19,7 +19,7 @@ dependencies:
         version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: 2.3.14
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: 2.3.14
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -51,19 +51,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +100,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/.ruby-version
 - bin/console
 - bin/setup
 - lib/vpos.rb
@@ -126,8 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: The one stop shop for online payments in Angola.