shogun 6.2.1 → 6.2.2

data/scaffold/new/project/lib/namespace/accounts/null.rb

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

data/scaffold/new/project/lib/namespace/accounts/presenter.rb

@@ -0,0 +1,40 @@
+module {{namespace_module}}
+  module Accounts
+    class Presenter
+      include Shogun::Presenter
+      include Accounts
+
+      def id
+        source.id
+      end
+
+      def signature
+        source.signature
+      end
+
+      def username
+        source.username
+      end
+
+      def email
+        source.email
+      end
+
+      def name
+        source.name
+      end
+
+      def created_at
+        source.created_at.to_datetime.rfc3339
+      end
+
+      def updated_at
+        source.updated_at.to_datetime.rfc3339 if source.updated_at
+      end
+
+      def destroyed_at
+        source.destroyed_at.to_datetime.rfc3339 if source.destroyed_at
+      end
+    end
+  end
+end

data/scaffold/new/project/lib/namespace/accounts/show.rb

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

data/scaffold/new/project/lib/namespace/accounts/show/control.rb

@@ -0,0 +1,31 @@
+module {{namespace_module}}
+  module Accounts
+    module Show
+      class Control
+        include Shogun::Control
+        include Accounts
+
+        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/new/project/lib/namespace/accounts/show/denormalizer.rb

@@ -0,0 +1,22 @@
+module {{namespace_module}}
+  module Accounts
+    module Show
+      class Denormalizer
+        include Shogun::Denormalizer
+        include Accounts
+
+        MAPPING = {
+          "id" => "id",
+          "signature" => "signature",
+          "username" => "username",
+          "email" => "email",
+          "name" => "name",
+          "created_at" => "created_at",
+          "destroyed_at" => "destroyed_at",
+          "updated_at" => "updated_at",
+          "href" => "href"
+        }
+      end
+    end
+  end
+end

data/scaffold/new/project/lib/namespace/accounts/show/normalizer.rb

@@ -0,0 +1,37 @@
+module {{namespace_module}}
+  module Accounts
+    module Show
+      class Normalizer
+        include Shogun::Normalizer
+        include Accounts
+
+        METADATA = %w|id fields|
+        LIST_DELIMITER = /\s*,\s*/
+        DEFAULT_FIELDS = %w|updated_at destroyed_at href created_at name email username signature id|
+        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/new/project/lib/namespace/accounts/show/validator.rb

@@ -0,0 +1,21 @@
+module {{namespace_module}}
+  module Accounts
+    module Show
+      class Validator
+        include Shogun::Validator
+        include Accounts
+
+        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|updated_at destroyed_at href created_at bio name email username signature id|
+
+        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/new/project/lib/namespace/accounts/update.rb

@@ -0,0 +1,11 @@
+module {{namespace_module}}
+  module Accounts
+    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/new/project/lib/namespace/accounts/update/authorizer.rb

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

data/scaffold/new/project/lib/namespace/accounts/update/control.rb

@@ -0,0 +1,37 @@
+module {{namespace_module}}
+  module Accounts
+    module Update
+      class Control
+        include Shogun::Control
+        include Accounts
+
+        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/new/project/lib/namespace/accounts/update/denormalizer.rb

@@ -0,0 +1,35 @@
+module {{namespace_module}}
+  module Accounts
+    module Update
+      class Denormalizer
+        include Shogun::Denormalizer
+        include Accounts
+
+        MAPPING = {
+          "id" => "id",
+          "signature" => "signature",
+          "username" => "username",
+          "email" => "email",
+          "name" => "name",
+          "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/new/project/lib/namespace/accounts/update/normalizer.rb

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

data/scaffold/new/project/lib/namespace/accounts/update/validator.rb

@@ -0,0 +1,47 @@
+module {{namespace_module}}
+  module Accounts
+    module Update
+      class Validator
+        include Shogun::Validator
+        include Accounts
+
+        ID_MATCH = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
+        EMAIL_MATCH = /^[^@\s]+@([^@\s]+\.)+[^@\s]+$/
+        SIGNATURE_RANGE = 2..64
+        USERNAME_MATCH = /^\S*$/
+        USERNAME_RANGE = 2..64
+
+        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::Presence.new(data: data.session, name: "session")
+          ]
+
+          if data.name
+            @verifiers << Shogun::Verifier::Presence.new(data: data.name, name: "name")
+          end
+
+          if data.email
+            @verifiers << Shogun::Verifier::Presence.new(data: data.email, name: "email")
+            @verifiers << Shogun::Verifier::Match.new(data: data.email, name: "email", comparison: EMAIL_MATCH)
+            @verifiers << Shogun::Verifier::Uniqueness.new(data: data.email, name: "email", list: Model.pluck(:email))
+          end
+
+          if data.signature
+            @verifiers << Shogun::Verifier::Presence.new(data: data.signature, name: "signature")
+            @verifiers << Shogun::Verifier::Range.new(data: data.signature, name: "signature", range: SIGNATURE_RANGE)
+            @verifiers << Shogun::Verifier::Uniqueness.new(data: data.signature, name: "signature", list: Model.pluck(:signature))
+          end
+
+          if data.username
+            @verifiers << Shogun::Verifier::Match.new(data: data.username, name: "username", comparison:  USERNAME_MATCH)
+            @verifiers << Shogun::Verifier::Range.new(data: data.username, name: "username", range: USERNAME_RANGE)
+            @verifiers << Shogun::Verifier::Presence.new(data: data.username, name: "username")
+            @verifiers << Shogun::Verifier::Uniqueness.new(data: data.username, name: "username", list: Model.pluck(:username))
+          end
+        end
+      end
+    end
+  end
+end

data/scaffold/new/project/lib/namespace/errors.rb

@@ -0,0 +1,8 @@
+module {{namespace_module}}
+  module Errors
+    NAMESPACE = "errors"
+
+    require_relative "errors/presenter"
+    require_relative "errors/denormalizer"
+  end
+end

data/scaffold/new/project/lib/namespace/errors/denormalizer.rb

@@ -0,0 +1,24 @@
+module {{namespace_module}}
+  module Errors
+    class Denormalizer
+      include Shogun::Denormalizer
+      include Errors
+
+      def initialize(object:)
+        @object = object
+        @meta = object.meta
+        @links = object.links
+        @linked = object.linked
+      end
+
+      private def document
+        @object.map do |object|
+          {
+            "id" => object.id,
+            "context" => object.context
+          }
+        end
+      end
+    end
+  end
+end

data/scaffold/new/project/lib/namespace/errors/presenter.rb

@@ -0,0 +1,16 @@
+module {{namespace_module}}
+  module Errors
+    class Presenter
+      include Shogun::Presenter
+      include Errors
+
+      def id
+        source.id
+      end
+
+      def context
+        source.context
+      end
+    end
+  end
+end