shogun 6.2.1 → 6.2.2

data/scaffold/generate/resource/list/normalizer.rb

@@ -0,0 +1,58 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module List
+      class Normalizer
+        include Shogun::Normalizer
+        include {{resource_module}}
+
+        METADATA = %w|limit filters includes fields|
+        LIST_DELIMITER = /\s*,\s*/
+        DEFAULT_FIELD = "id"
+        AUTOMATIC_FIELDS = %w|id href meta links linked|
+
+        def initialize(raw:)
+          @limit = raw["limit"]
+          @filters = raw["filter"]
+          @includes = raw["include"]
+          @fields = raw["fields"]
+        end
+
+        def limit
+          Integer(@limit) rescue 10
+        end
+
+        def filters
+          if @filters.is_a?(Hash)
+            @filters
+          else
+            Hash.new
+          end
+        end
+
+        def includes
+          case @includes
+          when String
+            @includes.split(LIST_DELIMITER)
+          when Array
+            @includes
+          else
+            Array.new
+          end
+        end
+
+        def fields
+          case
+          when @fields.is_a?(Array)
+            @fields + AUTOMATIC_FIELDS
+          when @fields.is_a?(String) && @fields.match(LIST_DELIMITER)
+            @fields.split(LIST_DELIMITER) + AUTOMATIC_FIELDS
+          when @fields.is_a?(String)
+            [@fields.strip] + AUTOMATIC_FIELDS
+          else
+            [DEFAULT_FIELD]
+          end.uniq
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/list/validator.rb

@@ -0,0 +1,24 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module List
+      class Validator
+        include Shogun::Validator
+        include {{resource_module}}
+
+        INCLUDES_ALLOWED = %w||
+        FIELDS_ALLOWED = %w|id created_at updated_at destroyed_at href meta links linked|
+        FILTERS_ALLOWED = %w|username signature created_at name|
+        LIMIT_RANGE = 1..100
+
+        def initialize(data:)
+          @verifiers = [
+            Shogun::Verifier::Range.new(data: data.limit, name: "limit", range: LIMIT_RANGE),
+            Shogun::Verifier::Allowed.new(data: data.filters.keys, name: "filters", list: FILTERS_ALLOWED),
+            Shogun::Verifier::Allowed.new(data: data.includes, name: "includes", list: INCLUDES_ALLOWED),
+            Shogun::Verifier::Allowed.new(data: data.fields, name: "fields", list: FIELDS_ALLOWED)
+          ]
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/model.rb

@@ -0,0 +1,21 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    class Model < ActiveRecord::Base
+      include {{resource_module}}
+
+      self.table_name = NAMESPACE
+
+      has_many :sessions, class_name: "{{namespace_module}}::Sessions::Model", foreign_key: "{{resource_singular}}_id", dependent: :destroy
+
+      def self.setup!
+        ActiveRecord::Migration.create_table table_name, force: true, id: :uuid do |table|
+          table.string :name, null: false, default: "", index: { unique: true }
+
+          table.datetime :created_at, null: false, index: true
+          table.datetime :updated_at, null: false, index: true
+          table.datetime :destroyed_at, index: true
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/null.rb

@@ -0,0 +1,11 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    class Null
+      attr_reader :attribute
+
+      def initialize
+        @attribute = nil
+      end
+    end
+  end
+end

data/scaffold/generate/resource/presenter.rb

@@ -0,0 +1,24 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    class Presenter
+      include Shogun::Presenter
+      include {{resource_module}}
+
+      def id
+        source.id
+      end
+
+      def created_at
+        source.created_at.to_datetime.rfc3339
+      end
+
+      def updated_at
+        source.updated_at.to_datetime.rfc3339
+      end
+
+      def destroyed_at
+        source.destroyed_at.to_datetime.rfc3339 if source.destroyed_at
+      end
+    end
+  end
+end

data/scaffold/generate/resource/show.rb

@@ -0,0 +1,10 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Show
+      require_relative "show/control"
+      require_relative "show/denormalizer"
+      require_relative "show/normalizer"
+      require_relative "show/validator"
+    end
+  end
+end

data/scaffold/generate/resource/show/authorizer.rb

@@ -0,0 +1,21 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Show
+      class Authorizer
+        include Shogun::Authorizer
+        include {{resource_module}}
+
+        def initialize(requester:, resource:)
+          if requester
+            @requester = requester.account
+          end
+          @resource = resource
+        end
+
+        def allowed?
+          @requester == @resource
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/show/control.rb

@@ -0,0 +1,31 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Show
+      class Control
+        include Shogun::Control
+        include {{resource_module}}
+
+        def initialize(payload:)
+          @normalizer = Normalizer.new(raw: payload.to_hash)
+          @validator = Validator.new(data: @normalizer)
+
+          if @validator.valid?
+            @model = Model.find_by(id: @normalizer.id)
+
+            if @model
+              @presenter = Presenter.new(resource: @model, meta: @normalizer.as_meta)
+              @denormalizer = Denormalizer.new(object: @presenter, fields: @normalizer.fields)
+              @status = OK
+            else
+              @status = NOT_FOUND
+            end
+          else
+            @presenters = Shogun::Presenters.new(resources: @validator.invalids, cast: Errors::Presenter)
+            @denormalizer = Errors::Denormalizer.new(object: @presenters)
+            @status = UNPROCESSABLE_ENTITY
+          end
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/show/denormalizer.rb

@@ -0,0 +1,18 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Show
+      class Denormalizer
+        include Shogun::Denormalizer
+        include {{resource_module}}
+
+        MAPPING = {
+          "id" => "id",
+          "created_at" => "created_at",
+          "destroyed_at" => "destroyed_at",
+          "updated_at" => "updated_at",
+          "href" => "href"
+        }
+      end
+    end
+  end
+end

data/scaffold/generate/resource/show/normalizer.rb

@@ -0,0 +1,37 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Show
+      class Normalizer
+        include Shogun::Normalizer
+        include {{resource_module}}
+
+        METADATA = %w|id fields|
+        LIST_DELIMITER = /\s*,\s*/
+        DEFAULT_FIELDS = %w|id created_at updated_at destroyed_at href|
+        AUTOMATIC_FIELDS = %w|id href|
+
+        def initialize(raw:)
+          @id = raw["id"]
+          @fields = raw["fields"]
+        end
+
+        def id
+          @id
+        end
+
+        def fields
+          case
+          when @fields.is_a?(String) && @fields.match(LIST_DELIMITER)
+            @fields.split(LIST_DELIMITER) + AUTOMATIC_FIELDS
+          when @fields.is_a?(Array)
+            @fields + AUTOMATIC_FIELDS
+          when @fields.is_a?(String)
+            [@fields.strip] + AUTOMATIC_FIELDS
+          else
+            DEFAULT_FIELDS
+          end.uniq
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/show/validator.rb

@@ -0,0 +1,21 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Show
+      class Validator
+        include Shogun::Validator
+        include {{resource_module}}
+
+        ID_MATCH = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
+        FIELDS_ALLOWED = %w|id created_at updated_at destroyed_at href|
+
+        def initialize(data:)
+          @verifiers = [
+            Shogun::Verifier::Presence.new(data: data.id, name: "id"),
+            Shogun::Verifier::Match.new(data: data.id, name: "id", comparison: ID_MATCH),
+            Shogun::Verifier::Allowed.new(data: data.fields, name: "fields", list: FIELDS_ALLOWED)
+          ]
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/update.rb

@@ -0,0 +1,11 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Update
+      require_relative "update/authorizer"
+      require_relative "update/control"
+      require_relative "update/denormalizer"
+      require_relative "update/normalizer"
+      require_relative "update/validator"
+    end
+  end
+end

data/scaffold/generate/resource/update/authorizer.rb

@@ -0,0 +1,21 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Update
+      class Authorizer
+        include Shogun::Authorizer
+        include {{resource_module}}
+
+        def initialize(requester:, resource:)
+          if requester
+            @requester = requester.account
+          end
+          @resource = resource
+        end
+
+        def allowed?
+          @requester == @resource
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/update/control.rb

@@ -0,0 +1,37 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Update
+      class Control
+        include Shogun::Control
+        include {{resource_module}}
+
+        def initialize(payload:)
+          @normalizer = Normalizer.new(raw: payload.to_hash)
+          @validator = Validator.new(data: @normalizer)
+
+          if @validator.valid?
+            @session = Sessions::Model.find_by(id: @normalizer.session)
+            @model = Model.find_by(id: @normalizer.id)
+            @authorizer = Authorizer.new(requester: @session, resource: @model)
+
+            case
+            when @model && @authorizer.allowed?
+              @model.update(@normalizer.to_hash)
+              @presenter = Presenter.new(resource: @model, meta: @normalizer.as_meta)
+              @denormalizer = Denormalizer.new(object: @presenter)
+              @status = OK
+            when @model && @authorizer.denied?
+              @status = UNAUTHORIZED
+            else
+              @status = NOT_FOUND
+            end
+          else
+            @presenters = Shogun::Presenters.new(resources: @validator.invalids, cast: Errors::Presenter)
+            @denormalizer = Errors::Denormalizer.new(object: @presenters)
+            @status = UNPROCESSABLE_ENTITY
+          end
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/update/denormalizer.rb

@@ -0,0 +1,31 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Update
+      class Denormalizer
+        include Shogun::Denormalizer
+        include {{resource_module}}
+
+        MAPPING = {
+          "id" => "id",
+          "created_at" => "created_at",
+          "destroyed_at" => "destroyed_at",
+          "updated_at" => "updated_at",
+          "href" => "href"
+        }
+
+        def initialize(object:)
+          @object = object
+          @meta = object.meta
+          @links = object.links
+          @linked = object.linked
+        end
+
+        private def document
+          mapping.inject({}) do |hash, (field, name)|
+            hash.merge(field => @object.public_send(name))
+          end
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/update/normalizer.rb

@@ -0,0 +1,37 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Update
+      class Normalizer
+        include Shogun::Normalizer
+        include {{resource_module}}
+
+        METADATA = %w|id|
+        ATTRIBUTES = %w|attirbute|
+
+        def initialize(raw:)
+          @id = raw["id"]
+
+          if raw["rack.authentication"] && raw["rack.authentication"]["sessions"]
+            @session = raw["rack.authentication"]["sessions"]["id"]
+          end
+
+          if raw[NAMESPACE]
+            @attribute = raw[namespace]["attribute"]
+          end
+        end
+
+        def id
+          @id
+        end
+
+        def session
+          @session
+        end
+
+        def attribute
+          @attribute.strip if @attribute.is_a?(String)
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/update/validator.rb

@@ -0,0 +1,14 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Update
+      class Validator
+        include Shogun::Validator
+        include {{resource_module}}
+
+        def initialize(data:)
+          @verifiers = []
+        end
+      end
+    end
+  end
+end