yogo-db 0.2.0

data/spec/factories/schema.rb

@@ -0,0 +1,5 @@
+# Defining a schema factory
+Factory.define(:schema) do |u|
+  u.sequence(:name) { |n| "yogo_#{n}" }
+  u.operations [['add/property', :name, 'String']]
+end

data/spec/helpers/request_helper.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+# This is inspired by Warden's spec helpers
+module Yogo
+  module Spec
+    module Helpers
+    
+      def env_with_params(path = "/", params = {})
+        method = params.fetch(:method, "GET")
+        ::Rack::MockRequest.env_for(path, :input => ::Rack::Utils.build_query(params),
+                                        'HTTP_VERSION' => '1.1',
+                                        'REQUEST_METHOD' => "#{method}")
+      end
+    
+      def setup_rack(app = default_app, middleware = {}, &block)
+        app ||= block if block_given?
+      
+        ::Rack::Builder.new do
+          use Yogo::Rack::ModelLookup, :paths => ['schema', 'data']
+          run app
+        end
+      
+      end
+    
+      def default_app
+        lambda { |env| [ 200, {'Content-Type' => 'text/plain'}, ["Hello World"]]}
+      end
+    end
+  end
+end

data/spec/model/schema_spec.rb

@@ -0,0 +1,136 @@
+# encoding: utf-8
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+require 'yogo/model/schema'
+
+# Testing the middleware and how it modifies the environment
+describe Schema do
+
+  before(:all) do
+    @schema = Factory.create(:schema)
+  end
+
+  after(:all) do
+    @schema.destroy
+  end
+
+  it "should generate a proc" do
+    Schema.first.to_proc.should be_kind_of Proc
+  end
+
+  it "should store and generate a model" do
+    Schema.first.data_model.should be_a(DataMapper::Model)
+  end
+
+  it "should update the data_model after being updated" do
+    original_model = @schema.data_model
+    # original_model.auto_migrate!
+
+    @schema.operation('add/property', :age, 'Integer')
+    @schema.save
+    # @schema.data_model.auto_upgrade!
+    # @schema.data_model.i.should_not eql original_model
+    @schema.data_model.properties.should_not eql original_model.properties
+  end
+
+  # it "should update the attributes" do
+  #   updated_schema = {:name => @schema.name,
+  #     :operations => [['add/property', :id, 'Serial'],['add/property', :description, 'Text'] ]}
+  #   @schema.update(updated_schema)
+  #   @schema.operation_definitions.should eql updated_schema[:operations]
+  # end
+
+  it "should remove the data_model data while being destroyed"
+
+  describe "the generated data model" do
+
+    before(:all) do
+
+      @schema.operation('add/property', :address, 'String', 'label' => 'Address')
+      @schema.operation('add/property', :food, 'Boolean', 'label' => 'Likes Food?')
+      @schema.save
+    end
+
+    it "should have a reference back to the schema object" do
+      model = @schema.data_model
+
+      model.schema.should eql @schema
+    end
+
+    # Assume that each add/property op is exacitly 1 property at the end
+    it "should have the same number of properties as described in the schema" do
+      property_operations = @schema.operation_definitions.select{|op| op[0].eql?('add/property')}
+
+      # There are 3 'default' properties added
+      @schema.data_model.properties.length.should eql(property_operations.length + 3)
+    end
+
+    describe "json" do
+      it "should respond to \#to_json" do
+        @schema.data_model.create.should respond_to(:to_json)
+      end
+
+      it "should should be valid" do
+        item = @schema.data_model.create
+        lambda {
+          JSON.parse(item.to_json)
+        }.should_not raise_exception
+      end
+
+      it "should should inclue url and :id keys" do
+        JSON.parse(@schema.data_model.create.to_json).should include('url', 'data')
+      end
+    end
+
+    it "should respond to \#to_url}" do
+      @schema.data_model.create.should respond_to(:to_url)
+    end
+
+    it "should raise an exception when new and to_url is called" do
+      lambda {
+        @schema.data_model.new.to_url
+      }.should raise_exception
+
+    end
+
+    it "should return valid urls" do
+      new_item = @schema.data_model.create
+      new_item.to_url.should eql("/data/#{@schema.name}/#{new_item.yogo_id}")
+    end
+
+    it "should respond to .parse_json" do
+      @schema.data_model.should respond_to(:parse_json)
+    end
+
+    describe "parse_json" do
+
+      it "should return a hash ready for the model" do
+        json = {:data => {'Address' => 'an address', 'Likes Food?' => true}}.to_json
+        opts = @schema.data_model.parse_json(json)
+        item = @schema.data_model.new(opts)
+        item.should be_valid
+      end
+    end
+
+    it "should respond to attributes_by_label" do
+      @schema.data_model.new.should respond_to(:attributes_by_label)
+    end
+
+    it "should return labeled attributed" do
+      item = @schema.data_model.new
+      attributes = item.attributes_by_label
+      attributes.should be_a Hash
+      attributes.keys.should include('Address', 'Likes Food?')
+    end
+  end
+
+  describe "file handling" do
+    it "should beable to have a file added" do
+      @schema.operation('add/file', :my_file, {'label' => "My File"})
+      
+      @schema.save
+      lambda{
+        @schema.data_model.first
+      }.should_not raise_exception
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+# Standard requirements for Bundler management
+require 'rubygems'
+require 'bundler/setup'
+
+# Load the bundler gemset
+Bundler.require(:default, ENV['RACK_ENV'] || :test )
+
+# Mess with load paths
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec/core'
+require 'autotest/rspec2'
+require 'rack/test'
+require 'rack/mock'
+
+require 'config/datamapper'
+
+begin
+  require 'ruby-debug'
+rescue Exception => e
+  puts "ruby-debug is not installed. Install it with 'gem install ruby-debug'"
+end
+
+Dir[File.join(File.dirname(__FILE__), "helpers", "**/*.rb")].each do |f|
+  require f
+end
+
+Dir[File.join(File.dirname(__FILE__), "factories", "**/*.rb")].each do |f|
+  require f
+end
+
+Rspec.configure do |config|
+  config.include Yogo::Spec::Helpers
+  # config.mock_with :rspec
+  config.before(:all) { DataMapper.finalize.auto_migrate! }
+end

