publicstorage 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91f7ec4d785ae72a4a91766044921b18fbb72bd794df5ef84396d691d8c8e20d
-  data.tar.gz: b34ad3956eb8b9983aa5c02a67f236c4ba3caf42bfa676a14993e0452fe95992
+  metadata.gz: 5f5319690995d8d7f216e02fa0ead21f9c3bfc136e2e9ed8d46333f840909474
+  data.tar.gz: f0da92039ca2c9dd5dbf1256a5e3df2cffa304763ee766229e0175bfcf817047
 SHA512:
-  metadata.gz: 17c85cd24def5db02b92ad2a8e8c4e2919344868102f6a16dea871af3f162152f8211dc0207425d81a905d925c90b3f43ecf0daf30b8d56fce77dfe4b9e8b6fa
-  data.tar.gz: f1ae2c946fbaa636dab672ad84af48962dd3635129bca987224c0cc9c739af520d49d6b5d1fd9cb15d4684c22618816912e64c71585f1dec227dc0ed2eb84c59
+  metadata.gz: 723e933f0da23b57b731e9123a7a412eb9984e7f54897a77304d1f0753cc274f1ffbf68711b59d25e4f9283f38ca4e3ee0aa8ffc9e606cdf26f0a92d4581e634
+  data.tar.gz: 5149248cc1fa272c78cc9ac8666bfe52501b23228a2dba66533c94c25ca5294fc9e31717fae635ea46361253428197c0007f1f577fca0e34cde15f49021bb4bf

data/README.md

@@ -20,24 +20,20 @@ require 'publicstorage'
 sitemap = PublicStorage::Facility.sitemap
 sitemap.links.each do |link|
   url = link.loc
+  facility = ExtraSpace::Facility.fetch(url:)
 
-  facility = PublicStorage::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
+  puts facility.text
 
   facility.prices.each do |price|
-    puts "ID: #{price.id}"
-    puts "Width: #{price.dimensions.width}"
-    puts "Depth: #{price.dimensions.depth}"
-    puts "SQFT: #{price.dimensions.sqft}"
-    puts "Rates: $#{price.rates.street} (street) / $#{price.rates.web} (web)"
-    puts
+    puts price.text
   end
+
+  puts
 end
 ```
+
+## CLI
+
+```bash
+publicstorage crawl
+```

data/exe/publicstorage

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

data/lib/publicstorage/address.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PublicStorage
-  # Represents an address associated with a facility.
+  # The address (street + city + state + zip) of a facility.
   class Address
     # @attribute [rw] street
     #   @return [String]
@@ -41,6 +41,11 @@ module PublicStorage
       "#<#{self.class.name} #{props.join(' ')}>"
     end
 
+    # @return [String]
+    def text
+      "#{street}, #{city}, #{state} #{zip}"
+    end
+
     # @param data [Hash]
     #
     # @return [Address]

data/lib/publicstorage/cli.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module PublicStorage
+  # Used when interacting with the library from the command line interface (CLI).
+  #
+  # Usage:
+  #
+  #   cli = PublicStorage::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
+      PublicStorage::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: PublicStorage [options] <command> [<args>]'
+
+        options.on('-h', '--help', 'help') { help(options) }
+        options.on('-v', '--version', 'version') { version }
+      end
+    end
+  end
+end

data/lib/publicstorage/crawler.rb

@@ -30,7 +30,7 @@ module PublicStorage
     # @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/publicstorage/dimensions.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PublicStorage
-  # The dimensions associated with a price.
+  # The dimensions (width + depth + sqft) of a price.
   class Dimensions
     SELECTOR = '.unit-size'
 
@@ -36,6 +36,11 @@ module PublicStorage
       "#<#{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 element [Nokogiri::XML::Element]
     #
     # @return [Dimensions]

data/lib/publicstorage/facility.rb

@@ -6,6 +6,17 @@ module PublicStorage
     SITEMAP_URL = 'https://www.publicstorage.com/sitemap_0-product.xml'
 
     PRICE_SELECTOR = '.units-results-section .unit-list-group .unit-list-item'
+    LD_SELECTOR = 'script[type="application/ld+json"]'
+
+    ID_REGEX = /(?<id>\d+)\.html/
+
+    # @attribute [rw] id
+    #   @return [Integer]
+    attr_accessor :id
+
+    # @attribute [rw] name
+    #   @return [String]
+    attr_accessor :name
 
     # @attribute [rw] address
     #   @return [Address]
@@ -19,25 +30,6 @@ module PublicStorage
     #   @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 +47,65 @@ module PublicStorage
     #
     # @return [Facility]
     def self.parse(document:)
-      data = JSON.parse(document.at_css('script[type="application/ld+json"]').text)
-      item = data.find { |entry| entry['@type'] == 'SelfStorage' }
-      address = Address.parse(data: item['address'])
-      geocode = Geocode.parse(data: item['geo'])
+      data = parse_ld(document:)
+      id = Integer(data['url'].match(ID_REGEX)[:id])
+      name = data['name']
+      address = Address.parse(data: data['address'])
+      geocode = Geocode.parse(data: data['geo'])
 
       prices = document.css(PRICE_SELECTOR).map { |element| Price.parse(element:) }
 
-      new(address:, geocode:, prices:)
+      new(id:, name:, address:, geocode:, prices:)
+    end
+
+    # @param document [NokoGiri::XML::Document]
+    #
+    # @return [Hash]
+    def self.parse_ld(document:)
+      JSON.parse(document.at_css(LD_SELECTOR).text).find { |entry| entry['@type'] == 'SelfStorage' }
+    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 = [
+        "address=#{@address.inspect}",
+        "geocode=#{@geocode.inspect}",
+        "prices=#{@prices.inspect}"
+      ]
+      "#<#{self.class.name} #{props.join(' ')}>"
+    end
+
+    # @return [String]
+    def text
+      "#{@id} | #{@name} | #{@address.text} | #{@geocode.text}"
     end
   end
 end

data/lib/publicstorage/geocode.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PublicStorage
-  # A geocode associated with a facility.
+  # The geocode (latitude + longitude) of a facility.
   class Geocode
     # @attribute [rw] latitude
     #   @return [Float]
@@ -27,6 +27,11 @@ module PublicStorage
       "#<#{self.class.name} #{props.join(' ')}>"
     end
 
+    # @return [String]
+    def text
+      "#{@latitude},#{@longitude}"
+    end
+
     # @param data [Hash]
     #
     # @return [Geocode]

data/lib/publicstorage/price.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PublicStorage
-  # A price associated with a unit.
+  # The price (id + dimensions + rate) for a facility
   class Price
     # @attribute [rw] id
     #   @return [String]
@@ -34,6 +34,11 @@ module PublicStorage
       "#<#{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 element [Nokogiri::XML::Element]
     #
     # @return [Price]

data/lib/publicstorage/rates.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PublicStorage
-  # The rates associated with a price
+  # The rates (street + web) for a facility
   class Rates
     STREET_SELECTOR = '.unit-prices .unit-pricing .unit-strike-through-price'
     WEB_SELECTOR = '.unit-prices .unit-pricing .unit-price'
@@ -30,6 +30,11 @@ module PublicStorage
       "#<#{self.class.name} #{props.join(' ')}>"
     end
 
+    # @return [String] e.g. "$80 (street) | $60 (web)"
+    def text
+      "$#{@street} (street) | $#{@web} (web)"
+    end
+
     # @param element [Nokogiri::XML::Element]
     #
     # @return [Rates]

data/lib/publicstorage/sitemap.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module PublicStorage
-  # A sitemap.
+  # A sitemap on publicstorage.com.
+  #
+  # e.g. https://www.publicstorage.com/sitemap_0-product.xml
   class Sitemap
     # @attribute [rw] links
     #   @return [Array<Link>]

data/lib/publicstorage/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PublicStorage
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/publicstorage.rb

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

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: publicstorage
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Sylvestre
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
 date: 2024-11-27 00:00:00.000000000 Z
@@ -69,7 +69,8 @@ dependencies:
 description: Uses HTTP.rb to scrape publicstorage.com.
 email:
 - kevin@ksylvest.com
-executables: []
+executables:
+- publicstorage
 extensions: []
 extra_rdoc_files: []
 files:
@@ -77,8 +78,10 @@ files:
 - README.md
 - bin/console
 - bin/setup
+- exe/publicstorage
 - lib/publicstorage.rb
 - lib/publicstorage/address.rb
+- lib/publicstorage/cli.rb
 - lib/publicstorage/crawler.rb
 - lib/publicstorage/dimensions.rb
 - lib/publicstorage/facility.rb
@@ -96,7 +99,7 @@ metadata:
   homepage_uri: https://github.com/ksylvest/publicstorage
   source_code_uri: https://github.com/ksylvest/publicstorage
   changelog_uri: https://github.com/ksylvest/publicstorage
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -111,8 +114,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 PublicStorage.
 test_files: []