extraspace 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a9b243e73e7e8ded7dec1cb75998fcf2b6cfc3907e9f07ec1c6a26071c10af4
-  data.tar.gz: 9b56a1dc1d3da8e3d83a358e1554214a58270f0936167004c29063024570445f
+  metadata.gz: febf4432cf5937d8fccef08a6210416fa4faa2fe37a28816832a6935bff36ac7
+  data.tar.gz: be2a71660eaffd362db0788a20b81c5a9688d4bb11efa4d36e5bdcce31085d78
 SHA512:
-  metadata.gz: 44636e3f4b7229189e6a806d14bf440fb565127a952a15911e761e440364f83c2413e7167fc55b51ce145eb11f8fe4446c7f259548a5f0dca3adc25a7cb06a4d
-  data.tar.gz: bea8280c5d3506e5358cc69ab1561419667442ca6fc2f78216400bebf60ba2be729fd282e5daee8c79b9dae7dab2f4312fc94d66ed65b5504aeaba67933ebc13
+  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/facility.rb

@@ -5,16 +5,31 @@ module ExtraSpace
   #
   # e.g. https://www.extraspace.com/storage/facilities/us/alabama/auburn/3264/
   class Facility
+    DEFAULT_EMAIL = 'info@extraspace.com'
+    DEFAULT_PHONE = '1-855-518-1443'
+
     SITEMAP_URL = 'https://www.extraspace.com/facility-sitemap.xml'
 
     # @attribute [rw] id
     #   @return [String]
     attr_accessor :id
 
+    # @attribute [rw] url
+    #   @return [String]
+    attr_accessor :url
+
     # @attribute [rw] name
     #   @return [String]
     attr_accessor :name
 
+    # @attribute [rw] phone
+    #   @return [String]
+    attr_accessor :phone
+
+    # @attribute [rw] email
+    #   @return [String]
+    attr_accessor :email
+
     # @attribute [rw] address
     #   @return [Address]
     attr_accessor :address
@@ -37,14 +52,15 @@ module ExtraSpace
     # @return [Facility]
     def self.fetch(url:)
       document = Crawler.html(url:)
-      data = JSON.parse(document.at('#__NEXT_DATA__').text)
-      parse(data:)
+      parse(url:, document:)
     end
 
-    # @param data [Hash]
+    # @param url [String]
+    # @param document [Nokogiri::HTML::Document]
     #
     # @return [Facility]
-    def self.parse(data:)
+    def self.parse(url:, document:)
+      data = parse_next_data(document: document)
       page_data = data.dig('props', 'pageProps', 'pageData', 'data')
       store_data = page_data.dig('facilityData', 'data', 'store')
       unit_classes = page_data.dig('unitClasses', 'data', 'unitClasses')
@@ -55,7 +71,16 @@ module ExtraSpace
       geocode = Geocode.parse(data: store_data['geocode'])
       prices = unit_classes.map { |price_data| Price.parse(data: price_data) }
 
-      new(id:, name:, address:, geocode:, prices:)
+      new(id:, url:, name:, address:, geocode:, prices:)
+    end
+
+    # @param document [Nokogiri::HTML::Document]
+    #
+    # @raise [ParseError]
+    #
+    # @return [Hash]
+    def self.parse_next_data(document:)
+      JSON.parse(document.at('#__NEXT_DATA__').text)
     end
 
     def self.crawl
@@ -74,15 +99,21 @@ module ExtraSpace
     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:, 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
+      @phone = phone
+      @email = email
       @prices = prices
     end
 
@@ -90,8 +121,11 @@ module ExtraSpace
     def inspect
       props = [
         "id=#{@id.inspect}",
+        "url=#{@url.inspect}",
         "address=#{@address.inspect}",
         "geocode=#{@geocode.inspect}",
+        "phone=#{@phone.inspect}",
+        "email=#{@email.inspect}",
         "prices=#{@prices.inspect}"
       ]
       "#<#{self.class.name} #{props.join(' ')}>"
@@ -99,7 +133,7 @@ module ExtraSpace
 
     # @return [String]
     def text
-      "#{@id} | #{@name} | #{@address.text} | #{@geocode.text}"
+      "#{@id} | #{@name} | #{@phone} | #{@email} | #{@address.text} | #{@geocode.text}"
     end
   end
 end

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

metadata

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