sinatra-rest-api 0.1.3 → 0.1.4

data/examples/ng-admin/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "test-ng-admin",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.html",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Mat",
+  "license": "MIT",
+  "dependencies": {
+    "ng-admin": "^1.0.0-beta3"
+  }
+}

data/examples/sequel/Gemfile

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

data/examples/sequel/Gemfile.lock

@@ -0,0 +1,54 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    backports (3.8.0)
+    coderay (1.1.2)
+    daemons (1.2.4)
+    eventmachine (1.2.5)
+    method_source (0.9.0)
+    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)
+    sequel (5.0.0)
+    sinatra (2.0.0)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.0)
+      tilt (~> 2.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)
+    tilt (2.0.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rake
+  sequel
+  sinatra
+  sinatra-contrib
+  sinatra-rest-api
+  sqlite3
+  thin
+
+BUNDLED WITH
+   1.15.4

data/examples/sequel/Rakefile

@@ -0,0 +1,3 @@
+# $VERBOSE = true
+
+Dir.glob( 'lib/tasks/*.rake' ).each { |r| load r }

data/examples/sequel/app.rb

@@ -0,0 +1,138 @@
+require 'pry'
+
+require 'json'
+require 'yaml'
+
+require 'sinatra/base'
+
+require 'sequel'
+require 'sqlite3'
+
+require 'sinatra-rest-api'
+
+# SequelTest App
+module SequelTest
+  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__ )
+  DB = Sequel.connect( CONF[env] )
+
+  unless ENV['SEQUEL_RECREATE_DB'].nil?
+    require 'rake'
+    FileUtils.rm CONF[env]['database'], force: true
+    FileUtils.touch CONF[env]['database']
+    load File.join( File.expand_path( '../lib', __FILE__ ), 'tasks', 'db.rake' )
+    Rake::Task['db:migrate'].invoke
+  end
+
+  Sequel::Model.plugin :association_pks
+  Sequel::Model.plugin :json_serializer
+  Sequel::Model.plugin :nested_attributes
+  Sequel::Model.plugin :timestamps
+  Sequel::Model.plugin :validation_helpers
+
+  # An author
+  class Author < Sequel::Model
+    plugin :timestamps, update_on_create: true
+
+    one_to_many :books
+
+    def validate
+      super
+      validates_presence [ :name, :email ]
+      validates_unique :email
+    end
+  end
+
+  # A book
+  class Book < Sequel::Model
+    plugin :timestamps, update_on_create: true
+
+    many_to_one :author
+    many_to_one :category
+    many_to_many :tags
+    one_to_many :chapters
+
+    nested_attributes :author
+    nested_attributes :category # , unmatched_pk: :create
+    nested_attributes :tags # , unmatched_pk: :create
+    nested_attributes :chapters
+
+    def validate
+      super
+      validates_presence :title
+    end
+  end
+
+  # A category
+  class Category < Sequel::Model
+    plugin :timestamps, update_on_create: true
+
+    one_to_many :books
+  end
+
+  # A tag
+  class Tag < Sequel::Model
+    plugin :timestamps, update_on_create: true
+
+    many_to_many :books
+  end
+
+  # A chapter
+  class Chapter < Sequel::Model
+    plugin :timestamps, update_on_create: true
+
+    many_to_one :book
+
+    def validate
+      super
+      validates_presence :title
+    end
+  end
+
+  ##############################################################################
+
+  # App entry point
+  class App < Sinatra::Application
+    register Sinatra::RestApi
+
+    # 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 ]
+
+    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

data/examples/sequel/config.ru

@@ -0,0 +1,9 @@
+# config.ru (run with rackup)
+
+# Launch with:
+# rackup -o 0.0.0.0 -p 4567
+
+require './app'
+
+# run App
+run SequelTest::App

data/examples/sequel/database.yml

@@ -0,0 +1,7 @@
+development:
+  adapter: sqlite
+  database: 'db/db.sqlite3'
+
+test:
+  adapter: sqlite
+  database: 'db/test.sqlite3'

data/examples/sequel/db/migrate/001_create_authors.rb

@@ -0,0 +1,15 @@
+Sequel.migration do
+  up do
+    create_table( :authors ) do
+      primary_key :id
+      String :name, null: false
+      String :email, null: false
+      Timestamp :created_at
+      Timestamp :updated_at
+    end
+  end
+
+  down do
+    drop_table( :authors )
+  end
+end

data/examples/sequel/db/migrate/002_create_categories.rb

@@ -0,0 +1,14 @@
+Sequel.migration do
+  up do
+    create_table( :categories ) do
+      primary_key :id
+      String :name, null: false
+      Timestamp :created_at
+      Timestamp :updated_at
+    end
+  end
+
+  down do
+    drop_table( :categories )
+  end
+end

data/examples/sequel/db/migrate/003_create_books.rb

@@ -0,0 +1,20 @@
+Sequel.migration do
+  up do
+    create_table( :books ) do
+      primary_key :id
+      String :title, null: false
+      String :description, text: true
+      Integer :pages
+      Float :price
+      DateTime :dt
+      Integer :author_id
+      Integer :category_id
+      Timestamp :created_at
+      Timestamp :updated_at
+    end
+  end
+
+  down do
+    drop_table( :books )
+  end
+end

data/examples/sequel/db/migrate/004_create_tags.rb

@@ -0,0 +1,14 @@
+Sequel.migration do
+  up do
+    create_table( :tags ) do
+      primary_key :id
+      String :name, null: false
+      Timestamp :created_at
+      Timestamp :updated_at
+    end
+  end
+
+  down do
+    drop_table( :tags )
+  end
+end

data/examples/sequel/db/migrate/005_create_books_tags.rb

@@ -0,0 +1,15 @@
+Sequel.migration do
+  up do
+    create_table( :books_tags ) do
+      primary_key :id
+      Integer :book_id, null: false
+      Integer :tag_id, null: false
+      Timestamp :created_at
+      Timestamp :updated_at
+    end
+  end
+
+  down do
+    drop_table( :books_tags )
+  end
+end

data/examples/sequel/db/migrate/006_create_chapters.rb

@@ -0,0 +1,16 @@
+Sequel.migration do
+  up do
+    create_table( :chapters ) do
+      primary_key :id
+      String :title, null: false
+      Integer :page
+      Integer :book_id, null: false
+      Timestamp :created_at
+      Timestamp :updated_at
+    end
+  end
+
+  down do
+    drop_table( :chapters )
+  end
+end

data/examples/sequel/lib/tasks/db.rake

@@ -0,0 +1,44 @@
+# require File.expand_path( '../../../app.rb', __FILE__ )
+require 'fileutils'
+require 'sequel'
+require 'yaml'
+
+Sequel.extension :migration
+
+PATH_MIGRATIONS = File.expand_path( '../../../db/migrate', __FILE__ ).freeze unless defined? PATH_MIGRATIONS
+
+def get_db( connect = true )
+  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__ )
+  connect ? Sequel.connect( conf[env] ) : conf
+end
+
+namespace :db do
+  desc 'Create database'
+  task :create do |_t, _args|
+    puts 'Create DB' # unless ENV['RACK_ENV'] == 'test'
+    env = ENV['RACK_ENV'] || 'development'
+    conf = get_db( false )
+    FileUtils.touch conf[env]['database']
+  end
+
+  # Ex. rake db:migrate[5]
+  desc 'Run migrations'
+  task :migrate, [ :version ] do |_t, args|
+    # db = Sequel.connect(ENV.fetch('DATABASE_URL'))
+    if args[:version]
+      puts "Migrating to version #{args[:version]}" # unless ENV['RACK_ENV'] == 'test'
+      Sequel::Migrator.run( get_db, PATH_MIGRATIONS, target: args[:version].to_i)
+    else
+      puts 'Migrating to latest' # unless ENV['RACK_ENV'] == 'test'
+      Sequel::Migrator.run( get_db, PATH_MIGRATIONS )
+    end
+  end
+
+  desc 'Reset database'
+  task :reset do |_t, _args|
+    puts 'Reset DB' # unless ENV['RACK_ENV'] == 'test'
+    Sequel::Migrator.run( get_db, PATH_MIGRATIONS, target: 0 )
+  end
+end

