ecoportal-api 0.6.0 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f58ff9e368c2607a55aed0c5e62d45e7c51f37baac25d5da83c4ce6dd4224733
-  data.tar.gz: c8bcd11749dfcd0a57650ba25a3d826e209b871c472c2cabbb9e61c01bbaa563
+  metadata.gz: 275ffcb5e9bfe17f44295a7c4438b9e169dc87f22afe19591752425ef008cdba
+  data.tar.gz: aeb53e930f75dc7299fc400a8a00624428dfe496b77a5fdf1af1075b144a6944
 SHA512:
-  metadata.gz: 0e730eff886dd4f908e1bdd52b468b513c4e0309b7be47e3461bd7ef7f81c91d6d9dd4e61c8bdc681132bb310dd423bc62c3379510701d9c71e3f4847688fd3e
-  data.tar.gz: dba899cde0099074a44549cd05fedcd3a72e57ca81403a9399411f67c6575db40fe170f63fda7ded3e6d4fa626db2dd0dd33df1eaf3b7058d3cb9aec83e53792
+  metadata.gz: 2e2e4c03089ccf675057b335a9c9e46a5a40a92d3720b256fb9a679eec6431885889171960bf106e3586efbc77d9b2384262c9e4aa52cdf34b6c291be78b76dd
+  data.tar.gz: c1df25f369172d215ba64bf932b63d78514871579540edabc991719a737999a5700828352bceca140d5715861b47cb6b2e4e56fab4b7b916fe5ef42627ec7e4f

data/CHANGELOG.md

