arkaan 0.9.6 → 0.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de6e70dbddabf869090ee32a2cbdb291bddc58a4
-  data.tar.gz: '09b28cdf6fbc13c3f5e58426187095ca4a926c9b'
+  metadata.gz: 82b48398f8819576417eade7cf5eba42d356d5ce
+  data.tar.gz: b2cfd36e16de4b6b4fa50d85e5a17bdc41b3b8aa
 SHA512:
-  metadata.gz: 5a18690f1ef9731b8bfe0e9cb500b61fb3e210c8ac9fb50e96fb482d2a4e6f4c826b195ab99668937f114f2ab56f7f60018af8f3f18f090fba4dd8534d5df915
-  data.tar.gz: 903147c91d3aae1119c739cbdad726853380160850099e4c4785f49d0ab3cecafac8c0bf34592552a6573c5d871ecba29d4c479785cfe4067128bae131e074eb
+  metadata.gz: 5f4dcd6b8d2c101495e0fa339deab9c1c063604f9c7e10865084b59506d3b6daa1fbe2735a69e2284e2e52cad63337dce697ae8b8bf8a5017f5565717a68afc6
+  data.tar.gz: 2dd59574e0346ab75935889a48d2b56133671b56eaa3c98a900267bb86be60517b42b2e64baf30507e2bab556b1c59c01d6bc11b97917bf50ed67ba919452a09

data/lib/arkaan/campaign.rb

@@ -17,6 +17,9 @@ module Arkaan
     # @!attribute [rw] tags
     #   @return [Array<String>] an array of tags describing characteristics of this campaign.
     field :tags, type: Array, default: []
+    # @!attributes [rw] max_players
+    #   @return [Integer] the maximum number of players allowed in this campaign.
+    field :max_players, type: Integer, default: 5
 
     # @!attribute [rw] creator
     #   @return [Arkaan::Campaign] the account creating the campaign, and considered "game master".

data/lib/arkaan/concerns/enumerable.rb

@@ -10,7 +10,7 @@ module Arkaan
       module ClassMethods
         
         # Creates the field with the given name, set of possible values, and options.
-        # @param name [String] the name of the enumerated field.
+        # @param field_name [String] the name of the enumerated field.
         # @param values [Array<Symbol>] the possible values of the enumerated field.
         # @param options [Hash<Symbol, Any>] the possible options for the field.
         def enum_field(field_name, values, options = {})

data/lib/arkaan/utils/controller.rb

@@ -121,6 +121,8 @@ module Arkaan
         return params.select { |key, value| fields.include?(key) }
       end
 
+      # Creates a custom error from an existing Arkaan exception class.
+      # @param exception {StandardError} the exception to transform in a usable error.
       def handle_arkaan_exception(exception)
         custom_error(exception.status, "#{exception.action}.#{exception.field}.#{exception.error}")
       end

data/lib/arkaan/utils/errors.rb

@@ -1,9 +1,12 @@
 module Arkaan
   module Utils
+    # Module gathering all the exception classes used throughout the utils module, mainly linked to HTTP errors.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
     module Errors
       autoload :BadRequest, 'arkaan/utils/errors/bad_request'
       autoload :Forbidden , 'arkaan/utils/errors/forbidden'
       autoload :NotFound  , 'arkaan/utils/errors/not_found'
+      autoload :HTTPError , 'arkaan/utils/errors/http_error'
     end
   end
 end

data/lib/arkaan/utils/errors/bad_request.rb

@@ -1,21 +1,12 @@
 module Arkaan
   module Utils
     module Errors
-      class BadRequest < StandardError
-        attr_accessor :field
-
-        attr_accessor :action
-
-        attr_accessor :error
+      # A bad request error is raised when the data given to a model makes this model invalid.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class BadRequest < Arkaan::Utils::Errors::HTTPError
 
         def initialize(action:, field:, error:)
-          @action = action
-          @field = field
-          @error = error
-        end
-
-        def status
-          return 400
+          super(action, field, error, 400)
         end
       end
     end

data/lib/arkaan/utils/errors/forbidden.rb

@@ -1,21 +1,12 @@
 module Arkaan
   module Utils
     module Errors
-      class Forbidden < StandardError
-        attr_accessor :field
+      # A forbidden error occurs when a user tries to perform an action he's not allowed to.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class Forbidden < Arkaan::Utils::Errors::HTTPError
 
-        attr_accessor :action
-
-        attr_accessor :error
-
-        def initialize(action:, field:, error:)
-          @action = action
-          @field = field
-          @error = error
-        end
-
-        def status
-          return 403
+        def initialize (field:, action:, error:)
+          super(action, field, error, 403)
         end
       end
     end

data/lib/arkaan/utils/errors/http_error.rb

@@ -0,0 +1,30 @@
+module Arkaan
+  module Utils
+    module Errors
+      # Standard class parent to all specialized http errors.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class HTTPError < StandardError
+
+        # @!attribute [rw] field
+        #   @return [String, Symbol] the name of the field in error in the model.
+        attr_accessor :field
+        # @!attribute [rw] action
+        #   @return [String] the name of the action the user was trying to perform on the model (often crate or update).
+        attr_accessor :action
+        # @attribute [rw] error
+        #   @return [String] the label of the error returned by the model.
+        attr_accessor :error
+        # @attribute [rw] status
+        #   @return [Integer] the HTTP status code as a number (eg: 400, 422 or 500)
+        attr_accessor :status
+
+        def initialize (action, field, error, status)
+          @action = action
+          @field = field.to_s
+          @error = error
+          @status = status
+        end
+      end
+    end
+  end
+end

data/lib/arkaan/utils/errors/not_found.rb

@@ -1,21 +1,12 @@
 module Arkaan
   module Utils
     module Errors
-      class NotFound < StandardError
-        attr_accessor :field
+      # A not found error occurs when a user tries to reach a resource that does not exist.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class NotFound < Arkaan::Utils::Errors::HTTPError
 
-        attr_accessor :action
-
-        attr_accessor :error
-
-        def initialize(action:, field:, error:)
-          @action = action
-          @field = field
-          @error = error
-        end
-
-        def status
-          return 404
+        def initialize (field:, action:, error:)
+          super(action, field, error, 404)
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: 0.9.7
 platform: ruby
 authors:
 - Vincent Courtois
@@ -247,6 +247,7 @@ files:
 - lib/arkaan/utils/errors.rb
 - lib/arkaan/utils/errors/bad_request.rb
 - lib/arkaan/utils/errors/forbidden.rb
+- lib/arkaan/utils/errors/http_error.rb
 - lib/arkaan/utils/errors/not_found.rb
 - lib/arkaan/utils/micro_service.rb
 - lib/arkaan/utils/seeder.rb