zip_money 1.2.1

data/lib/zip_money/api_error.rb

@@ -0,0 +1,31 @@
+#Merchant API 
+#ZipMoney Merchant API Initial build
+#zipMoney Merchant API version: 2017-03-01
+
+
+module ZipMoney
+  class ApiError < StandardError
+    attr_reader :code, :response_headers, :response_body
+
+    # Usage examples:
+    #   ApiError.new
+    #   ApiError.new("message")
+    #   ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
+    #   ApiError.new(:code => 404, :message => "Not Found")
+    def initialize(arg = nil)
+      if arg.is_a? Hash
+        if arg.key?(:message) || arg.key?('message')
+          super(arg[:message] || arg['message'])
+        else
+          super arg
+        end
+
+        arg.each do |k, v|
+          instance_variable_set "@#{k}", v
+        end
+      else
+        super arg
+      end
+    end
+  end
+end

data/lib/zip_money/configuration.rb

@@ -0,0 +1,238 @@
+#Merchant API 
+#ZipMoney Merchant API Initial build
+#zipMoney Merchant API version: 2017-03-01
+
+
+require 'uri'
+
+module ZipMoney
+  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 = 'api.sandbox.zipmoney.com.au'
+      @supported_environments = {:sandbox => "api.sandbox.zipmoney.com.au",:production => "api.zipmoney.com.au"}
+      @environment = "sandbox"
+      @base_path = '/merchant/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 = '2017-03-01'
+      @retry_interval = 0
+      @num_retries =  3      
+      @user_agent = "merchantapi/#{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] 
+        @environment = environment
+        @host = @supported_environments[environment]
+      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/zip_money/models/address.rb

@@ -0,0 +1,413 @@
+#Merchant API 
+#ZipMoney Merchant API Initial build
+#zipMoney Merchant API version: 2017-03-01
+
+
+require 'date'
+
+module ZipMoney
+  # The address object
+  class Address
+    # The first line in the address
+    attr_accessor :line1
+
+    # The (optional) second address line
+    attr_accessor :line2
+
+    # The address city
+    attr_accessor :city
+
+    # The state or province
+    attr_accessor :state
+
+    # The post or zip code
+    attr_accessor :postal_code
+
+    # The ISO-3166 country code. See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
+    attr_accessor :country
+
+    # The recipient's first name
+    attr_accessor :first_name
+
+    # The recipient's last name
+    attr_accessor :last_name
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'line1' => :'line1',
+        :'line2' => :'line2',
+        :'city' => :'city',
+        :'state' => :'state',
+        :'postal_code' => :'postal_code',
+        :'country' => :'country',
+        :'first_name' => :'first_name',
+        :'last_name' => :'last_name'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.zip_types
+      {
+        :'line1' => :'String',
+        :'line2' => :'String',
+        :'city' => :'String',
+        :'state' => :'String',
+        :'postal_code' => :'String',
+        :'country' => :'String',
+        :'first_name' => :'String',
+        :'last_name' => :'String'
+      }
+    end
+
+    # 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}
+
+      if attributes.has_key?(:'line1')
+        self.line1 = attributes[:'line1']
+      end
+
+      if attributes.has_key?(:'line2')
+        self.line2 = attributes[:'line2']
+      end
+
+      if attributes.has_key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.has_key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.has_key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.has_key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.has_key?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      end
+
+      if attributes.has_key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @line1.nil?
+        invalid_properties.push("invalid value for 'line1', line1 cannot be nil.")
+      end
+
+      if @line1.to_s.length > 200
+        invalid_properties.push("invalid value for 'line1', the character length must be smaller than or equal to 200.")
+      end
+
+      if !@line2.nil? && @line2.to_s.length > 200
+        invalid_properties.push("invalid value for 'line2', the character length must be smaller than or equal to 200.")
+      end
+
+      if @city.nil?
+        invalid_properties.push("invalid value for 'city', city cannot be nil.")
+      end
+
+      if @city.to_s.length > 50
+        invalid_properties.push("invalid value for 'city', the character length must be smaller than or equal to 50.")
+      end
+
+      if @state.nil?
+        invalid_properties.push("invalid value for 'state', state cannot be nil.")
+      end
+
+      if @state.to_s.length > 50
+        invalid_properties.push("invalid value for 'state', the character length must be smaller than or equal to 50.")
+      end
+
+      if @postal_code.nil?
+        invalid_properties.push("invalid value for 'postal_code', postal_code cannot be nil.")
+      end
+
+      if @postal_code.to_s.length > 15
+        invalid_properties.push("invalid value for 'postal_code', the character length must be smaller than or equal to 15.")
+      end
+
+      if @country.nil?
+        invalid_properties.push("invalid value for 'country', country cannot be nil.")
+      end
+
+      if @country.to_s.length > 2
+        invalid_properties.push("invalid value for 'country', the character length must be smaller than or equal to 2.")
+      end
+
+      if @country.to_s.length < 2
+        invalid_properties.push("invalid value for 'country', the character length must be great than or equal to 2.")
+      end
+
+      if !@first_name.nil? && @first_name.to_s.length > 200
+        invalid_properties.push("invalid value for 'first_name', the character length must be smaller than or equal to 200.")
+      end
+
+      return 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?
+      return false if @line1.nil?
+      return false if @line1.to_s.length > 200
+      return false if !@line2.nil? && @line2.to_s.length > 200
+      return false if @city.nil?
+      return false if @city.to_s.length > 50
+      return false if @state.nil?
+      return false if @state.to_s.length > 50
+      return false if @postal_code.nil?
+      return false if @postal_code.to_s.length > 15
+      return false if @country.nil?
+      return false if @country.to_s.length > 2
+      return false if @country.to_s.length < 2
+      return false if !@first_name.nil? && @first_name.to_s.length > 200
+      return true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] line1 Value to be assigned
+    def line1=(line1)
+      if line1.nil?
+        fail ArgumentError, "line1 cannot be nil"
+      end
+
+      if line1.to_s.length > 200
+        fail ArgumentError, "invalid value for 'line1', the character length must be smaller than or equal to 200."
+      end
+
+      @line1 = line1
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] line2 Value to be assigned
+    def line2=(line2)
+
+      if !line2.nil? && line2.to_s.length > 200
+        fail ArgumentError, "invalid value for 'line2', the character length must be smaller than or equal to 200."
+      end
+
+      @line2 = line2
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] city Value to be assigned
+    def city=(city)
+      if city.nil?
+        fail ArgumentError, "city cannot be nil"
+      end
+
+      if city.to_s.length > 50
+        fail ArgumentError, "invalid value for 'city', the character length must be smaller than or equal to 50."
+      end
+
+      @city = city
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] state Value to be assigned
+    def state=(state)
+      if state.nil?
+        fail ArgumentError, "state cannot be nil"
+      end
+
+      if state.to_s.length > 50
+        fail ArgumentError, "invalid value for 'state', the character length must be smaller than or equal to 50."
+      end
+
+      @state = state
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] postal_code Value to be assigned
+    def postal_code=(postal_code)
+      if postal_code.nil?
+        fail ArgumentError, "postal_code cannot be nil"
+      end
+
+      if postal_code.to_s.length > 15
+        fail ArgumentError, "invalid value for 'postal_code', the character length must be smaller than or equal to 15."
+      end
+
+      @postal_code = postal_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country Value to be assigned
+    def country=(country)
+      if country.nil?
+        fail ArgumentError, "country cannot be nil"
+      end
+
+      if country.to_s.length > 2
+        fail ArgumentError, "invalid value for 'country', the character length must be smaller than or equal to 2."
+      end
+
+      if country.to_s.length < 2
+        fail ArgumentError, "invalid value for 'country', the character length must be great than or equal to 2."
+      end
+
+      @country = country
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] first_name Value to be assigned
+    def first_name=(first_name)
+
+      if !first_name.nil? && first_name.to_s.length > 200
+        fail ArgumentError, "invalid value for 'first_name', the character length must be smaller than or equal to 200."
+      end
+
+      @first_name = first_name
+    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 &&
+          line1 == o.line1 &&
+          line2 == o.line2 &&
+          city == o.city &&
+          state == o.state &&
+          postal_code == o.postal_code &&
+          country == o.country &&
+          first_name == o.first_name &&
+          last_name == o.last_name
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [line1, line2, city, state, postal_code, country, first_name, last_name].hash
+    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.zip_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 = ZipMoney.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