rummageable 0.1.2

data/lib/rummageable.rb

@@ -0,0 +1,74 @@
+require "rest_client"
+require "json"
+require "plek"
+
+module Rummageable
+
+  InvalidDocument = Class.new(RuntimeError)
+  CHUNK_SIZE = 20
+
+  attr_writer :rummager_service_name
+  def rummager_service_name
+    @rummager_service_name || "search"
+  end
+
+  attr_writer :rummager_host
+  def rummager_host
+    @rummager_host || Plek.current.find(rummager_service_name)
+  end
+
+  attr_writer :path_prefix
+  def path_prefix
+    @path_prefix || ""
+  end
+
+  # documents must be either a hash (for one document) or an array of hashes
+  # (for multiple documents)
+  #
+  def index(documents)
+    documents = [documents].flatten
+    documents.each do |document|
+      validate_structure document
+    end
+    url = rummager_host + path_prefix + "/documents"
+    0.step(documents.length - 1, CHUNK_SIZE).each do |i|
+      body = JSON.dump(documents[i, CHUNK_SIZE])
+      RestClient.post url, body, content_type: :json, accept: :json
+    end
+  end
+
+  def delete(link)
+    url = rummager_host + path_prefix + "/documents/" + CGI.escape(link)
+    RestClient.delete url, content_type: :json, accept: :json
+  end
+
+  VALID_KEYS = [
+    %w[title],
+    %w[description],
+    %w[format],
+    %w[section],
+    %w[link],
+    %w[indexable_content],
+    %w[additional_links title],
+    %w[additional_links link],
+    %w[additional_links link_order],
+  ]
+
+  def validate_structure(hash, parents=[])
+    hash.each do |key, value|
+      full_key = parents + [key]
+      case value
+      when Array
+        value.each do |el|
+          validate_structure el, full_key
+        end
+      when Hash
+        validate_structure value, full_key
+      else
+        raise InvalidDocument unless VALID_KEYS.include?(full_key)
+      end
+    end
+  end
+
+  extend self
+end

data/test/rummageable_test.rb

@@ -0,0 +1,133 @@
+require "minitest/autorun"
+require "webmock/minitest"
+require "rummageable"
+ENV["RACK_ENV"] = "test"
+
+class RummageableTest < MiniTest::Unit::TestCase
+  API = Plek.current.find("search")
+
+  def test_should_index_a_single_document_by_posting_it_as_json
+    document = {
+      "title" => "TITLE",
+      "description" => "DESCRIPTION",
+      "format" => "NAME OF FORMAT",
+      "section" => "NAME OF SECTION",
+      "link" => "/link",
+      "indexable_content" => "TEXT",
+      "additional_links" => [
+        {"title" => "LINK1", "link" => "/link1"},
+        {"title" => "LINK2", "link" => "/link2"},
+      ]
+    }
+    json = JSON.dump([document])
+
+    stub_request(:post, "#{API}/documents").
+      with(body: json).
+      to_return(status: 200, body: '{"status":"OK"}')
+
+    Rummageable.index(document)
+  end
+
+  def test_should_index_multiple_documents_by_posting_them_as_json
+    documents = [
+      {"title" => "DOC1"},
+      {"title" => "DOC2"}
+    ]
+    json = JSON.dump(documents)
+
+    stub_request(:post, "#{API}/documents").
+      with(body: json).
+      to_return(status: 200, body: '{"status":"OK"}')
+
+    Rummageable.index(documents)
+  end
+
+  def test_should_send_documents_in_batches_of_20
+    documents = 21.times.map { |i| {"title" => "DOC#{i}"} }
+
+    stub_request(:post, "#{API}/documents").
+      to_return(status: 200, body: '{"status":"OK"}')
+
+    Rummageable.index(documents)
+    assert_requested :post, "#{API}/documents", body: JSON.dump(documents[0, 20])
+    assert_requested :post, "#{API}/documents", body: JSON.dump(documents[20, 1])
+  end
+
+  def test_should_raise_an_exception_if_a_document_has_symbol_keys
+    document = {title: "TITLE"}
+    assert_raises Rummageable::InvalidDocument do
+      Rummageable.index(document)
+    end
+  end
+
+  def test_should_raise_an_exception_if_a_document_has_unrecognised_keys
+    document = {"foo" => "bar"}
+    assert_raises Rummageable::InvalidDocument do
+      Rummageable.index(document)
+    end
+  end
+
+  def test_should_raise_an_exception_if_a_document_has_unrecognised_nested_keys
+    document = {
+      "additional_links" => [
+        {"foo" => "bar"}
+      ]
+    }
+    assert_raises Rummageable::InvalidDocument do
+      Rummageable.index(document)
+    end
+  end
+
+  def test_should_post_to_rummageable_host_determined_by_rummager_service_name
+    document = {"title" => "TITLE"}
+    stub_request(:post, "#{API}/documents")
+    stub_request(:post, "http://whitehall-search.test.alphagov.co.uk/documents")
+    with_rummager_service_name("whitehall-search") do
+      Rummageable.index(document)
+    end
+    assert_not_requested(:post, "#{API}/documents")
+    assert_requested(:post, "http://whitehall-search.test.alphagov.co.uk/documents")
+  end
+
+  def test_should_delete_a_document_by_its_link
+    link = "http://example.com/foo"
+
+    stub_request(:delete, "#{API}/documents/http%3A%2F%2Fexample.com%2Ffoo").
+      to_return(status: 200, body: '{"status":"OK"}')
+
+    Rummageable.delete(link)
+  end
+
+  def test_should_delete_to_rummageable_host_determined_by_rummager_service_name
+    link = "http://example.com/foo"
+    stub_request(:delete, "#{API}/documents/http%3A%2F%2Fexample.com%2Ffoo")
+    stub_request(:delete, "http://whitehall-search.test.alphagov.co.uk/documents/http%3A%2F%2Fexample.com%2Ffoo")
+    with_rummager_service_name("whitehall-search") do
+      Rummageable.delete(link)
+    end
+    assert_not_requested(:delete, "#{API}/#{API}/documents/http%3A%2F%2Fexample.com%2Ffoo")
+    assert_requested(:delete, "http://whitehall-search.test.alphagov.co.uk/documents/http%3A%2F%2Fexample.com%2Ffoo")
+  end
+
+  def test_should_defer_to_plek_for_the_location_of_the_rummager_host
+    assert_equal Plek.current.find("search"), Rummageable.rummager_host
+  end
+
+  def test_should_allow_the_rummager_host_to_be_set_manually_so_that_we_can_connect_to_rummager_running_at_arbitrary_locations
+    Rummageable.rummager_host = "http://example.com"
+    assert_equal "http://example.com", Rummageable.rummager_host
+    ensure
+      Rummageable.rummager_host = nil
+  end
+
+  private
+
+  def with_rummager_service_name(service_name)
+    original_rummager_service_name = Rummageable.rummager_service_name
+    Rummageable.rummager_service_name = "whitehall-search"
+    yield
+  ensure
+    Rummageable.rummager_service_name = original_rummager_service_name
+  end
+
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: rummageable
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- GovUK Beta Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70235750717760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70235750717760
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70235750717320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70235750717320
+- !ruby/object:Gem::Dependency
+  name: plek
+  requirement: &70235750716900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70235750716900
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70235750716480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70235750716480
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70235750708840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70235750708840
+description: Mediator for apps that want their content to be in the search index
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rummageable.rb
+- test/rummageable_test.rb
+homepage: https://github.com/alphagov/rummageable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Mediator for apps that want their content to be in the search index
+test_files:
+- test/rummageable_test.rb