twingly-search 5.0.1 → 5.1.0

data/spec/parser_spec.rb

@@ -14,55 +14,137 @@ describe Parser do
     subject        { result }
 
     context "with a valid result" do
-      let(:fixture) { :valid }
+      let(:fixture) { :minimal_valid }
 
       it { is_expected.to be_a Result }
-    end
 
-    context "with a minimal valid result" do
-      let(:fixture) { :minimal_valid }
+      describe "#number_of_matches_returned" do
+        subject { result.number_of_matches_returned }
+        it { is_expected.to eq(3) }
+      end
+
+      describe "#number_of_matches_total" do
+        subject { result.number_of_matches_total }
+        it { is_expected.to eq(3122050) }
+      end
+
+      describe "#seconds_elapsed" do
+        subject { result.seconds_elapsed }
+        it { is_expected.to eq(0.369) }
+      end
+
+      describe "#posts" do
+        subject { result.posts }
+
+        it { is_expected.to all(be_a(Post)) }
+
+        describe "#count" do
+          subject { result.posts.count }
+
+          it { is_expected.to eq(3) }
+        end
+      end
+
+      describe "#posts.first" do
+        subject(:post) { result.posts.first }
 
-      describe "#posts[0]" do
-        subject(:post) { result.posts[0] }
+        describe "#id" do
+          subject { post.id }
+          it { is_expected.to eq("16405819479794412880") }
+        end
+
+        describe "#author" do
+          subject { post.author }
+          it { is_expected.to eq("klivinihemligheten") }
+        end
 
         describe "#url" do
           subject { post.url }
-          it { is_expected.to eq("http://oppogner.blogg.no/1409602010_bare_m_ha.html") }
+          it { is_expected.to eq("http://nouw.com/klivinihemligheten/planering---men-dalig-30016048") }
         end
 
         describe "#title" do
           subject { post.title }
-          it { is_expected.to eq("Bare MÅ ha!") }
+          it { is_expected.to eq("Planering - men dålig") }
         end
 
-        describe "#summary" do
-          subject { post.summary }
-          it { is_expected.to eq("Ja, velkommen til høsten ...") }
+        describe "#text" do
+          subject { post.text }
+          it { is_expected.to start_with("Det vart en förmiddag på boxen med en brud som jag ") }
         end
 
         describe "#language_code" do
           subject { post.language_code }
-          it { is_expected.to eq("no") }
+          it { is_expected.to eq("sv") }
         end
 
-        describe "#published" do
-          subject { post.published }
-          it { is_expected.to eq(Time.parse("2014-09-02 06:53:26Z")) }
+        describe "#location_code" do
+          subject { post.location_code }
+          it { is_expected.to eq("se") }
         end
 
-        describe "#indexed" do
-          subject { post.indexed }
-          it { is_expected.to eq(Time.parse("2014-09-02 09:00:53Z")) }
+        describe "#coordinates" do
+          subject { post.coordinates }
+          it { is_expected.to eq({}) }
         end
 
-        describe "#blog_url" do
-          subject { post.blog_url }
-          it { is_expected.to eq("http://oppogner.blogg.no/") }
+        describe "#links" do
+          subject { post.links }
+          it { is_expected.to be_empty }
         end
 
-        describe "#authority" do
-          subject { post.authority }
-          it { is_expected.to eq(1) }
+        describe "#tags" do
+          subject { post.tags }
+          let(:expected_tags) do
+            [
+              "Ätas & drickas",
+              "Universitet & studentlivet",
+              "Träning",
+              "To to list",
+            ]
+          end
+
+          it { is_expected.to eq(expected_tags) }
+        end
+
+        describe "#images" do
+          subject { post.images }
+          it { is_expected.to be_empty }
+        end
+
+        describe "#indexed_at" do
+          subject { post.indexed_at }
+          it { is_expected.to eq(Time.parse("2017-05-04T06:51:23Z")) }
+        end
+
+        describe "#published_at" do
+          subject { post.published_at }
+          it { is_expected.to eq(Time.parse("2017-05-04T06:50:59Z")) }
+        end
+
+        describe "#reindexed_at" do
+          subject { post.reindexed_at }
+          it { is_expected.to eq(Time.parse("2017-05-04T08:51:23Z")) }
+        end
+
+        describe "#inlinks_count" do
+          subject { post.inlinks_count }
+          it { is_expected.to eq(0) }
+        end
+
+        describe "#blog_id" do
+          subject { post.blog_id }
+          it { is_expected.to eq("5312283800049632348") }
+        end
+
+        describe "#blog_name" do
+          subject { post.blog_name }
+          it { is_expected.to eq("Love life like a student") }
+        end
+
+        describe "#blog_url" do
+          subject { post.blog_url }
+          it { is_expected.to eq("http://nouw.com/klivinihemligheten") }
         end
 
         describe "#blog_rank" do
