twingly-search 5.0.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5fa690bb24c2c41b7f1c1141a636970c76b9057
-  data.tar.gz: 40ba48f85e4f1d255c0fb64b69aabac2b1e347c7
+  metadata.gz: 02b493d1ffc4f5ada3d5358efda0d1a109ea808f
+  data.tar.gz: c358cf6d79e121039b765dfe3b9133c1f67de916
 SHA512:
-  metadata.gz: 43941210a16c5377a5858d1bc296145d92f23162168043b7a932bb9a60590ea938b267b2ba1d0ec8e21effe9735ec09a939c43a99e3d49e75d61ee57156407d8
-  data.tar.gz: a82b2cb9a89a6539093a4f8e72b8ee79c0afc8c11d61f3ee60f26a12fd312619e49ec08c08df4516769b207d090dd0d316779dd36fa1914f9643320516c105dc
+  metadata.gz: 02a4a23e61a87504b8af957377448c0c0195100cb246d5b2c63bcce81eb27ffd7fca75c87ae06f43c967889b24377efff243d13ca59aa146f5ffa17227fed8e4
+  data.tar.gz: 46e0a56868dff241923f3461d69115e80877ee2cdda6ccd46af4684b2b32548df5aa0483050e1e4622e8a72514b69a4e1e8e16339223257b8ec951994d5d1f5d

data/.travis.yml

@@ -10,16 +10,6 @@ rvm:
   - 2.2
   - 2.3.0
   - jruby-9.0.0.0
-deploy:
-  provider: rubygems
-  api_key:
-    secure: QxMWXTQ3/T+0IQZl3pk3hmdoX8FcXTXEhH7Jn7Ub1A1D5faa8VNnfYsWAPjP6+VRgVfKEjAsHNMyZQNTvudpPPC/2kAwwzPvStyS+y7KnRkjZ9acC7sYVVel6cZ2lcl+t8iHY+19NRBFBWpq/P0eCAcR/Ew0XXaLZnig5h/1mQo=
-  gem: twingly-search
-  gemspec: twingly-search-api-ruby.gemspec
-  on:
-    tags: true
-    rvm: 2.2
-    repo: twingly/twingly-search-api-ruby
 notifications:
   email: false
   hipchat:

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Change Log
 
+## [v5.0.0](https://github.com/twingly/twingly-search-api-ruby/tree/v5.0.0) (2016-02-17)
+[Full Changelog](https://github.com/twingly/twingly-search-api-ruby/compare/v4.0.1...v5.0.0)
+
+**Implemented enhancements:**
+
+- Use Time all the time [\#50](https://github.com/twingly/twingly-search-api-ruby/issues/50)
+
+**Fixed bugs:**
+
+- Missing require "time" [\#44](https://github.com/twingly/twingly-search-api-ruby/issues/44)
+- Query\#start\_time and \#end\_time should be converted to UTC [\#43](https://github.com/twingly/twingly-search-api-ruby/issues/43)
+
+**Merged pull requests:**
+
+- Improve time handling [\#51](https://github.com/twingly/twingly-search-api-ruby/pull/51) ([dentarg](https://github.com/dentarg))
+- Improve parser specs [\#49](https://github.com/twingly/twingly-search-api-ruby/pull/49) ([dentarg](https://github.com/dentarg))
+- Sync documentation with PHP changes [\#47](https://github.com/twingly/twingly-search-api-ruby/pull/47) ([walro](https://github.com/walro))
+- Automatically convert Query\#start\_time and \#end\_time to UTC [\#46](https://github.com/twingly/twingly-search-api-ruby/pull/46) ([roback](https://github.com/roback))
+- Use require\_relative [\#45](https://github.com/twingly/twingly-search-api-ruby/pull/45) ([dentarg](https://github.com/dentarg))
+- Test Ruby 2.3 on Travis CI [\#42](https://github.com/twingly/twingly-search-api-ruby/pull/42) ([walro](https://github.com/walro))
+
 ## [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)
 

data/README.md

@@ -54,9 +54,21 @@ To learn more about the capabilities of the API, please read the [Twingly Search
   * Ruby 1.9, 2.0, 2.1, 2.2, 2.3
   * JRuby 9000
 
-## Development and release
+## Development
 
-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.
+### Tests
+
+Make sure you have all the dependencies
+
+    bundle
+
+Run the tests
+
+    bundle exec rake
+
+### Release
+
+1. Make a commit bumping 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.

data/lib/twingly/search/post.rb

@@ -16,9 +16,9 @@ module Twingly
     # @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.
-    #   See https://developer.twingly.com/resources/search/#authority
+    #   See https://developer.twingly.com/resources/ranking/#authority
     # @attr_reader [Integer] blog_rank the rank of the blog, based on authority and language.
-    #   See https://developer.twingly.com/resources/search/#authority
+    #   See https://developer.twingly.com/resources/ranking/#blogrank
     # @attr_reader [Array] tags
     class Post
       attr_reader :url, :title, :summary, :language_code, :indexed,

data/lib/twingly/search/query.rb

@@ -37,6 +37,8 @@ module Twingly
       # Executes the query and returns the result.
       #
       # @raise [QueryError] if {#pattern} is empty.
+      # @raise [AuthError] if the API couldn't authenticate you. Make sure your API key is correct.
+      # @raise [ServerError] if the query could not be executed due to a server error.
       # @return [Result] the result for this query.
       def execute
         @client.execute_query(self)
@@ -67,8 +69,9 @@ module Twingly
       #
       # @param [Time, #to_time] time an instance of the Time class
       #   or an object responding to #to_time.
+      # @raise [QueryError] if the object cannot be converted to a Time object.
       def start_time=(time)
-        fail QueryError, "Not a Time object" unless time.respond_to?(:to_time)
+        assert_valid_time(time)
 
         @start_time = time
       end
@@ -77,14 +80,21 @@ module Twingly
       #
       # @param [Time, #to_time] time an instance of the Time class
       #   or an object responding to #to_time.
+      # @raise [QueryError] if the object cannot be converted to a Time object.
       def end_time=(time)
-        fail QueryError, "Not a Time object" unless time.respond_to?(:to_time)
+        assert_valid_time(time)
 
         @end_time = time
       end
 
       private
 
+      def assert_valid_time(time)
+        return if time.nil?
+
+        fail QueryError, "Not a Time object" unless time.respond_to?(:to_time)
+      end
+
       def ts
         start_time.to_time.utc.strftime("%F %T") if start_time
       end

data/lib/twingly/search/version.rb

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

data/spec/fixtures/valid_empty_result.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<twinglydata numberOfMatchesReturned="0" secondsElapsed="0.213" numberOfMatchesTotal="0" />

data/spec/parser_spec.rb

@@ -198,6 +198,16 @@ Swedish House Mafia gör succé i USA") }
       end
     end
 
+    context "with a valid empty result" do
+      let(:fixture) { :valid_empty }
+
+      it "should return an empty result" do
+        expect(subject.posts.size).to eq(0)
+        expect(subject.number_of_matches_total).to eq(0)
+        expect(subject.number_of_matches_returned).to eq(0)
+      end
+    end
+
     context "with a nonexistent api key result" do
       let(:fixture) { :nonexistent_api_key }
 

data/spec/query_spec.rb

@@ -72,7 +72,7 @@ describe Query do
 
   describe "#start_time=" do
     before do
-      subject.pattern    = "semla"
+      subject.pattern = "semla"
     end
 
     context "when given time in UTC" do
@@ -80,40 +80,61 @@ describe Query do
         subject.start_time = time
       end
 
-      let(:time) { Time.parse("2016-02-09 09:01:22 UTC") }
+      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")
       end
 
       it "should not modify the given time object" do
-        expect(subject.start_time).to equal(time)
+        expect(subject.start_time.to_s).to eq(timestamp)
       end
     end
 
     context "when given time not in UTC" do
       before do
+        @TZ = ENV["TZ"]
+        # set timezone matching the timestamp, needed for Ruby versions before 2.2
+        # see https://github.com/twingly/twingly-search-api-ruby/pull/52
+        ENV["TZ"] = "Etc/GMT-5"
+
         subject.start_time = time
       end
 
-      let(:time) { Time.parse("2016-02-09 09:01:22 +05:00") }
+      after do
+        ENV["TZ"] = @TZ
+      end
+
+      let(:timestamp) { "2016-02-09 09:01:22 +0500" }
+      let(:time) { Time.parse(timestamp) }
 
       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)
+        expect(subject.start_time.to_s).to eq(timestamp)
       end
     end
 
-    context "when given non-time object" do
+    context "when given non-time object (except nil)" 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
+
+    context "when given nil" do
+      before do
+        subject.start_time = nil
+      end
+
+      it "should assign" do
+        expect(subject.start_time).to eq(nil)
+      end
+    end
   end
 
   describe "#end_time=" do
@@ -126,40 +147,61 @@ describe Query do
         subject.end_time = time
       end
 
-      let(:time) { Time.parse("2016-02-09 09:01:22 UTC") }
+      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(tsTo: "2016-02-09 09:01:22")
       end
 
       it "should not modify the given time object" do
-        expect(subject.end_time).to equal(time)
+        expect(subject.end_time.to_s).to eq(timestamp)
       end
     end
 
     context "when given time not in UTC" do
       before do
+        @TZ = ENV["TZ"]
+        # set timezone matching the timestamp, needed for Ruby versions before 2.2
+        # see https://github.com/twingly/twingly-search-api-ruby/pull/52
+        ENV["TZ"] = "Etc/GMT-5"
+
         subject.end_time = time
       end
 
-      let(:time) { Time.parse("2016-02-09 09:01:22 +05:00") }
+      after do
+        ENV["TZ"] = @TZ
+      end
+
+      let(:timestamp) { "2016-02-09 09:01:22 +0500" }
+      let(:time) { Time.parse(timestamp) }
 
       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)
+        expect(subject.end_time.to_s).to eq(timestamp)
       end
     end
 
-    context "when given non-time object" do
+    context "when given non-time object (except nil)" 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
+
+    context "when given nil" do
+      before do
+        subject.start_time = nil
+      end
+
+      it "should assign" do
+        expect(subject.start_time).to eq(nil)
+      end
+    end
   end
 
   context "with valid pattern" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twingly-search
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.0.1
 platform: ruby
 authors:
 - Twingly AB
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-17 00:00:00.000000000 Z
+date: 2016-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -175,6 +175,7 @@ files:
 - spec/fixtures/service_unavailable_result.xml
 - spec/fixtures/unauthorized_api_key_result.xml
 - spec/fixtures/undefined_error_result.xml
+- spec/fixtures/valid_empty_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
@@ -206,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: Ruby API client for Twingly Search
@@ -219,6 +220,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_empty_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