easyllama-client 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b275fa080c57dc300bb5d804413e54a90b69b04d58732db4e72286a03bc009f4
-  data.tar.gz: 23255762cc3409dfd092ef45ec3e089b455ed6f43097ad0faa5b24749c8bee91
+  metadata.gz: 89c72f06cf5a96eb1435d7578385620ebd1867d16ff897203b59c9b38151026b
+  data.tar.gz: 2130a6de5397b3fe31b9e1966ae6c4f060cef422549e51a6ec311c9b1acd4788
 SHA512:
-  metadata.gz: b59d2271d6987a6676cd7603dff54391d5dfbdd2793d7bf0133d2bec6950ba07ab19584f8289ca93fb6a491b6c7c5cb813b055d2f8d1750eaf827ad6da08af91
-  data.tar.gz: 946e1fa2c7ddfbb15a588841e8114eb714fb94a3a89d433c7201cd4972a4be1d889be3f0b0548cb9aee23835474bbf01ab5a956596522cbe3cf22169ccf46799
+  metadata.gz: 26bb01a590bb52623b2652b3ad401c2b8030eeed0bb8d61b03749ca9eff32d20902f9b207dda6b8995e860cba05004f100e99deadbf5a290af5c0494b662bb62
+  data.tar.gz: 3c05919297b58408454ac74ec1d572859ab1adb7429e40e79f7b628fabdccf088be1b95aca38071a9f908ec73656ce95369c6b5b3740cbe1d1da7178f8a49541

data/lib/easyllama/client/version.rb

@@ -2,6 +2,6 @@
 
 module Easyllama
   module Client
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

data/lib/easyllama/client.rb

@@ -27,16 +27,19 @@ module EasyLlama
 
       # Parses the response body and returns the value corresponding to the provided key.
       # If the response is successful, returns the value for the key.
-      # If the response is unsuccessful, returns an error message.
+      # If the response is unsuccessful, returns an error code and message.
       #
       # @param response [Net::HTTPResponse] The HTTP response.
       # @param key [String] The key to retrieve from the response body.
-      # @return [Object] The value corresponding to the key or an error message.
-      def response_body(response, key)
+      # @return [Object] The empty hash, parsed response body, value corresponding to the key or error code and message.
+      def parse_response(response, key = nil)
         if response.is_a?(Net::HTTPSuccess)
+          return {} if response.body.nil?
+          return JSON.parse(response.body) if key.nil?
+
           JSON.parse(response.body)[key]
         else
-          { 'error' => response.message }
+          { 'code' => response.code, 'error' => response.message }
         end
       end
 

data/lib/easyllama/learners.rb

@@ -2,6 +2,7 @@
 
 module EasyLlama
   class Client
+    # This class provides methods for interacting with the Easy Llama API for learners.
     class Learners
       class << self
         # Sends a GET request to retrieve all learners.
@@ -9,7 +10,8 @@ module EasyLlama
         # @return [Object] The learners or an error message.
         def all
           response = EasyLlama::Client.send_request(path: '/learners')
-          EasyLlama::Client.response_body(response, 'learners')
+
+          EasyLlama::Client.parse_response(response, 'learners')
         end
 
         # Sends a GET request to retrieve a learner by ID.
@@ -18,7 +20,8 @@ module EasyLlama
         # @return [Object] The learner or an error message.
         def find(id)
           response = EasyLlama::Client.send_request(path: "/learners/#{id}")
-          EasyLlama::Client.response_body(response, 'learner')
+
+          EasyLlama::Client.parse_response(response, 'learner')
         end
 
         # Sends a POST request to create a learner.
@@ -27,7 +30,8 @@ module EasyLlama
         # @return [Object] The created learner or an error message.
         def create(learner_attributes = {})
           response = EasyLlama::Client.send_request(path: '/learners', method: :post, body: learner_attributes)
-          EasyLlama::Client.response_body(response, 'learner')
+
+          EasyLlama::Client.parse_response(response, 'learner')
         end
 
         # Sends a PATCH request to update a learner by ID.
@@ -37,17 +41,33 @@ module EasyLlama
         # @return [Object] The updated learner or an error message.
         def update(id, learner_attributes = {})
           response = EasyLlama::Client.send_request(path: "/learners/#{id}", method: :patch, body: learner_attributes)
-          EasyLlama::Client.response_body(response, 'learner')
+
+          EasyLlama::Client.parse_response(response, 'learner')
         end
 
         # Sends a POST request to assign a training to a learner.
         #
         # @param training_id [Integer] The ID of the training.
         # @param learner_id [Integer] The ID of the learner.
-        # @return [Object] The assignment details or an error message.
+        # @return [Object] The training assignment details or an error message.
         def assign_training_to_learner(training_id:, learner_id:)
-          response = EasyLlama::Client.send_request(path: "/learners/#{learner_id}/learner_trainings", method: :post, body: { learner_id:, training_id: })
-          EasyLlama::Client.response_body(response, 'assignment')
+          response = EasyLlama::Client.send_request(
+            path: "/learners/#{learner_id}/learner_trainings",
+            method: :post,
+            body: { learner_id:, training_id: }
+          )
+
+          EasyLlama::Client.parse_response(response)
+        end
+
+        # Sends a DELETE request to archive a learner by ID.
+        #
+        # @param id [Integer] The ID of the learner.
+        # @return [Object] The updated learner or an error message.
+        def archive(id)
+          response = EasyLlama::Client.send_request(path: "/learners/#{id}", method: :delete)
+
+          EasyLlama::Client.parse_response(response)
         end
       end
     end

data/lib/easyllama/locations.rb

@@ -2,6 +2,7 @@
 
 module EasyLlama
   class Client
+    # This class provides methods for interacting with the Easy Llama API for locations.
     class Locations
       class << self
         # Sends a GET request to retrieve all locations.
@@ -9,7 +10,8 @@ module EasyLlama
         # @return [Object] The locations or an error message.
         def all
           response = EasyLlama::Client.send_request(path: '/locations')
-          EasyLlama::Client.response_body(response, 'locations')
+
+          EasyLlama::Client.parse_response(response, 'locations')
         end
 
         # Sends a POST request to create a location.
@@ -18,7 +20,8 @@ module EasyLlama
         # @return [Object] The created location or an error message.
         def create(location_attributes = {})
           response = EasyLlama::Client.send_request(path: '/locations', method: :post, body: location_attributes)
-          EasyLlama::Client.response_body(response, 'location')
+
+          EasyLlama::Client.parse_response(response, 'location')
         end
       end
     end

data/lib/easyllama/trainings.rb

@@ -2,6 +2,7 @@
 
 module EasyLlama
   class Client
+    # This class provides methods for interacting with the Easy Llama API for trainings.
     class Trainings
       class << self
         # Sends a GET request to retrieve all trainings.
@@ -9,7 +10,8 @@ module EasyLlama
         # @return [Object] The trainings or an error message.
         def all
           response = EasyLlama::Client.send_request(path: '/trainings')
-          EasyLlama::Client.response_body(response, 'trainings')
+
+          EasyLlama::Client.parse_response(response, 'trainings')
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easyllama-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Vitalii Kashoid