sinatra-rest-api 0.1.3 → 0.1.4

data/examples/misc/set_verb_options.rb

@@ -0,0 +1,12 @@
+require 'sinatra/base'
+
+class TestApp < Sinatra::Application
+  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
+
+  run! if app_file == $PROGRAM_NAME # = $0 ## starts the server if executed directly by ruby
+end

data/examples/mongoid/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'pry'
+
+gem 'sinatra'
+gem 'sinatra-contrib'
+gem 'thin'
+
+gem 'mongoid'
+
+gem 'sinatra-rest-api' #, path: '../../../sinatra-rest-api'

data/examples/mongoid/Gemfile.lock

@@ -0,0 +1,68 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.4)
+      activesupport (= 5.1.4)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    backports (3.8.0)
+    bson (4.2.2)
+    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)
+    mongo (2.4.3)
+      bson (>= 4.2.1, < 5.0.0)
+    mongoid (6.2.1)
+      activemodel (~> 5.1)
+      mongo (>= 2.4.1, < 3.0.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
+    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)
+    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
+  mongoid
+  pry
+  sinatra
+  sinatra-contrib
+  sinatra-rest-api
+  thin
+
+BUNDLED WITH
+   1.15.4

data/examples/mongoid/Rakefile

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

data/examples/mongoid/app.rb

@@ -0,0 +1,144 @@
+# require 'pry'
+
+require 'json'
+require 'yaml'
+
+require 'sinatra/base'
+
+require 'mongoid'
+
+require 'sinatra-rest-api'
+
+# MongoidTest App
+module MongoidTest
+  env = ENV['RACK_ENV'] || 'development'
+
+  Mongoid.load!( File.expand_path( '../database.yml', __FILE__ ), env.to_sym )
+
+  # An author
+  class Author
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    field :name, type: String
+    field :email, type: String
+
+    has_many :books
+    # has_many :books, inverse_of: :author
+
+    validates :name, presence: true
+    validates :email, presence: true, uniqueness: true
+  end
+
+  # A book
+  class Book
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    # Fields
+    field :title, type: String
+    field :description, type: String
+    field :pages, type: Integer
+    field :price, type: Float
+    field :dt, type: DateTime
+
+    # Relations
+    belongs_to :category, optional: true # optional disables required relations
+    belongs_to :author, optional: true
+    has_and_belongs_to_many :tags
+    has_many :chapters
+
+    accepts_nested_attributes_for :category
+    accepts_nested_attributes_for :author
+    accepts_nested_attributes_for :tags
+
+    # has_one :author, inverse_of: :books
+    # has_one :category, inverse_of: :book
+
+    # embeds_one :author
+    # embeds_one :category
+
+    validates :title, presence: true
+  end
+
+  # A category
+  class Category
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    field :name, type: String
+
+    has_many :books
+    # has_many :books, inverse_of: :category
+
+    # embedded_in :book
+  end
+
+  # A tag
+  class Tag
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    field :name, type: String
+
+    has_and_belongs_to_many :books
+  end
+
+  # A chapter
+  class Chapter
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    belongs_to :book
+
+    field :title, type: String
+
+    validates :title, presence: true
+  end
+
+  ##############################################################################
+
+  # App main class
+  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/mongoid/config.ru

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

data/examples/mongoid/database.yml

@@ -0,0 +1,13 @@
+development:
+  clients:
+    default:
+      database: sinatra-rest-api
+      hosts:
+        - localhost:27017
+
+test:
+  clients:
+    default:
+      database: sinatra-rest-api_test
+      hosts:
+        - localhost:27017

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

