sinatra-rest-api 0.1.3 → 0.1.4

data/spec/action_delete_spec.rb

@@ -0,0 +1,32 @@
+$VERBOSE = false
+
+# require 'pry'
+
+# Tests actions
+module ActionTests
+  RSpec.shared_examples 'Action: delete' do |models|
+    context 'Deleting authors...' do
+      # path = '/authors'
+      path = '/writers' # renamed resource
+
+      # action: delete
+      it 'should remove an author' do
+        cnt = models[:author].count
+        delete path + '/' + models[:author].last.id.to_s
+        expect( last_response.status ).to eq( 200 )
+        get path
+        expect( last_response.status ).to eq( 200 )
+        expect( JSON.parse( last_response.body ).length ).to eq( cnt - 1 )
+      end
+
+      it 'should not remove an author with invalid id' do
+        cnt = models[:author].count
+        delete path + '/999'
+        expect( last_response.status ).to eq( 404 )
+        get path
+        expect( last_response.status ).to eq( 200 )
+        expect( JSON.parse( last_response.body ).length ).to eq( cnt )
+      end
+    end
+  end
+end

data/spec/action_list_spec.rb

@@ -0,0 +1,31 @@
+$VERBOSE = false
+
+# require 'pry'
+
+# Tests actions
+module ActionTests
+  RSpec.shared_examples 'Action: list' do |models|
+    context 'Listing books...' do
+      cnt = 0
+
+      # action: list
+      it 'should list all books' do
+        cnt = models[:book].count
+        get '/books'
+        expect( last_response.status ).to eq( 200 )
+        expect( JSON.parse( last_response.body ).length ).to eq( cnt )
+      end
+
+      it 'should paginate books' do
+        page_size = 2
+        limit = cnt - page_size
+        get "/books?limit=#{limit}"
+        expect( last_response.status ).to eq( 200 )
+        expect( JSON.parse( last_response.body ).length ).to eq( limit )
+        get "/books?limit=#{limit}&offset=#{limit}"
+        expect( last_response.status ).to eq( 200 )
+        expect( JSON.parse( last_response.body ).length ).to eq( page_size )
+      end
+    end
+  end
+end

data/spec/action_read_spec.rb

@@ -0,0 +1,28 @@
+$VERBOSE = false
+
+# require 'pry'
+
+# Tests actions
+module ActionTests
+  RSpec.shared_examples 'Action: read' do |models|
+    context 'Reading books...' do
+      path = '/books'
+
+      # action: read
+      it 'should read the first book' do
+        get path + '/' + models[:book].first.id.to_s
+        expect( last_response.status ).to eq( 200 )
+      end
+
+      it 'should read the last book' do
+        get path + '/' + models[:book].last.id.to_s
+        expect( last_response.status ).to eq( 200 )
+      end
+
+      it 'should not read an author with invalid id' do
+        get path + '/999'
+        expect( last_response.status ).to eq( 404 )
+      end
+    end
+  end
+end

data/spec/action_update_spec.rb

@@ -0,0 +1,98 @@
+$VERBOSE = false
+
+# require 'pry'
+
+# Tests actions
+module ActionTests
+  RSpec.shared_examples 'Action: update' do |models|
+    context 'Updating authors...' do
+      # path = '/authors'
+      path = '/writers' # renamed resource
+
+      # action: update
+      it 'should update some authors' do
+        random_authors = []
+        (1..(models[:author].count / 2 )).each do |_i|
+          random_authors.push( name: Faker::Book.author, email: Faker::Internet.email )
+        end
+        random_authors.uniq! { |a| a[:email] }
+        ids = models[:author].all.sample( random_authors.length ).map( &:id )
+        random_authors.each_with_index do |author, index|
+          put path + '/' + ids[index].to_s, writer: author
+          expect( last_response.status ).to eq( 200 ) # status = ok ?
+          expect( JSON.parse( last_response.body )['message'] ).to eq 'ok' # message = ok ?
+          row = models[:author].where( author )
+          expect( row.count ).to eq 1 # record exists ?
+          expect( row.first.id ).to eq ids[index] # record corresponds ?
+        end
+      end
+
+      it 'should not update an author with invalid data' do
+        id = models[:author].all.sample.id
+        authors = [
+          { name: '' },
+          { email: '' },
+          { name: '', email: '' },
+          { name: ' ', email: '   ' }
+        ]
+        authors.each do |author|
+          put path + '/' + id.to_s, writer: author
+          expect( last_response.status ).to eq( 400 )
+        end
+      end
+    end
+
+    ##############################################################################
+
+    context 'Updating books...' do
+      # action: update
+      it 'should update some books' do
+        cnt = ( models[:book].count - 1 ) / 4
+        random_books = []
+        (1..cnt).each do |_i|
+          random_books.push( title: Faker::Book.title + " [#{rand( 8 ) + 1}]" )
+        end
+        random_books.uniq! { |b| b[:title] }
+        (1..cnt).each do |_i|
+          random_books.push( title: Faker::Hipster.sentence, pages: rand( 1000 ), price: rand * 20 )
+        end
+        (1..cnt).each do |_i|
+          random_books.push( title: Faker::StarWars.quote, pages: rand( 1000 ), price: rand * 20, category_attributes: { name: Faker::Book.genre } )
+        end
+        tags_ids = models[:tag].all.map( &:id )
+        (1..cnt).each do |_i|
+          random_books.push( title: Faker::University.name, pages: rand( 1000 ), price: rand * 20, category_id: models[:category].all.sample.id, tag_ids: tags_ids.sample( rand( 3 ) ) )
+        end
+        ids = models[:book].all.sample( random_books.length ).map( &:id )
+        random_books.each_with_index do |book, index|
+          put '/books/' + ids[index].to_s, book: book
+          expect( last_response.status ).to eq( 200 ) # check if the status is equal to ok
+          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( id: ids[index] ).first
+          expect( row.tags.map( &:id ).sort ).to eq( tag_ids.sort ) if !tag_ids.nil? && tag_ids.any?
+          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
+      end
+
+      it 'should not update a book without title' do
+        put '/books/' + models[:book].all.sample.id.to_s, book: { title: '', pages: rand( 1000 ), price: rand * 20 }
+        expect( last_response.status ).to eq( 400 )
+      end
+    end
+
+    ##############################################################################
+
+    context 'Updating categories...' do
+      # action: update
+      it 'should not update categories' do
+        put '/categories/' + models[:category].all.sample.id.to_s, category: { name: 'A cat' }
+        expect( last_response.status ).to eq( 404 )
+      end
+    end
+  end
+end

data/spec/app_active_record_spec.rb

@@ -0,0 +1,53 @@
+
+ENV['RACK_ENV'] ||= 'test'
+
+# App path
+APP_AR = File.expand_path( '../../examples/active_record', __FILE__ ).freeze
+
+require File.join( APP_AR, 'app.rb' )
+require File.expand_path( '../spec_helper.rb', __FILE__ )
+
+# AR tests
+module ActiveRecordTest
+  $VERBOSE = false
+
+  models = {
+    author: Author,
+    book: Book,
+    category: Category,
+    chapter: Chapter,
+    tag: Tag
+  }
+
+  load File.join( APP_AR, 'Rakefile' )
+  ActiveRecord::Tasks::DatabaseTasks.db_dir = File.join( APP_AR, 'db' )
+  ActiveRecord::Tasks::DatabaseTasks.migrations_paths = File.join( APP_AR, 'db', 'migrate' )
+
+  describe 'ActiveRecord Test App' do
+    def app
+      App
+    end
+
+    before( :all ) do
+      # $VERBOSE = false
+      # Rake::Task.define_task( :environment )
+      Rake::Task['db:environment:set'].invoke
+      Rake::Task['db:drop'].invoke
+      Rake::Task['db:create'].invoke
+      Rake::Task['db:migrate'].invoke
+      # $VERBOSE = true
+    end
+
+    it 'should list routes in home page' do
+      get '/'
+      expect( last_response ).to be_ok
+      expect( JSON.parse( last_response.body ).count ).to be > 0
+    end
+
+    include_examples 'Action: create', models
+    include_examples 'Action: read', models
+    include_examples 'Action: update', models
+    include_examples 'Action: delete', models
+    include_examples 'Action: list', models
+  end
+end

