publicstorage 0.3.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34a6d2f42dac72b5aac92461444a57e40f3dd42ace468fc24f61ac62c81d09e1
-  data.tar.gz: bbb5c737bcf5236e4236fe6d0b336497557f1e300938924b1eb9727c204a9ff1
+  metadata.gz: f797ad8918b9cea8da35957e83b8bbf56ab02f1bfae95ee24a0fe1a316d1117d
+  data.tar.gz: e2a976a36b0fc0d5edefde19c7234b778257341abc9c9507029bac2d6e31f1e3
 SHA512:
-  metadata.gz: b1bed2e588707393e89bf67a416bc8f3622dda29e3c8b4754cfd015f224555530a628cce7cbb68e5c4787c745905493ae8c6e6efe14a8c6d84fae852f213474b
-  data.tar.gz: e46336139bbf2f3054cff093e650b88c5e84b7bb0beaa876b5f833d192c641fa3e48449ca27a3af1215a2fdd9dafd284c937348951248e5704ca62668b43f11d
+  metadata.gz: eb338e5697de874ba118f47828d19ed3ed817cd136aac67372064fcea2dabde722c34cb39924b55e91bbbca3802b8469b7caf6a5fef5fa64abf559a2c2e38090
+  data.tar.gz: 8ed743ff4a0a59deefe92064d62345d6deaaceb860e597583758b8e7d18eac6f0db6b12f67ef0324212882ef1fea14009501b2ab0566d139241ae4d78d60f7eb

data/README.md

@@ -1,4 +1,4 @@
-# PublicStorage
+# Public Storage
 
 [![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ksylvest/publicstorage/blob/main/LICENSE)
 [![RubyGems](https://img.shields.io/gem/v/publicstorage)](https://rubygems.org/gems/publicstorage)
@@ -6,6 +6,8 @@
 [![Yard](https://img.shields.io/badge/docs-site-blue.svg)](https://publicstorage.ksylvest.com)
 [![CircleCI](https://img.shields.io/circleci/build/github/ksylvest/publicstorage)](https://circleci.com/gh/ksylvest/publicstorage)
 
+A Ruby library offering both a CLI and API for scraping [Public Storage](https://www.publicstorage.com/) self-storage facilities and prices.
+
 ## Installation
 
 ```bash
@@ -31,7 +33,7 @@ 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 facility.text
 
@@ -48,3 +50,7 @@ end
 ```bash
 publicstorage crawl
 ```
+
+```bash
+publicstorage crawl "https://www.publicstorage.com/self-storage-ca-venice/120.html"
+```

data/lib/publicstorage/cli.rb

@@ -21,7 +21,7 @@ module PublicStorage
       command = argv.shift
 
       case command
-      when 'crawl' then crawl
+      when 'crawl' then crawl(*argv)
       else
         warn("unsupported command=#{command.inspect}")
         exit(Code::ERROR)
@@ -30,8 +30,9 @@ module PublicStorage
 
     private
 
-    def crawl
-      PublicStorage::Facility.crawl
+    # @url [String] optional
+    def crawl(url = nil)
+      Crawl.run(url: url)
       exit(Code::OK)
     end
 
@@ -52,6 +53,11 @@ module PublicStorage
 
         options.on('-h', '--help', 'help') { help(options) }
         options.on('-v', '--version', 'version') { version }
+
+        options.separator <<~COMMANDS
+          commands:
+            crawl [url]
+        COMMANDS
       end
     end
   end

data/lib/publicstorage/config.rb

@@ -12,7 +12,7 @@ module PublicStorage
     attr_accessor :timeout
 
     def initialize
-      @user_agent = ENV.fetch('PUBLIC_STORAGE_USER_AGENT', "publicstorage.rb/#{VERSION}")
+      @user_agent = ENV.fetch('PUBLICSTORAGE_USER_AGENT', "publicstorage.rb/#{VERSION}")
       @timeout = Integer(ENV.fetch('PUBLICSTORAGE_TIMEOUT', 60))
     end
   end

data/lib/publicstorage/crawl.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module PublicStorage
+  # Handles the crawl command via CLI.
+  class Crawl
+    def self.run(...)
+      new(...).run
+    end
+
+    # @param stdout [IO] optional
+    # @param stderr [IO] optional
+    # @param url [String] optional
+    def initialize(stdout: $stdout, stderr: $stderr, url: nil)
+      @stdout = stdout
+      @stderr = stderr
+      @url = url
+    end
+
+    def run
+      if @url
+        process(url: @url)
+      else
+        sitemap = Facility.sitemap
+        @stdout.puts("count=#{sitemap.links.count}")
+        @stdout.puts
+        sitemap.links.each { |link| process(url: link.loc) }
+      end
+    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/publicstorage/crawler.rb

@@ -5,15 +5,6 @@ module PublicStorage
   class Crawler
     HOST = 'https://www.publicstorage.com'
 
-    # 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]

data/lib/publicstorage/dimensions.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 module PublicStorage
-  # The dimensions (width + depth + sqft) of a price.
+  # The dimensions (width + depth + height) of a price.
   class Dimensions
+    DEFAULT_HEIGHT = 8.0 # feet
+
     SELECTOR = '.unit-size'
 
     # @attribute [rw] depth
@@ -13,17 +15,17 @@ module PublicStorage
     #  @return [Integer]
     attr_accessor :width
 
-    # @attribute [rw] sqft
-    #   @return [Integer]
-    attr_accessor :sqft
+    # @attribute [rw] height
+    #  @return [Integer]
+    attr_accessor :height
 
     # @param depth [Float]
     # @param width [Float]
-    # @param sqft [Integer]
-    def initialize(depth:, width:, sqft:)
+    # @param height [Float]
+    def initialize(depth:, width:, height: DEFAULT_HEIGHT)
       @depth = depth
       @width = width
-      @sqft = sqft
+      @height = height
     end
 
     # @return [String]
@@ -31,26 +33,35 @@ module PublicStorage
       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)"
+      "#{format('%g', @width)}' × #{format('%g', @depth)}' (#{sqft} sqft)"
+    end
+
+    # @return [Integer]
+    def sqft
+      Integer(@width * @depth)
+    end
+
+    # @return [Integer]
+    def cuft
+      Integer(@width * @depth * @height)
     end
 
-    # @param element [Nokogiri::XML::Element]
+    # @param data [Hash]
     #
     # @return [Dimensions]
-    def self.parse(element:)
-      match = element.at(SELECTOR).text.match(/(?<depth>[\d\.]+)'x(?<width>[\d\.]+)'/)
+    def self.parse(data:)
+      match = data['dimension'].match(/(?<depth>[\d\.]+)'x(?<width>[\d\.]+)'/)
       depth = Float(match[:depth])
       width = Float(match[:width])
-      sqft = Integer(depth * width)
 
-      new(depth:, width:, sqft:)
+      new(depth:, width:, height: DEFAULT_HEIGHT)
     end
   end
 end

data/lib/publicstorage/fetch_error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module PublicStorage
+  # 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
+end

data/lib/publicstorage/price.rb

@@ -3,6 +3,8 @@
 module PublicStorage
   # The price (id + dimensions + rate) for a facility
   class Price
+    GTM_SELECTOR = 'button[data-gtmdata]'
+
     # @attribute [rw] id
     #   @return [String]
     attr_accessor :id
@@ -43,8 +45,10 @@ module PublicStorage
     #
     # @return [Price]
     def self.parse(element:)
-      rates = Rates.parse(element:)
-      dimensions = Dimensions.parse(element:)
+      data = JSON.parse(element.at(GTM_SELECTOR).attribute('data-gtmdata'))
+
+      rates = Rates.parse(data:)
+      dimensions = Dimensions.parse(data:)
 
       new(
         id: element.attr('data-unitid'),

data/lib/publicstorage/rates.rb

@@ -3,9 +3,6 @@
 module PublicStorage
   # 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'
-
     # @attribute [rw] street
     #   @return [Integer]
     attr_accessor :street
@@ -35,12 +32,12 @@ module PublicStorage
       "$#{@street} (street) | $#{@web} (web)"
     end
 
-    # @param element [Nokogiri::XML::Element]
+    # @param data [Hash]
     #
     # @return [Rates]
-    def self.parse(element:)
-      street = Integer(element.at(STREET_SELECTOR).text.match(/(?<value>\d+)/)[:value])
-      web = Integer(element.at(WEB_SELECTOR).text.match(/(?<value>\d+)/)[:value])
+    def self.parse(data:)
+      street = data['listprice']
+      web = data['saleprice']
       new(street:, web:)
     end
   end

data/lib/publicstorage/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: publicstorage
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-27 00:00:00.000000000 Z
+date: 2025-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -83,9 +83,11 @@ files:
 - lib/publicstorage/address.rb
 - lib/publicstorage/cli.rb
 - lib/publicstorage/config.rb
+- lib/publicstorage/crawl.rb
 - lib/publicstorage/crawler.rb
 - lib/publicstorage/dimensions.rb
 - lib/publicstorage/facility.rb
+- lib/publicstorage/fetch_error.rb
 - lib/publicstorage/geocode.rb
 - lib/publicstorage/link.rb
 - lib/publicstorage/price.rb
@@ -98,8 +100,9 @@ licenses:
 metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/ksylvest/publicstorage
-  source_code_uri: https://github.com/ksylvest/publicstorage
-  changelog_uri: https://github.com/ksylvest/publicstorage
+  source_code_uri: https://github.com/ksylvest/publicstorage/tree/v1.1.0
+  changelog_uri: https://github.com/ksylvest/publicstorage/releases/tag/v1.1.0
+  documentation_uri: https://publicstorage.ksylvest.com/
 post_install_message: 
 rdoc_options: []
 require_paths: