attio 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bc8e8104ce0d509fd592dbcfe3d7203998db7ea38352a40162e6a8e8e92f470
-  data.tar.gz: dd0bac00b8534523bf20f82238cd404cdc8f0ca0929b46a62be0137799d7aec2
+  metadata.gz: f2af7d69dcfda391c606d9d55ea6acfa950a2bce2271d6f867acdfa9b40ce269
+  data.tar.gz: f8387f9aaf8779af723ebe6a30279a0a8affb639e27aad4089f8353a3687f14a
 SHA512:
-  metadata.gz: 6413a664b4197e85df9a71caf88bb8f322b17cd330d3c39cbf77666eca06d337f0094781a2207d26fa7e0d2c1cf2eb3178d2a8c2eaf3b4b08708b25ea1f71369
-  data.tar.gz: 3f240f41215b4713c01a95c61e5076be16ee9702d9c95c997ef3bf009766acb7e1ccc6a245cb35f161f32cb29afcc26ff726c36970c06e5cedc223445f4e479a
+  metadata.gz: 11fbb524075e860b1c28e01f11b67ae6c28719f4e54a904fe026feabfd41f3f81ed9fe94b13a32228eb377f7125226fca92eb4cb031b260d283d3a03f67c0c8b
+  data.tar.gz: 4f813c14359415e5ca478ca429e7624798f778d040e2d317a50a4538cc4feffdea0b5b65e9cbe7c98a76a1124cd600bbf5914e0f365bde3dfbd514d6ec0b7414

data/.github/workflows/release.yml

@@ -72,13 +72,9 @@ jobs:
         echo "GEM_FILE=$(ls attio-*.gem)" >> $GITHUB_ENV
 
     - name: Publish to RubyGems
+      env:
+        GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_AUTH_TOKEN }}
       run: |
-        mkdir -p ~/.gem
-        cat << 'EOF' > ~/.gem/credentials
-        ---
-        :rubygems_api_key: ${{ secrets.RUBYGEMS_API_KEY }}
-        EOF
-        chmod 0600 ~/.gem/credentials
         gem push ${{ env.GEM_FILE }}
 
     - name: Generate changelog
@@ -118,48 +114,4 @@ jobs:
         upload_url: ${{ steps.create_release.outputs.upload_url }}
         asset_path: ${{ env.GEM_FILE }}
         asset_name: ${{ env.GEM_FILE }}
-        asset_content_type: application/x-tar
-
-  update-docs:
-    needs: [test, build-and-publish]
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-
-    steps:
-    - uses: actions/checkout@v4
-      with:
-        token: ${{ secrets.GITHUB_TOKEN }}
-        ref: main
-
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: '3.4'
-        bundler-cache: false
-    
-    - name: Install dependencies
-      run: |
-        gem install bundler -v 2.4.22
-        bundle config set --local deployment false
-        bundle install
-
-    - name: Extract version from tag
-      id: version
-      run: echo "version=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
-
-    - name: Generate documentation
-      run: |
-        bundle exec rake docs:generate
-
-    - name: Commit and push documentation
-      run: |
-        git config --local user.email "action@github.com"
-        git config --local user.name "GitHub Action"
-        git add docs/
-        if ! git diff --staged --quiet; then
-          git commit -m "Update documentation for release ${{ steps.version.outputs.version }}"
-          git push
-        else
-          echo "No documentation changes to commit"
-        fi
+        asset_content_type: application/x-tar

data/CHANGELOG.md

@@ -5,7 +5,68 @@ 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.3.0] - 2025-08-11
+
+### Added
+- **Workspace Members** resource for managing workspace access and permissions
+- **Deals** resource for sales pipeline management with win/loss tracking
+- **Meta API** resource for workspace identification and usage statistics
+- **Bulk Operations** with automatic batching (100 records per batch)
+- **Rate Limiting** with exponential backoff and request queuing
+- **SSL/TLS verification** for enhanced security
+- **Enhanced error classes** with proper attributes (retry_after for RateLimitError)
+- **Thread-safe rate limiter** implementation
+- Comprehensive architectural documentation in CONCEPTS.md
+- Development guidelines in CLAUDE.md
+- 116 new tests (392 total, up from 265)
+
+### Improved
+- **Security**: Added explicit SSL verification and disabled automatic redirects
+- **Thread Safety**: Fixed race conditions in rate limiter
+- **Code Quality**: Achieved 0 RuboCop violations (previously 6)
+- **Test Coverage**: 99.86% (718/719 lines)
+- **Performance**: Optimized bulk operations with efficient batching
+- **Validation**: Enhanced input validation to prevent injection attacks
+- **Documentation**: Updated README with comprehensive API coverage
+
+### Fixed
+- Thread safety issues in RateLimiter#update_from_headers
+- Complex validation methods refactored to reduce cyclomatic complexity
+- validate_required_hash now properly handles nil values
+- Removed unused api_key parameter from Meta#validate_key
+- Fixed conditional validation in Deals#create
+
+### Changed
+- **BREAKING**: Error messages for nil validation now say "must be a hash" instead of "is required"
+- RateLimitMiddleware simplified to avoid private method calls
+- Base resource class validation methods extracted for reusability
+
+## [0.2.0] - 2025-08-11
+
+### Added
+- Comments resource with full CRUD operations and emoji reactions
+- Threads resource with participant management and status control
+- Tasks resource with assignment and completion tracking
+- Notes resource for creating and managing notes on records
+- DELETE with body support in HttpClient for participant management
+- URL encoding for emoji reactions using CGI.escape
+- Comprehensive examples for collaboration features
+- Advanced filtering and querying examples
+- Complete CRM workflow example
+
+### Improved
+- Achieved 100% test coverage (376/376 lines)
+- Increased test count from 147 to 265 tests
+- Refactored Base class to reduce code duplication across resources
+- Extracted common validation methods to base class
+- Standardized error messages across all resources
+- Fixed keyword arguments vs options hash issues in test mocks
+- Updated README with all new features and comprehensive examples
+
+### Fixed
+- Semantic correctness in all test files
+- REST convention compliance for DELETE operations
+- Proper URL encoding for special characters in API paths
 
 ## [0.1.3] - 2025-08-11
 

data/CLAUDE.md

@@ -0,0 +1,360 @@
+# Claude Development Guidelines for Attio Ruby Gem
+
+This document contains important guidelines for Claude (or any AI assistant) when working on the Attio Ruby gem. Following these guidelines ensures high-quality, consistent, and production-ready code.
+
+## Pre-Release Checklist
+
+**IMPORTANT**: Before creating any release tag or pushing to master, ALWAYS complete this checklist:
+
+### 1. Code Quality
+- [ ] Run RuboCop and fix all violations: `bundle exec rubocop -A`
+- [ ] Ensure no RuboCop offenses remain
+- [ ] Run all tests: `bundle exec rspec`
+- [ ] Verify 100% test coverage: Check SimpleCov output
+- [ ] Update version in `lib/attio/version.rb`
+- [ ] Update CHANGELOG.md with release date
+
+### 2. Testing Commands
+```bash
+# Run all tests
+bundle exec rspec
+
+# Run tests with coverage report
+COVERAGE=true bundle exec rspec
+
+# Run specific test file
+bundle exec rspec spec/attio/resources/comments_spec.rb
+
+# Run RuboCop
+bundle exec rubocop
+
+# Auto-fix RuboCop violations
+bundle exec rubocop -A
+
+# Check for outdated gems
+bundle outdated
+```
+
+### 3. Documentation
+- [ ] Update README.md with new features
+- [ ] Add/update YARD documentation for new methods
+- [ ] Create example files for new features
+- [ ] Update API coverage section in README
+- [ ] Ensure all public methods have proper documentation
+
+### 4. Git Commit Standards
+
+#### Commit Message Format
+```
+<type>: <subject>
+
+<body>
+
+🤖 Generated with [Claude Code](https://claude.ai/code)
+
+Co-Authored-By: Claude <noreply@anthropic.com>
+```
+
+#### Commit Types
+- `feat`: New feature
+- `fix`: Bug fix
+- `docs`: Documentation only changes
+- `style`: Code style changes (formatting, missing semi-colons, etc)
+- `refactor`: Code refactoring
+- `test`: Adding or updating tests
+- `chore`: Maintenance tasks
+- `ci`: CI/CD changes
+
+#### Examples
+```bash
+git commit -m "feat: Add Comments resource with emoji reactions
+
+- Implement full CRUD operations for comments
+- Add support for emoji reactions with proper URL encoding
+- Include comprehensive test coverage
+
+🤖 Generated with [Claude Code](https://claude.ai/code)
+
+Co-Authored-By: Claude <noreply@anthropic.com>"
+```
+
+## Development Guidelines
+
+### 1. Test-Driven Development (TDD)
+- Write tests FIRST before implementing features
+- Ensure semantic correctness in all tests
+- Use `instance_double` for type safety in RSpec
+- Mock external API calls appropriately
+- Achieve and maintain 100% test coverage
+
+### 2. Code Organization
+```
+lib/attio/
+├── resources/
+│   ├── base.rb          # Base class with common functionality
+│   ├── comments.rb      # Resource-specific implementation
+│   └── ...
+├── client.rb            # Main client class
+├── http_client.rb       # HTTP handling
+├── errors.rb           # Error classes
+└── version.rb          # Version constant
+
+spec/attio/
+├── resources/          # Resource-specific tests
+├── client_spec.rb      # Client tests
+└── http_client_spec.rb # HTTP client tests
+```
+
+### 3. Resource Implementation Pattern
+
+When implementing a new resource:
+
+```ruby
+# lib/attio/resources/new_resource.rb
+module Attio
+  module Resources
+    class NewResource < Base
+      def list(params = {})
+        # Implementation
+      end
+
+      def get(id:)
+        validate_id!(id, "NewResource")
+        # Implementation
+      end
+
+      def create(data:)
+        validate_required_hash!(data, "Data")
+        # Implementation
+      end
+
+      def update(id:, data:)
+        validate_id!(id, "NewResource")
+        validate_required_hash!(data, "Data")
+        # Implementation
+      end
+
+      def delete(id:)
+        validate_id!(id, "NewResource")
+        # Implementation
+      end
+    end
+  end
+end
+```
+
+### 4. Testing Pattern
+
+```ruby
+# spec/attio/resources/new_resource_spec.rb
+RSpec.describe Attio::Resources::NewResource do
+  let(:connection) { instance_double(Attio::HttpClient) }
+  let(:resource) { described_class.new(connection) }
+
+  describe "#list" do
+    it "lists all resources" do
+      expect(connection).to receive(:get)
+        .with("new_resources", {})
+        .and_return({ "data" => [] })
+      
+      result = resource.list
+      expect(result).to eq({ "data" => [] })
+    end
+  end
+
+  # Test all methods with edge cases
+end
+```
+
+### 5. Error Handling
+- Always validate required parameters
+- Use specific error classes (ValidationError, NotFoundError, etc.)
+- Provide clear, actionable error messages
+- Include parameter names in error messages
+
+### 6. API Design Principles
+- Use keyword arguments for clarity
+- Support optional parameters with defaults
+- Return full API response (don't extract data)
+- Maintain consistency across all resources
+
+## Common Pitfalls to Avoid
+
+### 1. Test Mocks
+```ruby
+# WRONG - Using keyword arguments in mock
+expect(connection).to receive(:get).with("comments", thread_id: "123")
+
+# CORRECT - Using hash as second argument
+expect(connection).to receive(:get).with("comments", { thread_id: "123" })
+```
+
+### 2. URL Encoding
+```ruby
+# WRONG - Direct string interpolation
+"comments/#{id}/reactions/#{emoji}"
+
+# CORRECT - Proper encoding for special characters
+"comments/#{id}/reactions/#{CGI.escape(emoji)}"
+```
+
+### 3. Validation
+```ruby
+# WRONG - No validation
+def get(id:)
+  request(:get, "resources/#{id}")
+end
+
+# CORRECT - Validate required parameters
+def get(id:)
+  validate_id!(id, "Resource")
+  request(:get, "resources/#{id}")
+end
+```
+
+## Release Process
+
+### 1. Pre-Release
+```bash
+# 1. Ensure all tests pass
+bundle exec rspec
+
+# 2. Check RuboCop
+bundle exec rubocop
+
+# 3. Update version
+# Edit lib/attio/version.rb
+
+# 4. Update CHANGELOG
+# Add release section with date
+
+# 5. Commit changes
+git add -A
+git commit -m "chore: Prepare release v0.2.0"
+```
+
+### 2. Create Release
+```bash
+# 1. Push to master
+git push origin master
+
+# 2. Create and push tag
+git tag -a v0.2.0 -m "Release v0.2.0"
+git push origin v0.2.0
+```
+
+### 3. Post-Release
+The CI/CD pipeline will automatically:
+- Run tests across Ruby 3.0-3.4
+- Build the gem
+- Publish to RubyGems (requires RUBYGEMS_AUTH_TOKEN secret)
+- Create GitHub release
+
+## RuboCop Configuration
+
+Key rules enforced:
+- Line length: 120 characters
+- Method length: 20 lines
+- Class length: 250 lines
+- Cyclomatic complexity: 10
+- ABC metric: 17
+- Use `dig` for nested hash access (except single argument)
+- Prefer string interpolation over concatenation
+- Use single quotes unless interpolation needed
+
+## Environment Setup
+
+### Ruby Version
+- Minimum: Ruby 3.0
+- Recommended: Ruby 3.4
+- CI tests on: 3.0, 3.1, 3.2, 3.3, 3.4
+
+### Bundler Version
+- Use bundler 2.4.22 for compatibility
+- Set in CI: `gem install bundler -v 2.4.22`
+
+### Development Dependencies
+```ruby
+# Gemfile
+group :development, :test do
+  gem "rspec", "~> 3.13"
+  gem "rubocop", "~> 1.50"
+  gem "rubocop-rspec", "~> 2.22"
+  gem "simplecov", "~> 0.22"
+  gem "webmock", "~> 3.18"
+  gem "yard", "~> 0.9"
+end
+```
+
+## API Coverage Tracking
+
+Maintain this list in README.md:
+
+- [x] Records - Full CRUD
+- [x] Objects - List, Get
+- [x] Lists - List, Get, Entries, Create/Delete Entry
+- [x] Comments - Full CRUD, Reactions
+- [x] Threads - Full CRUD, Participants, Status
+- [x] Tasks - Full CRUD, Assignment, Completion
+- [x] Notes - Full CRUD
+- [x] Workspaces - List, Get
+- [x] Attributes - List, Create, Update
+- [x] Users - List, Get
+
+## Quality Metrics to Maintain
+
+- **Test Coverage**: 100%
+- **Test Count**: 265+ tests
+- **RuboCop Offenses**: 0
+- **Documentation Coverage**: 100% for public methods
+- **Example Coverage**: Example for each major feature
+
+## Final Reminders
+
+1. **NEVER** push code with failing tests
+2. **NEVER** push code with RuboCop violations
+3. **ALWAYS** update documentation with new features
+4. **ALWAYS** maintain 100% test coverage
+5. **ALWAYS** run the full test suite before committing
+6. **ALWAYS** update the version and CHANGELOG for releases
+7. **NEVER** create git commits without the co-author attribution
+
+## Useful Commands Reference
+
+```bash
+# Build gem locally
+gem build attio.gemspec
+
+# Install gem locally
+gem install ./attio-0.2.0.gem
+
+# Test gem in IRB
+irb -r attio
+
+# Generate YARD documentation
+bundle exec yard doc
+
+# View YARD documentation
+bundle exec yard server
+
+# Run specific test with line number
+bundle exec rspec spec/attio/resources/comments_spec.rb:42
+
+# Check test coverage details
+open coverage/index.html
+
+# List all rake tasks
+bundle exec rake -T
+```
+
+## Contact for Issues
+
+If you encounter any issues or need clarification:
+1. Check existing issues on GitHub
+2. Review test files for usage examples
+3. Consult the API documentation
+4. Create a detailed issue with reproduction steps
+
+---
+
+**Remember**: Quality over speed. It's better to take time and deliver production-ready code than to rush and create technical debt.