arkaan 0.8.21 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62fc4db782fa9567378e611fe99216336f19be83
-  data.tar.gz: 72b3b782759418f5b670e5c3ee96b5d06e36e735
+  metadata.gz: cc39dec4721b328451c73cde4e780f9917f66b9c
+  data.tar.gz: 06c34ff8141b36f29b7400c05e4f6b3d43c71fcc
 SHA512:
-  metadata.gz: 7a7083bab94b71ae595ca98197a91ea18c6a046a97009bdce03030a097e132431616e124a75e51228493350ec196d99aa2e7c8358d79e5ed4374c48ce023a1d4
-  data.tar.gz: ea4c07a5e3be90920febefdf99579fa6e6a0f090565b3c4126eee08550c9d3519c7bd3d17dff2f05a11ca2e8439866b58a7cff2593eb3b2042e494f1bb52ecd9
+  metadata.gz: 9364b342574cccb18d98d01513438b04f30a988d7732a94f3d7560b0ce3b2f4339d6ac435fc32f4d69f89d034bc8f48665e4d03570b637f20c0ef874eac50349
+  data.tar.gz: 235201b877ff1707df05753b9e61da44e9aa388205d9721e8896043fcc4b27f39005ef545c45ab8acbb9ed92e3d55cdb874df842b99842f6425ad96e4797b101

data/lib/arkaan.rb

@@ -15,5 +15,6 @@ module Arkaan
   autoload :Monitoring    , 'arkaan/monitoring'
   autoload :OAuth         , 'arkaan/oauth'
   autoload :Permissions   , 'arkaan/permissions'
+  autoload :Phone         , 'arkaan/phone'
   autoload :Utils         , 'arkaan/utils'
 end

data/lib/arkaan/account.rb

@@ -18,9 +18,6 @@ module Arkaan
     # @!attribute [rw] firstname
     #   @return [String] the first name of the user.
     field :firstname, type: String, default: ''
-    # @!attribute [rw] birthdate
-    #   @return [DateTime] the day of birth of the user, as an ISO-8601.
-    field :birthdate, type: DateTime
     # @!attribute [rw] email
     #   @return [String] the email address of the user, useful to contact them ; it must be given, unique, and have an email format.
     field :email, type: String
@@ -57,6 +54,10 @@ module Arkaan
     #   @return [Array<Arkaan::Campaigns::Invitation>] the invitations you've issued yourself to other players.
     has_many :created_invitations, class_name: 'Arkaan::Campaigns::Invitation', inverse_of: :creator
 
+    # @!attribute [rw] phones
+    #   @return [Array<Arkaan::Phone>] the phone numbers given by the user.
+    embeds_many :phones, class_name: 'Arkaan::Phone', inverse_of: :account
+
     validates :username,
       presence: {message: 'required'},
       length: {minimum: 6, message: 'minlength', if: :username?},

data/lib/arkaan/campaigns/invitation.rb

@@ -5,13 +5,11 @@ module Arkaan
     class Invitation
       include Mongoid::Document
       include Mongoid::Timestamps
+      include Arkaan::Concerns::Enumerable
 
-      # @!attribute [rw] accepted
-      #   @return [Boolean] TRUE if the invitation has been accepted, false otherwise.
-      field :accepted, type: Boolean, default: false
-      # @!attribute [rw] accepted_at
-      #   @return [DateTime] the date at which the invitation has been accepted.
-      field :accepted_at, type: DateTime, default: nil
+      # @!attribute [rw] status
+      #   @return [Symbol] the current status of the invitation.
+      enum_field :status, [:accepted, :expelled, :ignored, :pending, :refused], default: :pending
 
       # @!attribute [rw] account
       #   @return [Arkaan::Account] the account the invitation has been issued to.

data/lib/arkaan/concerns.rb

@@ -5,6 +5,7 @@ module Arkaan
     autoload :Sluggable, 'arkaan/concerns/sluggable'
     autoload :Activable, 'arkaan/concerns/activable'
     autoload :Diagnosticable, 'arkaan/concerns/diagnosticable'
+    autoload :Enumerable, 'arkaan/concerns/enumerable'
     autoload :Premiumable, 'arkaan/concerns/premiumable'
   end
 end

data/lib/arkaan/concerns/enumerable.rb

@@ -0,0 +1,44 @@
+module Arkaan
+  module Concerns
+    # Defines enumerations for the Mongoid models. An enumeration is a field that can only use a given set of values.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Enumerable
+      extend ActiveSupport::Concern
+
+      # Submodule holding all the static methods add to the current subclass.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      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 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 = {})
+          field :"enum_#{field_name}", type: Symbol, default: options[:default]
+
+          validates :"enum_#{field_name}", inclusion: {in: values.map(&:to_sym), message: 'inclusion'}
+
+          define_method field_name do
+            return self["enum_#{field_name}"]
+          end
+
+          define_method "#{field_name}=" do |value|
+            if values.include? value
+              self["enum_#{field_name}"] = value.to_sym
+            end
+          end
+
+          values.map(&:to_sym).each do |value|
+            define_method "#{field_name}_#{value}!" do
+              self["enum_#{field_name}"] = value
+            end
+
+            define_method "#{field_name}_#{value}?" do
+              self["enum_#{field_name}"] == value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/arkaan/phone.rb

@@ -0,0 +1,24 @@
+module Arkaan
+  # A phone number is given by a user so that the persons he has selected can have it to contact him.
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
+  class Phone
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include Arkaan::Concerns::Enumerable
+
+    # @!attribute [rw] privacy
+    #   @return [Symbol] the level of privacy you want for this phone number.
+    enum_field :privacy, [:players, :public, :private], default: :private
+    # @!attribute [rw] number
+    #   @return [Integer] the phone number the user has given.
+    field :number, type: Integer
+
+    # @!attribute [rw] account
+    #   @return [Arkaan::Account] the account the phone number is associated to.
+    embedded_in :account, class_name: 'Arkaan::Account', inverse_of: :phones
+
+    validates :number,
+      presence: {message: 'required'},
+      format: {with: /\A[0-9\-\._\/]+\z/, message: 'pattern'}
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 0.8.21
+  version: 0.9.0
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-12 00:00:00.000000000 Z
+date: 2018-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -209,6 +209,7 @@ files:
 - lib/arkaan/concerns.rb
 - lib/arkaan/concerns/activable.rb
 - lib/arkaan/concerns/diagnosticable.rb
+- lib/arkaan/concerns/enumerable.rb
 - lib/arkaan/concerns/premiumable.rb
 - lib/arkaan/concerns/sluggable.rb
 - lib/arkaan/monitoring.rb
@@ -225,6 +226,7 @@ files:
 - lib/arkaan/permissions/category.rb
 - lib/arkaan/permissions/group.rb
 - lib/arkaan/permissions/right.rb
+- lib/arkaan/phone.rb
 - lib/arkaan/specs.rb
 - lib/arkaan/utils.rb
 - lib/arkaan/utils/controller.rb