flying-sphinx 1.2.1 → 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b115e7eb956584d31756788bc14b8119ec3e68ba
+  data.tar.gz: 28d21d5c1364dfe513d482d6463de1924c04469b
+SHA512:
+  metadata.gz: 2921c3b5a1f2a8b2c5c7e962b290144581b46341c52b05685682798e84db1791bbedaed7a7e67aa45f9b5cc946829d4cafcf69b69d09ce08d85080a14e813655
+  data.tar.gz: 2ab0e472479c65c54157e50f08f6e7b8a4faa8c858f48c302fd5ddda9903c5513e163ccad20aff289c772190286babeec5998cc39c0d4330cacc19d05dee410d

data/.gitignore

@@ -3,4 +3,5 @@ Gemfile.lock
 *.tmproj
 *.sublime-*
 gemfiles/*.lock
+gemfiles/*.gemfile
 pkg

data/.travis.yml

@@ -1,39 +1,15 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - ree
-  - 1.9.3
-  - 2.0
-  - 2.1.2
-gemfile:
-  - gemfiles/rails_2.3.gemfile
-  - gemfiles/rails_3.0.gemfile
-  - gemfiles/rails_3.2.gemfile
-  - gemfiles/rails_4.0.gemfile
+- 1.9.3
+- 2.0
+- 2.1.10
+- 2.2.8
+- 2.3.5
+- 2.4.2
 before_install:
-  - gem update --system
-  - gem install bundler
-matrix:
-  exclude:
-    - rvm: 1.8.7
-      gemfile: gemfiles/rails_4.0.gemfile
-    - rvm: ree
-      gemfile: gemfiles/rails_4.0.gemfile
-    - rvm: 1.8.7
-      gemfile: gemfiles/rails_3.2.gemfile
-    - rvm: ree
-      gemfile: gemfiles/rails_3.2.gemfile
-    - rvm: 1.9.3
-      gemfile: gemfiles/rails_2.3.gemfile
-    - rvm: 2.0
-      gemfile: gemfiles/rails_2.3.gemfile
-    - rvm: 2.1.2
-      gemfile: gemfiles/rails_2.3.gemfile
-    - rvm: 1.9.3
-      gemfile: gemfiles/rails_3.0.gemfile
-    - rvm: 2.0
-      gemfile: gemfiles/rails_3.0.gemfile
-    - rvm: 2.1.2
-      gemfile: gemfiles/rails_3.0.gemfile
+- gem install bundler
+- gem update --system
+before_script:
+- bundle exec appraisal install
 cache: bundler
-script: bundle exec rspec
+script: bundle exec appraisal rspec

data/Appraisals

@@ -1,23 +1,25 @@
-if RUBY_VERSION.to_f <= 1.8
-  appraise 'rails-2.3' do
-    gem 'rails',   '~> 2.3.18'
-    gem 'faraday', '0.7.0'
-    gem 'riddle',  '< 2.0.0'
-  end
+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
 
-  appraise 'rails-3.0' do
-    gem 'rails',   '~> 3.0.20'
-    gem 'faraday', '~> 0.8.0'
-    gem 'riddle',  '< 2.0.0'
-  end
-else
-  appraise 'rails-3.2' do
-    gem 'rails',   '~> 3.2.18'
-    gem 'faraday', '~> 0.8.0'
-  end
+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
 
-  appraise 'rails-4.0' do
-    gem 'rails',   '~> 4.0.5'
-    gem 'faraday', '~> 0.9.0'
-  end
-end
+appraise 'rails-4.1' do
+  gem 'rails',   '~> 4.1.16'
+end if RUBY_VERSION.to_f >= 1.9 && 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
+
+appraise 'rails-5.0' do
+  gem 'rails',   '~> 5.0.6'
+end if RUBY_VERSION.to_f >= 2.2
+
+appraise 'rails-5.1' do
+  gem 'rails',   '~> 5.1.4'
+end if RUBY_VERSION.to_f >= 2.2

data/Gemfile

@@ -2,20 +2,15 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'activesupport', '< 4.0.0' if RUBY_VERSION.to_f <= 1.8
-gem 'riddle',        '< 2.0.0' if RUBY_VERSION.to_f <= 1.8
-
 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"
-else
-  gem "public_suffix"
+  gem "nokogiri",      "< 1.7.0"
 end
-
-gem 'appraisal',     '~> 1.0.0',
-  :git    => 'git://github.com/thoughtbot/appraisal',
-  :branch => 'master',
-  :ref    => 'bd6eef4b6a'

data/README.textile

@@ -9,16 +9,18 @@ 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    => '6b691c2b43'</code></pre>
+  :ref    => 'ab0dd5f047'</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.
 
-It works from Ruby 1.8.7 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.
+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're still using Ruby 1.8.7, flying-sphinx 1.2.1 is the last release to support that.
+
 h2. Contributing
 
 Patches are indeed welcome - though I understand it's a little tricky to test them thoroughly. It's best to give your changes a spin on your Heroku app that's running Flying Sphinx (and if you don't have one of those, I'm a little confused as to why you're contributing).
@@ -38,4 +40,4 @@ h2. Contributors
 
 h2. Licence
 
-Copyright &copy; 2011-2012 Pat Allan, released under an MIT licence.
+Copyright &copy; 2011-2017 Pat Allan, released under an MIT licence.

data/flying-sphinx.gemspec

@@ -17,15 +17,19 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
   s.executables   = ['flying-sphinx']
 
-  s.add_runtime_dependency 'thinking-sphinx'
-  s.add_runtime_dependency 'riddle',             '>= 1.5.6'
-  s.add_runtime_dependency 'multi_json',         '>= 1.3.0'
+  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 '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_development_dependency 'appraisal',    '~> 2.2'
   s.add_development_dependency 'dotenv',       '~> 0.11.1'
   s.add_development_dependency 'em-websocket', '~> 0.5.1'
   s.add_development_dependency 'mysql2',       '~> 0.3.15'
+  s.add_development_dependency 'rack'
   s.add_development_dependency 'rspec',        '~> 2.14'
   s.add_development_dependency 'rspec-retry',  '~> 0.4'
   s.add_development_dependency 'webmock',      '~> 1.17.4'

data/lib/flying_sphinx.rb

@@ -1,9 +1,12 @@
 require 'logger'
 
 module FlyingSphinx
+  module Request; end
   module Response; end
   module Translators; end
 
+  Error = Class.new StandardError
+
   @logger       = Logger.new(STDOUT)
   @logger.level = Logger::INFO
   if ENV['VERBOSE_LOGGING'] && ENV['VERBOSE_LOGGING'] == 'true'
@@ -28,25 +31,28 @@ module FlyingSphinx
 end
 
 require 'multi_json'
+require 'ey-hmac'
 require 'faraday'
+require 'gzipped_tar'
 require 'riddle'
 require 'riddle/0.9.9'
 require 'pusher-client'
 
 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/configuration'
 require 'flying_sphinx/configuration_options'
+require 'flying_sphinx/configurer'
 require 'flying_sphinx/controller'
-require 'flying_sphinx/gzipped_hash'
 require 'flying_sphinx/setting_files'
 require 'flying_sphinx/sphinxql'
-require 'flying_sphinx/version'
 
+require 'flying_sphinx/request/hmac'
 require 'flying_sphinx/response/invalid'
 require 'flying_sphinx/response/json'
 require 'flying_sphinx/response/logger'

data/lib/flying_sphinx/action.rb

@@ -62,7 +62,7 @@ class FlyingSphinx::Action
   def response
     attempts = 0
     @response ||= begin
-      block.call.body
+      block.call
     rescue
       attempts += 1
       retry if attempts <= 3

data/lib/flying_sphinx/api.rb

@@ -7,8 +7,8 @@ class FlyingSphinx::API
     PUSHER_KEY = 'c5602d4909b5144321ce'
   end
 
-  PATH    = '/api/my/app'
-  VERSION = 4
+  PATH    = '/api/my/v5'
+  HEADERS = {'X-Flying-Sphinx-Version' => FlyingSphinx::Version}
 
   attr_reader :api_key, :identifier
 
@@ -19,17 +19,11 @@ class FlyingSphinx::API
   end
 
   def get(path, data = {})
-    connection.get do |request|
-      request.url normalize_path(path), data
-    end
+    connection.get { |request| request.url normalize_path(path), data }.body
   end
 
   def post(path, data = {})
-    connection.post normalize_path(path), data
-  end
-
-  def put(path, data = {})
-    connection.put normalize_path(path), data
+    connection.post(normalize_path(path), data).body
   end
 
   private
@@ -41,27 +35,19 @@ class FlyingSphinx::API
     "#{PATH}#{path}"
   end
 
-  def api_headers
-    {
-      'Accept' => "application/vnd.flying-sphinx-v#{VERSION}+json",
-      'X-Flying-Sphinx-Token'   => "#{identifier}:#{api_key}",
-      'X-Flying-Sphinx-Version' => FlyingSphinx::Version
-    }
-  end
-
   def connection(connection_options = {})
     options = {
       :ssl     => {:verify => false},
       :url     => SERVER,
-      :headers => api_headers
+      :headers => HEADERS
     }
 
     Faraday.new(options) do |builder|
       # Built-in middleware
-      builder.request :multipart
       builder.request :url_encoded
 
       # Local middleware
+      builder.use FlyingSphinx::Request::HMAC, identifier, api_key, 'Thebes'
       builder.use FlyingSphinx::Response::Logger
       builder.use FlyingSphinx::Response::Invalid
       builder.use FlyingSphinx::Response::JSON

data/lib/flying_sphinx/cli.rb

@@ -63,7 +63,9 @@ class FlyingSphinx::CLI
   def load_rails
     return unless ENV['RAILS_ENV']
 
-    require File.expand_path('config/boot', Dir.pwd)
+    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)

data/lib/flying_sphinx/configuration.rb

@@ -29,7 +29,7 @@ class FlyingSphinx::Configuration
   attr_reader :identifier, :api_key
 
   def response_body
-    @response_body ||= api.get('/').body
+    @response_body ||= api.get '/app'
   end
 
   def identifier_from_env

data/lib/flying_sphinx/configuration_options.rb

@@ -1,26 +1,23 @@
 class FlyingSphinx::ConfigurationOptions
-  def to_hash
-    {:sphinx_version => version, :configuration => gzipped_files_hash}
-  end
-
-  private
+  attr_reader :raw
 
-  def configuration
-    @configuration ||= ThinkingSphinx::Configuration.instance
+  def initialize(raw = nil, version = nil)
+    @raw     = raw || FlyingSphinx.translator.sphinx_configuration
+    @version = version || '2.2.3'
   end
 
-  def files_hash
-    FlyingSphinx::SettingFiles.new.to_hash.merge(
-      'sphinx' => FlyingSphinx.translator.sphinx_configuration
-    )
+  def settings
+    @settings ||= FlyingSphinx::SettingFiles.new.to_hash
   end
 
-  def gzipped_files_hash
-    FlyingSphinx::GzippedHash.new(files_hash).to_gzipped_hash
+  def version
+    version_defined? ? configuration.version : @version
   end
 
-  def version
-    version_defined? ? configuration.version : '2.0.4'
+  private
+
+  def configuration
+    @configuration ||= ThinkingSphinx::Configuration.instance
   end
 
   def version_defined?

data/lib/flying_sphinx/configurer.rb

@@ -0,0 +1,62 @@
+class FlyingSphinx::Configurer
+  PresignatureError = Class.new FlyingSphinx::Error
+  UploadError = Class.new FlyingSphinx::Error
+
+  def initialize(api, input)
+    @api   = api
+    @input = input
+  end
+
+  def call
+    if presignature["status"] != "OK"
+      raise PresignatureError, "Requesting presignature failed"
+    end
+
+    response = connection.post "", fields.merge(
+      "file" => Faraday::UploadIO.new(file, 'application/gzip', 'sphinx.tar.gz')
+    )
+
+    if response.status == 200
+      presignature["path"]
+    else
+      raise UploadError, "Uploading configuration failed"
+    end
+  end
+
+  private
+
+  attr_reader :api, :input
+
+  def connection
+    Faraday.new(:url => presignature["url"]) do |builder|
+      builder.request :multipart
+
+      builder.use FlyingSphinx::Response::Logger
+
+      builder.adapter Faraday.default_adapter
+    end
+  end
+
+  def fields
+    presignature["fields"] || {}
+  end
+
+  def file
+    config = FlyingSphinx::ConfigurationOptions.new input
+    writer = GZippedTar::Writer.new
+
+    writer.add "sphinx/raw.conf",    config.raw
+    writer.add "sphinx/version.txt", config.version
+    writer.add "sphinx/extra.txt",   config.settings["extra"]
+
+    config.settings["extra"].split(";").each do |key|
+      writer.add key, config.settings[key]
+    end unless config.settings["extra"].empty?
+
+    StringIO.new writer.output
+  end
+
+  def presignature
+    @presignature ||= api.get "/presignature"
+  end
+end

data/lib/flying_sphinx/controller.rb

@@ -1,4 +1,5 @@
 class FlyingSphinx::Controller
+  DEFAULT_TIMEOUT = 60
   @index_timeout = 60 * 60 * 3 # 3 hours
 
   # For backwards compatibility. These aren't actually used here.
@@ -17,12 +18,7 @@ class FlyingSphinx::Controller
   end
 
   def configure(file = nil)
-    options = file.nil? ? FlyingSphinx::ConfigurationOptions.new.to_hash :
-      {:configuration => {'sphinx' => file}, :sphinx_version => '2.0.6'}
-
-    FlyingSphinx::Action.perform api.identifier do
-      api.put 'configure', options
-    end
+    run_action_with_path 'configure', file
   end
 
   def index(*indices)
@@ -31,24 +27,20 @@ class FlyingSphinx::Controller
     options[:indices] = indices.join(',')
 
     if async
-      api.post 'indices/unique', options
+      send_action 'index', options.merge(:unique => 'true')
     else
       ::Delayed::Job.delete_all(
         "handler LIKE '--- !ruby/object:FlyingSphinx::%'"
       ) if defined?(::Delayed) && ::Delayed::Job.table_exists?
 
-      FlyingSphinx::Action.perform api.identifier, self.class.index_timeout do
-        api.post 'indices', options
-      end
+      run_action 'index', self.class.index_timeout, options
     end
 
     true
   end
 
   def rebuild
-    FlyingSphinx::Action.perform api.identifier, self.class.index_timeout do
-      api.put 'rebuild', FlyingSphinx::ConfigurationOptions.new.to_hash
-    end
+    run_action_with_path 'rebuild', nil, self.class.index_timeout
   end
 
   def regenerate(file = nil)
@@ -58,24 +50,15 @@ class FlyingSphinx::Controller
   end
 
   def reset(file = nil)
-    options = file.nil? ? FlyingSphinx::ConfigurationOptions.new.to_hash :
-      {:configuration => {'sphinx' => file}, :sphinx_version => '2.0.6'}
-
-    FlyingSphinx::Action.perform api.identifier do
-      api.put 'reset', options
-    end
+    run_action_with_path 'reset', file
   end
 
   def restart
-    FlyingSphinx::Action.perform api.identifier do
-      api.post 'restart'
-    end
+    run_action 'restart'
   end
 
   def rotate
-    FlyingSphinx::Action.perform api.identifier do
-      api.post 'rotate'
-    end
+    run_action 'rotate'
   end
 
   def running?
@@ -87,14 +70,30 @@ class FlyingSphinx::Controller
   end
 
   def start(options = {})
-    FlyingSphinx::Action.perform(api.identifier) { api.post 'start' }
+    run_action 'start'
   end
 
   def stop
-    FlyingSphinx::Action.perform(api.identifier) { api.post 'stop' }
+    run_action 'stop'
   end
 
   private
 
   attr_reader :api
+
+  def run_action(action, timeout = DEFAULT_TIMEOUT, parameters = {})
+    FlyingSphinx::Action.perform api.identifier, timeout do
+      send_action action, parameters
+    end
+  end
+
+  def run_action_with_path(action, file = nil, timeout = DEFAULT_TIMEOUT)
+    path = FlyingSphinx::Configurer.new(api, file).call
+
+    run_action action, timeout, :path => path
+  end
+
+  def send_action(action, parameters = {})
+    api.post '/perform', parameters.merge(:action => action)
+  end
 end