bleumi_pay_sdk_ruby 1.0.6 → 1.0.7

data/docs/PayoutsApi.md

@@ -1,6 +1,6 @@
 # BleumiPay::PayoutsApi
 
-Payouts are available only for the Ethereum and xDAI networks today and require you to set up a Private Payment Processor and link it to your account. Please contact support@bleumi.com if you want to enable payouts for your account.
+Payouts are available only for the Ethereum, xDAI and RSK networks today and require you to set up a Private Payment Processor and link it to your account. Please contact support@bleumi.com if you want to enable payouts for your account.
 
 ## create_payout
 
@@ -41,7 +41,7 @@ begin
   payouts = [payout1, payout2]
 
   create_payout_request.txid = '<TXID>' # str | Replace with unique payout ID 
-  create_payout_request.token = '<TOKEN>' # str | Replace <TOKEN> with Token. Eg. ETH or ECR-20 token contract address or XDAI or XDAIT
+  create_payout_request.token = '<TOKEN>' # str | Replace <TOKEN>  by anyone of the following values: 'ETH' or 'XDAI' or 'XDAIT' or ECR-20 Contract Address or 'RBTC' or RSK ECR-20 Contract Address or 'Asset ID' of Algorand Standard Asset.
   create_payout_request.payouts = payouts # setting the payouts array to the payout create request
   
   #Create a payout.

data/docs/RskBalance.md

@@ -0,0 +1,28 @@
+# BleumiPay::RskBalance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rsk** <br>(Optional) | [**Hash&lt;String, WalletBalance&gt;**](WalletBalance.md) | A dictionary which gives the token balances in RSK MainNet  |
+**rsk_testnet** <br>(Optional) | [**Hash&lt;String, WalletBalance&gt;**](WalletBalance.md) | A dictionary which gives the token balances in RSK TestNet  |
+
+## Example - TestNet
+
+```json
+{
+    "balances": {
+        "rsk": {
+            "rsk_testnet": {
+                "0x1efeabf46ca3270a9a41d324350692664f1ea105": {
+                    "blockNum": "889362",
+                    "token_balance": "300",
+                    "balance": "3",
+                    "safety": "high",
+                    "token_decimals": 2
+                }
+            }
+        }
+    }
+}
+```

data/docs/WalletBalance.md

@@ -5,17 +5,21 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **balance** | **String** | Token balance for the wallet | 
-**token_balance** | **String** | Token balance for the wallet in Network format | 
+**token_balance** | **String** | Token balance for the wallet in Ethereum format | 
 **token_decimals** | **Integer** | Token decimal places | 
 **block_num** | **String** | Block in which the balance was last updated | 
+**safety** | **String** | Safety level indicator | 
+
+## Code Sample
+
+```ruby
+require 'BleumiPay'
+
+instance = BleumiPay::WalletBalance.new(balance: null,
+                                 token_balance: null,
+                                 token_decimals: null,
+                                 block_num: null,
+                                 safety: null)
+```
 
-## Example
 
-```json
-{
-    "balance": "1",
-    "token_decimals": 15,
-    "blockNum": "1698324",
-    "token_balance": "1000000000000000"
-}
-```

data/hc_create.rb

@@ -0,0 +1,40 @@
+# Load the gem
+require 'bleumi_pay_sdk_ruby'
+
+# Setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = 'gCix0pemxoUt76Ufef16jwvbV6cC7H60HdryEJj0'
+end
+
+api_instance = BleumiPay::HostedCheckoutsApi.new
+
+create_checkout_url_request = BleumiPay::CreateCheckoutUrlRequest.new # CreatePayoutRequest | Specify payout creation parameters.
+create_checkout_url_request.id = '17'
+create_checkout_url_request.currency = 'USD'
+create_checkout_url_request.amount = '10'
+create_checkout_url_request.success_url = 'https://demo.store/api/completeOrder'
+create_checkout_url_request.cancel_url = 'https://demo.store/api/cancelOrder'
+# create_checkout_url_request.token = '0x115615DbD0f835344725146Fa6343219315F15E5'
+# create_checkout_url_request.chain = BleumiPay::Chain::GOERLI
+
+# create_checkout_url_request.currency = 'ALGO'
+# create_checkout_url_request.token = 'ALGO'
+# create_checkout_url_request.chain = BleumiPay::Chain::ALG_TESTNET
+
+# RSK
+# USD p18 - 0xB3A4A821434bDFbE55872C240D3888c412c68B9B
+# USD p6 - 0xb9F624160Bb2755aa25366cc307ED27e39A4f296
+# USD p2 - 0x1efEaBf46Ca3270A9a41D324350692664f1eA105
+# EUR p2 - 0xd7a5c209194AC2E8e3E6Ca1dbF3C55484adb06e1
+# Chain: RSK_TESTNET
+create_checkout_url_request.token = '0xb9F624160Bb2755aa25366cc307ED27e39A4f296'
+create_checkout_url_request.chain = BleumiPay::Chain::RSK_TESTNET
+
+begin
+  #Create an unique wallet address to accept payments for an ERC-20 token from a buyer
+  result = api_instance.create_checkout_url(create_checkout_url_request)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling HostedCheckoutsApi->create_checkout_url: #{e}"
+end

data/hc_list.rb

@@ -0,0 +1,17 @@
+# load the gem
+require 'bleumi_pay_sdk_ruby'
+# setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = 'gCix0pemxoUt76Ufef16jwvbV6cC7H60HdryEJj0'
+end
+
+api_instance = BleumiPay::HostedCheckoutsApi.new
+
+begin
+  #Retrieve all tokens configured for the Hosted Checkout in your account in the Bleumi Pay Dashboard
+  result = api_instance.list_tokens
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling HostedCheckoutsApi->list_tokens: #{e}"
+end

data/hc_validate.rb

@@ -0,0 +1,22 @@
+# load the gem
+require 'bleumi_pay_sdk_ruby'
+# setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = 'gCix0pemxoUt76Ufef16jwvbV6cC7H60HdryEJj0'
+end
+
+api_instance = BleumiPay::HostedCheckoutsApi.new
+
+begin
+  validate_checkout_request = BleumiPay::ValidateCheckoutRequest.new # WalletSettleOperationInput | Request body - used to specify the amount to settle.
+  validate_checkout_request.hmac_alg = 'HMAC-SHA256-HEX'
+  validate_checkout_request.hmac_input = 'goerli|0xbeaa3c30fc4a89e31caec6e2c8e89d3138f3bc18|0x115615dbd0f835344725146fa6343219315f15e5|10|0'
+  validate_checkout_request.hmac_key_id = 'v1'
+  validate_checkout_request.hmac_value = '205e429e51618e377046a0e8452d94b364e6938ea04362d466418548f3871f30'
+  #Settle a wallet, amount received will be transferred even if less than payment amount
+  result = api_instance.validate_checkout_payment(validate_checkout_request)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling HostedCheckoutsApi->validate_checkout_payment: #{e}"
+end

data/lib/bleumi_pay_sdk_ruby.rb

@@ -46,6 +46,7 @@ require 'bleumi_pay_sdk_ruby/models/payment_settle_request'
 require 'bleumi_pay_sdk_ruby/models/payout'
 require 'bleumi_pay_sdk_ruby/models/payout_item'
 require 'bleumi_pay_sdk_ruby/models/payout_item_inputs'
+require 'bleumi_pay_sdk_ruby/models/rsk_balance'
 require 'bleumi_pay_sdk_ruby/models/validate_checkout_request'
 require 'bleumi_pay_sdk_ruby/models/validate_checkout_response'
 require 'bleumi_pay_sdk_ruby/models/wallet_balance'

data/lib/bleumi_pay_sdk_ruby/api/payouts_api.rb

@@ -1,7 +1,7 @@
 =begin
-#Bleumi Pay REST API
+#Bleumi Pay API
 
-#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai, Algorand payments and/or payouts into your business or application
+#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai payments and/or payouts into your business or application
 
 The version of the OpenAPI document: 1.0.0
 Contact: info@bleumi.com
@@ -15,16 +15,14 @@ require 'cgi'
 module BleumiPay
   class PayoutsApi
     attr_accessor :api_client
-    attr_accessor :request_validator
 
-    def initialize(api_client = ApiClient.default, request_validator = RequestValidator.default)
+    def initialize(api_client = ApiClient.default)
       @api_client = api_client
-      @request_validator = request_validator
     end
     # Create a payout.
     # @param create_payout_request [CreatePayoutRequest] Request body - used to specify payout creation parameters.
     # @param [Hash] opts the optional parameters
-    # @option opts [Chain] :chain Network in which payment is to be created. Please refer documentation for Supported Networks
+    # @option opts [Chain] :chain Ethereum network in which payment is to be created. Please refer documentation for Supported Networks
     # @return [CreatePayoutResponse]
     def create_payout(create_payout_request, opts = {})
       data, _status_code, _headers = create_payout_with_http_info(create_payout_request, opts)
@@ -34,7 +32,7 @@ module BleumiPay
     # Create a payout.
     # @param create_payout_request [CreatePayoutRequest] Request body - used to specify payout creation parameters.
     # @param [Hash] opts the optional parameters
-    # @option opts [Chain] :chain Network in which payment is to be created. Please refer documentation for Supported Networks
+    # @option opts [Chain] :chain Ethereum network in which payment is to be created. Please refer documentation for Supported Networks
     # @return [Array<(CreatePayoutResponse, Integer, Hash)>] CreatePayoutResponse data, response status code and response headers
     def create_payout_with_http_info(create_payout_request, opts = {})
       if @api_client.config.debugging
@@ -44,12 +42,6 @@ module BleumiPay
       if @api_client.config.client_side_validation && create_payout_request.nil?
         fail ArgumentError, "Missing the required parameter 'create_payout_request' when calling PayoutsApi.create_payout"
       end
-      # verify the values in the request body are valid
-      chain = opts[:'chain'] if !opts[:'chain'].nil?
-      msg = @request_validator.validate_create_payout_request(create_payout_request, chain)
-      if (@request_validator.is_not_empty(msg))
-        fail ArgumentError, "`#{msg}` when calling PayoutsApi.create_payout"
-      end
       # resource path
       local_var_path = '/v1/payout'
 

data/lib/bleumi_pay_sdk_ruby/api/request_validator.rb

@@ -1,7 +1,7 @@
 =begin
-#Bleumi Pay REST API
+#Bleumi Pay API
 
-#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai, Algorand payments and/or payouts into your business or application
+#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai payments and/or payouts into your business or application
 
 Contact: info@bleumi.com
 
@@ -23,6 +23,11 @@ module BleumiPay
             !!(str =~ /^[A-Z2-7+=*]{58}$/)
         end
 
+        def algo_token?(str)
+            # We use !! to convert the return value to a boolean
+            !!(str =~ /^[0-9]*$/)
+        end        
+
         def is_not_empty(str)
             if (str == nil || str == "") then
                 return false
@@ -37,9 +42,22 @@ module BleumiPay
             return nil
         end
 
-        def check_alg_addr(name, input)
-            if !((algo_address?(input))||(input == "ALGO")) then
-                return "`#{name}` is not a valid Algorand address"
+        def check_rsk_addr(name, input)
+            if !((eth_address?(input))||(input == "RBTC")) then
+                return "`#{name}` is not a valid RSK address"
+            end
+            return nil
+        end
+
+        def check_alg_addr(name, input, is_token)
+            if (is_token) 
+                if !((algo_token?(input))||(input == "ALGO")) then
+                    return "`#{name}` is not a valid Algorand token"
+                end
+            else
+                if !(algo_address?(input)) then
+                    return "`#{name}` is not a valid Algorand address"
+                end
             end
             return nil
         end
@@ -48,6 +66,10 @@ module BleumiPay
             return ((chain == "alg_mainnet")||(chain == "alg_testnet")) 
         end
 
+        def is_rsk_network(chain)
+            return ((chain == "rsk")||(chain == "rsk_testnet")) 
+        end
+
         def check_req_param(name, input)
             if (input == nil || input == "")
                 return "Missing required parameter `#{name}`"
@@ -55,7 +77,7 @@ module BleumiPay
             return nil
         end
 
-        def check_network_addr(name, input, chain, mandatory)
+        def check_network_addr(name, input, chain, mandatory, is_token)
             if mandatory then
                 msg = check_req_param(name, input)
                 if is_not_empty(msg) then
@@ -65,7 +87,9 @@ module BleumiPay
             if is_not_empty(input) then
                 msg = nil
                 if is_algo_network(chain) then
-                    msg =  check_alg_addr(name, input)
+                    msg =  check_alg_addr(name, input, is_token)
+                elsif is_rsk_network(chain) then
+                    msg =  check_rsk_addr(name, input)
                 else
                     msg =  check_eth_addr(name, input)
                 end    
@@ -83,19 +107,19 @@ module BleumiPay
                 return msg 
             end
             # check if buyer_address is valid address in the network  
-            msg = check_network_addr("BuyerAddress", params.buyer_address, chain, mandatory=true)
+            msg = check_network_addr("BuyerAddress", params.buyer_address, chain, mandatory=true, is_token=false)
             if is_not_empty(msg) then
                 return msg 
             end
             # check if transfer_address is valid address in the network  
-            msg = check_network_addr("TransferAddress", params.transfer_address, chain, mandatory=true)
+            msg = check_network_addr("TransferAddress", params.transfer_address, chain, mandatory=true, is_token=false)
             if is_not_empty(msg) then
                 return msg 
             end
 
             # check if token is valid address in the network (if provided) 
             if is_not_empty(params.token) then
-                msg = check_network_addr("Token", params.token, chain, mandatory=false)
+                msg = check_network_addr("Token", params.token, chain, mandatory=false, is_token=true)
                 if is_not_empty(msg) then
                     return msg 
                 end
@@ -110,7 +134,7 @@ module BleumiPay
                 return msg 
             end
             # check if token is valid address in the network 
-            msg = check_network_addr("Token", params.token, chain, mandatory=true)
+            msg = check_network_addr("Token", params.token, chain, mandatory=true, is_token=true)
             if is_not_empty(msg) then
                 return msg 
             end
@@ -124,7 +148,7 @@ module BleumiPay
                 return msg 
             end
             # check if token is valid address in the network 
-            msg = check_network_addr("Token", params.token, chain, mandatory=true)
+            msg = check_network_addr("Token", params.token, chain, mandatory=true, is_token=true)
             if is_not_empty(msg) then
                 return msg 
             end
@@ -177,14 +201,14 @@ module BleumiPay
                 end
 
                 # check if token is valid address in the network (if provided) 
-                msg = check_network_addr("Token", params.token, params.chain, mandatory=false)
+                msg = check_network_addr("Token", params.token, params.chain, mandatory=false, is_token=true)
                 if is_not_empty(msg) then
                     return msg 
                 end
 
                 # check if buyer_address is valid address in the network (if provided) 
                 if is_not_empty(params.buyer_address) then
-                    msg = check_network_addr("BuyerAddress", params.buyer_address, params.chain, mandatory=false)
+                    msg = check_network_addr("BuyerAddress", params.buyer_address, params.chain, mandatory=false, is_token=false)
                     if is_not_empty(msg) then
                         return msg 
                     end
@@ -227,7 +251,7 @@ module BleumiPay
                 return msg 
             end
             # check if token is valid address in the network 
-            msg = check_network_addr("Token", params.token, chain, mandatory=true)
+            msg = check_network_addr("Token", params.token, chain, mandatory=true, is_token=true)
             if is_not_empty(msg) then
                 return msg 
             end
@@ -239,7 +263,7 @@ module BleumiPay
 
             for payout in payouts
                 # check if payout.transfer_address is valid address in the network  
-                msg = check_network_addr("TransferAddress", payout.transfer_address, chain, mandatory=true)
+                msg = check_network_addr("TransferAddress", payout.transfer_address, chain, mandatory=true, is_token=false)
                 if is_not_empty(msg) then
                     return msg 
                 end

data/lib/bleumi_pay_sdk_ruby/api_client.rb

@@ -269,11 +269,13 @@ module BleumiPay
         tempfile.write(chunk)
       end
       request.on_complete do |response|
-        tempfile.close if tempfile
-        @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                            "explicitly with `tempfile.delete`"
+        if tempfile
+          tempfile.close
+          @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                              "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                              "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                              "explicitly with `tempfile.delete`"
+        end
       end
     end
 

data/lib/bleumi_pay_sdk_ruby/models/chain.rb

@@ -20,6 +20,8 @@ module BleumiPay
     XDAI_TESTNET = "xdai_testnet".freeze
     ALG_MAINNET = "alg_mainnet".freeze
     ALG_TESTNET = "alg_testnet".freeze
+    RSK = "rsk".freeze
+    RSK_TESTNET = "rsk_testnet".freeze
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string

data/lib/bleumi_pay_sdk_ruby/models/payment_addresses.rb

@@ -19,11 +19,14 @@ module BleumiPay
 
     attr_accessor :algorand
 
+    attr_accessor :rsk
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'ethereum' => :'ethereum',
-        :'algorand' => :'algorand'
+        :'algorand' => :'algorand',
+        :'rsk' => :'rsk'
       }
     end
 
@@ -31,7 +34,8 @@ module BleumiPay
     def self.openapi_types
       {
         :'ethereum' => :'Hash<String, EthereumWalletAddress>',
-        :'algorand' => :'Hash<String, AlgorandWalletAddress>'
+        :'algorand' => :'Hash<String, AlgorandWalletAddress>',
+        :'rsk' => :'Hash<String, EthereumWalletAddress>'
       }
     end
 
@@ -67,6 +71,12 @@ module BleumiPay
           self.algorand = value
         end
       end
+
+      if attributes.key?(:'rsk')
+        if (value = attributes[:'rsk']).is_a?(Hash)
+          self.rsk = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -88,7 +98,8 @@ module BleumiPay
       return true if self.equal?(o)
       self.class == o.class &&
           ethereum == o.ethereum &&
-          algorand == o.algorand
+          algorand == o.algorand &&
+          rsk == o.rsk
     end
 
     # @see the `==` method
@@ -100,7 +111,7 @@ module BleumiPay
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [ethereum, algorand].hash
+      [ethereum, algorand, rsk].hash
     end
 
     # Builds the object from hash