aylien_news_api 0.1.0 → 0.2.0

data/lib/aylien_news_api/models/related_stories.rb

@@ -15,6 +15,7 @@
 require 'date'
 
 module AylienNewsApi
+
   class RelatedStories
     # The input story title
     attr_accessor :story_title
@@ -28,13 +29,18 @@ module AylienNewsApi
     # An array of related stories for the input story
     attr_accessor :related_stories
 
+    # An array of clusters
+    attr_accessor :clusters
+
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'story_title' => :'story_title',
         :'story_body' => :'story_body',
         :'story_language' => :'story_language',
-        :'related_stories' => :'related_stories'
+        :'related_stories' => :'related_stories',
+        :'clusters' => :'clusters'
       }
     end
 
@@ -44,7 +50,8 @@ module AylienNewsApi
         :'story_title' => :'String',
         :'story_body' => :'String',
         :'story_language' => :'String',
-        :'related_stories' => :'Array<Story>'
+        :'related_stories' => :'Array<Story>',
+        :'clusters' => :'Array<StoryCluster>'
       }
     end
 
@@ -56,35 +63,59 @@ module AylienNewsApi
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes[:'story_title']
+      if attributes.has_key?(:'story_title')
         self.story_title = attributes[:'story_title']
       end
-      if attributes[:'story_body']
+
+      if attributes.has_key?(:'story_body')
         self.story_body = attributes[:'story_body']
       end
-      if attributes[:'story_language']
+
+      if attributes.has_key?(:'story_language')
         self.story_language = attributes[:'story_language']
       end
-      if attributes[:'related_stories']
+
+      if attributes.has_key?(:'related_stories')
         if (value = attributes[:'related_stories']).is_a?(Array)
           self.related_stories = value
         end
       end
+
+      if attributes.has_key?(:'clusters')
+        if (value = attributes[:'clusters']).is_a?(Array)
+          self.clusters = value
+        end
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return 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?
+      return true
     end
 
     # Checks equality by comparing each attribute.
-    # @param [Object] Object to be compared 
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
           story_title == o.story_title &&
           story_body == o.story_body &&
           story_language == o.story_language &&
-          related_stories == o.related_stories
+          related_stories == o.related_stories &&
+          clusters == o.clusters
     end
 
     # @see the `==` method
-    # @param [Object] Object to be compared 
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
@@ -92,7 +123,7 @@ module AylienNewsApi
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [story_title, story_body, story_language, related_stories].hash
+      [story_title, story_body, story_language, related_stories, clusters].hash
     end
 
     # Builds the object from hash
@@ -183,7 +214,7 @@ module AylienNewsApi
 
     # 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 
+    # @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)
@@ -200,4 +231,5 @@ module AylienNewsApi
     end
 
   end
+
 end

data/lib/aylien_news_api/models/scope.rb

@@ -15,19 +15,42 @@
 require 'date'
 
 module AylienNewsApi
+
   class Scope
-    # The country code of the scope. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
+    # The source scope by country code. It supports [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
     attr_accessor :country
 
-    # The state of the scope
+    # The scope by state
     attr_accessor :state
 
-    # The city of the scope
+    # The scope by city
     attr_accessor :city
 
-    # The level of the scope
+    # The scope by level
     attr_accessor :level
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -56,32 +79,51 @@ module AylienNewsApi
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes[:'country']
+      if attributes.has_key?(:'country')
         self.country = attributes[:'country']
       end
-      if attributes[:'state']
+
+      if attributes.has_key?(:'state')
         self.state = attributes[:'state']
       end
-      if attributes[:'city']
+
+      if attributes.has_key?(:'city')
         self.city = attributes[:'city']
       end
-      if attributes[:'level']
+
+      if attributes.has_key?(:'level')
         self.level = attributes[:'level']
       end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return 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?
+      level_validator = EnumAttributeValidator.new('String', ["international", "national", "local"])
+      return false unless level_validator.valid?(@level)
+      return true
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] level Object to be assigned
     def level=(level)
-      allowed_values = ["international", "national", "local"]
-      if level && !allowed_values.include?(level)
-        fail "invalid value for 'level', must be one of #{allowed_values}"
+      validator = EnumAttributeValidator.new('String', ["international", "national", "local"])
+      unless validator.valid?(level)
+        fail ArgumentError, "invalid value for 'level', must be one of #{validator.allowable_values}."
       end
       @level = level
     end
 
     # Checks equality by comparing each attribute.
-    # @param [Object] Object to be compared 
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -92,7 +134,7 @@ module AylienNewsApi
     end
 
     # @see the `==` method
-    # @param [Object] Object to be compared 
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
@@ -191,7 +233,7 @@ module AylienNewsApi
 
     # 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 
+    # @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)
@@ -208,4 +250,5 @@ module AylienNewsApi
     end
 
   end
+
 end

data/lib/aylien_news_api/models/sentiment.rb

@@ -15,6 +15,7 @@
 require 'date'
 
 module AylienNewsApi
+
   class Sentiment
     # Polarity of the sentiment
     attr_accessor :polarity
@@ -22,6 +23,28 @@ module AylienNewsApi
     # Polarity score of the sentiment
     attr_accessor :score
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -46,26 +69,63 @@ module AylienNewsApi
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes[:'polarity']
+      if attributes.has_key?(:'polarity')
         self.polarity = attributes[:'polarity']
       end
-      if attributes[:'score']
+
+      if attributes.has_key?(:'score')
         self.score = attributes[:'score']
       end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return 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?
+      polarity_validator = EnumAttributeValidator.new('String', ["positive", "neutral", "negative"])
+      return false unless polarity_validator.valid?(@polarity)
+      return false if @score > 1.0
+      return false if @score < 0.0
+      return true
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] polarity Object to be assigned
     def polarity=(polarity)
-      allowed_values = ["positive", "neutral", "negative"]
-      if polarity && !allowed_values.include?(polarity)
-        fail "invalid value for 'polarity', must be one of #{allowed_values}"
+      validator = EnumAttributeValidator.new('String', ["positive", "neutral", "negative"])
+      unless validator.valid?(polarity)
+        fail ArgumentError, "invalid value for 'polarity', must be one of #{validator.allowable_values}."
       end
       @polarity = polarity
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] score Value to be assigned
+    def score=(score)
+      if score.nil?
+        fail ArgumentError, "score cannot be nil"
+      end
+
+      if score > 1.0
+        fail ArgumentError, "invalid value for 'score', must be smaller than or equal to 1.0."
+      end
+
+      if score < 0.0
+        fail ArgumentError, "invalid value for 'score', must be greater than or equal to 0.0."
+      end
+
+      @score = score
+    end
+
     # Checks equality by comparing each attribute.
-    # @param [Object] Object to be compared 
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -74,7 +134,7 @@ module AylienNewsApi
     end
 
     # @see the `==` method
-    # @param [Object] Object to be compared 
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
@@ -173,7 +233,7 @@ module AylienNewsApi
 
     # 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 
+    # @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)
@@ -190,4 +250,5 @@ module AylienNewsApi
     end
 
   end
+
 end

data/lib/aylien_news_api/models/sentiments.rb

@@ -15,6 +15,7 @@
 require 'date'
 
 module AylienNewsApi
+
   class Sentiments
     # The sentiment for the story title
     attr_accessor :title
@@ -22,6 +23,7 @@ module AylienNewsApi
     # The sentiment for the story body
     attr_accessor :body
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -46,16 +48,31 @@ module AylienNewsApi
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes[:'title']
+      if attributes.has_key?(:'title')
         self.title = attributes[:'title']
       end
-      if attributes[:'body']
+
+      if attributes.has_key?(:'body')
         self.body = attributes[:'body']
       end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return 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?
+      return true
     end
 
     # Checks equality by comparing each attribute.
-    # @param [Object] Object to be compared 
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -64,7 +81,7 @@ module AylienNewsApi
     end
 
     # @see the `==` method
-    # @param [Object] Object to be compared 
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
@@ -163,7 +180,7 @@ module AylienNewsApi
 
     # 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 
+    # @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)
@@ -180,4 +197,5 @@ module AylienNewsApi
     end
 
   end
+
 end