@@ -0,0 +1,79 @@
+# require 'mongoid'
+
+load 'mongoid/tasks/database.rake'
+
+# spec = Gem::Specification.find_by_name 'mongoid'
+# load "#{spec.gem_dir}/lib/mongoid/railties/database.rake"
+
+# Rake::Task.define_task( :environment )
+
+namespace :db do
+  unless Rake::Task.task_defined?('db:drop')
+    desc 'Drops all the collections for the database for the current Rails.env'
+    task drop: 'mongoid:drop'
+  end
+
+  unless Rake::Task.task_defined?('db:purge')
+    desc 'Drop all collections except the system collections'
+    task purge: 'mongoid:purge'
+  end
+
+  unless Rake::Task.task_defined?('db:seed')
+    # if another ORM has defined db:seed, don't run it twice.
+    desc 'Load the seed data from db/seeds.rb'
+    task seed: :environment do
+      seed_file = File.join(Rails.root, 'db', 'seeds.rb')
+      load(seed_file) if File.exist?(seed_file)
+    end
+  end
+
+  unless Rake::Task.task_defined?('db:setup')
+    desc 'Create the database, and initialize with the seed data'
+    task setup: [ 'db:create', 'mongoid:create_indexes', 'db:seed' ]
+  end
+
+  unless Rake::Task.task_defined?('db:reset')
+    desc 'Delete data and loads the seeds'
+    task reset: [ 'db:drop', 'db:seed' ]
+  end
+
+  unless Rake::Task.task_defined?('db:create')
+    task create: :environment do
+      # noop
+    end
+  end
+
+  unless Rake::Task.task_defined?('db:migrate')
+    task migrate: :environment do
+      # noop
+    end
+  end
+
+  unless Rake::Task.task_defined?('db:schema:load')
+    namespace :schema do
+      task :load do
+        # noop
+      end
+    end
+  end
+
+  unless Rake::Task.task_defined?('db:test:prepare')
+    namespace :test do
+      task prepare: 'mongoid:create_indexes'
+    end
+  end
+
+  unless Rake::Task.task_defined?('db:create_indexes')
+    task create_indexes: 'mongoid:create_indexes'
+  end
+
+  unless Rake::Task.task_defined?('db:remove_indexes')
+    task remove_indexes: 'mongoid:remove_indexes'
+  end
+
+  namespace :mongoid do
+    task :load_models do
+      ::Rails.application.eager_load! if defined?(::Rails)
+    end
+  end
+end

data/examples/ng-admin/index.html

@@ -0,0 +1,168 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <title>Test ng-admin</title>
+    <link rel="stylesheet" href="node_modules/ng-admin/build/ng-admin.min.css">
+  </head>
+  <body ng-app="myApp" ng-strict-di>
+    <!-- <script src="node_modules/angular/angular.js"></script>
+    <script src="ng-admin/src/javascripts/ng-admin.js"></script> -->
+    <script src="node_modules/ng-admin/build/ng-admin.min.js"></script>
+    <!-- <script src="node_modules/ng-admin/lib/javascripts/ng-admin.js"></script> -->
+    <div ui-view="ng-admin"></div>
+    <script type="text/javascript">
+      var LIMIT = 10;
+
+      var entities = {
+        'writers': 'writer',
+        'books': 'book',
+        'categories': 'category',
+        'chapters': 'chapter',
+        'tags': 'tag'
+      };
+      var myApp = angular.module( 'myApp', [ 'ng-admin' ] );
+      myApp.config( [ 'NgAdminConfigurationProvider', function( NgAdminConfigurationProvider ) {
+        var nga = NgAdminConfigurationProvider;
+        // create an admin application
+        var admin = nga.application( 'My First Admin' ).baseApiUrl( 'http://127.0.0.1:3000/' );
+
+        var authors = nga.entity('writers');
+        var books = nga.entity('books');
+        var categories = nga.entity('categories' ).readOnly();
+        var chapters = nga.entity('chapters');
+        var tags = nga.entity('tags');
+
+        // Authors
+        authors.listView().fields([
+          nga.field( 'id' ),
+          nga.field( 'name' ).isDetailLink( true ),
+          nga.field( 'email' )
+        ]).listActions( [ 'show', 'delete' ] ).perPage( LIMIT );
+        authors.showView().fields([
+          nga.field( 'name' ),
+          nga.field( 'email' ),
+          nga.field( 'books', 'embedded_list' ).targetEntity( books ).targetFields( [ nga.field( 'title' ) ] )
+        ]);
+        authors.creationView().fields([
+          nga.field( 'name' ),
+          nga.field( 'email' )
+        ]);
+        authors.editionView().fields( authors.creationView().fields() );
+
+        // Books
+        books.listView().fields([
+          nga.field( 'id' ),
+          nga.field( 'title' ).isDetailLink(true),
+          // nga.field( 'description', 'text' ),
+          nga.field( 'pages', 'number' ),
+          nga.field( 'price', 'number' ).format( '$0,0.00' ),
+          // nga.field( 'dt', 'date' ),
+          nga.field( 'author_id', 'reference' ).targetEntity( authors ).targetField( nga.field( 'name' ) ),
+          nga.field( 'category_id', 'reference' ).targetEntity( categories ).targetField( nga.field( 'name' ) )
+        ]).listActions( [ 'show', 'delete' ] ).perPage( LIMIT );
+        books.showView().fields([
+          // nga.field( 'id' ),
+          nga.field( 'title' ).isDetailLink( true ),
+          nga.field( 'description', 'text' ),
+          nga.field( 'pages', 'number' ),
+          nga.field( 'price', 'number' ).format( '$0,0.00' ),
+          // nga.field( 'dt', 'date' ),
+          nga.field( 'author_id', 'reference' ).targetEntity( authors ).targetField( nga.field( 'name' ) ),
+          nga.field( 'category_id', 'reference' ).targetEntity( categories ).targetField( nga.field( 'name' ) ),
+          nga.field( 'chapters', 'embedded_list' ).targetEntity( chapters ).targetFields( [ nga.field( 'title' ) ] ),
+          nga.field( 'tags', 'embedded_list' ).targetEntity( tags ).targetFields( [ nga.field( 'name' ) ] )
+        ]);
+        books.creationView().fields([
+          // nga.field( 'id' ),
+          nga.field( 'title' ).isDetailLink( true ),
+          nga.field( 'description', 'text' ),
+          nga.field( 'pages', 'number' ),
+          nga.field( 'price', 'number' ).format( '$0,0.00' ),
+          // nga.field( 'dt', 'date' ),
+          nga.field( 'author_id', 'reference' ).targetEntity( authors ).targetField( nga.field( 'name' ) ),
+          nga.field( 'category_id', 'reference' ).targetEntity( categories ).targetField( nga.field( 'name' ) ),
+          // nga.field( 'chapters', 'referenced_list' ).targetEntity( chapters ).targetReferenceField( 'book_id' ).targetFields( [ nga.field( 'id' ), nga.field( 'title' ) ] ) // NO
+
+          // nga.field( 'chapters', 'embedded_list' ).targetEntity( chapters ).targetFields( [ nga.field( 'title' ) ] ) // NO
+
+          // nga.field( 'chapters', 'reference_many' ).targetEntity( chapters ).targetField( nga.field( 'title' ) )
+          // .singleApiCall( function( ids ) { return {'id': ids }; })
+          // nga.field( 'chapters', 'reference_many' ).targetEntity( chapters ).targetField( nga.field( 'title' ) )
+          // nga.field( 'chapters', 'reference_many' ).targetEntity( chapters ).targetField( nga.field( 'title' ) ).singleApiCall( function( tagIds ) {
+          //   return { '_where': "['id IN ?',['1','2']]" };
+          // })
+          // _where=["id IN ?",["1","2"]]
+        ]);
+        books.editionView().fields( books.creationView().fields() );
+
+        // Categories
+        categories.listView().fields([
+          nga.field( 'id' ),
+          nga.field( 'name' ).isDetailLink( true )
+        ]).listActions( [ 'show' ] ).perPage( LIMIT );
+        categories.showView().fields([
+          nga.field( 'name' ),
+          nga.field( 'books', 'embedded_list' ).targetEntity( books ).targetFields( [ nga.field( 'title' ) ] )
+        ]);
+
+        // Chapters
+        chapters.listView().fields([
+          nga.field( 'id' ),
+          nga.field( 'title' ).isDetailLink( true )
+        ]).listActions( [ 'show', 'delete' ] ).perPage( LIMIT );
+        chapters.showView().fields([
+          nga.field( 'id' ),
+          nga.field( 'title' ),
+          nga.field( 'book_id', 'reference' ).targetEntity( books ).targetField( nga.field( 'title' ) )
+        ]);
+        chapters.creationView().fields([
+          nga.field( 'title' )
+        ]);
+        chapters.editionView().fields( chapters.creationView().fields() );
+
+        // Tags
+        tags.listView().fields([
+          nga.field( 'id' ),
+          nga.field( 'name' ).isDetailLink( true )
+        ]).listActions( [ 'show', 'delete' ] ).perPage( LIMIT );
+        tags.showView().fields([
+          nga.field( 'id' ),
+          nga.field( 'name' ),
+          nga.field( 'books', 'embedded_list' ).targetEntity( books ).targetFields( [ nga.field( 'title' ) ] )
+        ]);
+        tags.creationView().fields([
+          nga.field( 'name' )
+        ]);
+        tags.editionView().fields( tags.creationView().fields() );
+
+        admin.addEntity( authors );
+        admin.addEntity( books );
+        admin.addEntity( categories );
+        admin.addEntity( chapters );
+        admin.addEntity( tags );
+
+        nga.configure( admin );
+      }]);
+
+      myApp.config( [ 'RestangularProvider', function( RestangularProvider ) {
+        RestangularProvider.addFullRequestInterceptor( function( element, operation, what, url, headers, params, httpConfig ) {
+          if( operation == 'getList' ) {
+            if( params._page && params._perPage ) {
+              params.limit = params._perPage;
+              params.offset = ( params._page - 1 )* params.limit;
+              delete params._page;
+              delete params._perPage;
+            }
+          }
+          else if( operation == 'post' || operation == 'put' ) {
+            ret = {}
+            ret[entities[what]] = element;
+            return { element: ret }
+          }
+          // return { element: element };
+          return { params: params };
+        });
+      }]);
+    </script>
+  </body>
+</html>