aylien_news_api 4.1.1 → 4.3.0

data/lib/aylien_news_api/models/query.rb

@@ -0,0 +1,271 @@
+=begin
+#AYLIEN News API
+
+#The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client. 
+
+The version of the OpenAPI document: 3.0
+Contact: support@aylien.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0-SNAPSHOT
+
+=end
+
+require 'date'
+
+module AylienNewsApi
+  class Query
+    attr_accessor :eq
+
+    attr_accessor :text
+
+    attr_accessor :_in
+
+    attr_accessor :gt
+
+    attr_accessor :gte
+
+    attr_accessor :lt
+
+    attr_accessor :lte
+
+    attr_accessor :boost
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'eq' => :'$eq',
+        :'text' => :'$text',
+        :'_in' => :'$in',
+        :'gt' => :'$gt',
+        :'gte' => :'$gte',
+        :'lt' => :'$lt',
+        :'lte' => :'$lte',
+        :'boost' => :'$boost'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'eq' => :'OneOfstringnumber',
+        :'text' => :'OneOfstringnumber',
+        :'_in' => :'Array<OneOfstringnumber>',
+        :'gt' => :'Float',
+        :'gte' => :'Float',
+        :'lt' => :'Float',
+        :'lte' => :'Float',
+        :'boost' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AylienNewsApi::Query` 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::Query`. 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?(:'eq')
+        self.eq = attributes[:'eq']
+      end
+
+      if attributes.key?(:'text')
+        self.text = attributes[:'text']
+      end
+
+      if attributes.key?(:'_in')
+        if (value = attributes[:'_in']).is_a?(Array)
+          self._in = value
+        end
+      end
+
+      if attributes.key?(:'gt')
+        self.gt = attributes[:'gt']
+      end
+
+      if attributes.key?(:'gte')
+        self.gte = attributes[:'gte']
+      end
+
+      if attributes.key?(:'lt')
+        self.lt = attributes[:'lt']
+      end
+
+      if attributes.key?(:'lte')
+        self.lte = attributes[:'lte']
+      end
+
+      if attributes.key?(:'boost')
+        self.boost = attributes[:'boost']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      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?
+      true
+    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 &&
+          eq == o.eq &&
+          text == o.text &&
+          _in == o._in &&
+          gt == o.gt &&
+          gte == o.gte &&
+          lt == o.lt &&
+          lte == o.lte &&
+          boost == o.boost
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [eq, text, _in, gt, gte, lt, lte, boost].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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.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
+
+    # 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
+        AylienNewsApi.const_get(type).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)
+        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
+
+    # 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

data/lib/aylien_news_api/models/story.rb

@@ -72,6 +72,9 @@ module AylienNewsApi
     # Word count of the story body
     attr_accessor :words_count
 
+    # License type of the story
+    attr_accessor :license_type
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -96,7 +99,8 @@ module AylienNewsApi
         :'summary' => :'summary',
         :'title' => :'title',
         :'translations' => :'translations',
-        :'words_count' => :'words_count'
+        :'words_count' => :'words_count',
+        :'license_type' => :'license_type'
       }
     end
 
@@ -124,7 +128,8 @@ module AylienNewsApi
         :'summary' => :'Summary',
         :'title' => :'String',
         :'translations' => :'StoryTranslations',
-        :'words_count' => :'Integer'
+        :'words_count' => :'Integer',
+        :'license_type' => :'Integer'
       }
     end
 
@@ -246,6 +251,10 @@ module AylienNewsApi
       if attributes.key?(:'words_count')
         self.words_count = attributes[:'words_count']
       end
+
+      if attributes.key?(:'license_type')
+        self.license_type = attributes[:'license_type']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -287,7 +296,8 @@ module AylienNewsApi
           summary == o.summary &&
           title == o.title &&
           translations == o.translations &&
-          words_count == o.words_count
+          words_count == o.words_count &&
+          license_type == o.license_type
     end
 
     # @see the `==` method
@@ -299,7 +309,7 @@ module AylienNewsApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [author, body, categories, characters_count, clusters, entities, hashtags, id, keywords, language, links, media, paragraphs_count, published_at, sentences_count, sentiment, social_shares_count, source, summary, title, translations, words_count].hash
+      [author, body, categories, characters_count, clusters, entities, hashtags, id, keywords, language, links, media, paragraphs_count, published_at, sentences_count, sentiment, social_shares_count, source, summary, title, translations, words_count, license_type].hash
     end
 
     # Builds the object from hash

data/lib/aylien_news_api/models/time_series.rb

@@ -20,11 +20,14 @@ module AylienNewsApi
     # The published date of the time series bin
     attr_accessor :published_at
 
+    attr_accessor :sentiment
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'count' => :'count',
-        :'published_at' => :'published_at'
+        :'published_at' => :'published_at',
+        :'sentiment' => :'sentiment'
       }
     end
 
@@ -32,7 +35,8 @@ module AylienNewsApi
     def self.openapi_types
       {
         :'count' => :'Integer',
-        :'published_at' => :'DateTime'
+        :'published_at' => :'DateTime',
+        :'sentiment' => :'AggregatedSentiment'
       }
     end
 
@@ -64,6 +68,10 @@ module AylienNewsApi
       if attributes.key?(:'published_at')
         self.published_at = attributes[:'published_at']
       end
+
+      if attributes.key?(:'sentiment')
+        self.sentiment = attributes[:'sentiment']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -85,7 +93,8 @@ module AylienNewsApi
       return true if self.equal?(o)
       self.class == o.class &&
           count == o.count &&
-          published_at == o.published_at
+          published_at == o.published_at &&
+          sentiment == o.sentiment
     end
 
     # @see the `==` method
@@ -97,7 +106,7 @@ module AylienNewsApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [count, published_at].hash
+      [count, published_at, sentiment].hash
     end
 
     # Builds the object from hash

data/lib/aylien_news_api/models/trend.rb

@@ -20,11 +20,14 @@ module AylienNewsApi
     # The value of the trend
     attr_accessor :value
 
+    attr_accessor :sentiment
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'count' => :'count',
-        :'value' => :'value'
+        :'value' => :'value',
+        :'sentiment' => :'sentiment'
       }
     end
 
@@ -32,7 +35,8 @@ module AylienNewsApi
     def self.openapi_types
       {
         :'count' => :'Integer',
-        :'value' => :'String'
+        :'value' => :'String',
+        :'sentiment' => :'AggregatedSentiment'
       }
     end
 
@@ -64,6 +68,10 @@ module AylienNewsApi
       if attributes.key?(:'value')
         self.value = attributes[:'value']
       end
+
+      if attributes.key?(:'sentiment')
+        self.sentiment = attributes[:'sentiment']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -85,7 +93,8 @@ module AylienNewsApi
       return true if self.equal?(o)
       self.class == o.class &&
           count == o.count &&
-          value == o.value
+          value == o.value &&
+          sentiment == o.sentiment
     end
 
     # @see the `==` method
@@ -97,7 +106,7 @@ module AylienNewsApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [count, value].hash
+      [count, value, sentiment].hash
     end
 
     # Builds the object from hash

data/lib/aylien_news_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.0.0-SNAPSHOT
 =end
 
 module AylienNewsApi
-  VERSION = '4.1.1'
+  VERSION = '4.3.0'
 end

data/spec/api/default_api_spec.rb

@@ -32,6 +32,25 @@ describe 'DefaultApi' do
     end
   end
 
+  # unit tests for advanced_list_stories
+  # List Stories
+  # The stories endpoint is used to return stories based on the json query you set in your request body. The News API crawler gathers articles in near real-time and stores information about them, or metadata. Below you can see all of the query parameters, and JSON schema for the body, which you can use to narrow down your query. 
+  # @param unknown_base_type /stories body schema to perform an advanced search with logical operators and nested objects. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :published_at_start This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). 
+  # @option opts [String] :published_at_end This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). 
+  # @option opts [Array<String>] :_return This parameter is used for specifying return fields.
+  # @option opts [String] :sort_by This parameter is used for changing the order column of the results. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results). 
+  # @option opts [String] :sort_direction This parameter is used for changing the order direction of the result. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results). 
+  # @option opts [String] :cursor This parameter is used for finding a specific page. You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results). 
+  # @option opts [Integer] :per_page This parameter is used for specifying number of items in each page You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results) 
+  # @return [Stories]
+  describe 'advanced_list_stories test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for list_autocompletes
   # List autocompletes
   # The autocompletes endpoint a string of characters provided to it, and then returns suggested terms that are the most likely full words or strings. The terms returned by the News API are based on parameters the type parameters you can see below. For example, if you provide the autocompletes endpoint with the term &#x60;New York C&#x60; and select the type &#x60;dbpedia_resources&#x60;, the API will return links to the DBpedia resources &#x60;New_York_City&#x60;, &#x60;New_York_City_Subway&#x60;, &#x60;New_York_City_Police_Department&#x60;, and so on.