factory_bot_instrumentation 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32b62f67039dbe0cd562eaf5ea41336866bce49cac7153b0abb86858a6ecf5e0
-  data.tar.gz: 3efc8629cced06d8d68da53aaaaa6ba1280d5b25be43b71b9d930fbd9f1424e5
+  metadata.gz: ff6458a1179520c115511b80ad9bdcb335fb652a04c647a12e7515a678440942
+  data.tar.gz: dce3493555ed93a948fea4b4d79b0dbb8c9d1984439706d4b0d1b400a75748fb
 SHA512:
-  metadata.gz: 8b8deb694372a595010a82a314234e4f0b5a2c5342c6ebb5568a497fe677530d54d2d4ea6443ef5f2154cc1fc601d1367e755035cb06c4fb26c39d06947b4ae1
-  data.tar.gz: 47b5760d942fcc51e5fc5d6df7c3fc9dfe8ed1a0b0ce593224aba027e925c7124239e0dbf28a222d143102dd6a16e593fa84c51446cd8c75b5b1cf4e50dc5d35
+  metadata.gz: 24a2ffa2f0c9092222f13826ec2e5232db505fcaddb8df33ae0eed39494ac8a36248f3c3cd39582fc88b6447401dbdd7850a08b6ed045091321f543d67eacc89
+  data.tar.gz: ab32dc405102f93ea3b6dfc409c292600b8bfdac8839bc4cabe949fe8168729d8f8a6b435798c3703bfcd1eba9853870344e2875f9ebef77d1182bea81c71276

data/.rubocop.yml

@@ -8,7 +8,7 @@ Documentation:
 
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
   Exclude:
     - db/schema.rb
     - bin/**/*

data/.travis.yml

@@ -9,7 +9,6 @@ rvm:
   - 2.6
   - 2.5
   - 2.4
-  - 2.3
 
 gemfile:
   - gemfiles/rails_4.gemfile

data/Appraisals

@@ -1,5 +1,6 @@
 appraise 'rails-4' do
   gem 'rails', '~> 4.2.11'
