kaze_client 0.3.2.2 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +249 -0
  3. data/CHANGELOG.md +11 -0
  4. data/Gemfile.lock +52 -40
  5. data/README.md +22 -0
  6. data/kaze_client.gemspec +0 -1
  7. data/lib/kaze_client/client.rb +5 -1
  8. data/lib/kaze_client/data_utils.rb +4 -0
  9. data/lib/kaze_client/error/disabled_account.rb +7 -1
  10. data/lib/kaze_client/error/forbidden.rb +7 -1
  11. data/lib/kaze_client/error/generic.rb +6 -0
  12. data/lib/kaze_client/error/internal_server_error.rb +7 -1
  13. data/lib/kaze_client/error/invalid_credentials.rb +7 -1
  14. data/lib/kaze_client/error/no_endpoint.rb +6 -0
  15. data/lib/kaze_client/error/no_private_token.rb +7 -1
  16. data/lib/kaze_client/error/not_found.rb +7 -1
  17. data/lib/kaze_client/error/unauthorized.rb +7 -1
  18. data/lib/kaze_client/json_utils.rb +4 -0
  19. data/lib/kaze_client/request/request.rb +5 -1
  20. data/lib/kaze_client/request/requests/collections/collection_request.rb +4 -0
  21. data/lib/kaze_client/request/requests/collections/collections_request.rb +4 -0
  22. data/lib/kaze_client/request/requests/collections/items/create_collection_item_request.rb +4 -0
  23. data/lib/kaze_client/request/requests/collections/items/create_link_request.rb +8 -0
  24. data/lib/kaze_client/request/requests/collections/items/item_request.rb +6 -0
  25. data/lib/kaze_client/request/requests/collections/items/items_request.rb +6 -0
  26. data/lib/kaze_client/request/requests/jobs/add_tag_request.rb +4 -0
  27. data/lib/kaze_client/request/requests/jobs/assign_performer_request.rb +4 -0
  28. data/lib/kaze_client/request/requests/jobs/cancel_job_request.rb +4 -0
  29. data/lib/kaze_client/request/requests/jobs/complete_step_request.rb +36 -0
  30. data/lib/kaze_client/request/requests/jobs/create_job_request.rb +5 -1
  31. data/lib/kaze_client/request/requests/jobs/job_document_request.rb +4 -0
  32. data/lib/kaze_client/request/requests/jobs/job_request.rb +4 -0
  33. data/lib/kaze_client/request/requests/jobs/job_workflow_request.rb +4 -0
  34. data/lib/kaze_client/request/requests/jobs/job_workflows_request.rb +4 -0
  35. data/lib/kaze_client/request/requests/jobs/jobs_request.rb +4 -0
  36. data/lib/kaze_client/request/requests/jobs/update_template_request.rb +4 -0
  37. data/lib/kaze_client/request/requests/login_request.rb +5 -1
  38. data/lib/kaze_client/request/requests/partners_request.rb +4 -0
  39. data/lib/kaze_client/request/requests/profile_request.rb +4 -0
  40. data/lib/kaze_client/request/requests/tags/tag_request.rb +21 -0
  41. data/lib/kaze_client/request/requests/tags/tags_request.rb +20 -0
  42. data/lib/kaze_client/request/requests/upload_attachment_request.rb +7 -3
  43. data/lib/kaze_client/request/requests/upload_image_request.rb +4 -0
  44. data/lib/kaze_client/request/requests/users_request.rb +4 -0
  45. data/lib/kaze_client/request/requests/utils/authentified_request.rb +6 -0
  46. data/lib/kaze_client/request/requests/utils/final_request.rb +6 -0
  47. data/lib/kaze_client/request/requests/utils/list_request.rb +8 -4
  48. data/lib/kaze_client/requests.rb +7 -0
  49. data/lib/kaze_client/response.rb +5 -1
  50. data/lib/kaze_client/version.rb +3 -1
  51. metadata +9 -6
@@ -1,6 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module KazeClient
4
+
4
5
  # @author chevre_a@modulotech.fr
5
6
  # List the users from the current user's company.
6
7
  # @see KazeClient::Request
@@ -8,11 +9,14 @@ module KazeClient
8
9
  # @see KazeClient::Utils::AuthentifiedRequest
9
10
  # @since 0.3.0
10
11
  class UsersRequest < Utils::FinalRequest
12
+
11
13
  include Utils::AuthentifiedRequest
12
14
  include Utils::ListRequest
13
15
 
14
16
  def initialize
15
17
  super(:get, 'api/users')
16
18
  end
19
+
17
20
  end
21
+
18
22
  end
@@ -1,12 +1,15 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module KazeClient
4
+
4
5
  # @since 0.1.0
5
6
  module Utils
7
+
6
8
  # @author ciappa_m@modulotech.fr
7
9
  # Included by the request where an authentication token is required.
8
10
  # @see KazeClient::Request
9
11
  module AuthentifiedRequest
12
+
10
13
  # @return [String] The authentication token
11
14
  attr_reader :token
12
15
 
@@ -20,6 +23,9 @@ module KazeClient
20
23
 
21
24
  self
22
25
  end
26
+
23
27
  end
28
+
24
29
  end
30
+
25
31
  end
@@ -1,13 +1,19 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module KazeClient
4
+
4
5
  module Utils
6
+
5
7
  # @author ciappa_m@modulotech.fr
6
8
  # Set the request as final, disabling the edition of query parameters, headers and request body.
7
9
  # @see KazeClient::Request
8
10
  class FinalRequest < Request
11
+
9
12
  # Remove write access inherited from Request
10
13
  undef_method :query=, :body=, :headers=
14
+
11
15
  end
16
+
12
17
  end
18
+
13
19
  end
@@ -1,11 +1,14 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module KazeClient
4
+
4
5
  module Utils
6
+
5
7
  # @author ciappa_m@modulotech.fr
6
8
  # Included by the request where a list will be returned.
7
9
  # @see KazeClient::Request
8
10
  module ListRequest
11
+
9
12
  # @return [Integer,String] The page to fetch.
10
13
  attr_reader :page
11
14
 
@@ -49,10 +52,8 @@ module KazeClient
49
52
  # Ensure the +per_page+ parameter is between 1 and 100
50
53
  @per_page = if !per_page.is_a?(Numeric) || per_page.to_i < 1
51
54
  1
52
- elsif per_page > 100
53
- 100
54
55
  else
55
- per_page
56
+ [per_page, 100].min
56
57
  end
57
58
 
58
59
  @query[:per_page] = @per_page
@@ -97,7 +98,7 @@ module KazeClient
97
98
  match_data ? filter_by(match_data[1], args[0]) : super
98
99
  end
99
100
 
100
- def respond_to_missing?(method_name, include_private = false)
101
+ def respond_to_missing?(method_name, include_private=false)
101
102
  method_name.match?(/^filter_by_/) || super
102
103
  end
103
104
 
@@ -115,6 +116,9 @@ module KazeClient
115
116
 
116
117
  self
117
118
  end
119
+
118
120
  end
121
+
119
122
  end
123
+
120
124
  end
@@ -21,6 +21,8 @@ require_relative 'request/requests/jobs/job_workflows_request'
21
21
  require_relative 'request/requests/jobs/jobs_request'
22
22
  require_relative 'request/requests/jobs/update_template_request'
23
23
  require_relative 'request/requests/jobs/cancel_job_request'
24
+ require_relative 'request/requests/jobs/add_tag_request'
25
+ require_relative 'request/requests/jobs/complete_step_request'
24
26
 
25
27
  # => Collections
26
28
  require_relative 'request/requests/collections/collection_request'
@@ -32,9 +34,14 @@ require_relative 'request/requests/collections/items/items_request'
32
34
  require_relative 'request/requests/collections/items/create_link_request'
33
35
  require_relative 'request/requests/collections/items/create_collection_item_request'
