testapi 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d2afa6dbeb5889a4722ecf0ce7651fcaf742078
+  data.tar.gz: 940cda919b2214c866b4d1bd1bff7a215da3d35e
+SHA512:
+  metadata.gz: 799cba1d972b24a238f1d3cb026f3ab0cf0c44c786400990a05615d39e2c6920c9c2174a8ea83d538e3ab6412c3911c3c447db1195101382449644aca296076d
+  data.tar.gz: c8003684a369e621731161ec8513b9bde46e88dbea7a507810ac985049248dc40984bf41bca894f9d3f4b505bfa010c02e228184beeacadb2e7bdc5f9436eaad

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 agilidée
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# Testapi
+
+A Test API for your models, factories, and database cleaner.
+
+**Important :** NEVER use this gem in production.
+
+## Usage
+
+Examples with curl:
+
+```bash
+alias curl-json='curl -H "Content-Type: application/json"'
+curl-json -X GET http://localhost:3000/testapi/models/User
+curl-json -X POST http://localhost:3000/testapi/factories/user -d '{"attributes": {"name": "John"}}'
+curl-json -X DELETE http://localhost:3000/testapi/database
+```
+
+All available routes :
+```
+DELETE /database           => testapi/databases#destroy
+POST   /factories/:factory => testapi/factories#create
+GET    /models/:model      => testapi/models#index
+POST   /models/:model      => testapi/models#create
+GET    /models/:model/:id  => testapi/models#show
+PATCH  /models/:model/:id  => testapi/models#update
+DELETE /models/:model/:id  => testapi/models#destroy
+```
+
+## Notes
+
+DatabaseCleaner use `truncation` strategy and ignore the following tables by default :
+
+- ar_internal_metadata
+- schema_migrations
+- spatial_ref_sys
+
+You can change it using :
+
+```ruby
+Testapi.database_cleaner_ignored_tables = %w(my_table)
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "testapi", group: [:development, :test]
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Add this to `routes.rb`:
+
+```ruby
+if Rails.env.development? || Rails.env.test?
+  mount Testapi::Engine => "/testapi"
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/testapi/application_controller.rb

@@ -0,0 +1,21 @@
+class Testapi::ApplicationController < ActionController::API
+  rescue_from StandardError, with: :render_error
+
+  private
+
+  def render_json(json = {}, options = {})
+    render options.merge(json: json)
+  end
+
+  def render_object(object = @object)
+    render_json(object.attributes)
+  end
+
+  def render_error(e)
+    render_json({error: e.to_s}, {status: :unprocessable_entity})
+  end
+
+  def attributes
+    params.fetch(:attributes, {}).permit!.to_h.symbolize_keys
+  end
+end

data/app/controllers/testapi/databases_controller.rb

@@ -0,0 +1,6 @@
+class Testapi::DatabasesController < Testapi::ApplicationController
+  def destroy
+    DatabaseCleaner.clean_with(:truncation, except: Testapi.database_cleaner_ignored_tables)
+    render_json
+  end
+end

data/app/controllers/testapi/factories_controller.rb

@@ -0,0 +1,12 @@
+class Testapi::FactoriesController < Testapi::ApplicationController
+  def create
+    @object = FactoryBot.create(factory, attributes)
+    render_object
+  end
+
+  private
+
+  def factory
+    @factory ||= params[:factory].to_s.to_sym
+  end
+end

data/app/controllers/testapi/models_controller.rb

@@ -0,0 +1,36 @@
+class Testapi::ModelsController < Testapi::ApplicationController
+  before_action :model
+
+  def index
+    @objects = model.all.reorder(:id)
+    render_json @objects.map(&:attributes)
+  end
+
+  def create
+    @object = model.create!(attributes)
+    render_object
+  end
+
+  def show
+    @object = model.find(params[:id])
+    render_object
+  end
+
+  def update
+    @object = model.find(params[:id])
+    @object.update!(attributes)
+    render_object
+  end
+
+  def destroy
+    @object = model.find(params[:id])
+    @object.destroy!
+    render_object
+  end
+
+  private
+
+  def model
+    @model ||= params[:model].to_s.constantize
+  end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+Testapi::Engine.routes.draw do
+  resource  :database,                              only: %i(destroy)
+  resources :factories, path: "factories/:factory", only: %i(create)
+  resources :models,    path: "models/:model",      only: %i(index create show update destroy)
+end

data/lib/testapi/config.rb

@@ -0,0 +1,11 @@
+class << Testapi
+  attr_writer :database_cleaner_ignored_tables
+
+  def database_cleaner_ignored_tables
+    @database_cleaner_ignored_tables ||= %w(
+      ar_internal_metadata
+      schema_migrations
+      spatial_ref_sys
+    )
+  end
+end

data/lib/testapi/engine.rb

@@ -0,0 +1,3 @@
+class Testapi::Engine < ::Rails::Engine
+  isolate_namespace Testapi
+end

data/lib/testapi/version.rb

@@ -0,0 +1,3 @@
+module Testapi
+  VERSION = "1.0.0"
+end

data/lib/testapi.rb

@@ -0,0 +1,5 @@
+module Testapi
+end
+
+require "testapi/engine"
+require "testapi/config"

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: testapi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- agilidée
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-07 00:00:00.000000000 Z
+dependencies: []
+description: A Test API
+email:
+- contact@agilidee.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/testapi/application_controller.rb
+- app/controllers/testapi/databases_controller.rb
+- app/controllers/testapi/factories_controller.rb
+- app/controllers/testapi/models_controller.rb
+- config/routes.rb
+- lib/testapi.rb
+- lib/testapi/config.rb
+- lib/testapi/engine.rb
+- lib/testapi/version.rb
+homepage: https://github.com/agilidee/testapi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: A Test API
+test_files: []