extraspace 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c428e33759133c5e280f2dfb72c99c04e71ee4c64f96f6b9ba2228cd5fdc033e
-  data.tar.gz: a2be67b968e35c3fa689583d00cacf92608cf74906d8b854c52f9333059a1857
+  metadata.gz: e31518705b665cfcff3914a8553164f1463a3c66140cb41ea14be9154abf44fa
+  data.tar.gz: bf86b8674cf0557e239b286acaca2f77d1688bd3f431434ad15914db9624a143
 SHA512:
-  metadata.gz: c66f9b36b6ee74d375a791c57a9f0712efe65c65a3aa5b6c7bc146779e22cb2f10cb5e2f176eea2b6430a7255620f0fa218d4bcefa015b39723c35653821ea15
-  data.tar.gz: d0f1f59b09c2f6d86baad0819ab63f5ca68491e9ccfc9895c0f5f43ccb69418130dc898ed1087ad9d1580397ad9270256f8253d61982c092969e1bbde27214dc
+  metadata.gz: 6204e8de2f7349debac7049c5ca1ade4fc0b5328be5faaf61eefb42d982e735897c28fc6292ac98c6a40e36dadf94550fcd30f5a066b3eb58ba8de7db3c2c20d
+  data.tar.gz: edd94f3a7d6dadc415f112f7dd3fa1ff7e8ae5fd8592794e3a218a3806e5ec7777659eeaee3bde305af51eee67f23fb5b5862925f51fc54d22ff5aa5ad863f34

data/README.md

@@ -20,23 +20,20 @@ require 'extraspace'
 sitemap = ExtraSpace::Facility.sitemap
 sitemap.links.each do |link|
   url = link.loc
-
   facility = ExtraSpace::Facility.fetch(url:)
 
-  puts "Street: #{facility.address.street}"
-  puts "City: #{facility.address.city}"
-  puts "State: #{facility.address.state}"
-  puts "ZIP: #{facility.address.zip}"
-  puts "Latitude: #{facility.geocode.latitude}"
-  puts "Longitude: #{facility.geocode.longitude}"
-  puts
+  puts facility.text
 
   facility.prices.each do |price|
-    puts "ID: #{price.id}"
-    puts "Width: #{price.dimensions.width}"
-    puts "Depth: #{price.dimensions.depth}"
-    puts "Rates: $#{price.rates.street} (street) / $#{price.rates.web} (web)"
-    puts
+    puts price.text
   end
+
+  puts
 end
 ```
+
+## CLI
+
+```bash
+extraspace crawl
+```

data/exe/extraspace

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'extraspace'
+
+cli = ExtraSpace::CLI.new
+cli.parse

data/lib/extraspace/address.rb

@@ -41,6 +41,11 @@ module ExtraSpace
       "#<#{self.class.name} #{props.join(' ')}>"
     end
 
+    # @return [String]
+    def text
+      "#{street}, #{city}, #{state} #{zip}"
+    end
+
     # @param data [Hash]
     #
     # @return [Address]

data/lib/extraspace/cli.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module ExtraSpace
+  # Used when interacting with the library from the command line interface (CLI).
+  #
+  # Usage:
+  #
+  #   cli = ExtraSpace::CLI.new
+  #   cli.parse
+  class CLI
+    module Code
+      OK = 0
+      ERROR = 1
+    end
+
+    # @param argv [Array<String>]
+    def parse(argv = ARGV)
+      parser.parse!(argv)
+      command = argv.shift
+
+      case command
+      when 'crawl' then crawl
+      else
+        warn("unsupported command=#{command.inspect}")
+        exit(Code::ERROR)
+      end
+    end
+
+    private
+
+    def crawl
+      ExtraSpace::Facility.crawl
+      exit(Code::OK)
+    end
+
+    def help(options)
+      puts(options)
+      exit(Code::OK)
+    end
+
+    def version
+      puts(VERSION)
+      exit(Code::OK)
+    end
+
+    # @return [OptionParser]
+    def parser
+      OptionParser.new do |options|
+        options.banner = 'usage: extraspace [options] <command> [<args>]'
+
+        options.on('-h', '--help', 'help') { help(options) }
+        options.on('-v', '--version', 'version') { version }
+      end
+    end
+  end
+end

data/lib/extraspace/crawler.rb

@@ -8,7 +8,7 @@ module ExtraSpace
       # @param url [String]
       # @param response [HTTP::Response]
       def initialize(url:, response:)
-        super("url=#{url} status=#{response.status.inspect} body=#{response.body.inspect}")
+        super("url=#{url} status=#{response.status.inspect} body=#{String(response.body).inspect}")
       end
     end
 
@@ -30,7 +30,7 @@ module ExtraSpace
     # @return [HTTP::Response]
     def fetch(url:)
       response = HTTP.get(url)
-      raise FetchError(url:, response: response.flush) unless response.status.ok?
+      raise FetchError.new(url:, response: response.flush) unless response.status.ok?
 
       response
     end

data/lib/extraspace/dimensions.rb

@@ -34,6 +34,11 @@ module ExtraSpace
       "#<#{self.class.name} #{props.join(' ')}>"
     end
 
+    # @return [String] e.g. "10' × 10' (100 sqft)"
+    def text
+      "#{format('%g', @width)}' × #{format('%g', @depth)}' (#{@sqft} sqft)"
+    end
+
     # @param data [Hash]
     #
     # @return [Dimensions]

data/lib/extraspace/facility.rb

@@ -7,6 +7,14 @@ module ExtraSpace
   class Facility
     SITEMAP_URL = 'https://www.extraspace.com/facility-sitemap.xml'
 
+    # @attribute [rw] id
+    #   @return [String]
+    attr_accessor :id
+
+    # @attribute [rw] name
+    #   @return [String]
+    attr_accessor :name
+
     # @attribute [rw] address
     #   @return [Address]
     attr_accessor :address
@@ -19,25 +27,6 @@ module ExtraSpace
     #   @return [Array<Price>]
     attr_accessor :prices
 
-    # @param address [Address]
-    # @param geocode [Geocode]
-    # @param prices [Array<Price>]
-    def initialize(address:, geocode:, prices:)
-      @address = address
-      @geocode = geocode
-      @prices = prices
-    end
-
-    # @return [String]
-    def inspect
-      props = [
-        "address=#{@address.inspect}",
-        "geocode=#{@geocode.inspect}",
-        "prices=#{@prices.inspect}"
-      ]
-      "#<#{self.class.name} #{props.join(' ')}>"
-    end
-
     # @return [Sitemap]
     def self.sitemap
       Sitemap.fetch(url: SITEMAP_URL)
@@ -57,14 +46,60 @@ module ExtraSpace
     # @return [Facility]
     def self.parse(data:)
       page_data = data.dig('props', 'pageProps', 'pageData', 'data')
-      facility_data = page_data.dig('facilityData', 'data')
+      store_data = page_data.dig('facilityData', 'data', 'store')
       unit_classes = page_data.dig('unitClasses', 'data', 'unitClasses')
+      id = store_data['number']
+      name = store_data['name']
 
-      address = Address.parse(data: facility_data['store']['address'])
-      geocode = Geocode.parse(data: facility_data['store']['geocode'])
+      address = Address.parse(data: store_data['address'])
+      geocode = Geocode.parse(data: store_data['geocode'])
       prices = unit_classes.map { |price_data| Price.parse(data: price_data) }
 
-      new(address:, geocode:, prices:)
+      new(id:, name:, address:, geocode:, prices:)
+    end
+
+    def self.crawl
+      sitemap.links.each do |link|
+        url = link.loc
+
+        facility = fetch(url:)
+        puts facility.text
+
+        facility.prices.each do |price|
+          puts price.text
+        end
+
+        puts
+      end
+    end
+
+    # @param id [String]
+    # @param name [String]
+    # @param address [Address]
+    # @param geocode [Geocode]
+    # @param prices [Array<Price>]
+    def initialize(id:, name:, address:, geocode:, prices:)
+      @id = id
+      @name = name
+      @address = address
+      @geocode = geocode
+      @prices = prices
+    end
+
+    # @return [String]
+    def inspect
+      props = [
+        "id=#{@id.inspect}",
+        "address=#{@address.inspect}",
+        "geocode=#{@geocode.inspect}",
+        "prices=#{@prices.inspect}"
+      ]
+      "#<#{self.class.name} #{props.join(' ')}>"
+    end
+
+    # @return [String] e.g. "123 Main St, Springfield, IL 62701"
+    def text
+      "#{@id} | #{@name} | #{@address.text} | #{@geocode.text}"
     end
   end
 end

data/lib/extraspace/geocode.rb

@@ -27,6 +27,11 @@ module ExtraSpace
       "#<#{self.class.name} #{props.join(' ')}>"
     end
 
+    # @return [String]
+    def text
+      "#{@latitude},#{@longitude}"
+    end
+
     # @param data [Hash]
     #
     # @return [Geocode]

data/lib/extraspace/price.rb

@@ -34,6 +34,11 @@ module ExtraSpace
       "#<#{self.class.name} #{props.join(' ')}>"
     end
 
+    # @return [String] e.g. "123 | 5' × 5' (25 sqft) | $100 (street) / $90 (web)"
+    def text
+      "#{@id} | #{@dimensions.text} | #{@rates.text}"
+    end
+
     # @param data [Hash]
     #
     # @return [Price]

data/lib/extraspace/rates.rb

@@ -27,6 +27,11 @@ module ExtraSpace
       "#<#{self.class.name} #{props.join(' ')}>"
     end
 
+    # @return [String] e.g. "$80 (street) | $60 (web)"
+    def text
+      "$#{@street} (street) | $#{@web} (web)"
+    end
+
     # @param data [Hash]
     #
     # @return [Rates]

data/lib/extraspace/version.rb

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

data/lib/extraspace.rb

@@ -6,6 +6,7 @@ require 'zeitwerk'
 
 loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect 'extraspace' => 'ExtraSpace'
+loader.inflector.inflect 'cli' => 'CLI'
 loader.setup
 
 module ExtraSpace

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: extraspace
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kevin Sylvestre
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -69,7 +83,8 @@ dependencies:
 description: Uses HTTP.rb to scrape extraspace.com.
 email:
 - kevin@ksylvest.com
-executables: []
+executables:
+- extraspace
 extensions: []
 extra_rdoc_files: []
 files:
@@ -77,8 +92,10 @@ files:
 - README.md
 - bin/console
 - bin/setup
+- exe/extraspace
 - lib/extraspace.rb
 - lib/extraspace/address.rb
+- lib/extraspace/cli.rb
 - lib/extraspace/crawler.rb
 - lib/extraspace/dimensions.rb
 - lib/extraspace/facility.rb