rummageable 0.4.0 → 0.5.0

data/lib/rummageable/fake.rb

@@ -1,12 +1,15 @@
 module Rummageable
   class Fake
-    def index(documents)
+    def index(documents, index_name)
     end
 
-    def delete(link)
+    def delete(link, index_name)
     end
 
-    def commit
+    def amend(link, amendments, index_name)
+    end
+
+    def commit(index_name)
     end
 
     def validate_structure(hash, parents=[])

data/lib/rummageable/implementation.rb

@@ -1,28 +1,28 @@
 module Rummageable
   class Implementation
-    def index(documents)
+    def index(documents, index_name)
       documents = [documents].flatten
       documents.each do |document|
         validate_structure document
       end
-      url = Rummageable.rummager_host + Rummageable.path_prefix + "/documents"
+      url = Rummageable.rummager_host + index_name + "/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 amend(link, amendments)
+    def amend(link, amendments, index_name)
       validate_structure amendments
-      RestClient.post url_for(link), amendments
+      RestClient.post url_for(link, index_name), amendments
     end
 
-    def delete(link)
-      RestClient.delete url_for(link), content_type: :json, accept: :json
+    def delete(link, index_name)
+      RestClient.delete url_for(link, index_name), content_type: :json, accept: :json
     end
 
-    def commit
-      url = Rummageable.rummager_host + Rummageable.path_prefix + "/commit"
+    def commit(index_name)
+      url = Rummageable.rummager_host + index_name + "/commit"
       RestClient.post url, {}
     end
 
@@ -43,9 +43,9 @@ module Rummageable
     end
 
   private
-    def url_for(link)
+    def url_for(link, index_name)
       [
-        Rummageable.rummager_host, Rummageable.path_prefix,
+        Rummageable.rummager_host, index_name,
         "/documents/", CGI.escape(link)
       ].join("")
     end

data/lib/rummageable/version.rb

@@ -1,3 +1,3 @@
 module Rummageable
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/rummageable.rb

@@ -20,9 +20,9 @@ module Rummageable
     @rummager_host || Plek.current.find(rummager_service_name)
   end
 
-  attr_writer :path_prefix
-  def path_prefix
-    @path_prefix || ""
+  attr_writer :default_index
+  def default_index
+    @default_index || ""
   end
 
   attr_writer :implementation
@@ -33,20 +33,20 @@ module Rummageable
   # documents must be either a hash (for one document) or an array of hashes
   # (for multiple documents)
   #
-  def index(documents)
-    implementation.index(documents)
+  def index(documents, index_name = default_index)
+    implementation.index(documents, index_name)
   end
 
-  def delete(link)
-    implementation.delete(link)
+  def delete(link, index_name = default_index)
+    implementation.delete(link, index_name)
   end
 
-  def amend(link, amendments)
-    implementation.amend(link, amendments)
+  def amend(link, amendments, index_name = default_index)
+    implementation.amend(link, amendments, index_name)
   end
 
-  def commit
-    implementation.commit
+  def commit(index_name = default_index)
+    implementation.commit(index_name)
   end
 
   VALID_KEYS = [
@@ -55,6 +55,7 @@ module Rummageable
     %w[format],
     %w[section],
     %w[subsection],
+    %w[subsubsection],
     %w[link],
     %w[indexable_content],
     %w[boost_phrases],

data/test/rummageable_test.rb

@@ -13,6 +13,7 @@ class RummageableTest < MiniTest::Unit::TestCase
       "format" => "NAME OF FORMAT",
       "section" => "NAME OF SECTION",
       "subsection" => "NAME OF SUBSECTION",
+      "subsubsection" => "NAME OF SUBSUBSECTION",
       "link" => "/link",
       "indexable_content" => "TEXT",
       "boost_phrases" => "BOOST",
@@ -80,6 +81,30 @@ class RummageableTest < MiniTest::Unit::TestCase
     end
   end
 
+  def test_allows_indexing_to_an_alternative_index
+    document = {
+      "title" => "TITLE",
+      "description" => "DESCRIPTION",
+      "format" => "NAME OF FORMAT",
+      "section" => "NAME OF SECTION",
+      "subsection" => "NAME OF SUBSECTION",
+      "link" => "/link",
+      "indexable_content" => "TEXT",
+      "boost_phrases" => "BOOST",
+      "additional_links" => [
+        {"title" => "LINK1", "link" => "/link1"},
+        {"title" => "LINK2", "link" => "/link2"},
+      ]
+    }
+    json = JSON.dump([document])
+
+    stub_request(:post, "#{API}/alternative/documents").
+      with(body: json).
+      to_return(status: 200, body: '{"status":"OK"}')
+
+    Rummageable.index(document, "/alternative")
+  end
+
   def test_should_post_to_rummageable_host_determined_by_rummager_service_name
     document = {"title" => "TITLE"}
     stub_request(:post, "#{API}/documents")
@@ -100,6 +125,15 @@ class RummageableTest < MiniTest::Unit::TestCase
     Rummageable.delete(link)
   end
 
+  def test_should_allow_deletion_from_an_alternative_index
+    link = "http://example.com/foo"
+
+    stub_request(:delete, "#{API}/alternative/documents/http:%2F%2Fexample.com%2Ffoo").
+      to_return(status: 200, body: '{"status":"OK"}')
+
+    Rummageable.delete(link, '/alternative')
+  end
+
   def test_should_post_amendments
     stub_request(:post, "#{API}/documents/%2Ffoobang").
       with(body: {"title" => "Cheese", "indexable_content" => "Blah"}).
@@ -159,6 +193,13 @@ class RummageableTest < MiniTest::Unit::TestCase
     Rummageable.commit
   end
 
+  def test_should_allow_committing_an_alternative_index
+    stub_request(:post, "#{API}/alternative/commit").
+      to_return(status: 200, body: '{"result":"OK"}')
+
+    Rummageable.commit '/alternative'
+  end
+
   private
 
   def with_rummager_service_name(service_name)

metadata

@@ -2,7 +2,7 @@
 name: rummageable
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - GovUK Beta Team
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-20 00:00:00 Z
+date: 2012-10-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -87,10 +87,10 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/rummageable.rb
 - lib/rummageable/implementation.rb
-- lib/rummageable/version.rb
 - lib/rummageable/fake.rb
+- lib/rummageable/version.rb
+- lib/rummageable.rb
 - test/rummageable_test.rb
 homepage: https://github.com/alphagov/rummageable
 licenses: []
@@ -105,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 354247613567923491
+      hash: 636288066068398025
       segments: 
       - 0
       version: "0"
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 354247613567923491
+      hash: 636288066068398025
       segments: 
       - 0
       version: "0"