data/spec/app_mongoid_spec.rb

@@ -0,0 +1,46 @@
+ENV['RACK_ENV'] ||= 'test'
+
+# App path
+APP_MONGO = File.expand_path( '../../examples/mongoid', __FILE__ ).freeze
+
+require File.join( APP_MONGO, 'app.rb' )
+require File.expand_path( '../spec_helper.rb', __FILE__ )
+
+# Mongo tests
+module MongoidTest
+  $VERBOSE = false
+
+  models = {
+    author: Author,
+    book: Book,
+    category: Category,
+    chapter: Chapter,
+    tag: Tag
+  }
+
+  load File.join( APP_MONGO, 'lib', 'tasks', 'db.rake' )
+
+  describe 'Mongoid Test App' do
+    def app
+      App
+    end
+
+    before( :all ) do
+      $VERBOSE = false
+      Rake::Task.define_task( :environment )
+      Rake::Task['db:drop'].invoke
+    end
+
+    it 'should list routes in home page' do
+      get '/'
+      expect( last_response ).to be_ok
+      expect( JSON.parse( last_response.body ).count ).to be > 0
+    end
+
+    include_examples 'Action: create', models
+    include_examples 'Action: read', models
+    include_examples 'Action: update', models
+    include_examples 'Action: delete', models
+    include_examples 'Action: list', models
+  end
+end

data/spec/app_sequel_spec.rb

@@ -0,0 +1,45 @@
+
+ENV['RACK_ENV'] ||= 'test'
+ENV['SEQUEL_RECREATE_DB'] = '1'
+
+APP_SEQUEL = File.expand_path( '../../examples/sequel', __FILE__ ).freeze
+
+require File.join( APP_SEQUEL, 'app.rb' )
+require File.expand_path( '../spec_helper.rb', __FILE__ )
+
+# Sequel tests
+module SequelTest
+  models = {
+    author: Author,
+    book: Book,
+    category: Category,
+    chapter: Chapter,
+    tag: Tag
+  }
+
+  load File.join( APP_SEQUEL, 'lib', 'tasks', 'db.rake' )
+
+  describe 'Sequel Test App' do
+    def app
+      App
+    end
+
+    before( :all ) do
+      $VERBOSE = false
+      # DB clean is done in the test app
+    end
+
+    it 'should list routes in home page' do
+      get '/'
+      expect( last_response ).to be_ok
+      expect( JSON.parse( last_response.body ).count ).to be > 0
+    end
+
+    # TODO: solve the problem Sequel::DatabaseError: SQLite3::ReadOnlyException: attempt to write a readonly database
+    # include_examples 'Action: create', models
+    # include_examples 'Action: read', models
+    # include_examples 'Action: update', models
+    # include_examples 'Action: delete', models
+    # include_examples 'Action: list', models
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,59 @@
+# spec/spec_helper.rb
+require 'rack/test'
+require 'rake'
+require 'rspec'
+require 'faker'
+
+# RSpecMixin
+module RSpecMixin
+  unless RSpecMixin.const_defined?( :ActionTests )
+    require File.expand_path( '../action_create_spec.rb', __FILE__ )
+    require File.expand_path( '../action_read_spec.rb',   __FILE__ )
+    require File.expand_path( '../action_update_spec.rb', __FILE__ )
+    require File.expand_path( '../action_delete_spec.rb', __FILE__ )
+    require File.expand_path( '../action_list_spec.rb',   __FILE__ )
+
+    include Rack::Test::Methods
+  end
+end
+
+# RSpec.shared_examples 'Basic tests' do
+#   it 'should list routes in home page' do
+#     get '/'
+#     expect( last_response.status ).to eq( 200 )
+#     # TODO: check the content partially
+#     # expect( last_response.body ).to eq( 'Hello world!' )
+#   end
+# end
+
+RSpec.configure do |config|
+  config.include RSpecMixin
+
+  config.filter_run :run_single_tests if RSpec.configuration.files_to_run.length > 1
+
+  # config.run_all_when_everything_filtered = true
+
+  # config.disable_monkey_patching!
+
+  config.warnings = true
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  # config.profile_examples = 10
+
+  # config.order = :random
+
+  # Kernel.srand config.seed
+
+  # config.before(:each) do
+  #   db = []
+  # end
+
+  # config.expect_with :rspec do |expectations|
+  #   expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  # end
+
+  # config.mock_with :rspec do |mocks|
+  #   mocks.verify_partial_doubles = true
+  # end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-rest-api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-01 00:00:00.000000000 Z
+date: 2017-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -31,11 +31,69 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- examples/active_record/Gemfile
+- examples/active_record/Gemfile.lock
+- examples/active_record/Rakefile
+- examples/active_record/app.rb
+- examples/active_record/config.ru
+- examples/active_record/database.yml
+- examples/active_record/db/migrate/001_create_authors.rb
+- examples/active_record/db/migrate/002_create_categories.rb
+- examples/active_record/db/migrate/003_create_books.rb
+- examples/active_record/db/migrate/004_create_tags.rb
+- examples/active_record/db/migrate/005_create_books_tags.rb
+- examples/active_record/db/migrate/006_create_chapters.rb
+- examples/active_record/db/schema.rb
+- examples/active_record/db/seeds.rb
+- examples/activeresource/Gemfile
+- examples/activeresource/Gemfile.lock
+- examples/activeresource/app.rb
+- examples/activeresource/config.ru
+- examples/activeresource/layout.slim
+- examples/misc/set_verb_options.rb
+- examples/mongoid/Gemfile
+- examples/mongoid/Gemfile.lock
+- examples/mongoid/Rakefile
+- examples/mongoid/app.rb
+- examples/mongoid/config.ru
+- examples/mongoid/database.yml
+- examples/mongoid/lib/tasks/db.rake
+- examples/ng-admin/index.html
+- examples/ng-admin/package.json
+- examples/sequel/Gemfile
+- examples/sequel/Gemfile.lock
+- examples/sequel/Rakefile
+- examples/sequel/app.rb
+- examples/sequel/config.ru
+- examples/sequel/database.yml
+- examples/sequel/db/migrate/001_create_authors.rb
+- examples/sequel/db/migrate/002_create_categories.rb
+- examples/sequel/db/migrate/003_create_books.rb
+- examples/sequel/db/migrate/004_create_tags.rb
+- examples/sequel/db/migrate/005_create_books_tags.rb
+- examples/sequel/db/migrate/006_create_chapters.rb
+- examples/sequel/lib/tasks/db.rake
 - lib/sinatra-rest-api.rb
 - lib/sinatra-rest-api/actions.rb
 - lib/sinatra-rest-api/adapter.rb
 - lib/sinatra-rest-api/provider.rb
 - lib/sinatra-rest-api/router.rb
+- sinatra-rest-api.gemspec
+- spec/action_create_spec.rb
+- spec/action_delete_spec.rb
+- spec/action_list_spec.rb
+- spec/action_read_spec.rb
+- spec/action_update_spec.rb
+- spec/app_active_record_spec.rb
+- spec/app_mongoid_spec.rb
+- spec/app_sequel_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/blocknotes/sinatra-rest-api
 licenses:
 - ISC
@@ -60,4 +118,13 @@ rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Sinatra REST API generator
-test_files: []
+test_files:
+- spec/action_create_spec.rb
+- spec/action_delete_spec.rb
+- spec/action_list_spec.rb
+- spec/action_read_spec.rb
+- spec/action_update_spec.rb
+- spec/app_active_record_spec.rb
+- spec/app_mongoid_spec.rb
+- spec/app_sequel_spec.rb
+- spec/spec_helper.rb