@@ -1,7 +1,74 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.6.0] - 2020-07-xx
+## [0.7.4] - 2021-01-2
+
+### Added
+
+### Fixed
+  - changed `compact` to `compact!`:
+    - `Ecoportal::API::V1::Person#filter_tags=`
+    - `Ecoportal::API::Internal::Account#policy_group_ids=`
+    - `Ecoportal::API::Internal::Account#login_provider_ids=`
+    - `Ecoportal::API::Internal::Account#starred_ids=`
+
+### Changed
+
+## [0.7.3] - 2020-11-30
+
+### Added
+
+### Fixed
+  - `Ecoportal::API::V1::Person#email=`: was not showing the incorrect value in the error message
+  - added `compact` to remove `null` values on:
+    - `Ecoportal::API::V1::Person#filter_tags=`
+    - `Ecoportal::API::Internal::Account#policy_group_ids=`
+    - `Ecoportal::API::Internal::Account#login_provider_ids=`
+    - `Ecoportal::API::Internal::Account#starred_ids=`
+
+### Changed
+
+
+## [0.7.2] - 2020-10-19
+
+### Added
+  - `Ecoportal::API::V1::Person#email=`:
+    - do a minimum validation (no blanks in the email)
+    - set in lower case (as this is how it's in the server)
+### Fixed
+  - `Ecoportal::API::V1::People#each`: when `silent` it shouldn't print a blank line
+  - fixed so they return empty array `[]` when `nil`:
+    - `Ecoportal::API::V1::Person#filter_tags`
+    - `Ecoportal::API::Internal::Account#policy_group_ids`
+    - `Ecoportal::API::Internal::Account#login_provider_ids`
+    - `Ecoportal::API::Internal::Account#starred_ids`
+### Changed
+  - made it so some methods the `Array` with `uniq` values:
+    - `Ecoportal::API::V1::Person#filter_tags=`
+    - `Ecoportal::API::Internal::Account#policy_group_ids=`
+  - made it so it only updates the keys defined in the `Hash` passed to the setter:
+    - `Ecoportal::API::Internal::Account#permissions_custom=`
+    - `Ecoportal::API::Internal::Account#preferences=`
+
+
+## [0.7.1] - 2020-09-30
+
+### Added
+  - `Ecoportal::API::Internal::Permissions`: **update for new ability `tasks` of ecoPortal release `1.5.3`**
+  - `Ecoportal::API::V1::People#each`: added keyword argument `silent:` to display download progress
+### Fixed
+  - `Ecoportal::API::V1::People#each`: when no block provided, it was creating an `Enumarator` without preserving the parameters (i.e. `:q` or `per_page` were lost)
+
+## [0.7.0] - 2020-09-11
+
+### Added
+### Changed
+  - `Ecoportal::API::Internal::Permissions`: **update for new abilities of ecoPortal release `1.5.2`**
+    - decoupled abilities: `person_core` into `person_core_create`, `person_core_edit`
+### Fixed
+
+
+## [0.6.0] - 2020-07-14
 
 ### Added
   - `Ecoportal::API::Common::BaseModel#initial_doc`: `#consolidate!` modifies `original_doc`

data/ecoportal-api.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "redcarpet", "~> 3.5", ">= 3.5.0"
   spec.add_development_dependency "pry"      , "~> 0.13"
 
-  spec.add_dependency 'http',          '~> 3'
+  spec.add_dependency 'http',          '~> 4'
   spec.add_dependency 'hash-polyfill', '~> 0'
 end

data/lib/ecoportal/api.rb

@@ -11,4 +11,5 @@ end
 require "ecoportal/api/logger"
 require "ecoportal/api/common"
 require "ecoportal/api/v1"
+require "ecoportal/api/v2"
 require "ecoportal/api/internal"

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

@@ -108,10 +108,10 @@ module Ecoportal
           end
         end
 
-        def pretty_print
-          puts JSON.pretty_generate(as_json)
-          self
-        end
+        # def pretty_print
+        #   puts JSON.pretty_generate(as_json)
+        #   self
+        # end
 
         protected
 

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

@@ -119,11 +119,18 @@ module Ecoportal
           Ecoportal::API::Common::Response.new(response)
         end
 
-        # Creates a HTTP object adding the `X-ApiKey` param to the header.
+        # Creates a HTTP object adding the `X-ApiKey` or `X-ECOPORTAL-API-KEY` param to the header, depending on the API version.
         # @note It configures HTTP so it only allows body data in json format.
         # @return [HTTP] HTTP object.
         def base_request
-          @base_request ||= HTTP.headers("X-ApiKey" => @api_key).accept(:json)
+          @base_request ||= begin
+            case @version
+            when "v2"
+              HTTP.headers("X-ECOPORTAL-API-KEY" => @api_key).accept(:json)
+            else
+              HTTP.headers("X-ApiKey" => @api_key).accept(:json)
+            end
+          end
         end
 
         # Full URl builder of the request

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

@@ -13,14 +13,49 @@ module Ecoportal
         embeds_one  :preferences, klass: :preferences_class
 
         # 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)
           unless value.is_a?(Array)
             raise "policy_group_ids= needs to be passed an Array, got #{value.class}"
           end
 
+          value.uniq!
           ini_ids = (original_doc && original_doc["policy_group_ids"]) || []
           # preserve original order to avoid false updates
           doc["policy_group_ids"] = (ini_ids & value) + (value - ini_ids)
+          doc["policy_group_ids"].compact
+        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)
+          unless value.is_a?(Array)
+            raise "login_provider_ids= needs to be passed an Array, got #{value.class}"
+          end
+          doc["login_provider_ids"] = value.compact
+        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)
+          unless value.is_a?(Array)
+            raise "starred_ids= needs to be passed an Array, got #{value.class}"
+          end
+          doc["starred_ids"] = value.compact
+        end
+
+        # @return [Array<String>] the starred page ids of this user.
+        def starred_ids
+          doc["starred_ids"] ||= []
         end
 
         # Sets the `permissions_preset`.
@@ -37,6 +72,20 @@ module Ecoportal
           self.permissions_preset.nil? ? "custom" : self.permissions_preset
         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|
             if preset == "custom"

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

@@ -3,8 +3,9 @@ module Ecoportal
     class Internal
       class Permissions < Common::BaseModel
         passthrough :files, :data, :reports
-        passthrough :organization, :person_core, :person_account, :person_details
-        passthrough :pages, :page_editor, :registers
+        passthrough :organization, :person_core, :person_core_create, :person_core_edit
+        passthrough :person_account, :person_details
+        passthrough :pages, :page_editor, :registers, :tasks
       end
     end
   end

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

@@ -27,15 +27,27 @@ module Ecoportal
         # @param params [Hash]
         # @option params [String] :per_page the number of people you get per request.
         # @option params [String] :q some text to search. Omit this parameter to target all the people.
+        # @param silent [Boolean] `false` to show percentage of progress.
         # @yield [person] does some stuff with the person.
         # @yieldparam person [Person]
-        def each(params: {}, &block)
-          return to_enum(:each) unless block
-          cursor_id = nil
+        def each(params: {}, silent: false, &block)
+          return to_enum(:each, params: params, silent: silent) unless block
+          cursor_id = nil; results = 0
+          puts "\n" unless silent
           loop do
             params.update(cursor_id: cursor_id) if cursor_id
             response = client.get("/people", params: params)
-            raise "Request failed." unless response.success?
+            raise "Request failed - Status #{response.status}: #{response.body}" unless response.success?
+
+            unless silent || (total = response.body["total_results"]) == 0
+              results += response.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"
+              $stdout.flush
+            end
+
             response.body["results"].each do |person|
               yield person_class.new(person)
             end
@@ -45,13 +57,14 @@ module Ecoportal
         end
 
         # Gets all the people via api requests.
-        # @note it ignores the key `:page` in `params:`.
+        # @note it ignores the key `:cursor_id` in `params:`.
         # @param params [Hash]
         # @option params [Integer] :per_page the number of people you get per request.
         # @option params [String] :q some text to search.
+        # @param silent [Boolean] `false` to show percentage of progress.
         # @return [Array<Person>] the array of people got via api.
-        def get_all(params: {})
-          each(params: params).to_a
+        def get_all(params: {}, silent: false)
+          each(params: params, silent: silent).to_a
         end
 
         # Gets a person via api.

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

@@ -15,6 +15,7 @@ module Ecoportal
         embeds_one :details, nullable: true, klass: :person_details_class
 
         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`.
         #
@@ -41,8 +42,17 @@ module Ecoportal
           self.supervisor_id = person&.id || person&.external_id
         end
 
+        # 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
+          doc["email"] = value&.downcase
+        end
+
         # Validates the string tags of the array, and sets the `filter_tags` property of the account.
-        # @note all is set in upper case.
+        # @note all is set in upper case and preserves the original order.
         # @raise [Exception] if there was any invalid string tag.
         # @param value [Array<String>] array of tags.
         def filter_tags=(value)
@@ -54,11 +64,17 @@ module Ecoportal
               raise "Invalid filter tag #{tag.inspect}"
             end
             tag.upcase
-          end
+          end.uniq
 
           ini_tags = (original_doc && original_doc["filter_tags"]) || []
           # preserve original order to avoid false updates
           doc["filter_tags"] = (ini_tags & end_tags) + (end_tags - ini_tags)
+          doc["filter_tags"].compact
+        end
+
+        # @return [Array<String>] the filter tags of this person.
+        def filter_tags
+          doc["filter_tags"] ||= []
         end
 
         def as_json

data/lib/ecoportal/api/v2.rb

@@ -0,0 +1,47 @@
+module Ecoportal
+  module API
+    # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+    # @attr_reader logger [Logger] the logger.
+    class V2
+      extend Common::BaseClass
+      include Common::Logging
+
+      VERSION = "v2"
+      class_resolver :registers_class,  "Ecoportal::API::V2::Registers"
+      class_resolver :pages_class,  "Ecoportal::API::V2::Pages"
+
+      attr_reader :client, :logger
+
+      # Creates an `V2` object to scope version specific api requests.
+      # @note
+      #   - The const `VERSION` determineds the api version that client will query against.
+      #   - This means that each subclass of `V2` should define their own `VERSION` constant.
+      # @param api_key [String] the key version to stablish the api connection.
+      # @param host [String] api server domain.
+      # @param logger [Logger] an object with `Logger` interface to generate logs.
+      # @return [V2] an object with the api version suit.
+      def initialize(api_key, version: VERSION, host: "live.ecoportal.com", logger: default_logger)
+        @logger = logger
+        @client = Common::Client.new(
+          api_key: api_key,
+          host:    host,
+          version: self.class::VERSION,
+          logger:  @logger
+        )
+      end
+
+      # Obtain specific object for register api requests.
+      # @return [Register] an instance object ready to make register api requests.
+      def registers
+        registers_class.new(client)
+      end
+
+      def pages
+        pages_class.new(client)
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/v2/registers'
+require 'ecoportal/api/v2/pages'

data/lib/ecoportal/api/v2/field.rb

@@ -0,0 +1,9 @@
+module Ecoportal
+  module API
+    class V2
+      class Field < Common::BaseModel
+        passthrough :id, :label, :value, :type
+      end
+    end
+  end
+end

data/lib/ecoportal/api/v2/page.rb

@@ -0,0 +1,30 @@
+module Ecoportal
+  module API
+    class V2
+      class Page < Common::BaseModel
+        passthrough :id, :name, :state
+
+        class_resolver :stage_class, "Ecoportal::API::V2::Stage"
+        class_resolver :field_class, "Ecoportal::API::V2::Field"
+
+        def stages
+          return nil unless doc["evolution"]
+          return @stages if defined?(@stages)
+          @stages = (doc["evolution"]["stages"] || []).each_with_index.map do |stage, i|
+            stage_class.new(stage, parent: self, key: ["stages", i])
+          end
+        end
+
+        def fields
+          return @fields if defined?(@fields)
+          @fields = (doc["components"] || []).each_with_index.map do |component, i|
+            field_class.new(component, parent: self, key: ["components", i])
+          end
+        end
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/v2/stage'
+require 'ecoportal/api/v2/field'

data/lib/ecoportal/api/v2/pages.rb

@@ -0,0 +1,46 @@
+module Ecoportal
+  module API
+    class V2
+      # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+      class Pages
+        extend Common::BaseClass
+        include Enumerable
+        include Common::DocHelpers
+
+        attr_reader :client
+
+        class_resolver :page_class, "Ecoportal::API::V2::Page"
+
+        # @param client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+        # @return [People] an instance object ready to make people api requests.
+        def initialize(client)
+          @client = client
+        end
+
+        def get(id, stage_id: nil)
+          if stage_id
+            response = get_with_stage_id(id, stage_id)
+            return page_class.new(response.body["data"])
+          end
+
+          response = client.get("/pages/#{id}")
+          # we get a 302 back when there's stages for the page
+          # let's follow it
+          if response.status == 302
+            stage_id = response.body["data"].match(/stages\/(.*)/)[1]
+            response = get_with_stage_id(id, stage_id)
+          end
+          page_class.new(response.body["data"])
+        end
+
+        private
+
+        def get_with_stage_id(id, stage_id)
+          client.get("/pages/#{id}/stages/#{stage_id}")
+        end
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/v2/page'

data/lib/ecoportal/api/v2/register_search_result.rb

@@ -0,0 +1,20 @@
+module Ecoportal
+  module API
+    class V2
+      class RegisterSearchResult < Common::BaseModel
+        passthrough :id, :name, :state
+
+        class_resolver :stage_class, "Ecoportal::API::V2::Stage"
+
+        def stages
+          return @stages if defined?(@stages)
+          @stages = (doc["stages"] || []).each_with_index.map do |stage, i|
+            stage_class.new(stage, parent: self, key: ["stages", i])
+          end
+        end
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/v2/stage'

data/lib/ecoportal/api/v2/registers.rb

@@ -0,0 +1,65 @@
+module Ecoportal
+  module API
+    class V2
+      # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+      class Registers
+        extend Common::BaseClass
+        include Enumerable
+        include Common::DocHelpers
+
+        class_resolver :register_search_result_class, "Ecoportal::API::V2::RegisterSearchResult"
+
+        attr_reader :client
+
+        # @param client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+        # @return [People] an instance object ready to make people api requests.
+        def initialize(client)
+          @client = client
+        end
+
+        def search(register_id, options = {})
+          # supply a query string
+          # or a filter array (copy/paste from dev tools in the browser)
+          options = {query: nil, filters: []}.update(options)
+          options = {}.tap do |ret|
+            options.each do |key, value|
+              if key == :filters && value.any?
+                ret[key] = {filters: value}.to_json
+              else
+                ret[key] = value if key
+              end
+            end
+          end
+
+          cursor_id = nil
+          results = 0
+          loop do
+            options.update(cursor_id: cursor_id) if cursor_id
+            response = client.get("/registers/#{register_id}/search", params: options)
+            raise "Request failed - Status #{response.status}: #{response.body}" unless response.success?
+
+            data = response.body["data"]
+            unless (total = data["total"]) == 0
+              results += data["results"].length
+              percent  = results * 100 / total
+              msg      = "Registers SEARCH"
+              print "#{msg}: #{percent.round}% (of #{total})\r"
+              $stdout.flush 
+            end
+
+            data["results"].each do |result|
+              object = register_search_result_class.new(result)
+              yield object
+            end
+
+            # break unless (cursor_id = data["cursor_id"])
+            break if total == results
+          end
+          self
+        end
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/v2/register_search_result'

data/lib/ecoportal/api/v2/stage.rb

@@ -0,0 +1,9 @@
+module Ecoportal
+  module API
+    class V2
+      class Stage < Common::BaseModel
+        passthrough :id, :name, :state
+      end
+    end
+  end
+end

data/lib/ecoportal/api/version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    VERSION = "0.6.0"
+    VERSION = "0.7.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.4
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-14 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -124,14 +124,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: hash-polyfill
   requirement: !ruby/object:Gem::Requirement
@@ -182,7 +182,6 @@ files:
 - lib/ecoportal/api/common/response.rb
 - lib/ecoportal/api/common/wrapped_response.rb
 - lib/ecoportal/api/internal.rb
-- lib/ecoportal/api/internal/.git-keep
 - lib/ecoportal/api/internal/account.rb
 - lib/ecoportal/api/internal/login_provider.rb
 - lib/ecoportal/api/internal/login_providers.rb
@@ -199,7 +198,6 @@ files:
 - lib/ecoportal/api/internal/schema_field_value.rb
 - lib/ecoportal/api/logger.rb
 - lib/ecoportal/api/v1.rb
-- lib/ecoportal/api/v1/.git-keep
 - lib/ecoportal/api/v1/people.rb
 - lib/ecoportal/api/v1/person.rb
 - lib/ecoportal/api/v1/person_details.rb
@@ -207,6 +205,13 @@ files:
 - lib/ecoportal/api/v1/person_schemas.rb
 - lib/ecoportal/api/v1/schema_field.rb
 - lib/ecoportal/api/v1/schema_field_value.rb
+- lib/ecoportal/api/v2.rb
+- lib/ecoportal/api/v2/field.rb
+- lib/ecoportal/api/v2/page.rb
+- lib/ecoportal/api/v2/pages.rb
+- lib/ecoportal/api/v2/register_search_result.rb
+- lib/ecoportal/api/v2/registers.rb
+- lib/ecoportal/api/v2/stage.rb
 - lib/ecoportal/api/version.rb
 homepage: https://www.ecoportal.com
 licenses: