synsbasen_api 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 70f3463d8af67697bd559cb53ced9254cc04a6b217963e56b7fe89e6ebd19e33
+  data.tar.gz: f1670824ee49861fbc4ef6f50ae9e929552ce78687bf1105167338ddc45c5a3f
+SHA512:
+  metadata.gz: d92c768c2ad3f9b159e66c388e7875a30cfc30e624886e3020005fb7c6b65ca773be241a61c5da715970afbbccd1d41c83d34e1cfe6d44e6b994a73f4ef4a840
+  data.tar.gz: 071c62aee5fc0c1de9261d14c63f6f56540025f65ec5dc55873bfe5e9a98a85a4c29d9138b462eb04736339b76ba32e24ffa9b52010dc54065b3d27f69a7c90c

data/lib/synsbasen_api/api_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SynsbasenApi
+  # The `ApiResponse` class represents the response structure from the Synsbasen API.
+  class ApiResponse
+    # @return [Hash] The data included in the API response.
+    attr_reader :data
+
+    # @return [Numeric] The cost associated with the API response.
+    attr_reader :cost
+
+    # @return [Boolean] Indicates whether there is more data available in the response.
+    attr_reader :has_more
+
+    # Initializes a new instance of `ApiResponse` with the provided response data.
+    #
+    # @param response [Hash] The response data from the API.
+    # @option response [Hash] :data The data included in the API response.
+    # @option response [Numeric] :cost The cost associated with the API response.
+    # @option response [Boolean] :has_more Indicates whether there is more data available in the response.
+    def initialize(response)
+      @data = response[:data]
+      @cost = response[:cost]
+      @has_more = response[:has_more] || false
+    end
+  end
+end

data/lib/synsbasen_api/client.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "synsbasen_api/api_response"
+require "synsbasen_api/error"
+require "faraday"
+require "active_support/core_ext/hash/keys"
+
+module SynsbasenApi
+  # The `Client` class serves as the base class for interacting with the Synsbasen API.
+  class Client
+    DEFAULT_BASE_URL = "https://api.synsbasen.dk".freeze
+
+    class << self
+      # Establishes and returns a connection to the Synsbasen API.
+      #
+      # @return [Faraday::Connection] A Faraday connection instance.
+      def connection
+        @_connection ||= Faraday.new(url: SynsbasenApi.config[:base_url] || DEFAULT_BASE_URL) do |conn|
+          conn.use Faraday::Response::RaiseError
+          conn.headers = {
+            'Content-Type' => 'application/json',
+            'Authorization' => 'Bearer ' + SynsbasenApi.config[:api_key],
+          }
+        end
+      end
+
+      # Sends a GET request to the Synsbasen API.
+      #
+      # @param path [String] The API endpoint path.
+      # @param params [Hash] Query parameters for the request.
+      # @param body [Hash] Request body.
+      # @return [ApiResponse] An instance of `ApiResponse` containing the API response.
+      # @raise [ClientError, ServerError] Raised for client or server errors.
+      def get(path, params: {}, body: {})
+        response = connection.get(path) do |req|
+          req.params = params
+          req.body = body unless body.empty?
+        end
+
+        ApiResponse.new(JSON.parse(response.body).deep_symbolize_keys)
+      rescue => e
+        rescue_and_raise_errors(e)
+      end
+
+      # Sends a POST request to the Synsbasen API.
+      #
+      # @param path [String] The API endpoint path.
+      # @param params [Hash] Query parameters for the request.
+      # @param body [Hash] Request body.
+      # @return [ApiResponse] An instance of `ApiResponse` containing the API response.
+      # @raise [ClientError, ServerError] Raised for client or server errors.
+      def post(path, params: {}, body: {})
+        response = connection.post(path) do |req|
+          req.params = params
+          req.body = body
+        end
+
+        ApiResponse.new(JSON.parse(response.body).deep_symbolize_keys)
+      rescue => e
+        rescue_and_raise_errors(e)
+      end
+
+      private
+
+      # Rescues and raises specific errors based on the type of Faraday error encountered.
+      #
+      # @param e [Exception] The exception to handle.
+      # @raise [ClientError, ServerError] Raised for client or server errors.
+      def rescue_and_raise_errors(e)
+        case e
+        when Faraday::UnauthorizedError
+          raise ClientError.new(e.message, e.response[:status], {})
+        when Faraday::ClientError
+          raise ClientError.new(e.message, e.response[:status], JSON.parse(e.response[:body]).deep_symbolize_keys)
+        when Faraday::ServerError
+          raise ServerError.new(e.message, e.response[:status], JSON.parse(e.response[:body]).deep_symbolize_keys)
+        else
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/synsbasen_api/error.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SynsbasenApi
+  # The `Error` module provides custom error classes for handling API errors.
+  class Error < StandardError
+    # @return [String] The error message.
+    attr_accessor :message
+
+    # @return [String] The HTTP status code associated with the error.
+    attr_accessor :status
+
+    # @return [Hash] Additional data associated with the error.
+    attr_accessor :data
+
+    # Initializes a new instance of `Error`.
+    #
+    # @param msg [String] The error message.
+    # @param status [String] The HTTP status code associated with the error.
+    # @param data [Hash] Additional data associated with the error.
+    def initialize(msg = '', status = '', data = {})
+      @message = msg
+      @status = status
+      @data = data
+    end
+  end
+
+  # The `ClientError` class represents errors that occur on the client side (4xx status codes).
+  class ClientError < Error; end
+
+  # The `ServerError` class represents errors that occur on the server side (5xx status codes).
+  class ServerError < Error; end
+end

data/lib/synsbasen_api/resources/brand.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SynsbasenApi
+  # The `Brand` class provides methods for interacting with brand-related
+  # endpoints in the Synsbasen API.
+  class Brand < Client
+    class << self
+      # Retrieves information about a specific brand based on its ID.
+      #
+      # @param id [String] The unique identifier of the brand.
+      # @return [ApiResponse] An instance of `ApiResponse` containing details
+      #   of the specified brand.
+      def find(id)
+        get("/v1/brands/#{id}")
+      end
+
+      # Retrieves information about all brands.
+      #
+      # @return [ApiResponse] An instance of `ApiResponse` containing details
+      #   of all brands.
+      def all
+        get("/v1/brands")
+      end
+    end
+  end
+end

data/lib/synsbasen_api/resources/inspection.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SynsbasenApi
+  # The `Inspection` class provides methods for interacting with inspection-related
+  # endpoints in the Synsbasen API.
+  class Inspection < Client
+    class << self
+      # Performs a search for inspections based on the provided criteria.
+      #
+      # @param args [Hash] Additional parameters to customize the search.
+      # @option args [String] :method The search method. Default is 'SELECT'.
+      # @return [ApiResponse] An instance of `ApiResponse` containing search results.
+      def search(args = {})
+        post(
+          "/v1/inspections/search",
+          body: {
+            method: 'SELECT',
+          }.merge(args).to_json
+        )
+      end
+    end
+  end
+end

data/lib/synsbasen_api/resources/inspection_test_center.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SynsbasenApi
+  # The `InspectionTestCenter` class provides methods for interacting with inspection test center-related
+  # endpoints in the Synsbasen API.
+  class InspectionTestCenter < Client
+    class << self
+      # Retrieves information about all inspection test centers.
+      #
+      # @return [ApiResponse] An instance of `ApiResponse` containing details
+      #   of all inspection test centers.
+      def all
+        get("/v1/inspection_test_centers")
+      end
+    end
+  end
+end

data/lib/synsbasen_api/resources/model.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SynsbasenApi
+  # The `Model` class provides methods for interacting with model-related
+  # endpoints in the Synsbasen API.
+  class Model < Client
+    class << self
+      # Retrieves information about a specific model based on its ID.
+      #
+      # @param id [String] The unique identifier of the model.
+      # @return [ApiResponse] An instance of `ApiResponse` containing details
+      #   of the specified model.
+      def find(id)
+        get("/v1/models/#{id}")
+      end
+
+      # Retrieves information about all models associated with a given brand.
+      #
+      # @param brand_id [String] The unique identifier of the brand.
+      # @return [ApiResponse] An instance of `ApiResponse` containing details
+      #   of all models associated with the specified brand.
+      def all(brand_id)
+        get("/v1/brands/#{brand_id}/models")
+      end
+    end
+  end
+end

data/lib/synsbasen_api/resources/test_center.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SynsbasenApi
+  # The `TestCenter` class provides methods for interacting with test center-related
+  # endpoints in the Synsbasen API.
+  class TestCenter < Client
+    class << self
+      # Retrieves information about all test centers.
+      #
+      # @return [ApiResponse] An instance of `ApiResponse` containing details
+      #   of all test centers.
+      def all
+        get("/v1/test_centers")
+      end
+    end
+  end
+end

data/lib/synsbasen_api/resources/variant.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SynsbasenApi
+  # The `Variant` class provides methods for interacting with variant-related
+  # endpoints in the Synsbasen API.
+  class Variant < Client
+    class << self
+      # Retrieves information about a specific variant based on its ID.
+      #
+      # @param id [String] The unique identifier of the variant.
+      # @return [ApiResponse] An instance of `ApiResponse` containing details
+      #   of the specified variant.
+      def find(id)
+        get("/v1/variants/#{id}")
+      end
+
+      # Retrieves information about all variants associated with a given model.
+      #
+      # @param model_id [String] The unique identifier of the model.
+      # @return [ApiResponse] An instance of `ApiResponse` containing details
+      #   of all variants associated with the specified model.
+      def all(model_id)
+        get("/v1/models/#{model_id}/variants")
+      end
+    end
+  end
+end

data/lib/synsbasen_api/resources/vehicle.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module SynsbasenApi
+  # The `Vehicle` class provides methods for interacting with vehicle-related
+  # endpoints in the Synsbasen API. It extends the `Client` class.
+  class Vehicle < Client
+    class << self
+      # Retrieves information about a specific vehicle based on its ID.
+      #
+      # @param id [String] The unique identifier of the vehicle.
+      # @return [ApiResponse] An instance of `ApiResponse` containing details
+      #   of the specified vehicle.
+      def find(id)
+        get("/v1/vehicles/#{id}")
+      end
+
+      # Retrieves information about a vehicle based on its registration number.
+      #
+      # @param registration [String] The registration number of the vehicle.
+      # @return [ApiResponse] An instance of `ApiResponse` containing details
+      #   of the specified vehicle.
+      def find_by_registration(registration)
+        get("/v1/vehicles/registration/#{registration}")
+      end
+
+      # Performs a search for vehicles based on the provided criteria.
+      #
+      # @param args [Hash] Additional parameters to customize the search.
+      # @option args [String] :method The search method. Default is 'SELECT'.
+      # @return [ApiResponse] An instance of `ApiResponse` containing search results.
+      def search(args = {})
+        post(
+          "/v1/vehicles/search",
+          body: {
+            method: 'SELECT',
+          }.merge(args).to_json
+        )
+      end
+    end
+  end
+end

data/lib/synsbasen_api/resources/version.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SynsbasenApi
+  # The `Version` class provides methods for interacting with version-related
+  # endpoints in the Synsbasen API.
+  class Version < Client
+    class << self
+      # Retrieves information about a specific version based on its ID.
+      #
+      # @param id [String] The unique identifier of the version.
+      # @return [ApiResponse] An instance of `ApiResponse` containing details
+      #   of the specified version.
+      def find(id)
+        get("/v1/versions/#{id}")
+      end
+
+      # Retrieves information about all versions associated with a given variant.
+      #
+      # @param variant_id [String] The unique identifier of the variant.
+      # @return [ApiResponse] An instance of `ApiResponse` containing details
+      #   of all versions associated with the specified variant.
+      def all(variant_id)
+        get("/v1/variants/#{variant_id}/versions")
+      end
+    end
+  end
+end

data/lib/synsbasen_api/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SynsbasenApi
+  # The `VERSION` module specifies the version of the SynsbasenApi gem.
+  VERSION = "1.0.1"
+end

data/lib/synsbasen_api.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "synsbasen_api/client"
+require "synsbasen_api/resources/brand"
+require "synsbasen_api/resources/inspection"
+require "synsbasen_api/resources/inspection_test_center"
+require "synsbasen_api/resources/model"
+require "synsbasen_api/resources/test_center"
+require "synsbasen_api/resources/vehicle"
+require "synsbasen_api/resources/variant"
+require "synsbasen_api/resources/version"
+
+# The `SynsbasenApi` module provides a configuration mechanism and requires various
+# classes and modules related to interacting with the Synsbasen API.
+module SynsbasenApi
+  # An array of required configuration keys.
+  REQUIRED_CONFIGS = %i[api_key]
+
+  # Configures the Synsbasen API client with the specified options.
+  #
+  # @yieldparam config [OpenStruct] The configuration object.
+  def self.configure
+    @config ||= OpenStruct.new
+    yield(@config) if block_given?
+
+    raise "Missing configuration. Required configurations are #{REQUIRED_CONFIGS}" unless REQUIRED_CONFIGS.all? { |c| @config[c] }
+
+    @config
+  end
+
+  # Retrieves the current configuration or configures the Synsbasen API client with default options.
+  #
+  # @return [OpenStruct] The configuration object.
+  def self.config
+    @config || configure
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: synsbasen_api
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Jimmy Poulsen
+- Tobias Knudsen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: Synsbasen API is the easiest way to get access to the Danish vehicle
+  registry. See https://api.synsbasen.dk for details.
+email:
+- jimmypoulsen96@gmail.com
+- tobias.knudsen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/synsbasen_api.rb
+- lib/synsbasen_api/api_response.rb
+- lib/synsbasen_api/client.rb
+- lib/synsbasen_api/error.rb
+- lib/synsbasen_api/resources/brand.rb
+- lib/synsbasen_api/resources/inspection.rb
+- lib/synsbasen_api/resources/inspection_test_center.rb
+- lib/synsbasen_api/resources/model.rb
+- lib/synsbasen_api/resources/test_center.rb
+- lib/synsbasen_api/resources/variant.rb
+- lib/synsbasen_api/resources/vehicle.rb
+- lib/synsbasen_api/resources/version.rb
+- lib/synsbasen_api/version.rb
+homepage: https://github.com/Synsbasen/synsbasen-api-ruby
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/synsbasen/synsbasen-api-ruby/issues
+  changelog_uri: https://github.com/synsbasen/synsbasen-api-ruby/blob/master/CHANGELOG.md
+  documentation_uri: https://synsbasen.github.io/synsbasen-api-ruby
+  github_repo: ssh://github.com/synsbasen/synsbasen-api-ruby
+  homepage_uri: https://api.synsbasen.dk
+  source_code_uri: https://github.com/synsbasen/synsbasen-api-ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Library that provides a simple way to interact with Synsbasen API
+test_files: []