trailblazer-endpoint 0.0.4 → 0.0.5

data/test/rails-app/config/credentials.yml.enc

@@ -0,0 +1 @@
+DrKH8tXT2zcMyRNuO17XGyj5qNwIUtoMDC6d+VfPQdJRIgRbfCd6tLY4N9AOkXXQP2e9DeJFgBPnfirNu4ixAoJmEwlnjhoobiMizxpbYgI9YLVhtCMyRNhQG9RsVfb4yoo6S4b9FEPlUmf0JKC4L/THuE15ro2tLBkx7dg+IYEz/oBe//xHqcD4wE1WYOJVzT53wpCWan6Ju+bdDmS9M7TmCPm6DQ0Kt9y+I350X5rUIPPTGO0akf3g+AkYRdEu/1Z6C8NmrmvBzcQ3UTRDUy+LubJ+JT342J/eQo1A480fhqDUTzWNUpYWD6zA0PRCKyaTaP4w/WvvPF6F6fmuHLDkMa1+TdX+rkLPIBbWYkba6DpVtwjLz+t5LUvk4BDNTfk59SNRQxC4jJOEWbxtU4rDopDCi/qGjP6i--fFGcdGkm4cR2s7ZR--3aMr7ojTm6N0V7CF/HjuHA==

data/test/rails-app/config/database.yml

@@ -1,4 +1,4 @@
-# SQLite version 3.x
+# SQLite. Versions 3.8.0 and up are supported.
 #   gem install sqlite3
 #
 #   Ensure the SQLite 3 gem is defined in your Gemfile
@@ -6,7 +6,7 @@
 #
 default: &default
   adapter: sqlite3
-  pool: 5
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
   timeout: 5000
 
 development:

data/test/rails-app/config/environments/development.rb

@@ -13,12 +13,11 @@ Rails.application.configure do
   config.consider_all_requests_local = true
 
   # Enable/disable caching. By default caching is disabled.
-  if Rails.root.join('tmp/caching-dev.txt').exist?
-    config.action_controller.perform_caching = true
-
+  # Run rails dev:cache to toggle caching.
+  if Rails.root.join('tmp', 'caching-dev.txt').exist?
     config.cache_store = :memory_store
     config.public_file_server.headers = {
-      'Cache-Control' => 'public, max-age=172800'
+      'Cache-Control' => "public, max-age=#{2.days.to_i}"
     }
   else
     config.action_controller.perform_caching = false
@@ -26,29 +25,20 @@ Rails.application.configure do
     config.cache_store = :null_store
   end
 
-  # Don't care if the mailer can't send.
-  config.action_mailer.raise_delivery_errors = false
-
-  config.action_mailer.perform_caching = false
-
   # Print deprecation notices to the Rails logger.
   config.active_support.deprecation = :log
 
   # Raise an error on page load if there are pending migrations.
   config.active_record.migration_error = :page_load
 
-  # Debug mode disables concatenation and preprocessing of assets.
-  # This option may cause significant delays in view rendering with a large
-  # number of complex assets.
-  config.assets.debug = true
+  # Highlight code that triggered database queries in logs.
+  config.active_record.verbose_query_logs = true
 
-  # Suppress logger output for asset requests.
-  config.assets.quiet = true
 
-  # Raises error for missing translations
+  # Raises error for missing translations.
   # config.action_view.raise_on_missing_translations = true
 
   # Use an evented file watcher to asynchronously detect changes in source code,
   # routes, locales, etc. This feature depends on the listen gem.
-  config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
 end

data/test/rails-app/config/environments/production.rb

@@ -12,21 +12,15 @@ Rails.application.configure do
 
   # Full error reports are disabled and caching is turned on.
   config.consider_all_requests_local       = false
-  config.action_controller.perform_caching = true
+
+  # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"]
+  # or in config/master.key. This key is used to decrypt credentials (and other encrypted files).
+  # config.require_master_key = true
 
   # Disable serving static files from the `/public` folder by default since
   # Apache or NGINX already handles this.
   config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
 
