followupboss_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f4e09dc895a09a254ed74cc7386a63c7d9e6fd4122c7aebe84a510111c79a44c
+  data.tar.gz: f2a2891e76c6ae01b836c70a56e0912327512b201639800eb591bfbc3f3552bb
+SHA512:
+  metadata.gz: fd32c62a15dd9de0dc40ebb494f681d8651dfda05aea30f3e3a3ecb96b308b17b1afc85ead1786660deac7d822d24a4e6a5390811a27a9e17b8bf3a0977581df
+  data.tar.gz: 211789660757346070247a8a2a8618d73f682e3f6ee7f6e8b34c55ac5e53cd4f8bdd62c71c26250ad704cde3f07a7c7b24a9792e9e932176d34cda980a559728

data/.env.example

@@ -0,0 +1,12 @@
+# FollowUpBoss API Credentials
+
+# API Key Authentication (for regular endpoints)
+FUB_API_KEY=your_api_key_here
+
+# Cookie-based Authentication (for shared inbox endpoints)
+FUB_EMAIL=your_email@example.com
+FUB_PASSWORD=your_password_here
+FUB_SUBDOMAIN=your_subdomain
+
+# Debug mode (set to true to see debug messages)
+DEBUG=false

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+# C9
+.c9
+# RubyMine
+.idea
+# Env
+.env
+# VCR
+/spec/cassettes
+scripts/test_with_real_credentials.rb

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+fub_client

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.4.1

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.4.1

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 3.4.1
+  - 3.3.0
+  - 3.2.0
+before_install: gem install bundler
+cache: bundler
+script:
+  - bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,149 @@
+# 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).
+
+## [1.0.0] - 2025-01-07
+
+### Major Release - Enhanced Fork
+
+This is the first major release of the enhanced `followupboss_client` gem, a comprehensive fork and expansion of the original `fub_client` gem with significant improvements and new features.
+
+### Added
+
+#### 🚀 Rails 8 Compatibility
+- Automatic compatibility patches for Rails 8
+- ActiveSupport::BasicObject compatibility fixes
+- Her gem middleware compatibility patches
+- JSON parsing compatibility improvements
+
+#### 🔐 Secure Cookie Authentication
+- New `CookieClient` class for advanced authentication
+- Support for GIST-based encrypted cookie storage
+- Integration with sync-my-cookie browser extension
+- Kevast encryption/decryption support for secure cookie handling
+- SharedInbox functionality requiring cookie authentication
+
+#### 📧 Advanced Inbox Management
+- `SharedInbox` resource with full CRUD operations
+- `TeamInbox` resource for team-specific inbox management
+- Inbox message and conversation management
+- Inbox settings configuration
+
+#### 📱 Comprehensive API Coverage
+- **Core Resources**: Person, Deal, Property with enhanced methods
+- **Communications**: Message, TextMessage, Call with advanced features
+- **Tasks & Events**: Task, Event, Appointment with completion tracking
+- **Templates & Automation**: EmailTemplate, TextMessageTemplate, ActionPlan
+- **Teams & Users**: User, Team, Group with member management
+- **Pipelines & Stages**: Pipeline, Stage with reordering and statistics
+- **Attachments**: PersonAttachment, DealAttachment with upload/download
+- **Custom Fields**: CustomField, DealCustomField management
+- **Integration**: Webhook, SmartList support
+
+#### 🛡️ Security Enhancements
+- Secure credential management
+- Environment variable configuration
+- Encrypted cookie storage
+- Proper authentication handling
+
+#### 🔧 Enhanced Features
+- Pagination support with `by_page` method
+- Safe operations with error handling
+- Method chaining for complex queries
+- Batch processing capabilities
+- Debug mode support
+- Comprehensive error handling
+
+#### 📚 Documentation & Examples
+- Extensive README with usage examples
+- Security best practices documentation
+- Troubleshooting guide
+- Example scripts for common operations
+- Migration guide from original gem
+
+### Changed
+
+#### 🏗️ Architecture Improvements
+- Enhanced middleware system
+- Improved authentication mechanisms
+- Better error handling and reporting
+- Optimized API request handling
+
+#### 📦 Gem Structure
+- Renamed from `fub_client` to `followupboss_client`
+- Maintained backward compatibility with `FubClient` module
+- Updated repository location to `connorgallopo/followupboss_client`
+- Professional gem packaging and metadata
+
+#### 🔄 Dependencies
+- Updated to support Rails 7.1+ through Rails 8.x
+- Enhanced Faraday compatibility (1.10.3 - 3.0)
+- Improved Her gem integration
+- Updated development dependencies
+
+### Technical Details
+
+#### New Classes and Modules
+- `FubClient::CookieClient` - Secure cookie authentication
+- `FubClient::SharedInbox` - Shared inbox management
+- `FubClient::TeamInbox` - Team inbox functionality
+- `FubClient::Rails8Patch` - Rails 8 compatibility patches
+- `FubClient::HerPatch` - Her gem compatibility fixes
+
+#### Enhanced Resources
+All existing resources have been enhanced with:
+- Better error handling
+- Improved pagination
+- Enhanced relationship management
+- Additional query methods
+- Comprehensive documentation
+
+#### Security Features
+- Credential encryption and secure storage
+- Environment-based configuration
+- Secure cookie handling
+- HTTPS enforcement recommendations
+
+### Migration from Original Gem
+
+#### Installation Change
+```ruby
+# Old
+gem 'fub_client', git: 'https://github.com/original/fub_client.git'
+
+# New
+gem 'followupboss_client'
+```
+
+#### Require Statement Change
+```ruby
+# Old
+require 'fub_client'
+
+# New
+require 'followupboss_client'
+```
+
+#### API Usage (Unchanged)
+All existing API usage remains the same:
+```ruby
+FubClient.configure do |config|
+  config.api_key = 'your_api_key'
+end
+
+people = FubClient::Person.all
+deals = FubClient::Deal.active
+```
+
+### Acknowledgments
+
+This release builds upon the original work by Kyoto Kopz and represents a significant enhancement and modernization of the Follow Up Boss Ruby client library. Special thanks to the Ruby and Rails communities for their continued support and contributions.
+
+---
+
+**For detailed usage examples and documentation, see the [README.md](README.md)**
+
+**For security considerations and best practices, see the Security section in the README**

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at kopz9999@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fub_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kyoto Kopz
+Copyright (c) 2025 Connor Gallopo
+
+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.