lotus-controller 0.0.0 → 0.1.0

data/test/action/callbacks_test.rb

@@ -0,0 +1,99 @@
+require 'test_helper'
+
+describe Lotus::Action do
+  describe '#before' do
+    it 'invokes the method(s) from the given symbol(s) before the action is run' do
+      action = BeforeMethodAction.new
+      action.call({})
+
+      action.article.must_equal 'Bonjour!'.reverse
+    end
+
+    it 'invokes the given block before the action is run' do
+      action = BeforeBlockAction.new
+      action.call({})
+
+      action.article.must_equal 'Good morning!'.reverse
+    end
+
+    it 'inherits callbacks from superclass' do
+      action = SubclassBeforeMethodAction.new
+      action.call({})
+
+      action.article.must_equal 'Bonjour!'.reverse.upcase
+    end
+
+    it 'can optionally have params in method signature' do
+      action = ParamsBeforeMethodAction.new
+      action.call(params = {bang: '!'})
+
+      action.article.must_equal 'Bonjour!!'.reverse
+      action.exposed_params.must_equal(params)
+    end
+
+    it 'yields params when the callback is a block' do
+      action   = YieldBeforeBlockAction.new
+      response = action.call(params = { twentythree: '23' })
+
+      response[0].must_equal 200
+      action.yielded_params.must_equal params
+    end
+
+    describe 'on error' do
+      it 'stops the callbacks execution and returns an HTTP 500 status' do
+        action   = ErrorBeforeMethodAction.new
+        response = action.call({})
+
+        response[0].must_equal 500
+        action.article.must_be_nil
+      end
+    end
+  end
+
+  describe '#after' do
+    it 'invokes the method(s) from the given symbol(s) after the action is run' do
+      action = AfterMethodAction.new
+      action.call({})
+
+      action.egg.must_equal 'gE!g'
+    end
+
+    it 'invokes the given block after the action is run' do
+      action = AfterBlockAction.new
+      action.call({})
+
+      action.egg.must_equal 'Coque'.reverse
+    end
+
+    it 'inherits callbacks from superclass' do
+      action = SubclassAfterMethodAction.new
+      action.call({})
+
+      action.egg.must_equal 'gE!g'.upcase
+    end
+
+    it 'can optionally have params in method signature' do
+      action = ParamsAfterMethodAction.new
+      action.call(question: '?')
+
+      action.egg.must_equal 'gE!g?'
+    end
+
+    it 'yields params when the callback is a block' do
+      action = YieldAfterBlockAction.new
+      action.call(params = { fortytwo: '42' })
+
+      action.meaning_of_life_params.must_equal params
+    end
+
+    describe 'on error' do
+      it 'stops the callbacks execution and returns an HTTP 500 status' do
+        action   = ErrorAfterMethodAction.new
+        response = action.call({})
+
+        response[0].must_equal 500
+        action.egg.must_be_nil
+      end
+    end
+  end
+end

data/test/action/params_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+require 'rack'
+
+describe Lotus::Action::Params do
+  it 'accepts params from "router.params"' do
+    action   = ParamsAction.new
+    response = action.call({ 'router.params' => {id: '23'} })
+
+    response[2].must_equal ["{:id=>\"23\"}"]
+  end
+
+  it 'accepts params as they are, for testing purposes' do
+    action   = ParamsAction.new
+    response = action.call({id: '23'})
+
+    response[2].must_equal ["{:id=>\"23\"}"]
+  end
+
+  it 'accepts params from "rack.input" as request body' do
+    response = Rack::MockRequest.new(ParamsAction.new).request('PATCH', "?id=23", params: { x: { foo: 'bar' } })
+    response.body.must_match "{:id=>\"23\", :x=>{:foo=>\"bar\"}}"
+  end
+
+  it 'is frozen' do
+    params  = Lotus::Action::Params.new({id: '23'})
+
+    -> { params.delete(:id) }.must_raise(RuntimeError)
+  end
+end

data/test/action_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+
+describe Lotus::Action do
+  describe '#call' do
+    it 'calls an action' do
+      response = CallAction.new.call({})
+
+      response[0].must_equal 201
+      response[1].must_equal({'Content-Type' => 'application/octet-stream', 'X-Custom' => 'OK'})
+      response[2].must_equal ['Hi from TestAction!']
+    end
+
+    it 'returns an HTTP 500 status code when an exception is raised' do
+      response = ErrorCallAction.new.call({})
+
+      response[0].must_equal 500
+      response[2].must_equal ['Internal Server Error']
+    end
+  end
+
+  describe '#expose' do
+    it 'creates a getter for the given ivar' do
+      action = ExposeAction.new
+
+      response = action.call({})
+      response[0].must_equal 200
+
+      action.exposures.must_equal({ film: '400 ASA', time: nil })
+    end
+  end
+end

data/test/controller_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+describe Lotus::Controller do
+  describe '.action' do
+    it 'creates an action for the given name' do
+      action = TestController::Index.new
+      action.call({name: 'test'})
+      action.xyz.must_equal 'test'
+    end
+
+    it "raises an error when the given name isn't a valid Ruby identifier" do
+      -> {
+        class Controller
+          include Lotus::Controller
+
+          action 12 do
+            def call(params)
+            end
+          end
+        end
+      }.must_raise TypeError
+    end
+  end
+end

data/test/cookies_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+describe Lotus::Action do
+  describe 'cookies' do
+    it 'gets cookies' do
+      action   = GetCookiesAction.new
+      response = action.call({'HTTP_COOKIE' => 'foo=bar'})
+
+      action.send(:cookies).must_equal({foo: 'bar'})
+      response[1].must_equal({'Content-Type' => 'application/octet-stream', 'Set-Cookie' => 'foo=bar'})
+    end
+
+    it 'sets cookies' do
+      action   = SetCookiesAction.new
+      response = action.call({})
+
+      response[2].must_equal(['yo'])
+      response[1].must_equal({'Content-Type' => 'application/octet-stream', 'Set-Cookie' => 'foo=yum%21'})
+    end
+
+    it 'sets cookies with options' do
+      tomorrow = Time.now + 60 * 60 * 24
+      action   = SetCookiesWithOptionsAction.new
+      response = action.call({expires: tomorrow})
+
+      response[1].must_equal({'Content-Type' => 'application/octet-stream', 'Set-Cookie' => "kukki=yum%21; domain=lotusrb.org; path=/controller; expires=#{ tomorrow.gmtime.rfc2822 }; secure; HttpOnly"})
+    end
+
+    it 'removes cookies' do
+      action   = RemoveCookiesAction.new
+      response = action.call({'HTTP_COOKIE' => 'foo=bar;rm=me'})
+
+      response[1].must_equal({'Content-Type' => 'application/octet-stream', 'Set-Cookie' => "foo=bar\nrm=; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 -0000"})
+    end
+  end
+end

data/test/fixtures.rb

