rubyn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b1ca55e10bd9ae4ec17fbdbfa196577fda468788c083905679a2c1e7e782181
+  data.tar.gz: f82e928da5975b754dca641f00488bb6360ffbd4cd45d538909348a4b1ff6b05
+SHA512:
+  metadata.gz: da671165752719684baaf371f4c1a47d7a9f3e8604af37360b106827d15c08a1508219b7fc47ae859a1c8f54f9e756a7e7a459c66fff4cbb718e70610eb4684a
+  data.tar.gz: 7f6f19c30b1ba42e74aeb0f3b0ec936d8f14ac63b6d52949d87c0714fce3b76c041c3cc8bf67a8eb07c36453b6d7602ae35736c46b1771646ce71bcebac748b4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 matthewsuttles
+
+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,251 @@
+<p align="center">
+  <img src="lib/rubyn/engine/app/assets/images/rubyn/RubynLogo.png" alt="Rubyn" width="80" height="80" />
+</p>
+
+<h1 align="center">Rubyn</h1>
+
+<p align="center">
+  <strong>AI Code Assistant for Ruby & Rails</strong>
+</p>
+
+<p align="center">
+  <a href="https://rubygems.org/gems/rubyn"><img src="https://img.shields.io/gem/v/rubyn?color=CC342D&label=gem" alt="Gem Version" /></a>
+  <a href="https://github.com/MatthewSuttles/rubyn"><img src="https://img.shields.io/badge/specs-412%20passing-brightgreen" alt="Tests" /></a>
+  <a href="https://github.com/rubocop/rubocop"><img src="https://img.shields.io/badge/code_style-rubocop-brightgreen.svg" alt="Ruby Style Guide" /></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT" /></a>
+  <a href="https://www.ruby-lang.org"><img src="https://img.shields.io/badge/ruby-%3E%3D%202.7-CC342D.svg" alt="Ruby" /></a>
+  <a href="https://github.com/MatthewSuttles/rubyn"><img src="https://img.shields.io/badge/coverage-95%25-brightgreen.svg" alt="Coverage" /></a>
+</p>
+
+<p align="center">
+  Refactor controllers, generate idiomatic RSpec, catch N+1 queries, and review code for anti-patterns — all context-aware with your schema, routes, and specs. Built for Ruby developers who care about conventions.
+</p>
+
+---
+
+<!-- Screenshots: replace these paths with your actual screenshots -->
+<p align="center">
+  <img src="docs/screenshots/dashboard.png" alt="Rubyn Dashboard" width="700" />
+</p>
+
+<p align="center">
+  <em>The Rubyn web dashboard mounted inside your Rails app</em>
+</p>
+
+<p align="center">
+  <img src="docs/screenshots/console.png" alt="Rubyn Dashboard" width="700" />
+</p>
+
+<p align="center">
+  <em>The Rubyn console for those hardcore users</em>
+</p>
+
+---
+
+## Why Rubyn?
+
+General AI tools write Ruby like they write Python. Rubyn is different:
+
+- **Rails-native** — Knows when to extract a service object, how to write idiomatic RSpec, and why your controller is too fat
+- **Context-aware** — Automatically includes your schema, routes, specs, factories, and related models before generating suggestions
+- **Best practices built in** — Every request is enriched with curated Ruby and Rails guidelines matched to what you're working on
+
+---
+
+## Installation
+
+Add Rubyn to your Gemfile:
+
+```ruby
+gem "rubyn"
+```
+
+Then run:
+
+```sh
+bundle install
+```
+
+Or install it directly:
+
+```sh
+gem install rubyn
+```
+
+### Requirements
+
+- Ruby >= 2.7
+- Rails >= 6.0 (for the web dashboard engine; the CLI works without Rails)
+- A Rubyn API key — sign up at [rubyn.ai](https://rubyn.ai)
+
+---
+
+## Quick Start
+
+### 1. Initialize your project
+
+```sh
+rubyn init
+```
+
+This will:
+
+- Prompt for your API key (or read from `RUBYN_API_KEY` env var)
+- Scan your project (Ruby version, Rails version, test framework, gems)
+- Create `.rubyn/project.yml` in your project root
+
+### 2. Refactor a file
+
+```sh
+rubyn refactor app/controllers/orders_controller.rb
+```
+
+Rubyn pulls in the related model, routes, request spec, and service objects — then suggests idiomatic improvements you can apply with one command.
+
+<!-- Screenshot: CLI refactor output -->
+<!-- <img src="docs/screenshots/cli-refactor.png" alt="CLI Refactor" width="600" /> -->
+
+### 3. Generate specs
+
+```sh
+rubyn spec app/services/orders/create_service.rb
+```
+
+Generates idiomatic tests that match your project's framework (RSpec or Minitest), factory setup, and assertion style.
+
+### 4. Review code
+
+```sh
+rubyn review app/controllers/
+```
+
+Catches N+1 queries, SQL injection, missing auth, fat controllers, and other anti-patterns — before your PR.
+
+### 5. Start an interactive session
+
+```sh
+rubyn agent
+```
+
+Ask Rubyn anything about your codebase. Attach files with `@filename`:
+
+```
+you> How should I refactor @app/models/order.rb to use service objects?
+rubyn> Looking at your Order model, I'd suggest extracting...
+```
+
+---
+
+## Web Dashboard
+
+Rubyn includes a mountable Rails engine that provides a full web UI in development.
+
+```ruby
+# config/routes.rb
+mount Rubyn::Engine => "/rubyn" if Rails.env.development?
+```
+
+Then visit [http://localhost:3000/rubyn](http://localhost:3000/rubyn).
+
+<!-- Screenshot: File browser with categorized files -->
+<!-- <img src="docs/screenshots/files.png" alt="File Browser" width="600" /> -->
+
+Features:
+
+- **File Browser** — Browse Ruby files by category (models, controllers, services, etc.) with one-click refactor, spec, and review
+- **Refactor View** — Code blocks with Apply button for each file, Apply All for multi-file changes
+- **Spec Generator** — Generated specs with Write to File button
+- **Code Review** — Findings displayed inline
+- **Agent Chat** — Conversational interface
+- **Settings** — API key status and preferences
+
+The engine is fully isolated — it uses its own layout, styles, and JavaScript. It will not interfere with your application.
+
+### Non-Rails Projects
+
+```sh
+rubyn dashboard
+# => Dashboard: http://localhost:9292/rubyn
+```
+
+---
+
+## All Commands
+
+| Command | Description |
+|---|---|
+| `rubyn init` | Initialize Rubyn in your project |
+| `rubyn refactor <file>` | Refactor a file toward best practices |
+| `rubyn spec <file>` | Generate tests for a file |
+| `rubyn review <file_or_dir>` | Review code for anti-patterns |
+| `rubyn agent` | Start an interactive conversation |
+| `rubyn usage` | Show credit balance and recent usage |
+| `rubyn config [key] [value]` | View or set configuration |
+| `rubyn dashboard` | Open the web dashboard |
+
+---
+
+## How Context Works
+
+When you refactor a controller, Rubyn automatically includes:
+
+| You pass | Rubyn also loads |
+|---|---|
+| Controller | Model, routes, request spec, service objects |
+| Model | Schema, controller, model spec, factory |
+| Service object | Referenced models, service spec |
+| Gem lib file | Corresponding spec, sibling classes |
+
+Plus relevant best practice documents matched to the file type — no configuration needed.
+
+---
+
+## Plans
+
+| Feature | Free | Pro | Lifetime |
+|---|:---:|:---:|:---:|
+| All commands (refactor, spec, review, agent) | Yes | Yes | Yes |
+| Web dashboard | Yes | Yes | Yes |
+| Convention-based file context | Yes | Yes | Yes |
+| Credits | 10/day | 250/month | 250/month |
+| Price | Free | $19/mo | $300 one-time |
+| Overages | - | $0.05/credit * | $0.05/credit * |
+
+\* Overages are optional and can be turned off at any time in your account settings.
+
+[Compare plans at rubyn.ai/pricing](https://rubyn.ai/pricing)
+
+---
+
+## Configuration
+
+### API Key
+
+```sh
+export RUBYN_API_KEY=rk_your_key_here
+```
+
+Or stored at `~/.rubyn/credentials` with `0600` permissions.
+
+### Environment Variables
+
+| Variable | Description |
+|---|---|
+| `RUBYN_API_KEY` | API key (overrides credentials file) |
+| `RUBYN_API_URL` | API base URL (default: `https://api.rubyn.ai`) |
+
+---
+
+## Development
+
+```sh
+bin/setup
+bundle exec rspec      # 412 specs
+bundle exec rubocop
+```
+
+---
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE).

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/exe/rubyn

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubyn"
+Rubyn::CLI.start(ARGV)

data/lib/generators/rubyn/install_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Rubyn
+  class InstallGenerator < Rails::Generators::Base
+    desc "Install Rubyn engine"
+
+    def add_route
+      route 'mount Rubyn::Engine => "/rubyn" if Rails.env.development?'
+    end
+
+    def show_instructions
+      say "Rubyn engine mounted at /rubyn (development only)"
+      say "Run 'rubyn init' to configure your API key and project"
+    end
+  end
+end

data/lib/rubyn/cli.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module Rubyn
+  class CLI < Thor
+    def self.exit_on_failure?
+      true
+    end
+
+    no_commands do
+      def check_for_updates
+        msg = Rubyn::VersionChecker.update_message
+        return unless msg
+
+        puts
+        puts Pastel.new.yellow(msg)
+      rescue Rubyn::Error, Net::HTTPError, SocketError, Timeout::Error
+        # Never let update check break the CLI
+      end
+    end
+
+    def self.start(given_args = ARGV, config = {})
+      super
+    ensure
+      # Check for updates after any command (in a non-blocking way)
+      new.check_for_updates if given_args.any? && !%w[help -h --help version -v --version].include?(given_args.first)
+    end
+
+    desc "init", "Initialize Rubyn in this project"
+    def init
+      require_relative "commands/init"
+      Commands::Init.new.execute
+    end
+
+    desc "refactor FILE", "Refactor a file toward best practices"
+    def refactor(file)
+      require_relative "commands/refactor"
+      Commands::Refactor.new.execute(file)
+    end
+
+    desc "spec FILE", "Generate RSpec tests for a file"
+    def spec(file)
+      require_relative "commands/spec"
+      Commands::Spec.new.execute(file)
+    end
+
+    desc "review FILE_OR_DIR", "Review code for anti-patterns"
+    def review(file_or_dir)
+      require_relative "commands/review"
+      Commands::Review.new.execute(file_or_dir)
+    end
+
+    desc "agent", "Start an interactive conversation with Rubyn"
+    def agent
+      require_relative "commands/agent"
+      Commands::Agent.new.execute
+    end
+
+    # desc "analyse", "Analyse your codebase for enhanced AI context"
+    # option :force, type: :boolean, default: false, desc: "Re-analyse all files, not just changed ones"
+    # def analyse
+    #   require_relative "commands/index"
+    #   Commands::Index.new.execute(force: options[:force])
+    # end
+
+    desc "usage", "Show credit balance and recent usage"
+    def usage
+      require_relative "commands/usage"
+      Commands::Usage.new.execute
+    end
+
+    desc "config [KEY] [VALUE]", "View or set configuration"
+    def config(key = nil, value = nil)
+      require_relative "commands/config"
+      Commands::Config.new.execute(key, value)
+    end
+
+    desc "dashboard", "Open the Rubyn web dashboard"
+    def dashboard
+      require_relative "commands/dashboard"
+      Commands::Dashboard.new.execute
+    end
+  end
+end

data/lib/rubyn/client/api_client.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday/multipart"
+require "json"
+
+module Rubyn
+  module Client
+    class ApiClient
+      attr_reader :base_url
+
+      def initialize(base_url: nil, api_key: nil)
+        @base_url = base_url || Rubyn.configuration.api_url
+        @api_key = api_key
+      end
+
+      def verify_auth
+        post("/api/v1/auth/verify")
+      end
+
+      def refactor(file_path:, code:, context_files:, project_token:)
+        post("/api/v1/ai/refactor", {
+               file_path: file_path,
+               code: code,
+               context_files: context_files,
+               project_token: project_token
+             })
+      end
+
+      def generate_spec(file_path:, code:, context_files:, project_token:)
+        post("/api/v1/ai/spec", {
+               file_path: file_path,
+               code: code,
+               context_files: context_files,
+               project_token: project_token
+             })
+      end
+
+      def review(files:, context_files:, project_token:)
+        post("/api/v1/ai/review", {
+               files: files,
+               context_files: context_files,
+               project_token: project_token
+             })
+      end
+
+      def agent_message(conversation_id:, message:, file_context:, project_token:)
+        post("/api/v1/ai/agent", {
+               conversation_id: conversation_id,
+               message: message,
+               file_context: file_context,
+               project_token: project_token
+             })
+      end
+
+      def submit_tool_results(conversation_id:, tool_results:, project_token:)
+        post("/api/v1/ai/agent/tool_results", {
+               conversation_id: conversation_id,
+               tool_results: tool_results,
+               project_token: project_token
+             })
+      end
+
+      def list_conversations(project_token:)
+        get("/api/v1/conversations", project_token: project_token)
+      end
+
+      def get_conversation(id:, project_token:)
+        get("/api/v1/conversations/#{id}", project_token: project_token)
+      end
+
+      def sync_project(metadata:, project_token:)
+        post("/api/v1/projects/sync", {
+               project_token: project_token,
+               name: metadata[:project_name],
+               project_type: metadata[:project_type],
+               ruby_version: metadata[:ruby_version],
+               rails_version: metadata[:rails_version],
+               test_framework: metadata[:test_framework],
+               factory_library: metadata[:factory_library],
+               gems_snapshot: metadata[:gems],
+               directory_structure: metadata[:directory_structure]
+             })
+      end
+
+      def index_project(project_token:, files:)
+        post("/api/v1/projects/index", project_token: project_token, files: files)
+      end
+
+      def join_project(project_token:)
+        post("/api/v1/projects/join", project_token: project_token)
+      end
+
+      def get_balance
+        get("/api/v1/usage/balance")
+      end
+
+      def get_history(page: 1)
+        get("/api/v1/usage/history", page: page)
+      end
+
+      def submit_feedback(interaction_id:, rating:, feedback: nil)
+        post("/api/v1/feedback", {
+               interaction_id: interaction_id,
+               rating: rating,
+               feedback: feedback
+             })
+      end
+
+      private
+
+      def api_key
+        @api_key || Rubyn::Config::Credentials.api_key
+      end
+
+      def connection
+        @connection ||= Faraday.new(url: @base_url) do |f|
+          f.request :json
+          f.response :json, content_type: /\bjson$/
+          f.adapter Faraday.default_adapter
+          f.options.timeout = 300
+          f.options.open_timeout = 10
+          f.headers["Authorization"] = "Bearer #{api_key}" if api_key
+          f.headers["User-Agent"] = "rubyn-gem/#{Rubyn::VERSION}"
+        end
+      end
+
+      def get(path, params = {})
+        response = connection.get(path, params)
+        parse_response(response)
+      end
+
+      def post(path, body = {})
+        response = connection.post(path, body)
+        parse_response(response)
+      end
+
+      def parse_response(response)
+        return response.body if response.status.between?(200, 299)
+
+        message = extract_error_message(response)
+
+        case response.status
+        when 400
+          raise APIError, message || "Bad request"
+        when 401
+          raise AuthenticationError, "Invalid API key. Run `rubyn init` to reconfigure."
+        when 402
+          raise APIError, message || "Insufficient credits. Check your balance with `rubyn usage`."
+        when 403
+          raise AuthenticationError, message || "Access denied. Check your project membership."
+        when 404
+          raise APIError, message || "Resource not found."
+        when 422
+          raise APIError, message || "Unprocessable entity"
+        when 429
+          raise APIError, "Rate limit exceeded. Please wait and try again."
+        else
+          raise APIError, "Unexpected error (#{response.status}): #{message}"
+        end
+      end
+
+      def extract_error_message(response)
+        body = response.body
+        return body["error"] if body.is_a?(Hash) && body["error"]
+        return body.to_s unless body.nil? || (body.is_a?(String) && body.empty?)
+
+        nil
+      end
+    end
+  end
+end