ecoportal-api 0.8.5 → 0.9.2

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

@@ -1,100 +1,99 @@
-module Ecoportal
-  module API
-    class Internal
-      class Account < Common::BaseModel
-        PROPERTIES = [
-          "user_id", "policy_group_ids", "default_tag", "prefilter",
-          "permissions_custom", "permissions_merged", "preferences",
-          "login_provider_ids", "starred_ids", "landing_page_id",
-          "accept_eula", "send_invites", "force_send_invites"
-        ]
-        passthrough *PROPERTIES.map(&:to_sym)
-
-        class_resolver :preferences_class, "Ecoportal::API::Internal::Preferences"
-        class_resolver :permissions_class, "Ecoportal::API::Internal::Permissions"
-
-        embeds_one  :permissions, key: "permissions_custom", klass: :permissions_class
-        embeds_one  :perms_merged, key: "permissions_merged", klass: :permissions_class
-        embeds_one  :preferences, klass: :preferences_class
-
-        # Sets the `default_tag` of the user
-        # @note it upcases the value
-        # @param value [String, nil] the tag
-        # @return [String, nil] the value set in `default_tag`
-        def default_tag=(value)
-          unless !value || value.is_a?(String)
-            raise ArgumentError.new("default_tag= needs to be passed a String or nil, got #{value.class}")
-          end
-          if value
-            unless value.match(Ecoportal::API::V1::Person::VALID_TAG_REGEX)
-              raise ArgumentError.new("Invalid default tag #{value.inspect}")
-            end
-            value = value.upcase
-          end
-          doc["default_tag"] = value
-        end
-
-        # Sets the `policy_group_ids`
-        # @note it preserves the original order
-        # @param value [Array<String>] the policy group ids to be set.
-        def policy_group_ids=(value)
-          set_uniq_array_keep_order("policy_group_ids", value)
-        end
-
-        # @return [Array<String>] the policy group ids of this user.
-        def policy_group_ids
-          doc["policy_group_ids"] ||= []
-        end
-
-        # Sets the `login_provider_ids`
-        def login_provider_ids=(value)
-          set_uniq_array_keep_order("login_provider_ids", value)
-        end
-
-        # @return [Array<String>] the login provider ids of this user.
-        def login_provider_ids
-          doc["login_provider_ids"] ||= []
-        end
-
-        # Sets the `starred_ids`
-        def starred_ids=(value)
-          set_uniq_array_keep_order("starred_ids", value)
-        end
-
-        # @return [Array<String>] the starred page ids of this user.
-        def starred_ids
-          doc["starred_ids"] ||= []
-        end
-
-        # It preserves the values of keys that are not defined in `value`.
-        # @param value [Hash] the abilities that you want to update.
-        def permissions_custom=(value)
-          doc["permissions_custom"] ||= {}
-          doc["permissions_custom"].merge!(value)
-        end
-
-        # It preserves the values of keys that are not defined in `value`.
-        # @param value [Hash] the preferences that you want to update.
-        def preferences=(value)
-          doc["preferences"] ||= {}
-          doc["preferences"].merge!(value)
-        end
-
-        def as_json
-          super.tap do |hash|
-            hash["permissions_custom"] = permissions.as_json
-            hash["permissions_merged"] = perms_merged.as_json
-            hash["preferences"] = preferences.as_json
-          end
-        end
-
-        def as_update(ref = :last, ignore: [])
-          super(ref, ignore: ignore | ["user_id", "permissions_merged", "prefilter"])
-        end
-
-      end
-    end
-  end
-end
-require 'ecoportal/api/internal/permissions'
-require 'ecoportal/api/internal/preferences'
+module Ecoportal
+  module API
+    class Internal
+      class Account < Common::BaseModel
+        PROPERTIES = [
+          "user_id", "policy_group_ids", "default_tag", "prefilter",
+          "permissions_custom", "permissions_merged", "preferences",
+          "login_provider_ids", "starred_ids", "landing_page_id",
+          "accept_eula", "send_invites", "force_send_invites"
+        ]
+        passthrough *PROPERTIES.map(&:to_sym)
+
+        class_resolver :preferences_class, "Ecoportal::API::Internal::Preferences"
+        class_resolver :permissions_class, "Ecoportal::API::Internal::Permissions"
+
+        embeds_one  :permissions, key: "permissions_custom", klass: :permissions_class
+        embeds_one  :perms_merged, key: "permissions_merged", klass: :permissions_class
+        embeds_one  :preferences, klass: :preferences_class
+
+        # Sets the `default_tag` of the user
+        # @note it upcases the value
+        # @param value [String, nil] the tag
+        # @return [String, nil] the value set in `default_tag`
+        def default_tag=(value)
+          unless !value || value.is_a?(String)
+            raise ArgumentError.new("default_tag= needs to be passed a String or nil, got #{value.class}")
+          end
+          if value
+            unless value.match(Ecoportal::API::V1::Person::VALID_TAG_REGEX)
+              raise ArgumentError.new("Invalid default tag #{value.inspect}")
+            end
+            value = value.upcase
+          end
+          doc["default_tag"] = value
+        end
+
+        # Sets the `policy_group_ids`
+        # @note it preserves the original order
+        # @param value [Array<String>] the policy group ids to be set.
+        def policy_group_ids=(value)
+          set_uniq_array_keep_order("policy_group_ids", value)
+        end
+
+        # @return [Array<String>] the policy group ids of this user.
+        def policy_group_ids
+          doc["policy_group_ids"] ||= []
+        end
+
+        # Sets the `login_provider_ids`
+        def login_provider_ids=(value)
+          set_uniq_array_keep_order("login_provider_ids", value)
+        end
+
+        # @return [Array<String>] the login provider ids of this user.
+        def login_provider_ids
+          doc["login_provider_ids"] ||= []
+        end
+
+        # Sets the `starred_ids`
+        def starred_ids=(value)
+          set_uniq_array_keep_order("starred_ids", value)
+        end
+
+        # @return [Array<String>] the starred page ids of this user.
+        def starred_ids
+          doc["starred_ids"] ||= []
+        end
+
+        # It preserves the values of keys that are not defined in `value`.
+        # @param value [Hash] the abilities that you want to update.
+        def permissions_custom=(value)
+          doc["permissions_custom"] ||= {}
+          doc["permissions_custom"].merge!(value)
+        end
+
+        # It preserves the values of keys that are not defined in `value`.
+        # @param value [Hash] the preferences that you want to update.
+        def preferences=(value)
+          doc["preferences"] ||= {}
+          doc["preferences"].merge!(value)
+        end
+
+        def as_json
+          super.tap do |hash|
+            hash["permissions_custom"] = permissions.as_json
+            hash["permissions_merged"] = perms_merged.as_json
+            hash["preferences"] = preferences.as_json
+          end
+        end
+
+        def as_update(ref = :last, ignore: [])
+          super(ref, ignore: ignore | ["user_id", "permissions_merged", "prefilter"])
+        end
+      end
+    end
+  end
+end
+require 'ecoportal/api/internal/permissions'
+require 'ecoportal/api/internal/preferences'

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

