algoliasearch-jekyll 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fc07f49e01332879569776774bc13b38b1fa601
-  data.tar.gz: 05bde1d8646bb06eb04049e5fb322d35c86744c2
+  metadata.gz: dc842f3c5823b8a809ffcd12e6d520f15eeefc60
+  data.tar.gz: 3fbfef0340971043048d1e0d71b439a50727e451
 SHA512:
-  metadata.gz: 27a25e5b66d6fbd44450897024bc837de069ae78d1142ad8d12e70def6334f593700299126875ae7bdea4dd8819d5dfee80c5832a7a31332b0d27fde5a611eb9
-  data.tar.gz: cf69b239d17b80fac3af079474b046b929bd5d7582b4e321ad2568b83184ea7f5b24971d62bc895f8206caaa6d2a54c292898e10ac84d8ae7b02763b337c223b
+  metadata.gz: 8b80bcd9875ac15f96fa76a1f2cb676c6b4a38d98be4c30936710f5ffb9e6c9d843ecf9f2af6ee1b2af56cc77afa3c54b9eb8ce0f814ec1392f0df89de5067ae
+  data.tar.gz: 70dc1b288661933a38f5b4845d073985d74f5e7f6dc947799af2c85f2afbdebbad6c9fa732b0c3f5a7538f6f596c8338368aba55982384cd83a78eec8fcb8385

data/CONTRIBUTING.md

@@ -34,6 +34,9 @@ I suggest updating the website `Gemfile` to point to the correct local directory
 ```ruby
 gem "algoliasearch-jekyll", :path => "/path/to/local/gem/folder"
 ```
+You should also run `rake gemspec` from the `algoliasearch-jekyll` repository if
+you added new files or dependencies.
+
 
 If you plan on submitting a PR, I suggest you install the git hooks. This will
 run pre-commit and pre-push checks. Those checks will also be run by TravisCI,

data/Gemfile

@@ -3,8 +3,10 @@ source 'http://rubygems.org'
 gem 'algoliasearch', '~> 1.4'
 gem 'appraisal', '~> 2.1.0'
 gem 'awesome_print', '~> 1.6'
+gem 'jekyll', '~> 2.5'
 gem 'json', '~> 1.8'
 gem 'nokogiri', '~> 1.6'
+gem 'verbal_expressions', '~> 0.1.5'
 
 group :development do
   gem 'coveralls', '~> 0.8'

data/Guardfile

@@ -1,17 +1,7 @@
-group :jekyll_v3 do
-  guard :rspec, cmd: 'appraisal jekyll-v3 bundle exec rspec --color --format documentation' do
-    watch(%r{^spec/.+_spec\.rb$})
-    watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
-    watch('spec/spec_helper.rb')  { 'spec' }
-  end
-end
-
-group :jekyll_v2 do
-  guard :rspec, cmd: 'appraisal jekyll-v2 bundle exec rspec --color --format documentation' do
-    watch(%r{^spec/.+_spec\.rb$})
-    watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
-    watch('spec/spec_helper.rb')  { 'spec' }
-  end
+guard :rspec, cmd: 'bundle exec rspec --color --format documentation' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
 end
 
 notification :off

data/README.md

