twingly-search 5.1.2 → 5.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3a75dac8aa30248ac63076961aed966d93bcb512
-  data.tar.gz: 1c777949aa160f64333d2b70873b6c1bc73fd3e9
+SHA256:
+  metadata.gz: f451d6c6e8102959e734c8376276e3d8a702155d7cd4e9e13e8b8d943310a7d4
+  data.tar.gz: 9b13fa23f12b24625b4f25a692e4c21c4fabb82e92e5fcefe24f5e85cb37129c
 SHA512:
-  metadata.gz: 6311e1a9faa3dabbd1f517370ab2e5efadb736bdbfc20fe7d93480b930ebeb35471eebfb0d006c7d95097c4e70d78d9ea4de20aed30706edfbcfb66ebe8ab4b6
-  data.tar.gz: 9fb8ec55a381bf78d234ec587e66893284187aee3a0960540a7a7f9675893218c35dae286df969f2595d0ca19510dcbf6f7b329f656fd216d82acde9d1b4e5a3
+  metadata.gz: 9564dd967b087fae002747d0425d3fc3afe27f351d77da2087bfdca4c3846e1c957dfb3995a429f2fff0a21a7584261adb26508844795de0642c417629ae2813
+  data.tar.gz: e369bac91125a4a89d1b1644325c251f25a11047638db92d42b45aef6b727dc6c0eb8fe1700d267914f0b02574648b79122d75b1efb912540cdc6a34375f1179

data/.github/workflows/ci-build-and-install-gem.yml

@@ -0,0 +1,21 @@
+name: CI build and install gem
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-18.04
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+
+    - name: Build and install gem
+      run: gem build *.gemspec && gem install *.gem

data/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-18.04
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5.8, 2.6.6, 2.7.2, jruby-9.2.13.0]
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Setup Ruby ${{ matrix.ruby }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,63 @@
 # Change Log
 
+## [v5.3.0](https://github.com/twingly/twingly-search-api-ruby/tree/v5.3.0) (2019-04-03)
+[Full Changelog](https://github.com/twingly/twingly-search-api-ruby/compare/v5.2.0...v5.3.0)
+
+**Implemented enhancements:**
+
+- Differentiate between 401 and 402 status codes [\#80](https://github.com/twingly/twingly-search-api-ruby/issues/80)
+- Low hanging fruit that would reduce memory consumption [\#75](https://github.com/twingly/twingly-search-api-ruby/issues/75)
+- Add fixture for "Invalid language code\(s\)" [\#56](https://github.com/twingly/twingly-search-api-ruby/issues/56)
+
+**Fixed bugs:**
+
+- Inconsistent formating in Result\#inspect [\#79](https://github.com/twingly/twingly-search-api-ruby/issues/79)
+- Uninitialized variable warnings [\#76](https://github.com/twingly/twingly-search-api-ruby/issues/76)
+
+**Merged pull requests:**
+
+- Drop support for older Rubies [\#87](https://github.com/twingly/twingly-search-api-ruby/pull/87) ([walro](https://github.com/walro))
+- AuthError -\> AuthenticationError/AuthorizationError [\#86](https://github.com/twingly/twingly-search-api-ruby/pull/86) ([jage](https://github.com/jage))
+- Travis for modern Rubies [\#85](https://github.com/twingly/twingly-search-api-ruby/pull/85) ([jage](https://github.com/jage))
+- Profile for object allocation and pick some fruit [\#84](https://github.com/twingly/twingly-search-api-ruby/pull/84) ([jage](https://github.com/jage))
+- Improve Result\#inspect output [\#83](https://github.com/twingly/twingly-search-api-ruby/pull/83) ([jage](https://github.com/jage))
+- Initialize variables to avoid warnings [\#82](https://github.com/twingly/twingly-search-api-ruby/pull/82) ([jage](https://github.com/jage))
+- Remove deprecated Query\#language usage in example [\#81](https://github.com/twingly/twingly-search-api-ruby/pull/81) ([jage](https://github.com/jage))
+
+## [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)
+
+**Implemented enhancements:**
+
+- Looser requirement on Faraday [\#70](https://github.com/twingly/twingly-search-api-ruby/issues/70)
+
+**Fixed bugs:**
+
+- Update yard gem dependency [\#72](https://github.com/twingly/twingly-search-api-ruby/issues/72)
+
+**Merged pull requests:**
+
+- Looser requirements on Faraday [\#74](https://github.com/twingly/twingly-search-api-ruby/pull/74) ([jage](https://github.com/jage))
+- Test with latest Ruby versions [\#73](https://github.com/twingly/twingly-search-api-ruby/pull/73) ([dentarg](https://github.com/dentarg))
+- Test with latest rubies, support Ruby 2.4 and JRuby 9.1 [\#71](https://github.com/twingly/twingly-search-api-ruby/pull/71) ([walro](https://github.com/walro))
+
+## [v5.1.3](https://github.com/twingly/twingly-search-api-ruby/tree/v5.1.3) (2017-10-16)
+[Full Changelog](https://github.com/twingly/twingly-search-api-ruby/compare/v5.1.2...v5.1.3)
+
+**Merged pull requests:**
+
+- Revert "Include timezone info for timestamps in search query" [\#69](https://github.com/twingly/twingly-search-api-ruby/pull/69) ([walro](https://github.com/walro))
+
+## [v5.1.2](https://github.com/twingly/twingly-search-api-ruby/tree/v5.1.2) (2017-05-29)
+[Full Changelog](https://github.com/twingly/twingly-search-api-ruby/compare/v5.1.1...v5.1.2)
+
 ## [v5.1.1](https://github.com/twingly/twingly-search-api-ruby/tree/v5.1.1) (2017-05-17)
 [Full Changelog](https://github.com/twingly/twingly-search-api-ruby/compare/v5.1.0...v5.1.1)
 

data/README.md

@@ -1,6 +1,6 @@
 # Twingly Search API Ruby
 
-[![Build Status](https://travis-ci.org/twingly/twingly-search-api-ruby.png?branch=master)](https://travis-ci.org/twingly/twingly-search-api-ruby)
+[![GitHub Build Status](https://github.com/twingly/twingly-search-api-ruby/workflows/CI/badge.svg?branch=master)](https://github.com/twingly/twingly-search-api-ruby/actions)
 [![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 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].
@@ -27,7 +27,7 @@ To learn more about the features of this gem, read the [gem documentation] or ch
 
 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
+[gem documentation]: https://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/
 
@@ -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
-  * JRuby 9000
+  * Ruby >= 2.5
+  * JRuby >= 9.2
 
 ## Development
 
@@ -88,9 +88,19 @@ 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.
+1. Ensure you are signed in to RubyGems.org as [twingly][twingly-rubygems] with `gem signin`.
 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 `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.
@@ -106,4 +116,5 @@ 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/
+[YARD]: https://yardoc.org/
+[twingly-rubygems]: https://rubygems.org/profiles/twingly

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'))
@@ -61,6 +65,32 @@ module Twingly
         @blog_rank     = params.fetch('blogRank').to_i
         @authority     = params.fetch('authority').to_i
       end
+
+      # @return [Hash] a hash containing all post attributes.
+      def to_h
+        {
+          id: @id,
+          author: @author,
+          url: @url,
+          title: @title,
+          text: @text,
+          language_code: @language_code,
+          location_code: @location_code,
+          coordinates: @coordinates,
+          links: @links,
+          tags: @tags,
+          images: @images,
+          indexed_at: @indexed_at,
+          published_at: @published_at,
+          reindexed_at: @reindexed_at,
+          inlinks_count: @inlinks_count,
+          blog_id: @blog_id,
+          blog_name: @blog_name,
+          blog_url: @blog_url,
+          blog_rank: @blog_rank,
+          authority: @authority,
+        }
+      end
     end
   end
 end

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.0.1"
+    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