qiita-sdk 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b720e463407c691d1fc4316968eb83bfb10ad842e74fd6cec3f2d1a3a2ec0c6d
-  data.tar.gz: effae48c571e4cdc3b112f03b1362effd7d8f535c3c8222626acaa08f382bd29
+  metadata.gz: 60c438348bcb63b2bd686be1d640435c69ee0f3603f9bb4d318f5ca2905f232a
+  data.tar.gz: 2144b561f252663cebfbdf02d852f8d76df07295054168da63f8cc64a53c78d1
 SHA512:
-  metadata.gz: 5f775f6ee09dc34cd50c377e7948958f4334647091a97a79928e8eeec1cc0004e38ce5bee07e33da6c7ba14801932c31414b9502f9ec828d6cdc1d3f8ffc1a55
-  data.tar.gz: 17241491a0797797e44cdb4520d048999ed147bfdc18dc609a73055729cc4ecd2bb818119b2b4f9ed65b6ba0b53859fc1825931423bf67676d0ed2a25875f013
+  metadata.gz: 9eb7e4f0f6ba5ce52ff942cd7b00023aa1cabf3d5d2f3d8cb1a66e6408d2181467343af48321ecfceb421bef02acfe3964a58b17f6894c8b2dc424267eddb435
+  data.tar.gz: 50671e6487f16abab46ad15cff2dcfd465a2d00099b8cfe5cca0541d307f0ff38fa1e8a1f6931997b765a723a4fd6d60d31b699447f2036f14be6d9f3180fc98

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,443 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### インスタンスの作成
+
+```ruby
+  client = Qiita::Sdk::Client.new
+```
+
+認証が必要なアクションを行う場合
+
+```ruby
+  client = Qiita::Sdk::Client.new do |config|
+    config.access_token = 'XXXX'
+  end
+```
+
+### メソッド一覧
+
+- 記事につけられた「LGTM！」一覧を取得
+
+```ruby
+  item_id = 'XXXX'
+  res = client.fetch_item_likes(item_id: item_id)
+```
+<br />
+<br />
+
+
+- コメントを削除
+
+```ruby
+  comment_id = 'XXXX'
+  res = 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'
+  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'
+  client.fetch_tag(tag_id: tag_id)
+```
+<br />
+<br />
+
+
+
+- ユーザがフォローしているタグ一覧
+
+```ruby
+  user_id = 'XXXX'
+  client.fetch_following_tags(user_id: user_id)
+```
+<br />
+<br />
+
+
 
-## Development
+- タグのフォローを外す
 
-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.
+```ruby
+  tag_id = 'XXXX'
+  cient.delete_tag_following(tag_id: tag_id)
+```
+<br />
+<br />
+
+
+
+- タグをフォローしているかどうかを調る
+
+```ruby
+  tag_id = 'XXXX'
+  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'
+  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 />
+
+
+
+- ユーザをフォローしている場合に204を返す
+
+```ruby
+  user_id = 'XXXX'
+  client.check_following(user_id: user_id)
+```
+<br />
+<br />
 
-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).
 
-## 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
+  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)
+```
+
+
+
+- 記事をストックから取り除く
+
+```ruby
+  item_id = 'XXXX'
+  client.delete_stock(item_id: item_id)
+```
+<br />
+<br />
+
+
+- 記事をストックしているかどうか調べる
+
+```ruby
+  item_id = 'XXXX'
+  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 />
+
+
+- コメントに付けられた絵文字リアクション一覧
+
+```ruby
+  comment_id = 'XXXX'
+
+  client.fetch_comment_reactions(comment_id: comment_id)
+```
+<br />
+<br />
+
+
+- 記事に付けられた絵文字リアクション一覧
+
+```ruby
+  item_id = 'XXXX'
+
+  client.fetch_item_reactions(item_id: item_id)
+```
+<br />
+<br />
+
+
+- アクセストークンに紐付いたユーザを返す
+
+```ruby
+  client.fetch_authenticated_user
+```
+<br />
+<br />
 
 ## License
 

data/lib/qiita/sdk/version.rb

@@ -1,5 +1,5 @@
 module Qiita
   module Sdk
-    VERSION = '0.1.1'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

data/qiita-sdk.gemspec

@@ -3,18 +3,18 @@ require_relative 'lib/qiita/sdk/version'
 Gem::Specification.new do |spec|
   spec.name          = 'qiita-sdk'
   spec.version       = Qiita::Sdk::VERSION
-  spec.authors       = ['yonetani']
+  spec.authors       = ['sibakeny']
   spec.email         = ['sbkn0919@gmail.com']
 
-  spec.summary       = 'qiita sdk'
-  spec.description   = 'qiita sdk'
-  spec.homepage      = 'http://example.com/'
+  spec.summary       = 'qiita sdk for ruby'
+  spec.description   = 'qiita sdk for ruby'
+  spec.homepage      = 'https://gitlab.com/sibakeny/qiita-sdk'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'http://example.com/'
-  spec.metadata['changelog_uri'] = 'http://example.com/'
+  spec.metadata['source_code_uri'] = 'https://gitlab.com/sibakeny/qiita-sdk'
+  spec.metadata['changelog_uri'] = 'https://gitlab.com/sibakeny/qiita-sdk'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: qiita-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
-- yonetani
+- sibakeny
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-29 00:00:00.000000000 Z
+date: 2020-08-30 00:00:00.000000000 Z
 dependencies: []
-description: qiita sdk
+description: qiita sdk for ruby
 email:
 - sbkn0919@gmail.com
 executables: []
@@ -35,13 +35,13 @@ files:
 - lib/qiita/sdk/httpclient.rb
 - lib/qiita/sdk/version.rb
 - qiita-sdk.gemspec
-homepage: http://example.com/
+homepage: https://gitlab.com/sibakeny/qiita-sdk
 licenses:
 - MIT
 metadata:
-  homepage_uri: http://example.com/
-  source_code_uri: http://example.com/
-  changelog_uri: http://example.com/
+  homepage_uri: https://gitlab.com/sibakeny/qiita-sdk
+  source_code_uri: https://gitlab.com/sibakeny/qiita-sdk
+  changelog_uri: https://gitlab.com/sibakeny/qiita-sdk
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -60,5 +60,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: qiita sdk
+summary: qiita sdk for ruby
 test_files: []