適合フェーズでのプラグインAPI

require "droonga/plugin"

module Droonga::Plugins::FooPlugin
  extend Plugin
  register("foo")

  class Adapter < Droonga::Adapter
    # このアダプターを設定するための操作
    XXXXXX = XXXXXX

    def adapt_input(input_message)
      # 入力メッセージを変更するための操作
      input_message.XXXXXX = XXXXXX
    end

    def adapt_output(output_message)
      # 出力メッセージを変更するための操作
      output_message.XXXXXX = XXXXXX
    end
  end
end

module Droonga::Plugins::QueryFixer
  class Adapter < Droonga::Adapter
    def adapt_input(input_message)
      input_message.body["query"] = "fixed query"
    end
  end
end

module Droonga::Plugins::ErrorConcealer
  class Adapter < Droonga::Adapter
    def adapt_output(output_message)
      output_message.status_code = Droonga::StatusCode::OK
    end
  end
end

module Droonga::Plugins::MySearch
  class Adapter < Droonga::Adapter
    input_message.pattern = ["type", :equal, "my-search"]

    def adapt_input(input_message)
      p input_message.type
      # => "my-search"
      #    このメッセージは「my-search」というメッセージタイプに
      #    対応したプラグインによって処理される。

      input_message.type = "search"

      p input_message.type
      # => "search"
      #    メッセージタイプが変更された。
      #    このメッセージはsearchプラグインによって、
      #    通常の検索リクエストとして処理される。
    end
  end
end

module Droonga::Plugins::MinimumLimit
  class Adapter < Droonga::Adapter
    input_message.pattern = ["type", :equal, "search"]

    MAXIMUM_LIMIT = 10

    def adapt_input(input_message)
      input_message.body["queries"].each do |name, query|
        query["output"] ||= {}
        query["output"]["limit"] ||= MAXIMUM_LIMIT
        query["output"]["limit"] = [query["output"]["limit"], MAXIMUM_LIMIT].min
      end
      # この時点で、すべての検索クエリが"output.limit=10"の指定を持っている。
    end
  end
end

module Droonga::Plugins::MySearch
  class Adapter < Droonga::Adapter
    input_message.pattern = ["type", :equal, "my-search"]

    def adapt_input(input_message)
      # 独自形式のメッセージからクエリ文字列を取り出す。
      query_string = input_message["body"]["query"]

      # "search"型の内部的な検索リクエストを組み立てる。
      input_message.type = "search"
      input_message.body = {
        "queries" => {
          "source"    => "Store",
          "condition" => {
            "query"   => query_string,
            "matchTo" => ["name"],
          },
          "output" => {
            "elements" => ["records"],
            "limit"    => 10,
          },
        },
      }
      # この時点で、"type"と"body"は両方とも完全に置き換えられている。
    end
  end
end

module Droonga::Plugins::ErrorConcealer
  class Adapter < Droonga::Adapter
    input_message.pattern = ["type", :equal, "search"]

    def adapt_output(output_message)
      unless output_message.status_code == StatusCode::InternalServerError
        output_message.status_code = Droonga::StatusCode::OK
        output_message.body = {}
        output_message.errors = nil
        # この時点で、内部的なサーバーエラーはすべて無視されるため
        # クライアントは通常のレスポンスを受け取る事になる。
      end
    end
  end
end

module Droonga::Plugins::ErrorExporter
  class Adapter < Droonga::Adapter
    input_message.pattern = ["type", :equal, "search"]

    def adapt_output(output_message)
      output_message.errors.delete(secret_database)
      # 秘密のデータベースからのエラー情報を削除する。

      output_message.body["errors"] = {
        "records" => output_message.errors.collect do |database, error|
          {
            "database" => database,
            "error" => error
          }
        end,
      }
      # エラー情報を、"error"という名前の擬似的な検索結果に変換する。
    end
  end
end

module Droonga::Plugins::SponsoredSearch
  class Adapter < Droonga::Adapter
    input_message.pattern = ["type", :equal, "search"]

    def adapt_output(output_message)
      output_message.body.each do |name, result|
        next unless result["records"]
        result["records"].unshift(sponsored_entry)
      end
      # これにより、すべての検索結果が広告エントリを含むようになる。
    end

    def sponsored_entry
      {
        "title"=> "SALE!",
        "url"=>   "http://..."
      }
    end
  end
end