bleumi_pay_sdk_ruby 1.0.3 → 1.0.8

data/lib/bleumi_pay_sdk_ruby/api/payouts_api.rb

@@ -1,7 +1,7 @@
 =begin
-#Bleumi Pay API
+#Bleumi Pay REST API
 
-#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai payments and/or payouts 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

data/lib/bleumi_pay_sdk_ruby/api/request_validator.rb

@@ -0,0 +1,261 @@
+=begin
+#Bleumi Pay REST API
+
+#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai, Algorand 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_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 transfer_address is valid address in the network (if provided) 
+                if is_not_empty(params.transfer_address) then
+                    msg = check_network_addr("TransferAddress", params.transfer_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,7 +1,7 @@
 =begin
-#Bleumi Pay API
+#Bleumi Pay REST API
 
-#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai payments and/or payouts 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
@@ -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
 

data/lib/bleumi_pay_sdk_ruby/api_error.rb

@@ -1,7 +1,7 @@
 =begin
-#Bleumi Pay API
+#Bleumi Pay REST API
 
-#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai payments and/or payouts 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

data/lib/bleumi_pay_sdk_ruby/configuration.rb

@@ -1,7 +1,7 @@
 =begin
-#Bleumi Pay API
+#Bleumi Pay REST API
 
-#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai payments and/or payouts 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
@@ -208,7 +208,7 @@ module BleumiPay
       [
         {
           url: "https://api.pay.bleumi.com/",
-          description: "Bleumi Pay API",
+          description: "Bleumi Pay REST API",
         }
       ]
     end

data/lib/bleumi_pay_sdk_ruby/models/algorand_address.rb

@@ -0,0 +1,219 @@
+=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 'date'
+
+module BleumiPay
+  class AlgorandAddress
+    attr_accessor :alg_mainnet
+
+    attr_accessor :alg_testnet
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'alg_mainnet' => :'alg_mainnet',
+        :'alg_testnet' => :'alg_testnet'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'alg_mainnet' => :'Hash<String, AlgorandWalletAddress>',
+        :'alg_testnet' => :'Hash<String, AlgorandWalletAddress>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `BleumiPay::AlgorandAddress` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `BleumiPay::AlgorandAddress`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'alg_mainnet')
+        if (value = attributes[:'alg_mainnet']).is_a?(Hash)
+          self.alg_mainnet = value
+        end
+      end
+
+      if attributes.key?(:'alg_testnet')
+        if (value = attributes[:'alg_testnet']).is_a?(Hash)
+          self.alg_testnet = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          alg_mainnet == o.alg_mainnet &&
+          alg_testnet == o.alg_testnet
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [alg_mainnet, alg_testnet].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        BleumiPay.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end