data/lib/sinatra-rest-api/actions.rb

@@ -46,10 +46,11 @@ module Sinatra
       end
 
       def self.list( route_args, params, mapping )
-        # TODO: option to enable X-Total-Count ?
+        # TODO: option to enable/disable X-Total-Count ?
         params[:_where] = params[:_where].nil? ? {} : JSON.parse( params[:_where] )
         route_args[:response].headers['X-Total-Count'] = mapping[:count].call( params ).to_s
         result = mapping[:list].call( params, route_args[:fields] )
+        result = result.limit( route_args[:options][:limit].to_i ) if route_args[:options].include?( :limit )
         [ 200, result.to_json( include: route_args[:options].include?( :include ) ? route_args[:options][:include] : mapping[:relations].call( nil ) ) ]
       end
 

data/sinatra-rest-api.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path( '../lib', __FILE__ )
+$LOAD_PATH.unshift( lib ) unless $LOAD_PATH.include?( lib )
+
+Gem::Specification.new do |spec|
+  spec.name        = 'sinatra-rest-api'
+  spec.version     = '0.1.4'
+  spec.authors     = [ 'Mattia Roccoberton' ]
+  spec.email       = 'mat@blocknot.es'
+  spec.homepage    = 'https://github.com/blocknotes/sinatra-rest-api'
+  spec.summary     = 'Sinatra REST API generator'
+  spec.description = 'Sinatra REST API generator: CRUD actions, nested resources, supports ActiveRecord, Sequel and Mongoid'
+  spec.platform    = Gem::Platform::RUBY
+  spec.license     = 'ISC'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_runtime_dependency 'sinatra', '> 1.4'
+end

data/spec/action_create_spec.rb

@@ -0,0 +1,164 @@
+$VERBOSE = false
+
+# require 'pry'
+
+# Tests actions
+module ActionTests
+  RSpec.shared_examples 'Action: create' do |models|
+    ##############################################################################
+
+    context 'Creating authors...' do
+      # path = '/authors'
+      path = '/writers' # renamed resource
+      random_authors = []
+      (1..( rand( 15 ) + 5 )).each do |_i|
+        random_authors.push( name: Faker::Book.author, email: Faker::Internet.email )
+      end
+      random_authors.uniq! { |a| a[:email] }
+
+      # action: create
+      it "should create #{random_authors.length} authors" do
+        random_authors.each do |author|
+          post path, writer: author
+          expect( last_response.status ).to eq( 201 ) # response = created ?
+          expect( JSON.parse( last_response.body ).include?( 'id' ) ).to be true # id is returned ?
+          expect( models[:author].where( author ).count ).to eq( 1 ) # record exists ?
+        end
+        expect( models[:author].count ).to eq( random_authors.length ) # check number of authors created
+      end
+
+      it 'should not create authors with invalid data' do
+        authors = [
+          {},
+          { name: '', email: ' ' },
+          { email: 'aaa@bbb.ccc' },
+          { name: '', email: 'aaa@bbb.ccc' },
+          { name: '   ', email: 'aaa@bbb.ccc' },
+          { name: 'Dick' },
+          { name: 'Dick', email: '' },
+          { name: 'Dick', email: '  ' }
+        ]
+        authors.each do |author|
+          post path, writer: author
+          expect( last_response.status ).to eq( 400 )
+        end
+      end
+
+      # action: create
+      it 'no authors with same email' do
+        post path, writer: { name: 'Jane Doe', email: random_authors.sample[:email] }
+        expect( last_response.status ).to eq( 400 )
+      end
+    end
+
+    ##############################################################################
+
+    context 'Creating tags...' do
+      random_tags = []
+      (1..( rand( 6 ) + 3 ) ).each { |_i| random_tags.push( name: Faker::Hipster.word ) }
+      random_tags.uniq! { |t| t[:name] }
+
+      # action: create
+      it "should create #{random_tags.length} tags" do
+        random_tags.each do |tag|
+          post '/tags', tag: tag
+          expect( last_response.status ).to eq( 201 )
+          expect( JSON.parse( last_response.body ).include?( 'id' ) ).to be true
+          expect( models[:tag].where( tag ).count ).to eq( 1 )
+        end
+        expect( models[:tag].count ).to eq( random_tags.length )
+      end
+    end
+
+    ##############################################################################
+
+    context 'Creating books...' do
+      random_books = []
+      (1..( rand( 4 ) + 2 )).each do |_i|
+        random_books.push( title: Faker::Book.title )
+      end
+      random_books.uniq! { |b| b[:title] }
+      (1..( rand( 4 ) + 2 )).each do |_i|
+        random_books.push( title: Faker::Hipster.sentence, pages: rand( 1000 ), price: rand * 20 )
+      end
+      new_cats = rand( 4 ) + 2
+      (1..new_cats).each do |_i|
+        random_books.push( title: Faker::Superhero.name, description: Faker::StarWars.quote, pages: rand( 1000 ), price: rand * 20, category_attributes: { name: Faker::Book.genre } )
+      end
+      new_tags = 2
+      (1..new_tags).each do |_i|
+        random_books.push( title: Faker::Superhero.name, description: Faker::StarWars.quote, pages: rand( 1000 ), price: rand * 20, tags_attributes: [ { name: Faker::Hipster.word } ] )
+      end
+
+      # action: create
+      it "should create #{random_books.length} books, #{new_cats} categories and #{new_tags} tags" do
+        tags_ids = models[:tag].all.map( &:id )
+        (1..( rand( 4 ) + 2 )).each do |_i|
+          random_books.push( title: Faker::University.name, pages: rand( 1000 ), price: rand * 20, tag_ids: tags_ids.sample( rand( 3 ) ) )
+        end
+        random_books.each do |book|
+          book[:author_id] = models[:author].all.sample.id if rand > 0.5
+          post '/books', book: book
+          expect( last_response.status ).to eq( 201 ) # check if the status is equal to created
+          expect( JSON.parse( last_response.body ).include?( 'id' ) ).to be true # check if the id is returned
+          category_attributes = book.delete :category_attributes
+          tags_attributes = book.delete :tags_attributes
+          tag_ids = book.delete :tag_ids
+          expect( models[:book].where( book ).count ).to eq( 1 ) # check if book is created
+          # check the relations
+          row = models[:book].where( book ).first
+          expect( row.tags.map( &:id ).sort ).to eq( tag_ids.sort ) unless tag_ids.nil?
+          expect( row.tags.map( &:name ) ).to eq( tags_attributes.map { |a| a[:name] } ) unless tags_attributes.nil?
+          expect( row.category.name ).to eq( category_attributes[:name] ) unless category_attributes.nil?
+        end
+        expect( models[:book].count ).to eq( random_books.length )
+        expect( models[:category].count ).to eq( new_cats )
+        expect( models[:tag].count ).to eq( tags_ids.length + new_tags )
+      end
+    end
+
+    ##############################################################################
+
+    context 'Creating chapters...' do
+      random_chapters = []
+      (1..( rand( 10 ) + 2 )).each do |_i|
+        random_chapters.push( title: Faker::Superhero.name )
+      end
+      random_chapters.uniq! { |c| c[:title] }
+
+      # action: create
+      it "should create #{random_chapters.length} chapters" do
+        ids = models[:book].all.map( &:id )
+        random_chapters.each do |chapter|
+          chapter[:book_id] = ids.sample
+          post '/chapters', chapter: chapter
+          expect( last_response.status ).to eq( 201 )
+          expect( JSON.parse( last_response.body ).include?( 'id' ) ).to be true
+          expect( models[:chapter].where( chapter ).count ).to eq( 1 )
+        end
+        expect( models[:chapter].count ).to eq( random_chapters.length )
+      end
+
+      it 'should not create a chapter without data' do
+        chapters = [
+          {},
+          { book_id: models[:book].last.id.to_s }
+        ]
+        chapters.each do |chapter|
+          post '/chapters', chapter: chapter
+          expect( last_response.status ).to eq( 400 )
+        end
+      end
+    end
+
+    ##############################################################################
+
+    context 'Creating categories...' do
+      # action: create
+      it 'should not create categories' do
+        post '/categories', category: { name: 'A cat' }
+        expect( last_response.status ).to eq( 404 )
+      end
+    end
+  end
+end