-  # Compress JavaScripts and CSS.
-  config.assets.js_compressor = :uglifier
-  # config.assets.css_compressor = :sass
-
-  # Do not fallback to assets pipeline if a precompiled asset is missed.
-  config.assets.compile = false
-
-  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
-
   # Enable serving of images, stylesheets, and JavaScripts from an asset server.
   # config.action_controller.asset_host = 'http://assets.example.com'
 
@@ -34,11 +28,6 @@ Rails.application.configure do
   # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
   # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
 
-  # Mount Action Cable outside main process or domain
-  # config.action_cable.mount_path = nil
-  # config.action_cable.url = 'wss://example.com/cable'
-  # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ]
-
   # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
   # config.force_ssl = true
 
@@ -52,14 +41,9 @@ Rails.application.configure do
   # Use a different cache store in production.
   # config.cache_store = :mem_cache_store
 
-  # Use a real queuing backend for Active Job (and separate queues per environment)
+  # Use a real queuing backend for Active Job (and separate queues per environment).
   # config.active_job.queue_adapter     = :resque
-  # config.active_job.queue_name_prefix = "rails-app_#{Rails.env}"
-  config.action_mailer.perform_caching = false
-
-  # Ignore bad email addresses and do not raise email delivery errors.
-  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
-  # config.action_mailer.raise_delivery_errors = false
+  # config.active_job.queue_name_prefix = "rails_app_production"
 
   # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
   # the I18n.default_locale when a translation cannot be found).
@@ -78,9 +62,30 @@ Rails.application.configure do
   if ENV["RAILS_LOG_TO_STDOUT"].present?
     logger           = ActiveSupport::Logger.new(STDOUT)
     logger.formatter = config.log_formatter
-    config.logger = ActiveSupport::TaggedLogging.new(logger)
+    config.logger    = ActiveSupport::TaggedLogging.new(logger)
   end
 
   # Do not dump schema after migrations.
   config.active_record.dump_schema_after_migration = false
+
+  # Inserts middleware to perform automatic connection switching.
+  # The `database_selector` hash is used to pass options to the DatabaseSelector
+  # middleware. The `delay` is used to determine how long to wait after a write
+  # to send a subsequent read to the primary.
+  #
+  # The `database_resolver` class is used by the middleware to determine which
+  # database is appropriate to use based on the time delay.
+  #
+  # The `database_resolver_context` class is used by the middleware to set
+  # timestamps for the last write to the primary. The resolver uses the context
+  # class timestamps to determine how long to wait before reading from the
+  # replica.
+  #
+  # By default Rails will store a last write timestamp in the session. The
+  # DatabaseSelector middleware is designed as such you can define your own
+  # strategy for connection switching and pass that into the middleware through
+  # these configuration options.
+  # config.active_record.database_selector = { delay: 2.seconds }
+  # config.active_record.database_resolver = ActiveRecord::Middleware::DatabaseSelector::Resolver
+  # config.active_record.database_resolver_context = ActiveRecord::Middleware::DatabaseSelector::Resolver::Session
 end

data/test/rails-app/config/environments/test.rb

@@ -1,10 +1,11 @@
+# The test environment is used exclusively to run your application's
+# test suite. You never need to work with it otherwise. Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs. Don't rely on the data there!
+
 Rails.application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
 
-  # The test environment is used exclusively to run your application's
-  # test suite. You never need to work with it otherwise. Remember that
-  # your test database is "scratch space" for the test suite and is wiped
-  # and recreated between test runs. Don't rely on the data there!
   config.cache_classes = true
 
   # Do not eager load code on boot. This avoids loading your whole application
@@ -15,28 +16,23 @@ Rails.application.configure do
   # Configure public file server for tests with Cache-Control for performance.
   config.public_file_server.enabled = true
   config.public_file_server.headers = {
-    'Cache-Control' => 'public, max-age=3600'
+    'Cache-Control' => "public, max-age=#{1.hour.to_i}"
   }
 
   # Show full error reports and disable caching.
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
+  config.cache_store = :null_store
 
   # Raise exceptions instead of rendering exception templates.
   config.action_dispatch.show_exceptions = false
 
   # Disable request forgery protection in test environment.
   config.action_controller.allow_forgery_protection = false
-  config.action_mailer.perform_caching = false
-
-  # Tell Action Mailer not to deliver emails to the real world.
-  # The :test delivery method accumulates sent emails in the
-  # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test
 
   # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr
 
-  # Raises error for missing translations
+  # Raises error for missing translations.
   # config.action_view.raise_on_missing_translations = true
 end

data/test/rails-app/config/initializers/application_controller_renderer.rb

@@ -1,6 +1,8 @@
 # Be sure to restart your server when you modify this file.
 
-# ApplicationController.renderer.defaults.merge!(
-#   http_host: 'example.org',
-#   https: false
-# )
+# ActiveSupport::Reloader.to_prepare do
+#   ApplicationController.renderer.defaults.merge!(
+#     http_host: 'example.org',
+#     https: false
+#   )
+# end

data/test/rails-app/config/initializers/cors.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Avoid CORS issues when API is called from the frontend app.
+# Handle Cross-Origin Resource Sharing (CORS) in order to accept cross-origin AJAX requests.
+
+# Read more: https://github.com/cyu/rack-cors
+
+# Rails.application.config.middleware.insert_before 0, Rack::Cors do
+#   allow do
+#     origins 'example.com'
+#
+#     resource '*',
+#       headers: :any,
+#       methods: [:get, :post, :put, :patch, :delete, :options, :head]
+#   end
+# end

data/test/rails-app/config/initializers/trailblazer.rb

@@ -0,0 +1,2 @@
+require "trailblazer/operation"
+require "representable/json"

data/test/rails-app/config/locales/en.yml

@@ -16,8 +16,18 @@
 #
 # This would use the information in config/locales/es.yml.
 #
+# The following keys must be escaped otherwise they will not be retrieved by
+# the default I18n backend:
+#
+# true, false, on, off, yes, no
+#
+# Instead, surround them with single quotes.
+#
+# en:
+#   'true': 'foo'
+#
 # To learn more, please read the Rails Internationalization guide
-# available at http://guides.rubyonrails.org/i18n.html.
+# available at https://guides.rubyonrails.org/i18n.html.
 
 en:
   hello: "Hello world"

data/test/rails-app/config/master.key

@@ -0,0 +1 @@
+fee3e51bb20a824ec13dc5912f3548f2

data/test/rails-app/config/routes.rb

@@ -1,6 +1,11 @@
 Rails.application.routes.draw do
-  # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
+  # For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html
   resources :songs
-  post "update_with_user", to: "songs#update_with_user"
-  post "create_with_custom_handlers", to: "songs#create_with_custom_handlers"
+  post "/songs/create_with_options", to: "songs#create_with_options"
+  post "/songs/create_with_or", to: "songs#create_with_or"
+
+  post "/v1/songs", to: "api/v1/songs#create"
+  get "/v1/songs/:id", to: "api/v1/songs#show"
+
+  get "/v1/songs_with_options/:id", to: "api/v1/songs_controller/with_options#show"
 end

data/test/rails-app/db/schema.rb

@@ -0,0 +1,15 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `rails
+# db:schema:load`. When creating a new database, `rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 0) do
+
+end

data/test/rails-app/test/controllers/api_songs_controller_test.rb

@@ -0,0 +1,83 @@
+require "test_helper"
+
+class ApiSongsControllerTest < ActionDispatch::IntegrationTest
+
+  def jwt(user_id)
+    Auth::Jwt.generate('user_id', user_id, {}
+      # 'email': options['current_user'].email
+    )
+  end
+
+  def post_json(endpoint, params_hash, api_token = nil, headers={})
+    post endpoint, params: params_hash.to_json, headers: request_headers(api_token).merge(headers)
+  end
+  def get_json(endpoint, params = nil, api_token = nil)
+    get endpoint, params: params, headers: request_headers(api_token)
+  end
+
+  def request_headers(api_token = nil)
+    headers = {
+      'Content-Type' => 'application/json'
+    }
+    unless api_token.nil?
+      headers.merge!(authorization_header(api_token))
+    end
+    headers
+  end
+  def authorization_header(api_token)
+    { 'Authorization' => "Bearer #{api_token}"}
+  end
+
+
+  test "API interface" do
+    yogi_jwt = jwt(1)
+
+    post_json "/v1/songs", {id: 1}, yogi_jwt
+
+  # default {success}
+    assert_response 200
+    assert_equal "{\"id\":1}", response.body
+
+    # no proper input/params
+    post_json "/v1/songs", {}, yogi_jwt
+  # default {failure}
+    assert_response 422
+    assert_equal "{\"errors\":{\"message\":\"The submitted data is invalid.\"}}", response.body
+
+  # 401
+    post_json "/v1/songs", {authenticate: false}
+    assert_response 401
+    assert_equal "{\"errors\":{\"message\":\"Authentication credentials were not provided or are invalid.\"}}", response.body
+
+  # 403
+    post_json "/v1/songs", {id: 1, policy: false}, yogi_jwt
+    assert_response 403
+    assert_equal "{\"errors\":{\"message\":\"Action not allowed due to a policy setting.\"}}", response.body
+
+  # 200 / GET
+    get_json "/v1/songs/1", {}, yogi_jwt
+    assert_response 200
+    assert_equal "{\"id\":\"1\"}", response.body
+
+  # 404
+    get_json "/v1/songs/0", {}, yogi_jwt
+    assert_response 404
+    assert_equal "{\"errors\":{}}", response.body
+
+  # TODO: CHANGE/customize block
+  end
+
+  test "allows overriding {:success_block} and friends" do
+    yogi_jwt = jwt(1)
+
+  # Not authenticated, 401, overridden {:protocol_failure_block} kicks in
+    get_json "/v1/songs_with_options/1"
+    assert_response 402
+
+  # All good, default block
+    get_json "/v1/songs_with_options/1", yogi_jwt
+
+  end
+end
+
+# TODO: test 404 with NotFound config

data/test/rails-app/test/controllers/songs_controller_test.rb

@@ -1,156 +1,48 @@
 require "test_helper"
 
-module Reform
-  Form = nil
-end # FIXME
+class SongsControllerTest < ActionDispatch::IntegrationTest
+  test "create 200" do
+    post "/songs", params: {id: 1}
+  # default {success} block doesn't do anything
+    assert_response 200
+    assert_equal "", response.body
+
+    post "/songs", params: {}
+  # default {failure} block doesn't do anything
+    assert_response 422
+    assert_equal "", response.body
 
+  # 401
+    post "/songs", params: {authenticate: false}
+    assert_response 401
+    assert_equal "", response.body
 
-Song = Struct.new(:id, :title, :length) do
-  def self.find_by(id:1); id=="0" ? nil : new(id, "A Song") end
-end
-
-require "trailblazer"
-require "trailblazer/operation/model"
-# require "reform/form/active_model/validations"
-require "trailblazer/operation/contract"
-require "trailblazer/operation/representer"
-require "trailblazer/operation/guard"
-require "trailblazer/endpoint"
-
-
-require "representable/json"
-class Serializer < Representable::Decorator
-  include Representable::JSON
-  property :id
-  property :title
-  property :length
-
-  class Errors < Representable::Decorator
-    include Representable::JSON
-    property :messages
-  end
-end
-
-class Deserializer < Representable::Decorator
-  include Representable::JSON
-  property :title
-end
-
-
-class Create < Trailblazer::Operation
-  include Policy::Guard
-  policy ->(*) { self["user.current"] == ::Module }
-
-  extend Representer::DSL
-  representer :serializer, Serializer
-  representer :deserializer, Deserializer
-  representer :errors, Serializer::Errors
-  # self["representer.serializer.class"] = Representer
-  # self["representer.deserializer.class"] = Deserializer
+  # 403
+    post "/songs", params: {policy: false}
+    assert_response 403
+    assert_equal "", response.body
 
-  include Model
-  model Song, :create
+    post "/songs/create_with_options", params: {id: 1}
+  # {success} block renders model
+    assert_response 200
+    assert_equal "[\"1\",\"yay!\"]", response.body
 
-  include Contract::Step
-  include Representer::Deserializer::JSON
-  # contract do
-  #   property :title
-  #   property :length
+    post "/songs/create_with_options", params: {}
+  # default {failure} block doesn't do anything
+    assert_response 422
+    assert_equal "", response.body
 
-  #   include Reform::Form::ActiveModel::Validations
-  #   validates :title, presence: true
-  # end
+    post "/songs/create_with_or", params: {id: 1}
+  # {success} block renders model
+    assert_response 200
+    assert_equal "{\"or\":\"1\"}", response.body
 
-  # FIXME: use trb-rails and reform
-  class FakeContract
-    def initialize(model,*); @model = model end
-    def call(params)
-      if params[:title]
-        @title, @length = params[:title],params[:length]
-        return Trailblazer::Operation::Result.new(true, {})
-      end
+    post "/songs/create_with_or", params: {}
+  # default {failure} block doesn't do anything
+    assert_response 422
+    assert_equal "null", response.body
 
-      return Struct.new(:errors, :success?).new(Struct.new(:messages).new({"title": ["must be set"]}), false)
-    end
-    def sync; @model.title = @title; @model.length = @length; end
   end
-
-  contract FakeContract
-
-  def process(params)
-    validate(params) do |f|
-      self["contract"].sync
-      self["model"].id = 9
-    end
-  end
-end
-
-class Update < Create
-  action :find_by
-end
-
-# TODO: test present.
-class Show < Trailblazer::Operation
-  include Policy::Guard
-  policy ->(*) { self["user.current"] == ::Module }
-
-  extend Representer::DSL
-  representer :serializer, Serializer
-
-  include Model
-  model Song, :find_by
-
-  self.> ->(input, options) { options["present"] = true }, before: "operation.result"
 end
 
-class SongsControllerTest < ActionController::TestCase
-  # 404
-  test "update 404" do
-    post :update, params: { id: 0 }
-    assert_equal 404, response.status
-  end
-
-  # 401
-  test "update 401" do
-    post :update, params: { id: 1 }
-    assert_equal 401, response.status
-  end
-
-  # 422
-  # TODO: test when no error repr set.
-  test "update 422" do
-    post :create, params: { id: 1 }
-    assert_equal 422, response.status
-    assert_equal %{{\"messages\":{\"title\":[\"must be set\"]}}}, response.body
-  end
-
-  # 201
-  test "create 201" do
-    post :create, params: { id: 1, title: "AVH" }
-    assert_equal 201, response.status
-    assert_equal %{}, response.body
-    assert_equal "/songs/9", response.header["Location"]
-  end
-
-  # 200 present
-  test "show 200" do
-    get :show, params: { id: 1 }
-    assert_equal 200, response.status
-    assert_equal %{{"id":"1","title":"A Song"}}, response.body
-  end
-
-  # 201 update
-  test "update 200" do
-    post :update_with_user, params: { id: 1, title: "AVH" }
-    assert_equal 200, response.status
-    assert_equal %{}, response.body
-    assert_equal "/songs/9", response.header["Location"]
-  end
-
-  # custom 999
-  test "custom 999" do
-    post :create_with_custom_handlers, params: { id: 1, title: "AVH" }
-    assert_equal 999, response.status
-    assert_equal %{{"id":9,"title":"AVH"}}, response.body
-  end
-end
+# TODO: test 404 with NotFound config