synsbasen_api 1.0.6 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ec09887bb8b74dc5f47f9dcb332df43bc09fe4fcea136ec6d9aeac2b49bacd7
-  data.tar.gz: 0ce055a70a194f3d39f27b4e53dbb8cbb98dac3d1d6a1626c2cbe60c06137158
+  metadata.gz: de87965f69a8b280b6520272e6bc6cc005ba5573052015e80d5eaad9f82dde9f
+  data.tar.gz: 46a3bbab6a5d51f3b843ab008be9d5e292ef3235035cb943cf631f653891ab90
 SHA512:
-  metadata.gz: e5626d8778158b88925117cdacd28131dc95fc1571ebe04b9306a1b446ac92d60d4067162ca0801b7105e1b161ed5e1b8773b2ca8dcc684ed670b9130a8a867f
-  data.tar.gz: ad7fba5fe84d5dae76cd87f767e67019e08c050fec7262af4a4ed32fbfc805c275837aede3622f2a417e3f6b36e0b33706b5292c4485bdbd3d07a43e777df094
+  metadata.gz: 87360c58515dc8a084bcf08f02435e5320989f13bdc06d17ec391e9ee8e1492546c2adafa6f1c0bad310fdd6b88c7397449f917038e3e244201ae7f8a6e8452d
+  data.tar.gz: d4904776df894bb5e2dac117ec719202b98ac4ed84054e78238372997d08839504475211cbf3321e34e3f3d9141731b5b8f717a3b50a5e0be1f00427024ede40

data/lib/synsbasen_api/client.rb

@@ -2,10 +2,9 @@
 
 require "synsbasen_api/api_response"
 require "synsbasen_api/error"
-require "faraday"
-require "active_support/core_ext/hash/keys"
-require "active_support/core_ext/object/blank"
-require "active_support/core_ext/enumerable"
+require "net/http"
+require "uri"
+require "json"
 
 module SynsbasenApi
   # The `Client` class serves as the base class for interacting with the Synsbasen API.
@@ -13,86 +12,139 @@ module SynsbasenApi
     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.
+      # Sends a GET request to Synsbasen API.
       #
       # @param path [String] The API endpoint path.
       # @param params [Hash] Query parameters for the request.
-      # @param body [Hash] Request body.
+      # @param expand [Array] List of fields to expand in the response.
       # @return [ApiResponse] An instance of `ApiResponse` containing the API response.
       # @raise [ClientError, ServerError] Raised for client or server errors.
       def get(path, params: {}, expand: [])
-        response = connection.get(path) do |req|
-          req.params = { **params, expand: expand }.compact_blank
-        end
+        request = build_request(path, method: Net::HTTP::Get, params: params, expand: expand)
+
+        response = connection.request(request)
+
+        raise_errors(response)
 
         handle_after_request_callback(response)
 
-        ApiResponse.new(JSON.parse(response.body).deep_symbolize_keys)
-      rescue => e
-        rescue_and_raise_errors(e)
+        ApiResponse.new(parse_json(response.body))
       end
 
-      # Sends a POST request to the Synsbasen API.
+      # Sends a POST request to Synsbasen API.
       #
       # @param path [String] The API endpoint path.
       # @param params [Hash] Query parameters for the request.
       # @param body [Hash] Request body.
+      # @param expand [Array] List of fields to expand in the response.
       # @return [ApiResponse] An instance of `ApiResponse` containing the API response.
       # @raise [ClientError, ServerError] Raised for client or server errors.
       def post(path, params: {}, body: {}, expand: [])
-        response = connection.post(path) do |req|
-          req.params = params
-          req.body = { **body, expand: expand }.compact_blank.to_json
-        end
+        request = build_request(path, method: Net::HTTP::Post, params: params, body: body, expand: expand)
+
+        response = connection.request(request)
+
+        raise_errors(response)
 
         handle_after_request_callback(response)
 
-        ApiResponse.new(JSON.parse(response.body).deep_symbolize_keys)
-      rescue => e
-        rescue_and_raise_errors(e)
+        ApiResponse.new(parse_json(response.body))
       end
 
       private
 
-      # Rescues and raises specific errors based on the type of Faraday error encountered.
+      # Establishes and returns a connection to Synsbasen API.
+      #
+      # @return [Net::HTTP] A Net::HTTP connection instance.
+      def connection
+        uri = URI.parse(SynsbasenApi.config[:base_url] || DEFAULT_BASE_URL)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == "https"
+        http
+      end
+
+      # Builds a Net::HTTP request object with the specified parameters.
+      #
+      # @param path [String] The API endpoint path.
+      # @param params [Hash] Query parameters for the request.
+      # @param body [Hash] Request body.
+      # @param expand [Array] List of fields to expand in the response.
+      # @param method [Net::HTTP::Get, Net::HTTP::Post] The HTTP method to use.
+      #
+      # @return [Net::HTTP::Get, Net::HTTP::Post] A Net::HTTP request object.
+      def build_request(path, method:, params: {}, body: {}, expand: [])
+        uri = URI.parse(SynsbasenApi.config[:base_url] || DEFAULT_BASE_URL)
+        uri.path = path
+        query = params
+        query.merge!('expand[]': expand) unless expand.nil? || expand.empty?
+        uri.query = URI.encode_www_form(query)
+
+        request = method.new(uri)
+        request.body = body.reject { |i| i.nil? || i.empty? }.to_json if method == Net::HTTP::Post
+        request["Content-Type"] = "application/json"
+        request["Authorization"] = "Bearer #{SynsbasenApi.config[:api_key]}"
+
+        request
+      end
+
+      # Raises specific errors based on the type of Net::HTTP 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)
+      def raise_errors(response)
+        case response
+        when Net::HTTPUnauthorized
+          raise ClientError.new(response.message, response.code, {})
+        when Net::HTTPClientError, Net::HTTPBadRequest, Net::HTTPForbidden, Net::HTTPNotFound
+          raise ClientError.new(response.message, response.code, parse_json(response.body))
+        when Net::HTTPServerError
+          raise ServerError.new(response.message, response.code, {})
         else
-          raise e
+          response
         end
       end
 
       # Calls the after_request callback if configured in the SynsbasenApi.
       #
-      # @param response [Faraday::Response] The Faraday response object.
+      # @param response [Net::HTTPResponse] The Net::HTTPResponse object.
       # @return [void]
       def handle_after_request_callback(response)
         return unless SynsbasenApi.config[:after_request]
 
         SynsbasenApi.config[:after_request].call(response)
       end
+
+      # Parses a JSON string into a hash with symbolized keys.
+      #
+      # @param data [String] The JSON string to parse.
+      # @return [Hash] The parsed JSON string as a hash with symbolized keys.
+      def parse_json(data)
+        deep_symbolize_keys(JSON.parse(data))
+      end
+
+      # Recursively converts all keys in a hash to symbols.
+      #
+      # This method is used to convert all keys in the API response to symbols.
+      #
+      # @param hash [Hash] The hash to convert.
+      # @return [Hash] The hash with all keys converted to symbols.
+      # @example
+      #  deep_symbolize_keys({ "key" => "value" }) #=> { key: "value" }
+      #  deep_symbolize_keys({ "key" => { "nested_key" => "value" } }) #=> { key: { nested_key: "value" } }
+      def deep_symbolize_keys(obj)
+        case obj
+        when Hash
+          obj.each_with_object({}) do |(key, value), result|
+            new_key = key.is_a?(String) ? key.to_sym : key
+            new_value = deep_symbolize_keys(value)
+            result[new_key] = new_value
+          end
+        when Array
+          obj.map { |value| deep_symbolize_keys(value) }
+        else
+          obj
+        end
+      end
     end
   end
 end

data/lib/synsbasen_api/findable.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SynsbasenApi
+  # Provides a method to find a resource by its ID.
+  #
+  # This module is intended to be extended in classes that represent resources.
+  module Findable
+    # Retrieves information about a specific record based on its ID.
+    #
+    # @param id [String] The unique identifier of the record.
+    # @param expand [Array<String>] A list of related resources to include in the response.
+    # @return [ApiResponse] An instance of `ApiResponse` containing details
+    #   of the specified version.
+    def find(id, expand: [])
+      get("/v1/#{resource_name}/#{id}", expand: expand)
+    end
+  end
+end

data/lib/synsbasen_api/resource.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SynsbasenApi
+  class Resource < Client
+    class << self
+      private
+
+      # Define the resource name
+      #
+      # @return [String]
+      # @raise [NotImplementedError] if the method is not implemented by the subclass
+      def resource_name
+        raise NotImplementedError, 'Subclasses must implement this method'
+      end
+    end
+  end
+end

data/lib/synsbasen_api/resources/brand.rb

@@ -3,23 +3,23 @@
 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, expand: [])
-        get("/v1/brands/#{id}", expand: expand)
-      end
+  class Brand < Resource
+    extend Findable
+    extend Searchable
 
+    class << self
       # Retrieves information about all brands.
       #
       # @return [ApiResponse] An instance of `ApiResponse` containing details
       #   of all brands.
       def all(expand: [])
-        get("/v1/brands", expand: expand)
+        get("/v1/#{resource_name}", expand: expand)
+      end
+
+      private
+
+      def resource_name
+        "brands"
       end
     end
   end

data/lib/synsbasen_api/resources/inspection.rb

@@ -3,21 +3,14 @@
 module SynsbasenApi
   # The `Inspection` class provides methods for interacting with inspection-related
   # endpoints in the Synsbasen API.
-  class Inspection < Client
+  class Inspection < Resource
+    extend Searchable
+
     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 = {}, expand: [])
-        post(
-          "/v1/inspections/search",
-          body: {
-            method: 'SELECT',
-          }.merge(args),
-          expand: expand
-        )
+      private
+
+      def resource_name
+        "inspections"
       end
     end
   end

data/lib/synsbasen_api/resources/inspection_test_center.rb

@@ -3,14 +3,22 @@
 module SynsbasenApi
   # The `InspectionTestCenter` class provides methods for interacting with inspection test center-related
   # endpoints in the Synsbasen API.
-  class InspectionTestCenter < Client
+  class InspectionTestCenter < Resource
+    extend Searchable
+
     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")
+        get("/v1/#{resource_name}")
+      end
+
+      private
+
+      def resource_name
+        "inspection_test_centers"
       end
     end
   end

data/lib/synsbasen_api/resources/leasing_period.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SynsbasenApi
+  class LeasingPeriod < Resource
+    extend Searchable
+
+    class << self
+      private
+
+      def resource_name
+        "leasing_periods"
+      end
+    end
+  end
+end

data/lib/synsbasen_api/resources/model.rb

@@ -3,24 +3,24 @@
 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, expand: [])
-        get("/v1/models/#{id}", expand: expand)
-      end
+  class Model < Resource
+    extend Findable
+    extend Searchable
 
+    class << self
       # 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, expand: [])
-        get("/v1/brands/#{brand_id}/models", expand: expand)
+        get("/v1/brands/#{brand_id}/#{resource_name}", expand: expand)
+      end
+
+      private
+
+      def resource_name
+        "models"
       end
     end
   end

data/lib/synsbasen_api/resources/test_center.rb

@@ -3,14 +3,20 @@
 module SynsbasenApi
   # The `TestCenter` class provides methods for interacting with test center-related
   # endpoints in the Synsbasen API.
-  class TestCenter < Client
+  class TestCenter < Resource
     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")
+        get("/v1/#{resource_name}")
+      end
+
+      private
+
+      def resource_name
+        "test_centers"
       end
     end
   end

data/lib/synsbasen_api/resources/variant.rb

@@ -3,24 +3,24 @@
 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, expand: [])
-        get("/v1/variants/#{id}", expand: expand)
-      end
+  class Variant < Resource
+    extend Findable
+    extend Searchable
 
+    class << self
       # 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, expand: [])
-        get("/v1/models/#{model_id}/variants", expand: expand)
+        get("/v1/models/#{model_id}/#{resource_name}", expand: expand)
+      end
+
+      private
+
+      def resource_name
+        "variants"
       end
     end
   end

data/lib/synsbasen_api/resources/vehicle.rb

@@ -5,17 +5,11 @@ require 'cgi/escape'
 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, expand: [])
-        get("/v1/vehicles/#{id}", expand: expand)
-      end
+  class Vehicle < Resource
+    extend Findable
+    extend Searchable
 
+    class << self
       # Retrieves information about a vehicle based on its registration number.
       #
       # @param registration [String] The registration number of the vehicle.
@@ -23,7 +17,7 @@ module SynsbasenApi
       #   of the specified vehicle.
       def find_by_registration(registration, expand: [])
         escaped_registration = CGI.escape(registration)
-        get("/v1/vehicles/registration/#{escaped_registration}", expand: expand)
+        get("/v1/#{resource_name}/registration/#{escaped_registration}", expand: expand)
       end
 
       # Retrieves information about a vehicle based on its VIN (Vehicle Identification Number).
@@ -32,22 +26,13 @@ module SynsbasenApi
       # @return [ApiResponse] An instance of `ApiResponse` containing details
       #   of the specified vehicle.
       def find_by_vin(vin, expand: [])
-        get("/v1/vehicles/vin/#{vin}", expand: expand)
+        get("/v1/#{resource_name}/vin/#{vin}", expand: expand)
       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 = {}, expand: nil)
-        post(
-          "/v1/vehicles/search",
-          body: {
-            method: 'SELECT',
-          }.merge(args),
-          expand: expand
-        )
+      private
+
+      def resource_name
+        "vehicles"
       end
     end
   end

data/lib/synsbasen_api/resources/version.rb

@@ -3,24 +3,24 @@
 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, expand: [])
-        get("/v1/versions/#{id}", expand: expand)
-      end
+  class Version < Resource
+    extend Findable
+    extend Searchable
 
+    class << self
       # 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, expand: [])
-        get("/v1/variants/#{variant_id}/versions", expand: expand)
+        get("/v1/variants/#{variant_id}/#{resource_name}", expand: expand)
+      end
+
+      private
+
+      def resource_name
+        "versions"
       end
     end
   end

data/lib/synsbasen_api/searchable.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SynsbasenApi
+  # Provides a search method for resources.
+  #
+  # This module is intended to be extended in classes that represent resources.
+  module Searchable
+    # Performs a search for resources 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 = {}, expand: nil)
+      post(
+        "/v1/#{resource_name}/search",
+        body: {
+          method: 'SELECT',
+        }.merge(args),
+        expand: expand
+      )
+    end
+  end
+end

data/lib/synsbasen_api/version.rb

@@ -2,5 +2,5 @@
 
 module SynsbasenApi
   # The `VERSION` module specifies the version of the SynsbasenApi gem.
-  VERSION = "1.0.6"
+  VERSION = "1.0.8"
 end

data/lib/synsbasen_api.rb

@@ -1,14 +1,19 @@
 # frozen_string_literal: true
 
 require "synsbasen_api/client"
+require "synsbasen_api/resource"
+require "synsbasen_api/findable"
+require "synsbasen_api/searchable"
 require "synsbasen_api/resources/brand"
 require "synsbasen_api/resources/inspection"
 require "synsbasen_api/resources/inspection_test_center"
+require "synsbasen_api/resources/leasing_period"
 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/vehicle"
 require "synsbasen_api/resources/version"
+require "ostruct"
 
 # The `SynsbasenApi` module provides a configuration mechanism and requires various
 # classes and modules related to interacting with the Synsbasen API.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synsbasen_api
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.8
 platform: ruby
 authors:
 - Jimmy Poulsen
@@ -9,36 +9,8 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-26 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'
+date: 2024-05-06 00:00:00.000000000 Z
+dependencies: []
 description: Synsbasen API is the easiest way to get access to the Danish vehicle
   registry. See https://api.synsbasen.dk for details.
 email:
@@ -52,14 +24,18 @@ files:
 - lib/synsbasen_api/api_response.rb
 - lib/synsbasen_api/client.rb
 - lib/synsbasen_api/error.rb
+- lib/synsbasen_api/findable.rb
+- lib/synsbasen_api/resource.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/leasing_period.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/searchable.rb
 - lib/synsbasen_api/version.rb
 homepage: https://github.com/Synsbasen/synsbasen-api-ruby
 licenses: