class AylienNewsApi::Source

Attributes

description[RW]

A general explanation about the source

domain[RW]

The domain name of the source which is extracted from the source URL

home_page_url[RW]

The home page URL of the source

id[RW]

The source id which is a unique value

locations[RW]

The source locations which are tend to be the physical locations of the source, e.g. BBC headquarter is located in London.

logo_url[RW]

A URL which points to the source logo

name[RW]

The source name

rankings[RW]
scopes[RW]

The source scopes which is tend to be scope locations of the source, e.g. BBC scopes is international.

title[RW]

The title of the home page URL

Public Class Methods

attribute_map() click to toggle source

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

# File lib/aylien_news_api/models/source.rb, line 50
def self.attribute_map
  {
    :'description' => :'description',
    :'domain' => :'domain',
    :'home_page_url' => :'home_page_url',
    :'id' => :'id',
    :'links_in_count' => :'links_in_count',
    :'locations' => :'locations',
    :'logo_url' => :'logo_url',
    :'name' => :'name',
    :'rankings' => :'rankings',
    :'scopes' => :'scopes',
    :'title' => :'title'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/aylien_news_api/models/source.rb, line 199
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/aylien_news_api/models/source.rb, line 91
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AylienNewsApi::Source` 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 `AylienNewsApi::Source`. 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?(:'description')
    self.description = attributes[:'description']
  end

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'title')
    self.title = attributes[:'title']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/aylien_news_api/models/source.rb, line 84
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/aylien_news_api/models/source.rb, line 67
def self.openapi_types
  {
    :'description' => :'String',
    :'domain' => :'String',
    :'home_page_url' => :'String',
    :'id' => :'Integer',
    :'links_in_count' => :'Integer',
    :'locations' => :'Array<Location>',
    :'logo_url' => :'String',
    :'name' => :'String',
    :'rankings' => :'Rankings',
    :'scopes' => :'Array<Scope>',
    :'title' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/aylien_news_api/models/source.rb, line 168
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      domain == o.domain &&
      home_page_url == o.home_page_url &&
      id == o.id &&
      links_in_count == o.links_in_count &&
      locations == o.locations &&
      logo_url == o.logo_url &&
      name == o.name &&
      rankings == o.rankings &&
      scopes == o.scopes &&
      title == o.title
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/aylien_news_api/models/source.rb, line 227
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
    AylienNewsApi.const_get(type).build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

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

# File lib/aylien_news_api/models/source.rb, line 296
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/aylien_news_api/models/source.rb, line 206
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/aylien_news_api/models/source.rb, line 186
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/aylien_news_api/models/source.rb, line 192
def hash
  [description, domain, home_page_url, id, links_in_count, locations, logo_url, name, rankings, scopes, title].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/aylien_news_api/models/source.rb, line 155
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/aylien_news_api/models/source.rb, line 272
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/aylien_news_api/models/source.rb, line 278
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/aylien_news_api/models/source.rb, line 266
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/aylien_news_api/models/source.rb, line 162
def valid?
  true
end