ai_pr_reviewer 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a61d180df947862b3037057a7e44f07f1a59d085fd304fbe1d326c4be43ac600
+  data.tar.gz: 3e781555225208fbda19fd0e54cfcc086f96a2e1c107335fda60ff900cb01b62
+SHA512:
+  metadata.gz: 2ab25a7a08407add6ec385e8a72924efb82d8e12c94a80cacb067ed5e3c2c27068c4feb3edd7757d37753065708eac52cec1ec9376457ebefd1ef2f1eb19765c
+  data.tar.gz: 4840a32311ce1d7595cd85e7a4038e83765cece942aeb99a3e97320af85be9b021c869d45e7ba3d9e8174001e3304cdfc4acb9fcab4fe05092cf450fdc5d5f1d

data/README.md

@@ -0,0 +1,72 @@
+# AI PR Reviewer
+
+An AI-powered Pull Request reviewer that uses the Perplexity API to provide actionable feedback on your pull requests.
+
+## Features
+
+- Automatically reviews pull requests using AI
+- Provides actionable feedback on code quality, bugs, security, and performance
+- Adds inline comments for specific code feedback
+- Integrates with GitHub Actions for automated reviews
+- Supports both manual and automated workflows
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ai_pr_reviewer'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it globally:
+```bash
+$ gem install ai_pr_reviewer
+```
+
+## Configuration
+
+1. For local usage, create a `.env` file in your project root with the following variables:
+```
+GITHUB_TOKEN=your_github_token_here
+GITHUB_REPOSITORY=owner/repo_name
+PERPLEXITY_API_KEY=your_perplexity_api_key_here
+```
+
+2. For GitHub Actions, add these secrets to your repository:
+- `GITHUB_TOKEN` (automatically provided by GitHub Actions)
+- `PERPLEXITY_API_KEY` (add this in your repository secrets)
+- Run `ai_pr_review install` to automatically install a GitHub Actions workflow file in your repository's `.github/workflows` directory.
+
+
+## Usage
+
+### Command Line
+
+Review a specific PR:
+```bash
+$ ai-pr-review PR_NUMBER
+```
+
+### GitHub Actions
+
+The installed workflow will automatically review pull requests when:
+- A new PR is opened
+- An existing PR is updated
+- A PR is reopened
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/brilyuhns/ai_pr_reviewer.
+
+## License
+
+The gem is available as open source under the terms of the MIT License. 

data/exe/ai-pr-review

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require "ai_pr_reviewer"
+require_relative "../lib/pr_reviewer"
+
+if ARGV.empty?
+  puts "Usage:"
+  puts "  ai-pr-review <pr_number>     # Review a specific PR"
+  puts "  ai-pr-review install         # Install GitHub Actions workflow"
+  exit 1
+end
+
+if ARGV[0] == "install"
+  if AiPrReviewer.install_github_actions
+    exit 0
+  else
+    exit 1
+  end
+end
+
+reviewer = PRReviewer.new
+reviewer.review_pr(ARGV[0].to_i) 

data/lib/ai_pr_reviewer/version.rb

@@ -0,0 +1,3 @@
+module AiPrReviewer
+  VERSION = "0.1.4"
+end 

data/lib/ai_pr_reviewer.rb

@@ -0,0 +1,34 @@
+require "ai_pr_reviewer/version"
+require "fileutils"
+
+module AiPrReviewer
+  class Error < StandardError; end
+  
+  class << self
+    def install_github_actions
+      source = File.join(File.dirname(__FILE__), '..', 'templates', 'github', 'workflows', 'ai_pr_review.yml')
+      target_dir = File.join(Dir.pwd, '.github', 'workflows')
+      target = File.join(target_dir, 'ai_pr_review.yml')
+      
+      FileUtils.mkdir_p(target_dir)
+      if File.exist?(target)
+        puts "GitHub Actions workflow already exists at #{target}"
+        false
+      else
+        FileUtils.cp(source, target)
+        puts "Successfully installed GitHub Actions workflow at #{target}"
+        true
+      end
+    rescue StandardError => e
+      puts "Error installing GitHub Actions workflow: #{e.message}"
+      false
+    end
+  end
+end
+
+# Add post-install hook
+Gem.post_install do |installer|
+  if installer.spec.name == 'ai_pr_reviewer'
+    AiPrReviewer.install_github_actions
+  end
+end 

data/lib/pr_reviewer.rb

@@ -0,0 +1,187 @@
+require 'octokit'
+require 'dotenv'
+require 'json'
+require 'httparty'
+
+# Load environment variables
+Dotenv.load('.env')
+
+class PRReviewer
+  def initialize
+    @github_client = Octokit::Client.new(access_token: ENV['GITHUB_TOKEN'])
+    @repository = ENV['GITHUB_REPOSITORY']
+  end
+
+  def review_pr(pr_number)
+    begin
+      # Fetch PR details
+      pr = @github_client.pull_request(@repository, pr_number)
+      puts "Reviewing PR ##{pr_number}: #{pr.title}"
+
+      # Get PR diff
+      diff = @github_client.pull_request(@repository, pr_number, accept: 'application/vnd.github.v3.diff')
+      
+      # Generate summary
+      summary = generate_summary(pr, diff)
+      puts summary
+      
+      # Get review from Perplexity
+      review = get_perplexity_review(pr, diff)
+      
+      # Post comments
+      post_review_comments(pr_number, summary, review)
+      
+      puts "Review completed successfully!"
+    rescue Octokit::Error => e
+      puts "GitHub API Error: #{e.message}"
+    rescue StandardError => e
+      puts "Error: #{e.message}"
+    end
+  end
+
+  private
+
+  def generate_summary(pr, diff)
+    "## PR Summary\n\n" \
+    "**Title:** #{pr.title}\n" \
+    "**Author:** #{pr.user.login}\n" \
+    "**Changed Files:** #{pr.changed_files}\n" \
+    "**Additions:** #{pr.additions}\n" \
+    "**Deletions:** #{pr.deletions}\n"
+  end
+
+  def system_prompt
+    <<~PROMPT
+      You are an experienced code reviewer. Provide concise, constructive, actionable feedback.
+      I REQUIRE EXTREME BREVITY - use minimal words and only include actionable feedback.
+      As a code reviewer, focus on actionable feedback around the following areas:
+        1. Code quality and best practices: SKIP SECTION IF THE PR DOES NOT IMPACT CODE QUALITY AND BEST PRACTICES OR CREATE NEW CODE QUALITY AND BEST PRACTICES
+        2. Potential bugs or issues: SKIP SECTION IF THE PR DOES NOT IMPACT POTENTIAL BUGS OR ISSUES OR CREATE NEW POTENTIAL BUGS OR ISSUES
+        3. Security concerns: SKIP SECTION IF THE PR DOES NOT IMPACT SECURITY OR CREATE NEW SECURITY CONCERNS
+        4. Performance implications: SKIP SECTION IF THE PR DOES NOT IMPACT PERFORMANCE OR CREATE NEW PERFORMANCE IMPLICATIONS
+        5. Suggestions for improvement: SKIP SECTION IF THE PR DOES NOT IMPACT SUGGESTIONS FOR IMPROVEMENT OR CREATE NEW SUGGESTIONS FOR IMPROVEMENT
+      ONLY PROVIDE ACTIONABLE FEEDBACK. Do not provide feedback that is not actionable. If for any of the areas the feedback is not actionable, skip the area.
+      CRITICAL INSTRUCTIONS:
+      - Please format your response as a JSON object with the following structure. Ensure the feedback is in markdown format: 
+        {
+          "summary": "overall review summary",
+          "inline_comments": [
+            { "path": "file_path", "line": line_number, "body": "comment text" }
+          ],
+          "general_feedback": "general feedback text",
+          "performance_feedback": "performance feedback text",
+          "security_feedback": "security feedback text",
+          "testing_recommendation": "testing recommendation text"
+        }
+      - USE PR description as context if available
+      - NEVER include a section if it has no critical, actionable feedback.
+      - NEVER include phrases like "No X issues found" - simply omit that section.
+      - Use bullet points for all feedback items.
+      - Sort feedback by criticality (highest first).
+      - ONLY flag issues that are definitively problems, not speculative concerns.
+    PROMPT
+  end
+
+  def user_prompt(pr, diff)
+    <<~PROMPT
+      As a code reviewer, provide feedback for the following PR:
+      Pull Request Details:
+      Title: #{pr.title}
+      Description: #{pr.body}
+      
+      Changes (diff):
+      #{diff}
+    PROMPT
+  end
+
+  def get_perplexity_review(pr, diff)
+    begin
+      api_key = ENV['PERPLEXITY_API_KEY']
+      raise "Perplexity API key not found in environment variables" if api_key.nil?
+
+      # Prepare the prompt for the review
+      prompt = user_prompt(pr, diff)
+
+      # Make request to Perplexity API
+      response = HTTParty.post(
+        'https://api.perplexity.ai/chat/completions',
+        headers: {
+          'Authorization' => "Bearer #{api_key}",
+          'Content-Type' => 'application/json'
+        },
+        body: {
+          model: 'sonar-pro',
+          messages: [
+            { role: 'system', content: system_prompt },
+            { role: 'user', content: prompt }
+          ]
+        }.to_json
+      )
+
+      if response.success?
+        result = JSON.parse(response.body)
+        review_text = result['choices'][0]['message']['content']
+        # p "## AI Review\n\n#{review_text}"
+      else
+        raise "Perplexity API Error: #{response.code} - #{response.body}"
+      end
+    rescue StandardError => e
+      puts "Error generating review: #{e.message}"
+      "## AI Review\n\nError generating review: #{e.message}"
+    end
+  end
+
+  def post_review_comments(pr_number, summary, review)
+    begin
+      # Parse the review JSON
+      review_data = JSON.parse(review)
+      
+      # Create the main review body with general feedback
+      main_comment = []
+      main_comment << "# AI Review Summary\n\n#{review_data['summary']}" if review_data['summary']
+      main_comment << "\n\n## General Feedback\n#{review_data['general_feedback']}" if review_data['general_feedback']
+      main_comment << "\n\n## Performance Feedback\n#{review_data['performance_feedback']}" if review_data['performance_feedback']
+      main_comment << "\n\n## Security Feedback\n#{review_data['security_feedback']}" if review_data['security_feedback']
+      main_comment << "\n\n## Testing Recommendations\n#{review_data['testing_recommendation']}" if review_data['testing_recommendation']
+      
+      # Get the PR's latest commit SHA
+      pr_commits = @github_client.pull_request_commits(@repository, pr_number)
+      latest_commit_sha = pr_commits.last.sha
+      
+      # Prepare review parameters
+      review_params = {
+        commit_id: latest_commit_sha,
+        body: main_comment.join,
+        event: 'COMMENT'
+      }
+      
+      # Add inline comments if they exist
+      if review_data['inline_comments']&.any?
+        review_params[:comments] = review_data['inline_comments'].map do |comment|
+          {
+            path: comment['path'],
+            position: comment['line'],
+            body: comment['body']
+          }
+        end
+      end
+      
+      # Create a single review with both body and inline comments
+      @github_client.create_pull_request_review(
+        @repository,
+        pr_number,
+        review_params
+      )
+      
+      puts "Successfully posted review!"
+    rescue JSON::ParserError => e
+      puts "Error parsing review JSON: #{e.message}"
+      # Fallback to posting the raw review if JSON parsing fails
+      @github_client.add_comment(@repository, pr_number, [summary, review].join("\n\n"))
+    rescue Octokit::Error => e
+      puts "GitHub API Error: #{e.message}"
+    rescue StandardError => e
+      puts "Error posting review: #{e.message}"
+    end
+  end
+end 

data/templates/github/workflows/ai_pr_review.yml

@@ -0,0 +1,67 @@
+name: PR Reviewer
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+  workflow_dispatch:
+    inputs:
+      pr_number:
+        description: 'PR number'
+        required: true
+        default: ''
+
+jobs:
+  review:
+    if: |
+      (github.event_name == 'pull_request') ||
+      (github.event_name == 'issue_comment' && 
+       github.event.issue.pull_request && 
+       contains(github.event.comment.body, '/review'))
+    runs-on: ubuntu-latest
+    # defaults:
+    #   run:
+    #     working-directory: ./ai_pr_reviewer # this is the directory of the pr_reviewer.rb file
+    #     shell: bash
+    permissions:  
+      contents: read
+      pull-requests: write
+      issues: write
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.2.2'
+        bundler-cache: false
+
+    - name: Install dependencies
+      run: |
+        gem install specific_install
+        gem specific_install https://github.com/brilyuhns/ai_pr_reviewer.git
+    
+    # - name: Cache dependencies
+    #   uses: actions/cache@v3
+    #   with:
+    #     path: ai_pr_reviewer/vendor/bundle
+    #     key: ${{ runner.os }}-gems-${{ hashFiles('ai_pr_reviewer/Gemfile.lock') }}
+    #     restore-keys: |
+    #       ${{ runner.os }}-gems-
+      
+    - name: Run PR Review
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        PERPLEXITY_API_KEY: ${{ secrets.PERPLEXITY_API_KEY }}
+        GITHUB_REPOSITORY: ${{ github.repository }}
+      run: |
+        if [[ "${{ github.event_name }}" == "pull_request" ]]; then
+          PR_NUMBER="${{ github.event.pull_request.number }}"
+        else
+          PR_NUMBER="${{ github.event.issue.number }}"
+        fi
+        ai-pr-review $PR_NUMBER 

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: ai_pr_reviewer
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Your Name
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: Automatically review Pull Requests using AI to provide actionable feedback,
+  inline comments, and suggestions for improvement
+email:
+- your.email@example.com
+executables:
+- ai-pr-review
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- exe/ai-pr-review
+- lib/ai_pr_reviewer.rb
+- lib/ai_pr_reviewer/version.rb
+- lib/pr_reviewer.rb
+- templates/github/workflows/ai_pr_review.yml
+homepage: https://github.com/yourusername/ai_pr_reviewer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yourusername/ai_pr_reviewer
+  source_code_uri: https://github.com/yourusername/ai_pr_reviewer
+  changelog_uri: https://github.com/yourusername/ai_pr_reviewer/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.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: AI-powered Pull Request reviewer using Perplexity API
+test_files: []