extraspace 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c85ab034de8c329973cfe53e470745608a52076d9dce4a037532dc8214f5913
-  data.tar.gz: fa535b917b40c8349b79683642ce5e367b0ea34c519fbfd16c094fba87025ebe
+  metadata.gz: c428e33759133c5e280f2dfb72c99c04e71ee4c64f96f6b9ba2228cd5fdc033e
+  data.tar.gz: a2be67b968e35c3fa689583d00cacf92608cf74906d8b854c52f9333059a1857
 SHA512:
-  metadata.gz: d243f120d52703c773053469004d735eb8deadd63f0706012f1b4e92abe2fc747db2010f8a99e561cce4336841b3e350ebe27376a2de1f037fce75d6da14935c
-  data.tar.gz: 21db75d1f583a0577bc4b62ea4465eca29e69185f668b254c5fb1ee19dc4215ebb77f2abdf3234820e06964b4bc1926255b74a36b7619017cf203ea0a68a8b89
+  metadata.gz: c66f9b36b6ee74d375a791c57a9f0712efe65c65a3aa5b6c7bc146779e22cb2f10cb5e2f176eea2b6430a7255620f0fa218d4bcefa015b39723c35653821ea15
+  data.tar.gz: d0f1f59b09c2f6d86baad0819ab63f5ca68491e9ccfc9895c0f5f43ccb69418130dc898ed1087ad9d1580397ad9270256f8253d61982c092969e1bbde27214dc

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 "Street: #{facility.address.street}"
+  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 "ID: #{price.id}"
+    puts "Width: #{price.dimensions.width}"
+    puts "Depth: #{price.dimensions.depth}"
+    puts "Rates: $#{price.rates.street} (street) / $#{price.rates.web} (web)"
+    puts
+  end
 end
 ```

data/lib/extraspace/address.rb

@@ -1,15 +1,11 @@
 # frozen_string_literal: true
 
 module ExtraSpace
-  # e.g. https://www.extraspace.com/storage/facilities/us/alabama/auburn/3264/
+  # The address (street + city + state + zip) of a facility.
   class Address
-    # @attribute [rw] line1
+    # @attribute [rw] street
     #   @return [String]
-    attr_accessor :line1
-
-    # @attribute [rw] line2
-    #   @return [String]
-    attr_accessor :line2
+    attr_accessor :street
 
     # @attribute [rw] city
     #   @return [String]
@@ -23,14 +19,12 @@ module ExtraSpace
     #   @return [String]
     attr_accessor :zip
 
-    # @param line1 [String]
-    # @param line2 [String]
+    # @param street [String]
     # @param city [String]
     # @param state [String]
     # @param zip [String]
-    def initialize(line1:, line2:, city:, state:, zip:)
-      @line1 = line1
-      @line2 = line2
+    def initialize(street:, city:, state:, zip:)
+      @street = street
       @city = city
       @state = state
       @zip = zip
@@ -39,8 +33,7 @@ module ExtraSpace
     # @return [String]
     def inspect
       props = [
-        "line1=#{@line1.inspect}",
-        "line2=#{@line2.inspect}",
+        "street=#{@street.inspect}",
         "city=#{@city.inspect}",
         "state=#{@state.inspect}",
         "zip=#{@zip.inspect}"
@@ -52,9 +45,10 @@ module ExtraSpace
     #
     # @return [Address]
     def self.parse(data:)
+      lines = %w[line1 line2 line3 line4].map { |key| data[key] }
+
       new(
-        line1: data['line1'],
-        line2: data['line2'],
+        street: lines.compact.reject(&:empty?).join(' '),
         city: data['city'],
         state: data['stateName'],
         zip: data['postalCode']

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ExtraSpace
-  # e.g. https://www.extraspace.com/storage/facilities/us/alabama/auburn/3264/
+  # The dimensions (width + depth + sqft) of a price.
   class Dimensions
     # @attribute [rw] depth
     #   @return [Integer]
@@ -15,19 +15,13 @@ module ExtraSpace
     #   @return [Integer]
     attr_accessor :sqft
 
-    # @attribute [rw] display
-    #   @return [String]
-    attr_accessor :display
-
     # @param depth [Integer]
     # @param width [Integer]
     # @param sqft [Integer]
-    # @param display [String]
-    def initialize(depth:, width:, sqft:, display:)
+    def initialize(depth:, width:, sqft:)
       @depth = depth
       @width = width
       @sqft = sqft
-      @display = display
     end
 
     # @return [String]
@@ -35,8 +29,7 @@ module ExtraSpace
       props = [
         "depth=#{@depth.inspect}",
         "width=#{@width.inspect}",
-        "sqft=#{@sqft.inspect}",
-        "display=#{@display.inspect}"
+        "sqft=#{@sqft.inspect}"
       ]
       "#<#{self.class.name} #{props.join(' ')}>"
     end
@@ -45,7 +38,7 @@ module ExtraSpace
     #
     # @return [Dimensions]
     def self.parse(data:)
-      new(depth: data['depth'], width: data['width'], sqft: data['squareFoot'], display: data['display'])
+      new(depth: data['depth'], width: data['width'], sqft: data['squareFoot'])
     end
   end
 end

data/lib/extraspace/facility.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
 module ExtraSpace
+  # A facility (address + geocode + prices) on extraspace.com.
+  #
   # 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
@@ -34,15 +38,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/geocode.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ExtraSpace
-  # e.g. https://www.extraspace.com/storage/facilities/us/alabama/auburn/3264/
+  # The geocode (latitude + longitude) of a facility.
   class Geocode
     # @attribute [rw] latitude
     #   @return [Float]

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

@@ -1,15 +1,11 @@
 # frozen_string_literal: true
 
 module ExtraSpace
-  # e.g. https://www.extraspace.com/storage/facilities/us/alabama/auburn/3264/
+  # The price (id + dimensions + rate) for a facility
   class Price
-    # @attribute [rw] uid
+    # @attribute [rw] id
     #   @return [String]
-    attr_accessor :uid
-
-    # @attribute [rw] availability
-    #   @return [Availability]
-    attr_accessor :availability
+    attr_accessor :id
 
     # @attribute [rw] dimensions
     #   @return [Dimensions]
@@ -19,13 +15,11 @@ module ExtraSpace
     #   @return [Rates]
     attr_accessor :rates
 
-    # @param uid [String]
-    # @param availability [Availability]
+    # @param id [String]
     # @param dimensions [Dimensions]
     # @param rates [Rates]
-    def initialize(uid:, availability:, dimensions:, rates:)
-      @uid = uid
-      @availability = availability
+    def initialize(id:, dimensions:, rates:)
+      @id = id
       @dimensions = dimensions
       @rates = rates
     end
@@ -33,8 +27,7 @@ module ExtraSpace
     # @return [String]
     def inspect
       props = [
-        "uid=#{@uid.inspect}",
-        "availability=#{@availability.inspect}",
+        "id=#{@id.inspect}",
         "dimensions=#{@dimensions.inspect}",
         "rates=#{@rates.inspect}"
       ]
@@ -45,12 +38,10 @@ module ExtraSpace
     #
     # @return [Price]
     def self.parse(data:)
-      availability = Availability.parse(data: data['availability'])
       dimensions = Dimensions.parse(data: data['dimensions'])
       rates = Rates.parse(data: data['rates'])
       new(
-        uid: data['uid'],
-        availability: availability,
+        id: data['uid'],
         dimensions: dimensions,
         rates: rates
       )

data/lib/extraspace/rates.rb

@@ -1,12 +1,8 @@
 # frozen_string_literal: true
 
 module ExtraSpace
-  # e.g. https://www.extraspace.com/storage/facilities/us/alabama/auburn/3264/
+  # The rates (street + web) for a facility
   class Rates
-    # @attribute [rw] nsc
-    #   @return [Integer]
-    attr_accessor :nsc
-
     # @attribute [rw] street
     #   @return [Integer]
     attr_accessor :street
@@ -15,11 +11,9 @@ module ExtraSpace
     #   @return [Integer]
     attr_accessor :web
 
-    # @param nsc [Integer]
     # @param street [Integer]
     # @param web [Integer]
-    def initialize(nsc:, street:, web:)
-      @nsc = nsc
+    def initialize(street:, web:)
       @street = street
       @web = web
     end
@@ -27,7 +21,6 @@ module ExtraSpace
     # @return [String]
     def inspect
       props = [
-        "nsc=#{@nsc.inspect}",
         "street=#{@street.inspect}",
         "web=#{@web.inspect}"
       ]
@@ -39,7 +32,6 @@ module ExtraSpace
     # @return [Rates]
     def self.parse(data:)
       new(
-        nsc: data['nsc'],
         street: data['street'],
         web: data['web']
       )

data/lib/extraspace/sitemap.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ExtraSpace
+  # A sitemap on extraspace.com.
+  #
+  # 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.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extraspace
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-21 00:00:00.000000000 Z
+date: 2024-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -79,12 +79,14 @@ files:
 - bin/setup
 - 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:

data/lib/extraspace/availability.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module ExtraSpace
-  # e.g. https://www.extraspace.com/storage/facilities/us/alabama/auburn/3264/
-  class Availability
-    # @attribute [rw] available
-    #   @return [String]
-    attr_accessor :available
-
-    # @param available [String]
-    def initialize(available:)
-      @available = available
-    end
-
-    # @return [String]
-    def inspect
-      props = [
-        "available=#{@available.inspect}"
-      ]
-      "#<#{self.class.name} #{props.join(' ')}>"
-    end
-
-    # @param data [Hash]
-    #
-    # @return [Availability]
-    def self.parse(data:)
-      new(available: data['available'])
-    end
-  end
-end