kaze_client 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd31be1e3cb6ccd738c9646f50ad6096961f4b77f893373f38481f747a2c5442
-  data.tar.gz: 7f2081157ac8778d108e4629524e228ad67aaeabb38ad977b7eb362476d0e996
+  metadata.gz: 483e914296f78875d5a5eb30e3207f7f99d8db4c7bfddbc8440f3983e99f5605
+  data.tar.gz: ebb0a204c158f59fa6cdde4d04573b1beaeaa94b07f86b8b7815ce59c9e40ca0
 SHA512:
-  metadata.gz: 96c9f307c9d54f2d446d82e10f1ed795223a2679c3dc60dcc7dcfd1f3609bf90b78042552e34560fe2ef292ea35ec2f93a8dc744f12ba05dac7c4a76316417f7
-  data.tar.gz: 5645d82b34831f41eacd354e69a573a7e566c488dd6686e9b552e704953319c4733715bbe34e13efd9007af1e75ad122b9e6c33d5b3c923d312b4d37b8d17fc0
+  metadata.gz: c3006d994cb61c5b180449f58dce770ddb7f12cf3636cb3247b2b669f7ea387b3d4a71085645a1671d0aea0e298ba1f28db984227dbcc5c9d1e39809041ba0b7
+  data.tar.gz: a96e0bcd0089c80c89bed0573ff829d62e727f5b3e4d6de0b87b0a6b3158cb17bb1c5344fbd35bca8a52ced6b9466024365e004dc02fc704005e662a8b34615d

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# CHANGELOG
+
+## [0.3.1] - 2022-11-30
+
+- Update error handling for more clarity.
+
+## [0.3.0] - 2022-09-28
+
+- Add new requests:
+  - Cancel job
+  - Get job document
+  - List users
+  - Upload image
+
 ## [0.2.1] - 2022-06-17
 
 - Add methods and utilities to get and set data in the response.

data/lib/kaze_client/request/request.rb

@@ -10,7 +10,7 @@ module KazeClient
     # Those headers are added on all requests by default
     DEFAULT_HEADERS = {
       'Content-Type' => 'application/json',
-      'Accept' => 'application/json'
+      'Accept'       => 'application/json'
     }.freeze
 
     # @return [String, Symbol] The HTTP verb to use for the request
@@ -64,19 +64,12 @@ module KazeClient
     # @param response [HTTParty::Response] The response object from HTTParty call
     # @return [KazeClient::Error::Generic] The adequate error object according to the given response
     def error_for(response)
-      # Not found is handled in a specific way since there is no message key and the error has a
-      # specific format
-      return KazeClient::Error::NotFound.new if response.code == 404
+      error   = response.parsed_response['error']
+      message = response.parsed_response['message']
 
-      # Return the adequate error class for the error code in the response
-      "KazeClient::Error::#{response.parsed_response['error'].camelize}"
-        .constantize.new(response.parsed_response['message'])
-    rescue NameError
-      # This means no error class exists for the error code in the response, we fallback to a
-      # generic error
-      Error::Generic.new(status: response.code,
-                         error: response.parsed_response['error'],
-                         message: response.parsed_response['message'])
+      return non_generic_error(error, message, response) if error != 'generic'
+
+      generic_http_error(error, message, response)
     end
 
     protected
@@ -100,6 +93,8 @@ module KazeClient
         @body
       when Hash
         @body.to_json
+      else
+        @body.to_s
       end
     end
 
@@ -109,5 +104,30 @@ module KazeClient
 
       @query
     end
+
+    def non_generic_error(error, message, response)
+      # Return the adequate error class for the error code in the response
+      "KazeClient::Error::#{error.camelize}".constantize.new(message)
+    rescue NameError
+      # This means no error class exists for the error code in the response, we fallback to a
+      # generic error
+      Error::Generic.new(status: response.code, error: error, message: message)
+    end
+
+    def generic_http_error(error, message, response)
+      case response.code
+      when 401
+        KazeClient::Error::Unauthorized.new(message)
+      when 403
+        KazeClient::Error::Forbidden.new(message)
+      when 404
+        KazeClient::Error::NotFound.new
+      when 500
+        KazeClient::Error::InternalServerError.new(message)
+      else
+        # This means no error class exists for the response code, we fallback to a generic error
+        Error::Generic.new(status: response.code, error: error, message: message)
+      end
+    end
   end
 end

data/lib/kaze_client/request/requests/cancel_job_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module KazeClient
+  # @author chevre_a@modulotech.fr
+  # Cancel a job.
+  # @see KazeClient::Request
+  # @see KazeClient::Utils::FinalRequest
+  # @see KazeClient::Utils::AuthentifiedRequest
+  # @since 0.3.0
+  class CancelJobRequest < Utils::FinalRequest
+    include Utils::AuthentifiedRequest
+
+    def initialize(job_id, cancel_reason_id)
+      super(:put, "api/jobs/#{job_id}/cancel")
+
+      @body = {
+        job: { cancel_reason_id: cancel_reason_id }
+      }
+    end
+  end
+end

