gds-api-adapters 7.17.1 → 7.18.0

data/lib/gds_api/router.rb

@@ -23,16 +23,26 @@ class GdsApi::Router < GdsApi::Base
     get_json("#{endpoint}/routes?incoming_path=#{CGI.escape(path)}&route_type=#{CGI.escape(type)}")
   end
 
-  def add_route(path, type, backend_id)
-    put_json!("#{endpoint}/routes", :route => {:incoming_path => path, :route_type => type, :handler => "backend", :backend_id => backend_id})
+  def add_route(path, type, backend_id, options = {})
+    response = put_json!("#{endpoint}/routes", :route => {:incoming_path => path, :route_type => type, :handler => "backend", :backend_id => backend_id})
+    commit_routes unless options[:skip_commit]
+    response
   end
 
-  def add_redirect_route(path, type, destination, redirect_type = "permanent")
-    put_json!("#{endpoint}/routes", :route => {:incoming_path => path, :route_type => type, :handler => "redirect",
+  def add_redirect_route(path, type, destination, redirect_type = "permanent", options = {})
+    response = put_json!("#{endpoint}/routes", :route => {:incoming_path => path, :route_type => type, :handler => "redirect",
               :redirect_to => destination, :redirect_type => redirect_type})
+    commit_routes unless options[:skip_commit]
+    response
   end
 
-  def delete_route(path, type)
-    delete_json!("#{endpoint}/routes?incoming_path=#{CGI.escape(path)}&route_type=#{CGI.escape(type)}")
+  def delete_route(path, type, options = {})
+    response = delete_json!("#{endpoint}/routes?incoming_path=#{CGI.escape(path)}&route_type=#{CGI.escape(type)}")
+    commit_routes unless options[:skip_commit]
+    response
+  end
+
+  def commit_routes
+    post_json!("#{endpoint}/routes/commit", {})
   end
 end

data/lib/gds_api/rummager.rb

@@ -5,12 +5,12 @@ module GdsApi
   class Rummager < Base
 
     def search(query, extra_params={})
-      return [] if query.nil? || query == ""
+      raise ArgumentError.new("Query cannot be blank") if query.nil? || query.strip.empty?
       get_json!(search_url(:search, query, extra_params))
     end
 
     def advanced_search(args)
-      return [] if args.nil? || args.empty?
+      raise ArgumentError.new("Args cannot be blank") if args.nil? || args.empty?
       request_path = "#{base_url}/advanced_search?#{Rack::Utils.build_nested_query(args)}"
       get_json!(request_path)
     end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '7.17.1'
+  VERSION = '7.18.0'
 end

data/test/router_test.rb

@@ -140,6 +140,11 @@ describe GdsApi::Router do
   end
 
   describe "managing routes" do
+    before :each do
+      @commit_req = WebMock.stub_request(:post, "#{@base_api_url}/routes/commit").
+        to_return(:status => 200, :body => "Routers updated")
+    end
+
     describe "fetching a route" do
       it "should return the route details" do
         route_data = {"incoming_path" => "/foo", "route_type" => "exact", "handler" => "backend", "backend_id" => "foo"}
@@ -152,6 +157,7 @@ describe GdsApi::Router do
         assert_equal "foo", response.backend_id
 
         assert_requested(req)
+        assert_not_requested(@commit_req)
       end
 
       it "should return nil if nothing found" do
@@ -163,6 +169,7 @@ describe GdsApi::Router do
         assert_nil response
 
         assert_requested(req)
+        assert_not_requested(@commit_req)
       end
 
       it "should escape the params" do
@@ -176,6 +183,7 @@ describe GdsApi::Router do
         assert_nil response
 
         assert_requested(req)
+        assert_not_requested(@commit_req)
       end
     end
 
@@ -191,6 +199,17 @@ describe GdsApi::Router do
         assert_equal "foo", response.backend_id
 
         assert_requested(req)
+        assert_requested(@commit_req)
+      end
+
+      it "should not commit the routes when asked not to" do
+        req = WebMock.stub_request(:put, "#{@base_api_url}/routes").
+          to_return(:status => 201, :body => {}.to_json, :headers => {"Content-type" => "application/json"})
+
+        @api.add_route("/foo", "exact", "foo", :skip_commit => true)
+
+        assert_requested(req)
+        assert_not_requested(@commit_req)
       end
 
       it "should raise an error if creating/updating the route fails" do
@@ -213,6 +232,7 @@ describe GdsApi::Router do
         assert_equal response_data, e.error_details
 
         assert_requested(req)
+        assert_not_requested(@commit_req)
       end
     end
 
@@ -228,6 +248,7 @@ describe GdsApi::Router do
         assert_equal "/bar", response.redirect_to
 
         assert_requested(req)
+        assert_requested(@commit_req)
       end
 
       it "should allow creating/updating a temporary redirect route" do
@@ -241,6 +262,17 @@ describe GdsApi::Router do
         assert_equal "/bar", response.redirect_to
 
         assert_requested(req)
+        assert_requested(@commit_req)
+      end
+
+      it "should not commit the routes when asked not to" do
+        req = WebMock.stub_request(:put, "#{@base_api_url}/routes").
+          to_return(:status => 201, :body =>{}.to_json, :headers => {"Content-type" => "application/json"})
+
+        @api.add_redirect_route("/foo", "exact", "/bar", "temporary", :skip_commit => true)
+
+        assert_requested(req)
+        assert_not_requested(@commit_req)
       end
 
       it "should raise an error if creating/updating the redirect route fails" do
@@ -263,6 +295,7 @@ describe GdsApi::Router do
         assert_equal response_data, e.error_details
 
         assert_requested(req)
+        assert_not_requested(@commit_req)
       end
     end
 
@@ -278,6 +311,18 @@ describe GdsApi::Router do
         assert_equal "foo", response.backend_id
 
         assert_requested(req)
+        assert_requested(@commit_req)
+      end
+
+      it "should not commit the routes when asked not to" do
+        req = WebMock.stub_request(:delete, "#{@base_api_url}/routes").
+          with(:query => {"incoming_path" => "/foo", "route_type" => "exact"}).
+          to_return(:status => 200, :body => {}.to_json, :headers => {"Content-type" => "application/json"})
+
+        @api.delete_route("/foo", "exact", :skip_commit => true)
+
+        assert_requested(req)
+        assert_not_requested(@commit_req)
       end
 
       it "should raise HTTPNotFound if nothing found" do
@@ -296,6 +341,7 @@ describe GdsApi::Router do
         assert_equal 404, e.code
 
         assert_requested(req)
+        assert_not_requested(@commit_req)
       end
 
       it "should escape the params" do
@@ -313,5 +359,29 @@ describe GdsApi::Router do
         assert_requested(req)
       end
     end
+
+    describe "committing the routes" do
+      it "should allow committing the routes" do
+        @api.commit_routes
+
+        assert_requested(@commit_req)
+      end
+
+      it "should raise an error if committing the routes fails" do
+        req = WebMock.stub_request(:post, "#{@base_api_url}/routes/commit").
+          to_return(:status => 500, :body => "Failed to update all routers")
+
+        e = nil
+        begin
+          @api.commit_routes
+        rescue GdsApi::HTTPErrorResponse => ex
+          e = ex
+        end
+
+        refute_nil e
+        assert_equal 500, e.code
+        assert_equal "Failed to update all routers", e.message
+      end
+    end
   end
 end

data/test/rummager_test.rb

@@ -37,17 +37,15 @@ describe GdsApi::Rummager do
   end
 
   it "should return an empty set of results without making request if query is empty" do
-    results = GdsApi::Rummager.new("http://example.com").search("")
-
-    assert_equal [], results
-    assert_not_requested :get, /example.com/
+    assert_raises(ArgumentError) do
+      GdsApi::Rummager.new("http://example.com").search("")
+    end
   end
 
   it "should return an empty set of results without making request if query is nil" do
-    results = GdsApi::Rummager.new("http://example.com").search(nil)
-
-    assert_equal [], results
-    assert_not_requested :get, /example.com/
+    assert_raises(ArgumentError) do
+      GdsApi::Rummager.new("http://example.com").search(nil)
+    end
   end
 
   it "should request the search results in JSON format" do
@@ -116,17 +114,15 @@ describe GdsApi::Rummager do
   end
 
   it "#advanced_search should return an empty set of results without making request if arguments are empty" do
-    results = GdsApi::Rummager.new("http://example.com").advanced_search({})
-
-    assert_equal [], results
-    assert_not_requested :get, /example.com/
+    assert_raises(ArgumentError) do
+      GdsApi::Rummager.new("http://example.com").advanced_search({})
+    end
   end
 
   it "#advanced_search should return an empty set of results without making request if arguments is nil" do
-    results = GdsApi::Rummager.new("http://example.com").advanced_search(nil)
-
-    assert_equal [], results
-    assert_not_requested :get, /example.com/
+    assert_raises(ArgumentError) do
+      results = GdsApi::Rummager.new("http://example.com").advanced_search(nil)
+    end
   end
 
   it "#advanced_search should request the search results in JSON format" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 7.17.1
+  version: 7.18.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-01 00:00:00.000000000 Z
+date: 2013-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -340,7 +340,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -187163505061002706
+      hash: 471718950989814646
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -349,7 +349,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -187163505061002706
+      hash: 471718950989814646
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23