decko 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2c0b62be6973d42ca0313378dbbc42161349f30
-  data.tar.gz: 065f3de25caebaa321a6170cdae58a7471456cb5
+  metadata.gz: aeacf2fbbf0981f2cee104c70ae92aa444ebaac7
+  data.tar.gz: f1eb236d57cf919828baeea2ee765b96a7d42fa1
 SHA512:
-  metadata.gz: 75874b945a5c272db5bbbce646ecd8f866a80bb9dad9933caaaefcc6204b177288929e7166eca04339fae2a7b3c37f20cb47411f322607ba8cc4950039c3ed8f
-  data.tar.gz: 20fd9ae8f95b4583d10f57fc3c6621d7d955daa4ea09ef977076e10e4feef9560db96bf20a9ed2e89db1a8c0893095855de96ab9364b50d89a9f1ef002dace22
+  metadata.gz: d877cc738c99466edc35464b075ea017bfe1fe48d2c322767c190ae2a61627c17cb59fcf0f9d91d20e784f809ccbc7e804ab0c2757450711c5b94f13082c853d
+  data.tar.gz: db58b0aecd2e3f1a9a59b714ff2925ade4bc3b64218fad93185f4df246cf0850be88dd13b2056787ba9087a226eb3e9ecba8fcba25fa5fb00b8579b0a712eda3

data/lib/decko/response.rb

@@ -2,7 +2,22 @@ module Decko
   # methods for managing decko responses
   module Response
     private
-    def card_redirect url
+    def respond format, result, status
+      if status == 302
+        hard_redirect result
+      elsif format.is_a?(Card::Format::FileFormat) && status == 200
+        send_file(*result)
+      else
+        render_response result.to_s.html_safe, status, format.mime_type
+      end
+    end
+
+    def render_response body, status, content_type
+      render body: body, status: status, content_type: content_type
+    end
+
+    # return a redirect response
+    def hard_redirect url
       url = card_url url # make sure we have absolute url
       if Card::Env.ajax?
         # lets client reset window location
@@ -14,93 +29,101 @@ module Decko
       end
     end
 
-    def deliver format, result, status
-      if status == 302
-        card_redirect result
-      elsif format.is_a?(Card::Format::FileFormat) && status == 200
-        send_file(*result)
-      else
-        render body: result.to_s.html_safe,
-               status: status,
-               content_type: format.mime_type
-      end
+    # return a standard GET response directly.
+    # Used in AJAX situations where PRG pattern is unwieldy
+    def soft_redirect success
+      @card = success.target
+      require_card_for_soft_redirect!
+      self.params = Card::Env[:params] = soft_redirect_params
+      load_action
+      show
     end
 
-    def reset_card new_card
-      @card = new_card
-      update_params_for_success
-      @card.select_action_by_params params
+    def soft_redirect_params
+      new_params = params.clone
+      new_params.delete :card
+      new_params.delete :action
+      new_params.merge Card::Env.success.params
     end
 
-    def update_params_for_success
-      success = Card::Env.success
-      Card::Env[:params] =
-        self.params =
-          success.soft_redirect? ? success.params : params.merge(success.params)
+    def require_card_for_soft_redirect!
+      return if card.is_a? Card
+      raise Card::Error, "tried to do soft redirect without a card"
     end
 
+    # (obviously) deprecated
     def send_deprecated_asset
-      filename = [params[:filename], params[:format]].join(".")
+      filename = [params[:mark], params[:format]].join(".")
       # for security, block relative paths
       raise Card::Error::BadAddress if filename.include? "../"
       path = Decko::Engine.paths["gem-assets"].existent.first
       send_file File.join(path, filename), x_sendfile: true
     end
 
-    def format_from_params card
+    # TODO: everything below should go in a separate file
+    # below is about beginning (initialization).  above is about end (response)
+    # Both this file and that would make sense as submodules of CardController
+
+    def load_format
+      request.format = :html if Card::Env.ajax? && !params[:format]
       card.format format_name_from_params
     end
 
     def format_name_from_params
-      return :file if params[:explicit_file]
-      format = request.format
-      # format = request.parameters[:format]
-      # unknown format
-      return :file unless Card::Format.registered.member?(format)
-      format.to_sym
-    end
-
-    def interpret_id id
-      case id
-      when "*previous" then
-        return card_redirect(Card::Env.previous_location)
-      when nil then
-        determine_id
+      explicit_file_format? ? :file : request.format.to_sym
+    end
+
+    def explicit_file_format?
+      params[:explicit_file] || !Card::Format.registered.member?(request.format)
+    end
+
+    def interpret_mark mark
+      case mark
+      when "*previous"
+        # Why support this? It's only needed in Success, right? Deprecate?
+        return hard_redirect(Card::Env.previous_location)
+      when nil
+        implicit_mark
       else
-        validate_id_encoding id
+        explicit_mark mark
       end
     end
 
-    def determine_id
+    def explicit_mark mark
+      # we should find the place where we produce these bad urls
+      mark.valid_encoding? ? mark : mark.force_encoding("ISO-8859-1").encode("UTF-8")
+    end
+
+    def implicit_mark
       case
