alt 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 148a693bc8405a8166a936e47e37639800e8bef103a714a2d90f419e7542d652
+  data.tar.gz: 9749870ae389b7ed01f6945e49f4bedf5ca6200ffbf06ecb3fff44ea166d5c8d
+SHA512:
+  metadata.gz: b69cd118dd593f5e64ff6c1e998ba607efeea236a60a07dec65012a879cfaaee8010d95cbab5871c31fc04212b89f15c15e09d785153f53b799851c2cb93f8d0
+  data.tar.gz: a5bb353c48ac96684080977b3842cf1a8d6f3f88f2ad38b5b7b0bccaa4e73c7855cbd001437cd137fc92fdeabf9dd8d7424ccd9ca1d1eed2ae0d9731bb8c1763

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.0.1] - 2026-07-28
+
+- Initial release

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 = Alt::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/alt/error.rb

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

data/lib/alt/property.rb

@@ -0,0 +1,28 @@
+# A wrapper for the HouseCanary API to fetch public records about a property.
+# @see https://api-docs.housecanary.com/#tag/Property-Level/
+module Alt
+  # 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 property_details = details[:property_details]
+
+  private
+
+    def details
+      @details ||= fetch
+    end
+
+    def fetch
+      # TODO
+    end
+  end
+end

data/lib/alt/version.rb

@@ -0,0 +1,3 @@
+module Alt
+  VERSION = '0.0.1'
+end

data/lib/alt.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 'alt/error'
+require 'alt/property'

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: alt
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+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/alt.rb
+- lib/alt/error.rb
+- lib/alt/property.rb
+- lib/alt/version.rb
+homepage: https://github.com/claudiob/alt
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/claudiob/alt
+  source_code_uri: https://github.com/claudiob/alt
+  changelog_uri: https://github.com/claudiob/alt
+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: []