@@ -1,9 +1,9 @@
-module Ecoportal
-  module API
-    class Internal
-      class LoginProvider < Common::BaseModel
-        passthrough :id, :name, :type, :enabled_for
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class Internal
+      class LoginProvider < Common::BaseModel
+        passthrough :id, :name, :type, :enabled_for
+      end
+    end
+  end
+end

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

@@ -1,33 +1,33 @@
-module Ecoportal
-  module API
-    class Internal
-      # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
-      class LoginProviders
-        include Enumerable
-
-        attr_reader :client
-
-        # @param client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
-        # @return [LoginProviders] an instance object ready to make login providers api requests.
-        def initialize(client)
-          @client = client
-        end
-
-        # Gets all the login providers via api request.
-        # @return [Enumerable<LoginProvider>] an `Enumerable` with all login providers already wrapped as `LoginProvider` objects.
-        def get_all
-          response = @client.get("/login_providers")
-          Common::WrappedResponse.new(response, Internal::LoginProvider)
-        end
-
-        def each(&block)
-          return to_enum(:each) unless block
-          get_all.each(&block)
-        end
-
-      end
-    end
-  end
-end
-
-require 'ecoportal/api/internal/login_provider'
+module Ecoportal
+  module API
+    class Internal
+      # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+      class LoginProviders
+        include Enumerable
+
+        attr_reader :client
+
+        # @param client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+        # @return [LoginProviders] an instance object ready to make login providers api requests.
+        def initialize(client)
+          @client = client
+        end
+
+        # Gets all the login providers via api request.
+        # @return [Enumerable<LoginProvider>] an `Enumerable` with all login providers already wrapped as `LoginProvider` objects.
+        def get_all
+          response = @client.get("/login_providers")
+          Common::WrappedResponse.new(response, Internal::LoginProvider)
+        end
+
+        def each(&block)
+          return to_enum(:each) unless block
+          get_all.each(&block)
+        end
+
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/internal/login_provider'

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

