extraspace 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d0f31dad347795d2fb0a8cbd14b3c6452fc8c8dfea0f9b66639bc4c1bf1c433
-  data.tar.gz: 35cedca68983cab7e29c76abc7c8c83d617dad6c2ef881bbd13ecced436fd89d
+  metadata.gz: b2d656b5fbca3894562492b6a8c3e90c97a4c785cf88d6ff7c2c65c380a5ba8e
+  data.tar.gz: c564ac28246067bfb3d843070aa8ea3dcaa0898e12161e15c7570439cd8d4907
 SHA512:
-  metadata.gz: e56ad3839e7a9f5a11b8298e7977c518590aade51b78a7248c201b03027b35b697ef792e311e76b797d1d6aa51d00e996d753651ff66e2fb5e00b74d2c8ab86c
-  data.tar.gz: 5bb15f6c216c19d628f2179dd4dafe714804ee50d9142d72039d7fba0e68a5ad7ceaaa29e54259868a3ad0f53be9e0d9c677ce207ced6a5730471a2ac0439f13
+  metadata.gz: 503b60e74410c4fe5cf0db8644382555cf0ddb8343790e5eed69d61c7b8d5e494be3cdbd55097fee3454f555f2bd030722b704906384da65d020e688252ad46a
+  data.tar.gz: d48d92e05c00b065619738803344b79254ecb29cec4e9d461a47709169c1125864d278f07ce421647b17d2e6f83efdb09c9a102fe393766edab8d5aa457639db

data/README.md

@@ -17,22 +17,26 @@ gem install extrapsace
 ```ruby
 require 'extraspace'
 
-URL = 'https://www.extraspace.com/storage/facilities/us/alabama/auburn/3264/'
-facility = ExtraSpace::Facility.fetch(url: URL)
-
-puts "Line 1: #{facility.address.line1}"
-puts "Line 2: #{facility.address.line2}"
-puts "City: #{facility.address.city}"
-puts "State: #{facility.address.state}"
-puts "ZIP: #{facility.address.zip}"
-puts "Latitude: #{facility.geocode.latitude}"
-puts "Longitude: #{facility.geocode.longitude}"
-puts
-
-facility.prices.each do |price|
-  puts "UID: #{price.uid}"
-  puts "Dimensions: #{price.dimensions.display}"
-  puts "Rates: $#{price.rates.street} (street) / $#{price.rates.web} (web)"
+sitemap = ExtraSpace::Facility.sitemap
+sitemap.links.each do |link|
+  url = link.loc
+
+  facility = ExtraSpace::Facility.fetch(url:)
+
+  puts "Line 1: #{facility.address.line1}"
+  puts "Line 2: #{facility.address.line2}"
+  puts "City: #{facility.address.city}"
+  puts "State: #{facility.address.state}"
+  puts "ZIP: #{facility.address.zip}"
+  puts "Latitude: #{facility.geocode.latitude}"
+  puts "Longitude: #{facility.geocode.longitude}"
   puts
+
+  facility.prices.each do |price|
+    puts "UID: #{price.uid}"
+    puts "Dimensions: #{price.dimensions.display}"
+    puts "Rates: $#{price.rates.street} (street) / $#{price.rates.web} (web)"
+    puts
+  end
 end
 ```

data/lib/extraspace/address.rb

@@ -26,9 +26,8 @@ module ExtraSpace
     # @param line1 [String]
     # @param line2 [String]
     # @param city [String]
-    # @param state_abbreviation [String]
-    # @param state_name [String]
-    # @param postal_code [String]
+    # @param state [String]
+    # @param zip [String]
     def initialize(line1:, line2:, city:, state:, zip:)
       @line1 = line1
       @line2 = line2
@@ -37,6 +36,7 @@ module ExtraSpace
       @zip = zip
     end
 
