rockauto_api 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e4cbe41448443aa7171c3b64a5eabd9cb57238eede7153139787e20a02d703d
-  data.tar.gz: 26413f356a2c6d7981fa912415e878f2f776a1d2c836cd43b60039e3c9217ec0
+  metadata.gz: 2d861f195fe9c02dc5737f5756f0c3e7248ddad192a380913dd9e95a65d327b8
+  data.tar.gz: 93ef1dddb194b74a1d091039460b3586466f1e225bba2289b0da43cfe5253e02
 SHA512:
-  metadata.gz: 21c380dc61636b085274e65ac4529e33ebd5fe2218f6d0be8d7ff22f5cf00763163098ffc5828ca4161375707f0f5b62df85fa43ef7952e522ea13d81aa76022
-  data.tar.gz: cd88096e1c0e0473373dee1ac07244007a2e8b21a176539ff733c92178b496c6012a7b663b3a647400ddd1a094d89a4566a8f0ba285fd71c96aeab48fb27497b
+  metadata.gz: d4606e5e6fe6ea4b7301722ddaba983dfab6de91c47ea8510054898b1d95f292b44c4adf2e98ce5bd44bca10d8dc2f7c86b539df7f888863b0b86e821f809d91
+  data.tar.gz: 0d6ec3fdb8ba7f234e91dbfcbd31b504d44dc53b10ab3c1d3610e28a63dd3c4f983a79b077f3312c3922f1e3c824fb6c1688aeebf7e1c404c8716482e38ba7d0

data/README.md

