sinatra-rest-api 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f221bc7f806a2770f5903144a0e72fbb9f91be3b
-  data.tar.gz: e68a253284bf6490d89f9327d345469c25f9beb9
+  metadata.gz: 797c81c8b82f82d443d4d866f00fe0ca445058e0
+  data.tar.gz: 24c413e0fb58eb2947346ecb48efcdc711f7feb0
 SHA512:
-  metadata.gz: a74fd00c70ce021325e9997836b7f70a8f9d276bdef3e31da2fa0811b6ffe01ef207070f838c715c4a750ebaab7eec4abf6c455b1fef0950515c361bb0e7a029
-  data.tar.gz: c3dc877e255474a1ee504a2d29dfe476c8d0cfcf9aeb60b013a76c0bc408cef2a948fac7a099760bcafcb6fd0a940de6666a81707a77285baeb58767a9d4250f
+  metadata.gz: adff2d50c73dd49a2921488607fce33d1b71eab4a881d83ea570ad9626274735550df52c0776ee4641306ecba5873cac6c6f28443fb65ba71cf7b3d3d3dc240a
+  data.tar.gz: 7fb8cb86191aca81939733097e64b31a469b866e9144f6ad65a350e82ee73f8942e0bca81b853ab3fc5a756f63deceb628e00f679a976a5528d961dd632303b6

data/.gitignore

@@ -0,0 +1,4 @@
+_misc/
+node_modules/
+examples/ng-admin/ng-admin/
+*.sqlite3

data/.rubocop.yml

