ecoportal-api 0.10.11 → 0.10.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a555853c173845b7e088537a48316ab93d1e1cade81a1554bf75ebdd9d754c5
-  data.tar.gz: 1cbd64e04195227bd5d4eb2694b8968f0987ca301ccb48a558fd1ca7fb409e6c
+  metadata.gz: 1c2232426e0251d1242aba6d7a0aa65c545b1bf07f273d23403b0daab0ae57d1
+  data.tar.gz: e155ec14f82fa569df5eeb4adcb89eb3848b21c902f01009ab4d5644b42b73c4
 SHA512:
-  metadata.gz: 7adc6cf22eef822270e8429e469d4566109e93bcfbb93431a4a47406e7ff370c1bd26f4f683ede1799fc2b8c7b4d46509d41d28674489868b58a2550f5eafa7b
-  data.tar.gz: 15ba327d877408f5b576e004789143deddf231f4d6954943034bfa82b9e69aa14137fb65c4a33f93dd8dc0be96164f540dcb29b7c1867d7315a2ee4ea285731f
+  metadata.gz: 41297931b543449d223f06cb64f46108d96d16141ab8b2a54f10a5bf782d241e8c37060a43807dd4e63d34288f1919c0a716db4a554e5ef4f3da54e42a574561
+  data.tar.gz: d0d7c16a92811f06df6611ae85fe0e93a62abd950ac478a8be0a6dca7c59fe4e064ca06849d974b913c370c65d79a68593c194324984f7cb3045fe0d5476be62

data/CHANGELOG.md

@@ -2,10 +2,18 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.10.11] - 2025-04-xx
+## [0.10.12] - 2025-05-xx
 
 ### Added
 
+- `Client#post` **added** named argument `params` (for the **url** arguments)
+
+### Changed
+
+### Fixed
+
+## [0.10.11] - 2025-05-15
+
 ### Changed
 
 - `MAX_START_DELAY` to be `120` (it was `60`).

data/lib/ecoportal/api/common/client.rb

@@ -27,7 +27,8 @@ module Ecoportal
         include WithRetry
         include RateThrottling
 
-        DEFAULT_HOST = 'live.ecoportal.com'.freeze
+        DEFAULT_HOST   = 'live.ecoportal.com'.freeze
+        MAIN_END_POINT = 'api'.freeze
 
         attr_accessor :logger
         attr_reader :host
@@ -47,9 +48,9 @@ module Ecoportal
           @deep_logging = deep_logging
 
           if host.match(/^localhost|^127\.0\.0\.1/)
-            @base_uri = "http://#{host}/api/"
+            @base_uri = "http://#{host}/#{main_end_point}/"
           else
-            @base_uri = "https://#{host}/api/"
+            @base_uri = "https://#{host}/#{main_end_point}/"
           end
 
           if deep_logging?
@@ -58,7 +59,7 @@ module Ecoportal
             }
           end
 
-          return unless @api_key.nil? || @api_key.match(/\A\W*\z/)
+          return unless api_key.nil? || api_key.match(/\A\W*\z/)
           return unless version
 
           log(:error) { 'Api-key missing!' }
@@ -85,11 +86,17 @@ module Ecoportal
         # @note it automatically adds the http header param `Content-Type` as `application/json`
         # @param path [String] the tail that completes the url of the request.
         # @param data [String] the body of the query in json format.
+        # @param params [Hash] the header paramters of the http request (not including the api key).
+        # @option params [String] URL params; will depend on he API being used.
         # @return [Common::Reponse] the basic custom response object.
-        def post(path, data:)
-          instrument('POST', path, data) do
+        def post(path, data:, params: {})
+          instrument('POST', path, params) do
             request do |http|
-              http.post(url_for(path), json: data)
+              http.post(
+                url_for(path),
+                json:   data,
+                params: params
+              )
             end
           end
         end
@@ -144,9 +151,9 @@ module Ecoportal
           @base_request ||=
             case @version
             when 'v2'
-              HTTP.headers('X-ECOPORTAL-API-KEY' => @api_key).accept(:json)
+              HTTP.headers('X-ECOPORTAL-API-KEY' => api_key).accept(:json)
             else
-              HTTP.headers('X-ApiKey' => @api_key).accept(:json)
+              HTTP.headers('X-ApiKey' => api_key).accept(:json)
             end
         end
 
@@ -159,6 +166,8 @@ module Ecoportal
 
         private
 
+        attr_reader :api_key
+
         def instrument(method, path, data = nil, &block)
           raise 'Expected block' unless block_given?
 
@@ -203,6 +212,10 @@ module Ecoportal
           puts "(#{level}) #{yield}"
           logger&.send(level, &block)
         end
+
+        def main_end_point
+          self.class::MAIN_END_POINT
+        end
       end
     end
   end

data/lib/ecoportal/api/version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    VERSION = '0.10.11'.freeze
+    VERSION = '0.10.12'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.10.11
+  version: 0.10.12
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-15 00:00:00.000000000 Z
+date: 2025-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry