dm-rest-adapter 0.9.10 → 0.9.11

data/lib/rest_adapter/version.rb

@@ -1,5 +1,3 @@
-module DataMapper
-  class RestAdapter
-    VERSION = '0.9.10'
-  end
+module DataMapperRest
+  VERSION = '0.9.11'
 end

data/spec/connection_spec.rb

@@ -0,0 +1,130 @@
+$LOAD_PATH << File.dirname(__FILE__)
+require 'spec_helper'
+
+describe 'A Connection instance' do
+
+  before do
+    @username = "admin"
+    @password = "tot@ls3crit"
+    @uri = DataObjects::URI.parse(Addressable::URI.new(
+      :scheme       => 'http',
+      :adapter      => 'rest',
+      :user         => @username,
+      :password     => @password,
+      :host         => 'localhost',
+      :port         => '4000',
+      :query        => nil
+      ))
+    @connection = DataMapperRest::Connection.new(@uri, "xml")
+  end
+
+  it "should construct a valid uri" do
+    @connection.uri.to_s.should == "http://#{@username}:#{@password}@localhost:4000"
+    @connection.uri.host.should == "localhost"
+    @connection.uri.port.should == 4000
+    @connection.uri.user.should == @username
+    @connection.uri.password.should == @password
+  end
+
+  it "should return the correct extension and mime type for xml" do
+    @connection.format.header.should == {'Content-Type' => "application/xml"}
+  end
+
+  it "should return the correct extension and mime type for json" do
+    connection = DataMapperRest::Connection.new(@uri, "json")
+    connection.format.header.should == {'Content-Type' => "application/json"}
+  end
+
+  describe 'when running the verb methods' do
+
+    it 'should make an HTTP Post' do
+      @connection.should_receive(:run_verb).with("post", "<somexml>")
+      @connection.http_post("foobars", "<somexml>")
+    end
+
+    it 'should make an HTTP Get' do
+      @connection.should_receive(:run_verb).with("get", "<somexml>")
+      @connection.http_get("foobars", "<somexml>")
+    end
+
+    it 'should make an HTTP Put' do
+      @connection.should_receive(:run_verb).with("put", "<somexml>")
+      @connection.http_put("foobars", "<somexml>")
+    end
+
+    it 'should make an HTTP Delete' do
+      @connection.should_receive(:run_verb).with("delete", "<somexml>")
+      @connection.http_delete("foobars", "<somexml>")
+    end
+
+    it "should only accept the listed verbs" do
+      @connection.should_not_receive(:run_verb).with("delete", "<somexml>")
+      @connection.http_explode("foobars", "<somexml>")
+    end
+
+  end
+
+  describe "when receiving error response codes" do
+
+    before do
+      @mock_http = mock("http")
+      Net::HTTP.should_receive(:start).with(@connection.uri.host, @connection.uri.port).and_yield @mock_http
+      @mock_resp = mock("response")
+      @mock_resp.stub!(:body).and_return ""
+    end
+
+    it "should raise 404" do
+      @mock_http.should_receive(:request).and_return Net::HTTPResponse.new(1, 404, "oops")
+      lambda {@connection.http_post("foobars", "<somexml>")}.should raise_error(DataMapperRest::ResourceNotFound, "Resource action failed with code: 404, message: oops")
+    end
+
+    it "should redirect on 301" do
+      @mock_http.should_receive(:request).and_return Net::HTTPResponse.new(1, 301, "moved")
+      lambda {@connection.http_post("foobars", "<somexml>")}.should raise_error(DataMapperRest::Redirection, "Resource action failed with code: 301, message: moved")
+    end
+
+    it "should redirect on 302" do
+      @mock_http.should_receive(:request).and_return Net::HTTPResponse.new(1, 302, "moved")
+      lambda {@connection.http_post("foobars", "<somexml>")}.should raise_error(DataMapperRest::Redirection, "Resource action failed with code: 302, message: moved")
+    end
+
+    it "should raise bad request on 400" do
+      @mock_http.should_receive(:request).and_return Net::HTTPResponse.new(1, 400, "bad mojo")
+
+      lambda {@connection.http_post("foobars", "<somexml>")}.should raise_error(DataMapperRest::BadRequest, "Resource action failed with code: 400, message: bad mojo")
+    end
+
+    it "should raise MethodNotAllowed on 405" do
+      @mock_http.should_receive(:request).and_return Net::HTTPResponse.new(1, 405, "nope zero")
+
+      lambda {@connection.http_post("foobars", "<somexml>")}.should raise_error(DataMapperRest::MethodNotAllowed, "Resource action failed with code: 405, message: nope zero")
+    end
+
+    it "should raise ResourceConflict on 409" do
+      @mock_http.should_receive(:request).and_return Net::HTTPResponse.new(1, 409, "should I stay or should I go")
+
+      lambda {@connection.http_post("foobars", "<somexml>")}.should raise_error(DataMapperRest::ResourceConflict, "Resource action failed with code: 409, message: should I stay or should I go")
+    end
+
+    it "should raise ResourceInvalid on 422" do
+      @mock_resp.should_receive(:code).twice.and_return 422
+      @mock_resp.should_receive(:message).and_return "WTF"
+      @mock_http.should_receive(:request).and_return @mock_resp
+
+      lambda {@connection.http_post("foobars", "<somexml>")}.should raise_error(DataMapperRest::ResourceInvalid, "Resource action failed with code: 422, message: WTF")
+    end
+
+    it "should raise ClientError on 401" do
+      @mock_http.should_receive(:request).and_return Net::HTTPResponse.new(1, 401, "no idea")
+
+      lambda {@connection.http_post("foobars", "<somexml>")}.should raise_error(DataMapperRest::ClientError, "Resource action failed with code: 401, message: no idea")
+    end
+
+    it "should raise ServerError on 500" do
+      @mock_http.should_receive(:request).and_return Net::HTTPResponse.new(1, 500, "I broken")
+
+      lambda {@connection.http_post("foobars", "<somexml>")}.should raise_error(DataMapperRest::ServerError, "Resource action failed with code: 500, message: I broken")
+    end
+
+  end
+end

data/spec/crud_spec.rb

@@ -0,0 +1,250 @@
+$LOAD_PATH << File.dirname(__FILE__)
+require 'spec_helper'
+
+describe 'A REST adapter' do
+
+  before do
+    @book = Book.new(:title => 'Hello, World!', :author => 'Anonymous')
+    @adapter = DataMapper::Repository.adapters[:default]
+  end
+
+  describe 'when saving a new resource' do
+
+    before(:each) do
+      @mock_resp = mock("response")
+
+      @book.id = 1
+      @mock_resp.should_receive(:body).and_return @book.to_xml
+    end
+
+    it "should create a book" do
+      @mock_http = mock("http")
+      Net::HTTP.should_receive(:start).and_yield @mock_http
+
+      @mock_resp.should_receive(:code).and_return 200
+
+      @mock_http.should_receive(:request).and_return @mock_resp
+
+      @book.save.should eql(true)
+    end
+
+    it 'should make an HTTP POST' do
+      @adapter.connection.should_receive(:http_post).with('books', @book.to_xml).and_return @mock_resp
+      @book.save
+    end
+
+    it 'should call run_verb with POST' do
+      @adapter.connection.should_receive(:run_verb).with('post', @book.to_xml).and_return @mock_resp
+      @book.save
+    end
+
+  end
+
+  describe 'when returning incorrect xml from a save' do
+    before(:all) do
+      @mock_resp = mock("response")
+    end
+
+    it "should raise error on missing root element in xml" do
+      @mock_resp.should_receive(:body).and_return ""
+      @adapter.connection.should_receive(:run_verb).with('post', @book.to_xml).and_return @mock_resp
+
+      lambda {@book.save}.should raise_error(RuntimeError, "No root element matching book in xml")
+    end
+
+    it "should not raise an error if the root xml is empty" do
+      @mock_resp.should_receive(:body).and_return "<book></book>"
+      @adapter.connection.should_receive(:run_verb).with('post', @book.to_xml).and_return @mock_resp
+
+      lambda {@book.save}.should_not raise_error(RuntimeError)
+    end
+  end
+
+  describe 'when deleting an existing resource' do
+    before do
+      @book.stub!(:new_record?).and_return(false)
+    end
+
+    it 'should do an HTTP DELETE' do
+      @adapter.connection.should_receive(:http_delete)
+      @book.destroy
+    end
+
+    it "should raise NotImplementedError if is not a single resource query" do
+      @adapter.should_receive(:is_single_resource_query?).and_return(false)
+      lambda {@book.destroy}.should raise_error(NotImplementedError)
+    end
+
+    it 'should call run_verb with DELETE and no data' do
+      @adapter.connection.should_receive(:run_verb).with('delete', nil)
+      @book.destroy
+    end
+
+    it "should return false if the record does not exist in the repository" do
+      @book.should_receive(:new_record?).and_return(true)
+      @book.destroy.should eql(false)
+    end
+  end
+
+  describe 'when getting one resource' do
+
+    describe 'if the resource exists' do
+
+      before do
+        book_xml = <<-BOOK
+        <?xml version='1.0' encoding='UTF-8'?>
+        <book>
+          <author>Stephen King</author>
+          <created-at type='datetime'>2008-06-08T17:03:07Z</created-at>
+          <id type='integer'>1</id>
+          <title>The Shining</title>
+          <updated-at type='datetime'>2008-06-08T17:03:07Z</updated-at>
+        </book>
+        BOOK
+        @id = 1
+        @response = mock(Net::HTTPResponse)
+        @response.stub!(:body).and_return(book_xml)
+        @adapter.connection.stub!(:http_get).and_return(@response)
+      end
+
+      it 'should return the resource' do
+        book = Book.get(@id)
+        book.should_not be_nil
+        book.id.should be_an_instance_of(Fixnum)
+        book.id.should == 1
+      end
+
+      it "should have its attributes well formed" do
+        book = Book.get(@id)
+        book.author.should == 'Stephen King'
+        book.title.should == 'The Shining'
+      end
+
+      it 'should do an HTTP GET' do
+        @adapter.connection.should_receive(:http_get).with('books/1').and_return(@response)
+        Book.get(@id)
+      end
+
+      it "should be equal to itself" do
+        Book.get(@id).should == Book.get(@id)
+      end
+
+      it "should return its cached version when it was already fetched" do
+        book = mock(Book, :kind_of? => Book)
+        repo = mock(DataMapper::Repository)
+        ident_map = mock(DataMapper::IdentityMap)
+
+        Book.should_receive(:repository).and_return(repo)
+        repo.should_receive(:identity_map).and_return(ident_map)
+        ident_map.stub!(:get).with([@id]).and_return(book)
+
+        # The remote resource won't be called when a cached object exists
+        Book.should_receive(:first).never
+        Book.get(@id).should be_a_kind_of(Book)
+      end
+
+      it "should call read_one method" do
+        @adapter.should_receive(:read_one)
+        Book.get(@id)
+      end
+    end
+
+    describe 'if the resource does not exist' do
+      it 'should raise DataMapperRest::ResourceNotFound' do
+        @mock_resp = mock("response")
+        @mock_http = mock("http")
+        Net::HTTP.should_receive(:start).and_yield @mock_http
+
+        @mock_resp.should_receive(:code).and_return 404
+        @mock_http.should_receive(:request).and_return @mock_resp
+
+        lambda{ Book.get(5000) }.should raise_error(DataMapperRest::ResourceNotFound)
+      end
+    end
+  end
+
+  describe 'when getting all resource of a particular type' do
+    before do
+      books_xml = <<-BOOK
+      <?xml version='1.0' encoding='UTF-8'?>
+      <books type='array'>
+        <book>
+          <author>Ursula K LeGuin</author>
+          <created-at type='datetime'>2008-06-08T17:02:28Z</created-at>
+          <id type='integer'>1</id>
+          <title>The Dispossed</title>
+          <updated-at type='datetime'>2008-06-08T17:02:28Z</updated-at>
+        </book>
+        <book>
+          <author>Stephen King</author>
+          <created-at type='datetime'>2008-06-08T17:03:07Z</created-at>
+          <id type='integer'>2</id>
+          <title>The Shining</title>
+          <updated-at type='datetime'>2008-06-08T17:03:07Z</updated-at>
+        </book>
+      </books>
+      BOOK
+      @response = mock(Net::HTTPResponse)
+      @response.stub!(:body).and_return(books_xml)
+    end
+
+    it 'should get a non-empty list' do
+      @adapter.connection.stub!(:http_get).and_return(@response)
+      Book.all.should_not be_empty
+    end
+
+    it 'should receive one Resource for each entity in the XML' do
+      @adapter.connection.stub!(:http_get).and_return(@response)
+      Book.all.size.should == 2
+    end
+
+    it "should call read_many method" do
+      @adapter.connection.stub!(:http_get).and_return(@response)
+      @adapter.should_receive(:read_many)
+      Book.all
+    end
+
+    it "should raise NotImplementedError if conditions are specified" do
+      # Have to find a way to set an expectation for a method call inside a block
+      # Book.all(:title => "NonExistentTitle")
+    end
+  end
+
+  describe 'when updating an existing resource' do
+    before do
+      @books_xml = <<-XML
+      <book>
+        <id type='integer'>42</id>
+        <title>Starship Troopers</title>
+        <author>Robert Heinlein</author>
+        <created-at type='datetime'>2008-06-08T17:02:28Z</created-at>
+      </book>
+      XML
+      repository do |repo|
+        @repository = repo
+        @book = Book.new(:id => 42,
+                         :title => 'Starship Troopers',
+                         :author => 'Robert Heinlein',
+                         :created_at => DateTime.parse('2008-06-08T17:02:28Z'))
+        @book.instance_eval { @new_record = false }
+        @repository.identity_map(Book)[@book.key] = @book
+        @book.title = "Mary Had a Little Lamb"
+      end
+    end
+
+    it 'should do an HTTP PUT' do
+      @adapter.connection.should_receive(:http_put).with('books/42', @book.to_xml)
+      @repository.scope do
+        @book.save
+      end
+    end
+
+    it "should not do an HTTP PUT for non-dirty resources" do
+      @book.should_receive(:dirty_attributes).and_return({})
+      @adapter.connection.should_receive(:http_put).never
+      @repository.scope do
+        @book.save
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -9,12 +9,7 @@ $LOAD_PATH.unshift(lib) if lib.directory?
 
 require ROOT + 'lib/rest_adapter'
 
-DataMapper.setup(:default, {
-  :adapter  => 'rest',
-  :format => 'xml',
-  :host => 'localhost',
-  :port => '3001'
-})
+load ROOT + 'config/database.rb.example'
 
 class Book
   include DataMapper::Resource

data/tasks/spec.rb

@@ -1,5 +1,5 @@
 begin
-  gem 'rspec', '~>1.1.11'
+  gem 'rspec', '~>1.2'
   require 'spec'
   require 'spec/rake/spectask'
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: dm-rest-adapter
 version: !ruby/object:Gem::Version 
-  version: 0.9.10
+  version: 0.9.11
 platform: ruby
 authors: 
-- Potomac Ruby Hackers
+- Scott Burton @ Joyent Inc
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-01-19 00:00:00 -08:00
+date: 2009-03-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -18,13 +18,13 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ~>
+    - - "="
       - !ruby/object:Gem::Version 
-        version: 0.9.10
+        version: 0.9.11
     version: 
 description: REST Adapter for DataMapper
 email: 
-- potomac-ruby-hackers [a] googlegroups [d] com
+- scott.burton [a] joyent [d] com
 executables: []
 
 extensions: []
@@ -38,105 +38,27 @@ files:
 - History.txt
 - LICENSE
 - Manifest.txt
+- README.markdown
 - README.txt
 - Rakefile
 - TODO
-- fixtures/book_service/README
-- fixtures/book_service/Rakefile
-- fixtures/book_service/app/controllers/application.rb
-- fixtures/book_service/app/controllers/books_controller.rb
-- fixtures/book_service/app/controllers/shelves_controller.rb
-- fixtures/book_service/app/helpers/application_helper.rb
-- fixtures/book_service/app/helpers/books_helper.rb
-- fixtures/book_service/app/helpers/shelf_helper.rb
-- fixtures/book_service/app/models/book.rb
-- fixtures/book_service/app/models/shelf.rb
-- fixtures/book_service/app/views/books/edit.html.erb
-- fixtures/book_service/app/views/books/index.html.erb
-- fixtures/book_service/app/views/books/new.html.erb
-- fixtures/book_service/app/views/books/show.html.erb
-- fixtures/book_service/app/views/layouts/books.html.erb
-- fixtures/book_service/app/views/shelves/edit.html.erb
-- fixtures/book_service/app/views/shelves/index.html.erb
-- fixtures/book_service/app/views/shelves/new.html.erb
-- fixtures/book_service/app/views/shelves/show.html.erb
-- fixtures/book_service/config/boot.rb
-- fixtures/book_service/config/database.yml
-- fixtures/book_service/config/environment.rb
-- fixtures/book_service/config/environments/development.rb
-- fixtures/book_service/config/environments/production.rb
-- fixtures/book_service/config/environments/test.rb
-- fixtures/book_service/config/initializers/inflections.rb
-- fixtures/book_service/config/initializers/mime_types.rb
-- fixtures/book_service/config/initializers/new_rails_defaults.rb
-- fixtures/book_service/config/routes.rb
-- fixtures/book_service/db/development.sqlite3
-- fixtures/book_service/db/migrate/20080608165526_create_books.rb
-- fixtures/book_service/db/migrate/20080621171551_create_shelves.rb
-- fixtures/book_service/db/migrate/20080629143033_create_fake_books_and_shelves.rb
-- fixtures/book_service/db/schema.rb
-- fixtures/book_service/public/404.html
-- fixtures/book_service/public/422.html
-- fixtures/book_service/public/500.html
-- fixtures/book_service/public/dispatch.cgi
-- fixtures/book_service/public/dispatch.fcgi
-- fixtures/book_service/public/dispatch.rb
-- fixtures/book_service/public/favicon.ico
-- fixtures/book_service/public/images/rails.png
-- fixtures/book_service/public/index.html
-- fixtures/book_service/public/javascripts/application.js
-- fixtures/book_service/public/javascripts/controls.js
-- fixtures/book_service/public/javascripts/dragdrop.js
-- fixtures/book_service/public/javascripts/effects.js
-- fixtures/book_service/public/javascripts/prototype.js
-- fixtures/book_service/public/robots.txt
-- fixtures/book_service/public/stylesheets/scaffold.css
-- fixtures/book_service/script/about
-- fixtures/book_service/script/console
-- fixtures/book_service/script/dbconsole
-- fixtures/book_service/script/destroy
-- fixtures/book_service/script/generate
-- fixtures/book_service/script/performance/benchmarker
-- fixtures/book_service/script/performance/profiler
-- fixtures/book_service/script/performance/request
-- fixtures/book_service/script/plugin
-- fixtures/book_service/script/process/inspector
-- fixtures/book_service/script/process/reaper
-- fixtures/book_service/script/process/spawner
-- fixtures/book_service/script/runner
-- fixtures/book_service/script/server
-- fixtures/book_service/test/fixtures/books.yml
-- fixtures/book_service/test/fixtures/shelves.yml
-- fixtures/book_service/test/functional/books_controller_test.rb
-- fixtures/book_service/test/functional/shelf_controller_test.rb
-- fixtures/book_service/test/test_helper.rb
-- fixtures/book_service/test/unit/book_test.rb
-- fixtures/book_service/test/unit/shelf_test.rb
+- config/database.rb.example
+- dm-rest-adapter.gemspec
 - lib/rest_adapter.rb
+- lib/rest_adapter/adapter.rb
+- lib/rest_adapter/connection.rb
+- lib/rest_adapter/exceptions.rb
+- lib/rest_adapter/formats.rb
 - lib/rest_adapter/version.rb
-- spec/create_spec.rb
-- spec/delete_spec.rb
-- spec/read_spec.rb
+- spec/connection_spec.rb
+- spec/crud_spec.rb
 - spec/ruby_forker.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- spec/update_spec.rb
-- stories/all.rb
-- stories/crud/create
-- stories/crud/delete
-- stories/crud/read
-- stories/crud/stories.rb
-- stories/crud/update
-- stories/helper.rb
-- stories/resources/helpers/book.rb
-- stories/resources/helpers/story_helper.rb
-- stories/resources/steps/read.rb
-- stories/resources/steps/using_rest_adapter.rb
 - tasks/install.rb
 - tasks/spec.rb
-- tasks/stories.rb
 has_rdoc: true
-homepage: http://github.com/sam/dm-more/tree/master/adapters/dm-rest-adapter
+homepage: http://github.com/datamapper/dm-more/tree/master/adapters/dm-rest-adapter
 post_install_message: 
 rdoc_options: 
 - --main