data/spec/yogo/data_app_spec.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+require 'yogo/data_app'
+
+# Testing potential endpoints
+describe Yogo::DataApp do
+  include Rack::Test::Methods
+
+  def app
+    setup_rack(Yogo::DataApp)
+  end
+
+  before(:all) do
+    @cur_schema = Factory.create(:schema)
+  end
+
+  after(:all) do
+    @cur_schema.destroy
+  end
+
+  describe "when retrieving /data/:model_id" do
+
+    it "should return all data" do
+      header 'accepts', 'application/json'
+      get "/data/#{@cur_schema.name}", :headers => {'accepts' => 'application/json'}
+
+      last_response.should be_ok
+      last_response.headers['content-type'].should eql 'application/json;charset=utf-8'
+    end
+  end
+
+end

data/spec/yogo/model_lookup_spec.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+require 'yogo/rack/model_lookup'
+
+# Testing the middleware and how it modifies the environment
+describe "Model lookup" do
+  include Rack::Test::Methods
+
+  def app
+    setup_rack()
+  end
+
+  describe 'with an existing configuration' do
+
+    before(:all) do
+      @configuration = Factory.create(:schema)
+    end
+
+    after(:all) do
+      @configuration.destroy
+    end
+
+    it "should add a yogo.resource key to the environment hash" do
+      env = env_with_params("/schema/#{@configuration.name}")
+      response = app.call(env)
+      env.should be_a Hash
+      env.should have_key('yogo.resource')
+    end
+
+    it "should add a yogo.schema key to the environment hash" do
+      env = env_with_params("/schema/#{@configuration.name}")
+      response = app().call(env)
+      env.should be_a Hash
+      env.should have_key('yogo.schema')
+    end
+
+    it "should point to a datamapper model" do
+      env = env_with_params("/schema/#{@configuration.name}")
+      response = app.call(env)
+      env['yogo.resource'].should be_kind_of(DataMapper::Model)
+    end
+
+    it "should set a model when more then a path was specified" do
+      env = env_with_params("/schema/#{@configuration.name}/more_path")
+      response = app.call(env)
+      env['yogo.resource'].should be_kind_of(DataMapper::Model)
+    end
+  end
+
+  it "should not change the keys environment without a proper URI path" do
+    env = env_with_params('/')
+    lambda {
+      app.call(env)
+    }.should_not change(env, :keys)
+  end
+
+
+  it "should not set a model if no model id was specified" do
+    env = env_with_params('/schema')
+    lambda {
+      app.call(env)
+    }.should_not change(env, :keys)
+  end
+
+  it "should not set a model if a model id was specified but doesn't exist" do
+    env = env_with_params('/schema/some%20sort%20of%20model')
+    app.call(env)
+    env['yogo.resource'].should be_nil
+    env['yogo.schema'].should be_nil
+  end
+
+  # This test feels funny here.
+  it "should respond with a 404 if a model id was specified but doesn't exist" do
+    get '/schema/with_bad_id'
+    last_response.should_not be_ok
+    last_response.status.should eql(404)
+  end
+end

