aylien_news_api 0.3.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aa2c2f32d6124f25f96c8fa0b56767670006ce1e
-  data.tar.gz: 531931f7a468cde8ebc03c7d4a8744dbb20e0e94
+SHA256:
+  metadata.gz: 103a59a0b85dedac191c3759850adf87723bcd7f4e98ccc5b86a07b9c5897c7d
+  data.tar.gz: adc3d91e41664186fa776a30bf6ad37ff85534e8cd8d79af8ba153da178eb789
 SHA512:
-  metadata.gz: 074d9de795c0103ef021c38fbcdc354033b955d7d81a6699f70200c0d0c041b29c63998b3bc688f8c57ab225dc1a517f71435aad09ad40fdbfdcaba6556cb56b
-  data.tar.gz: 189ddf25ba97325a1b72307cb8b8e1018deb8b4df20ce9746477a1363c0c923e525493425309ee4a42e598ae1908c67e28d937199f26d9acef95fe8ee190353c
+  metadata.gz: 9520368541991c79a467bf62d04796567963befd52bcc02b691136481573fa1bbf618afcbbfc62d393e4b830c579567b1a54169d4ec82e67e80ffa86e43a509b
+  data.tar.gz: 0c64e2a57e8ee735f715f8d4c8bd063d461641743f80590548950e07c0f0bc15e269b317be76329fdf92481cbfac3211fdcb2efd877af71d0f1a37021a1ebe13

data/Gemfile

@@ -1,3 +1,9 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -1,10 +1,123 @@
-# AYLIEN News API
+# AYLIEN News API - Ruby SDK
 
-AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content.
+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. 
 
 Sign up at [https://newsapi.aylien.com/](https://newsapi.aylien.com/).
 
 For more documentation see [https://newsapi.aylien.com/docs/](https://newsapi.aylien.com/docs/).
 
-## Bug Reports
-If you've got a bug report, please contact us at support@aylien.com.
+## Installation
+
+Add this to the Gemfile:
+
+    gem 'aylien_news_api', '~> 3.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/aylien/aylien_newsapi_ruby, then add the following in the Gemfile:
+
+    gem 'aylien_news_api', :git => 'https://github.com/aylien/aylien_newsapi_ruby.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'aylien_news_api'
+
+# Setup authorization
+AylienNewsApi.configure do |config|
+  config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = ENV['NEWSAPI_APP_ID']
+  config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = ENV['NEWSAPI_APP_KEY']
+end
+
+api_instance = AylienNewsApi::DefaultApi.new
+
+opts = {
+  title: 'trump',
+  published_at_start: "NOW-7DAYS",
+  published_at_end: "NOW",
+  entities_body_links_dbpedia: [
+    'http://dbpedia.org/resource/Donald_Trump',
+  ],
+  not_language: ['en'],
+  sort_by: 'social_shares_count.facebook'
+}
+
+
+begin
+  result = api_instance.list_stories(opts)
+  result.stories.each do |story|
+    puts "#{story.title} / #{story.source.name}"
+  end
+rescue AylienNewsApi::ApiError => e
+  puts "Exception when calling DefaultApi->list_stories: #{e}"
+  puts e.response_body
+end
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.aylien.com/news*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AylienNewsApi::DefaultApi* | [**list_autocompletes**](docs/DefaultApi.md#list_autocompletes) | **GET** /autocompletes | List autocompletes
+*AylienNewsApi::DefaultApi* | [**list_clusters**](docs/DefaultApi.md#list_clusters) | **GET** /clusters | List Clusters
+*AylienNewsApi::DefaultApi* | [**list_coverages**](docs/DefaultApi.md#list_coverages) | **GET** /coverages | List coverages
+*AylienNewsApi::DefaultApi* | [**list_histograms**](docs/DefaultApi.md#list_histograms) | **GET** /histograms | List histograms
+*AylienNewsApi::DefaultApi* | [**list_related_stories**](docs/DefaultApi.md#list_related_stories) | **GET** /related_stories | List related stories
+*AylienNewsApi::DefaultApi* | [**list_stories**](docs/DefaultApi.md#list_stories) | **GET** /stories | List Stories
+*AylienNewsApi::DefaultApi* | [**list_time_series**](docs/DefaultApi.md#list_time_series) | **GET** /time_series | List time series
+*AylienNewsApi::DefaultApi* | [**list_trends**](docs/DefaultApi.md#list_trends) | **GET** /trends | List trends
+
+
+## Documentation for Models
+
+ - [AylienNewsApi::Author](docs/Author.md)
+ - [AylienNewsApi::Autocomplete](docs/Autocomplete.md)
+ - [AylienNewsApi::Autocompletes](docs/Autocompletes.md)
+ - [AylienNewsApi::Category](docs/Category.md)
+ - [AylienNewsApi::CategoryLinks](docs/CategoryLinks.md)
+ - [AylienNewsApi::Cluster](docs/Cluster.md)
+ - [AylienNewsApi::Clusters](docs/Clusters.md)
+ - [AylienNewsApi::Coverages](docs/Coverages.md)
+ - [AylienNewsApi::Entities](docs/Entities.md)
+ - [AylienNewsApi::Entity](docs/Entity.md)
+ - [AylienNewsApi::EntityLinks](docs/EntityLinks.md)
+ - [AylienNewsApi::Error](docs/Error.md)
+ - [AylienNewsApi::ErrorLinks](docs/ErrorLinks.md)
+ - [AylienNewsApi::Errors](docs/Errors.md)
+ - [AylienNewsApi::HistogramInterval](docs/HistogramInterval.md)
+ - [AylienNewsApi::Histograms](docs/Histograms.md)
+ - [AylienNewsApi::Location](docs/Location.md)
+ - [AylienNewsApi::Media](docs/Media.md)
+ - [AylienNewsApi::Rank](docs/Rank.md)
+ - [AylienNewsApi::Rankings](docs/Rankings.md)
+ - [AylienNewsApi::RelatedStories](docs/RelatedStories.md)
+ - [AylienNewsApi::RepresentativeStory](docs/RepresentativeStory.md)
+ - [AylienNewsApi::Scope](docs/Scope.md)
+ - [AylienNewsApi::Sentiment](docs/Sentiment.md)
+ - [AylienNewsApi::Sentiments](docs/Sentiments.md)
+ - [AylienNewsApi::ShareCount](docs/ShareCount.md)
+ - [AylienNewsApi::ShareCounts](docs/ShareCounts.md)
+ - [AylienNewsApi::Source](docs/Source.md)
+ - [AylienNewsApi::Stories](docs/Stories.md)
+ - [AylienNewsApi::Story](docs/Story.md)
+ - [AylienNewsApi::StoryCluster](docs/StoryCluster.md)
+ - [AylienNewsApi::StoryLinks](docs/StoryLinks.md)
+ - [AylienNewsApi::StoryTranslations](docs/StoryTranslations.md)
+ - [AylienNewsApi::StoryTranslationsEn](docs/StoryTranslationsEn.md)
+ - [AylienNewsApi::Summary](docs/Summary.md)
+ - [AylienNewsApi::TimeSeries](docs/TimeSeries.md)
+ - [AylienNewsApi::TimeSeriesList](docs/TimeSeriesList.md)
+ - [AylienNewsApi::Trend](docs/Trend.md)
+ - [AylienNewsApi::Trends](docs/Trends.md)

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/aylien_news_api.gemspec

@@ -1,17 +1,16 @@
 # -*- encoding: utf-8 -*-
-# Copyright 2016 Aylien, Inc. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
+
+=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
 
 $:.push File.expand_path("../lib", __FILE__)
 require "aylien_news_api/version"
@@ -20,25 +19,19 @@ Gem::Specification.new do |s|
   s.name        = "aylien_news_api"
   s.version     = AylienNewsApi::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["AYLIEN Inc.", "Hamed R. Nik"]
-  s.email       = ["support@aylien.com", "hamed.r.nik@gmail.com"]
+  s.authors     = ["AYLIEN"]
+  s.email       = ["info@aylien.com"]
   s.homepage    = "https://newsapi.aylien.com/"
-  s.summary     = "AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content"
-  s.description = "AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content."
-  s.license     = "Apache-2.0"
-
-  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
-  s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
-
-  s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
-  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
-  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
-  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
-  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
-  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
-  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
-
-  s.files         = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
+  s.summary     = "AYLIEN's officially supported Ruby client library for accessing News API"
+  s.description = "AYLIEN's officially supported Ruby client library for accessing News API"
+  s.license     = 'Apache-2.0'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'faraday', '>= 0.14.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
   s.test_files    = `find spec/*`.split("\n")
   s.executables   = []
   s.require_paths = ["lib"]

data/docs/Author.md

@@ -1,10 +1,21 @@
 # AylienNewsApi::Author
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**avatar_url** | **String** | A URL which points to the author avatar | [optional] 
 **id** | **Integer** | A unique identification for the author | [optional] 
 **name** | **String** | The extracted author full name | [optional] 
-**avatar_url** | **String** | A URL which points to the author avatar | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Author.new(avatar_url: null,
+                                 id: null,
+                                 name: null)
+```
 
 

data/docs/Autocomplete.md

@@ -1,9 +1,19 @@
 # AylienNewsApi::Autocomplete
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | ID of the autocomplete | [optional] 
 **text** | **String** | Text of the autocomplete | [optional] 
 
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Autocomplete.new(id: null,
+                                 text: null)
+```
+
 

data/docs/Autocompletes.md

@@ -1,8 +1,17 @@
 # AylienNewsApi::Autocompletes
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **autocompletes** | [**Array<Autocomplete>**](Autocomplete.md) | An array of autocompletes | [optional] 
 
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Autocompletes.new(autocompletes: null)
+```
+
 

data/docs/Category.md

@@ -1,13 +1,29 @@
 # AylienNewsApi::Category
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**confident** | **Boolean** | It defines whether the extracted category is confident or not | [optional] 
 **id** | **String** | The ID of the category | [optional] 
-**taxonomy** | **String** | The taxonomy of the category | [optional] 
+**label** | **String** | The label of the category | [optional] 
 **level** | **Integer** | The level of the category | [optional] 
+**links** | [**CategoryLinks**](CategoryLinks.md) |  | [optional] 
 **score** | **Float** | The score of the category | [optional] 
-**confident** | **BOOLEAN** | It defines whether the extracted category is confident or not | [optional] 
-**links** | [**CategoryLinks**](CategoryLinks.md) | Related links for the category | [optional] 
+**taxonomy** | [**CategoryTaxonomy**](CategoryTaxonomy.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Category.new(confident: null,
+                                 id: null,
+                                 label: null,
+                                 level: null,
+                                 links: null,
+                                 score: null,
+                                 taxonomy: null)
+```
 
 

data/docs/CategoryLinks.md

@@ -1,9 +1,19 @@
 # AylienNewsApi::CategoryLinks
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**_self** | **String** | A URL pointing to the category | [optional] 
 **parent** | **String** | A URL pointing to the parent category | [optional] 
+**_self** | **String** | A URL pointing to the category | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::CategoryLinks.new(parent: null,
+                                 _self: null)
+```
 
 

data/docs/CategoryTaxonomy.md

@@ -0,0 +1,16 @@
+# AylienNewsApi::CategoryTaxonomy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::CategoryTaxonomy.new()
+```
+
+

data/docs/Cluster.md

@@ -0,0 +1,29 @@
+# AylienNewsApi::Cluster
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**earliest_story** | **DateTime** | Publication date of the earliest story in cluster | [optional] 
+**id** | **Integer** | ID of the cluster which is a unique identification | [optional] 
+**latest_story** | **DateTime** | Publication date of the latest story in cluster | [optional] 
+**location** | [**Location**](Location.md) |  | [optional] 
+**representative_story** | [**RepresentativeStory**](RepresentativeStory.md) |  | [optional] 
+**story_count** | **Integer** | Number of stories associated with the cluster | [optional] 
+**time** | **DateTime** | Time of the event | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Cluster.new(earliest_story: null,
+                                 id: null,
+                                 latest_story: null,
+                                 location: null,
+                                 representative_story: null,
+                                 story_count: null,
+                                 time: null)
+```
+
+

data/docs/Clusters.md

@@ -0,0 +1,21 @@
+# AylienNewsApi::Clusters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cluster_count** | **Integer** | The total number of clusters | [optional] 
+**clusters** | [**Array<Cluster>**](Cluster.md) | An array of clusters | [optional] 
+**next_page_cursor** | **String** | The next page cursor | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Clusters.new(cluster_count: null,
+                                 clusters: null,
+                                 next_page_cursor: null)
+```
+
+

data/docs/Coverages.md

@@ -1,13 +1,25 @@
 # AylienNewsApi::Coverages
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**story_title** | **String** | The input story title | [optional] 
+**coverages** | [**Array<Story>**](Story.md) | An array of coverages for the input story | [optional] 
 **story_body** | **String** | The input story body | [optional] 
-**story_published_at** | **DateTime** | The input story published date | [optional] 
 **story_language** | **String** | The input story language | [optional] 
-**coverages** | [**Array<Story>**](Story.md) | An array of coverages for the input story | [optional] 
-**clusters** | [**Array<StoryCluster>**](StoryCluster.md) | An array of clusters | [optional] 
+**story_published_at** | **DateTime** | The input story published date | [optional] 
+**story_title** | **String** | The input story title | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AylienNewsApi'
+
+instance = AylienNewsApi::Coverages.new(coverages: null,
+                                 story_body: null,
+                                 story_language: null,
+                                 story_published_at: null,
+                                 story_title: null)
+```