virtuaservices 0.1.0

data/lib/virtuaservices/utils/controllers/checked.rb

@@ -0,0 +1,14 @@
+module Arkaan
+  module Utils
+    module Controllers
+      # Base controller to handle the standard error when accessing the API.
+      # @author Vincent Courtois <courtois.vincenet@outlook.com>
+      class Checked < Arkaan::Utils::Controllers::Base
+
+        before do
+          before_checks
+        end
+      end
+    end
+  end
+end

data/lib/virtuaservices/utils/errors.rb

@@ -0,0 +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/virtuaservices/utils/errors/bad_request.rb

@@ -0,0 +1,14 @@
+module Arkaan
+  module Utils
+    module Errors
+      # 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:)
+          super(action, field, error, 400)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Arkaan
+  module Utils
+    module Errors
+      # 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
+
+        def initialize (field:, action:, error:)
+          super(action, field, error, 403)
+        end
+      end
+    end
+  end
+end

data/lib/virtuaservices/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/virtuaservices/utils/errors/not_found.rb

@@ -0,0 +1,14 @@
+module Arkaan
+  module Utils
+    module Errors
+      # 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
+
+        def initialize (field:, action:, error:)
+          super(action, field, error, 404)
+        end
+      end
+    end
+  end
+end

data/lib/virtuaservices/utils/loaders.rb

@@ -0,0 +1,7 @@
+module Arkaan
+  module Utils
+    module Loaders
+      autoload :Heroku, 'arkaaan/utils/loaders/heroku'
+    end
+  end
+end

data/lib/virtuaservices/utils/loaders/heroku.rb

@@ -0,0 +1,20 @@
+module Arkaan
+  module Utils
+    module Plugins
+      class Heroku
+        # Loads the heroku informations inside the data of the instance.
+        # @param instance [Arkaan::Monitoring::Instance] the instance to put the enrichment inside.
+        def self.load!(instance)
+          if !ENV['OAUTH_TOKEN'].nil? && instance != false && instance.persisted?
+            heroku = PlatformAPI.connect_oauth(ENV['OAUTH_TOKEN'])
+            regex = /\Ahttps?:\/\/([a-z\-]+).herokuapp.com\/?\z/
+            if instance.url.match(regex)
+              app_name = instance.url.scan(regex).first.first
+              instance.update_attribute(:data, heroku.app.info(app_name))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/virtuaservices/utils/micro_service.rb

@@ -0,0 +1,170 @@
+module Arkaan
+  module Utils
+    # This class is a singleton to load and save parameters for the whole application.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class MicroService
+      include Singleton
+
+      # @!attribute [r] name
+      #   @return [String] the name of the service you want to load.
+      attr_reader :service
+      # @!attribute [r] location
+      #   @return [String] the path to the file loading the whole application, used to deduce the loading paths.
+      attr_reader :location
+      # @!attribute [r] name
+      #   @return [String] the name of the service, used later to instantiate it when the mongoid configuration is fully loaded.
+      attr_reader :name
+      # @!attribute [r] instance
+      #   @return [Arkaan::Monitoring::Instance] the instance of the service currently deployed.
+      attr_reader :instance
+      # @!attribute [r] type
+      #   @return [Symbol] the type of instance the application is declaring
+      attr_reader :type
+
+      def initialize
+        @location = false
+        @service = false
+        @instance = false
+        @name = false
+        @type = ENV['INSTANCE_TYPE'] || :heroku
+        @controller_classes = []
+      end
+
+      def get_controllers
+        return [] if defined?(Controllers).nil?
+        classes = Controllers.constants.map { |symbol| get_const(symbol) }
+        return classes.select { |symbol| symbol.is_a? Class }
+      end
+
+      def get_const(symbol)
+        return Object.const_get("Controllers::#{symbol.to_s}")
+      end
+
+      # Determines if the application can be loaded (all the parameters have been correctly set)
+      # @return [Boolean] TRUE if the application can be safely loaded, FALSE otherwise.
+      def loadable?
+        return !!(service && location)
+      end
+
+      # Getter for the path on which the service is mapped.
+      # @return [String, Boolean] the absolute path in the URL on which the service is mapped upon, or FALSE if it's not set already.
+      def path
+        return service ? service.path : false
+      end
+
+      # Look for the service and sets it if it's found in the database, or set it to nil if not found.
+      # @param [String] service_name - the name of the service to look for in the database.
+      # @return [Arkaan::utils::MicroService] the instance of the micro-service to chain other calls.
+      def register_as(service_name)
+        @name = service_name
+        return self
+      end
+
+      # Sets the location of the file calling the micro service and initializing it so that it's used as root.
+      # @param filename [String] the full naame of the file with the extension.
+      # @return [Arkaan::utils::MicroService] the instance of the micro-service to chain other calls.
+      def from_location(filename)
+        @location = File.dirname(filename)
+        return self
+      end
+
+      # Loads the application in standard (production/development) mode, without the test files.
+      # @return [Arkaan::utils::MicroService] the instance of the micro-service to chain other calls.
+      def in_standard_mode
+        return load_application(test_mode: false)
+      end
+
+      # Loads the application in test mode, by adding the needed files to run the test suite to the standard loading process.
+      # @return [Arkaan::utils::MicroService] the instance of the micro-service to chain other calls.
+      def in_test_mode
+        @location = File.join(location, '..')
+        return load_application(test_mode: true)
+      end
+
+      # Loads the application as a websockets service. Only the websockets application should use that.
+      # @return [Arkaan::utils::MicroService] the instance of the micro-service to chain other calls.
+      def in_websocket_mode
+        load_mongoid_configuration
+        load_standard_files
+
+        Arkaan::Monitoring::Websocket.find_or_create_by(url: ENV['WEBSOCKET_URL']).save
+        return self
+      end
+
+      # Deactivates the current instance and the associated service if no more instances are available.
+      def deactivate!
+        instance.update_attribute(:running, false)
+        service.update_attribute(:test_mode, false) if ENV['TEST_MODE']
+      end
+
+      private
+
+      # Registers the service in the database if it has not been created already.
+      def register_service
+        @service = Arkaan::Monitoring::Service.create(key: @name, path: "/#{@name}")
+      end
+
+      # Register the instance of the currently deployed service in the database.
+      # @return [Arkaan::Monitoring::Instance] the instance of the micro service currently running.
+      def register_instance
+        @instance = @service.instances.where(url: ENV['SERVICE_URL']).first
+        if @instance.nil?
+          @instance = Arkaan::Monitoring::Instance.create(service: @service, url: ENV['SERVICE_URL'], type: type)
+        end
+        @instance.update_attribute(:running, true)
+        return @instance
+      end
+
+      # Loads the configuration for Mongoid, the files of the application, and registers the service and the instance in the database.
+      # @param test_mode [Boolean] TRUE to run in test mode (from /spec), FALSE otherwise.
+      # @return [Arkaan::Utils::MicroService] the current instance of the micro service to chain other calls.
+      def load_application(test_mode: false)
+        Dotenv.load
+        load_mongoid_configuration(test_mode: test_mode)
+        if !!(@name && location)
+          @service = Arkaan::Monitoring::Service.where(key: @name).first
+          register_service if @service.nil?
+          if ENV['TEST_MODE']
+            @service.update_attribute(:test_mode, true)
+          end
+          register_instance
+          load_plugin!
+          if service
+            load_standard_files
+            load_test_files if test_mode
+          end
+        end
+        return self
+      end
+
+      def load_plugin!
+        plugin = ENV['ADDITIONAL_PLUGIN']
+        if !plugin.nil? && Arkaan::Utils::Plugins.constants.include?(plugin)
+          Arkaan::Utils::Plugins.const_get(plugin).load!(@instance)
+        end
+      end
+
+      def load_mongoid_configuration(test_mode: false)
+        environment = test_mode ? 'test' : (ENV['RACK_ENV'] || 'development')
+        Mongoid.load!('config/mongoid.yml', environment)
+      end
+
+      def load_standard_files
+        require_folder('decorators')
+        require_folder('services')
+        require_folder('controllers')
+      end
+
+      def load_test_files
+        require_folder('spec', 'support')
+        require_folder('spec', 'shared')
+      end
+
+      def require_folder(*folders)
+        Dir[File.join(location, folders, '**', '*.rb')].each do |filename|
+          require filename
+        end
+      end
+    end
+  end
+end

