cubesmart 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85d1ddedfe264f2f4222c108695490f532df6c6e4ca15603793ab238ae252d6a
-  data.tar.gz: 9fa27011d2d71cb6a88ba3d94ea5aa66425d3c16c44a64bb598f550ebaf9e1c8
+  metadata.gz: 9f6ca103f9053e6250a85a42aa2a374edefdd702195777acbc7b3434e86b3775
+  data.tar.gz: b5852885f4fba9a2e9976c675a43d655afaf3cc1b090930b4d80a790c70b097b
 SHA512:
-  metadata.gz: 05f744c51f4a5e7f0690e48b04241d74e042aaff8f0463c6ac2464022fd1ebda9fa31163acd342a0f61edb9b580d7fc6872d5cab5a2112ccc537922575d31c56
-  data.tar.gz: 5d264cd65e2a48d0bb2efe3e16aa7992b98c6f1666f74edc94495cba81d5eb156ce9aabd09ead70e0b2024f4e197844da0456e7778d4d5206c505b6f2aa536ec
+  metadata.gz: 3ac76e5460e15ec7f7f26acce3aca8682e01f63d81e41ba408588089da2458c7514e12990e6d6e1f27544a26e59055a3ccd1a6456913e61446ea7a0a55fdee5b
+  data.tar.gz: 3a3ed1f456a2740714cd240058ced94d2e7dc9b7cbef5a8c49742d3f395f7da27b93bd9aebd2242db032a3e682fe93d1debb696976b3be776b7241b0a7012ba8

data/README.md

@@ -6,6 +6,8 @@
 [![Yard](https://img.shields.io/badge/docs-site-blue.svg)](https://cubesmart.ksylvest.com)
 [![CircleCI](https://img.shields.io/circleci/build/github/ksylvest/cubesmart)](https://circleci.com/gh/ksylvest/cubesmart)
 
+A Ruby library offering both a CLI and API for scraping [CubeSmart](hhttps://www.cubesmart.com/) self-storage facilities and prices.
+
 ## Installation
 
 ```bash
@@ -49,3 +51,7 @@ end
 ```bash
 cubesmart crawl
 ```
+
+```bash
+cubesmart crawl "https://www.cubesmart.com/california-self-storage/los-angeles-self-storage/3844.html"
+```

data/lib/cubesmart/cli.rb

@@ -21,7 +21,7 @@ module CubeSmart
       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 CubeSmart
 
     private
 
-    def crawl
-      Crawl.run
+    # @param url [String] optional
+    def crawl(url = nil)
+      Crawl.run(url: url)
       exit(Code::OK)
     end
 
@@ -48,10 +49,15 @@ module CubeSmart
     # @return [OptionParser]
     def parser
       OptionParser.new do |options|
-        options.banner = 'usage: cubesmart [options] <command> [<args>]'
+        options.banner = 'usage: extraspace [options] <command> [<args>]'
 
         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/cubesmart/config.rb

@@ -3,6 +3,10 @@
 module CubeSmart
   # The core configuration.
   class Config
+    # @attribute [rw] accept_language
+    #   @return [String]
+    attr_accessor :accept_language
+
     # @attribute [rw] user_agent
     #   @return [String]
     attr_accessor :user_agent
@@ -16,48 +20,39 @@ module CubeSmart
     attr_accessor :proxy_url
 
     def initialize
+      @accept_language = ENV.fetch('CUBESMART_ACCEPT_LANGUAGE', 'en-US,en;q=0.9')
       @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
+    def headers?
+      !@user_agent.nil?
     end
 
-    # @return [String]
-    def proxy_scheme
-      proxy_uri&.scheme
+    # @return [Boolean]
+    def timeout?
+      !@timeout.zero?
     end
 
-    # @return [String]
-    def proxy_username
-      proxy_uri&.user
+    # @return [Boolean]
+    def proxy?
+      !@proxy_url.nil?
     end
 
-    # @return [String]
-    def proxy_password
-      proxy_uri&.password
+    # @return [Hash<String, String>] e.g { 'User-Agent' => 'cubesmart.rb/1.0.0' }
+    def headers
+      {
+        'Accept-Language' => @accept_language,
+        'User-Agent' => @user_agent
+      }
     end
 
-    # @return [Array]
-    def proxy_options
-      [proxy_host, proxy_port, proxy_username, proxy_password]
+    # @return [Array] e.g. ['proxy.example.com', 8080, 'user', 'pass']
+    def via
+      proxy_uri = URI.parse(@proxy_url)
+      [proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password]
     end
   end
 end

data/lib/cubesmart/crawl.rb

@@ -9,19 +9,22 @@ module CubeSmart
 
     # @param stdout [IO] optional
     # @param stderr [IO] optional
-    # @param options [Hash] optional
-    def initialize(stdout: $stdout, stderr: $stderr, options: {})
+    # @param url [String] optional
+    def initialize(stdout: $stdout, stderr: $stderr, url: nil)
       @stdout = stdout
       @stderr = stderr
-      @options = options
+      @url = url
     end
 
     def run
-      sitemap = Facility.sitemap
-      @stdout.puts("count=#{sitemap.links.count}")
-      @stdout.puts
-
-      sitemap.links.each { |link| process(url: link.loc) }
+      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:)

data/lib/cubesmart/crawler.rb

@@ -24,10 +24,10 @@ module CubeSmart
       @connection ||= begin
         config = CubeSmart.config
 
-        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 = HTTP.use(:auto_deflate).use(:auto_inflate).persistent(HOST)
+        connection = connection.headers(config.headers) if config.headers?
+        connection = connection.timeout(config.timeout) if config.timeout?
+        connection = connection.via(*config.via) if config.proxy?
 
         connection
       end

data/lib/cubesmart/dimensions.rb

@@ -3,23 +3,23 @@
 module CubeSmart
   # The dimensions (width + depth + sqft) of a price.
   class Dimensions
-    DEFAULT_HEIGHT = 8 # feet
+    DEFAULT_HEIGHT = 8.0 # feet
 
     # @attribute [rw] depth
-    #   @return [Integer]
+    #   @return [Float]
     attr_accessor :depth
 
     # @attribute [rw] width
-    #  @return [Integer]
+    #  @return [Float]
     attr_accessor :width
 
     # @attribute [rw] height
-    #   @return [Integer]
+    #   @return [Float]
     attr_accessor :height
 
-    # @param depth [Integer]
-    # @param width [Integer]
-    # @param height [Integer]
+    # @param depth [Float]
+    # @param width [Float]
+    # @param height [Float]
     def initialize(depth:, width:, height: DEFAULT_HEIGHT)
       @depth = depth
       @width = width
@@ -48,7 +48,7 @@ module CubeSmart
 
     # @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
 
     # @param element [Nokogiri::XML::Element]

data/lib/cubesmart/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cubesmart
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-12-05 00:00:00.000000000 Z
+date: 2024-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -115,8 +115,9 @@ licenses:
 metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/ksylvest/cubesmart
-  source_code_uri: https://github.com/ksylvest/cubesmart
-  changelog_uri: https://github.com/ksylvest/cubesmart
+  source_code_uri: https://github.com/ksylvest/cubesmart/tree/v1.0.0
+  changelog_uri: https://github.com/ksylvest/cubesmart/releases/tag/v1.0.0
+  documentation_uri: https://cubesmart.ksylvest.com/
 post_install_message: 
 rdoc_options: []
 require_paths: