qiita-sdk 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef3399319b6663a45463b626c00587b01e17a82d6dcc659cda6e20ab88b09a86
-  data.tar.gz: 102404f6146bdc3e1da5d34aa9888d8a6f1be4eec348c63a56528d0ecb74ec6c
+  metadata.gz: 780338808d3cf7b8d12073b34dcf52eb5636db8fca64ab564a38b7ec6eb3ebce
+  data.tar.gz: 8171b3502aed7e42ee1201bfcffe9be28325ac8fc64c04f3cae711c1a201037d
 SHA512:
-  metadata.gz: 637a211f86a0afa7148f5c9411dd088c6bfd425c9495a66310f683959bf1870ee2c8a4cb5d8b07967a1ba982d990210f1ac5430700b3839b259c1dd06acd33f6
-  data.tar.gz: b4cccf3edaa50a4e6794d027776ff963da8d63a4e45c7f54e44f10f8e98f6489bd1f1e4a341c486e141bbb90019b81d461d65737b2a52a444f4db7079f92021a
+  metadata.gz: cc2238a489e205915fa38a2953e4e39db89d295a06fcb3b0404215c173ef79692dfa15504b597c227071d185bfaccab1486cc8b3ffc69ded1c50707018829748
+  data.tar.gz: b4d114f19fb603199f1994ae24e50fb89cb14bf37cda71ee37022afeb1558b518c1b772381ecad569ab711134fc9ded6aacfc88529586cdf6ce4a214ded05dbe

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Style/AsciiComments:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false

data/Gemfile

@@ -1,7 +1,10 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in qiita-sdk.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop'
+gem 'webmock'
+gem 'pry-byebug'

data/Gemfile.lock

@@ -1,13 +1,35 @@
 PATH
   remote: .
   specs:
-    qiita-sdk (0.1.0)
+    qiita-sdk (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
     diff-lcs (1.4.4)
+    hashdiff (1.0.1)
+    method_source (1.0.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.5)
+    rainbow (3.0.0)
     rake (12.3.3)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -21,14 +43,35 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
+    rubocop (0.89.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    unicode-display_width (1.7.0)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  pry-byebug
   qiita-sdk!
   rake (~> 12.0)
   rspec (~> 3.0)
+  rubocop
+  webmock
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,13 +1,9 @@
 # Qiita::Sdk
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/qiita/sdk`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+[Qiita Api](https://qiita.com/api/v2/docs) の Api クライアント
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
 ```ruby
 gem 'qiita-sdk'
 ```
@@ -22,18 +18,451 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### インスタンスの作成
+
+```ruby
+  client = Qiita::Sdk::Client.new
+```
+<br />
+<br />
+
+認証が必要なアクションを行う場合
+
+```ruby
+  client = Qiita::Sdk::Client.new do |config|
+    config.access_token = 'XXXX'
+  end
+```
+<br />
+<br />
+
+### メソッド一覧
+
+全て戻り値は [Net::HTTPResponse] を返す
+
+
+- 記事につけられた「LGTM！」一覧を取得
+
+```ruby
+  item_id = 'XXXX'
+  res = client.fetch_item_likes(item_id: item_id)
+```
+<br />
+<br />
+
+
+- コメントを削除
+
+```ruby
+  comment_id = 'XXXX'
+  client.delete_comment(comment_id: comment_id)
+```
+<br />
+<br />
+
+
+
+- コメントを取得
+
+```ruby
+  comment_id = 'XXXX'
+  res = client.fetch_comment(comment_id: comment_id)
+```
+<br />
+<br />
+
+
+- コメントを更新
+
+```ruby
+  comment_id = 'XXXX'
+  body = 'update body'
+  client.update_comment(comment_id: comment_id, body: body)
+```
+<br />
+<br />
+
+
+
+- 投稿に紐づけられた投稿一覧
+
+```ruby
+  item_id = 'XXXX'
+  res = client.fetch_item_comments(item_id: item_id)
+```
+<br />
+<br />
+
+
+
+- 記事に対してコメントを投稿
+
+```ruby
+  item_id = 'XXXX'
+  body = 'comment body'
+  client.post_comment(item_id: item_id, body: body)
+```
+<br />
+<br />
+
+
+
+- タグを取得
+
+```ruby
+  tag_id = 'XXXX'
+  res = client.fetch_tag(tag_id: tag_id)
+```
+<br />
+<br />
+
+
+
+- ユーザがフォローしているタグ一覧
+
+```ruby
+  user_id = 'XXXX'
+  res = client.fetch_following_tags(user_id: user_id)
+```
+<br />
+<br />
+
+
+
+- タグのフォローを外す
+
+```ruby
+  tag_id = 'XXXX'
+  client.delete_tag_following(tag_id: tag_id)
+```
+<br />
+<br />
+
+
+
+- タグをフォローしているかどうかを調る
+
+```ruby
+  tag_id = 'XXXX'
+  res = client.check_tag_following(tag_id: tag_id)
+```
+<br />
+<br />
+
+
+
+- タグをフォロー
+
+```ruby
+  tag_id = 'XXXX'
+  client.follow_tag(tag_id: tag_id)
+```
+<br />
+<br />
+
+
+
+- 記事をストックしているユーザ一覧を、ストックした日時の降順で返す
+
+```ruby
+  item_id = 'XXXX'
+  res = client.fetch_item_stockers(item_id: item_id)
+```
+<br />
+<br />
+
+
+
+- 全てのユーザの一覧を作成日時の降順で取得
+
+```ruby
+  res = client.fetch_users
+```
+<br />
+<br />
+
+
+
+- ユーザを取得
+
+```ruby
+  user_id = 'XXXX'
+  res = client.fetch_user(user_id: user_id)
+```
+<br />
+<br />
+
+
+
+- ユーザがフォローしているユーザ一覧を取得
+
+```ruby
+  user_id = 'XXXX'
+  res = client.fetch_followees(user_id: user_id)
+```
+<br />
+<br />
+
+
+
+- ユーザをフォローしているユーザ一覧を取得
+
+```ruby
+  user_id = 'XXXX'
+  res = client.fetch_followers(user_id: user_id)
+```
+<br />
+<br />
+
+
+
+- ユーザへのフォローを外します。
+
+```ruby
+  user_id = 'XXXX'
+  client.delete_following(user_id: user_id)
+```
+<br />
+<br />
+
+
 
-## Development
+- ユーザをフォローしている場合に204を返す
+
+```ruby
+  user_id = 'XXXX'
+  res = client.check_following(user_id: user_id)
+```
+<br />
+<br />
+
+
+
+- ユーザをフォロー
+
+```ruby
+  user_id = 'XXXX'
+  client.follow_user(user_id: user_id)
+```
+<br />
+<br />
+
+
+
+- 認証中のユーザの記事の一覧を作成日時の降順で返す
+
+```ruby
+  res = client.fetch_my_items
+```
+<br />
+<br />
+
+
+
+- 記事の一覧を作成日時の降順で返す
+
+```ruby
+  res = client.fetch_items
+```
+<br />
+<br />
+
+
+
+- 新たに記事を作成
+
+title, bodyは必須
+
+デフォルト値
+tweet = false
+tags = []
+restricted = false
+
+```ruby
+  title = 'title'
+  body = 'body'
+  tweet = true
+  tags = ['ruby', 'rails']
+  restricted = false
+
+  client.post_item(title: title, body: body, tweet: tweet, tags: tags, restricted: restricted)
+```
+<br />
+<br />
+
+
+- 記事を削除
+
+```ruby
+  item_id = 'XXXX'
+  client.delete_item(item_id: item_id)
+```
+<br />
+<br />
+
+
+- 記事を取得
+
+```ruby
+  item_id = 'XXXX'
+  res = client.fetch_item(item_id: item_id)
+```
+<br />
+<br />
+
+
+- 記事を更新
+
+```ruby
+  item_id = 'XXXX'
+  title = 'update title'
+  body = 'update body'
+  restricted = false
+  tags = ['rails']
+
+  client.update_item(item_id: item_id, title: title, body: body, restricted: restricted, tags: tags)
+```
+<br />
+<br />
+
+
+- 記事をストック
+
+```ruby
+  item_id = 'XXXX'
+  client.stock_item(item_id: item_id)
+```
+<br />
+<br />
+
+
+- 記事をストックから取り除く
+
+```ruby
+  item_id = 'XXXX'
+  client.delete_stock(item_id: item_id)
+```
+<br />
+<br />
 
-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.
 
-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).
+- 記事をストックしているかどうか調べる
+
+```ruby
+  item_id = 'XXXX'
+  res = client.check_item_stock(item_id: item_id)
+```
+<br />
+<br />
+
+
+- タグの記事一覧
+
+```ruby
+  tag_id = 'XXXX'
+  res = client.fetch_tag_items(teg_id: tag_id)
+```
+<br />
+<br />
+
+
+- 指定されたユーザの記事一覧
+
+```ruby
+  user_id = 'XXXX'
+  res = client.fetch_user_items(user_id: user_id)
+```
+<br />
+<br />
+
+
+- 指定されたユーザがストックした記事一覧
+
+```ruby
+  user_id = 'XXXX'
+  res = client.fetch_user_stocks(user_id: user_id)
+```
+<br />
+<br />
+
+
+- コメントに絵文字リアクションを付ける
+
+```ruby
+  comment_id = 'XXXX'
+  name = 'XXXX'
+
+  client.attach_reaction_to_comment(comment_id: comment_id, name: name)
+```
+<br />
+<br />
+
+
+- 記事に絵文字リアクションを付ける
+
+```ruby
+  item_id = 'XXXX'
+  name = 'XXXX'
+
+  client.attach_reaction_to_item(item_id: item_id, name: name)
+```
+<br />
+<br />
+
+
+- コメントから絵文字リアクションを削除
+
+```ruby
+  comment_id = 'XXXX'
+  reaction_name = 'XXXX'
+
+  client.delete_comment_reaction(comment_id: comment_id, reaction_name: reaction_name)
+```
+<br />
+<br />
+
+
+- 記事から絵文字リアクションを削除
+
+```ruby
+  item_id = 'XXXX'
+  reaction_name = 'XXXX'
+
+  client.delete_item_reaction(item_id: item_id, reaction_name: reaction_name)
+```
+<br />
+<br />
 
-## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/qiita-sdk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/qiita-sdk/blob/master/CODE_OF_CONDUCT.md).
+- コメントに付けられた絵文字リアクション一覧
 
+```ruby
+  comment_id = 'XXXX'
+
+  res = client.fetch_comment_reactions(comment_id: comment_id)
+```
+<br />
+<br />
+
+
+- 記事に付けられた絵文字リアクション一覧
+
+```ruby
+  item_id = 'XXXX'
+
+  res = client.fetch_item_reactions(item_id: item_id)
+```
+<br />
+<br />
+
+
+- アクセストークンに紐付いたユーザを返す
+
+```ruby
+  res = client.fetch_authenticated_user
+```
+<br />
+<br />
 
 ## License