hcn 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5bae325675aa747f1fb056114e78231d497d22aa137f85fa930df446ad7dd1a7
+  data.tar.gz: 830a23955f011c28b6a25235dee408c417fd530a1d10ea732cb2698279da6aa3
+SHA512:
+  metadata.gz: 82b6a9a17ec7e3ccccedb12c2e2629b0fc48b0a074d8cd8968b71453f95c897cb676f7c7fec6a17f605ce0f558e5e0c29d8f08879204e5e7f433b505fdca4833
+  data.tar.gz: 8b1db068010524f767a78874265e9fa55be76f374d3a0c550012c5236a9c9571efe1edbd8d5f9f291e07fe8437916760779d74988d7a8ce66b846a3479fcfa22

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [1.0.0] - 2026-07-09
+
+- Initial release: Hcn::Property with #subject_address, #public_records, #assessment

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 HouseAccount
+
+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.

data/README.md

@@ -0,0 +1,20 @@
+# HouseCanary API Ruby client
+
+## Authentication
+
+Generate an API key/secret in HouseCanary and set as environment variables:
+
+- `ENV['HOUSECANARY_API_KEY']`
+- `ENV['HOUSECANARY_API_SECRET']`
+
+## Available methods
+
+```ruby
+property = Hcn::Property.new address: "4352 Desert Park Ave", unit: nil, city: "North Las Vegas", zipcode: "89085"
+
+property.subject_address # => {msa: "29820", city: "North Las Vegas", fips: "32003", slug: "4352-Desert-Park-Ave-North-Las-Vegas-NV-89085", unit: "", state: "NV", address: "4352 Desert Park Ave", zipcode: "89085", block_id: "320030036621009", latitude: 36.31164, longitude: -115.20045, address_id: 8412516, address_full: "4352 Desert Park Ave North Las Vegas NV 89085", geo_precision: "rooftop", zipcode_plus4: "2321"}
+
+property.public_records # => {pool: nil, attic: nil, sewer: nil, water: nil, zoning: {code: nil, description: nil}, cooling: nil, heating: ["Forced Air Unit"], parking: {total: 2, garage: nil, description: "Built-in"}, stories: 2, basement: {has: nil, total_area: nil, finished_pct: nil}, bedrooms: 4, lot_size: 4792, bathrooms: {full: nil, total: nil, partial: nil, total_provided: 3.0, total_projected: 3}, buildings: nil, fireplace: true, parcel_id: "12407312060", roof_type: nil, year_built: 2007, living_area: 2778, rooms_total: 9, subdivision: nil, units_total: nil, neighborhood: nil, sewer_public: nil, solar_panels: nil, property_type: "SFR", roof_material: "Tile", pool_community: nil, building_quality: nil, fireplaces_total: 1, legal_description: "DIST:NLV CITY/MUNI/TWP:NORTH LAS VEGAS SEC/TWN/RNG/MER:SEC 07 TWN 19S RNG 61E GRAND TETON VALLEY N W 80 PUD-45 #2 PLAT BOOK 123 PAGE 68 LOT 129 MAP REF:PB B0123 P0068", construction_types: ["Frame"], architectural_style: nil, building_condition_code: "Average", living_area_above_grade: nil, living_area_below_grade: nil, walls_exterior_material: "Stucco", property_type_description: "Single Family Residential"}
+
+property.assessment # => {apn: "124-07-312-060", tax_year: 2026, amount_annual: 2772.91, year_assessed: 2026, value_assessed: 150470, value_assessed_land: 35350, value_assessed_improvement: 115120}
+```

data/lib/hcn/error.rb

@@ -0,0 +1,4 @@
+module Hcn
+  # An error to raise when HouseCanary API doesn't respond as expected.
+  Error = Class.new(StandardError)
+end

data/lib/hcn/property.rb

@@ -0,0 +1,43 @@
+# A wrapper for the HouseCanary API to fetch public records about a property.
+# @see https://api-docs.housecanary.com/#tag/Property-Level/
+module Hcn
+  # Embeds the logic of a HouseCanary property.
+  class Property
+    # @data [Hash] data the attributes of each provider
+    # @option data [String] address Building number, street name, and optionally unit number
+    # @option data [String] unit Unit number for the property
+    # @option data [String] city City in which the property is located
+    # @option data [String] zipcode 5-digit US zipcode in which the property is located
+    def initialize(data = {})
+      @data = data
+    end
+
+    # @return [Hash] Address information
+    def subject_address = details[:subject_address]
+
+    # @return [Hash] Public Record information
+    def public_records = details[:public_records]
+
+    # @return [Hash] Details about the most recent assessment
+    def assessment = details[:assessment]
+
+  private
+
+    def details
+      @details ||= fetch
+    end
+
+    def fetch
+      uri = URI 'https://api.housecanary.com/v3/property/details_advanced'
+      uri.query = URI.encode_www_form @data.merge(type: :public)
+
+      request = Net::HTTP::Get.new uri
+      request.basic_auth ENV['HOUSECANARY_API_KEY'], ENV['HOUSECANARY_API_SECRET']
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request(request)
+      end
+      raise Error unless response.is_a?(Net::HTTPSuccess)
+      JSON(response.body).with_indifferent_access
+    end
+  end
+end

data/lib/hcn/version.rb

@@ -0,0 +1,3 @@
+module Hcn
+  VERSION = '1.0.0'
+end

data/lib/hcn.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/hash/indifferent_access'
+require 'json'
+require 'net/http'
+require 'uri'
+
+require 'hcn/error'
+require 'hcn/property'

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: hcn
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Claudio Baccigalupo
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+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: Jobber API
+email:
+- claudiob@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/hcn.rb
+- lib/hcn/error.rb
+- lib/hcn/property.rb
+- lib/hcn/version.rb
+homepage: https://github.com/HouseAccountEng/hcn
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/HouseAccountEng/hcn
+  source_code_uri: https://github.com/HouseAccountEng/hcn
+  changelog_uri: https://github.com/HouseAccountEng/hcn
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: A Ruby client for the HouseCanary API.
+test_files: []