my_api_client 0.22.0 → 0.23.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 (24) hide show
  1. checksums.yaml +4 -4
  2. data/.circleci/config.yml +26 -26
  3. data/.rubocop.yml +10 -10
  4. data/.rubocop_todo.yml +2 -2
  5. data/CHANGELOG.md +194 -157
  6. data/Gemfile +0 -2
  7. data/Gemfile.lock +39 -58
  8. data/README.jp.md +21 -22
  9. data/README.md +10 -11
  10. data/example/api_clients/application_api_client.rb +1 -1
  11. data/lib/my_api_client/errors/network_error.rb +3 -3
  12. data/lib/my_api_client/errors.rb +2 -2
  13. data/lib/my_api_client/integrations/bugsnag.rb +2 -2
  14. data/lib/my_api_client/version.rb +1 -1
  15. data/my_api/Gemfile +1 -1
  16. data/my_api/Gemfile.lock +82 -82
  17. data/my_api/app/controllers/pagination_controller.rb +1 -1
  18. data/my_api_client.gemspec +1 -1
  19. data/rails_app/rails_5.2/Gemfile.lock +5 -5
  20. data/rails_app/rails_6.0/Gemfile +1 -0
  21. data/rails_app/rails_6.0/Gemfile.lock +83 -97
  22. data/rails_app/rails_6.1/Gemfile.lock +89 -99
  23. data/rails_app/rails_7.0/Gemfile.lock +131 -68
  24. metadata +4 -4
data/CHANGELOG.md CHANGED
@@ -1,122 +1,151 @@
1
1
  # Change log
2
2
 
3
+ ## v0.23.0 (Jun 08, 2022)
4
+
5
+ ### Feature
6
+
7
+ - [#731](https://github.com/ryz310/my_api_client/pull/731) Allow the error class to be initialized with no arguments ([@ryz310](https://github.com/ryz310))
8
+
9
+ ### Breaking Change
10
+
11
+ - [#711](https://github.com/ryz310/my_api_client/pull/711) Bump up ruby version ([@ryz310](https://github.com/ryz310))
12
+
13
+ ### Rubocop Challenge
14
+
15
+ - [#698](https://github.com/ryz310/my_api_client/pull/698) RSpec/VerifiedDoubleReference-20220419233100 ([@ryz310](https://github.com/ryz310))
16
+ - [#700](https://github.com/ryz310/my_api_client/pull/700) Style/FetchEnvVar-20220421233101 ([@ryz310](https://github.com/ryz310))
17
+ - [#728](https://github.com/ryz310/my_api_client/pull/728) Re-generate .rubocop_todo.yml with RuboCop v1.30.1 ([@ryz310](https://github.com/ryz310))
18
+
19
+ ### Dependabot
20
+
21
+ - [#658](https://github.com/ryz310/my_api_client/pull/658) ryz310/dependabot/bundler/rspec_junit_formatter-0.5.1 ([@ryz310](https://github.com/ryz310))
22
+ - [#666](https://github.com/ryz310/my_api_client/pull/666) Bump bugsnag from 6.24.1 to 6.24.2 ([@ryz310](https://github.com/ryz310))
23
+ - [#667](https://github.com/ryz310/my_api_client/pull/667) Bump rubocop-rspec from 2.7.0 to 2.8.0 ([@ryz310](https://github.com/ryz310))
24
+ - [#671](https://github.com/ryz310/my_api_client/pull/671) Bump rspec from 3.10.0 to 3.11.0 ([@ryz310](https://github.com/ryz310))
25
+ - [#678](https://github.com/ryz310/my_api_client/pull/678) Bump faraday from 1.10.0 to 2.2.0 ([@ryz310](https://github.com/ryz310))
26
+ - [#702](https://github.com/ryz310/my_api_client/pull/702) Bump jsonpath from 1.1.0 to 1.1.2 ([@ryz310](https://github.com/ryz310))
27
+ - [#715](https://github.com/ryz310/my_api_client/pull/715) Bump activesupport from 7.0.2.4 to 7.0.3 ([@ryz310](https://github.com/ryz310))
28
+ - [#726](https://github.com/ryz310/my_api_client/pull/726) Bump yard from 0.9.27 to 0.9.28 ([@ryz310](https://github.com/ryz310))
29
+ - [#729](https://github.com/ryz310/my_api_client/pull/729) Bump rubocop-performance from 1.14.1 to 1.14.2 ([@ryz310](https://github.com/ryz310))
30
+ - [#730](https://github.com/ryz310/my_api_client/pull/730) Bump sawyer from 0.9.1 to 0.9.2 ([@ryz310](https://github.com/ryz310))
31
+
3
32
  ## v0.22.0 (Dec 26, 2021)
4
33
 
5
34
  ### Feature
6
35
 
7
- * [#648](https://github.com/ryz310/my_api_client/pull/648) Support Rails 7.0 ([@ryz310](https://github.com/ryz310))
36
+ - [#648](https://github.com/ryz310/my_api_client/pull/648) Support Rails 7.0 ([@ryz310](https://github.com/ryz310))
8
37
 
9
38
  ### Rubocop Challenge
10
39
 
11
- * [#617](https://github.com/ryz310/my_api_client/pull/617) RSpec/ExcessiveDocstringSpacing-20210922233114 ([@ryz310](https://github.com/ryz310))
12
- * [#623](https://github.com/ryz310/my_api_client/pull/623) Security/IoMethods-20210930233112 ([@ryz310](https://github.com/ryz310))
13
- * [#624](https://github.com/ryz310/my_api_client/pull/624) ryz310/rubocop-challenge/20211004233152 ([@ryz310](https://github.com/ryz310))
14
- * [#638](https://github.com/ryz310/my_api_client/pull/638) Gemspec/RequireMFA-20211115233105 ([@ryz310](https://github.com/ryz310))
40
+ - [#617](https://github.com/ryz310/my_api_client/pull/617) RSpec/ExcessiveDocstringSpacing-20210922233114 ([@ryz310](https://github.com/ryz310))
41
+ - [#623](https://github.com/ryz310/my_api_client/pull/623) Security/IoMethods-20210930233112 ([@ryz310](https://github.com/ryz310))
42
+ - [#624](https://github.com/ryz310/my_api_client/pull/624) Re-generate .rubocop_todo.yml with RuboCop v1.22.1 ([@ryz310](https://github.com/ryz310))
43
+ - [#638](https://github.com/ryz310/my_api_client/pull/638) Gemspec/RequireMFA-20211115233105 ([@ryz310](https://github.com/ryz310))
15
44
 
16
45
  ### Dependabot
17
46
 
18
- * [#576](https://github.com/ryz310/my_api_client/pull/576) Bump bugsnag from 6.21.0 to 6.22.1 ([@ryz310](https://github.com/ryz310))
19
- * [#612](https://github.com/ryz310/my_api_client/pull/612) ryz310/dependabot/bundler/faraday-1.8.0 ([@ryz310](https://github.com/ryz310))
20
- * [#625](https://github.com/ryz310/my_api_client/pull/625) ryz310/dependabot/bundler/bugsnag-6.24.0 ([@ryz310](https://github.com/ryz310))
21
- * [#635](https://github.com/ryz310/my_api_client/pull/635) Bump rubocop-performance from 1.11.5 to 1.12.0 ([@ryz310](https://github.com/ryz310))
22
- * [#636](https://github.com/ryz310/my_api_client/pull/636) ryz310/dependabot/bundler/rubocop-rspec-2.6.0 ([@ryz310](https://github.com/ryz310))
23
- * [#639](https://github.com/ryz310/my_api_client/pull/639) Bump yard from 0.9.26 to 0.9.27 ([@ryz310](https://github.com/ryz310))
24
- * [#640](https://github.com/ryz310/my_api_client/pull/640) Bump bugsnag from 6.24.0 to 6.24.1 ([@ryz310](https://github.com/ryz310))
25
- * [#641](https://github.com/ryz310/my_api_client/pull/641) Bump activesupport from 6.1.4.1 to 6.1.4.2 ([@ryz310](https://github.com/ryz310))
26
- * [#644](https://github.com/ryz310/my_api_client/pull/644) ryz310/dependabot/bundler/activesupport-6.1.4.4 ([@ryz310](https://github.com/ryz310))
47
+ - [#576](https://github.com/ryz310/my_api_client/pull/576) Bump bugsnag from 6.21.0 to 6.22.1 ([@ryz310](https://github.com/ryz310))
48
+ - [#612](https://github.com/ryz310/my_api_client/pull/612) ryz310/dependabot/bundler/faraday-1.8.0 ([@ryz310](https://github.com/ryz310))
49
+ - [#625](https://github.com/ryz310/my_api_client/pull/625) ryz310/dependabot/bundler/bugsnag-6.24.0 ([@ryz310](https://github.com/ryz310))
50
+ - [#635](https://github.com/ryz310/my_api_client/pull/635) Bump rubocop-performance from 1.11.5 to 1.12.0 ([@ryz310](https://github.com/ryz310))
51
+ - [#636](https://github.com/ryz310/my_api_client/pull/636) ryz310/dependabot/bundler/rubocop-rspec-2.6.0 ([@ryz310](https://github.com/ryz310))
52
+ - [#639](https://github.com/ryz310/my_api_client/pull/639) Bump yard from 0.9.26 to 0.9.27 ([@ryz310](https://github.com/ryz310))
53
+ - [#640](https://github.com/ryz310/my_api_client/pull/640) Bump bugsnag from 6.24.0 to 6.24.1 ([@ryz310](https://github.com/ryz310))
54
+ - [#641](https://github.com/ryz310/my_api_client/pull/641) Bump activesupport from 6.1.4.1 to 6.1.4.2 ([@ryz310](https://github.com/ryz310))
55
+ - [#644](https://github.com/ryz310/my_api_client/pull/644) ryz310/dependabot/bundler/activesupport-6.1.4.4 ([@ryz310](https://github.com/ryz310))
27
56
 
28
57
  ## v0.21.0 (Aug 07, 2021)
29
58
 
30
59
  ### Feature
31
60
 
32
- * [#570](https://github.com/ryz310/my_api_client/pull/570) Stubbing status code on testing ([@ryz310](https://github.com/ryz310))
61
+ - [#570](https://github.com/ryz310/my_api_client/pull/570) Stubbing status code on testing ([@ryz310](https://github.com/ryz310))
33
62
 
34
63
  ### Breaking Change
35
64
 
36
- * [#561](https://github.com/ryz310/my_api_client/pull/561) Goodbye Ruby 2.5.x! ([@ryz310](https://github.com/ryz310))
65
+ - [#561](https://github.com/ryz310/my_api_client/pull/561) Goodbye Ruby 2.5.x! ([@ryz310](https://github.com/ryz310))
37
66
 
38
67
  ### Rubocop Challenge
39
68
 
40
- * [#523](https://github.com/ryz310/my_api_client/pull/523) Layout/LineEndStringConcatenationIndentation-20210629233103 ([@ryz310](https://github.com/ryz310))
41
- * [#562](https://github.com/ryz310/my_api_client/pull/562) Re-generate .rubocop_todo.yml with RuboCop v1.18.4 ([@ryz310](https://github.com/ryz310))
69
+ - [#523](https://github.com/ryz310/my_api_client/pull/523) Layout/LineEndStringConcatenationIndentation-20210629233103 ([@ryz310](https://github.com/ryz310))
70
+ - [#562](https://github.com/ryz310/my_api_client/pull/562) Re-generate .rubocop_todo.yml with RuboCop v1.18.4 ([@ryz310](https://github.com/ryz310))
42
71
 
43
72
  ### Misc
44
73
 
45
- * [#509](https://github.com/ryz310/my_api_client/pull/509) Fix the problem of mimemagic gem dependency ([@ryz310](https://github.com/ryz310))
46
- * [#559](https://github.com/ryz310/my_api_client/pull/559) Fix gemfiles compatibility ([@ryz310](https://github.com/ryz310))
74
+ - [#509](https://github.com/ryz310/my_api_client/pull/509) Fix the problem of mimemagic gem dependency ([@ryz310](https://github.com/ryz310))
75
+ - [#559](https://github.com/ryz310/my_api_client/pull/559) Fix gemfiles compatibility ([@ryz310](https://github.com/ryz310))
47
76
 
48
77
  ## v0.20.0 (Mar 07, 2021)
49
78
 
50
79
  ### Feature
51
80
 
52
- * [#456](https://github.com/ryz310/my_api_client/pull/456) Stubbed pagination ([@ryz310](https://github.com/ryz310))
81
+ - [#456](https://github.com/ryz310/my_api_client/pull/456) Stubbed pagination ([@ryz310](https://github.com/ryz310))
53
82
 
54
83
  ### Rubocop Challenge
55
84
 
56
- * [#414](https://github.com/ryz310/my_api_client/pull/414) Style/StringConcatenation-20210106033935 ([@ryz310](https://github.com/ryz310))
57
- * [#416](https://github.com/ryz310/my_api_client/pull/416) Style/HashTransformValues-20210106233116 ([@ryz310](https://github.com/ryz310))
58
- * [#433](https://github.com/ryz310/my_api_client/pull/433) Lint/SymbolConversion-20210128233108 ([@ryz310](https://github.com/ryz310))
59
- * [#452](https://github.com/ryz310/my_api_client/pull/452) Re-generate .rubocop_todo.yml with RuboCop v1.11.0 ([@ryz310](https://github.com/ryz310))
85
+ - [#414](https://github.com/ryz310/my_api_client/pull/414) Style/StringConcatenation-20210106033935 ([@ryz310](https://github.com/ryz310))
86
+ - [#416](https://github.com/ryz310/my_api_client/pull/416) Style/HashTransformValues-20210106233116 ([@ryz310](https://github.com/ryz310))
87
+ - [#433](https://github.com/ryz310/my_api_client/pull/433) Lint/SymbolConversion-20210128233108 ([@ryz310](https://github.com/ryz310))
88
+ - [#452](https://github.com/ryz310/my_api_client/pull/452) Re-generate .rubocop_todo.yml with RuboCop v1.11.0 ([@ryz310](https://github.com/ryz310))
60
89
 
61
90
  ### Misc
62
91
 
63
- * [#436](https://github.com/ryz310/my_api_client/pull/436) Use Circle CI matrix ([@ryz310](https://github.com/ryz310))
92
+ - [#436](https://github.com/ryz310/my_api_client/pull/436) Use Circle CI matrix ([@ryz310](https://github.com/ryz310))
64
93
 
65
94
  ## v0.19.0 (Jan 04, 2021)
66
95
 
67
96
  ### Feature
68
97
 
69
- * [#402](https://github.com/ryz310/my_api_client/pull/402) Support Ruby 3.0 and Rails 6.1 ([@ryz310](https://github.com/ryz310))
98
+ - [#402](https://github.com/ryz310/my_api_client/pull/402) Support Ruby 3.0 and Rails 6.1 ([@ryz310](https://github.com/ryz310))
70
99
 
71
100
  ### Rubocop Challenge
72
101
 
73
- * [#400](https://github.com/ryz310/my_api_client/pull/400) Re-generate .rubocop_todo.yml with RuboCop v1.7.0 ([@ryz310](https://github.com/ryz310))
102
+ - [#400](https://github.com/ryz310/my_api_client/pull/400) Re-generate .rubocop_todo.yml with RuboCop v1.7.0 ([@ryz310](https://github.com/ryz310))
74
103
 
75
104
  ## v0.18.0 (Dec 04, 2020)
76
105
 
77
106
  ### Feature
78
107
 
79
- * [#381](https://github.com/ryz310/my_api_client/pull/381) Add endpoint option to the generator ([@ryz310](https://github.com/ryz310))
108
+ - [#381](https://github.com/ryz310/my_api_client/pull/381) Add endpoint option to the generator ([@ryz310](https://github.com/ryz310))
80
109
 
81
110
  ### Breaking Change
82
111
 
83
- * [#365](https://github.com/ryz310/my_api_client/pull/365) End of support for Ruby 2.4 and Rails 4.2 ([@ryz310](https://github.com/ryz310))
112
+ - [#365](https://github.com/ryz310/my_api_client/pull/365) End of support for Ruby 2.4 and Rails 4.2 ([@ryz310](https://github.com/ryz310))
84
113
 
85
114
  ### Rubocop Challenge
86
115
 
87
- * [#383](https://github.com/ryz310/my_api_client/pull/383) Re-generate .rubocop_todo.yml with RuboCop v1.5.1 ([@ryz310](https://github.com/ryz310))
116
+ - [#383](https://github.com/ryz310/my_api_client/pull/383) Re-generate .rubocop_todo.yml with RuboCop v1.5.1 ([@ryz310](https://github.com/ryz310))
88
117
 
89
118
  ## v0.17.0 (Sep 20, 2020)
90
119
 
91
120
  ### Feature
92
121
 
93
- * [#303](https://github.com/ryz310/my_api_client/pull/303) Change the duration format to milliseconds ([@ryz310](https://github.com/ryz310))
94
- * [#308](https://github.com/ryz310/my_api_client/pull/308) Add testing for api client generators ([@ryz310](https://github.com/ryz310))
122
+ - [#303](https://github.com/ryz310/my_api_client/pull/303) Change the duration format to milliseconds ([@ryz310](https://github.com/ryz310))
123
+ - [#308](https://github.com/ryz310/my_api_client/pull/308) Add testing for api client generators ([@ryz310](https://github.com/ryz310))
95
124
 
96
125
  ### Rubocop Challenge
97
126
 
98
- * [#311](https://github.com/ryz310/my_api_client/pull/311) Style/GlobalStdStream-20200906233350 ([@ryz310](https://github.com/ryz310))
99
- * [#312](https://github.com/ryz310/my_api_client/pull/312) Style/StringConcatenation-20200907233020 ([@ryz310](https://github.com/ryz310))
100
- * [#313](https://github.com/ryz310/my_api_client/pull/313) Style/HashTransformValues-20200908233016 ([@ryz310](https://github.com/ryz310))
101
- * [#316](https://github.com/ryz310/my_api_client/pull/316) Layout/EmptyLinesAroundAttributeAccessor-20200909233021 ([@ryz310](https://github.com/ryz310))
102
- * [#320](https://github.com/ryz310/my_api_client/pull/320) Re-generate .rubocop_todo.yml with RuboCop v0.91.0 ([@ryz310](https://github.com/ryz310))
127
+ - [#311](https://github.com/ryz310/my_api_client/pull/311) Style/GlobalStdStream-20200906233350 ([@ryz310](https://github.com/ryz310))
128
+ - [#312](https://github.com/ryz310/my_api_client/pull/312) Style/StringConcatenation-20200907233020 ([@ryz310](https://github.com/ryz310))
129
+ - [#313](https://github.com/ryz310/my_api_client/pull/313) Style/HashTransformValues-20200908233016 ([@ryz310](https://github.com/ryz310))
130
+ - [#316](https://github.com/ryz310/my_api_client/pull/316) Layout/EmptyLinesAroundAttributeAccessor-20200909233021 ([@ryz310](https://github.com/ryz310))
131
+ - [#320](https://github.com/ryz310/my_api_client/pull/320) Re-generate .rubocop_todo.yml with RuboCop v0.91.0 ([@ryz310](https://github.com/ryz310))
103
132
 
104
133
  ## v0.16.1 (Aug 27, 2020)
105
134
 
106
135
  ### Feature
107
136
 
108
- * [#296](https://github.com/ryz310/my_api_client/pull/296) Support HTTP PUT method ([@ryz310](https://github.com/ryz310))
137
+ - [#296](https://github.com/ryz310/my_api_client/pull/296) Support HTTP PUT method ([@ryz310](https://github.com/ryz310))
109
138
 
110
139
  ### Rubocop Challenge
111
140
 
112
- * [#256](https://github.com/ryz310/my_api_client/pull/256) Performance/StartWith-20200523233027 ([@ryz310](https://github.com/ryz310))
113
- * [#268](https://github.com/ryz310/my_api_client/pull/268) Lint/RedundantCopDisableDirective-20200622233019 ([@ryz310](https://github.com/ryz310))
114
- * [#289](https://github.com/ryz310/my_api_client/pull/289) Re-generate .rubocop_todo.yml with RuboCop v0.89.1 ([@ryz310](https://github.com/ryz310))
115
- * [#293](https://github.com/ryz310/my_api_client/pull/293) RSpec/LeadingSubject-20200817233022 ([@ryz310](https://github.com/ryz310))
141
+ - [#256](https://github.com/ryz310/my_api_client/pull/256) Performance/StartWith-20200523233027 ([@ryz310](https://github.com/ryz310))
142
+ - [#268](https://github.com/ryz310/my_api_client/pull/268) Lint/RedundantCopDisableDirective-20200622233019 ([@ryz310](https://github.com/ryz310))
143
+ - [#289](https://github.com/ryz310/my_api_client/pull/289) Re-generate .rubocop_todo.yml with RuboCop v0.89.1 ([@ryz310](https://github.com/ryz310))
144
+ - [#293](https://github.com/ryz310/my_api_client/pull/293) RSpec/LeadingSubject-20200817233022 ([@ryz310](https://github.com/ryz310))
116
145
 
117
146
  ### Misc
118
147
 
119
- * [#271](https://github.com/ryz310/my_api_client/pull/271) Minor fixes ([@ryz310](https://github.com/ryz310))
148
+ - [#271](https://github.com/ryz310/my_api_client/pull/271) Minor fixes ([@ryz310](https://github.com/ryz310))
120
149
 
121
150
  ## v0.16.0 (Mar 29, 2020)
122
151
 
@@ -137,6 +166,7 @@ def my_error_handling
137
166
  # No exception is raised. You can raise an error if necessary.
138
167
  end
139
168
  ```
169
+
140
170
  ```rb
141
171
  error_handling status_code: 500..599 do |_params, logger|
142
172
  # Executes this block when an error is detected.
@@ -154,6 +184,7 @@ def my_error_handling
154
184
  # And then raise `MyApiClient::Error`.
155
185
  end
156
186
  ```
187
+
157
188
  ```rb
158
189
  error_handling status_code: 500..599 do |params, logger|
159
190
  # Executes this block when an error is detected.
@@ -171,74 +202,80 @@ See: https://github.com/ryz310/my_api_client/blob/master/lib/my_api_client/defau
171
202
 
172
203
  ### Misc
173
204
 
174
- * [#229](https://github.com/ryz310/my_api_client/pull/229) Edit dependabot configuration ([@ryz310](https://github.com/ryz310))
205
+ - [#229](https://github.com/ryz310/my_api_client/pull/229) Edit dependabot configuration ([@ryz310](https://github.com/ryz310))
175
206
 
176
207
  ## v0.15.0 (Mar 21, 2020)
177
208
 
178
209
  ### Feature
179
210
 
180
- * [#220](https://github.com/ryz310/my_api_client/pull/220) Pageable HTTP request ([@ryz310](https://github.com/ryz310))
181
- * Add `#pageable_get` method (alias: `#pget`)
182
- * For example:
183
- * API client definition
184
- ```ruby
185
- class MyPaginationApiClient < ApplicationApiClient
186
- endpoint 'https://example.com/v1'
187
-
188
- # GET pagination?page=1
189
- def pagination
190
- pageable_get 'pagination', paging: '$.links.next', headers: headers, query: { page: 1 }
191
- end
192
-
193
- private
194
-
195
- def headers
196
- { 'Content-Type': 'application/json;charset=UTF-8' }
197
- end
198
- end
199
- ```
200
- * The pagination API response
201
- ```json
202
- {
203
- "links": {
204
- "next": "https://example.com/pagination?page=3",
205
- "previous": "https://example.com/pagination?page=1",
206
- },
207
- "page": 2
208
- }
209
- ```
210
- * Usage
211
- ```ruby
212
- api_clinet = MyPaginationApiClient.new
213
- api_clinet.pagination.each do |response|
214
- # Do something.
215
- end
216
-
217
- p = api_clinet.pagination
218
- p.next # => 1st page result
219
- p.next # => 2nd page result
220
- p.next # => 3rd page result
221
- ```
222
- * [#223](https://github.com/ryz310/my_api_client/pull/223) Use Enumerator::Lazy instead of Enumerator ([@ryz310](https://github.com/ryz310))
211
+ - [#220](https://github.com/ryz310/my_api_client/pull/220) Pageable HTTP request ([@ryz310](https://github.com/ryz310))
212
+
213
+ - Add `#pageable_get` method (alias: `#pget`)
214
+ - For example:
215
+
216
+ - API client definition
217
+
218
+ ```ruby
219
+ class MyPaginationApiClient < ApplicationApiClient
220
+ endpoint 'https://example.com/v1'
221
+
222
+ # GET pagination?page=1
223
+ def pagination
224
+ pageable_get 'pagination', paging: '$.links.next', headers: headers, query: { page: 1 }
225
+ end
226
+
227
+ private
228
+
229
+ def headers
230
+ { 'Content-Type': 'application/json;charset=UTF-8' }
231
+ end
232
+ end
233
+ ```
234
+
235
+ - The pagination API response
236
+ ```json
237
+ {
238
+ "links": {
239
+ "next": "https://example.com/pagination?page=3",
240
+ "previous": "https://example.com/pagination?page=1"
241
+ },
242
+ "page": 2
243
+ }
244
+ ```
245
+ - Usage
246
+
247
+ ```ruby
248
+ api_clinet = MyPaginationApiClient.new
249
+ api_clinet.pagination.each do |response|
250
+ # Do something.
251
+ end
252
+
253
+ p = api_clinet.pagination
254
+ p.next # => 1st page result
255
+ p.next # => 2nd page result
256
+ p.next # => 3rd page result
257
+ ```
258
+
259
+ - [#223](https://github.com/ryz310/my_api_client/pull/223) Use Enumerator::Lazy instead of Enumerator ([@ryz310](https://github.com/ryz310))
223
260
 
224
261
  ## v0.14.0 (Mar 14, 2020)
225
262
 
226
263
  ### Feature
227
264
 
228
- * [#211](https://github.com/ryz310/my_api_client/pull/211) Integration testing using the jets framework ([@ryz310](https://github.com/ryz310))
229
- * [#213](https://github.com/ryz310/my_api_client/pull/213) Add status API to integration testing ([@ryz310](https://github.com/ryz310))
230
- * [#214](https://github.com/ryz310/my_api_client/pull/214) Add error API to integration testing ([@ryz310](https://github.com/ryz310))
231
- * [#215](https://github.com/ryz310/my_api_client/pull/215) Update the REST API to enhance integration testing ([@ryz310](https://github.com/ryz310))
265
+ - [#211](https://github.com/ryz310/my_api_client/pull/211) Integration testing using the jets framework ([@ryz310](https://github.com/ryz310))
266
+ - [#213](https://github.com/ryz310/my_api_client/pull/213) Add status API to integration testing ([@ryz310](https://github.com/ryz310))
267
+ - [#214](https://github.com/ryz310/my_api_client/pull/214) Add error API to integration testing ([@ryz310](https://github.com/ryz310))
268
+ - [#215](https://github.com/ryz310/my_api_client/pull/215) Update the REST API to enhance integration testing ([@ryz310](https://github.com/ryz310))
232
269
 
233
270
  ### Refactoring
234
271
 
235
- * [#179](https://github.com/ryz310/my_api_client/pull/179) Change the "with" option structure ([@ryz310](https://github.com/ryz310))
236
- * [#206](https://github.com/ryz310/my_api_client/pull/206) Rebuild api request processing ([@ryz310](https://github.com/ryz310))
237
- * [#207](https://github.com/ryz310/my_api_client/pull/207) Fix offending codes ([@ryz310](https://github.com/ryz310))
272
+ - [#179](https://github.com/ryz310/my_api_client/pull/179) Change the "with" option structure ([@ryz310](https://github.com/ryz310))
273
+ - [#206](https://github.com/ryz310/my_api_client/pull/206) Rebuild api request processing ([@ryz310](https://github.com/ryz310))
274
+ - [#207](https://github.com/ryz310/my_api_client/pull/207) Fix offending codes ([@ryz310](https://github.com/ryz310))
238
275
 
239
276
  ### Breaking Change
240
277
 
241
- * [#196](https://github.com/ryz310/my_api_client/pull/196) Change the request structure ([@ryz310](https://github.com/ryz310))
278
+ - [#196](https://github.com/ryz310/my_api_client/pull/196) Change the request structure ([@ryz310](https://github.com/ryz310))
242
279
 
243
280
  > ### logging
244
281
  >
@@ -287,149 +324,149 @@ See: https://github.com/ryz310/my_api_client/blob/master/lib/my_api_client/defau
287
324
 
288
325
  ### Rubocop Challenge
289
326
 
290
- * [#205](https://github.com/ryz310/my_api_client/pull/205) Re-generate .rubocop_todo.yml with RuboCop v0.80.0 ([@ryz310](https://github.com/ryz310))
291
- * [#210](https://github.com/ryz310/my_api_client/pull/210) Re-generate .rubocop_todo.yml with RuboCop v0.80.1 ([@ryz310](https://github.com/ryz310))
327
+ - [#205](https://github.com/ryz310/my_api_client/pull/205) Re-generate .rubocop_todo.yml with RuboCop v0.80.0 ([@ryz310](https://github.com/ryz310))
328
+ - [#210](https://github.com/ryz310/my_api_client/pull/210) Re-generate .rubocop_todo.yml with RuboCop v0.80.1 ([@ryz310](https://github.com/ryz310))
292
329
 
293
330
  ## v0.13.0 (Jan 21, 2020)
294
331
 
295
332
  ### Feature
296
333
 
297
- * [#180](https://github.com/ryz310/my_api_client/pull/180) Stub response on raising error ([@ryz310](https://github.com/ryz310))
334
+ - [#180](https://github.com/ryz310/my_api_client/pull/180) Stub response on raising error ([@ryz310](https://github.com/ryz310))
298
335
 
299
336
  ## v0.12.0 (Jan 19, 2020)
300
337
 
301
338
  ### Feature
302
339
 
303
- * [#173](https://github.com/ryz310/my_api_client/pull/173) Avoid sleep on testing ([@ryz310](https://github.com/ryz310))
304
- * [#175](https://github.com/ryz310/my_api_client/pull/175) Verify arguments on error handling definition ([@ryz310](https://github.com/ryz310))
305
- * [#176](https://github.com/ryz310/my_api_client/pull/176) Provides a syntax sugar of `retry_on` on `error_handling` ([@ryz310](https://github.com/ryz310))
340
+ - [#173](https://github.com/ryz310/my_api_client/pull/173) Avoid sleep on testing ([@ryz310](https://github.com/ryz310))
341
+ - [#175](https://github.com/ryz310/my_api_client/pull/175) Verify arguments on error handling definition ([@ryz310](https://github.com/ryz310))
342
+ - [#176](https://github.com/ryz310/my_api_client/pull/176) Provides a syntax sugar of `retry_on` on `error_handling` ([@ryz310](https://github.com/ryz310))
306
343
 
307
344
  ### Bugfix
308
345
 
309
- * [#174](https://github.com/ryz310/my_api_client/pull/174) Fix warning on ruby 2.7 ([@ryz310](https://github.com/ryz310))
346
+ - [#174](https://github.com/ryz310/my_api_client/pull/174) Fix warning on ruby 2.7 ([@ryz310](https://github.com/ryz310))
310
347
 
311
348
  ## v0.11.0 (Jan 16, 2020)
312
349
 
313
350
  ### Feature
314
351
 
315
- * [#170](https://github.com/ryz310/my_api_client/pull/170) Support ruby 2.7 ([@ryz310](https://github.com/ryz310))
352
+ - [#170](https://github.com/ryz310/my_api_client/pull/170) Support ruby 2.7 ([@ryz310](https://github.com/ryz310))
316
353
 
317
354
  ### Rubocop Challenge
318
355
 
319
- * [#158](https://github.com/ryz310/my_api_client/pull/158) Re-generate .rubocop_todo.yml with RuboCop v0.78.0 ([@ryz310](https://github.com/ryz310))
320
- * [#168](https://github.com/ryz310/my_api_client/pull/168) Re-generate .rubocop_todo.yml with RuboCop v0.79.0 ([@ryz310](https://github.com/ryz310))
356
+ - [#158](https://github.com/ryz310/my_api_client/pull/158) Re-generate .rubocop_todo.yml with RuboCop v0.78.0 ([@ryz310](https://github.com/ryz310))
357
+ - [#168](https://github.com/ryz310/my_api_client/pull/168) Re-generate .rubocop_todo.yml with RuboCop v0.79.0 ([@ryz310](https://github.com/ryz310))
321
358
 
322
359
  ## v0.10.3 (Dec 05, 2019)
323
360
 
324
361
  ### Bugfix
325
362
 
326
- * [#150](https://github.com/ryz310/my_api_client/pull/150) Redefine network error class ([@ryz310](https://github.com/ryz310))
363
+ - [#150](https://github.com/ryz310/my_api_client/pull/150) Redefine network error class ([@ryz310](https://github.com/ryz310))
327
364
 
328
365
  ### Rubocop Challenge
329
366
 
330
- * [#136](https://github.com/ryz310/my_api_client/pull/136) Re-generate .rubocop_todo.yml with RuboCop v0.76.0 ([@ryz310](https://github.com/ryz310))
331
- * [#148](https://github.com/ryz310/my_api_client/pull/148) Re-generate .rubocop_todo.yml with RuboCop v0.77.0 ([@ryz310](https://github.com/ryz310))
367
+ - [#136](https://github.com/ryz310/my_api_client/pull/136) Re-generate .rubocop_todo.yml with RuboCop v0.76.0 ([@ryz310](https://github.com/ryz310))
368
+ - [#148](https://github.com/ryz310/my_api_client/pull/148) Re-generate .rubocop_todo.yml with RuboCop v0.77.0 ([@ryz310](https://github.com/ryz310))
332
369
 
333
370
  ## 0.10.2 (Oct 23, 2019)
334
371
 
335
372
  ### Bugfix
336
373
 
337
- * Ignore error handling when using request to matcher ([#130](https://github.com/ryz310/my_api_client/pull/130))
338
- * Fix `be_handled_as_an_error` description ([#131](https://github.com/ryz310/my_api_client/pull/131))
374
+ - Ignore error handling when using request to matcher ([#130](https://github.com/ryz310/my_api_client/pull/130))
375
+ - Fix `be_handled_as_an_error` description ([#131](https://github.com/ryz310/my_api_client/pull/131))
339
376
 
340
377
  ## 0.10.1 (Oct 23, 2019)
341
378
 
342
379
  ### Feature
343
380
 
344
- * Support `retry_on` testing at shoulda matcher ([#127](https://github.com/ryz310/my_api_client/pull/127))
381
+ - Support `retry_on` testing at shoulda matcher ([#127](https://github.com/ryz310/my_api_client/pull/127))
345
382
 
346
383
  ## 0.10.0 (Oct 23, 2019)
347
384
 
348
385
  ### Feature
349
386
 
350
- * Shoulda-matchers for my_api_client ([#124](https://github.com/ryz310/my_api_client/pull/124))
387
+ - Shoulda-matchers for my_api_client ([#124](https://github.com/ryz310/my_api_client/pull/124))
351
388
 
352
389
  ### Misc
353
390
 
354
- * Modify request specifications ([#120](https://github.com/ryz310/my_api_client/pull/120))
355
- * Re-generate .rubocop_todo.yml with RuboCop v0.75.1 ([#121](https://github.com/ryz310/my_api_client/pull/121))
391
+ - Modify request specifications ([#120](https://github.com/ryz310/my_api_client/pull/120))
392
+ - Re-generate .rubocop_todo.yml with RuboCop v0.75.1 ([#121](https://github.com/ryz310/my_api_client/pull/121))
356
393
 
357
394
  ## 0.9.2 (Oct 8, 2019)
358
395
 
359
396
  ### Bugfix
360
397
 
361
- * Fix endpoint parsing when including port number ([#117](https://github.com/ryz310/my_api_client/pull/117))
362
- * Fixes: Can't request to URL which includes port numbert ([#116](https://github.com/ryz310/my_api_client/pull/116))
398
+ - Fix endpoint parsing when including port number ([#117](https://github.com/ryz310/my_api_client/pull/117))
399
+ - Fixes: Can't request to URL which includes port numbert ([#116](https://github.com/ryz310/my_api_client/pull/116))
363
400
 
364
401
  ### Misc
365
402
 
366
- * Re-generate .rubocop_todo.yml with RuboCop v0.74.0 ([#100](https://github.com/ryz310/my_api_client/pull/100))
367
- * Re-generate .rubocop_todo.yml with RuboCop v0.75.0 ([#112](https://github.com/ryz310/my_api_client/pull/112))
368
- * Support Rails 6.0 ([#101](https://github.com/ryz310/my_api_client/pull/101))
403
+ - Re-generate .rubocop_todo.yml with RuboCop v0.74.0 ([#100](https://github.com/ryz310/my_api_client/pull/100))
404
+ - Re-generate .rubocop_todo.yml with RuboCop v0.75.0 ([#112](https://github.com/ryz310/my_api_client/pull/112))
405
+ - Support Rails 6.0 ([#101](https://github.com/ryz310/my_api_client/pull/101))
369
406
 
370
- * deprecated/my_api_client_stub ([#102](https://github.com/ryz310/my_api_client/pull/102))
407
+ - deprecated/my_api_client_stub ([#102](https://github.com/ryz310/my_api_client/pull/102))
371
408
 
372
409
  ## 0.9.1 (July 25, 2019)
373
410
 
374
411
  ### Bugfix
375
412
 
376
- * Fix forbid nil option ([#97](https://github.com/ryz310/my_api_client/pull/97)) **Breaking Changes**
413
+ - Fix forbid nil option ([#97](https://github.com/ryz310/my_api_client/pull/97)) **Breaking Changes**
377
414
 
378
415
  ## 0.9.0 (July 25, 2019)
379
416
 
380
417
  ### New Features
381
418
 
382
- * Forbid nil response ([#93](https://github.com/ryz310/my_api_client/pull/93))
419
+ - Forbid nil response ([#93](https://github.com/ryz310/my_api_client/pull/93))
383
420
 
384
421
  ### Misc
385
422
 
386
- * RSpec/DescribedClass-20190723233015 ([#92](https://github.com/ryz310/my_api_client/pull/92))
423
+ - RSpec/DescribedClass-20190723233015 ([#92](https://github.com/ryz310/my_api_client/pull/92))
387
424
 
388
425
  ## 0.8.0 (July 23, 2019)
389
426
 
390
427
  ### New Features
391
428
 
392
- * Allow method calling on error handling ([#89](https://github.com/ryz310/my_api_client/pull/89))
429
+ - Allow method calling on error handling ([#89](https://github.com/ryz310/my_api_client/pull/89))
393
430
 
394
431
  ### Breaking Changes
395
432
 
396
- * Require sawyer gem v0.8.2 over ([#88](https://github.com/ryz310/my_api_client/pull/88))
433
+ - Require sawyer gem v0.8.2 over ([#88](https://github.com/ryz310/my_api_client/pull/88))
397
434
 
398
435
  ## 0.7.0 (July 17, 2019)
399
436
 
400
437
  ### Features
401
438
 
402
- * Add request duration to metadata ([#80](https://github.com/ryz310/my_api_client/pull/80))
403
- * Support boolean on error handling ([#81](https://github.com/ryz310/my_api_client/pull/81))
439
+ - Add request duration to metadata ([#80](https://github.com/ryz310/my_api_client/pull/80))
440
+ - Support boolean on error handling ([#81](https://github.com/ryz310/my_api_client/pull/81))
404
441
 
405
442
  ### Breaking Changes
406
443
 
407
- * Modify the generator to be simple ([#82](https://github.com/ryz310/my_api_client/pull/82))
444
+ - Modify the generator to be simple ([#82](https://github.com/ryz310/my_api_client/pull/82))
408
445
 
409
446
  ### Misc
410
447
 
411
- * Re-generate .rubocop_todo.yml with RuboCop v0.73.0 ([#79](https://github.com/ryz310/my_api_client/pull/79))
412
- * Introduce gem comet ([#85](https://github.com/ryz310/my_api_client/pull/85))
448
+ - Re-generate .rubocop_todo.yml with RuboCop v0.73.0 ([#79](https://github.com/ryz310/my_api_client/pull/79))
449
+ - Introduce gem comet ([#85](https://github.com/ryz310/my_api_client/pull/85))
413
450
 
414
451
  ## 0.6.2 (July 03, 2019)
415
452
 
416
453
  ### Bug fixes
417
454
 
418
- * Fix logger setter on the template ([#76](https://github.com/ryz310/my_api_client/pull/76))
419
- * Fixes: The logger does not work... ([#54](https://github.com/ryz310/my_api_client/pull/54))
455
+ - Fix logger setter on the template ([#76](https://github.com/ryz310/my_api_client/pull/76))
456
+ - Fixes: The logger does not work... ([#54](https://github.com/ryz310/my_api_client/pull/54))
420
457
 
421
458
  ## 0.6.1 (July 03, 2019)
422
459
 
423
460
  ### Misc
424
461
 
425
- * Bump yard from `0.9.19` to `0.9.20` ([#72](https://github.com/ryz310/my_api_client/pull/72))
426
- * Fix a security risk
462
+ - Bump yard from `0.9.19` to `0.9.20` ([#72](https://github.com/ryz310/my_api_client/pull/72))
463
+ - Fix a security risk
427
464
 
428
465
  ## 0.6.0 (June 25, 2019)
429
466
 
430
467
  ### New Features
431
468
 
432
- * New stubbing helper ([#65](https://github.com/ryz310/my_api_client/pull/65))
469
+ - New stubbing helper ([#65](https://github.com/ryz310/my_api_client/pull/65))
433
470
 
434
471
  ```rb
435
472
  stub_api_client_all(
@@ -459,86 +496,86 @@ response.id # => 1
459
496
 
460
497
  ### Bug Fixes
461
498
 
462
- * Initialize sawyer agent before logger initialization ([#60](https://github.com/ryz310/my_api_client/pull/60))
463
- * Fixes: The URL included in the logger is incomplete ([#53](https://github.com/ryz310/my_api_client/pull/53))
464
- * Fix parsing error if given text/html response ([#61](https://github.com/ryz310/my_api_client/pull/61))
499
+ - Initialize sawyer agent before logger initialization ([#60](https://github.com/ryz310/my_api_client/pull/60))
500
+ - Fixes: The URL included in the logger is incomplete ([#53](https://github.com/ryz310/my_api_client/pull/53))
501
+ - Fix parsing error if given text/html response ([#61](https://github.com/ryz310/my_api_client/pull/61))
465
502
 
466
503
  ## 0.5.2 (June 23, 2019)
467
504
 
468
505
  ### Bug Fixes
469
506
 
470
- * Fix the result of the retry ([#57](https://github.com/ryz310/my_api_client/pull/57))
471
- * Issue: Return values are nil after retrying ([#56](https://github.com/ryz310/my_api_client/pull/56))
507
+ - Fix the result of the retry ([#57](https://github.com/ryz310/my_api_client/pull/57))
508
+ - Issue: Return values are nil after retrying ([#56](https://github.com/ryz310/my_api_client/pull/56))
472
509
 
473
510
  ### Misc
474
511
 
475
- * Improvement test coverage ([#55](https://github.com/ryz310/my_api_client/pull/55))
512
+ - Improvement test coverage ([#55](https://github.com/ryz310/my_api_client/pull/55))
476
513
 
477
514
  ## 0.5.1 (June 19, 2019)
478
515
 
479
516
  ### Bug Fixes
480
517
 
481
- * Fix unsupported data for the Bugsnag breadcrumbs ([#50](https://github.com/ryz310/my_api_client/pull/50))
518
+ - Fix unsupported data for the Bugsnag breadcrumbs ([#50](https://github.com/ryz310/my_api_client/pull/50))
482
519
 
483
520
  ## 0.5.0 (June 16, 2019)
484
521
 
485
522
  ### New Features
486
523
 
487
- * Support bugsnag breadcrumb ([#41](https://github.com/ryz310/my_api_client/pull/41))
524
+ - Support bugsnag breadcrumb ([#41](https://github.com/ryz310/my_api_client/pull/41))
488
525
 
489
526
  ### Misc
490
527
 
491
- * Use CircleCI Orbs ([#43](https://github.com/ryz310/my_api_client/pull/43))
528
+ - Use CircleCI Orbs ([#43](https://github.com/ryz310/my_api_client/pull/43))
492
529
 
493
530
  ## 0.4.0 (June 03, 2019)
494
531
 
495
532
  ### Feature
496
533
 
497
- * Improvement for endpoint ([#35](https://github.com/ryz310/my_api_client/pull/35))
534
+ - Improvement for endpoint ([#35](https://github.com/ryz310/my_api_client/pull/35))
498
535
 
499
536
  ### Bug Fix
500
537
 
501
- * Add requirements for `$ bin/console` ([#31](https://github.com/ryz310/my_api_client/pull/31))
538
+ - Add requirements for `$ bin/console` ([#31](https://github.com/ryz310/my_api_client/pull/31))
502
539
 
503
540
  ### Misc
504
541
 
505
- * Update RuboCop v0.70.0 -> v0.71.0 ([#34](https://github.com/ryz310/my_api_client/pull/34))
542
+ - Update RuboCop v0.70.0 -> v0.71.0 ([#34](https://github.com/ryz310/my_api_client/pull/34))
506
543
 
507
544
  ## 0.3.0 (May 29, 2019)
508
545
 
509
546
  ### New Features
510
547
 
511
- * Provide test helper for RSpec ([#28](https://github.com/ryz310/my_api_client/pull/28))
548
+ - Provide test helper for RSpec ([#28](https://github.com/ryz310/my_api_client/pull/28))
512
549
 
513
550
  ## 0.2.0 (May 29, 2019)
514
551
 
515
552
  ### New Features
516
553
 
517
- * Support Bugsnag metadata ([#22](https://github.com/ryz310/my_api_client/pull/22))
554
+ - Support Bugsnag metadata ([#22](https://github.com/ryz310/my_api_client/pull/22))
518
555
 
519
556
  ### Misc
520
557
 
521
- * Improve test coverage ([#24](https://github.com/ryz310/my_api_client/pull/24))
522
- * Fix problem on the release job ([#25](https://github.com/ryz310/my_api_client/pull/25))
558
+ - Improve test coverage ([#24](https://github.com/ryz310/my_api_client/pull/24))
559
+ - Fix problem on the release job ([#25](https://github.com/ryz310/my_api_client/pull/25))
523
560
 
524
561
  ## 0.1.4 (May 28, 2019)
525
562
 
526
563
  ### Bugfix
527
564
 
528
- * Support activesupport before v5.2.0 ([#17](https://github.com/ryz310/my_api_client/pull/17))
565
+ - Support activesupport before v5.2.0 ([#17](https://github.com/ryz310/my_api_client/pull/17))
529
566
 
530
567
  ## 0.1.3 (May 27, 2019)
531
568
 
532
- * Fix wrong variable name ([#13](https://github.com/ryz310/my_api_client/pull/13))
569
+ - Fix wrong variable name ([#13](https://github.com/ryz310/my_api_client/pull/13))
533
570
 
534
571
  ## 0.1.2 (May 27, 2019)
535
572
 
536
- * Fix wrong method name ([#10](https://github.com/ryz310/my_api_client/pull/10))
573
+ - Fix wrong method name ([#10](https://github.com/ryz310/my_api_client/pull/10))
537
574
 
538
575
  ## 0.1.1 (May 27, 2019)
539
576
 
540
- * Fix typo ([#6](https://github.com/ryz310/my_api_client/pull/6))
577
+ - Fix typo ([#6](https://github.com/ryz310/my_api_client/pull/6))
541
578
 
542
579
  ## 0.1.0 (May 27, 2019)
543
580
 
544
- * The first release :tada:
581
+ - The first release :tada: