hovercraft 0.0.2 → 0.1.0

data/.rspec

@@ -0,0 +1 @@
+--color

data/lib/hovercraft/builder.rb

@@ -1,5 +1,6 @@
 require 'hovercraft/loader'
-require 'hovercraft/actions'
+require 'hovercraft/routes'
+require 'hovercraft/helpers'
 require 'sinatra/base'
 require 'rack/contrib'
 require 'forwardable'
@@ -22,7 +23,8 @@ module Hovercraft
     end
 
     def configure(application)
-      application.register(Hovercraft::Actions)
+      application.register(Hovercraft::Helpers)
+      application.register(Hovercraft::Routes)
       application.use(Rack::PostBodyContentTypeParser)
       application
     end

data/lib/hovercraft/helpers.rb

@@ -0,0 +1,38 @@
+module Hovercraft
+  module Helpers
+    def self.registered(application)
+      application.helpers(Hovercraft::Helpers)
+    end
+
+    def respond_with(content)
+      if content.respond_to?(format_method_name)
+        content.send(format_method_name)
+      else
+        fail "Serialization method not supported: #{format_method_name}"
+      end
+    end
+
+    def format_method_name
+      "to_#{format}"
+    end
+
+    def format
+      params[:format] ||
+      preferred_type  ||
+      default_format
+    end
+
+    def preferred_type
+      case request.preferred_type
+      when /.*\/json/ then :json
+      when /.*\/xml/  then :xml
+      when /.*\/\*/   then default_format
+      else fail "Unknown media type: %p" % request.preferred_type
+      end
+    end
+
+    def default_format
+      :json
+    end
+  end
+end

data/lib/hovercraft/{actions.rb → routes.rb}

@@ -1,46 +1,44 @@
-require 'sinatra/base'
-
 module Hovercraft
-  module Actions
+  module Routes
     def generate_index(model_class, model_name, plural_model_name)