+  gem 'rails-api', '~> 0.4.1'
 end
 
 appraise 'rails-5.0' do

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+### 0.6.0
+
+* Added support for custom error handling and improved the default error
+  handling on FactoryBot usage (#9)
+
+### 0.5.1
+
+* Corrected a bug on the scenario description update (#8)
+
+### 0.5.0
+
+* Added support for custom before action logics (#7)
+
+### 0.4.0
+
+* Added support for configurable rendering (#6)
+
+### 0.3.0
+
+* Removed CI support for Ruby 2.3 (it never worked before)
+* Fixed the overwrite params bug on Rails 4.2
+* Added a test suite for the engine
+
 ### 0.2.0
 
 * Removed the Gemfile locks and added the to the ignore list

data/Makefile

@@ -93,4 +93,4 @@ shell-irb: install
 
 release:
 	# Release a new gem version
-	@$(RAKE) release
+	@$(BUNDLE) exec $(RAKE) release

data/README.md

@@ -48,6 +48,14 @@ Add this line to your application's Gemfile:
 gem 'factory_bot_instrumentation'
 ```
 
+**Heads up!** In case you use Rails 4.2, you need to add the
+[rails-api](https://github.com/rails-api/rails-api) gem as well, because this
+feature was first introduced with Rails 5.0.
+
+```ruby
+gem 'rails-api'
+```
+
 And then execute:
 
 ```bash
@@ -107,20 +115,20 @@ FactoryBot.define do
 
     trait :with_friend do
       after(:create) do |user, elevator|
-        FactoryBot.create(:lead,
-                           *elevator.lead_traits.map(&:to_sym),
-                           friends: [user],
-                           **elevator.friend_overwrites)
+        FactoryBot.create(:user,
+                          *elevator.friend_traits.map(&:to_sym),
+                          friends: [user],
+                          **elevator.friend_overwrites)
       end
     end
 
     trait :with_friends do
       after(:create) do |user, elevator|
         FactoryBot.create_list(:user,
-                                elevator.leads_amount,
-                                *elevator.lead_traits.map(&:to_sym),
-                                friends: [user],
-                                **elevator.friend_overwrites)
+                               elevator.friends_amount,
+                               *elevator.friend_traits.map(&:to_sym),
+                               friends: [user],
+                               **elevator.friend_overwrites)
       end
     end
   end
@@ -263,8 +271,8 @@ ease the integration. But as you can imagine the Instrumentation engine opens
 up some risky possibilities to your application. This is fine for a canary or
 development environment, but not for a production environment.
 
-There is currently only one way to secure the Instrumentation engine. You can
-completly disable it on your production environment by reconfiguring your
+There are currently multiple ways to secure the Instrumentation engine. You can
+completely disable it on your production environment by reconfiguring your
 routes like this:
 
 ```ruby
@@ -275,8 +283,17 @@ Rails.application.routes.draw do
 end
 ```
 
-Another option would be an HTTP basic authentication on this routes, but this
-is not yet implemented.
+Another option would be an HTTP basic authentication. Just configure the gem
+like this on the initializer:
+
+```ruby
+FactoryBot::Instrumentation.configure do |conf|
+  conf.before_action = proc do |controller|
+    basic_auth(username: ENV.fetch('INSTRUMENTATION_USERNAME'),
+               password: ENV.fetch('INSTRUMENTATION_PASSWORD'))
+  end
+end
+```
 
 #### Global settings
 
@@ -293,6 +310,30 @@ FactoryBot::Instrumentation.configure do |conf|
   # The instrumentation configuration file path we should use,
   # defaults to config/instrumentation.yml
   conf.config_file = 'config/scenarios.yml'
+  # By default we use the Rails default JSON rendering mechanism, but
+  # you can configure your own logic here (eg. a custom representer)
+  conf.render_entity = proc do |controller, entity|
+    controller.render plain: entity.to_json,
+                      content_type: 'application/json'
+  end
+  # By default we assemble a JSON response on errors which may be
+  # helpful for debugging, but you can configure your own logic here
+  conf.render_error = proc do |controller, error|
+    app_name = FactoryBot::Instrumentation.configuration.application_name
+    controller.render status: :internal_server_error,
+                      content_type: 'application/json',
+                      plain: {
+                        application: app_name,
+                        error: error.message,
+                        backtrace: error.backtrace.join("\n")
+                      }.to_json
+  end
+  # By default we do not perform any custom +before_action+ filters on the
+  # instrumentation controllers, with this option you can implement your
+  # custom logic like authentication
+  conf.before_action = proc do |controller|
+    # do your custom logic here
+  end
 end
 ```
 

data/Rakefile

@@ -1,8 +1,26 @@
 # frozen_string_literal: true
 
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+ENV['DISABLE_DATABASE_ENVIRONMENT_CHECK'] = '1'
+
+require 'bundler/setup'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(spec: [
+  'db:drop', 'db:create', 'db:migrate', 'db:setup'
+])
 
 task default: :spec

data/app/assets/javascripts/factory_bot_instrumentation/create.js

@@ -101,7 +101,7 @@ CreateForm.prototype.bind = function()
     this.submit();
   });
 
-  this.select.on('change', this.updateDesc);
+  this.select.on('change', this.updateDesc.bind(this));
   this.updateDesc();
 };
 

data/app/controllers/factory_bot/instrumentation/application_controller.rb

@@ -3,5 +3,33 @@
 module FactoryBot::Instrumentation
   # A base engine application controller.
   class ApplicationController < ActionController::API
+    # Extend our core functionality to support easy authentication logics
+    include ActionController::HttpAuthentication::Basic::ControllerMethods
+    include ActionController::HttpAuthentication::Digest::ControllerMethods
+    include ActionController::HttpAuthentication::Token::ControllerMethods
+
+    # Allow the users to implement additional instrumentation-wide before
+    # action logic, like authentication
+    before_action do |controller|
+      if FactoryBot::Instrumentation.configuration.before_action
+        instance_eval &FactoryBot::Instrumentation.configuration.before_action
+      end
+    end
+
+    protected
+
+    # A simple shortcut for Basic Auth on Rails 4.2+. Just configure the
+    # username and password and you're ready to check the current request.
+    #
+    # @param username [String] the required user name
+    # @param password [String] the required password of the user
+    # @param realm [String] the authentication realm
+    def basic_auth(username:, password:, realm: 'Instrumentation')
+      authenticate_or_request_with_http_basic(realm) \
+        do |given_name, given_password|
+        ActiveSupport::SecurityUtils.secure_compare(given_name, username) &
+          ActiveSupport::SecurityUtils.secure_compare(given_password, password)
+      end
+    end
   end
 end

data/app/controllers/factory_bot/instrumentation/root_controller.rb

@@ -40,12 +40,11 @@ module FactoryBot::Instrumentation
       FactoryBot.reload
       # Call the factory construction with the user given parameters
       entity = FactoryBot.create(*factory_params)
-      # Render the resulting entity as an API v1 representation
-      render plain: entity.to_json, content_type: 'application/json'
+      # Render the resulting entity with the configured rendering block
+      FactoryBot::Instrumentation.configuration.render_entity.call(self, entity)
     rescue StandardError => err
-      # Log for local factory debugging and re-raise for canary onwards
-      Rails.logger.error("#{err}\n#{err.backtrace.join("\n")}")
-      raise err
+      # Handle any error gracefully with the configured error handler
+      FactoryBot::Instrumentation.configuration.render_error.call(self, err)
     end
 
     private
@@ -56,7 +55,13 @@ module FactoryBot::Instrumentation
     # @return [Array<Mixed>] the FactoryBot options
     def factory_params
       data = params.permit(:factory, traits: [])
-      overwrite = params.to_unsafe_h.fetch(:overwrite, {}).deep_symbolize_keys
+
+      if Rails::VERSION::MAJOR >= 5
+        overwrite = params.to_unsafe_h.fetch(:overwrite, {})
+                          .deep_symbolize_keys
+      else
+        overwrite = params.fetch('overwrite', {}).deep_symbolize_keys
+      end
 
       [
         data.fetch(:factory).to_sym,

data/docker-compose.yml

@@ -1,7 +1,7 @@
 version: "3"
 services:
   test:
-    image: ruby:2.3
+    image: ruby:2.4
     network_mode: bridge
     working_dir: /app
     volumes:

data/factory_bot_instrumentation.gemspec

@@ -25,9 +25,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'factory_bot'
 
   spec.add_development_dependency 'bundler', '>= 1.16', '< 3'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-rails', '~> 3.8'
   spec.add_development_dependency 'simplecov', '~> 0.15'
   spec.add_development_dependency 'timecop', '~> 0.9.1'
-  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'sqlite3', '~> 1.3.6'
   spec.add_development_dependency 'appraisal'
 end

data/gemfiles/rails_4.gemfile

@@ -3,5 +3,6 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 4.2.11"
+gem "rails-api", "~> 0.4.1"
 
 gemspec path: "../"

data/lib/factory_bot/instrumentation/configuration.rb

@@ -15,6 +15,35 @@ module FactoryBot
       # You can set a fixed application name here,
       # defaults to your Rails application name in a titlized version
       config_accessor(:application_name) { nil }
+
+      # By default we use the Rails default JSON rendering mechanism, but
+      # you can configure your own logic here
+      config_accessor(:render_entity) do
+        proc do |controller, entity|
+          controller.render plain: entity.to_json,
+                            content_type: 'application/json'
+        end
+      end
+
+      # By default we assemble a JSON response on errors which may be
+      # helpful for debugging, but you can configure your own logic here
+      config_accessor(:render_error) do
+        proc do |controller, error|
+          app_name = FactoryBot::Instrumentation.configuration.application_name
+          controller.render status: :internal_server_error,
+                            content_type: 'application/json',
+                            plain: {
+                              application: app_name,
+                              error: error.message,
+                              backtrace: error.backtrace.join("\n")
+                            }.to_json
+        end
+      end
+
+      # By default we do not perform any custom +before_action+ filters on the
+      # instrumentation controllers, with this option you can implement your
+      # custom logic like authentication
+      config_accessor(:before_action) { nil }
     end
   end
 end

data/lib/factory_bot/instrumentation/version.rb

@@ -2,6 +2,6 @@
 
 module FactoryBot
   module Instrumentation
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.6.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot_instrumentation
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Hermann Mayer
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-03-22 00:00:00.000000000 Z
+date: 2020-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -59,19 +59,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -104,16 +104,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -188,7 +188,7 @@ files:
 homepage: https://github.com/hausgold/factory_bot_instrumentation
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -203,8 +203,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Allow your testers to generate test data on demand
 test_files: []