-      when prompt_setup?
-        prepare_setup_card!
-      when params[:card] && params[:card][:name]
-        params[:card][:name]
-      when Card::Format.tagged(params[:view], :unknown_ok)
-        ""
-      else
-        Card.global_setting(:home) || "Home"
+      when initial_setup                    then ""
+      when (name = params.dig :card, :name) then name
+      when view_does_not_require_name?      then ""
+      else                                       home_mark
       end
     end
 
-    def prompt_setup?
-      Card::Auth.needs_setup? && Card::Env.html?
+    def home_mark
+      Card.global_setting(:home) || "Home"
     end
 
-    def prepare_setup_card!
-      params[:card] = { type_id: Card.default_accounted_type_id }
-      params[:view] = "setup"
-      ""
+    def view_does_not_require_name?
+      Card::Format.tagged params[:view], :unknown_ok
     end
 
-    def validate_id_encoding id
-      # we should find the place where we produce these bad urls
-      id.valid_encoding? ? id : id.force_encoding("ISO-8859-1").encode("UTF-8")
+    # alters params
+    def initial_setup
+      return unless initial_setup?
+      prepare_setup_card!
+    end
+
+    def initial_setup?
+      Card::Auth.needs_setup? && Card::Env.html?
     end
 
-    def use_draft?
-      params[:edit_draft] && card.drafts.present?
+    def prepare_setup_card!
+      params[:card] = { type_id: Card.default_accounted_type_id }
+      params[:view] = "setup"
     end
   end
 end

data/lib/decko/rest_spec_helper.rb

@@ -0,0 +1,22 @@
+# -*- encoding : utf-8 -*-
+
+module Decko
+  # for use in REST API specs
+  module RestSpecMethods
+    def with_token_for usermark
+      yield Card[usermark].account.reset_token
+    end
+  end
+
+  # for use in REST API specs
+  module RestSpecHelper
+    def self.describe_api &block
+      RSpec.describe CardController, type: :controller do
+        routes { Decko::Engine.routes }
+        include Capybara::DSL
+        include RestSpecMethods
+        instance_eval(&block)
+      end
+    end
+  end
+end

data/rails/controllers/card_controller.rb

@@ -49,37 +49,43 @@ class CardController < ActionController::Base
 
   before_action :setup, except: [:asset]
   before_action :authenticate, except: [:asset]
-  before_action :load_id, only: [:read]
+  before_action :load_mark, only: [:read]
   before_action :load_card, except: [:asset]
+  before_action :load_action, only: [:read]
   before_action :refresh_card, only: [:create, :update, :delete]
 
   def setup
     Card::Machine.refresh_script_and_style unless params[:explicit_file]
     Card::Cache.renew
     Card::Env.reset controller: self
-    request.format = :html if Card::Env.ajax? && !params[:format]
   end
 
   def authenticate
     Card::Auth.set_current params[:token], params[:current]
   end
 
-  def load_id
-    params[:id] = interpret_id params[:id]
+  def load_mark
+    params[:mark] = interpret_mark params[:mark]
   end
 
   def load_card
-    @card = Card.controller_fetch params
-    raise Card::Error::NotFound unless @card
-    load_action
-    record_as_main
-    card.errors.any? ? render_errors : true
+    handle_errors do
+      @card = Card.controller_fetch params
+      raise Card::Error::NotFound unless card
+      record_as_main
+    end
   end
 
   def load_action
-    @card.select_action_by_params params
+    handle_errors do
+      card.select_action_by_params params
+      if params[:edit_draft] && card.drafts.present?
+        card.content = card.last_draft_content
+      end
+    end
   end
 
+  # TODO: refactor this away this when new layout handling is ready
   def record_as_main
     Card::Env[:main_name] = params[:main] || card&.name || ""
   end
@@ -96,27 +102,27 @@ class CardController < ActionController::Base
     end
   end
 
+  def handle_errors
+    yield
+    card.errors.any? ? render_errors : true
+  end
+
+  # successful create, update, or delete action
   def render_success
-    success = Card::Env.success
-    success.name_context = @card.name
-    if !Card::Env.ajax? || success.hard_redirect?
-      card_redirect success.to_url
-    elsif success.target.is_a? String
-      render plain: success.target
+    success = Card::Env.success.in_context card.name
+    if Card::Env.ajax? && !success.hard_redirect?
+      soft_redirect success
     else
-      reset_card success.target
-      show
+      hard_redirect success.to_url
     end
   end
 
   def show view=nil, status=200
     card.action = :read
-    card.content = card.last_draft_content if use_draft?
-
-    format = format_from_params card
+    format = load_format
     result = render_page format, view
     status = format.error_status || status
-    deliver format, result, status
+    respond format, result, status
   end
 
   def render_page format, view

data/rails/engine-routes.rb

@@ -1,55 +1,49 @@
 # -*- encoding : utf-8 -*-
 
 Decko::Engine.routes.draw do
-  # most common
+  files = Decko::Engine.config.files_web_path
+  file_matchers = { mark: /[^-]+/, explicit_file: true, rev_id: /[^-]+/ }
+
   root "card#read"
-  get "#{Decko::Engine.config.files_web_path}/:id/:rev_id(-:size).:format" =>
-    "card#read", id: /[^-]+/, rev_id: /[^-]+/, explicit_file: true
-  get "#{Decko::Engine.config.files_web_path}/:id(-:size)-:rev_id.:format" =>
-    "card#read", id: /[^-]+/, explicit_file: true  # deprecated
-  get "assets/*filename"      => "card#asset"
-  get "javascripts/*filename" => "card#asset"
-  get "jasmine/*filename"     => "card#asset"
-
-  get "recent(.:format)"      => "card#read", id: ":recent" # obviate by making links use codename
-  #  match ':view:(:id(.:format))'          => 'card#read', via: :get
-  get "(/wagn)/:id(.:format)" => "card#read"  # /wagn is deprecated
-
-  # RESTful
-  post   "/" => "card#create"
-  put    "/" => "card#update"
-  delete "/" => "card#delete"
 
-  match ":id(.:format)" => "card#create", via: :post
-  match ":id(.:format)" => "card#update", via: :put
-  match ":id(.:format)" => "card#delete", via: :delete
+  # explicit file request
+  get({ "#{files}/:mark/:rev_id(-:size).:format" => "card#read" }.merge(file_matchers))
+
+  # DEPRECATED (old file and asset requests)
+  get({ "#{files}/:mark(-:size)-:rev_id.:format" => "card#read" }.merge(file_matchers))
+  %w[assets javascripts jasmine].each do |prefix|
+    get "#{prefix}/*mark" => "card#asset"
+  end
 
-  get ":id/view/:view(.:format)" => "card#read"
+  # Standard GET requests
+  get "(/wagn)/:mark(.:format)" => "card#read"  # /wagn is deprecated
 
-  # ~~~~~~~~~~~~~~~~~~~~~~~~~~
-  # legacy
-  get "new/:type"                  => "card#read",   view: "new"
-  get "card/:view(/:id(.:format))" => "card#read",   view: /new|edit/
+  # Alternate GET requests
+  get "new/:type" => "card#read", view: "new" # common case for card without mark
+  get ":mark/view/:view(.:format)" => "card#read" # simplifies API documentation
+  get "card/:view(/:mark(.:format))" => "card#read", view: /new|edit/ # legacy
 
-  get "account/signin"             => "card#read",   id: ":signin"
-  get "account/signout"            => "card#delete", id: ":signin"
-  get "account/signup"             => "card#read",   view: "new",  card: { type_code: :signup }
-  get "account/invite"             => "card#read",   view: "new",  card: { type_code: :signup }
-  get "account/accept"             => "card#read",   view: "edit", card: { type_code: :signup }
-  # use type_code rather than id because in some cases (eg populating test data) routes must get loaded without loading Card
+  # RESTful (without mark)
+  post   "/" => "card#create"
+  put    "/" => "card#update"
+  patch  "/" => "card#update"
+  delete "/" => "card#delete"
 
-  get "admin/stats"                => "card#read",   id: ":admin"
-  get "admin/:task"                => "card#update", id: ":admin"
-  # ~~~~~~~~~~~~~~~~~~~~~~~~~~
+  # RESTful (with mark)
+  match ":mark(.:format)" => "card#create", via: :post
+  match ":mark(.:format)" => "card#update", via: %i[put patch]
+  match ":mark(.:format)" => "card#delete", via: :delete
 
-  # standard non-RESTful
+  # explicit GET alternatives for transactions
   %w[create read update delete asset].each do |action|
-    get "(card)/#{action}(/:id(.:format))"  => "card", action: action
+    get "(card)/#{action}(/:mark(.:format))"  => "card", action: action
   end
 
-  match "(card)/create(/:id(.:format))" => "card#create", via: [:post, :patch]
-  match "(card)/update(/:id(.:format))" => "card#update", via: [:post, :put, :patch]
-  match "(card)/delete(/:id(.:format))" => "card#delete", via: :delete
-  # other
-  get "*id" => "card#read", view: "bad_address"
+  # for super-explicit over-achievers
+  match "(card)/create(/:mark(.:format))" => "card#create", via: %i[post patch]
+  match "(card)/update(/:mark(.:format))" => "card#update", via: %i[post put patch]
+  match "(card)/delete(/:mark(.:format))" => "card#delete", via: :delete
+
+  # Wildcard for bad addresses
+  get "*mark" => "card#read", view: "bad_address"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decko
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Ethan McCutchen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-23 00:00:00.000000000 Z
+date: 2018-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: card
@@ -19,14 +19,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.96.0
+        version: 1.96.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.96.0
+        version: 1.96.1
 description: a wiki approach to stuctured data, dynamic interaction,  and web design
 email:
 - info@decko.org
@@ -113,6 +113,7 @@ files:
 - lib/decko/generators/decko/templates/spec/spec_helper.rb
 - lib/decko/mods_spec_helper.rb
 - lib/decko/response.rb
+- lib/decko/rest_spec_helper.rb
 - lib/decko/script_decko_loader.rb
 - lib/decko/tasks/alias.rb
 - lib/decko/tasks/cucumber.rake