shaf 1.5.0 → 2.0.0

data/lib/shaf/authenticator/basic_auth.rb

@@ -0,0 +1,25 @@
+module Shaf
+  module Authenticator
+    class BasicAuth < Base
+      scheme 'Basic'
+
+      param :realm
+      param :charset, required: false, values: ["UTF-8"]
+
+      def self.credentials(authorization, _request)
+        return unless authorization
+
+        decoded = String(authorization.unpack("m*").first)
+        return {} if decoded.empty?
+
+        user, password = decoded.split(/:/, 2)
+                                .map { |str| str unless String(str).empty? }
+
+        {
+          user: user,
+          password: password
+        }
+      end
+    end
+  end
+end

data/lib/shaf/authenticator/challenge.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Shaf
+  module Authenticator
+    class Challenge
+      attr_reader :scheme, :parameters, :realm
+
+      def initialize(scheme, **parameters, &block)
+        @scheme = scheme
+        @realm = parameters.delete(:realm)&.to_s
+        @parameters = parameters
+        define_singleton_method(:test, &block)
+      end
+
+      def to_s
+        "#{scheme} #{parameter_string}"
+      end
+
+      def realm?(arg)
+        realm&.to_s == arg&.to_s
+      end
+
+      private
+
+      def parameter_string
+        params = {}
+        params[:realm] = realm if realm
+        params.merge(parameters).map { |k,v| %Q(#{k}="#{v}") }.join(', ')
+      end
+    end
+  end
+end

data/lib/shaf/authenticator/parameter.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Shaf
+  module Authenticator
+    class Parameter
+      attr_reader :name, :default, :values
+
+      def initialize(name, required: true, default: nil, values: nil)
+        @name = name
+        @required = required
+        @default = default
+        @values = values&.map(&:downcase)
+      end
+
+      def required?
+        @required
+      end
+
+      def optional?
+        !required?
+      end
+
+      def valid?(value)
+        return optional? if value.nil?
+        return true unless values
+
+        values.include?(value.downcase)
+      end
+    end
+  end
+end

data/lib/shaf/authenticator/request.rb

@@ -0,0 +1,17 @@
+require 'rack/auth/abstract/request'
+
+module Shaf
+  module Authenticator
+    class Request < Rack::Auth::AbstractRequest
+      attr_reader :env
+
+      def valid?
+        !String(authorization).strip.empty?
+      end
+
+      def authorization
+        env[authorization_key]
+      end
+    end
+  end
+end

data/lib/shaf/command/console.rb

@@ -4,7 +4,7 @@ module Shaf
   module Command
     class Console < Base
 
-      identifier %r(\Ac(onsole)?\Z)
+      identifier %r(\Ac(\b|onsole)\Z)
       usage 'console'
 
       def call

data/lib/shaf/command/generate.rb

@@ -1,10 +1,11 @@
+require 'file_transactions'
 require 'shaf/generator'
 
 module Shaf
   module Command
     class Generate < Base
 
-      identifier %r(\Ag(en(erate)?)?\Z)
+      identifier %r(\Ag(\b|en(\b|erate))\Z)
       usage Generator::Factory.usage.flatten.sort
 
       def self.options(parser, options)
@@ -19,7 +20,9 @@ module Shaf
 
       def call
         in_project_root do
-          Generator::Factory.create(*args, **options).call
+          FileTransactions.transaction do
+            Generator::Factory.create(*args, **options).call
+          end
         end
       rescue StandardError => e
         raise Command::ArgumentError, e.message

data/lib/shaf/command/new.rb

@@ -10,21 +10,26 @@ module Shaf
       usage 'new PROJECT_NAME'
 
       def call
-        @project_name = args.first
-        if @project_name.nil? || @project_name.empty?
+        self.project_name = args.first
+        if project_name.nil? || project_name.empty?
           raise ArgumentError,
             "Please provide a project name when using command 'new'!"
         end
 
-        create_dir @project_name
-        Dir.chdir(@project_name) do
+        create_dir project_name
+        Dir.chdir(project_name) do
           copy_templates
           create_gemfile
+          create_settings_file
           write_shaf_version
           create_ruby_version_file
         end
       end
 
+      private
+
+      attr_accessor :project_name
+
       def create_dir(name)
         return if Dir.exist? name
         FileUtils.mkdir_p(name)
@@ -38,9 +43,17 @@ module Shaf
         File.write "Gemfile", erb(content)
       end
 
-      def erb(content)
-        return ERB.new(content, 0, '%-<>').result if RUBY_VERSION < "2.6.0"
-        ERB.new(content, trim_mode: '-<>').result
+      def create_settings_file
+        settings_file = 'config/settings.yml'
+        template_file = File.expand_path("../templates/#{settings_file}.erb", __FILE__)
+        content = File.read(template_file)
+        File.write settings_file,
+                   erb(content, project_name: project_name.capitalize)
+      end
+
+      def erb(content, locals = {})
+        return ERB.new(content, 0, '%-<>').result_with_hash(locals) if RUBY_VERSION < "2.6.0"
+        ERB.new(content, trim_mode: '-<>').result_with_hash(locals)
       end
 
       def copy_templates

data/lib/shaf/command/templates/Gemfile.erb

@@ -11,6 +11,7 @@ gem 'sinatra-sequel'
 gem 'bcrypt'
 gem 'hal_presenter'
 gem 'redcarpet'
+gem 'yard'
 
 group :production, :development do
   gem 'pg'

data/{templates/config/settings.yml → lib/shaf/command/templates/config/settings.yml.erb}

@@ -1,5 +1,6 @@
 ---
 default: &default
+  project_name: <%= project_name %>
   public_folder: frontend/assets
   views_folder: frontend/views
   documents_dir: doc/api
@@ -12,11 +13,6 @@ default: &default
   hostname: localhost
   protocol: http
   port: 3000
-  auth_token_header: X-Auth-Token
-  form_profile_name: shaf-form
-  form_profile_uri: https://gist.githubusercontent.com/sammyhenningsson/39c8aafeaf60192b082762cbf3e08d57/raw/shaf-form.md
-  error_profile_name: shaf-error
-  error_profile_uri: https://gist.githubusercontent.com/sammyhenningsson/049d10e2b8978059cde104fc5d6c2d52/raw/shaf-error.md
 
 production:
   <<: *default

data/lib/shaf/errors.rb

@@ -64,6 +64,17 @@ module Shaf
       end
     end
 
+    class NotAcceptableError < ServerError
+      def http_status
+        406
+      end
+
+      def initialize(msg = nil)
+        msg ||= 'Resource found, but a suitable representation could not be generated'
+        super(msg, code: 'NOT_ACCEPTABLE', title: 'Content negotiation failed')
+      end
+    end
+
     class ConflictError < ServerError
       def http_status
         409

data/lib/shaf/extensions.rb

@@ -1,9 +1,9 @@
 require 'shaf/extensions/log'
 require 'shaf/extensions/resource_uris'
 require 'shaf/extensions/controller_hooks'
-require 'shaf/extensions/current_user'
 require 'shaf/extensions/authorize'
 require 'shaf/extensions/symbolic_routes'
+require 'shaf/extensions/api_routes'
 
 module Shaf
   def self.extensions
@@ -11,9 +11,9 @@ module Shaf
       Log,
       ResourceUris,
       ControllerHooks,
-      CurrentUser,
       Authorize,
-      SymbolicRoutes
+      SymbolicRoutes,
+      ApiRoutes # This extension must be registered after `SymbolicRoutes`!
     ]
   end
 end

data/lib/shaf/extensions/api_routes.rb

@@ -0,0 +1,60 @@
+require 'set'
+
+module Shaf
+  module ApiRoutes
+    class Registry
+      class << self
+        def register(controller, method, symbol)
+          routes[controller][symbol] << method.to_s.upcase
+        end
+
+        def controllers
+          routes.keys.sort_by(&:to_s)
+        end
+
+        def routes_for(controller)
+          sorted = routes[controller].keys.sort_by(&:to_s)
+          sorted.each do |symbol|
+            yield route_info(controller, symbol)
+          end
+        end
+
+        private
+
+        def routes
+          @routes ||= Hash.new do |hash, key|
+            # Group routes with conditionals together (`Set.new`). Like:
+            # get(:foobar_path, agent: /ios/) { "ios specific" }
+            # get(:foobar_path, agent: /android/) { "android specific" }
+            hash[key] = Hash.new { |h, k| h[k] = Set.new }
+          end
+        end
+
+        def route_info(controller, symbol)
+          methods = routes[controller][symbol].to_a
+          template_method = :"#{symbol}_template"
+
+          if controller.respond_to? template_method
+            template = controller.public_send(template_method)
+          else
+            template = symbol
+            symbol = '-'
+          end
+
+          [methods, template, symbol]
+        end
+      end
+    end
+
+    Shaf::SUPPORTED_HTTP_METHODS.each do |method|
+      define_method method do |path, **options, &block|
+        path_str = path.to_s
+        path_str.sub!(/_uri/, '_path')
+        path_str = "#{path_str}_path" unless path_str.end_with? '_path'
+        path_str.sub!(/_path/, '_collection_path') if options[:collection]
+        Registry.register(self, method, path_str.to_sym)
+        super(path, **options, &block)
+      end
+    end
+  end
+end

data/lib/shaf/extensions/authorize.rb

@@ -8,22 +8,25 @@ module Shaf
 
     attr_reader :policy_class
 
-    def authorize_with(policy_class)
-      @policy_class = policy_class
-    end
-
     def self.registered(app)
       app.helpers Helpers
     end
+
+    def authorize_with(policy_class)
+      @policy_class = policy_class
+    end
   end
 
   module Helpers
     def authorize(action, resource = nil)
-      policy(resource) or raise Authorize::NoPolicyError
+      policy = policy(resource)
+      raise Authorize::NoPolicyError unless policy
+
       method = __method_for(action)
-      return @policy.public_send(method) if @policy.respond_to? method
+      return policy.public_send(method) if policy.respond_to? method
+
       raise Authorize::MissingPolicyAction,
-        "#{@policy.class} does not implement method #{method}"
+        "#{policy.class} does not implement method #{method}"
     end
 
     def authorize!(action, resource = nil)
@@ -33,9 +36,8 @@ module Shaf
     private
 
     def policy(resource)
-      return @policy if defined?(@policy) && @policy
       user = current_user if respond_to? :current_user
-      @policy = self.class.policy_class&.new(user, resource)
+      self.class.policy_class&.new(user, resource)
     end
 
     def __method_for(action)

data/lib/shaf/extensions/log.rb

@@ -7,7 +7,7 @@ module Shaf
     end
 
     def log
-      $logger ||= Logger.new('/dev/nul')
+      Shaf.log
     end
   end
 

data/lib/shaf/extensions/resource_uris.rb

@@ -11,15 +11,25 @@ module Shaf
       end
     end
 
+    class << self
+      def resource_uris_for(name, **kwargs)
+        CreateUriMethods.new(name, **kwargs).call
+      end
+
+      def register_uri(name, uri)
+        MethodBuilder.new(name, uri).call
+      end
+    end
+
     def resource_uris_for(name, **kwargs)
-      result = CreateUriMethods.new(name, **kwargs).call
+      result = ResourceUris.resource_uris_for(name, **kwargs)
       UriHelperMethods.add_path_helpers(self, result)
 
       include UriHelper unless self < UriHelper
     end
 
     def register_uri(name, uri)
-      result = MethodBuilder.new(name, uri).call
+      result = ResourceUris.register_uri(name, uri)
       UriHelperMethods.add_path_helpers(self, result)
 
       include UriHelper unless self < UriHelper
@@ -39,23 +49,23 @@ module Shaf
       end
 
       def add_path_helpers(clazz, methods)
-        @path_helpers ||= {}
-        @path_helpers[clazz] ||= []
-        @path_helpers[clazz].concat Array(methods)
+        path_helpers[clazz].concat Array(methods)
       end
 
       def path_helpers_for(clazz = nil)
-        @path_helpers ||= {}
-        return @path_helpers unless clazz
-        return [] unless @path_helpers.key?(clazz)
-        @path_helpers[clazz] ||= []
+        return path_helpers unless clazz
+        path_helpers[clazz]
+      end
+
+      def path_helpers
+        @path_helpers ||= Hash.new { |hash, key| hash[key] = [] }
       end
 
       # For cleaning up after tests
       def remove_all
         helpers = instance_methods - [:path_helpers]
         remove_method(*helpers)
-        @path_helpers = {}
+        @path_helpers = Hash.new { |hash, key| hash[key] = [] }
       end
     end
 
@@ -107,11 +117,15 @@ module Shaf
 
     def call
       if plural_name == name
+        # Deprecated code path
+        # Remove this branch and only keep the `else` behavior when dropping
+        # support for this
         register_resource_helper_by_arg
       else
         register_collection_helper
         register_resource_helper
       end
+
       register_new_resource_helper
       register_edit_resource_helper
       @added_path_methods
@@ -125,7 +139,9 @@ module Shaf
       return if skip? :collection
 
       template_uri = "#{base}/#{plural_name}".freeze
-      register(plural_name, template_uri)
+      method_name = plural_name
+      method_name = "#{name}_collection" if name == @plural_name
+      register(method_name, template_uri)
     end
 
     def register_resource_helper
@@ -140,7 +156,8 @@ module Shaf
     # as argument and the resources uri when no arguments are provided.
     def register_resource_helper_by_arg
       return register_resource_helper if skip? :collection
-      return register_collection_helper if skip? :new
+      register_collection_helper
+      return if skip? :new
 
       resource_template_uri =   "#{base}/#{plural_name}/:id"
       collection_template_uri = "#{base}/#{plural_name}"
@@ -180,24 +197,33 @@ module Shaf
   end
 
   class MethodBuilder
+    NO_GIVEN_VALUE = Object.new
+
     def self.query_string(query)
-      return "" unless query.any?
-      "?#{query.map { |key,value| "#{key}=#{value}" }.join("&")}"
+      return '' unless query&.any?
+
+      fragment_id = query.delete(:fragment_id)
+      fragment_str = "##{fragment_id}" if fragment_id
+
+      query_str = query.map { |a| a.join('=') }.join('&')
+      query_str = "?#{query_str}" unless query_str.empty?
+
+      [query_str, fragment_str].join
     end
 
     def initialize(name, uri, alt_uri: nil)
       @name = name
-      @uri = uri
-      @alt_uri = alt_uri
+      @uri = uri.dup.freeze
+      @alt_uri = alt_uri.dup.freeze
     end
 
     def call
       if UriHelper.respond_to? uri_method_name
         exception = ResourceUris::UriHelperMethodAlreadyExistError
-        raise exception.new(@name, uri_method_name)
+        raise exception.new(name, uri_method_name)
       end
 
-      if @alt_uri.nil?
+      if alt_uri.nil?
         build_methods
       else
         build_methods_with_optional_arg
@@ -206,6 +232,8 @@ module Shaf
 
     private
 
+    attr_reader :name, :uri, :alt_uri
+
     def build_methods
       UriHelperMethods.eval_method uri_method_string
       UriHelperMethods.eval_method path_method_string
@@ -225,11 +253,11 @@ module Shaf
     end
 
     def uri_method_name
-      "#{@name}_uri".freeze
+      "#{name}_uri".freeze
     end
 
     def path_method_name
-      "#{@name}_path".freeze
+      "#{name}_path".freeze
     end
 
     def path_matcher_name
@@ -244,81 +272,92 @@ module Shaf
       "#{uri_method_name}_template".freeze
     end
 
-    def uri_signature(optional_args: 0)
-      signature(uri_method_name, optional_args: optional_args)
+    def uri_signature(uri: @uri, optional_args: 0)
+      signature(uri_method_name, uri, optional_args: optional_args)
     end
 
-    def path_signature(optional_args: 0)
-      signature(path_method_name, optional_args: optional_args)
+    def path_signature(uri: @uri, optional_args: 0)
+      signature(path_method_name, uri, optional_args: optional_args)
     end
 
-    def signature(method_name, optional_args: 0)
-      s = "#{method_name}("
+    def signature(method_name, uri, optional_args: 0)
+      args = extract_symbols(uri).size.times.map { |i| "arg#{i}" }
+      sym_count = args.size
 
-      symbols = extract_symbols.size.times.map { |i| "arg#{i}" }
-      sym_count = symbols.size
+      optional_args.times { |i| args << "arg#{sym_count + i} = nil" }
+      args << '**query'
 
-      args = []
-      symbols.each_with_index do |arg, i|
-        if i < sym_count - optional_args
-          args << "arg#{i}"
-        else
-          args << "arg#{i} = nil"
-        end
-      end
-      s << (args.empty? ? "**query)" : "#{args.join(', ')}, **query)")
+      "#{method_name}(#{args.join(', ')})"
     end
 
     def uri_method_string
       base_uri = UriHelper.base_uri
-      <<~Ruby
+      <<~RUBY
         def #{uri_signature}
           query_str = Shaf::MethodBuilder.query_string(query)
-          \"#{base_uri}#{interpolated_uri_string(@uri)}\#{query_str}\".freeze
+          \"#{base_uri}#{interpolated_uri_string(uri)}\#{query_str}\".freeze
         end
-      Ruby
+      RUBY
     end
 
     def path_method_string
-      <<~Ruby
+      <<~RUBY
         def #{path_signature}
           query_str = Shaf::MethodBuilder.query_string(query)
-          \"#{interpolated_uri_string(@uri)}\#{query_str}\".freeze
+          \"#{interpolated_uri_string(uri)}\#{query_str}\".freeze
         end
-      Ruby
+      RUBY
     end
 
     def uri_method_with_optional_arg_string
       base_uri = UriHelper.base_uri
-      arg_no = extract_symbols.size - 1
-      <<~Ruby
-        def #{uri_signature(optional_args: 1)}
+      arg_no = extract_symbols(alt_uri).size
+      <<~RUBY
+        def #{uri_signature(uri: alt_uri, optional_args: 1)}
           query_str = Shaf::MethodBuilder.query_string(query)
           if arg#{arg_no}.nil?
-            \"#{base_uri}#{interpolated_uri_string(@alt_uri)}\#{query_str}\".freeze
+            warn <<~DEPRECATION
+
+              Deprecated use of collection uri helper:
+              To get the collection uri use ##{name}_collection_uri instead of ##{uri_method_name}.
+              Or pass an argument to ##{uri_method_name} to get the uri to a resource.
+                \#{caller.find { |s| !s.match? %r{lib/shaf/extensions/resource_uris.rb} }}
+
+            DEPRECATION
+
+            \"#{base_uri}#{interpolated_uri_string(alt_uri)}\#{query_str}\".freeze
           else
-            \"#{base_uri}#{interpolated_uri_string(@uri)}\#{query_str}\".freeze
+            \"#{base_uri}#{interpolated_uri_string(uri)}\#{query_str}\".freeze
           end
         end
-      Ruby
+      RUBY
     end
 
     def path_method_with_optional_arg_string
-      arg_no = extract_symbols.size - 1
-      <<~Ruby
-        def #{path_signature(optional_args: 1)}
+      arg_no = extract_symbols(alt_uri).size
+      <<~RUBY
+        def #{path_signature(uri: alt_uri, optional_args: 1)}
           query_str = Shaf::MethodBuilder.query_string(query)
           if arg#{arg_no}.nil?
-            \"#{interpolated_uri_string(@alt_uri)}\#{query_str}\".freeze
+            warn <<~DEPRECATION
+
+              Deprecated use of collection path helper:
+              To get the collection path use ##{name}_collection_path instead of ##{path_method_name}.
+              Or pass an argument to ##{path_method_name} to get the path to a resource.
+                \#{caller.find { |s| !s.match? %r{lib/shaf/extensions} }}
+
+            DEPRECATION
+
+            \"#{interpolated_uri_string(alt_uri)}\#{query_str}\".freeze
           else
-            \"#{interpolated_uri_string(@uri)}\#{query_str}\".freeze
+            \"#{interpolated_uri_string(uri)}\#{query_str}\".freeze
           end
         end
-      Ruby
+      RUBY
     end
 
     def extract_symbols(uri = @uri)
-      uri.split('/').grep(/:.*/).map { |t| t[1..-1].to_sym }
+      uri.split('/').grep(/\A:.+/).map { |t| t[1..-1].to_sym }
     end
 
     def transform_symbols(uri)
@@ -334,8 +373,13 @@ module Shaf
       return uri if uri == '/'
 
       transform_symbols(uri) do |segment, i|
-        sym = segment[1..-1]
-        "\#{arg#{i}.respond_to?(#{segment}) ? arg#{i}.#{sym} : arg#{i}}"
+        # if the uri is templated (starting with a '{'), then we need to
+        # exclude it from the interpolated string but add it back to the end of
+        # the segment.
+        last = (segment.index('{') || 0) - 1
+        sym = segment[1..last]
+        template = segment[(last + 1)..-1] unless last == -1
+        "\#{arg#{i}.respond_to?(:#{sym}) ? arg#{i}.#{sym} : arg#{i}}#{template}"
       end
     end
 
@@ -343,23 +387,55 @@ module Shaf
       uri, alt_uri = @uri, @alt_uri
 
       if alt_uri.nil?
-        ->(_ = nil) { uri.freeze }
+        -> { uri }
       else
-        ->(collection = false) { collection ? alt_uri : uri }
+        deprecated_method = template_method_name
+        replacing_method = "#{name}_collection_path_template"
+
+        lambda do |collection = NO_GIVEN_VALUE|
+          if collection != NO_GIVEN_VALUE
+            warn <<~DEPRECATION
+
+              Deprecated use of uri template helper with `collection` argument:
+              Use #{replacing_method} instead of #{deprecated_method}"
+                #{caller.find { |s| !s.match? %r{lib/shaf/extensions} }}
+
+            DEPRECATION
+          else
+            collection = false
+          end
+
+          collection ? alt_uri : uri
+        end
       end
     end
 
     def path_mather_patterns
       [
-        @uri.gsub(%r{:[^/]*}, '\w+'),
-        @alt_uri&.gsub(%r{:[^/]*}, '\w+')
+        uri.gsub(%r{:[^/]*}, '\w+'),
+        alt_uri&.gsub(%r{:[^/]*}, '\w+')
       ].compact.map { |str| Regexp.new("\\A#{str}\\Z") }
     end
 
     def path_matcher_proc
       patterns = path_mather_patterns
 
-      lambda do |path = nil, collection: false|
+      deprecated_method = path_matcher_name
+      replacing_method = "#{name}_collection_path?"
+
+      lambda do |path = nil, collection: NO_GIVEN_VALUE|
+        if collection != NO_GIVEN_VALUE
+          warn <<~DEPRECATION
+
+            Deprecated use of uri predicate helper with `collection` argument:
+            Use #{replacing_method} instead of #{deprecated_method}(collection: true)
+              #{caller.find { |s| !s.match? %r{lib/shaf/extensions} }}
+
+          DEPRECATION
+        else
+          collection = false
+        end
+
         unless path
           r = request if respond_to? :request
           path = r.path_info if r&.respond_to? :path_info