@@ -4,6 +4,7 @@
 [![Build Status][2]](https://travis-ci.org/algolia/algoliasearch-jekyll)
 [![Coverage Status][3]](https://coveralls.io/github/algolia/algoliasearch-jekyll?branch=master)
 [![Code Climate][4]](https://codeclimate.com/github/algolia/algoliasearch-jekyll)
+![Jekyll >= 2.5](https://img.shields.io/badge/jekyll-%3E%3D%202.5-green.svg)
 
 Jekyll plugin to automatically index your Jekyll posts and pages into an
 Algolia index by simply running `jekyll algolia push`.

data/algoliasearch-jekyll.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: algoliasearch-jekyll 0.6.0 ruby lib
+# stub: algoliasearch-jekyll 0.6.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch-jekyll"
-  s.version = "0.6.0"
+  s.version = "0.6.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Tim Carry"]
-  s.date = "2016-01-11"
+  s.date = "2016-01-13"
   s.description = "Index all your pages and posts to an Algolia index with `jekyll algolia push`"
   s.email = "tim@pixelastic.com"
   s.extra_rdoc_files = [
@@ -36,12 +36,14 @@ Gem::Specification.new do |s|
     "gemfiles/jekyll_v3.gemfile",
     "lib/algoliasearch-jekyll.rb",
     "lib/credential_checker.rb",
+    "lib/error_handler.rb",
     "lib/push.rb",
     "lib/record_extractor.rb",
     "lib/version.rb",
     "scripts/bump_version",
     "scripts/check_flay",
     "scripts/check_flog",
+    "scripts/coverage",
     "scripts/git_hooks/pre-commit",
     "scripts/git_hooks/pre-push",
     "scripts/release",
@@ -53,6 +55,7 @@ Gem::Specification.new do |s|
     "scripts/watch_v2",
     "scripts/watch_v3",
     "spec/credential_checker_spec.rb",
+    "spec/error_handler_spec.rb",
     "spec/fixtures/jekyll_version_2/_config.yml",
     "spec/fixtures/jekyll_version_2/_layouts/default.html",
     "spec/fixtures/jekyll_version_2/_my-collection/collection-item.html",
@@ -89,7 +92,9 @@ Gem::Specification.new do |s|
     "spec/spec_helper_simplecov.rb",
     "txt/api_key_missing",
     "txt/application_id_missing",
-    "txt/index_name_missing"
+    "txt/check_key_acl_to_tmp_index",
+    "txt/index_name_missing",
+    "txt/sample"
   ]
   s.homepage = "https://github.com/algolia/algoliasearch-jekyll"
   s.licenses = ["MIT"]
@@ -103,8 +108,10 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<algoliasearch>, ["~> 1.4"])
       s.add_runtime_dependency(%q<appraisal>, ["~> 2.1.0"])
       s.add_runtime_dependency(%q<awesome_print>, ["~> 1.6"])
+      s.add_runtime_dependency(%q<jekyll>, ["~> 2.5"])
       s.add_runtime_dependency(%q<json>, ["~> 1.8"])
       s.add_runtime_dependency(%q<nokogiri>, ["~> 1.6"])
+      s.add_runtime_dependency(%q<verbal_expressions>, ["~> 0.1.5"])
       s.add_development_dependency(%q<coveralls>, ["~> 0.8"])
       s.add_development_dependency(%q<flay>, ["~> 2.6"])
       s.add_development_dependency(%q<flog>, ["~> 4.3"])
@@ -117,8 +124,10 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<algoliasearch>, ["~> 1.4"])
       s.add_dependency(%q<appraisal>, ["~> 2.1.0"])
       s.add_dependency(%q<awesome_print>, ["~> 1.6"])
+      s.add_dependency(%q<jekyll>, ["~> 2.5"])
       s.add_dependency(%q<json>, ["~> 1.8"])
       s.add_dependency(%q<nokogiri>, ["~> 1.6"])
+      s.add_dependency(%q<verbal_expressions>, ["~> 0.1.5"])
       s.add_dependency(%q<coveralls>, ["~> 0.8"])
       s.add_dependency(%q<flay>, ["~> 2.6"])
       s.add_dependency(%q<flog>, ["~> 4.3"])
@@ -132,8 +141,10 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<algoliasearch>, ["~> 1.4"])
     s.add_dependency(%q<appraisal>, ["~> 2.1.0"])
     s.add_dependency(%q<awesome_print>, ["~> 1.6"])
+    s.add_dependency(%q<jekyll>, ["~> 2.5"])
     s.add_dependency(%q<json>, ["~> 1.8"])
     s.add_dependency(%q<nokogiri>, ["~> 1.6"])
+    s.add_dependency(%q<verbal_expressions>, ["~> 0.1.5"])
     s.add_dependency(%q<coveralls>, ["~> 0.8"])
     s.add_dependency(%q<flay>, ["~> 2.6"])
     s.add_dependency(%q<flog>, ["~> 4.3"])

data/gemfiles/jekyll_v2.gemfile

@@ -5,9 +5,10 @@ source "http://rubygems.org"
 gem "algoliasearch", "~> 1.4"
 gem "appraisal", "~> 2.1.0"
 gem "awesome_print", "~> 1.6"
+gem "jekyll", "~> 2.5"
 gem "json", "~> 1.8"
 gem "nokogiri", "~> 1.6"
-gem "jekyll", "~> 2.5"
+gem "verbal_expressions", "~> 0.1.5"
 
 group :development do
   gem "coveralls", "~> 0.8"

data/gemfiles/jekyll_v3.gemfile

@@ -5,9 +5,10 @@ source "http://rubygems.org"
 gem "algoliasearch", "~> 1.4"
 gem "appraisal", "~> 2.1.0"
 gem "awesome_print", "~> 1.6"
+gem "jekyll", "~> 3.0"
 gem "json", "~> 1.8"
 gem "nokogiri", "~> 1.6"
-gem "jekyll", "~> 3.0"
+gem "verbal_expressions", "~> 0.1.5"
 gem "jekyll-paginate", "~> 1.1.0"
 
 group :development do

data/lib/credential_checker.rb

@@ -1,13 +1,15 @@
 require 'algoliasearch'
 require 'nokogiri'
 require 'json'
+require_relative './error_handler.rb'
 
 # Given an HTML file as input, will return an array of records to index
 class AlgoliaSearchCredentialChecker
-  attr_accessor :config
+  attr_accessor :config, :logger
 
   def initialize(config)
     @config = config
+    @logger = AlgoliaSearchErrorHandler.new
   end
 
   # Read the API key either from ENV or from an _algolia_api_key file in
@@ -24,36 +26,24 @@ class AlgoliaSearchCredentialChecker
     nil
   end
 
-  def display_error(file)
-    file = File.expand_path(File.join(File.dirname(__FILE__), '../txt', file))
-    content = File.open(file).readlines.map(&:chomp)
-    content.each_with_index do |line, index|
-      if index == 0
-        Jekyll.logger.error line
-        next
-      end
-      Jekyll.logger.warn line
-    end
-  end
-
   # Check that the API key is available
   def check_api_key
     return if api_key
-    display_error('api_key_missing')
+    @logger.display('api_key_missing')
     exit 1
   end
 
   # Check that the application id is defined
   def check_application_id
     return if @config['algolia'] && @config['algolia']['application_id']
-    display_error('application_id_missing')
+    @logger.display('application_id_missing')
     exit 1
   end
 
   # Check that the index name is defined
   def check_index_name
     return if @config['algolia'] && @config['algolia']['index_name']
-    display_error('index_name_missing')
+    @logger.display('index_name_missing')
     exit 1
   end
 

data/lib/error_handler.rb

@@ -0,0 +1,87 @@
+require 'json'
+require 'verbal_expressions'
+
+# Helps in displaying useful error messages to users, to help them debug their
+# issues
+class AlgoliaSearchErrorHandler
+  # Will output the specified error file.
+  # First line is displayed as error, next ones as warning
+  def display(file)
+    file = File.expand_path(File.join(File.dirname(__FILE__), '../txt', file))
+    content = File.open(file).readlines.map(&:chomp)
+    content.each_with_index do |line, index|
+      if index == 0
+        Jekyll.logger.error line
+        next
+      end
+      Jekyll.logger.warn line
+    end
+  end
+
+  def error_tester
+    # Ex: Cannot PUT to https://appid.algolia.net/1/indexes/index_name/settings:
+    # {"message":"Invalid Application-ID or API key","status":403} (403)
+    VerEx.new do
+      find 'Cannot '
+      capture('verb') { word }
+      find ' to '
+      capture('scheme') { word }
+      find '://'
+      capture('app_id') { word }
+      anything_but '/'
+      find '/'
+      capture('api_version') { digit }
+      find '/'
+      capture('api_section') { word }
+      find '/'
+      capture('index_name') { word }
+      find '/'
+      capture('api_action') { word }
+      find ': '
+      capture('json') do
+        find '{'
+        anything_but('}')
+        find '}'
+      end
+      find ' ('
+      capture('http_error') { word }
+      find ')'
+    end
+  end
+
+  def parse_algolia_error(error)
+    error.gsub!("\n", '')
+
+    tester = error_tester
+    matches = tester.match(error)
+
+    return false unless matches
+
+    hash = {}
+    matches.names.each do |match|
+      hash[match] = matches[match]
+    end
+
+    # Cast integers
+    hash['api_version'] = hash['api_version'].to_i
+    hash['http_error'] = hash['http_error'].to_i
+
+    # Parse JSON
+    hash['json'] = JSON.parse(hash['json'])
+
+    hash
+  end
+
+  # Given an Algolia API error message, will return the best error message
+  def readable_algolia_error(error)
+    error = parse_algolia_error(error)
+    return false unless error
+
+    # Given API key does not have rights on the _tmp index
+    if error['http_error'] == 403 && error['index_name'] =~ /_tmp$/
+      return 'check_key_acl_to_tmp_index'
+    end
+
+    false
+  end
+end

data/lib/push.rb

@@ -4,6 +4,7 @@ require 'json'
 require_relative './version'
 require_relative './record_extractor'
 require_relative './credential_checker'
+require_relative './error_handler'
 
 # `jekyll algolia push` command
 class AlgoliaSearchJekyllPush < Jekyll::Command
@@ -126,7 +127,25 @@ class AlgoliaSearchJekyllPush < Jekyll::Command
         end
       end
 
-      index.set_settings(settings)
+      begin
+        index.set_settings(settings)
+      rescue StandardError => error
+        display_error(error)
+        exit 1
+      end
+    end
+
+    # Display the error in a human-friendly way if possible
+    def display_error(error)
+      error_handler = AlgoliaSearchErrorHandler.new
+      readable_error = error_handler.readable_algolia_error(error.message)
+
+      if readable_error
+        error_handler.display(readable_error)
+      else
+        Jekyll.logger.error 'Algolia Error: HTTP Error'
+        Jekyll.logger.warn error.message
+      end
     end
 
     # Change the User-Agent header to isolate calls from this plugin
@@ -150,8 +169,7 @@ class AlgoliaSearchJekyllPush < Jekyll::Command
         begin
           index.add_objects!(batch) unless @is_dry_run
         rescue StandardError => error
-          Jekyll.logger.error 'Algolia Error: HTTP Error'
-          Jekyll.logger.warn error.message
+          display_error(error)
           exit 1
         end
       end

data/lib/version.rb

@@ -1,6 +1,6 @@
 # Expose gem version
 class AlgoliaSearchJekyllVersion
   def self.to_s
-    '0.6.0'
+    '0.6.1'
   end
 end

data/scripts/coverage

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+COVERAGE=1 appraisal jekyll-v2 bundle exec rspec

data/scripts/test_ci

@@ -4,4 +4,4 @@
 # worrying about appraisal
 cd "$(dirname "$BASH_SOURCE")"/..
 
-bundle exec rspec
+COVERAGE=1 bundle exec rspec

data/scripts/test_v2

@@ -2,4 +2,4 @@
 cd "$(dirname "$BASH_SOURCE")"/..
 
 echo "Testing under Jekyll 2.5"
-appraisal jekyll-v2 bundle exec rspec
+COVERAGE=1 appraisal jekyll-v2 bundle exec rspec

data/scripts/test_v3

@@ -2,5 +2,5 @@
 cd "$(dirname "$BASH_SOURCE")"/..
 
 echo "Testing under Jekyll 3.0"
-appraisal jekyll-v3 bundle exec rspec
+COVERAGE=1 appraisal jekyll-v3 bundle exec rspec
 

data/scripts/watch

@@ -1,4 +1,4 @@
 #!/usr/bin/env bash
 cd "$(dirname "$BASH_SOURCE")"/..
 
-guard -g jekyll_v2
+appraisal jekyll-v2 guard 

data/scripts/watch_v2

@@ -1,4 +1,4 @@
 #!/usr/bin/env bash
 cd "$(dirname "$BASH_SOURCE")"/..
 
-guard -g jekyll_v2
+appraisal jekyll-v2 guard 

data/scripts/watch_v3

@@ -1,4 +1,4 @@
 #!/usr/bin/env bash
 cd "$(dirname "$BASH_SOURCE")"/..
 
-guard -g jekyll_v3
+appraisal jekyll-v3 guard 

data/spec/credential_checker_spec.rb

@@ -60,14 +60,16 @@ describe(AlgoliaSearchCredentialChecker) do
   end
 
   describe 'assert_valid' do
+    before(:each) do
+      allow(checker.logger).to receive(:display)
+    end
     it 'should display error if no api key' do
       # Given
-      allow(checker).to receive(:api_key) { nil }
+      allow(checker).to receive(:api_key).and_return nil
 
       # Then
-      expect(Jekyll.logger).to receive(:error).with(/api key/i)
-      expect(Jekyll.logger).to receive(:warn).at_least(:once)
       expect(-> { checker.assert_valid }).to raise_error SystemExit
+      expect(checker.logger).to have_received(:display).with('api_key_missing')
     end
 
     it 'should display error if no application id' do
@@ -79,9 +81,10 @@ describe(AlgoliaSearchCredentialChecker) do
       stub_const('ENV', 'ALGOLIA_API_KEY' => 'APIKEY_FROM_ENV')
 
       # Then
-      expect(Jekyll.logger).to receive(:error).with(/application id/i)
-      expect(Jekyll.logger).to receive(:warn).at_least(:once)
       expect(-> { checker.assert_valid }).to raise_error SystemExit
+      expect(checker.logger)
+        .to have_received(:display)
+        .with('application_id_missing')
     end
 
     it 'should display error if no index name' do
@@ -93,9 +96,10 @@ describe(AlgoliaSearchCredentialChecker) do
       stub_const('ENV', 'ALGOLIA_API_KEY' => 'APIKEY_FROM_ENV')
 
       # Then
-      expect(Jekyll.logger).to receive(:error).with(/index name/i)
-      expect(Jekyll.logger).to receive(:warn).at_least(:once)
       expect(-> { checker.assert_valid }).to raise_error SystemExit
+      expect(checker.logger)
+        .to have_received(:display)
+        .with('index_name_missing')
     end
 
     it 'should init the Algolia client' do

data/spec/error_handler_spec.rb

@@ -0,0 +1,150 @@
+require 'spec_helper'
+
+describe(AlgoliaSearchErrorHandler) do
+  before(:each) do
+    @error_handler = AlgoliaSearchErrorHandler.new
+  end
+
+  describe 'display' do
+    before(:each) do
+      allow(Jekyll.logger).to receive(:error)
+      allow(Jekyll.logger).to receive(:warn)
+    end
+
+    it 'should display first line as error' do
+      # Given
+      input = 'sample'
+
+      # When
+      @error_handler.display(input)
+
+      # Then
+      expect(Jekyll.logger).to have_received(:error).exactly(1).times
+    end
+
+    it 'should display all other lines as warnings' do
+      # Given
+      input = 'sample'
+
+      # When
+      @error_handler.display(input)
+
+      # Then
+      expect(Jekyll.logger).to have_received(:warn).exactly(3).times
+    end
+  end
+
+  describe 'parse_algolia_error' do
+    before(:each) do
+      @algolia_error = 'Cannot PUT to ' \
+        'https://appid.algolia.net/1/indexes/index_name/settings: ' \
+        '{"message":"Invalid Application-ID or API key","status":403} (403)'
+    end
+
+    it 'should extract all the url parts' do
+      # Given
+      input = @algolia_error
+
+      # When
+      actual = @error_handler.parse_algolia_error(input)
+
+      # Then
+      expect(actual['verb']).to eq 'PUT'
+      expect(actual['scheme']).to eq 'https'
+      expect(actual['app_id']).to eq 'appid'
+      expect(actual['api_section']).to eq 'indexes'
+      expect(actual['index_name']).to eq 'index_name'
+      expect(actual['api_action']).to eq 'settings'
+    end
+
+    it 'should cast integers to integers' do
+      # Given
+      input = @algolia_error
+
+      # When
+      actual = @error_handler.parse_algolia_error(input)
+
+      # Then
+      expect(actual['api_version']).to eq 1
+      expect(actual['http_error']).to eq 403
+    end
+
+    it 'should parse the JSON part' do
+      # Given
+      input = @algolia_error
+
+      # When
+      actual = @error_handler.parse_algolia_error(input)
+
+      # Then
+      expect(actual['json']).to be_a(Hash)
+      expect(actual['json']['status']).to eq 403
+    end
+
+    it 'should return false if this is not parsable' do
+      # Given
+      input = 'foo bar baz'
+
+      # When
+      actual = @error_handler.parse_algolia_error(input)
+
+      # Then
+      expect(actual).to eq(false)
+    end
+
+    it 'should work on multiline errors' do
+      # Given
+      input = @algolia_error.gsub('}', "}\n")
+
+      # When
+      actual = @error_handler.parse_algolia_error(input)
+
+      # Then
+      expect(actual).to be_a(Hash)
+      expect(actual['http_error']).to eq 403
+    end
+  end
+
+  describe 'readable_algolia_error' do
+    it 'should warn about key ACL' do
+      # Given
+      parsed = {
+        'http_error' => 403,
+        'index_name' => 'something_tmp'
+      }
+      allow(@error_handler).to receive(:parse_algolia_error).and_return(parsed)
+
+      # When
+      actual = @error_handler.readable_algolia_error('error')
+
+      # Then
+      expect(actual).to eq('check_key_acl_to_tmp_index')
+    end
+
+    it 'should return false if no nice message found' do
+      # Given
+      parsed = false
+      allow(@error_handler).to receive(:parse_algolia_error).and_return(parsed)
+
+      # When
+      actual = @error_handler.readable_algolia_error('error')
+
+      # Then
+      expect(actual).to eq(false)
+    end
+
+    it 'should return false if message does not match any known case' do
+      # Given
+      parsed = {
+        'http_error' => 42
+      }
+      allow(@error_handler).to receive(:parse_algolia_error).and_return(parsed)
+
+      # When
+      actual = @error_handler.readable_algolia_error('error')
+
+      # Then
+      expect(actual).to eq(false)
+    end
+  end
+end

data/spec/push_spec.rb

@@ -140,6 +140,66 @@ describe(AlgoliaSearchJekyllPush) do
       # When
       push.configure_index(index)
     end
+
+    describe 'throw an error' do
+      before(:each) do
+        @index_double = double('Algolia Index').as_null_object
+        @error_handler_double = double('Error Handler double').as_null_object
+        push.init_options(nil, {}, {})
+        allow(@index_double).to receive(:set_settings).and_raise
+        allow(Jekyll.logger).to receive(:error)
+      end
+
+      it 'stops if API throw an error' do
+        # Given
+
+        # When
+
+        # Then
+        expect(-> { push.configure_index(@index_double) })
+          .to raise_error SystemExit
+      end
+
+      it 'displays the error directly if unknown' do
+        # Given
+        allow(@error_handler_double)
+          .to receive(:readable_algolia_error).and_return false
+        allow(@error_handler_double)
+          .to receive(:display)
+        allow(AlgoliaSearchErrorHandler)
+          .to receive(:new).and_return(@error_handler_double)
+
+        # When
+
+        # Then
+        expect(-> { push.configure_index(@index_double) })
+          .to raise_error SystemExit
+        expect(@error_handler_double)
+          .to have_received(:display).exactly(0).times
+        expect(Jekyll.logger)
+          .to have_received(:error).with('Algolia Error: HTTP Error')
+      end
+
+      it 'display a human readable version of the error if one is found' do
+        # Given
+        allow(@error_handler_double)
+          .to receive(:readable_algolia_error).and_return 'known_errors'
+        allow(@error_handler_double)
+          .to receive(:display)
+        allow(AlgoliaSearchErrorHandler)
+          .to receive(:new).and_return(@error_handler_double)
+
+        # When
+
+        # Then
+        expect(-> { push.configure_index(@index_double) })
+          .to raise_error SystemExit
+        expect(@error_handler_double)
+          .to have_received(:display)
+          .exactly(1).times
+          .with('known_errors')
+      end
+    end
   end
 
   describe 'jekyll_new' do
@@ -272,7 +332,6 @@ describe(AlgoliaSearchJekyllPush) do
     end
 
     it 'should display an error if `add_objects!` failed' do
-      # Given
       allow(index_double).to receive(:add_objects!).and_raise
 
       expect(Jekyll.logger).to receive(:error)

data/spec/spec_helper.rb

@@ -10,6 +10,7 @@ require './lib/push.rb'
 
 RSpec.configure do |config|
   config.filter_run(focus: true)
+  config.fail_fast = true
   config.run_all_when_everything_filtered = true
 end
 

data/txt/check_key_acl_to_tmp_index

@@ -0,0 +1,9 @@
+Algolia Error: API key cannot write to `{index_name}_tmp` index
+  In order to do atomic pushes to your Algolia index, the plugin first pushes to
+  a temporary index (suffixed with `_tmp`), then renames it.
+
+  You see this error because the plugin wasn't able to push to that 
+  `{index_name}_tmp` index, with the API key you provided.
+
+  Make sure the API key you're using has rights to write on both your index and
+  its `{index_name}_tmp` suffixed version.

data/txt/sample

@@ -0,0 +1,4 @@
+Algolia Error: Sample Error
+This is where you can explain the error and:
+    - one way to fix it
+    - or another way to fix it

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-jekyll
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Tim Carry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-11 00:00:00.000000000 Z
+date: 2016-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: algoliasearch
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: verbal_expressions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -218,12 +246,14 @@ files:
 - gemfiles/jekyll_v3.gemfile
 - lib/algoliasearch-jekyll.rb
 - lib/credential_checker.rb
+- lib/error_handler.rb
 - lib/push.rb
 - lib/record_extractor.rb
 - lib/version.rb
 - scripts/bump_version
 - scripts/check_flay
 - scripts/check_flog
+- scripts/coverage
 - scripts/git_hooks/pre-commit
 - scripts/git_hooks/pre-push
 - scripts/release
@@ -235,6 +265,7 @@ files:
 - scripts/watch_v2
 - scripts/watch_v3
 - spec/credential_checker_spec.rb
+- spec/error_handler_spec.rb
 - spec/fixtures/jekyll_version_2/_config.yml
 - spec/fixtures/jekyll_version_2/_layouts/default.html
 - spec/fixtures/jekyll_version_2/_my-collection/collection-item.html
@@ -271,7 +302,9 @@ files:
 - spec/spec_helper_simplecov.rb
 - txt/api_key_missing
 - txt/application_id_missing
+- txt/check_key_acl_to_tmp_index
 - txt/index_name_missing
+- txt/sample
 homepage: https://github.com/algolia/algoliasearch-jekyll
 licenses:
 - MIT