extraspace 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2d656b5fbca3894562492b6a8c3e90c97a4c785cf88d6ff7c2c65c380a5ba8e
-  data.tar.gz: c564ac28246067bfb3d843070aa8ea3dcaa0898e12161e15c7570439cd8d4907
+  metadata.gz: e31518705b665cfcff3914a8553164f1463a3c66140cb41ea14be9154abf44fa
+  data.tar.gz: bf86b8674cf0557e239b286acaca2f77d1688bd3f431434ad15914db9624a143
 SHA512:
-  metadata.gz: 503b60e74410c4fe5cf0db8644382555cf0ddb8343790e5eed69d61c7b8d5e494be3cdbd55097fee3454f555f2bd030722b704906384da65d020e688252ad46a
-  data.tar.gz: d48d92e05c00b065619738803344b79254ecb29cec4e9d461a47709169c1125864d278f07ce421647b17d2e6f83efdb09c9a102fe393766edab8d5aa457639db
+  metadata.gz: 6204e8de2f7349debac7049c5ca1ade4fc0b5328be5faaf61eefb42d982e735897c28fc6292ac98c6a40e36dadf94550fcd30f5a066b3eb58ba8de7db3c2c20d
+  data.tar.gz: edd94f3a7d6dadc415f112f7dd3fa1ff7e8ae5fd8592794e3a218a3806e5ec7777659eeaee3bde305af51eee67f23fb5b5862925f51fc54d22ff5aa5ad863f34

data/README.md

@@ -20,23 +20,20 @@ require 'extraspace'
 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
+  puts facility.text
 
   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
+    puts price.text
   end
+
+  puts
 end
 ```
+
+## CLI
+
+```bash
+extraspace crawl
+```

data/exe/extraspace

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'extraspace'
+
+cli = ExtraSpace::CLI.new
+cli.parse

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}"
@@ -48,13 +41,19 @@ module ExtraSpace
       "#<#{self.class.name} #{props.join(' ')}>"
     end
 
+    # @return [String]
+    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(
-        line1: data['line1'],
-        line2: data['line2'],
+        street: lines.compact.reject(&:empty?).join(' '),
         city: data['city'],
         state: data['stateName'],
         zip: data['postalCode']

data/lib/extraspace/cli.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module ExtraSpace
+  # Used when interacting with the library from the command line interface (CLI).
+  #
+  # Usage:
+  #
+  #   cli = ExtraSpace::CLI.new
+  #   cli.parse
+  class CLI
+    module Code
+      OK = 0
+      ERROR = 1
+    end
+
+    # @param argv [Array<String>]
+    def parse(argv = ARGV)
+      parser.parse!(argv)
+      command = argv.shift
+
+      case command
+      when 'crawl' then crawl
+      else
+        warn("unsupported command=#{command.inspect}")
+        exit(Code::ERROR)
+      end
+    end
+
+    private
+
+    def crawl
+      ExtraSpace::Facility.crawl
+      exit(Code::OK)
+    end
+
+    def help(options)
+      puts(options)
+      exit(Code::OK)
+    end
+
+    def version
+      puts(VERSION)
+      exit(Code::OK)
+    end
+
+    # @return [OptionParser]
+    def parser
+      OptionParser.new do |options|
+        options.banner = 'usage: extraspace [options] <command> [<args>]'
+
+        options.on('-h', '--help', 'help') { help(options) }
+        options.on('-v', '--version', 'version') { version }
+      end
+    end
+  end
+end

data/lib/extraspace/crawler.rb

@@ -8,7 +8,7 @@ module ExtraSpace
       # @param url [String]
       # @param response [HTTP::Response]
       def initialize(url:, response:)
-        super("url=#{url} status=#{response.status.inspect} body=#{response.body.inspect}")
+        super("url=#{url} status=#{response.status.inspect} body=#{String(response.body).inspect}")
       end
     end
 
@@ -30,7 +30,7 @@ module ExtraSpace
     # @return [HTTP::Response]
     def fetch(url:)
       response = HTTP.get(url)
-      raise FetchError(url:, response: response.flush) unless response.status.ok?
+      raise FetchError.new(url:, response: response.flush) unless response.status.ok?
 
       response
     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,17 +29,21 @@ module ExtraSpace
       props = [
         "depth=#{@depth.inspect}",
         "width=#{@width.inspect}",
-        "sqft=#{@sqft.inspect}",
-        "display=#{@display.inspect}"
+        "sqft=#{@sqft.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)"
+    end
+
     # @param data [Hash]
     #
     # @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,10 +1,20 @@
 # 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] id
+    #   @return [String]
+    attr_accessor :id
+
+    # @attribute [rw] name
+    #   @return [String]
+    attr_accessor :name
+
     # @attribute [rw] address
     #   @return [Address]
     attr_accessor :address
@@ -17,25 +27,6 @@ module ExtraSpace
     #   @return [Array<Price>]
     attr_accessor :prices
 
-    # @param address [Address]
-    # @param geocode [Geocode]
-    # @param prices [Array<Price>]
-    def initialize(address:, geocode:, prices:)
-      @address = address
-      @geocode = geocode
-      @prices = prices
-    end
-
-    # @return [String]
-    def inspect
-      props = [
-        "address=#{@address.inspect}",
-        "geocode=#{@geocode.inspect}",
-        "prices=#{@prices.inspect}"
-      ]
-      "#<#{self.class.name} #{props.join(' ')}>"
-    end
-
     # @return [Sitemap]
     def self.sitemap
       Sitemap.fetch(url: SITEMAP_URL)
@@ -55,14 +46,60 @@ module ExtraSpace
     # @return [Facility]
     def self.parse(data:)
       page_data = data.dig('props', 'pageProps', 'pageData', 'data')
-      facility_data = page_data.dig('facilityData', 'data')
+      store_data = page_data.dig('facilityData', 'data', 'store')
       unit_classes = page_data.dig('unitClasses', 'data', 'unitClasses')
+      id = store_data['number']
+      name = store_data['name']
 
-      address = Address.parse(data: facility_data['store']['address'])
-      geocode = Geocode.parse(data: facility_data['store']['geocode'])
+      address = Address.parse(data: store_data['address'])
+      geocode = Geocode.parse(data: store_data['geocode'])
       prices = unit_classes.map { |price_data| Price.parse(data: price_data) }
 
-      new(address:, geocode:, prices:)
+      new(id:, name:, address:, geocode:, prices:)
+    end
+
+    def self.crawl
+      sitemap.links.each do |link|
+        url = link.loc
+
+        facility = fetch(url:)
+        puts facility.text
+
+        facility.prices.each do |price|
+          puts price.text
+        end
+
+        puts
+      end
+    end
+
+    # @param id [String]
+    # @param name [String]
+    # @param address [Address]
+    # @param geocode [Geocode]
+    # @param prices [Array<Price>]
+    def initialize(id:, name:, address:, geocode:, prices:)
+      @id = id
+      @name = name
+      @address = address
+      @geocode = geocode
+      @prices = prices
+    end
+
+    # @return [String]
+    def inspect
+      props = [
+        "id=#{@id.inspect}",
+        "address=#{@address.inspect}",
+        "geocode=#{@geocode.inspect}",
+        "prices=#{@prices.inspect}"
+      ]
+      "#<#{self.class.name} #{props.join(' ')}>"
+    end
+
+    # @return [String] e.g. "123 Main St, Springfield, IL 62701"
+    def text
+      "#{@id} | #{@name} | #{@address.text} | #{@geocode.text}"
     end
   end
 end

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]
@@ -27,6 +27,11 @@ module ExtraSpace
       "#<#{self.class.name} #{props.join(' ')}>"
     end
 
+    # @return [String]
+    def text
+      "#{@latitude},#{@longitude}"
+    end
+
     # @param data [Hash]
     #
     # @return [Geocode]

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,24 +27,26 @@ module ExtraSpace
     # @return [String]
     def inspect
       props = [
-        "uid=#{@uid.inspect}",
-        "availability=#{@availability.inspect}",
+        "id=#{@id.inspect}",
         "dimensions=#{@dimensions.inspect}",
         "rates=#{@rates.inspect}"
       ]
       "#<#{self.class.name} #{props.join(' ')}>"
     end
 
+    # @return [String] e.g. "123 | 5' × 5' (25 sqft) | $100 (street) / $90 (web)"
+    def text
+      "#{@id} | #{@dimensions.text} | #{@rates.text}"
+    end
+
     # @param data [Hash]
     #
     # @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,19 +21,22 @@ module ExtraSpace
     # @return [String]
     def inspect
       props = [
-        "nsc=#{@nsc.inspect}",
         "street=#{@street.inspect}",
         "web=#{@web.inspect}"
       ]
       "#<#{self.class.name} #{props.join(' ')}>"
     end
 
+    # @return [String] e.g. "$80 (street) | $60 (web)"
+    def text
+      "$#{@street} (street) | $#{@web} (web)"
+    end
+
     # @param data [Hash]
     #
     # @return [Rates]
     def self.parse(data:)
       new(
-        nsc: data['nsc'],
         street: data['street'],
         web: data['web']
       )

data/lib/extraspace/sitemap.rb

@@ -1,6 +1,8 @@
 # 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

data/lib/extraspace/version.rb

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

data/lib/extraspace.rb

@@ -6,6 +6,7 @@ require 'zeitwerk'
 
 loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect 'extraspace' => 'ExtraSpace'
+loader.inflector.inflect 'cli' => 'CLI'
 loader.setup
 
 module ExtraSpace

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extraspace
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-26 00:00:00.000000000 Z
+date: 2024-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: optparse
+  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'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -69,7 +83,8 @@ dependencies:
 description: Uses HTTP.rb to scrape extraspace.com.
 email:
 - kevin@ksylvest.com
-executables: []
+executables:
+- extraspace
 extensions: []
 extra_rdoc_files: []
 files:
@@ -77,9 +92,10 @@ files:
 - README.md
 - bin/console
 - bin/setup
+- exe/extraspace
 - lib/extraspace.rb
 - lib/extraspace/address.rb
-- lib/extraspace/availability.rb
+- lib/extraspace/cli.rb
 - lib/extraspace/crawler.rb
 - lib/extraspace/dimensions.rb
 - lib/extraspace/facility.rb

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