data/spec/yogo/schema_app_spec.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+require 'yogo/schema_app'
+
+# Testing potential endpoints
+describe Yogo::SchemaApp do
+  include Rack::Test::Methods
+
+  def app
+    setup_rack(Yogo::SchemaApp)
+  end
+
+  describe "when retrieving /schema" do
+
+    it "should retrive a list of all schemas" do
+      header 'accept', 'application/json'
+      get '/schema'
+
+      last_response.should be_ok
+      last_response.headers['content-type'].should eql 'application/json;charset=utf-8'
+    end
+  end
+
+  describe "when retriving /schema/:id" do
+    it "should retrieve retrieve a particular schema" do
+      schema = Factory.create(:schema)
+      header 'accept', 'application/json'
+      get "/schema/#{schema.name}"
+      last_response.should be_ok
+      last_response.body.should eql( { :content => schema }.to_json )
+    end
+
+    it "should give a 404 error when the schema does not exist" do
+      get '/schema/with_bad_id'
+      last_response.should_not be_ok
+      last_response.status.should eql(404)
+    end
+  end
+
+  describe "when posting to /schema" do
+    it "should create a new schema with the provided id" do
+      post '/schema', {:name => 'test_item',
+        :operations => [['add/property', :id, 'Serial'],['add/property', :name, 'String']]}.to_json
+
+      last_response.status.should eql(201)
+
+      get '/schema/test_item'
+      last_response.should be_ok
+    end
+
+    it "should not create a new schema with invalid data" do
+      post '/schema', {:name => 'test_item',
+        :bad_op => 42}.to_json
+
+      last_response.status.should eql(401)
+      last_response.body.should eql("Invalid Format")
+    end
+  end
+
+  describe "when putting to /schema/:id" do
+    before(:all) do
+      @cur_schema = Factory.create(:schema)
+    end
+
+    after(:all) do
+      @cur_schema.destroy
+    end
+
+    it "should replace the schema with the given payload" do
+      updated_schema = {'name' => @cur_schema.name,
+        'operations' => [['add/property', 'id', 'Integer'],['add/property', 'description', 'Text'] ]}
+      put "/schema/#{@cur_schema.name}", updated_schema.to_json
+
+      last_response.status.should eql(200)
+      JSON.parse(last_response.body)["content"].should eql updated_schema.merge('guid' => "/schema/#{@cur_schema.name}")
+    end
+
+    it "should not update when given an invalid payload" do
+      put "/schema/#{@cur_schema.name}", "some really bad data"
+
+      last_response.should_not be_ok
+    end
+    it "should return an error when an invalid ID is given" do
+      put '/schema/a_bad_id', "not so good data"
+
+      last_response.should_not be_ok
+      last_response.status.should eql(404)
+    end
+  end
+
+  describe "when deleting /schema/:id" do
+    it "should delete the schema of the given id" do
+      schema = Factory.create(:schema)
+      delete "/schema/#{schema.name}"
+
+      last_response.should be_ok
+    end
+    it "should not delete anything when an invalid ID is given" do
+      delete "/schema/a_bad_id"
+
+      last_response.should_not be_ok
+      last_response.status.should eql 404
+    end
+  end
+end

