synsbasen_api 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70f3463d8af67697bd559cb53ced9254cc04a6b217963e56b7fe89e6ebd19e33
-  data.tar.gz: f1670824ee49861fbc4ef6f50ae9e929552ce78687bf1105167338ddc45c5a3f
+  metadata.gz: 2d13815e17928657fa26ebc1d124b909410034c2713e61f48ddb730ca255e137
+  data.tar.gz: 58476734c861a468c7ad7aab2a87cf5815c5420c70176babec6614b88666fe28
 SHA512:
-  metadata.gz: d92c768c2ad3f9b159e66c388e7875a30cfc30e624886e3020005fb7c6b65ca773be241a61c5da715970afbbccd1d41c83d34e1cfe6d44e6b994a73f4ef4a840
-  data.tar.gz: 071c62aee5fc0c1de9261d14c63f6f56540025f65ec5dc55873bfe5e9a98a85a4c29d9138b462eb04736339b76ba32e24ffa9b52010dc54065b3d27f69a7c90c
+  metadata.gz: a5e5d967bcc260fa27c79c1887ae250d22c88dcd1a8578266fb4340060e3225cb74a3879c93e50ad2cbc8ce9fd25d2aae06c5068bf28ea5216a9bd68cb671ee6
+  data.tar.gz: 278e5e5cdf251caf9b64fdb134cc0d961b620cb11f7b5b393704ad32e04ddac63404bd3ab88ad458a032ba7667f3e138890ce729bb2912d77fbbe9de784ea391

data/lib/synsbasen_api/client.rb

@@ -4,6 +4,8 @@ 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"
 
 module SynsbasenApi
   # The `Client` class serves as the base class for interacting with the Synsbasen API.
@@ -31,12 +33,13 @@ module SynsbasenApi
       # @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: {})
+      def get(path, params: {}, expand: [])
         response = connection.get(path) do |req|
-          req.params = params
-          req.body = body unless body.empty?
+          req.params = { **params, expand: expand }.compact_blank
         end
 
+        handle_after_request_callback(response)
+
         ApiResponse.new(JSON.parse(response.body).deep_symbolize_keys)
       rescue => e
         rescue_and_raise_errors(e)
@@ -49,12 +52,14 @@ module SynsbasenApi
       # @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: {})
+      def post(path, params: {}, body: {}, expand: [])
         response = connection.post(path) do |req|
           req.params = params
-          req.body = body
+          req.body = { **body, expand: expand }.compact_blank.to_json
         end
 
+        handle_after_request_callback(response)
+
         ApiResponse.new(JSON.parse(response.body).deep_symbolize_keys)
       rescue => e
         rescue_and_raise_errors(e)
@@ -78,6 +83,16 @@ module SynsbasenApi
           raise e
         end
       end
+
+      # Calls the after_request callback if configured in the SynsbasenApi.
+      #
+      # @param response [Faraday::Response] The Faraday response object.
+      # @return [void]
+      def handle_after_request_callback(response)
+        return unless SynsbasenApi.config[:after_request]
+
+        SynsbasenApi.config[:after_request].call(response)
+      end
     end
   end
 end

data/lib/synsbasen_api/resources/brand.rb

@@ -10,16 +10,16 @@ module SynsbasenApi
       # @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}")
+      def find(id, expand: [])
+        get("/v1/brands/#{id}", expand: expand)
       end
 
       # Retrieves information about all brands.
       #
       # @return [ApiResponse] An instance of `ApiResponse` containing details
       #   of all brands.
-      def all
-        get("/v1/brands")
+      def all(expand: [])
+        get("/v1/brands", expand: expand)
       end
     end
   end

data/lib/synsbasen_api/resources/inspection.rb

@@ -10,12 +10,13 @@ module SynsbasenApi
       # @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 = {})
+      def search(args = {}, expand: [])
         post(
           "/v1/inspections/search",
           body: {
             method: 'SELECT',
-          }.merge(args).to_json
+          }.merge(args),
+          expand: expand
         )
       end
     end

data/lib/synsbasen_api/resources/model.rb

@@ -10,8 +10,8 @@ module SynsbasenApi
       # @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}")
+      def find(id, expand: [])
+        get("/v1/models/#{id}", expand: expand)
       end
 
       # Retrieves information about all models associated with a given brand.
@@ -19,8 +19,8 @@ module SynsbasenApi
       # @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")
+      def all(brand_id, expand: [])
+        get("/v1/brands/#{brand_id}/models", expand: expand)
       end
     end
   end

data/lib/synsbasen_api/resources/variant.rb

@@ -10,8 +10,8 @@ module SynsbasenApi
       # @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}")
+      def find(id, expand: [])
+        get("/v1/variants/#{id}", expand: expand)
       end
 
       # Retrieves information about all variants associated with a given model.
@@ -19,8 +19,8 @@ module SynsbasenApi
       # @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")
+      def all(model_id, expand: [])
+        get("/v1/models/#{model_id}/variants", expand: expand)
       end
     end
   end

data/lib/synsbasen_api/resources/vehicle.rb

@@ -10,8 +10,8 @@ module SynsbasenApi
       # @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}")
+      def find(id, expand: [])
+        get("/v1/vehicles/#{id}", expand: expand)
       end
 
       # Retrieves information about a vehicle based on its registration number.
@@ -19,8 +19,17 @@ module SynsbasenApi
       # @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}")
+      def find_by_registration(registration, expand: [])
+        get("/v1/vehicles/registration/#{registration}", expand: expand)
+      end
+
+      # Retrieves information about a vehicle based on its VIN (Vehicle Identification Number).
+      #
+      # @param vin [String] The VIN of the vehicle.
+      # @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)
       end
 
       # Performs a search for vehicles based on the provided criteria.
@@ -28,12 +37,13 @@ module SynsbasenApi
       # @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 = {})
+      def search(args = {}, expand: nil)
         post(
           "/v1/vehicles/search",
           body: {
             method: 'SELECT',
-          }.merge(args).to_json
+          }.merge(args),
+          expand: expand
         )
       end
     end

data/lib/synsbasen_api/resources/version.rb

@@ -10,8 +10,8 @@ module SynsbasenApi
       # @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}")
+      def find(id, expand: [])
+        get("/v1/versions/#{id}", expand: expand)
       end
 
       # Retrieves information about all versions associated with a given variant.
@@ -19,8 +19,8 @@ module SynsbasenApi
       # @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")
+      def all(variant_id, expand: [])
+        get("/v1/variants/#{variant_id}/versions", 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.1"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synsbasen_api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Jimmy Poulsen
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-12 00:00:00.000000000 Z
+date: 2023-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport