openrain-active_racksource 0.1.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 OpenRain, LLC.  All rights reserved.
+
+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.markdown

@@ -0,0 +1,45 @@
+ActiveRacksource
+================
+
+NOT COMPLETE - CHECK BACK REAL SOON!
+====================================
+
+Active**Rack**source is a [Rack][] backend for [ActiveResource][].
+
+Ok ... What does that mean?
+---------------------------
+
+Here's an example, let's define a simple [ActiveResource][] library
+
+    ActiveResource::Base.site = 'http://lots-of-dogs.com/'
+
+    class Dog < ActiveResource::Base
+    end
+
+If you run the following command, it runs over HTTP and actually requests http://lots-of-dogs.com/dogs.xml 
+
+    >> Dog.find( :all ).length
+    => 1462
+
+But, if you give [ActiveResource][] a [Rack][] application to use as a backend ...
+
+    require 'active_racksource'
+
+    ActiveResource::Base.app = @my_rack_application
+
+And run the command again ...
+
+    >> Dog.find( :all ).length
+    => 5
+
+Then it runs against the [Rack][] application, not over any TCP or anything! 
+This is great for creating & testing [ActiveResource][] APIs for your web applications. 
+
+Cool, how should I get started?
+-------------------------------
+
+... ( documentation coming soon! ) ...
+
+
+[rack]:            http://rack.rubyforge.org
+[activeresource]:  http://api.rubyonrails.org/classes/ActiveResource/Base.html

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rake'
+require 'rubygems'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name        = "active_racksource"
+    s.summary     = "Rack backend for ActiveResource for testing RESTful Rack APIs"
+    s.email       = "remi@remitaylor.com"
+    s.homepage    = "http://github.com/openrain/active_racksource"
+    s.description = "Rack backend for ActiveResource for testing RESTful Rack APIs"
+    s.authors     = %w( remi )
+    s.files       = FileList["[A-Z]*", "{lib,spec,examples,rails_generators}/**/*"] 
+    s.add_dependency 'remi-rackbox' 
+    # s.executables = "neato" 
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('rcov') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'active_racksource'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('RDOC_README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Confirm that gemspec is $SAFE'
+task :safe do
+  require 'yaml'
+  require 'rubygems/specification'
+  data = File.read('active_racksource.gemspec')
+  spec = nil
+  if data !~ %r{!ruby/object:Gem::Specification}
+    Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join
+  else
+    spec = YAML.load(data)
+  end
+  spec.validate
+  puts spec
+  puts "OK"
+end
+
+task :default => :spec

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 0
+:minor: 1

data/lib/active_racksource.rb

@@ -0,0 +1,24 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'rubygems' # i'd like to remove this - it's becoming less conventional to have this in ruby gems / libraries
+
+begin
+  require 'active_resource'
+rescue LoadError
+  raise "active_racksource requires active_resource, try: gem install activeresource"
+end
+
+begin
+  require 'rackbox'
+rescue LoadError
+  raise "active_racksource requires rackbox, try: gem install remi-rackbox -s http://gems.github.com"
+end
+
+require 'active_racksource/active_racksource'
+require 'active_racksource/response'
+require 'active_racksource/http'
+require 'active_racksource/base'
+require 'active_racksource/connection'
+
+ActiveResource::Base.send       :include, ActiveRacksource::Base
+ActiveResource::Connection.send :include, ActiveRacksource::Connection

data/lib/active_racksource/active_racksource.rb

@@ -0,0 +1,7 @@
+# global namespace for ActiveRacksource
+#
+# if we add any global configuration options, 
+# they'll go here
+#
+class ActiveRacksource
+end

data/lib/active_racksource/base.rb

@@ -0,0 +1,24 @@
+class ActiveRacksource #:nodoc:
+
+  # Overrides parts of ActiveResource::Base for ActiveRacksource (to use Rack instead of HTTP)
+  module Base
+    
+    def self.included base
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      
+      def app= rack_app
+        @rack_app = rack_app
+      end
+
+      def app
+        @rack_app
+      end
+
+    end
+
+  end
+
+end

data/lib/active_racksource/connection.rb

@@ -0,0 +1,36 @@
+class ActiveRacksource #:nodoc:
+
+  # Overrides parts of ActiveResource::Connection for ActiveRacksource (to use Rack instead of HTTP)
+  module Connection
+
+    def self.included base
+      base.instance_eval {
+        alias_method_chain :http, :rack_instead_of_real_http
+      }
+    end
+
+    # Overrides ActiveResource::Connection#http, returning our own object
+    # that uses a Rack application instead of actually going over HTTP
+    #
+    # example of what the HTTP object might get sent:
+    #   http.send( :get,    "/dogs.xml",   [{"Accept"=>"application/xml"}] )
+    #   http.send( :post,   "/dogs.xml",   ["<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<dog>\n  <name>Rover</name>\n</dog>\n", {"Content-Type"=>"application/xml"}])
+    #   http.send( :delete, "/dogs/6.xml", [{"Accept"=>"application/xml"}])
+    #   http.send( :put,    "/dogs/1.xml", ["<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<dog>\n  <name>spot</name>\n  <created-at type=\"datetime\">2009-02-09T18:27:11Z</created-at>\n  <updated-at type=\"datetime\">2009-02-09T18:27:11Z</updated-at>\n  <id type=\"integer\">1</id>\n</dog>\n", {"Content-Type"=>"application/xml"}])
+    #
+    # the object http.send :foo returns should have
+    #   #code:    string representation of status code, eg. '200' or '404'
+    #   #message: string message, eg. 'OK' or 'Not Found'
+    #   #body:    string response body
+    #
+    def http_with_rack_instead_of_real_http
+      if ActiveResource::Base.app
+        ActiveRacksource::HTTP.new ActiveResource::Base.app
+      else
+        http_without_rack_instead_of_real_http
+      end
+    end
+
+  end
+
+end

data/lib/active_racksource/http.rb

@@ -0,0 +1,48 @@
+class ActiveRacksource #:nodoc:
+
+  # Adapter ... acts like Net::HTTP but actually works against a Rack application
+  class HTTP
+
+    # Rack application
+    attr_accessor :app
+
+    # Initialized a new ActiveRacksource::HTTP
+    #
+    # ==== Parameters
+    # app: a Rack application
+    #
+    def initialize app = ActiveResource::Base.app
+      @app = RackBox::App.new app
+    end
+
+    def method_missing method, url, *args
+      
+      case args.length
+      when 0
+        headers = { }
+      when 1
+        headers = args.first
+      when 2
+        if args.last.is_a?Hash
+          headers = args.last
+          data    = args.first
+        else
+          raise "not sure howto #{ method.inspect } url:#{ url.inspect } with these args:#{ args.inspect }"
+        end
+      else
+        raise "not sure howto #{ method.inspect } url:#{ url.inspect } with these args:#{ args.inspect }"
+      end
+
+      request_options = { }
+      request_options[:method] = method
+      request_options[:data]   = data   if data
+      request_options.merge!( headers ) if headers
+
+      rack_response = @app.request url, request_options
+
+      ActiveRacksource::Response.new rack_response
+    end
+
+  end
+
+end

data/lib/active_racksource/response.rb

@@ -0,0 +1,49 @@
+class ActiveRacksource #:nodoc:
+
+  # A thin wrapper around Rack::Response
+  #
+  # ActiveResource expects an HTTP Response object to be 
+  # formatted in a certain way with the right methods, etc.
+  #
+  # This object wraps a Rack::Response and implements an 
+  # inferface that supports ActiveResource
+  #
+  # Some methods called by ActiveResource:
+  # code::    string representation of status code, eg. '200' or '404'
+  # message:: string message, eg. 'OK' or 'Not Found'
+  # body::    string response body
+  #
+  class Response
+
+    # initialize a new ActiveRacksource::Response
+    #
+    # ==== Parameters
+    # rack_response:: a Rack::Response instance
+    #
+    def initialize rack_response
+      @rack_response = rack_response
+    end
+
+    def code
+      @rack_response.status.to_s
+    end
+
+    def message
+      if code.start_with?'2'
+        'OK'
+      elsif code.start_with?'4'
+        'Not Found'
+      elsif code.start_with?'3'
+        'Redirect'
+      else
+        'Error'
+      end
+    end
+
+    # by default, fall back to methods on the Rack::Response
+    def method_missing name, *args
+      @rack_response.send name, *args
+    end
+  end
+
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: openrain-active_racksource
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- remi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-09 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: remi-rackbox
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Rack backend for ActiveResource for testing RESTful Rack APIs
+email: remi@remitaylor.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- VERSION.yml
+- README.markdown
+- LICENSE
+- lib/active_racksource.rb
+- lib/active_racksource
+- lib/active_racksource/http.rb
+- lib/active_racksource/active_racksource.rb
+- lib/active_racksource/base.rb
+- lib/active_racksource/connection.rb
+- lib/active_racksource/response.rb
+has_rdoc: true
+homepage: http://github.com/openrain/active_racksource
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Rack backend for ActiveResource for testing RESTful Rack APIs
+test_files: []
+