twingly-search 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd9953d1e03a6e3b8876f3a4b86580ddcfeeeccf
-  data.tar.gz: 36f8ccb71ca25e1016d00e366652e06dc71b6321
+  metadata.gz: a62fb19132e1def965555e328f84667e5588a4c3
+  data.tar.gz: 9d04745eba432e6d60676c9ff5ce517d20f539fe
 SHA512:
-  metadata.gz: 525c3009c34290b6a86a6a397c9e907d9defbf7089e82e0786274d0c46146d79d4bf9d69cb673120ebd50ea1f10626a13b94d5e113590095f1c557edbc6380ef
-  data.tar.gz: 3df9d3ddd711c7185005a81c93ce3fb4b362a7a526698a2203e475c2e6234054e054269ebb2d45aedb44bc4c31ea88d083598952debd78af2c63f38dcc680edd
+  metadata.gz: 9d2c2e6d94f4748e78bb355d60376afa52abda4249bee1ccd1654c8a5e16995baf7d5b272ce09748c5eead3f777d4d41a3db48c4256b1e0fe93ae9232413a24a
+  data.tar.gz: 6094058ff17173434ee61da5251f47d9777625e6a49a2485b64741925ef192f9120170263f6d79d093b1a4d42752ba75c446529c3805c096282d715e036c7d26

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
+before_install:
+  - gem update bundler
 cache: bundler
 rvm:
   - 1.9.3

data/README.md

@@ -49,7 +49,7 @@ To learn more about the capabilities of the API, please read the [Twingly Search
 
 ## Requirements
 
-* API key, contact sales@twingly.com via [twingly.com](http://www.twingly.com/try-for-free/) to get one
+* API key, contact sales@twingly.com via [twingly.com](https://www.twingly.com/try-for-free/) to get one
 * Ruby
   * Ruby 1.9, 2.0, 2.1, 2.2
   * JRuby 9000

data/lib/twingly/search/parser.rb

@@ -28,7 +28,7 @@ module Twingly
         result.number_of_matches_total    = data_node.attribute('numberOfMatchesTotal').value.to_i
         result.seconds_elapsed            = data_node.attribute('secondsElapsed').value.to_f
 
-        data_node.xpath('//post').each do |post|
+        data_node.xpath('//post[@contentType="blog"]').each do |post|
           result.posts << parse_post(post)
         end
 

data/lib/twingly/search/version.rb

@@ -1,5 +1,5 @@
 module Twingly
   module Search
-    VERSION = "4.0.0"
+    VERSION = "4.0.1"
   end
 end

data/spec/client_spec.rb

@@ -1,44 +1,36 @@
-require 'spec_helper'
+require "spec_helper"
 
 include Twingly::Search
 
 describe Client do
-  subject { Client.new('api_key') }
+  let(:valid_api_key) { "api_key" }
 
   describe ".new" do
-    context 'with API key as arguments' do
-      it { should be_a Client }
-    end
+    context "with API key as argument" do
+      subject { described_class.new(valid_api_key) }
 
-    it "BASE_URL should be parsable" do
-      expect(URI(Client::BASE_URL).to_s).to eq(Client::BASE_URL)
+      it { should be_a Twingly::Search::Client }
     end
 
-    context 'with API key from ENV variable' do
-      before { allow_any_instance_of(Client).to receive(:env_api_key).and_return('api_key') }
-      subject { Client.new }
-      it { should be_a Client }
-    end
+    context "without API key as argument" do
+      before { expect_any_instance_of(described_class).to receive(:env_api_key).and_return(valid_api_key) }
 
-    context 'without valid API key' do
-      before { allow_any_instance_of(Client).to receive(:env_api_key).and_return(nil) }
-      subject { Client.new }
-      it { expect { subject }.to raise_error(AuthError, "No API key has been provided.") }
+      it "should be read from the environment" do
+        described_class.new
+      end
     end
 
-    context "with optional :user_agent given" do
-      let(:user_agent) { "TwinglySearchTest/1.0" }
-      subject { Client.new('api_key', user_agent: user_agent) }
+    context "with no API key at all" do
+      before { expect_any_instance_of(described_class).to receive(:env_api_key).and_return(nil) }
+      subject { described_class.new }
 
-      it "should use that user agent" do
-        expect(subject.user_agent).to eq(user_agent)
-      end
+      it { expect { subject }.to raise_error(AuthError, "No API key has been provided.") }
     end
 
     context "with block" do
       it "should yield self" do
         yielded_client = nil
-        client = Client.new("api_key") do |c|
+        client = described_class.new(valid_api_key) do |c|
           yielded_client = c
         end
 
@@ -46,10 +38,9 @@ describe Client do
       end
 
       context "when api key gets set in block" do
-        before { allow_any_instance_of(Client).to receive(:env_api_key).and_return(nil) }
         let(:api_key) { "api_key_from_block" }
         subject do
-          Client.new do |client|
+          described_class.new do |client|
             client.api_key = api_key
           end
         end
@@ -63,14 +54,23 @@ describe Client do
         end
       end
     end
+
+    context "with optional :user_agent given" do
+      let(:user_agent) { "TwinglySearchTest/1.0" }
+      subject { described_class.new(valid_api_key, user_agent: user_agent) }
+
+      it "should use that user agent" do
+        expect(subject.user_agent).to eq(user_agent)
+      end
+    end
   end
 
-  describe '#query' do
-    subject { Client.new('api_key').query }
+  describe "#query" do
+    subject { described_class.new(valid_api_key).query }
     it { should be_a Query }
 
     context "with block" do
-      subject { Client.new("api_key") }
+      subject { described_class.new(valid_api_key) }
 
       it "should yield the query" do
         yielded_query = nil
@@ -85,7 +85,8 @@ describe Client do
 
   describe "#execute_query" do
     context "with invalid API key" do
-      subject { Client.new("wrong") }
+      let(:invalid_api_key) { "wrong" }
+      subject { described_class.new(invalid_api_key) }
 
       let(:query) do
         query = subject.query
@@ -102,8 +103,8 @@ describe Client do
   end
 
   describe "#endpoint_url" do
-    subject { Client.new("api_key").endpoint_url }
-    let(:expected) { "#{Client::BASE_URL}#{Client::SEARCH_PATH}" }
+    subject { described_class.new(valid_api_key).endpoint_url }
+    let(:expected) { "#{described_class::BASE_URL}#{described_class::SEARCH_PATH}" }
 
     it { is_expected.to eq(expected) }
 

data/spec/error_spec.rb

@@ -15,7 +15,7 @@ describe Twingly::Search::Error do
     context "when given a server error message" do
       let(:server_response_message) { "An error occured." }
 
-      it { is_expected.to be_an(ServerError) }
+      it { is_expected.to be_a(ServerError) }
     end
   end
 

data/spec/fixtures/valid_non_blog_result.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?><twinglydata numberOfMatchesReturned="2" secondsElapsed="0.022" numberOfMatchesTotal="2">
+<post contentType="newspaper">
+  <url>http://www.someurl.com/post</url>
+  <title>Title</title>
+  <summary>Summary</summary>
+  <languageCode>sv</languageCode>
+  <published>2013-01-29 15:26:33Z</published>
+  <indexed>2013-01-29 15:27:07Z</indexed>
+  <blogUrl>http://www.someurl.com/</blogUrl>
+  <blogName>Newspaper Name</blogName>
+  <authority>0</authority>
+  <blogRank>1</blogRank>
+</post>
+<post contentType="blog">
+  <url>http://www.someotherurl.com/post</url>
+  <title>Title</title>
+  <summary>Summary</summary>
+  <languageCode>sv</languageCode>
+  <published>2013-01-29 15:26:33Z</published>
+  <indexed>2013-01-29 15:27:07Z</indexed>
+  <blogUrl>http://www.someotherurl.com/</blogUrl>
+  <blogName>Blog Name</blogName>
+  <authority>0</authority>
+  <blogRank>1</blogRank>
+</post>
+</twinglydata>

data/spec/parser_spec.rb

@@ -6,16 +6,25 @@ describe Parser do
   it { should respond_to(:parse) }
 
   describe "#parse" do
-    subject { Parser.new.parse(document) }
+    subject { described_class.new.parse(document) }
+    let(:document) { Fixture.get(fixture) }
 
     context "with a valid result" do
-      let(:document) { Fixture.get(:valid) }
+      let(:fixture) { :valid }
 
       it { is_expected.to be_a Result }
     end
 
+    context "with a valid result containing non-blogs" do
+      let(:fixture) { :valid_non_blog }
+
+      it "should exclude the non-blog entries" do
+        expect(subject.posts.size).to eq(1)
+      end
+    end
+
     context "with a nonexistent api key result" do
-      let(:document) { Fixture.get(:nonexistent_api_key) }
+      let(:fixture) { :nonexistent_api_key }
 
       it "should raise AuthError" do
         expect { subject }.to raise_error(AuthError)
@@ -23,7 +32,7 @@ describe Parser do
     end
 
     context "with an unauthorized api key result" do
-      let(:document) { Fixture.get(:unauthorized_api_key) }
+      let(:fixture) { :unauthorized_api_key }
 
       it "should raise AuthError" do
         expect { subject }.to raise_error(AuthError)
@@ -31,7 +40,7 @@ describe Parser do
     end
 
     context "with a service unavailable result" do
-      let(:document) { Fixture.get(:service_unavailable) }
+      let(:fixture) { :service_unavailable }
 
       it "should raise ServerError" do
         expect { subject }.to raise_error(ServerError)
@@ -39,7 +48,7 @@ describe Parser do
     end
 
     context "with a undefined error result" do
-      let(:document) { Fixture.get(:undefined_error) }
+      let(:fixture) { :undefined_error }
 
       it "should raise ServerError" do
         expect { subject }.to raise_error(ServerError)
@@ -47,7 +56,7 @@ describe Parser do
     end
 
     context "with a undefined error result" do
-      let(:document) { Fixture.get(:non_xml) }
+      let(:fixture) { :non_xml }
 
       it "should raise ServerError" do
         expect { subject }.to raise_error(ServerError, /503 Service Unavailable/)

data/spec/query_spec.rb

@@ -4,13 +4,13 @@ require 'vcr_setup'
 include Twingly::Search
 
 describe Query do
-  let(:client_double) { double("Client") }
+  let(:client_double) { instance_double("Client") }
 
   before(:each) do
     allow(client_double).to receive(:api_key).and_return("api_key")
   end
 
-  subject { Query.new(client_double) }
+  subject { described_class.new(client_double) }
 
   it { should respond_to(:pattern) }
   it { should respond_to(:language) }
@@ -21,9 +21,9 @@ describe Query do
 
   describe ".new" do
     context "without client" do
-      subject { Query.new }
+      subject { described_class.new }
 
-      it "should not work" do
+      it "raises an error" do
         expect { subject }.to raise_error(ArgumentError)
       end
     end
@@ -31,7 +31,7 @@ describe Query do
     context "with block" do
       it "should yield self" do
         yielded_query = nil
-        query = Query.new(client_double) do |q|
+        query = described_class.new(client_double) do |q|
           yielded_query = q
         end
 
@@ -46,7 +46,7 @@ describe Query do
       allow(client_double).to receive(:endpoint_url).and_return(endpoint_url)
     end
 
-    let(:query) { Query.new(client_double) }
+    let(:query) { described_class.new(client_double) }
 
     context "with valid pattern" do
       before { query.pattern = "christmas" }
@@ -104,15 +104,14 @@ describe Query do
 
   describe "#execute" do
     context "when called" do
-      let(:client) { instance_double("Client", "api_key") }
       subject do
-        query = Query.new(client)
+        query = described_class.new(client_double)
         query.pattern = 'something'
         query
       end
 
       it "should send the query to the client" do
-        expect(client).to receive(:execute_query).with(subject)
+        expect(client_double).to receive(:execute_query).with(subject)
 
         subject.execute
       end
@@ -120,7 +119,7 @@ describe Query do
 
     context "when searching for spotify" do
       subject {
-        query = Query.new(Client.new('api_key'))
+        query = described_class.new(Client.new('api_key'))
         query.pattern = 'spotify page-size:10'
         query.language = 'sv'
         query

data/spec/result_spec.rb

@@ -13,5 +13,6 @@ describe Result do
 
   context "before query has populated responses" do
     its(:posts) { should be_empty }
+    its(:all_results_returned?) { should be_truthy }
   end
 end

data/twingly-search-api-ruby.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.platform      = Gem::Platform::RUBY
   spec.authors       = ["Twingly AB"]
   spec.email         = ["support@twingly.com"]
-  spec.homepage      = "http://github.com/twingly/twingly-search-api-ruby"
+  spec.homepage      = "https://github.com/twingly/twingly-search-api-ruby"
   spec.summary       = "Ruby API client for Twingly Search"
   spec.description   = "Twingly Search is a product from Twingly AB"
   spec.license       = 'MIT'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twingly-search
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Twingly AB
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-02 00:00:00.000000000 Z
+date: 2016-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -174,6 +174,7 @@ files:
 - spec/fixtures/service_unavailable_result.xml
 - spec/fixtures/unauthorized_api_key_result.xml
 - spec/fixtures/undefined_error_result.xml
+- spec/fixtures/valid_non_blog_result.xml
 - spec/fixtures/valid_result.xml
 - spec/fixtures/vcr_cassettes/search_for_spotify_on_sv_blogs.yml
 - spec/fixtures/vcr_cassettes/search_without_valid_api_key.yml
@@ -184,7 +185,7 @@ files:
 - spec/spec_helper.rb
 - spec/vcr_setup.rb
 - twingly-search-api-ruby.gemspec
-homepage: http://github.com/twingly/twingly-search-api-ruby
+homepage: https://github.com/twingly/twingly-search-api-ruby
 licenses:
 - MIT
 metadata: {}
@@ -216,6 +217,7 @@ test_files:
 - spec/fixtures/service_unavailable_result.xml
 - spec/fixtures/unauthorized_api_key_result.xml
 - spec/fixtures/undefined_error_result.xml
+- spec/fixtures/valid_non_blog_result.xml
 - spec/fixtures/valid_result.xml
 - spec/fixtures/vcr_cassettes/search_for_spotify_on_sv_blogs.yml
 - spec/fixtures/vcr_cassettes/search_without_valid_api_key.yml