gds-api-adapters 7.13.0 → 7.14.0

data/lib/gds_api/exceptions.rb

@@ -12,10 +12,11 @@ module GdsApi
   end
 
   class HTTPErrorResponse < BaseError
-    attr_accessor :code
+    attr_accessor :code, :error_details
 
-    def initialize(code)
+    def initialize(code, error_details = nil)
       @code = code
+      @error_details = error_details
     end
   end
 

data/lib/gds_api/json_client.rb

@@ -88,7 +88,7 @@ module GdsApi
     end
 
     def delete_json!(url, params = nil, additional_headers = {})
-      do_request(:delete, url, params, additional_headers)
+      do_json_request(:delete, url, params, additional_headers)
     end
 
     def post_multipart(url, params)
@@ -125,12 +125,12 @@ module GdsApi
 
       rescue RestClient::Exception => e
         # Attempt to parse the body as JSON if possible
-        body = begin
+        error_details = begin
           e.http_body ? JSON.parse(e.http_body) : nil
         rescue JSON::ParserError
-          e.http_body
+          nil
         end
-        raise GdsApi::HTTPErrorResponse.new(e.http_code), body
+        raise GdsApi::HTTPErrorResponse.new(e.http_code, error_details), e.http_body
       end
 
       # If no custom response is given, just instantiate Response

data/lib/gds_api/response.rb

@@ -1,5 +1,6 @@
 require 'json'
 require 'ostruct'
+require 'forwardable'
 require_relative 'core-ext/openstruct'
 
 module GdsApi

data/lib/gds_api/router.rb

@@ -0,0 +1,33 @@
+require_relative 'base'
+#require_relative 'exceptions'
+
+class GdsApi::Router < GdsApi::Base
+
+  ### Backends
+
+  def get_backend(id)
+    get_json("#{endpoint}/backends/#{CGI.escape(id)}")
+  end
+
+  def add_backend(id, url)
+    put_json!("#{endpoint}/backends/#{CGI.escape(id)}", :backend => {:backend_url => url})
+  end
+
+  def delete_backend(id)
+    delete_json!("#{endpoint}/backends/#{CGI.escape(id)}")
+  end
+
+  ### Routes
+
+  def get_route(path, type)
+    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})
+  end
+
+  def delete_route(path, type)
+    delete_json!("#{endpoint}/routes?incoming_path=#{CGI.escape(path)}&route_type=#{CGI.escape(type)}")
+  end
+end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '7.13.0'
+  VERSION = '7.14.0'
 end

data/test/router_test.rb

@@ -0,0 +1,268 @@
+require 'test_helper'
+require 'gds_api/router'
+
+describe GdsApi::Router do
+
+  before do
+    @base_api_url = "http://router-api.example.com"
+    @api = GdsApi::Router.new(@base_api_url)
+  end
+
+  describe "managing backends" do
+    describe "fetching details about a backend" do
+      it "should return backend details" do
+        req = WebMock.stub_request(:get, "#{@base_api_url}/backends/foo").
+          to_return(:body => {"backend_id" => "foo", "backend_url" => "http://foo.example.com/"}.to_json,
+                    :headers => {"Content-type" => "application/json"})
+
+        response = @api.get_backend("foo")
+        assert_equal 200, response.code
+        assert_equal "http://foo.example.com/", response.backend_url
+
+        assert_requested(req)
+      end
+
+      it "should return nil for a non-existend backend" do
+        req = WebMock.stub_request(:get, "#{@base_api_url}/backends/foo").
+          to_return(:status => 404)
+
+        response = @api.get_backend("foo")
+        assert_nil response
+
+        assert_requested(req)
+      end
+
+      it "should URI escape the given ID" do
+        req = WebMock.stub_request(:get, "#{@base_api_url}/backends/foo+bar").
+          to_return(:status => 404)
+
+        response = @api.get_backend("foo bar")
+        assert_nil response
+
+        assert_requested(req)
+      end
+    end
+
+    describe "creating/updating a backend" do
+      it "should allow creating/updating a backend" do
+        req = WebMock.stub_request(:put, "#{@base_api_url}/backends/foo").
+          with(:body => {"backend" => {"backend_url" => "http://foo.example.com/"}}.to_json).
+          to_return(:status => 201, :body => {"backend_id" => "foo", "backend_url" => "http://foo.example.com/"}.to_json,
+                    :headers => {"Content-type" => "application/json"})
+
+        response = @api.add_backend("foo", "http://foo.example.com/")
+        assert_equal 201, response.code
+        assert_equal "http://foo.example.com/", response.backend_url
+
+        assert_requested(req)
+      end
+
+      it "should raise an error if creating/updating a backend fails" do
+        response_data = {"backend_id" => "foo", "backend_url" => "ftp://foo.example.com/", "errors" => {"backend_url" => "is not an HTTP URL"}}
+        req = WebMock.stub_request(:put, "#{@base_api_url}/backends/foo").
+          with(:body => {"backend" => {"backend_url" => "http://foo.example.com/"}}.to_json).
+          to_return(:status => 400, :body => response_data.to_json, :headers => {"Content-type" => "application/json"})
+
+        e = nil
+        begin
+          @api.add_backend("foo", "http://foo.example.com/")
+        rescue GdsApi::HTTPErrorResponse => ex
+          e = ex
+        end
+
+        refute_nil e
+        assert_equal 400, e.code
+        assert_equal response_data, e.error_details
+
+        assert_requested(req)
+      end
+
+      it "should URI escape the passed id" do
+        req = WebMock.stub_request(:put, "#{@base_api_url}/backends/foo+bar").
+          with(:body => {"backend" => {"backend_url" => "http://foo.example.com/"}}.to_json).
+          to_return(:status => 404, :body => "Not found")
+
+        # We expect a GdsApi::HTTPErrorResponse, but we want to ensure nothing else is raised
+        begin
+          @api.add_backend("foo bar", "http://foo.example.com/")
+        rescue GdsApi::HTTPErrorResponse
+        end
+
+        assert_requested(req)
+      end
+    end
+
+    describe "deleting a backend" do
+      it "allow deleting a backend" do
+        req = WebMock.stub_request(:delete, "#{@base_api_url}/backends/foo").
+          to_return(:status => 200, :body => {"backend_id" => "foo", "backend_url" => "http://foo.example.com/"}.to_json,
+                    :headers => {"Content-type" => "application/json"})
+
+        response = @api.delete_backend("foo")
+        assert_equal 200, response.code
+        assert_equal "http://foo.example.com/", response.backend_url
+
+        assert_requested(req)
+      end
+
+      it "should raise an error if deleting the backend fails" do
+        response_data = {"backend_id" => "foo", "backend_url" => "ftp://foo.example.com/", "errors" => {"base" => "Backend has routes - can't delete"}}
+        req = WebMock.stub_request(:delete, "#{@base_api_url}/backends/foo").
+          to_return(:status => 400, :body => response_data.to_json, :headers => {"Content-type" => "application/json"})
+
+        e = nil
+        begin
+          @api.delete_backend("foo")
+        rescue GdsApi::HTTPErrorResponse => ex
+          e = ex
+        end
+
+        refute_nil e
+        assert_equal 400, e.code
+        assert_equal response_data, e.error_details
+
+        assert_requested(req)
+      end
+
+      it "should URI escape the passed id" do
+        req = WebMock.stub_request(:delete, "#{@base_api_url}/backends/foo+bar").
+          to_return(:status => 404, :body => "Not found")
+
+        # We expect a GdsApi::HTTPErrorResponse, but we want to ensure nothing else is raised
+        begin
+          @api.delete_backend("foo bar")
+        rescue GdsApi::HTTPErrorResponse
+        end
+
+        assert_requested(req)
+      end
+    end
+  end
+
+  describe "managing routes" do
+    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"}
+        req = WebMock.stub_request(:get, "#{@base_api_url}/routes").
+          with(:query => {"incoming_path" => "/foo", "route_type" => "exact"}).
+          to_return(:status => 200, :body => route_data.to_json, :headers => {"Content-type" => "application/json"})
+
+        response = @api.get_route("/foo", "exact")
+        assert_equal 200, response.code
+        assert_equal "foo", response.backend_id
+
+        assert_requested(req)
+      end
+
+      it "should return nil if nothing found" do
+        req = WebMock.stub_request(:get, "#{@base_api_url}/routes").
+          with(:query => {"incoming_path" => "/foo", "route_type" => "exact"}).
+          to_return(:status => 404)
+
+        response = @api.get_route("/foo", "exact")
+        assert_nil response
+
+        assert_requested(req)
+      end
+
+      it "should escape the params" do
+        # The WebMock query matcher matches unescaped params.  The call blows up if they're not escaped
+
+        req = WebMock.stub_request(:get, "#{@base_api_url}/routes").
+          with(:query => {"incoming_path" => "/foo bar", "route_type" => "exa ct"}).
+          to_return(:status => 404)
+
+        response = @api.get_route("/foo bar", "exa ct")
+        assert_nil response
+
+        assert_requested(req)
+      end
+    end
+
+    describe "creating/updating a route" do
+      it "should allow creating/updating a route" do
+        route_data = {"incoming_path" => "/foo", "route_type" => "exact", "handler" => "backend", "backend_id" => "foo"}
+        req = WebMock.stub_request(:put, "#{@base_api_url}/routes").
+          with(:body => {"route" => route_data}.to_json).
+          to_return(:status => 201, :body => route_data.to_json, :headers => {"Content-type" => "application/json"})
+
+        response = @api.add_route("/foo", "exact", "foo")
+        assert_equal 201, response.code
+        assert_equal "foo", response.backend_id
+
+        assert_requested(req)
+      end
+
+      it "should raise an error if creating/updating the route fails" do
+        route_data = {"incoming_path" => "/foo", "route_type" => "exact", "handler" => "backend", "backend_id" => "foo"}
+        response_data = route_data.merge(:errors => {"backend_id" => "does not exist"})
+
+        response_data = {"backend_id" => "foo", "backend_url" => "ftp://foo.example.com/", "errors" => {"backend_url" => "is not an HTTP URL"}}
+        req = WebMock.stub_request(:put, "#{@base_api_url}/routes").
+          with(:body => {"route" => route_data}.to_json).
+          to_return(:status => 400, :body => response_data.to_json, :headers => {"Content-type" => "application/json"})
+
+        e = nil
+        begin
+          @api.add_route("/foo", "exact", "foo")
+        rescue GdsApi::HTTPErrorResponse => ex
+          e = ex
+        end
+
+        refute_nil e
+        assert_equal 400, e.code
+        assert_equal response_data, e.error_details
+
+        assert_requested(req)
+      end
+    end
+
+    describe "deleting a route" do
+      it "should allow deleting a route" do
+        route_data = {"incoming_path" => "/foo", "route_type" => "exact", "handler" => "backend", "backend_id" => "foo"}
+        req = WebMock.stub_request(:delete, "#{@base_api_url}/routes").
+          with(:query => {"incoming_path" => "/foo", "route_type" => "exact"}).
+          to_return(:status => 200, :body => route_data.to_json, :headers => {"Content-type" => "application/json"})
+
+        response = @api.delete_route("/foo", "exact")
+        assert_equal 200, response.code
+        assert_equal "foo", response.backend_id
+
+        assert_requested(req)
+      end
+
+      it "should raise HTTPNotFound if nothing found" do
+        req = WebMock.stub_request(:delete, "#{@base_api_url}/routes").
+          with(:query => {"incoming_path" => "/foo", "route_type" => "exact"}).
+          to_return(:status => 404)
+
+        e = nil
+        begin
+          @api.delete_route("/foo", "exact")
+        rescue GdsApi::HTTPNotFound => ex
+          e = ex
+        end
+
+        refute_nil e
+        assert_equal 404, e.code
+
+        assert_requested(req)
+      end
+
+      it "should escape the params" do
+        # The WebMock query matcher matches unescaped params.  The call blows up if they're not escaped
+
+        req = WebMock.stub_request(:delete, "#{@base_api_url}/routes").
+          with(:query => {"incoming_path" => "/foo bar", "route_type" => "exa ct"}).
+          to_return(:status => 404)
+
+        begin
+          @api.delete_route("/foo bar", "exa ct")
+        rescue GdsApi::HTTPNotFound
+        end
+
+        assert_requested(req)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 7.13.0
+  version: 7.14.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-22 00:00:00.000000000 Z
+date: 2013-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -299,6 +299,7 @@ files:
 - lib/gds_api/core-ext/openstruct.rb
 - lib/gds_api/response.rb
 - lib/gds_api/publisher.rb
+- lib/gds_api/router.rb
 - lib/gds_api/content_api.rb
 - README.md
 - Rakefile
@@ -320,6 +321,7 @@ files:
 - test/asset_manager_test.rb
 - test/fixtures/hello.txt
 - test/fixtures/world_organisations_australia.json
+- test/router_test.rb
 - test/list_response_test.rb
 - test/gds_api_base_test.rb
 - test/worldwide_api_test.rb
@@ -338,7 +340,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3882474794805816869
+      hash: -758637662694178891
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -347,7 +349,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3882474794805816869
+      hash: -758637662694178891
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -373,6 +375,7 @@ test_files:
 - test/asset_manager_test.rb
 - test/fixtures/hello.txt
 - test/fixtures/world_organisations_australia.json
+- test/router_test.rb
 - test/list_response_test.rb
 - test/gds_api_base_test.rb
 - test/worldwide_api_test.rb