flying-sphinx 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ee5d5fc1f8745bb68578415a4e036f69adedf09c
-  data.tar.gz: a73a8a240b8950aea9f893fca507e07ba46e3783
+SHA256:
+  metadata.gz: 9e456647fed387b52501630a4ccfcbb68997dac89175eb6f4d774373f4022cfe
+  data.tar.gz: 06ebf9bd4a0c560f1df0892c58d36cab1b19d4571e47d37cd9ff16d32bfd3096
 SHA512:
-  metadata.gz: 6d93b097372f02dacaefad4deefa2c19d21a14e38e491a74065124ea753614e56d52be6a8063fac6969657f13a54783c829548bdf30966193d2f5b4dbe4091b3
-  data.tar.gz: 86de7fec9d219ae58f0195d3cbf6edd51c7f57e9b50e3ab30de59e2437be4843458db5ba02931cc2abd50a59a9abe5cc36791729421f213a7143747d481f85a9
+  metadata.gz: 6de104433df80fe158a321f122ab4d745b455e3132da6d4fac4a14d65d5dab481ce01b5992882c7216746856e93a7f6b5afc9422ab8f31d59fc89f329410bd64
+  data.tar.gz: b8a333189a913fbc7011c63fa12f8d9c1c39037f22c00dc61d6bf77836e86107dd8f31a38b3867040410f8b480851b16b07b55829514fa3b7b4f7a1cc5a3ae73

data/.travis.yml

@@ -1,11 +1,9 @@
 language: ruby
 rvm:
-- 1.9.3
-- 2.0
-- 2.1.10
-- 2.2.8
-- 2.3.5
-- 2.4.2
+- 2.2.10
+- 2.3.7
+- 2.4.4
+- 2.5.1
 before_install:
 - gem install bundler
 - gem update --system

data/Appraisals

@@ -1,25 +1,29 @@
 appraise 'rails-3.2' do
   gem 'rails',   '~> 3.2.18'
   gem 'faraday', '~> 0.8.0'
-end if RUBY_VERSION.to_f >= 1.9 && RUBY_VERSION.to_f <= 2.3
+end if RUBY_VERSION.to_f <= 2.3
 
 appraise 'rails-4.0' do
   gem 'rails',   '~> 4.0.5'
   gem 'faraday', '~> 0.9.0'
-end if RUBY_VERSION.to_f >= 1.9 && RUBY_VERSION.to_f <= 2.3
+end if RUBY_VERSION.to_f <= 2.3
 
 appraise 'rails-4.1' do
-  gem 'rails',   '~> 4.1.16'
-end if RUBY_VERSION.to_f >= 1.9 && RUBY_VERSION.to_f <= 2.3
+  gem 'rails', '~> 4.1.16'
+end if RUBY_VERSION.to_f <= 2.3
 
 appraise 'rails-4.2' do
-  gem 'rails',   '~> 4.2.10'
-end if RUBY_VERSION.to_f >= 1.9 && RUBY_VERSION.to_f <= 2.3
+  gem 'rails', '~> 4.2.10'
+end if RUBY_VERSION.to_f <= 2.3
 
 appraise 'rails-5.0' do
-  gem 'rails',   '~> 5.0.6'
-end if RUBY_VERSION.to_f >= 2.2
+  gem 'rails', '~> 5.0.6'
+end
 
 appraise 'rails-5.1' do
-  gem 'rails',   '~> 5.1.4'
-end if RUBY_VERSION.to_f >= 2.2
+  gem 'rails', '~> 5.1.4'
+end
+
+appraise 'rails-5.2' do
+  gem 'rails', '~> 5.2.0'
+end

data/HISTORY

@@ -1,3 +1,11 @@
+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
 * Fix call to generate real-time data for thinking-sphinx v3.4+.
 

data/README.textile

@@ -9,15 +9,13 @@ 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    => 'ffc9530a1b'</code></pre>
+  :ref    => 'e72b86b56a'</code></pre>
 
 h2. Compatibility and Limitations
 
-Flying Sphinx is built with support for Rails 2.3.6 and beyond. Sadly, earlier versions of Rails aren't supported due to a requirement of a recent version of Rack deep in the dependency tree.
+The current (2.x) releases support Thinking Sphinx v4+, ActiveRecord/Rails 3.2+, and Ruby 2.2+.
 
