ecoportal-api 0.10.11 → 0.10.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a555853c173845b7e088537a48316ab93d1e1cade81a1554bf75ebdd9d754c5
-  data.tar.gz: 1cbd64e04195227bd5d4eb2694b8968f0987ca301ccb48a558fd1ca7fb409e6c
+  metadata.gz: 42c60da1fe6f9c6176e85d65b5283b75b54af11f5e977788eddd7fde57bba953
+  data.tar.gz: d5bf03e2eaec6dad5778f8a0ce693b9a29d9786331e5517facab0e28941abccd
 SHA512:
-  metadata.gz: 7adc6cf22eef822270e8429e469d4566109e93bcfbb93431a4a47406e7ff370c1bd26f4f683ede1799fc2b8c7b4d46509d41d28674489868b58a2550f5eafa7b
-  data.tar.gz: 15ba327d877408f5b576e004789143deddf231f4d6954943034bfa82b9e69aa14137fb65c4a33f93dd8dc0be96164f540dcb29b7c1867d7315a2ee4ea285731f
+  metadata.gz: b5d0dfc99e97e97b857a1f424b80e4211811ed7ef6250300a9cd8614a39d5281fef6661519d915a29980a8347368b50bcf7961cfb5a676b6b6d196f16a48cafb
+  data.tar.gz: 1ca5a7a3ffc81adc74679524ad715d4833e665867041e7c2c25eace44e98d9612a330dad433e0db4c9e85d95e5fbc5209fc5c46705c1510e91280a011a122c11

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 3.2.2
+  TargetRubyVersion: 3.2
   Exclude:
     - 'config/routes.rb'
   NewCops: enable

data/CHANGELOG.md

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

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/v1/person.rb

@@ -13,6 +13,8 @@ module Ecoportal
         alias_method :archived?, :archived
 
         passthrough :supervisor_id, :contractor_organization_id
+
+        passthrough :phone_number
         passthrough :brand_id
         passthrough :freemium
 
@@ -22,6 +24,7 @@ module Ecoportal
 
         VALID_TAG_REGEX   = /^[A-Za-z0-9 &_'\/.-]+$/
         VALID_EMAIL_REGEX = /^[^@\s]+@[^@\s]+\.[^@\s]+$/
+        NON_PHONE_REGEX   = /[^+0-9]/
 
         def unarchive!
           self.archived = false
@@ -65,6 +68,15 @@ module Ecoportal
           doc['email'] = value&.downcase
         end
 
+        # @note this property is read-only in the APIv0.
+        # Sets the **primary** phone number of a person.
+        # @param value [String, nil] the phone number of this person.
+        def phone_number=(value)
+          return
+
+          doc['phone_number'] = parse_number(value)
+        end
+
         # Validates the string tags of the array, and sets the `filter_tags` property of the account.
         # @note all is set in upper case and preserves the original order.
         # @raise [Exception] if there was any invalid string tag.
@@ -146,6 +158,19 @@ module Ecoportal
             }
           end
         end
+
+        private
+
+        def parse_number(value)
+          value = value.to_s.strip
+          return if value.empty?
+
+          value.gsub(NON_PHONE_REGEX, '').then do |str|
+            next str if str.start_with?('+')
+
+            "+#{str}"
+          end
+        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.14'.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.14
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-15 00:00:00.000000000 Z
+date: 2025-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry