qiita-sdk 0.1.1 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +432 -11
- data/lib/qiita/sdk/version.rb +1 -1
- data/qiita-sdk.gemspec +6 -6
- metadata +9 -9
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 60c438348bcb63b2bd686be1d640435c69ee0f3603f9bb4d318f5ca2905f232a
|
4
|
+
data.tar.gz: 2144b561f252663cebfbdf02d852f8d76df07295054168da63f8cc64a53c78d1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9eb7e4f0f6ba5ce52ff942cd7b00023aa1cabf3d5d2f3d8cb1a66e6408d2181467343af48321ecfceb421bef02acfe3964a58b17f6894c8b2dc424267eddb435
|
7
|
+
data.tar.gz: 50671e6487f16abab46ad15cff2dcfd465a2d00099b8cfe5cca0541d307f0ff38fa1e8a1f6931997b765a723a4fd6d60d31b699447f2036f14be6d9f3180fc98
|
data/README.md
CHANGED
@@ -1,13 +1,9 @@
|
|
1
1
|
# Qiita::Sdk
|
2
2
|
|
3
|
-
|
4
|
-
|
5
|
-
TODO: Delete this and the text above, and describe your gem
|
3
|
+
[Qiita Api](https://qiita.com/api/v2/docs) の Api クライアント
|
6
4
|
|
7
5
|
## Installation
|
8
6
|
|
9
|
-
Add this line to your application's Gemfile:
|
10
|
-
|
11
7
|
```ruby
|
12
8
|
gem 'qiita-sdk'
|
13
9
|
```
|
@@ -22,18 +18,443 @@ Or install it yourself as:
|
|
22
18
|
|
23
19
|
## Usage
|
24
20
|
|
25
|
-
|
21
|
+
### インスタンスの作成
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
client = Qiita::Sdk::Client.new
|
25
|
+
```
|
26
|
+
|
27
|
+
認証が必要なアクションを行う場合
|
28
|
+
|
29
|
+
```ruby
|
30
|
+
client = Qiita::Sdk::Client.new do |config|
|
31
|
+
config.access_token = 'XXXX'
|
32
|
+
end
|
33
|
+
```
|
34
|
+
|
35
|
+
### メソッド一覧
|
36
|
+
|
37
|
+
- 記事につけられた「LGTM!」一覧を取得
|
38
|
+
|
39
|
+
```ruby
|
40
|
+
item_id = 'XXXX'
|
41
|
+
res = client.fetch_item_likes(item_id: item_id)
|
42
|
+
```
|
43
|
+
<br />
|
44
|
+
<br />
|
45
|
+
|
46
|
+
|
47
|
+
- コメントを削除
|
48
|
+
|
49
|
+
```ruby
|
50
|
+
comment_id = 'XXXX'
|
51
|
+
res = client.delete_comment(comment_id: comment_id)
|
52
|
+
```
|
53
|
+
<br />
|
54
|
+
<br />
|
55
|
+
|
56
|
+
|
57
|
+
|
58
|
+
- コメントを取得
|
59
|
+
|
60
|
+
```ruby
|
61
|
+
comment_id = 'XXXX'
|
62
|
+
res = client.fetch_comment(comment_id: comment_id)
|
63
|
+
```
|
64
|
+
<br />
|
65
|
+
<br />
|
66
|
+
|
67
|
+
|
68
|
+
- コメントを更新
|
69
|
+
|
70
|
+
```ruby
|
71
|
+
comment_id = 'XXXX'
|
72
|
+
body = 'update body'
|
73
|
+
client.update_comment(comment_id: comment_id, body: body)
|
74
|
+
```
|
75
|
+
<br />
|
76
|
+
<br />
|
77
|
+
|
78
|
+
|
79
|
+
|
80
|
+
- 投稿に紐づけられた投稿一覧
|
81
|
+
|
82
|
+
```ruby
|
83
|
+
item_id = 'XXXX'
|
84
|
+
client.fetch_item_comments(item_id: item_id)
|
85
|
+
```
|
86
|
+
<br />
|
87
|
+
<br />
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
- 記事に対してコメントを投稿
|
92
|
+
|
93
|
+
```ruby
|
94
|
+
item_id = 'XXXX'
|
95
|
+
body = 'comment body'
|
96
|
+
client.post_comment(item_id: item_id, body: body)
|
97
|
+
```
|
98
|
+
<br />
|
99
|
+
<br />
|
100
|
+
|
101
|
+
|
102
|
+
|
103
|
+
- タグを取得
|
104
|
+
|
105
|
+
```ruby
|
106
|
+
tag_id = 'XXXX'
|
107
|
+
client.fetch_tag(tag_id: tag_id)
|
108
|
+
```
|
109
|
+
<br />
|
110
|
+
<br />
|
111
|
+
|
112
|
+
|
113
|
+
|
114
|
+
- ユーザがフォローしているタグ一覧
|
115
|
+
|
116
|
+
```ruby
|
117
|
+
user_id = 'XXXX'
|
118
|
+
client.fetch_following_tags(user_id: user_id)
|
119
|
+
```
|
120
|
+
<br />
|
121
|
+
<br />
|
122
|
+
|
123
|
+
|
26
124
|
|
27
|
-
|
125
|
+
- タグのフォローを外す
|
28
126
|
|
29
|
-
|
127
|
+
```ruby
|
128
|
+
tag_id = 'XXXX'
|
129
|
+
cient.delete_tag_following(tag_id: tag_id)
|
130
|
+
```
|
131
|
+
<br />
|
132
|
+
<br />
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
- タグをフォローしているかどうかを調る
|
137
|
+
|
138
|
+
```ruby
|
139
|
+
tag_id = 'XXXX'
|
140
|
+
client.check_tag_following(tag_id: tag_id)
|
141
|
+
```
|
142
|
+
<br />
|
143
|
+
<br />
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
- タグをフォロー
|
148
|
+
|
149
|
+
```ruby
|
150
|
+
tag_id = 'XXXX'
|
151
|
+
client.follow_tag(tag_id: tag_id)
|
152
|
+
```
|
153
|
+
<br />
|
154
|
+
<br />
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
- 記事をストックしているユーザ一覧を、ストックした日時の降順で返す
|
159
|
+
|
160
|
+
```ruby
|
161
|
+
item_id = 'XXXX'
|
162
|
+
client.fetch_item_stockers(item_id: item_id)
|
163
|
+
```
|
164
|
+
<br />
|
165
|
+
<br />
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
- 全てのユーザの一覧を作成日時の降順で取得
|
170
|
+
|
171
|
+
```ruby
|
172
|
+
res = client.fetch_users
|
173
|
+
```
|
174
|
+
<br />
|
175
|
+
<br />
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
- ユーザを取得
|
180
|
+
|
181
|
+
```ruby
|
182
|
+
user_id = 'XXXX'
|
183
|
+
res = client.fetch_user(user_id: user_id)
|
184
|
+
```
|
185
|
+
<br />
|
186
|
+
<br />
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
- ユーザがフォローしているユーザ一覧を取得
|
191
|
+
|
192
|
+
```ruby
|
193
|
+
user_id = 'XXXX'
|
194
|
+
res = client.fetch_followees(user_id: user_id)
|
195
|
+
```
|
196
|
+
<br />
|
197
|
+
<br />
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
- ユーザをフォローしているユーザ一覧を取得
|
202
|
+
|
203
|
+
```ruby
|
204
|
+
user_id = 'XXXX'
|
205
|
+
res = client.fetch_followers(user_id: user_id)
|
206
|
+
```
|
207
|
+
<br />
|
208
|
+
<br />
|
209
|
+
|
210
|
+
|
211
|
+
|
212
|
+
- ユーザへのフォローを外します。
|
213
|
+
|
214
|
+
```ruby
|
215
|
+
user_id = 'XXXX'
|
216
|
+
client.delete_following(user_id: user_id)
|
217
|
+
```
|
218
|
+
<br />
|
219
|
+
<br />
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
- ユーザをフォローしている場合に204を返す
|
224
|
+
|
225
|
+
```ruby
|
226
|
+
user_id = 'XXXX'
|
227
|
+
client.check_following(user_id: user_id)
|
228
|
+
```
|
229
|
+
<br />
|
230
|
+
<br />
|
30
231
|
|
31
|
-
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
32
232
|
|
33
|
-
## Contributing
|
34
233
|
|
35
|
-
|
234
|
+
- ユーザをフォロー
|
36
235
|
|
236
|
+
```ruby
|
237
|
+
user_id = 'XXXX'
|
238
|
+
client.follow_user(user_id: user_id)
|
239
|
+
```
|
240
|
+
<br />
|
241
|
+
<br />
|
242
|
+
|
243
|
+
|
244
|
+
|
245
|
+
- 認証中のユーザの記事の一覧を作成日時の降順で返す
|
246
|
+
|
247
|
+
```ruby
|
248
|
+
res = client.fetch_my_items
|
249
|
+
```
|
250
|
+
<br />
|
251
|
+
<br />
|
252
|
+
|
253
|
+
|
254
|
+
|
255
|
+
- 記事の一覧を作成日時の降順で返す
|
256
|
+
|
257
|
+
```ruby
|
258
|
+
res = client.fetch_items
|
259
|
+
```
|
260
|
+
<br />
|
261
|
+
<br />
|
262
|
+
|
263
|
+
|
264
|
+
|
265
|
+
- 新たに記事を作成
|
266
|
+
|
267
|
+
title, bodyは必須
|
268
|
+
|
269
|
+
デフォルト値
|
270
|
+
tweet = false
|
271
|
+
tags = []
|
272
|
+
restricted = false
|
273
|
+
|
274
|
+
```ruby
|
275
|
+
title = 'title'
|
276
|
+
body = 'body'
|
277
|
+
tweet = true
|
278
|
+
tags = ['ruby', 'rails']
|
279
|
+
restricted = false
|
280
|
+
|
281
|
+
client.post_item(title: title, body: body, tweet: tweet, tags: tags, restricted: restricted)
|
282
|
+
```
|
283
|
+
<br />
|
284
|
+
<br />
|
285
|
+
|
286
|
+
|
287
|
+
- 記事を削除
|
288
|
+
|
289
|
+
```ruby
|
290
|
+
item_id = 'XXXX'
|
291
|
+
client.delete_item(item_id: item_id)
|
292
|
+
```
|
293
|
+
<br />
|
294
|
+
<br />
|
295
|
+
|
296
|
+
|
297
|
+
- 記事を取得
|
298
|
+
|
299
|
+
```ruby
|
300
|
+
item_id = 'XXXX'
|
301
|
+
res = client.fetch_item(item_id: item_id)
|
302
|
+
```
|
303
|
+
<br />
|
304
|
+
<br />
|
305
|
+
|
306
|
+
|
307
|
+
- 記事を更新
|
308
|
+
|
309
|
+
```ruby
|
310
|
+
item_id = 'XXXX'
|
311
|
+
title = 'update title'
|
312
|
+
body = 'update body'
|
313
|
+
restricted = false
|
314
|
+
tags = ['rails']
|
315
|
+
|
316
|
+
client.update_item(item_id: item_id, title: title, body: body, restricted: restricted, tags: tags)
|
317
|
+
```
|
318
|
+
<br />
|
319
|
+
<br />
|
320
|
+
|
321
|
+
|
322
|
+
- 記事をストック
|
323
|
+
|
324
|
+
```ruby
|
325
|
+
item_id = 'XXXX'
|
326
|
+
client.stock_item(item_id: item_id)
|
327
|
+
```
|
328
|
+
|
329
|
+
|
330
|
+
|
331
|
+
- 記事をストックから取り除く
|
332
|
+
|
333
|
+
```ruby
|
334
|
+
item_id = 'XXXX'
|
335
|
+
client.delete_stock(item_id: item_id)
|
336
|
+
```
|
337
|
+
<br />
|
338
|
+
<br />
|
339
|
+
|
340
|
+
|
341
|
+
- 記事をストックしているかどうか調べる
|
342
|
+
|
343
|
+
```ruby
|
344
|
+
item_id = 'XXXX'
|
345
|
+
client.check_item_stock(item_id: item_id)
|
346
|
+
```
|
347
|
+
<br />
|
348
|
+
<br />
|
349
|
+
|
350
|
+
|
351
|
+
- タグの記事一覧
|
352
|
+
|
353
|
+
```ruby
|
354
|
+
tag_id = 'XXXX'
|
355
|
+
res = client.fetch_tag_items(teg_id: tag_id)
|
356
|
+
```
|
357
|
+
<br />
|
358
|
+
<br />
|
359
|
+
|
360
|
+
|
361
|
+
- 指定されたユーザの記事一覧
|
362
|
+
|
363
|
+
```ruby
|
364
|
+
user_id = 'XXXX'
|
365
|
+
res = client.fetch_user_items(user_id: user_id)
|
366
|
+
```
|
367
|
+
<br />
|
368
|
+
<br />
|
369
|
+
|
370
|
+
|
371
|
+
- 指定されたユーザがストックした記事一覧
|
372
|
+
|
373
|
+
```ruby
|
374
|
+
user_id = 'XXXX'
|
375
|
+
res = client.fetch_user_stocks(user_id: user_id)
|
376
|
+
```
|
377
|
+
<br />
|
378
|
+
<br />
|
379
|
+
|
380
|
+
|
381
|
+
- コメントに絵文字リアクションを付ける
|
382
|
+
|
383
|
+
```ruby
|
384
|
+
comment_id = 'XXXX'
|
385
|
+
name = 'XXXX'
|
386
|
+
|
387
|
+
client.attach_reaction_to_comment(comment_id: comment_id, name: name)
|
388
|
+
```
|
389
|
+
<br />
|
390
|
+
<br />
|
391
|
+
|
392
|
+
|
393
|
+
- 記事に絵文字リアクションを付ける
|
394
|
+
|
395
|
+
```ruby
|
396
|
+
item_id = 'XXXX'
|
397
|
+
name = 'XXXX'
|
398
|
+
|
399
|
+
client.attach_reaction_to_item(item_id: item_id, name: name)
|
400
|
+
```
|
401
|
+
<br />
|
402
|
+
<br />
|
403
|
+
|
404
|
+
|
405
|
+
- コメントから絵文字リアクションを削除
|
406
|
+
|
407
|
+
```ruby
|
408
|
+
comment_id = 'XXXX'
|
409
|
+
reaction_name = 'XXXX'
|
410
|
+
|
411
|
+
client.delete_comment_reaction(comment_id: comment_id, reaction_name: reaction_name)
|
412
|
+
```
|
413
|
+
<br />
|
414
|
+
<br />
|
415
|
+
|
416
|
+
|
417
|
+
- 記事から絵文字リアクションを削除
|
418
|
+
|
419
|
+
```ruby
|
420
|
+
item_id = 'XXXX'
|
421
|
+
reaction_name = 'XXXX'
|
422
|
+
|
423
|
+
client.delete_item_reaction(item_id: item_id, reaction_name: reaction_name)
|
424
|
+
```
|
425
|
+
<br />
|
426
|
+
<br />
|
427
|
+
|
428
|
+
|
429
|
+
- コメントに付けられた絵文字リアクション一覧
|
430
|
+
|
431
|
+
```ruby
|
432
|
+
comment_id = 'XXXX'
|
433
|
+
|
434
|
+
client.fetch_comment_reactions(comment_id: comment_id)
|
435
|
+
```
|
436
|
+
<br />
|
437
|
+
<br />
|
438
|
+
|
439
|
+
|
440
|
+
- 記事に付けられた絵文字リアクション一覧
|
441
|
+
|
442
|
+
```ruby
|
443
|
+
item_id = 'XXXX'
|
444
|
+
|
445
|
+
client.fetch_item_reactions(item_id: item_id)
|
446
|
+
```
|
447
|
+
<br />
|
448
|
+
<br />
|
449
|
+
|
450
|
+
|
451
|
+
- アクセストークンに紐付いたユーザを返す
|
452
|
+
|
453
|
+
```ruby
|
454
|
+
client.fetch_authenticated_user
|
455
|
+
```
|
456
|
+
<br />
|
457
|
+
<br />
|
37
458
|
|
38
459
|
## License
|
39
460
|
|
data/lib/qiita/sdk/version.rb
CHANGED
data/qiita-sdk.gemspec
CHANGED
@@ -3,18 +3,18 @@ require_relative 'lib/qiita/sdk/version'
|
|
3
3
|
Gem::Specification.new do |spec|
|
4
4
|
spec.name = 'qiita-sdk'
|
5
5
|
spec.version = Qiita::Sdk::VERSION
|
6
|
-
spec.authors = ['
|
6
|
+
spec.authors = ['sibakeny']
|
7
7
|
spec.email = ['sbkn0919@gmail.com']
|
8
8
|
|
9
|
-
spec.summary = 'qiita sdk'
|
10
|
-
spec.description = 'qiita sdk'
|
11
|
-
spec.homepage = '
|
9
|
+
spec.summary = 'qiita sdk for ruby'
|
10
|
+
spec.description = 'qiita sdk for ruby'
|
11
|
+
spec.homepage = 'https://gitlab.com/sibakeny/qiita-sdk'
|
12
12
|
spec.license = 'MIT'
|
13
13
|
spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
|
14
14
|
|
15
15
|
spec.metadata['homepage_uri'] = spec.homepage
|
16
|
-
spec.metadata['source_code_uri'] = '
|
17
|
-
spec.metadata['changelog_uri'] = '
|
16
|
+
spec.metadata['source_code_uri'] = 'https://gitlab.com/sibakeny/qiita-sdk'
|
17
|
+
spec.metadata['changelog_uri'] = 'https://gitlab.com/sibakeny/qiita-sdk'
|
18
18
|
|
19
19
|
# Specify which files should be added to the gem when it is released.
|
20
20
|
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
metadata
CHANGED
@@ -1,16 +1,16 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: qiita-sdk
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.2.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
|
-
-
|
7
|
+
- sibakeny
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-08-
|
11
|
+
date: 2020-08-30 00:00:00.000000000 Z
|
12
12
|
dependencies: []
|
13
|
-
description: qiita sdk
|
13
|
+
description: qiita sdk for ruby
|
14
14
|
email:
|
15
15
|
- sbkn0919@gmail.com
|
16
16
|
executables: []
|
@@ -35,13 +35,13 @@ files:
|
|
35
35
|
- lib/qiita/sdk/httpclient.rb
|
36
36
|
- lib/qiita/sdk/version.rb
|
37
37
|
- qiita-sdk.gemspec
|
38
|
-
homepage:
|
38
|
+
homepage: https://gitlab.com/sibakeny/qiita-sdk
|
39
39
|
licenses:
|
40
40
|
- MIT
|
41
41
|
metadata:
|
42
|
-
homepage_uri:
|
43
|
-
source_code_uri:
|
44
|
-
changelog_uri:
|
42
|
+
homepage_uri: https://gitlab.com/sibakeny/qiita-sdk
|
43
|
+
source_code_uri: https://gitlab.com/sibakeny/qiita-sdk
|
44
|
+
changelog_uri: https://gitlab.com/sibakeny/qiita-sdk
|
45
45
|
post_install_message:
|
46
46
|
rdoc_options: []
|
47
47
|
require_paths:
|
@@ -60,5 +60,5 @@ requirements: []
|
|
60
60
|
rubygems_version: 3.0.3
|
61
61
|
signing_key:
|
62
62
|
specification_version: 4
|
63
|
-
summary: qiita sdk
|
63
|
+
summary: qiita sdk for ruby
|
64
64
|
test_files: []
|