cubesmart 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '04490c967861512d4d25fd09f917727d68f6d49f67b8c8c3c6c6cb35e49c0eec'
-  data.tar.gz: 35323ecbb630e3124f67aa1b424a7bf9c87e9d27a48a3790238c314548b1eadc
+  metadata.gz: 85d1ddedfe264f2f4222c108695490f532df6c6e4ca15603793ab238ae252d6a
+  data.tar.gz: 9fa27011d2d71cb6a88ba3d94ea5aa66425d3c16c44a64bb598f550ebaf9e1c8
 SHA512:
-  metadata.gz: a217dd096b6923431d7282a06fb581b87dc660d2b3c94ee778a6531c855390d314dd04846e649887b312e2da18a7f60418461bc7d74b7c91d0c2550102dff6e8
-  data.tar.gz: e50bda05ca0c0944682c1c759ffff34dd32042a9739d527f55de1d7d8826893d3dcfa5fd4ecd066893052bd7f1512617b3b6a02e99e404fdf81b2cc06e1dcc4e
+  metadata.gz: 05f744c51f4a5e7f0690e48b04241d74e042aaff8f0463c6ac2464022fd1ebda9fa31163acd342a0f61edb9b580d7fc6872d5cab5a2112ccc537922575d31c56
+  data.tar.gz: 5d264cd65e2a48d0bb2efe3e16aa7992b98c6f1666f74edc94495cba81d5eb156ce9aabd09ead70e0b2024f4e197844da0456e7778d4d5206c505b6f2aa536ec

data/README.md

@@ -20,6 +20,7 @@ require 'cubesmart'
 CubeSmart.configure do |config|
   config.user_agent = '../..' # ENV['CUBESMART_USER_AGENT']
   config.timeout = 30 # ENV['CUBESMART_TIMEOUT']
+  config.proxy_url = 'http://user:pass@superproxy.zenrows.com:1337' # ENV['CUBESMART_PROXY_URL']
 end
 ```
 

data/lib/cubesmart/config.rb

@@ -11,9 +11,53 @@ module CubeSmart
     #   @return [Integer]
     attr_accessor :timeout
 
+    # @attribute [rw] proxy_url
+    #   @return [String]
+    attr_accessor :proxy_url
+
     def initialize
       @user_agent = ENV.fetch('CUBESMART_USER_AGENT', "cubesmart.rb/#{VERSION}")
       @timeout = Integer(ENV.fetch('CUBESMART_TIMEOUT', 60))
+      @proxy_url = ENV.fetch('CUBESMART_PROXY_URL', nil)
+    end
+
+    # @return [Boolean]
+    def proxy?
+      !@proxy_url.nil?
+    end
+
+    # @return [URI]
+    def proxy_uri
+      @proxy_uri ||= URI.parse(proxy_url) if proxy?
+    end
+
+    # @return [Integer]
+    def proxy_port
+      proxy_uri&.port
+    end
+
+    def proxy_host
+      proxy_uri&.host
+    end
+
+    # @return [String]
+    def proxy_scheme
+      proxy_uri&.scheme
+    end
+
+    # @return [String]
+    def proxy_username
+      proxy_uri&.user
+    end
+
+    # @return [String]
+    def proxy_password
+      proxy_uri&.password
+    end
+
+    # @return [Array]
+    def proxy_options
+      [proxy_host, proxy_port, proxy_username, proxy_password]
     end
   end
 end

data/lib/cubesmart/crawler.rb

@@ -27,6 +27,8 @@ module CubeSmart
         connection = HTTP.persistent(HOST)
         connection = connection.headers('User-Agent' => config.user_agent) if config.user_agent
         connection = connection.timeout(config.timeout) if config.timeout
+        connection = connection.via(*config.proxy_options) if config.proxy?
+
         connection
       end
     end

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/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.4.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cubesmart
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.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