extraspace 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6b9f72cb5e07f8752d98b4f9a03ae259d29e434bc136a83c131355ca805303c
-  data.tar.gz: 42db36f6586bf84339fd09b9acacdba161886a23087932a9dd7d392bb30bd5bd
+  metadata.gz: febf4432cf5937d8fccef08a6210416fa4faa2fe37a28816832a6935bff36ac7
+  data.tar.gz: be2a71660eaffd362db0788a20b81c5a9688d4bb11efa4d36e5bdcce31085d78
 SHA512:
-  metadata.gz: eaa2e29a14042f4609f6aa3e7534a7e281fa7831cfd9254b8dc57309ded56fe14063fe8ce730d11a4f569e7068617eb1ab3bfdb541689de57a21d236313e751f
-  data.tar.gz: 2d15bad80e64d83162ab01665752d16abc198ccc65299a815c550e9eed5f121810c120ae46a0f560dc59bf8d4a0291e0de85c3470acd3bf9d9c026d34d823754
+  metadata.gz: 139bacf0760a498199df8a1cf5171c2da994a65f736cc971af63c082f47916df2a5665ccf329b87d65f034e0a5a92373fe85ada538717d4b2fde170f8d70395a
+  data.tar.gz: 91855347437bd257fbd117098d15cc30eda47aed595bc77c42095bbdcc148dff5c4c6eaf3ca31d02ee01e92afb51a2f9eac4a2edbc3d167ad5317706d62d39bc

data/README.md

@@ -1,4 +1,4 @@
-# ExtraSpace
+# Extra Space
 
 [![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ksylvest/extraspace/blob/main/LICENSE)
 [![RubyGems](https://img.shields.io/gem/v/extraspace)](https://rubygems.org/gems/extraspace)
@@ -6,10 +6,12 @@
 [![Yard](https://img.shields.io/badge/docs-site-blue.svg)](https://extraspace.ksylvest.com)
 [![CircleCI](https://img.shields.io/circleci/build/github/ksylvest/extraspace)](https://circleci.com/gh/ksylvest/extraspace)
 
+A Ruby library offering both a CLI and API for scraping [Extra Space](https://www.extraspace.com/) self-storage facilities and prices.
+
 ## Installation
 
 ```bash
-gem install extrapsace
+gem install extraspace
 ```
 
 ## Configuration
@@ -48,3 +50,7 @@ end
 ```bash
 extraspace crawl
 ```
+
+```bash
+extrapsace crawl "https://www.extraspace.com/storage/facilities/us/california/los_angeles/900113/"
+```

data/lib/extraspace/cli.rb

@@ -21,7 +21,7 @@ module ExtraSpace
       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 ExtraSpace
 
     private
 
-    def crawl
-      Crawl.run
+    # @param url [String] optional
+    def crawl(url = nil)
+      Crawl.run(url: url)
       exit(Code::OK)
     end
 
@@ -52,6 +53,11 @@ module ExtraSpace
 
         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/extraspace/crawl.rb

@@ -9,19 +9,22 @@ module ExtraSpace
 
     # @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/extraspace/crawler.rb

@@ -5,15 +5,6 @@ module ExtraSpace
   class Crawler
     HOST = 'https://www.extraspace.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=#{String(response.body).inspect}")
-      end
-    end
-
     # @param url [String]
     # @raise [FetchError]
     # @return [Nokogiri::HTML::Document]

data/lib/extraspace/fetch_error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ExrtaSpace
+  # 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=#{String(response.body).inspect}")
+    end
+  end
+end

data/lib/extraspace/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extraspace
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-12-10 00:00:00.000000000 Z
+date: 2024-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -102,6 +102,7 @@ files:
 - lib/extraspace/dimensions.rb
 - lib/extraspace/facility.rb
 - lib/extraspace/features.rb
+- lib/extraspace/fetch_error.rb
 - lib/extraspace/geocode.rb
 - lib/extraspace/link.rb
 - lib/extraspace/price.rb