dm-rest-adapter 0.9.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Potomac Ruby Hackers
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

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

data/Rakefile

@@ -0,0 +1,52 @@
+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
+
+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}"
+task :install => [ :package ] do
+  sh "#{SUDO} gem install pkg/#{spec.name}-#{spec.version} --no-update-sources", :verbose => false
+end
+
+desc 'Run specifications'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  if File.exists?('spec/spec.opts')
+    t.spec_opts << '--options' << 'spec/spec.opts'
+  end
+  t.spec_files =
+    Pathname.glob(Pathname.new(__FILE__).dirname + 'spec/**/*_spec.rb')
+end
+
+desc "Run all stories"
+task :stories do
+  ruby "stories/all.rb --colour --format plain"
+end

data/TODO

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

data/lib/rest_adapter.rb

@@ -0,0 +1,190 @@
+require 'rubygems'
+gem 'dm-core', '=0.9.2'
+require 'dm-core'
+require 'extlib'
+require 'dm-serializer'
+require 'pathname'
+require 'net/http'
+require 'rexml/document'
+
+# TODO: Abstract XML support out from the protocol
+# TODO: Build JSON support
+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
+        resources.each do |resource|
+          resource_name = Inflection.underscore(resource.class.name.downcase)
+          result = http_post("/#{resource_name.pluralize}.xml", resource.to_xml)
+          # TODO: Raise error if cannot reach server
+          success = success && result.instance_of?(Net::HTTPCreated)
+          if success
+            updated_resource = 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
+      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.downcase)
+        case query.conditions
+        when []
+          read_set_all(repository, query, resource_name)
+        else
+          read_set_for_condition(repository, query, resource)
+        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_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
+      end
+
+      def update(attributes, query)
+        # TODO update for v0.9.2
+        raise NotImplementedError.new unless is_single_resource_query? query
+        id = query.conditions.first[2]
+        resource = query.model.new
+        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)
+        # TODO: Raise error if cannot reach server
+      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")
+      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)
+        # 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 { |http| http.put(uri, data) }
+      end
+
+      def http_post(uri, data)
+        request { |http| http.post(uri, data, {"Content-Type", "application/xml"}) }
+      end
+
+      def http_get(uri)
+        request { |http| http.get(uri) }
+      end
+
+      def http_delete(uri)
+        request { |http| http.delete(uri) }
+      end
+
+      def request(&block)
+        res = nil
+        Net::HTTP.start(@uri[:host], @uri[:port].to_i) do |http|
+          res = yield(http)
+        end
+        res
+      end
+
+      def resource_from_rexml(entity_element, dm_model_class)
+        resource = dm_model_class.new
+        entity_element.elements.each do |field_element|
+          attribute = resource.attributes.find do |name, val|
+            # *MUST* use Inflection.underscore on the XML as Rails converts '_' to '-' in the XML
+            name.to_s == Inflection.underscore(field_element.name.to_s)
+          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)
+        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)
+      end
+
+      def parse_resources(xml, dm_model_class)
+        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|
+          resource_from_rexml(entity_element, dm_model_class)
+        end
+      end
+
+      def resource_name_from_model(model)
+        Inflection.underscore(model.name.downcase)
+      end
+
+      def resource_name_from_query(query)
+        resource_name_from_model(query.model)
+      end
+    end
+  end
+end

data/spec/rest_adapter_spec.rb

@@ -0,0 +1,153 @@
+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
+
+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'?>
+        <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.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
+    end
+
+    describe 'if the resource does not exist' do
+      it 'should return nil' do
+        @id = 1
+        @response = mock(Net::HTTPNotFound)
+        @response.stub!(:content_type).and_return('text/html')
+        @response.stub!(:body).and_return('<html></html>')
+        @adapter.stub!(:http_get).and_return(@response)
+        id = 4200
+        Book.get(id).should be_nil
+      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)
+      @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
+
+  end
+end

data/spec/ruby_forker.rb

@@ -0,0 +1,13 @@
+require 'rbconfig'
+
+module RubyForker
+  # Forks a ruby interpreter with same type as ourself.
+  # juby will fork jruby, ruby will fork ruby etc.
+  def ruby(args, stderr=nil)
+    config       = ::Config::CONFIG
+    interpreter  = File::join(config['bindir'], config['ruby_install_name']) + config['EXEEXT']
+    cmd = "#{interpreter} #{args}"
+    cmd << " 2> #{stderr}" unless stderr.nil?
+    `#{cmd}`
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: dm-rest-adapter
+version: !ruby/object:Gem::Version 
+  version: 0.9.2
+platform: ruby
+authors: 
+- Potomac Ruby Hackers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-25 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
+description: REST Adapter for DataMapper
+email: potomac-ruby-hackers@googlegroups.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- lib/rest_adapter.rb
+- spec/rest_adapter_spec.rb
+- spec/ruby_forker.rb
+- spec/spec.opts
+- Rakefile
+- README
+- LICENSE
+- TODO
+has_rdoc: true
+homepage: http://github.com/pjb3/dm-more/tree/master/adapters/dm-rest-adapter
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: REST Adapter for DataMapper
+test_files: []
+