aylien_news_api 0.1.0 → 0.2.0

data/lib/aylien_news_api/models/trends.rb

@@ -15,6 +15,7 @@
 require 'date'
 
 module AylienNewsApi
+
   class Trends
     # An array of trends
     attr_accessor :trends
@@ -22,6 +23,7 @@ module AylienNewsApi
     # The field of trends
     attr_accessor :field
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -46,18 +48,33 @@ module AylienNewsApi
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes[:'trends']
+      if attributes.has_key?(:'trends')
         if (value = attributes[:'trends']).is_a?(Array)
           self.trends = value
         end
       end
-      if attributes[:'field']
+
+      if attributes.has_key?(:'field')
         self.field = attributes[:'field']
       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 &&
@@ -66,7 +83,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
@@ -165,7 +182,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)
@@ -182,4 +199,5 @@ module AylienNewsApi
     end
 
   end
+
 end

data/lib/aylien_news_api/version.rb

@@ -13,5 +13,5 @@
 # limitations under the License.
 
 module AylienNewsApi
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/api_client_spec.rb

@@ -0,0 +1,306 @@
+# 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.
+
+require 'spec_helper'
+
+describe AylienNewsApi::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          AylienNewsApi.configure { |c| c.host = 'http://example.com' }
+          expect(AylienNewsApi::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          AylienNewsApi.configure { |c| c.host = 'https://wookiee.com' }
+          expect(AylienNewsApi::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          AylienNewsApi.configure { |c| c.host = 'hobo.com/v4' }
+          expect(AylienNewsApi::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          AylienNewsApi.configure { |c| c.base_path = 'v4/dog' }
+          expect(AylienNewsApi::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          AylienNewsApi.configure { |c| c.base_path = '/v4/dog' }
+          expect(AylienNewsApi::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          AylienNewsApi.configure { |c| c.base_path = nil }
+          expect(AylienNewsApi::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe "#update_params_for_auth!" do
+    it "sets header api-key parameter with prefix" do
+      AylienNewsApi.configure do |c|
+        c.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'PREFIX'
+        c.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'special-key'
+      end
+
+      api_client = AylienNewsApi::ApiClient.new
+
+      config2 = AylienNewsApi::Configuration.new do |c|
+        c.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = 'PREFIX2'
+        c.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'special-key2'
+      end
+      api_client2 = AylienNewsApi::ApiClient.new(config2)
+
+      auth_names = ['app_id']
+
+      header_params = {}
+      query_params = {}
+      api_client.update_params_for_auth! header_params, query_params, auth_names
+      expect(header_params).to eq({'X-AYLIEN-NewsAPI-Application-ID' => 'PREFIX special-key'})
+      expect(query_params).to eq({})
+
+      header_params = {}
+      query_params = {}
+      api_client2.update_params_for_auth! header_params, query_params, auth_names
+      expect(header_params).to eq({'X-AYLIEN-NewsAPI-Application-ID' => 'PREFIX2 special-key2'})
+      expect(query_params).to eq({})
+    end
+
+    it "sets header api-key parameter without prefix" do
+      AylienNewsApi.configure do |c|
+        c.api_key_prefix['X-AYLIEN-NewsAPI-Application-ID'] = nil
+        c.api_key['X-AYLIEN-NewsAPI-Application-ID'] = 'special-key'
+      end
+
+      api_client = AylienNewsApi::ApiClient.new
+
+      header_params = {}
+      query_params = {}
+      auth_names = ['app_id']
+      api_client.update_params_for_auth! header_params, query_params, auth_names
+      expect(header_params).to eq({'X-AYLIEN-NewsAPI-Application-ID' => 'special-key'})
+      expect(query_params).to eq({})
+    end
+  end
+
+  describe "params_encoding in #build_request" do
+    let(:config) { AylienNewsApi::Configuration.new }
+    let(:api_client) { AylienNewsApi::ApiClient.new(config) }
+
+    it "defaults to multi" do
+      expect(AylienNewsApi::Configuration.default.params_encoding).to eq(:multi)
+      expect(config.params_encoding).to eq(:multi)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(:multi)
+    end
+
+    it "can be customized" do
+      config.params_encoding = nil
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(nil)
+    end
+  end
+
+  describe "timeout in #build_request" do
+    let(:config) { AylienNewsApi::Configuration.new }
+    let(:api_client) { AylienNewsApi::ApiClient.new(config) }
+
+    it "defaults to 0" do
+      expect(AylienNewsApi::Configuration.default.timeout).to eq(0)
+      expect(config.timeout).to eq(0)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(0)
+    end
+
+    it "can be customized" do
+      config.timeout = 100
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(100)
+    end
+  end
+
+  describe "#deserialize" do
+    it "handles Array<Integer>" do
+      api_client = AylienNewsApi::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '[12, 34]')
+      data = api_client.deserialize(response, 'Array<Integer>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([12, 34])
+    end
+
+    it "handles Array<Array<Integer>>" do
+      api_client = AylienNewsApi::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '[[12, 34], [56]]')
+      data = api_client.deserialize(response, 'Array<Array<Integer>>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([[12, 34], [56]])
+    end
+
+    it "handles Hash<String, String>" do
+      api_client = AylienNewsApi::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '{"message": "Hello"}')
+      data = api_client.deserialize(response, 'Hash<String, String>')
+      expect(data).to be_instance_of(Hash)
+      expect(data).to eq({:message => 'Hello'})
+    end
+
+    it "handles Hash<String, Story>" do
+      api_client = AylienNewsApi::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '{"story": {"id": 1}}')
+      data = api_client.deserialize(response, 'Hash<String, Story>')
+      expect(data).to be_instance_of(Hash)
+      expect(data.keys).to eq([:story])
+
+      story = data[:story]
+      expect(story).to be_instance_of(AylienNewsApi::Story)
+      expect(story.id).to eq(1)
+    end
+
+    it "handles Hash<String, Hash<String, Story>>" do
+      api_client = AylienNewsApi::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '{"data": {"story": {"id": 1}}}')
+      result = api_client.deserialize(response, 'Hash<String, Hash<String, Story>>')
+      expect(result).to be_instance_of(Hash)
+      expect(result.keys).to match_array([:data])
+
+      data = result[:data]
+      expect(data).to be_instance_of(Hash)
+      expect(data.keys).to match_array([:story])
+
+      story = data[:story]
+      expect(story).to be_instance_of(AylienNewsApi::Story)
+      expect(story.id).to eq(1)
+    end
+  end
+
+  describe "#object_to_hash" do
+    it "ignores nils and includes empty arrays" do
+      api_client = AylienNewsApi::ApiClient.new
+      story = AylienNewsApi::Story.new
+      story.id = 1
+      story.title = ''
+      story.published_at = nil
+      story.body = nil
+      story.hashtags = []
+      expected = {id: 1, title: '', hashtags: []}
+      expect(api_client.object_to_hash(story)).to eq(expected)
+    end
+  end
+
+  describe "#build_collection_param" do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { AylienNewsApi::ApiClient.new }
+
+    it "works for csv" do
+      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+    end
+
+    it "works for ssv" do
+      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    end
+
+    it "works for tsv" do
+      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    end
+
+    it "works for pipes" do
+      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    end
+
+    it "works for multi" do
+      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+    end
+
+    it "fails for invalid collection format" do
+      expect(proc { api_client.build_collection_param(param, :INVALID) }).to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe "#json_mime?" do
+    let(:api_client) { AylienNewsApi::ApiClient.new }
+
+    it "works" do
+      expect(api_client.json_mime?(nil)).to eq false
+      expect(api_client.json_mime?('')).to eq false
+
+      expect(api_client.json_mime?('application/json')).to eq true
+      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
+      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+
+      expect(api_client.json_mime?('application/xml')).to eq false
+      expect(api_client.json_mime?('text/plain')).to eq false
+      expect(api_client.json_mime?('application/jsonp')).to eq false
+    end
+  end
+
+  describe "#select_header_accept" do
+    let(:api_client) { AylienNewsApi::ApiClient.new }
+
+    it "works" do
+      expect(api_client.select_header_accept(nil)).to be_nil
+      expect(api_client.select_header_accept([])).to be_nil
+
+      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+
+      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+    end
+  end
+
+  describe "#select_header_content_type" do
+    let(:api_client) { AylienNewsApi::ApiClient.new }
+
+    it "works" do
+      expect(api_client.select_header_content_type(nil)).to eq('application/json')
+      expect(api_client.select_header_content_type([])).to eq('application/json')
+
+      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
+    end
+  end
+
+  describe "#sanitize_filename" do
+    let(:api_client) { AylienNewsApi::ApiClient.new }
+
+    it "works" do
+      expect(api_client.sanitize_filename('sun')).to eq('sun')
+      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,39 @@
+# 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.
+
+require 'spec_helper'
+
+describe AylienNewsApi::Configuration do
+  let(:config) { AylienNewsApi::Configuration.default }
+
+  before(:each) do
+    AylienNewsApi.configure do |c|
+      c.host = 'api.newsapi.aylien.com'
+      c.base_path = 'v1'
+    end
+  end
+
+  describe '#base_url' do
+    it 'should have the default value' do
+      expect(config.base_url).to eq('https://api.newsapi.aylien.com/v1')
+    end
+
+    it 'should remove trailing slashes' do
+      [nil, '', '/', '//'].each do |base_path|
+        config.base_path = base_path
+        expect(config.base_url).to eq('https://api.newsapi.aylien.com')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,113 @@
+# 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.
+
+# load the gem
+require 'aylien_news_api'
+
+# The following  was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end