arkaan 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c1ec575ec3457e7920d4ba8adc017667cc6703e
-  data.tar.gz: 977526cae9348564d8e3e14674c73646a7b522a5
+  metadata.gz: 4ac83b9b70e1ecb3bca72b55a576c6c73f09b941
+  data.tar.gz: 6b6e2d509bd95684032a0553807255cbed1209eb
 SHA512:
-  metadata.gz: 28c7cecdc80476e4e624d7b5cbc37a8d12456ef0667a4c01586efcc4146068bc2930f81db9c8a3bb8415930f7e73e44bc8272cfa394246581a668b28c6895d81
-  data.tar.gz: 0126a61e8bc40fc9e8b4172084515a82f08720380f01b49fb1cad9aae2c27de6790939b9a187be620dae92c9d71774f96aceb036496c0cb3009e0acab2b6e874
+  metadata.gz: 3e2f8ef7eddb21380844592ae7c9c0a1380a19db6a42d44b567caba5a35c46dc5e791d3eb6f35bdf47c1f70c0a9ac6633b3b281b8f778108f04ffa273d9da312
+  data.tar.gz: 132672eacf3f19613cb58c6929f5d04575191a0a3a17e57c23897511491371d94a992767951d7508e2ca6161fe6144aea0d254eca067b76afce4eb0e24039886

data/lib/arkaan.rb

@@ -8,4 +8,5 @@ module Arkaan
   autoload :Account    , 'arkaan/account'
   autoload :Permissions, 'arkaan/permissions'
   autoload :Concerns   , 'arkaan/concerns'
+  autoload :OAuth      , 'arkaan/oauth'
 end

data/lib/arkaan/account.rb

@@ -25,18 +25,24 @@ module Arkaan
     #   @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
 
+    # @!attribute [w] password
+    #   @return [String] password, in clear, of the user ; do not attempt to get the value, just set it when changing the password.
+    # @!attribute [w] password_confirmation
+    #   @return [String] the confirmation of the password, do not get, just set it ; it must be the same as the password.
+    has_secure_password
+
     # @!attribute [rw] groups
     #   @return [Array<Arkaan::Permissions::Group>] the groups giving their corresponding rights to the current account.
     has_and_belongs_to_many :groups, class_name: 'Arkaan::Permissions::Group', inverse_of: :accounts
+    # @!attribute [rw] applications
+    #   @return [Array<Arkaan::OAuth::Application] the applications this user has created and owns.
+    has_many :applications, class_name: 'Arkaan::OAuth::Application', inverse_of: :creator
+    # @!attribute [rw] authorizations
+    #   @return [Array<Arkaan::OAuth::Authorization>] the authorization issued by this account to third-party applications to access its data.
+    has_many :authorizations, class_name: 'Arkaan::OAuth::Authorization', inverse_of: :account
 
     validates :username, length: {minimum: 6}, uniqueness: true
 
     validates :email, presence: true, format: {with: /\A[a-z0-9._%+-]+@[a-z0-9.-]+\.[a-z]{2,}\z/}, uniqueness: true
-
-    # @!attribute [w] password
-    #   @return [String] password, in clear, of the user ; do not attempt to get the value, just set it when changing the password.
-    # @!attribute [w] password_confirmation
-    #   @return [String] the confirmation of the password, do not get, just set it ; it must be the same as the password.
-    has_secure_password
   end
 end

data/lib/arkaan/oauth.rb

@@ -0,0 +1,10 @@
+module Arkaan
+  # This module holds the logic for the connection of an application to our API.
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
+  module OAuth
+    autoload :Application  , 'arkaan/oauth/application'
+    autoload :Authorization, 'arkaan/oauth/authorization'
+    autoload :AccessToken  , 'arkaan/oauth/access_token'
+    autoload :RefreshToken , 'arkaan/oauth/refresh_token'
+  end
+end

data/lib/arkaan/oauth/access_token.rb

@@ -0,0 +1,23 @@
+module Arkaan
+  module OAuth
+    # An access token is the value assigned to the application to access the private data of an account.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class AccessToken
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      # @!attribute [rw] value
+      #   @return [String] the value of the token, returned to the application when built.
+      field :value, type: String, default: ->{ SecureRandom.hex }
+      # @!attribute [rw] expiration
+      #   @return [Integer] the time, in seconds, after which the token is declared expired, and thus can't be used anymore.
+      field :expiration, type: Integer, default: 86400
+
+      # @!attribute [rw] authorization
+      #   @return [Arkaan::OAuth::Authorization] the authorization code that issued this token to the application for this user.
+      belongs_to :authorization, class_name: 'Arkaan::OAuth::Authorization', inverse_of: :access_token
+
+      validates :value, presence: true, uniqueness: true
+    end
+  end
+end

data/lib/arkaan/oauth/application.rb

@@ -0,0 +1,31 @@
+module Arkaan
+  module OAuth
+    # An application is what is referred to in the OAuth2.0 RFC as a client, wanting to access private informations about the user.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Application
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      # @!attribute [rw] name
+      #   @return [String] the unique name of the application, mainly used to identify and display it.
+      field :name, type: String
+      # @!attribute [rw] key
+      #   @return [String] the unique key for the application, identifying it when requesting a token for the API.
+      field :key, type: String, default: ->{ SecureRandom.hex }
+      # @!attribute [rw] premium
+      #   @return [Boolean] a value indicating whether the application should automatically receive a token when an account is created, or not.
+      field :premium, type: Boolean, default: false
+
+      # @!attribute [rw] creator
+      #   @return [Arkaan::Account] the account that has created this application, considered its owner.
+      belongs_to :creator, class_name: 'Arkaan::Account', inverse_of: :applications
+      # @!attribute [rw] authorizations
+      #   @return [Array<Arkaan::OAuth::Authorization>] the authorizations linked to the accounts this application can get the data from.
+      has_many :authorizations, class_name: 'Arkaan::OAuth::Authorization', inverse_of: :application
+
+      validates :name, presence: true, length: {minimum: 6}, uniqueness: true
+
+      validates :key, presence: true, uniqueness: true
+    end
+  end
+end

data/lib/arkaan/oauth/authorization.rb

@@ -0,0 +1,26 @@
+module Arkaan
+  module OAuth
+    # An OAuth authorization is granted by a user to an application to access its personal data.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Authorization
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      # @!attribute [rw] code
+      #   @return [String] the value corresponding to the authentication code in the RFC of OAuth2.0, kep for historic purpose.
+      field :code, type: String, default: ->{ SecureRandom.hex }
+
+      # @!attribute [rw] account
+      #   @return [Arkaaan::Account] the account granting the authorization to access its data to the application.
+      belongs_to :account, class_name: 'Arkaan::Account', inverse_of: :authorizations
+      # @!attribute [rw] application
+      #   @return [Arkaan::OAuth::Application] the application asking to access account's data.
+      belongs_to :application, class_name: 'Arkaan::OAuth::Application', inverse_of: :authorizations
+      # @!attribute [rw] token
+      #   @return [Arkaan::OAuth::AccessToken] the access token used further in the application process to access private data of the account.
+      has_one :token, class_name: 'Arkaan::OAuth::AccessToken', inverse_of: :authorization
+
+      validates :code, presence: true, uniqueness: true
+    end
+  end
+end

data/lib/arkaan/oauth/refresh_token.rb

@@ -0,0 +1,18 @@
+module Arkaan
+  module OAuth
+    # A refresh token is used when an access token is expired, to get a new one. It is then recreated for the next expiration.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class RefreshToken
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      # @!attribute [rw] value
+      #   @return [String] the value of the token, returned to the application when built.
+      field :value, type: String, default: ->{ SecureRandom.hex }
+
+      # @!attribute [rw] authorization
+      #   @return [Arkaan::OAuth::Authorization] the authorization code that issued this token to the application for this user.
+      belongs_to :authorization, class_name: 'Arkaan::OAuth::Authorization', inverse_of: :refresh_token
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-19 00:00:00.000000000 Z
+date: 2017-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -160,6 +160,11 @@ files:
 - lib/arkaan/account.rb
 - lib/arkaan/concerns.rb
 - lib/arkaan/concerns/sluggable.rb
+- lib/arkaan/oauth.rb
+- lib/arkaan/oauth/access_token.rb
+- lib/arkaan/oauth/application.rb
+- lib/arkaan/oauth/authorization.rb
+- lib/arkaan/oauth/refresh_token.rb
 - lib/arkaan/permissions.rb
 - lib/arkaan/permissions/category.rb
 - lib/arkaan/permissions/group.rb