ecoportal-api 0.9.8 → 0.10.1

data/lib/ecoportal/api/v1/people.rb

@@ -1,13 +1,14 @@
 module Ecoportal
   module API
     class V1
-      # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+      # @attr_reader client [Common::Client] a `Common::Client` object that
+      #   holds the configuration of the api connection.
       class People
         extend Common::BaseClass
-        include Enumerable
         include Common::DocHelpers
+        include Enumerable
 
-        JOB_TIMEOUT = 240
+        JOB_TIMEOUT        = 240
         DELAY_STATUS_CHECK = 5
 
         class_resolver :person_class, "Ecoportal::API::V1::Person"
@@ -30,35 +31,49 @@ module Ecoportal
         # @param silent [Boolean] `false` to show percentage of progress.
         # @yield [person] does some stuff with the person.
         # @yieldparam person [Person]
-        def each(params: {}, silent: false, &block)
-          return to_enum(:each, params: params, silent: silent) unless block
-          cursor_id = nil; results = 0
+        def each(params: {}, silent: false) # rubocop:disable Metrics/AbcSize
+          return to_enum(:each, params: params, silent: silent) unless block_given?
+
+          cursor_id = nil
+          results   = 0
+
           puts "\n" unless silent
+
           loop do
             params.update(cursor_id: cursor_id) if cursor_id
-            body = nil; response = nil; count = 5
+
+            body     = nil
+            response = nil
+            count    = 5
+
             loop do
               response = client.get("/people", params: params)
               body     = response && body_data(response.body)
               break if response.success? || count <= 0
+
               puts "Request failed - Status #{response.status}: #{body}"
               count -= 1
+
               sleep(0.5)
             end
+
             raise "Request failed - Status #{response.status}: #{body}" unless response.success?
 
-            unless silent || (total = body["total_results"]) == 0
+            unless silent || (total = body["total_results"])&.zero?
               results += body["results"].length
               percent  = results * 100 / total
+
               msg      = "People GET"
-              msg     += " (search=#{params[:q]})" if params.key?(:q)
-              print "#{msg}: #{percent.round}% (of #{total})\r"
+              msg     << " (search=#{params[:q]})" if params.key?(:q)
+
+              print "#{msg}: #{percent.round}% (of #{total}): #{results}\r"
               $stdout.flush
             end
 
             body["results"].each do |person|
               yield person_class.new(person)
             end
+
             break unless (cursor_id = body["cursor_id"])
           end
           self
@@ -81,9 +96,10 @@ module Ecoportal
         # @return [Person] the person with `id` (internal or external) contained in `doc`.
         def get(doc)
           id       = get_id(doc)
-          response = client.get("/people/"+CGI.escape(id))
+          response = client.get("/people/#{CGI.escape(id)}")
           body     = body_data(response.body)
           return person_class.new(body) if response.success?
+
           raise "Could not get person #{id} - Error #{response.status}: #{body}"
         end
 
@@ -93,7 +109,7 @@ module Ecoportal
         def update(doc)
           body = get_body(doc)
           id   = get_id(doc)
-          client.patch("/people/"+CGI.escape(id), data: body)
+          client.patch("/people/#{CGI.escape(id)}", data: body)
         end
 
         # Requests to create a person via api.
@@ -110,7 +126,7 @@ module Ecoportal
         def upsert(doc)
           body = get_body(doc)
           id   = get_id(doc)
-          client.post("/people/"+CGI.escape(id), data: body)
+          client.post("/people/#{CGI.escape(id)}", data: body)
         end
 
         # Requests to completelly remove from an organization an existing person via api.
@@ -118,7 +134,7 @@ module Ecoportal
         # @return [Response] an object with the api response.
         def delete(doc)
           id = get_id(doc)
-          client.delete("/people/"+CGI.escape(id))
+          client.delete("/people/#{CGI.escape(id)}")
         end
 
         # Creates a `BatchOperation` and yields it to the given bock.
@@ -128,8 +144,15 @@ module Ecoportal
         # @return [Ecoportal::API::Common::Response] the results of the batch
         def batch(job_mode: true, &block)
           return job(&block) if job_mode
-          operation = Common::BatchOperation.new("/people", person_class, logger: client.logger)
+
+          operation = Common::BatchOperation.new(
+            "/people",
+            person_class,
+            logger: client.logger
+          )
+
           yield operation
+
           # The batch operation is responsible for logging the output
           client.post("/people/batch", data: operation.as_json).tap do |response|
             operation.process_response(response)
@@ -138,16 +161,25 @@ module Ecoportal
 
         # @return [Ecoportal::API::Common::Response] the results of the batch job
         def job
-          operation = Common::BatchOperation.new("/people", person_class, logger: client.logger)
+          operation = Common::BatchOperation.new(
+            "/people",
+            person_class,
+            logger: client.logger
+          )
+
           yield operation
+
           job_id = create_job(operation)
           status = wait_for_job_completion(job_id)
 
           if status&.complete?
             job_result(job_id, operation)
           else
-            msg = "Job `#{job_id}` not complete. Probably timeout after #{JOB_TIMEOUT} seconds. Current status: #{status}"
-            raise API::Errors::TimeOut.new msg
+            msg  = "Job `#{job_id}` not complete. "
+            msg << "Probably timeout after #{JOB_TIMEOUT} seconds. "
+            msg << "Current status: #{status}"
+
+            raise API::Errors::TimeOut, msg
           end
         end
 
@@ -160,10 +192,15 @@ module Ecoportal
         private
 
         JobStatus = Struct.new(:id, :complete?, :errored?, :progress)
+
         def job_status(job_id)
           response = client.get("/people/job/#{CGI.escape(job_id)}/status")
           body     = response && body_data(response.body)
-          raise "Status error (#{response.status}) - Errors: #{body}" unless response.success?
+
+          msg      = "Status error (#{response.status}) - "
+          msg     << "Errors: #{body}"
+          raise msg unless response.success?
+
           JobStatus.new(
             body["id"],
             body["complete"],
@@ -183,10 +220,12 @@ module Ecoportal
           # timeout library is evil. So we make poor-man timeout.
           # https://jvns.ca/blog/2015/11/27/why-rubys-timeout-is-dangerous-and-thread-dot-raise-is-terrifying/
           before = Time.now
-          while true
+
+          loop do
             status = job_status(job_id)
             break status if status.complete?
             break status if Time.now >= before + JOB_TIMEOUT
+
             sleep(DELAY_STATUS_CHECK)
             status
           end
@@ -207,7 +246,6 @@ module Ecoportal
         def body_data(body)
           body
         end
-
       end
     end
   end

data/lib/ecoportal/api/v1/person.rb

@@ -9,14 +9,16 @@ module Ecoportal
       # @attr details [PersonDetails, nil] the details of the person or `nil` if missing.
       class Person < Common::BaseModel
         passthrough :id, :external_id, :name, :email, :filter_tags
+        passthrough :archived
         passthrough :supervisor_id, :contractor_organization_id
+        passthrough :brand_id
         passthrough :freemium
 
         class_resolver :person_schema_class,  "Ecoportal::API::V1::PersonSchema"
         class_resolver :person_details_class, "Ecoportal::API::V1::PersonDetails"
         embeds_one :details, nullable: true, klass: :person_details_class
 
-        VALID_TAG_REGEX = /^[A-Za-z0-9 &_'\/.-]+$/
+        VALID_TAG_REGEX   = /^[A-Za-z0-9 &_'\/.-]+$/
         VALID_EMAIL_REGEX = /^[^@\s]+@[^@\s]+\.[^@\s]+$/
 
         # Gets the supervisor (`Person`) of this person, with given his `supervisor_id`.
@@ -47,9 +49,8 @@ module Ecoportal
         # Sets the email of a person.
         # @param value [String, nil] the email of this person.
         def email=(value)
-          unless !value || value.match(VALID_EMAIL_REGEX)
-            raise "Invalid email #{value.inspect}"
-          end
+          raise "Invalid email #{value.inspect}" if value && !value.match(VALID_EMAIL_REGEX)
+
           doc["email"] = value&.downcase
         end
 
@@ -58,15 +59,16 @@ module Ecoportal
         # @raise [Exception] if there was any invalid string tag.
         # @param value [Array<String>] array of tags.
         def filter_tags=(value)
-          unless value.is_a?(Array)
-            raise "filter_tags= needs to be passed an Array, got #{value.class}"
-          end
+          msg = "filter_tags= needs to be passed an Array, got #{value.class}"
+          raise ArgumentError, msg unless value.is_a?(Array)
+
           end_tags = value.compact.map do |tag|
-            unless tag.match(VALID_TAG_REGEX)
-              raise "Invalid filter tag #{tag.inspect}"
-            end
+            msg = "Invalid filter tag #{tag.inspect}"
+            raise ArgumentError, msg unless tag.match(VALID_TAG_REGEX)
+
             tag.upcase
           end
+
           set_uniq_array_keep_order("filter_tags", end_tags)
         end
 
@@ -105,8 +107,10 @@ module Ecoportal
         end
 
         # Sets the PersonDetails to the person, depending on the parameter received:
-        #  - `PersonSchema`: initializes the `PersonDetails` as per the schema specified (`schema_id` and `fields`).
-        #  - `String`: it just sets the `schema_id` on the `PersonDetails` (as `fields` is not include, `details[key]=` will throw error).
+        #  - `PersonSchema`: initializes the `PersonDetails` as per the schema specified
+        #    (`schema_id` and `fields`).
+        #  - `String`: it just sets the `schema_id` on the `PersonDetails`
+        #    (as `fields` is not include, `details[key]=` will throw error).
         # (see #details=)
         # @note
         #   - this method alone only sets the internal structure of the details.
@@ -130,7 +134,6 @@ module Ecoportal
             }
           end
         end
-
       end
     end
   end

data/lib/ecoportal/api/v1/person_details.rb

@@ -40,7 +40,8 @@ module Ecoportal
 
         # Gets the value of one specific field of the PersonDetails.
         # @param id [String] the `id` or the `alt_id` of the target field.
-        # @return [String, Array<String>, Boolean, Array<Boolean>, Date, Array<Date>, Numberic, Array<Numeric>] the value of field or `nil` if missing.
+        # @return [String, Array<String>, Boolean, Array<Boolean>, Date, Array<Date>, Numberic, Array<Numeric>]
+        #   the value of field or `nil` if missing.
         def [](id)
           get_field(id)&.value
         end
@@ -50,11 +51,10 @@ module Ecoportal
         # @param id [String] the `id` or the `alt_id` of the target field.
         # @return [void]
         def []=(id, value)
-          if field = get_field(id)
-            field.value = value
-          else
-            raise MissingId.new("details[#{id.inspect}] is missing. Did you forget to load the schema?")
-          end
+          msg = "details[#{id.inspect}] is missing. Did you forget to load the schema?"
+          raise MissingId, msg unless (field = get_field(id))
+
+          field.value = value
         end
 
         # Checks if an `id` or `alt_id` exists
@@ -67,12 +67,14 @@ module Ecoportal
 
         # @return [Boolean] `true` if `id` exists and `value` has changed, `false` otherwise
         def changed?(id, doc = :original)
-          return false unless field = get_field(id)
+          return false unless (field = get_field(id))
+
           field.as_update.key?("value")
         end
 
         def original_value(id)
-          return nil unless field = get_field(id)
+          return nil unless (field = get_field(id))
+
           field.original_doc["value"]
         end
 
@@ -87,7 +89,6 @@ module Ecoportal
             @fields_by_alt_id[wrapped.alt_id] = wrapped
           end
         end
-
       end
     end
   end

data/lib/ecoportal/api/v1/person_schema.rb

@@ -30,6 +30,7 @@ module Ecoportal
         def index_fields
           @fields_by_id     = {}
           @fields_by_alt_id = {}
+
           doc["fields"].each do |field|
             wrapped = schema_field_class.new(field)
             @fields_by_id[wrapped.id] = wrapped
@@ -45,7 +46,6 @@ module Ecoportal
             )
           end
         end
-
       end
     end
   end

data/lib/ecoportal/api/v1/person_schemas.rb

@@ -38,8 +38,6 @@ module Ecoportal
           return to_enum(:each) unless block
           get_all.each(&block)
         end
-
-
       end
     end
   end

data/lib/ecoportal/api/v1/schema_field.rb

@@ -22,11 +22,10 @@ module Ecoportal
               Date.parse(line) rescue return nil, false
             end
           end.compact
-          if multiple
-            return values, true
-          else
-            return values.first, true
-          end
+
+          out = values
+          out = values.first unless multiple
+          [out, true]
         end
       end
     end

data/lib/ecoportal/api/v1/schema_field_value.rb

@@ -6,29 +6,27 @@ module Ecoportal
         passthrough :id, :alt_id, :type, :name, :shared, :multiple
 
         def clear
-          if multiple
-            doc["value"] = []
-          else
-            doc["value"] = nil
-          end
+          return doc["value"] = [] if multiple
+
+          doc["value"] = nil
         end
 
         def value
           case type
           when "text", "phone_number", "number", "boolean", "select"
-           doc["value"]
+            doc["value"]
           when "date"
-           if doc["value"]
-             maybe_multiple(doc["value"]) do |v|
-               Date.iso8601(v)
-             end
-           end
+            if doc["value"]
+              maybe_multiple(doc["value"]) do |v|
+                Date.iso8601(v)
+              end
+            end
           else
-           raise "Unknown type #{type}"
+            raise "Unknown type #{type}"
           end
         end
 
-        def value=(value)
+        def value=(value) # rubocop:disable Metrics/AbcSize
           case type
           when "text", "phone_number", "select"
             doc["value"] = maybe_multiple(value) do |v|
@@ -36,19 +34,21 @@ module Ecoportal
             end
           when "number"
             maybe_multiple(value) do |v|
-              unless v.nil? || v.is_a?(Numeric)
-                raise "Invalid number type #{v.class}"
-              end
+              next if v.nil? || v.is_a?(Numeric)
+
+              raise "Invalid number type #{v.class}"
             end
+
             doc["value"] = value
           when "boolean"
             doc["value"] = !!value
           when "date"
             maybe_multiple(value) do |v|
-              unless v.nil? || v.respond_to?(:to_date)
-                raise "Invalid date type #{v.class}"
-              end
+              next if v.nil? || v.respond_to?(:to_date)
+
+              raise "Invalid date type #{v.class}"
             end
+
             doc["value"] = maybe_multiple(value) do |v|
               v&.to_date&.to_s
             end
@@ -57,12 +57,11 @@ module Ecoportal
           end
         end
 
-        def maybe_multiple(value)
+        def maybe_multiple(value, &block)
           if multiple
-            unless value.is_a?(Array)
-              raise "Expected Array, got #{value.class}"
-            end
-            value.map {|v| yield v }
+            raise "Expected Array, got #{value.class}" unless value.is_a?(Array)
+
+            value.map(&block)
           else
             yield value
           end

data/lib/ecoportal/api/v1.rb

@@ -6,9 +6,10 @@ module Ecoportal
       extend Common::BaseClass
       include Common::Logging
 
-      VERSION = "v1"
-      class_resolver :people_class,  "Ecoportal::API::V1::People"
-      class_resolver :person_schemas_class,  "Ecoportal::API::V1::PersonSchemas"
+      VERSION = "v1".freeze
+
+      class_resolver :people_class, "Ecoportal::API::V1::People"
+      class_resolver :person_schemas_class, "Ecoportal::API::V1::PersonSchemas"
 
       attr_reader :client, :logger
 

data/lib/ecoportal/api/version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    VERSION = "0.9.8".freeze
+    VERSION = "0.10.1".freeze
   end
 end

metadata

@@ -1,35 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 0.10.1
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-14 00:00:00.000000000 Z
+date: 2024-08-01 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.4.12
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.4.12
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -125,65 +105,59 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.14'
 - !ruby/object:Gem::Dependency
-  name: http
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: elastic-apm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '4.7'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '4.7'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '5'
 - !ruby/object:Gem::Dependency
-  name: elastic-apm
+  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
 description:
 email:
 - tapio@ecoportal.co.nz
@@ -195,8 +169,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".markdownlint.json"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -250,7 +226,8 @@ files:
 homepage: https://www.ecoportal.com
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -259,14 +236,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.2
+      version: 3.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: A collection of helpers for interacting with the ecoPortal MS's various APIs