inquisitio 0.0.1 → 0.0.11

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: e00221909913b20b1935e3893e2d28215e10c20b
-  data.tar.gz: f09754c49440894e83dc6f510eb971f68df1ab25
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjA2YTc0ZDY2MWMwODRhODBlZGNjOWYzYzE3MzRkYjgwOGFiNjRkNg==
+  data.tar.gz: !binary |-
+    MDBmN2I1ZjMwMzEwZDk4MGQ4ZjZkZjEzNGY2ODZlYWEwNjBmYmY4NA==
 SHA512:
-  metadata.gz: b30f62c09ea9a79aebc2ca49b03b6f1b23524a276843f4add66e690c2206889646ab336d2651cabbd7c2c4141d8f4d5d68be0b26b18b75ca67ab331d2f9e2012
-  data.tar.gz: b06bfa625a9c9b7c1d47432771bb26fdc7302779b8c5e02434b34a3c49b1a8e3e515a111895d87983e9de738735bfd6eb468cf63c1fd3d510dd8700e6e79eee7
+  metadata.gz: !binary |-
+    MzJkN2U4OGE0ZmY4YWVlMjUxYmE3YjBmY2M0MmMzYTg0NmY4YjNlOGMyNTk3
+    YzUxNmVhZGM5ODk5Yzk4MGVhNWZjODBlM2I4NDk4OGZkNGUwM2Q2ZTUwZDNi
+    YWE4M2JlNjRhMzhhMTEzMWZmMDljYWYwZGU1ZDY1YTVmY2M0MzE=
+  data.tar.gz: !binary |-
+    NWVlYWQzYWJlNmM3MmI5NGM3ZGViNTNhODA3MmU4NTU0ZDlmYzUwMTYxMzE4
+    M2M4NGQ5ZDYxNWVjZTA5MzE5MDlhYmQ3ODVkYTM3M2EzZDNhN2Y2OWNkZjBh
+    Y2VmYjczNzhjMjg1YjBlMmVjMjhhMWU3OGU5ZDUwZTIzOTFjYzQ=

data/.gitignore

@@ -1,3 +1,4 @@
+*.swp
 *.gem
 *.rbc
 .bundle

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+0.0.11 / Unreleased
+
+[FEATURE] Searcher now has default size read from configuration.
+[FEATURE] Searcher now performs simple sanatization of search queries.
+
+0.0.9 / Unreleased
+
+[FEATURE] Searcher now has id, records and results.
+[FEATURE] Refactor SearchUrlBuilder out of Searcher.
+
+0.0.8 / 2013-10-23
+
+[FEATURE] Extended searcher to handle arguments (for example, facet arguments).
+
+0.0.7 / 2013-10-23
+
+[FEATURE] Extended searcher to handle boolean queries.
+
+0.0.6 / 2013-10-23
+
+[FEATURE] Changed version of excon
+
+0.0.5 / 2013-10-22
+
+[FEATURE] Initial indexer created.
+
+0.0.4 / 2013-10-22
+
+[FEATURE] Return_fields is now optional in search call.
+
+0.0.3 / 2013-10-21
+
+[FEATURE] Added ability to perform search using Searcher class.
+
+0.0.2 / 2013-10-21
+
+[FEATURE] Added Document class representing AWS SDF document.
+
+0.0.1 / 2013-10-21
+
+[FEATURE] Added configuration, logger and error classes.

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in inquisitio.gemspec
 gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Rakefile

@@ -1 +1,12 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+end
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end
+
+task default: :test

data/bin/boolean_query

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "inquisitio"
+
+# Perform a search containing a boolean query against AWS CloudSearch
+#
+# example usage:
+#
+# ruby ./bin/search <enddpoint> "Star Wars" "genre" "Animation" "title"
+
+endpoint = ARGV[0]
+query = ARGV[1]
+filter_name = ARGV[2]
+filter_value =  ARGV[3]
+return_fields = [ ARGV[4] ]
+
+Inquisitio.config do |config|
+  config.search_endpoint = endpoint
+end
+
+puts Inquisitio.search(query, { filter_name.to_sym => filter_value.to_sym, :return_fields => return_fields} )

data/bin/facet_query

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "inquisitio"
+
+# Perform a search containing a boolean query against AWS CloudSearch
+#
+# example usage:
+#
+# ruby ./bin/search <enddpoint> "Star Wars" "genre" "Animation" "title"
+
+endpoint = ARGV[0]
+query = ARGV[1]
+filter_name = ARGV[2]
+filter_value =  ARGV[3]
+return_fields = [ ARGV[4] ]
+
+Inquisitio.config do |config|
+  config.search_endpoint = endpoint
+end
+
+puts Inquisitio.search(query,
+                       { filter_name.to_sym => filter_value.to_sym, 
+                         :arguments => { :facet => 'genre',
+                                         'facet-genre-constraints' => 'Animation',
+                                         'facet-genre-top-n' => '5'
+                                       },
+                         :return_fields => return_fields
+                       } )

data/bin/index

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "inquisitio"
+
+# Index a spdf file in AWS CloudSearch
+#
+# example usage:
+#
+# ruby ./bin/index <document_endpoint> "id" "version" "field_name" "field_value"
+
+endpoint = ARGV[0]
+id = ARGV[1]
+
+version = Time.now.to_i
+
+Inquisitio.config do |config|
+  config.document_endpoint = endpoint
+end
+
+fields = { :title => 'The Title',
+           :author => 'The Author' }
+document = Inquisitio::Document.new("add",
+                                    id,
+                                    version,
+                                    fields)
+Inquisitio.index(document)

data/bin/search

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "inquisitio"
+
+# Perform a search against AWS CloudSearch
+#
+# example usage:
+#
+# ruby ./bin/search <enddpoint> "Star Wars" "title"
+
+endpoint = ARGV[0]
+query = ARGV[1]
+return_fields = [ ARGV[2] ]
+
+Inquisitio.config do |config|
+  config.search_endpoint = endpoint
+end
+
+if return_fields.nil?
+  puts Inquisitio.search(query)
+else
+  puts Inquisitio.search(query, { "return_fields" => return_fields} )
+end

data/inquisitio.gemspec

@@ -18,6 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "excon", "~> 0.25.0"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "minitest", "~> 5.0.8"
 end

data/lib/inquisitio/configuration.rb

@@ -0,0 +1,34 @@
+module Inquisitio
+
+  class InquisitioConfigurationError < InquisitioError
+  end
+
+  class Configuration
+
+    SETTINGS = [
+      :search_endpoint,
+      :document_endpoint,
+      :default_search_size,
+      :logger
+    ]
+    attr_writer *SETTINGS
+
+    def initialize
+      self.logger = Inquisitio::Logger.new
+    end
+
+    SETTINGS.each do |setting|
+      define_method setting do
+        get_or_raise(setting)
+      end
+    end
+
+    private
+
+    def get_or_raise(setting)
+      instance_variable_get("@#{setting.to_s}") || 
+        raise(InquisitioConfigurationError.new("Configuration for #{setting} is not set"))
+    end
+  end
+end
+

data/lib/inquisitio/document.rb

@@ -0,0 +1,24 @@
+require 'json'
+module Inquisitio
+  class Document
+
+    attr_reader :type, :id, :version, :fields
+    def initialize(type, id, version, fields)
+      @type = type
+      @id = id
+      @version = version
+      @fields = fields
+    end
+
+    def to_SDF
+      <<-EOS
+{ "type": "#{type}",
+  "id":   "#{id}",
+  "version": #{version},
+  "lang": "en",
+  "fields": #{fields.to_json}
+}
+      EOS
+    end
+  end
+end

data/lib/inquisitio/indexer.rb

@@ -0,0 +1,36 @@
+require 'excon'
+
+module Inquisitio
+  class Indexer
+
+    def self.index(documents)
+      new(documents).index
+    end
+
+    def initialize(documents)
+      raise InquisitioError.new("Document(s) is null") if documents.nil?
+      raise InquisitioError.new("Document(s) is empty") unless documents.any?
+
+      @documents = documents
+    end
+
+    def index
+      response = Excon.post(batch_index_url,
+                           :body => body,
+                           :headers => {"Content-Type" =>"application/json"})
+      raise InquisitioError.new("Index failed with status code: #{response.status} Message: #{response.body}") unless response.status == 200
+      response.body
+    end
+
+    private
+
+    def body
+      body = @documents.map(&:to_SDF).join(", ")
+      "[#{body}]"
+    end
+
+    def batch_index_url
+      "#{Inquisitio.config.document_endpoint}/2011-02-01/documents/batch"
+    end
+  end
+end