@@ -0,0 +1,501 @@
+HTTP_TEST_STATUSES = {
+  100 => 'Continue',
+  101 => 'Switching Protocols',
+  102 => 'Processing (WebDAV) (RFC 2518)',
+  103 => 'Checkpoint',
+  122 => 'Request-URI too long',
+  200 => 'OK',
+  201 => 'Created',
+  202 => 'Accepted',
+  203 => 'Non-Authoritative Information',
+  204 => 'No Content',
+  205 => 'Reset Content',
+  206 => 'Partial Content',
+  207 => 'Multi-Status (WebDAV) (RFC 4918)',
+  208 => 'Already Reported (WebDAV) (RFC 5842)',
+  226 => 'IM Used (RFC 3229)',
+  300 => 'Multiple Choices',
+  301 => 'Moved Permanently',
+  302 => 'Found',
+  303 => 'See Other',
+  304 => 'Not Modified',
+  305 => 'Use Proxy',
+  306 => 'Switch Proxy',
+  307 => 'Temporary Redirect',
+  308 => 'Resume Incomplete',
+  400 => 'Bad Request',
+  401 => 'Unauthorized',
+  402 => 'Payment Required',
+  403 => 'Forbidden',
+  404 => 'Not Found',
+  405 => 'Method Not Allowed',
+  406 => 'Not Acceptable',
+  407 => 'Proxy Authentication Required',
+  408 => 'Request Timeout',
+  409 => 'Conflict',
+  410 => 'Gone',
+  411 => 'Length Required',
+  412 => 'Precondition Failed',
+  413 => 'Request Entity Too Large',
+  414 => 'Request-URI Too Long',
+  415 => 'Unsupported Media Type',
+  416 => 'Requested Range Not Satisfiable',
+  417 => 'Expectation Failed',
+  418 => 'I\'m a teapot (RFC 2324)',
+  420 => 'Enhance Your Calm',
+  422 => 'Unprocessable Entity (WebDAV) (RFC 4918)',
+  423 => 'Locked (WebDAV) (RFC 4918)',
+  424 => 'Failed Dependency (WebDAV) (RFC 4918)',
+  426 => 'Upgrade Required (RFC 2817)',
+  428 => 'Precondition Required',
+  429 => 'Too Many Requests',
+  431 => 'Request Header Fields Too Large',
+  444 => 'No Response',
+  449 => 'Retry With',
+  450 => 'Blocked by Windows Parental Controls',
+  451 => 'Wrong Exchange server',
+  499 => 'Client Closed Request',
+  500 => 'Internal Server Error',
+  501 => 'Not Implemented',
+  502 => 'Bad Gateway',
+  503 => 'Service Unavailable',
+  504 => 'Gateway Timeout',
+  505 => 'HTTP Version Not Supported',
+  506 => 'Variant Also Negotiates (RFC 2295)',
+  507 => 'Insufficient Storage (WebDAV) (RFC 4918)',
+  508 => 'Loop Detected (WebDAV) (RFC 5842)',
+  509 => 'Bandwidth Limit Exceeded (Apache bw\/limited extension)',
+  510 => 'Not Extended (RFC 2774)',
+  511 => 'Network Authentication Required',
+  598 => 'Network read timeout error',
+  599 => 'Network connect timeout error'
+}
+
+class TestController
+  include Lotus::Controller
+
+  action 'Index' do
+    expose :xyz
+
+    def call(params)
+      @xyz = params[:name]
+    end
+  end
+end
+
+class CallAction
+  include Lotus::Action
+
+  def call(params)
+    self.status  = 201
+    self.body    = 'Hi from TestAction!'
+    self.headers.merge!({ 'X-Custom' => 'OK' })
+  end
+end
+
+class ErrorCallAction
+  include Lotus::Action
+
+  def call(params)
+    raise
+  end
+end
+
+class ExposeAction
+  include Lotus::Action
+
+  expose :film, :time
+
+  def call(params)
+    @film = '400 ASA'
+  end
+end
+
+class BeforeMethodAction
+  include Lotus::Action
+
+  expose :article
+  before :set_article, :reverse_article
+
+  def call(params)
+  end
+
+  private
+  def set_article
+    @article = 'Bonjour!'
+  end
+
+  def reverse_article
+    @article.reverse!
+  end
+end
+
+class SubclassBeforeMethodAction < BeforeMethodAction
+  before :upcase_article
+
+  private
+  def upcase_article
+    @article.upcase!
+  end
+end
+
+class ParamsBeforeMethodAction < BeforeMethodAction
+  expose :exposed_params
+
+  private
+  def set_article(params)
+    @exposed_params = params
+    @article = super() + params[:bang]
+  end
+end
+
+class ErrorBeforeMethodAction < BeforeMethodAction
+  private
+  def set_article
+    raise
+  end
+end
+
+class BeforeBlockAction
+  include Lotus::Action
+
+  expose :article
+  before { @article = 'Good morning!' }
+  before { @article.reverse! }
+
+  def call(params)
+  end
+end
+
+class YieldBeforeBlockAction < BeforeBlockAction
+  expose :yielded_params
+  before {|params| @yielded_params = params }
+end
+
+class AfterMethodAction
+  include Lotus::Action
+
+  expose :egg
+  after  :set_egg, :scramble_egg
+
+  def call(params)
+  end
+
+  private
+  def set_egg
+    @egg = 'Egg!'
+  end
+
+  def scramble_egg
+    @egg = 'gE!g'
+  end
+end
+
+class SubclassAfterMethodAction < AfterMethodAction
+  after :upcase_egg
+
+  private
+  def upcase_egg
+    @egg.upcase!
+  end
+end
+
+class ParamsAfterMethodAction < AfterMethodAction
+  private
+  def scramble_egg(params)
+    @egg = super() + params[:question]
+  end
+end
+
+class ErrorAfterMethodAction < AfterMethodAction
+  private
+  def set_egg
+    raise
+  end
+end
+
+class AfterBlockAction
+  include Lotus::Action
+
+  expose :egg
+  after { @egg = 'Coque' }
+  after { @egg.reverse! }
+
+  def call(params)
+  end
+end
+
+class YieldAfterBlockAction < AfterBlockAction
+  expose :meaning_of_life_params
+  before {|params| @meaning_of_life_params = params }
+end
+
+class SessionAction
+  include Lotus::Action
+  include Lotus::Action::Session
+
+  def call(params)
+  end
+end
+
+class RedirectAction
+  include Lotus::Action
+
+  def call(params)
+    redirect_to '/destination'
+  end
+end
+
+class StatusRedirectAction
+  include Lotus::Action
+
+  def call(params)
+    redirect_to '/destination', status: 301
+  end
+end
+
+class GetCookiesAction
+  include Lotus::Action
+  include Lotus::Action::Cookies
+
+  def call(params)
+  end
+end
+
+class SetCookiesAction
+  include Lotus::Action
+  include Lotus::Action::Cookies
+
+  def call(params)
+    self.body = 'yo'
+    cookies[:foo] = 'yum!'
+  end
+end
+
+class SetCookiesWithOptionsAction
+  include Lotus::Action
+  include Lotus::Action::Cookies
+
+  def call(params)
+    cookies[:kukki] = { value: 'yum!', domain: 'lotusrb.org', path: '/controller', expires: params[:expires], secure: true, httponly: true }
+  end
+end
+
+class RemoveCookiesAction
+  include Lotus::Action
+  include Lotus::Action::Cookies
+
+  def call(params)
+    cookies[:rm] = nil
+  end
+end
+
+class ThrowCodeAction
+  include Lotus::Action
+
+  def call(params)
+    throw params[:status]
+  end
+end
+
+class ThrowBeforeMethodAction
+  include Lotus::Action
+
+  before :authorize!
+  before :set_body
+
+  def call(params)
+    self.body = 'Hello!'
+  end
+
+  private
+  def authorize!
+    throw 401
+  end
+
+  def set_body
+    self.body = 'Hi!'
+  end
+end
+
+class ThrowBeforeBlockAction
+  include Lotus::Action
+
+  before { throw 401 }
+  before { self.body = 'Hi!' }
+
+  def call(params)
+    self.body = 'Hello!'
+  end
+end
+
+class ThrowAfterMethodAction
+  include Lotus::Action
+
+  after :raise_timeout!
+  after :set_body
+
+  def call(params)
+    self.body = 'Hello!'
+  end
+
+  private
+  def raise_timeout!
+    throw 408
+  end
+
+  def set_body
+    self.body = 'Later!'
+  end
+end
+
+class ThrowAfterBlockAction
+  include Lotus::Action
+
+  after { throw 408 }
+  after { self.body = 'Later!' }
+
+  def call(params)
+    self.body = 'Hello!'
+  end
+end
+
+class RecordNotFound < StandardError
+end
+
+class HandledExceptionAction
+  include Lotus::Action
+  handle_exception RecordNotFound, 404
+
+  def call(params)
+    raise RecordNotFound.new
+  end
+end
+
+class UnhandledExceptionAction
+  include Lotus::Action
+
+  def call(params)
+    raise RecordNotFound.new
+  end
+end
+
+class ParamsAction
+  include Lotus::Action
+
+  def call(params)
+    self.body = params.inspect
+  end
+end
+
+class Root
+  include Lotus::Action
+
+  def call(params)
+    self.body = params.inspect
+    headers.merge!({'X-Test' => 'test'})
+  end
+end
+
+class AboutController
+  include Lotus::Controller
+
+  class Team < Root
+  end
+
+  action 'Contacts' do
+    def call(params)
+      self.body = params.inspect
+    end
+  end
+end
+
+class IdentityController
+  include Lotus::Controller
+
+  class Action
+    include Lotus::Action
+
+    def call(params)
+      self.body = params.inspect
+    end
+  end
+
+  Show    = Class.new(Action)
+  New     = Class.new(Action)
+  Create  = Class.new(Action)
+  Edit    = Class.new(Action)
+  Update  = Class.new(Action)
+  Destroy = Class.new(Action)
+end
+
+class FlowersController
+  include Lotus::Controller
+
+  class Action
+    include Lotus::Action
+
+    def call(params)
+      self.body = params.inspect
+    end
+  end
+
+  Index   = Class.new(Action)
+  Show    = Class.new(Action)
+  New     = Class.new(Action)
+  Create  = Class.new(Action)
+  Edit    = Class.new(Action)
+  Update  = Class.new(Action)
+  Destroy = Class.new(Action)
+end
+
+class DashboardController
+  include Lotus::Controller
+
+  action 'Index' do
+    include Lotus::Action::Session
+    before :authenticate!
+
+    def call(params)
+    end
+
+    private
+    def authenticate!
+      throw 401 unless loggedin?
+    end
+
+    def loggedin?
+      session.has_key?(:user_id)
+    end
+  end
+end
+
+class SessionsController
+  include Lotus::Controller
+
+  action 'Create' do
+    include Lotus::Action::Session
+
+    def call(params)
+      session[:user_id] = 23
+      redirect_to '/'
+    end
+  end
+
+  action 'Destroy' do
+    include Lotus::Action::Session
+
+    def call(params)
+      session[:user_id] = nil
+    end
+  end
+end
+
+class StandaloneSession
+  include Lotus::Action
+  include Lotus::Action::Session
+
+  def call(params)
+    session[:age] = Time.now.year - 1982
+  end
+end