easyllama-client 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9148ba219056e97f195875a8aec77ee9f3aa3b11d21356af8da2b18987dfd126
-  data.tar.gz: c7fe8a6bc289ae159f72509dd5ed2a745517b867a57ec62913082c18c3320415
+  metadata.gz: e1ffbbb8a0986c23d5f09b3d8550629f028d2d97589ff462f134c5a4368fd8d8
+  data.tar.gz: 7be45f553af3491b6b5c15b7da1caaac5893259d3a8972b392e9aa2a1f445de1
 SHA512:
-  metadata.gz: 19b32f437da95f1a010f89ccc3bf89f8938ef5838d4722cdf4f1634b66dff8775efc71168cacd8c6d02515f8b1e3e107bad7a96b316b70997cdb372afd73e424
-  data.tar.gz: 0e82fb94ff4773260861dfe11361bf5ff89530489cc23927c40be159afb67a040a0e55732b08a858a05c209e4decd939bf3f66bed7dac001c806dc2317af1e62
+  metadata.gz: 629a934fa5ccfb8a8dad78ac51501844d3283c8ef670be906964e5aef6816594b9c2f468c55c92bdd6d56a2d47c67a42280d5d829ad839008898e1c0fde2351f
+  data.tar.gz: 7e8e4ecdc91a01704c4636a6e52f9331d7e5a902480441d7c435658cd75efa6d0acde4c1fe08dbf93737804f035f4520d8f490cc3cb7956f0a3f71fe135fceec

data/lib/easyllama/api.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module EasyLlama
+  class Client
+    # This class provides methods for interacting with the Easy Llama API.
+    class Api
+      DEFAULT_URI_BASE = 'https://api.easyllama.com/api/'
+      DEFAULT_API_VERSION = 'v1'
+
+      # Initializes the API client.
+      #
+      # @param token [String] The token.
+      # @return [String] The token.
+      def initialize(token)
+        @token = token
+
+        super()
+      end
+
+      # Sends an HTTP request to the specified path.
+      #
+      # @param path [String] The path of the API endpoint.
+      # @param method [Symbol] The HTTP method (:get, :post, :put, :patch, :delete).
+      # @param body [Hash] The request body (optional).
+      # @return [Net::HTTPResponse] The HTTP response.
+      def send_request(path: nil, method: :get, body: nil)
+        raise ArgumentError, 'Please provide EasyLlama::Client.api_token' if @token.nil?
+
+        uri = build_uri(path)
+        request = build_request(uri, method, body)
+        execute_request(uri, request)
+      end
+
+      # Parses the response body.
+      # If the response is successful, returns the value for the key.
+      # 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 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
+          { 'code' => response.code, 'error' => response.message }
+        end
+      end
+
+      private
+
+      def build_uri(path)
+        URI("#{DEFAULT_URI_BASE}#{DEFAULT_API_VERSION}#{path}")
+      end
+
+      def build_request(uri, method, body)
+        request = http_method_class(method).new(uri)
+        request['content-type'] = 'application/json'
+        request['accept'] = 'application/json'
+        request['authorization'] = "Bearer #{@token}"
+        request.body = body.to_json if body.present?
+        request
+      end
+
+      def execute_request(uri, request)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.request(request)
+      end
+
+      def http_method_class(method)
+        case method
+        when :get then Net::HTTP::Get
+        when :post then Net::HTTP::Post
+        when :put then Net::HTTP::Put
+        when :patch then Net::HTTP::Patch
+        when :delete then Net::HTTP::Delete
+        else raise ArgumentError, "Http method #{method} not recognized in EasyLlama::Client"
+        end
+      end
+    end
+  end
+end

data/lib/easyllama/client/version.rb

@@ -2,6 +2,6 @@
 
 module EasyLlama
   module Client
-    VERSION = '0.1.3'
+    VERSION = '0.2.0'
   end
 end

data/lib/easyllama/client.rb

@@ -3,76 +3,28 @@
 require 'net/http'
 require 'json'
 
