synsbasen_api 1.0.7 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ba050bd5ad13d81687977a3963bb9ff3029508c76ff2390b96bb47808229b45
-  data.tar.gz: 1b00104a8517540a698866f3297cc0e451e5febc8e6afb0eea945a2d3585632c
+  metadata.gz: 7eae796f59f57889dba53b55e321dff632935a108f5e5697a171907c9d59ba3e
+  data.tar.gz: 308637d66c60bab9443403ebc9dc80ef8d989368ab73c231a5a90c8076b3c858
 SHA512:
-  metadata.gz: 680d20a16b8e05837775a3ca5feb39703e09ed19a39f23f2b8c4031f89ccce241c871349c97fe5045e49e5c20a99d18df348dfb154ce1d6e147ce1b695720969
-  data.tar.gz: 410e80b9db9a317ca11a285452f5b1875b54556e17880354952bb4b01351952299a5bfd0d51de396af3456cd8343a73815e96e6fa7e16b6074565af1bb7e9dd8
+  metadata.gz: '079ec0f9cfec921aa4af2469add7dc3cda8d207bf1644ef2e9250c31adbf65d8a1d4da278b931f6cea69ed3c0c4a8c3b7575f073b250559a8fe4e5113bfb86ff'
+  data.tar.gz: 26060a57d7ce0a782a3d7b4f6bd4ebf426240a2ceae0c1b66504e58d77427d06e5e292a0e9b96b56c6037ccc7a34590426876369407d9523c251a76f6159a8ff

data/lib/synsbasen_api/api_response.rb

@@ -12,6 +12,9 @@ module SynsbasenApi
     # @return [Boolean] Indicates whether there is more data available in the response.
     attr_reader :has_more
 
+    # @return [Numeric] The current page number.
+    attr_reader :page
+
     # @return [Numeric] The total number of pages available.
     attr_reader :total_pages
 
@@ -30,7 +33,7 @@ module SynsbasenApi
       @data = response[:data]
       @cost = response[:cost]
 
-      %i[has_more total_pages total_count].each do |key|
+      %i[has_more page total_pages total_count].each do |key|
         instance_variable_set("@#{key}", response[key]) if response.key?(key)
       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,29 +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
 
-      # Performs a search for inspection test centers 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/inspection_test_centers/search",
-          body: {
-            method: 'SELECT',
-          }.merge(args),
-          expand: expand
-        )
+      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.7"
+  VERSION = "1.0.9"
 end

data/lib/synsbasen_api.rb

@@ -1,13 +1,17 @@
 # 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"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synsbasen_api
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.9
 platform: ruby
 authors:
 - Jimmy Poulsen
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-24 00:00:00.000000000 Z
+date: 2024-10-19 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.
@@ -24,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: