arkaan 0.10.23 → 0.10.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 572e451be0e72248cf6c0ed386d2a8da6755cf4a
-  data.tar.gz: 8392d4f80339b7fd7b20d3006eed6a19f6e5cffa
+  metadata.gz: 10054ec59c36dfb69ce43553469e07bb156c83f0
+  data.tar.gz: 21822cb99ab1c672e796096cda30ec9ccef4fb01
 SHA512:
-  metadata.gz: 7c5c1b394e0ec3c58b708c80c7cca2f4c87afb124b7cc912a065cbf0d0042af607fabb039e7b01344d26d05d522f6f5b0088c54da53cb80b367d41b249fefd1e
-  data.tar.gz: 689b8668b590b407006dea0af733fb270299d9736086f40d1d321b01da1e984740d97e729b06bcc47b721057c7d446526eb4af477b11fed8ff4452fe4b06d665
+  metadata.gz: 9077ac7f917c9a13257dff98cf3528a84e3bde30ea5af7ed045f434cb98eea760e9ace89a5ca226443d1b63b230aaba71403ad326cc876839693387d81e60747
+  data.tar.gz: fdc7509b41a13c14d279b7ff05ad76d19437b7ef69607b224e097a9dd5710553dadc478d33391ca975b26076b642e8936e77218f98216173eed6f786e1f7323e

data/lib/arkaan.rb

@@ -5,6 +5,7 @@ require 'sinatra/base'
 require 'sinatra/config_file'
 require 'platform-api'
 require 'draper'
+require 'faraday'
 
 # Main module of the application, holding all the subsequent classes.
 # @author Vincent Courtois <courtois.vincent@outlook.com>

data/lib/arkaan/decorators/gateway.rb

@@ -14,29 +14,67 @@ module Arkaan
         @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(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(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 route [String] the URL you want to reach on the service.
-      # @param parameters [Hash] the additional parameters to pass in the JSON body.
+      # @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 post(route, parameters)
+      def make_request(verb:, session:, url:, params:)
         if ENV['APP_KEY'].nil?
-          raise Arkaan::Decorators::Errors::EnvVariableMissing.new(action)
+          raise Arkaan::Decorators::Errors::EnvVariableMissing.new(action: action)
         end
-        parameters[:app_key] = ENV['APP_KEY']
-        connection = Faraday.new(object.url) do
+        params[:app_key] = ENV['APP_KEY']
+        params[:session_d] = session.token
+        connection = Faraday.new(object.url) do |faraday|
           faraday.request  :url_encoded
           faraday.response :logger
           faraday.adapter  Faraday.default_adapter
         end
-        responde = connection.post do |req|
-          req.url route
+        responde = connection.send(verb) do |req|
+          req.url url
           req.headers['Content-Type'] = 'application/json'
-          req.body = parameters.to_json
+          req.body = params.to_json
         end
         return {
           status: response.status,

data/lib/arkaan/factories/gateways.rb

@@ -10,7 +10,7 @@ module Arkaan
       def self.random(action)
         gateway = Arkaan::Monitoring::Gateway.where(active: true, running: true).first
         if gateway.nil?
-          raise Arkaan::Factories::Errors::GatewayNotFound.new(action)
+          raise Arkaan::Factories::Errors::GatewayNotFound.new(action: action)
         end
         return Arkaan::Decorators::Gateway.new(action, gateway)
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 0.10.23
+  version: 0.10.24
 platform: ruby
 authors:
 - Vincent Courtois
@@ -234,6 +234,20 @@ dependencies:
     - - '='
       - !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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem holds the model layer for my table-top RPG games application.
 email: courtois.vincent@outlook.com
 executables: []