virtuatable 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cd86829736be01f12a1db35c85f32513ad867d7d1da90653e5ea72daaab4b6c
-  data.tar.gz: 91c4df3d59ad15bbd01863dda00b579dbfe036c784c1032811e38ad2be74afe0
+  metadata.gz: 514569bd58f7fea17204a3f89f5d0404286204311430bfe72c9d54e4c5c40886
+  data.tar.gz: 53c6187ab3c547bf9ce3ab5213db35606626cbc374eddc7ac65b6eef6e9361db
 SHA512:
-  metadata.gz: a898038115a0536877da85e88106e41ddba528980ef1e5cd3ae19c2a6781ecf2e3ab91b63ef63de9a061cdcaf6409ad8a0fe7d2a3d791ef0e0244480cb316535
-  data.tar.gz: db2d41f21c9da67b47394643485df87f90c8b0d8b9727ab0d3a8098ca84e4fc811cd47d2db264b2bb58b56413360609d97035818a2c867bda9728581e75afcee
+  metadata.gz: 2d4890c76a8ee25542c82a16c77bbb5b17e289f6c7ce2c4d2d5b1a3a3e91469f66f3db60f58dc35115dd76eba3713077f3b4e0a9b2758bc7a73aa3497c6a0a8c
+  data.tar.gz: 160aadc26b64faf46c7c3cb62a127db92b31888a5acea04497eaae1911c684a4848405c233af1517d9a67e0a56e37df2035c6c8b383dc42b5866329adc49e850

data/lib/virtuatable/api/responses.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module API
+    # Modules holding the responses that are NOT errors.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Responses
+      # Builds a list of items as a standard API response.
+      # The response will be a JSON hash containing two keys :
+      # - :count will hold the number of items displayed in the list
+      # - :items will hold the list of items.
+      # @param items [Array] the items to format as a standard API response.
+      def api_list(items)
+        halt 200, {
+          count: items.count,
+          items: items.map(&:to_h)
+        }.to_json
+      end
+
+      # Displays a creation standard response,
+      # returning the informations about the created item.
+      # @param item [Object] any object that responds to #to_h to display to the user.
+      def api_created(item)
+        halt 201, item.to_h.to_json
+      end
+
+      # Displays an item with the standards of the API.
+      # @param item [Object] the item to display as a JSON formatted hash.
+      def api_item(item)
+        halt 200, item.to_h.to_json
+      end
+
+      # Displays a message with a 200 status code
+      # @param message [String] the message to display with the API standards.
+      def api_ok(message)
+        api_item({message: message})
+      end
+    end
+  end
+end

data/lib/virtuatable/api.rb

@@ -6,5 +6,6 @@ module Virtuatable
   # @author Vincent Courtois <courtois.vincent@outlook.com>
   module API
     autoload :Errors, 'virtuatable/api/errors'
+    autoload :Responses, 'virtuatable/api/responses'
   end
 end

data/lib/virtuatable/application.rb

@@ -19,7 +19,7 @@ module Virtuatable
         path: path,
         name: name
       )
-      self.instance.builder = builder
+      instance.builder = builder
       builder.load!
       builder
     end
@@ -32,7 +32,7 @@ module Virtuatable
         path: path,
         name: name
       )
-      self.instance.builder = builder
+      instance.builder = builder
       builder.load!
       builder
     end

data/lib/virtuatable/builders/base.rb

@@ -81,8 +81,8 @@ module Virtuatable
       # Gets the loaders of the current class and all its ancestors that have loaders
       # @return [Array<Symbol>] the name of the loaders declared.
       def all_loaders
-        superclasses = sanitized_ancestors.select do |ancestor|
-          ancestor != self.class
+        superclasses = sanitized_ancestors.reject do |ancestor|
+          ancestor == self.class
         end
         ancestors_loaders = superclasses.map do |ancestor|
           ancestor.respond_to?(:loaders) ? ancestor.loaders : []

data/lib/virtuatable/builders/helpers/loaders.rb

@@ -13,7 +13,7 @@ module Virtuatable
         # Declares a loader in the current builder class.
         # @param loader [Symbol] the name of the loader, infered as the method name to call.
         def declare_loader(loader, priority:)
-          loader_h = {name: loader.to_sym, priority: priority}
+          loader_h = { name: loader.to_sym, priority: priority }
           @loaders.nil? ? @loaders = [loader_h] : @loaders << loader_h
         end
       end

data/lib/virtuatable/builders/helpers/registration.rb

@@ -23,7 +23,7 @@ module Virtuatable
         # Registers the service in the micro-services registry (consisting in
         # the arkaan_monitoring_services and arkaan_monitoring_instances collections)
         def load_registration!
-          @service = Arkaan::Monitoring::Service.first_or_create!(
+          @service = Arkaan::Monitoring::Service.find_or_create_by!(
             key: @name,
             path: "/#{@name}"
           )

data/lib/virtuatable/controllers/base.rb

@@ -8,8 +8,9 @@ module Virtuatable
     class Base < Sinatra::Base
       register Sinatra::ConfigFile
       helpers Sinatra::CustomLogger
-      # Includes the custom errors throwers.
+      # Includes the custom errors throwers and responses helpers.
       include Virtuatable::API::Errors
+      include Virtuatable::API::Responses
       # Includes the checking methods for sessions.
       include Virtuatable::Helpers::Sessions
       # Include the checkers and getters for the API gateway.

data/lib/virtuatable/helpers/routes.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
 module Virtuatable
   module Helpers
+    # This module provides the #current_route method to get the current
+    # Arkaan::Monitoring::Route object from whithin sinatra routes.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
     module Routes
       def current_route
         splitted = request.env['sinatra.route'].split(' ')
@@ -10,4 +15,4 @@ module Virtuatable
       end
     end
   end
-end
+end

data/lib/virtuatable/specs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Virtuatable
   # This module holds all the logic for the specs tools for all micro services (shared examples and other things).
   # @author Vincent Courtois <courtois.vincent@outlook.com>
@@ -87,4 +89,4 @@ module Virtuatable
       end
     end
   end
-end
+end

data/lib/virtuatable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Virtuatable
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: virtuatable
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Vincent Courtois
@@ -360,6 +360,7 @@ files:
 - lib/virtuatable/api/errors/base.rb
 - lib/virtuatable/api/errors/forbidden.rb
 - lib/virtuatable/api/errors/not_found.rb
+- lib/virtuatable/api/responses.rb
 - lib/virtuatable/application.rb
 - lib/virtuatable/builders.rb
 - lib/virtuatable/builders/base.rb