34
36
 
37
+ # => Tags
38
+ require_relative 'request/requests/tags/tag_request'
39
+ require_relative 'request/requests/tags/tags_request'
40
+
35
41
  # => General
36
42
  require_relative 'request/requests/login_request'
37
43
  require_relative 'request/requests/partners_request'
38
44
  require_relative 'request/requests/profile_request'
39
45
  require_relative 'request/requests/upload_image_request'
46
+ require_relative 'request/requests/upload_attachment_request'
40
47
  require_relative 'request/requests/users_request'
@@ -1,12 +1,14 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module KazeClient
4
+
4
5
  # @author ciappa_m@modulotech.fr
5
6
  # Represents response from a Kaze API
6
7
  # @see KazeClient::Client
7
8
  # @see KazeClient::Request
8
9
  # @since 0.1.0
9
10
  class Response
11
+
10
12
  # @return [HTTParty::Response] The response object from HTTParty call
11
13
  attr_reader :original_response
12
14
 
@@ -27,7 +29,7 @@ module KazeClient
27
29
  end
28
30
  end
29
31
 
30
- def respond_to_missing?(method_name, include_private = false)
32
+ def respond_to_missing?(method_name, include_private=false)
31
33
  %i[original_response parsed_response].include?(method_name) || super
32
34
  end
33
35
 
@@ -73,5 +75,7 @@ module KazeClient
73
75
 
74
76
  self
75
77
  end
78
+
76
79
  end
80
+
77
81
  end
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module KazeClient
4
- VERSION = '0.3.2.2'
4
+
5
+ VERSION = '0.4.0'
6
+
5
7
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: kaze_client
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.2.2
4
+ version: 0.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Matthieu Ciappara
8
- autorequire:
8
+ autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2023-05-31 00:00:00.000000000 Z
11
+ date: 2023-09-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: httparty
@@ -100,6 +100,7 @@ files:
100
100
  - lib/kaze_client/request/requests/jobs/add_tag_request.rb
101
101
  - lib/kaze_client/request/requests/jobs/assign_performer_request.rb
102
102
  - lib/kaze_client/request/requests/jobs/cancel_job_request.rb
103
+ - lib/kaze_client/request/requests/jobs/complete_step_request.rb
103
104
  - lib/kaze_client/request/requests/jobs/create_job_request.rb
104
105
  - lib/kaze_client/request/requests/jobs/job_document_request.rb
105
106
  - lib/kaze_client/request/requests/jobs/job_request.rb
@@ -110,6 +111,8 @@ files:
110
111
  - lib/kaze_client/request/requests/login_request.rb
111
112
  - lib/kaze_client/request/requests/partners_request.rb
112
113
  - lib/kaze_client/request/requests/profile_request.rb
114
+ - lib/kaze_client/request/requests/tags/tag_request.rb
115
+ - lib/kaze_client/request/requests/tags/tags_request.rb
113
116
  - lib/kaze_client/request/requests/upload_attachment_request.rb
114
117
  - lib/kaze_client/request/requests/upload_image_request.rb
115
118
  - lib/kaze_client/request/requests/users_request.rb
@@ -126,7 +129,7 @@ metadata:
126
129
  homepage_uri: https://github.com/moduloTech/kaze_client
127
130
  source_code_uri: https://github.com/moduloTech/kaze_client
128
131
  changelog_uri: https://github.com/moduloTech/kaze_client/blob/master/CHANGELOG.md
129
- post_install_message:
132
+ post_install_message:
130
133
  rdoc_options: []
131
134
  require_paths:
132
135
  - lib
@@ -141,8 +144,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
141
144
  - !ruby/object:Gem::Version
142
145
  version: '0'
143
146
  requirements: []
144
- rubygems_version: 3.3.7
145
- signing_key:
147
+ rubygems_version: 3.4.10
148
+ signing_key:
146
149
  specification_version: 4
147
150
  summary: This is the official Ruby client library for Kaze API.
148
151
  test_files: []