kaze_client 0.3.2.2 → 0.4.0

data/lib/kaze_client/error/unauthorized.rb

@@ -1,13 +1,19 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   module Error
+
     # @author ciappa_m@modulotech.fr
     # Generic 401 error sent by Kaze server
     class Unauthorized < Generic
-      def initialize(msg = '401 Unauthorized')
+
+      def initialize(msg='401 Unauthorized')
         super(status: :unauthorized, message: msg)
       end
+
     end
+
   end
+
 end

data/lib/kaze_client/json_utils.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author ciappa_m@modulotech.fr
   # Utility methods to interact with JSON data
   # @see KazeClient::Response
   # @since 0.2.1
   module JsonUtils
+
     # Fetch nodes in given JSON
     #
     # @param json [KazeClient::Response,Hash,String] The JSON to analyze
@@ -32,5 +34,7 @@ module KazeClient
     def self.fetch_node(json, path)
       fetch_nodes(json, path).first
     end
+
   end
+
 end

data/lib/kaze_client/request/request.rb

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author ciappa_m@modulotech.fr
   # Represents request to a Kaze API
   # @see KazeClient::Client
   # @see KazeClient::Response
   # @since 0.1.0
   class Request
+
     # 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
@@ -123,5 +125,7 @@ module KazeClient
         Error::Generic.new(status: response.code, error: error, message: message)
       end
     end
+
   end
+
 end

data/lib/kaze_client/request/requests/collections/collection_request.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author richar_p@modulotech.fr
   # Fetch the details for the given collection id.
   # @see KazeClient::Request
@@ -8,10 +9,13 @@ module KazeClient
   # @see KazeClient::Utils::AuthentifiedRequest
   # @since 0.3.2
   class CollectionRequest < Utils::FinalRequest
+
     include Utils::AuthentifiedRequest
 
     def initialize(id)
       super(:get, "api/collections/#{id}")
     end
+
   end
+
 end

data/lib/kaze_client/request/requests/collections/collections_request.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author richar_p@modulotech.fr
   # List the collections for the company of the current user.
   # @see KazeClient::Request
@@ -8,11 +9,14 @@ module KazeClient
   # @see KazeClient::Utils::AuthentifiedRequest
   # @since 0.3.2
   class CollectionsRequest < Utils::FinalRequest
+
     include Utils::AuthentifiedRequest
     include Utils::ListRequest
 
     def initialize
       super(:get, 'api/collections')
     end
+
   end
+
 end

data/lib/kaze_client/request/requests/collections/items/create_collection_item_request.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author chevre_a@modulotech.fr
   # Create a collection item
   # @see KazeClient::Request
@@ -8,6 +9,7 @@ module KazeClient
   # @see KazeClient::Utils::AuthentifiedRequest
   # @since 0.3.2
   class CreateCollectionItemRequest < Utils::FinalRequest
+
     include Utils::AuthentifiedRequest
 
     # @param collection_id [String]
@@ -17,5 +19,7 @@ module KazeClient
 
       @body = payload
     end
+
   end
+
 end

data/lib/kaze_client/request/requests/collections/items/create_link_request.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   module Collection
+
     module Item
+
       class CreateLinkRequest < Utils::FinalRequest
+
         include Utils::AuthentifiedRequest
 
         # @author chevre_a@modulotech.fr
@@ -17,7 +21,11 @@ module KazeClient
 
           @body = { id: linked_collection_item_id }
         end
+
       end
+
     end
+
   end
+
 end

data/lib/kaze_client/request/requests/collections/items/item_request.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   module Collection
+
     # @author richar_p@modulotech.fr
     # Fetch the details for the given item id from the given collection id.
     # @see KazeClient::Request
@@ -9,11 +11,15 @@ module KazeClient
     # @see KazeClient::Utils::AuthentifiedRequest
     # @since 0.3.2
     class ItemRequest < Utils::FinalRequest
+
       include Utils::AuthentifiedRequest
 
       def initialize(collection_id, item_id)
         super(:get, "api/collection/#{collection_id}/items/#{item_id}")
       end
+
     end
+
   end
+
 end

data/lib/kaze_client/request/requests/collections/items/items_request.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   module Collection
+
     # @author richar_p@modulotech.fr
     # List the items assigned to the collection id.
     # @see KazeClient::Request
@@ -9,12 +11,16 @@ module KazeClient
     # @see KazeClient::Utils::AuthentifiedRequest
     # @since 0.3.2
     class ItemsRequest < Utils::FinalRequest
+
       include Utils::AuthentifiedRequest
       include Utils::ListRequest
 
       def initialize(id)
         super(:get, "api/collections/#{id}/items")
       end
+
     end
+
   end
+
 end

data/lib/kaze_client/request/requests/jobs/add_tag_request.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author RICHARD Peter <richar_p@modulotech.fr>
   # Add tags to a job.
   # @note    This API is under development and does not work well.
@@ -27,6 +28,7 @@ module KazeClient
   # @see KazeClient::Utils::AuthentifiedRequest
   # @since 0.3.2
   class AddTagRequest < Utils::FinalRequest
+
     include Utils::AuthentifiedRequest
 
     def initialize(job_id, tag_ids)
@@ -34,5 +36,7 @@ module KazeClient
 
       @body = { tags: tag_ids }
     end
+
   end
+
 end

data/lib/kaze_client/request/requests/jobs/assign_performer_request.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author ciappa_m@modulotech.fr
   # Assign a performer to the given job.
   # @see KazeClient::Request
@@ -8,6 +9,7 @@ module KazeClient
   # @see KazeClient::Utils::AuthentifiedRequest
   # @since 0.1.0
   class AssignPerformerRequest < Utils::FinalRequest
+
     include Utils::AuthentifiedRequest
 
     def initialize(id, performer_user_id)
@@ -19,5 +21,7 @@ module KazeClient
         }
       }
     end
+
   end
+
 end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author chevre_a@modulotech.fr
   # Cancel a job.
   # @see KazeClient::Request
@@ -8,6 +9,7 @@ module KazeClient
   # @see KazeClient::Utils::AuthentifiedRequest
   # @since 0.3.0
   class CancelJobRequest < Utils::FinalRequest
+
     include Utils::AuthentifiedRequest
 
     def initialize(job_id, cancel_reason_id)
@@ -17,5 +19,7 @@ module KazeClient
         job: { cancel_reason_id: cancel_reason_id }
       }
     end
+
   end
+
 end

data/lib/kaze_client/request/requests/jobs/complete_step_request.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module KazeClient
+
+  # @author richar_p@modulotech.fr
+  # Validate a step from a job.
+  # @see KazeClient::Request
+  # @see KazeClient::Utils::FinalRequest
+  # @see KazeClient::Utils::AuthentifiedRequest
+  # @since 0.3.3
+  class CompleteStepRequest < Utils::FinalRequest
+
+    include Utils::AuthentifiedRequest
+
+    # @return [String] The id of the targeted job.
+    attr_reader :job_id
+
+    # @return [Hash] The step needed to be completed.
+    attr_reader :step_id
+
+    # @example
+    # KazeClient::CompleteStepRequest.new('5295d1c4-2c25-4fc2-8bad-e714f2907f0d', 'job_info')
+    # => The step job_info is now completed.
+    def initialize(job_id, step_id)
+      super(:put, "api/jobs/#{job_id}/cells/#{step_id}")
+
+      @body = {
+        data: {
+          step_id => { completed: { value: true } }
+        }
+      }
+    end
+
+  end
+
+end

data/lib/kaze_client/request/requests/jobs/create_job_request.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author ciappa_m@modulotech.fr
   # Create a job from the current user to the target company.
   # @see KazeClient::Request
@@ -8,6 +9,7 @@ module KazeClient
   # @see KazeClient::Utils::AuthentifiedRequest
   # @since 0.1.0
   class CreateJobRequest < Utils::FinalRequest
+
     include Utils::AuthentifiedRequest
 
     # @return [String] The id of the target company.
@@ -25,8 +27,10 @@ module KazeClient
       @workflow  = workflow
       @body      = {
         target_id: @target_id,
-        workflow: @workflow
+        workflow:  @workflow
       }
     end
+
   end
+
 end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author chevre_a@modulotech.fr
   # Retrieve a job document from a job.
   # @see KazeClient::Request
@@ -8,10 +9,13 @@ module KazeClient
   # @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/jobs/job_request.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author ciappa_m@modulotech.fr
   # Fetch the details for the given job id.
   # @see KazeClient::Request
@@ -8,10 +9,13 @@ module KazeClient
   # @see KazeClient::Utils::AuthentifiedRequest
   # @since 0.1.0
   class JobRequest < Utils::FinalRequest
+
     include Utils::AuthentifiedRequest
 
     def initialize(id)
       super(:get, "api/jobs/#{id}")
     end
+
   end
+
 end

data/lib/kaze_client/request/requests/jobs/job_workflow_request.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author ciappa_m@modulotech.fr
   # Request the details about a specific workflow.
   # @see KazeClient::Request
@@ -8,6 +9,7 @@ module KazeClient
   # @see KazeClient::Utils::AuthentifiedRequest
   # @since 0.1.0
   class JobWorkflowRequest < Utils::FinalRequest
+
     include Utils::AuthentifiedRequest
 
     # @return [String] The id of the workflow to request
@@ -21,5 +23,7 @@ module KazeClient
       @query   = {}
       @filters = {}
     end
+
   end
+
 end

data/lib/kaze_client/request/requests/jobs/job_workflows_request.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author ciappa_m@modulotech.fr
   # Request the list of job workflows for the current user.
   # @see KazeClient::Request
@@ -9,11 +10,14 @@ module KazeClient
   # @see KazeClient::Utils::ListRequest
   # @since 0.1.0
   class JobWorkflowsRequest < Utils::FinalRequest
+
     include Utils::AuthentifiedRequest
     include Utils::ListRequest
 
     def initialize
       super(:get, 'api/job_workflows')
     end
+
   end
+
 end

data/lib/kaze_client/request/requests/jobs/jobs_request.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author ciappa_m@modulotech.fr
   # List the jobs assigned to the current user's company.
   # @see KazeClient::Request
@@ -8,11 +9,14 @@ module KazeClient
   # @see KazeClient::Utils::AuthentifiedRequest
   # @since 0.1.0
   class JobsRequest < Utils::FinalRequest
+
     include Utils::AuthentifiedRequest
     include Utils::ListRequest
 
     def initialize
       super(:get, 'api/jobs')
     end
+
   end
+
 end

data/lib/kaze_client/request/requests/jobs/update_template_request.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author ciappa_m@modulotech.fr
   # Update data of the given template on the given job.
   # @see KazeClient::Request
@@ -8,6 +9,7 @@ module KazeClient
   # @see KazeClient::Utils::AuthentifiedRequest
   # @since 0.1.0
   class UpdateTemplateRequest < Utils::FinalRequest
+
     include Utils::AuthentifiedRequest
 
     def initialize(id, template_id, body)
@@ -15,5 +17,7 @@ module KazeClient
 
       @body = body
     end
+
   end
+
 end

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

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author ciappa_m@modulotech.fr
   # Authenticate a user on the server.
   # @see KazeClient::Request
   # @see KazeClient::Utils::FinalRequest
   # @since 0.1.0
   class LoginRequest < Utils::FinalRequest
+
     # @return [String] The user login.
     attr_reader :login
 
@@ -19,10 +21,12 @@ module KazeClient
       @password = password
       @body     = {
         user: {
-          login: @login,
+          login:    @login,
           password: @password
         }
       }
     end
+
   end
+
 end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author ciappa_m@modulotech.fr
   # Request the list of companies.
   # @see KazeClient::Request
@@ -9,11 +10,14 @@ module KazeClient
   # @see KazeClient::Utils::ListRequest
   # @since 0.1.1
   class PartnersRequest < Utils::FinalRequest
+
     include Utils::AuthentifiedRequest
     include Utils::ListRequest
 
     def initialize
       super(:get, 'api/partners')
     end
+
   end
+
 end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author ciappa_m@modulotech.fr
   # Request data about the current user.
   # @see KazeClient::Request
@@ -8,10 +9,13 @@ module KazeClient
   # @see KazeClient::Utils::AuthentifiedRequest
   # @since 0.1.0
   class ProfileRequest < Utils::FinalRequest
+
     include Utils::AuthentifiedRequest
 
     def initialize
       super(:get, 'api/profile')
     end
+
   end
+
 end

data/lib/kaze_client/request/requests/tags/tag_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module KazeClient
+
+  # @author chevre_a@modulotech.fr
+  # Fetch a tag with the given id
+  # @see KazeClient::Request
+  # @see KazeClient::Utils::FinalRequest
+  # @see KazeClient::Utils::AuthentifiedRequest
+  class TagRequest < Utils::FinalRequest
+
+    include Utils::AuthentifiedRequest
+
+    # @param tag_id [String]
+    def initialize(tag_id)
+      super(:get, "api/tag/#{tag_id}")
+    end
+
+  end
+
+end

data/lib/kaze_client/request/requests/tags/tags_request.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module KazeClient
+
+  # @author chevre_a@modulotech.fr
+  # Fetch all tags
+  # @see KazeClient::Request
+  # @see KazeClient::Utils::FinalRequest
+  # @see KazeClient::Utils::AuthentifiedRequest
+  class TagsRequest < Utils::FinalRequest
+
+    include Utils::AuthentifiedRequest
+
+    def initialize
+      super(:get, 'api/tags')
+    end
+
+  end
+
+end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author chevre_a@modulotech.fr
   # Upload an ActiveStorage::Attachment to a job document from a job.
   # @see KazeClient::Request
@@ -12,6 +13,7 @@ module KazeClient
   #   response = KazeClient::Client.new(URL).execute(rq)
   #   rq.send_attachment(response['direct_upload'])
   class UploadAttachmentRequest < Utils::FinalRequest
+
     include Utils::AuthentifiedRequest
 
     # @param attachment [ActiveStorage::Attachment]
@@ -23,9 +25,9 @@ module KazeClient
 
       @body = {
         blob: {
-          filename: @attachment.filename,
-          byte_size: @attachment.byte_size,
-          checksum: @attachment.checksum,
+          filename:     @attachment.filename,
+          byte_size:    @attachment.byte_size,
+          checksum:     @attachment.checksum,
           content_type: @attachment.content_type
         }
       }
@@ -35,5 +37,7 @@ module KazeClient
       header = direct_uploads['headers']
       HTTParty.put(direct_uploads['url'], { body: @attachment.download, headers: header })
     end
+
   end
+
 end

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

@@ -1,6 +1,7 @@
 # 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.
@@ -13,6 +14,7 @@ module KazeClient
   #   response = KazeClient::Client.new(URL).execute(request)
   #   request.send_image(response['direct_upload'])
   class UploadImageRequest < Utils::FinalRequest
+
     include Utils::AuthentifiedRequest
 
     def initialize(filepath)
@@ -35,5 +37,7 @@ module KazeClient
       header = direct_uploads['headers']
       HTTParty.put(direct_uploads['url'], { body: body, headers: header })
     end
+
   end
+
 end