hovercraft 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 vanstee
+
+MIT License
+
+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.md

@@ -0,0 +1,30 @@
+# Hovercraft
+
+Generate a RESTful API from a directory of ActiveRecord models.
+
+## Get Up and Running
+
+1. Throw this in your Gemfile:
+
+   `gem 'hovercraft'`
+
+2. Put your ActiveRecord models in `models/` (make sure the file names
+   are the same as the class names).
+
+3. Create a rackup file that generates the application:
+
+   ```ruby
+   run Hovercraft::Server.new
+   ``` 
+
+4. Run the application like normal:
+
+   `bundle exec rackup`
+
+## Give Back
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/hovercraft.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hovercraft/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['vanstee']
+  gem.email         = ['vanstee@highgroove.com']
+  gem.description   = %q{Generate a RESTful API from a directory of ActiveRecord models}
+  gem.summary       = %q{There's a lot of boiler plate code that goes into
+                         creating an API so why not just generate all that code
+                         from the models. Just throw your models in a models
+                         directory and call the server from the rackup file and
+                         you have yourself a perfect API.}
+  gem.homepage      = ''
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.test_files    = `git ls-files -- spec/*`.split("\n")
+  gem.name          = 'hovercraft'
+  gem.require_paths = ['lib']
+  gem.version       = Hovercraft::VERSION
+
+  gem.add_dependency 'sinatra-activerecord'
+  gem.add_dependency 'rack-contrib'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rack-test'
+end

data/lib/hovercraft/actions.rb

@@ -0,0 +1,47 @@
+require 'sinatra/base'
+
+module Hovercraft
+  module Actions
+    def generate_index(model_class, model_name, plural_model_name)
+      get("/#{plural_model_name}.:format") do
+        model_instances = model_class.all
+        status 200
+        model_instances.to_json
+      end
+    end
+
+    def generate_create(model_class, model_name, plural_model_name)
+      post("/#{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
+      end
+    end
+
+    def generate_show(model_class, model_name, plural_model_name)
+      get("/#{plural_model_name}/:id.:format") do
+        model_instance = model_class.find(params[:id])
+        status 200
+        model_instance.to_json
+      end
+    end
+
+    def generate_update(model_class, model_name, plural_model_name)
+      put("/#{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
+      end
+    end
+
+    def generate_destroy(model_class, model_name, plural_model_name)
+      delete("/#{plural_model_name}/:id.:format") do
+        model_instance = model_class.find(params[:id])
+        model_instance.destroy
+        status 204
+        model_instance.to_json
+      end
+    end
+  end
+end

data/lib/hovercraft/builder.rb

@@ -0,0 +1,39 @@
+require 'hovercraft/loader'
+require 'hovercraft/actions'
+require 'sinatra/base'
+require 'rack/contrib'
+require 'forwardable'
+
+module Hovercraft
+  class Builder
+    extend Forwardable
+
+    def_delegator :@loader, :with_each_model
+
+    def initialize
+      @loader = Loader.new
+    end
+
+    def application
+      application = Sinatra.new
+      application = configure(application)
+      application = generate_routes(application)
+      application
+    end
+
+    def configure(application)
+      application.register(Hovercraft::Actions)
+      application.use(Rack::PostBodyContentTypeParser)
+      application
+    end
+
+    def generate_routes(application)
+      with_each_model do |model_class, model_name, plural_model_name|
+        application.methods.grep(/generate/).each do |action|
+          application.send(action, model_class, model_name, plural_model_name)
+        end
+      end
+      application
+    end
+  end
+end

data/lib/hovercraft/caller.rb

@@ -0,0 +1,29 @@
+module Hovercraft
+  class Caller
+    CALLERS_TO_IGNORE = [
+      /\/hovercraft(\/(caller|loader|builder|server))?\.rb$/, # hovercraft libary
+      /\/sinatra(\/(base|main|showexceptions))?\.rb$/,        # sinatra library
+      /^\(.*\)$/,                                             # generated code
+      /lib\/ruby/,                                            # ruby core libraries
+      /rubygems\/custom_require\.rb$/,                        # rubygems require hacks
+      /active_support/,                                       # active_support require hack
+      /bundler(\/runtime)?\.rb/,                              # bundler require hacks
+      /<internal:/,                                           # internal in ruby >= 1.9.2
+      /src\/kernel\/bootstrap\/[A-Z]/                         # maglev kernel files
+    ]
+
+    def directory
+      File.dirname(caller_file)
+    end
+
+    def caller_file
+      cleaned_caller_files.first || $PROGRAM_NAME
+    end
+
+    def cleaned_caller_files
+      caller(1).map    { |line| line.split(/:(?=\d|in )/, 3)[0, 1] }.
+                reject { |file, *_| CALLERS_TO_IGNORE.any? { |pattern| file =~ pattern } }.
+                flatten
+    end
+  end
+end

data/lib/hovercraft/loader.rb

@@ -0,0 +1,41 @@
+require 'hovercraft/caller'
+require 'active_support/inflector'
+require 'pry'
+
+module Hovercraft
+  class Loader
+    def initialize
+      @caller = Caller.new
+    end
+
+    def with_each_model
+      models.each do |model_class|
+        model_name = model_class.name.underscore
+        plural_model_name = model_name.pluralize
+        yield(model_class, model_name, plural_model_name)
+      end
+    end
+
+    def models
+      @models ||= require_models
+    end
+
+    private
+
+    def require_models
+      Dir.glob(File.join(models_directory, '**/*.rb')).map do |file|
+        require file
+        class_from(file)
+      end
+    end
+
+    def models_directory
+      File.join(@caller.directory, 'models')
+    end
+
+    def class_from(file)
+      file.gsub!(/#{models_directory}|.rb/, '')
+      file.classify.safe_constantize
+    end
+  end
+end

data/lib/hovercraft/server.rb

@@ -0,0 +1,14 @@
+require 'hovercraft/builder'
+
+module Hovercraft
+  class Server
+    def initialize
+      builder = Builder.new
+      @application = builder.application
+    end
+
+    def call(env)
+      @application.call(env)
+    end
+  end
+end

data/lib/hovercraft/version.rb

@@ -0,0 +1,3 @@
+module Hovercraft
+  VERSION = '0.0.1'
+end

data/lib/hovercraft.rb

@@ -0,0 +1,2 @@
+require 'hovercraft/server'
+require 'hovercraft/version'

data/spec/hovercraft/actions_spec.rb

@@ -0,0 +1,158 @@
+require 'hovercraft/actions'
+require 'rack/test'
+
+describe Hovercraft::Actions do
+  include Rack::Test::Methods
+
+  let(:application)          { Sinatra.new }
+  let(:model_name)           { 'employee' }
+  let(:model_name_pluralize) { 'employees' }
+  let(:model_class)          { Class.new }
+
+  let(:model) do
+    stub(
+      to_json:
+      '
+        {
+          "employee": {
+            "name": "Philip J. Fry",
+            "career": "Intergalactic Delivery Boy"
+          }
+        }
+      ',
+      valid?: true,
+      update_attributes: self,
+      destroy: self
+    )
+  end
+
+  let(:models) do
+    stub(
+      to_json:
+      '
+        [
+          {
+            "employee": {
+              "name": "Philip J. Fry",
+              "career": "Intergalactic Delivery Boy"
+            }
+          },
+          {
+            "employee": {
+              "name": "John A. Zoidberg",
+              "career": "Physician"
+          }
+        ]
+      '
+    )
+  end
+
+  alias :app :application
+
+  before do
+    application.register(Hovercraft::Actions)
+
+    model_class.stub(all: models, create: model, find: model)
+  end
+
+  describe '#generate_index' do
+    before do
+      application.generate_index(model_class, model_name, model_name_pluralize)
+    end
+
+    it 'generates a GET collection route' do
+      application.routes['GET'][0][0].should == %r{^/employees(?:\.|%2E)([^/?#]+)$}
+      application.routes['GET'][0][1].should == ['format']
+    end
+
+    it 'returns a list of models' do
+      get '/employees.json'
+
+      last_response.status.should == 200
+    end
+  end
+
+  describe '#generate_create' do
+    before do
+      application.generate_create(model_class, model_name, model_name_pluralize)
+    end
+
+    it 'generates a POST collection route' do
+      application.routes['POST'][0][0].should == %r{^/employees(?:\.|%2E)([^/?#]+)$}
+      application.routes['POST'][0][1].should == ['format']
+    end
+
+    it 'creates and returns a model' do
+      post '/employees.json', zoidberg: { occipation: 'doctor' }
+
+      last_response.status.should == 201
+    end
+
+    it 'fails and returns an error' do
+      model.stub(valid?: false)
+
+      post '/employees.json', employee: { name: 'Bender Bending Rodriguez', career: 'Girder-bender' }
+
+      last_response.status.should == 400
+    end
+  end
+
+  describe '#generate_show' do
+    before do
+      application.generate_show(model_class, model_name, model_name_pluralize)
+    end
+
+    it 'generates a GET member route' do
+      application.routes['GET'][0][0].should == %r{^/employees/([^/?#]+)(?:\.|%2E)([^/?#]+)$}
+      application.routes['GET'][0][1].should == ['id', 'format']
+    end
+
+    it 'returns a model' do
+      get '/employees/1.json'
+
+      last_response.status.should == 200
+    end
+  end
+
+  describe '#generate_update' do
+    before do
+      application.generate_update(model_class, model_name, model_name_pluralize)
+    end
+
+    it 'generates a PUT member route' do
+      application.routes['PUT'][0][0].should == %r{^/employees/([^/?#]+)(?:\.|%2E)([^/?#]+)$}
+      application.routes['PUT'][0][1].should == ['id', 'format']
+    end
+
+    it 'updates and returns a model' do
+      put '/employees/1.json'
+
+      last_response.status.should == 204
+    end
+
+    it 'fails and returns an error' do
+      model.stub(valid?: false)
+
+      put '/employees/1.json', employee: { career: 'Unemployed' }
+
+      last_response.status.should == 400
+    end
+  end
+
+  describe '#generate_destroy' do
+    before do
+      application.generate_destroy(model_class, model_name, model_name_pluralize)
+    end
+
+    it 'generates a DELETE member route' do
+      application.routes['DELETE'][0][0].should == %r{^/employees/([^/?#]+)(?:\.|%2E)([^/?#]+)$}
+      application.routes['DELETE'][0][1].should == ['id', 'format']
+    end
+
+    it 'destroys and returns a model' do
+      delete '/employees/1.json'
+
+      last_response.status.should == 204
+    end
+  end
+end

data/spec/hovercraft/builder_spec.rb

@@ -0,0 +1,60 @@
+require 'hovercraft/builder'
+
+describe Hovercraft::Builder do
+  let(:model)  { stub(name: 'Robot') }
+  let(:models) { Array.new(3) { model } }
+  let(:params) { models.map { |m| [m, 'robot', 'robots'] } }
+
+  before do
+    subject.stub(:with_each_model).
+      and_yield(*params[0]).
+      and_yield(*params[1]).
+      and_yield(*params[2])
+  end
+
+  describe '#application' do
+    it 'creates a sinatra application' do
+      subject.application.ancestors.should include(Sinatra::Base)
+    end
+
+    it 'configures the application' do
+      subject.should_receive(:configure)
+
+      subject.application
+    end
+
+    it 'generates routes for the application' do
+      subject.should_receive(:generate_routes)
+
+      subject.application
+    end
+  end
+
+  describe '#configure' do
+    let(:application) { stub(register: nil, use: nil) }
+
+    it 'registers the methods to generate actions' do
+      application.should_receive(:register).with(Hovercraft::Actions)
+
+      subject.configure(application)
+    end
+
+    it 'uses a post body parsing middleware' do
+      application.should_receive(:use).with(Rack::PostBodyContentTypeParser)
+
+      subject.configure(application)
+    end
+  end
+
+  describe '#generate_routes' do
+    let(:application) { stub }
+
+    it 'calls all generate methods for each model' do
+      [:index, :create, :show, :update, :destroy].each do |action|
+        application.should_receive("generate_#{action}").exactly(3).times
+      end
+
+      subject.generate_routes(application)
+    end
+  end
+end

data/spec/hovercraft/caller_spec.rb

@@ -0,0 +1,28 @@
+require 'hovercraft/caller'
+
+describe Hovercraft::Caller do
+  describe '#directory' do
+    before { subject.stub(caller_file: '/gems/futurama/parallel_universe_box.rb:10 in `universe`') }
+
+    it 'returns the directory of the file at the top of the execution stack' do
+      subject.directory.should == '/gems/futurama'
+    end
+  end
+
+  describe '#cleaned_caller_files' do
+    let(:files) do
+      [
+        '/gems/futurama/parallel_universe_box.rb:10 in `universe`',
+        '/gems/futurama/parallel_universe_box.rb:3 in `initialize`',
+        '<internal: (irb)'
+      ]
+    end
+
+    before { subject.stub(caller: files) }
+
+    it 'returns a cleaned list of files on the execution stack' do
+      subject.cleaned_caller_files.should_not include('<internal: (irb)')
+      subject.cleaned_caller_files.should have(2).files
+    end
+  end
+end

data/spec/hovercraft/loader_spec.rb

@@ -0,0 +1,23 @@
+require 'hovercraft/loader'
+
+describe Hovercraft::Loader do
+  let(:model)  { stub(name: 'Robot') }
+  let(:models) { Array.new(3) { model } }
+  let(:params) { models.map { |m| [m, 'robot', 'robots'] } }
+
+  describe '#with_each_model' do
+    before { subject.stub(models: models) }
+
+    it 'yields the class, name, and plural name of each model' do
+      expect { |b| subject.with_each_model(&b) }.to yield_successive_args(*params)
+    end
+  end
+
+  describe '#models' do
+    it 'is memoized' do
+      subject.should_receive(:require_models).once.and_return([])
+
+      2.times { subject.models }
+    end
+  end
+end

data/spec/hovercraft/server_spec.rb

@@ -0,0 +1,7 @@
+require 'hovercraft/server'
+
+describe Hovercraft::Server do
+  it 'is a rack application' do
+    subject.respond_to?(:call).should be_true
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: hovercraft
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- vanstee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra-activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-contrib
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate a RESTful API from a directory of ActiveRecord models
+email:
+- vanstee@highgroove.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hovercraft.gemspec
+- lib/hovercraft.rb
+- lib/hovercraft/actions.rb
+- lib/hovercraft/builder.rb
+- lib/hovercraft/caller.rb
+- lib/hovercraft/loader.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/loader_spec.rb
+- spec/hovercraft/server_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2214615904925685358
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2214615904925685358
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: There's a lot of boiler plate code that goes into creating an API so why
+  not just generate all that code from the models. Just throw your models in a models
+  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/loader_spec.rb
+- spec/hovercraft/server_spec.rb