kaze_client 0.3.0 → 0.3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f04fc270f92f58f489ff092c78adb05ec7d8d241277d2294e1d7d88ddd47e5ef
-  data.tar.gz: 69a336ea1b82c2a97c6a079a70220a625dfd48da3a3223a637e8c3d4a1e3bde3
+  metadata.gz: 970cb363aca76ee05e22edb67d4227509d9713188e0f8521d6e58c485cb10592
+  data.tar.gz: fcdf3eda5f50d2881ef4f5a9637e7ebaf2f5a3637f2b282124b566c2de8803c5
 SHA512:
-  metadata.gz: 44e207d6ccb69a208c5273d63e62615d113c0a8b0cf2bcd5020e5b977312ca79125740e29746e2375b18f32c5cdbfe0c70289e3c261e0f5b64c3fefcbd070468
-  data.tar.gz: bb1088a6628adca37f824660306ea5d4053f86df96f453fea12b02893f37c53e229fb3f7de1d0698cc15fd17d0a8ec4788037327315fb4c599e38462b6d874b6
+  metadata.gz: 99b86ffe270cb25d3a496d47ee59fe5fd181dd7c30997033c185cd919f611c1e60e06a2ebdf80c072918b5e2fa51454ac410301aad8bbbbe7a36d6392dfc5f6d
+  data.tar.gz: 4124802d5242b5d02ccbaf29ff6098efd7b2421ad415031d26273cdcb406b97f82c9494cf157320d248b0747345a9d14589369f9ea2053ce43c60c082f11b420

data/.github/workflows/main.yml

@@ -10,9 +10,14 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0.1
-    - name: Run the default task
+        ruby-version: 3.2.2
+    - name: Run specs and rubocop
       run: |
         gem install bundler -v 2.2.15
         bundle install
         bundle exec rake
+    - name: Run bundler-audit
+      run: |
+        gem install bundler -v 2.2.15
+        bundle install
+        bundle exec bundler-audit

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+# CHANGELOG
+
+## [0.3.2.1] - 2023-04-23
+
+- Add new requests:
+  - Upload activestorage attachment
+  - List the collections for the company of the current user
+  - Fetch the details for the given collection id
+  - List the items assigned to the collection id
+  - Fetch the details for the given item id from the given collection id
+  - Add tags to a job
+  - Create a collection item
+  - Create a link between 2 collection items
+- Fix handling of 404 HTTP status.
+
+## [0.3.1] - 2022-11-30
+
+- Update error handling for more clarity.
+
 ## [0.3.0] - 2022-09-28
 
 - Add new requests:

data/Gemfile

@@ -16,3 +16,7 @@ gem 'rubocop-rake', '~> 0.6.0'
 gem 'rubocop-rspec', '~> 2.11.1'
 
 gem 'debug', '~> 1.5'
+
+gem 'yard', '~> 0.9.28'
+
+gem 'bundler-audit', '~> 0.9.1'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kaze_client (0.2.0)
+    kaze_client (0.3.1)
       httparty (~> 0.18, >= 0.18.1)
       jsonpath (~> 1.1, >= 1.1.2)
 
@@ -9,21 +9,22 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    bundler-audit (0.9.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
     debug (1.5.0)
       irb (>= 1.3.6)
       reline (>= 0.2.7)
     diff-lcs (1.4.4)
-    httparty (0.20.0)
-      mime-types (~> 3.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
     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)
+    mini_mime (1.1.2)
     multi_json (1.15.0)
     multi_xml (0.6.0)
     parallel (1.22.1)
@@ -64,13 +65,18 @@ GEM
     rubocop-rspec (2.11.1)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
+    thor (1.2.1)
     unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
 
 PLATFORMS
   aarch64-linux
   x86_64-darwin-20
 
 DEPENDENCIES
+  bundler-audit (~> 0.9.1)
   debug (~> 1.5)
   kaze_client!
   rake (~> 13.0)
@@ -78,6 +84,7 @@ DEPENDENCIES
   rubocop (~> 1.30)
   rubocop-rake (~> 0.6.0)
   rubocop-rspec (~> 2.11.1)
+  yard (~> 0.9.28)
 
 BUNDLED WITH
    2.2.15

data/lib/kaze_client/data_utils.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module KazeClient
+  # @author richar_p@modulotech.fr
+  # Utility methods to interact with KazeData
+  # @since 0.3.2
+  module DataUtils
+    # Parse a Kaze Workflow datetime
+    # @param time [Integer] The datetime to parse
+    # @return [Time] The parsed datetime
+    # @example
+    #  KazeClient::DataUtils.parse_datetime(1546300800000)
+    # => 2019-01-01 00:00:00 UTC
+    def self.parse_time(time)
+      raise ArgumentError, 'time must not be nil' unless time.nil?
+
+      Time.at(time.to_i / 1000).utc
+    end
+  end
+end

data/lib/kaze_client/request/request.rb

@@ -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,24 @@ 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
+      generic_http_error(error, message, response)
+    end
+
+    def generic_http_error(error, message, response)
+      case response.code
+      when 401 then KazeClient::Error::Unauthorized.new(message)
+      when 403 then KazeClient::Error::Forbidden.new(message)
+      when 404 then KazeClient::Error::NotFound.new
+      when 500 then 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/collections/collection_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module KazeClient
+  # @author richar_p@modulotech.fr
+  # Fetch the details for the given collection id.
+  # @see KazeClient::Request
+  # @see KazeClient::Utils::FinalRequest
+  # @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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module KazeClient
+  # @author richar_p@modulotech.fr
+  # List the collections for the company of the current user.
+  # @see KazeClient::Request
+  # @see KazeClient::Utils::FinalRequest
+  # @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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module KazeClient
+  # @author chevre_a@modulotech.fr
+  # Create a collection item
+  # @see KazeClient::Request
+  # @see KazeClient::Utils::FinalRequest
+  # @see KazeClient::Utils::AuthentifiedRequest
+  # @since 0.3.2
+  class CreateCollectionItemRequest < Utils::FinalRequest
+    include Utils::AuthentifiedRequest
+
+    # @param collection_id [String]
+    # @param payload [Hash]
+    def initialize(collection_id, payload)
+      super(:post, "api/collections/#{collection_id}/items")
+
+      @body = payload
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module KazeClient
+  module Collection
+    module Item
+      class CreateLinkRequest < Utils::FinalRequest
+        include Utils::AuthentifiedRequest
+
+        # @author chevre_a@modulotech.fr
+        # Create a link between 2 collection items
+        # @see KazeClient::Request
+        # @see KazeClient::Utils::FinalRequest
+        # @see KazeClient::Utils::AuthentifiedRequest
+        # @since 0.3.2
+        def initialize(collection_id, collection_item_id, linked_collection_item_id)
+          super(:post, "api/collections/#{collection_id}/items/#{collection_item_id}/links")
+
+          @body = { id: linked_collection_item_id }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# 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
+    # @see KazeClient::Utils::FinalRequest
+    # @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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module KazeClient
+  module Collection
+    # @author richar_p@modulotech.fr
+    # List the items assigned to the collection id.
+    # @see KazeClient::Request
+    # @see KazeClient::Utils::FinalRequest
+    # @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

@@ -0,0 +1,38 @@
+# 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.
+  #          When you add a tag with it, it does not check if the id is correct or
+  #          not and it deletes all the other tags.
+  #          It should be fixed in a next version of Kaze API.
+  #
+  # @example
+  #     rq = KazeClient::AddTagRequest.new(123, [1, 2, 3]).with_token('token')
+  #     KazeClient::Client.new('https://kaze.modulotech.fr').execute(rq)
+  # Will make a request like this:
+  #    PUT https://kaze.modulotech.fr/api/tags/references/job/123
+  #   --- HEADERS ---
+  #   {
+  #       "Authorization": "token", "Content-Type": "application/json", "Accept": "application/json"
+  #   }
+  #   --- BODY ---
+  #   {
+  #       "tags": [1, 2, 3]
+  #   }
+  #
+  # @see KazeClient::Request
+  # @see KazeClient::Utils::FinalRequest
+  # @see KazeClient::Utils::AuthentifiedRequest
+  # @since 0.3.2
+  class AddTagRequest < Utils::FinalRequest
+    include Utils::AuthentifiedRequest
+
+    def initialize(job_id, tag_ids)
+      super(:put, "/api/tags/references/job/#{job_id}")
+
+      @body = { tags: tag_ids }
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# 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
+  # @see KazeClient::Utils::FinalRequest
+  # @see KazeClient::Utils::AuthentifiedRequest
+  # @since 0.3.2
+  # @example How to use
+  #   rq = KazeClient::UploadAttachmentRequest.new(f).with_token(TOKEN)
+  #   response = KazeClient::Client.new(URL).execute(rq)
+  #   rq.send_attachment(response['direct_upload'])
+  class UploadAttachmentRequest < Utils::FinalRequest
+    include Utils::AuthentifiedRequest
+
+    # @param attachment [ActiveStorage::Attachment]
+    def initialize(attachment)
+      super(:post, 'api/direct_uploads')
+
+      # @type [ActiveStorage::Attachment]
+      @attachment = attachment
+
+      @body = {
+        blob: {
+          filename: @attachment.filename,
+          byte_size: @attachment.byte_size,
+          checksum: @attachment.checksum,
+          content_type: @attachment.content_type
+        }
+      }
+    end
+
+    def send_attachment(direct_uploads)
+      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

@@ -13,23 +13,18 @@ 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)
       super(:post, 'api/direct_uploads')
-      @filepath = if filepath.is_a?(Pathname)
-                    filepath
-                  else
-                    Pathname.new(filepath.to_s)
-                  end
+
+      @filepath = filepath.is_a?(Pathname) ? filepath : Pathname.new(filepath.to_s)
       @filename = @filepath.basename.to_s
 
       @body = {
         blob: {
-          filename:     @filename,
-          byte_size:    File.size(@filepath),
-          checksum:     Digest::MD5.base64digest(@filepath.read),
+          filename: @filename, byte_size: File.size(@filepath),
+          checksum: Digest::MD5.base64digest(@filepath.read),
           content_type: "image/#{@filename.split('.')[1]}"
         }
       }
@@ -40,7 +35,5 @@ module KazeClient
       header = direct_uploads['headers']
       HTTParty.put(direct_uploads['url'], { body: body, headers: header })
     end
-
   end
-
 end

data/lib/kaze_client/requests.rb

@@ -11,13 +11,29 @@ require_relative 'request/requests/utils/list_request'
 require_relative 'request/requests/utils/final_request'
 
 # The pre-crafted requests
-require_relative 'request/requests/assign_performer_request'
-require_relative 'request/requests/partners_request'
-require_relative 'request/requests/create_job_request'
-require_relative 'request/requests/job_request'
-require_relative 'request/requests/job_workflow_request'
-require_relative 'request/requests/job_workflows_request'
-require_relative 'request/requests/jobs_request'
+
+# => Jobs
+require_relative 'request/requests/jobs/assign_performer_request'
+require_relative 'request/requests/jobs/create_job_request'
+require_relative 'request/requests/jobs/job_request'
+require_relative 'request/requests/jobs/job_workflow_request'
+require_relative 'request/requests/jobs/job_workflows_request'
+require_relative 'request/requests/jobs/jobs_request'
+require_relative 'request/requests/jobs/update_template_request'
+
+# => Collections
+require_relative 'request/requests/collections/collection_request'
+require_relative 'request/requests/collections/collections_request'
+
+# => => Items
+require_relative 'request/requests/collections/items/item_request'
+require_relative 'request/requests/collections/items/items_request'
+require_relative 'request/requests/collections/items/create_link_request'
+require_relative 'request/requests/collections/items/create_collection_item_request'
+
+# => General
 require_relative 'request/requests/login_request'
+require_relative 'request/requests/partners_request'
 require_relative 'request/requests/profile_request'
-require_relative 'request/requests/update_template_request'
+require_relative 'request/requests/upload_image_request'
+require_relative 'request/requests/users_request'

data/lib/kaze_client/version.rb

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

data/lib/kaze_client.rb

@@ -14,6 +14,7 @@ require_relative 'kaze_client/version'
 
 # Require the different parts of the gem
 require_relative 'kaze_client/json_utils'
+require_relative 'kaze_client/data_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.3.0
+  version: 0.3.2.1
 platform: ruby
 authors:
 - Matthieu Ciappara
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-28 00:00:00.000000000 Z
+date: 2023-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -78,6 +78,7 @@ files:
 - lib/activesupport/camelize.rb
 - lib/kaze_client.rb
 - lib/kaze_client/client.rb
+- lib/kaze_client/data_utils.rb
 - lib/kaze_client/error/disabled_account.rb
 - lib/kaze_client/error/forbidden.rb
 - lib/kaze_client/error/generic.rb
@@ -90,18 +91,26 @@ files:
 - 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
-- lib/kaze_client/request/requests/jobs_request.rb
+- lib/kaze_client/request/requests/collections/collection_request.rb
+- lib/kaze_client/request/requests/collections/collections_request.rb
+- lib/kaze_client/request/requests/collections/items/create_collection_item_request.rb
+- lib/kaze_client/request/requests/collections/items/create_link_request.rb
+- lib/kaze_client/request/requests/collections/items/item_request.rb
+- lib/kaze_client/request/requests/collections/items/items_request.rb
+- lib/kaze_client/request/requests/jobs/add_tag_request.rb
+- lib/kaze_client/request/requests/jobs/assign_performer_request.rb
+- lib/kaze_client/request/requests/jobs/cancel_job_request.rb
+- lib/kaze_client/request/requests/jobs/create_job_request.rb
+- lib/kaze_client/request/requests/jobs/job_document_request.rb
+- lib/kaze_client/request/requests/jobs/job_request.rb
+- lib/kaze_client/request/requests/jobs/job_workflow_request.rb
+- lib/kaze_client/request/requests/jobs/job_workflows_request.rb
+- lib/kaze_client/request/requests/jobs/jobs_request.rb
+- lib/kaze_client/request/requests/jobs/update_template_request.rb
 - lib/kaze_client/request/requests/login_request.rb
 - 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_attachment_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
@@ -132,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: This is the official Ruby client library for Kaze API.