dm-rest-adapter 0.9.10 → 0.9.11

data/History.txt

@@ -1,6 +1,12 @@
+=== 0.9.11 / 2009-03-29
+
+* 1 major enhancement:
+
+  * Updated and refactored entire adapter
+
 === 0.9.10 / 2009-01-19
 
-  * No changes this version
+* No changes this version
 
 === 0.9.9 / 2009-01-04
 

data/Manifest.txt

@@ -1,100 +1,22 @@
 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

data/README.markdown

@@ -0,0 +1,47 @@
+= dm-rest-adapter
+
+A DataMapper adapter for REST Web Services
+
+== Usage
+
+DM Rest Adapter requires the use of a model which is the same name as the resource you are using. For example, if you have a resource named "posts" you will create a standard datamapper object called post.rb in app/models. The only difference in this model is you will need to define the rest adapter for the model. The following is an example of a post model, where the host settings point to the app you are running the resource on. In addition I have included a basic auth login which will be used if your resource requires auth:
+
+DataMapper.setup(:default, {
+ :adapter  => 'rest',
+ :format   => 'xml',
+ :host     => 'localhost',
+ :port     => 4000,
+ :login    => 'user',
+ :password => 'verys3crit'
+})
+
+class Post
+
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :title, String
+  property :body,  Text
+
+end
+
+
+If you notice this looks exactly like a normal datmapper model. Every property you define will map itself with the xml returned or posted from/to the resource.
+
+== Code
+
+Now for some code examples. DM Rest Adapter uses the same methods as datamapper including during creation.
+
+Post.first => returns the object from the resouce
+Post.get(1) => returns the object from the resource
+p = Post.new(:title => "My awesome blog post", :body => "I really have nothing to say...")
+p.save => saves the resource on the remote
+
+== Caveat
+
+Posts do not honor RESTful HTTP status codes. I might fix this...
+
+== TODO:
+
+Nested resources
+Put verb actions

data/README.txt

@@ -1,3 +1,47 @@
 = dm-rest-adapter
 
 A DataMapper adapter for REST Web Services
+
+== Usage
+
+DM Rest Adapter requires the use of a model which is the same name as the resource you are using. For example, if you have a resource named "posts" you will create a standard datamapper object called post.rb in app/models. The only difference in this model is you will need to define the rest adapter for the model. The following is an example of a post model, where the host settings point to the app you are running the resource on. In addition I have included a basic auth login which will be used if your resource requires auth:
+
+DataMapper.setup(:default, {
+ :adapter  => 'rest',
+ :format   => 'xml',
+ :host     => 'localhost',
+ :port     => 4000,
+ :login    => 'user',
+ :password => 'verys3crit'
+})
+
+class Post
+
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :title, String
+  property :body,  Text
+
+end
+
+
+If you notice this looks exactly like a normal datmapper model. Every property you define will map itself with the xml returned or posted from/to the resource.
+
+== Code
+
+Now for some code examples. DM Rest Adapter uses the same methods as datamapper including during creation.
+
+Post.first => returns the object from the resouce
+Post.get(1) => returns the object from the resource
+p = Post.new(:title => "My awesome blog post", :body => "I really have nothing to say...")
+p.save => saves the resource on the remote
+
+== Caveat
+
+Posts do not honor RESTful HTTP status codes. I might fix this...
+
+== TODO:
+
+Nested resources
+Put verb actions

data/Rakefile

@@ -8,16 +8,16 @@ SUDO    = (WINDOWS || JRUBY) ? '' : ('sudo' unless ENV['SUDOLESS'])
 
 require ROOT + 'lib/rest_adapter/version'
 
-AUTHOR = 'Potomac Ruby Hackers'
-EMAIL  = 'potomac-ruby-hackers [a] googlegroups [d] com'
+AUTHOR = 'Scott Burton @ Joyent Inc'
+EMAIL  = 'scott.burton [a] joyent [d] com'
 GEM_NAME = 'dm-rest-adapter'
-GEM_VERSION = DataMapper::RestAdapter::VERSION
-GEM_DEPENDENCIES = [['dm-core', "~>#{GEM_VERSION}"]]
+GEM_VERSION = DataMapperRest::VERSION
+GEM_DEPENDENCIES = [['dm-core', GEM_VERSION]]
 GEM_CLEAN = %w[ log pkg coverage ]
 GEM_EXTRAS = { :has_rdoc => true, :extra_rdoc_files => %w[ README.txt LICENSE TODO History.txt ] }
 
 PROJECT_NAME = 'datamapper'
-PROJECT_URL  = "http://github.com/sam/dm-more/tree/master/adapters/#{GEM_NAME}"
+PROJECT_URL  = "http://github.com/datamapper/dm-more/tree/master/adapters/#{GEM_NAME}"
 PROJECT_DESCRIPTION = PROJECT_SUMMARY = 'REST Adapter for DataMapper'
 
 [ ROOT, ROOT.parent.parent ].each do |dir|

data/config/database.rb.example

@@ -0,0 +1,8 @@
+DataMapper.setup(:default, {
+  :adapter  => 'rest',
+  :format => 'xml',
+  :host => 'localhost',
+  :port => '4000',
+  :username => 'admin',
+  :password => 'secret'
+})

data/dm-rest-adapter.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-rest-adapter}
+  s.version = "0.9.11"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Burton @ Joyent Inc"]
+  s.date = %q{2009-03-23}
+  s.description = %q{REST Adapter for DataMapper}
+  s.email = ["scott.burton [a] joyent [d] com"]
+  s.extra_rdoc_files = ["README.txt", "LICENSE", "TODO", "History.txt"]
+  s.files = ["History.txt", "LICENSE", "Manifest.txt", "README.markdown", "README.txt", "Rakefile", "TODO", "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/connection_spec.rb", "spec/crud_spec.rb", "spec/ruby_forker.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/install.rb", "tasks/spec.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/datamapper/dm-more/tree/master/adapters/dm-rest-adapter}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{datamapper}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{REST Adapter for DataMapper}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<dm-core>, ["= 0.9.11"])
+    else
+      s.add_dependency(%q<dm-core>, ["= 0.9.11"])
+    end
+  else
+    s.add_dependency(%q<dm-core>, ["= 0.9.11"])
+  end
+end

data/lib/rest_adapter.rb

@@ -1,251 +1,15 @@
-require 'net/http'
-require 'pathname'
-require 'rexml/document'
-require 'rubygems'
+$:.push File.expand_path(File.dirname(__FILE__))
 
-gem 'dm-core', '~>0.9.10'
 require 'dm-core'
-
-gem 'extlib', '~>0.9.10'
 require 'extlib'
-
-#gem 'dm-serializer', '~>0.9.10'
+require 'pathname'
+require 'rexml/document'
+require 'rubygems'
 require 'dm-serializer'
+require 'rest_adapter/version'
+require 'rest_adapter/adapter'
+require 'rest_adapter/connection'
+require 'rest_adapter/formats'
+require 'rest_adapter/exceptions'
 
-require Pathname(__FILE__).dirname + 'rest_adapter/version'
-
-# TODO: Abstract XML support out from the protocol
-# TODO: Build JSON support
-module DataMapper
-  module Adapters
-    class RestAdapter < AbstractAdapter
-      include Extlib
-
-      # Creates a new resource in the specified repository.
-      def create(resources)
-        count = 0
-        resources.each do |resource|
-          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 = result.instance_of?(Net::HTTPCreated)
-          if success
-            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
-        count
-      end
-
-      # read_set
-      #
-      # Examples of query string:
-      # A. []
-      #    GET /books/
-      #
-      # B. [[:eql, #<Property:Book:id>, 4200]]
-      #    GET /books/4200
-      #
-      # 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)
-        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)
-        resource = nil
-        resource_name = resource_name_from_query(query)
-        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 What if we have a compound key?
-        raise NotImplementedError.new unless is_single_resource_query? query
-        id = query.conditions.first[2]
-        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
-        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)
-        raise NotImplementedError.new unless is_single_resource_query? query
-        id = query.conditions.first[2]
-        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
-
-      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, 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
-
-      # 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 do |http|
-          request = Net::HTTP::Put.new(uri, data)
-          request.basic_auth(@uri[:login], @uri[:password]) unless @uri[:login].blank?
-          http.request(request)
-        end
-      end
-
-      def http_post(uri, data)
-        request do |http|
-          request = Net::HTTP::Post.new(uri, data, 'Content-Type' => 'application/xml')
-          request.basic_auth(@uri[:login], @uri[:password]) unless @uri[:login].blank?
-          http.request(request)
-        end
-      end
-
-      def http_get(uri)
-        request do |http|
-          request = Net::HTTP::Get.new(uri)
-          request.basic_auth(@uri[:login], @uri[:password]) unless @uri[:login].blank?
-          http.request(request)
-        end
-      end
-
-      def http_delete(uri)
-        request do |http|
-          request = Net::HTTP::Delete.new(uri)
-          request.basic_auth(@uri[:login], @uri[:password]) unless @uri[:login].blank?
-          http.request(request)
-        end
-      end
-
-      def request(&block)
-        res = nil
-        Net::HTTP.start(@uri[:host], @uri[:port].to_i) do |http|
-          res = yield(http)
-        end
-        res
-      end
-
-      def values_from_rexml(entity_element, dm_model_class)
-        resource = {}
-        resource[:values] = []
-        entity_element.elements.each do |field_element|
-          attribute = dm_model_class.properties(repository.name).find do |property|
-            property.name.to_s == field_element.name.to_s.tr('-', '_')
-          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
-        end
-        resource
-      end
-
-      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
-        values_from_rexml(entity_element, dm_model_class)
-      end
-
-      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']")
-        # if array
-        #   parse_resources()
-        # else
-        resource_name = resource_name_from_model dm_model_class
-        doc.elements.collect("#{resource_name.pluralize}/#{resource_name}") do |entity_element|
-          values_from_rexml(entity_element, dm_model_class)
-        end
-      end
-
-      def resource_name_from_model(model)
-        Inflection.underscore(model.name)
-      end
-
-      def resource_name_from_query(query)
-        resource_name_from_model(query.model)
-      end
-    end
-  end
-end
+DataMapper::Adapters::RestAdapter = DataMapperRest::Adapter