trailblazer-endpoint 0.0.4 → 0.0.5

data/test/rails-app/app/concepts/song/operation/create.rb

@@ -0,0 +1,13 @@
+module Song::Operation
+  class Create < Trailblazer::Operation
+    # include Trailblazer::Activity::Testing.def_steps(:model, :validate, :save)
+    step :model
+    # step :validate
+    # step :save
+
+    def model(ctx, params:, **)
+      return unless params[:id]
+      ctx[:model] = Song.new(params[:id])
+    end
+  end
+end

data/test/rails-app/app/concepts/song/operation/show.rb

@@ -0,0 +1,10 @@
+module Song::Operation
+  class Show < Trailblazer::Operation
+    step :model, Output(:failure) => End(:not_found)
+
+    def model(ctx, params:, **)
+      return unless params[:id] == "1"
+      ctx[:model] = Song.new(params[:id])
+    end
+  end
+end

data/test/rails-app/app/concepts/song/representer.rb

@@ -0,0 +1,5 @@
+class Song::Representer < Representable::Decorator
+  include Representable::JSON
+
+  property :id
+end

data/test/rails-app/app/controllers/api/v1/songs_controller.rb

@@ -0,0 +1,35 @@
+#:controller
+module Api
+  module V1
+    class SongsController < ApplicationController::Api
+      endpoint Song::Operation::Create.to_s, domain_activity: Song::Operation::Create
+      endpoint Song::Operation::Show.to_s, domain_activity: Song::Operation::Show do {Output(:not_found) => Track(:not_found)} end
+
+      #:create
+      def create
+        endpoint Song::Operation::Create.to_s, representer_class: Song::Representer
+      end
+      #:create end
+
+      def show
+        endpoint Song::Operation::Show.to_s, representer_class: Song::Representer
+      end
+
+      def show_with_options
+        endpoint Song::Operation::Show.to_s, representer_class: Song::Representer, protocol_failure_block: ->(ctx, endpoint_ctx:, **) { head endpoint_ctx[:status] + 1 }
+      end
+
+      class WithOptionsController < ApplicationController::Api
+        endpoint Song::Operation::Show.to_s, domain_activity: Song::Operation::Show do {Output(:not_found) => Track(:not_found)} end
+
+        #:show-options
+        def show
+          endpoint Song::Operation::Show.to_s, representer_class: Song::Representer,
+            protocol_failure_block: ->(ctx, endpoint_ctx:, **) { head endpoint_ctx[:status] + 1 }
+        end
+        #:show-options end
+      end
+    end
+  end
+end
+#:controller end

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

@@ -1,3 +1,8 @@
+require "trailblazer/endpoint/controller"
+
 class ApplicationController < ActionController::Base
-  protect_from_forgery with: :exception
+
 end
+
+
+# directive

data/test/rails-app/app/controllers/application_controller/api.rb

@@ -0,0 +1,105 @@
+#:app-controller
+class ApplicationController::Api < ApplicationController
+  include Trailblazer::Endpoint::Controller.module(api: true)
+
+  def self.options_for_block_options(ctx, controller:, **)
+    response_block = ->(ctx, endpoint_ctx:, **) do
+      controller.render json: endpoint_ctx[:representer], status: endpoint_ctx[:status]
+    end
+
+    {
+      success_block:          response_block,
+      failure_block:          response_block,
+      protocol_failure_block: response_block
+    }
+  end
+
+  directive :options_for_block_options, method(:options_for_block_options)
+#:app-controller end
+
+#:options_for_endpoint
+  def self.options_for_endpoint(ctx, controller:, **)
+    {
+      request: controller.request,
+      errors_representer_class: App::Api::V1::Representer::Errors,
+      errors: Trailblazer::Endpoint::Adapter::API::Errors.new,
+    }
+  end
+
+  directive :options_for_endpoint, method(:options_for_endpoint)
+#:options_for_endpoint end
+
+#:options_for_domain_ctx
+  def self.options_for_domain_ctx(ctx, controller:, **) # TODO: move to ApplicationController
+    {
+      params: controller.params,
+    }
+  end
+
+  directive :options_for_domain_ctx,    method(:options_for_domain_ctx)
+#:options_for_domain_ctx end
+
+  #:protocol
+  class Protocol < Trailblazer::Endpoint::Protocol
+    step Auth::Operation::Policy, inherit: true, id: :policy, replace: :policy
+    step Subprocess(Auth::Operation::Authenticate), inherit: true, id: :authenticate, replace: :authenticate
+  end
+  #:protocol end
+
+  #:adapter
+  module Adapter
+    class Representable < Trailblazer::Endpoint::Adapter::API
+      step :render # added before End.success
+      step :render_errors, after: :_422_status, magnetic_to: :failure, Output(:success) => Track(:failure)
+      step :render_errors, after: :protocol_failure, magnetic_to: :fail_fast, Output(:success) => Track(:fail_fast), id: :render_protocol_failure_errors
+
+      def render(ctx, domain_ctx:, representer_class:, **) # this is what usually happens in your {Responder}.
+        ctx[:representer] = representer_class.new(domain_ctx[:model] || raise("no model found!"))
+      end
+
+      def render_errors(ctx, errors:, errors_representer_class:, **) # TODO: extract with {render}
+        ctx[:representer] = errors_representer_class.new(errors)
+      end
+
+      Trailblazer::Endpoint::Adapter::API.insert_error_handler_steps!(self)
+      include Trailblazer::Endpoint::Adapter::API::Errors::Handlers # handler methods to set an error message.
+    end # Representable
+  end
+  #:adapter end
+
+puts Trailblazer::Developer.render(Adapter::Representable)
+
+  #:endpoint
+  # app/controllers/application_controller/api.rb
+  endpoint protocol: Protocol, adapter: Adapter::Representable do
+    # {Output(:not_found) => Track(:not_found)}
+    {}
+  end
+  #:endpoint end
+end
+
+
+# header 'Authorization', "Bearer #{result['jwt_token']}" if result['jwt_token']
+
+
+# ΓΞΞ Protocol ΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞ˥
+# | (Start)--->[Authenticate]-->[Policy]-->[Show]----------->((success))  |
+# |                 |            |          | L------------->((failure))  |
+# |                 |            |          L------------->((not_found))  |
+# |                 |            L------------------->((not_authorized))  |
+# |                 L----------------------------->((not_authenticated))  |
+# |                                                     ((invalid_data))  |
+# LΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞ˩
+#--˥˩   ˪
+
+# ΓΞΞ Adapter::Representable ΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞ˥
+# |                                                                                                                                                                                                |
+# | (Start)---> ΓΞΞ Protocol ΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞ˥                                                                                                          |
+#               | (Start)--->[Authenticate]-->[Policy]-->[Show]----------->((success))  |--->[_200_status]--->[render]---------------------------------------------------------------->((success)) |
+#               |                 |            |          | L------------->((failure))  |-˥                                                                                                        |
+#               |                 |            |          L------------->((not_found))  |-|------------------------------->[_404_status]-----------v                                               |
+#               |                 |            L------------------->((not_authorized))  |-|->[handle_not_authorized]------>[_403_status]--->[protocol_failure]--->[render_errors]--->((fail_fast)) |
+#               |                 L----------------------------->((not_authenticated))  |-|->[handle_not_authenticated]--->[_401_status]-----------^                                               |
+#               |                                                     ((invalid_data))  |-┴->[handle_invalid_data]-------->[_422_status]--->[render_errors]--------------------------->((failure)) |
+#               LΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞ˩                                                                                                          |
+# LΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞ˩

data/test/rails-app/app/controllers/application_controller/web.rb

@@ -0,0 +1,30 @@
+class ApplicationController::Web < ApplicationController
+  extend Trailblazer::Endpoint::Controller
+  include Trailblazer::Endpoint::Controller::InstanceMethods::DSL
+  include Trailblazer::Endpoint::Controller::Rails
+  extend Trailblazer::Endpoint::Controller::Rails::DefaultBlocks
+  extend Trailblazer::Endpoint::Controller::Rails::DefaultParams
+  include Trailblazer::Endpoint::Controller::Rails::Process
+
+  # directive :options_for_endpoint, method(:options_for_endpoint), method(:request_options)
+  # directive :options_for_flow_options, method(:options_for_flow_options)
+  # directive :options_for_block_options, method(:options_for_block_options)
+
+  Protocol = Class.new(Trailblazer::Endpoint::Protocol) do
+    # no {:seq} dependency
+    def authenticate(ctx, domain_ctx:, **)
+      # puts domain_ctx[:params].inspect
+
+puts "TODO: should we always inject params into the endpoint_ctx?"
+      domain_ctx[:params][:authenticate] == "false" ? false : true
+    end
+
+    def policy(ctx, domain_ctx:, **)
+      domain_ctx[:params][:policy] == "false" ? false : true
+    end
+  end
+
+  endpoint protocol: Protocol, adapter: Trailblazer::Endpoint::Adapter::Web do
+    {Output(:not_found) => Track(:not_found)}
+  end
+end

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

