kaze_client 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff98889c7d39f15fc54339f9751d5197b15d3c5ed8af54375382858cf76a431b
-  data.tar.gz: 8484f58d8443003290a8a165c640c936705ffb4c2b7a51188fa9b8486d6e672c
+  metadata.gz: f04fc270f92f58f489ff092c78adb05ec7d8d241277d2294e1d7d88ddd47e5ef
+  data.tar.gz: 69a336ea1b82c2a97c6a079a70220a625dfd48da3a3223a637e8c3d4a1e3bde3
 SHA512:
-  metadata.gz: e0197299afa26f1a0a773f60e28f77c5d49b8a49930149f80e07cf7762311bdf7dd5c496df45e72c52d163b8e194ab57e7e94b97835449798db3f47f4a34e3bb
-  data.tar.gz: 76488d384368b10038eb5e126c846c29f6bac94d318f899528b4c8d9b001e2c637d9775b882f40dfaa33d5e06884477e0801d3fb24eb8fbadb0e3f1b5423a2bb
+  metadata.gz: 44e207d6ccb69a208c5273d63e62615d113c0a8b0cf2bcd5020e5b977312ca79125740e29746e2375b18f32c5cdbfe0c70289e3c261e0f5b64c3fefcbd070468
+  data.tar.gz: bb1088a6628adca37f824660306ea5d4053f86df96f453fea12b02893f37c53e229fb3f7de1d0698cc15fd17d0a8ec4788037327315fb4c599e38462b6d874b6

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [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.
+
 ## [0.2.0] - 2022-06-01
 
 - Allow to set the authentication token on the client skipping login step.

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    kaze_client (0.1.1p0)
+    kaze_client (0.2.0)
       httparty (~> 0.18, >= 0.18.1)
+      jsonpath (~> 1.1, >= 1.1.2)
 
 GEM
   remote: https://rubygems.org/
@@ -18,9 +19,12 @@ GEM
     io-console (0.5.11)
     irb (1.4.1)
       reline (>= 0.3.0)
+    jsonpath (1.1.2)
+      multi_json
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2022.0105)
+    multi_json (1.15.0)
     multi_xml (0.6.0)
     parallel (1.22.1)
     parser (3.1.2.0)

data/kaze_client.gemspec

@@ -32,5 +32,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'httparty', '~> 0.18', '>= 0.18.1'
+  spec.add_runtime_dependency 'jsonpath', '~> 1.1', '>= 1.1.2'
   # spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/kaze_client/json_utils.rb

@@ -0,0 +1,36 @@
+# 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
+    # @param path [String] A JSONpath - https://goessner.net/articles/JsonPath/
+    # @return [Array] The nodes or data corresponding to the path
+    def self.fetch_nodes(json, path)
+      json = case json
+             when ::KazeClient::Response
+               json.parsed_response
+             when String
+               JSON.parse(json)
+             else
+               json
+             end
+
+      JsonPath.on(json, path)
+    end
+
+    # Fetch a node in given JSON
+    #
+    # @param json [KazeClient::Response,Hash,String] The JSON to analyze
+    # @param path [String] A JSONpath - https://goessner.net/articles/JsonPath/
+    # @return [Object,nil] The node or data corresponding to the path or nil
+    def self.fetch_node(json, path)
+      fetch_nodes(json, path).first
+    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/response.rb

@@ -30,5 +30,48 @@ module KazeClient
     def respond_to_missing?(method_name, include_private = false)
       %i[original_response parsed_response].include?(method_name) || super
     end
+
+    # Find the child whose id is the given one in this response
+    #
+    # @param id [String] The id of the child to find
+    # @return [Hash,nil] The child or nil if not found
+    # @see KazeClient::JsonUtils.fetch_node
+    def fetch_child(id)
+      ::KazeClient::JsonUtils.fetch_node(self, %{$..children[?(@['id'] == '#{id}')]})
+    end
+
+    # Find the first child with the given id and return the given field
+    #
+    # @param id [String] The id of the child to find
+    # @param field [String] The name of the searched field
+    # @return [Object,nil] The value of the field or nil if not found
+    # @see #fetch_child
+    def fetch_data_from_child(id, field: 'data')
+      fetch_child(id)&.[](field)
+    end
+
+    # Find all the widget in this response.
+    # Technically, it fetch all the children whose type is +widget_*+
+    #
+    # @return [Array] The list of widgets
+    # @see KazeClient::JsonUtils.fetch_nodes
+    def fetch_widgets
+      ::KazeClient::JsonUtils.fetch_nodes(self, %{$..children[?(@['type'] =~ /^widget_/)]})
+    end
+
+    # Find the first child with the given id and update value of the given field
+    # Does nothing when +id+ was not found.
+    # Add a field when +field+ is not found.
+    #
+    # @param id [String] The id of the child to find
+    # @param value [Object] The value to set on the field
+    # @param field [String] The name of the searched field
+    # @return [KazeClient::Response] The response itself for chaining
+    # @see #fetch_child
+    def update_data_in_child(id, value, field: 'data')
+      fetch_child(id)&.[]=(field.to_s, value)
+
+      self
+    end
   end
 end

data/lib/kaze_client/version.rb

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

data/lib/kaze_client.rb

@@ -4,13 +4,16 @@
 require 'activesupport/blank'
 require 'activesupport/camelize'
 
-# Require HTTParty
+# Require third-party libraries
+require 'pathname'
 require 'httparty'
+require 'jsonpath'
 
 # Require the version number
 require_relative 'kaze_client/version'
 
 # Require the different parts of the gem
+require_relative 'kaze_client/json_utils'
 require_relative 'kaze_client/errors'
 require_relative 'kaze_client/requests'
 require_relative 'kaze_client/response'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kaze_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matthieu Ciappara
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-01 00:00:00.000000000 Z
+date: 2022-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -30,6 +30,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: jsonpath
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
 description: |
   This is the official Ruby client library for Kaze (https://www.kaze.so/) API.
 
@@ -68,9 +88,12 @@ files:
 - lib/kaze_client/error/not_found.rb
 - lib/kaze_client/error/unauthorized.rb
 - lib/kaze_client/errors.rb
+- 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
@@ -79,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