hcp 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90d571ad7e7872688843090321835c3f6d8b0c02a5793acee7673575d61e44f3
-  data.tar.gz: 78bd3365a5feabeced0e6a94739f091708b94722e509d2447aba4986053dd24c
+  metadata.gz: 2c507e653633d17395829ab18ff34b44313aa37c8e19286aecad3096adae8848
+  data.tar.gz: 3677c714fefd88238ff2ebee783f2d6ba6141bf6a2aa37d994a43b7cd0b292e5
 SHA512:
-  metadata.gz: 9dd74a5fda91a8dd80376cea9825bcd4d11db89263679ec6d21ebe382a90c14e3f4ae5a5e438ab43612f492843c26b364a40ed0a83a31389d6809b40700e80ae
-  data.tar.gz: ec5410256cfcca4f65ac92aaa0e1988eec68009ae3ae440667f71097dabc9a5e1abceb962cc7c44e3154842837130f17bddf6cf082bba7afd26f46b620fd81d5
+  metadata.gz: 34f585b624bec1d61839a69a6c2678bad38e8b24bd02605e5fb47aa11fc5fdff5c31cd8e2aab802daa75f943a72cf9c7f39ac97fafa5d15dd52b0efb52ef42d6
+  data.tar.gz: a498b1a75b5f8170837a99661c265800eccaec5d3384c626f5bbbd086373488afbc063172876e04c15abb7c520418aa51e7c6fb3ef2c5ac28d580bcc1795304c

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [1.1.0] - 2026-05-27
+
+- [New] Add Hcp::Event
+
 ## [1.0.0] - 2026-05-15
 
 - Initial release: Lead and Lead::Pipeline classes

data/README.md

@@ -1,4 +1,4 @@
-# Housecall Pro API Ruby client
+# The Housecall Pro API Ruby client
 
 ## Available methods
 

data/lib/hcp/event.rb

@@ -0,0 +1,58 @@
+module Hcp
+  class Event
+    # @see https://docs.housecallpro.com/docs/housecall-public-api/46e9e1be07621-webhooks
+    SIGNATURE_HEADER = 'Api-Signature'
+
+    # @see https://docs.housecallpro.com/docs/housecall-public-api/46e9e1be07621-webhooks
+    TIMESTAMP_HEADER = 'Api-Timestamp'
+
+    # @param params [Hash] the payload for an event webhook.
+    def initialize(params = {})
+      @params = params
+    end
+
+    # @return [Symbol] the type of event, e.g.: :lead_converted, :job_created, :invoice_sent.
+    def type = @params[:event].gsub('.', '_').to_sym
+
+    # @return [String] unique identifier of the lead in a :lead_converted event.
+    def lead_id = @params.dig :lead, :id
+
+    # @return [String] unique identifier of the customer in a :lead_converted or :job_created event.
+    def customer_id = @params.dig resource_type, :customer, :id
+
+    # @return [String] unique identifier of the job in a :job_created/scheduled/completed event.
+    def job_id = @params.dig :job, :id
+
+    # @return [String] unique identifier of the estimate in a :job_created event.
+    def estimate_id = @params.dig :job, :original_estimate_id
+
+    # @return [Symbol] the latest conversion type, can be :estimate or :job.
+    def conversion_type = conversion['type'].downcase.to_sym
+
+    # @return [String] the latest conversion ID, can be an estimate ID or a job ID.
+    def conversion_id = conversion['id']
+
+    # @return [Time] time when the job is scheduled a :job_scheduled event.
+    def scheduled_at = Time.iso8601(@params.dig :job, :schedule, :scheduled_start)
+
+    # @return [Time] time when the job was completed a :job_completed event.
+    def completed_at = Time.iso8601(@params.dig :job, :work_timestamps, :completed_at)
+
+    # @return [String] unique identifier of the invoice in an :invoice_sent event.
+    def invoice_id = @params.dig :invoice, :id
+
+    # @return [String] unique identifier of the job in an :invoice_sent event.
+    def invoice_job_id = @params.dig :invoice, :job_id
+
+    # @return [BigDecimal] dollar amount of the invoice in an :invoice_sent event.
+    def invoice_amount = BigDecimal(@params.dig :invoice, :amount) / 100.0
+
+  private
+
+    # @return [Hash] the latest conversion, applies to 'lead.converted' events.
+    def conversion = @params.dig(:lead, :conversions).last
+
+    # @return [Symbol] the type of resource affected by the event, can be :lead or :job.
+    def resource_type = @params[:event].split('.').first.to_sym
+  end
+end

data/lib/hcp/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Ruby client for the Housecall Pro API.
 module Hcp
-  VERSION = '1.0.0'
+  # Current version of the gem.
+  VERSION = '1.1.0'
 end

data/lib/hcp.rb

@@ -7,3 +7,5 @@ require 'hcp/error'
 require 'hcp/resource'
 require 'hcp/lead'
 require 'hcp/lead/pipeline'
+
+require 'hcp/event'

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: hcp
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Claudio Baccigalupo
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
 description: Housecall Pro API
 email:
 - claudiob@users.noreply.github.com
@@ -21,17 +35,18 @@ files:
 - README.md
 - lib/hcp.rb
 - lib/hcp/error.rb
+- lib/hcp/event.rb
 - lib/hcp/lead.rb
 - lib/hcp/lead/pipeline.rb
 - lib/hcp/resource.rb
 - lib/hcp/version.rb
-homepage: https://github.com/HouseAccountEng/hcp
+homepage: https://github.com/claudiob/hcp
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/HouseAccountEng/hcp
-  source_code_uri: https://github.com/HouseAccountEng/hcp
-  changelog_uri: https://github.com/HouseAccountEng/hcp
+  homepage_uri: https://github.com/claudiob/hcp
+  source_code_uri: https://github.com/claudiob/hcp
+  changelog_uri: https://github.com/claudiob/hcp
 rdoc_options: []
 require_paths:
 - lib