+require_relative 'api'
+require_relative 'oauth'
 require_relative 'locations'
 require_relative 'learners'
 require_relative 'trainings'
 
 module EasyLlama
-  # This class provides methods for interacting with the Easy Llama API.
+  # This class provides methods for interacting with the Easy Llama API interface.
   class Client
     class << self
-      API_ROOT = 'https://api.easyllama.com/api/v1'
+      attr_accessor :api_token
 
-      # Sends an HTTP request to the specified path.
-      #
-      # @param path [String] The path of the API endpoint.
-      # @param method [Symbol] The HTTP method (:get, :post, :put, :patch, :delete).
-      # @param body [Hash] The request body (optional).
-      # @return [Net::HTTPResponse] The HTTP response.
-      def send_request(path: nil, method: :get, body: nil)
-        uri = build_uri(path)
-        request = build_request(uri, method, body)
-        execute_request(uri, request)
+      def locations
+        Locations.new(api_token)
       end
 
-      # Parses the response body.
-      # If the response is successful, returns the value for the key.
-      # 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 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
-          { 'code' => response.code, 'error' => response.message }
-        end
-      end
-
-      private
-
-      def build_uri(path)
-        URI("#{API_ROOT}#{path}")
-      end
-
-      def build_request(uri, method, body)
-        request = http_method_class(method).new(uri)
-        request['content-type'] = 'application/json'
-        request['accept'] = 'application/json'
-        request['authorization'] = "Bearer #{ENV['EASY_LLAMA_API_TOKEN']}"
-        request.body = body.to_json if body.present?
-        request
-      end
-
-      def execute_request(uri, request)
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = true
-        http.request(request)
+      def learners
+        Learners.new(api_token)
       end
 
-      def http_method_class(method)
-        case method
-        when :get then Net::HTTP::Get
-        when :post then Net::HTTP::Post
-        when :put then Net::HTTP::Put
-        when :patch then Net::HTTP::Patch
-        when :delete then Net::HTTP::Delete
-        else raise ArgumentError, "Http method #{method} not recognized in EasyLlama::Client"
-        end
+      def trainings
+        Trainings.new(api_token)
       end
     end
   end

data/lib/easyllama/learners.rb

@@ -3,72 +3,70 @@
 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.
-        #
-        # @return [Object] The learners or an error message.
-        def all
-          response = EasyLlama::Client.send_request(path: '/learners')
+    class Learners < Api
+      # Sends a GET request to retrieve all learners.
+      #
+      # @return [Object] The learners or an error message.
+      def all
+        response = send_request(path: '/learners')
 
-          EasyLlama::Client.parse_response(response, 'learners')
-        end
+        parse_response!(response, 'learners')
+      end
 
-        # Sends a GET request to retrieve a learner by ID.
-        #
-        # @param id [Integer] The ID of the learner.
-        # @return [Object] The learner or an error message.
-        def find(id)
-          response = EasyLlama::Client.send_request(path: "/learners/#{id}")
+      # Sends a GET request to retrieve a learner by ID.
+      #
+      # @param id [Integer] The ID of the learner.
+      # @return [Object] The learner or an error message.
+      def find(id)
+        response = send_request(path: "/learners/#{id}")
 
-          EasyLlama::Client.parse_response(response, 'learner')
-        end
+        parse_response!(response, 'learner')
+      end
 
-        # Sends a POST request to create a learner.
-        #
-        # @param learner_attributes [Hash] The attributes of the learner.
-        # @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)
+      # Sends a POST request to create a learner.
+      #
+      # @param learner_attributes [Hash] The attributes of the learner.
+      # @return [Object] The created learner or an error message.
+      def create(learner_attributes = {})
+        response = send_request(path: '/learners', method: :post, body: learner_attributes)
 
-          EasyLlama::Client.parse_response(response, 'learner')
-        end
+        parse_response!(response, 'learner')
+      end
 
-        # Sends a PATCH request to update a learner by ID.
-        #
-        # @param id [Integer] The ID of the learner.
-        # @param learner_attributes [Hash] The attributes to update.
-        # @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)
+      # Sends a PATCH request to update a learner by ID.
+      #
+      # @param id [Integer] The ID of the learner.
+      # @param learner_attributes [Hash] The attributes to update.
+      # @return [Object] The updated learner or an error message.
+      def update(id, learner_attributes = {})
+        response = send_request(path: "/learners/#{id}", method: :patch, body: learner_attributes)
 
-          EasyLlama::Client.parse_response(response, 'learner')
-        end
+        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 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: }
-          )
+      # 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 training assignment details or an error message.
+      def assign_training_to_learner(training_id:, learner_id:)
+        response = send_request(
+          path: "/learners/#{learner_id}/learner_trainings",
+          method: :post,
+          body: { learner_id:, training_id: }
+        )
 
-          EasyLlama::Client.parse_response(response)
-        end
+        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)
+      # 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 = send_request(path: "/learners/#{id}", method: :delete)
 
-          EasyLlama::Client.parse_response(response)
-        end
+        parse_response!(response)
       end
     end
   end

data/lib/easyllama/locations.rb

@@ -3,26 +3,24 @@
 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.
-        #
-        # @return [Object] The locations or an error message.
-        def all
-          response = EasyLlama::Client.send_request(path: '/locations')
+    class Locations < Api
+      # Sends a GET request to retrieve all locations.
+      #
+      # @return [Object] The locations or an error message.
+      def all
+        response = send_request(path: '/locations')
 
-          EasyLlama::Client.parse_response(response, 'locations')
-        end
+        parse_response!(response, 'locations')
+      end
 
-        # Sends a POST request to create a location.
-        #
-        # @param location_attributes [Hash] The attributes of the location.
-        # @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)
+      # Sends a POST request to create a location.
+      #
+      # @param location_attributes [Hash] The attributes of the location.
+      # @return [Object] The created location or an error message.
+      def create(location_attributes = {})
+        response = send_request(path: '/locations', method: :post, body: location_attributes)
 
-          EasyLlama::Client.parse_response(response, 'location')
-        end
+        parse_response!(response, 'location')
       end
     end
   end

data/lib/easyllama/oauth.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module EasyLlama
+  class Client
+    # This class provides methods for interacting with the Easy Llama API for OAuth.
+    class OAuth < Api
+      # Initializes the OAuth client.
+      #
+      # @param client_id [String] The client ID.
+      # @param client_secret [String] The client secret.
+      # @return [Object] The Easy Llama API client.
+      def initialize(client_id, client_secret)
+        access_token = get_access_token(client_id, client_secret)
+
+        EasyLlama::Client.api_token = access_token
+
+        super access_token
+      end
+
+      private
+
+      def get_access_token(client_id, client_secret)
+        response = send_request(
+          path: '/oauth/token',
+          method: :post,
+          body: {
+            client_id:,
+            client_secret:,
+            grant_type: 'client_credentials'
+          }
+        )
+
+        parse_response!(response, 'access_token')
+      end
+    end
+  end
+end

data/lib/easyllama/trainings.rb

@@ -3,16 +3,14 @@
 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.
-        #
-        # @return [Object] The trainings or an error message.
-        def all
-          response = EasyLlama::Client.send_request(path: '/trainings')
+    class Trainings < Api
+      # Sends a GET request to retrieve all trainings.
+      #
+      # @return [Object] The trainings or an error message.
+      def all
+        response = send_request(path: '/trainings')
 
-          EasyLlama::Client.parse_response(response, 'trainings')
-        end
+        parse_response!(response, 'trainings')
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easyllama-client
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Vitalii Kashoid
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-16 00:00:00.000000000 Z
+date: 2024-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -45,10 +45,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/easyllama/api.rb
 - lib/easyllama/client.rb
 - lib/easyllama/client/version.rb
 - lib/easyllama/learners.rb
 - lib/easyllama/locations.rb
+- lib/easyllama/oauth.rb
 - lib/easyllama/trainings.rb
 homepage: https://rubygems.org/gems/easyllama-client
 licenses: