twingly-search 5.0.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02b493d1ffc4f5ada3d5358efda0d1a109ea808f
-  data.tar.gz: c358cf6d79e121039b765dfe3b9133c1f67de916
+  metadata.gz: 3c9c84cb7c69272bfd499b2901f475082d4dc251
+  data.tar.gz: d51285306f3bc40452016e81bee6a6b22f783c59
 SHA512:
-  metadata.gz: 02a4a23e61a87504b8af957377448c0c0195100cb246d5b2c63bcce81eb27ffd7fca75c87ae06f43c967889b24377efff243d13ca59aa146f5ffa17227fed8e4
-  data.tar.gz: 46e0a56868dff241923f3461d69115e80877ee2cdda6ccd46af4684b2b32548df5aa0483050e1e4622e8a72514b69a4e1e8e16339223257b8ec951994d5d1f5d
+  metadata.gz: 407a46a73b5bff7aed5277240f45bf7be611cafc2b64b8b9a22de2b019be3f3cd49d1da236c4ecdd5a6a221e0a82e54482ba60c40ca4babae33f0e6e0f93b389
+  data.tar.gz: 7f64f9eec9386722f72f13701f473d687680016f2bf303be68007a30b116872b61e8790ed6a43c8ff3ba7702edc81baecf31f6b0c7cd4850bf07070da439796b

data/.travis.yml

@@ -4,11 +4,10 @@ before_install:
   - gem update bundler
 cache: bundler
 rvm:
-  - 1.9.3
-  - 2.0.0
   - 2.1
   - 2.2
   - 2.3.0
+  - 2.4.0
   - jruby-9.0.0.0
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## [v5.0.1](https://github.com/twingly/twingly-search-api-ruby/tree/v5.0.1) (2016-03-03)
+[Full Changelog](https://github.com/twingly/twingly-search-api-ruby/compare/v5.0.0...v5.0.1)
+
+**Fixed bugs:**
+
+- Not possible to remove start\_time from query [\#53](https://github.com/twingly/twingly-search-api-ruby/issues/53)
+
+**Closed issues:**
+
+- New release [\#48](https://github.com/twingly/twingly-search-api-ruby/issues/48)
+
+**Merged pull requests:**
+
+- Be able to remove start/end time from Query [\#54](https://github.com/twingly/twingly-search-api-ruby/pull/54) ([dentarg](https://github.com/dentarg))
+- Actually test what we intend to test [\#52](https://github.com/twingly/twingly-search-api-ruby/pull/52) ([dentarg](https://github.com/dentarg))
+
 ## [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)
 

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/twingly/twingly-search-api-ruby.png?branch=master)](https://travis-ci.org/twingly/twingly-search-api-ruby)
 [![Code Climate](https://codeclimate.com/github/twingly/twingly-search-api-ruby/badges/gpa.svg)](https://codeclimate.com/github/twingly/twingly-search-api-ruby)
 
-A Ruby gem for Twingly's Search API (previously known as Analytics API). Twingly is a blog search service that provides a searchable API known as [Twingly Search API](https://developer.twingly.com/resources/search/).
+A Ruby gem for Twingly's Blog Search API (previously known as Analytics API) and Blog LiveFeed API. Twingly is a blog search service that provides a searchable API known as [Twingly Blog Search API][Blog Search API documentation] and a blog data firehose called [Twingly Blog LiveFeed API][Blog LiveFeed API documentation].
 
 ## Installation
 
@@ -21,6 +21,18 @@ gem "twingly-search"
 
 ## Usage
 
+The `twingly-search` gem talks to a commercial API and requires an API key. Best practice is to set the `TWINGLY_SEARCH_KEY` environment variable to the obtained key. `Twingly::Search::Client` and `Twingly::LiveFeed::Client` can be passed a key at initialization if your setup does not allow environment variables.
+
+To learn more about the features of this gem, read the [gem documentation] or check out the example code that can be found in [examples/](examples/).
+
+To learn more about the capabilities of Twingly's APIs, please read the [Blog Search API documentation] and [Blog LiveFeed API documentation].
+
+[gem documentation]: http://www.rubydoc.info/github/twingly/twingly-search-api-ruby
+[Blog Search API documentation]: https://developer.twingly.com/resources/search/
+[Blog LiveFeed API documentation]: https://developer.twingly.com/resources/livefeed/
+
+### Blog Search API
+
 ```ruby
 require "twingly/search"
 
@@ -29,8 +41,8 @@ client = Twingly::Search::Client.new do |client|
 end
 
 query = client.query do |query|
-  query.pattern  = "github page-size:10"
-  query.language = "sv"
+  query.search_query  = "github page-size:10"
+  query.language      = "sv"
 end
 
 result = query.execute
@@ -38,20 +50,30 @@ result = query.execute
 result.posts # will include all returned posts
 ```
 
-The `twingly-search` gem talks to a commercial blog search API and requires an API key. Best practice is to set the `TWINGLY_SEARCH_KEY` environment variable to the obtained key. `Twingly::Search::Client` can be passed a key at initialization if your setup does not allow environment variables.
+### Blog LiveFeed API
 
-To learn more about the features of this gem, read the [gem documentation] or check out the example code that can be found in [examples/](examples/).
+```ruby
+require "twingly/livefeed"
 
-To learn more about the capabilities of the API, please read the [Twingly Search API documentation].
+client = Twingly::LiveFeed::Client.new do |client|
+  client.user_agent = "MyCompany/1.0"
+  # Start getting posts indexed by Twingly at this timestamp
+  client.timestamp = Time.now - 3600 # 1 hour ago
+  client.max_posts = 1000            # Maximum number of posts returned per call
+end
 
-[gem documentation]: http://www.rubydoc.info/github/twingly/twingly-search-api-ruby
-[Twingly Search API documentation]: https://developer.twingly.com/resources/search/
+# 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>
+
+result.posts # will include all returned posts
+```
 
 ## Requirements
 
-* API key, contact sales@twingly.com via [twingly.com](https://www.twingly.com/try-for-free/) to get one
+* API key, [sign up](https://www.twingly.com/try-for-free) via [twingly.com](https://www.twingly.com/) to get one
 * Ruby
-  * Ruby 1.9, 2.0, 2.1, 2.2, 2.3
+  * Ruby 2.1, 2.2, 2.3
   * JRuby 9000
 
 ## Development
@@ -70,7 +92,7 @@ Run the tests
 
 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. Generate a changelog with `github_changelog_generator` (`gem install github_changelog_generator` if you don't have it). 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
@@ -85,26 +107,3 @@ This gem is documented using [YARD]. To start a local YARD server run:
 The YARD server reloads the documentation automatically so there is no need to restart it when making changes.
 
 [YARD]: http://yardoc.org/
-
-## License
-
-The MIT License (MIT)
-
-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
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -10,12 +10,6 @@ task :spec do
   end
 end
 
-require "github_changelog_generator/task"
-GitHubChangelogGenerator::RakeTask.new(:changelog) do |config|
-  config.user = "twingly"
-  config.project = "twingly-search-api-ruby"
-end
-
 namespace :yard do
   require "yard"
   require "yard/rake/yardoc_task"

data/examples/find_all_posts_mentioning_github.rb

@@ -8,8 +8,8 @@ class SearchPostStream
     end
 
     @query = client.query do |query|
-      query.language = language
-      query.pattern  = "sort-order:asc sort:published #{keyword}"
+      query.language     = language
+      query.search_query = "sort-order:asc sort:published #{keyword}"
     end
   end
 
@@ -25,7 +25,7 @@ class SearchPostStream
 
       break if result.all_results_returned?
 
-      @query.start_time = result.posts.last.published
+      @query.start_time = result.posts.last.published_at
     end
   end
 

data/examples/hello_world.rb

@@ -3,8 +3,8 @@ Bundler.require
 # Set environment variable TWINGLY_SEARCH_KEY
 client = Twingly::Search::Client.new
 query = client.query do |query|
-  query.pattern    = '"hello world"'
-  query.start_time = Time.now - (24 * 3600) # search last day
+  query.search_query = '"hello world"'
+  query.start_time   = Time.now - (24 * 3600) # search last day
 end
 
 result = query.execute

data/examples/livefeed_loop.rb

@@ -0,0 +1,24 @@
+Bundler.require
+
+require "twingly/livefeed"
+
+# Set environment variable TWINGLY_SEARCH_KEY
+client = Twingly::LiveFeed::Client.new do |client|
+  # get posts published less than an hour ago
+  client.timestamp = (Time.now - 3600)
+  client.max_posts = 4000
+end
+
+loop do
+  result = client.next_result
+
+  result.posts.each do |post|
+    puts "#{post.indexed_at} - #{post.url}"
+  end
+
+  # You're faster than Twingly! Take a break and wait for
+  # us to index some new posts before asking again
+  if result.number_of_posts < result.max_number_of_posts
+    sleep 20
+  end
+end

data/lib/twingly/livefeed/client.rb

@@ -0,0 +1,121 @@
+require "faraday"
+require "time"
+
+module Twingly
+  module LiveFeed
+    # Twingly LiveFeed API client
+    #
+    # @attr [String] api_key the API key
+    # @attr [String] user_agent the user agent to be used for all API requests
+    # @attr [Integer] max_posts the maximum number of posts that each request can return
+    # @attr [Time] timestamp the timestamp that will be used in the next request
+    class Client
+      attr_accessor :api_key, :user_agent, :max_posts, :timestamp
+
+      BASE_URL             = "https://api.twingly.com"
+      LIVEFEED_API_VERSION = "v5"
+      LIVEFEED_PATH        = "/blog/livefeed/api/#{LIVEFEED_API_VERSION}/getdata"
+
+      DEFAULT_USER_AGENT = "Twingly LiveFeed Ruby Client/#{VERSION}"
+      DEFAULT_MAX_POSTS  = 1000
+      TIMESTAMP_FORMAT   = "%Y-%m-%dT%H:%M:%S.%3N%z"
+
+      # Creates a new Twingly Search API client
+      #
+      # @param api_key [String] the API key provided by Twingly.
+      #   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
+      # @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
+      def initialize(api_key = nil, options = {})
+        @api_key    = api_key
+        @user_agent = options.fetch(:user_agent) { DEFAULT_USER_AGENT }
+        @max_posts  = options.fetch(:max_posts)  { DEFAULT_MAX_POSTS }
+        @timestamp  = options.fetch(:timestamp)  { Time.now }
+
+        yield self if block_given?
+
+        @api_key ||= env_api_key || api_key_missing
+      end
+
+      # Get the next result from the API and updates the next timestamp
+      #
+      # Sends a request to the API using the timestamp set with {#timestamp},
+      # updates the timestamp that should be used in the next request and
+      # 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 [ServerError] if the query could not be executed due to a server error.
+      # @return [Result] the result for this request.
+      def next_result
+        assert_valid_time(timestamp)
+
+        get_and_parse_result.tap do |result|
+          update_timestamp(result.next_timestamp)
+        end
+      end
+
+      # @return [String] the request url for the next request.
+      def url
+        "#{endpoint_url}?#{url_parameters}"
+      end
+
+      # @return [String] the API endpoint URL.
+      def endpoint_url
+        "#{BASE_URL}#{LIVEFEED_PATH}"
+      end
+
+      # @see #url
+      # @return [String] the query part of the request url.
+      def url_parameters
+        Faraday::Utils.build_query(request_parameters)
+      end
+
+      # @return [Hash] the request parameters.
+      def request_parameters
+        {
+          apikey:    api_key,
+          timestamp: timestamp.to_time.utc.strftime(TIMESTAMP_FORMAT),
+          maxPosts:  max_posts,
+        }
+      end
+
+      private
+
+      def update_timestamp(timestamp)
+        @timestamp = timestamp
+      end
+
+      def get_and_parse_result
+        response_body = get_response.body
+        Parser.new.parse(response_body)
+      end
+
+      def get_response
+        connection = Faraday.new(url: BASE_URL) do |faraday|
+          faraday.request :url_encoded
+          faraday.adapter Faraday.default_adapter
+        end
+        connection.headers[:user_agent] = user_agent
+        connection.get(LIVEFEED_PATH, request_parameters)
+      end
+
+      def env_api_key
+        ENV['TWINGLY_SEARCH_KEY']
+      end
+
+      def api_key_missing
+        fail AuthError, "No API key has been provided."
+      end
+
+      def assert_valid_time(time)
+        fail QueryError, "Not a Time object" unless time.respond_to?(:to_time)
+      end
+    end
+  end
+end

data/lib/twingly/livefeed/error.rb

@@ -0,0 +1,28 @@
+module Twingly
+  module LiveFeed
+    class Error < StandardError
+      def self.from_api_response(code, message)
+        error =
+          case code.to_s
+          when /^400/, /^404/
+            QueryError
+          when /^401/
+            AuthError
+          else
+            ServerError
+          end
+
+        error.new("#{message} (code: #{code})")
+      end
+    end
+
+    class AuthError < Error
+    end
+
+    class ServerError < Error
+    end
+
+    class QueryError < Error
+    end
+  end
+end

data/lib/twingly/livefeed/parser.rb

@@ -0,0 +1,96 @@
+require 'nokogiri'
+
+module Twingly
+  module LiveFeed
+    class Parser
+      # Parse an API response body.
+      #
+      # @param [String] document containing an API response XML.
+      # @raise [Error] which error depends on the API response (see {Error.from_api_response}).
+      # @return [Result] containing the result.
+      def parse(document)
+        nokogiri = Nokogiri::XML(document)
+
+        failure = nokogiri.at_xpath('/error')
+        handle_failure(failure) if failure
+
+        data_node = nokogiri.at_xpath('/twinglydata')
+        handle_non_xml_document(document) unless data_node
+
+        create_result(data_node)
+      end
+
+      private
+
+      def create_result(data_node)
+        result = Result.new
+        result.ts                  = parse_time(data_node.attribute('ts').value)
+        result.from                = parse_time(data_node.attribute('from').value)
+        result.number_of_posts     = data_node.attribute('numberOfPosts').value.to_i
+        result.max_number_of_posts = data_node.attribute('maxNumberOfPosts').value.to_i
+        result.next_timestamp      = parse_time(data_node.attribute('nextTimestamp').value)
+
+        unless result.number_of_posts.zero?
+          result.first_post = parse_time(data_node.attribute('firstPost').value)
+          result.last_post  = parse_time(data_node.attribute('lastPost').value)
+        end
+
+        data_node.xpath('//post').each do |post|
+          result.posts << parse_post(post)
+        end
+
+        result
+      end
+
+      def parse_post(element)
+        post_params = {}
+        element.element_children.each do |child|
+          post_params[child.name] =
+            case child.name
+            when *%w(tags links images)
+              parse_array(child)
+            when "coordinates"
+              parse_coordinates(child)
+            else
+              child.text
+            end
+        end
+
+        post = Post.new
+        post.set_values(post_params)
+        post
+      end
+
+      def parse_array(element)
+        element.element_children.map do |child|
+          child.text
+        end
+      end
+
+      # TODO: Decide if a class or hash should be used...
+      def parse_coordinates(element)
+        return {} if element.children.empty?
+
+        {
+          latitude:  element.at_xpath("latitude/text()"),
+          longitude: element.at_xpath("longitude/text()"),
+        }
+      end
+
+      def handle_failure(failure)
+        code    = failure.attribute('code').value
+        message = failure.at_xpath('message').text
+
+        fail Error.from_api_response(code, message)
+      end
+
+      def handle_non_xml_document(document)
+        fail ServerError, "Failed to parse response: \"#{document}\""
+      end
+
+      def parse_time(time)
+        Time.parse(time)
+      end
+    end
+  end
+end

data/lib/twingly/livefeed/post.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+module Twingly
+  module LiveFeed
+
+    # A blog post
+    #
+    # @attr_reader [String] id the post ID (Twingly internal identification)
+    # @attr_reader [String] author the author of the blog post
+    # @attr_reader [String] url the post URL
+    # @attr_reader [String] title the post title
+    # @attr_reader [String] text 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 [String] location_code ISO two letter country code for the
+    #   location of the blog
+    # @attr_reader [Hash] coordinates a hash containing :latitude and :longitude
+    #   from the post RSS
+    # @attr_reader [Array] links all links from the blog post to other resources
+    # @attr_reader [Array] tags the post tags/categories
+    # @attr_reader [Array] images image URLs from the post (currently not populated)
+    # @attr_reader [Time] indexed_at the time, in UTC, when the post was indexed by Twingly
+    # @attr_reader [Time] published_at the time, in UTC, when the post was published
+    # @attr_reader [Time] reindexed_at timestamp when the post last was changed in our database/index
+    # @attr_reader [String] inlinks_count number of links to this post that was found in other blog posts
+    # @attr_reader [String] blog_id the blog ID (Twingly internal identification)
+    # @attr_reader [String] blog_name the name of the blog
+    # @attr_reader [String] blog_url the blog URL
+    # @attr_reader [Integer] blog_rank the rank of the blog, based on authority and language.
+    #   See https://developer.twingly.com/resources/ranking/#blogrank
+    # @attr_reader [Integer] authority the blog's authority/influence.
+    #   See https://developer.twingly.com/resources/ranking/#authority
+    class Post
+      attr_reader :id, :author, :url, :title, :text, :location_code,
+        :language_code, :coordinates, :links, :tags, :images, :indexed_at,
+        :published_at, :reindexed_at, :inlinks_count, :blog_id, :blog_name,
+        :blog_url, :blog_rank, :authority
+
+      # Sets all instance variables for the {Post}, given a Hash.
+      #
+      # @param [Hash] params containing blog post data.
+      def set_values(params)
+        @id            = params.fetch('id')
+        @author        = params.fetch('author')
+        @url           = params.fetch('url')
+        @title         = params.fetch('title')
+        @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', [])
+        @indexed_at    = Time.parse(params.fetch('indexedAt'))
+        @published_at  = Time.parse(params.fetch('publishedAt'))
+        @reindexed_at  = Time.parse(params.fetch('reindexedAt'))
+        @inlinks_count = params.fetch('inlinksCount').to_i
+        @blog_id       = params.fetch('blogId')
+        @blog_name     = params.fetch('blogName')
+        @blog_url      = params.fetch('blogUrl')
+        @blog_rank     = params.fetch('blogRank').to_i
+        @authority     = params.fetch('authority').to_i
+      end
+    end
+  end
+end

data/lib/twingly/livefeed/result.rb

@@ -0,0 +1,39 @@
+module Twingly
+  module LiveFeed
+    # Represents a result from a request to the LiveFeed API
+    #
+    # @see Client#next_result
+    # @attr [Time] ts the exact time when the result was built
+    # @attr [Time] from the timestamp that was sent in the request.
+    #   See {Client#timestamp}
+    # @attr [Integer] number_of_posts the number of posts this result contains
+    # @attr [Integer] max_number_of_posts the maximum number of posts this result
+    #   could contain. See {Client#max_posts}
+    # @attr [Time] first_post the index time for the first post in the result
+    # @attr [Time] last_post the index time for the last post in the result
+    # @attr [Time] next_timestamp the timestamp that should be used to get the
+    #   next batch of posts
+    class Result
+      attr_accessor :ts, :from, :number_of_posts, :max_number_of_posts,
+        :first_post, :last_post, :next_timestamp
+
+      # @return [Array<Post>] all posts that matched the {Query}.
+      def posts
+        @posts ||= []
+      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}"
+
+        sprintf("#<%s:0x%x %s>", self.class.name, __id__, instance_variables)
+      end
+    end
+  end
+end

data/lib/twingly/livefeed/version.rb

@@ -0,0 +1,5 @@
+module Twingly
+  module LiveFeed
+    VERSION = "5.0.1"
+  end
+end

data/lib/twingly/livefeed.rb

@@ -0,0 +1,6 @@
+require_relative "livefeed/version"
+require_relative "livefeed/error"
+require_relative "livefeed/client"
+require_relative "livefeed/result"
+require_relative "livefeed/parser"
+require_relative "livefeed/post"

data/lib/twingly/search/client.rb

@@ -6,8 +6,9 @@ module Twingly
     class Client
       attr_accessor :api_key, :user_agent
 
-      BASE_URL    = "https://api.twingly.com"
-      SEARCH_PATH = "/analytics/Analytics.ashx"
+      BASE_URL           = "https://api.twingly.com"
+      SEARCH_API_VERSION = "v3"
+      SEARCH_PATH        = "/blog/search/api/#{SEARCH_API_VERSION}/search"
 
       DEFAULT_USER_AGENT = "Twingly Search Ruby Client/#{VERSION}"
 

data/lib/twingly/search/error.rb

@@ -1,17 +1,18 @@
 module Twingly
   module Search
     class Error < StandardError
-      # @param [String] message API response error message.
-      # @return [Error] an instance of {AuthError} or {ServerError}.
-      def self.from_api_response_message(message)
+      def self.from_api_response(code, message)
         error =
-          if message =~ /API key/
+          case code.to_s
+          when /^400/, /^404/
+            QueryError
+          when /^401/, /^402/
             AuthError
           else
             ServerError
           end
 
-        error.new(message)
+        error.new("#{message} (code: #{code})")
       end
     end