virtuaservices 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb059e789bd366ef871e57251808b7d6f7a7f1605008f7ab7afe12169becf477
-  data.tar.gz: 277f3210c31440030234400b95cc1af645afbefab05fa194b1a20e61fdeef088
+  metadata.gz: 429f143252f897b7157b1e21f3c8cbc703a5aeb521af6554ea44d76ada0f2671
+  data.tar.gz: 76f1f59d9aafb5a4ad2c4e1c7d1c7e887e9bb48c4c11d2a98c356af2651c34a6
 SHA512:
-  metadata.gz: b5fdca969d3b8280c9ef4e76b34682fab5ed70431d08150ee08b10b99e36f2160339ad0b1e008013ff4e83b7fd5c051b75986505a4014c0685097ea7252eed05
-  data.tar.gz: 996825708dfd4fbc9b6dc1f52d723d92f8e9ef7be414fed6fb4feec16aff9dcc041ec30c8036c7ec5d0b1c1cbd21bed4abc7e0930705aef66c85ce1bf7bc9968
+  metadata.gz: cff262582fc0fac91cf20e140a24a44f5ddf9511e3e00286fead412f2000eedb5a0782756fe6126952794af3bc78f994eb990842b244dab3160a8a820c9da301
+  data.tar.gz: f0e114472f942b4a45fab68414ca1a39b0e3adbc858682a6cf6574e2d0c871e25fe7c064f5574e37cf90dcd090e596e997437001045feb8f1f6bb439234d1809

data/lib/virtuaservices.rb

@@ -1,9 +1,19 @@
 require 'mongoid'
+require 'active_model'
+require 'active_support'
+require 'sinatra/base'
+require 'sinatra/config_file'
+require 'platform-api'
+require 'faraday'
+require 'sinatra/custom_logger'
+require 'dotenv/load'
 
 module Virtuaservices
   autoload :Account       , 'virtuaservices/account'
   autoload :Authentication, 'virtuaservices/authentication'
   autoload :Concerns      , 'virtuaservices/concerns'
+  autoload :Decorators    , 'virtuaservices/decorators'
+  autoload :Factories     , 'virtuaservices/factories'
   autoload :Monitoring    , 'virtuaservices/monitoring'
   autoload :OAuth         , 'virtuaservices/oauth'
   autoload :Permissions   , 'virtuaservices/permissions'

data/lib/virtuaservices/decorators.rb

@@ -0,0 +1,8 @@
+module Virtuaservices
+  # Decorators are used to enrich the features of the model classes without making it too big.
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
+  module Decorators
+    autoload :Gateway, 'virtuaservices/decorators/gateway'
+    autoload :Errors , 'virtuaservices/decorators/errors'
+  end
+end

data/lib/virtuaservices/decorators/errors.rb

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

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

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

data/lib/virtuaservices/decorators/gateway.rb

@@ -0,0 +1,109 @@
+module Virtuaservices
+  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 [Virtuaservices::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 [Virtuaservices::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 [Virtuaservices::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 [Virtuaservices::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 [Virtuaservices::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 Virtuaservices::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/virtuaservices/factories.rb

@@ -0,0 +1,8 @@
+module Virtuaservices
+  # Static factories are used to create decorated objects easily.
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
+  module Factories
+    autoload :Gateways, 'virtuaservices/factories/gateways'
+    autoload :Errors  , 'virtuaservices/factories/errors'
+  end
+end

data/lib/virtuaservices/factories/errors.rb

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

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

@@ -0,0 +1,14 @@
+module Virtuaservices
+  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 < Virtuaservices::Utils::Errors::HTTPError
+
+        def initialize(action:)
+          super(action, 'gateway_id', 'not_found', 404)
+        end
+      end
+    end
+  end
+end

data/lib/virtuaservices/factories/gateways.rb

@@ -0,0 +1,19 @@
+module Virtuaservices
+  module Factories
+    # This class provides methods to create decorated services.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Gateways
+
+      # Searches for a gateway via its key and returns it decorated.
+      # @param key [String] the key of the server you want to find.
+      # @return [Virtuaservices::Decorators::Gateway, NilClass] nil if the gateway is not found, or the decorated gateway.
+      def self.random(action)
+        gateway = Virtuaservices::Monitoring::Gateway.where(active: true, running: true).first
+        if gateway.nil?
+          raise Virtuaservices::Factories::Errors::GatewayNotFound.new(action: action)
+        end
+        return Virtuaservices::Decorators::Gateway.new(action, gateway)
+      end
+    end
+  end
+end

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

@@ -1,9 +1,9 @@
-module Arkaan
+module Virtuaservices
   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
+      class Forbidden < Virtuaservices::Utils::Errors::HTTPError
 
         def initialize (field:, action:, error:)
           super(action, field, error, 403)

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

@@ -1,4 +1,4 @@
-module Arkaan
+module Virtuaservices
   module Utils
     module Errors
       # Standard class parent to all specialized http errors.

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

@@ -1,9 +1,9 @@
-module Arkaan
+module Virtuaservices
   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
+      class NotFound < Virtuaservices::Utils::Errors::HTTPError
 
         def initialize (field:, action:, error:)
           super(action, field, error, 404)

data/lib/virtuaservices/version.rb

@@ -1,3 +1,3 @@
 module Virtuaservices
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: virtuaservices
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Vincent Courtois
@@ -267,6 +267,14 @@ files:
 - lib/virtuaservices/concerns/premiumable.rb
 - lib/virtuaservices/concerns/sluggable.rb
 - lib/virtuaservices/concerns/typable.rb
+- lib/virtuaservices/decorators.rb
+- lib/virtuaservices/decorators/errors.rb
+- lib/virtuaservices/decorators/errors/env_variable_missing.rb
+- lib/virtuaservices/decorators/gateway.rb
+- lib/virtuaservices/factories.rb
+- lib/virtuaservices/factories/errors.rb
+- lib/virtuaservices/factories/errors/gateway_not_found.rb
+- lib/virtuaservices/factories/gateways.rb
 - lib/virtuaservices/monitoring.rb
 - lib/virtuaservices/monitoring/gateway.rb
 - lib/virtuaservices/monitoring/instance.rb