kaze_client 0.3.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 756b450f1d01dc6323eff1c6045dd92cd7abc104bf3e69b02caa803b1b20a53c
-  data.tar.gz: f642ec73a940d44487983897db2d6d22b5a8988d3b8b574a538d813e4b4c5ed1
+  metadata.gz: 3bad3016b37b1fcfbc04bf4882571b9d346d4c6debacf3240735abbd8d56495f
+  data.tar.gz: 5ae1d5dbcf3312b49a88ca829a9a81cbc563c62af259a81863981098ff513b15
 SHA512:
-  metadata.gz: a2eb0ece62d5512a19f1003916f960f7c34933d45e80c384aa6bec335fb2eedea7da017e741d73842e7d8b7401beb20a131b0464a6bc5298c1aa396f9a520027
-  data.tar.gz: 512b06645dc287f53fbbf511a5b30772cf1b8331fdb6b850e60ca1873ca028ba29624721a581e25ccdf065c6437872a9561a9498743727552fedb2f7c079811e
+  metadata.gz: df16ba5388bad0cb2cbb71f1667d617986b124100be8b2dfc815eadfd36ed487567954419e9d89ca7c03d0f3c1ec84ce6550d469817161db21f77e2148057e52
+  data.tar.gz: cb28147c6f5831cd82f1ed31050e0f307fc875725d0b2c0fff558b833868ed3968a4944b184a73494ee1694f631e6b5516c8e836f0d0b4f144392bfaa25b73d3

data/.rubocop.yml

@@ -1,2 +1,251 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+inherit_mode:
+  merge:
+    - Exclude
+    - Include
+
 AllCops:
+  # Enable new cops by default
   NewCops: enable
+
+  # Align target ruby version with the required ruby version in gemspec
+  TargetRubyVersion: 2.6
+
+  # Excluding most directories with generated files and directories with configuration files.
+  Exclude:
+    - 'bin'
+    - '.github'
+    - '**/Gemfile'
+    - '**/Guardfile'
+    - '**/Rakefile'
+    - 'node_modules/**/*'
+    - 'spec/**/*'
+    - 'sig/**/*'
+
+# Checks if String literals are using single quotes when no interpolation is required
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+  ConsistentQuotesInMultiline: false
+
+# Checks if the quotes used for quoted symbols are single quotes when no interpolation is required
+Style/QuotedSymbols:
+  Enabled: true
+  EnforcedStyle: same_as_string_literals
+
+# This cop checks for uses of literal strings converted to a symbol where a literal symbol could be used instead.
+Lint/SymbolConversion:
+  Enabled: true
+  EnforcedStyle: strict
+
+# Useless cop. It checks for unnecessary safe navigations.
+# Example:
+# obj&.a && obj.b
+# Triggers rubocop error: it requires to add safe navigation for "obj.b" call => "obj&.b".
+# but it is not necessary. obj&.a will return nil if obj is nil, and it will stop
+# execution of the operation because `&&` right part executes only when left part is truthy.
+Lint/SafeNavigationConsistency:
+  Enabled: false
+
+# Checks for places where keyword arguments can be used instead of boolean arguments when defining methods.
+# Disabled because moving from default arguments to keywords is not that easy.
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+# Checks for use of the lambda.(args) syntax.
+# Disabled while the Ruby team has not voted on this.
+Style/LambdaCall:
+  Enabled: false
+  EnforcedStyle: braces
+
+# Checks for presence or absence of braces around hash literal as a last array item depending on configuration.
+# Disabled because it would break a lot of permitted_params definitions
+Style/HashAsLastArrayItem:
+  Enabled: false
+
+# Checks for grouping of accessors in class and module bodies.
+# Useless.
+Style/AccessorGrouping:
+  Enabled: false
+
+# Makes our lives happier: we don't need to disable it in each case/when method
+# with more than 5 "when"s.
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Commonly used screens these days easily fit more than 80 characters.
+Layout/LineLength:
+  Max: 120
+
+# Too short methods lead to extraction of single-use methods, which can make
+# the code easier to read (by naming things), but can also clutter the class
+Metrics/MethodLength:
+  Max: 25
+
+# The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
+Metrics/ClassLength:
+  Max: 1500
+
+# No space makes the method definition shorter and differentiates
+# from a regular assignment.
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+# We do not need to support Ruby 1.9, so this is good to use.
+Style/SymbolArray:
+  Enabled: true
+
+# Most readable form.
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+# Mixing the styles looks just silly.
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+# has_key? and has_value? are far more readable than key? and value?
+Style/PreferredHashMethods:
+  Enabled: false
+
+# String#% is by far the least verbose and only object oriented variant.
+Style/FormatString:
+  EnforcedStyle: percent
+
+# Annotated or template are too verbose and rarely needed.
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    # inject seems more common in the community.
+    reduce: "inject"
+
+# Either allow this style or don't. Marking it as safe with parenthesis
+# is silly. Let's try to live without them for now.
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: false
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+# A specialized exception class will take one or more arguments and construct the message from it.
+# So both variants make sense.
+Style/RaiseArgs:
+  Enabled: false
+
+# Indenting the chained dots beneath each other is not supported by this cop,
+# see https://github.com/bbatsov/rubocop/issues/1633
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+# Fail is an alias of raise. Avoid aliases, it's more cognitive load for no gain.
+# The argument that fail should be used to abort the program is wrong too,
+# there's Kernel#abort for that.
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Suppressing exceptions can be perfectly fine, and be it to avoid to
+# explicitly type nil into the rescue since that's what you want to return,
+# or suppressing LoadError for optional dependencies
+Lint/SuppressedException:
+  Enabled: false
+
+# { ... } for multi-line blocks is okay, follow Weirichs rule instead:
+# https://web.archive.org/web/20140221124509/http://onestepback.org/index.cgi/Tech/Ruby/BraceVsDoEnd.rdoc
+Style/BlockDelimiters:
+  Enabled: false
+
+# do / end blocks should be used for side effects,
+# methods that run a block for side effects and have
+# a useful return value are rare, assign the return
+# value to a local variable for those cases.
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+# Enforcing the names of variables? To single letter ones? Just no.
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# Shadowing outer local variables with block parameters is often useful
+# to not reinvent a new name for the same thing, it highlights the relation
+# between the outer variable and the parameter. The cases where it's actually
+# confusing are rare, and usually bad for other reasons already, for example
+# because the method is too long.
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+# Check with yard instead.
+Style/Documentation:
+  Enabled: false
+
+# This is just silly. Calling the argument `other` in all cases makes no sense.
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+
+# Disable frozen string
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Disable No ASCII char in comments
+Style/AsciiComments:
+  Enabled: false
+
+# Disable ordered Gems By ascii
+Bundler/OrderedGems:
+  Enabled: false
+
+# Change ABC max value
+Metrics/AbcSize:
+  Max: 35
+
+# Disable empty method in one line
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+# Disable max height block
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - 'app/admin/**/*'
+    - 'lib/tasks/**/*'
+
+# Checks if empty lines around the bodies of classes match the configuration.
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines
+# Checks if empty lines around the bodies of modules match the configuration.
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines
+
+# Enforces the consistent usage of %-literal delimiters.
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: '()'
+    '%i': '[]'
+    '%I': '[]'
+    '%r': '{}'
+    '%w': '[]'
+    '%W': '[]'
+
+# Unnecessary cop. In what universe "A || B && C" or "A && B || C && D" is ambiguous? looks
+# like a cop for those who can't in boolean.
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+
+# Checks for simple usages of parallel assignment.
+Style/ParallelAssignment:
+  Enabled: false
+
+# Checks the style of children definitions at classes and modules.
+Style/ClassAndModuleChildren:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## [Unreleased]
+
+## [0.4.0] - 2023-09-12
+
+- Require `AddTagRequest`
+- Add new requests:
+  - List all tags
+  - Get details about one tag
+  - Complete step
+- Update bundler and dependencies
+
 ## [0.3.2.2] - 2023-05-31
 
 - Add new requests:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kaze_client (0.3.1)
+    kaze_client (0.4.0)
       httparty (~> 0.18, >= 0.18.1)
       jsonpath (~> 1.1, >= 1.1.2)
 
@@ -9,67 +9,79 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    base64 (0.1.1)
     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)
+    debug (1.8.0)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.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)
+    io-console (0.6.0)
+    irb (1.8.1)
+      rdoc
+      reline (>= 0.3.8)
+    json (2.6.3)
+    jsonpath (1.1.3)
       multi_json
-    mini_mime (1.1.2)
+    language_server-protocol (3.17.0.3)
+    mini_mime (1.1.5)
     multi_json (1.15.0)
     multi_xml (0.6.0)
-    parallel (1.22.1)
-    parser (3.1.2.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
+    psych (5.1.0)
+      stringio
+    racc (1.7.1)
     rainbow (3.1.1)
-    rake (13.0.3)
-    regexp_parser (2.5.0)
-    reline (0.3.1)
+    rake (13.0.6)
+    rdoc (6.5.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.8.1)
+    reline (0.3.8)
       io-console (~> 0.5)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.30.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.3)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.18.0, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
-      parser (>= 3.1.1.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
     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)
+    ruby-progressbar (1.13.0)
+    stringio (3.0.8)
+    thor (1.2.2)
+    unicode-display_width (2.4.2)
+    yard (0.9.34)
 
 PLATFORMS
   aarch64-linux
@@ -87,4 +99,4 @@ DEPENDENCIES
   yard (~> 0.9.28)
 
 BUNDLED WITH
-   2.2.15
+   2.4.19

data/README.md

@@ -18,6 +18,28 @@ Or install it yourself as:
 
     $ gem install kaze_client
 
+## Usage
+
+Here is an example of how to chain requests:
+
+```ruby
+require 'kaze_client'
+
+client = KazeClient::Client.new('https://app.kaze.so', token: 'A_valid_token')
+request = KazeClient::JobsRequest.new.filter_by_status('completed').filter_by_query('client_reference_42')
+
+response = client.execute(request)
+
+first_job = response.dig['data'].first
+puts("First job id: #{first_job['id']}")
+
+request = KazeClient::JobRequest.new(first_job['id'])
+
+job = client.execute(request)
+pickup_address = job.fetch_data_from_child('pick_up_address', field: 'city')
+puts("City: #{pickup_address}")
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/kaze_client.gemspec

@@ -33,5 +33,4 @@ Gem::Specification.new do |spec|
 
   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/client.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @author ciappa_m@modulotech.fr
   # Execute a KazeClient::Request, stores the server's base URL, the request and the response.
   # @see KazeClient::Request
   # @see KazeClient::Response
   # @since 0.1.0
   class Client
+
     # @return [String] The server's base URL (e.g. https://app.kaze.so)
     attr_reader :base_url
     # @return [String,nil] The last authentication token
@@ -50,7 +52,7 @@ module KazeClient
     # @raise [KazeClient::Error::NoEndpoint] if the base URL is blank
     # @raise [KazeClient::Error::Generic] if the response is not a success: not a 2xx HTTP status
     # @see KazeClient::Client#do_execute
-    def login(login = @login, password = @password)
+    def login(login=@login, password=@password)
       # Impossible to login using nil login or password.
       # The first call to #login must be given a login and a password.
       raise KazeClient::Error::InvalidCredentials, 'Please set login and password' if login.nil? || password.nil?
@@ -106,5 +108,7 @@ module KazeClient
       # Build the response object from the HTTParty response
       Response.new(@response)
     end
+
   end
+
 end

data/lib/kaze_client/data_utils.rb

@@ -1,10 +1,12 @@
 # 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
@@ -16,5 +18,7 @@ module KazeClient
 
       Time.at(time.to_i / 1000).utc
     end
+
   end
+
 end

data/lib/kaze_client/error/disabled_account.rb

@@ -1,13 +1,19 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   module Error
+
     # @author ciappa_m@modulotech.fr
     # 403 error sent by Kaze server when trying to log in with a disabled account
     class DisabledAccount < Forbidden
-      def initialize(msg = 'User account was disabled by administrator')
+
+      def initialize(msg='User account was disabled by administrator')
         super(msg)
       end
+
     end
+
   end
+
 end

data/lib/kaze_client/error/forbidden.rb

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

data/lib/kaze_client/error/generic.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   # @since 0.1.0
   module Error
+
     # @author ciappa_m@modulotech.fr
     # Generic error raised when Kaze server send an unknown error. By default, it is considered
     # to be an internal server error.
     class Generic < RuntimeError
+
       # @return [Symbol] The HTTP status sent by the server
       attr_reader :status
 
@@ -24,6 +27,9 @@ module KazeClient
         @status = status || :internal_server_error
         @error  = error || @status
       end
+
     end
+
   end
+
 end

data/lib/kaze_client/error/internal_server_error.rb

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

data/lib/kaze_client/error/invalid_credentials.rb

@@ -1,13 +1,19 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   module Error
+
     # @author ciappa_m@modulotech.fr
     # 401 error sent by Kaze server when trying to log in with invalid credentials
     class InvalidCredentials < Unauthorized
-      def initialize(msg = 'Invalid Login or Password')
+
+      def initialize(msg='Invalid Login or Password')
         super(msg)
       end
+
     end
+
   end
+
 end

data/lib/kaze_client/error/no_endpoint.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   module Error
+
     # @author ciappa_m@modulotech.fr
     # An error raised when the base URL given to the +KazeClient::Client+ is nil
     # @see KazeClient::Client
     class NoEndpoint < Generic
+
       # @return the given base URL
       attr_reader :base_url
 
@@ -14,6 +17,9 @@ module KazeClient
 
         @base_url = base_url
       end
+
     end
+
   end
+
 end

data/lib/kaze_client/error/no_private_token.rb

@@ -1,13 +1,19 @@
 # frozen_string_literal: true
 
 module KazeClient
+
   module Error
+
     # @author ciappa_m@modulotech.fr
     # 403 error sent by Kaze server when trying to log in and user has no token
     class NoPrivateToken < Forbidden
-      def initialize(msg = 'User has no private token assigned')
+
+      def initialize(msg='User has no private token assigned')
         super(msg)
       end
+
     end
+
   end
+
 end

data/lib/kaze_client/error/not_found.rb

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