cloudflare-d1 0.1.0

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-12-20
+
+### Added
+
+- ActiveRecord adapter for Cloudflare D1
+- Sequel adapter for Cloudflare D1
+- HTTP client for D1 REST API
+- Database management (create, delete, list databases)
+- Rake tasks for ActiveRecord migrations
+- Rake tasks for Sequel migrations
+- Local development support with SQLite
+- Roda + Cloudflare Containers example
+- Complete test suite (89 tests, 172 assertions)
+- CI/CD with GitHub Actions
+- Automated gem releases

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 ben@dee.mx. 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/DATABASE_MANAGEMENT.md

@@ -0,0 +1,365 @@
+# Database Management
+
+This document explains how to create, manage, and migrate Cloudflare D1 databases using both ActiveRecord and Sequel.
+
+## ActiveRecord (Rails)
+
+### Configuration
+
+Add to your `config/database.yml`:
+
+```yaml
+development:
+  adapter: cloudflare_d1
+  account_id: <%= ENV['CLOUDFLARE_ACCOUNT_ID'] %>
+  api_token: <%= ENV['CLOUDFLARE_API_TOKEN'] %>
+  database_id: <%= ENV['DATABASE_ID'] %>  # UUID of your D1 database
+```
+
+Or use environment variables:
+```bash
+export CLOUDFLARE_ACCOUNT_ID=your_account_id
+export CLOUDFLARE_API_TOKEN=your_api_token
+export DATABASE_ID=your_database_uuid
+```
+
+### Available Rake Tasks
+
+#### Create Database
+
+```bash
+# For Rails applications
+rake db:create
+```
+
+This will create a new D1 database and return its UUID. Add the UUID to your `database.yml` or environment variables.
+
+#### Drop Database
+
+```bash
+rake db:drop
+```
+
+Deletes the D1 database. **This is irreversible!**
+
+#### List Databases
+
+```bash
+rake db:list
+```
+
+Shows all D1 databases in your Cloudflare account.
+
+#### Run Migrations
+
+```bash
+# Run all pending migrations
+rake db:migrate
+
+# Run migrations with verbose output
+VERBOSE=true rake db:migrate
+```
+
+#### Rollback Migrations
+
+```bash
+# Rollback one migration
+rake db:rollback
+
+# Rollback multiple migrations
+rake db:rollback STEP=3
+```
+
+#### Migration Status
+
+```bash
+rake db:migrate_status
+```
+
+Shows which migrations have been applied.
+
+#### Reset Database
+
+```bash
+# Drop, create, and migrate (WARNING: destroys all data!)
+rake db:reset
+```
+
+#### Setup Database
+
+```bash
+# Create and migrate (for initial setup)
+rake db:setup
+```
+
+### Creating Migrations
+
+Use standard Rails migration generators:
+
+```bash
+rails generate migration CreateUsers email:string
+rails generate migration AddIndexToUsers email:index
+```
+
+Example migration:
+
+```ruby
+class CreateUsers < ActiveRecord::Migration[7.0]
+  def change
+    create_table :users do |t|
+      t.string :email, null: false
+      t.timestamps
+    end
+
+    add_index :users, :email, unique: true
+  end
+end
+```
+
+### Limitations
+
+- **No DDL transactions**: Schema changes are not wrapped in transactions
+- **No savepoints**: Transaction savepoints are not supported
+- **No concurrent migrations**: Each migration runs as separate HTTP requests
+
+## Sequel
+
+### Configuration
+
+Connect using a URL or hash:
+
+```ruby
+# Using URL
+DB = Sequel.connect(
+  "cloudflare_d1://",
+  adapter: :cloudflare_d1,
+  account_id: ENV['CLOUDFLARE_ACCOUNT_ID'],
+  api_token: ENV['CLOUDFLARE_API_TOKEN'],
+  database: ENV['DATABASE_ID']
+)
+
+# Or using hash
+DB = Sequel.connect(
+  adapter: :cloudflare_d1,
+  account_id: ENV['CLOUDFLARE_ACCOUNT_ID'],
+  api_token: ENV['CLOUDFLARE_API_TOKEN'],
+  database: ENV['DATABASE_ID']
+)
+```
+
+### Available Rake Tasks
+
+All Sequel tasks are under the `sequel:db` namespace:
+
+#### Create Database
+
+```bash
+DATABASE_NAME=my_app_db rake sequel:db:create
+```
+
+#### Drop Database
+
+```bash
+DATABASE_ID=your_database_uuid rake sequel:db:drop
+```
+
+#### List Databases
+
+```bash
+rake sequel:db:list
+```
+
+#### Run Migrations
+
+```bash
+# Run all migrations
+DATABASE_URL=cloudflare_d1://your_database_uuid rake sequel:db:migrate
+
+# Run to specific version
+DATABASE_URL=cloudflare_d1://your_database_uuid rake sequel:db:migrate[42]
+
+# Custom migrations path
+MIGRATIONS_PATH=db/migrations DATABASE_URL=... rake sequel:db:migrate
+```
+
+#### Rollback Migrations
+
+```bash
+# Rollback one migration
+DATABASE_URL=... rake sequel:db:rollback
+
+# Rollback multiple migrations
+DATABASE_URL=... rake sequel:db:rollback[3]
+```
+
+#### Migration Status
+
+```bash
+DATABASE_URL=... rake sequel:db:status
+```
+
+#### Reset Database
+
+```bash
+DATABASE_URL=... rake sequel:db:reset
+```
+
+#### Setup Database
+
+```bash
+DATABASE_NAME=my_app_db DATABASE_URL=... rake sequel:db:setup
+```
+
+### Creating Migrations
+
+Create migration files in `db/migrations/` with format: `001_description.rb`
+
+```ruby
+# db/migrations/001_create_users.rb
+Sequel.migration do
+  up do
+    create_table(:users) do
+      primary_key :id
+      String :email, null: false, unique: true
+      DateTime :created_at
+      DateTime :updated_at
+    end
+  end
+
+  down do
+    drop_table(:users)
+  end
+end
+```
+
+Or use the `change` method for reversible migrations:
+
+```ruby
+# db/migrations/002_add_name_to_users.rb
+Sequel.migration do
+  change do
+    alter_table(:users) do
+      add_column :name, String
+    end
+  end
+end
+```
+
+### Running Migrations from Command Line
+
+```bash
+sequel -m db/migrations cloudflare_d1://your_database_uuid
+```
+
+### Limitations
+
+- **No transactions**: Migrations run without transaction support
+- **No concurrent access**: Each operation is a separate HTTP request
+- **No connection pooling**: API-based connections don't benefit from traditional pooling
+
+## Environment Variables
+
+Both ActiveRecord and Sequel tasks require:
+
+```bash
+export CLOUDFLARE_ACCOUNT_ID=your_account_id
+export CLOUDFLARE_API_TOKEN=your_api_token
+```
+
+For ActiveRecord:
+```bash
+export DATABASE_ID=your_database_uuid
+```
+
+For Sequel:
+```bash
+export DATABASE_URL=cloudflare_d1://your_database_uuid
+export DATABASE_NAME=my_app_db  # Only for creation
+export MIGRATIONS_PATH=db/migrations  # Optional, defaults to db/migrations
+```
+
+## Best Practices
+
+### 1. Database Creation
+
+Always note the UUID returned when creating a database:
+
+```bash
+$ rake db:create
+Created database: my_app_db (a1b2c3d4-e5f6-7890-abcd-ef1234567890)
+
+Add this to your database.yml:
+  database_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
+```
+
+### 2. Migration Safety
+
+Since D1 doesn't support DDL transactions, test migrations carefully:
+
+- Use staging databases for testing
+- Backup important data before migrations (export via queries)
+- Write reversible migrations with both `up` and `down` methods
+
+### 3. Schema Changes
+
+Some operations are not reversible in SQLite:
+- Dropping columns (SQLite doesn't support `DROP COLUMN`)
+- Changing column types (requires table recreation)
+- Renaming columns (requires table recreation)
+
+For these, write explicit `up` and `down` methods.
+
+### 4. Connection Configuration
+
+Store credentials securely:
+- Use environment variables (never commit API tokens)
+- Use Rails credentials or encrypted secrets
+- Restrict API token permissions to only D1 databases
+
+## Troubleshooting
+
+### "database_id is required"
+
+Make sure your configuration includes the UUID:
+
+```yaml
+# database.yml
+database_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
+```
+
+Or set environment variable:
+```bash
+export DATABASE_ID=a1b2c3d4-e5f6-7890-abcd-ef1234567890
+```
+
+### "Real HTTP connections are disabled"
+
+In test environment with WebMock, stub the D1 API calls:
+
+```ruby
+stub_request(:post, /api.cloudflare.com/)
+  .to_return(status: 200, body: { success: true, result: [...] }.to_json)
+```
+
+### "Table already exists"
+
+Drop and recreate the database, or use migrations to detect existing tables:
+
+```ruby
+create_table?(:users) do  # ? makes it conditional
+  # ...
+end
+```
+
+## API Rate Limits
+
+Cloudflare D1 API has rate limits:
+- Migrations run sequentially (one HTTP request per SQL statement)
+- Large migrations may take time
+- Consider batching operations when possible
+
+## See Also
+
+- [Cloudflare D1 Documentation](https://developers.cloudflare.com/d1/)
+- [ActiveRecord Migrations Guide](https://guides.rubyonrails.org/active_record_migrations.html)
+- [Sequel Migrations Documentation](https://sequel.jeremyevans.net/rdoc/files/doc/migration_rdoc.html)

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Ben
+
+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.