data/lib/inquisitio/inquisitio_error.rb

@@ -0,0 +1,7 @@
+module Inquisitio
+
+  # The exception from which all other exceptions in this library derive.
+  class InquisitioError < StandardError
+  end
+
+end

data/lib/inquisitio/logger.rb

@@ -0,0 +1,19 @@
+module Inquisitio
+  class Logger
+
+    StdLevels = %W{debug info warn}
+    ErrorLevels = %W{error fatal}
+
+    StdLevels.each do |level|
+      define_method level do |*args|
+        $stdout.puts *args
+      end
+    end
+
+    ErrorLevels.each do |level|
+      define_method level do |*args|
+        $stderr.puts *args 
+      end
+    end
+  end
+end

data/lib/inquisitio/search_url_builder.rb

@@ -0,0 +1,59 @@
+module Inquisitio
+  class SearchUrlBuilder
+
+    def self.build(*args)
+      new(*args).build
+    end
+
+    def initialize(options = {})
+      @query         = options[:query]
+      @filters       = options[:filters] || {}
+      @arguments     = options[:arguments]
+      @return_fields = options[:return_fields]
+      add_default_size if @arguments.nil? || @arguments[:size].nil?
+    end
+
+    def build
+      components = [url_root]
+      components << (@filters.empty?? simple_query : boolean_query)
+      components << return_fields_query_string
+      components << arguments
+      components.join("")
+    end
+
+    private
+    def simple_query
+      "q=#{URI.encode(@query.gsub('\'',''))}"
+    end
+
+    def boolean_query
+      filters = @filters.map{|key,value| "#{key.to_s.gsub('\'','')}:'#{value.to_s.gsub('\'','')}'"}
+      queries = filters.join(" ")
+      queries = "'#{@query.gsub('\'','')}' #{queries}" if @query
+      "bq=#{URI.encode("(and #{queries})")}"
+    end
+
+    def return_fields_query_string
+      return "" if @return_fields.nil?
+      "&return-fields=#{URI::encode(@return_fields.join(',').gsub('\'',''))}"
+    end
+
+    def arguments
+      return "" if @arguments.nil?
+      @arguments.map{|key,value| "&#{key.to_s.gsub('\'','')}=#{value.to_s.gsub('\'','')}"}.join("")
+    end
+
+    def url_root
+      "#{Inquisitio.config.search_endpoint}/2011-02-01/search?"
+    end
+
+    def add_default_size
+      if @arguments.nil?
+        @arguments = {}
+      end
+      if @arguments[:size].nil?
+        @arguments = @arguments.merge(:size => Inquisitio.config.default_search_size)
+      end
+    end
+  end
+end

data/lib/inquisitio/searcher.rb

@@ -0,0 +1,49 @@
+require 'excon'
+
+module Inquisitio
+  class Searcher
+
+    def self.search(*args)
+      searcher = new(*args)
+      searcher.search
+      searcher
+    end
+
+    attr_reader :results
+    def initialize(query, filters = {})
+      raise InquisitioError.new("Query is null") if query.nil?
+
+      if query.is_a?(String)
+        @query = query
+        @filters = filters
+      else
+        @filters = query
+      end
+
+      @return_fields = @filters.delete(:return_fields)
+      @arguments = @filters.delete(:arguments)
+    end
+
+    def search
+      response = Excon.get(search_url)
+      raise InquisitioError.new("Search failed with status code: #{response.status} Message #{response.body}") unless response.status == 200
+      body = response.body
+      @results = JSON.parse(body)["hits"]["hit"]
+    end
+
+    def ids
+      @ids ||= @results.map{|result|result['id']}
+    end
+
+    def records
+      @records ||= @results.map do |result|
+        {result['type'] => result['id']}
+      end
+    end
+
+    private
+    def search_url
+      @search_url ||= SearchUrlBuilder.build(query: @query, filters: @filters, arguments: @arguments, return_fields: @return_fields)
+    end
+  end
+end

data/lib/inquisitio/version.rb

@@ -1,3 +1,3 @@
 module Inquisitio
-  VERSION = "0.0.1"
+  VERSION = "0.0.11"
 end

data/lib/inquisitio.rb

@@ -1,5 +1,50 @@
 require "inquisitio/version"
+require "inquisitio/inquisitio_error"
+require "inquisitio/logger"
+require "inquisitio/configuration"
+require "inquisitio/document"
+require "inquisitio/search_url_builder"
+require "inquisitio/searcher"
+require "inquisitio/indexer"
 
 module Inquisitio
-  # Your code goes here...
+
+  # Inquisitio configuration settings.
+  #
+  # Settings should be set in an initializer or using some
+  # other method that insures they are set before any
+  # Inquisitio code is used. They can be set as followed:
+  #
+  #   Inquisitio.config.access_key = "my-access-key"
+  #
+  # The following settings are allowed:
+  #
+  # * <tt>:access_key</tt> - The AWS access key
+  # * <tt>:secret_key</tt> - The AWS secret key
+  # * <tt>:queue_region</tt> - The AWS region
+  #   is included in.
+  # * <tt>:logger</tt> - A logger object that responds to puts.
+  def self.config
+    @config ||= Configuration.new
+    if block_given?
+      yield @config
+    else
+      @config
+    end
+  end
+
+  # Perform a search.
+  #
+  # @param [String] query The search query.
+  # @param [Hash] options. Optionaly specify return_fields. The fields to be returned in the search results.
+  def self.search(query, options =  {})
+    Searcher.search(query, options)
+  end
+
+  # Index a batch of documents.
+  #
+  # @param [Array] documents. A list of Documents to index.
+  def self.index(documents)
+    Indexer.index([documents])
+  end
 end

data/test/configuration_test.rb

@@ -0,0 +1,59 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Inquisitio
+  class ConfigurationTest < Minitest::Test
+
+    def setup
+      Inquisitio.instance_variable_set("@config", nil)
+    end
+
+    def test_obtaining_singletion
+      refute Inquisitio.config.nil?
+    end
+
+    def test_block_syntax
+      test_search_endpoint = "foobar-123-endpoint"
+      Inquisitio.config do |config|
+        config.search_endpoint = test_search_endpoint
+      end
+      assert_equal test_search_endpoint, Inquisitio.config.search_endpoint
+    end
+
+    def test_search_endpoint
+      search_endpoint = "test-search-endpoint"
+      Inquisitio.config.search_endpoint = search_endpoint
+      assert_equal search_endpoint, Inquisitio.config.search_endpoint
+    end
+
+    def test_missing_search_endpoint_throws_exception
+      assert_raises(InquisitioConfigurationError) do
+        Inquisitio.config.search_endpoint
+      end
+    end
+
+    def test_document_endpoint
+      document_endpoint = "test-document-endpoint"
+      Inquisitio.config.document_endpoint = document_endpoint
+      assert_equal document_endpoint, Inquisitio.config.document_endpoint
+    end
+
+    def test_missing_document_endpoint_throws_exception
+      assert_raises(InquisitioConfigurationError) do
+        Inquisitio.config.document_endpoint
+      end
+    end
+
+    def test_default_search_size
+      default_search_size = "test-default_search_size"
+      Inquisitio.config.default_search_size = default_search_size
+      assert_equal default_search_size, Inquisitio.config.default_search_size
+    end
+
+    def test_missing_default_search_size_throws_exception
+      assert_raises(InquisitioConfigurationError) do
+        Inquisitio.config.default_search_size
+      end
+    end
+  end
+end
+

data/test/document_test.rb

@@ -0,0 +1,48 @@
+require File.expand_path('../test_helper', __FILE__)
+require 'json'
+
+module Inquisitio
+  class DocumentTest < Minitest::Test
+    def setup
+      @type = 'add'
+      @id = '12345'
+      @version = 1
+      @fields = { :title => 'The Title', :author => 'The Author' }
+      @document = Document.new(@type, @id, @version, @fields)
+
+      @expected_SDF = 
+        <<-EOS
+{ "type": "add",
+  "id":   "12345",
+  "version": 1,
+  "lang": "en",
+  "fields": {
+    "title": "The Title",
+    "author": "The Author"
+  }
+}
+        EOS
+    end
+
+    def test_initialization_sets_type
+      assert_equal @type, @document.type
+    end
+
+    def test_initialization_sets_id
+      assert_equal @id, @document.id
+    end
+
+    def test_initialization_sets_version
+      assert_equal @version, @document.version
+    end
+
+    def test_initialization_sets_fields
+      assert_equal @fields, @document.fields
+    end
+
+    def test_create_valid_SDF_json
+      assert_equal JSON.parse(@expected_SDF).to_json,
+                   JSON.parse(@document.to_SDF).to_json
+    end
+  end
+end

data/test/indexer_test.rb

@@ -0,0 +1,74 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Inquisitio
+  class IndexerTest < Minitest::Test
+    def setup
+      @document_endpoint = 'http://my.document-endpoint.com'
+      Inquisitio.config.document_endpoint = @document_endpoint
+    #def initialize(type, id, version, fields)
+      @documents = [Document.new("add", "12345", 1, {})]
+    end
+
+    def teardown
+      Excon.stubs.clear
+    end
+
+    def test_initialization
+      indexer = Indexer.new(@documents)
+      refute indexer.nil?
+    end
+
+    def test_indexer_should_raise_exception_if_documents_nil
+      assert_raises(InquisitioError, "Documents is nil") do
+        Indexer.index(nil)
+      end
+    end
+
+    def test_indexer_should_raise_exception_if_documents_empty
+      assert_raises(InquisitioError, "Documents is empty") do
+        Indexer.index([])
+      end
+    end
+
+    def test_create_correct_index_url
+      indexer = Indexer.new(@documents)
+      expected_url = 'http://my.document-endpoint.com/2011-02-01/documents/batch'
+      assert_equal expected_url, indexer.send(:batch_index_url)
+    end
+
+    def test_create_correct_body
+      doc1 = mock()
+      doc1.expects(:to_SDF).returns("sdf1")
+      doc2 = mock()
+      doc2.expects(:to_SDF).returns("sdf2")
+      doc3 = mock()
+      doc3.expects(:to_SDF).returns("sdf3")
+
+      documents = [ doc1, doc2, doc3 ]
+      indexer = Indexer.new(documents)
+      expected_body = '[sdf1, sdf2, sdf3]'
+      assert_equal expected_body, indexer.send(:body)
+    end
+
+    def test_index_raises_exception_when_response_not_200
+      Excon.defaults[:mock] = true
+      Excon.stub({}, {:body => 'Bad Happened', :status => 500})
+
+      indexer = Indexer.new(@documents)
+
+      assert_raises(InquisitioError, "Indexer failed with status code 500") do
+        indexer.index
+      end
+    end
+
+    def test_index_returns_results
+      body = 'Some Body'
+      Excon.defaults[:mock] = true
+      Excon.stub({}, {:body => body, :status => 200})
+
+      indexer = Indexer.new(@documents)
+      response = indexer.index
+      assert_equal body, response
+    end
+  end
+end

data/test/logger_test.rb

@@ -0,0 +1,35 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Inquisitio
+  class LoggerTest < Minitest::Test
+    def setup
+      super
+      @logger = Logger.new
+    end
+
+    def test_debug
+      $stdout.expects(:puts).with("foobar")
+      @logger.debug "foobar"
+    end
+
+    def test_info
+      $stdout.expects(:puts).with("foobar")
+      @logger.info "foobar"
+    end
+
+    def test_warn
+      $stdout.expects(:puts).with("foobar")
+      @logger.warn "foobar"
+    end
+
+    def test_error
+      $stderr.expects(:puts).with("foobar")
+      @logger.error "foobar"
+    end
+
+    def test_fatal
+      $stderr.expects(:puts).with("foobar")
+      @logger.fatal "foobar"
+    end
+  end
+end

data/test/search_url_builder_test.rb

@@ -0,0 +1,67 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Inquisitio
+  class SearchUrlBuilderTest < Minitest::Test
+    def setup
+      super
+      @search_endpoint = 'http://my.search-endpoint.com'
+      Inquisitio.config.search_endpoint = @search_endpoint
+      Inquisitio.config.default_search_size = '10'
+    end
+
+    def test_create_correct_search_url_without_return_fields
+      url = SearchUrlBuilder.build(query: 'Star Wars')
+      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?q=Star%20Wars&size=10'
+      assert_equal expected_url, url
+    end
+
+    def test_create_correct_search_url_including_return_fields
+      url = SearchUrlBuilder.build(query: 'Star Wars', return_fields: [ 'title', 'year', '%' ] )
+      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?q=Star%20Wars&return-fields=title,year,%25&size=10'
+      assert_equal expected_url, url
+    end
+
+    def test_create_boolean_query_search_url_with_only_filters
+      url = SearchUrlBuilder.build(filters: {title: 'Star Wars'})
+      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?bq=(and%20title:\'Star%20Wars\')&size=10'
+      assert_equal expected_url, url
+    end
+
+    def test_create_boolean_query_search_url_with_query_and_filters
+      url = SearchUrlBuilder.build(query: 'Star Wars', filters: {genre: 'Animation'})
+      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?bq=(and%20\'Star%20Wars\'%20genre:\'Animation\')&size=10'
+      assert_equal expected_url, url
+    end
+
+    def test_create_boolean_query_search_url_with_query_and_filters_and_return_fields
+      url = SearchUrlBuilder.build(query: 'Star Wars', filters: {genre: 'Animation'}, return_fields: [ 'title', 'year', '%' ])
+      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?bq=(and%20\'Star%20Wars\'%20genre:\'Animation\')&return-fields=title,year,%25&size=10'
+      assert_equal expected_url, url
+    end
+
+    def test_create_search_url_with_added_arguments
+      url = SearchUrlBuilder.build(query: 'Star Wars', filters: {genre: 'Animation'}, :arguments => { facet: 'genre', 'facet-genre-constraints' => 'Animation', 'facet-genre-top-n' => '5'})
+      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?bq=(and%20\'Star%20Wars\'%20genre:\'Animation\')&facet=genre&facet-genre-constraints=Animation&facet-genre-top-n=5&size=10'
+      assert_equal expected_url, url
+    end
+
+    def test_create_search_url_with_default_size
+      url = SearchUrlBuilder.build(query: 'Star Wars')
+      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?q=Star%20Wars&size=10'
+      assert_equal expected_url, url
+    end
+
+    def test_create_search_url_overriding_default_size
+      url = SearchUrlBuilder.build(query: 'Star Wars', :arguments => { size: '200' })
+      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?q=Star%20Wars&size=200'
+      assert_equal expected_url, url
+    end
+
+    def test_create_correct_search_url_with_sanatised_query_string
+      url = SearchUrlBuilder.build(query: 'Star\' Wars', filters: {genre: 'Anim\'ation'}, :arguments => { facet: 'ge\'nre', 'facet-genr\'e-constraints' => 'Anim\'ation', 'facet-gen\'re-top-n' => '\'5'}, return_fields: [ 't\'itle', 'y\'ear' ])
+      expected_url = 'http://my.search-endpoint.com/2011-02-01/search?bq=(and%20\'Star%20Wars\'%20genre:\'Animation\')&return-fields=title,year&facet=genre&facet-genre-constraints=Animation&facet-genre-top-n=5&size=10'
+      assert_equal expected_url, url
+    end
+
+  end
+end

data/test/searcher_test.rb

@@ -0,0 +1,90 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Inquisitio
+  class SearcherTest < Minitest::Test
+    def setup
+      super
+      @search_endpoint = 'http://my.search-endpoint.com'
+      Inquisitio.config.search_endpoint = @search_endpoint
+      @expected_result_1 = {'id' => 1, 'title' => "Foobar", 'type' => "cat"}
+      @expected_result_2 = {'id' => 2, 'title' => "Foobar2", 'type' => "dog"}
+      @expected_results = [@expected_result_1, @expected_result_2]
+
+      body = <<-EOS
+      {"rank":"-text_relevance","match-expr":"(label 'star wars')","hits":{"found":2,"start":0,"hit":#{@expected_results.to_json}},"info":{"rid":"9d3b24b0e3399866dd8d376a7b1e0f6e930d55830b33a474bfac11146e9ca1b3b8adf0141a93ecee","time-ms":3,"cpu-time-ms":0}}
+      EOS
+
+      Excon.defaults[:mock] = true
+      Excon.stub({}, {body: body, status: 200})
+    end
+
+    def teardown
+      super
+      Excon.stubs.clear
+    end
+
+    def test_initialization_with_string
+      filters = { :genre => [ 'Animation' ] }
+      return_fields = [ 'title' ]
+      searcher = Searcher.new('Star Wars', filters.merge({return_fields: return_fields}))
+      assert_equal 'Star Wars', searcher.instance_variable_get("@query")
+      assert_equal filters, searcher.instance_variable_get("@filters")
+      assert_equal return_fields, searcher.instance_variable_get("@return_fields")
+    end
+
+    def test_initialization_with_hash
+      filters = { :genre => [ 'Animation' ] }
+      return_fields = [ 'title' ]
+      searcher = Searcher.new(filters.merge({return_fields: return_fields}))
+      assert_equal nil, searcher.instance_variable_get("@query")
+      assert_equal filters, searcher.instance_variable_get("@filters")
+      assert_equal return_fields, searcher.instance_variable_get("@return_fields")
+    end
+
+    def test_searcher_should_raise_exception_if_query_null
+      assert_raises(InquisitioError, "Query is nil") do
+        Searcher.search(nil)
+      end
+    end
+
+
+    def test_search_raises_exception_when_response_not_200
+      Excon.stub({}, {:body => 'Bad Happened', :status => 500})
+
+      searcher = Searcher.new('Star Wars')
+
+      assert_raises(InquisitioError, "Search failed with status code 500") do
+        searcher.search
+      end
+    end
+
+    def test_search_should_set_results
+      searcher = Searcher.new('Star Wars', { :return_fields => [ 'title', 'year', '%' ] } )
+      searcher.search
+      assert_equal @expected_results, searcher.instance_variable_get("@results")
+    end
+
+    def test_search_should_set_ids
+      searcher = Searcher.new('Star Wars', { :return_fields => [ 'title', 'year', '%' ] } )
+      searcher.search
+      assert_equal @expected_results.map{|r|r['id']}, searcher.ids
+    end
+
+    def test_search_should_set_records
+      searcher = Searcher.new('Star Wars', { :return_fields => [ 'title', 'year', '%' ] } )
+      searcher.search
+
+      # [{"MediaFile" => 1}, {...}]
+      records = []
+      records << {@expected_result_1['type'] => @expected_result_1['id']}
+      records << {@expected_result_2['type'] => @expected_result_2['id']}
+      assert_equal records, searcher.records
+    end
+
+    def test_search_calls_search_url_builder
+      SearchUrlBuilder.any_instance.expects(build: "http://www.example.com")
+      searcher = Searcher.new('Star Wars')
+      searcher.search
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+gem "minitest"
+require "minitest/autorun"
+require "minitest/pride"
+require "minitest/mock"
+require "mocha/setup"
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "inquisitio"
+
+class Minitest::Test
+  def setup
+    Inquisitio.config do |config|
+      config.search_endpoint = "test-search-endpoint"
+
+      config.logger.stubs(:debug)
+      config.logger.stubs(:error)
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: inquisitio
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.11
 platform: ruby
 authors:
 - Jeremy Walker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-21 00:00:00.000000000 Z
+date: 2013-10-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.25.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.25.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -28,32 +42,97 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.8
 description: A Ruby Gem that wraps search for CloudSearch
 email:
 - jeremy@meducation.net
-executables: []
+executables:
+- boolean_query
+- facet_query
+- index
+- search
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENCE.md
 - README.md
 - Rakefile
+- bin/boolean_query
+- bin/facet_query
+- bin/index
+- bin/search
 - inquisitio.gemspec
 - lib/inquisitio.rb
+- lib/inquisitio/configuration.rb
+- lib/inquisitio/document.rb
+- lib/inquisitio/indexer.rb
+- lib/inquisitio/inquisitio_error.rb
+- lib/inquisitio/logger.rb
+- lib/inquisitio/search_url_builder.rb
+- lib/inquisitio/searcher.rb
 - lib/inquisitio/version.rb
+- test/configuration_test.rb
+- test/document_test.rb
+- test/indexer_test.rb
+- test/logger_test.rb
+- test/search_url_builder_test.rb
+- test/searcher_test.rb
+- test/test_helper.rb
 homepage: https://github.com/meducation/inquisition
 licenses:
 - AGPL3
@@ -64,12 +143,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -78,5 +157,12 @@ rubygems_version: 2.1.9
 signing_key: 
 specification_version: 4
 summary: This wraps AWS CloudSearch in a Ruby Gem
-test_files: []
+test_files:
+- test/configuration_test.rb
+- test/document_test.rb
+- test/indexer_test.rb
+- test/logger_test.rb
+- test/search_url_builder_test.rb
+- test/searcher_test.rb
+- test/test_helper.rb
 has_rdoc: