resquirrel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d1b67d88a6d2613d99f17da16dbd88b207d4f8d73f53ac89ebc4e4baa9d97ece
+  data.tar.gz: 01c194ab3ac13bd585480877360bcdf595d3bc8694a2d6d1e81806df53800ada
+SHA512:
+  metadata.gz: 3b73fe4ea5c9adf48c4db5b0a8f0c8a13f08859f454bb302bfdb69fece539799adab9e7175748110385ed026bc5f69fbb40ae898f3429fb8c265592349cc300b
+  data.tar.gz: f26a0c8c04e737cc5bc1ecd37ad870984f1859166b7de1232fa7e03b6cb5af8471fbfea839091cc1db7bb8d89736fe44252cc41123b27fd94053260b590a09bd

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/AbcSize:
+  Max: 20
+
+Style/Documentation:
+  Enabled: false
+
+Layout/TrailingWhitespace:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-04-23
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at y.horikoshi.pg@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 yuki-snow1823
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,169 @@
+# Resquirrel
+
+RubyGems that automatically create release notes for Notion DB using Open AI API.
+
+<img width="480" src="https://github.com/yuki-snow1823/resquirrel/assets/59280290/48ab260d-242b-421d-b7ce-88ba611f0d19">
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```Gemfile
+gem 'fabrique'
+```
+
+And then execute:
+
+```console
+$ bundle install
+```
+
+Or install it yourself as:
+
+```console
+$ gem install resquirrel
+```
+
+## Usage（日本語）
+
+### NotionのAPIキーの用意
+1. まずは、NotionのAPIを使えるようにするためのトークンを取得します。
+2. [Notionの開発者ページ](https://www.notion.so/my-integrations)にアクセスします。
+3.  `New integration`をクリックして、作成したトークンをリリースノートを作成したいリポジトリのrepository secretsに登録します。`NOTION_API_KEY`という名前で登録してください。
+
+### Notionのデータベースの用意
+1. Notionにリリースノートを作成するためのFull Pageのデータベースを作成します。
+2. データベースには、以下のプロパティを用意します。
+    - `changes` : リリースノートのタイトル（DBを作成するとデフォルトで用意されています。）
+    - `URL` : リリースノートのリンク
+3. 作成したDBのURLをコピーして、https://www.notion.so/[この部分]?v=hogehoge の文字列を、リリースノートを作成したいリポジトリのrepository secretsに登録します。`NOTION_DATABASE_ID`という名前で登録してください。
+
+### Open AI APIの用意
+1. Open AI APIを使えるようにするためのAPIキーを取得します。
+2. [Open AIの開発者ページ](https://platform.openai.com/account/api-keys)にアクセスします。
+3. `Create API Key`をクリックして、作成したAPIキーをリリースノートを作成したいリポジトリのrepository secretsに登録します。`OPENAI_API_KEY`という名前で登録してください。
+   - 制限に関しては、ModelsのRead、Model CapabilitiesのWriteが必要です。
+
+### 実行方法
+sample: 
+`.github/workflows/create_release_notes.yml` のようなCIで実行するファイルを作成します。
+
+```yml
+name: create release notes
+
+on:
+  pull_request:
+    types:
+      - closed
+
+jobs:
+  create_release_notes:
+    if: ${{ github.event.pull_request.merged }}
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.3'
+
+    - name: Install dependencies
+      run: |
+        bundle install
+
+    - name: Run script
+      run: ruby lib/resquirrel.rb
+      env:
+        GITHUB_EVENT_PATH: ${{ github.event_path }}
+        OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+        NOTION_API_KEY: ${{ secrets.NOTION_API_KEY }}
+        NOTION_DATABASE_ID: ${{ secrets.NOTION_DATABASE_ID }}
+```
+
+```rb
+resquirrel = Resquirrel.new
+resquirrel.generate_release_note
+```
+それぞれのenvは必須です。
+
+## Usage(English)
+
+### Preparing Notion's API key
+1. first, you will need to obtain a token to be able to use Notion's API. 2.
+2. go to [Notion's developer page](https://www.notion.so/my-integrations).
+3. click `New integration` and register the token you have created in the repository secrets of the repository for which you want to create release notes. The name shold be set `NOTION_API_KEY`.
+
+### Preparing Notion's database
+1. Create a Full Page database in Notion to create release notes.
+2. Prepare the following properties in the database.
+    - `changes` : Title of the release note (this is provided by default when you create a DB.)
+    - `URL` : Link to the release note
+3. Copy the URL of the created DB and register the string `https://www.notion.so/[this part]?v=hogehoge` in the repository secrets of the repository where you want to create the release notes. The name should be set to `NOTION_DATABASE_ID`.
+
+### Preparing Open AI API
+1. Obtain an API key to use the Open AI API.
+2. Go to the [Open AI developer page](https://platform.openai.com/account/api-keys).
+3. Click `Create API Key` and register the created API key in the repository secrets of the repository where you want to create the release notes. The name should be set to `OPENAI_API_KEY`.
+   - The required permissions are Models Read and Model Capabilities Write.
+
+### How to run
+sample:
+Create a file to run the script in CI, such as `.github/workflows/create_release_notes.yml`.
+
+
+```yml
+name: create release notes
+
+on:
+  pull_request:
+    types:
+      - closed
+
+jobs:
+  create_release_notes:
+    if: ${{ github.event.pull_request.merged }}
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.3'
+
+    - name: Install dependencies
+      run: |
+        bundle install
+
+    - name: Run script
+      run: ruby lib/resquirrel.rb
+      env:
+        GITHUB_EVENT_PATH: ${{ github.event_path }}
+        OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+        NOTION_API_KEY: ${{ secrets.NOTION_API_KEY }}
+        NOTION_DATABASE_ID: ${{ secrets.NOTION_DATABASE_ID }}
+```
+
+```rb
+resquirrel = Resquirrel.new
+resquirrel.generate_release_note
+```
+Each env is required.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yuki-snow1823/resquirrel 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/yuki-snow1823/resquirrel/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Resquirrel project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yuki-snow1823/resquirrel/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/resquirrel/client/notion.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+
+class NotionClient
+  def initialize(api_key, database_id)
+    @api_key = api_key
+    @database_id = database_id
+  end
+
+  def create_release_note(summary, url)
+    uri = URI("https://api.notion.com/v1/pages")
+    request = Net::HTTP::Post.new(uri)
+    request["Authorization"] = "Bearer #{@api_key}"
+    request["Notion-Version"] = "2022-06-28"
+    request.content_type = "application/json"
+    request.body = {
+      parent: { type: "database_id", database_id: @database_id },
+      properties: {
+        title: {
+          title: [
+            {
+              type: "text",
+              text: {
+                content: summary
+              }
+            }
+          ]
+        },
+        URL: {
+          url: url
+        }
+      }
+    }.to_json
+
+    Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+      http.request(request)
+    end
+  end
+end

data/lib/resquirrel/client/openai.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+
+class OpenAiClient
+  BASE_URL = "https://api.openai.com/v1"
+
+  def initialize(api_key, model: "gpt-3.5-turbo")
+    @api_key = api_key
+    @model = model
+  end
+
+  def summary_pr(title, body, max_tokens: 200)
+    uri = URI("#{BASE_URL}/chat/completions")
+    request = Net::HTTP::Post.new(uri)
+    request["Authorization"] = "Bearer #{@api_key}"
+    request.content_type = "application/json"
+    request.body = {
+      model: @model,
+      messages: [{ "role": "user",
+                   "content":
+                   "これからGitHub PRのタイトルと内容を送ります。
+                   この内容を、プログラミングやウェブ技術にそれほど詳しくない人のために要約してください。
+                   日本語で必ず返答してください。
+                   要約の文章はタイトル：本文：のようにせず、文章だけでお願いします。
+                   タイトルと本文を踏まえて、どのような変更があったのか文章にわかりやすくまとめてください。
+                   以下がPRの内容です。
+                   タイトル： #{title}
+                   本文： #{body}" }],
+      max_tokens: max_tokens
+    }.to_json
+
+    response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+      http.request(request)
+    end
+
+    JSON.parse(response.body)
+  end
+end

data/lib/resquirrel/main.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "logger"
+require "json"
+require_relative "client/notion"
+require_relative "client/openai"
+
+class Resquirrel
+  def initialize
+    @openai_client = OpenAiClient.new(ENV["OPENAI_API_KEY"])
+    @notion_client = NotionClient.new(ENV["NOTION_API_KEY"], ENV["NOTION_DATABASE_ID"])
+  end
+
+  def generate_release_note
+    logger = Logger.new($stdout)
+    
+    logger.info "Getting PR information..."
+    pr_data = JSON.parse(File.read(ENV["GITHUB_EVENT_PATH"]))["pull_request"]
+
+    title = pr_data["title"]
+    body = pr_data["body"]
+
+    logger.info "Summarizing PR with OpenAI..."
+    response = @openai_client.summary_pr(title, body)
+
+    summary = response["choices"].first["message"]["content"]
+    url = pr_data["html_url"]
+
+    logger.info "Updating Notion database..."
+    @notion_client.create_release_note(summary, url)
+  end
+end
+
+resquirrel = Resquirrel.new
+resquirrel.generate_release_note

data/lib/resquirrel/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Resquirrel
+  VERSION = "0.1.0"
+end

data/lib/resquirrel.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "resquirrel/version"
+
+module Resquirrel
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: resquirrel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yuki-snow1823
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-04-27 00:00:00.000000000 Z
+dependencies: []
+description: ''
+email:
+- y.horikoshi.pg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/resquirrel.rb
+- lib/resquirrel/client/notion.rb
+- lib/resquirrel/client/openai.rb
+- lib/resquirrel/main.rb
+- lib/resquirrel/version.rb
+homepage: https://github.com/yuki-snow1823/resquirrel
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yuki-snow1823/resquirrel
+  source_code_uri: https://github.com/yuki-snow1823/resquirrel
+  changelog_uri: https://github.com/yuki-snow1823/resquirrel/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: RubyGems that automatically create release notes for Notion DB using Open
+  AI API.
+test_files: []