instant-api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af76d4080ac639a97ba3378849e41d274b96a32f
+  data.tar.gz: cb9fa8521e82d1ca0f2c98fdf704264280af8a37
+SHA512:
+  metadata.gz: 422fb15565dcabe18d98b1434974a8d2d8219847a54bf50d39e8eb25f841a68a39396a2ece4abee17ce3deb69ed198ca4ddee89cbe57a6b85a07ce093bb15d40
+  data.tar.gz: 442fdb18531c0736b9bb7b9dc3a83d79cfd00cab0b2a3f770c0d5833c2a102a2a645a942bd408e3421c9469cbe64d3cebc328867481184fcd2460175740ce09d

data/.gitignore

@@ -0,0 +1,9 @@
+/spec/dummy/log/*.log
+/.bundle
+/log/*.log
+/public/system
+/tmp
+/vendor/bundle
+*.swp
+*.orig
+.idea

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'factory_girl_rails', '~> 4.2.1'
+  gem 'rspec-rails',        '~> 2.14.0'
+  gem 'shoulda-matchers',   '~> 2.3.0'
+  gem 'fuubar',             '~> 1.2.0'
+  gem 'ffaker',             '~> 1.18.0'
+  gem 'database_cleaner',   '~> 1.1.1'
+  gem 'webmock',            '~> 1.13.0'
+  gem 'mysql2'
+end

data/Gemfile.lock

@@ -0,0 +1,142 @@
+PATH
+  remote: .
+  specs:
+    instant-api (0.1)
+      kaminari (~> 0.15)
+      rails (~> 4.0)
+      rails-api (~> 0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.0.2)
+      actionpack (= 4.0.2)
+      mail (~> 2.5.4)
+    actionpack (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+    activerecord (4.0.2)
+      activemodel (= 4.0.2)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.2)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    arel (4.0.2)
+    atomic (1.1.15)
+    builder (3.1.4)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    database_cleaner (1.1.1)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    factory_girl (4.2.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.2.1)
+      factory_girl (~> 4.2.0)
+      railties (>= 3.0.0)
+    ffaker (1.18.0)
+    fuubar (1.2.1)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.2.0)
+      ruby-progressbar (~> 1.0)
+    hike (1.2.3)
+    i18n (0.6.9)
+    kaminari (0.15.1)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    minitest (4.7.5)
+    multi_json (1.8.4)
+    mysql2 (0.3.15)
+    polyglot (0.3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.2)
+      actionmailer (= 4.0.2)
+      actionpack (= 4.0.2)
+      activerecord (= 4.0.2)
+      activesupport (= 4.0.2)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.2)
+      sprockets-rails (~> 2.0.0)
+    rails-api (0.2.0)
+      actionpack (>= 3.2.11)
+      railties (>= 3.2.11)
+    railties (4.0.2)
+      actionpack (= 4.0.2)
+      activesupport (= 4.0.2)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-instafail (0.2.4)
+    rspec-mocks (2.14.6)
+    rspec-rails (2.14.1)
+      actionpack (>= 3.0)
+      activemodel (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    ruby-progressbar (1.4.2)
+    safe_yaml (1.0.1)
+    shoulda-matchers (2.3.0)
+      activesupport (>= 3.0.0)
+    sprockets (2.11.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    thor (0.18.1)
+    thread_safe (0.2.0)
+      atomic (>= 1.1.7, < 2)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.38)
+    webmock (1.13.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner (~> 1.1.1)
+  factory_girl_rails (~> 4.2.1)
+  ffaker (~> 1.18.0)
+  fuubar (~> 1.2.0)
+  instant-api!
+  mysql2
+  rspec-rails (~> 2.14.0)
+  shoulda-matchers (~> 2.3.0)
+  webmock (~> 1.13.0)

data/README.md

@@ -0,0 +1,231 @@
+# Overview
+
+Instant-API automatically creates a REST API from a Rails project
+Configuration
+---
+
+Instant-API works with Rails (it has been tested with Rails 4.0)
+
+Add the gem to your Gemfile
+```ruby
+gem 'instant-api'
+```
+
+Create an initializer: config/initializers/instant_api.rb
+```ruby
+require 'instant_api'
+InstantApi::Controller::Routes.new.build_controllers
+```
+
+
+Example
+---
+
+Let's say, you have these models
+```ruby
+class Movie < ActiveRecord::Base
+  has_and_belongs_to_many :countries
+end
+
+class Country < ActiveRecord::Base
+  has_and_belongs_to_many :movies
+end
+```
+
+And you want to access these though a Rest API, for instanace, your config/routes.rb
+
+```ruby
+YourApp::Application.routes.draw do
+  resources :countries do
+    resources :movies, only: [:index, :show]
+  end
+end
+```
+
+The routes generated are
+
+```
+                 Prefix Verb   URI Pattern                                                     Controller#Action
+         country_movies GET    /countries/:country_id/movies(.:format)                         movies#index
+          country_movie GET    /countries/:country_id/movies/:id(.:format)                     movies#show
+              countries GET    /countries(.:format)                                            countries#index
+                        POST   /countries(.:format)                                            countries#create
+            new_country GET    /countries/new(.:format)                                        countries#new
+           edit_country GET    /countries/:id/edit(.:format)                                   countries#edit
+                country GET    /countries/:id(.:format)                                        countries#show
+                        PATCH  /countries/:id(.:format)                                        countries#update
+                        PUT    /countries/:id(.:format)                                        countries#update
+                        DELETE /countries/:id(.:format)                                        countries#destroy
+```
+
+Start your app and then you can make the following calls:
+
+* Create
+```bash
+> curl -X POST -d "country[name]=Japón;country[english_name]=Japan" http://localhost:3000/countries
+{
+  "id": 87,
+  "name": "Japón",
+  "created_at": "2014-08-03T15:09:35.611Z",
+  "updated_at": "2014-08-03T15:09:35.611Z",
+  "english_name": "Japan"
+}
+```
+
+
+* Index, pagination paremeters: page, per_page
+````bash
+> curl -s -X GET http://localhost:3000/countries?page=2&per_page=4
+{
+  "collection": [
+    {
+      "id": 5,
+      "name": "Netherlands",
+      "created_at": "2010-09-16T23:46:07.000Z",
+      "updated_at": "2013-01-28T17:32:01.000Z",
+      "english_name": "Netherlands"
+    },
+    {
+      "id": 6,
+      "name": "Germany",
+      "created_at": "2010-10-21T16:53:52.000Z",
+      "updated_at": "2013-01-28T17:29:12.000Z",
+      "english_name": "Germany"
+    },
+    {
+      "id": 7,
+      "name": "New Zealand",
+      "created_at": "2010-10-21T16:55:30.000Z",
+      "updated_at": "2013-01-28T17:32:01.000Z",
+      "english_name": "New Zealand"
+    },
+    {
+      "id": 8,
+      "name": "Japan",
+      "created_at": "2010-10-21T16:59:02.000Z",
+      "updated_at": "2013-01-28T17:32:00.000Z",
+      "english_name": "Japan"
+    }
+  ],
+  "pagination": { "count": 84, "page": 2, "per_page": 4 }
+}
+```
+
+* Show
+```bash
+> curl -s -X GET http://localhost:3000/countries/5
+{
+  "id": 5,
+  "name": "Netherlands",
+  "created_at": "2010-09-16T23:46:07.000Z",
+  "updated_at": "2013-01-28T17:32:01.000Z",
+  "english_name": "Netherlands"
+}
+```
+
+* Delete
+```bash
+> curl -s -X DELETE http://localhost:3000/countries/87
+```
+
+* Update
+```bash
+> curl -s -X PUT -d "country[name]=Holanda" http://localhost:3000/countries/5
+{
+  "id": 5,
+  "name": "Holanda",
+  "created_at": "2010-09-16T23:46:07.000Z",
+  "updated_at": "2014-08-03T16:18:03.215Z",
+  "english_name": "Netherlands"
+}
+```
+
+* New
+```bash
+> curl -s -X GET http://localhost:3000/countries/new
+```
+
+* Edit
+```bash
+> curl -s -X GET http://localhost:3000/countries/3/edit
+{
+  "id": 3,
+  "name": "United States",
+  "created_at": "2010-09-16T23:45:48.000Z",
+  "updated_at": "2013-01-28T17:32:00.000Z",
+  "english_name": "United States"
+}
+```
+
+
+All these methods works at any level:
+
+```bash
+> curl -s -X GET http://localhost:3000/countries/1/movies?page=2&per_page=3
+{
+  "collection": [
+    {
+      "id": 202,
+      "title": "Good Night. And Good Luck",
+      "original_title": "Good Night. And Good Luck",
+      "year": 2005,
+      "duration": 90,
+    },
+    {
+      "id": 207,
+      "title": "L'amant",
+      "original_title": "L'amant",
+      "year": 1992,
+      "duration": 115,
+    },
+    {
+      "id": 239,
+      "title": "Tess",
+      "original_title": "Tess",
+      "year": 1979,
+      "duration": 170,
+    }
+  ],
+  "pagination": { "count": 64, "page": 2, "per_page": 3 }
+}
+
+> curl -s -X GET http://localhost:3000/countries/1/movies/202
+{
+  "id": 202,
+  "title": "Good Night. And Good Luck",
+  "original_title": "Good Night. And Good Luck",
+  "year": 2005,
+  "duration": 90
+}
+````
+
+Errors
+
+If there's any error creating or updating, it will be return with a 422 HTTP error
+
+```bash
+> curl -s -X POST -d "name=Japan" http://localhost:3000/countries
+{ "errors": [["name", ["has already been taken"]]] }
+
+> curl -s -X PUT -d "country[name]=Holanda" http://localhost:3000/countries/6
+{ "errors": [["name", ["has already been taken"]]] }
+```
+
+If we ask for a resource that doesn't exists, a 404 HTTP error will be return
+
+```bash
+> curl -s -X GET http://localhost:3000/countries/666
+{ "errors": { "field": "id", "message": "Couldn't find Country with id=666" } }
+```
+
+
+
+# TODO
+
+- Integration with a authentication mechanism, API only available to authenticated users
+- Implementation of a cache
+- Response json configuration
+
+
+![Code Climate](https://codeclimate.com/github/miquelbarba/instant-api.png)
+

data/instant_api.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'instant_api/version'
+
+Gem::Specification.new do |s|
+  s.name        = "instant-api"
+  s.summary     = "Automatically creates a REST API"
+  s.description = "Automatically creates a REST API for Rails projects"
+  s.authors     = ['Miquel Barba']
+  s.email       = 'miquel.barba@gmail.com'
+  s.homepage    = 'https://github.com/miquelbarba/instant-api'
+  s.files       = `git ls-files`.split("\n")
+  s.version     = InstantApi::VERSION
+  s.require_paths = ['lib']
+  s.license     = 'MIT'
+
+  s.add_runtime_dependency 'kaminari', '~> 0.15'
+  s.add_runtime_dependency 'rails-api', '~> 0.2'
+  s.add_runtime_dependency 'rails', '~> 4.0'
+end

data/lib/instant_api.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module InstantApi
+end
+
+require 'kaminari'
+require 'instant_api/util/array'
+require 'instant_api/controller/routes'
+
+# why?
+Kaminari::Hooks.init
+
+

data/lib/instant_api/controller/build_create.rb

@@ -0,0 +1,34 @@
+module InstantApi::Controller
+  class BuildCreate
+
+    attr_reader :model_class_name, :controller
+
+    def initialize(controller, model_class_name)
+      @controller, @model_class_name = controller, model_class_name
+    end
+
+    def build
+      controller.class_eval(&build_create)
+    end
+
+    private
+
+    def build_create
+      # TODO: extract this require
+      body = %Q{
+        require 'instant_api/model/builder'
+        require 'instant_api/controller/parameters'
+        def create
+          parameters = InstantApi::Controller::Parameters.new(params, request.path)
+          builder = InstantApi::Model::Builder.new(parameters, #{model_class_name}, true)
+          resource = builder.build
+          raise ActiveRecord::RecordInvalid.new(resource) if resource.invalid?
+
+          render json: resource
+        end
+      }
+
+      Proc.new { eval body }
+    end
+  end
+end