vpos 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e865b5fffb4fe4f2e13e6bb282439885fd0a56274d3c4bc84c7ae45d90ef07e2
-  data.tar.gz: d83b8a685d97e8b8141c2cf5d9e43378dbdd0c955691e89ec9a130d036467033
+  metadata.gz: 8ce8a846da74d76619ecc28a4c433c7a84d2e759ab0ce7c1dd9a6ad06e3a9fa0
+  data.tar.gz: ecd2849235767f671634540dd75491d8069b200ae21b2984c3e68a8429e6a094
 SHA512:
-  metadata.gz: 168cffa759c19a468b376b57c62dafffd2fcd1890fa3df9bdac4f9f8f7725b1f3362cee3f6b8791bdde808df7fc3c0418b658ec19f514be806ae59928617669b
-  data.tar.gz: 2a9af917900e0d8342db0e8bc9f5433d005d33d2865308a3eb407c9b943bb5d67c345b5377c9cc7dc27590d9cd6359ef26c5d171578ead1f288f2b39e1a6f0ed
+  metadata.gz: 3b414e72948061cbe3b478202df5196cb6f468da6071286f3623f80beb946b79f2b6c2e328430ff34f37675b464e74b0f0761b91c16af5eb3d80a7cef703b58c
+  data.tar.gz: 87214e410ace8ec0aae927cdd91df7553d1da9b271352db6fad413ea352c488d4949becd6104514f7e3bbceb22dfff1f1855d107e5b1d086bd4da73459fb82d9

data/README.md

@@ -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)
 
@@ -77,43 +78,71 @@ or using one of the optional arguments
 | `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 using a env variable token.
+Retrieves a transaction given a valid transaction ID:
 
 ```ruby
-transaction = merchant.get_transaction(transaction_id: '1jHbXEbRTIbbwaoJ6w06nLcRG7X')
-```
-
-or
-
-Using a explicitly stated token
-
-```ruby
-transaction = merchant.get_transaction(transaction_id: '1jHbXEbRTIbbwaoJ6w06nLcRG7X', token: 'EbRTIbb1jHbXEbRTIbbwaoJ6w06nLcRG7X')
+# 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 | 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 using a env variable token.
+and a valid amount:
 
 ```ruby
-payment = merchant.new_payment(customer: '900111222', amount: '123.45')
-```
-
-or
-
-Using a explicitly stated token
-
-```ruby
-payment = merchant.new_payment(customer: '900111222', amount: '123.45', token: 'EbRTIbb1jHbXEbRTIbbwaoJ6w06nLcRG7X')
+# 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 | 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) |
@@ -123,42 +152,76 @@ payment = merchant.new_payment(customer: '900111222', amount: '123.45', token: '
 Given an existing `parent_transaction_id`, request a refund using a env variable token.
 
 ```ruby
-refund = merchant.new_refund(parent_transaction_id: '1kTFGhJH8i58uD9MdJpMjWnoE')
-```
-
-or
-
-Using a explicitly stated token
-
-```ruby
-refund = merchant.new_refund(parent_transaction_id: '1kTFGhJH8i58uD9MdJpMjWnoE', token: 'EbRTIbb1jHbXEbRTIbbwaoJ6w06nLcRG7X')
+# 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 | 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` using a env variable token. 
+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(request_id: '1jHbXEbRTIbbwaoJ6w06nLcRG7X')
-```
-
-or
-
-Using a explicitly stated token
-
-```ruby
-transaction = merchant.get_request(request_id: '1jHbXEbRTIbbwaoJ6w06nLcRG7X', token: 'EbRTIbb1jHbXEbRTIbbwaoJ6w06nLcRG7X')
+# 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 | 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) |
 

data/lib/vpos/version.rb

@@ -1,3 +1,3 @@
 module VposModule
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/lib/vpos_module.rb

@@ -15,7 +15,7 @@ module VposModule
   )
     conn = connection
     response = conn.post('transactions') do |req|
-      req.headers['Authorization'] = token
+      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)
@@ -24,7 +24,7 @@ module VposModule
   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'] = token
+      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)
@@ -33,7 +33,7 @@ module VposModule
   def get_transaction(transaction_id: required, token: @token)
     conn = connection
     response = conn.get("transactions/#{transaction_id}") do |req|
-      req.headers['Authorization'] = token
+      req.headers['Authorization'] = "Bearer #{token}"
     end
     return_vpos_object(response)
   end
@@ -42,7 +42,7 @@ module VposModule
     if response[:location].nil?
       conn = connection
       response = conn.get("references/invalid") do |req|
-        req.headers['Authorization'] = token
+        req.headers['Authorization'] = "Bearer #{token}"
       end
     else
       if response[:status_code] == 202
@@ -56,7 +56,7 @@ module VposModule
   def get_request(request_id: required, token: @token)
     conn = connection
     response = conn.get("requests/#{request_id}") do |req|
-      req.headers['Authorization'] = token
+      req.headers['Authorization'] = "Bearer #{token}"
     end
     return_vpos_object(response)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vpos
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Sergio Maziano
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-25 00:00:00.000000000 Z
+date: 2022-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler