attio-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 326cdb48011eef91cec7539a0392807c05ac2b1d4934dfb307760e76d8dfea57
+  data.tar.gz: 0b6b51c04055d87a0f5415e16d51c4aba68d570d73ba3b4ccca61ea52a35a31c
+SHA512:
+  metadata.gz: 44a37aba1c6f0372d3acf61bdf3aaf46a9a3424949baaf7edad6ab71a4b21949afcf38598644530eedace80b443f3bcc5d78706d6465dcc57a4a707db1c23529
+  data.tar.gz: 0ddda37466544f419d441f33f85048307c37c94701c6890fb5c19470a869952b5f68f7d9a0267f367d88791bd900d1ac1471b1f157a376aac666618528f7e135

data/.github/dependabot.yml

@@ -0,0 +1,42 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "09:00"
+    open-pull-requests-limit: 10
+    reviewers:
+      - "ernestsim"
+    assignees:
+      - "ernestsim"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+    labels:
+      - "dependencies"
+      - "ruby"
+    ignore:
+      - dependency-name: "rails"
+        update-types: ["version-update:semver-major"]
+      - dependency-name: "ruby"
+        update-types: ["version-update:semver-major"]
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "09:00"
+    open-pull-requests-limit: 5
+    reviewers:
+      - "ernestsim"
+    assignees:
+      - "ernestsim"
+    commit-message:
+      prefix: "ci"
+      include: "scope"
+    labels:
+      - "dependencies"
+      - "github-actions"

data/.github/workflows/ci.yml

@@ -0,0 +1,74 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['3.0', '3.1', '3.2', '3.3']
+        rails-version: ['6.1', '7.0', '7.1']
+        exclude:
+          - ruby-version: '3.0'
+            rails-version: '7.1'
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    
+    - name: Install Rails ${{ matrix.rails-version }}
+      run: |
+        gem install rails -v "~> ${{ matrix.rails-version }}.0"
+        bundle update rails
+    
+    - name: Run tests
+      run: bundle exec rspec
+    
+    - name: Upload coverage reports
+      if: matrix.ruby-version == '3.2' && matrix.rails-version == '7.1'
+      uses: codecov/codecov-action@v3
+      with:
+        file: ./coverage/coverage.xml
+        flags: unittests
+        name: codecov-umbrella
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.2'
+        bundler-cache: true
+    
+    - name: Run RuboCop
+      run: bundle exec rubocop --format github
+
+  security:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.2'
+        bundler-cache: true
+    
+    - name: Run security audit
+      run: |
+        gem install bundler-audit
+        bundle audit check --update

data/.github/workflows/docs.yml

@@ -0,0 +1,51 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.2'
+        bundler-cache: true
+
+    - name: Setup Pages
+      uses: actions/configure-pages@v4
+
+    - name: Generate documentation
+      run: |
+        bundle exec rake yard:gh_pages
+
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: docs
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

data/.github/workflows/release.yml

@@ -0,0 +1,70 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    
+    permissions:
+      contents: write
+      packages: write
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.2'
+        bundler-cache: true
+
+    - name: Configure gem credentials
+      run: |
+        mkdir -p ~/.gem
+        cat > ~/.gem/credentials << EOF
+        ---
+        :rubygems_api_key: ${{ secrets.RUBYGEMS_API_KEY }}
+        EOF
+        chmod 0600 ~/.gem/credentials
+
+    - name: Run tests
+      run: |
+        bundle exec rspec
+        bundle exec rubocop
+
+    - name: Generate documentation
+      run: bundle exec rake yard
+
+    - name: Build gem
+      run: bundle exec rake build
+
+    - name: Publish to RubyGems
+      run: bundle exec rake release
+
+    - name: Create GitHub Release
+      uses: softprops/action-gh-release@v1
+      with:
+        files: pkg/*.gem
+        generate_release_notes: true
+        draft: false
+        prerelease: ${{ contains(github.ref_name, 'pre') || contains(github.ref_name, 'rc') || contains(github.ref_name, 'alpha') || contains(github.ref_name, 'beta') }}
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Update GitHub Pages with documentation
+      run: |
+        git config --local user.email "action@github.com"
+        git config --local user.name "GitHub Action"
+        git checkout --orphan gh-pages
+        git rm -rf .
+        cp -r docs/* .
+        git add -A
+        git commit -m "Update documentation for ${{ github.ref_name }}"
+        git push origin gh-pages --force

data/.gitignore

@@ -0,0 +1,60 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Documentation
+/doc/
+/docs/yard/
+/.yardoc/
+/_yardoc/
+/rdoc/
+
+# Bundler
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+.rvmrc
+
+# IDE
+/.idea/
+/.vscode/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Test artifacts
+/spec/dummy/log/*.log
+/spec/dummy/tmp/
+/spec/dummy/db/*.sqlite3
+/spec/dummy/db/*.sqlite3-journal
+/spec/dummy/public/system
+/spec/dummy/coverage/
+/spec/dummy/node_modules/
+/spec/dummy/yarn-error.log
+/spec/dummy/storage/
+/spec/dummy/public/packs
+/spec/dummy/public/packs-test
+
+# Environment
+.env
+.env.local
+.env.*.local
+
+# Logs
+*.log
+
+# Cache
+.sass-cache/
+.cache/

data/.rspec

@@ -0,0 +1,4 @@
+--require spec_helper
+--color
+--format documentation
+--order random

data/.rubocop.yml

@@ -0,0 +1,65 @@
+require:
+  - rubocop-rspec
+  - rubocop-rails
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  Exclude:
+    - 'bin/**/*'
+    - 'db/**/*'
+    - 'vendor/**/*'
+    - 'spec/dummy/**/*'
+    - 'node_modules/**/*'
+    - 'tmp/**/*'
+    - '.git/**/*'
+
+# Style
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+# Layout
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*'
+
+# Metrics
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+    - 'lib/generators/**/*'
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/AbcSize:
+  Max: 20
+
+# Rails specific
+Rails/ApplicationRecord:
+  Exclude:
+    - 'spec/dummy/**/*'
+
+Rails/SkipsModelValidations:
+  Enabled: false
+
+# RSpec specific
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/MultipleExpectations:
+  Max: 3
+
+RSpec/NestedGroups:
+  Max: 3

data/.yardopts

@@ -0,0 +1,14 @@
+--output-dir docs/yard
+--markup markdown
+--markup-provider redcarpet
+--charset utf-8
+--no-private
+--embed-mixins
+--readme README.md
+--title "Attio Rails Integration Documentation"
+--main README.md
+--files CHANGELOG.md,CONTRIBUTING.md
+lib/**/*.rb
+-
+CHANGELOG.md
+CONTRIBUTING.md

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+# 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.0] - 2025-01-11
+
+### Added
+- Initial release of Attio Rails integration gem
+- ActiveRecord concern `Attio::Rails::Syncable` for model synchronization
+- Rails generator for initial setup (`rails generate attio:install`)
+- ActiveJob integration for async syncing
+- Configuration management through Rails config
+- Support for Rails 6.1, 7.0, and 7.1
+- Comprehensive test suite with dummy Rails app
+- Full documentation with YARD
+- CI/CD setup with GitHub Actions
+
+### Features
+- Automatic syncing of ActiveRecord models to Attio
+- Configurable attribute mapping
+- Support for callbacks (before_sync, after_sync)
+- Error handling and retry logic
+- Batch operations support
+- Custom field transformations
+
+[Unreleased]: https://github.com/idl3/attio-rails/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/idl3/attio-rails/releases/tag/v0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,37 @@
+# Code of Conduct
+
+## Our Pledge
+
+We pledge to make participation in our project a respectful and professional experience for everyone.
+
+## Our Standards
+
+Examples of positive behavior include:
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints
+* Gracefully accepting constructive feedback
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior include:
+* Unprofessional or unwelcome comments
+* Personal attacks
+* Public or private harassment
+* Publishing others' private information without permission
+* Other conduct which could reasonably be considered inappropriate
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying standards of acceptable behavior and are expected to take appropriate corrective action in response to unacceptable behavior.
+
+## Scope
+
+This Code of Conduct applies within project spaces and in public spaces when representing the project.
+
+## Enforcement
+
+Instances of unacceptable behavior may be reported to the project team. All complaints will be reviewed and investigated promptly and fairly.
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 2.0.

data/CONTRIBUTING.md

@@ -0,0 +1,241 @@
+# Contributing to Attio Rails
+
+Thank you for your interest in contributing to the Attio Rails integration gem! This guide will help you get started.
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+- [Development Setup](#development-setup)
+- [Testing with Rails](#testing-with-rails)
+- [Submitting Changes](#submitting-changes)
+- [Rails-Specific Guidelines](#rails-specific-guidelines)
+
+## Getting Started
+
+1. Fork the repository on GitHub
+2. Clone your fork locally:
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/attio-rails.git
+   cd attio-rails
+   ```
+3. Add the upstream remote:
+   ```bash
+   git remote add upstream https://github.com/idl3/attio-rails.git
+   ```
+
+## Development Setup
+
+1. Install Ruby 3.0 or higher
+2. Install dependencies:
+   ```bash
+   bundle install
+   ```
+3. Set up the test Rails app:
+   ```bash
+   cd spec/dummy
+   bundle install
+   rails db:create db:migrate
+   cd ../..
+   ```
+4. Run tests:
+   ```bash
+   bundle exec rspec
+   ```
+
+### Testing Different Rails Versions
+
+To test with different Rails versions:
+
+```bash
+# Test with Rails 7.1
+RAILS_VERSION=7.1 bundle update
+bundle exec rspec
+
+# Test with Rails 7.0
+RAILS_VERSION=7.0 bundle update
+bundle exec rspec
+
+# Test with Rails 6.1
+RAILS_VERSION=6.1 bundle update
+bundle exec rspec
+```
+
+## Testing with Rails
+
+### Writing Rails-Specific Tests
+
+When adding new features, ensure you test:
+
+1. **Generator Tests**: If adding generators
+   ```ruby
+   require "generators/attio/install/install_generator"
+   
+   RSpec.describe Attio::Generators::InstallGenerator do
+     # Test generator behavior
+   end
+   ```
+
+2. **Model Concern Tests**: For ActiveRecord integrations
+   ```ruby
+   RSpec.describe "Attio::Rails::Syncable" do
+     let(:model) { User.new }
+     # Test concern behavior
+   end
+   ```
+
+3. **Railtie Tests**: For Rails integration points
+   ```ruby
+   RSpec.describe Attio::Rails::Railtie do
+     # Test Rails configuration
+   end
+   ```
+
+### Testing with Dummy Rails App
+
+The gem includes a dummy Rails app in `spec/dummy` for integration testing:
+
+```bash
+cd spec/dummy
+rails console  # Test your changes interactively
+rails server   # Run the dummy app
+```
+
+## Submitting Changes
+
+### Before Submitting
+
+1. Create a feature branch:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. Make your changes following Rails conventions
+
+3. Write or update tests
+
+4. Update documentation
+
+5. Run the full test suite:
+   ```bash
+   bundle exec rspec
+   bundle exec rubocop
+   ```
+
+6. Update CHANGELOG.md
+
+### Commit Messages
+
+Use conventional commits:
+- `feat:` New features
+- `fix:` Bug fixes
+- `docs:` Documentation
+- `test:` Test changes
+- `chore:` Maintenance
+
+Examples:
+```
+feat: add ActiveJob integration for async syncing
+fix: handle Rails 7.1 deprecations
+docs: add Rails 6.1 migration guide
+```
+
+## Rails-Specific Guidelines
+
+### Following Rails Conventions
+
+1. **Generators**: Follow Rails generator conventions
+   - Use Thor for generator implementation
+   - Provide clear descriptions
+   - Support Rails conventions (--skip flags, etc.)
+
+2. **Concerns**: Design reusable concerns
+   - Keep concerns focused and single-purpose
+   - Document required methods
+   - Provide clear examples
+
+3. **Configuration**: Use Rails configuration patterns
+   ```ruby
+   Rails.application.configure do
+     config.attio.api_key = ENV['ATTIO_API_KEY']
+   end
+   ```
+
+4. **ActiveRecord Integration**:
+   - Follow ActiveRecord callback conventions
+   - Support Rails validations
+   - Integrate with Rails error handling
+
+### Rails Version Compatibility
+
+- Maintain compatibility with Rails 6.1+
+- Test against multiple Rails versions
+- Document version-specific features
+- Handle deprecations gracefully
+
+### Performance Considerations
+
+- Use Rails caching when appropriate
+- Leverage ActiveJob for background processing
+- Optimize database queries
+- Consider connection pooling
+
+## Code Organization
+
+```
+lib/
+├── attio/
+│   ├── rails.rb              # Main module
+│   ├── rails/
+│   │   ├── version.rb         # Version constant
+│   │   ├── railtie.rb         # Rails integration
+│   │   ├── configuration.rb   # Config management
+│   │   └── concerns/          # Model concerns
+│   │       └── syncable.rb
+└── generators/                # Rails generators
+    └── attio/
+        └── install/
+            ├── install_generator.rb
+            └── templates/
+```
+
+## Testing Requirements
+
+- Write tests for all new features
+- Maintain test coverage above 85%
+- Test with multiple Rails versions
+- Include integration tests with dummy app
+- Test generators with Rails test helpers
+
+## Documentation
+
+### YARD Documentation
+
+Document Rails-specific features:
+
+```ruby
+# Syncs the model with Attio
+#
+# @example Basic usage
+#   class User < ApplicationRecord
+#     include Attio::Rails::Syncable
+#     
+#     attio_syncable object: 'people',
+#                    attributes: [:email, :name]
+#   end
+#
+# @param options [Hash] sync configuration
+# @option options [String] :object Attio object type
+# @option options [Array] :attributes Attributes to sync
+def attio_syncable(**options)
+  # implementation
+end
+```
+
+## Getting Help
+
+- Check [Rails Guides](https://guides.rubyonrails.org/) for Rails conventions
+- Review the [main Attio gem](https://github.com/idl3/attio) documentation
+- Open an issue for questions
+- Join discussions on GitHub
+
+Thank you for contributing to Attio Rails!