claude_usage 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8eb8b5aad49b48df6c4b6453edb62b8a150c3e90d435c4676799b52175c0f64f
+  data.tar.gz: fd710be1cc9263d734f9bb7873132ce2af550e9fc46cedfd451d02a8f577830f
+SHA512:
+  metadata.gz: c4ed073e2979c9847b30f2c174282bed63e17dea0848837a8fc302463fbabde58626e7306c761d8005e50bef3dbe3875c95f47be9d0d869ade28de94eb5ba6e1
+  data.tar.gz: e82b2b96f3a4e0905aea7a7738b5872eebb7ff433abd39142bd2e901a6abf8bf9a5004e83a3a00a8f7046b7c104038eee5d4a4ba2ee0d7f07d65de248cbcee91

data/.rubocop.yml

@@ -0,0 +1,74 @@
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'bin/**/*'
+    - 'vendor/**/*'
+    - 'node_modules/**/*'
+
+# Gem-specific configurations
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+# Style preferences
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false # We have separate documentation
+
+# Metrics - reasonable defaults for gem code
+Metrics/MethodLength:
+  Max: 20
+  Exclude:
+    - 'lib/tasks/**/*'
+    - 'lib/claude_usage/litellm_pricing_fetcher.rb'
+    - 'lib/claude_usage/cost_calculator.rb'
+    - 'lib/claude_usage/file_reader.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/tasks/**/*'
+    - 'Rakefile'
+    - '*.gemspec'
+
+Metrics/AbcSize:
+  Max: 20
+  Exclude:
+    - 'lib/tasks/**/*'
+    - 'lib/claude_usage/litellm_pricing_fetcher.rb'
+    - 'lib/claude_usage/cost_calculator.rb'
+    - 'lib/claude_usage/usage_aggregator.rb'
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/claude_usage/litellm_pricing_fetcher.rb'
+    - 'lib/claude_usage/file_reader.rb'
+    - 'lib/claude_usage/usage_aggregator.rb'
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/claude_usage/litellm_pricing_fetcher.rb'
+    - 'lib/claude_usage/usage_aggregator.rb'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/claude_usage/litellm_pricing_fetcher.rb'
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+# Layout
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*'
+
+# Naming
+Naming/VariableNumber:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.2] - 2025-12-23
+
+### Added
+- Initial release of claude_usage gem
+- Rails Engine for automatic route mounting
+- Service objects for reading Claude Code JSONL files
+- LiteLLM pricing integration with automatic fetching and caching
+- Cost calculator with tiered pricing support (200k+ tokens)
+- Usage aggregator for daily and total usage statistics
+- Web UI with modern, responsive design
+- JSON API endpoint for programmatic access
+- Rake tasks for CLI usage reports
+- Rails generator for easy installation
+- Configuration system with sensible defaults
+- Support for cache creation and read token tracking
+- Deduplication of usage entries
+- Offline mode for working without internet access
+- Comprehensive documentation and guides
+- ProjectNameResolver module for shared project name detection
+- Formatters module for consistent number and currency formatting
+- UsageHelper for view formatting methods
+- RuboCop enforcement in CI pipeline
+- Rubocop executable in bin directory
+
+### Security
+- Path traversal vulnerability protection in FileReader
+- Project name validation to prevent directory traversal attacks
+- Sanitized exception messages in controller to prevent information leakage
+- Input validation for all file operations
+- User-friendly error messages that don't expose internal details
+
+### Features
+- Automatic detection of Rails app name for project tracking
+- Multi-path support for Claude Code directories
+- Configurable pricing cache expiry
+- Beautiful HTML reports with gradient styling
+- Centralized number formatting with comma separators
+- Model badge display in reports
+- Robust error handling with detailed server-side logging
+- DRY code with shared utilities for formatting and project detection
+
+[Unreleased]: https://github.com/Shoebtamboli/claude_usage/compare/v0.1.2...HEAD
+[0.1.2]: https://github.com/Shoebtamboli/claude_usage/releases/tag/v0.1.2
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Shoeb
+
+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,212 @@
+# ClaudeUsage
+
+[![CI](https://github.com/Shoebtamboli/claude_usage/actions/workflows/main.yml/badge.svg)](https://github.com/Shoebtamboli/claude_usage/actions/workflows/main.yml)
+[![Gem Version](https://badge.fury.io/rb/claude_usage.svg)](https://badge.fury.io/rb/claude_usage)
+[![codecov](https://codecov.io/gh/Shoebtamboli/claude_usage/branch/main/graph/badge.svg)](https://codecov.io/gh/Shoebtamboli/claude_usage)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)
+
+A Rails engine for tracking Claude Code token usage and costs in your Rails applications. Get real-time insights into your Claude Code usage with automatic cost calculation using LiteLLM pricing data.
+
+## Features
+
+✅ **Automatic Usage Tracking** - Reads Claude Code JSONL logs automatically  
+✅ **Auto-Detection** - Automatically detects project name from Rails.root  
+✅ **LiteLLM Pricing Integration** - Fetches up-to-date pricing from LiteLLM API  
+✅ **Tiered Pricing Support** - Handles 200k+ token tiered pricing  
+✅ **Cache Token Tracking** - Tracks cache creation and read tokens  
+✅ **Beautiful Web UI** - Modern, responsive interface for viewing usage  
+✅ **JSON API** - Programmatic access to usage data  
+✅ **Rake Tasks** - CLI commands for quick reports  
+✅ **Zero Configuration** - Works out of the box with sensible defaults
+
+## Installation
+
+Add this line to your application's Gemfile in the development group:
+
+```ruby
+group :development do
+  gem 'claude_usage'
+end
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+> **Note:** This gem is designed for development environments to track your Claude Code usage while building your application. It's recommended to keep it in the development group unless you need production usage tracking.
+
+Or install it yourself as:
+
+```bash
+gem install claude_usage
+```
+
+## Quick Start
+
+After installing the gem, run the generator:
+
+```bash
+rails generate claude_usage:install
+```
+
+**IMPORTANT:** Verify your setup immediately:
+
+```bash
+rake claude_usage:show_project
+```
+
+This command will:
+- Show which project is being tracked
+- List all available Claude Code projects
+- Indicate if data files exist
+- Provide solutions if no data is found
+
+If the project name doesn't match, update `config/initializers/claude_usage.rb`:
+
+```ruby
+ClaudeUsage.configure do |config|
+  config.project_name = "actual-project-name"  # From show_project output
+end
+```
+
+Start your Rails server and visit:
+
+```
+http://localhost:3000/claude-usage
+```
+
+## Usage
+
+### Web Interface
+
+Visit `http://localhost:3000/claude-usage` to see:
+- Total usage statistics
+- Daily breakdown of token usage
+- Cost calculations
+- Model usage information
+
+### JSON API
+
+Access usage data programmatically:
+
+```bash
+curl http://localhost:3000/claude-usage/json
+```
+
+### Rake Tasks
+
+```bash
+# Show daily usage report
+rake claude_usage:daily
+
+# Show total usage
+rake claude_usage:total
+
+# Clear pricing cache
+rake claude_usage:clear_cache
+
+# Show which project is being tracked and list all available projects
+rake claude_usage:show_project
+
+# Debug pricing issues (helps diagnose $0 cost problems)
+rake claude_usage:debug_pricing
+```
+
+### Programmatic Access
+
+```ruby
+# In your Rails app
+aggregator = ClaudeUsage::UsageAggregator.new
+totals = aggregator.total_usage
+daily = aggregator.daily_usage
+
+# Access specific data
+puts "Total cost: $#{totals[:total_cost]}"
+puts "Total tokens: #{totals[:total_tokens]}"
+puts "Models used: #{totals[:models_used].join(', ')}"
+```
+
+## Configuration
+
+You can customize the behavior in `config/initializers/claude_usage.rb`:
+
+```ruby
+ClaudeUsage.configure do |config|
+  # Project name - defaults to Rails.root.basename
+  config.project_name = "my-rails-app"
+
+  # Custom Claude paths (optional)
+  config.claude_paths = [
+    File.expand_path("~/.config/claude/projects"),
+    File.expand_path("~/.claude/projects")
+  ]
+
+  # Pricing cache expiry (default: 1 hour)
+  config.cache_expiry = 1.hour
+
+  # Offline mode (use cached pricing only)
+  config.offline_mode = false
+end
+```
+
+### Configuration Options
+
+- **`project_name`** - The Claude Code project name to track (defaults to Rails app name)
+- **`claude_paths`** - Array of paths to search for Claude Code logs
+- **`cache_expiry`** - How long to cache LiteLLM pricing data (default: 1 hour)
+- **`offline_mode`** - Use only cached pricing data without fetching from API
+
+## How It Works
+
+1. **Reads JSONL Files** - Scans `~/.config/claude/projects/{project_name}/` for usage logs
+2. **Fetches Pricing** - Gets current pricing from [LiteLLM](https://github.com/BerriAI/litellm)
+3. **Calculates Costs** - Applies tiered pricing (200k+ tokens) and cache pricing
+4. **Displays Results** - Shows usage in web UI, JSON API, or CLI
+
+## Data Location
+
+Claude Code stores usage data at:
+```
+~/.config/claude/projects/{your-project-name}/{sessionId}.jsonl
+```
+
+The gem automatically detects your Rails app name and looks for matching Claude Code projects.
+
+**Troubleshooting:** If no data is found, see [TROUBLESHOOTING.md](TROUBLESHOOTING.md) for detailed solutions.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shoebtamboli/claude_usage. 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/Shoebtamboli/claude_usage/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 ClaudeUsage project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Shoebtamboli/claude_usage/blob/main/CODE_OF_CONDUCT.md).
+
+## Acknowledgments
+
+- Pricing data from [LiteLLM](https://github.com/BerriAI/litellm)
+- Inspired by the need to track AI development costs
+
+## Support
+
+If you find this gem useful, please consider:
+- ⭐ Starring the repository
+- 🐛 Reporting bugs
+- 💡 Suggesting new features
+- 🤝 Contributing code
+
+---
+
+Made with ❤️ for Rails developers using Claude Code

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/controllers/claude_usage/application_controller.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ClaudeUsage
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+
+    # Optional: Add authentication
+    # before_action :authenticate_user!
+    # before_action :authorize_admin!
+  end
+end

data/app/controllers/claude_usage/usage_controller.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module ClaudeUsage
+  class UsageController < ApplicationController
+    def index
+      load_usage_data
+      @error = nil
+    rescue StandardError => e
+      @error = sanitize_error_message(e)
+      @daily_usage = []
+      @totals = {}
+      log_error(e)
+    end
+
+    def show_json
+      load_usage_data
+      data = {
+        daily: @daily_usage,
+        totals: @totals,
+        timestamp: Time.current
+      }
+      render json: data
+    rescue StandardError => e
+      log_error(e)
+      render json: { error: sanitize_error_message(e) }, status: :internal_server_error
+    end
+
+    private
+
+    def load_usage_data
+      @aggregator = UsageAggregator.new
+      @daily_usage = @aggregator.daily_usage
+      @totals = @aggregator.total_usage
+    end
+
+    def sanitize_error_message(exception)
+      # Return user-friendly messages without exposing internal details
+      case exception
+      when FileReader::InvalidProjectNameError
+        exception.message
+      when JSON::ParserError
+        'Error parsing usage data. Please check your Claude usage files.'
+      when Errno::ENOENT, Errno::EACCES
+        'Unable to access usage data files. Please check file permissions.'
+      else
+        'An error occurred while loading usage data. Please try again later.'
+      end
+    end
+
+    def log_error(exception)
+      Rails.logger.error("ClaudeUsage Error: #{exception.class} - #{exception.message}")
+      Rails.logger.error(exception.backtrace.join("\n")) if exception.backtrace
+    end
+  end
+end

data/app/helpers/claude_usage/usage_helper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ClaudeUsage
+  module UsageHelper
+    # Format a number with comma separators
+    def format_number(number)
+      ClaudeUsage::Formatters.format_number(number)
+    end
+
+    # Format a dollar amount
+    def format_currency(amount)
+      ClaudeUsage::Formatters.format_currency(amount)
+    end
+
+    # Format a percentage
+    def format_percentage(decimal)
+      ClaudeUsage::Formatters.format_percentage(decimal)
+    end
+  end
+end