windcave_rest 0.1.0

data/lib/windcave_rest/configuration.rb

@@ -0,0 +1,234 @@
+require 'uri'
+require 'logger'
+
+module WindcaveRest
+  class Configuration
+    # Defines url scheme
+    attr_accessor :scheme
+
+    # Defines url host
+    attr_accessor :host
+
+    # Defines url base path
+    attr_accessor :base_path
+
+    # Supported environments
+    attr_accessor :supported_environments
+    
+    # Current environment
+    attr_accessor :environment
+
+    # Defines API keys used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: parameter value (API key)
+    #
+    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
+    #   config.api_key['api_key'] = 'xxx'
+    attr_accessor :api_key
+
+    # Defines API key prefixes used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: API key prefix
+    #
+    # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
+    #   config.api_key_prefix['api_key'] = 'Token'
+    attr_accessor :api_key_prefix
+
+    # Defines the username used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :username
+
+    # Defines the password used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :password
+
+    # Defines the access token (Bearer) used with OAuth2.
+    attr_accessor :access_token
+
+    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+    # details will be logged with `logger.debug` (see the `logger` attribute).
+    # Default to false.
+    #
+    # @return [true, false]
+    attr_accessor :debugging
+
+    # Defines the logger used for debugging.
+    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+    #
+    # @return [#debug]
+    attr_accessor :logger
+
+    # Defines the temporary folder to store downloaded files
+    # (for API endpoints that have file response).
+    # Default to use `Tempfile`.
+    #
+    # @return [String]
+    attr_accessor :temp_folder_path
+
+    # The time limit for HTTP request in seconds.
+    # Default to 0 (never times out).
+    attr_accessor :timeout
+
+    # Number of retries allowed if the first one fails. 
+    # Default to 0 (no retries).
+    attr_accessor :num_retries
+
+    # Retry interval.
+    # Default to 0 (retry immediately).
+    attr_accessor :retry_interval
+
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL certificate when calling API from https server.
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL host name
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl_host
+
+    ### TLS/SSL setting
+    # Set this to customize the certificate file to verify the peer.
+    #
+    # @return [String] the path to the certificate file
+    #
+    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
+    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
+    attr_accessor :ssl_ca_cert
+
+    ### TLS/SSL setting
+    # Client certificate file (for client certificate)
+    attr_accessor :cert_file
+
+    ### TLS/SSL setting
+    # Client private key file (for client certificate)
+    attr_accessor :key_file
+
+    # Set this to customize parameters encoding of array parameter with multi collectionFormat.
+    # Default to nil.
+    #
+    # @see The params_encoding option of Ethon. Related source code:
+    # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
+    attr_accessor :params_encoding
+
+    attr_accessor :inject_format
+
+    attr_accessor :force_ending_format
+    
+    attr_accessor :api_version
+
+    attr_accessor :platform
+
+    attr_accessor :user_agent
+
+    def initialize
+      @scheme = 'https'
+      @host = 'uat.windcave.com'
+      @supported_environments = { :test => "uat.windcave.com", :live => "sec.windcave.com" }
+      @environment = "test"
+      @base_path = '/api/v1'
+      @api_key = {}
+      @api_key_prefix = {}
+      @timeout = 0
+      @verify_ssl = true
+      @verify_ssl_host = true
+      @params_encoding = nil
+      @cert_file = nil
+      @key_file = nil
+      @debugging = false
+      @inject_format = false
+      @force_ending_format = false
+      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+      @api_version = '1'
+      @retry_interval = 0
+      @num_retries =  3      
+      @user_agent = "windcave_rest/#{VERSION}/ruby"
+
+      yield(self) if block_given?
+    end
+
+    # The default Configuration object.
+    def self.default
+      @@default ||= Configuration.new
+    end
+
+    def configure
+      yield(self) if block_given?
+    end
+
+    def scheme=(scheme)
+      # remove :// from scheme
+      @scheme = scheme.sub(/:\/\//, '')
+    end
+
+    def environment=(environment)
+      if @supported_environments[environment.to_sym] 
+        @environment = environment
+        @host = @supported_environments[environment.to_sym]
+      end  
+    end
+
+    def host=(host)
+      # remove http(s):// and anything after a slash
+      @host = host.sub(/https?:\/\//, '').split('/').first
+    end
+
+    def base_path=(base_path)
+      # Add leading and trailing slashes to base_path
+      @base_path = "/#{base_path}".gsub(/\/+/, '/')
+      @base_path = "" if @base_path == "/"
+    end
+
+    def base_url
+      url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+      URI.encode(url)
+    end
+
+    # Gets API key (with prefix if set).
+    # @param [String] param_name the parameter name of API key auth
+    def api_key_with_prefix(param_name)
+      if @api_key_prefix[param_name]
+        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+      else
+        @api_key[param_name]
+      end
+    end
+
+    # Gets Basic Auth token string
+    def basic_auth_token
+      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
+    end
+
+    def user_agent=(user_agent)
+      @user_agent = user_agent
+    end
+
+    def platform=(platform)
+      @platform = platform
+    end
+
+    # Returns Auth Settings hash for api client.
+    def auth_settings
+      {
+        'Authorization' =>
+          {
+            type: 'api_key',
+            in: 'header',
+            key: 'Authorization',
+            value: api_key_with_prefix('Authorization')
+          },
+      }
+    end
+  end
+end

data/lib/windcave_rest/models/address.rb

@@ -0,0 +1,24 @@
+module WindcaveRest
+  class Address < WindcaveRest::Base
+    api_attribute :name
+
+    # (required)
+    api_attribute :address1
+
+    api_attribute :address2
+
+    api_attribute :address3
+
+    api_attribute :city
+
+    # ISO 3166-1 alpha-2
+    api_attribute :country_code
+
+    # state of country, second part of ISO 3166-2 code
+    api_attribute :state
+
+    api_attribute :postal_code
+
+    api_attribute :phone_number
+  end
+end

data/lib/windcave_rest/models/avs.rb

@@ -0,0 +1,22 @@
+module WindcaveRest
+  class Avs < WindcaveRest::Base
+
+    # (required) post code of the card holders registered billing address
+    api_attribute :post_code
+
+    # (required) street address of the card holders registered billing address
+    api_attribute :street_address
+
+    # (required) instruction on how to process avs response. 0, 1, 2, 3, 4
+    api_attribute :avs_action, :'Integer'
+
+    # (required) avs action as a string
+    api_attribute :avs_action_name
+
+    # (required) outcome code, single Upper case character as per https://en.wikipedia.org/wiki/Address_Verification_System
+    api_attribute :avs_result_code
+
+    # (required) outcome description
+    api_attribute :avs_result_description
+  end
+end

data/lib/windcave_rest/models/base.rb

@@ -0,0 +1,152 @@
+module WindcaveRest
+  class Base
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      self.class.windcave_types.keys.each do |attrib|
+        if attributes.has_key?(attrib)
+          self.send("#{attrib.to_s}=", attributes[attrib])
+        end
+      end
+    end
+
+    def self.api_attribute(attribute, datatype = :'String', api_format = :"#{attribute.to_s.camel_case_lower}")
+      self.__send__(:attr_accessor, attribute)
+
+      @attribute_map ||= {}
+      @windcave_types ||= {}
+
+      @attribute_map[attribute] = api_format
+      @windcave_types[attribute] = datatype
+    end
+
+    def self.attribute_map
+      @attribute_map
+    end
+
+    def self.windcave_types
+      @windcave_types
+    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.windcave_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the 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
+        temp_model = WindcaveRest.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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
+
+# to convert from snake case to camel case in String
+class String
+  def camel_case
+    return self if self !~ /_/ && self =~ /[A-Z]+.*/
+    split('_').map{|e| e.capitalize}.join
+  end
+
+  def camel_case_lower
+    self.split('_').inject([]){ |buffer,e| buffer.push(buffer.empty? ? e : e.capitalize) }.join
+  end
+end

data/lib/windcave_rest/models/browser.rb

@@ -0,0 +1,6 @@
+module WindcaveRest
+  class Browser < WindcaveRest::Base
+    api_attribute :ip_address
+    api_attribute :user_agent
+  end
+end

data/lib/windcave_rest/models/callback_urls.rb

@@ -0,0 +1,12 @@
+module WindcaveRest
+  class CallbackUrls < WindcaveRest::Base
+    # populate with the url you want the cardholder to be redirected back to on processing an approved transaction.
+    api_attribute :approved
+
+    # populate with the url you want the cardholder to be redirected back to on processing a final declined transaction.
+    api_attribute :declined
+
+    # populate with the url you want the cardholder to be redirected back to on a cancel payment occurring.
+    api_attribute :cancelled
+  end
+end