flying-sphinx 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e456647fed387b52501630a4ccfcbb68997dac89175eb6f4d774373f4022cfe
-  data.tar.gz: 06ebf9bd4a0c560f1df0892c58d36cab1b19d4571e47d37cd9ff16d32bfd3096
+  metadata.gz: e9e14e5453c49da728c4c1a6fcd73d3bb69f9757346d389118a83f2e637f8d02
+  data.tar.gz: a03b95890d0fbe8d5ecf8c9a4254bbb419ee06fc28f722fc1c90d4e7d3d21db3
 SHA512:
-  metadata.gz: 6de104433df80fe158a321f122ab4d745b455e3132da6d4fac4a14d65d5dab481ce01b5992882c7216746856e93a7f6b5afc9422ab8f31d59fc89f329410bd64
-  data.tar.gz: b8a333189a913fbc7011c63fa12f8d9c1c39037f22c00dc61d6bf77836e86107dd8f31a38b3867040410f8b480851b16b07b55829514fa3b7b4f7a1cc5a3ae73
+  metadata.gz: d2e2893b492f73235a30acfe70c3aab0958beca8f495606e0da53f743b17bf7869c2b2178ae2cff97fa3c4cc7496d88bb2fc0472a24b3d4d81a11291f12c4763
+  data.tar.gz: 1d7280b6f9b55632436a5665098bc77abe9f2ec859b4fe7073449953d451a8b89c9a2af6c4786a9041a6af29660b5169c2c6f36599cb12a4b4a46a06f72fe925

data/{HISTORY → CHANGELOG.markdown}

@@ -1,149 +1,282 @@
-2.0.0 - 10th April 2018
-* Add support for Manticore (via engine setting in config/thinking_sphinx.yml).
-* Drop support for Thinking Sphinx 3.x or older.
-* Drop support for ActiveRecord/Rails 3.1 or older.
-* Drop support for Ruby 2.1 or older.
-* Deprecate fs tasks and the flying-sphinx CLI tool.
-* Use Thinking Sphinx v4's new task/command architecture, and so all the ts rake tasks perform the appropriate behaviour on Flying Sphinx.
-
-1.3.1 - 4th December 2017
+# Changelog
+
+All notable changes to this project (at least, from v0.4.0 onwards) are documented in this file.
+
+## 2.1.0 - 2018-04-20
+
+### Added
+
+* Check Sphinx/Manticore version against what's available on the Flying Sphinx servers as part of the configuration process.
+
+### Changed
+
+* Update gzipped_tar dependency.
+
+## 2.0.0 - 2018-04-10
+
+### Added
+
+* Add support for Manticore (via `engine` setting in config/thinking_sphinx.yml).
+* Using Thinking Sphinx v4's new task/command architecture, and so all the ts rake tasks perform the appropriate behaviour on Flying Sphinx.
+
+### Changed
+
+* Dropped support for Thinking Sphinx 3.x or older.
+* Dropped support for ActiveRecord/Rails 3.1 or older.
+* Dropped support for Ruby 2.1 or older.
+
+### Deprecated
+
+* The fs tasks and the flying-sphinx CLI tool are deprecated and will be removed in a future release. Please use the standard Thinking Sphinx ts rake tasks instead.
+
+## 1.3.1 - 2017-12-04
+
+### Fixed
+
 * Fix call to generate real-time data for thinking-sphinx v3.4+.
 
-1.3.0 - 4th December 2017
-* Use v5 of the flying-sphinx.com API.
-* Drop support for Ruby 1.8.7 and REE.
+## 1.3.0 - 2017-12-04
+
+### Changed
+
+* Using v5 of the flying-sphinx.com API.
+* Dropping support for Ruby 1.8.7 and REE.
 * Be clear about the reliance on thinking-sphinx v1.5 or better.
 
-1.2.1 - 29th September 2017
-* Fix population of real-time indices for thinking-sphinx v3.4+.
+## 1.2.1 - 2017-09-29
+
+### Changed
+
 * Remove post-install message.
 * Relax Faraday requirement to allow for v0.7.
 * Improved behaviour with Ruby 1.8.7.
 
-1.2.0 - 30th March 2014
+### Fixed
+
+* Fix population of real-time indices for thinking-sphinx v3.4+.
+
+## 1.2.0 - 2014-03-30
+
+### Changed
+
 * All configuration files (Sphinx, wordforms, exceptions, etc) are now gzipped when sent to the API.
 
-1.1.0 - 15th March 2014
-* Updated Faraday dependency to require 0.9 or newer (and removed faraday_middleware dependency).
+## 1.1.0 - 2014-03-15
+
+### Added
+
 * Added remote rotate support via custom controller.
 * Added regenerate command (for when real-time indices are being used).
+
+### Changed
+
+* Updated Faraday dependency to require 0.9 or newer (and removed faraday_middleware dependency).
 * Removed the requirement of Rashie.
 
-1.0.0 - 7th May 2013
+## 1.0.0 - 2013-05-07
+
+### Changed
+
 * Updating Riddle dependency to >= 1.5.6.
 * Support for Thinking Sphinx v1/2/3.
 * Delayed Job support pushed back to ts-delayed-delta.
 * Updating MultiJson dependency to ensure MultiJson.load is always available.
 * All actions are now tracked through Pusher, instead of polling or using slow HTTP requests.
 
-0.8.5 - 10th December 2012
+## 0.8.5 - 2012-12-10
+
+### Changed
+
 * Daemon actions (start/stop) are now asynchronous.
 * More forgiving when environment variables aren't around. Particularly helpful for Padrino and Sinatra.
 * Make delta indexing jobs asynchronous - no need to wait for the result. Also, with the different URL, flying-sphinx.com will not queue up duplicate delta jobs within the last 20 minutes if there's a indexing job still pending.
 
-0.8.4 - 22nd September 2012
+## 0.8.4 - 2012-09-22
+
+### Fixed
+
 * Load the Delta class when loading Rails.
 
-0.8.3 - 17th September 2012
+## 0.8.3 - 2012-09-17
+
+### Changed
+
 * Requires Rails 3 or better (if you're using Rails).
 * Load Rails when configuring.
 * Don't check whether a document exists before marking it as deleted - Sphinx handles this gracefully anyway.
 
-0.8.2 - 28th August 2012
+## 0.8.2 - 2012-08-28
+
+### Changed
+
 * Don't presume there is a Time.zone method (for Rails 2.3).
 * Set client key as part of the configuration generation process (for Rails 2.3).
 
-0.8.1 - 28th August 2012
+## 0.8.1 - 2012-08-28
+
+### Changed
+
 * Load Thinking Sphinx when sending a generated configuration (as opposed to a hand-written file).
 * Rebuild command now sends the new configuration up, as before.
 
-0.8.0 - 25th August 2012
-* Making the executable the main command entry point.
+## 0.8.0 - 2012-08-25
+
+### Added
+
 * Adding a 'flying-sphinx' executable to match Python and Node.js clients.
+
+### Removed
+
 * Removing support for accessing Heroku's shared databases through an SSH tunnel.
 
-0.7.0 - 16th July 2012
+## 0.7.0 - 2012-07-16
+
+### Changed
+
 * Print the indexing log.
 * Distinguish between search server and SSH/indexing server, which allows for load balancers as the former.
 * Send the gem version through as a header on API calls.
 * Let flying-sphinx.com wrangle the Sphinx configuration.
 * Use v3 of the flying-sphinx.com API
 
-0.6.6 - 14th July 2012
+## 0.6.6 - 2012-07-14
+
+### Changed
+
 * Don't complain about 201s for starting/stopping Sphinx.
 * Relaxing the faraday_middleware dependency to allow 0.8 releases (Matthew Zikherman).
 
-0.6.5 - 3rd May 2012
+## 0.6.5 - 2012-05-03
+
+### Changed
+
 * Relaxing the multi_json dependency to allow for higher versions.
 * Support for staging.flying-sphinx.com.
 
-0.6.4 - 3rd March 2012
+## 0.6.4 - 2012-03-03
+
+### Fixed
+
 * Fix for Rails 2 with API verbose logging.
 
-0.6.3 - 1st March 2012
+## 0.6.3 - 2012-03-01
+
+### Added
+
+* Allow direct database access when FLYING_SPHINX_INGRESS is set.
+
+### Changed
+
 * Slow down polling for direct indexing from every 1 second to every 3 seconds.
 * Verbose logging now has timestamps.
-* Allow direct database access when FLYING_SPHINX_INGRESS is set.
 * Use dups of ENV variables so the values can be modified.
 * Report if Sphinx wasn't able to start.
 * Load Flying Sphinx when ENV['FLYING_SPHINX_IDENTIFIER'] exists, instead of for any Rails environment that isn't development or test.
 
-0.6.2 - 2nd January 2012
+## 0.6.2 - 2012-01-02
+
+### Changed
+
 * Pass Sphinx version through to Flying Sphinx servers.
 
-0.6.1 - 4th November 2011
+## 0.6.1 - 2011-11-04
+
+### Changed
+
 * Adding Riddle dependency requirement.
 * Updating indexes (index plural) references to indices.
 * Updating faraday_middleware version requirement, to play nicely with OmniAuth (Paolo Perrotta)
 
-0.6.0 - 31st July 2011
-* Version in a separate file.
+## 0.6.0 - 2011-07-31
+
+### Added
+
 * Support for all file-based Sphinx settings: stopwords, wordforms, exceptions, and mysql ssl settings for SQL sources.
 
-0.5.2 - 28th July 2011
-* Log SSH exceptions during indexing (when we're being verbose).
+### Changed
+
+* Version in a separate file.
+
+## 0.5.2 - 2011-07-28
+
+### Added
+
 * This history file now exists (pre-populated).
 * An actual README, courtesy of some prodding by Mislav.
 * Added support for wordforms (automatically sent through to the server).
+
+### Changed
+
+* Log SSH exceptions during indexing (when we're being verbose).
 * Don't presume that ENV['DATABASE_URL'] exists - it won't in non-Heroku environments.
 
-0.5.1 - 23rd June 2011
+## 0.5.1 - 2011-06-23
+
+### Added
+
 * Adding rake as a development dependency, just for Travis CI.
+* Sinatra loader (equivalent of a Railtie).
+
+### Changed
+
 * Have a default database port - Cedar stack doesn't set it by default.
 * Allow for newer net-ssh gem versions (including 2.1).
-* Sinatra loader (equivalent of a Railtie).
+
+### Fixed
+
 * Fixed bug for handling JSON always as a Hash (sometimes it's an Array).
 * Better error checking when index requests don't get created as expected.
 
-0.5.0 - 12th May 2011
+## 0.5.0 - 2011-05-12
+
+### Added
+
 * Rake tasks for latest actions and last index log.
-* Switching to version 2 of the API.
 * Adding default rake task for Travis CI.
-* Allow for Rails 2 versions of Delayed Job.
-* Set client_key for connections, configuration if supported by Riddle and Thinking Sphinx.
 * Allow server to automatically close SSH connections.
 * Adding logging on API calls (Josh Kalderimis).
 * Allow for non-tunnelled index requests (for RDS).
+
+### Changed
+
+* Switching to version 2 of the API.
+* Allow for Rails 2 versions of Delayed Job.
+* Set client_key for connections, configuration if supported by Riddle and Thinking Sphinx.
 * Don't use custom database adapter if the database is MySQL.
 * Fall back to environment variables for connection settings.
 * Switching from JSON and HTTParty to MultiJSON and Faraday (Josh Kalderimis).
 * Using Bundler as gem driver instead of Jeweler (Josh Kalderimis).
 * More flexible JSON dependency.
 
-0.4.4 - 7th February 2011
+## 0.4.4 - 2011-02-07
+
+### Changed
+
 * Using ActiveRecord's connection information, as we can't rely on heroku_env.yml to be around.
 
-0.4.3 - 4th February 2011
+## 0.4.3 - 2011-02-04
+
+### Changed
+
 * Wait until the SSH session and forward is prepared before making the index request.
 * If credentials are invalid, raise an appropriate error instead of letting the JSON parsing fail.
 
-0.4.2 - 29th January 2011
+## 0.4.2 - 2011-01-29
+
+### Changed
+
 * Set the Thinking Sphinx database adapter when loaded, instead of requiring the Rails dispatcher to setup.
 
-0.4.1 - 24th January 2011
+## 0.4.1 - 2011-01-24
+
+### Changed
+
 * Comparing against response bodies for consistency (and avoiding HTTParty magic).
 
-0.4.0 - 18th January 2011
+## 0.4.0 - 2011-01-18
+
+### Changed
+
 * Using HTTPS for API calls.
 * Using Flying Sphinx server's account identifier instead of the heroku id from the environment (the latter being unreliable and not part of any official Heroku add-on documentation).
 

data/Gemfile

@@ -1,16 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-if RUBY_VERSION.to_f <= 1.8
-  gem "public_suffix", "< 1.4.0"
-  gem "nokogiri",      "< 1.6.0"
-  gem "activesupport", "< 4.0.0"
-elsif RUBY_VERSION.to_f <= 1.9
-  gem "public_suffix", "< 1.5.0"
-  gem "mime-types",    "< 3.0"
-  gem "nokogiri",      "< 1.7.0"
-elsif RUBY_VERSION.to_f <= 2.0
-  gem "public_suffix", "< 1.5.0"
-  gem "nokogiri",      "< 1.7.0"
-end

data/README.textile

@@ -9,7 +9,7 @@ This is all covered pretty well on "the Flying Sphinx site":http://flying-sphinx
 <pre><code>gem 'flying-sphinx',
   :git    => 'git://github.com/flying-sphinx/flying-sphinx.git',
   :branch => 'master',
-  :ref    => 'e72b86b56a'</code></pre>
+  :ref    => 'da021897c6'</code></pre>
 
 h2. Compatibility and Limitations
 

data/flying-sphinx.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'ey-hmac',            '~> 2.2'
   s.add_runtime_dependency 'faraday',            '>= 0.7'
-  s.add_runtime_dependency 'gzipped_tar',        '~> 0.0.3'
+  s.add_runtime_dependency 'gzipped_tar',        '~> 0.1.1'
   s.add_runtime_dependency 'multi_json',         '>= 1.3.0'
   s.add_runtime_dependency 'pusher-client',      '~> 0.3'
   s.add_runtime_dependency 'thinking-sphinx',    '>= 4.0.0'

data/lib/flying_sphinx/configurer.rb

@@ -1,6 +1,7 @@
 class FlyingSphinx::Configurer
-  PresignatureError = Class.new FlyingSphinx::Error
-  UploadError = Class.new FlyingSphinx::Error
+  InvalidVersionError = Class.new FlyingSphinx::Error
+  PresignatureError   = Class.new FlyingSphinx::Error
+  UploadError         = Class.new FlyingSphinx::Error
 
   def self.call(api, input = nil)
     new(api, input).call
@@ -12,6 +13,11 @@ class FlyingSphinx::Configurer
   end
 
   def call
+    if invalid_version?
+      raise InvalidVersionError,
+        "Unknown Sphinx engine/version: #{config.engine}-#{config.version}"
+    end
+
     if presignature["status"] != "OK"
       raise PresignatureError, "Requesting presignature failed"
     end
@@ -31,6 +37,10 @@ class FlyingSphinx::Configurer
 
   attr_reader :api, :input
 
+  def config
+    @config ||= FlyingSphinx::ConfigurationOptions.new input
+  end
+
   def connection
     Faraday.new(:url => presignature["url"]) do |builder|
       builder.request :multipart
@@ -46,7 +56,6 @@ class FlyingSphinx::Configurer
   end
 
   def file
-    config = FlyingSphinx::ConfigurationOptions.new input
     writer = GZippedTar::Writer.new
 
     writer.add "sphinx/raw.conf",    config.raw
@@ -61,6 +70,10 @@ class FlyingSphinx::Configurer
     StringIO.new writer.output
   end
 
+  def invalid_version?
+    api.get("/versions/#{config.engine}-#{config.version}")["status"] != "OK"
+  end
+
   def presignature
     @presignature ||= api.get "/presignature"
   end

data/lib/flying_sphinx/version.rb

@@ -1,3 +1,3 @@
 module FlyingSphinx
-  Version = '2.0.0'
+  Version = '2.1.0'
 end

data/spec/acceptance/configuring_spec.rb

@@ -16,6 +16,10 @@ describe 'Configuring Sphinx' do
       to_return(
         :body => '{"url":"https://foo","path":"bar","fields":{},"status":"OK"}'
       )
+    stub_hmac_request(
+      :get, "https://flying-sphinx.com/api/my/v5/versions/sphinx-2.2.11"
+    ).to_return(:body => '{"status":"OK"}')
+
     stub_request(:post, "https://foo/").to_return(:status => 200)
   end
 

data/spec/flying_sphinx/configurer_spec.rb

@@ -2,13 +2,14 @@ require "spec_helper"
 
 RSpec.describe FlyingSphinx::Configurer do
   let(:subject) { FlyingSphinx::Configurer.new api }
-  let(:api)     { double :get => presignature }
+  let(:api)     { double "API" }
   let(:presignature) { {
     "status" => "OK",
     "path"   => "a/path/of/my/own",
     "url"    => "https://confserver",
     "fields" => {"message" => "something"}
   } }
+  let(:version_check) { {"status" => "OK"} }
   let(:configuration_options) { double "conf options", :version => "2.2.3",
     :raw => "indexer ...", :settings => settings, :engine => "manticore" }
   let(:settings) { {
@@ -19,6 +20,10 @@ RSpec.describe FlyingSphinx::Configurer do
   before :each do
     stub_request(:post, "https://confserver").to_return(:status => 200)
 
+    allow(api).to receive(:get).with("/versions/manticore-2.2.3").
+      and_return(version_check)
+    allow(api).to receive(:get).with("/presignature").and_return(presignature)
+
     allow(FlyingSphinx::ConfigurationOptions).to receive(:new).
       and_return(configuration_options)
   end
@@ -144,4 +149,27 @@ RSpec.describe FlyingSphinx::Configurer do
       )
     end
   end
+
+  context "version failure" do
+    before :each do
+      version_check["status"] = "NOT FOUND"
+    end
+
+    it "raises an InvalidVersionError exception" do
+      expect { subject.call }.to raise_error(
+        FlyingSphinx::Configurer::InvalidVersionError
+      )
+    end
+
+    it "does not attempt to upload" do
+      begin
+        subject.call
+      rescue FlyingSphinx::Configurer::InvalidVersionError
+      end
+
+      expect(
+        a_multipart_request(:post, "https://confserver")
+      ).not_to have_been_made
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flying-sphinx
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-10 00:00:00.000000000 Z
+date: 2018-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ey-hmac
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -218,8 +218,8 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Appraisals
+- CHANGELOG.markdown
 - Gemfile
-- HISTORY
 - LICENCE
 - README.textile
 - Rakefile