carsxe 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8772fd8486f77ee741efb317c60f082cc17a359772b42a58e8a90268e55f9871
+  data.tar.gz: ebb283a4087e486016fa34066cb4949dcee572f4fc3cc08fba81aad032862332
+SHA512:
+  metadata.gz: ff6a99b04ef27d76cba8170a7ac7537a8e481d0bfdb18ba5622a778a36e4bca1da214e0ccd874971f68c488f1fcb349467ab960f4e69a2b11b2b6c663747022b
+  data.tar.gz: 3da21ca1907c4f97d0cbd49e2258dca19d2e455c435c8a83118c07e388ab174cee49725bd22f36ba87f7de2d475cc7f9a66a6defe48a981e86a4bade9285f95b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2025-09-10
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 CarsXE
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,297 @@
+# 🚗 CarsXE API (Ruby Gem)
+
+[![Gem Version](https://img.shields.io/gem/v/carsxe.svg)](https://rubygems.org/gems/carsxe)
+
+**CarsXE** is a powerful and developer-friendly API that gives you instant access to a wide range of vehicle data. From VIN decoding and market value estimation to vehicle history, images, OBD code explanations, and plate recognition, CarsXE provides everything you need to build automotive applications at scale.
+
+🌐 **Website:** [https://api.carsxe.com](https://api.carsxe.com)  
+📄 **Docs:** [https://api.carsxe.com/docs](https://api.carsxe.com/docs)  
+📦 **All Products:** [https://api.carsxe.com/all-products](https://api.carsxe.com/all-products)
+
+To get started with the CarsXE API, follow these steps:
+
+1. **Sign up for a CarsXE account:**
+
+   - [Register here](https://api.carsxe.com/register)
+   - Add a [payment method](https://api.carsxe.com/dashboard/billing#payment-methods) to activate your subscription and get your API key.
+
+2. **Install the CarsXE Ruby gem:**
+
+   Run this command in your terminal:
+
+   ```bash
+   gem install carsxe
+   ```
+
+   Or add it to your Gemfile:
+
+   ```ruby
+   gem 'carsxe'
+   ```
+
+   Then run `bundle install`.
+
+3. **Require the CarsXE API in your code:**
+
+   ```ruby
+   require 'carsxe'
+   ```
+
+4. **Initialize the API with your API key:**
+
+   ```ruby
+   API_KEY = 'YOUR_API_KEY'
+   carsxe = Carsxe::CarsXE.new(api_key: API_KEY)
+   ```
+
+5. **Use the various endpoint methods provided by the API to access the data you need.**
+
+## Usage
+
+```ruby
+vin = 'WBAFR7C57CC811956'
+
+begin
+  vehicle = carsxe.specs('vin' => vin)
+  puts vehicle['input']['vin']
+rescue StandardError => error
+  puts "Error: #{error.message}"
+end
+```
+
+---
+
+## 📚 Endpoints
+
+The CarsXE API provides the following endpoint methods:
+
+### `specs` – Decode VIN & get full vehicle specifications
+
+**Required:**
+
+- `vin`
+
+**Optional:**
+
+- `deepdata`
+- `disableIntVINDecoding`
+
+**Example:**
+
+```ruby
+vehicle = carsxe.specs('vin' => 'WBAFR7C57CC811956')
+```
+
+---
+
+### `int_vin_decoder` – Decode VIN with worldwide support
+
+**Required:**
+
+- `vin`
+
+**Optional:**
+
+- None
+
+**Example:**
+
+```ruby
+intvin = carsxe.int_vin_decoder('vin' => 'WF0MXXGBWM8R43240')
+```
+
+---
+
+### `plate_decoder` – Decode license plate info (plate, country)
+
+**Required:**
+
+- `plate`
+- `country` (always required except for US, where it is optional and defaults to 'US')
+
+**Optional:**
+
+- `state` (required for some countries, e.g. US, AU, CA)
+- `district` (required for Pakistan)
+
+> **Note:**
+>
+> - The `state` parameter is required only when applicable (for
+>   specific countries such as US, AU, CA, etc.).
+> - For Pakistan (`country='pk'`), both `state` and `district`
+>   are required.
+
+**Example:**
+
+```ruby
+decoded_plate = carsxe.plate_decoder('plate' => '7XER187', 'state' => 'CA', 'country' => 'US')
+```
+
+---
+
+### `market_value` – Estimate vehicle market value based on VIN
+
+**Required:**
+
+- `vin`
+
+**Optional:**
+
+- `state`
+
+**Example:**
+
+```ruby
+marketvalue = carsxe.market_value('vin' => 'WBAFR7C57CC811956')
+```
+
+---
+
+### `history` – Retrieve vehicle history
+
+**Required:**
+
+- `vin`
+
+**Optional:**
+
+- None
+
+**Example:**
+
+```ruby
+history = carsxe.history('vin' => 'WBAFR7C57CC811956')
+```
+
+---
+
+### `images` – Fetch images by make, model, year, trim
+
+**Required:**
+
+- `make`
+- `model`
+
+**Optional:**
+
+- `year`
+- `trim`
+- `color`
+- `transparent`
+- `angle`
+- `photoType`
+- `size`
+- `license`
+
+**Example:**
+
+```ruby
+images = carsxe.images('make' => 'BMW', 'model' => 'X5', 'year' => '2019')
+```
+
+---
+
+### `recalls` – Get safety recall data for a VIN
+
+**Required:**
+
+- `vin`
+
+**Optional:**
+
+- None
+
+**Example:**
+
+```ruby
+recalls = carsxe.recalls('vin' => '1C4JJXR64PW696340')
+```
+
+---
+
+### `plate_image_recognition` – Read & decode plates from images
+
+**Required:**
+
+- `upload_url`
+
+**Optional:**
+
+- None
+
+**Example:**
+
+```ruby
+plateimg = carsxe.plate_image_recognition('upload_url' => 'https://api.carsxe.com/img/apis/plate_recognition.JPG')
+```
+
+---
+
+### `vin_ocr` – Extract VINs from images using OCR
+
+**Required:**
+
+- `upload_url`
+
+**Optional:**
+
+- None
+
+**Example:**
+
+```ruby
+vinocr = carsxe.vin_ocr('upload_url' => 'https://api.carsxe.com/img/apis/plate_recognition.JPG')
+```
+
+---
+
+### `year_make_model` – Query vehicle by year, make, model and trim (optional)
+
+**Required:**
+
+- `year`
+- `make`
+- `model`
+
+**Optional:**
+
+- `trim`
+
+**Example:**
+
+```ruby
+yymm = carsxe.year_make_model('year' => '2012', 'make' => 'BMW', 'model' => '5 Series')
+```
+
+---
+
+### `obd_codes_decoder` – Decode OBD error/diagnostic codes
+
+**Required:**
+
+- `code`
+
+**Optional:**
+
+- None
+
+**Example:**
+
+```ruby
+obdcode = carsxe.obd_codes_decoder('code' => 'P0115')
+```
+
+---
+
+## Notes & Best Practices
+
+- **Parameter requirements:** Each endpoint requires specific parameters—see the Required/Optional fields above.
+- **Return values:** All responses are Ruby hashes for easy access and manipulation.
+- **Error handling:** Use begin/rescue blocks to gracefully handle API errors.
+- **More info:** For advanced usage and full details, visit the [official API documentation](https://api.carsxe.com/docs).
+
+---
+
+## Overall
+
+CarsXE API provides a wide range of powerful, easy-to-use tools for accessing and integrating vehicle data into your applications and services. Whether you're a developer or a business owner, you can quickly get the information you need to take your projects to the next level—without hassle or inconvenience.

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "standard/rake"
+
+task default: :standard

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "carsxe"
+
+# 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/carsxe/carsxe.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "json"
+require_relative "types"
+
+module Carsxe
+  class CarsXE
+    include Types
+
+    def initialize(api_key:)
+      @api_key = api_key
+    end
+
+    attr_reader :api_key
+
+    def api_base_url
+      "https://api.carsxe.com"
+    end
+
+    # Public API methods (mirror the python template)
+    def specs(params = {})
+      get("specs", params, Types::SPECS_INPUT)
+    end
+
+    def int_vin_decoder(params = {})
+      get("v1/international-vin-decoder", params, Types::VIN_INPUT)
+    end
+
+    def recalls(params = {})
+      get("v1/recalls", params, Types::VIN_INPUT)
+    end
+
+    def plate_decoder(params = {})
+      # default country to US if not provided (matches Python template)
+      params = params.dup
+      params["country"] = "US" if params["country"].nil? || params["country"] == ""
+      get("v2/platedecoder", params, Types::PLATE_DECODER_PARAMS)
+    end
+
+    def images(params = {})
+      get("images", params, Types::IMAGE_INPUT)
+    end
+
+    def market_value(params = {})
+      # market_value: same required params as VIN_INPUT but 'state' is allowed optional
+      required, optional = required_optional(Types::VIN_INPUT, params)
+      optional |= ["state"]
+      url, query = build_url("v2/marketvalue", params, required, optional)
+      perform_get(url, query)
+    end
+
+    def history(params = {})
+      get("history", params, Types::VIN_INPUT)
+    end
+
+    def plate_image_recognition(params = {})
+      url = "#{api_base_url}/platerecognition?key=#{api_key}&source=ruby"
+      if params.size == 1
+        first_key, first_value = params.first
+        post_json(url, { first_key => first_value })
+      else
+        raise ArgumentError, "Expected exactly one parameter, but got #{params.size}"
+      end
+    end
+
+    def vin_ocr(params = {})
+      url = "#{api_base_url}/v1/vinocr?key=#{api_key}&source=ruby"
+      if params.size == 1
+        first_key, first_value = params.first
+        post_json(url, { first_key => first_value })
+      else
+        raise ArgumentError, "Expected exactly one parameter, but got #{params.size}"
+      end
+    end
+
+    def year_make_model(params = {})
+      get("v1/ymm", params, Types::YEAR_MAKE_MODEL_INPUT)
+    end
+
+    def obd_codes_decoder(params = {})
+      get("obdcodesdecoder", params, Types::OBDCODESDECODER_INPUT)
+    end
+
+    private
+
+    # Determine required and optional keys from a param definition hash.
+    # Also applies special plate/country logic:
+    # - If country is 'PK' (Pakistan), both 'state' and 'district' are required.
+    # - Otherwise ensure 'state' is required for plate decoder (mirrors Python behavior).
+    def required_optional(param_def, params = nil)
+      required = param_def.select { |_k, v| v == :required }.keys.map(&:to_s)
+      optional = param_def.select { |_k, v| v == :optional }.keys.map(&:to_s)
+
+      # Special case for plate decoder params
+      if param_def.equal?(Types::PLATE_DECODER_PARAMS)
+        country = if params && params["country"]
+                    params["country"].to_s.downcase
+                  else
+                    "us"
+                  end
+
+        if country == "pk" || country == "pakistan"
+          required |= ["state", "district"]
+          optional -= ["state", "district"]
+        else
+          # ensure 'state' is required for non-PK
+          required |= ["state"]
+          optional -= ["state"]
+        end
+      end
+
+      # If params is provided, check all required keys exist and are non-nil
+      if params
+        missing = required.reject { |k| params.key?(k) && !params[k].nil? }
+        unless missing.empty?
+          raise ArgumentError, "Missing required parameter(s): #{missing.join(', ')}"
+        end
+      end
+
+      [required, optional]
+    end
+
+    # Build url (string) and query hash for GET requests
+    def build_url(endpoint, params, required, optional)
+      permitted = (required + optional).map(&:to_s)
+      query = {}
+
+      params.each do |k, v|
+        key = k.to_s
+        next unless permitted.include?(key)
+        next if v.nil?
+
+        query[key] = v
+      end
+
+      query["key"] = api_key
+      query["source"] = "ruby"
+      ["#{api_base_url}/#{endpoint}", query]
+    end
+
+    # Generic GET path that validates params using the param_def.
+    def get(endpoint, params, param_def)
+      required, optional = required_optional(param_def, params)
+      url, query = build_url(endpoint, params, required, optional)
+      perform_get(url, query)
+    end
+
+    # Low-level HTTP get helper
+    def perform_get(url_str, query = {})
+      uri = URI(url_str)
+      uri.query = URI.encode_www_form(query) unless query.empty?
+
+      response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") do |http|
+        req = Net::HTTP::Get.new(uri)
+        http.request(req)
+      end
+
+      parse_response(response)
+    end
+
+    def post_json(url_str, payload = {})
+      uri = URI(url_str)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      req = Net::HTTP::Post.new(uri)
+      req["Content-Type"] = "application/json"
+      req.body = payload.to_json
+      response = http.request(req)
+      parse_response(response)
+    end
+
+    def parse_response(response)
+      body = response.body.to_s
+      parsed=JSON.parse(body) 
+      parsed
+    end
+  end
+end

data/lib/carsxe/types.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+#
+# Parameter "schemas" used by the client to determine required vs optional keys.
+# Values are :required or :optional (simple representation, enough for validation here).
+
+module Carsxe
+  module Types
+    VIN_INPUT = {
+      "vin" => :required
+    }.freeze
+
+    PLATE_DECODER_PARAMS = {
+      "plate"    => :required,
+      "country"  => :optional, # country is allowed but not strictly required by default
+      "state"    => :optional,
+      "district" => :optional
+    }.freeze
+
+    IMAGE_INPUT = {
+      "make"        => :required,
+      "model"       => :required,
+      "year"        => :optional,
+      "trim"        => :optional,
+      "color"       => :optional,
+      "transparent" => :optional,
+      "angle"       => :optional,
+      "photoType"   => :optional,
+      "size"        => :optional,
+      "license"     => :optional
+    }.freeze
+
+    OBDCODESDECODER_INPUT = {
+      "code" => :required
+    }.freeze
+
+    PLATE_IMAGE_RECOGNITION_INPUT = {
+      "upload_url" => :required
+    }.freeze
+
+    VIN_OCR_INPUT = {
+      "upload_url" => :required
+    }.freeze
+
+    YEAR_MAKE_MODEL_INPUT = {
+      "year"  => :required,
+      "make"  => :required,
+      "model" => :required,
+      "trim"  => :optional
+    }.freeze
+
+    SPECS_INPUT = {
+      "vin"                     => :required,
+      "deepData"                => :optional,
+      "disableIntVINDecoding"   => :optional
+    }.freeze
+  end
+end

data/lib/carsxe/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Carsxe
+  VERSION = "1.0.0"
+end

data/lib/carsxe.rb

@@ -0,0 +1,2 @@
+require "carsxe/version"
+require "carsxe/carsxe"

data/sig/carsxe.rbs

@@ -0,0 +1,4 @@
+module Carsxe
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: carsxe
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- CarsXE Developer
+- Omar Welied
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: CarsXE Ruby gem provides a simple and efficient way to interact with
+  CarsXE APIs, enabling developers to integrate vehicle data and services into their
+  applications.
+email:
+- devops@carsxe.com
+- omar.walied@carsxe.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/carsxe.rb
+- lib/carsxe/carsxe.rb
+- lib/carsxe/types.rb
+- lib/carsxe/version.rb
+- sig/carsxe.rbs
+homepage: https://github.com/carsxe/carsxe-ruby-package
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/carsxe/carsxe-ruby-package
+  source_code_uri: https://github.com/carsxe/carsxe-ruby-package
+  changelog_uri: https://github.com/carsxe/carsxe-ruby-package/blob/main/CHANGELOG.md
+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.6.9
+specification_version: 4
+summary: A Ruby gem for interacting with CarsXE APIs.
+test_files: []