Module: Io::Flow::V0::HttpClient::Preconditions

Defined in:
lib/flow_commerce/flow_api_v0_client.rb

Class Method Summary collapse

Class Method Details

.assert_boolean(field_name, value) ⇒ Object 



20107
20108
20109
20110
20111
20112
20113
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20107

def Preconditions.assert_boolean(field_name, value)
  Preconditions.check_not_nil('field_name', field_name)
  Preconditions.check_not_nil('value', value, "Value for %s cannot be nil. Expected an instance of TrueClass or FalseClass" % field_name)
  Preconditions.check_state(value.is_a?(TrueClass) || value.is_a?(FalseClass),
                            "Value for #{field_name} is of type[#{value.class}] - class[TrueClass or FalseClass] is required. value[#{value.inspect.to_s}]")
  value
end

.assert_boolean_or_nil(field_name, value) ⇒ Object 



20115
20116
20117
20118
20119
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20115

def Preconditions.assert_boolean_or_nil(field_name, value)
  if !value.nil?
    Preconditions.assert_boolean(field_name, value)
  end
end

.assert_class(field_name, value, klass) ⇒ Object

Asserts that value is not nill and is_?(klass). Returns value. Common use is

amount = Preconditions.assert_class(‘amount’, amount, BigDecimal)



20092
20093
20094
20095
20096
20097
20098
20099
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20092

def Preconditions.assert_class(field_name, value, klass)
  Preconditions.check_not_nil('field_name', field_name)
  Preconditions.check_not_nil('klass', klass)
  Preconditions.check_not_nil('value', value, "Value for %s cannot be nil. Expected an instance of class %s" % [field_name, klass.name])
  Preconditions.check_state(value.is_a?(klass),
                            "Value for #{field_name} is of type[#{value.class}] - class[#{klass}] is required. value[#{value.inspect.to_s}]")
  value
end

.assert_class_or_nil(field_name, value, klass) ⇒ Object 



20101
20102
20103
20104
20105
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20101

def Preconditions.assert_class_or_nil(field_name, value, klass)
  if !value.nil?
    Preconditions.assert_class(field_name, value, klass)
  end
end

.assert_collection_of_class(field_name, values, klass) ⇒ Object 



20121
20122
20123
20124
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20121

def Preconditions.assert_collection_of_class(field_name, values, klass)
  Preconditions.assert_class(field_name, values, Array)
  values.each { |v| Preconditions.assert_class(field_name, v, klass) }
end

.assert_empty_opts(opts) ⇒ Object

Throws an error if opts is not empty. Useful when parsing arguments to a function



20072
20073
20074
20075
20076
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20072

def Preconditions.assert_empty_opts(opts)
  if !opts.empty?
    raise PreconditionException.new("Invalid opts: #{opts.keys.inspect}\n#{opts.inspect}")
  end
end

.assert_hash_of_class(field_name, hash, klass) ⇒ Object 



20126
20127
20128
20129
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20126

def Preconditions.assert_hash_of_class(field_name, hash, klass)
  Preconditions.assert_class(field_name, hash, Hash)
  values.each { |k, v| Preconditions.assert_class(field_name, v, klass) }
end

.check_argument(expression, error_message = nil) ⇒ Object 



20042
20043
20044
20045
20046
20047
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20042

def Preconditions.check_argument(expression, error_message=nil)
  if !expression
    raise PreconditionException.new(error_message || "check_argument failed")
  end
  nil
end

.check_not_blank(field_name, reference, error_message = nil) ⇒ Object 



20063
20064
20065
20066
20067
20068
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20063

def Preconditions.check_not_blank(field_name, reference, error_message=nil)
  if reference.to_s.strip == ""
    raise PreconditionException.new(error_message || "argument for %s cannot be blank" % field_name)
  end
  reference
end

.check_not_nil(field_name, reference, error_message = nil) ⇒ Object 



20056
20057
20058
20059
20060
20061
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20056

def Preconditions.check_not_nil(field_name, reference, error_message=nil)
  if reference.nil?
    raise PreconditionException.new(error_message || "argument for %s cannot be nil" % field_name)
  end
  reference
end

.check_state(expression, error_message = nil) ⇒ Object 



20049
20050
20051
20052
20053
20054
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20049

def Preconditions.check_state(expression, error_message=nil)
  if !expression
    raise PreconditionException.new(error_message || "check_state failed")
  end
  nil
end

.require_keys(hash, fields, error_prefix = nil) ⇒ Object

Requires that the provided hash has the specified keys.

Parameters:

  • fields —

    A list of symbols



20080
20081
20082
20083
20084
20085
20086
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 20080

def Preconditions.require_keys(hash, fields, error_prefix=nil)
  missing = fields.select { |f| !hash.has_key?(f) }
  if !missing.empty?
    msg = "Missing required fields: " + missing.join(", ")
    raise PreconditionException.new(error_prefix.empty? ? msg : "#{error_prefix}: #{msg}")
  end
end