twingly-search 5.0.1 → 5.1.0

data/spec/fixtures/vcr_cassettes/search_without_valid_api_key.yml

@@ -2,40 +2,41 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.twingly.com/analytics/Analytics.ashx?documentlang&key=wrong&searchpattern=something&ts&tsTo&xmloutputversion=2
+    uri: https://api.twingly.com/blog/search/api/v3/search?apikey=wrong&q=something
     body:
       encoding: US-ASCII
       string: ''
     headers:
       User-Agent:
-      - Twingly Analytics Ruby Client/2.0.1
+      - Twingly Search Ruby Client/5.0.1
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
       - "*/*"
   response:
     status:
-      code: 200
-      message: OK
+      code: 401
+      message: Unauthorized
     headers:
       Server:
       - nginx
       Date:
-      - Tue, 03 Nov 2015 09:29:04 GMT
+      - Thu, 04 May 2017 07:14:00 GMT
       Content-Type:
-      - text/xml; charset=utf-8
+      - application/xml; charset=utf-8
       Content-Length:
-      - '183'
+      - '97'
       Connection:
       - keep-alive
       Cache-Control:
-      - private
-      Set-Cookie:
-      - SERVERID=web01; path=/
+      - no-cache
+      Pragma:
+      - no-cache
+      Expires:
+      - "-1"
     body:
       encoding: UTF-8
-      string: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><blogstream xmlns=\"http://www.twingly.com\">\r\n
-        \ <operationResult resultType=\"failure\">The API key does not exist.</operationResult>\r\n</blogstream>"
-    http_version: 
-  recorded_at: Tue, 03 Nov 2015 09:29:04 GMT
+      string: <?xml version="1.0" encoding="utf-8"?><error code="40101"><message>Unauthorized</message></error>
+    http_version:
+  recorded_at: Thu, 04 May 2017 07:14:00 GMT
 recorded_with: VCR 2.9.3

data/spec/livefeed/client_spec.rb

@@ -0,0 +1,135 @@
+require "spec_helper"
+require "time"
+
+module Twingly::LiveFeed
+  describe Client do
+    let(:valid_api_key) { "api_key" }
+    let(:max_posts)     { 3 }
+
+    subject(:client) do
+      described_class.new do |client|
+        client.max_posts = max_posts
+      end
+    end
+
+    describe ".new" do
+      context "with API key as argument" do
+        subject { described_class.new(valid_api_key) }
+
+        it { should be_a Twingly::LiveFeed::Client }
+      end
+
+      context "without API key as argument" do
+        before do
+          expect_any_instance_of(described_class)
+            .to receive(:env_api_key).and_return(valid_api_key)
+        end
+
+        it "should be read from the environment" do
+          described_class.new
+        end
+      end
+
+      context "with no API key at all" do
+        before do
+          expect_any_instance_of(described_class)
+            .to receive(:env_api_key).and_return(nil)
+        end
+
+        subject { described_class.new }
+
+        it do
+          expect { subject }
+            .to raise_error(AuthError, "No API key has been provided.")
+        end
+      end
+
+      context "with block" do
+        it "should yield self" do
+          yielded_client = nil
+          client = described_class.new(valid_api_key) do |c|
+            yielded_client = c
+          end
+
+          expect(yielded_client).to equal(client)
+        end
+
+        context "when api key gets set in block" do
+          let(:api_key) { "api_key_from_block" }
+          subject do
+            described_class.new do |client|
+              client.api_key = api_key
+            end
+          end
+
+          it "should not raise an AuthError" do
+            expect { subject }.not_to raise_exception
+          end
+
+          it "should use that api key" do
+            expect(subject.api_key).to eq(api_key)
+          end
+        end
+      end
+
+      context "with optional :user_agent given" do
+        let(:user_agent) { "TwinglyLiveFeedTest/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 "#next_result" do
+      before do
+        client.timestamp = timestamp
+      end
+
+      context "with a valid timestamp" do
+        let(:timestamp) { Time.parse("2017-04-19T22:00:00 UTC") }
+
+        subject do
+          VCR.use_cassette("livefeed_valid_request") do
+            client.next_result
+          end
+        end
+
+        it { is_expected.to be_a(Result) }
+
+        it "should update the timestamp" do
+          timestamp_before = client.timestamp
+          subject
+          timestamp_after = client.timestamp
+
+          expect(timestamp_after).to be > timestamp_before
+        end
+      end
+
+      context "with an invalid timestamp" do
+        let(:timestamp) { "not a timestamp" }
+
+        subject { client.next_result }
+
+        it "should raise an error" do
+          expect{ subject }
+            .to raise_error(QueryError, /Not a Time object/)
+        end
+      end
+    end
+
+    describe "#endpoint_url" do
+      subject { described_class.new(valid_api_key).endpoint_url }
+      let(:expected_url) do
+        "#{described_class::BASE_URL}#{described_class::LIVEFEED_PATH}"
+      end
+
+      it { is_expected.to eq(expected_url) }
+
+      it "should be parsable" do
+        expect(URI(subject).to_s).to eq(expected_url)
+      end
+    end
+  end
+end

data/spec/livefeed/error_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+module Twingly::LiveFeed
+  describe Error do
+    it { is_expected.to be_a(StandardError) }
+
+    let(:message) { "This is the error message!" }
+
+    describe ".from_api_response" do
+      subject { described_class.from_api_response(code, message) }
+
+      context "when given code 401" do
+        let(:code) { 401 }
+
+        it { is_expected.to be_a(AuthError) }
+      end
+
+      context "when given code 400" do
+        let(:code) { 400 }
+
+        it { is_expected.to be_a(QueryError) }
+      end
+
+      context "when given code 404" do
+        let(:code) { 404 }
+
+        it { is_expected.to be_a(QueryError) }
+      end
+
+      context "when given another code" do
+        let(:code) { 500 }
+
+        it { is_expected.to be_a(ServerError) }
+      end
+    end
+
+    describe "all error classes" do
+      error_classes = [
+        AuthError,
+        ServerError,
+        QueryError,
+      ]
+
+      error_classes.each do |error_class|
+        describe error_class do
+          it { is_expected.to be_kind_of(Twingly::LiveFeed::Error) }
+        end
+      end
+    end
+  end
+end

data/spec/livefeed/parser_spec.rb

@@ -0,0 +1,351 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require 'time'
+
+module Twingly::LiveFeed
+  describe Parser do
+    it { should respond_to(:parse) }
+
+    describe "#parse" do
+      let(:document)   { Fixture.livefeed_get(fixture) }
+      subject(:result) { described_class.new.parse(document) }
+
+      context "with a valid result" do
+        let(:fixture) { :valid }
+
+        it { is_expected.to be_a Result }
+
+        describe "#ts" do
+          subject { result.ts }
+          it { is_expected.to eq(Time.parse("2017-04-11T15:09:48.8750635Z")) }
+        end
+
+        describe "#from" do
+          subject { result.from }
+          it { is_expected.to eq(Time.parse("2017-04-10T22:00:00Z")) }
+        end
+
+        describe "#first_post" do
+          subject { result.first_post }
+          it { is_expected.to eq(Time.parse("2017-04-10T22:00:29.267Z")) }
+        end
+
+        describe "#last_post" do
+          subject { result.last_post }
+          it { is_expected.to eq(Time.parse("2017-04-10T22:11:47.243Z")) }
+        end
+
+        describe "#number_of_posts" do
+          subject { result.number_of_posts }
+          it { is_expected.to eq(3) }
+        end
+
+        describe "#max_number_of_posts" do
+          subject { result.max_number_of_posts }
+          it { is_expected.to eq(3) }
+        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 "#id" do
+            subject { post.id }
+            it { is_expected.to eq("727444183574244541") }
+          end
+
+          describe "#author" do
+            subject { post.author }
+            it { is_expected.to eq("") }
+          end
+
+          describe "#url" do
+            subject { post.url }
+            it { is_expected.to eq("http://flinnman.blogg.se/2017/april/mandag-igen.html") }
+          end
+
+          describe "#title" do
+            subject { post.title }
+            it { is_expected.to eq("Måndag igen") }
+          end
+
+          describe "#text" do
+            subject { post.text }
+            it { is_expected.to match("Hoppla hejsan bloggy!Måndag.") }
+          end
+
+          describe "#language_code" do
+            subject { post.language_code }
+            it { is_expected.to eq("sv") }
+          end
+
+          describe "#location_code" do
+            subject { post.location_code }
+            it { is_expected.to eq("se") }
+          end
+
+          describe "#coordinates" do
+            subject { post.coordinates }
+            it { is_expected.to eq({}) }
+          end
+
+          describe "#links" do
+            subject { post.links }
+            it { is_expected.to be_empty }
+          end
+
+          describe "#tags" do
+            subject { post.tags }
+            it { is_expected.to eq(%w(Jag)) }
+          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-04-10T22:00:24Z")) }
+          end
+
+          describe "#published_at" do
+            subject { post.published_at }
+            it { is_expected.to eq(Time.parse("2017-04-10T19:11:11Z")) }
+          end
+
+          describe "#reindexed_at" do
+            subject { post.reindexed_at }
+            it { is_expected.to eq(Time.parse("2017-04-10T22:00:24Z")) }
+          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("10357806725947705095") }
+          end
+
+          describe "#blog_name" do
+            subject { post.blog_name }
+            it { is_expected.to eq("Frida L") }
+          end
+
+          describe "#blog_url" do
+            subject { post.blog_url }
+            it { is_expected.to eq("http://flinnman.blogg.se") }
+          end
+
+          describe "#blog_rank" do
+            subject { post.blog_rank }
+            it { is_expected.to eq(1) }
+          end
+
+          describe "#authority" do
+            subject { post.authority }
+            it { is_expected.to eq(2) }
+          end
+        end
+
+        describe "#posts.last" do
+          subject(:post) { result.posts.last }
+
+          describe "#id" do
+            subject { post.id }
+            it { is_expected.to eq("3062976931264108164") }
+          end
+
+          describe "#author" do
+            subject { post.author }
+            it { is_expected.to eq("josegacel") }
+          end
+
+          describe "#url" do
+            subject { post.url }
+            it { is_expected.to eq("https://josegabrielcelis.wordpress.com/2017/04/09/1476/") }
+          end
+
+          describe "#title" do
+            subject { post.title }
+            it { is_expected.to eq("") }
+          end
+
+          describe "#text" do
+            subject { post.text }
+            it { is_expected.to eq("from Instagram: http://ift.tt/2ofZdhV") }
+          end
+
+          describe "#language_code" do
+            subject { post.language_code }
+            it { is_expected.to eq("sv") }
+          end
+
+          describe "#location_code" do
+            subject { post.location_code }
+            it { is_expected.to eq("") }
+          end
+
+          describe "#coordinates" do
+            subject { post.coordinates }
+            it { is_expected.to eq({}) }
+          end
+
+          describe "#links" do
+            subject { post.links }
+            let(:expected) do
+              %w(
+                http://www.ift.tt/2ofZdhV
+                http://feeds.wordpress.com/1.0/gocomments/josegabrielcelis.wordpress.com/1476
+              )
+            end
+
+            it { is_expected.to eq(expected) }
+          end
+
+          describe "#tags" do
+            subject { post.tags }
+            it { is_expected.to eq(%w(Fotos Instagram)) }
+          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-04-10T22:00:28Z")) }
+          end
+
+          describe "#published_at" do
+            subject { post.published_at }
+            it { is_expected.to eq(Time.parse("2017-04-09T22:31:34Z")) }
+          end
+
+          describe "#reindexed_at" do
+            subject { post.reindexed_at }
+            it { is_expected.to eq(Time.parse("2017-04-10T22:00:28Z")) }
+          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("1811310581070495497") }
+          end
+
+          describe "#blog_name" do
+            subject { post.blog_name }
+            it { is_expected.to eq("José Gabriel Celis") }
+          end
+
+          describe "#blog_url" do
+            subject { post.blog_url }
+            it { is_expected.to eq("https://josegabrielcelis.wordpress.com") }
+          end
+
+          describe "#blog_rank" do
+            subject { post.blog_rank }
+            it { is_expected.to eq(1) }
+          end
+
+          describe "#authority" do
+            subject { post.authority }
+            it { is_expected.to eq(0) }
+          end
+        end
+      end
+
+      context "with a valid empty result" do
+        let(:fixture) { :valid_empty }
+
+        describe "#posts" do
+          subject { result.posts }
+          it { is_expected.to be_empty }
+        end
+
+        describe "#number_of_posts" do
+          subject { result.number_of_posts }
+          it { is_expected.to eq(0) }
+        end
+
+        describe "#first_post" do
+          subject { result.first_post }
+          it { is_expected.to eq(nil) }
+        end
+
+        describe "#last_post" do
+          subject { result.last_post }
+          it { is_expected.to eq(nil) }
+        end
+
+        describe "#next_timestamp" do
+          subject { result.next_timestamp }
+          it { is_expected.to eq(Time.parse("2017-04-25T22:00:00Z")) }
+        end
+      end
+
+      context "with an unauthorized api key result" do
+        let(:fixture) { :unauthorized_api_key }
+
+        it "should raise AuthError" do
+          expect { subject }.to raise_error(AuthError)
+        end
+      end
+
+      context "with an empty api key result" do
+        let(:fixture) { :empty_api_key }
+
+        it "should raise AuthError" do
+          expect { subject }.to raise_error(QueryError)
+        end
+      end
+
+      context "with a 404 not found result" do
+        let(:fixture) { :not_found }
+
+        it "should raise QueryError" do
+          expect { subject }.to raise_error(QueryError)
+        end
+      end
+
+      context "with a service unavailable result" do
+        let(:fixture) { :service_unavailable }
+
+        it "should raise ServerError" do
+          expect { subject }.to raise_error(ServerError)
+        end
+      end
+
+      context "with a non XML response" do
+        let(:fixture) { :non_xml }
+        let(:expected_exception_message) do
+          /Failed to parse response: "<html>.*/
+        end
+
+        it "should raise ServerError" do
+          expect { subject }
+            .to raise_error(ServerError, expected_exception_message)
+        end
+      end
+    end
+  end
+end

data/spec/livefeed/post_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module Twingly::LiveFeed
+  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 :text }
+    it { should respond_to :location_code }
+    it { should respond_to :language_code }
+    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 :blog_url }
+    it { should respond_to :blog_rank }
+    it { should respond_to :authority }
+  end
+end

data/spec/livefeed/result_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+module Twingly::LiveFeed
+  describe Result do
+    it { should respond_to :posts }
+    it { should respond_to :ts }
+    it { should respond_to :from }
+    it { should respond_to :number_of_posts }
+    it { should respond_to :max_number_of_posts }
+    it { should respond_to :first_post }
+    it { should respond_to :last_post }
+    it { should respond_to :next_timestamp }
+
+    context "before query has populated responses" do
+      its(:posts) { should be_empty }
+    end
+  end
+end