ecoportal-api 0.10.7 → 0.10.9

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

@@ -3,24 +3,27 @@ module Ecoportal
     class Internal
       # @attr account [Account, nil] the account of the person or `nil` if missing.
       class Person < V1::Person
-        class_resolver :person_details_class, "Ecoportal::API::Internal::PersonDetails"
-        class_resolver :person_account_class, "Ecoportal::API::Internal::Account"
+        class_resolver :person_details_class, 'Ecoportal::API::Internal::PersonDetails'
+        class_resolver :person_account_class, 'Ecoportal::API::Internal::Account'
         embeds_one :account, nullable: true, klass: :person_account_class
 
         def initialize(doc = {}, *args, **kargs, &block)
-          super(doc, *args, **kargs, &block)
+          super
+
           @is_new = @prev_is_new = no_account_nor_details?(@doc)
         end
 
         def consolidate!
           @prev_is_new = @is_new
-          @is_new = false
+          @is_new      = false
+
           super
         end
 
         def reset!(*args)
           @is_new = @prev_is_new
-          super(*args)
+
+          super
         end
 
         # @note
@@ -34,27 +37,28 @@ module Ecoportal
         # @return [Boolean] whether or not this entry is being created now (i.e. non existent on server)
         def new?(value = :original)
           return @is_new if value == :original
+
           no_account_nor_details?(initial_doc)
         end
 
         # @return [Boolean] if the account has been added to `doc`
         def account_added?(value = :original)
-          ref_doc = (value == :original) ? original_doc : initial_doc
-          !!account && !ref_doc["account"]
+          ref_doc = value == :original ? original_doc : initial_doc
+          !!account && !ref_doc['account']
         end
 
         # @return [Boolean] if the account has been removed from `doc`
         def account_removed?(value = :original)
-          ref_doc = (value == :original) ? original_doc : initial_doc
-          !account && !!ref_doc["account"]
+          ref_doc = value == :original ? original_doc : initial_doc
+          !account && !!ref_doc['account']
         end
 
         def as_json
-          super.update("account" => account&.as_json)
+          super.update('account' => account&.as_json)
         end
 
         def as_update(ref = :last, ignore: [])
-          super(ref, ignore: ignore | ["user_id", "permissions_merged", "prefilter"])
+          super(ref, ignore: ignore | %w[user_id permissions_merged prefilter])
         end
 
         # Sets the Account to the person, depending on the paramter received:
@@ -67,19 +71,20 @@ module Ecoportal
         def account=(value)
           case value
           when NilClass
-            doc["account"] = nil
+            doc['account'] = nil
           when Internal::Account
-            doc["account"] = JSON.parse(value.to_json)
+            doc['account'] = JSON.parse(value.to_json)
           when Hash
             user_id = account.user_id if account
-            doc["account"] = value.slice(*Internal::Account::PROPERTIES)
-            doc["account"]["user_id"] = user_id if user_id
+            doc['account'] = value.slice(*Internal::Account::PROPERTIES)
+            doc['account']['user_id'] = user_id if user_id
           else
             # TODO
             raise "Invalid set on account: Need nil, Account or Hash; got #{value.class}"
           end
-          remove_instance_variable("@account") if defined?(@account)
-          return account
+
+          remove_instance_variable('@account') if defined?(@account)
+          account
         end
 
         # Adds an empty account to the person.
@@ -93,7 +98,8 @@ module Ecoportal
 
         def no_account_nor_details?(value = @doc)
           return true unless value.is_a?(Hash)
-          !value.key?("details") && !value.key?("account")
+
+          !value.key?('details') && !value.key?('account')
         end
       end
     end

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class Internal
       class PersonDetails < V1::PersonDetails
-        class_resolver :schema_field_value_class, "Ecoportal::API::Internal::SchemaFieldValue"
+        class_resolver :schema_field_value_class, 'Ecoportal::API::Internal::SchemaFieldValue'
       end
     end
   end

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class Internal
       class PersonSchema < V1::PersonSchema
-        class_resolver :schema_field_class, "Ecoportal::API::Internal::SchemaField"
+        class_resolver :schema_field_class, 'Ecoportal::API::Internal::SchemaField'
       end
     end
   end

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class Internal
       class PersonSchemas < V1::PersonSchemas
-        class_resolver :person_schema_class,  "Ecoportal::API::Internal::PersonSchema"
+        class_resolver :person_schema_class, 'Ecoportal::API::Internal::PersonSchema'
       end
     end
   end

data/lib/ecoportal/api/internal/policy_groups.rb

@@ -15,13 +15,14 @@ module Ecoportal
 
         # Gets all the policy groups via api request.
         # @return [Enumerable<PolicyGroup>] an `Enumerable` with all the policy groups already wrapped as `PolicyGroup` objects.
-        def get_all
-          response = client.get("/policy_groups")
+        def get_all # rubocop:disable Naming/AccessorMethodName
+          response = client.get('/policy_groups')
           Common::WrappedResponse.new(response, Internal::PolicyGroup)
         end
 
         def each(&block)
           return to_enum(:each) unless block
+
           get_all.each(&block)
         end
       end

data/lib/ecoportal/api/internal/preferences.rb

@@ -2,17 +2,19 @@ module Ecoportal
   module API
     class Internal
       class Preferences < Common::BaseModel
-        passthrough  :kiosk_enabled, :kiosk_workflow_message, :kiosk_create_button_label,
-            :kiosk_create_button_help, :kiosk_return_button_label, :kiosk_return_button_help,
-            :kiosk_dashboard_button_label, :kiosk_dashboard_button_help
+        passthrough(
+          :kiosk_enabled, :kiosk_workflow_message, :kiosk_create_button_label,
+          :kiosk_create_button_help, :kiosk_return_button_label, :kiosk_return_button_help,
+          :kiosk_dashboard_button_label, :kiosk_dashboard_button_help
+        )
 
-        [
-          :show_sidebar,
-          :show_shortcuts,
-          :show_coming_soon,
-          :show_recently_visited_forms,
-          :show_tasks,
-          :show_task_bubbles
+        %i[
+          show_sidebar
+          show_shortcuts
+          show_coming_soon
+          show_recently_visited_forms
+          show_tasks
+          show_task_bubbles
         ].map(&:to_s).each do |field|
           define_method(field) do
             if doc.key?(field)
@@ -21,6 +23,7 @@ module Ecoportal
               true
             end
           end
+
           define_method("#{field}=") do |value|
             doc[field] = !!value
           end

data/lib/ecoportal/api/internal.rb

@@ -3,12 +3,12 @@ module Ecoportal
     class Internal < V1
       include Common::Logging
 
-      VERSION = "v0".freeze
-      class_resolver :people_class, "Ecoportal::API::Internal::People"
-      class_resolver :person_schemas_class, "Ecoportal::API::Internal::PersonSchemas"
+      VERSION = 'v0'.freeze
+      class_resolver :people_class, 'Ecoportal::API::Internal::People'
+      class_resolver :person_schemas_class, 'Ecoportal::API::Internal::PersonSchemas'
 
-      class_resolver :policy_groups_class, "Ecoportal::API::Internal::PolicyGroups"
-      class_resolver :login_providers_class, "Ecoportal::API::Internal::LoginProviders"
+      class_resolver :policy_groups_class, 'Ecoportal::API::Internal::PolicyGroups'
+      class_resolver :login_providers_class, 'Ecoportal::API::Internal::LoginProviders'
 
       # Obtain specific object for policy groups api requests.
       # @return [PolicyGroups] an instance object ready to make policy groups api requests.

data/lib/ecoportal/api/logger.rb

@@ -1,26 +1,27 @@
 module Ecoportal
   module API
     class Logger
-      TIMESTAMP_PATTERN  = "%Y-%m-%dT%H:%M:%S".freeze
+      TIMESTAMP_PATTERN  = '%Y-%m-%dT%H:%M:%S'.freeze
 
       STDOUT_FORMAT_PROC = proc do |severity, _datetime, _progname, msg|
         prefix = "%5s > " % severity # rubocop:disable Style/FormatString
-        msg.lines.map.with_index do |line, idx|
+        msg.lines.map.with_index do |line, idx| # rubocop:disable Style/StringConcatenation
           if idx.zero?
             prefix + line.chomp
           else
-            (" " * prefix.length) + line.chomp
+            (' ' * prefix.length) + line.chomp
           end
         end.join("\n")+"\n"
       end
 
       FILE_FORMAT_PROC = proc do |severity, datetime, _progname, msg|
         prefix = "%5s(%s) > " % [severity, datetime.strftime(TIMESTAMP_PATTERN)] # rubocop:disable Style/FormatString, Style/FormatStringToken
-        msg.lines.map.with_index do |line, idx|
+
+        msg.lines.map.with_index do |line, idx| # rubocop:disable Style/StringConcatenation
           if idx.zero?
             prefix + line.chomp
           else
-            (" " * prefix.length) + line.chomp
+            (' ' * prefix.length) + line.chomp
           end
         end.join("\n")+"\n"
       end
@@ -30,7 +31,7 @@ module Ecoportal
       def initialize(
         console_level: ::Logger::INFO,
         file_level:   ::Logger::DEBUG,
-        output_file:  File.join(Dir.getwd, "API_Log-#{Time.now.strftime("%Y-%m-%dT%H%M")}.txt")
+        output_file:  File.join(Dir.getwd, "API_Log-#{Time.now.strftime('%Y-%m-%dT%H%M')}.txt")
       )
         @console = make_stdout_logger(console_level)
         @file    = make_file_logger(file_level, output_file)
@@ -54,7 +55,7 @@ module Ecoportal
 
       def make_file_logger(level, output_file)
         return unless output_file
-        ::Logger.new(File.open(output_file, "a")).tap do |logger|
+        ::Logger.new(File.open(output_file, 'a')).tap do |logger|
           logger.formatter = FILE_FORMAT_PROC
           logger.level     = level
         end

data/lib/ecoportal/api/v1/job/awaiter/timer.rb

@@ -9,6 +9,7 @@ module Ecoportal
             status lstatus
           ].freeze
 
+          # The class
           Timer = Struct.new(*TIMER_ARGS) do
             self::MAX_START_DELAY = 60
 
@@ -21,11 +22,7 @@ module Ecoportal
             end
 
             alias_method :original_start, :start
-            # `start` time only counts from the moment that
-            # it already started to progress
             def start
-              return timestamp unless lstatus&.started?
-
               original_start || timestamp
             end
 
@@ -76,6 +73,10 @@ module Ecoportal
             end
 
             def time_left
+              (timeout_in - waited).round(2)
+            end
+
+            def time_left_total
               (timeout - waited).round(2)
             end
 
@@ -86,7 +87,7 @@ module Ecoportal
             end
 
             def timeout_in
-              return time_left if started?
+              return time_left_total if started?
 
               time_left_to_start
             end
@@ -94,7 +95,7 @@ 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/
             def timeout?
-              !time_left.positive?
+              !time_left_total.positive?
             end
 
             def start_timeout?
@@ -140,7 +141,8 @@ module Ecoportal
               %i[total timeout start].each_with_object({}) do |key, kargs|
                 kargs[key] = send(key)
               end.tap do |kargs|
-                kargs[:start]   = timestamp
+                kargs[:start]   = start
+                kargs[:last]    = timestamp
                 kargs[:lstatus] = status
               end
             end

data/lib/ecoportal/api/v1/job/status.rb

@@ -44,8 +44,8 @@ module Ecoportal
           end
 
           def to_s
-            msg = complete? ? "Completed" : "In progress"
-            msg = "Errored" if errored?
+            msg = complete? ? 'Completed' : 'In progress'
+            msg = 'Errored' if errored?
             msg << " with #{progress} done."
             msg
           end

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

@@ -31,7 +31,7 @@ module Ecoportal
           raise_if_already_launched! unless recover
 
           @operation ||= Common::BatchOperation.new(
-            "/people",
+            '/people',
             person_class,
             logger: client.logger
           )
@@ -84,7 +84,7 @@ module Ecoportal
         def raise_if_already_launched!
           return unless created?
 
-          msg  = "Missusage: job was already created."
+          msg  = 'Missusage: job was already created.'
           msg << " Can't call batch more than once"
           raise msg
         end
@@ -102,8 +102,8 @@ module Ecoportal
 
           job_id = nil
 
-          client.post("/people/job", data: operation.as_json).tap do |response|
-            job_id = body_data(response.body)["id"] if response.success?
+          client.post('/people/job', data: operation.as_json).tap do |response|
+            job_id = body_data(response.body)['id'] if response.success?
 
             next if job_id
 

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

@@ -8,7 +8,7 @@ module Ecoportal
         include Common::DocHelpers
         include Enumerable
 
-        class_resolver :person_class, "Ecoportal::API::V1::Person"
+        class_resolver :person_class, 'Ecoportal::API::V1::Person'
 
         attr_reader :client
 
@@ -44,7 +44,7 @@ module Ecoportal
             count    = 5
 
             loop do
-              response = client.get("/people", params: params)
+              response = client.get('/people', params: params)
               body     = response && body_data(response.body)
               break if response.success? || count <= 0
 
@@ -56,22 +56,22 @@ module Ecoportal
 
             raise "Request failed - Status #{response.status}: #{body}" unless response.success?
 
-            unless silent || (total = body["total_results"])&.zero?
-              results += body["results"].length
+            unless silent || (total = body['total_results'])&.zero?
+              results += body['results'].length
               percent  = results * 100 / total
 
-              msg      = "People GET"
+              msg      = 'People GET'
               msg     << " (search=#{params[:q]})" if params.key?(:q)
 
               print "#{msg}: #{percent.round}% (of #{total}): #{results}\r"
               $stdout.flush
             end
 
-            body["results"].each do |person|
+            body['results'].each do |person|
               yield person_class.new(person)
             end
 
-            break unless (cursor_id = body["cursor_id"])
+            break unless (cursor_id = body['cursor_id'])
           end
           self
         end
@@ -106,6 +106,7 @@ module Ecoportal
         def update(doc)
           body = get_body(doc)
           id   = get_id(doc)
+
           client.patch("/people/#{CGI.escape(id)}", data: body)
         end
 
@@ -114,7 +115,8 @@ module Ecoportal
         # @return [Response] an object with the api response.
         def create(doc)
           body = get_body(doc)
-          client.post("/people", data: body)
+
+          client.post('/people', data: body)
         end
 
         # Requests to update an existing person or if it does not exist, to create it, via api.
@@ -143,7 +145,7 @@ module Ecoportal
           return job.batch(&block) if job_mode
 
           operation = Common::BatchOperation.new(
-            "/people",
+            '/people',
             person_class,
             logger: client.logger
           )
@@ -151,7 +153,7 @@ module Ecoportal
           yield operation
 
           # The batch operation is responsible for logging the output
-          client.post("/people/batch", data: operation.as_json).tap do |response|
+          client.post('/people/batch', data: operation.as_json).tap do |response|
             operation.process_response(response)
           end
         end

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

@@ -10,25 +10,35 @@ module Ecoportal
       class Person < Common::BaseModel
         passthrough :id, :external_id, :name, :email, :filter_tags
         passthrough :archived
+        alias_method :archived?, :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"
+        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_EMAIL_REGEX = /^[^@\s]+@[^@\s]+\.[^@\s]+$/
 
+        def unarchive!
+          self.archived = false
+        end
+
+        def archive!
+          self.archived = true
+        end
+
         # Gets the supervisor (`Person`) of this person, with given his `supervisor_id`.
         #
         # **Example Usage**:
         # ```ruby
         # API_KEY = 'some-private-api-key-version'
-        # HOST    = "live.ecoportal.com"
+        # HOST    = 'live.ecoportal.com'
         # api     = Ecoportal::API::Internal.new(API_KEY, host: HOST)
-        # person  = api.people.get({"id": "my-dummy-user"})
+        # person  = api.people.get({'id': 'my-dummy-user'})
         # super   = person.supervisor(api.client)
         # pp "#{person.name}'s supervisor is #{super.name}."
         # ```
@@ -37,6 +47,7 @@ module Ecoportal
         def supervisor(client)
           return @supervisor if defined?(@supervisor)
           return @supervisor = nil if supervisor_id.nil?
+
           @supervisor = client.people.get(supervisor_id).result
         end
 
@@ -51,7 +62,7 @@ module Ecoportal
         def email=(value)
           raise "Invalid email #{value.inspect}" if value && !value.match(VALID_EMAIL_REGEX)
 
-          doc["email"] = value&.downcase
+          doc['email'] = value&.downcase
         end
 
         # Validates the string tags of the array, and sets the `filter_tags` property of the account.
@@ -69,20 +80,20 @@ module Ecoportal
             tag.upcase
           end
 
-          set_uniq_array_keep_order("filter_tags", end_tags)
+          set_uniq_array_keep_order('filter_tags', end_tags)
         end
 
         # @return [Array<String>] the filter tags of this person.
         def filter_tags
-          doc["filter_tags"] ||= []
+          doc['filter_tags'] ||= []
         end
 
         def as_json
-          super.merge "details" => details&.as_json
+          super.merge 'details' => details&.as_json
         end
 
         def as_update(ref = :last, ignore: [])
-          super(ref, ignore: ignore)
+          super
         end
 
         # Sets the PersonDetails to the person, depending on the paramter received:
@@ -95,15 +106,15 @@ module Ecoportal
         def details=(value)
           case value
           when NilClass
-            doc["details"] = nil
+            doc['details'] = nil
           when person_details_class
-            doc["details"] = value.as_json
+            doc['details'] = value.as_json
           when Hash
-            doc["details"] = value.slice("schema_id", "fields")
+            doc['details'] = value.slice('schema_id', 'fields')
           else
             raise "Invalid type set on details. Required nil, PersonDetails or Hash; got #{value.class}"
           end
-          remove_instance_variable("@details") if defined?(@details)
+          remove_instance_variable('@details') if defined?(@details)
         end
 
         # Sets the PersonDetails to the person, depending on the parameter received:
@@ -127,10 +138,11 @@ module Ecoportal
             else
               raise "Invalid set on details: Requierd PersonSchema or String; got #{schema_or_id.class}"
             end
+
             self.details = new_details
             # Patch out static data from as_update
-            original_doc["details"] = {
-              "fields" => JSON.parse(doc["details"]["fields"].to_json)
+            original_doc['details'] = {
+              'fields' => JSON.parse(doc['details']['fields'].to_json)
             }
           end
         end

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

@@ -7,10 +7,10 @@ module Ecoportal
 
         passthrough :schema_id
 
-        class_resolver :schema_field_value_class, "Ecoportal::API::V1::SchemaFieldValue"
+        class_resolver :schema_field_value_class, 'Ecoportal::API::V1::SchemaFieldValue'
 
         def as_json
-          super.merge "fields" => fields.map(&:as_json)
+          super.merge 'fields' => fields.map(&:as_json)
         end
 
         # Sets the `id` of the PersonDetails.
@@ -18,15 +18,15 @@ module Ecoportal
         # @param value [nil, String] the id of the schema.
         def schema_id=(value)
           @fields          = [] if value.nil?
-          doc["schema_id"] = value
+          doc['schema_id'] = value
         end
 
         # Gets all the fields of the PersonDetails.
         # @return [Array<SchemaFieldValue>] the array of fields of the schema.
         def fields
           return @fields if defined?(@fields)
-          @fields = (doc["fields"] || []).each_with_index.map do |field, i|
-            schema_field_value_class.new(field, parent: self, key: ["fields", i])
+          @fields = (doc['fields'] || []).each_with_index.map do |field, i|
+            schema_field_value_class.new(field, parent: self, key: ['fields', i])
           end
         end
 
@@ -69,13 +69,13 @@ module Ecoportal
         def changed?(id, doc = :original)
           return false unless (field = get_field(id))
 
-          field.as_update.key?("value")
+          field.as_update.key?('value')
         end
 
         def original_value(id)
           return nil unless (field = get_field(id))
 
-          field.original_doc["value"]
+          field.original_doc['value']
         end
 
         protected

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

@@ -5,7 +5,7 @@ module Ecoportal
         passthrough :id, :name
         passthrough :enable_tags, :tags
 
-        class_resolver :schema_field_class, "Ecoportal::API::V1::SchemaField"
+        class_resolver :schema_field_class, 'Ecoportal::API::V1::SchemaField'
 
         def fields
           @fields_by_id or index_fields
@@ -31,7 +31,7 @@ module Ecoportal
           @fields_by_id     = {}
           @fields_by_alt_id = {}
 
-          doc["fields"].each do |field|
+          doc['fields'].each do |field|
             wrapped = schema_field_class.new(field)
             @fields_by_id[wrapped.id] = wrapped
             @fields_by_alt_id[wrapped.alt_id] = wrapped
@@ -40,9 +40,9 @@ module Ecoportal
 
         def initialize_details(details)
           details.schema_id = id
-          details.doc["fields"] = fields.map do |field|
+          details.doc['fields'] = fields.map do |field|
             field.doc.slice(*%w[id alt_id name multiple type shared]).merge(
-              "value" => field.multiple ? [] : nil
+              'value' => field.multiple ? [] : nil
             )
           end
         end
@@ -50,4 +50,5 @@ module Ecoportal
     end
   end
 end
+
 require 'ecoportal/api/v1/schema_field'