data/lib/virtuaservices/utils/seeder.rb

@@ -0,0 +1,25 @@
+module Arkaan
+  module Utils
+    # This class loads the necessary data in the database if they don't exist yet.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Seeder
+      include Singleton
+
+      # Creates the service if it does not exist, and the instance if it does not exist.
+      # @return [Arkaan::Monitoring::Service] the created, or found, service corresponding to this micro-service.
+      def create_service(key)
+        service = Arkaan::Monitoring::Service.where(key: key).first
+
+        if service.nil?
+          service = Arkaan::Monitoring::Service.create!(key: key, path: "/#{key}", premium: true, active: true)
+        end
+
+        if service.instances.where(url: ENV['SERVICE_URL']).first.nil?
+          Arkaan::Monitoring::Instance.create!(url: ENV['SERVICE_URL'], running: true, service: service, active: true)
+        end
+
+        return service
+      end
+    end
+  end
+end

data/lib/virtuaservices/version.rb

@@ -0,0 +1,3 @@
+module Virtuaservices
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,321 @@
+--- !ruby/object:Gem::Specification
+name: virtuaservices
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vincent Courtois
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: rspec-json_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.0.1
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.11
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: platform-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+description: This application is the generic base to handle elements like servers,
+  users, and sessions.
+email: courtois.vincent@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/virtuaservices.rb
+- lib/virtuaservices/account.rb
+- lib/virtuaservices/authentication.rb
+- lib/virtuaservices/authentication/session.rb
+- lib/virtuaservices/concerns.rb
+- lib/virtuaservices/concerns/activable.rb
+- lib/virtuaservices/concerns/diagnosticable.rb
+- lib/virtuaservices/concerns/enumerable.rb
+- lib/virtuaservices/concerns/mime_typable.rb
+- lib/virtuaservices/concerns/premiumable.rb
+- lib/virtuaservices/concerns/sluggable.rb
+- lib/virtuaservices/concerns/typable.rb
+- lib/virtuaservices/monitoring.rb
+- lib/virtuaservices/monitoring/action.rb
+- lib/virtuaservices/monitoring/gateway.rb
+- lib/virtuaservices/monitoring/instance.rb
+- lib/virtuaservices/monitoring/route.rb
+- lib/virtuaservices/monitoring/service.rb
+- lib/virtuaservices/monitoring/websocket.rb
+- lib/virtuaservices/oauth.rb
+- lib/virtuaservices/oauth/application.rb
+- lib/virtuaservices/permissions.rb
+- lib/virtuaservices/permissions/category.rb
+- lib/virtuaservices/permissions/group.rb
+- lib/virtuaservices/permissions/right.rb
+- lib/virtuaservices/specs.rb
+- lib/virtuaservices/utils.rb
+- lib/virtuaservices/utils/controllers.rb
+- lib/virtuaservices/utils/controllers/base.rb
+- lib/virtuaservices/utils/controllers/checked.rb
+- lib/virtuaservices/utils/errors.rb
+- lib/virtuaservices/utils/errors/bad_request.rb
+- lib/virtuaservices/utils/errors/forbidden.rb
+- lib/virtuaservices/utils/errors/http_error.rb
+- lib/virtuaservices/utils/errors/not_found.rb
+- lib/virtuaservices/utils/loaders.rb
+- lib/virtuaservices/utils/loaders/heroku.rb
+- lib/virtuaservices/utils/micro_service.rb
+- lib/virtuaservices/utils/seeder.rb
+- lib/virtuaservices/version.rb
+homepage: https://rubygems.org/gems/virtuaservices
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A generic SaaS platform
+test_files: []