data/yogo-db.gemspec

@@ -0,0 +1,115 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{yogo-db}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Heimbuch"]
+  s.date = %q{2010-10-29}
+  s.description = %q{Restful interface to yogo data components}
+  s.email = %q{rheimbuch@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rspec",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "config.ru",
+     "config/database.yml",
+     "config/datamapper.rb",
+     "features/step_definitions/yogo-db_steps.rb",
+     "features/support/env.rb",
+     "features/yogo-db.feature",
+     "lib/yogo-db.rb",
+     "lib/yogo/data/default_methods.rb",
+     "lib/yogo/data_app.rb",
+     "lib/yogo/db/.gitdir",
+     "lib/yogo/model/schema.rb",
+     "lib/yogo/operations.rb",
+     "lib/yogo/operations/basic.rb",
+     "lib/yogo/operations/file.rb",
+     "lib/yogo/rack/model_lookup.rb",
+     "lib/yogo/schema_app.rb",
+     "spec/factories/schema.rb",
+     "spec/helpers/request_helper.rb",
+     "spec/model/schema_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/yogo/data_app_spec.rb",
+     "spec/yogo/model_lookup_spec.rb",
+     "spec/yogo/schema_app_spec.rb",
+     "yogo-db.gemspec"
+  ]
+  s.homepage = %q{http://github.com/yogo/yogo-db}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Yogo DB Rest components}
+  s.test_files = [
+    "spec/factories/schema.rb",
+     "spec/helpers/request_helper.rb",
+     "spec/model/schema_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/yogo/data_app_spec.rb",
+     "spec/yogo/model_lookup_spec.rb",
+     "spec/yogo/schema_app_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sinatra>, [">= 0"])
+      s.add_runtime_dependency(%q<rack>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<dm-core>, [">= 0"])
+      s.add_runtime_dependency(%q<dm-migrations>, [">= 0"])
+      s.add_runtime_dependency(%q<dm-serializer>, [">= 0"])
+      s.add_runtime_dependency(%q<dm-timestamps>, [">= 0"])
+      s.add_runtime_dependency(%q<dm-validations>, [">= 0"])
+      s.add_runtime_dependency(%q<dm-sqlite-adapter>, [">= 0"])
+      s.add_runtime_dependency(%q<dm-postgres-adapter>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<carrierwave>, [">= 0"])
+    else
+      s.add_dependency(%q<sinatra>, [">= 0"])
+      s.add_dependency(%q<rack>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<dm-core>, [">= 0"])
+      s.add_dependency(%q<dm-migrations>, [">= 0"])
+      s.add_dependency(%q<dm-serializer>, [">= 0"])
+      s.add_dependency(%q<dm-timestamps>, [">= 0"])
+      s.add_dependency(%q<dm-validations>, [">= 0"])
+      s.add_dependency(%q<dm-sqlite-adapter>, [">= 0"])
+      s.add_dependency(%q<dm-postgres-adapter>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<carrierwave>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<sinatra>, [">= 0"])
+    s.add_dependency(%q<rack>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<dm-core>, [">= 0"])
+    s.add_dependency(%q<dm-migrations>, [">= 0"])
+    s.add_dependency(%q<dm-serializer>, [">= 0"])
+    s.add_dependency(%q<dm-timestamps>, [">= 0"])
+    s.add_dependency(%q<dm-validations>, [">= 0"])
+    s.add_dependency(%q<dm-sqlite-adapter>, [">= 0"])
+    s.add_dependency(%q<dm-postgres-adapter>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<carrierwave>, [">= 0"])
+  end
+end
+