@@ -1,14 +1,14 @@
-module Ecoportal
-  module API
-    class Internal
-      class People < V1::People
-        class_resolver :person_class,  "Ecoportal::API::Internal::Person"
-      end
-    end
-  end
-end
-
-require 'ecoportal/api/internal/schema_field_value'
-require 'ecoportal/api/internal/person_details'
-require 'ecoportal/api/internal/account'
-require 'ecoportal/api/internal/person'
+module Ecoportal
+  module API
+    class Internal
+      class People < V1::People
+        class_resolver :person_class,  "Ecoportal::API::Internal::Person"
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/internal/schema_field_value'
+require 'ecoportal/api/internal/person_details'
+require 'ecoportal/api/internal/account'
+require 'ecoportal/api/internal/person'

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

@@ -1,13 +1,14 @@
-module Ecoportal
-  module API
-    class Internal
-      class Permissions < Common::BaseModel
-        passthrough :files, :data, :reports
-        passthrough :organization, :pages, :page_editor, :registers, :tasks
-        passthrough :person_core, :person_core_create, :person_core_edit
-        passthrough :person_details, :person_account, :person_abilities
-        passthrough :visitor_management, :broadcast_notifications, :cross_register_reporting
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class Internal
+      class Permissions < Common::BaseModel
+        passthrough :files, :data, :reports
+        passthrough :organization, :pages, :page_editor, :registers, :tasks
+        passthrough :person_core, :person_core_create, :person_core_edit
+        passthrough :person_details, :person_account, :person_abilities
+        passthrough :visitor_management, :contractor_management
+        passthrough :broadcast_notifications, :cross_register_reporting
+      end
+    end
+  end
+end

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

@@ -1,53 +1,101 @@
-module Ecoportal
-  module API
-    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"
-        embeds_one :account, nullable: true, klass: :person_account_class
-
-        def as_json
-          super.update("account" => account&.as_json)
-        end
-
-        def as_update(ref = :last, ignore: [])
-          super(ref, ignore: ignore | ["user_id", "permissions_merged", "prefilter"])
-        end
-
-        # Sets the Account to the person, depending on the paramter received:
-        #  - `nil`: blanks the account.
-        #  - `Account`: sets a copy of the object param as account.
-        #  - `Hash`: slices the properties of `Account` (keeping the value of `user_id` if there was already account).
-        # @note this method does not make dirty the account (meaning that `as_json` will be an empty hash `{}`)
-        # @param value [nil, Account, Hash] value to be set.
-        # @return [nil, Account] the resulting `Account` set to the person.
-        def account=(value)
-          case value
-          when NilClass
-            doc["account"] = nil
-          when Internal::Account
-            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
-          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
-        end
-
-        # Adds an empty account to the person.
-        # @note if the person exists, and does not have an account, an this will send an invite.
-        # @note this will **not** change the account properties of this person.
-        def add_account
-          self.account = {}
-        end
-
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    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"
+        embeds_one :account, nullable: true, klass: :person_account_class
+
+        def initialize(doc = {}, *args, **kargs, &block)
+          super(doc, *args, **kargs, &block)
+          @is_new = @prev_is_new = no_account_nor_details?(@doc)
+        end
+
+        def consolidate!
+          @prev_is_new = @is_new
+          @is_new = false
+          super
+        end
+
+        def reset!(*args)
+          @is_new = @prev_is_new
+          super(*args)
+        end
+
+        # @note
+        #   - `original_doc` should technically hold the model as it is on **server side**
+        #   - Once this person has been successfullyupdated, `#consolidate!` should be called.
+        #   - The above sets a copy of `doc` as `original_doc` (meaning: _no pending changes_)
+        #   - Therefore we can safely assume that this is a **new record** if the `original_doc`
+        #     does not have details nor account (as all people should have either to exist).
+        #   - **However**, to the purpose of getting a clean `as_update`, `original_doc` is filled
+        #     with `details` right on creation. For this reason, a workaround is necessary via `@is_new`
+        # @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"]
+        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"]
+        end
+
+        def as_json
+          super.update("account" => account&.as_json)
+        end
+
+        def as_update(ref = :last, ignore: [])
+          super(ref, ignore: ignore | ["user_id", "permissions_merged", "prefilter"])
+        end
+
+        # Sets the Account to the person, depending on the paramter received:
+        #  - `nil`: blanks the account.
+        #  - `Account`: sets a copy of the object param as account.
+        #  - `Hash`: slices the properties of `Account` (keeping the value of `user_id` if there was already account).
+        # @note this method does not make dirty the account (meaning that `as_json` will be an empty hash `{}`)
+        # @param value [nil, Account, Hash] value to be set.
+        # @return [nil, Account] the resulting `Account` set to the person.
+        def account=(value)
+          case value
+          when NilClass
+            doc["account"] = nil
+          when Internal::Account
+            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
+          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
+        end
+
+        # Adds an empty account to the person.
+        # @note if the person exists, and does not have an account, an this will send an invite.
+        # @note this will **not** change the account properties of this person.
+        def add_account
+          self.account = {}
+        end
+
+        private
+
+        def no_account_nor_details?(value = @doc)
+          return true unless value.is_a?(Hash)
+          !value.key?("details") && !value.key?("account")
+        end
+      end
+    end
+  end
+end

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

@@ -1,9 +1,9 @@
-module Ecoportal
-  module API
-    class Internal
-      class PersonDetails < V1::PersonDetails
-        class_resolver :schema_field_value_class, "Ecoportal::API::Internal::SchemaFieldValue"
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class Internal
+      class PersonDetails < V1::PersonDetails
+        class_resolver :schema_field_value_class, "Ecoportal::API::Internal::SchemaFieldValue"
+      end
+    end
+  end
+end

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

@@ -1,10 +1,10 @@
-module Ecoportal
-  module API
-    class Internal
-      class PersonSchema < V1::PersonSchema
-        class_resolver :schema_field_class, "Ecoportal::API::Internal::SchemaField"
-      end
-    end
-  end
-end
-require 'ecoportal/api/internal/schema_field'
+module Ecoportal
+  module API
+    class Internal
+      class PersonSchema < V1::PersonSchema
+        class_resolver :schema_field_class, "Ecoportal::API::Internal::SchemaField"
+      end
+    end
+  end
+end
+require 'ecoportal/api/internal/schema_field'

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

@@ -1,11 +1,11 @@
-module Ecoportal
-  module API
-    class Internal
-      class PersonSchemas < V1::PersonSchemas
-        class_resolver :person_schema_class,  "Ecoportal::API::Internal::PersonSchema"
-      end
-    end
-  end
-end
-
-require 'ecoportal/api/internal/person_schema'
+module Ecoportal
+  module API
+    class Internal
+      class PersonSchemas < V1::PersonSchemas
+        class_resolver :person_schema_class,  "Ecoportal::API::Internal::PersonSchema"
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/internal/person_schema'

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

@@ -1,9 +1,9 @@
-module Ecoportal
-  module API
-    class Internal
-      class PolicyGroup < Common::BaseModel
-        passthrough :id, :name
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class Internal
+      class PolicyGroup < Common::BaseModel
+        passthrough :id, :name
+      end
+    end
+  end
+end

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

@@ -1,32 +1,32 @@
-module Ecoportal
-  module API
-    class Internal
-      # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
-      class PolicyGroups
-        include Enumerable
-
-        attr_reader :client
-
-        # @param client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
-        # @return [PolicyGroups] an instance object ready to make policy groups api requests.
-        def initialize(client)
-          @client = client
-        end
-
-        # 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")
-          Common::WrappedResponse.new(response, Internal::PolicyGroup)
-        end
-
-        def each(&block)
-          return to_enum(:each) unless block
-          get_all.each(&block)
-        end
-      end
-    end
-  end
-end
-
-require 'ecoportal/api/internal/policy_group'
+module Ecoportal
+  module API
+    class Internal
+      # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+      class PolicyGroups
+        include Enumerable
+
+        attr_reader :client
+
+        # @param client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+        # @return [PolicyGroups] an instance object ready to make policy groups api requests.
+        def initialize(client)
+          @client = client
+        end
+
+        # 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")
+          Common::WrappedResponse.new(response, Internal::PolicyGroup)
+        end
+
+        def each(&block)
+          return to_enum(:each) unless block
+          get_all.each(&block)
+        end
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/internal/policy_group'