ecoportal-api 0.3.8 → 0.4.1

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

@@ -2,6 +2,7 @@ module Ecoportal
   module API
     module Common
       module DocHelpers
+
         def get_body(doc)
           if doc.respond_to?(:as_update)
             doc.as_update
@@ -11,6 +12,7 @@ module Ecoportal
             doc
           end
         end
+        
         def get_id(doc)
           id = nil
           id ||= doc.id if doc.respond_to?(:id)

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

@@ -4,32 +4,34 @@ module Ecoportal
       module HashDiff
         ID_KEYS = %w[id]
 
-        def self.diff(a, b)
-          return a if a.class != b.class
-          case a
-          when Hash
-            {}.tap do |diffed|
-              a.each do |key, a_value|
-                b_value = b[key]
-                next if a_value == b_value && !ID_KEYS.include?(key)
-                diffed[key] = diff(a_value, b_value)
-                diffed.delete(key) if diffed[key] == {}
+        class << self
+          def diff(a, b)
+            return a if a.class != b.class
+            case a
+            when Hash
+              {}.tap do |diffed|
+                a.each do |key, a_value|
+                  b_value = b[key]
+                  next if a_value == b_value && !ID_KEYS.include?(key)
+                  diffed[key] = diff(a_value, b_value)
+                  diffed.delete(key) if diffed[key] == {}
+                end
+                # All keys are IDs, so it's actually blank
+                if (diffed.keys - ID_KEYS).empty?
+                  return {}
+                end
               end
-              # All keys are IDs, so it's actually blank
-              if (diffed.keys - ID_KEYS).empty?
-                return {}
+            when Array
+              return a unless a.length == b.length
+              a.map.with_index do |a_value, idx|
+                b_value = b[idx]
+                diff(a_value, b_value)
+              end.reject do |el|
+                el == {}
               end
+            else
+              a
             end
-          when Array
-            return a unless a.length == b.length
-            a.map.with_index do |a_value, idx|
-              b_value = b[idx]
-              diff(a_value, b_value)
-            end.reject do |el|
-              el == {}
-            end
-          else
-            a
           end
         end
       end

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

@@ -2,7 +2,9 @@ module Ecoportal
   module API
     module Common
       class Response
+
         attr_reader :status, :body
+
         def initialize(response)
           @status = response.status
           @body   = [].tap do |body_data|
@@ -13,9 +15,11 @@ module Ecoportal
           @body   = JSON.parse(@body.to_s) rescue nil
           response
         end
+
         def success?
           @status.success?
         end
+        
         def print
           puts "Status: #{@status.code}"
           puts "Body:"

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

@@ -3,35 +3,43 @@ module Ecoportal
     module Common
       class WrappedResponse
         include Enumerable
+
         attr_reader :response, :result
+
         def initialize(response, klass)
           @response = response
           @klass    = klass
 
           if @response.success?
-            @result = if @response.body.is_a?(Array)
-                        @response.body.map do |doc|
-                          @klass.new(doc)
-                        end
-                      else
-                        @klass.new(@response.body)
-                      end
+            @result =
+              if @response.body.is_a?(Array)
+                @response.body.map do |doc|
+                  @klass.new(doc)
+                end
+              else
+                @klass.new(@response.body)
+              end
           end
         end
+
         def body
           response.body.to_s
         end
+
         def each
-          [*@result].each do |doc|
+          [*result].each do |doc|
             yield doc
           end
         end
+
         def status
-          @response.status.code
+          response.status.code
         end
+
         def success?
-          @response.success?
+          response.success?
         end
+
         def print
           if success?
             each(&:print)
@@ -39,6 +47,7 @@ module Ecoportal
             puts "Request failed."
           end
         end
+        
       end
     end
   end

data/lib/ecoportal/api/internal.rb

@@ -1,34 +1,31 @@
 module Ecoportal
   module API
-    class Internal
+    class Internal < V1
       include Common::Logging
-      attr_reader :client, :logger
-      def initialize(api_key, host: "live.ecoportal.com", logger: default_logger)
-        @logger = logger
-        @client = Common::Client.new(
-          api_key: api_key,
-          host:    host,
-          version: "v0",
-          logger:  @logger
-        )
-      end
-      def people
-        Internal::People.new(client)
-      end
-      def person_schemas
-        Internal::PersonSchemas.new(client)
-      end
+
+      VERSION = "v0"
+      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"
+
+      # Obtain specific object for policy groups api requests.
+      # @return [PolicyGroups] an instance object ready to make policy groups api requests.
       def policy_groups
-        Internal::PolicyGroups.new(client)
+        policy_groups_class.new(client)
       end
+
+      # Obtain specific object for login providers api requests.
+      # @return [LoginProviders] an instance object ready to make login providers api requests.
       def login_providers
-        Internal::LoginProviders.new(client)
+        login_providers_class.new(client)
       end
     end
   end
 end
 
-require 'ecoportal/api/internal/people'
 require 'ecoportal/api/internal/person_schemas'
 require 'ecoportal/api/internal/policy_groups'
 require 'ecoportal/api/internal/login_providers'
+require 'ecoportal/api/internal/people'

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

@@ -2,14 +2,36 @@ module Ecoportal
   module API
     class Internal
       class Account < Common::BaseModel
-        passthrough :policy_group_ids, :landing_page_id, :permissions_preset, :permissions_custom, :preferences, :prefilter, :filter_tags, :login_provider_ids, :starred_ids, :accept_eula, :send_invites, :default_tag, to: :doc
+        passthrough :policy_group_ids, :landing_page_id, :permissions_preset, :permissions_custom,
+          :preferences, :prefilter, :filter_tags, :login_provider_ids, :starred_ids, :accept_eula,
+          :send_invites, :default_tag
+
+        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  :preferences, klass: :preferences_class
 
         VALID_TAG_REGEX = /^[A-Za-z0-9 &_'\/-]+$/
 
+        # Sets the `permissions_preset`.
+        # @note basically the same as `permissions_preset=` but when `"custom"`, it's changed to `nil`
+        # @param value [nil, String] preset name.
         def preset=(value)
           self.permissions_preset = value == "custom" ? nil : value
         end
 
+        # Gets the `permissions_preset`.
+        # @note basically the same as `permissions_preset` but when 'nil', it returns `"custom"` instead
+        # @return [nil, String] preset name.
+        def preset
+          self.permissions_preset.nil? ? "custom" : self.permissions_preset
+        end
+
+        # Validates the string tags of the array, and sets the `filter_tags` property of the account.
+        # @note all is set in upper case.
+        # @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}"
@@ -22,10 +44,6 @@ module Ecoportal
           end
         end
 
-        def preset
-          self.permissions_preset.nil? ? "custom" : self.permissions_preset
-        end
-
         def as_json
           super.tap do |hash|
             if preset == "custom"
@@ -37,17 +55,6 @@ module Ecoportal
           end
         end
 
-        def permissions
-          return @permissions if defined?(@permissions)
-          doc["permissions_custom"] ||= {}
-          @permissions = Internal::Permissions.new(doc["permissions_custom"])
-        end
-
-        def preferences
-          return @preferences if defined?(@preferences)
-          doc["preferences"] ||= {}
-          @preferences = Internal::Preferences.new(doc["preferences"])
-        end
       end
     end
   end

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class Internal
       class LoginProvider < Common::BaseModel
-        passthrough :id, :name, :type, :enabled_for, to: :doc
+        passthrough :id, :name, :type, :enabled_for
       end
     end
   end

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

@@ -1,20 +1,30 @@
 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

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

@@ -1,19 +1,14 @@
-require 'ecoportal/api/common/doc_helpers'
 module Ecoportal
   module API
     class Internal
       class People < V1::People
-        private
-
-        def person_class
-          Internal::Person
-        end
+        class_resolver :person_class,  "Ecoportal::API::Internal::Person"
       end
     end
   end
 end
 
-require 'ecoportal/api/internal/person'
-require 'ecoportal/api/internal/person_details'
 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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class Internal
       class Permissions < Common::BaseModel
-        passthrough :files, :data, :reports, :organization, :people, :pages, :page_editor, :registers, to: :doc
+        passthrough :files, :data, :reports, :organization, :people, :pages, :page_editor, :registers
       end
     end
   end

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

@@ -1,17 +1,23 @@
 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 account
-          return @account if defined?(@account)
-          return @account = nil if doc["account"].nil?
-          @account = Internal::Account.new(doc["account"])
-        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`.
+        # @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
@@ -19,7 +25,9 @@ module Ecoportal
           when Internal::Account
             doc["account"] = JSON.parse(value.to_json)
           when Hash
-            # TODO
+            # TODO:
+            # => missing send_invites
+            # => better use an Internal::Account::PROPERTIES const for this kind of stuff
             doc["account"] = value.slice(%w[policy_group_ids landing_page_id permissions_preset permissions_custom preferences prefilter filter_tags login_provider_ids starred_ids])
           else
             # TODO
@@ -29,19 +37,13 @@ module Ecoportal
           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 person_schema_class
-          Internal::PersonSchema
-        end
-
-        def person_details_class
-          Internal::PersonDetails
-        end
       end
     end
   end

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

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

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

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

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

@@ -2,14 +2,10 @@ module Ecoportal
   module API
     class Internal
       class PersonSchemas < V1::PersonSchemas
-        private
-
-        def person_schema_class
-          Internal::PersonSchema
-        end
+        class_resolver :person_schema_class,  "Ecoportal::API::Internal::PersonSchema"
       end
     end
   end
 end
 
-require 'ecoportal/api/internal/person_schema'
+require 'ecoportal/api/internal/person_schema'