trailblazer-endpoint 0.0.3 → 0.0.8

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,29 @@
 Rails.application.routes.draw do
-  # For details on the DSL available within this file, see http://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"
+  # For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html
+  post "/songs/create_with_options", to: "songs_controller/create_with_options#create"
+  post "/songs/create_or", to: "songs_controller/create_or#create"
+  post "/songs/endpoint_ctx", to: "songs_controller/create_endpoint_ctx#create"
+  post "/songs/create_with_or", to: "songs#create"
+  post "/songs", to: "songs#create_without_block"
+  post "/songs/create_with_protocol_failure", to: "songs_controller/create_with_protocol_failure#create_with_protocol_failure"
+  post "/songs/create_with_options_for_domain_ctx", to: "songs_controller/create_with_options_for_domain_ctx#create"
+  post "/auth/sign_in", to: "auth#sign_in"
+
+  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"
+
+  get "/", to: "home#dashboard"
+
+  post "/songs/serialize", to: "songs_controller/serialize#create"
+  post "/songs/copy_from_domain_ctx", to: "songs_controller/create1#create"
+  post "/songs/serialize1", to: "songs_controller/serialize1#create"
+  post "/songs/serialize2", to: "songs_controller/serialize2#create"
+  post "/songs/serialize3", to: "songs_controller/serialize3#create"
+  post "/songs/serialize4", to: "songs_controller/serialize4#create"
+  post "/songs/serialize5", to: "songs_controller/serialize5#create"
+  post "/songs/serialize6", to: "songs_controller/serialize6#create"
+  post "/songs/serialize7", to: "songs_controller/serialize7#create"
+  post "/songs/serialize72", to: "songs_controller/serialize7#new"
 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,87 @@
+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)
+
+  # default {success}
+    #:success
+    post_json "/v1/songs", {id: 1}, yogi_jwt
+
+    assert_response 200
+    assert_equal "{\"id\":1}", response.body
+    #:success end
+
+    # 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
+    #:not_authenticated
+    post_json "/v1/songs", {} # no token
+    assert_response 401
+    assert_equal "{\"errors\":{\"message\":\"Authentication credentials were not provided or are invalid.\"}}", response.body
+    #:not_authenticated end
+
+  # 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,163 @@
 require "test_helper"
 
-module Reform
-  Form = nil
-end # FIXME
-
-
-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
-
-  include Model
-  model Song, :create
-
-  include Contract::Step
-  include Representer::Deserializer::JSON
-  # contract do
-  #   property :title
-  #   property :length
-
-  #   include Reform::Form::ActiveModel::Validations
-  #   validates :title, presence: true
-  # end
-
-  # 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
-
-      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
-
+class SongsControllerTest < ActionDispatch::IntegrationTest
+  test "all possible outcomes with {Create}" do
   # 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
