twingly-search 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3183abe585817948bbaa2b8c196c819861e1bf605ea84e0df3993b574dd056da
-  data.tar.gz: 6d9467ae4f7b961ce8084a6a18f2df5081fd5067d32f246ceba3b9a9ff25213b
+  metadata.gz: 816d2bcb38d40a6f83dd9c815f3eded749735d06c16e66910c9d19eccda14a56
+  data.tar.gz: 3d70d46edfa3c201e06fc36292498a3669ad63c9bbf0a6b509b758efa2d23138
 SHA512:
-  metadata.gz: 81aef4a30e435c318207a3fd7c89503c876fcbe505dbd87ac87abb8f6fedb0a16a08fb882e99b3069be6c6391774311e1d8ea87e47457db1b0e5577cc6edef96
-  data.tar.gz: 5bf47a6e3ca598356d97ebc7d5c7584579afa2d018f4024465bd75097d06864e4af4f8d0771b67fd88af67a2dea08607933c54918bf3a25b292fd3af71c32738
+  metadata.gz: cf6d1617263939de594f571031ee98fb0ed592838e0d53a5a221850511f7e948992af2e59c3630c8311fec0f53cf6d29f9a1a3594bc17d324817b6c284acd56c
+  data.tar.gz: 67c9e8cd2b7180fbe34401b16cab2d6a0f79ed5764d356843bce1b520f7473e787a8d3d47dcb88a34b94c7c2e92ce2af285974e82c5558e6d734ee80132b6f94

data/.travis.yml

@@ -4,20 +4,9 @@ before_install:
   - gem update bundler
 cache: bundler
 rvm:
-  - 2.1.10
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
-  - jruby-9.0.5.0
-  - jruby-9.1.15.0
+  - 2.4.6
+  - 2.5.5
+  - 2.6.2
+  - jruby-9.2.6.0
 notifications:
   email: false
-  hipchat:
-    on_success: never
-    on_failure: change
-    template:
-    - '%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message} (<a href="%{build_url}">Details</a>/<a href="%{compare_url}">Change view</a>)'
-    format: html
-    rooms:
-      secure: KU2mE9mcqvBczfiCTgTsgMmJPyW02AH/0Rzcli7oj3HVbiHGw8t5JlBQWYROF5TPht0kFhGkiwVPl6HUt/VAGxOIBsOp+/8MXR6aK5FkdIw6g8DMKlDjm9a2QijOT9rvat5bZ3l6hm3snojgkI3s9pLKmLq9l+KalAsPcevwKAQ=

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## [v5.2.0](https://github.com/twingly/twingly-search-api-ruby/tree/v5.2.0) (2018-05-17)
+[Full Changelog](https://github.com/twingly/twingly-search-api-ruby/compare/v5.1.4...v5.2.0)
+
+**Merged pull requests:**
+
+- Add Post\#to\_h for both LiveFeed and Search [\#77](https://github.com/twingly/twingly-search-api-ruby/pull/77) ([dentarg](https://github.com/dentarg))
+
 ## [v5.1.4](https://github.com/twingly/twingly-search-api-ruby/tree/v5.1.4) (2018-02-23)
 [Full Changelog](https://github.com/twingly/twingly-search-api-ruby/compare/v5.1.3...v5.1.4)
 

data/README.md

@@ -46,7 +46,7 @@ query = client.query do |query|
 end
 
 result = query.execute
-=> #<Twingly::Search::Result:0x3ff7adcbe3d4 @posts, @number_of_matches_returned=10, @number_of_matches_total=3035221>
+=> #<Twingly::Search::Result:0x3fca8ad3aa60 posts, number_of_matches_returned=10, number_of_matches_total=281, incomplete_result=false, seconds_elapsed=0.239, all_results_returned?=false, incomplete?=false>
 result.posts # will include all returned posts
 ```
 
@@ -64,7 +64,7 @@ end
 
 # get the next chunk of posts
 result = client.next_result
-=> #<Twingly::LiveFeed::Result:0x3fcd98215c14 @posts, @ts=2017-04-18 14:42:18 UTC, @from=2017-04-18 13:42:06 UTC, @number_of_posts=989, @max_number_of_posts=1000, @first_post=2017-04-18 13:42:19 UTC, @last_post=2017-04-18 14:42:13 UTC>
+=> #<Twingly::LiveFeed::Result:0x3fca8ad4e81c posts, ts=2019-03-27 12:52:54 UTC, from=2019-03-27 11:52:53 UTC, number_of_posts=709, max_number_of_posts=1000, first_post=2019-03-27 11:53:02 UTC, last_post=2019-03-27 12:52:42 UTC, next_timestamp=2019-03-27 12:52:42 UTC>
 
 result.posts # will include all returned posts
 ```
@@ -73,8 +73,8 @@ result.posts # will include all returned posts
 
 * API key, [sign up](https://www.twingly.com/try-for-free) via [twingly.com](https://www.twingly.com/) to get one
 * Ruby
-  * Ruby 2.1, 2.2, 2.3, 2.4
-  * JRuby 9.0, 9.1
+  * Ruby >= 2.4
+  * JRuby >= 9.2
 
 ## Development
 
@@ -88,6 +88,15 @@ Run the tests
 
     bundle exec rake
 
+### Profiling
+
+It's possible to profile memory and object allocation:
+
+    bundle exec ruby profiler/profile_livefeed.rb
+    bundle exec ruby profiler/profile_search.rb
+
+Currently using [memory_profiler](https://github.com/SamSaffron/memory_profiler) for reports and [VCR](https://github.com/vcr/vcr) for saving requests (to make runs comparable).
+
 ### 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.

data/examples/find_all_posts_mentioning_github.rb

@@ -8,8 +8,14 @@ class SearchPostStream
     end
 
     @query = client.query do |query|
-      query.language     = language
-      query.search_query = "sort-order:asc sort:published #{keyword}"
+      query_parts = [
+        "sort-order:asc",
+        "sort:published",
+        keyword,
+      ]
+      query_parts << "lang:#{language}" if language
+
+      query.search_query = query_parts.join(" ")
     end
   end
 

data/lib/twingly/livefeed.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "livefeed/version"
 require_relative "livefeed/error"
 require_relative "livefeed/client"

data/lib/twingly/livefeed/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "faraday"
 require "time"
 
@@ -30,7 +32,7 @@ module Twingly
       # @option options [String] :max_posts the maximum number of posts that can
       #    be returned for each request
       # @option options [String] :timestamp the timestamp to start the client at
-      # @raise [AuthError] if an API key is not set
+      # @raise [AuthenticationError] if an API key is not set
       def initialize(api_key = nil, options = {})
         @api_key    = api_key
         @user_agent = options.fetch(:user_agent) { DEFAULT_USER_AGENT }
@@ -49,7 +51,7 @@ module Twingly
       # then returns the result.
       #
       # @raise [QueryError] if the timestamp is invalid.
-      # @raise [AuthError] if the API couldn't authenticate you. Make sure your API key is correct.
+      # @raise [AuthenticationError] 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 request.
       def next_result
@@ -110,7 +112,7 @@ module Twingly
       end
 
       def api_key_missing
-        fail AuthError, "No API key has been provided."
+        fail AuthenticationError, "No API key has been provided."
       end
 
       def assert_valid_time(time)

data/lib/twingly/livefeed/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twingly
   module LiveFeed
     class Error < StandardError
@@ -7,7 +9,7 @@ module Twingly
           when /^400/, /^404/
             QueryError
           when /^401/
-            AuthError
+            AuthenticationError
           else
             ServerError
           end
@@ -19,6 +21,9 @@ module Twingly
     class AuthError < Error
     end
 
+    class AuthenticationError < AuthError
+    end
+
     class ServerError < Error
     end
 

data/lib/twingly/livefeed/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'nokogiri'
 
 module Twingly
@@ -45,9 +47,10 @@ module Twingly
       def parse_post(element)
         post_params = {}
         element.element_children.each do |child|
-          post_params[child.name] =
-            case child.name
-            when *%w(tags links images)
+          name = child.name.freeze
+          post_params[name] =
+            case name
+            when "tags", "links", "images"
               parse_array(child)
             when "coordinates"
               parse_coordinates(child)

data/lib/twingly/livefeed/post.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module Twingly
   module LiveFeed
@@ -36,6 +37,9 @@ module Twingly
         :published_at, :reindexed_at, :inlinks_count, :blog_id, :blog_name,
         :blog_url, :blog_rank, :authority
 
+      EMPTY_ARRAY = [].freeze
+      EMPTY_HASH  = {}.freeze
+
       # Sets all instance variables for the {Post}, given a Hash.
       #
       # @param [Hash] params containing blog post data.
@@ -47,10 +51,10 @@ module Twingly
         @text          = params.fetch('text')
         @language_code = params.fetch('languageCode')
         @location_code = params.fetch('locationCode')
-        @coordinates   = params.fetch('coordinates', {})
-        @links         = params.fetch('links', [])
-        @tags          = params.fetch('tags', [])
-        @images        = params.fetch('images', [])
+        @coordinates   = params.fetch('coordinates') { EMPTY_HASH }
+        @links         = params.fetch('links') { EMPTY_ARRAY }
+        @tags          = params.fetch('tags') { EMPTY_ARRAY }
+        @images        = params.fetch('images') { EMPTY_ARRAY }
         @indexed_at    = Time.parse(params.fetch('indexedAt'))
         @published_at  = Time.parse(params.fetch('publishedAt'))
         @reindexed_at  = Time.parse(params.fetch('reindexedAt'))

data/lib/twingly/livefeed/result.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twingly
   module LiveFeed
     # Represents a result from a request to the LiveFeed API
@@ -23,16 +25,18 @@ module Twingly
       end
 
       def inspect
-        instance_variables = "@posts, "
-        instance_variables << "@ts=#{self.ts}, "
-        instance_variables << "@from=#{self.from}, "
-        instance_variables << "@number_of_posts=#{self.number_of_posts}, "
-        instance_variables << "@max_number_of_posts=#{self.max_number_of_posts}, "
-        instance_variables << "@first_post=#{self.first_post}, "
-        instance_variables << "@last_post=#{self.last_post}"
-        instance_variables << "@next_timestamp=#{self.next_timestamp}"
+        instance_methods = [
+          "posts",
+          "ts=#{self.ts}",
+          "from=#{self.from}",
+          "number_of_posts=#{self.number_of_posts}",
+          "max_number_of_posts=#{self.max_number_of_posts}",
+          "first_post=#{self.first_post}",
+          "last_post=#{self.last_post}",
+          "next_timestamp=#{self.next_timestamp}",
+        ].join(", ")
 
-        sprintf("#<%s:0x%x %s>", self.class.name, __id__, instance_variables)
+        sprintf("#<%s:0x%x %s>", self.class.name, __id__, instance_methods)
       end
     end
   end

data/lib/twingly/livefeed/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Twingly
   module LiveFeed
-    VERSION = "5.2.0"
+    VERSION = "5.3.0"
   end
 end

data/lib/twingly/search.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "search/version"
 require_relative "search/error"
 require_relative "search/client"

data/lib/twingly/search/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "faraday"
 
 module Twingly
@@ -19,7 +21,7 @@ module Twingly
       # @param options [Hash]
       # @option options [String] :user_agent the user agent to be used
       #    for all requests
-      # @raise [AuthError] if an API key is not set.
+      # @raise [AuthenticationError] if an API key is not set.
       def initialize(api_key = nil, options = {})
         @api_key    = api_key
         @user_agent = options.fetch(:user_agent) { DEFAULT_USER_AGENT }
@@ -70,7 +72,7 @@ module Twingly
       end
 
       def api_key_missing
-        fail AuthError, "No API key has been provided."
+        fail AuthenticationError, "No API key has been provided."
       end
     end
   end

data/lib/twingly/search/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twingly
   module Search
     class Error < StandardError
@@ -6,8 +8,10 @@ module Twingly
           case code.to_s
           when /^400/, /^404/
             QueryError
-          when /^401/, /^402/
-            AuthError
+          when /^401/ # E.g. API key not enabled
+            AuthenticationError
+          when /^402/ # E.g. language access denied
+            AuthorizationError
           else
             ServerError
           end
@@ -19,6 +23,12 @@ module Twingly
     class AuthError < Error
     end
 
+    class AuthenticationError < AuthError
+    end
+
+    class AuthorizationError < AuthError
+    end
+
     class ServerError < Error
     end
 

data/lib/twingly/search/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'nokogiri'
 
 module Twingly
@@ -43,9 +45,10 @@ module Twingly
       def parse_post(element)
         post_params = {}
         element.element_children.each do |child|
-          post_params[child.name] =
-            case child.name
-            when *%w(tags links images)
+          name = child.name.freeze
+          post_params[name] =
+            case name
+            when "tags", "links", "images"
               parse_array(child)
             when "coordinates"
               parse_coordinates(child)

data/lib/twingly/search/post.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module Twingly
   module Search
@@ -35,6 +36,9 @@ module Twingly
         :published_at, :reindexed_at, :inlinks_count, :blog_id, :blog_name,
         :blog_url, :blog_rank, :authority
 
+      EMPTY_ARRAY = [].freeze
+      EMPTY_HASH  = {}.freeze
+
       # Sets all instance variables for the {Post}, given a Hash.
       #
       # @param [Hash] params containing blog post data.
@@ -46,10 +50,10 @@ module Twingly
         @text          = params.fetch('text')
         @language_code = params.fetch('languageCode')
         @location_code = params.fetch('locationCode')
-        @coordinates   = params.fetch('coordinates', {})
-        @links         = params.fetch('links', [])
-        @tags          = params.fetch('tags', [])
-        @images        = params.fetch('images', [])
+        @coordinates   = params.fetch('coordinates') { EMPTY_HASH }
+        @links         = params.fetch('links') { EMPTY_ARRAY }
+        @tags          = params.fetch('tags') { EMPTY_ARRAY }
+        @images        = params.fetch('images') { EMPTY_ARRAY }
         @indexed_at    = Time.parse(params.fetch('indexedAt'))
         @published_at  = Time.parse(params.fetch('publishedAt'))
         @reindexed_at  = Time.parse(params.fetch('reindexedAt'))

data/lib/twingly/search/query.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "faraday"
 require "time"
 
@@ -48,7 +50,11 @@ module Twingly
       #
       # @param client [Client] the client that this query should be connected to.
       def initialize(client)
-        @client = client
+        @client     = client
+        @start_time = nil
+        @end_time   = nil
+        @language   = nil
+
         yield self if block_given?
       end
 
@@ -60,7 +66,8 @@ module Twingly
       # Executes the query and returns the result.
       #
       # @raise [QueryError] if {#search_query} is empty.
-      # @raise [AuthError] if the API couldn't authenticate you. Make sure your API key is correct.
+      # @raise [AuthenticationError] if the API couldn't authenticate you. Make sure your API key is correct.
+      # @raise [AuthorizationError] if you don't have access to something.
       # @raise [ServerError] if the query could not be executed due to a server error.
       # @return [Result] the result for this query.
       def execute

data/lib/twingly/search/result.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twingly
   module Search
     # Represents a result from a {Query} to the Search API
@@ -35,12 +37,16 @@ module Twingly
       end
 
       def inspect
-        matches = "@posts, "
-        matches << "@number_of_matches_returned=#{self.number_of_matches_returned}, "
-        matches << "@number_of_matches_total=#{self.number_of_matches_total}"
-        matches << "@incomplete_result=#{self.incomplete?}"
+        instance_methods = [
+          "posts",
+          "number_of_matches_returned=#{self.number_of_matches_returned}",
+          "number_of_matches_total=#{self.number_of_matches_total}",
+          "seconds_elapsed=#{self.seconds_elapsed}",
+          "all_results_returned?=#{self.all_results_returned?}",
+          "incomplete?=#{self.incomplete?}",
+        ].join(", ")
 
-        sprintf("#<%s:0x%x %s>", self.class.name, __id__, matches)
+        sprintf("#<%s:0x%x %s>", self.class.name, __id__, instance_methods)
       end
     end
   end

data/lib/twingly/search/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Twingly
   module Search
-    VERSION = "5.2.0"
+    VERSION = "5.3.0"
   end
 end