flying-sphinx 1.2.1 → 1.3.0

data/lib/flying_sphinx/request/hmac.rb

@@ -0,0 +1,20 @@
+class FlyingSphinx::Request::HMAC < Faraday::Middleware
+  def initialize(app, identifier, api_key, service)
+    super app
+
+    @identifier = identifier
+    @api_key    = api_key
+    @service    = service
+  end
+
+  def call(environment)
+    Ey::Hmac.sign! environment, identifier, api_key,
+      :adapter => Ey::Hmac::Adapter::Faraday, :service => service
+
+    app.call environment
+  end
+
+  private
+
+  attr_reader :app, :identifier, :api_key, :service
+end

data/lib/flying_sphinx/response/json.rb

@@ -1,5 +1,7 @@
 class FlyingSphinx::Response::JSON < Faraday::Response::Middleware
   def on_complete(environment)
+    return if environment[:request_headers]['Authorization'].nil?
+
     environment[:body] = MultiJson.load environment[:body]
   end
 end

data/lib/flying_sphinx/setting_files.rb

@@ -10,7 +10,7 @@ class FlyingSphinx::SettingFiles
     hash = {}
 
     each_file_for_setting do |setting, file|
-      hash["#{setting}:#{File.basename(file)}"] = File.read(file)
+      hash["#{setting}/#{File.basename(file)}"] = File.read(file)
     end
 
     hash['extra'] = hash.keys.join(';')

data/lib/flying_sphinx/version.rb

@@ -1,3 +1,3 @@
 module FlyingSphinx
-  Version = '1.2.1'
+  Version = '1.3.0'
 end

data/spec/acceptance/configuring_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'cgi'
+
+describe 'Configuring Sphinx' do
+  let(:cli)        { FlyingSphinx::CLI.new 'configure' }
+  let(:translator) { double 'Translator', :sphinx_indices => [index],
+    :sphinx_configuration => 'searchd { }' }
+  let(:index)      { double 'Index' }
+
+  before :each do
+    allow(FlyingSphinx).to receive(:translator).and_return(translator)
+
+    stub_hmac_request(:post, 'https://flying-sphinx.com/api/my/v5/perform').
+      to_return(:body => '{"id":953, "status":"OK"}')
+    stub_hmac_request(:get, "https://flying-sphinx.com/api/my/v5/presignature").
+      to_return(
+        :body => '{"url":"https://foo","path":"bar","fields":{},"status":"OK"}'
+      )
+    stub_request(:post, "https://foo/").to_return(:status => 200)
+  end
+
+  it 'sends the configuration to the server' do
+    SuccessfulAction.new(953).matches? lambda { cli.run }
+
+    expect(
+      a_hmac_request(:post, 'https://flying-sphinx.com/api/my/v5/perform').
+      with { |request| CGI::parse(request.body)["action"] == ["configure"] }
+    ).to have_been_made
+  end
+
+  it 'handles the full request successfully' do
+    expect { cli.run }.to be_successful_with 953
+  end
+end

data/spec/acceptance/get_info_spec.rb

@@ -4,10 +4,11 @@ describe 'Requesting customer information' do
   let(:configuration) { FlyingSphinx::Configuration.new 'foo', 'bar' }
 
   before :each do
-    stub_request(:get, 'https://flying-sphinx.com/api/my/app').to_return(
-      :status => 200,
-      :body   => '{"server":"my.sphinx.server","port":9307}'
-    )
+    stub_hmac_request(:get, 'https://flying-sphinx.com/api/my/v5/app').
+      to_return(
+        :status => 200,
+        :body   => '{"server":"my.sphinx.server","port":9307}'
+      )
   end
 
   it { expect(configuration.host).to eq('my.sphinx.server') }

data/spec/acceptance/start_or_stop_sphinx_spec.rb

@@ -4,12 +4,17 @@ describe 'Starting Sphinx' do
   let(:cli) { FlyingSphinx::CLI.new 'start' }
 
   before :each do
-    stub_request(:post, 'https://flying-sphinx.com/api/my/app/start').
+    stub_hmac_request(:post, 'https://flying-sphinx.com/api/my/v5/perform').
       to_return(:status => 200, :body => '{"id":429, "status":"OK"}')
   end
 
   it 'makes the request to the server', :retry => 3 do
     expect { cli.run }.to be_successful_with 429
+
+    expect(
+      a_hmac_request(:post, 'https://flying-sphinx.com/api/my/v5/perform').
+        with(:body => {:action => 'start'})
+    ).to have_been_made
   end
 end
 
@@ -17,11 +22,16 @@ describe 'Stopping Sphinx', :retry => 3 do
   let(:cli) { FlyingSphinx::CLI.new 'stop' }
 
   before :each do
-    stub_request(:post, 'https://flying-sphinx.com/api/my/app/stop').
+    stub_request(:post, 'https://flying-sphinx.com/api/my/v5/perform').
       to_return(:status => 200, :body => '{"id":537, "status":"OK"}')
   end
 
   it 'makes the request to the server', :retry => 3 do
     expect { cli.run }.to be_successful_with 537
+
+    expect(
+      a_hmac_request(:post, 'https://flying-sphinx.com/api/my/v5/perform').
+        with(:body => {:action => 'stop'})
+    ).to have_been_made
   end
 end

data/spec/flying_sphinx/action_spec.rb

@@ -6,7 +6,7 @@ describe FlyingSphinx::Action do
   let(:socket)   { double 'socket', :connect => true, :disconnect => true,
     :subscribe => true, :[] => channel, :connected => true }
   let(:channel)  { double 'channel', :bind => true }
-  let(:response) { double :body => {'status' => 'OK', 'id' => 748} }
+  let(:response) { {'status' => 'OK', 'id' => 748} }
   let(:logger)   { double 'logger', :debug => true }
 
   before :each do

data/spec/flying_sphinx/api_spec.rb

@@ -18,8 +18,6 @@ describe FlyingSphinx::API do
     it "sets up a connection with the appropriate headers" do
       faraday.should_receive(:new) do |options|
         options[:headers].should == {
-          'Accept'                  => 'application/vnd.flying-sphinx-v4+json',
-          'X-Flying-Sphinx-Token'   => 'foo:bar',
           'X-Flying-Sphinx-Version' => FlyingSphinx::Version
         }
 
@@ -52,7 +50,7 @@ describe FlyingSphinx::API do
 
     it "sends the GET request with the given path and data" do
       request.should_receive(:url).
-        with('/api/my/app/resource', 'param' => 'value')
+        with('/api/my/v5/resource', 'param' => 'value')
 
       send_request
     end
@@ -69,25 +67,7 @@ describe FlyingSphinx::API do
 
     it "sends the POST request with the given path and data" do
       connection.should_receive(:post).
-        with('/api/my/app/resource', 'param' => 'value').
-        and_return(response)
-
-      send_request
-    end
-  end
-
-  describe '#put' do
-    let(:send_request) { api.put '/resource', 'param' => 'value' }
-
-    before :each do
-      connection.stub(:put => response)
-    end
-
-    it_should_behave_like 'an API call'
-
-    it "sends the PUT request with the given path and data" do
-      connection.should_receive(:put).
-        with('/api/my/app/resource', 'param' => 'value').
+        with('/api/my/v5/resource', 'param' => 'value').
         and_return(response)
 
       send_request

data/spec/flying_sphinx/configuration_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe FlyingSphinx::Configuration do
-  let(:api)        { double 'FlyingSphinx::API', :get => double(:body => body) }
+  let(:api)        { double 'FlyingSphinx::API', :get => body }
   let(:body)       { {'server' => 'foo.bar.com', 'port' => 9319} }
   let(:api_key)    { 'foo-bar-baz' }
   let(:identifier) { 'my-identifier' }

data/spec/flying_sphinx/controller_spec.rb

@@ -2,11 +2,12 @@ require 'spec_helper'
 
 describe FlyingSphinx::Controller do
   let(:controller)    { FlyingSphinx::Controller.new api }
-  let(:api)           { double 'API', :identifier => 'foo', :put => true }
+  let(:api)           { double 'API', :identifier => 'foo', :put => true,
+    :get => {"path" => "/foo", "url" => "https://confserver", "status" => "OK"} }
   let(:action_class)  { double }
   let(:configuration) { double 'TS Configuration' }
-  let(:setting_files) { double :to_hash => {'extra' => 'wordforms:txt.txt',
-    'wordforms:txt.txt' => 'something'} }
+  let(:setting_files) { double :to_hash => {'extra' => 'wordforms/txt.txt',
+    'wordforms/txt.txt' => 'something'} }
   let(:translator)    { double :sphinx_configuration => 'indexer ...' }
 
   before :each do
@@ -20,38 +21,51 @@ describe FlyingSphinx::Controller do
 
     stub_const 'FlyingSphinx::SettingFiles', double(:new => setting_files)
     FlyingSphinx.stub :translator => translator
-  end
 
-  def ungzip(contents)
-    io     = StringIO.new contents, 'rb'
-    reader = Zlib::GzipReader.new io
-    reader.read
+    stub_request(:post, "https://confserver").to_return(:status => 200)
   end
 
   describe 'configure' do
     it 'sends data to the server' do
-      api.should_receive(:put)
+      api.should_receive(:post)
 
       controller.configure
     end
 
-    it 'sends through gzipped configuration files' do
-      api.should_receive(:put) do |path, options|
-        path.should == 'configure'
-        options[:configuration]['gzip'].should == 'true'
-        ungzip(options[:configuration]['sphinx'].read).should == 'indexer ...'
-        ungzip(options[:configuration]['wordforms:txt.txt'].read).should == 'something'
-      end
+    it 'sends through gzipped configuration archive' do
+      expect(api).to receive(:post).with '/perform',
+        :action => 'configure',
+        :path   => '/foo'
 
       controller.configure
+
+      expect(
+        a_multipart_request(:post, 'https://confserver').
+        with_file { |contents|
+          reader = GZippedTar::Reader.new contents
+
+          reader.read("sphinx/raw.conf") == "indexer ..." &&
+          reader.read("sphinx/version.txt") == "2.2.3" &&
+          reader.read("wordforms/txt.txt") == "something"
+        }
+      ).to have_been_made
     end
 
     it 'sends through file if provided' do
-      api.should_receive(:put).with 'configure',
-        :configuration  => {'sphinx' => 'searchd ...'},
-        :sphinx_version => '2.0.6'
+      expect(api).to receive(:post).with '/perform',
+        :action => 'configure',
+        :path   => '/foo'
 
       controller.configure 'searchd ...'
+
+      expect(
+        a_multipart_request(:post, 'https://confserver').
+        with_file { |contents|
+          reader = GZippedTar::Reader.new contents
+
+          reader.read("sphinx/raw.conf") == "searchd ..."
+        }
+      ).to have_been_made
     end
   end
 end

data/spec/flying_sphinx/setting_files_spec.rb

@@ -18,12 +18,12 @@ describe FlyingSphinx::SettingFiles do
     end
 
     [:stopwords, :wordforms, :exceptions].each do |setting|
-      it "uploads #{setting} files from indices" do
+      it "collects #{setting} files from indices" do
         indices << index_double(setting => '/my/file/foo.txt')
 
         files.to_hash.should == {
-          "#{setting}:foo.txt" => 'blah',
-          'extra'              => "#{setting}:foo.txt"
+          "#{setting}/foo.txt" => 'blah',
+          'extra'              => "#{setting}/foo.txt"
         }
       end
 
@@ -32,8 +32,8 @@ describe FlyingSphinx::SettingFiles do
         indices << index_double(setting => '/my/file/foo.txt')
 
         files.to_hash.should == {
-          "#{setting}:foo.txt" => 'blah',
-          'extra'              => "#{setting}:foo.txt"
+          "#{setting}/foo.txt" => 'blah',
+          'extra'              => "#{setting}/foo.txt"
         }
       end
 
@@ -41,22 +41,22 @@ describe FlyingSphinx::SettingFiles do
         indices << index_double(
           setting => '/my/file/foo.txt /my/file/bar.txt')
 
