rack-core-data 0.0.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    rack-core-data (0.0.1)
+      activesupport (~> 3.2.6)
+      nokogiri (~> 1.4)
+      rack (~> 1.4)
+      sequel (~> 3.37.0)
+      sinatra (~> 1.3.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    i18n (0.6.0)
+    multi_json (1.3.6)
+    nokogiri (1.5.5)
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    rake (0.9.2.2)
+    rspec (0.6.4)
+    sequel (3.37.0)
+    sinatra (1.3.2)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-core-data!
+  rake (~> 0.9.2)
+  rspec (~> 0.6.1)

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 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,52 @@
+# Rack::CoreData
+**Automatically generate REST APIs for Core Data models**
+
+> This is still in early stages of development, so proceed with caution when using this in a production application. Any bug reports, feature requests, or general feedback at this point would be greatly appreciated.
+
+Building web services for iOS apps is a constant struggle to coordinating data models. You're _probably_ not running Objective-C on the server, so you're stuck duplicating your business logic--allthewhile doing your best to maintain the correct conventions and idioms for each platform.
+
+`Rack::CoreData` aims to bridge the client/server divide, and save you time.
+
+Simply point `Rack::CoreData` at your Core Data model file, and a RESTful webserive is automatically created for you, with all of the resource endpoints you might expect in Rails.
+
+Since we're running on Rack, each endpoint can be overriden if you need to add or change any existing behavior. Likewise, any of the models in the application can be re-opened to make any necessary adjustments.
+
+Think of it like an API scaffold: while you may well throw all of it away eventually, having something to start with will allow you to iterate on the most important parts of your application while you're the most excited about them.
+
+## Usage
+
+### Gemfile
+
+```Ruby
+$ gem 'rack-core-data', :require => 'rack/core-data' 
+```
+
+### config.ru
+
+```ruby
+require 'bundler'
+Bundler.require
+
+# Rack::CoreData requires a Sequel connection to a database
+DB = Sequel.connect(ENV['DATABASE_URL'] || "postgres://localhost:5432/coredata")
+
+run Rack::CoreData('./Example.xcdatamodeld')
+```
+
+## Examples
+
+An example web API using a Core Data model can be found the `/example` directory. 
+
+It uses the same data model as the [AFIncrementalStore](https://github.com/afnetworking/afincrementalStore/) example iOS project, so try running that against Rack::CoreData running on localhost.
+
+## Contact
+
+Mattt Thompson
+
+- http://github.com/mattt
+- http://twitter.com/mattt
+- m@mattt.me
+
+## License
+
+Rack::CoreData 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-core-data.gemspec"))
+
+task :build => "#{gemspec.full_name}.gem"
+
+file "#{gemspec.full_name}.gem" => gemspec.files + ["rack-core-data.gemspec"] do
+  system "gem build rack-core-data.gemspec"
+end

data/lib/rack/core-data/data_model/attribute.rb

@@ -0,0 +1,33 @@
+class Rack::CoreData::DataModel
+  class Attribute
+    attr_reader :name, :type, :identifier, :version_hash_modifier, :default_value
+
+    def initialize(attribute)
+      raise ArgumentError unless ::Nokogiri::XML::Element === attribute
+
+      @name = attribute['name']
+      @type = attribute['attributeType']
+      @identifier = attribute['elementID']
+      @version_hash_modifier = attribute['versionHashModifier']
+      @default_value = case @type
+                       when "Integer 16", "Integer 32", "Integer 64"
+                         attribute['defaultValueString'].to_i
+                       when "Float", "Decimal"
+                         attribute['defaultValueString'].to_f
+                       end if attribute['defaultValueString']
+
+      @optional = attribute['optional'] == "YES"
+      @transient = attribute['transient'] == "YES"
+      @indexed = attribute['indexed'] == "YES"
+      @syncable = attribute['syncable'] == "YES"
+    end
+
+    def to_s
+      @name
+    end
+
+    [:optional, :transient, :indexed, :syncable].each do |symbol|
+      define_method("#{symbol}?") {!!instance_variable_get(("@#{symbol}").intern)}
+    end
+  end
+end

data/lib/rack/core-data/data_model/entity.rb

@@ -0,0 +1,17 @@
+class Rack::CoreData::DataModel
+  class Entity
+    attr_reader :name, :attributes, :relationships
+
+    def initialize(entity)
+      raise ArgumentError unless ::Nokogiri::XML::Element === entity
+
+      @name = entity['name']
+      @attributes = entity.xpath('attribute').collect{|element| Attribute.new(element)}
+      @relationships = entity.xpath('relationship').collect{|element| Relationship.new(element)}
+    end
+
+    def to_s
+      @name
+    end
+  end
+end

data/lib/rack/core-data/data_model/relationship.rb

@@ -0,0 +1,37 @@
+class Rack::CoreData::DataModel
+  class Relationship
+    attr_reader :name, :destination, :inverse, :deletion_rule, :min_count, :max_count
+
+    def initialize(relationship)
+      raise ArgumentError unless ::Nokogiri::XML::Element === relationship
+
+      @name = relationship['name']
+      @destination = relationship['destinationEntity']
+      @inverse = relationship['inverseName']
+      @deletion_rule = relationship['deletionRule'].downcase.to_sym
+
+      @min_count = relationship['minCount'].to_i
+      @max_count = relationship['maxCount'].to_i
+
+      @to_many = relationship['toMany'] == "YES"
+      @optional = relationship['optional'] == "YES"
+      @syncable = relationship['syncable'] == "YES"
+    end
+
+    def to_s
+      @name
+    end
+
+    def to_many?
+      !!@to_many
+    end
+
+    def to_one?
+      !to_many?
+    end
+
+    [:optional, :syncable].each do |symbol|
+      define_method("#{symbol}?") {!!instance_variable_get(("@#{symbol}").intern)}
+    end
+  end
+end

data/lib/rack/core-data/data_model.rb

@@ -0,0 +1,36 @@
+require 'nokogiri'
+
+module Rack::CoreData
+  class DataModel
+    attr_reader :name, :version, :entities
+
+    def initialize(data_model)
+      loop do
+        case data_model
+        when File, /^\<\?xml/
+          data_model = ::Nokogiri::XML(data_model) and redo
+        when String
+          case data_model
+          when /\.xcdatamodeld?$/
+            data_model = Dir[File.join(data_model, "/**/contents")].first and redo
+          else
+            data_model = ::File.read(data_model) and redo
+          end
+        when ::Nokogiri::XML::Document
+          break
+        else
+          raise ArgumentError
+        end
+      end
+
+      model = data_model.at_xpath('model')
+      @name = model['name']
+      @version = model['systemVersion']
+      @entities = model.xpath('entity').collect{|element| Entity.new(element)}
+    end
+  end
+end
+
+require 'rack/core-data/data_model/entity'
+require 'rack/core-data/data_model/attribute'
+require 'rack/core-data/data_model/relationship'

data/lib/rack/core-data/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module CoreData
+    VERSION = '0.0.1'
+  end
+end

data/lib/rack/core-data.rb

@@ -0,0 +1,147 @@
+require 'rack'
+require 'sinatra/base'
+
+require 'sequel'
+require 'active_support/inflector'
+
+require 'rack/core-data/data_model'
+require 'rack/core-data/version'
+
+module Rack::CoreData::Models
+end
+
+module Rack
+  def self.CoreData(xcdatamodel)
+    app = Class.new(Sinatra::Base) do
+      before do
+        content_type :json
+      end
+    end
+
+    model = CoreData::DataModel.new(xcdatamodel)
+
+    # Create each model class before implementing, in order to correctly set up relationships
+    model.entities.each do |entity|
+      klass = Rack::CoreData::Models.const_set(entity.name.capitalize, Class.new(Sequel::Model))
+    end
+
+    model.entities.each do |entity|
+      klass = Rack::CoreData::Models.const_get(entity.name.capitalize)
+      klass.dataset = entity.name.downcase.pluralize.to_sym
+
+      klass.class_eval do
+        strict_param_setting = false
+        plugin :json_serializer, :naked => true, :include => :url, :except => :id 
+        plugin :schema
+
+        def url
+          "/#{self.class.table_name}/#{id}"
+        end
+
+        entity.relationships.each do |relationship|
+          options = {:class => Rack::CoreData::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|
+            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 "Decimal" then :float8
+                    when "Date" then :timestamp
+                    when "Boolean" then :boolean
+                    when "Binary" then :bytea
+                    else :varchar
+                   end
+
+            column attribute.name, 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
+
+        create_table unless table_exists?
+      end
+
+      app.class_eval do
+        include Rack::CoreData::Models
+        klass = Rack::CoreData::Models.const_get(entity.name.capitalize)
+
+        get "/#{entity.name.downcase.pluralize}/?" do
+          klass.all.to_json
+        end
+
+        post "/#{entity.name.downcase.pluralize}/?" do
+          record = klass.new(params)
+          if record.save
+            status 201
+            record.to_json
+          else
+            status 406
+            record.errors.to_json
+          end
+        end
+        
+        get "/#{entity.name.downcase.pluralize}/:id/?" do
+          klass[params[:id]].to_json
+        end
+
+        put "/#{entity.name.downcase.pluralize}/:id/?" do
+          record = klass[params[:id]] or halt 404
+          if record.update(params)
+            status 200
+            record.to_json
+          else
+            status 406
+            record.errors.to_json
+          end
+        end
+        
+        delete "/#{entity.name.downcase.pluralize}/:id/?" do
+          record = klass[params[:id]] or halt 404
+          if record.destroy
+            status 200
+          else
+            status 406
+            record.errors.to_json
+          end
+        end
+
+        entity.relationships.each do |relationship|
+          next unless relationship.to_many?
+
+          get "/#{entity.name.downcase.pluralize}/:id/#{relationship.name}/?" do
+            klass[params[:id]].send(relationship.name).to_json
+          end
+        end
+      end
+    end
+
+    return app
+  end
+end

data/rack-core-data.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack/core-data"
+
+Gem::Specification.new do |s|
+  s.name        = "rack-core-data"
+  s.authors     = ["Mattt Thompson"]
+  s.email       = "m@mattt.me"
+  s.homepage    = "http://mattt.me"
+  s.version     = Rack::CoreData::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = "Rack::CoreData"
+  s.description = "Automatically generate REST APIs for Core Data models."
+
+  s.add_development_dependency "rspec", "~> 0.6.1"
+  s.add_development_dependency "rake",  "~> 0.9.2"
+
+  s.add_dependency "rack", "~> 1.4"
+  s.add_dependency "nokogiri", "~> 1.4"
+  s.add_dependency "sinatra", "~> 1.3.2"
+  s.add_dependency "sequel", "~> 3.37.0"
+  s.add_dependency "activesupport", "~> 3.2.6"
+
+  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-core-data
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mattt Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70340923946660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :development
+  prerelease: false
+  version_requirements: *70340923946660
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70340923946160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70340923946160
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70340923945700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70340923945700
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70340923945240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70340923945240
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70340923944780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70340923944780
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: &70340923944320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.37.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70340923944320
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70340923734700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70340923734700
+description: Automatically generate REST APIs for Core Data models.
+email: m@mattt.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./Gemfile
+- ./Gemfile.lock
+- ./lib/rack/core-data/data_model/attribute.rb
+- ./lib/rack/core-data/data_model/entity.rb
+- ./lib/rack/core-data/data_model/relationship.rb
+- ./lib/rack/core-data/data_model.rb
+- ./lib/rack/core-data/version.rb
+- ./lib/rack/core-data.rb
+- ./LICENSE
+- ./rack-core-data.gemspec
+- ./Rakefile
+- ./README.md
+homepage: http://mattt.me
+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: 3292093600849607730
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3292093600849607730
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Rack::CoreData
+test_files: []