rack-scaffold 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62eaf4d70bb8f5ffe5b174b33713b1ebeae39bc5
+  data.tar.gz: 60452a102b8b505f53dfdc1a6ef2b32a56931ccf
+SHA512:
+  metadata.gz: 5f9b7caa071e3813f3b0115e68db9ada8c116f57d5283594d3c6811a84faed2781a745ea1866dea66d722d3d9121058cd6f4f78c16c8dcf5009c3990fd51604d
+  data.tar.gz: 36a22a42bbd975c11cfec13ca44f239774061b8a8a7115eeda608bf96031b84ec74813a7eddc113d72cbac3d1ec125cb1f1e43ee2171c4c578dae97ac351bc09

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    rack-scaffold (0.0.1)
+      activesupport (>= 3.0)
+      rack (~> 1.4)
+      rack-contrib (~> 1.1)
+      sinatra (~> 1.3)
+      sinatra-param (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    i18n (0.6.1)
+    multi_json (1.7.2)
+    rack (1.5.2)
+    rack-contrib (1.1.0)
+      rack (>= 0.9.1)
+    rack-protection (1.5.0)
+      rack
+    rake (10.0.4)
+    sinatra (1.4.2)
+      rack (~> 1.5, >= 1.5.2)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    sinatra-param (0.1.2)
+      sinatra (~> 1.3)
+    tilt (1.3.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-scaffold!
+  rake

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Mattt Thompson (http://mattt.me/)
+
+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,53 @@
+# Rack::Scaffold
+**Automatically generate RESTful CRUD services**
+
+> This project generalizes the webservice auto-generation functionality of [Rack::CoreData](https://github.com/mattt/rack-core-data) with a plugin architecture that can adapt to any data model format. It is currently being actively developed for inclusion in the next release of [Helios](https://github.com/helios-framework/helios)
+
+### Supported Data Models
+
+- [Core Data Model](https://github.com/mattt/core_data/) (`.xcdatamodeld`)
+- [Sequel](https://github.com/jeremyevans/sequel)
+- [ActiveRecord](https://github.com/rails/rails)
+
+## Usage
+
+### Gemfile
+
+```Ruby
+source :rubygems
+
+gem 'rack-scaffold', require: 'rack/scaffold'
+gem 'sequel'
+gem 'core_data'
+
+gem 'unicorn'
+gem 'pg'
+```
+
+### config.ru
+
+```ruby
+require 'sequel'
+require 'core_data'
+require 'rack/scaffold'
+
+DB = Sequel.connect(ENV['DATABASE_URL'])
+
+run Rack::Scaffold model: './Example.xcdatamodeld', only: [:create, :read]
+```
+
+## Examples
+
+An example web API using a Core Data model can be found the `/example` directory.
+
+## Contact
+
+Mattt Thompson
+
+- http://github.com/mattt
+- http://twitter.com/mattt
+- m@mattt.me
+
+## License
+
+Rack::Scaffold is available under the MIT license. See the LICENSE file for more info.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler"
+Bundler.setup
+
+gemspec = eval(File.read("rack-scaffold.gemspec"))
+
+task :build => "#{gemspec.full_name}.gem"
+
+file "#{gemspec.full_name}.gem" => gemspec.files + ["rack-scaffold.gemspec"] do
+  system "gem build rack-scaffold.gemspec"
+end

data/lib/rack/scaffold.rb

@@ -0,0 +1,121 @@
+require 'rack'
+require 'rack/contrib'
+require 'sinatra/base'
+require 'sinatra/param'
+
+require 'rack/scaffold/version'
+require 'rack/scaffold/adapters'
+
+module Rack
+  class Scaffold
+    ACTIONS = [:create, :read, :update, :destroy]
+
+    def initialize(options = {})
+      raise ArgumentError, "Missing option: :model or :models" unless options[:model] or options[:models]
+
+      if options[:models] and options[:models].kind_of?(Array)
+        @app = Rack::Cascade.new(options.delete(:models).collect{|model| self.class.new(options.dup.merge({model: model}))}) and return
+      end
+
+      @app = Class.new(Sinatra::Base) do
+        use Rack::PostBodyContentTypeParser
+        helpers Sinatra::Param
+
+        before do
+          content_type :json
+        end
+
+        disable :raise_errors, :show_exceptions
+      end
+
+      @actions = (options[:only] || ACTIONS) - (options[:except] || [])
+
+      @adapter = Rack::Scaffold.adapters.detect{|adapter| adapter === options[:model]}
+      raise "No suitable adapters found for #{options[:model]} in #{Rack::Scaffold.adapters}" unless @adapter
+
+      resources = Array(@adapter.resources(options[:model]))
+      resources.each do |resource|
+        @app.instance_eval do
+          post "/#{resource.plural}/?" do
+            if record = resource.create!(params)
+              status 201
+              {entity.name.downcase => record}.to_json
+            else
+              status 406
+              {errors: record.errors}.to_json
+            end
+          end
+        end if @actions.include?(:create)
+
+        @app.instance_eval do
+          get "/#{resource.plural}/?" do
+            if params[:page] or params[:per_page]
+              param :page, Integer, default: 1, min: 1
+              param :per_page, Integer, default: 100, in: (1..100)
+
+              {
+                "#{resource.plural}" => resource.paginate(params[:per_page], (params[:page] - 1) * params[:per_page]),
+                page: params[:page],
+                total: resource.count
+              }.to_json
+            else
+              param :limit, Integer, default: 100, in: (1..100)
+              param :offset, Integer, default: 0, min: 0
+
+              {
+                "#{resource.plural}" => resource.paginate(params[:limit], params[:offset])
+              }.to_json
+            end
+          end
+
+          get "/#{resource.plural}/:id/?" do
+            record = resource[params[:id]] or halt 404
+            {entity.name.downcase => record}.to_json
+          end
+        end if @actions.include?(:read)
+
+        @app.instance_eval do
+          put "/#{resource.plural}/:id/?" do
+            record = resource[params[:id]] or halt 404
+            if record.update!(params)
+              status 200
+              {entity.name.downcase => record}.to_json
+            else
+              status 406
+              {errors: record.errors}.to_json
+            end
+          end
+        end if @actions.include?(:update)
+
+        @app.instance_eval do
+          delete "/#{resource.plural}/:id/?" do
+            record = resource[params[:id]] or halt 404
+            if record.destroy
+              status 200
+            else
+              status 406
+              {errors: record.errors}.to_json
+            end
+          end
+        end if @actions.include?(:delete)
+
+        # @app.instance_eval do
+        #   entity.relationships.each do |relationship|
+        #     next unless relationship.to_many?
+
+        #     get "/#{resource.plural}/:id/#{relationship.name}/?" do
+        #       {relationship.name => resource[params[:id]].send(relationship.name)}.to_json
+        #     end
+        #   end
+        # end
+      end
+    end
+
+    def call(env)
+      @app.call(env)
+    end
+  end
+
+  module Models
+  end
+end

data/lib/rack/scaffold/adapters.rb

@@ -0,0 +1,78 @@
+module Rack
+  class Scaffold
+    def self.adapters
+      @@adapters ||= []
+    end
+
+    module Adapters
+      class NotImplementedError < StandardError; end
+
+      class Base
+        attr_reader :klass
+
+        class << self
+          def inherited(adapter)
+            ::Rack::Scaffold.adapters << adapter
+            super
+          end
+
+          def ===(model)
+            raise NotImplementedError
+          end
+
+          def resources(model)
+            raise NotImplementedError
+          end
+        end
+
+        def initialize(klass)
+          @klass = klass
+        end
+
+        def singular
+          raise NotImplementedError
+        end
+
+        def plural
+          raise NotImplementedError
+        end
+
+        def count
+          raise NotImplementedError
+        end
+
+        def all
+          raise NotImplementedError
+        end
+
+        def paginate(offset, limit)
+          raise NotImplementedError
+        end
+
+        def [](id)
+          raise NotImplementedError
+        end
+
+        def find(options = {})
+          raise NotImplementedError
+        end
+
+        def create!(attributes = {})
+          raise NotImplementedError
+        end
+
+        def update!(attributes = {})
+          raise NotImplementedError
+        end
+
+        def destroy!
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end
+
+require 'rack/scaffold/adapters/active_record' if defined?(ActiveRecord::Base)
+require 'rack/scaffold/adapters/sequel' if defined?(Sequel)
+require 'rack/scaffold/adapters/core_data' if defined?(Sequel) and defined?(CoreData)

data/lib/rack/scaffold/adapters/active_record.rb

@@ -0,0 +1,36 @@
+require 'active_record'
+require 'forwardable'
+
+module Rack::Scaffold::Adapters
+  class ActiveRecord < Base
+    extend Forwardable
+
+    def_delegators :@klass, :count, :all, :find, :create!, :update!, :destroy!
+
+    class << self
+      def ===(model)
+        ::ActiveRecord::Base === model
+      end
+
+      def resources(model)
+        model
+      end
+    end
+
+    def singular
+      @klass.name.downcase
+    end
+
+    def plural
+      @klass.table_name
+    end
+
+    def paginate(limit, offset)
+      @klass.limit(limit).offset(offset)
+    end
+
+    def [](id)
+      self.find(id)
+    end
+  end
+end

data/lib/rack/scaffold/adapters/core_data.rb

@@ -0,0 +1,114 @@
+require 'core_data'
+require 'sequel'
+require 'active_support/inflector'
+
+module Rack::Scaffold::Adapters
+  class CoreData < Sequel
+    class << self
+      def ===(model)
+        return true if ::CoreData::DataModel === model
+        !! ::CoreData::DataModel.new(model) rescue false
+      end
+
+      def resources(xcdatamodel)
+        model = ::CoreData::DataModel.new(xcdatamodel)
+        model.entities.collect{|entity| new(entity)}
+      end
+    end
+
+    def initialize(entity)
+      klass = Class.new(::Sequel::Model)
+      klass.dataset = entity.name.downcase.pluralize.to_sym
+
+      klass.class_eval do
+        self.strict_param_setting = false
+        self.raise_on_save_failure = false
+
+        plugin :json_serializer, naked: true, include: [:url]
+        plugin :schema
+        plugin :validation_helpers
+
+        def url
+          "/#{self.class.table_name}/#{self[primary_key]}"
+        end
+
+        # entity.relationships.each do |relationship|
+        #   options = {:class => Rack::Scaffold::Models.const_get(relationship.destination.capitalize)}
+
+        #   if relationship.to_many?
+        #     one_to_many relationship.name.to_sym, options
+        #   else
+        #     many_to_one relationship.name.to_sym, options
+        #   end
+        # end
+
+        set_schema do
+          primary_key :id
+
+          entity.attributes.each do |attribute|
+            next if attribute.transient?
+
+            options = {
+              :null => attribute.optional?,
+              :index => attribute.indexed?,
+              :default => attribute.default_value
+            }
+
+            type = case attribute.type
+                    when "Integer 16" then :int2
+                    when "Integer 32" then :int4
+                    when "Integer 64" then :int8
+                    when "Float" then :float4
+                    when "Double" then :float8
+                    when "Decimal" then :float8
+                    when "Date" then :timestamp
+                    when "Boolean" then :boolean
+                    when "Binary" then :bytea
+                    else :varchar
+                   end
+
+            column attribute.name.to_sym, type, options
+          end
+
+          entity.relationships.each do |relationship|
+            options = {
+              :index => true,
+              :null => relationship.optional?
+            }
+
+            if not relationship.to_many?
+              column "#{relationship.name}_id".to_sym, :integer, options
+            end
+          end
+        end
+
+        if table_exists?
+          missing_columns = schema.columns.reject{|c| columns.include?(c[:name])}
+          db.alter_table table_name do
+            missing_columns.each do |options|
+              add_column options.delete(:name), options.delete(:type), options
+            end
+          end
+        else
+          create_table
+        end
+      end
+
+      klass.send :define_method, :validate do
+        entity.attributes.each do |attribute|
+          case attribute.type
+            when "Integer 16", "Integer 32", "Integer 64"
+              validates_integer attribute.name
+            when "Float", "Double", "Decimal"
+              validates_numeric attribute.name
+            when "String"
+              validates_min_length attribute.minimum_value, attribute.name if attribute.minimum_value
+              validates_max_length attribute.maximum_value, attribute.name if attribute.maximum_value
+           end
+        end
+      end
+
+      super(klass)
+    end
+  end
+end

data/lib/rack/scaffold/adapters/sequel.rb

@@ -0,0 +1,32 @@
+require 'sequel'
+require 'forwardable'
+
+module Rack::Scaffold::Adapters
+  class Sequel < Base
+    extend Forwardable
+
+    def_delegators :@klass, :count, :all, :find, :[], :create!, :update!, :destroy!
+
+    class << self
+      def ===(model)
+        ::Sequel::Model === model
+      end
+
+      def resources(model)
+        model
+      end
+    end
+
+    def singular
+      @klass.name
+    end
+
+    def plural
+      @klass.table_name
+    end
+
+    def paginate(limit, offset)
+      @klass.limit(limit, offset)
+    end
+  end
+end

data/lib/rack/scaffold/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class Scaffold
+    VERSION = "0.0.1"
+  end
+end

data/rack-scaffold.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack/scaffold/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rack-scaffold"
+  s.authors     = ["Mattt Thompson"]
+  s.email       = "m@mattt.me"
+  s.homepage    = "http://mattt.me"
+  s.license     = "MIT"
+  s.version     = Rack::Scaffold::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = "Rack::Scaffold"
+  s.description = "Automatically generate RESTful CRUD services"
+
+  s.add_dependency "rack", "~> 1.4"
+  s.add_dependency "rack-contrib", "~> 1.1"
+  s.add_dependency "sinatra", "~> 1.3"
+  s.add_dependency "sinatra-param", "~> 0.1"
+  s.add_dependency "activesupport", ">= 3.0"
+
+  s.add_development_dependency "rake"
+
+  s.files         = Dir["./**/*"].reject { |file| file =~ /\.\/(bin|example|log|pkg|script|spec|test|vendor)/ }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: rack-scaffold
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mattt Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rack-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: sinatra-param
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Automatically generate RESTful CRUD services
+email: m@mattt.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./Gemfile
+- ./Gemfile.lock
+- ./lib/rack/scaffold/adapters/active_record.rb
+- ./lib/rack/scaffold/adapters/core_data.rb
+- ./lib/rack/scaffold/adapters/sequel.rb
+- ./lib/rack/scaffold/adapters.rb
+- ./lib/rack/scaffold/version.rb
+- ./lib/rack/scaffold.rb
+- ./LICENSE
+- ./rack-scaffold.gemspec
+- ./Rakefile
+- ./README.md
+homepage: http://mattt.me
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Rack::Scaffold
+test_files: []