twingly-search 4.0.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a62fb19132e1def965555e328f84667e5588a4c3
-  data.tar.gz: 9d04745eba432e6d60676c9ff5ce517d20f539fe
+  metadata.gz: b5fa690bb24c2c41b7f1c1141a636970c76b9057
+  data.tar.gz: 40ba48f85e4f1d255c0fb64b69aabac2b1e347c7
 SHA512:
-  metadata.gz: 9d2c2e6d94f4748e78bb355d60376afa52abda4249bee1ccd1654c8a5e16995baf7d5b272ce09748c5eead3f777d4d41a3db48c4256b1e0fe93ae9232413a24a
-  data.tar.gz: 6094058ff17173434ee61da5251f47d9777625e6a49a2485b64741925ef192f9120170263f6d79d093b1a4d42752ba75c446529c3805c096282d715e036c7d26
+  metadata.gz: 43941210a16c5377a5858d1bc296145d92f23162168043b7a932bb9a60590ea938b267b2ba1d0ec8e21effe9735ec09a939c43a99e3d49e75d61ee57156407d8
+  data.tar.gz: a82b2cb9a89a6539093a4f8e72b8ee79c0afc8c11d61f3ee60f26a12fd312619e49ec08c08df4516769b207d090dd0d316779dd36fa1914f9643320516c105dc

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+sudo: false
 before_install:
   - gem update bundler
 cache: bundler
@@ -7,6 +8,7 @@ rvm:
   - 2.0.0
   - 2.1
   - 2.2
+  - 2.3.0
   - jruby-9.0.0.0
 deploy:
   provider: rubygems

data/CHANGELOG.md

@@ -1,7 +1,14 @@
 # Change Log
 
-## [v4.0.0](https://github.com/twingly/twingly-search-api-ruby/tree/v4.0.0)
+## [v4.0.1](https://github.com/twingly/twingly-search-api-ruby/tree/v4.0.1) (2016-01-28)
+[Full Changelog](https://github.com/twingly/twingly-search-api-ruby/compare/v4.0.0...v4.0.1)
 
+**Merged pull requests:**
+
+- Improve tests [\#38](https://github.com/twingly/twingly-search-api-ruby/pull/38) ([roback](https://github.com/roback))
+- Take contenttype into account [\#37](https://github.com/twingly/twingly-search-api-ruby/pull/37) ([walro](https://github.com/walro))
+
+## [v4.0.0](https://github.com/twingly/twingly-search-api-ruby/tree/v4.0.0) (2015-12-02)
 [Full Changelog](https://github.com/twingly/twingly-search-api-ruby/compare/v3.0.0...v4.0.0)
 
 **Implemented enhancements:**
@@ -99,4 +106,4 @@
 
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -51,17 +51,18 @@ To learn more about the capabilities of the API, please read the [Twingly Search
 
 * 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
+  * Ruby 1.9, 2.0, 2.1, 2.2, 2.3
   * JRuby 9000
 
 ## Development and release
 
-1. Make sure the master branch has an up-to-date changelog. Generate with `rake changelog`. Set `CHANGELOG_GITHUB_TOKEN` to a personal access token to increase the API rate limit. (The changelog uses [GitHub Changelog Generator](https://github.com/skywinder/github-changelog-generator/))
-1. Bump version in `lib/twingly/search/version.rb`, follow [Semantic Versioning 2.0.0](http://semver.org/)
-1. Build and release gem with `bundle exec rake release`. This will create a git tag for the version and push the `.gem` file to https://rubygems.org/.
-1. Update release information on the [releases page].
+1. Bump the version in `lib/twingly/search/version.rb`, follow [Semantic Versioning 2.0.0](http://semver.org/). No need to push as this will be taken care of automatically in the next step.
+1. Build and the release gem with `bundle exec rake release`. This will create a git tag for the version and push the `.gem` file to [RubyGems.org].
+1. Generate a changelog with `bundle exec rake changelog`. Set `CHANGELOG_GITHUB_TOKEN` to a personal access token to increase the API rate limit. (The changelog uses [GitHub Changelog Generator](https://github.com/skywinder/github-changelog-generator/))
+1. Update release information on the [releases page]. This is done manually.
 
 [releases page]: https://github.com/twingly/twingly-search-api-ruby/releases
+[RubyGems.org]: https://rubygems.org/
 
 ### Documentation
 
@@ -77,7 +78,7 @@ The YARD server reloads the documentation automatically so there is no need to r
 
 The MIT License (MIT)
 
-Copyright (c) 2013 Twingly AB
+Copyright (c) 2013-2016 Twingly AB
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/lib/twingly/search/client.rb

@@ -14,7 +14,7 @@ module Twingly
       # Creates a new Twingly Search API client
       #
       # @param api_key [optional, String] the API key provided by Twingly.
-      #   If nil, reads api_key from environment (TWINGLY_SEARCH_KEY).
+      #   If nil, reads key from environment (TWINGLY_SEARCH_KEY).
       # @param options [Hash]
       # @option options [String] :user_agent the user agent to be used
       #    for all requests

data/lib/twingly/search/post.rb

@@ -11,8 +11,8 @@ module Twingly
     # @attr_reader [String] summary the blog post text.
     # @attr_reader [String] language_code ISO two letter language code for the
     #   language that the post was written in.
-    # @attr_reader [DateTime] indexed the time, in UTC, when this post was indexed by Twingly.
-    # @attr_reader [DateTime] published the time, in UTC, when this post was published.
+    # @attr_reader [Time] indexed the time, in UTC, when the post was indexed by Twingly.
+    # @attr_reader [Time] published the time, in UTC, when the post was published.
     # @attr_reader [String] blog_url the blog URL.
     # @attr_reader [String] blog_name name of the blog.
     # @attr_reader [String] authority the blog's authority/influence.
@@ -32,8 +32,8 @@ module Twingly
         @title         = params.fetch('title')
         @summary       = params.fetch('summary')
         @language_code = params.fetch('languageCode')
-        @published     = DateTime.parse(params.fetch('published'))
-        @indexed       = DateTime.parse(params.fetch('indexed'))
+        @published     = Time.parse(params.fetch('published'))
+        @indexed       = Time.parse(params.fetch('indexed'))
         @blog_url      = params.fetch('blogUrl')
         @blog_name     = params.fetch('blogName')
         @authority     = params.fetch('authority').to_i

data/lib/twingly/search/query.rb

@@ -1,18 +1,25 @@
 require "faraday"
+require "time"
 
 module Twingly
   module Search
     # Twingly Search API query
     #
     # @attr [String] pattern the search query.
-    # @attr [String] language which language to restrict the query to.
+    # @attr [String] language language to restrict the query to.
     # @attr [Client] client the client that this query is connected to.
-    # @attr [Time, #to_time] start_time search for posts published after
-    #   this time (inclusive).
-    # @attr [Time, #to_time] end_time search for posts published before
-    #   this time (inclusive).
     class Query
-      attr_accessor :pattern, :language, :client, :start_time, :end_time
+      attr_accessor :pattern, :language, :client
+
+      # @return [Time] the time that was set with {#start_time=}.
+      def start_time
+        @start_time
+      end
+
+      # @return [Time] the time that was set with {#end_time=}.
+      def end_time
+        @end_time
+      end
 
       # No need to call this method manually, instead use {Client#query}.
       #
@@ -56,14 +63,34 @@ module Twingly
         }
       end
 
+      # Search for posts published after this time (inclusive).
+      #
+      # @param [Time, #to_time] time an instance of the Time class
+      #   or an object responding to #to_time.
+      def start_time=(time)
+        fail QueryError, "Not a Time object" unless time.respond_to?(:to_time)
+
+        @start_time = time
+      end
+
+      # Search for posts published before this time (inclusive).
+      #
+      # @param [Time, #to_time] time an instance of the Time class
+      #   or an object responding to #to_time.
+      def end_time=(time)
+        fail QueryError, "Not a Time object" unless time.respond_to?(:to_time)
+
+        @end_time = time
+      end
+
       private
 
       def ts
-        start_time.to_time.strftime("%F %T") if start_time
+        start_time.to_time.utc.strftime("%F %T") if start_time
       end
 
       def ts_to
-        end_time.to_time.strftime("%F %T") if end_time
+        end_time.to_time.utc.strftime("%F %T") if end_time
       end
     end
   end

data/lib/twingly/search/version.rb

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

data/lib/twingly/search.rb

@@ -1,7 +1,7 @@
-require 'twingly/search/version'
-require 'twingly/search/error'
-require 'twingly/search/client'
-require 'twingly/search/query'
-require 'twingly/search/result'
-require 'twingly/search/parser'
-require 'twingly/search/post'
+require_relative "search/version"
+require_relative "search/error"
+require_relative "search/client"
+require_relative "search/query"
+require_relative "search/result"
+require_relative "search/parser"
+require_relative "search/post"

data/spec/fixtures/minimal_valid_result.xml

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<twinglydata numberOfMatchesReturned="1" secondsElapsed="0.148" numberOfMatchesTotal="1">
+<post contentType="blog">
+  <url>http://oppogner.blogg.no/1409602010_bare_m_ha.html</url>
+  <title><![CDATA[Bare MÅ ha!]]></title>
+  <summary><![CDATA[Ja, velkommen til høsten ...]]></summary>
+  <languageCode>no</languageCode>
+  <published>2014-09-02 06:53:26Z</published>
+  <indexed>2014-09-02 09:00:53Z</indexed>
+  <blogUrl>http://oppogner.blogg.no/</blogUrl>
+  <blogName><![CDATA[oppogner]]></blogName>
+  <authority>1</authority>
+  <blogRank>1</blogRank>
+  <tags>
+      <tag><![CDATA[Blogg]]></tag>
+  </tags>
+</post><post contentType="blog">
+  <url>http://www.skvallernytt.se/hardtraning-da-galler-swedish-house-mafia</url>
+  <title><![CDATA[Hårdträning – då gäller Swedish House Mafia]]></title>
+  <summary><![CDATA[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]]></summary>
+  <languageCode>sv</languageCode>
+  <published>2013-01-29 15:21:56Z</published>
+  <indexed>2013-01-29 15:22:52Z</indexed>
+  <blogUrl>http://www.skvallernytt.se/</blogUrl>
+  <blogName><![CDATA[Skvallernytt.se]]></blogName>
+  <authority>38</authority>
+  <blogRank>4</blogRank>
+  <tags>
+    <tag><![CDATA[Okategoriserat]]></tag>
+    <tag><![CDATA[Träning]]></tag>
+    <tag><![CDATA[greyhound]]></tag>
+    <tag><![CDATA[koncept]]></tag>
+    <tag><![CDATA[mafia]]></tag>
+  </tags>
+</post><post contentType="blog">
+  <url>http://didriksinspesielleverden.blogg.no/1359472349_justin_bieber.html</url>
+  <title><![CDATA[Justin Bieber]]></title>
+  <summary><![CDATA[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]]></summary>
+  <languageCode>no</languageCode>
+  <published>2013-01-29 15:12:29Z</published>
+  <indexed>2013-01-29 15:14:37Z</indexed>
+  <blogUrl>http://didriksinspesielleverden.blogg.no/</blogUrl>
+  <blogName><![CDATA[Didriksinspesielleverden]]></blogName>
+  <authority>0</authority>
+  <blogRank>1</blogRank>
+</post>
+</twinglydata>

data/spec/parser_spec.rb

@@ -1,4 +1,7 @@
+# encoding: utf-8
+
 require 'spec_helper'
+require 'date'
 
 include Twingly::Search
 
@@ -6,8 +9,9 @@ describe Parser do
   it { should respond_to(:parse) }
 
   describe "#parse" do
-    subject { described_class.new.parse(document) }
     let(:document) { Fixture.get(fixture) }
+    let(:result)   { described_class.new.parse(document) }
+    subject        { result }
 
     context "with a valid result" do
       let(:fixture) { :valid }
@@ -15,6 +19,177 @@ describe Parser do
       it { is_expected.to be_a Result }
     end
 
+    context "with a minimal valid result" do
+      let(:fixture) { :minimal_valid }
+
+      describe "#posts[0]" do
+        subject(:post) { result.posts[0] }
+
+        describe "#url" do
+          subject { post.url }
+          it { is_expected.to eq("http://oppogner.blogg.no/1409602010_bare_m_ha.html") }
+        end
+
+        describe "#title" do
+          subject { post.title }
+          it { is_expected.to eq("Bare MÅ ha!") }
+        end
+
+        describe "#summary" do
+          subject { post.summary }
+          it { is_expected.to eq("Ja, velkommen til høsten ...") }
+        end
+
+        describe "#language_code" do
+          subject { post.language_code }
+          it { is_expected.to eq("no") }
+        end
+
+        describe "#published" do
+          subject { post.published }
+          it { is_expected.to eq(Time.parse("2014-09-02 06:53:26Z")) }
+        end
+
+        describe "#indexed" do
+          subject { post.indexed }
+          it { is_expected.to eq(Time.parse("2014-09-02 09:00:53Z")) }
+        end
+
+        describe "#blog_url" do
+          subject { post.blog_url }
+          it { is_expected.to eq("http://oppogner.blogg.no/") }
+        end
+
+        describe "#authority" do
+          subject { post.authority }
+          it { is_expected.to eq(1) }
+        end
+
+        describe "#blog_rank" do
+          subject { post.blog_rank }
+          it { is_expected.to eq(1) }
+        end
+
+        describe "#tags" do
+          subject { post.tags }
+          it { is_expected.to eq(["Blogg"]) }
+        end
+      end
+
+      describe "#posts[1]" do
+        subject(:post) { result.posts[1] }
+
+        describe "#url" do
+          subject { post.url }
+          it { is_expected.to eq("http://www.skvallernytt.se/hardtraning-da-galler-swedish-house-mafia") }
+        end
+
+        describe "#title" do
+          subject { post.title }
+          it { is_expected.to eq("Hårdträning – då gäller Swedish House Mafia") }
+        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") }
+        end
+
+        describe "#language_code" do
+          subject { post.language_code }
+          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/") }
+        end
+
+        describe "#authority" do
+          subject { post.authority }
+          it { is_expected.to eq(38) }
+        end
+
+        describe "#blog_rank" do
+          subject { post.blog_rank }
+          it { is_expected.to eq(4) }
+        end
+
+        describe "#tags" do
+          subject { post.tags }
+          it { is_expected.to eq(["Okategoriserat", "Träning", "greyhound", "koncept", "mafia"]) }
+        end
+      end
+
+      describe "#posts[2]" do
+        subject(:post) { result.posts[2] }
+
+        describe "#url" do
+          subject { post.url }
+          it { is_expected.to eq("http://didriksinspesielleverden.blogg.no/1359472349_justin_bieber.html") }
+        end
+
+        describe "#title" do
+          subject { post.title }
+          it { is_expected.to eq("Justin Bieber") }
+        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") }
+        end
+
+        describe "#language_code" do
+          subject { post.language_code }
+          it { is_expected.to eq("no") }
+        end
+
+        describe "#published" do
+          subject { post.published }
+          it { is_expected.to eq(Time.parse("2013-01-29 15:12:29Z")) }
+        end
+
+        describe "#indexed" do
+          subject { post.indexed }
+          it { is_expected.to eq(Time.parse("2013-01-29 15:14:37Z")) }
+        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) }
+        end
+
+        describe "#blog_rank" do
+          subject { post.blog_rank }
+          it { is_expected.to eq(1) }
+        end
+
+        describe "#tags" do
+          subject { post.tags }
+          it { is_expected.to eq([]) }
+        end
+      end
+    end
+
     context "with a valid result containing non-blogs" do
       let(:fixture) { :valid_non_blog }
 

data/spec/query_spec.rb

@@ -70,6 +70,98 @@ describe Query do
     end
   end
 
+  describe "#start_time=" do
+    before do
+      subject.pattern    = "semla"
+    end
+
+    context "when given time in UTC" do
+      before do
+        subject.start_time = time
+      end
+
+      let(:time) { Time.parse("2016-02-09 09:01:22 UTC") }
+
+      it "should not change timezone" do
+        expect(subject.request_parameters).to include(ts: "2016-02-09 09:01:22")
+      end
+
+      it "should not modify the given time object" do
+        expect(subject.start_time).to equal(time)
+      end
+    end
+
+    context "when given time not in UTC" do
+      before do
+        subject.start_time = time
+      end
+
+      let(:time) { Time.parse("2016-02-09 09:01:22 +05:00") }
+
+      it "should convert to UTC" do
+        expect(subject.request_parameters).to include(ts: "2016-02-09 04:01:22")
+      end
+
+      it "should not modify the given time object" do
+        expect(subject.start_time).to equal(time)
+      end
+    end
+
+    context "when given non-time object" do
+      let(:time) { "2013-12-28+09%3A01%3A22" }
+
+      it "should raise exception" do
+        expect { subject.start_time = time }.to raise_error(QueryError, "Not a Time object")
+      end
+    end
+  end
+
+  describe "#end_time=" do
+    before do
+      subject.pattern  = "semla"
+    end
+
+    context "when given time in UTC" do
+      before do
+        subject.end_time = time
+      end
+
+      let(:time) { Time.parse("2016-02-09 09:01:22 UTC") }
+
+      it "should not change timezone" do
+        expect(subject.request_parameters).to include(tsTo: "2016-02-09 09:01:22")
+      end
+
+      it "should not modify the given time object" do
+        expect(subject.end_time).to equal(time)
+      end
+    end
+
+    context "when given time not in UTC" do
+      before do
+        subject.end_time = time
+      end
+
+      let(:time) { Time.parse("2016-02-09 09:01:22 +05:00") }
+
+      it "should convert to UTC" do
+        expect(subject.request_parameters).to include(tsTo: "2016-02-09 04:01:22")
+      end
+
+      it "should not modify the given time object" do
+        expect(subject.end_time).to equal(time)
+      end
+    end
+
+    context "when given non-time object" do
+      let(:time) { "2013-12-28+09%3A01%3A22" }
+
+      it "should raise exception" do
+        expect { subject.end_time = time }.to raise_error(QueryError, "Not a Time object")
+      end
+    end
+  end
+
   context "with valid pattern" do
     before { subject.pattern = "christmas" }
 
@@ -78,18 +170,8 @@ describe Query do
       expect(subject.request_parameters).to include(documentlang: 'en')
     end
 
-    it "should add start_time" do
-      subject.start_time = Time.new(2012, 12, 28, 9, 01, 22)
-      expect(subject.request_parameters).to include(ts: '2012-12-28 09:01:22')
-    end
-
-    it "should add end_time" do
-      subject.end_time = Time.new(2013, 12, 28, 9, 01, 22)
-      expect(subject.request_parameters).to include(tsTo: '2013-12-28 09:01:22')
-    end
-
     it "should encode url paramters" do
-      subject.end_time = Time.new(2013, 12, 28, 9, 01, 22)
+      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')
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twingly-search
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 5.0.0
 platform: ruby
 authors:
 - Twingly AB
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-28 00:00:00.000000000 Z
+date: 2016-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -169,6 +169,7 @@ files:
 - lib/twingly/search/version.rb
 - spec/client_spec.rb
 - spec/error_spec.rb
+- spec/fixtures/minimal_valid_result.xml
 - spec/fixtures/non_xml_result.xml
 - spec/fixtures/nonexistent_api_key_result.xml
 - spec/fixtures/service_unavailable_result.xml
@@ -212,6 +213,7 @@ summary: Ruby API client for Twingly Search
 test_files:
 - spec/client_spec.rb
 - spec/error_spec.rb
+- spec/fixtures/minimal_valid_result.xml
 - spec/fixtures/non_xml_result.xml
 - spec/fixtures/nonexistent_api_key_result.xml
 - spec/fixtures/service_unavailable_result.xml