data/lib/kaze_client/request/requests/job_document_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module KazeClient
+  # @author chevre_a@modulotech.fr
+  # Retrieve a job document from a job.
+  # @see KazeClient::Request
+  # @see KazeClient::Utils::FinalRequest
+  # @see KazeClient::Utils::AuthentifiedRequest
+  # @since 0.3.0
+  class JobDocumentRequest < Utils::FinalRequest
+    include Utils::AuthentifiedRequest
+
+    def initialize(job_id, job_document_id)
+      super(:get, "api/jobs/#{job_id}/documents/#{job_document_id}")
+    end
+  end
+end

data/lib/kaze_client/request/requests/partners_request.rb

@@ -7,7 +7,7 @@ module KazeClient
   # @see KazeClient::Utils::FinalRequest
   # @see KazeClient::Utils::AuthentifiedRequest
   # @see KazeClient::Utils::ListRequest
-  # @since 0.1.0
+  # @since 0.1.1
   class PartnersRequest < Utils::FinalRequest
     include Utils::AuthentifiedRequest
     include Utils::ListRequest

data/lib/kaze_client/request/requests/upload_image_request.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module KazeClient
+  # @author pourch_t@modulotech.fr
+  # @author ciappa_m@modulotech.fr
+  # Upload an image to a job document from a job.
+  # @see KazeClient::Request
+  # @see KazeClient::Utils::FinalRequest
+  # @see KazeClient::Utils::AuthentifiedRequest
+  # @since 0.3.0
+  # @example How to use
+  #   request  = KazeClient::UploadImageRequest.new(Rails.root.join('public/images/test.jpg'))
+  #   response = KazeClient::Client.new(URL).execute(request)
+  #   request.send_image(response['direct_upload'])
+  class UploadImageRequest < Utils::FinalRequest
+
+    include Utils::AuthentifiedRequest
+
+    def initialize(filepath)
+      super(:post, 'api/direct_uploads')
+      @filepath = if filepath.is_a?(Pathname)
+                    filepath
+                  else
+                    Pathname.new(filepath.to_s)
+                  end
+      @filename = @filepath.basename.to_s
+
+      @body = {
+        blob: {
+          filename:     @filename,
+          byte_size:    File.size(@filepath),
+          checksum:     Digest::MD5.base64digest(@filepath.read),
+          content_type: "image/#{@filename.split('.')[1]}"
+        }
+      }
+    end
+
+    def send_image(direct_uploads)
+      body   = @filepath.read
+      header = direct_uploads['headers']
+      HTTParty.put(direct_uploads['url'], { body: body, headers: header })
+    end
+
+  end
+
+end

data/lib/kaze_client/request/requests/users_request.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module KazeClient
+  # @author chevre_a@modulotech.fr
+  # List the users from the current user's company.
+  # @see KazeClient::Request
+  # @see KazeClient::Utils::FinalRequest
+  # @see KazeClient::Utils::AuthentifiedRequest
+  # @since 0.3.0
+  class UsersRequest < Utils::FinalRequest
+    include Utils::AuthentifiedRequest
+    include Utils::ListRequest
+
+    def initialize
+      super(:get, 'api/users')
+    end
+  end
+end

data/lib/kaze_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KazeClient
-  VERSION = '0.2.1'
+  VERSION = '0.3.1'
 end

data/lib/kaze_client.rb

@@ -4,7 +4,8 @@
 require 'activesupport/blank'
 require 'activesupport/camelize'
 
-# Require third-part libraries
+# Require third-party libraries
+require 'pathname'
 require 'httparty'
 require 'jsonpath'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kaze_client
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Matthieu Ciappara
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-17 00:00:00.000000000 Z
+date: 2022-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -91,7 +91,9 @@ files:
 - lib/kaze_client/json_utils.rb
 - lib/kaze_client/request/request.rb
 - lib/kaze_client/request/requests/assign_performer_request.rb
+- lib/kaze_client/request/requests/cancel_job_request.rb
 - lib/kaze_client/request/requests/create_job_request.rb
+- lib/kaze_client/request/requests/job_document_request.rb
 - lib/kaze_client/request/requests/job_request.rb
 - lib/kaze_client/request/requests/job_workflow_request.rb
 - lib/kaze_client/request/requests/job_workflows_request.rb
@@ -100,6 +102,8 @@ files:
 - lib/kaze_client/request/requests/partners_request.rb
 - lib/kaze_client/request/requests/profile_request.rb
 - lib/kaze_client/request/requests/update_template_request.rb
+- lib/kaze_client/request/requests/upload_image_request.rb
+- lib/kaze_client/request/requests/users_request.rb
 - lib/kaze_client/request/requests/utils/authentified_request.rb
 - lib/kaze_client/request/requests/utils/final_request.rb
 - lib/kaze_client/request/requests/utils/list_request.rb