+    # @return [String]
     def inspect
       props = [
         "line1=#{@line1.inspect}",

data/lib/extraspace/availability.rb

@@ -7,7 +7,7 @@ module ExtraSpace
     #   @return [String]
     attr_accessor :available
 
-    # @param uid [String]
+    # @param available [String]
     def initialize(available:)
       @available = available
     end
@@ -22,7 +22,7 @@ module ExtraSpace
 
     # @param data [Hash]
     #
-    # @return [Address]
+    # @return [Availability]
     def self.parse(data:)
       new(available: data['available'])
     end

data/lib/extraspace/crawler.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ExtraSpace
+  # Used to fetch and parse either HTML or XML via a URL.
+  class Crawler
+    # Raised for unexpected HTTP responses.
+    class FetchError < StandardError
+      # @param url [String]
+      # @param response [HTTP::Response]
+      def initialize(url:, response:)
+        super("url=#{url} status=#{response.status.inspect} body=#{response.body.inspect}")
+      end
+    end
+
+    # @param url [String]
+    # @raise [FetchError]
+    # @return [Nokogiri::HTML::Document]
+    def self.html(url:)
+      new.html(url:)
+    end
+
+    # @param url [String]
+    # @raise [FetchError]
+    # @return [Nokogiri::XML::Document]
+    def self.xml(url:)
+      new.xml(url:)
+    end
+
+    # @param url [String]
+    # @return [HTTP::Response]
+    def fetch(url:)
+      response = HTTP.get(url)
+      raise FetchError(url:, response: response.flush) unless response.status.ok?
+
+      response
+    end
+
+    # @param url [String]
+    # @raise [FetchError]
+    # @return [Nokogiri::XML::Document]
+    def html(url:)
+      Nokogiri::HTML(String(fetch(url:).body))
+    end
+
+    # @param url [String]
+    # @raise [FetchError]
+    # @return [Nokogiri::XML::Document]
+    def xml(url:)
+      Nokogiri::XML(String(fetch(url:).body))
+    end
+  end
+end

data/lib/extraspace/dimensions.rb

@@ -19,7 +19,10 @@ module ExtraSpace
     #   @return [String]
     attr_accessor :display
 
-    # @param uid [String]
+    # @param depth [Integer]
+    # @param width [Integer]
+    # @param sqft [Integer]
+    # @param display [String]
     def initialize(depth:, width:, sqft:, display:)
       @depth = depth
       @width = width
@@ -40,7 +43,7 @@ module ExtraSpace
 
     # @param data [Hash]
     #
-    # @return [Address]
+    # @return [Dimensions]
     def self.parse(data:)
       new(depth: data['depth'], width: data['width'], sqft: data['squareFoot'], display: data['display'])
     end

data/lib/extraspace/facility.rb

@@ -3,6 +3,8 @@
 module ExtraSpace
   # e.g. https://www.extraspace.com/storage/facilities/us/alabama/auburn/3264/
   class Facility
+    SITEMAP_URL = 'https://www.extraspace.com/facility-sitemap.xml'
+
     # @attribute [rw] address
     #   @return [Address]
     attr_accessor :address
@@ -24,6 +26,7 @@ module ExtraSpace
       @prices = prices
     end
 
+    # @return [String]
     def inspect
       props = [
         "address=#{@address.inspect}",
@@ -33,15 +36,18 @@ module ExtraSpace
       "#<#{self.class.name} #{props.join(' ')}>"
     end
 
+    # @return [Sitemap]
+    def self.sitemap
+      Sitemap.fetch(url: SITEMAP_URL)
+    end
+
     # @param url [String]
     #
     # @return [Facility]
     def self.fetch(url:)
-      response = HTTP.get(url)
-      document = Nokogiri::HTML(String(response.body))
+      document = Crawler.html(url:)
       data = JSON.parse(document.at('#__NEXT_DATA__').text)
-
-      parse(data: data)
+      parse(data:)
     end
 
     # @param data [Hash]

data/lib/extraspace/link.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ExtraSpace
+  # A link in a sitemap.
+  class Link
+    # @attribute [rw] loc
+    #   @return [String]
+    attr_accessor :loc
+
+    # @attribute [rw] lastmod
+    #   @return [Time]
+    attr_accessor :lastmod
+
+    # @param loc [String]
+    # @param lastmod [String]
+    def initialize(loc:, lastmod:)
+      @loc = loc
+      @lastmod = Time.parse(lastmod)
+    end
+
+    # @return [String]
+    def inspect
+      "#<#{self.class.name} loc=#{@loc.inspect} lastmod=#{@lastmod.inspect}>"
+    end
+  end
+end

data/lib/extraspace/price.rb

@@ -43,7 +43,7 @@ module ExtraSpace
 
     # @param data [Hash]
     #
-    # @return [Address]
+    # @return [Price]
     def self.parse(data:)
       availability = Availability.parse(data: data['availability'])
       dimensions = Dimensions.parse(data: data['dimensions'])

data/lib/extraspace/rates.rb

@@ -15,7 +15,9 @@ module ExtraSpace
     #   @return [Integer]
     attr_accessor :web
 
-    # @param uid [String]
+    # @param nsc [Integer]
+    # @param street [Integer]
+    # @param web [Integer]
     def initialize(nsc:, street:, web:)
       @nsc = nsc
       @street = street
@@ -34,7 +36,7 @@ module ExtraSpace
 
     # @param data [Hash]
     #
-    # @return [Address]
+    # @return [Rates]
     def self.parse(data:)
       new(
         nsc: data['nsc'],

data/lib/extraspace/sitemap.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ExtraSpace
+  # e.g. https://www.extraspace.com/facility-sitemap.xml
+  class Sitemap
+    # @attribute [rw] links
+    #   @return [Array<Link>]
+    attr_accessor :links
+
+    # @param document [NokoGiri::XML::Document]
+    #
+    # @return [Sitemap]
+    def self.parse(document:)
+      links = document.xpath('//xmlns:url').map do |url|
+        loc = url.at_xpath('xmlns:loc')&.text
+        lastmod = url.at_xpath('xmlns:lastmod')&.text
+        Link.new(loc:, lastmod:)
+      end
+
+      new(links: links)
+    end
+
+    # @param url [String]
+    #
+    # @return [Sitemap]
+    def self.fetch(url:)
+      document = Crawler.xml(url:)
+      parse(document:)
+    end
+
+    # @param links [Array<Link>]
+    def initialize(links:)
+      @links = links
+    end
+
+    # @return [String]
+    def inspect
+      "#<#{self.class.name} links=#{@links.inspect}>"
+    end
+  end
+end

data/lib/extraspace/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ExtraSpace
-  VERSION = '0.1.0'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extraspace
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Kevin Sylvestre
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-20 00:00:00.000000000 Z
+date: 2024-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -80,11 +80,14 @@ files:
 - lib/extraspace.rb
 - lib/extraspace/address.rb
 - lib/extraspace/availability.rb
+- lib/extraspace/crawler.rb
 - lib/extraspace/dimensions.rb
 - lib/extraspace/facility.rb
 - lib/extraspace/geocode.rb
+- lib/extraspace/link.rb
 - lib/extraspace/price.rb
 - lib/extraspace/rates.rb
+- lib/extraspace/sitemap.rb
 - lib/extraspace/version.rb
 homepage: https://github.com/ksylvest/extraspace
 licenses:
@@ -94,7 +97,7 @@ metadata:
   homepage_uri: https://github.com/ksylvest/extraspace
   source_code_uri: https://github.com/ksylvest/extraspace
   changelog_uri: https://github.com/ksylvest/extraspace
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -109,8 +112,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.5.23
+signing_key: 
 specification_version: 4
 summary: A crawler for ExtraSpace.
 test_files: []