binocs 0.1.0

data/lib/generators/binocs/install/install_generator.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Binocs
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      def self.next_migration_number(dirname)
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+      def copy_migrations
+        migration_template "create_binocs_requests.rb", "db/migrate/create_binocs_requests.rb"
+      end
+
+      def create_initializer
+        template "initializer.rb", "config/initializers/binocs.rb"
+      end
+
+      def add_route
+        route "mount Binocs::Engine => '/binocs' unless Rails.env.production?"
+      end
+
+      def update_gitignore
+        gitignore_path = Rails.root.join(".gitignore")
+        return unless File.exist?(gitignore_path)
+
+        gitignore_entries = <<~GITIGNORE
+
+          # Binocs AI Agent files
+          .binocs-context.md
+          .binocs-prompt.md
+        GITIGNORE
+
+        gitignore_content = File.read(gitignore_path)
+
+        # Check if already added
+        return if gitignore_content.include?(".binocs-context.md")
+
+        append_to_file ".gitignore", gitignore_entries
+        say "Updated .gitignore with Binocs entries", :green
+      end
+
+      def show_readme
+        say ""
+        say "Binocs installed successfully!", :green
+        say ""
+        say "Next steps:"
+        say "  1. Run migrations: bin/rails db:migrate"
+        say "  2. Start your server: bin/rails server"
+        say "  3. Visit: http://localhost:3000/binocs"
+        say ""
+      end
+    end
+  end
+end

data/lib/generators/binocs/install/templates/create_binocs_requests.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class CreateBinocsRequests < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :binocs_requests do |t|
+      t.string :uuid, null: false, index: { unique: true }
+      t.string :method, null: false
+      t.string :path, null: false
+      t.text :full_url
+      t.string :controller_name
+      t.string :action_name
+      t.string :route_name
+      t.text :params
+      t.text :request_headers
+      t.text :response_headers
+      t.text :request_body
+      t.text :response_body
+      t.integer :status_code
+      t.float :duration_ms
+      t.string :ip_address
+      t.string :session_id
+      t.text :logs
+      t.text :exception
+      t.integer :memory_delta
+      t.string :content_type
+
+      t.timestamps
+    end
+
+    add_index :binocs_requests, :method
+    add_index :binocs_requests, :status_code
+    add_index :binocs_requests, :controller_name
+    add_index :binocs_requests, :created_at
+    add_index :binocs_requests, :duration_ms
+  end
+end

data/lib/generators/binocs/install/templates/initializer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Binocs Configuration
+# For more options, see: https://github.com/zincan/binocs
+
+Binocs.configure do |config|
+  # Enable/disable Binocs (automatically disabled in production)
+  config.enabled = true
+
+  # How long to keep request records
+  config.retention_period = 24.hours
+
+  # Maximum request/response body size to store
+  config.max_body_size = 64.kilobytes
+
+  # Paths to ignore
+  config.ignored_paths = %w[/assets /packs /binocs /cable]
+
+  # Maximum number of requests to store
+  config.max_requests = 1000
+
+  # Optional: Protect dashboard with basic auth
+  # config.basic_auth_username = ENV['BINOCS_USERNAME']
+  # config.basic_auth_password = ENV['BINOCS_PASSWORD']
+end

data/lib/tasks/binocs_tasks.rake

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+namespace :binocs do
+  desc "Clear all Binocs request records"
+  task clear: :environment do
+    count = Binocs::Request.count
+    Binocs::Request.delete_all
+    puts "Cleared #{count} Binocs request records."
+  end
+
+  desc "Prune old Binocs request records"
+  task prune: :environment do
+    retention = Binocs.configuration.retention_period
+    count = Binocs::Request.where("created_at < ?", retention.ago).delete_all
+    puts "Pruned #{count} Binocs request records older than #{retention.inspect}."
+  end
+
+  desc "Show Binocs statistics"
+  task stats: :environment do
+    puts "Binocs Statistics"
+    puts "-" * 40
+    puts "Total requests: #{Binocs::Request.count}"
+    puts "Requests today: #{Binocs::Request.today.count}"
+    puts "Requests last hour: #{Binocs::Request.last_hour.count}"
+    puts "Average duration: #{Binocs::Request.average_duration || 0}ms"
+    puts "Error rate: #{Binocs::Request.error_rate}%"
+    puts ""
+    puts "Methods breakdown:"
+    Binocs::Request.methods_breakdown.each do |method, count|
+      puts "  #{method}: #{count}"
+    end
+    puts ""
+    puts "Status breakdown:"
+    Binocs::Request.status_breakdown.sort.each do |status, count|
+      puts "  #{status}: #{count}"
+    end
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: binocs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nate Collins
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: stimulus-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A Rails engine that provides a beautiful dashboard to monitor and debug
+  HTTP requests, similar to Laravel Telescope. Includes a terminal UI with vim keybindings.
+email:
+- n@zincan.com
+executables:
+- binocs
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/binocs/application.js
+- app/assets/stylesheets/binocs/application.css
+- app/channels/binocs/application_cable/channel.rb
+- app/channels/binocs/application_cable/connection.rb
+- app/channels/binocs/requests_channel.rb
+- app/controllers/binocs/application_controller.rb
+- app/controllers/binocs/requests_controller.rb
+- app/helpers/binocs/application_helper.rb
+- app/models/binocs/application_record.rb
+- app/models/binocs/request.rb
+- app/views/binocs/requests/_empty_list.html.erb
+- app/views/binocs/requests/_request.html.erb
+- app/views/binocs/requests/index.html.erb
+- app/views/binocs/requests/show.html.erb
+- app/views/layouts/binocs/application.html.erb
+- config/importmap.rb
+- config/routes.rb
+- db/migrate/20240101000000_create_binocs_requests.rb
+- exe/binocs
+- lib/binocs.rb
+- lib/binocs/agent.rb
+- lib/binocs/agent_context.rb
+- lib/binocs/agent_manager.rb
+- lib/binocs/configuration.rb
+- lib/binocs/engine.rb
+- lib/binocs/log_subscriber.rb
+- lib/binocs/middleware/request_recorder.rb
+- lib/binocs/swagger/client.rb
+- lib/binocs/swagger/path_matcher.rb
+- lib/binocs/tui.rb
+- lib/binocs/tui/agent_output.rb
+- lib/binocs/tui/agents_list.rb
+- lib/binocs/tui/app.rb
+- lib/binocs/tui/colors.rb
+- lib/binocs/tui/filter_menu.rb
+- lib/binocs/tui/help_screen.rb
+- lib/binocs/tui/request_detail.rb
+- lib/binocs/tui/request_list.rb
+- lib/binocs/tui/spirit_animal.rb
+- lib/binocs/tui/window.rb
+- lib/binocs/version.rb
+- lib/generators/binocs/install/install_generator.rb
+- lib/generators/binocs/install/templates/create_binocs_requests.rb
+- lib/generators/binocs/install/templates/initializer.rb
+- lib/tasks/binocs_tasks.rake
+homepage: https://github.com/zincan/binocs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/zincan/binocs
+  source_code_uri: https://github.com/zincan/binocs
+  changelog_uri: https://github.com/zincan/binocs/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Web and TUI request monitoring for development in Rails
+test_files: []