-It works from Ruby 1.9.3 onwards, and on both Heroku's Bamboo and Cedar stacks. You _do_ need to use it with Heroku at this point - allowing others hosting elsewhere to use Flying Sphinx is something I'm considering, but it's not possible right now.
-
-There are limitations with Heroku's setup and Sphinx/Thinking Sphinx functionality - again, the official documentation "covers this":http://flying-sphinx.com/docs#limitations, so have a read there.
+If you are using older versions of any of these, please use v1.3.1 (which supports Thinking Sphinx v1.5+, ActiveRecord/Rails 2.3.6+, and Ruby 1.9.3+).
 
 If you're still using Ruby 1.8.7, flying-sphinx 1.2.1 is the last release to support that.
 
@@ -40,4 +38,4 @@ h2. Contributors
 
 h2. Licence
 
-Copyright &copy; 2011-2017 Pat Allan, released under an MIT licence.
+Copyright &copy; 2011-2018 Pat Allan, released under an MIT licence.

data/flying-sphinx.gemspec

@@ -22,8 +22,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'gzipped_tar',        '~> 0.0.3'
   s.add_runtime_dependency 'multi_json',         '>= 1.3.0'
   s.add_runtime_dependency 'pusher-client',      '~> 0.3'
-  s.add_runtime_dependency 'riddle',             '>= 1.5.6'
-  s.add_runtime_dependency 'thinking-sphinx',    '>= 1.5.0'
+  s.add_runtime_dependency 'thinking-sphinx',    '>= 4.0.0'
 
   s.add_development_dependency 'appraisal',    '~> 2.2'
   s.add_development_dependency 'dotenv',       '~> 0.11.1'

data/lib/flying_sphinx.rb

@@ -20,22 +20,13 @@ module FlyingSphinx
   def self.logger=(logger)
     @logger = logger
   end
-
-  def self.translator
-    @translator
-  end
-
-  def self.translator=(translator)
-    @translator = translator
-  end
 end
 
 require 'multi_json'
 require 'ey-hmac'
 require 'faraday'
 require 'gzipped_tar'
-require 'riddle'
-require 'riddle/0.9.9'
+require 'thinking_sphinx'
 require 'pusher-client'
 
 PusherClient.logger = FlyingSphinx.logger
@@ -43,14 +34,13 @@ PusherClient.logger = FlyingSphinx.logger
 require 'flying_sphinx/version'
 require 'flying_sphinx/action'
 require 'flying_sphinx/api'
-require 'flying_sphinx/binary'
 require 'flying_sphinx/cli'
+require 'flying_sphinx/commands'
 require 'flying_sphinx/configuration'
 require 'flying_sphinx/configuration_options'
 require 'flying_sphinx/configurer'
-require 'flying_sphinx/controller'
+require 'flying_sphinx/rake_interface'
 require 'flying_sphinx/setting_files'
-require 'flying_sphinx/sphinxql'
 
 require 'flying_sphinx/request/hmac'
 require 'flying_sphinx/response/invalid'
@@ -59,6 +49,6 @@ require 'flying_sphinx/response/logger'
 
 if defined?(Rails) && defined?(Rails::Railtie)
   require 'flying_sphinx/railtie'
-elsif defined?(Rails) && defined?(Rails::Plugin)
-  require 'flying_sphinx/rails'
 end
+
+ThinkingSphinx.rake_interface = FlyingSphinx::RakeInterface

data/lib/flying_sphinx/cli.rb

@@ -1,94 +1,31 @@
-require 'forwardable'
-
 class FlyingSphinx::CLI
-  extend Forwardable
-
   COMMANDS = {
-    'configure'  => [:configure],
-    'index'      => [:index],
-    'setup'      => [:configure, :index],
-    'start'      => [:start],
-    'stop'       => [:stop],
-    'restart'    => [:restart],
-    'rebuild'    => [:rebuild],
-    'regenerate' => [:regenerate]
+    'configure'  => "ts:configure",
+    'index'      => "ts:index",
+    'setup'      => "ts:index",
+    'start'      => "ts:start",
+    'stop'       => "ts:stop",
+    'restart'    => "ts:restart",
+    'rebuild'    => "ts:rebuild",
+    'regenerate' => "ts:rebuild"
   }
 
-  def_delegators :controller, :start, :stop, :restart
-
   def initialize(command, arguments = [])
     @command, @arguments = command, arguments
   end
 
   def run
-    methods = COMMANDS[@command]
-    raise "Unknown command #{@command}" if methods.nil?
-
-    methods.all? do |method|
-      FlyingSphinx.logger.info "Executing Action: #{method}"
-      result = send method
-      FlyingSphinx.logger.info "Action Finished: #{method}"
-
-      result
-    end
-  end
-
-  private
-
-  def configuration
-    @configuration ||= FlyingSphinx::Configuration.new
-  end
-
-  def configure
-    if @arguments.empty?
-      load_rails
-
-      controller.configure
-    else
-      controller.configure File.read(@arguments.first)
-    end
-
-    true
-  end
+    task = COMMANDS[@command]
+    raise "Unknown command #{@command}" if task.nil?
 
-  def controller
-    @controller ||= FlyingSphinx::Controller.new configuration.api
-  end
-
-  def index
-    indices = @arguments + [{:verbose => true}]
-    controller.index *indices
-  end
-
-  def load_rails
-    return unless ENV['RAILS_ENV']
-
-    boot = File.expand_path('config/boot', Dir.pwd)
-    return unless File.exist?("#{boot}.rb")
-    require boot
-
-    if defined?(Rails) && !defined?(Rails::Railtie)
-      require File.expand_path('config/environment', Dir.pwd)
-      require 'flying_sphinx/rails'
-
-      FlyingSphinx::Binary.load
-    else
-      require File.expand_path('config/application', Dir.pwd)
-      require 'flying_sphinx/railtie'
-
-      Rails.application.require_environment!
-    end
-  end
-
-  def rebuild
-    load_rails
-
-    controller.rebuild
-  end
+    puts <<-MESSAGE
+The flying_sphinx CLI tool is now deprecated. Please use the standard Thinking
+Sphinx tasks instead. (Thinking Sphinx tasks will now invoke the appropriate
+behaviour for both local and Flying Sphinx environments). In this case:
 
-  def regenerate
-    load_rails
+    heroku run rake #{task}
+    MESSAGE
 
-    controller.regenerate
+    `bundle exec rake #{task}`
   end
 end

data/lib/flying_sphinx/commands.rb

@@ -0,0 +1,35 @@
+module FlyingSphinx::Commands
+end
+
+require "flying_sphinx/commands/base"
+require "flying_sphinx/commands/clear"
+require "flying_sphinx/commands/configure"
+require "flying_sphinx/commands/index_sql"
+require "flying_sphinx/commands/merge"
+require "flying_sphinx/commands/prepare"
+require "flying_sphinx/commands/rebuild"
+require "flying_sphinx/commands/reset"
+require "flying_sphinx/commands/restart"
+require "flying_sphinx/commands/rotate"
+require "flying_sphinx/commands/running"
+require "flying_sphinx/commands/start"
+require "flying_sphinx/commands/start_attached"
+require "flying_sphinx/commands/stop"
+
+ThinkingSphinx::Commander.registry.merge!(
+  :clear           => FlyingSphinx::Commands::Clear,
+  :clear_real_time => FlyingSphinx::Commands::Clear,
+  :clear_sql       => FlyingSphinx::Commands::Clear,
+  :configure       => FlyingSphinx::Commands::Configure,
+  :index_sql       => FlyingSphinx::Commands::IndexSQL,
+  :merge           => FlyingSphinx::Commands::Merge,
+  :prepare         => FlyingSphinx::Commands::Prepare,
+  :rebuild         => FlyingSphinx::Commands::Rebuild,
+  :reset           => FlyingSphinx::Commands::Reset,
+  :restart         => FlyingSphinx::Commands::Restart,
+  :rotate          => FlyingSphinx::Commands::Rotate,
+  :running         => FlyingSphinx::Commands::Running,
+  :start_attached  => FlyingSphinx::Commands::StartAttached,
+  :start_detached  => FlyingSphinx::Commands::Start,
+  :stop            => FlyingSphinx::Commands::Stop
+)

data/lib/flying_sphinx/commands/base.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+class FlyingSphinx::Commands::Base < ThinkingSphinx::Commands::Base
+  DEFAULT_TIMEOUT = 60
+  INDEX_TIMEOUT   = 60 * 60 * 3 # 3 hours
+  ERROR_MESSAGES  = {
+    "BLOCKED"      => <<-TXT,
+BLOCKED: Single-index processing is not permitted for your plan level
+    TXT
+    "UNCONFIGURED" => <<-TXT,
+UNCONFIGURED: This command can only be run once you have provided your Sphinx
+configuration (via the ts:configure or ts:rebuild tasks).
+    TXT
+    "INVALID PATH" => <<-TXT
+INVALID PATH: Something has gone wrong with the uploading of your configuration.
+Please contact Flying Sphinx Support: http://support.flying-sphinx.com
+    TXT
+  }.freeze
+
+  def call_with_handling
+    call
+  rescue FlyingSphinx::Error => error
+    handle_failure error
+  end
+
+  private
+
+  def api
+    @api ||= options[:api] || FlyingSphinx::Configuration.new.api
+  end
+
+  def flying_sphinx_settings
+    configuration.settings.fetch("flying_sphinx", {})
+  end
+
+  def handle_failure(error)
+    stream.puts <<-TXT
+
+The Flying Sphinx command failed:
+  Class: #{self.class.name}
+  Error: #{error.message}
+
+If everything looks to be in order, please try the command again. If the error
+persists, please contact Flying Sphinx Support: http://support.flying-sphinx.com
+
+    TXT
+
+    raise error
+  end
+
+  def index_timeout
+    flying_sphinx_settings["index_timeout"] || INDEX_TIMEOUT
+  end
+
+  def run_action(action, timeout = default_timeout, parameters = {})
+    FlyingSphinx.logger.info "Executing Action: #{action}"
+    FlyingSphinx::Action.perform api.identifier, timeout do
+      send_action action, parameters
+    end
+    FlyingSphinx.logger.info "Action Finished: #{action}"
+  end
+
+  def run_action_with_path(action, timeout = default_timeout)
+    path = FlyingSphinx::Configurer.call api
+
+    run_action action, timeout, :path => path
+  end
+
+  def send_action(action, parameters = {})
+    response = api.post '/perform', parameters.merge(:action => action)
+
+    if ERROR_MESSAGES.keys.include?(response["status"])
+      raise FlyingSphinx::Error, ERROR_MESSAGES[response["status"]]
+    end
+
+    if response["status"] != "OK"
+      raise FlyingSphinx::Error, "Unknown Exception: #{response["status"]}"
+    end
+
+    response
+  end
+
+  def default_timeout
+    flying_sphinx_settings["timeout"] || DEFAULT_TIMEOUT
+  end
+end

data/lib/flying_sphinx/commands/clear.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class FlyingSphinx::Commands::Clear < FlyingSphinx::Commands::Base
+  def call
+    run_action 'clear'
+  end
+end

data/lib/flying_sphinx/commands/configure.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class FlyingSphinx::Commands::Configure < FlyingSphinx::Commands::Base
+  def call
+    run_action_with_path 'configure'
+  end
+end

data/lib/flying_sphinx/commands/index_sql.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class FlyingSphinx::Commands::IndexSQL < FlyingSphinx::Commands::Base
+  def call
+    if async?
+      send_action 'index', indexing_options.merge(:unique => 'true')
+    else
+      clear_jobs
+
+      run_action 'index', index_timeout, indexing_options
+    end
+  end
+
+  private
+
+  def async?
+    indices.any? && !options[:verbose]
+  end
+
+  def clear_jobs
+    ::Delayed::Job.delete_all(
+      "handler LIKE '--- !ruby/object:FlyingSphinx::%'"
+    ) if defined?(::Delayed) && ::Delayed::Job.table_exists?
+  end
+
+  def indexing_options
+    {:indices => indices.join(",")}
+  end
+
+  def indices
+    options[:indices] || []
+  end
+end