cubesmart 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e26402813c2f507a7a4902766a26821194de2f1c9c2d31ef633b2138c45e2f5
-  data.tar.gz: 91628c2ca652fc5be1788d4616652b82483863ab3b0bc3107cf7f3b9861cac51
+  metadata.gz: 4632b3c1c352b868287bc92291fb0535ee9bf4b0c419a9501cdf60ebc4ca272c
+  data.tar.gz: 9839c357de5c6337185a84592f626bd8e39b1effc586dacf9a1685dc05474bed
 SHA512:
-  metadata.gz: e1f88ebc04f150dc9cbf0d590e01f05245be3a3a323d31526b6f5cdd6f445b38ad66c2cf7a0f77847ba20c62c364b58a1fd9db1bb87ee2fd8d610f0fc30f53cc
-  data.tar.gz: 04f620cbfe554d8ecaeb77e363ad7a31c506a954c86deec4f6ad597af182c39c42340667f202fe9a7880740d4c4525c657368813d8a9bd6d6751aea8398db3ca
+  metadata.gz: 43f365fb2584f00de5dce8ecb4199fdb8659db50c2b59a61d0f0891b58b099403a65e0fd0c8b1b8e4bb58b72fb82c2b30590951a9d597f99b82466806f9b7ce2
+  data.tar.gz: 3fc196914dde673a3e95111204a1ba1d282ccc3d0d4fe99db571cb2a646f4ccd125dc38b454ee4a4221e9875229a40a038694fe6066d384b0165547dacb07966

data/lib/cubesmart/dimensions.rb

@@ -3,6 +3,8 @@
 module CubeSmart
   # The dimensions (width + depth + sqft) of a price.
   class Dimensions
+    DEFAULT_HEIGHT = 8 # feet
+
     # @attribute [rw] depth
     #   @return [Integer]
     attr_accessor :depth
@@ -11,17 +13,17 @@ module CubeSmart
     #  @return [Integer]
     attr_accessor :width
 
-    # @attribute [rw] sqft
+    # @attribute [rw] height
     #   @return [Integer]
-    attr_accessor :sqft
+    attr_accessor :height
 
     # @param depth [Integer]
     # @param width [Integer]
-    # @param sqft [Integer]
-    def initialize(depth:, width:, sqft:)
+    # @param height [Integer]
+    def initialize(depth:, width:, height: DEFAULT_HEIGHT)
       @depth = depth
       @width = width
-      @sqft = sqft
+      @height = height
     end
 
     # @return [String]
@@ -29,11 +31,21 @@ module CubeSmart
       props = [
         "depth=#{@depth.inspect}",
         "width=#{@width.inspect}",
-        "sqft=#{@sqft.inspect}"
+        "height=#{@height.inspect}"
       ]
       "#<#{self.class.name} #{props.join(' ')}>"
     end
 
+    # @return [Integer]
+    def sqft
+      Integer(@width * @depth)
+    end
+
+    # @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)"
@@ -49,8 +61,7 @@ module CubeSmart
 
       width = Float(match[:width])
       depth = Float(match[:depth])
-      sqft = Integer(width * depth)
-      new(depth:, width:, sqft:)
+      new(depth:, width:, height: DEFAULT_HEIGHT)
     end
   end
 end

data/lib/cubesmart/facility.rb

@@ -22,6 +22,10 @@ module CubeSmart
     #   @return [String]
     attr_accessor :id
 
+    # @attribute [rw] url
+    #   @return [String]
+    attr_accessor :url
+
     # @attribute [rw] name
     #   @return [String]
     attr_accessor :name
@@ -56,22 +60,23 @@ module CubeSmart
     # @return [Facility]
     def self.fetch(url:)
       document = Crawler.html(url:)
-      parse(document:)
+      parse(url:, document:)
     end
 
+    # @param url [String]
     # @param document [Nokogiri::HTML::Document]
     #
     # @return [Facility]
-    def self.parse(document:)
+    def self.parse(url:, document:)
       data = parse_json_ld(document:)
 
-      id = data['url'].match(ID_REGEX)[:id]
+      id = ID_REGEX.match(url)[: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: element) }
 
-      new(id:, name:, address:, geocode:, prices:)
+      new(id:, url:, name:, address:, geocode:, prices:)
     end
 
     # @param document [Nokogiri::HTML::Document]
@@ -85,14 +90,16 @@ module CubeSmart
     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:, phone: DEFAULT_PHONE, email: DEFAULT_EMAIL, 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
@@ -105,6 +112,7 @@ module CubeSmart
     def inspect
       props = [
         "id=#{@id.inspect}",
+        "url=#{@url.inspect}",
         "address=#{@address.inspect}",
         "geocode=#{@geocode.inspect}",
         "phone=#{@phone.inspect}",

data/lib/cubesmart/features.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module CubeSmart
+  # The features (e.g. climate-controlled, inside-drive-up-access, outside-drive-up-access, etc) of a price.
+  class Features
+    # @param element [Nokogiri::XML::Element]
+    #
+    # @return [Features]
+    def self.parse(element:)
+      text = element.text
+
+      new(
+        climate_controlled: text.include?('Climate controlled'),
+        inside_drive_up_access: text.include?('Inside drive-up access'),
+        outside_drive_up_access: text.include?('Outside drive-up access'),
+        first_floor_access: text.include?('1st floor access')
+      )
+    end
+
+    # @param climate_controlled [Boolean]
+    # @param inside_drive_up_access [Boolean]
+    # @param outside_drive_up_access [Boolean]
+    # @param first_floor_access [Boolean]
+    def initialize(climate_controlled:, inside_drive_up_access:, outside_drive_up_access:, first_floor_access:)
+      @climate_controlled = climate_controlled
+      @inside_drive_up_access = inside_drive_up_access
+      @outside_drive_up_access = outside_drive_up_access
+      @first_floor_access = first_floor_access
+    end
+
+    # @return [String]
+    def inspect
+      props = [
+        "climate_controlled=#{@climate_controlled}",
+        "inside_drive_up_access=#{@inside_drive_up_access}",
+        "outside_drive_up_access=#{@outside_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 << 'Inside Drive-Up Access' if inside_drive_up_access?
+        amenities << 'Outside Drive-Up Access' if outside_drive_up_access?
+        amenities << 'First Floor Access' if first_floor_access?
+      end
+    end
+
+    # @return [Boolean]
+    def climate_controlled?
+      @climate_controlled
+    end
+
+    # @return [Boolean]
+    def inside_drive_up_access?
+      @inside_drive_up_access
+    end
+
+    # @return [Boolean]
+    def outside_drive_up_access?
+      @outside_drive_up_access
+    end
+
+    # @return [Boolean]
+    def drive_up_access?
+      inside_drive_up_access? || outside_drive_up_access?
+    end
+
+    # @return [Boolean]
+    def first_floor_access?
+      @first_floor_access
+    end
+  end
+end

data/lib/cubesmart/price.rb

@@ -11,16 +11,22 @@ module CubeSmart
     #   @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
 
@@ -29,6 +35,7 @@ module CubeSmart
       props = [
         "id=#{@id.inspect}",
         "dimensions=#{@dimensions.inspect}",
+        "features=#{@features.inspect}",
         "rates=#{@rates.inspect}"
       ]
       "#<#{self.class.name} #{props.join(' ')}>"
@@ -36,20 +43,18 @@ module CubeSmart
 
     # @return [String] e.g. "123 | 5' × 5' (25 sqft) | $100 (street) / $90 (web)"
     def text
-      "#{@id} | #{@dimensions.text} | #{@rates.text}"
+      "#{@id} | #{@dimensions.text} | #{@rates.text} | #{@features.text}"
     end
 
     # @param element [Nokogiri::XML::Element]
     #
     # @return [Price]
     def self.parse(element:)
-      id = element.attr('id')
-      dimensions = Dimensions.parse(element:)
-      rates = Rates.parse(element:)
       new(
-        id:,
-        dimensions: dimensions,
-        rates: rates
+        id: element.attr('id'),
+        dimensions: Dimensions.parse(element:),
+        features: Features.parse(element:),
+        rates: Rates.parse(element:)
       )
     end
   end

data/lib/cubesmart/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cubesmart
 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-12-04 00:00:00.000000000 Z
+date: 2024-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -101,6 +101,7 @@ files:
 - lib/cubesmart/crawler.rb
 - lib/cubesmart/dimensions.rb
 - lib/cubesmart/facility.rb
+- lib/cubesmart/features.rb
 - lib/cubesmart/fetch_error.rb
 - lib/cubesmart/geocode.rb
 - lib/cubesmart/link.rb