kaze_client 0.1.1p0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 687ef335a59eb5c25b4efece8a9e74f49a12a465b4018512c01246d2753fd218
-  data.tar.gz: 45905959e188ba363b09fa69bd96839e3b31057fac1704ede9c9a9fa3bbb020d
+  metadata.gz: fd31be1e3cb6ccd738c9646f50ad6096961f4b77f893373f38481f747a2c5442
+  data.tar.gz: 7f2081157ac8778d108e4629524e228ad67aaeabb38ad977b7eb362476d0e996
 SHA512:
-  metadata.gz: 0eddfc2630c7ebd3aab7b17403662dd8922dc7f6a36488ac62b450d5246311763a2a4c0942e7618be16084267d2f64e0493fa17148c3b0c134d66f018f4d8536
-  data.tar.gz: 15c60ae8c4b65d96a63f1438c9dd7560d9f5e449a39780ad4040556973f2c185a6ec69980ae257e8a1cf6da5dfda1990a0c293398d7aca662defebbee2e4f77c
+  metadata.gz: 96c9f307c9d54f2d446d82e10f1ed795223a2679c3dc60dcc7dcfd1f3609bf90b78042552e34560fe2ef292ea35ec2f93a8dc744f12ba05dac7c4a76316417f7
+  data.tar.gz: 5645d82b34831f41eacd354e69a573a7e566c488dd6686e9b552e704953319c4733715bbe34e13efd9007af1e75ad122b9e6c33d5b3c923d312b4d37b8d17fc0

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-## [0.1.1p1] - 2022-05-31
+## [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.
+
+## [0.1.1p0] - 2022-05-31
 
 - Replace KazeClient::CompaniesRequest (/api/companies) with KazeClient::PartnersRequest (/api/partners).
 - Upgrade rubocop.

data/Gemfile

@@ -9,4 +9,10 @@ gem 'rake', '~> 13.0'
 
 gem 'rspec', '~> 3.0'
 
-gem 'rubocop', '~> 1.7'
+gem 'rubocop', '~> 1.30'
+
+gem 'rubocop-rake', '~> 0.6.0'
+
+gem 'rubocop-rspec', '~> 2.11.1'
+
+gem 'debug', '~> 1.5'

data/Gemfile.lock

@@ -1,20 +1,30 @@
 PATH
   remote: .
   specs:
-    kaze_client (0.1.1)
+    kaze_client (0.2.0)
       httparty (~> 0.18, >= 0.18.1)
+      jsonpath (~> 1.1, >= 1.1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    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)
       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)
+    multi_json (1.15.0)
     multi_xml (0.6.0)
     parallel (1.22.1)
     parser (3.1.2.0)
@@ -22,6 +32,8 @@ GEM
     rainbow (3.1.1)
     rake (13.0.3)
     regexp_parser (2.5.0)
+    reline (0.3.1)
+      io-console (~> 0.5)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -47,6 +59,10 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.18.0)
       parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.11.1)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     unicode-display_width (2.1.0)
 
@@ -55,10 +71,13 @@ PLATFORMS
   x86_64-darwin-20
 
 DEPENDENCIES
+  debug (~> 1.5)
   kaze_client!
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (~> 1.7)
+  rubocop (~> 1.30)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.11.1)
 
 BUNDLED WITH
    2.2.15

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/client.rb

@@ -14,9 +14,10 @@ module KazeClient
     attr_reader :token
 
     # @param base_url [String] The server's base URL (e.g. https://app.kaze.so)
-    def initialize(base_url)
+    # @param token [String] The authentication token
+    def initialize(base_url, token: nil)
       @base_url = base_url
-      @token    = nil
+      @token    = token
       @login    = nil
       @password = nil
     end
@@ -66,6 +67,16 @@ module KazeClient
       response
     end
 
+    # Set the authentication token
+    #
+    # @param token [String] The new authentication token
+    # @return [KazeClient::Client] The client after assigning the new token
+    def with_token(token)
+      @token = token
+
+      self
+    end
+
     private
 
     # @param request [KazeClient::Request] The request which was executed

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/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.1.1p0'
+  VERSION = '0.2.1'
 end

data/lib/kaze_client.rb

@@ -4,13 +4,15 @@
 require 'activesupport/blank'
 require 'activesupport/camelize'
 
-# Require HTTParty
+# Require third-part libraries
 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.1.1p0
+  version: 0.2.1
 platform: ruby
 authors:
 - Matthieu Ciappara
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-31 00:00:00.000000000 Z
+date: 2022-06-17 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,6 +88,7 @@ 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/create_job_request.rb
@@ -103,9 +124,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3.1
 signing_key: