Click me

\n\n```json\n{\n \"total_count\": 31,\n \"incomplete_results\": false,\n \"items\": [\n {\n \"url\": \"https://api.github.com/repos/mziyut/honkit-plugin-prism/issues/7\",\n \"repository_url\": \"https://api.github.com/repos/mziyut/honkit-plugin-prism\",\n \"labels_url\": \"https://api.github.com/repos/mziyut/honkit-plugin-prism/issues/7/labels{/name}\",\n \"comments_url\": \"https://api.github.com/repos/mziyut/honkit-plugin-prism/issues/7/comments\",\n \"events_url\": \"https://api.github.com/repos/mziyut/honkit-plugin-prism/issues/7/events\",\n \"html_url\": \"https://github.com/mziyut/honkit-plugin-prism/pull/7\",\n \"id\": 1410719907,\n \"node_id\": \"PR_kwDOIJ_6M85A4onc\",\n \"number\": 7,\n \"title\": \"Bump @types/node from 18.8.3 to 18.11.0\",\n \"user\": {\n \"login\": \"dependabot[bot]\",\n \"id\": 49699333,\n \"node_id\": \"MDM6Qm90NDk2OTkzMzM=\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/in/29110?v=4\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/dependabot%5Bbot%5D\",\n \"html_url\": \"https://github.com/apps/dependabot\",\n \"followers_url\": \"https://api.github.com/users/dependabot%5Bbot%5D/followers\",\n \"following_url\": \"https://api.github.com/users/dependabot%5Bbot%5D/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/dependabot%5Bbot%5D/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/dependabot%5Bbot%5D/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/dependabot%5Bbot%5D/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/dependabot%5Bbot%5D/orgs\",\n \"repos_url\": \"https://api.github.com/users/dependabot%5Bbot%5D/repos\",\n \"events_url\": \"https://api.github.com/users/dependabot%5Bbot%5D/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/dependabot%5Bbot%5D/received_events\",\n \"type\": \"Bot\",\n \"site_admin\": false\n },\n \"labels\": [\n {\n \"id\": 4678247549,\n \"node_id\": \"LA_kwDOIJ_6M88AAAABFthkfQ\",\n \"url\": \"https://api.github.com/repos/mziyut/honkit-plugin-prism/labels/dependencies\",\n \"name\": \"dependencies\",\n \"color\": \"0366d6\",\n \"default\": false,\n \"description\": \"Pull requests that update a dependency file\"\n },\n {\n \"id\": 4678247557,\n \"node_id\": \"LA_kwDOIJ_6M88AAAABFthkhQ\",\n \"url\": \"https://api.github.com/repos/mziyut/honkit-plugin-prism/labels/javascript\",\n \"name\": \"javascript\",\n \"color\": \"168700\",\n \"default\": false,\n \"description\": \"Pull requests that update Javascript code\"\n }\n ],\n \"state\": \"open\",\n \"locked\": false,\n \"assignee\": null,\n \"assignees\": [],\n \"milestone\": null,\n \"comments\": 0,\n \"created_at\": \"2022-10-17T01:17:11Z\",\n \"updated_at\": \"2022-10-17T01:17:13Z\",\n \"closed_at\": null,\n \"author_association\": \"NONE\",\n \"active_lock_reason\": null,\n \"draft\": false,\n \"pull_request\": {\n \"url\": \"https://api.github.com/repos/mziyut/honkit-plugin-prism/pulls/7\",\n \"html_url\": \"https://github.com/mziyut/honkit-plugin-prism/pull/7\",\n \"diff_url\": \"https://github.com/mziyut/honkit-plugin-prism/pull/7.diff\",\n \"patch_url\": \"https://github.com/mziyut/honkit-plugin-prism/pull/7.patch\",\n \"merged_at\": null\n },\n \"body\": \"Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 18.8.3 to 18.11.0.\\n

\\n

Commits

\\n

See full diff in compare view

\\n

\\n
\\n\\n\\n[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=@types/node&package-manager=npm_and_yarn&previous-version=18.8.3&new-version=18.11.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)\\n\\nDependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.\\n\\n[//]: # (dependabot-automerge-start)\\n[//]: # (dependabot-automerge-end)\\n\\n---\\n\\n

\\n

Dependabot commands and options

\\n
\\n\\nYou can trigger Dependabot actions by commenting on this PR:\\n- `@dependabot rebase` will rebase this PR\\n- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it\\n- `@dependabot merge` will merge this PR after your CI passes on it\\n- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it\\n- `@dependabot cancel merge` will cancel a previously requested merge and block automerging\\n- `@dependabot reopen` will reopen this PR if it is closed\\n- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually\\n- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)\\n- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)\\n- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)\\n\\n\\n

\",\n \"reactions\": {\n \"url\": \"https://api.github.com/repos/mziyut/honkit-plugin-prism/issues/7/reactions\",\n \"total_count\": 0,\n \"+1\": 0,\n \"-1\": 0,\n \"laugh\": 0,\n \"hooray\": 0,\n \"confused\": 0,\n \"heart\": 0,\n \"rocket\": 0,\n \"eyes\": 0\n },\n \"timeline_url\": \"https://api.github.com/repos/mziyut/honkit-plugin-prism/issues/7/timeline\",\n \"performed_via_github_app\": null,\n \"state_reason\": null,\n \"score\": 1.0\n }\n ]\n}\n```\n\n

\n\n今回、 Issue/Pull request の検索に必要な API が定義され、返却される項目が理解できたら次のステップに進みましょう\n\n### Gem `octkit` を確認する\n\n`ruboty-qiita-github` では `octokit/octokit.rb` を利用し GitHub API 経由でデータを取得・操作しています\n\nhttps://github.com/octokit/octokit.rb\n\n```ruby:lib/octokit/client/search.rb#L37-L49\n # Search issues\n #\n # @param query [String] Search term and qualifiers\n # @param options [Hash] Sort and pagination options\n # @option options [String] :sort Sort field\n # @option options [String] :order Sort order (asc or desc)\n # @option options [Integer] :page Page of paginated results\n # @option options [Integer] :per_page Number of items per page\n # @return [Sawyer::Resource] Search results object\n # @see https://developer.github.com/v3/search/#search-issues-and-pull-requests\n def search_issues(query, options = {})\n search 'search/issues', query, options\n end\n```\n\nhttps://github.com/octokit/octokit.rb/blob/e915332a3ab7aa2de3442b0a7fedd6b6ecb3b928/lib/octokit/client/search.rb#L37-L49\n\n先ほど GitHub REST API で確認した endpoint を叩けることが確認できました。\n\n### `ruboty-qiita-github` に command を追加する\n\n必要な GitHub API が確認できたら `ruboty-qiita-github` に command を定義します\ncommand を定義するために以下ファイルを変更、作成しましょう\n\n- 新規作成\n - `lib/ruboty/github/actions/search_issues.rb`\n- 変更\n - `lib/ruboty/handlers/github.rb`\n - `lib/ruboty/github.rb`\n\n実際のコードを例に役割など説明していきます\n\n#### `lib/ruboty/github/actions/search_issues.rb`\n\nまず先に、 `search issues` の処理を定義しましょう\n`lib/ruboty/github/actions/search_issues.rb` を新規作成します\n\n処理の流れとしては...\n\n- GitHub Token が登録されているか確認\n - 登録されていない場合、エラーを返却\n- octkit (code 上は client) 経由で search_issues API からデータを取得する\n- 結果を整形して、返却する\n\n```ruby:lib/ruboty/github/actions/search_issues.rb\n# frozen_string_literal: true\n\nmodule Ruboty\n module Github\n module Actions\n class SearchIssues < Base\n def call\n if has_access_token?\n search\n else\n require_access_token\n end\n end\n\n private\n\n def search\n results = search_issues.items.each_with_object([\"Searched: '#{query}'\"]) do |item, object|\n repository_url = item[:repository_url].delete_prefix('https://api.github.com/repos/')\n\n object << \"[#{repository_url}##{item[:number]}] #{item[:title]} (#{item[:user][:login]})\\n#{item[:html_url]}\"\n end\n\n message.reply(results.join(\"\\n\"))\n rescue Octokit::Unauthorized\n message.reply('Failed in authentication (401)')\n rescue Octokit::NotFound\n message.reply('Could not find that repository')\n rescue StandardError => e\n message.reply(\"Failed by #{e.class}\")\n end\n\n def query\n message[:query]\n end\n\n def search_issues\n client.search_issues(query)\n end\n end\n end\n end\nend\n```\n\nhttps://github.com/increments/ruboty-qiita-github/blob/7df067035fd2f735359980b1265e613029334feb/lib/ruboty/github/actions/search_issues.rb#L1-L43\n\n処理が定義できたら次のステップに進みましょう\n\n#### `lib/ruboty/github.rb`\n\n先ほど作成した `lib/ruboty/github/actions/search_issues.rb` を require します\n\n```:lib/ruboty/github.rb\nrequire 'ruboty/github/actions/search_issues'\n```\n\nhttps://github.com/increments/ruboty-qiita-github/blob/7df067035fd2f735359980b1265e613029334feb/lib/ruboty/github.rb#L14\n\n#### `lib/ruboty/handlers/github.rb`\n\n`lib/ruboty/handlers/github.rb` は Ruboty が受け取ったコマンドを定義された process に dispatch する役割を担っています\n今回追加した処理は以下 2 つです\n\n```ruby:lib/ruboty/handlers/github.rb#L14-L18\n on(\n /search issues \"(?.+)\"/, # 追加する command の条件を記載\n name: \"search_issues\", # dispatch する method 名を記載\n description: \"Search an issue\", # command の説明を記載\n )\n```\n\n```ruby:lib/ruboty/handlers/github.rb#L54-L56\n def search_issues(message)\n Ruboty::Github::Actions::SearchIssues.new(message).call\n end\n```\n\nここまでで、 Ruboty に対して `search issues \"user:foo\"` 等と送信すると指定した処理が実行されるようになります\n\n#### その他\n\n必要に応じて今回追加した command に対するテストも書きましょう :muscle:\n\n##### `spec/ruboty/handlers/github_spec.rb`\n\nhttps://github.com/increments/ruboty-qiita-github/blob/a3fb3554d9e7bcf5b4e8cfdb7070ae7f92120f88/spec/ruboty/handlers/github_spec.rb#L92-L124\n\n## 最後に\n\n今回は Ruboty の plugin である `ruboty-qiita-github` に簡単な command を追加してみました\nコマンドを追加するだけであれば簡単なので Ruboty の plugin の開発に try してみてはいかがでしょうか\n\n## Reference\n\nhttps://github.com/increments/ruboty-qiita-github/pull/7\n\nhttps://github.com/increments/ruboty-qiita-github\n","attributes",{"_256":257,"_258":259,"_5":260,"_261":262},"title","Ruboty に GitHub の issue/pull request を検索する command を追加する","date","2023-06-16T14:35:50+09:00",[112,47,111,48,59],"published",true,"tag","actionData","errors"]

Tag: GitHubAPI

Ruboty に GitHub の issue/pull request を検索する command を追加する