-      get("/#{plural_model_name}.:format") do
+      get(%r{^/#{plural_model_name}(\.(?<format>[^\./?#]+))?$}) do
         model_instances = model_class.all
         status 200
-        model_instances.to_json
+        respond_with model_instances
       end
     end
 
     def generate_create(model_class, model_name, plural_model_name)
-      post("/#{plural_model_name}.:format") do
+      post(%r{^/#{plural_model_name}(\.(?<format>[^\./?#]+))?$}) do
         model_instance = model_class.create(params[model_name.to_sym])
         status model_instance.valid? ? 201 : 400
-        model_instance.to_json
+        respond_with model_instance
       end
     end
 
     def generate_show(model_class, model_name, plural_model_name)
-      get("/#{plural_model_name}/:id.:format") do
+      get(%r{^/#{plural_model_name}/(?<id>[^\./?#]+)(\.(?<format>[^\./?#]+))?$}) do
         model_instance = model_class.find(params[:id])
         status 200
-        model_instance.to_json
+        respond_with model_instance
       end
     end
 
     def generate_update(model_class, model_name, plural_model_name)
-      put("/#{plural_model_name}/:id.:format") do
+      put(%r{^/#{plural_model_name}/(?<id>[^\./?#]+)(\.(?<format>[^\./?#]+))?$}) do
         model_instance = model_class.find(params[:id])
         model_instance.update_attributes(params[model_name.to_sym])
         status model_instance.valid? ? 204 : 400
-        model_instance.to_json
+        respond_with model_instance
       end
     end
 
     def generate_destroy(model_class, model_name, plural_model_name)
-      delete("/#{plural_model_name}/:id.:format") do
+      delete(%r{^/#{plural_model_name}/(?<id>[^\./?#]+)(\.(?<format>[^\./?#]+))?$}) do
         model_instance = model_class.find(params[:id])
         model_instance.destroy
         status 204
-        model_instance.to_json
+        respond_with model_instance
       end
     end
   end

data/lib/hovercraft/version.rb

@@ -1,3 +1,3 @@
 module Hovercraft
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/spec/hovercraft/builder_spec.rb

@@ -33,8 +33,14 @@ describe Hovercraft::Builder do
   describe '#configure' do
     let(:application) { stub(register: nil, use: nil) }
 
+    it 'registers the helper methods' do
+      application.should_receive(:register).with(Hovercraft::Helpers)
+
+      subject.configure(application)
+    end
+
     it 'registers the methods to generate actions' do
-      application.should_receive(:register).with(Hovercraft::Actions)
+      application.should_receive(:register).with(Hovercraft::Routes)
 
       subject.configure(application)
     end

data/spec/hovercraft/helpers_spec.rb

@@ -0,0 +1,86 @@
+require 'hovercraft/helpers'
+
+describe Hovercraft::Helpers do
+  subject { Class.new { extend Hovercraft::Helpers } }
+  let(:model_to_json) { stub }
+  let(:model) { stub(to_json: model_to_json) }
+
+  describe '.registered' do
+    let(:application) { stub }
+
+    it 'includes the helpers in the application' do
+      application.should_receive(:helpers).with(described_class)
+
+      Hovercraft::Helpers.registered(application)
+    end
+  end
+
+  describe '#respond_with' do
+    it 'serializes the content to the preferred format' do
+      subject.stub(format: :json)
+
+      subject.respond_with(model).should == model_to_json
+    end
+
+    it 'fails if the preferred format is not supported' do
+      subject.stub(format: :xml)
+
+      lambda { subject.respond_with(model) }.should raise_error
+    end
+  end
+
+  describe '#format' do
+    let(:format_param)   { stub }
+    let(:preferred_type) { stub }
+    let(:default_format) { stub }
+
+    before do
+      subject.stub(
+        params: { format: nil },
+        preferred_type: nil,
+        default_format: nil
+      )
+    end
+
+    it 'defaults to the format param' do
+      subject.stub(params: { format: format_param })
+      subject.format.should == format_param
+    end
+
+    it 'falls back on the preferred_type' do
+      subject.stub(preferred_type: preferred_type)
+      subject.format.should == preferred_type
+    end
+
+    it 'uses the default format as a worst case' do
+      subject.stub(default_format: default_format)
+      subject.format.should == default_format
+    end
+  end
+
+  describe '#preferred_type' do
+    let(:default_format) { stub }
+
+    before { subject.stub(default_format: default_format) }
+
+    it 'checks for json' do
+      subject.stub_chain(:request, :preferred_type) { 'application/json' }
+      subject.preferred_type.should == :json
+    end
+
+    it 'checks for xml' do
+      subject.stub_chain(:request, :preferred_type) { 'application/xml' }
+      subject.preferred_type.should == :xml
+    end
+
+    it 'defaults to json if any format is allowed' do
+      subject.stub_chain(:request, :preferred_type) { '*/*' }
+      subject.preferred_type.should == default_format
+    end
+
+    it 'fails if the acceptable type is unknown' do
+      subject.stub_chain(:request, :preferred_type) { 'unknown/type' }
+      lambda { subject.preferred_type.should }.should raise_error
+    end
+  end
+end

data/spec/hovercraft/{actions_spec.rb → routes_spec.rb}

@@ -1,7 +1,9 @@
-require 'hovercraft/actions'
+require 'hovercraft/routes'
+require 'hovercraft/helpers'
+require 'sinatra'
 require 'rack/test'
 
-describe Hovercraft::Actions do
+describe Hovercraft::Routes do
   include Rack::Test::Methods
 
   let(:application)          { Sinatra.new }
@@ -50,7 +52,8 @@ describe Hovercraft::Actions do
   alias :app :application
 
   before do
-    application.register(Hovercraft::Actions)
+    application.register(Hovercraft::Helpers)
+    application.register(Hovercraft::Routes)
 
     model_class.stub(all: models, create: model, find: model)
   end
@@ -61,7 +64,7 @@ describe Hovercraft::Actions do
     end
 
     it 'generates a GET collection route' do
-      application.routes['GET'][0][0].should == %r{^/employees(?:\.|%2E)([^/?#]+)$}
+      application.routes['GET'][0][0].should == %r{^/employees(\.(?<format>[^\./?#]+))?$}
       application.routes['GET'][0][1].should == ['format']
     end
 
@@ -78,7 +81,7 @@ describe Hovercraft::Actions do
     end
 
     it 'generates a POST collection route' do
-      application.routes['POST'][0][0].should == %r{^/employees(?:\.|%2E)([^/?#]+)$}
+      application.routes['POST'][0][0].should == %r{^/employees(\.(?<format>[^\./?#]+))?$}
       application.routes['POST'][0][1].should == ['format']
     end
 
@@ -103,7 +106,7 @@ describe Hovercraft::Actions do
     end
 
     it 'generates a GET member route' do
-      application.routes['GET'][0][0].should == %r{^/employees/([^/?#]+)(?:\.|%2E)([^/?#]+)$}
+      application.routes['GET'][0][0].should == %r{^/employees/(?<id>[^\./?#]+)(\.(?<format>[^\./?#]+))?$}
       application.routes['GET'][0][1].should == ['id', 'format']
     end
 
@@ -120,7 +123,7 @@ describe Hovercraft::Actions do
     end
 
     it 'generates a PUT member route' do
-      application.routes['PUT'][0][0].should == %r{^/employees/([^/?#]+)(?:\.|%2E)([^/?#]+)$}
+      application.routes['PUT'][0][0].should == %r{^/employees/(?<id>[^\./?#]+)(\.(?<format>[^\./?#]+))?$}
       application.routes['PUT'][0][1].should == ['id', 'format']
     end
 
@@ -145,7 +148,7 @@ describe Hovercraft::Actions do
     end
 
     it 'generates a DELETE member route' do
-      application.routes['DELETE'][0][0].should == %r{^/employees/([^/?#]+)(?:\.|%2E)([^/?#]+)$}
+      application.routes['DELETE'][0][0].should == %r{^/employees/(?<id>[^\./?#]+)(\.(?<format>[^\./?#]+))?$}
       application.routes['DELETE'][0][1].should == ['id', 'format']
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hovercraft
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-11 00:00:00.000000000 Z
+date: 2012-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra-activerecord
@@ -115,6 +115,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .travis.yml
 - Gemfile
 - LICENSE
@@ -122,16 +123,18 @@ files:
 - Rakefile
 - hovercraft.gemspec
 - lib/hovercraft.rb
-- lib/hovercraft/actions.rb
 - lib/hovercraft/builder.rb
 - lib/hovercraft/caller.rb
+- lib/hovercraft/helpers.rb
 - lib/hovercraft/loader.rb
+- lib/hovercraft/routes.rb
 - lib/hovercraft/server.rb
 - lib/hovercraft/version.rb
-- spec/hovercraft/actions_spec.rb
 - spec/hovercraft/builder_spec.rb
 - spec/hovercraft/caller_spec.rb
+- spec/hovercraft/helpers_spec.rb
 - spec/hovercraft/loader_spec.rb
+- spec/hovercraft/routes_spec.rb
 - spec/hovercraft/server_spec.rb
 homepage: ''
 licenses: []
@@ -147,7 +150,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1562352661766896187
+      hash: -800613418121454242
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -156,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1562352661766896187
+      hash: -800613418121454242
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -167,8 +170,9 @@ summary: There's a lot of boiler plate code that goes into creating an API so wh
   directory and call the server from the rackup file and you have yourself a perfect
   API.
 test_files:
-- spec/hovercraft/actions_spec.rb
 - spec/hovercraft/builder_spec.rb
 - spec/hovercraft/caller_spec.rb
+- spec/hovercraft/helpers_spec.rb
 - spec/hovercraft/loader_spec.rb
+- spec/hovercraft/routes_spec.rb
 - spec/hovercraft/server_spec.rb