publicstorage 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24f5bb4366cb716cf259fb43e0df167617389a71bbcffa20c2e3534c588b06c1
-  data.tar.gz: 5b3be4bad58043fdfe30dee4067935bfc2346b778c967231155b670490a08d70
+  metadata.gz: c9f5251b3a20251494fcb996abc4a615d4aea13328e56930cadf9d9cc55b7b85
+  data.tar.gz: c6118d03fc038114cca43d836c7699a3b1992a482bda995f2138272076ee318e
 SHA512:
-  metadata.gz: e117b9fa84c46cbae5a14756cb4f5926a6a1405a91be4963c112fbe2c22d71f8090a33df5ad4b7c9a9126c64c09b524caaa01a1e10c58975d98b5ee593f22a4e
-  data.tar.gz: 15e95167c0d18276093a62594d95c13b9d2be48276541045c3b683b14748fbe65f38d43e58aeb609e75c3dc98cd82dc688d54d8a22aeb7ebbc514d4dd5e90dbd
+  metadata.gz: f29a0afa30474641681ec49b9a3b80e3e5fcffd30b26b53ae65aaf316d78bceafb894bbc789bcc8440f95220d7e1e44f290915464ebcab658560538d3c6f794b
+  data.tar.gz: 193ffa5234a99e8238d8f06c3e31bdaeb6bf6fe17e3be3b5378718866a7a943982d56b70695b314a0bda23edac14b6f7f7cf209edcf8ac82a51033c0e80fa53a

data/lib/publicstorage/address.rb

@@ -51,11 +51,21 @@ module PublicStorage
     # @return [Address]
     def self.parse(data:)
       new(
-        street: data['streetAddress'],
+        street: stripe_leading_or_trailing_null(data['streetAddress']),
         city: data['addressLocality'],
         state: data['addressRegion'],
         zip: data['postalCode']
       )
     end
+
+    # NOTE: this fixes a bug w/ publicstorage that currently exists where addresses have a leading / trailing null.
+    #
+    # @param value [String]
+    #
+    # @return [String]
+    def self.stripe_leading_or_trailing_null(value)
+      match = value.match(/\A(?:null)?(?<text>.*?)(?:null)?\z/)
+      match[:text]
+    end
   end
 end

data/lib/publicstorage/facility.rb

@@ -8,6 +8,7 @@ module PublicStorage
     DEFAULT_PHONE = '1-800-742-8048'
     DEFAULT_EMAIL = 'customerservice@publicstorage.com'
 
+    NAME_SELECTOR = '.plp-page-header'
     PRICE_SELECTOR = '.units-results-section .unit-list-group .unit-list-item'
     LD_SELECTOR = 'script[type="application/ld+json"]'
 
@@ -62,17 +63,36 @@ module PublicStorage
     #
     # @return [Facility]
     def self.parse(url:, document:)
-      data = parse_ld(document:)
-      id = Integer(data['url'].match(ID_REGEX)[:id])
-      name = data['name']
+      data = parse_ld(document: document)
+      id = parse_id(data: data)
+      name = parse_name(document: document)
       address = Address.parse(data: data['address'])
       geocode = Geocode.parse(data: data['geo'])
-
-      prices = document.css(PRICE_SELECTOR).map { |element| Price.parse(element:) }
+      prices = parse_prices(document: document)
 
       new(id:, url:, name:, address:, geocode:, prices:)
     end
 
+    # @param data [Hash]
+    #
+    # @return [Integer]
+    def self.parse_id(data:)
+      Integer(data['url'].match(ID_REGEX)[:id])
+    end
+
+    # @param document [NokoGiri::XML::Document]
+    #
+    # @return [String]
+    def self.parse_name(document:)
+      document.at_css(NAME_SELECTOR).text.gsub(/\s+/, ' ').strip
+    end
+
+    # @param docunent [NokoGiri::XML::Document]
+    # @return Array<Price>
+    def self.parse_prices(document:)
+      document.css(PRICE_SELECTOR).map { |element| Price.parse(element:) }
+    end
+
     # @param document [NokoGiri::XML::Document]
     #
     # @return [Hash]

data/lib/publicstorage/features.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module PublicStorage
+  # The features (e.g. climate-controlled, inside-drive-up-access, outside-drive-up-access, etc) of a price.
+  class Features
+    # @param data [Hash]
+    #
+    # @return [Features]
+    def self.parse(data:)
+      features = data['features']
+      new(
+        climate_controlled: features&.include?('climate controlled'),
+        drive_up_access: features&.include?('drive-up access'),
+        first_floor_access: features&.include?('1st floor')
+      )
+    end
+
+    # @param climate_controlled [Boolean]
+    # @param drive_up_access [Boolean]
+    # @param first_floor_access [Boolean]
+    def initialize(climate_controlled:, drive_up_access:, first_floor_access:)
+      @climate_controlled = climate_controlled
+      @drive_up_access = drive_up_access
+      @first_floor_access = first_floor_access
+    end
+
+    # @return [String]
+    def inspect
+      props = [
+        "climate_controlled=#{@climate_controlled}",
+        "drive_up_access=#{@drive_up_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 << '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 first_floor_access?
+      @first_floor_access
+    end
+  end
+end

data/lib/publicstorage/price.rb

@@ -13,16 +13,22 @@ module PublicStorage
     #   @return [Dimensions]
     attr_accessor :dimensions
 
+    # @attribute [rw] features
+    #   @return [Features]
+    attr_accessor :features
+
     # @attribute [rw] rates
     #   @return [Rates]
     attr_accessor :rates
 
     # @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
 
@@ -31,14 +37,15 @@ module PublicStorage
       props = [
         "id=#{@id.inspect}",
         "dimensions=#{@dimensions.inspect}",
+        "features=#{@features.inspect}",
         "rates=#{@rates.inspect}"
       ]
       "#<#{self.class.name} #{props.join(' ')}>"
     end
 
-    # @return [String] e.g. "123 | 5' × 5' (25 sqft) | $100 (street) / $90 (web)"
+    # @return [String] e.g. "123 | 5' × 5' (25 sqft) | $100 (street) / $90 (web) | Climate Controlled"
     def text
-      "#{@id} | #{@dimensions.text} | #{@rates.text}"
+      "#{@id} | #{@dimensions.text} | #{@rates.text} | #{@features.text}"
     end
 
     # @param element [Nokogiri::XML::Element]
@@ -49,10 +56,12 @@ module PublicStorage
 
       rates = Rates.parse(data:)
       dimensions = Dimensions.parse(data:)
+      features = Features.parse(data:)
 
       new(
         id: element.attr('data-unitid'),
         dimensions: dimensions,
+        features: features,
         rates: rates
       )
     end

data/lib/publicstorage/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: publicstorage
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Kevin Sylvestre
@@ -87,6 +87,7 @@ files:
 - lib/publicstorage/crawler.rb
 - lib/publicstorage/dimensions.rb
 - lib/publicstorage/facility.rb
+- lib/publicstorage/features.rb
 - lib/publicstorage/fetch_error.rb
 - lib/publicstorage/geocode.rb
 - lib/publicstorage/link.rb
@@ -100,8 +101,8 @@ licenses:
 metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/ksylvest/publicstorage
-  source_code_uri: https://github.com/ksylvest/publicstorage/tree/v1.2.0
-  changelog_uri: https://github.com/ksylvest/publicstorage/releases/tag/v1.2.0
+  source_code_uri: https://github.com/ksylvest/publicstorage/tree/v1.4.0
+  changelog_uri: https://github.com/ksylvest/publicstorage/releases/tag/v1.4.0
   documentation_uri: https://publicstorage.ksylvest.com/
 post_install_message: 
 rdoc_options: []