extraspace 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e31518705b665cfcff3914a8553164f1463a3c66140cb41ea14be9154abf44fa
-  data.tar.gz: bf86b8674cf0557e239b286acaca2f77d1688bd3f431434ad15914db9624a143
+  metadata.gz: a6b9f72cb5e07f8752d98b4f9a03ae259d29e434bc136a83c131355ca805303c
+  data.tar.gz: 42db36f6586bf84339fd09b9acacdba161886a23087932a9dd7d392bb30bd5bd
 SHA512:
-  metadata.gz: 6204e8de2f7349debac7049c5ca1ade4fc0b5328be5faaf61eefb42d982e735897c28fc6292ac98c6a40e36dadf94550fcd30f5a066b3eb58ba8de7db3c2c20d
-  data.tar.gz: edd94f3a7d6dadc415f112f7dd3fa1ff7e8ae5fd8592794e3a218a3806e5ec7777659eeaee3bde305af51eee67f23fb5b5862925f51fc54d22ff5aa5ad863f34
+  metadata.gz: eaa2e29a14042f4609f6aa3e7534a7e281fa7831cfd9254b8dc57309ded56fe14063fe8ce730d11a4f569e7068617eb1ab3bfdb541689de57a21d236313e751f
+  data.tar.gz: 2d15bad80e64d83162ab01665752d16abc198ccc65299a815c550e9eed5f121810c120ae46a0f560dc59bf8d4a0291e0de85c3470acd3bf9d9c026d34d823754

data/README.md

@@ -12,6 +12,17 @@
 gem install extrapsace
 ```
 
+## Configuration
+
+```ruby
+require 'extraspace'
+
+ExtraSpace.configure do |config|
+  config.user_agent = '../..' # ENV['EXTRASPACE_USER_AGENT']
+  config.timeout = 30 # ENV['EXTRASPACE_TIMEOUT']
+end
+```
+
 ## Usage
 
 ```ruby

data/lib/extraspace/address.rb

@@ -19,6 +19,20 @@ module ExtraSpace
     #   @return [String]
     attr_accessor :zip
 
+    # @param data [Hash]
+    #
+    # @return [Address]
+    def self.parse(data:)
+      lines = %w[line1 line2 line3 line4].map { |key| data[key] }
+
+      new(
+        street: lines.compact.reject(&:empty?).join(' '),
+        city: data['city'],
+        state: data['stateName'],
+        zip: data['postalCode']
+      )
+    end
+
     # @param street [String]
     # @param city [String]
     # @param state [String]
@@ -45,19 +59,5 @@ module ExtraSpace
     def text
       "#{street}, #{city}, #{state} #{zip}"
     end
-
-    # @param data [Hash]
-    #
-    # @return [Address]
-    def self.parse(data:)
-      lines = %w[line1 line2 line3 line4].map { |key| data[key] }
-
-      new(
-        street: lines.compact.reject(&:empty?).join(' '),
-        city: data['city'],
-        state: data['stateName'],
-        zip: data['postalCode']
-      )
-    end
   end
 end

data/lib/extraspace/cli.rb

@@ -31,7 +31,7 @@ module ExtraSpace
     private
 
     def crawl
-      ExtraSpace::Facility.crawl
+      Crawl.run
       exit(Code::OK)
     end
 

data/lib/extraspace/config.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module ExtraSpace
+  # The core configuration.
+  class Config
+    # @attribute [rw] accept_language
+    #   @return [String]
+    attr_accessor :accept_language
+
+    # @attribute [rw] user_agent
+    #   @return [String]
+    attr_accessor :user_agent
+
+    # @attribute [rw] timeout
+    #   @return [Integer]
+    attr_accessor :timeout
+
+    # @attribute [rw] proxy_url
+    #   @return [String]
+    attr_accessor :proxy_url
+
+    def initialize
+      @accept_language = ENV.fetch('EXTRASPACE_ACCEPT_LANGUAGE', 'en-US,en;q=0.9')
+      @user_agent = ENV.fetch('EXTRASPACE_USER_AGENT', "extraspace.rb/#{VERSION}")
+      @timeout = Integer(ENV.fetch('EXTRASPACE_TIMEOUT', 60))
+      @proxy_url = ENV.fetch('EXTRASPACE_PROXY_URL', nil)
+    end
+
+    # @return [Boolean]
+    def headers?
+      !@user_agent.nil?
+    end
+
+    # @return [Boolean]
+    def timeout?
+      !@timeout.zero?
+    end
+
+    # @return [Boolean]
+    def proxy?
+      !@proxy_url.nil?
+    end
+
+    # @return [Hash<String, String>] e.g { 'User-Agent' => 'extraspace.rb/1.0.0' }
+    def headers
+      {
+        'Accept-Language' => @accept_language,
+        'User-Agent' => @user_agent
+      }
+    end
+
+    # @return [Array] e.g. ['proxy.example.com', 8080, 'user', 'pass']
+    def via
+      proxy_uri = URI.parse(@proxy_url)
+      [proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password]
+    end
+  end
+end

data/lib/extraspace/crawl.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ExtraSpace
+  # Handles the crawl command via CLI.
+  class Crawl
+    def self.run(...)
+      new(...).run
+    end
+
+    # @param stdout [IO] optional
+    # @param stderr [IO] optional
+    # @param options [Hash] optional
+    def initialize(stdout: $stdout, stderr: $stderr, options: {})
+      @stdout = stdout
+      @stderr = stderr
+      @options = options
+    end
+
+    def run
+      sitemap = Facility.sitemap
+      @stdout.puts("count=#{sitemap.links.count}")
+      @stdout.puts
+
+      sitemap.links.each { |link| process(url: link.loc) }
+    end
+
+    def process(url:)
+      @stdout.puts(url)
+      facility = Facility.fetch(url: url)
+      @stdout.puts(facility.text)
+      facility.prices.each { |price| @stdout.puts(price.text) }
+      @stdout.puts
+    rescue FetchError => e
+      @stderr.puts("url=#{url} error=#{e.message}")
+    end
+  end
+end

data/lib/extraspace/crawler.rb

@@ -3,6 +3,8 @@
 module ExtraSpace
   # Used to fetch and parse either HTML or XML via a URL.
   class Crawler
+    HOST = 'https://www.extraspace.com'
+
     # Raised for unexpected HTTP responses.
     class FetchError < StandardError
       # @param url [String]
@@ -26,10 +28,24 @@ module ExtraSpace
       new.xml(url:)
     end
 
+    # @return [HTTP::Client]
+    def connection
+      @connection ||= begin
+        config = ExtraSpace.config
+
+        connection = HTTP.use(:auto_deflate).use(:auto_inflate).persistent(HOST)
+        connection = connection.headers('User-Agent' => config.user_agent) if config.user_agent
+        connection = connection.timeout(config.timeout) if config.timeout
+        connection = connection.via(*config.via) if config.proxy?
+
+        connection
+      end
+    end
+
     # @param url [String]
     # @return [HTTP::Response]
     def fetch(url:)
-      response = HTTP.get(url)
+      response = connection.get(url)
       raise FetchError.new(url:, response: response.flush) unless response.status.ok?
 
       response

data/lib/extraspace/dimensions.rb

@@ -3,25 +3,34 @@
 module ExtraSpace
   # The dimensions (width + depth + sqft) of a price.
   class Dimensions
+    DEFAULT_HEIGHT = 8.0 # feet
+
     # @attribute [rw] depth
-    #   @return [Integer]
+    #   @return [Float]
     attr_accessor :depth
 
     # @attribute [rw] width
-    #  @return [Integer]
+    #  @return [Float]
     attr_accessor :width
 
-    # @attribute [rw] sqft
-    #   @return [Integer]
-    attr_accessor :sqft
+    # @attribute [rw] height
+    #   @return [Float]
+    attr_accessor :height
 
-    # @param depth [Integer]
-    # @param width [Integer]
-    # @param sqft [Integer]
-    def initialize(depth:, width:, sqft:)
+    # @param data [Hash]
+    #
+    # @return [Dimensions]
+    def self.parse(data:)
+      new(depth: data['depth'], width: data['width'], height: DEFAULT_HEIGHT)
+    end
+
+    # @param depth [Float]
+    # @param width [Float]
+    # @param height [Float]
+    def initialize(depth:, width:, height: DEFAULT_HEIGHT)
       @depth = depth
       @width = width
-      @sqft = sqft
+      @height = height
     end
 
     # @return [String]
@@ -29,21 +38,24 @@ module ExtraSpace
       props = [
         "depth=#{@depth.inspect}",
         "width=#{@width.inspect}",
-        "sqft=#{@sqft.inspect}"
+        "height=#{@height.inspect}"
       ]
       "#<#{self.class.name} #{props.join(' ')}>"
     end
 
-    # @return [String] e.g. "10' × 10' (100 sqft)"
-    def text
-      "#{format('%g', @width)}' × #{format('%g', @depth)}' (#{@sqft} sqft)"
+    # @return [Integer]
+    def sqft
+      Integer(@width * @depth)
     end
 
-    # @param data [Hash]
-    #
-    # @return [Dimensions]
-    def self.parse(data:)
-      new(depth: data['depth'], width: data['width'], sqft: data['squareFoot'])
+    # @return [Integer]
+    def cuft
+      Integer(@width * @depth * @height)
+    end
+
+    # @return [String] e.g. "10' × 10' (100 sqft)"
+    def text
+      "#{format('%g', @width)}' × #{format('%g', @depth)}' (#{sqft} sqft)"
     end
   end
 end

data/lib/extraspace/facility.rb

@@ -5,16 +5,31 @@ module ExtraSpace
   #
   # e.g. https://www.extraspace.com/storage/facilities/us/alabama/auburn/3264/
   class Facility
+    DEFAULT_EMAIL = 'info@extraspace.com'
+    DEFAULT_PHONE = '1-855-518-1443'
+
     SITEMAP_URL = 'https://www.extraspace.com/facility-sitemap.xml'
 
     # @attribute [rw] id
     #   @return [String]
     attr_accessor :id
 
+    # @attribute [rw] url
+    #   @return [String]
+    attr_accessor :url
+
     # @attribute [rw] name
     #   @return [String]
     attr_accessor :name
 
+    # @attribute [rw] phone
+    #   @return [String]
+    attr_accessor :phone
+
+    # @attribute [rw] email
+    #   @return [String]
+    attr_accessor :email
+
     # @attribute [rw] address
     #   @return [Address]
     attr_accessor :address
@@ -37,14 +52,15 @@ module ExtraSpace
     # @return [Facility]
     def self.fetch(url:)
       document = Crawler.html(url:)
-      data = JSON.parse(document.at('#__NEXT_DATA__').text)
-      parse(data:)
+      parse(url:, document:)
     end
 
-    # @param data [Hash]
+    # @param url [String]
+    # @param document [Nokogiri::HTML::Document]
     #
     # @return [Facility]
-    def self.parse(data:)
+    def self.parse(url:, document:)
+      data = parse_next_data(document: document)
       page_data = data.dig('props', 'pageProps', 'pageData', 'data')
       store_data = page_data.dig('facilityData', 'data', 'store')
       unit_classes = page_data.dig('unitClasses', 'data', 'unitClasses')
@@ -55,7 +71,16 @@ module ExtraSpace
       geocode = Geocode.parse(data: store_data['geocode'])
       prices = unit_classes.map { |price_data| Price.parse(data: price_data) }
 
-      new(id:, name:, address:, geocode:, prices:)
+      new(id:, url:, name:, address:, geocode:, prices:)
+    end
+
+    # @param document [Nokogiri::HTML::Document]
+    #
+    # @raise [ParseError]
+    #
+    # @return [Hash]
+    def self.parse_next_data(document:)
+      JSON.parse(document.at('#__NEXT_DATA__').text)
     end
 
     def self.crawl
@@ -74,15 +99,21 @@ module ExtraSpace
     end
 
     # @param id [String]
+    # @param url [String]
     # @param name [String]
     # @param address [Address]
     # @param geocode [Geocode]
+    # @param phone [String]
+    # @param email [String]
     # @param prices [Array<Price>]
-    def initialize(id:, name:, address:, geocode:, prices:)
+    def initialize(id:, url:, name:, address:, geocode:, phone: DEFAULT_PHONE, email: DEFAULT_EMAIL, prices: [])
       @id = id
+      @url = url
       @name = name
       @address = address
       @geocode = geocode
+      @phone = phone
+      @email = email
       @prices = prices
     end
 
@@ -90,16 +121,19 @@ module ExtraSpace
     def inspect
       props = [
         "id=#{@id.inspect}",
+        "url=#{@url.inspect}",
         "address=#{@address.inspect}",
         "geocode=#{@geocode.inspect}",
+        "phone=#{@phone.inspect}",
+        "email=#{@email.inspect}",
         "prices=#{@prices.inspect}"
       ]
       "#<#{self.class.name} #{props.join(' ')}>"
     end
 
-    # @return [String] e.g. "123 Main St, Springfield, IL 62701"
+    # @return [String]
     def text
-      "#{@id} | #{@name} | #{@address.text} | #{@geocode.text}"
+      "#{@id} | #{@name} | #{@phone} | #{@email} | #{@address.text} | #{@geocode.text}"
     end
   end
 end

data/lib/extraspace/features.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module ExtraSpace
+  # The features (e.g. climate-controlled, inside-drive-up-access, outside-drive-up-access, etc) of a price.
+  class Features
+    FIRST_FLOOR_ACCESS_NAME = '1stFloorAccess'
+    CLIMATE_CONTROLLED_NAME = 'ClimateControlled'
+    DRIVE_UP_ACCESS_NAME = 'DriveUpAccess'
+    ELEVATOR_ACCESS_NAME = 'ElevatorAccess'
+
+    # @param data [Array<Hash>]
+    #
+    # @return [Features]
+    def self.parse(data:)
+      new(
+        climate_controlled: data.any? { |feature| feature['name'].eql?(CLIMATE_CONTROLLED_NAME) },
+        drive_up_access: data.any? { |feature| feature['name'].eql?(DRIVE_UP_ACCESS_NAME) },
+        elevator_access: data.any? { |feature| feature['name'].eql?(ELEVATOR_ACCESS_NAME) },
+        first_floor_access: data.any? { |feature| feature['name'].eql?(FIRST_FLOOR_ACCESS_NAME) }
+      )
+    end
+
+    # @param climate_controlled [Boolean]
+    # @param drive_up_access [Boolean]
+    # @param first_floor_access [Boolean]
+    def initialize(climate_controlled:, drive_up_access:, elevator_access:, first_floor_access:)
+      @climate_controlled = climate_controlled
+      @drive_up_access = drive_up_access
+      @elevator_access = elevator_access
+      @first_floor_access = first_floor_access
+    end
+
+    # @return [String]
+    def inspect
+      props = [
+        "climate_controlled=#{@climate_controlled}",
+        "drive_up_access=#{@drive_up_access}",
+        "elevator_access=#{@elevator_access}",
+        "first_floor_access=#{@first_floor_access}"
+      ]
+
+      "#<#{self.class.name} #{props.join(' ')}>"
+    end
+
+    # @return [String] e.g. "Climate Controlled + First Floor Access"
+    def text
+      amenities.join(' + ')
+    end
+
+    # @return [Array<String>]
+    def amenities
+      [].tap do |amenities|
+        amenities << 'Climate Controlled' if climate_controlled?
+        amenities << 'Drive-Up Access' if drive_up_access?
+        amenities << 'Elevator Access' if elevator_access?
+        amenities << 'First Floor Access' if first_floor_access?
+      end
+    end
+
+    # @return [Boolean]
+    def climate_controlled?
+      @climate_controlled
+    end
+
+    # @return [Boolean]
+    def drive_up_access?
+      @drive_up_access
+    end
+
+    # @return [Boolean]
+    def elevator_access?
+      @elevator_access
+    end
+
+    # @return [Boolean]
+    def first_floor_access?
+      @first_floor_access
+    end
+  end
+end

data/lib/extraspace/geocode.rb

@@ -11,6 +11,16 @@ module ExtraSpace
     #   @return [Float]
     attr_accessor :longitude
 
+    # @param data [Hash]
+    #
+    # @return [Geocode]
+    def self.parse(data:)
+      new(
+        latitude: data['latitude'],
+        longitude: data['longitude']
+      )
+    end
+
     # @param latitude [Float]
     # @param longitude [Float]
     def initialize(latitude:, longitude:)
@@ -31,15 +41,5 @@ module ExtraSpace
     def text
       "#{@latitude},#{@longitude}"
     end
-
-    # @param data [Hash]
-    #
-    # @return [Geocode]
-    def self.parse(data:)
-      new(
-        latitude: data['latitude'],
-        longitude: data['longitude']
-      )
-    end
   end
 end

data/lib/extraspace/price.rb

@@ -11,16 +11,34 @@ module ExtraSpace
     #   @return [Dimensions]
     attr_accessor :dimensions
 
+    # @attribute [rw] features
+    #   @return [Features]
+    attr_accessor :features
+
     # @attribute [rw] rates
     #   @return [Rates]
     attr_accessor :rates
 
+    # @param data [Hash]
+    #
+    # @return [Price]
+    def self.parse(data:)
+      new(
+        id: data['uid'],
+        dimensions: Dimensions.parse(data: data['dimensions']),
+        features: Features.parse(data: data['features']),
+        rates: Rates.parse(data: data['rates'])
+      )
+    end
+
     # @param id [String]
     # @param dimensions [Dimensions]
+    # @param features [Features]
     # @param rates [Rates]
-    def initialize(id:, dimensions:, rates:)
+    def initialize(id:, dimensions:, features:, rates:)
       @id = id
       @dimensions = dimensions
+      @features = features
       @rates = rates
     end
 
@@ -29,6 +47,7 @@ module ExtraSpace
       props = [
         "id=#{@id.inspect}",
         "dimensions=#{@dimensions.inspect}",
+        "features=#{@features.inspect}",
         "rates=#{@rates.inspect}"
       ]
       "#<#{self.class.name} #{props.join(' ')}>"
@@ -38,18 +57,5 @@ module ExtraSpace
     def text
       "#{@id} | #{@dimensions.text} | #{@rates.text}"
     end
-
-    # @param data [Hash]
-    #
-    # @return [Price]
-    def self.parse(data:)
-      dimensions = Dimensions.parse(data: data['dimensions'])
-      rates = Rates.parse(data: data['rates'])
-      new(
-        id: data['uid'],
-        dimensions: dimensions,
-        rates: rates
-      )
-    end
   end
 end

data/lib/extraspace/rates.rb

@@ -11,6 +11,16 @@ module ExtraSpace
     #   @return [Integer]
     attr_accessor :web
 
+    # @param data [Hash]
+    #
+    # @return [Rates]
+    def self.parse(data:)
+      new(
+        street: data['street'],
+        web: data['web']
+      )
+    end
+
     # @param street [Integer]
     # @param web [Integer]
     def initialize(street:, web:)
@@ -31,15 +41,5 @@ module ExtraSpace
     def text
       "$#{@street} (street) | $#{@web} (web)"
     end
-
-    # @param data [Hash]
-    #
-    # @return [Rates]
-    def self.parse(data:)
-      new(
-        street: data['street'],
-        web: data['web']
-      )
-    end
   end
 end

data/lib/extraspace/version.rb

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

data/lib/extraspace.rb

@@ -9,6 +9,18 @@ loader.inflector.inflect 'extraspace' => 'ExtraSpace'
 loader.inflector.inflect 'cli' => 'CLI'
 loader.setup
 
+# An interface for ExtraSpace.
 module ExtraSpace
   class Error < StandardError; end
+
+  # @return [Config]
+  def self.config
+    @config ||= Config.new
+  end
+
+  # @yield [config]
+  # @yieldparam config [Config]
+  def self.configure
+    yield config
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extraspace
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-27 00:00:00.000000000 Z
+date: 2024-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -96,9 +96,12 @@ files:
 - lib/extraspace.rb
 - lib/extraspace/address.rb
 - lib/extraspace/cli.rb
+- lib/extraspace/config.rb
+- lib/extraspace/crawl.rb
 - lib/extraspace/crawler.rb
 - lib/extraspace/dimensions.rb
 - lib/extraspace/facility.rb
+- lib/extraspace/features.rb
 - lib/extraspace/geocode.rb
 - lib/extraspace/link.rb
 - lib/extraspace/price.rb