extraspace 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d0f31dad347795d2fb0a8cbd14b3c6452fc8c8dfea0f9b66639bc4c1bf1c433
+  data.tar.gz: 35cedca68983cab7e29c76abc7c8c83d617dad6c2ef881bbd13ecced436fd89d
+SHA512:
+  metadata.gz: e56ad3839e7a9f5a11b8298e7977c518590aade51b78a7248c201b03027b35b697ef792e311e76b797d1d6aa51d00e996d753651ff66e2fb5e00b74d2c8ab86c
+  data.tar.gz: 5bb15f6c216c19d628f2179dd4dafe714804ee50d9142d72039d7fba0e68a5ad7ceaaa29e54259868a3ad0f53be9e0d9c677ce207ced6a5730471a2ac0439f13

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'rspec_junit_formatter'
+gem 'rubocop'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'
+gem 'vcr'
+gem 'webmock'
+gem 'yard'

data/README.md

@@ -0,0 +1,38 @@
+# ExtraSpace
+
+[![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)
+[![GitHub](https://img.shields.io/badge/github-repo-blue.svg)](https://github.com/ksylvest/extraspace)
+[![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)
+
+## Installation
+
+```bash
+gem install extrapsace
+```
+
+## Usage
+
+```ruby
+require 'extraspace'
+
+URL = 'https://www.extraspace.com/storage/facilities/us/alabama/auburn/3264/'
+facility = ExtraSpace::Facility.fetch(url: URL)
+
+puts "Line 1: #{facility.address.line1}"
+puts "Line 2: #{facility.address.line2}"
+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
+
+facility.prices.each do |price|
+  puts "UID: #{price.uid}"
+  puts "Dimensions: #{price.dimensions.display}"
+  puts "Rates: $#{price.rates.street} (street) / $#{price.rates.web} (web)"
+  puts
+end
+```

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'extraspace'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/extraspace/address.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module ExtraSpace
+  # e.g. https://www.extraspace.com/storage/facilities/us/alabama/auburn/3264/
+  class Address
+    # @attribute [rw] line1
+    #   @return [String]
+    attr_accessor :line1
+
+    # @attribute [rw] line2
+    #   @return [String]
+    attr_accessor :line2
+
+    # @attribute [rw] city
+    #   @return [String]
+    attr_accessor :city
+
+    # @attribute [rw] state
+    #   @return [String]
+    attr_accessor :state
+
+    # @attribute [rw] zip
+    #   @return [String]
+    attr_accessor :zip
+
+    # @param line1 [String]
+    # @param line2 [String]
+    # @param city [String]
+    # @param state_abbreviation [String]
+    # @param state_name [String]
+    # @param postal_code [String]
+    def initialize(line1:, line2:, city:, state:, zip:)
+      @line1 = line1
+      @line2 = line2
+      @city = city
+      @state = state
+      @zip = zip
+    end
+
+    def inspect
+      props = [
+        "line1=#{@line1.inspect}",
+        "line2=#{@line2.inspect}",
+        "city=#{@city.inspect}",
+        "state=#{@state.inspect}",
+        "zip=#{@zip.inspect}"
+      ]
+      "#<#{self.class.name} #{props.join(' ')}>"
+    end
+
+    # @param data [Hash]
+    #
+    # @return [Address]
+    def self.parse(data:)
+      new(
+        line1: data['line1'],
+        line2: data['line2'],
+        city: data['city'],
+        state: data['stateName'],
+        zip: data['postalCode']
+      )
+    end
+  end
+end

data/lib/extraspace/availability.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ExtraSpace
+  # e.g. https://www.extraspace.com/storage/facilities/us/alabama/auburn/3264/
+  class Availability
+    # @attribute [rw] available
+    #   @return [String]
+    attr_accessor :available
+
+    # @param uid [String]
+    def initialize(available:)
+      @available = available
+    end
+
+    # @return [String]
+    def inspect
+      props = [
+        "available=#{@available.inspect}"
+      ]
+      "#<#{self.class.name} #{props.join(' ')}>"
+    end
+
+    # @param data [Hash]
+    #
+    # @return [Address]
+    def self.parse(data:)
+      new(available: data['available'])
+    end
+  end
+end

data/lib/extraspace/dimensions.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ExtraSpace
+  # e.g. https://www.extraspace.com/storage/facilities/us/alabama/auburn/3264/
+  class Dimensions
+    # @attribute [rw] depth
+    #   @return [Integer]
+    attr_accessor :depth
+
+    # @attribute [rw] width
+    #  @return [Integer]
+    attr_accessor :width
+
+    # @attribute [rw] sqft
+    #   @return [Integer]
+    attr_accessor :sqft
+
+    # @attribute [rw] display
+    #   @return [String]
+    attr_accessor :display
+
+    # @param uid [String]
+    def initialize(depth:, width:, sqft:, display:)
+      @depth = depth
+      @width = width
+      @sqft = sqft
+      @display = display
+    end
+
+    # @return [String]
+    def inspect
+      props = [
+        "depth=#{@depth.inspect}",
+        "width=#{@width.inspect}",
+        "sqft=#{@sqft.inspect}",
+        "display=#{@display.inspect}"
+      ]
+      "#<#{self.class.name} #{props.join(' ')}>"
+    end
+
+    # @param data [Hash]
+    #
+    # @return [Address]
+    def self.parse(data:)
+      new(depth: data['depth'], width: data['width'], sqft: data['squareFoot'], display: data['display'])
+    end
+  end
+end

data/lib/extraspace/facility.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module ExtraSpace
+  # e.g. https://www.extraspace.com/storage/facilities/us/alabama/auburn/3264/
+  class Facility
+    # @attribute [rw] address
+    #   @return [Address]
+    attr_accessor :address
+
+    # @attribute [rw] geocode
+    #   @return [Geocode]
+    attr_accessor :geocode
+
+    # @attribute [rw] prices
+    #   @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
+
+    def inspect
+      props = [
+        "address=#{@address.inspect}",
+        "geocode=#{@geocode.inspect}",
+        "prices=#{@prices.inspect}"
+      ]
+      "#<#{self.class.name} #{props.join(' ')}>"
+    end
+
+    # @param url [String]
+    #
+    # @return [Facility]
+    def self.fetch(url:)
+      response = HTTP.get(url)
+      document = Nokogiri::HTML(String(response.body))
+      data = JSON.parse(document.at('#__NEXT_DATA__').text)
+
+      parse(data: data)
+    end
+
+    # @param data [Hash]
+    #
+    # @return [Facility]
+    def self.parse(data:)
+      page_data = data.dig('props', 'pageProps', 'pageData', 'data')
+      facility_data = page_data.dig('facilityData', 'data')
+      unit_classes = page_data.dig('unitClasses', 'data', 'unitClasses')
+
+      address = Address.parse(data: facility_data['store']['address'])
+      geocode = Geocode.parse(data: facility_data['store']['geocode'])
+      prices = unit_classes.map { |price_data| Price.parse(data: price_data) }
+
+      new(address:, geocode:, prices:)
+    end
+  end
+end

data/lib/extraspace/geocode.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ExtraSpace
+  # e.g. https://www.extraspace.com/storage/facilities/us/alabama/auburn/3264/
+  class Geocode
+    # @attribute [rw] latitude
+    #   @return [Float]
+    attr_accessor :latitude
+
+    # @attribute [rw] longitude
+    #   @return [Float]
+    attr_accessor :longitude
+
+    # @param latitude [Float]
+    # @param longitude [Float]
+    def initialize(latitude:, longitude:)
+      @latitude = latitude
+      @longitude = longitude
+    end
+
+    # @return [String]
+    def inspect
+      props = [
+        "latitude=#{@latitude.inspect}",
+        "longitude=#{@longitude.inspect}"
+      ]
+      "#<#{self.class.name} #{props.join(' ')}>"
+    end
+
+    # @param data [Hash]
+    #
+    # @return [Geocode]
+    def self.parse(data:)
+      new(
+        latitude: data['latitude'],
+        longitude: data['longitude']
+      )
+    end
+  end
+end

data/lib/extraspace/price.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module ExtraSpace
+  # e.g. https://www.extraspace.com/storage/facilities/us/alabama/auburn/3264/
+  class Price
+    # @attribute [rw] uid
+    #   @return [String]
+    attr_accessor :uid
+
+    # @attribute [rw] availability
+    #   @return [Availability]
+    attr_accessor :availability
+
+    # @attribute [rw] dimensions
+    #   @return [Dimensions]
+    attr_accessor :dimensions
+
+    # @attribute [rw] rates
+    #   @return [Rates]
+    attr_accessor :rates
+
+    # @param uid [String]
+    # @param availability [Availability]
+    # @param dimensions [Dimensions]
+    # @param rates [Rates]
+    def initialize(uid:, availability:, dimensions:, rates:)
+      @uid = uid
+      @availability = availability
+      @dimensions = dimensions
+      @rates = rates
+    end
+
+    # @return [String]
+    def inspect
+      props = [
+        "uid=#{@uid.inspect}",
+        "availability=#{@availability.inspect}",
+        "dimensions=#{@dimensions.inspect}",
+        "rates=#{@rates.inspect}"
+      ]
+      "#<#{self.class.name} #{props.join(' ')}>"
+    end
+
+    # @param data [Hash]
+    #
+    # @return [Address]
+    def self.parse(data:)
+      availability = Availability.parse(data: data['availability'])
+      dimensions = Dimensions.parse(data: data['dimensions'])
+      rates = Rates.parse(data: data['rates'])
+      new(
+        uid: data['uid'],
+        availability: availability,
+        dimensions: dimensions,
+        rates: rates
+      )
+    end
+  end
+end

data/lib/extraspace/rates.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ExtraSpace
+  # e.g. https://www.extraspace.com/storage/facilities/us/alabama/auburn/3264/
+  class Rates
+    # @attribute [rw] nsc
+    #   @return [Integer]
+    attr_accessor :nsc
+
+    # @attribute [rw] street
+    #   @return [Integer]
+    attr_accessor :street
+
+    # @attribute [rw] web
+    #   @return [Integer]
+    attr_accessor :web
+
+    # @param uid [String]
+    def initialize(nsc:, street:, web:)
+      @nsc = nsc
+      @street = street
+      @web = web
+    end
+
+    # @return [String]
+    def inspect
+      props = [
+        "nsc=#{@nsc.inspect}",
+        "street=#{@street.inspect}",
+        "web=#{@web.inspect}"
+      ]
+      "#<#{self.class.name} #{props.join(' ')}>"
+    end
+
+    # @param data [Hash]
+    #
+    # @return [Address]
+    def self.parse(data:)
+      new(
+        nsc: data['nsc'],
+        street: data['street'],
+        web: data['web']
+      )
+    end
+  end
+end

data/lib/extraspace/version.rb

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

data/lib/extraspace.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'http'
+require 'nokogiri'
+require 'zeitwerk'
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect 'extraspace' => 'ExtraSpace'
+loader.setup
+
+module ExtraSpace
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: extraspace
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Sylvestre
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  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: json
+  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: nokogiri
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Uses HTTP.rb to scrape extraspace.com.
+email:
+- kevin@ksylvest.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- bin/console
+- bin/setup
+- lib/extraspace.rb
+- lib/extraspace/address.rb
+- lib/extraspace/availability.rb
+- lib/extraspace/dimensions.rb
+- lib/extraspace/facility.rb
+- lib/extraspace/geocode.rb
+- lib/extraspace/price.rb
+- lib/extraspace/rates.rb
+- lib/extraspace/version.rb
+homepage: https://github.com/ksylvest/extraspace
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/ksylvest/extraspace
+  source_code_uri: https://github.com/ksylvest/extraspace
+  changelog_uri: https://github.com/ksylvest/extraspace
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: A crawler for ExtraSpace.
+test_files: []