Moving the REST API functions into a module

This module is now used by the client and
server side, rather than having a Handler module
that's 90% server functionality but also used by
the client.

While we don't automatically get api choice from this,
it at least provides a pattern for how we'll handle API
development over time.

Signed-off-by: Luke Kanies <luke@madstop.com>

1 files changed, 122 insertions, 0 deletions

diff --git a/spec/unit/network/http/api/v1.rb b/spec/unit/network/http/api/v1.rb
new file mode 100644
index 000000000..fc284de82
--- /dev/null
+++ b/spec/unit/network/http/api/v1.rb
@@ -0,0 +1,122 @@
+#!/usr/bin/env ruby
+
+Dir.chdir(File.dirname(__FILE__)) { (s = lambda { |f| File.exist?(f) ? require(f) : Dir.chdir("..") { s.call(f) } }).call("spec/spec_helper.rb") }
+
+require 'puppet/network/http/api/v1'
+
+class V1RestApiTester
+    include Puppet::Network::HTTP::API::V1
+end
+
+describe Puppet::Network::HTTP::API::V1 do
+    before do
+        @tester = V1RestApiTester.new
+    end
+
+    it "should be able to convert a URI into a request" do
+        @tester.should respond_to(:uri2indirection)
+    end
+
+    it "should be able to convert a request into a URI" do
+        @tester.should respond_to(:indirection2uri)
+    end
+
+    describe "when converting a URI into a request" do
+        before do
+            @tester.stubs(:handler).returns "foo"
+        end
+
+        it "should require the http method, the URI, and the query parameters" do
+            # Not a terribly useful test, but an important statement for the spec
+            lambda { @tester.uri2indirection("/foo") }.should raise_error(ArgumentError)
+        end
+
+        it "should use the first field of the URI as the environment" do
+            @tester.uri2indirection("GET", "/env/foo/bar", {}).environment.should == Puppet::Node::Environment.new("env")
+        end
+
+        it "should fail if the environment is not alphanumeric" do
+            lambda { @tester.uri2indirection("GET", "/env ness/foo/bar", {}) }.should raise_error(ArgumentError)
+        end
+
+        it "should use the environment from the URI even if one is specified in the parameters" do
+            @tester.uri2indirection("GET", "/env/foo/bar", {:environment => "otherenv"}).environment.should == Puppet::Node::Environment.new("env")
+        end
+
+        it "should use the second field of the URI as the indirection name" do
+            @tester.uri2indirection("GET", "/env/foo/bar", {}).indirection_name.should == :foo
+        end
+
+        it "should fail if the indirection name is not alphanumeric" do
+            lambda { @tester.uri2indirection("GET", "/env/foo ness/bar", {}) }.should raise_error(ArgumentError)
+        end
+
+        it "should use the remainder of the URI as the indirection key" do
+            @tester.uri2indirection("GET", "/env/foo/bar", {}).key.should == "bar"
+        end
+
+        it "should support the indirection key being a /-separated file path" do
+            @tester.uri2indirection("GET", "/env/foo/bee/baz/bomb", {}).key.should == "bee/baz/bomb"
+        end
+
+        it "should fail if no indirection key is specified" do
+            lambda { @tester.uri2indirection("GET", "/env/foo/", {}) }.should raise_error(ArgumentError)
+            lambda { @tester.uri2indirection("GET", "/env/foo", {}) }.should raise_error(ArgumentError)
+        end
+
+        it "should choose 'find' as the indirection method if the http method is a GET and the indirection name is singular" do
+            @tester.uri2indirection("GET", "/env/foo/bar", {}).method.should == :find
+        end
+
+        it "should choose 'search' as the indirection method if the http method is a GET and the indirection name is plural" do
+            @tester.uri2indirection("GET", "/env/foos/bar", {}).method.should == :search
+        end
+
+        it "should choose 'delete' as the indirection method if the http method is a DELETE and the indirection name is singular" do
+            @tester.uri2indirection("DELETE", "/env/foo/bar", {}).method.should == :destroy
+        end
+
+        it "should choose 'save' as the indirection method if the http method is a PUT and the indirection name is singular" do
+            @tester.uri2indirection("PUT", "/env/foo/bar", {}).method.should == :save
+        end
+
+        it "should fail if an indirection method cannot be picked" do
+            lambda { @tester.uri2indirection("UPDATE", "/env/foo/bar", {}) }.should raise_error(ArgumentError)
+        end
+
+        it "should URI unescape the indirection key" do
+            escaped = URI.escape("foo bar")
+            @tester.uri2indirection("GET", "/env/foo/#{escaped}", {}).key.should == "foo bar"
+        end
+    end
+
+    describe "when converting a request into a URI" do
+        before do
+            @request = Puppet::Indirector::Request.new(:foo, :find, "with spaces", :foo => :bar, :environment => "myenv")
+        end
+
+        it "should use the environment as the first field of the URI" do
+            @tester.indirection2uri(@request).split("/")[1].should == "myenv"
+        end
+
+        it "should use the indirection as the second field of the URI" do
+            @tester.indirection2uri(@request).split("/")[2].should == "foo"
+        end
+
+        it "should pluralize the indirection name if the method is 'search'" do
+            @request.stubs(:method).returns :search
+            @tester.indirection2uri(@request).split("/")[2].should == "foos"
+        end
+
+        it "should use the escaped key as the remainder of the URI" do
+            escaped = URI.escape("with spaces")
+            @tester.indirection2uri(@request).split("/")[3].sub(/\?.+/, '').should == escaped
+        end
+
+        it "should add the query string to the URI" do
+            @request.expects(:query_string).returns "?query"
+            @tester.indirection2uri(@request).should =~ /\?query$/
+        end
+    end
+
+end