@@ -0,0 +1,34 @@
+AllCops:
+  TargetRubyVersion: 2.1
+
+# generic rules
+Metrics/LineLength:
+  Enabled: false
+Style/FileName:
+  Enabled: false
+Style/SpaceInsideBrackets:
+  Enabled: false
+Style/SpaceInsideParens:
+  Enabled: false
+Style/SpaceAroundBlockParameters:
+  Enabled: false
+
+# specific project rules
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Max: 10
+Metrics/MethodLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Style/IfInsideElse:
+  Enabled: false
+Style/RescueModifier:
+  Enabled: false
+Style/ClassVars:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rack-test'
+  gem 'rspec'
+  gem 'faker'
+
+  gem 'pry'
+  gem 'rake'
+
+  gem 'sinatra'
+
+  gem 'activerecord'
+  gem 'sinatra-activerecord'
+  gem 'sequel'
+  gem 'mongoid'
+  gem 'sqlite3'
+end

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    sinatra-rest-api (0.1.0)
+      sinatra (= 1.4.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.0.0.1)
+      activesupport (= 5.0.0.1)
+    activerecord (5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      arel (~> 7.0)
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (7.1.4)
+    bson (4.1.1)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.2)
+    diff-lcs (1.2.5)
+    faker (1.6.6)
+      i18n (~> 0.5)
+    i18n (0.7.0)
+    method_source (0.8.2)
+    minitest (5.9.1)
+    mongo (2.3.0)
+      bson (~> 4.1)
+    mongoid (6.0.2)
+      activemodel (~> 5.0)
+      mongo (~> 2.3)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rack-protection (1.5.3)
+      rack
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rake (11.3.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    sequel (4.40.0)
+    sinatra (1.4.7)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    sinatra-activerecord (2.0.11)
+      activerecord (>= 3.2)
+      sinatra (~> 1.0)
+    slop (3.6.0)
+    sqlite3 (1.3.12)
+    thread_safe (0.3.5)
+    tilt (2.0.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  faker
+  mongoid
+  pry
+  rack-test
+  rake
+  rspec
+  sequel
+  sinatra
+  sinatra-activerecord
+  sinatra-rest-api!
+  sqlite3
+
+BUNDLED WITH
+   1.13.5

data/LICENSE

@@ -0,0 +1,5 @@
+Copyright (c) 2016, Mattia Roccoberton
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,135 @@
+# Sinatra REST API [![Gem Version](https://badge.fury.io/rb/sinatra-rest-api.svg)](https://badge.fury.io/rb/sinatra-rest-api)
+
+A Sinatra component that generates CRUD routes for database ORM models.
+
+Features:
+- supports Active Record, Mongoid and Sequel ORMs
+- default actions already setup
+- nested resources available
+
+Install: `gem install sinatra-rest-api` (or in Gemfile)
+
+## Options
+
+For *resource* DSL keyword:
+- **actions**: list of actions to enable (array of symbols)
+- **include**: list of associations to expose in list/read actions (array of symbols) or false to skip every association
+- **limit**: set a fixed limit server side
+- **plural**: plural model name used for routes (string)
+- **singular**: singular model name for resource key (string)
+
+Routes parameters:
+- **limit**: limit results (ex. 20)
+- **offset**: results offset (ex. 40)
+
+## Examples
+
+```rb
+class Book < ActiveRecord::Base
+end
+
+class App < Sinatra::Application
+  register Sinatra::RestApi
+
+  resource Book
+  resource Category do
+    actions [ :list, :read ]
+  end
+end
+```
+
+Generates:
+
+```
+GET:    /books/:id.?:format?
+PUT:    /books/:id.?:format?
+DELETE: /books/:id.?:format?
+PUT:    /books/?.?:format?
+POST:   /books/?.?:format?
+DELETE: /books/?.?:format?
+GET:    /books/?.?:format?
+GET:    /categories/:id.?:format?
+GET:    /categories/?.?:format?
+```
+
+#### More examples
+
+See [examples](examples/). Execute: `thin start` in the folder of an example.
+
+#### Using inside a Rails app
+
+Let's create an Importer class to import data between 2 Rails app.
+
+A simple way to add an API for every model on the source app:
+
+- create a sinatra app in: `lib/sinatra_app/app.rb`:
+
+```rb
+Rails.application.eager_load!  # if cache_classes is off
+
+class MySinatraApp < Sinatra::Base
+  register Sinatra::RestApi
+
+  ActiveRecord::Base.descendants.each do |model|  # Iterate all models
+    next if model.abstract_class
+    resource model, actions: [ :list, :read ], include: false
+  end
+end
+```
+
+- load the sinatra app editing `config/application.rb`:
+
+```rb
+module RailsSinatra
+  class Application < Rails::Application
+    config.after_initialize do
+      require_relative '../lib/sinatra_app/app'
+    end
+  end
+end
+```
+
+- setup the routes editing `config/routes.rb`:
+
+```rb
+Rails.application.routes.draw do
+  mount MySinatraApp.new => '/sinatra'
+end
+```
+
+- now you can access to every model under 'sinatra' path, example: '/sinatra/posts.json'
+
+- on the destination app you can access these models using *ActiveResource* gem:
+
+```rb
+class Importer < ActiveResource::Base
+  self.site = 'http://127.0.0.1:3000/sinatra'  # first app path
+
+  def self.init( collection_name )
+    set_collection_name collection_name
+    self
+  end
+end
+
+# List of tags names:
+Importer.init( 'tags' ).all.map( &:name )
+```
+
+## Tests
+
+Run individual example apps tests:
+- `rspec spec/app_active_record_spec.rb`
+- `rspec spec/app_mongoid_spec.rb`
+- `rspec spec/app_sequel_spec.rb`
+
+## Do you like it? Star it!
+
+If you use this component just star it. A developer is more motivated to improve a project when there is some interest.
+
+## Contributors
+
+- [Mattia Roccoberton](http://blocknot.es) - creator, maintainer
+
+## License
+
+[ISC](LICENSE)

data/examples/active_record/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gem 'pry'
+
+gem 'sinatra'
+gem 'sinatra-contrib'
+
+gem 'rake'
+gem 'thin'
+
+gem 'activerecord'
+gem 'sinatra-activerecord'
+gem 'sqlite3'
+
+gem 'sinatra-rest-api' # , path: '../../../sinatra-rest-api'

data/examples/active_record/Gemfile.lock

@@ -0,0 +1,75 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.4)
+      activesupport (= 5.1.4)
+    activerecord (5.1.4)
+      activemodel (= 5.1.4)
+      activesupport (= 5.1.4)
+      arel (~> 8.0)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    backports (3.8.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    daemons (1.2.4)
+    eventmachine (1.2.5)
+    i18n (0.8.6)
+    method_source (0.9.0)
+    minitest (5.10.3)
+    multi_json (1.12.2)
+    mustermann (1.0.1)
+    pry (0.11.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.3)
+    rack-protection (2.0.0)
+      rack
+    rake (12.1.0)
+    sinatra (2.0.0)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.0)
+      tilt (~> 2.0)
+    sinatra-activerecord (2.0.13)
+      activerecord (>= 3.2)
+      sinatra (>= 1.0)
+    sinatra-contrib (2.0.0)
+      backports (>= 2.0)
+      multi_json
+      mustermann (~> 1.0)
+      rack-protection (= 2.0.0)
+      sinatra (= 2.0.0)
+      tilt (>= 1.3, < 3)
+    sinatra-rest-api (0.1.2)
+      sinatra (~> 2.0, > 1.4.0)
+    sqlite3 (1.3.13)
+    thin (1.7.2)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
+    thread_safe (0.3.6)
+    tilt (2.0.8)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  pry
+  rake
+  sinatra
+  sinatra-activerecord
+  sinatra-contrib
+  sinatra-rest-api
+  sqlite3
+  thin
+
+BUNDLED WITH
+   1.15.4

data/examples/active_record/Rakefile

@@ -0,0 +1,8 @@
+# Rakefile
+require 'sinatra/activerecord/rake'
+
+namespace :db do
+  task :load_config do
+    require File.expand_path( '../app', __FILE__ )
+  end
+end

data/examples/active_record/app.rb

@@ -0,0 +1,117 @@
+# require 'pry'
+
+require 'json'
+require 'yaml'
+
+require 'sinatra/activerecord'
+require 'sinatra/base'
+
+require 'active_record'
+require 'sqlite3'
+
+require 'sinatra-rest-api'
+
+# ActiveRecordTest App
+module ActiveRecordTest
+  env = ENV['RACK_ENV'] || 'development'
+  conf = YAML.load( File.read( File.expand_path( '../database.yml', __FILE__ ) ) )
+  conf[env]['database'] = File.expand_path( '../' + conf[env]['database'], __FILE__ )
+
+  ActiveRecord::Base.establish_connection( conf[env] )
+
+  # An author
+  class Author < ActiveRecord::Base
+    has_many :books, dependent: :destroy
+
+    validates :name, presence: true
+    validates :email, presence: true, uniqueness: true
+  end
+
+  # A book
+  class Book < ActiveRecord::Base
+    belongs_to :author
+    belongs_to :category
+    has_and_belongs_to_many :tags
+    has_many :chapters
+
+    accepts_nested_attributes_for :author
+    accepts_nested_attributes_for :category
+    accepts_nested_attributes_for :tags
+
+    # default_scope { where( 'id > 2' ) }
+    # default_scope { where( published: true ) }
+
+    validates :title, presence: true
+  end
+
+  # A category
+  class Category < ActiveRecord::Base
+    has_many :books
+  end
+
+  # A tag
+  class Tag < ActiveRecord::Base
+    has_and_belongs_to_many :books
+  end
+
+  # A chapter
+  class Chapter < ActiveRecord::Base
+    belongs_to :book
+
+    validates :title, presence: true
+  end
+
+  ##############################################################################
+
+  # App main class
+  class App < Sinatra::Application
+    register Sinatra::RestApi
+    register Sinatra::ActiveRecordExtension
+
+    # model Author, actions: { list: { verb: :post }, read: { verb: :post } }
+    # model Author, actions: { list: true, read: true }
+
+    # set :restapi_request_type, :json
+
+    resource Author, singular: 'writer' # , plural: 'writers'
+    resource Book
+    resource Category do
+      actions [ :list, :read ]
+    end
+    resource Chapter
+    resource Tag # , actions: [ :list, :read ]
+
+    configure do
+      env = ENV['RACK_ENV'] || 'development'
+      conf = YAML.load( File.read( File.expand_path( '../database.yml', __FILE__ ) ) )
+      conf[env]['database'] = File.expand_path( '../' + conf[env]['database'], __FILE__ )
+      set :database, conf[env]
+    end
+
+    before do
+      content_type :json
+      headers( 'Access-Control-Allow-Origin' => '*',
+               'Access-Control-Allow-Methods' => Sinatra::RestApi::Router::VERBS.join(',').upcase,
+               'Access-Control-Allow-Headers' => 'Origin, Content-Type, Accept, Authorization, Token',
+               'Access-Control-Expose-Headers' => 'X-Total-Count' )
+    end
+
+    options '*' do
+      response.headers['Access-Control-Allow-Origin'] = '*'
+      response.headers['Access-Control-Allow-Methods'] = 'HEAD,GET,PUT,DELETE,OPTIONS'
+      response.headers['Access-Control-Allow-Headers'] = 'X-Requested-With, X-HTTP-Method-Override, Content-Type, Cache-Control, Accept'
+      halt 200
+    end
+
+    get '/' do
+      Sinatra::RestApi::Router.list_routes.to_json
+    end
+
+    not_found do
+      return if JSON.parse( body[0] ).include?( 'error' ) rescue nil # Error already defined
+      [ 404, { message: 'This is not the page you are looking for...' }.to_json ]
+    end
+
+    run! if app_file == $PROGRAM_NAME # = $0 ## starts the server if executed directly by ruby
+  end
+end