@@ -0,0 +1,380 @@
+# RockautoApi
+
+An unofficial Ruby API client for [RockAuto.com](https://www.rockauto.com). Browse vehicle catalogs, search parts by number, look up fitments, check order status, and manage your RockAuto account.
+
+**Disclaimer:** This gem is for **educational and research purposes only**. It is not affiliated with, endorsed by, or officially connected to RockAuto LLC. Automated scraping of RockAuto.com may violate their Terms of Service. Use responsibly and respect rate limits.
+
+---
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "rockauto_api"
+```
+
+Then:
+
+```
+bundle install
+```
+
+Or install directly:
+
+```
+gem install rockauto_api
+```
+
+---
+
+## Quick Start
+
+```ruby
+require "rockauto_api"
+
+client = RockautoApi::Client.new
+
+# Browse what RockAuto sells
+makes = client.get_makes
+makes.makes #=> ["ACURA", "AUDI", "BMW", ...]
+
+years = client.get_years_for_make("AUDI")
+years.years #=> [1980, 1981, ..., 2026]
+
+models = client.get_models_for_make_year("AUDI", 2019)
+models.models #=> ["A4", "A5", "A6", "A7", ...]
+
+engines = client.get_engines_for_vehicle("AUDI", 2019, "A4")
+engines.engines #=> [Engine(description: "2.0L L4 Turbocharged", carcode: "3443561"), ...]
+
+# Get part categories for a vehicle
+categories = client.get_part_categories("AUDI", 2019, "A4", "3443561")
+categories.categories #=> [PartCategory(name: "Belt Drive"), ...]
+
+# Get parts in a category
+parts = client.get_parts_by_category("AUDI", 2019, "A4", "3443561", "Belt Drive")
+parts.parts #=> [PartInfo, ...]
+```
+
+---
+
+## All Endpoints
+
+### Vehicle Catalog
+
+Browse the vehicle catalog to find makes, years, models, and engines.
+
+```ruby
+# List all makes
+makes = client.get_makes
+makes.makes   #=> ["ACURA", "AUDI", "BMW", ...]
+makes.count   #=> Integer
+
+# List years for a make
+years = client.get_years_for_make("ACURA")
+years.make    #=> "ACURA"
+years.years   #=> [1986, 1987, ..., 2026]
+years.count   #=> Integer
+
+# List models for a make and year
+models = client.get_models_for_make_year("ACURA", 2020)
+models.make   #=> "ACURA"
+models.year   #=> 2020
+models.models #=> ["MDX", "TLX", ...]
+models.count  #=> Integer
+
+# List engines for a specific vehicle
+engines = client.get_engines_for_vehicle("ACURA", 2020, "MDX")
+engines.make       #=> "ACURA"
+engines.year       #=> 2020
+engines.model      #=> "MDX"
+engines.engines    #=> [Engine(description, carcode, href), ...]
+engines.count      #=> Integer
+```
+
+### Part Categories
+
+Get the part categories available for a specific vehicle, and parts within a category.
+
+```ruby
+# Get all part categories for a vehicle
+categories = client.get_part_categories("ACURA", 2020, "MDX", "3444459")
+categories.make       #=> "ACURA"
+categories.year       #=> 2020
+categories.model      #=> "MDX"
+categories.carcode    #=> "3444459"
+categories.categories #=> [PartCategory(name, group_name, href), ...]
+categories.count      #=> Integer
+
+# Get parts in a category
+parts = client.get_parts_by_category("ACURA", 2020, "MDX", "3444459", "Brake & Wheel Hub")
+parts.make       #=> "ACURA"
+parts.year       #=> 2020
+parts.model      #=> "MDX"
+parts.carcode    #=> "3444459"
+parts.category   #=> "Brake & Wheel Hub"
+parts.parts      #=> [PartInfo, ...]
+parts.count      #=> Integer
+```
+
+### Part Search
+
+Search for parts by number, name, or browse available manufacturers, groups, and types.
+
+```ruby
+# Browse available manufacturers (cached for 24 hours)
+manufacturers = client.get_manufacturers
+manufacturers.manufacturers #=> [PartSearchOption(value, text), ...]
+manufacturers.lookup("Bosch") #=> PartSearchOption(value: "128", text: "Bosch")
+
+# Browse part groups (cached for 24 hours)
+groups = client.get_part_groups
+groups.part_groups #=> [PartSearchOption(value, text), ...]
+
+# Browse part types (cached for 24 hours)
+types = client.get_part_types
+types.part_types #=> [PartSearchOption(value, text), ...]
+
+# Search parts by number
+results = client.search_parts_by_number("FG0326")
+results.parts        #=> [PartInfo, ...]
+results.count        #=> Integer
+results.search_term  #=> "FG0326"
+results.manufacturer #=> "All"
+results.part_group   #=> "All"
+
+# Search with filters
+results = client.search_parts_by_number(
+  "FG0326",
+  manufacturer: "Bosch",
+  part_group: "Brakes",
+  part_type: "Pads"
+)
+
+# Include fitment data (triggers additional API call per part)
+results = client.search_parts_by_number("FG0326", include_fitments: true)
+results.parts.first.buyers_guide #=> BuyersGuideResult
+
+# Look up what a part is called
+results = client.what_is_part_called("brake pad")
+results.results #=> [WhatIsPartCalledResult(main_category, subcategory, full_path), ...]
+```
+
+### Fitment / Buyers Guide
+
+Get vehicle fitment information for a specific part.
+
+```ruby
+fitment = client.get_fitment_for_part(listing_data)
+# listing_data comes from PartInfo#listing_data or can be constructed manually
+fitment.part_number #=> "FG0326"
+fitment.brand      #=> "Bosch"
+fitment.fitments   #=> [FitmentInfo(year, make, model, engine, ...), ...]
+fitment.count      #=> Integer
+```
+
+### Order Status
+
+Look up order status and request order lists (no login required).
+
+```ruby
+# Look up an order by email and order number
+result = client.lookup_order_status("you@example.com", "RA-123456")
+result.success #=> true/false
+result.order   #=> OrderStatus (if found)
+result.error   #=> OrderStatusError (if not found)
+
+# Order status details
+order = result.order
+order.order_number    #=> "RA-123456"
+order.order_date      #=> "2024-01-15"
+order.status          #=> "Shipped"
+order.items           #=> [OrderItem(part_number, description, quantity, ...), ...]
+order.billing         #=> BillingInfo(subtotal, shipping_cost, tax, total, ...)
+order.shipping        #=> ShippingInfo(method, carrier, tracking_number, ...)
+order.notes           #=> String
+order.return_eligibility #=> String
+
+# Request RockAuto to email you a list of your orders
+client.request_order_list(:email, "you@example.com") #=> true
+
+# Request via SMS
+client.request_order_list(:sms, "+15551234567") #=> true
+```
+
+### Account (Authenticated)
+
+Requires logging in with valid RockAuto credentials.
+
+```ruby
+# Configure credentials globally
+RockautoApi.configure do |config|
+  config.credentials = { email: "you@example.com", password: "your_password" }
+end
+
+# Or pass credentials per-session
+client = RockautoApi::Client.new
+client.login("you@example.com", "your_password")
+
+# Check login status
+client.authenticated? #=> true/false
+
+# Get saved addresses
+addresses = client.get_saved_addresses
+addresses.addresses   #=> [SavedAddress(name, full_name, address_line1, city, state, ...), ...]
+addresses.count       #=> Integer
+addresses.has_default #=> true/false
+
+# Get saved vehicles
+vehicles = client.get_saved_vehicles
+vehicles.vehicles #=> [SavedVehicle(year, make, model, engine, carcode, ...), ...]
+vehicles.count    #=> Integer
+
+# Get order history
+history = client.get_order_history
+history.orders       #=> [OrderHistoryItem(order_number, date, status, total, vehicle), ...]
+history.count        #=> Integer
+history.search_time  #=> "2026-06-28T..."
+
+# Get full account activity (addresses + vehicles)
+activity = client.get_account_activity
+activity.saved_addresses  #=> SavedAddressesResult
+activity.saved_vehicles   #=> SavedVehiclesResult
+
+# Add an external order to your account
+client.add_external_order("you@example.com", "RA-123456") #=> true
+
+# Logout
+client.logout #=> true
+client.authenticated? #=> false
+```
+
+### Tools
+
+Browse RockAuto's tool catalog.
+
+```ruby
+# Get tool categories
+categories = client.get_tool_categories
+categories.categories #=> [ToolCategory(name, group_name, href, level), ...]
+categories.count      #=> Integer
+
+# Get tools in a category
+tools = client.get_tools_by_category("/en/tools/?parttype=260")
+tools.tools       #=> [ToolInfo(name, part_number, brand, description, ...), ...]
+tools.count       #=> Integer
+tools.category    #=> "?parttype=260"
+```
+
+---
+
+## Configuration
+
+```ruby
+RockautoApi.configure do |config|
+  config.default_mobile  = true   # Use mobile site headers (slimmer HTML)
+  config.request_timeout = 30     # HTTP timeout in seconds
+  config.credentials     = { email: "me@example.com", password: "s3cret" }
+  config.cache           = Rails.cache  # Use Rails cache for 24h/7d TTLs
+end
+```
+
+---
+
+## Rails Integration
+
+The gem includes a Railtie that automatically hooks into `Rails.cache`. No extra setup needed:
+
+```ruby
+# Gemfile
+gem "rockauto_api"
+
+# config/initializers/rockauto_api.rb
+RockautoApi.configure do |config|
+  config.default_mobile = false
+end
+
+# app/models/part_lookup.rb
+class PartLookup
+  def search(query)
+    client = RockautoApi::Client.new
+    client.search_parts_by_number(query)
+  end
+end
+```
+
+---
+
+## Error Handling
+
+All errors inherit from `RockautoApi::Error`:
+
+| Error Class | When It's Raised |
+|---|---|
+| `RockautoApi::AuthenticationError` | Calling authenticated methods without logging in |
+| `RockautoApi::NetworkError` | HTTP request fails (timeout, connection error) |
+| `RockautoApi::CaptchaError` | RockAuto returns a CAPTCHA challenge |
+| `RockautoApi::ParseError` | Failed to parse HTML response |
+| `RockautoApi::NotFoundError` | Resource not found |
+
+Example:
+
+```ruby
+begin
+  client.get_saved_addresses
+rescue RockautoApi::AuthenticationError => e
+  puts "Please login first: #{e.message}"
+rescue RockautoApi::NetworkError => e
+  puts "Network issue: #{e.message}"
+end
+```
+
+---
+
+## Development
+
+```
+git clone https://github.com/bendangelo/rockauto_api
+cd rockauto_api
+bin/setup
+```
+
+Run the test suite:
+
+```
+bundle exec rspec
+```
+
+Tests use [VCR](https://github.com/vcr/vcr) to record and replay HTTP interactions. To re-record cassettes with live data:
+
+```
+rm -rf spec/cassettes/
+bundle exec rspec
+```
+
+New cassettes will be created recording real HTTP requests. Sensitive data (credentials, cookies) is automatically filtered.
+
+---
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/my-feature`)
+3. Commit your changes (`git commit -am "Add my feature"`)
+4. Push to the branch (`git push origin feature/my-feature`)
+5. Open a Pull Request
+
+Please include tests for any new functionality and ensure the full suite passes.
+
+---
+
+## License
+
+Apache 2.0. See [LICENSE](LICENSE).
+
+---
+
+## Disclaimer
+
+This software is provided for **educational and research purposes only**. It is not affiliated with, endorsed by, or officially connected to RockAuto LLC. Automated access to RockAuto.com may violate their Terms of Service. Users are solely responsible for ensuring their use complies with all applicable terms and laws. The authors assume no liability for any misuse.

data/lib/rockauto_api/client.rb

@@ -68,6 +68,7 @@ module RockautoApi
 
       resp = @conn.get("/")
       @nck_token = Parsers::HtmlHelpers.extract_javascript_variable(resp.body, "_nck")
+      @nck_token ||= Parsers::HtmlHelpers.extract_csrf_token(resp.body, "_nck")
       @jnck_token = @nck_token ? CGI.escape(@nck_token) : nil
       @session_initialized = true
     end
@@ -126,23 +127,50 @@ module RockautoApi
       end
 
       if make
-        payload = {
-          "jsn" => {
-            "make" => make,
-            "nodetype" => "make",
-            "loaded" => false,
-            "expand_after_load" => true,
-            "fetching" => true,
-            "max_group_index" => 363,
-            "mkt_US" => true,
-            "mkt_CA" => false,
-            "mkt_MX" => false
-          }
-        }
+        payload = navnode_fetch_payload(
+          make: make,
+          nodetype: "make",
+          label: make,
+          href: "#{BASE_URL}/en/catalog/#{make.downcase}"
+        )
         call_catalog_api("navnode_fetch", payload)
       end
     end
 
+    def navnode_fetch_payload(make:, nodetype:, label: nil, href: nil, year: nil, model: nil, carcode: nil)
+      jsn = {
+        "tab" => "catalog",
+        "make" => make,
+        "nodetype" => nodetype,
+        "jsdata" => {
+          "markets" => [
+            {"c" => "US", "y" => "Y", "i" => "Y"},
+            {"c" => "CA", "y" => "Y", "i" => "Y"},
+            {"c" => "MX", "y" => "Y", "i" => "Y"}
+          ],
+          "mktlist" => "US,CA,MX",
+          "showForMarkets" => {"US" => true, "CA" => true, "MX" => true},
+          "importanceByMarket" => {"US" => "Y", "CA" => "Y", "MX" => "Y"},
+          "Show" => 1
+        },
+        "loaded" => false,
+        "expand_after_load" => true,
+        "fetching" => true
+      }
+
+      jsn["year"] = year.to_s if year
+      jsn["model"] = model if model
+      jsn["carcode"] = carcode if carcode
+      jsn["label"] = label if label
+      jsn["href"] = href if href
+      jsn["labelset"] = true if label || href
+      jsn["jump_to_after_expand"] = true if nodetype == "make"
+      jsn["dont_change_url"] = true if nodetype == "make"
+      jsn["has_more_auto_open_steps"] = true if nodetype == "make"
+
+      { "jsn" => jsn, "max_group_index" => 388 }
+    end
+
     def get(path)
       init_session!
       resp = @conn.get(path)

data/lib/rockauto_api/endpoints/account.rb

@@ -8,23 +8,41 @@ module RockautoApi
       ORDER_HISTORY_URL = "/en/orderhistory/"
 
       def login(email, password)
-        payload = {
-          "jsn" => {
-            "email" => email,
-            "password" => password,
-            "keep_me_logged_in" => false
-          }
+        init_session!
+
+        form_data = {
+          "loginaction" => "login",
+          "accountemail" => email,
+          "captchacode" => "",
+          "passworddecoy" => "",
+          "password" => password,
+          "passwordconfirmdecoy" => "",
+          "passwordconfirm" => "",
+          "keepsignin" => "false",
+          "async" => "1",
+          "accountlogin_php" => "1"
         }
 
-        response = call_catalog_api("login", payload)
-        @authenticated = response["success"] == true || response.dig("response", "success") == true
+        resp = account_api_post(form_data)
+
+        result = JSON.parse(resp.body)
+        @authenticated = result["message"]&.include?("Successful") || false
         @authenticated
-      rescue NetworkError
+      rescue StandardError
         @authenticated = false
       end
 
       def logout
-        response = call_catalog_api("logout", {})
+        init_session!
+
+        form_data = {
+          "loginaction" => "logout",
+          "async" => "1",
+          "accountlogin_php" => "1"
+        }
+
+        account_api_post(form_data)
+
         @authenticated = false
         true
       rescue StandardError
@@ -154,6 +172,23 @@ module RockautoApi
       def require_authentication!
         raise AuthenticationError, "Not authenticated. Call login(email, password) first." unless @authenticated
       end
+
+      def account_api_post(form_data)
+        Faraday.new(url: Client::BASE_URL) do |f|
+          f.request :url_encoded
+          f.use :cookie_jar
+          f.adapter Faraday.default_adapter
+          f.options.timeout = RockautoApi.configuration&.request_timeout || 30
+          @conn.headers["Cookie"].to_s.split(";").each do |cookie|
+            name, val = cookie.strip.split("=", 2)
+            f.headers["Cookie"] = "#{f.headers['Cookie']}; #{name}=#{val}" if name && val
+          end
+          f.headers["User-Agent"] = Client::MOBILE_HEADERS["User-Agent"]
+          f.headers["Referer"] = "#{Client::BASE_URL}/"
+          f.headers["Content-Type"] = "application/x-www-form-urlencoded; charset=UTF-8"
+          f.headers["X-Requested-With"] = "XMLHttpRequest"
+        end.post("/catalog/catalogapi.php", form_data)
+      end
     end
   end
 end

data/lib/rockauto_api/endpoints/part_categories.rb

@@ -4,22 +4,15 @@ module RockautoApi
   module Endpoints
     module PartCategories
       def get_part_categories(make, year, model, carcode)
-        payload = {
-          "jsn" => {
-            "make" => make,
-            "year" => year.to_s,
-            "model" => model,
-            "carcode" => carcode,
-            "nodetype" => "model",
-            "loaded" => false,
-            "expand_after_load" => true,
-            "fetching" => true,
-            "max_group_index" => 0,
-            "mkt_US" => true,
-            "mkt_CA" => false,
-            "mkt_MX" => false
-          }
-        }
+        payload = navnode_fetch_payload(
+          make: make,
+          nodetype: "model",
+          label: model,
+          href: "#{Client::BASE_URL}/en/catalog/#{make.downcase},#{year},#{model.downcase}",
+          year: year,
+          model: model,
+          carcode: carcode
+        )
 
         response = call_catalog_api("navnode_fetch", payload)
         html = response.dig("html_fill_sections", "navchildren[]") || ""

data/lib/rockauto_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RockautoApi
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rockauto_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben D'Angelo
@@ -141,6 +141,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/rockauto_api.rb
 - lib/rockauto_api/cache.rb
 - lib/rockauto_api/client.rb