arkaan 0.10.21 → 0.10.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9e5590c7b5776567dfca8179a55c9ea24ddd76c
-  data.tar.gz: 359cd55594d85a2146c2b3bcbbea688b8a83f503
+  metadata.gz: 9558fd9ac23d57362899823ae089ac10ff78e1e0
+  data.tar.gz: 27f9532aeedb7b456676b74ebc4c57b95ec45a0a
 SHA512:
-  metadata.gz: 7d9d612b8ae8dabb4ed92c673daa203dae96984cb7758b4c69641ebac359589787bf22c4874923d4d717c2a12690b82e945e570874cc8f99e1edaadd73856734
-  data.tar.gz: c969f7ebef770b1ddf1f3820a3f8f36916e27b5f6b48be70e003b2204b36b4af540ff45bcb9859f54d08556972d2dc8ed7edaa81dcf2ff59d419c94cae40f6f4
+  metadata.gz: 593bfc4c2d2db36b11f64cf7feb5dcd0bb861563fc67616f872ba48c500a85ac1b952f7de2461fab3c5799ad41b970511479f253eebb9eb360112e95efe24b0d
+  data.tar.gz: 894e993156092a369acb3a0de1ceedcab5f16d4f0f2f34bc1287216f43b4e02eb8c6a7644113efcb92413183ac0775ab85d132cea3891e002036b74498dc1c31

data/lib/arkaan.rb

@@ -14,7 +14,7 @@ module Arkaan
   autoload :Campaigns     , 'arkaan/campaigns'
   autoload :Concerns      , 'arkaan/concerns'
   autoload :Dacorators    , 'arkaan/decorators'
-  autoload :Phone         , 'arkaan/factories'
+  autoload :Factories     , 'arkaan/factories'
   autoload :Monitoring    , 'arkaan/monitoring'
   autoload :OAuth         , 'arkaan/oauth'
   autoload :Permissions   , 'arkaan/permissions'

data/lib/arkaan/decorators.rb

@@ -2,6 +2,7 @@ module Arkaan
   # 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 :Service, 'arkaan/decorators/service'
+    autoload :Gateway, 'arkaan/decorators/gateway'
+    autoload :Errors , 'arkaan/decorators/errors'
   end
 end

data/lib/arkaan/decorators/errors.rb

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,14 @@
+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/{service.rb → gateway.rb}

@@ -2,9 +2,18 @@ module Arkaan
   module Decorators
     # Decorator for a service, providing methods to make requests on it.
     # @author Vincent Courtois <courtois.vincent@outlook.com>
-    class Service < Draper::Decorator
+    class Gateway < Draper::Decorator
       delegate_all
 
+      # @!attribute [rw] action
+      #   @return [String] the action of the route using this API.
+      attr_accessor :action
+
+      def initialize(action, _object)
+        super(_object)
+        @action = action
+      end
+
       # 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.
@@ -15,9 +24,11 @@ module Arkaan
       # @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 post(route, parameters)
-        instance = object.instances.where(active: true, running: true).first
-        return false if instance.nil?
-        connection = Faraday.new(instance.url) do
+        if ENV['APP_KEY'].nil?
+          raise Arkaan::Decorators::Errors::EnvVariableMissing.new(action)
+        end
+        parameters[:app_key] = ENV['APP_KEY']
+        connection = Faraday.new(object.url) do
           faraday.request  :url_encoded
           faraday.response :logger
           faraday.adapter  Faraday.default_adapter

data/lib/arkaan/factories.rb

@@ -2,6 +2,7 @@ module Arkaan
   # Static factories are used to create decorated objects easily.
   # @author Vincent Courtois <courtois.vincent@outlook.com>
   module Factories
-    autoload :Services, 'arkaan/factories/services'
+    autoload :Gateways, 'arkaan/factories/gateways'
+    autoload :Errors  , 'arkaan/factories/errors'
   end
 end

data/lib/arkaan/factories/errors.rb

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,14 @@
+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/factories/gateways.rb

@@ -0,0 +1,19 @@
+module Arkaan
+  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 [Arkaan::Decorators::Gateway, NilClass] nil if the gateway is not found, or the decorated gateway.
+      def self.random(action)
+        gateway = Arkaan::Monitoring::Gateway.where(active: true, running: true).first
+        if gateway.nil?
+          raise Arkaan::Factories::Errors::GatewayNotFound.new(action)
+        end
+        return Arkaan::Decorators::Gateway.new(action, gateway)
+      end
+    end
+  end
+end

data/lib/arkaan/utils/controller_without_filter.rb

@@ -138,6 +138,14 @@ module Arkaan
       error Arkaan::Utils::Errors::NotFound do |exception|
         handle_arkaan_exception(exception)
       end
+
+      error Arkaan::Factories::Errors::GatewayNotFound do |exception|
+        handle_arkaan_exception(exception)
+      end
+
+      error StandardError do
+        custom_error(500, 'system_error.unknown_field.unknown_error')
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 0.10.21
+  version: 0.10.22
 platform: ruby
 authors:
 - Vincent Courtois
@@ -241,9 +241,13 @@ files:
 - lib/arkaan/concerns/premiumable.rb
 - lib/arkaan/concerns/sluggable.rb
 - lib/arkaan/decorators.rb
-- lib/arkaan/decorators/service.rb
+- lib/arkaan/decorators/errors.rb
+- lib/arkaan/decorators/errors/env_variable_missing.rb
+- lib/arkaan/decorators/gateway.rb
 - lib/arkaan/factories.rb
-- lib/arkaan/factories/services.rb
+- lib/arkaan/factories/errors.rb
+- lib/arkaan/factories/errors/gateway_not_found.rb
+- lib/arkaan/factories/gateways.rb
 - lib/arkaan/monitoring.rb
 - lib/arkaan/monitoring/action.rb
 - lib/arkaan/monitoring/gateway.rb

data/lib/arkaan/factories/services.rb

@@ -1,17 +0,0 @@
-module Arkaan
-  module Factories
-    # This class provides methods to create decorated services.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    class Services
-
-      # Searches for a service via its key and returns it decorated.
-      # @param key [String] the key of the server you want to find.
-      # @return [Arkaan::Decorators::Service, NilClass] nil if the service is not found, or the decorated service.
-      def self.search(key)
-        service = Arkaan::Monitoring::Service.where(key: key).first
-        return nil if service.nil?
-        return Arkaan::Decorators::Service.new(service)
-      end
-    end
-  end
-end