mattt / rack-scaffold Goto Github PK

View Code? Open in Web Editor NEW

527.0 30.0 39.0 210 KB

Automatically generate REST APIs from Core Data models

License: MIT License

Ruby 100.00%

rack-scaffold's Introduction

Rack::Scaffold

Automatically generate RESTful CRUD services

This project is no longer maintained.

Installation

Gemfile

source :rubygems

gem 'rack-scaffold', require: 'rack/scaffold'

gem 'sequel'
gem 'core_data'

gem 'unicorn'
gem 'pg'

Usage

An example web API using a Core Data model can be found the /example directory.

config.ru

require 'sequel'
require 'core_data'
require 'rack/scaffold'

DB = Sequel.connect(ENV['DATABASE_URL'])

run Rack::Scaffold model: './Example.xcdatamodeld', only: [:create, :read]

Available Actions

By default, Rack::Scaffold will enable all of the actions described below. Actions can be whitelisted or blacklisted by passing either the only or except options, respectively.

create (POST /resources): Creates a new resource with the fields in a www-form-urlencoded or application/json encoded HTTP request body.
read (GET /resources & GET /resources/123): Reads a collection of resources or an individual resource at the specified URI. Supports pagination by passing either page & per_page or limit & offset parameters.
update (PUT OR PATCH /resources/123): Updates the specified resource with the fields in a www-form-urlencoded or application/json encoded HTTP request body.
delete (DELETE /resources/123): Deletes the specified resource.
susbscribe (SUBSCRIBE or GET /resources with Accept: text/event-stream): Subscribes to create, update, and delete actions performed, streaming corresponding JSON Patch diffs. You can read more about the Rocket technique for streaming REST resources at http://rocket.github.io.

Supported Data Models

Core Data Model (.xcdatamodeld)
Sequel
ActiveRecord

Contact

Mattt

License

Rack::Scaffold is available under the MIT license. See the LICENSE file for more info.

rack-scaffold's People

Contributors

Stargazers

Watchers

rack-scaffold's Issues

Automatic Migrations For Missing Columns

example error

When I follow the example steps, in the "bundle" step, terminal return this:

There was a LoadError while evaluating rack-core-data.gemspec: 
cannot load such file -- rack/contrib from
  /*/rack-core-data-master/rack-core-data.gemspec:3:in `<main>'

Does it try to require a relative path? That's been removed in Ruby 1.9.

Using CoreData indexed="YES"

When using an indexed field in CoreData

    <entity name="Song" syncable="YES">
        <attribute name="title" attributeType="String" indexed="YES" syncable="YES"/>
    </entity>

rack-core-data and Sequel throws an exception while trying to create the index in Postgres

PG::Error: ERROR:  syntax error at or near "'title'" (Sequel::DatabaseError)
CREATE INDEX "songs_title_index" ON "songs" ('title')
                                             ^

Sequel is receiving a string for the column name, and single-quoting it when creating an index. Sequel can accept a symbol instead of a string, still create the table, and also create the index.

Quick pull request coming shortly.

Doesn't handle changes to CoreData

I added an additional attribute on a managed object and it was not recognized. It looks like it only creates the table for an entity if it doesn't exist.

I would expect it to either to true up the data model with whatever is in the database or error if there is a difference between the two. Maybe I have unrealistic expectations :)

Heroku deployment

Question, not an issue
What a cool project! I can run it locally without a hitch, on all sorts of data models, but I'm having issues deploying to Heroku.

Here's the directory example:

.env
.git
Example.xcdatamodeld
Gemfile
Gemfile.lock
Procfile
README.md
config.ru

And the heroku push response:

➜  example git:(master) gp heroku master
Counting objects: 23, done.
Delta compression using up to 8 threads.
Compressing objects: 100% (21/21), done.
Writing objects: 100% (23/23), 4.49 KiB, done.
Total 23 (delta 7), reused 0 (delta 0)

-----> Heroku receiving push
-----> Ruby/Rack app detected
-----> Installing dependencies using Bundler version 1.2.0
       Running: bundle install --without development:test --path vendor/bundle --binstubs bin/ --deployment
       You are trying to install in deployment mode after changing
       your Gemfile. Run `bundle install` elsewhere and add the
       updated Gemfile.lock to version control.
       You have added to the Gemfile:
       * source: source at /tmp
       You have deleted from the Gemfile:
       * source: source at /Users/jp/Documents/sandbox/rack-core-data
       You have changed in the Gemfile:
       * rack-core-data from `source at /tmp` to `no specified source`
 !
 !     Failed to install gems via Bundler.
 !
 !     Heroku push rejected, failed to compile Ruby/rack app

Connection to 10.44.66.18 closed by remote host.
To [email protected]:core-data-test.git
 ! [remote rejected] master -> master (pre-receive hook declined)
error: failed to push some refs to '[email protected]:core-data-test.git'

Any thoughts as to what I'm doing wrong?

Thanks,
JP

Read and Evaluate Core Data Migrations

POST with JSON payload will create empty object

Recreated the Artist/Song model at: http://nameless-mountain-3995.herokuapp.com/artists

When I try to create a new artist with a JSON payload, an empty object is returned. The request should return a 406 if it is unacceptable, otherwise it should create my object with the data provided and return a 201.

Payload:
{"artistDescription":"English rock band formed in Liverpool in 1960","name":"The Beatles"}

Response:

HTTP 201 Created
{
    "artistDescription" : null,
    "name" : null,
    "url" : "/artists/5"
}

PUT to an object will always 406 when sending JSON

Tried this on two separate data models. Recreated the Artists/Song model in the README and pushed to: http://nameless-mountain-3995.herokuapp.com/artists

Actual: If I PUT to /artists/1 with Content-Type application/json, and payload {"artistDescription":"Test"} I will get a 406 Bad Request.

Expected: The API should update my object and return a 200 OK.

This works fine when sending application/x-www-form-urlencoded data.

I've recreated this using both a REST client, and using AFNetworking to hit the server with an AFJSONRequestOperation (with JSON payload).