-        files.to_hash["#{setting}:foo.txt"].should == 'blah'
-        files.to_hash["#{setting}:bar.txt"].should == 'blah'
+        files.to_hash["#{setting}/foo.txt"].should == 'blah'
+        files.to_hash["#{setting}/bar.txt"].should == 'blah'
         files.to_hash['extra'].split(';').should =~ [
-          "#{setting}:foo.txt", "#{setting}:bar.txt"
+          "#{setting}/foo.txt", "#{setting}/bar.txt"
         ]
       end
     end
 
     [:mysql_ssl_cert, :mysql_ssl_key, :mysql_ssl_ca].each do |setting|
-      it "uploads #{setting} files from indices" do
+      it "collects #{setting} files from sources" do
         indices << index_double(:sources => [
           source_double(setting => '/my/file/foo.txt')])
 
         files.to_hash.should == {
-          "#{setting}:foo.txt" => 'blah',
-          'extra'              => "#{setting}:foo.txt"
+          "#{setting}/foo.txt" => 'blah',
+          'extra'              => "#{setting}/foo.txt"
         }
       end
 
@@ -67,8 +67,8 @@ describe FlyingSphinx::SettingFiles do
           source_double(setting => '/my/file/foo.txt')])
 
         files.to_hash.should == {
-          "#{setting}:foo.txt" => 'blah',
-          'extra'              => "#{setting}:foo.txt"
+          "#{setting}/foo.txt" => 'blah',
+          'extra'              => "#{setting}/foo.txt"
         }
       end
 
@@ -76,10 +76,10 @@ describe FlyingSphinx::SettingFiles do
         indices << index_double(:sources => [
           source_double(setting => '/my/file/foo.txt /my/file/bar.txt')])
 
-        files.to_hash["#{setting}:foo.txt"].should == 'blah'
-        files.to_hash["#{setting}:bar.txt"].should == 'blah'
+        files.to_hash["#{setting}/foo.txt"].should == 'blah'
+        files.to_hash["#{setting}/bar.txt"].should == 'blah'
         files.to_hash['extra'].split(';').should =~ [
-          "#{setting}:foo.txt", "#{setting}:bar.txt"
+          "#{setting}/foo.txt", "#{setting}/bar.txt"
         ]
       end
     end

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ require 'bundler'
 require 'dotenv'
 require 'webmock/rspec'
 require 'em-websocket'
+require 'rack'
 
 Dotenv.load '.env.test'
 WebMock.disable_net_connect!

data/spec/support/hmac.rb

@@ -0,0 +1,23 @@
+class HMACRequestPattern < WebMock::RequestPattern
+  def matches?(request_signature)
+    request_signature.headers['Authorization'].present? && super
+  end
+end
+
+module HMACHelpers
+  def stub_hmac_request(method, uri)
+    stub_request(method, uri).with { |request|
+      request.headers['Authorization'].present?
+    }
+  end
+
+  def a_hmac_request(method, uri)
+    HMACRequestPattern.new method, uri
+  end
+
+  private
+end
+
+RSpec.configure do |config|
+  config.include HMACHelpers
+end

data/spec/support/multipart.rb

@@ -0,0 +1,56 @@
+module MultipartHelpers
+  def a_multipart_request(method, uri)
+    MultipartRequestPattern.new method, uri
+  end
+end
+
+class MultipartRequestPattern < WebMock::RequestPattern
+  def with_file(&block)
+    with { |request| block.call MultipartRequestToFile.call(request) }
+  end
+end
+
+class MultipartRequestToFile
+  def self.call(request)
+    new(request).call
+  end
+
+  def initialize(request)
+    @request = request
+  end
+
+  def call
+    parsed["file"][:tempfile].read
+  end
+
+  private
+
+  attr_reader :request
+
+  def parsed
+    if Rack::Multipart.respond_to? :extract_multipart
+      Rack::Multipart.extract_multipart rack_request
+    else
+      Rack::Multipart.parse_multipart rack_env
+    end
+  end
+
+  def rack_env
+    transformed_headers.merge 'rack.input' => StringIO.new(request.body)
+  end
+
+  def rack_request
+    Rack::Request.new rack_env
+  end
+
+  def transformed_headers
+    request.headers.keys.inject({}) do |hash, key|
+      hash[key.underscore.upcase] = request.headers[key]
+      hash
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include MultipartHelpers
+end