Class: Shotstack::Crop

Inherits:
Object
  • Object
show all
Defined in:
lib/shotstack/models/crop.rb

Overview

Crop the sides of an asset by a relative amount. The size of the crop is specified using a scale between 0 and 1, relative to the screen width - i.e a left crop of 0.5 will crop half of the asset from the left, a top crop of 0.25 will crop the top by quarter of the asset.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Crop

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/shotstack/models/crop.rb', line 64

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Shotstack::Crop` 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 `Shotstack::Crop`. 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?(:'top')
    self.top = attributes[:'top']
  end

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

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

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

Instance Attribute Details

#bottom ⇒ Object

Crop from the bottom of the asset



23
24
25
 
# File 'lib/shotstack/models/crop.rb', line 23

def bottom
  @bottom
end

#left ⇒ Object

Crop from the left of the asset



26
27
28
 
# File 'lib/shotstack/models/crop.rb', line 26

def left
  @left
end

#right ⇒ Object

Crop from the left of the asset



29
30
31
 
# File 'lib/shotstack/models/crop.rb', line 29

def right
  @right
end

#top ⇒ Object

Crop from the top of the asset



20
21
22
 
# File 'lib/shotstack/models/crop.rb', line 20

def top
  @top
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



42
43
44
 
# File 'lib/shotstack/models/crop.rb', line 42

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
 
# File 'lib/shotstack/models/crop.rb', line 32

def self.attribute_map
  {
    :'top' => :'top',
    :'bottom' => :'bottom',
    :'left' => :'left',
    :'right' => :'right'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



229
230
231
 
# File 'lib/shotstack/models/crop.rb', line 229

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



57
58
59
60
 
# File 'lib/shotstack/models/crop.rb', line 57

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

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
 
# File 'lib/shotstack/models/crop.rb', line 47

def self.openapi_types
  {
    :'top' => :'Float',
    :'bottom' => :'Float',
    :'left' => :'Float',
    :'right' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



205
206
207
208
209
210
211
212
 
# File 'lib/shotstack/models/crop.rb', line 205

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      top == o.top &&
      bottom == o.bottom &&
      left == o.left &&
      right == o.right
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/shotstack/models/crop.rb', line 259

def _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
  else # model
    # models (e.g. Pet) or oneOf
    klass = Shotstack.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/shotstack/models/crop.rb', line 330

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/shotstack/models/crop.rb', line 236

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", 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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


216
217
218
 
# File 'lib/shotstack/models/crop.rb', line 216

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



222
223
224
 
# File 'lib/shotstack/models/crop.rb', line 222

def hash
  [top, bottom, left, right].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
 
# File 'lib/shotstack/models/crop.rb', line 96

def list_invalid_properties
  invalid_properties = Array.new
  if !@top.nil? && @top > 1
    invalid_properties.push('invalid value for "top", must be smaller than or equal to 1.')
  end

  if !@top.nil? && @top < 0
    invalid_properties.push('invalid value for "top", must be greater than or equal to 0.')
  end

  if !@bottom.nil? && @bottom > 1
    invalid_properties.push('invalid value for "bottom", must be smaller than or equal to 1.')
  end

  if !@bottom.nil? && @bottom < 0
    invalid_properties.push('invalid value for "bottom", must be greater than or equal to 0.')
  end

  if !@left.nil? && @left > 1
    invalid_properties.push('invalid value for "left", must be smaller than or equal to 1.')
  end

  if !@left.nil? && @left < 0
    invalid_properties.push('invalid value for "left", must be greater than or equal to 0.')
  end

  if !@right.nil? && @right > 1
    invalid_properties.push('invalid value for "right", must be smaller than or equal to 1.')
  end

  if !@right.nil? && @right < 0
    invalid_properties.push('invalid value for "right", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



306
307
308
 
# File 'lib/shotstack/models/crop.rb', line 306

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/shotstack/models/crop.rb', line 312

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



300
301
302
 
# File 'lib/shotstack/models/crop.rb', line 300

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/shotstack/models/crop.rb', line 135

def valid?
  return false if !@top.nil? && @top > 1
  return false if !@top.nil? && @top < 0
  return false if !@bottom.nil? && @bottom > 1
  return false if !@bottom.nil? && @bottom < 0
  return false if !@left.nil? && @left > 1
  return false if !@left.nil? && @left < 0
  return false if !@right.nil? && @right > 1
  return false if !@right.nil? && @right < 0
  true
end