followupboss_client 1.0.0

data/lib/fub_client/webhook.rb

@@ -0,0 +1,47 @@
+module FubClient
+  class Webhook < Resource
+    collection_path 'webhooks'
+    root_element :webhook
+    include_root_in_json true
+
+    # Convenience method to find webhooks by event type
+    scope :by_event_type, ->(event_type) { where(eventType: event_type) }
+
+    # Convenience method to find active webhooks
+    def self.active
+      where(active: true)
+    end
+
+    # Convenience method to find inactive webhooks
+    def self.inactive
+      where(active: false)
+    end
+
+    # Get webhook events
+    def events(limit = 10)
+      return [] unless id
+
+      begin
+        response = self.class.get("#{id}/events", { limit: limit })
+        response[:events] || []
+      rescue StandardError
+        []
+      end
+    end
+
+    # Activate a webhook
+    def activate
+      self.class.put("#{id}/activate", {})
+    end
+
+    # Deactivate a webhook
+    def deactivate
+      self.class.put("#{id}/deactivate", {})
+    end
+
+    # Test a webhook by sending a test event
+    def test
+      self.class.post("#{id}/test", {})
+    end
+  end
+end

data/lib/fub_client.rb

@@ -0,0 +1,61 @@
+# Libs
+require 'base64'
+require 'singleton'
+require 'logger'
+require 'active_support'
+require 'active_support/all'
+require 'active_support/core_ext/hash/keys'
+require 'faraday'
+require 'fub_client/rails8_patch'  # Must be loaded after ActiveSupport and Faraday but before Her
+require 'fub_client/her_patch'     # Must be loaded after Faraday but before Her
+require 'facets/string/snakecase'
+require 'multi_json'
+require 'fub_client/compatibility'
+require 'her'
+
+# App
+require 'fub_client/version'
+require 'fub_client/configuration'
+require 'fub_client/client'
+require 'fub_client/cookie_client'
+require 'fub_client/middleware'
+require 'fub_client/middleware/cookie_authentication'
+require 'fub_client/resource'
+# App Models
+require 'fub_client/event'
+require 'fub_client/person'
+require 'fub_client/note'
+require 'fub_client/call'
+require 'fub_client/user'
+require 'fub_client/smart_list'
+require 'fub_client/email_template'
+require 'fub_client/action_plan'
+require 'fub_client/em_event'
+require 'fub_client/custom_field'
+require 'fub_client/task'
+require 'fub_client/property'
+require 'fub_client/deal'
+require 'fub_client/message'
+require 'fub_client/appointment'
+require 'fub_client/text_message'
+require 'fub_client/stage'
+require 'fub_client/pipeline'
+require 'fub_client/webhook'
+require 'fub_client/text_message_template'
+require 'fub_client/people_relationship'
+require 'fub_client/person_attachment'
+require 'fub_client/team'
+require 'fub_client/deal_custom_field'
+require 'fub_client/deal_attachment'
+require 'fub_client/group'
+require 'fub_client/appointment_type'
+require 'fub_client/appointment_outcome'
+require 'fub_client/identity'
+require 'fub_client/team_inbox'
+require 'fub_client/shared_inbox'
+
+module FubClient
+  def self.root
+    File.expand_path '..', __dir__
+  end
+end

data/scripts/test_api.rb

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'fub_client'
+require 'dotenv'
+require 'pp'
+
+# Load environment variables from .env file
+Dotenv.load
+
+# Print API key (masked for security)
+api_key = ENV['FUB_API_KEY']
+if api_key
+  puts "Using API key: #{api_key[0..3]}...#{api_key[-4..-1]}"
+else
+  puts 'ERROR: No API key found in environment. Make sure you have FUB_API_KEY set in your .env file.'
+  exit 1
+end
+
+# Helper function to test an endpoint
+def test_endpoint(model_class, description = nil)
+  description ||= model_class.name.split('::').last.downcase
+  puts "\n===================================="
+  puts "Testing #{model_class.name}.all (#{description})..."
+  puts '===================================='
+
+  begin
+    puts 'Making API request...'
+    response = model_class.all
+
+    puts "\n=== Response Object Type ==="
+    puts response.class
+
+    if response.nil?
+      puts "\n=== Response is nil ==="
+    elsif response.respond_to?(:empty?) && response.empty?
+      puts "\n=== Response is empty array ==="
+    else
+      count = response.respond_to?(:length) ? response.length : 'N/A'
+      puts "\n=== Got #{count} results ==="
+
+      if response.respond_to?(:first) && response.first
+        puts "\n=== First result ==="
+        pp response.first
+      end
+    end
+
+    true
+  rescue StandardError => e
+    puts "\n=== ERROR ==="
+    puts "#{e.class}: #{e.message}"
+    puts e.backtrace[0..5]
+    false
+  end
+end
+
+# Test multiple endpoints
+success = true
+
+# Test People endpoint
+success = test_endpoint(FubClient::Person) && success
+
+# Test Users endpoint
+success = test_endpoint(FubClient::User) && success
+
+# Test Events endpoint
+success = test_endpoint(FubClient::Event) && success
+
+# Test newly added endpoints
+puts "\n===================================="
+puts 'Testing newly added endpoints...'
+puts '===================================='
+
+# Test Tasks endpoint
+success = test_endpoint(FubClient::Task, 'tasks') && success
+
+# Test Properties endpoint
+success = test_endpoint(FubClient::Property, 'properties') && success
+
+# Test Deals endpoint
+success = test_endpoint(FubClient::Deal, 'deals') && success
+
+# Test Messages endpoint
+success = test_endpoint(FubClient::Message, 'messages') && success
+
+# Test pagination with Events
+puts "\n===================================="
+puts 'Testing FubClient::Event.by_page (pagination)...'
+puts '===================================='
+begin
+  puts 'Making API request with pagination...'
+  response = FubClient::Event.by_page(1, 5)
+
+  puts "\n=== Response Metadata ==="
+  if response.respond_to?(:metadata) && response.metadata
+    pp response.metadata
+  else
+    puts 'No metadata available'
+  end
+
+  puts "\n=== Got #{response.length} results with pagination ===" if response.respond_to?(:length)
+rescue StandardError => e
+  puts "\n=== ERROR (Pagination) ==="
+  puts "#{e.class}: #{e.message}"
+  puts e.backtrace[0..5]
+  success = false
+end
+
+puts "\n===================================="
+puts "SUMMARY: All tests #{success ? 'PASSED ✓' : 'FAILED ✗'}"
+puts '===================================='

data/scripts/test_shared_inbox.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'fub_client'
+require 'dotenv'
+require 'pry'
+Dotenv.load
+
+# Load environment variables from .env file
+EMAIL = ENV['FUB_EMAIL'] || 'your_email@example.com'
+PASSWORD = ENV['FUB_PASSWORD'] || 'your_password'
+SUBDOMAIN = ENV['FUB_SUBDOMAIN'] || 'your_subdomain'
+
+# Set debug mode
+ENV['DEBUG'] = 'true'
+
+puts '-------------------------------------------'
+puts 'Testing SharedInbox API with Cookie Auth'
+puts '-------------------------------------------'
+
+# Step 1: Login to obtain cookies
+client = FubClient::Client.instance
+login_success = client.login(EMAIL, PASSWORD)
+
+if login_success
+  puts '✅ Login successful! Cookies obtained.'
+else
+  puts '❌ Login failed! Cannot proceed.'
+  exit 1
+end
+
+# Step 2: Setup cookie client with subdomain
+client.subdomain = SUBDOMAIN
+puts "💡 Set subdomain to: #{SUBDOMAIN}"
+
+# Reset the HER API to apply the new settings
+client.reset_her_api
+puts '🔄 Reset the HER API connection with new settings'
+
+# Add a breakpoint for debugging
+puts "\n🔍 Debug point - inspect client state"
+binding.pry
+
+# Step 3: Get all shared inboxes
+puts "\n📬 Fetching all shared inboxes..."
+begin
+  inboxes = FubClient::SharedInbox.all_inboxes
+  puts "Found #{inboxes.count} shared inboxes"
+
+  inboxes.each do |inbox|
+    puts "  - Inbox ID: #{inbox.id}, Name: #{inbox.name}"
+  end
+rescue StandardError => e
+  puts "❌ Error fetching shared inboxes: #{e.message}"
+  puts 'Debugging error:'
+  binding.pry
+end
+
+# Step 4: Get a specific shared inbox
+puts "\n📬 Fetching shared inbox with ID 1..."
+begin
+  inbox = FubClient::SharedInbox.get_inbox(1)
+  if inbox
+    puts "✅ Found inbox: #{inbox.name}"
+
+    # Get settings
+    puts "\n⚙️ Fetching settings for inbox #{inbox.id}..."
+    settings = inbox.settings
+    puts "Settings: #{settings.inspect}"
+
+    # Get conversations
+    puts "\n💬 Fetching conversations for inbox #{inbox.id}..."
+    conversations = inbox.conversations(5, 0)
+    puts "Found #{conversations.count} conversations"
+
+    # Get messages
+    puts "\n📨 Fetching messages for inbox #{inbox.id}..."
+    messages = inbox.messages(5, 0)
+    puts "Found #{messages.count} messages"
+  else
+    puts '❌ Inbox with ID 1 not found'
+  end
+rescue StandardError => e
+  puts "❌ Error fetching shared inbox: #{e.message}"
+  puts 'Debugging error:'
+  binding.pry
+end
+
+puts "\n-------------------------------------------"
+puts 'Test completed!'
+puts '-------------------------------------------'

metadata

@@ -0,0 +1,335 @@
+--- !ruby/object:Gem::Specification
+name: followupboss_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Connor Gallopo
+- Kyoto Kopz
+bindir: exe
+cert_chain: []
+date: 2025-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: her
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.18.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.18.1
+description: A comprehensive Ruby client for the Follow Up Boss API with Rails 8 compatibility,
+  secure cookie authentication for SharedInbox, and enhanced features for real estate
+  CRM integration.
+email:
+- connor.gallopo@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".tool-versions"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- followupboss_client.gemspec
+- lib/followupboss_client.rb
+- lib/fub_client.rb
+- lib/fub_client/action_plan.rb
+- lib/fub_client/appointment.rb
+- lib/fub_client/appointment_outcome.rb
+- lib/fub_client/appointment_type.rb
+- lib/fub_client/call.rb
+- lib/fub_client/client.rb
+- lib/fub_client/compatibility.rb
+- lib/fub_client/configuration.rb
+- lib/fub_client/cookie_client.rb
+- lib/fub_client/custom_field.rb
+- lib/fub_client/deal.rb
+- lib/fub_client/deal_attachment.rb
+- lib/fub_client/deal_custom_field.rb
+- lib/fub_client/em_event.rb
+- lib/fub_client/email_template.rb
+- lib/fub_client/event.rb
+- lib/fub_client/group.rb
+- lib/fub_client/her_patch.rb
+- lib/fub_client/identity.rb
+- lib/fub_client/message.rb
+- lib/fub_client/middleware.rb
+- lib/fub_client/middleware/authentication.rb
+- lib/fub_client/middleware/cookie_authentication.rb
+- lib/fub_client/middleware/parser.rb
+- lib/fub_client/note.rb
+- lib/fub_client/people_relationship.rb
+- lib/fub_client/person.rb
+- lib/fub_client/person_attachment.rb
+- lib/fub_client/pipeline.rb
+- lib/fub_client/property.rb
+- lib/fub_client/rails8_patch.rb
+- lib/fub_client/resource.rb
+- lib/fub_client/shared_inbox.rb
+- lib/fub_client/smart_list.rb
+- lib/fub_client/stage.rb
+- lib/fub_client/task.rb
+- lib/fub_client/team.rb
+- lib/fub_client/team_inbox.rb
+- lib/fub_client/text_message.rb
+- lib/fub_client/text_message_template.rb
+- lib/fub_client/user.rb
+- lib/fub_client/version.rb
+- lib/fub_client/webhook.rb
+- scripts/test_api.rb
+- scripts/test_shared_inbox.rb
+homepage: https://github.com/connorgallopo/followupboss_client
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Enhanced Ruby client for Follow Up Boss API with Rails 8 compatibility
+test_files: []