bleumi_pay_sdk_ruby 1.0.2 → 1.0.7

data/lib/bleumi_pay_sdk_ruby/api/payouts_api.rb

@@ -0,0 +1,157 @@
+=begin
+#Bleumi Pay API
+
+#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
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.2
+
+=end
+
+require 'cgi'
+
+module BleumiPay
+  class PayoutsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    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 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)
+      data
+    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 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
+        @api_client.config.logger.debug 'Calling API: PayoutsApi.create_payout ...'
+      end
+      # verify the required parameter 'create_payout_request' is set
+      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
+      # resource path
+      local_var_path = '/v1/payout'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'chain'] = opts[:'chain'] if !opts[:'chain'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(create_payout_request) 
+
+      # return_type
+      return_type = opts[:return_type] || 'CreatePayoutResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayoutsApi#create_payout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns a list of payouts
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :next_token Cursor to start results from
+    # @option opts [String] :sort_by Sort payments by
+    # @option opts [String] :start_at Get payouts from this timestamp (unix)
+    # @option opts [String] :end_at Get payouts till this timestamp (unix)
+    # @return [PaginatedPayoutItems]
+    def list_payouts(opts = {})
+      data, _status_code, _headers = list_payouts_with_http_info(opts)
+      data
+    end
+
+    # Returns a list of payouts
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :next_token Cursor to start results from
+    # @option opts [String] :sort_by Sort payments by
+    # @option opts [String] :start_at Get payouts from this timestamp (unix)
+    # @option opts [String] :end_at Get payouts till this timestamp (unix)
+    # @return [Array<(PaginatedPayoutItems, Integer, Hash)>] PaginatedPayoutItems data, response status code and response headers
+    def list_payouts_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutsApi.list_payouts ...'
+      end
+      allowable_values = ["createdAt", "updatedAt"]
+      if @api_client.config.client_side_validation && opts[:'sort_by'] && !allowable_values.include?(opts[:'sort_by'])
+        fail ArgumentError, "invalid value for \"sort_by\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/v1/payout'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'nextToken'] = opts[:'next_token'] if !opts[:'next_token'].nil?
+      query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
+      query_params[:'startAt'] = opts[:'start_at'] if !opts[:'start_at'].nil?
+      query_params[:'endAt'] = opts[:'end_at'] if !opts[:'end_at'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'PaginatedPayoutItems' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayoutsApi#list_payouts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/bleumi_pay_sdk_ruby/api/request_validator.rb

@@ -0,0 +1,288 @@
+=begin
+#Bleumi Pay API
+
+#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
+
+=end
+module BleumiPay
+    class RequestValidator
+
+        def self.default
+            @@default ||= RequestValidator.new
+        end
+
+        def eth_address?(str)
+            # We use !! to convert the return value to a boolean
+            !!(str =~ /^0x[a-fA-F0-9]{40}$/)
+        end
+
+        def algo_address?(str)
+            # We use !! to convert the return value to a boolean
+            !!(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
+            end    
+            return true
+        end    
+
+        def check_eth_addr(name, input)
+            if !((eth_address?(input))||(input == "ETH")||(input == "XDAI")||(input == "XDAIT")) then
+                return "`#{name}` is not a valid Ethereum address"
+            end
+            return nil
+        end
+
+        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
+
+        def is_algo_network(chain)
+            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}`"
+            end
+            return nil
+        end
+
+        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
+                    return msg 
+                end    
+            end
+            if is_not_empty(input) then
+                msg = nil
+                if is_algo_network(chain) then
+                    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    
+                if is_not_empty(msg) then
+                    return msg 
+                end
+            end   
+            return nil
+        end
+
+        def validate_create_payment_request(params, chain)
+            # check if chain is provided 
+            msg = check_req_param("Chain", chain)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            # check if buyer_address is valid address in the network  
+            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, 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, is_token=true)
+                if is_not_empty(msg) then
+                    return msg 
+                end
+            end    
+            return nil
+        end
+        
+        def validate_refund_payment_request(params, chain)
+            # check if chain is provided 
+            msg = check_req_param("Chain", chain)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            # check if token is valid address in the network 
+            msg = check_network_addr("Token", params.token, chain, mandatory=true, is_token=true)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            return nil
+        end
+        
+        def validate_settle_payment_request(params, chain)
+            # check if chain is provided 
+            msg = check_req_param("Chain", chain)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            # check if token is valid address in the network 
+            msg = check_network_addr("Token", params.token, chain, mandatory=true, is_token=true)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            # check if amount to settle is provided
+            msg = check_req_param("Amount", params.amount)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            return nil
+        end
+        
+        def validate_create_checkout_url_request(params)
+            # check if id is provided while creating checkout url
+            msg = check_req_param("Id", params.id)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            
+            # check if currency is provided while creating checkout url
+            msg = check_req_param("Currency", params.currency)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            
+            # check if amount is provided while creating checkout url
+            msg = check_req_param("Amount", params.amount)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            
+            # check if cancel_url is provided while creating checkout url
+            msg = check_req_param("CancelUrl", params.cancel_url)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            
+            # check if success_url is provided while creating checkout url
+            msg = check_req_param("SuccessUrl", params.success_url)
+            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
+                
+                # check if chain is provided in the request, when token is provided, this is required 
+                msg = check_req_param("Chain", params.chain)
+                if is_not_empty(msg) then
+                    return msg 
+                end
+
+                # check if token is valid address in the network (if provided) 
+                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, is_token=false)
+                    if is_not_empty(msg) then
+                        return msg 
+                    end
+                end    
+            end   
+            return nil
+        end
+        
+        def validate_checkout_payment_params(params)
+            
+            # check if hmac_alg is provided while creating checkout payment parameters request
+            msg = check_req_param("HmacAlg", params.hmac_alg)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            
+            # check if hmac_input is provided while creating checkout payment parameters request
+            msg = check_req_param("HmacInput", params.hmac_input)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            
+            # check if hmac_key_id is provided while creating checkout payment parameters request
+            msg = check_req_param("HmacKeyId", params.hmac_key_id)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            
+            # check if hmac_value is provided while creating checkout payment parameters request
+            msg = check_req_param("HmacValue", params.hmac_value)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            return nil
+        end
+        
+        def validate_create_payout_request(params, chain)
+            msg = check_req_param("Chain", chain)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            # check if token is valid address in the network 
+            msg = check_network_addr("Token", params.token, chain, mandatory=true, is_token=true)
+            if is_not_empty(msg) then
+                return msg 
+            end
+
+            payouts = params.payouts
+            if payouts.length == 0 then 
+                return "Payouts not defined."
+            end
+
+            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, is_token=false)
+                if is_not_empty(msg) then
+                    return msg 
+                end
+
+                # check if payout.amount is provided for payout
+                msg = check_req_param("Amount", payout.amount)
+                if is_not_empty(msg) then
+                    return msg 
+                end
+
+                if is_algo_network(chain) then
+                    # check if payout.authorization is provided for Algorand payout
+                    msg = check_req_param("Authorization", payout.authorization)
+                    if is_not_empty(msg) then
+                        return msg 
+                    end
+                end 
+            end
+            return nil
+        end
+    end
+end

data/lib/bleumi_pay_sdk_ruby/api_client.rb

@@ -1,12 +1,12 @@
 =begin
-#Bleumi Pay API
+#Bleumi Pay REST API
 
-#A simple and powerful REST API to integrate ERC20 payments into your business or application
+#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai, Algorand payments and/or payouts into your business or application
 
 The version of the OpenAPI document: 1.0.0
 Contact: info@bleumi.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.0
+OpenAPI Generator version: 4.2.2
 
 =end
 
@@ -30,7 +30,7 @@ module BleumiPay
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "BleumiPay/#{VERSION}/ruby"
+      @user_agent = "bleumi_pay_sdk_ruby/#{VERSION}/ruby"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
@@ -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