dm-rest-adapter 0.9.2 → 0.9.3

data/History.txt

@@ -0,0 +1 @@
+

data/Manifest.txt

@@ -0,0 +1,26 @@
+History.txt
+LICENSE
+Manifest.txt
+README.txt
+Rakefile
+TODO
+lib/rest_adapter.rb
+lib/rest_adapter/version.rb
+spec/create_spec.rb
+spec/delete_spec.rb
+spec/read_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

data/{README → README.txt}

@@ -1,4 +1,3 @@
-dm-rest-adapter
-==================
+= dm-rest-adapter
 
 A DataMapper adapter for REST Web Services

data/Rakefile

@@ -1,40 +1,33 @@
 require 'rubygems'
 require 'spec'
-require 'rake/clean'
-require 'rake/gempackagetask'
 require 'spec/rake/spectask'
 require 'pathname'
 
-CLEAN.include '{log,pkg}/'
-
-spec = Gem::Specification.new do |s|
-  s.name             = 'dm-rest-adapter'
-  s.version          = '0.9.2'
-  s.platform         = Gem::Platform::RUBY
-  s.has_rdoc         = true
-  s.extra_rdoc_files = %w[ README LICENSE TODO ]
-  s.summary          = 'REST Adapter for DataMapper'
-  s.description      = s.summary
-  s.author           = 'Potomac Ruby Hackers'
-  s.email            = 'potomac-ruby-hackers@googlegroups.com'
-  s.homepage         = 'http://github.com/pjb3/dm-more/tree/master/adapters/dm-rest-adapter'
-  s.require_path     = 'lib'
-  s.files            = FileList[ '{lib,spec}/**/*.rb', 'spec/spec.opts', 'Rakefile', *s.extra_rdoc_files ]
-  s.add_dependency('dm-core', "=#{s.version}")
-end
+ROOT = Pathname(__FILE__).dirname.expand_path
+require ROOT + 'lib/rest_adapter/version'
+
+AUTHOR = "Potomac Ruby Hackers"
+EMAIL  = "potomac-ruby-hackers@googlegroups.com"
+GEM_NAME = "dm-rest-adapter"
+GEM_VERSION = DataMapper::More::RestAdapter::VERSION
+GEM_DEPENDENCIES = [["dm-core", GEM_VERSION]]
+GEM_CLEAN = ["log", "pkg"]
+GEM_EXTRAS = { :has_rdoc => true, :extra_rdoc_files => %w[ README.txt LICENSE TODO ] }
+
+PROJECT_NAME = "datamapper"
+PROJECT_URL  = "http://github.com/pjb3/dm-more/tree/master/adapters/dm-rest-adapter"
+PROJECT_DESCRIPTION = PROJECT_SUMMARY = "REST Adapter for DataMapper"
+
+require ROOT.parent.parent + 'tasks/hoe'
 
 task :default => [ :spec ]
 
 WIN32 = (RUBY_PLATFORM =~ /win32|mingw|cygwin/) rescue nil
 SUDO  = WIN32 ? '' : ('sudo' unless ENV['SUDOLESS'])
 
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.gem_spec = spec
-end
-
-desc "Install #{spec.name} #{spec.version}"
+desc "Install #{GEM_NAME} #{GEM_VERSION}"
 task :install => [ :package ] do
-  sh "#{SUDO} gem install pkg/#{spec.name}-#{spec.version} --no-update-sources", :verbose => false
+  sh "#{SUDO} gem install pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources", :verbose => false
 end
 
 desc 'Run specifications'
@@ -48,5 +41,6 @@ end
 
 desc "Run all stories"
 task :stories do
+  # TODO Re-migrate the book service or else you won't have test data!
   ruby "stories/all.rb --colour --format plain"
 end

data/TODO

@@ -1,2 +1 @@
 TODO
-====

data/lib/rest_adapter.rb

@@ -1,9 +1,10 @@
 require 'rubygems'
-gem 'dm-core', '=0.9.2'
+require 'pathname'
+require Pathname(__FILE__).dirname + 'rest_adapter/version'
+gem 'dm-core', DataMapper::More::RestAdapter::VERSION
 require 'dm-core'
 require 'extlib'
 require 'dm-serializer'
-require 'pathname'
 require 'net/http'
 require 'rexml/document'
 
@@ -13,36 +14,26 @@ module DataMapper
   module Adapters
     class RestAdapter < AbstractAdapter
       include Extlib
-
-      # def read_one(query)
-      #   raise NotImplementedError
-      # end
-      #
-      # def update(attributes, query)
-      #   raise NotImplementedError
-      # end
-      #
-      # def delete(query)
-      #   raise NotImplementedError
-      # end
-
+      
       # Creates a new resource in the specified repository.
       def create(resources)
-        success = true
+        count = 0
         resources.each do |resource|
-          resource_name = Inflection.underscore(resource.class.name.downcase)
+          resource_name = Inflection.underscore(resource.class.name)
           result = http_post("/#{resource_name.pluralize}.xml", resource.to_xml)
           # TODO: Raise error if cannot reach server
-          success = success && result.instance_of?(Net::HTTPCreated)
+          success = result.instance_of?(Net::HTTPCreated) 
           if success
-            updated_resource = parse_resource(result.body, resource.class)
-            resource.id = updated_resource.id
+            count += 1
+            # TODO: Fix commented out code below to work through the identity_map of the repository
+            # values = parse_resource(result.body, resource.class)
+            # resource.id = updated_resource.id
           end
           # TODO: We're not using the response to update the DataMapper::Resource with the newly acquired ID!!!
         end
-        success
+        count
       end
-
+      
       # read_set
       #
       # Examples of query string:
@@ -55,73 +46,107 @@ module DataMapper
       # IN PROGRESS
       # TODO: Need to account for query.conditions (i.e., [[:eql, #<Property:Book:id>, 1]] for books/1)
       def read_many(query)
-        resource_name = Inflection.underscore(query.model.name.downcase)
-        case query.conditions
-        when []
-          read_set_all(repository, query, resource_name)
-        else
-          read_set_for_condition(repository, query, resource)
+        resource_name = Inflection.underscore(query.model.name)
+        Collection.new(query) do |collection|
+          case query.conditions
+          when []
+            resources_meta = read_set_all(repository, query, resource_name)
+          else
+            resources_meta = read_set_for_condition(repository, query, resource_name)
+          end
+          resources_meta.each do |resource_meta|
+            if resource_meta.has_key?(:associations)
+              load_nested_resources_from resource_meta[:associations], query
+            end
+            collection.load(resource_meta[:values])
+          end
         end
       end
-
+      
       def read_one(query)
-        # puts "---------------- QUERY: #{query} #{query.inspect}"
-        id = query.conditions.first[2]
-        # KLUGE: Again, we're assuming below that we're dealing with a pluralized resource mapping
+        resource = nil
         resource_name = resource_name_from_query(query)
-        response = http_get("/#{resource_name.pluralize}/#{id}.xml")
-
-        # KLUGE: Rails returns HTML if it can't find a resource.  A properly RESTful app would return a 404, right?
-        return nil if response.is_a? Net::HTTPNotFound || response.content_type == "text/html"
-
-        data = response.body
-        res = parse_resource(data, query.model)
-        res
+        resources_meta = nil
+        if query.conditions.empty? && query.limit == 1
+          results = read_set_all(repository, query, resource_name)
+          resource_meta = results.first unless results.empty?
+        else
+          id = query.conditions.first[2]
+          # KLUGE: Again, we're assuming below that we're dealing with a pluralized resource mapping
+          
+          response = http_get("/#{resource_name.pluralize}/#{id}.xml")
+        
+          # KLUGE: Rails returns HTML if it can't find a resource.  A properly RESTful app would return a 404, right?
+          return nil if response.is_a? Net::HTTPNotFound || response.content_type == "text/html"
+        
+          data = response.body
+          resource_meta = parse_resource(data, query.model, query)
+        end
+        if resource_meta 
+          if resource_meta.has_key?(:associations)
+            load_nested_resources_from resource_meta[:associations], query
+          end
+          resource = query.model.load(resource_meta[:values], query)
+        end
+        resource
       end
-
+      
       def update(attributes, query)
-        # TODO update for v0.9.2
+        # TODO What if we have a compound key?
         raise NotImplementedError.new unless is_single_resource_query? query
         id = query.conditions.first[2]
-        resource = query.model.new
+        resource = nil
+        query.repository.scope do 
+          resource = query.model.get(id)
+        end
         attributes.each do |attr, val|
           resource.send("#{attr.name}=", val)
         end
         # KLUGE: Again, we're assuming below that we're dealing with a pluralized resource mapping
-        http_put("/#{resource_name_from_query(query).pluralize}/#{id}.xml", resource.to_xml)
+        res = http_put("/#{resource_name_from_query(query).pluralize}/#{id}.xml", resource.to_xml)
         # TODO: Raise error if cannot reach server
+        res.kind_of?(Net::HTTPSuccess) ? 1 : 0
       end
-
+      
       def delete(query)
-        #puts ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>> QUERY: #{query} #{query.inspect}"
-        # TODO update for v0.9.2
         raise NotImplementedError.new unless is_single_resource_query? query
         id = query.conditions.first[2]
-        http_delete("/#{resource_name_from_query(query).pluralize}/#{id}.xml")
+        res = http_delete("/#{resource_name_from_query(query).pluralize}/#{id}.xml")
+        res.kind_of?(Net::HTTPSuccess) ? 1 : 0
+      end
+      
+    protected    
+      def load_nested_resources_from(nested_resources, query)
+        nested_resources.each do |resource_meta|
+          # TODO: Houston, we have a problem.  Model#load expects a Query.  When we're nested, we don't have a query yet...
+          #resource_meta[:model].load(resource_meta[:values])
+          #if resource_meta.has_key? :associations
+          #  load_nested_resources_from resource_meta, query
+          #end
+        end
       end
-
-    protected
+    
       def read_set_all(repository, query, resource_name)
         # TODO: how do we know whether the resource we're talking to is singular or plural?
         res = http_get("/#{resource_name.pluralize}.xml")
         data = res.body
-        parse_resources(data, query.model)
+        parse_resources(data, query.model, query)
         # TODO: Raise error if cannot reach server
       end
-
+      
       #    GET /books/4200
       def read_set_for_condition(repository, query, resource_name)
         # More complex conditions
         raise NotImplementedError.new
-      end
-
+      end    
+          
       # query.conditions like [[:eql, #<Property:Book:id>, 4200]]
       def is_single_resource_query?(query)
         query.conditions.length == 1 && query.conditions.first.first == :eql && query.conditions.first[1].name == :id
       end
-
+      
       def http_put(uri, data = nil)
-        request { |http| http.put(uri, data) }
+        request { |http| http.put(uri, data, {"Content-Type", "application/xml"}) }
       end
 
       def http_post(uri, data)
@@ -129,11 +154,11 @@ module DataMapper
       end
 
       def http_get(uri)
-        request { |http| http.get(uri) }
+        request { |http| http.get(uri, {"Content-Type", "application/xml"}) }
       end
 
       def http_delete(uri)
-        request { |http| http.delete(uri) }
+        request { |http| http.delete(uri, {"Content-Type", "application/xml"}) }
       end
 
       def request(&block)
@@ -142,30 +167,45 @@ module DataMapper
           res = yield(http)
         end
         res
-      end
+      end  
 
-      def resource_from_rexml(entity_element, dm_model_class)
-        resource = dm_model_class.new
+      def values_from_rexml(entity_element, dm_model_class)
+        resource = {}
+        resource[:values] = []
         entity_element.elements.each do |field_element|
-          attribute = resource.attributes.find do |name, val|
+          attribute = dm_model_class.properties(repository.name).find do |property| 
             # *MUST* use Inflection.underscore on the XML as Rails converts '_' to '-' in the XML
-            name.to_s == Inflection.underscore(field_element.name.to_s)
+            property.name.to_s == Inflection.underscore(field_element.name.to_s)
+          end
+          if attribute
+            resource[:values] << field_element.text
+            next
+          end
+          association = dm_model_class.relationships.find do |name, dm_relationship|
+            field_element.name.to_s == Inflection.pluralize(Inflection.underscore(dm_relationship.child_model.to_s))
+          end
+          if association
+            field_element.each_element do |associated_element|
+              model = association[1].child_model
+              (resource[:associations] ||= []) << {
+                :model => model, 
+                :value => values_from_rexml(associated_element, association[1].child_model)
+              }
+            end
           end
-          resource.send("#{Inflection.underscore(attribute[0])}=", field_element.text) if attribute
         end
-        resource.instance_eval { @new_record= false }
         resource
       end
 
-      def parse_resource(xml, dm_model_class)
+      def parse_resource(xml, dm_model_class, query = nil)
         doc = REXML::Document::new(xml)
         # TODO: handle singular resource case as well....
         entity_element = REXML::XPath.first(doc, "/#{resource_name_from_model(dm_model_class)}")
         return nil unless entity_element
-        resource_from_rexml(entity_element, dm_model_class)
+        values_from_rexml(entity_element, dm_model_class)
       end
-
-      def parse_resources(xml, dm_model_class)
+      
+      def parse_resources(xml, dm_model_class, query = nil)
         doc = REXML::Document::new(xml)
         # # TODO: handle singular resource case as well....
         # array = XPath(doc, "/*[@type='array']")
@@ -174,17 +214,17 @@ module DataMapper
         # else
         resource_name = resource_name_from_model dm_model_class
         doc.elements.collect("#{resource_name.pluralize}/#{resource_name}") do |entity_element|
-          resource_from_rexml(entity_element, dm_model_class)
+          values_from_rexml(entity_element, dm_model_class)
         end
-      end
-
+      end  
+      
       def resource_name_from_model(model)
-        Inflection.underscore(model.name.downcase)
+        Inflection.underscore(model.name)
       end
-
+      
       def resource_name_from_query(query)
         resource_name_from_model(query.model)
       end
     end
   end
-end
+end

data/lib/rest_adapter/version.rb

@@ -0,0 +1,7 @@
+module DataMapper
+  module More
+    class RestAdapter
+      VERSION = "0.9.3"
+    end
+  end
+end

data/spec/create_spec.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH << File.dirname(__FILE__)
+require 'spec_helper'
+
+describe 'A REST adapter' do
+  
+  before do
+    @adapter = DataMapper::Repository.adapters[:default]
+  end
+  
+  describe 'when saving a resource' do
+  
+    before do
+      @book = Book.new(:title => 'Hello, World!', :author => 'Anonymous')
+    end
+  
+    it 'should make an HTTP Post' do
+      @adapter.should_receive(:http_post).with('/books.xml', @book.to_xml)
+      @book.save
+    end
+  end
+end

data/spec/delete_spec.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH << File.dirname(__FILE__)
+require 'spec_helper'
+
+describe 'A REST adapter' do
+  
+  before do
+    @adapter = DataMapper::Repository.adapters[:default]
+  end
+  
+  describe 'when deleting an existing resource' do
+    before do
+      @book = Book.new(:title => 'Hello, World!', :author => 'Anonymous')
+      @book.stub!(:new_record?).and_return(false)
+    end
+    
+    it 'should do an HTTP DELETE' do
+      @adapter.should_receive(:http_delete)
+      @book.destroy
+    end
+    
+  end
+end

data/spec/{rest_adapter_spec.rb → read_spec.rb}

@@ -1,43 +1,16 @@
-require 'pathname'
-require Pathname(__FILE__).dirname.parent.expand_path + 'lib/rest_adapter'
-
-DataMapper.setup(:default, {
-  :adapter  => 'rest',
-  :format => 'xml',
-  :host => 'localhost',
-  :port => '3001'
-})
-
-class Book
-  include DataMapper::Resource
-  property :id,         Integer, :serial => true
-  property :title,      String
-  property :author,     String
-  property :created_at, DateTime
-end
+$LOAD_PATH << File.dirname(__FILE__)
+require 'spec_helper'
 
 describe 'A REST adapter' do
-
+  
   before do
     @adapter = DataMapper::Repository.adapters[:default]
   end
-
-  describe 'when saving a resource' do
-
-    before do
-      @book = Book.new(:title => 'Hello, World!', :author => 'Anonymous')
-    end
-
-    it 'should make an HTTP Post' do
-      @adapter.should_receive(:http_post).with('/books.xml', @book.to_xml)
-      @book.save
-    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'?>
@@ -54,20 +27,25 @@ describe 'A REST adapter' do
         @response.stub!(:body).and_return(book_xml)
         @adapter.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 do an HTTP GET' do
         @adapter.should_receive(:http_get).with('/books/1.xml').and_return(@response)
         Book.get(@id)
       end
+      
+      it "it be equal to itself" do
+        Book.get(@id).should == Book.get(@id)
+      end      
     end
-
+      
+    
     describe 'if the resource does not exist' do
       it 'should return nil' do
         @id = 1
@@ -80,9 +58,9 @@ describe 'A REST adapter' do
       end
     end
   end
-
+  
   describe 'when getting all resource of a particular type' do
-    before do
+    before do      
       books_xml = <<-BOOK
       <?xml version='1.0' encoding='UTF-8'?>
       <books type='array'>
@@ -92,7 +70,7 @@ describe 'A REST adapter' do
           <id type='integer'>1</id>
           <title>The Dispossed</title>
           <updated-at type='datetime'>2008-06-08T17:02:28Z</updated-at>
-        </book>
+        </book>      
         <book>
           <author>Stephen King</author>
           <created-at type='datetime'>2008-06-08T17:03:07Z</created-at>
@@ -106,48 +84,18 @@ describe 'A REST adapter' do
       @response.stub!(:body).and_return(books_xml)
       @adapter.stub!(:http_get).and_return(@response)
     end
-
+    
     it 'should get a non-empty list' do
       Book.all.should_not be_empty
     end
-
+    
     it 'should receive one Resource for each entity in the XML' do
       Book.all.size.should == 2
     end
-
+    
     it 'should do an HTTP GET' do
       @adapter.should_receive(:http_get).and_return(@response)
-      Book.all
-    end
-  end
-
-  describe 'when updating an existing resource' do
-    before do
-      @books_xml = "<book><id type='integer'>42</id><title>The Dispossed</title><author>Ursula K LeGuin</author><created-at type='datetime'>2008-06-08T17:02:28Z</created-at></book>"
-      @book = Book.new(:id => 42,
-                       :title => 'The Dispossed',
-                       :author => 'Ursula K LeGuin',
-                       :created_at => DateTime.parse('2008-06-08T17:02:28Z'))
-      @book.stub!(:new_record?).and_return(false)
-      @book.stub!(:dirty?).and_return(true)
-    end
-
-    it 'should do an HTTP PUT' do
-      @adapter.should_receive(:http_put).with('/books/42.xml', @book.to_xml)
-      @book.save
-    end
-  end
-
-  describe 'when deleting an existing resource' do
-    before do
-      @book = Book.new(:title => 'Hello, World!', :author => 'Anonymous')
-      @book.stub!(:new_record?).and_return(false)
-    end
-
-    it 'should do an HTTP DELETE' do
-      @adapter.should_receive(:http_delete)
-      @book.destroy
-    end
-
+      Book.first
+    end    
   end
-end
+end

data/spec/ruby_forker.rb

@@ -10,4 +10,4 @@ module RubyForker
     cmd << " 2> #{stderr}" unless stderr.nil?
     `#{cmd}`
   end
-end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.parent.expand_path + 'lib/rest_adapter'
+
+DataMapper.setup(:default, {
+  :adapter  => 'rest',
+  :format => 'xml',
+  :host => 'localhost',
+  :port => '3001'
+})
+
+class Book
+  include DataMapper::Resource
+  property :author,     String
+  property :created_at, DateTime
+  property :id,         Integer, :serial => true
+  property :title,      String
+end

data/spec/update_spec.rb

@@ -0,0 +1,36 @@
+$LOAD_PATH << File.dirname(__FILE__)
+require 'spec_helper'
+
+describe 'A REST adapter' do
+  
+  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).set(@book.key, @book)      
+        @book.title = "Mary Had a Little Lamb"
+      end
+    end
+
+    it 'should do an HTTP PUT' do
+      adapter = @repository.adapter #DataMapper::Repository.adapters[:default]
+      adapter.should_receive(:http_put).with('/books/42.xml', @book.to_xml)
+      @repository.scope do 
+        @book.save
+      end
+    end
+  end
+end

data/stories/all.rb

@@ -0,0 +1,5 @@
+require File.join(File.dirname(__FILE__), *%w[helper])
+
+%w[crud].each do |dir|
+  require File.join(File.dirname(__FILE__), "#{dir}/stories")
+end

data/stories/crud/create

@@ -0,0 +1,39 @@
+Story: remote app wants to create a resource
+  As a remote app
+  I want to create a resource
+  So that I can store some data about a particular item
+  
+  Scenario: remote app supplies a new valid Resource 
+    Given a valid DataMapper::Resource
+    When I try to save the Resource
+    Then the Resource should save
+
+  Scenario: remote app supplies a new invalid Resource 
+    Given a valid DataMapper::Resource
+    When I make invalid changes to that Resource
+    When I try to save the Resource
+    Then the Resource should not save
+    
+  Scenario: remote app supplies a new valid Resource associated with another new valid Resource
+    Given a new Resource
+    And another new Resource associated with the first
+    When I try to save the first Resource
+    Then both Resources should save
+    
+  Scenario: remote app supplies a new invalid Resource associated with another new valid Resource
+    Given a new invalid Resouce
+    And another new Resource associated with the first
+    When I try to save the first Resource
+    Neither Resource should save
+    
+  Scenario: remote app supplies a new valid Resource associated with another new invalid Resource
+    Given a new Resource
+    And another new invalid Resource associted with the first
+    When I try to save the first Resource
+    Neither Resource should save
+    
+  Scenario: remote app supplies a new invalid Resource associated with another new invalid Resource
+    Given a new invalid Resource
+    And another new invalid Resource associted with the first
+    When I try to save the first Resource
+    Neither Resource should save

data/stories/crud/delete

@@ -0,0 +1,9 @@
+Story: remote app wants to delete a Resource
+  As a remote app
+  I want to delete a Resource
+  So that the information will no longer be available
+
+  Scenario: remote app attempts to delete a Resource by ID
+    Given a local representation of a remote Resource
+    When I destroy the Resource
+    Then the Resource will no longer be available

data/stories/crud/read

@@ -0,0 +1,36 @@
+Story: remote app wants to access one or more Resources
+  As a remote app
+  I want to get one or more Resources
+  So that I can take an action based upon the information
+
+  Scenario: GET <resource>
+    Given a type of Resource
+    When I request all of the Resources of that type
+    Then I should not receive an empty list
+    
+  Scenario: GET <resource>/<id>
+    Given a type of Resource
+    And the ID of an existing Resource
+    When I request the Resource
+    Then I should receive that Resource
+    
+  Scenario: GET <resource>/<invalid id>
+    Given a type of Resource
+    And the ID of a nonexistent Resource
+    When I request the Resource
+    Then I should get nothing in return
+  
+  Scenario: GET <nested resource>/<id>
+    Given a Resource that returns associated resources
+    And the ID of an existing Resource that has associated Resources
+    And I have all of the necessary class definitions 
+    When I GET <nested resource>/<id>
+    Then I should get the Resource
+    And the Resource will have associated Resources
+    
+  Scenario: GET <nested resource>/<id> but we are missing some class definitions
+    Given a Resource that returns associated resources
+    And the ID of an existing Resource that has associated Resources
+    And I do not have all of the necessary class definitions 
+    When I GET <nested resource>/<id>
+    Then I should get an Exception

data/stories/crud/stories.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__), *%w[.. helper])
+
+Dir["#{File.dirname(__FILE__)}/*"].each do |file|
+  unless (file =~ /\.rb$/)
+    file_name = file.split('/').last
+    begin
+      require File.join(File.dirname(__FILE__), "..", "resources", "steps", file_name)
+    rescue LoadError
+      puts "Can't find #{file_name}.rb to define story steps; assuming this is intentional"
+    rescue Exception => e
+      puts e.backtrace
+      exit 1
+    end
+    with_steps_for :using_rest_adapter, file_name.to_sym do
+      run file if File.file?(file)
+    end
+  end
+end

data/stories/crud/update

@@ -0,0 +1,44 @@
+Story: remote app wants to update a resource
+  As a remote app
+  I want to modify a resource
+  So that it's information represents the correct state
+
+  Scenario: remote app updates with changes made to a resource's state
+    Given a local representation of a remote Resource
+    When I make valid changes to that Resource
+    And I try to save the Resource
+    Then the Resource should save 
+    
+  Scenario: remote app updates with invalid changes to a resource's state
+    Given a local representation of a remote Resource
+    When I make invalid changes to that Resource
+    And I try to save the Resource
+    Then the Resource should not save
+    
+  Scenario: remote app updates with changes to an object and one of its children
+    Given a local representation of a remote Resource
+    And a local representation of one of that Resource's child Resources
+    When I make valid changes to the parent Resource
+    And I make valid changes to the child Resource
+    Then both Resources should save
+    
+  Scenario: remote app updates with valid changes to an object and invalid changes to one of its children
+    Given a local representation of a remote Resource
+    And a local representation of one of that Resource's child Resources
+    When I make valid changes to the parent Resource
+    And I make invalid changes to the child Resource
+    Then neither Resource should save
+  
+  Scenario: remote app updates with invalid changes to an object and valid changes to one of its children
+    Given a local representation of a remote Resource
+    And a local representation of one of that Resource's child Resources
+    When I make invalid changes to the parent Resource
+    And I make valid changes to the child Resource
+    Then neither Resource should save
+
+  Scenario: remote app updates with invalid changes to an object and invalid changes to one of its children          
+    Given a local representation of a remote Resource
+    And a local representation of one of that Resource's child Resources
+    When I make invalid changes to the parent Resource
+    And I make invalid changes to the child Resource
+    Then neither Resource should save

data/stories/helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift File.expand_path("#{File.dirname(__FILE__)}/../lib/rest_adapter")
+require 'rubygems'
+require 'spec'
+require 'tempfile'
+require 'dm-core'
+#require 'pathname'
+#require Pathname(__FILE__).dirname.parent.expand_path + '../../lib/rest_adapter'
+require File.join(File.dirname(__FILE__), *%w[resources helpers story_helper])
+require File.join(File.dirname(__FILE__), *%w[resources steps using_rest_adapter])

data/stories/resources/helpers/book.rb

@@ -0,0 +1,7 @@
+class Book
+  include DataMapper::Resource
+  property :author,     String
+  property :created_at, DateTime
+  property :id,         Integer, :serial => true
+  property :title,      String
+end

data/stories/resources/helpers/story_helper.rb

@@ -0,0 +1,2 @@
+require 'spec/story'
+require File.dirname(__FILE__) + '/../../../spec/ruby_forker'

data/stories/resources/steps/read.rb

@@ -0,0 +1,35 @@
+steps_for :read do
+  Given "a Resource that returns associated resources" do
+    class Shelf
+      include DataMapper::Resource
+      property :id,   Integer, :serial => true
+      property :name, String
+      has n, :books
+    end
+  end
+  
+  Given "the ID of an existing Resource that has associated Resources" do
+    # Assuming that resource 1 is there.  
+    # @type.first would do a GET; that's what we're testing
+    @resource_id = 1
+  end
+
+  Given "I have all of the necessary class definitions" do
+    # NO-OP because defined above
+  end
+
+  When "I GET <nested resource>/<id>" do
+    @resource = Shelf.get(@resource_id)
+  end
+  
+  Then "I should get the Resource" do
+    @resource.should_not be_nil
+    @resource.should be_an_instance_of(Shelf)
+    @resource.id.should == 1
+  end
+  
+  Then "the Resource will have associated Resources" do
+    @resource.books.should_not be_empty
+    @resource.books.first.should be_an_instance_of(Book)
+  end
+end

data/stories/resources/steps/using_rest_adapter.rb

@@ -0,0 +1,99 @@
+require 'dm-core'
+
+steps_for :using_rest_adapter do
+  #To run these specs, you must have a REST Application running on port 3001 on your localhost
+  #The app is expected to implement the REST API for CRUD operations on a Book
+
+  DataMapper.setup(:default, {
+    :adapter  => 'rest',
+    :format => 'xml',
+    :host => 'localhost',
+    :port => '3001'
+  })
+
+  Given("a valid DataMapper::Resource") do
+    # TODO refactor
+    require File.join(File.dirname(__FILE__), '..', 'helpers', 'book')
+    @resource = new_book
+  end
+
+  Given("a type of Resource") do
+    # TODO refactor
+#    require File.join(File.dirname(__FILE__), '..', 'helpers', 'book')
+#    Book = Book
+  end
+
+  Given("the ID of an existing Resource") do
+    # TODO refactor
+    require File.join(File.dirname(__FILE__), '..', 'helpers', 'book')
+    @resource_id = Book.first.id
+  end
+
+  Given("the ID of a nonexistent Resource") do
+    @resource_id = 42 ** 3
+  end
+
+  Given("a local representation of a remote Resource") do
+    # TODO refactor
+    require File.join(File.dirname(__FILE__), '..', 'helpers', 'book')
+    @resource = Book.first
+    @resource_id = @resource.id
+  end
+  
+  When("I try to save the Resource") do
+    @result = @resource.save
+  end
+  
+  When("I request all of the Resources of that type") do
+    require File.join(File.dirname(__FILE__), '..', 'helpers', 'book')
+    @resources = Book.all
+  end
+  
+  When("I request the Resource") do
+    require File.join(File.dirname(__FILE__), '..', 'helpers', 'book')    
+    @resource = Book.get(@resource_id)
+  end
+
+  When("I make valid changes to that Resource") do
+    @resource.title = "Mary had a little lamb"
+  end
+
+  When("I make invalid changes to that Resource") do
+    @resource.title = nil
+  end
+  
+  When("I destroy the Resource") do
+    @resource.destroy
+  end
+  
+  Then("the Resource should save") do
+    @result.should be_true
+  end
+  
+  Then("the Resource should not save") do
+    @result.should be_false
+  end
+  
+  Then("I should not receive an empty list") do
+    @resources.should_not be_empty
+  end
+
+  Then("I should receive that Resource") do
+    @resource.should_not be_nil
+    @resource.id.should == @resource_id
+  end
+
+  Then("I should get nothing in return") do
+    @resource.should be_nil
+  end
+  
+  Then("the Resource will no longer be available") do
+    # TODO refactor
+    require File.join(File.dirname(__FILE__), '..', 'helpers', 'book')
+    Book.get(@resource_id).should be_nil
+  end
+end
+
+def new_book(options={})
+  Book.new(options.merge({:title => "Hello, World!", :author => "Some dude"}))
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dm-rest-adapter
 version: !ruby/object:Gem::Version 
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors: 
 - Potomac Ruby Hackers
@@ -9,42 +9,73 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-25 00:00:00 -05:00
+date: 2008-07-24 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: dm-core
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 0.9.2
+        version: 0.9.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
     version: 
 description: REST Adapter for DataMapper
-email: potomac-ruby-hackers@googlegroups.com
+email: 
+- potomac-ruby-hackers@googlegroups.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.txt
 - LICENSE
 - TODO
 files: 
+- History.txt
+- LICENSE
+- Manifest.txt
+- README.txt
+- Rakefile
+- TODO
 - lib/rest_adapter.rb
-- spec/rest_adapter_spec.rb
+- lib/rest_adapter/version.rb
+- spec/create_spec.rb
+- spec/delete_spec.rb
+- spec/read_spec.rb
 - spec/ruby_forker.rb
 - spec/spec.opts
-- Rakefile
-- README
-- LICENSE
-- TODO
+- 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
 has_rdoc: true
 homepage: http://github.com/pjb3/dm-more/tree/master/adapters/dm-rest-adapter
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --main
+- README.txt
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -61,8 +92,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.0.1
+rubyforge_project: datamapper
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: REST Adapter for DataMapper