@@ -70,33 +152,38 @@ describe Parser do
           it { is_expected.to eq(1) }
         end
 
-        describe "#tags" do
-          subject { post.tags }
-          it { is_expected.to eq(["Blogg"]) }
+        describe "#authority" do
+          subject { post.authority }
+          it { is_expected.to eq(0) }
         end
       end
 
-      describe "#posts[1]" do
-        subject(:post) { result.posts[1] }
+      describe "#posts.last" do
+        subject(:post) { result.posts.last }
+
+        describe "#id" do
+          subject { post.id }
+          it { is_expected.to eq("2770252465384762934") }
+        end
+
+        describe "#author" do
+          subject { post.author }
+          it { is_expected.to eq("maartiinasvardag") }
+        end
 
         describe "#url" do
           subject { post.url }
-          it { is_expected.to eq("http://www.skvallernytt.se/hardtraning-da-galler-swedish-house-mafia") }
+          it { is_expected.to eq("http://nouw.com/maartiinasvardag/god-formiddag-30016041") }
         end
 
         describe "#title" do
           subject { post.title }
-          it { is_expected.to eq("Hårdträning – då gäller Swedish House Mafia") }
+          it { is_expected.to eq("God förmiddag! ☀️") }
         end
 
-        describe "#summary" do
-          subject { post.summary }
-          it { is_expected.to eq("Träning. Och Swedish House Mafia. Det verkar vara ett lyckat koncept. \"Don't you worry child\" och \"Greyhound\" är nämligen de två mest spelade träningslåtarna under januari 2013 på Spotify.
-
-Relaterade inlägg:
-Swedish House Mafia – ny låt!
-Ny knivattack på Swedish House Mafia-konsert
-Swedish House Mafia gör succé i USA") }
+        describe "#text" do
+          subject { post.text }
+          it { is_expected.to start_with("Hmm.... Vad ska man börja ??  Jag vet inte riktigt vad min gnista ") }
         end
 
         describe "#language_code" do
@@ -104,78 +191,64 @@ Swedish House Mafia gör succé i USA") }
           it { is_expected.to eq("sv") }
         end
 
-        describe "#published" do
-          subject { post.published }
-          it { is_expected.to eq(Time.parse("2013-01-29 15:21:56Z")) }
-        end
-
-        describe "#indexed" do
-          subject { post.indexed }
-          it { is_expected.to eq(Time.parse("2013-01-29 15:22:52Z")) }
-        end
-
-        describe "#blog_url" do
-          subject { post.blog_url }
-          it { is_expected.to eq("http://www.skvallernytt.se/") }
+        describe "#location_code" do
+          subject { post.location_code }
+          it { is_expected.to eq("se") }
         end
 
-        describe "#authority" do
-          subject { post.authority }
-          it { is_expected.to eq(38) }
+        describe "#coordinates" do
+          subject { post.coordinates }
+          it { is_expected.to eq({}) }
         end
 
-        describe "#blog_rank" do
-          subject { post.blog_rank }
-          it { is_expected.to eq(4) }
+        describe "#links" do
+          subject { post.links }
+          it { is_expected.to be_empty }
         end
 
         describe "#tags" do
           subject { post.tags }
-          it { is_expected.to eq(["Okategoriserat", "Träning", "greyhound", "koncept", "mafia"]) }
+          it { is_expected.to be_empty }
         end
-      end
 
-      describe "#posts[2]" do
-        subject(:post) { result.posts[2] }
+        describe "#images" do
+          subject { post.images }
+          it { is_expected.to be_empty }
+        end
 
-        describe "#url" do
-          subject { post.url }
-          it { is_expected.to eq("http://didriksinspesielleverden.blogg.no/1359472349_justin_bieber.html") }
+        describe "#indexed_at" do
+          subject { post.indexed_at }
+          it { is_expected.to eq(Time.parse("2017-05-04T06:50:07Z")) }
         end
 
-        describe "#title" do
-          subject { post.title }
-          it { is_expected.to eq("Justin Bieber") }
+        describe "#published_at" do
+          subject { post.published_at }
+          it { is_expected.to eq(Time.parse("2017-05-04T06:49:50Z")) }
         end
 
-        describe "#summary" do
-          subject { post.summary }
-          it { is_expected.to eq("OMG! Justin Bieber Believe acoustic albumet er nå ute på spotify. Han er helt super. Love him. Personlig liker jeg best beauty and a beat og as long as you love me, kommenter gjerne hva dere synes! <3 #sus YOLO") }
+        describe "#reindexed_at" do
+          subject { post.reindexed_at }
+          it { is_expected.to eq(Time.parse("0001-01-01T00:00:00Z")) }
         end
 
-        describe "#language_code" do
-          subject { post.language_code }
-          it { is_expected.to eq("no") }
+        describe "#inlinks_count" do
+          subject { post.inlinks_count }
+          it { is_expected.to eq(0) }
         end
 
-        describe "#published" do
-          subject { post.published }
-          it { is_expected.to eq(Time.parse("2013-01-29 15:12:29Z")) }
+        describe "#blog_id" do
+          subject { post.blog_id }
+          it { is_expected.to eq("1578135310841173675") }
         end
 
-        describe "#indexed" do
-          subject { post.indexed }
-          it { is_expected.to eq(Time.parse("2013-01-29 15:14:37Z")) }
+        describe "#blog_name" do
+          subject { post.blog_name }
+          it { is_expected.to eq("maartiinasvardag blogg") }
         end
 
         describe "#blog_url" do
           subject { post.blog_url }
-          it { is_expected.to eq("http://didriksinspesielleverden.blogg.no/") }
-        end
-
-        describe "#authority" do
-          subject { post.authority }
-          it { is_expected.to eq(0) }
+          it { is_expected.to eq("http://nouw.com/maartiinasvardag") }
         end
 
         describe "#blog_rank" do
@@ -183,18 +256,30 @@ Swedish House Mafia gör succé i USA") }
           it { is_expected.to eq(1) }
         end
 
-        describe "#tags" do
-          subject { post.tags }
-          it { is_expected.to eq([]) }
+        describe "#authority" do
+          subject { post.authority }
+          it { is_expected.to eq(0) }
         end
       end
     end
 
-    context "with a valid result containing non-blogs" do
-      let(:fixture) { :valid_non_blog }
+    context "with a valid result containing links" do
+      let(:fixture) { :valid_links }
+
+      describe "#posts.first" do
+        subject(:post) { result.posts.first }
+        let(:expected_links) do
+          %w[
+            https://1.bp.blogspot.com/-4uNjjiNQiug/WKguo1sBxwI/AAAAAAAAqKE/_eR7cY8Ft3cd2fYCx-2yXK8AwSHE_A2GgCLcB/s1600/aaea427ee3eaaf8f47d650f48fdf1242.jpg
+            http://www.irsn.fr/EN/newsroom/News/Pages/20170213_Detection-of-radioactive-iodine-at-trace-levels-in-Europe-in-January-2017.aspx
+            https://www.t.co/2P4IDmovzH
+            https://www.twitter.com/Strat2Intel/status/832710701730844672
+          ]
+        end
 
-      it "should exclude the non-blog entries" do
-        expect(subject.posts.size).to eq(1)
+        describe "#links" do
+          its(:links) { should eq(expected_links) }
+        end
       end
     end
 
@@ -208,11 +293,23 @@ Swedish House Mafia gör succé i USA") }
       end
     end
 
+    context "with an complete result" do
+      let(:fixture) { :valid_empty }
+
+      it { is_expected.not_to be_incomplete }
+    end
+
+    context "with an incomplete result" do
+      let(:fixture) { :incomplete }
+
+      it { is_expected.to be_incomplete }
+    end
+
     context "with a nonexistent api key result" do
       let(:fixture) { :nonexistent_api_key }
 
       it "should raise AuthError" do
-        expect { subject }.to raise_error(AuthError)
+        expect { subject }.to raise_error(QueryError)
       end
     end
 

data/spec/post_spec.rb

@@ -3,15 +3,34 @@ require 'spec_helper'
 include Twingly::Search
 
 describe Post do
+  it { should respond_to :id }
+  it { should respond_to :author }
   it { should respond_to :url }
   it { should respond_to :title }
-  it { should respond_to :summary }
+  it { should respond_to :text }
+  it { should respond_to :location_code }
   it { should respond_to :language_code }
-  it { should respond_to :indexed }
-  it { should respond_to :published }
-  it { should respond_to :blog_url }
+  it { should respond_to :coordinates }
+  it { should respond_to :links }
+  it { should respond_to :tags }
+  it { should respond_to :images }
+  it { should respond_to :indexed_at }
+  it { should respond_to :published_at }
+  it { should respond_to :reindexed_at }
+  it { should respond_to :inlinks_count }
+  it { should respond_to :blog_id }
   it { should respond_to :blog_name }
-  it { should respond_to :authority }
+  it { should respond_to :blog_url }
   it { should respond_to :blog_rank }
-  it { should respond_to :tags }
+  it { should respond_to :authority }
+
+  deprecated_methods = %i(summary indexed published outlinks)
+  deprecated_methods.each do |method_name|
+    describe "##{method_name}" do
+      it do
+        expect { subject.public_send(method_name) }
+          .to output(/deprecated/).to_stderr
+      end
+    end
+  end
 end

data/spec/query_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'vcr_setup'
 
 include Twingly::Search
 
@@ -10,15 +9,30 @@ describe Query do
     allow(client_double).to receive(:api_key).and_return("api_key")
   end
 
-  subject { described_class.new(client_double) }
+  subject(:query) { described_class.new(client_double) }
 
-  it { should respond_to(:pattern) }
+  it { should respond_to(:search_query) }
   it { should respond_to(:language) }
   it { should respond_to(:start_time) }
   it { should respond_to(:end_time) }
   it { should respond_to(:execute) }
   it { should respond_to(:client) }
 
+  describe "#pattern" do
+    it { expect { subject.pattern }.to output(/deprecated/).to_stderr }
+    it { expect { subject.pattern = "test" }.to output(/deprecated/).to_stderr }
+  end
+
+  describe "#language" do
+    it { expect { subject.language }.to output(/deprecated/).to_stderr }
+    it { expect { subject.language = "en" }.to output(/deprecated/).to_stderr }
+
+    it "should be included in the search query" do
+      subject.language = "no"
+      expect(subject.request_parameters.fetch(:q)).to include("lang:no")
+    end
+  end
+
   describe ".new" do
     context "without client" do
       subject { described_class.new }
@@ -42,49 +56,42 @@ describe Query do
 
   describe "#url" do
     before do
-      endpoint_url = "https://api.twingly.com/analytics/Analytics.ashx"
+      endpoint_url = "https://api.twingly.com/blog/search/api/v3/search"
       allow(client_double).to receive(:endpoint_url).and_return(endpoint_url)
     end
 
     let(:query) { described_class.new(client_double) }
 
-    context "with valid pattern" do
-      before { query.pattern = "christmas" }
-      subject { query.url }
-
-      it { should include("xmloutputversion=2") }
-    end
-
-    context "without valid pattern" do
+    context "without valid search query" do
       it "raises an error" do
-        expect { query.url }.to raise_error(QueryError, "Missing pattern")
+        expect { query.url }.to raise_error(QueryError, /query cannot be empty/)
       end
     end
 
-    context "with empty pattern" do
-      before { query.pattern = "" }
+    context "with empty search query" do
+      before { query.search_query = "" }
 
       it "raises an error" do
-        expect { query.url }.to raise_error(QueryError, "Missing pattern")
+        expect { query.url }.to raise_error(QueryError, /query cannot be empty/)
       end
     end
   end
 
   describe "#start_time=" do
     before do
-      subject.pattern = "semla"
+      query.search_query = "semla"
     end
 
     context "when given time in UTC" do
       before do
-        subject.start_time = time
+        query.start_time = time
       end
 
       let(:timestamp) { "2016-02-09 09:01:22 UTC" }
       let(:time) { Time.parse(timestamp) }
 
       it "should not change timezone" do
-        expect(subject.request_parameters).to include(ts: "2016-02-09 09:01:22")
+        expect(subject.request_parameters.fetch(:q)).to include("2016-02-09T09:01:22")
       end
 
       it "should not modify the given time object" do
@@ -110,7 +117,7 @@ describe Query do
       let(:time) { Time.parse(timestamp) }
 
       it "should convert to UTC" do
-        expect(subject.request_parameters).to include(ts: "2016-02-09 04:01:22")
+        expect(subject.request_parameters.fetch(:q)).to include("2016-02-09T04:01:22")
       end
 
       it "should not modify the given time object" do
@@ -139,7 +146,7 @@ describe Query do
 
   describe "#end_time=" do
     before do
-      subject.pattern  = "semla"
+      subject.search_query  = "semla"
     end
 
     context "when given time in UTC" do
@@ -151,7 +158,7 @@ describe Query do
       let(:time) { Time.parse(timestamp) }
 
       it "should not change timezone" do
-        expect(subject.request_parameters).to include(tsTo: "2016-02-09 09:01:22")
+        expect(subject.request_parameters.fetch(:q)).to include("end-date:2016-02-09T09:01:22")
       end
 
       it "should not modify the given time object" do
@@ -177,7 +184,7 @@ describe Query do
       let(:time) { Time.parse(timestamp) }
 
       it "should convert to UTC" do
-        expect(subject.request_parameters).to include(tsTo: "2016-02-09 04:01:22")
+        expect(subject.request_parameters.fetch(:q)).to include("end-date:2016-02-09T04:01:22")
       end
 
       it "should not modify the given time object" do
@@ -204,25 +211,25 @@ describe Query do
     end
   end
 
-  context "with valid pattern" do
-    before { subject.pattern = "christmas" }
+  context "with valid search query" do
+    before { subject.search_query = "christmas" }
 
     it "should add language" do
       subject.language = "en"
-      expect(subject.request_parameters).to include(documentlang: 'en')
+      expect(subject.request_parameters.fetch(:q)).to include("lang:en")
     end
 
     it "should encode url paramters" do
       subject.end_time = Time.parse("2013-12-28 09:01:22 UTC")
-      expect(subject.url_parameters).to include('tsTo=2013-12-28+09%3A01%3A22')
+      expect(subject.url_parameters).to include('end-date%3A2013-12-28T09%3A01%3A22')
     end
   end
 
-  describe "#pattern" do
-    before { subject.pattern = "spotify" }
+  describe "#search_query" do
+    before { subject.search_query = "spotify" }
 
-    it "should add searchpattern" do
-      expect(subject.url_parameters).to include("searchpattern=spotify")
+    it "should add q parameter" do
+      expect(subject.url_parameters).to include("q=spotify")
     end
   end
 
@@ -230,7 +237,7 @@ describe Query do
     context "when called" do
       subject do
         query = described_class.new(client_double)
-        query.pattern = 'something'
+        query.search_query = 'something'
         query
       end
 
@@ -243,8 +250,8 @@ describe Query do
 
     context "when searching for spotify" do
       subject {
-        query = described_class.new(Client.new('api_key'))
-        query.pattern = 'spotify page-size:10'
+        query = described_class.new(Client.new)
+        query.search_query = 'spotify page-size:10'
         query.language = 'sv'
         query
       }

data/spec/result_spec.rb

@@ -10,6 +10,7 @@ describe Result do
   it { should respond_to :number_of_matches_total }
   it { should respond_to :seconds_elapsed }
   it { should respond_to :all_results_returned? }
+  it { should respond_to :incomplete? }
 
   context "before query has populated responses" do
     its(:posts) { should be_empty }

data/spec/spec_helper.rb

@@ -1,8 +1,18 @@
 require File.dirname(__FILE__) + '/../lib/twingly/search'
+require File.dirname(__FILE__) + '/../lib/twingly/livefeed'
+
+require 'vcr_setup'
+require 'rspec/its'
+
+ENV["TWINGLY_SEARCH_KEY"] ||= "api_key"
 
 class Fixture
   def self.get(fixture_name)
     filename = "spec/fixtures/#{fixture_name}_result.xml"
     File.read(filename)
   end
+
+  def self.livefeed_get(fixture_name)
+    get("livefeed/#{fixture_name}")
+  end
 end

data/twingly-search-api-ruby.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Ruby API client for Twingly Search"
   spec.description   = "Twingly Search is a product from Twingly AB"
   spec.license       = 'MIT'
-  spec.required_ruby_version = ">= 1.9.3"
+  spec.required_ruby_version = ">= 2.1.0"
 
   spec.files         = `git ls-files`.split($/)
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
@@ -25,7 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-its", "~> 1"
   spec.add_development_dependency "vcr", "~> 2.6"
   spec.add_development_dependency "webmock", "~> 1.0"
-  spec.add_development_dependency "rake", "~> 0"
-  spec.add_development_dependency "github_changelog_generator", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 11"
   spec.add_development_dependency "yard", "~> 0.8"
 end