aylien_news_api 0.2.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 43cf58c6e6a815ab918358b4e04485e23c7c0108
-  data.tar.gz: bc3866443b77211eaa72d638d58a28c88e93b5ca
+SHA256:
+  metadata.gz: 49747d64a222470fc36e5962a1d62838fbffe4be02d1a434a4347ed962546d03
+  data.tar.gz: '02586f0009083761258e5bf44a603ae94f6f6a6303cb85a603f33a927a4818ae'
 SHA512:
-  metadata.gz: c6e8415b22f3af42361240206b3fd15e99657b76eb45ca4075b9141656cfc4bfe642ff8793f947d5ab12bb0431035bc247e475c449778432d4aab9996cb1bf96
-  data.tar.gz: 255e0a58ab1d34bc29fe5ac1ac3f92f2de305a583541f65a09219b62d68a3eee3a8c89bcf4050ed557195a08dec16036e5db4a8858e51288c4537582c2c84099
+  metadata.gz: 1e84be4e7946ae32e0a8285a9b5fc4147b95491e875618e819962dbbb56e3a1401cc20f53e995f3251f42e95c56d777c30659d811784f451468588c8f86ba874
+  data.tar.gz: '0935c028ce823eea885b9891850f9cb3535ecfc8016ac962a921bc1ba72a961636d19ce63d3145ec2ae2935e5ace78555c1db8a1efe5966e2767ec3009e11dbe'

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,30 +1,30 @@
-# AYLIEN News API
-[![Gem Version](https://badge.fury.io/rb/aylien_news_api.svg)](https://badge.fury.io/rb/aylien_news_api)
+# AYLIEN News API - Ruby SDK
 
-The Ruby gem for the 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. 
 
-AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. If you haven't already done so, you will need to [sign up](https://newsapi.aylien.com/signup).
+Sign up at [https://newsapi.aylien.com/](https://newsapi.aylien.com/).
 
-Visit our [interactive documentation](https://newsapi.aylien.com/docs/#swagger-ui-container) to familiarize yourself with the API.
+For more documentation see [https://newsapi.aylien.com/docs/](https://newsapi.aylien.com/docs/).
 
 ## Installation
 
-### RubyGems
-
 Add this to the Gemfile:
 
-    gem 'aylien_news_api'
+    gem 'aylien_news_api', '~> 3.0.0'
 
-or install it directly:
+### Install from Git
 
-	gem install aylien_news_api
+If the Ruby gem is hosted at a git repository: https://github.com/aylien/aylien_newsapi_ruby, then add the following in the Gemfile:
 
-### Git
+    gem 'aylien_news_api', :git => 'https://github.com/aylien/aylien_newsapi_ruby.git'
 
-Add the following in the Gemfile:
+### Include the Ruby code directly
 
-    gem 'aylien_news_api', :git => 'https://github.com/AYLIEN/aylien_newsapi_ruby.git'
+Include the Ruby code directly using `-I` as follows:
 
+```shell
+ruby -Ilib script.rb
+```
 
 ## Getting Started
 
@@ -35,48 +35,46 @@ require 'aylien_news_api'
 
 # Setup authorization
 AylienNewsApi.configure do |config|
-  # Configure API key authorization: app_id
-  config.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'YOUR APP ID'
-  
-  # Configure API key authorization: app_key
-  config.api_key['X-AYLIEN-NewsAPI-Application-Key'] = 'YOUR APP KEY'
+  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 => [
+  title: 'trump',
+  published_at_start: "NOW-7DAYS",
+  published_at_end: "NOW",
+  entities_body_links_dbpedia: [
     'http://dbpedia.org/resource/Donald_Trump',
-    'http://dbpedia.org/resource/Hillary_Rodham_Clinton'
   ],
-  :language => ['en'],
-  :sort_by => 'social_shares_count.facebook'
+  not_language: ['en'],
+  sort_by: 'social_shares_count.facebook'
 }
 
 
 begin
-  #List stories
   result = api_instance.list_stories(opts)
-  puts result
+  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.newsapi.aylien.com/api/v1*
+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_coverages**](docs/DefaultApi.md#list_coverages) | **POST** /coverages | List coverages
+*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) | **POST** /related_stories | List related stories
+*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
@@ -89,6 +87,8 @@ Class | Method | HTTP request | Description
  - [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)
@@ -100,7 +100,10 @@ Class | Method | HTTP request | Description
  - [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)
@@ -111,24 +114,10 @@ Class | Method | HTTP request | Description
  - [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)
-
-
-## Documentation for Authorization
-
-
-### app_id
-
-- **Type**: API key
-- **API key parameter name**: X-AYLIEN-NewsAPI-Application-ID
-- **Location**: HTTP header
-
-### app_key
-
-- **Type**: API key
-- **API key parameter name**: X-AYLIEN-NewsAPI-Application-Key
-- **Location**: HTTP header

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 Ramezanian Nik"]
-  s.email       = ["support@aylien.com", "hamed.r.nik@gmail.com"]
-  s.homepage    = "https://github.com/AYLIEN/aylien_newsapi_ruby"
-  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.authors     = ["AYLIEN"]
+  s.email       = ["info@aylien.com"]
+  s.homepage    = "https://newsapi.aylien.com/"
+  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)
+```
+
+