Class: Algolia::Ingestion::SourceCommercetools

Inherits:
Object
  • Object
show all
Defined in:
lib/algolia/models/ingestion/source_commercetools.rb

Overview

Specific configuration attributes of a ‘commercetools` source.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SourceCommercetools

Initializes the object



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 76

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    raise(
      ArgumentError,
      "The input argument (attributes) must be a hash in `Algolia::SourceCommercetools` 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))
      raise(
        ArgumentError,
        "`#{k}` is not a valid attribute in `Algolia::SourceCommercetools`. 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?(:store_keys)
    if (value = attributes[:store_keys]).is_a?(Array)
      self.store_keys = value
    end
  end

  if attributes.key?(:locales)
    if (value = attributes[:locales]).is_a?(Array)
      self.locales = value
    end
  end

  if attributes.key?(:url)
    self.url = attributes[:url]
  else
    self.url = nil
  end

  if attributes.key?(:project_key)
    self.project_key = attributes[:project_key]
  else
    self.project_key = nil
  end

  if attributes.key?(:fallback_is_in_stock_value)
    self.fallback_is_in_stock_value = attributes[:fallback_is_in_stock_value]
  end

  if attributes.key?(:product_query_predicate)
    self.product_query_predicate = attributes[:product_query_predicate]
  end

  if attributes.key?(:use_images_objects)
    self.use_images_objects = attributes[:use_images_objects]
  end

  if attributes.key?(:custom_fields)
    self.custom_fields = attributes[:custom_fields]
  end
end

Instance Attribute Details

#custom_fields ⇒ Object

Returns the value of attribute custom_fields.



30
31
32
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 30

def custom_fields
  @custom_fields
end

#fallback_is_in_stock_value ⇒ Object

Whether a fallback value is stored in the Algolia record if there’s no inventory information about the product.



22
23
24
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 22

def fallback_is_in_stock_value
  @fallback_is_in_stock_value
end

#locales ⇒ Object

Locales for your commercetools stores.



15
16
17
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 15

def locales
  @locales
end

#product_query_predicate ⇒ Object

Predicate to filter out specific products when indexing. For more information, see [Query Predicate](docs.commercetools.com/api/predicates/query).



25
26
27
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 25

def product_query_predicate
  @product_query_predicate
end

#project_key ⇒ Object

Returns the value of attribute project_key.



19
20
21
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 19

def project_key
  @project_key
end

#store_keys ⇒ Object

Returns the value of attribute store_keys.



12
13
14
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 12

def store_keys
  @store_keys
end

#url ⇒ Object

Returns the value of attribute url.



17
18
19
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 17

def url
  @url
end

#use_images_objects ⇒ Object

When set to true, the connector indexes objects with all images attributes instead of only the URLs.



28
29
30
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 28

def use_images_objects
  @use_images_objects
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 204

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # model
  else
    # models (e.g. Pet) or oneOf
    klass = Algolia::Ingestion.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass
      .build_from_hash(value)
  end
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 33

def self.attribute_map
  {
    :store_keys => :storeKeys,
    :locales => :locales,
    :url => :url,
    :project_key => :projectKey,
    :fallback_is_in_stock_value => :fallbackIsInStockValue,
    :product_query_predicate => :productQueryPredicate,
    :use_images_objects => :useImagesObjects,
    :custom_fields => :customFields
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 177

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  types_mapping.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash[key.to_sym] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash[key.to_sym] = attributes[attribute_map[key]].map { |v|
          _deserialize(::Regexp.last_match(1), v)
        }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]])
    end
  end

  new(transformed_hash)
end

.discriminator_attributes ⇒ Object

Returns the keys that uniquely identify this oneOf variant when present



47
48
49
50
51
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 47

def self.discriminator_attributes
  [
    :projectKey
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



68
69
70
71
72
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 68

def self.openapi_nullable
  Set.new(
    []
  )
end

.types_mapping ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 54

def self.types_mapping
  {
    :store_keys => :"Array<String>",
    :locales => :"Array<String>",
    :url => :"String",
    :project_key => :"String",
    :fallback_is_in_stock_value => :"Boolean",
    :product_query_predicate => :"String",
    :use_images_objects => :"Boolean",
    :custom_fields => :"CommercetoolsCustomFields"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 140

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    store_keys == other.store_keys &&
    locales == other.locales &&
    url == other.url &&
    project_key == other.project_key &&
    fallback_is_in_stock_value == other.fallback_is_in_stock_value &&
    product_query_predicate == other.product_query_predicate &&
    use_images_objects == other.use_images_objects &&
    custom_fields == other.custom_fields
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 283

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

#eql?(other) ⇒ Boolean

See Also:

  • `==` method


155
156
157
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 155

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 161

def hash
  [
    store_keys,
    locales,
    url,
    project_key,
    fallback_is_in_stock_value,
    product_query_predicate,
    use_images_objects,
    custom_fields
  ].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



254
255
256
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 254

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 264

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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

#to_json(*_args) ⇒ Object 



258
259
260
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 258

def to_json(*_args)
  to_hash.to_json
end

#to_s ⇒ String

Returns the string representation of the object



248
249
250
 
# File 'lib/algolia/models/ingestion/source_commercetools.rb', line 248

def to_s
  to_hash.to_s
end