arkaan 2.8.0 → 3.0.0

data/lib/arkaan/oauth/authorization.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   module OAuth
     # An OAuth authorization is granted by a user to an application to access its personal data.
@@ -10,8 +12,8 @@ module Arkaan
       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 }
+      #   @return [String] the value corresponding to the authentication code in the RFC of OAuth2.0.
+      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.
@@ -20,12 +22,12 @@ module Arkaan
       #   @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.
+      #   @return [Arkaan::OAuth::AccessToken] the access token used further in the application process to access data.
       has_many :tokens, class_name: 'Arkaan::OAuth::AccessToken', inverse_of: :authorization
 
       validates :code,
-        presence: {message: 'required'},
-        uniqueness: {message: 'uniq'}
+                presence: { message: 'required' },
+                uniqueness: { message: 'uniq' }
     end
   end
-end
+end

data/lib/arkaan/oauth/refresh_token.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 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.
+    # 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
@@ -8,11 +11,11 @@ module Arkaan
 
       # @!attribute [rw] value
       #   @return [String] the value of the token, returned to the application when built.
-      field :value, type: String, default: ->{ SecureRandom.hex }
+      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.
+      #   @return [Arkaan::OAuth::Authorization] the authorization code that issued this token to the application.
       belongs_to :authorization, class_name: 'Arkaan::OAuth::Authorization', inverse_of: :refresh_token
     end
   end
-end
+end

data/lib/arkaan/permissions.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Arkaan
   # This module holds the logic for all the classes concerning the permissions abd rights for the user.
   # A permission is restricting the access to one or several features to the users having it.
   # @author Vincent Courtois <courtois.vincent@outlook.com>
   module Permissions
-    autoload :Right   , 'arkaan/permissions/right'
-    autoload :Group   , 'arkaan/permissions/group'
+    autoload :Right, 'arkaan/permissions/right'
+    autoload :Group, 'arkaan/permissions/group'
     autoload :Category, 'arkaan/permissions/category'
   end
-end
+end

data/lib/arkaan/permissions/category.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Permissions
     # A category of rights regroups one or several rights for convenience purposes.
@@ -9,7 +11,7 @@ module Arkaan
 
       has_many :rights, class_name: 'Arkaan::Permissions::Right', inverse_of: :category
 
-      make_sluggable 'category'
+      make_sluggable
     end
   end
-end
+end

data/lib/arkaan/permissions/group.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Permissions
     # A group gathers one or several users to give them the same rights for conviniency purposes.
@@ -24,7 +26,7 @@ module Arkaan
       #   @return [Array<Arkaan::Monitoring::Route>] the routes this group can access in the API.
       has_and_belongs_to_many :routes, class_name: 'Arkaan::Monitoring::Route', inverse_of: :groups
 
-      make_sluggable 'group'
+      make_sluggable
     end
   end
-end
+end

data/lib/arkaan/permissions/right.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Permissions
-    # A right is the access to one or several features in the application. It's applied to a group, and transitively to an account.
+    # A right is the access to one or several features in the application.
+    # It's applied to a group, and transitively to an account.
     # @author Vincent Courtois <courtois;vincent@outlook.com>
     class Right
       include Mongoid::Document
@@ -8,12 +11,13 @@ module Arkaan
       include Arkaan::Concerns::Sluggable
 
       # @!attribute [rw] groups
-      #   @return [Array<Arkaan::Permissions::Group>] the groups granted with the permission to access features opened by this right.
+      #   @return [Array<Arkaan::Permissions::Group>] the groups granted with the permission to
+      #     access features opened by this right.
       has_and_belongs_to_many :groups, class_name: 'Arkaan::Permissions::Group', inverse_of: :rights
 
       belongs_to :category, class_name: 'Arkaan::Permissions::Category', inverse_of: :rights
 
-      make_sluggable 'right'
+      make_sluggable
     end
   end
-end
+end

data/lib/arkaan/ruleset.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   # A set of rules is describing how a specific game system works (eg. Dungeons and Dragons 5th Edition, or Fate)
   # @author Vincent Courtois <courtois.vincent@outlook.com>
@@ -23,8 +25,8 @@ module Arkaan
     has_many :campaigns, class_name: 'Arkaan::Campaign', inverse_of: :ruleset
 
     validates :name,
-      presence: {message: 'required'},
-      length: {minimum: 4, message: 'minlength', if: :name?},
-      uniqueness: {message: 'uniq', if: :name?}
+              presence: { message: 'required' },
+              length: { minimum: 4, message: 'minlength', if: :name? },
+              uniqueness: { message: 'uniq', if: :name? }
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-26 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_cleaner
@@ -333,13 +333,8 @@ files:
 - lib/arkaan/concerns/premiumable.rb
 - lib/arkaan/concerns/sluggable.rb
 - lib/arkaan/concerns/typable.rb
-- lib/arkaan/decorators/errors.rb
-- lib/arkaan/decorators/errors/env_variable_missing.rb
-- lib/arkaan/decorators/gateway.rb
 - lib/arkaan/event.rb
 - lib/arkaan/factories.rb
-- lib/arkaan/factories/errors.rb
-- lib/arkaan/factories/errors/gateway_not_found.rb
 - lib/arkaan/files.rb
 - lib/arkaan/files/document.rb
 - lib/arkaan/files/permission.rb
@@ -357,7 +352,6 @@ files:
 - lib/arkaan/permissions/group.rb
 - lib/arkaan/permissions/right.rb
 - lib/arkaan/ruleset.rb
-- lib/arkaan/version.rb
 homepage: https://rubygems.org/gems/arkaan
 licenses:
 - MIT

data/lib/arkaan/decorators/errors.rb

@@ -1,9 +0,0 @@
-module Arkaan
-  module Decorators
-    # Module holding all the errors concerning the code of the decorators.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    module Errors
-      autoload :EnvVariableMissing, 'arkaan/decorators/errors/env_variable_missing'
-    end
-  end
-end

data/lib/arkaan/decorators/errors/env_variable_missing.rb

@@ -1,14 +0,0 @@
-module Arkaan
-  module Decorators
-    module Errors
-      # Error raised if the application key variable is missing.
-      # @author Vincent Courtois <courtois.vincent@outlook.com>
-      class EnvVariableMissing < Arkaan::Utils::Errors::HTTPError
-
-        def initialize(action:)
-          super(action, 'app_key', 'not_found', 404)
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/decorators/gateway.rb

@@ -1,109 +0,0 @@
-module Arkaan
-  module Decorators
-    # Decorator for a service, providing methods to make requests on it.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    class Gateway < Draper::Decorator
-      delegate_all
-
-      # @!attribute [rw] action
-      #   @return [String] the action of the route using this API.
-      attr_accessor :action
-
-      attr_accessor :logger
-
-      def initialize(action, _object)
-        super(_object)
-        @logger = Logger.new(STDOUT)
-        @action = action
-      end
-
-      # Shortcut to make a DELETE request on the API.
-      # @param session [Arkaan::Authentication::Session] the session of the user requesting the API.
-      # @param url [String] the URL you want to reach on the service.
-      # @param params [Hash] the additional parameters to pass in the JSON body.
-      def delete(session:, url:, params:)
-        return make_request_without_body(verb: 'delete', session: session, url: url, params: params)
-      end
-
-      # Shortcut to make a GET request on the API.
-      # @param session [Arkaan::Authentication::Session] the session of the user requesting the API.
-      # @param url [String] the URL you want to reach on the service.
-      # @param params [Hash] the additional parameters to pass in the JSON body.
-      def get(session:, url:, params:)
-        return make_request_without_body(verb: 'get', session: session, url: url, params: params)
-      end
-
-      # Shortcut to make a POST request on the API.
-      # @param session [Arkaan::Authentication::Session] the session of the user requesting the API.
-      # @param url [String] the URL you want to reach on the service.
-      # @param params [Hash] the additional parameters to pass in the JSON body.
-      def post(session:, url:, params:)
-        return make_request(verb: 'post', session: session, url: url, params: params)
-      end
-
-      # Shortcut to make a PUT request on the API.
-      # @param session [Arkaan::Authentication::Session] the session of the user requesting the API.
-      # @param url [String] the URL you want to reach on the service.
-      # @param params [Hash] the additional parameters to pass in the JSON body.
-      def put(session:, url:, params:)
-        return make_request(verb: 'put', session: session, url: url, params: params)
-      end
-
-      private
-
-      # Makes a POST request to the given service with the following steps :
-      # 1. Gets an active and running instance of the service to make the request.
-      # 2. Creates a Faraday connection to use it as a pipeline for the request.
-      # 3. Makes the actual request and returns an object with the status and body of the response.
-      #
-      # @param verb [String] the HTTP verb to use for this request.
-      # @param session [Arkaan::Authentication::Session] the session of the user requesting the API.
-      # @param url [String] the URL you want to reach on the service.
-      # @param params [Hash] the additional parameters to pass in the JSON body.
-      #
-      # @return [Hash, Boolean] FALSE if no instance are found, or an object with :status and :body keys correspding
-      #                         to the status and body of the response to the request
-      def make_request(verb:, session:, url:, params:)
-        params = before_requests(session, params)
-        connection = get_connection
-
-        response = connection.send(verb) do |req|
-          req.url url
-          req.headers['Content-Type'] = 'application/json'
-          req.body = params.to_json
-        end
-
-        return {
-          status: response.status,
-          body: JSON.parse(response.body)
-        }
-      end
-
-      def make_request_without_body(verb:, session:, url:, params:)
-        params = before_requests(session, params)
-        connection = get_connection
-        response = connection.send(verb) do |req|
-          req.url url, params
-          req.headers['Content-Type'] = 'application/json'
-        end
-      end
-
-      def before_requests(session, params)
-        if ENV['APP_KEY'].nil?
-          raise Arkaan::Decorators::Errors::EnvVariableMissing.new(action: action)
-        end
-        params[:app_key] = ENV['APP_KEY']
-        params[:session_id] = session.token
-        return params
-      end
-
-      def get_connection
-        Faraday.new(object.url) do |faraday|
-          faraday.request  :url_encoded
-          faraday.response :logger
-          faraday.adapter  Faraday.default_adapter
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/factories/errors.rb

@@ -1,9 +0,0 @@
-module Arkaan
-  module Factories
-    # Module holding all the errors concerning the code of the factories.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    module Errors
-      autoload :GatewayNotFound, 'arkaan/factories/errors/gateway_not_found'
-    end
-  end
-end

data/lib/arkaan/factories/errors/gateway_not_found.rb

@@ -1,14 +0,0 @@
-module Arkaan
-  module Factories
-    module Errors
-      # Error raised when not gateway active and running is found in the factory.
-      # @author Vincent Courtois <courtois.vincent@outlook.com>
-      class GatewayNotFound < Arkaan::Utils::Errors::HTTPError
-
-        def initialize(action:)
-          super(action, 'gateway_id', 'not_found', 404)
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/version.rb

@@ -1,3 +0,0 @@
-module Arkaan
-  VERSION = '2.7.2'
-end