@@ -1,26 +1,24 @@
-class SongsController < ApplicationController
-  require "trailblazer/endpoint/rails"
-  include Trailblazer::Endpoint::Controller
+class SongsController < ApplicationController::Web
+  endpoint("Create", domain_activity: Song::Operation::Create) do {} end # FIXME: we still need to provide an empty hash here if we want to override the not_found behavior.
 
-  def create
-    endpoint Create, path: songs_path, args: [ params, { "user.current" => ::Module } ]
-  end
-
-  def update
-    endpoint Update, path: songs_path, args: [params]
-  end
+  # directive :options_for_domain_ctx, ->(ctx, **) { {seq: []} }
 
-  def update_with_user
-    endpoint Update, path: songs_path, args: [ params, { "user.current" => ::Module } ]
+  def create
+    endpoint "Create"
   end
 
-  def show
-    endpoint Show, path: songs_path, args: [ params, { "user.current" => ::Module } ]
+  def create_with_options
+    endpoint "Create", process_model: "yay!" do |ctx, model:, endpoint_ctx:, **|
+      # TODO test process_model
+      render json: [model, endpoint_ctx[:process_model]]
+    end
   end
 
-  def create_with_custom_handlers
-    endpoint Create, path: songs_path, args: [ params, { "user.current" => ::Module } ] do |m|
-      m.created { |result| render json: result["representer.serializer.class"].new(result["model"]), status: 999 }
+  def create_with_or
+    endpoint "Create" do |ctx, model:, **|
+      render json: {or: model}
+    end.Or do |ctx, model:, endpoint_ctx:, **|
+      render json: model, status: 422
     end
   end
 end

data/test/rails-app/app/models/song.rb

@@ -0,0 +1,3 @@
+class Song < Struct.new(:id)
+
+end

data/test/rails-app/app/models/user.rb

@@ -0,0 +1,5 @@
+class User < Struct.new(:id, :email)
+  def self.find_by(id:)
+    return User.new(id, "yogi@trb.to") if id.to_s == "1"
+  end
+end

data/test/rails-app/bin/bundle

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||=
+      env_var_version || cli_arg_version ||
+        lockfile_version
+  end
+
+  def bundler_requirement
+    return "#{Gem::Requirement.default}.a" unless bundler_version
+
+    bundler_gem_version = Gem::Version.new(bundler_version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.7.0")
+
+    requirement += ".a" if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/test/rails-app/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/rails-app/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/rails-app/bin/setup

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to setup or update your development environment automatically.
+  # This script is idempotent, so that you can run it at anytime and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:prepare'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

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

@@ -1,6 +1,20 @@
+require 'uri'
 require_relative 'boot'
 
-require 'rails/all'
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+# require "active_job/railtie"
+require "active_record/railtie"
+# require "active_storage/engine"
+require "action_controller/railtie"
+# require "action_mailer/railtie"
+# require "action_mailbox/engine"
+# require "action_text/engine"
+# require "action_view/railtie"
+# require "action_cable/engine"
+# require "sprockets/railtie"
+require "rails/test_unit/railtie"
 
 # Require the gems listed in Gemfile, including any gems
 # you've limited to :test, :development, or :production.
@@ -8,8 +22,17 @@ Bundler.require(*Rails.groups)
 
 module RailsApp
   class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 6.0
+
     # Settings in config/environments/* take precedence over those specified here.
-    # Application configuration should go into files in config/initializers
-    # -- all .rb files in that directory are automatically loaded.
+    # Application configuration can go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded after loading
+    # the framework and any gems in your application.
+
+    # Only loads a smaller set of middleware suitable for API only apps.
+    # Middleware like session, flash, cookies can be added back manually.
+    # Skip views, helpers and assets when generating a new resource.
+    config.api_only = true
   end
 end