+    post "/songs", params: {}
+    assert_response 401
+    assert_equal "", response.body
+
+  # sign in
+    post "/auth/sign_in", params: {username: "yogi@trb.to", password: "secret"}
+    assert_equal 1, session[:user_id]
+    # follow_redirect!
+    assert_equal 1, session[:user_id]
+
+    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
+
+  # 403
+    post "/songs", params: {policy: false}
+    assert_response 403
+    assert_equal "", response.body
+
+    post "/songs/create_with_options", params: {id: 1}
+  # {success} block renders model
+    assert_response 200
+    assert_equal "<div>#<struct Song id=\"1\">#<struct User id=2, email=\"seuros@trb.to\"></div>\n", response.body
+
+    post "/songs/create_with_options", params: {}
+  # default {failure} block doesn't do anything
+    assert_response 422
+    assert_equal "", response.body
+
+    post "/songs/create_with_or", params: {id: 1}
+  # {success} block renders model
+    assert_response 200
+    assert_equal "<div>#<struct Song id=\"1\">#<struct User id=1, email=\"yogi@trb.to\"></div>\n", response.body
+
+    post "/songs/create_with_or", params: {}
+    assert_response 200
+    assert_equal %{<div>#<struct errors=nil></div>\n}, response.body
+
+  # Or { render status: 422 }
+    post "/songs/create_or", params: {}
+    assert_response 422
+    assert_equal %{null}, response.body
+
+  # {:endpoint_ctx} is available in blocks
+    post "/songs/endpoint_ctx", params: {id: 1}
+    assert_response 200
+    assert_equal "Created", response.body
+    # assert_equal "[\"domain_ctx\",\"session\",\"controller\",\"config_source\",\"current_user\",\"domain_activity_return_signal\"]", response.body
+
+    # {:options_for_domain_ctx} overrides domain_ctx
+    post "/songs/create_with_options_for_domain_ctx", params: {id: 1} # params get overridden
+    assert_response 200
+    assert_equal "<div>#<struct Song id=999></div>\n", 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"]
+  test "override protocol_failure" do
+    post "/songs/create_with_protocol_failure", params: {}
+    assert_response 500
+    assert_equal "wrong login, app crashed", response.body
   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
+  test "serializing/deserializing/find_process_model_from_resume_data" do
+  # # 401
+  #   post "/songs/serialize/"
+  #   assert_response 401
+
+  # sign in
+    post "/auth/sign_in", params: {username: "yogi@trb.to", password: "secret"}
+    assert_equal 1, session[:user_id]
+
+
+  # When {:encrypted_resume_data} is {nil} the entire deserialize cycle is skipped.
+  # Nothing gets serialized.
+  # This is considered an error since we're expecting resume data.
+    post "/songs/serialize1/", params: {} # encrypted_resume_data: nil
+    assert_response 500
+    assert_equal "xxx", response.body # DISCUSS: is this an application or a protocol error?
+
+  # Nothing deserialized, but {:remember} serialized
+  # "confirm_delete form"
+    post "/songs/serialize2/", params: {} # {:remember} serialized
+    assert_response 200
+    encrypted_string = "0109C4E535EDA2CCE8CD69E50C179F5950CC4A2A898504F951C995B6BCEAFE1DFAB02894854B96B9D11C23E25DB5FB03"
+    assert_equal "false/nil/#{encrypted_string}", response.body
+
+  # {:remember} deserialized
+  # "submit confirm_delete"
+  # We're expecting serialized data and don't serialize anything.
+    post "/songs/serialize3/", params: {encrypted_resume_data: encrypted_string} # {:remember} serialized
+    assert_response 200
+    assert_equal "false/{\"remember\"=>\"#<OpenStruct id=1>\", \"id\"=>9}/", response.body
+
+  # retrieve process_model via id in {:resume_data}
+  # we can see {endpoint_ctx[:process_model_id]}
+  # We're expecting serialized data and don't serialize anything.
+    post "/songs/serialize4/", params: {encrypted_resume_data: encrypted_string}
+    assert_response 200
+    assert_equal "9/{\"remember\"=>\"#<OpenStruct id=1>\", \"id\"=>9}/", response.body
+
+  # retrieve process_model via {:resume_data}'s serialized id.
+  # We're expecting serialized data and don't serialize anything.
+    post "/songs/serialize5/", params: {encrypted_resume_data: encrypted_string}
+    assert_response 200
+    assert_equal "#<struct Song id=9>/{\"remember\"=>\"#<OpenStruct id=1>\", \"id\"=>9}/", response.body
+    # model not found
+    post "/songs/serialize5/", params: {encrypted_resume_data: "36C61CCE30E6CFDE637DF0DA9257CC49"}
+    assert_response 404
+    assert_equal "", response.body
+
+  # find model without serialize from params, no serialized stuff passed
+  # DISCUSS: this could be a different test
+    post "/songs/serialize6/", params: {id: 1}
+    assert_response 200
+    assert_equal "#<struct Song id=\"1\">/#<struct Song id=\"1\">/", response.body
+    # model not found
+    post "/songs/serialize6/", params: {id: nil}
+    assert_response 404
+    assert_equal "", response.body
+
+  # {find_process_model: true} set on controller level, for all endpoints.
+    post "/songs/serialize7/", params: {id: 1}
+    assert_response 200
+    assert_equal "#<struct Song id=\"1\">/#<struct Song id=\"1\">/", response.body
+  # {find_process_model: false} overrides controller setting
+    post "/songs/serialize72/", params: {id: 1}
+    assert_response 200
+    assert_equal "false/false/", response.body
+
+
+# {#insert_copy_from_domain_ctx!} provides {:process_model}
+    post "/songs/copy_from_domain_ctx", params: {id: 1}
+    assert_response 200
+    assert_equal %{#<struct Song id="1">}, 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
+  test "sign_in" do
+  # wrong credentials
+    post "/auth/sign_in", params: {}
+    assert_response 401
+    assert_equal "", response.body
+    assert_nil session[:user_id]
+
+  # valid signin
+    post "/auth/sign_in", params: {username: "yogi@trb.to", password: "secret"}
+    assert_response 302
+    # assert_equal "", response.body
+    assert_equal 1, session[:user_id]
+    assert_redirected_to "/"
   end
 end
+
+# TODO: test 404 with NotFound config