ecoportal-api 0.4.3 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5441ef892224dc43af0a9060cf90725d93640cc98a66642565962ace69eefa00
-  data.tar.gz: 5c53d8665f94cae4e06f86b72cc4807ed8862908f0999156fd792d38c8a46ed5
+  metadata.gz: 31190d7d5719d21b732605d97eccaad0c042f9fc3212fc5f181e6e18e6f12771
+  data.tar.gz: e7bb04368723c7da36ca8408b05088ed09753c9f9fa53722b32c3ef0df3f6e0e
 SHA512:
-  metadata.gz: 0102b941ada369991d37a24676fedf97055633b3df0b4b0198f5dfef7007ddc289b53c1e36cdf4a0aae4afa995a26b05c26a3d2df5aecdcfeabe6e53bf108650
-  data.tar.gz: e3d0401ba1d6d91508812f549677e23fc60667cb794d22cafe82fc5bda8c344b529cf248856c36f1d13dad9d4e0bc8a00d66844f628686b6b3442035521f1a12
+  metadata.gz: f10ac460fa44b8750825f46648f54d394b36b9a4bec95b138724dd79f278db4014540bb268fecf9e4a3e719b8eb03da1d398a15203776706643eaa9437ba9fe8
+  data.tar.gz: 67185025081f552f608ba0512fce293ef5a731d31fee2b2132e276eda04f85bd135b0f268936209af1e948ff066f537d7834c005a302ca251f75359d7cfeb758

data/.rubocop.yml

@@ -0,0 +1,55 @@
+AllCops:
+  TargetRubyVersion: 2.5.1
+  Exclude:
+    - 'config/routes.rb'
+
+Metrics/LineLength:
+  Enabled: false
+Metrics/BlockLength:
+  ExcludedMethods: [context, describe]
+  Max: 50
+Metrics/MethodLength:
+  Max: 50
+Metrics/ClassLength:
+  Max: 200
+Metrics/AbcSize:
+  Max: 30
+
+ParameterLists:
+  Max: 5
+  CountKeywordArgs: false
+
+Style/StringLiterals:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/CommentedKeyword:
+  Enabled: false
+Style/MultilineBlockChain:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+Style/AndOr:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+Layout/SpaceInsideBlockBraces:
+  Enabled: false
+Layout/SpaceAroundOperators:
+  Enabled: false
+Layout/ExtraSpacing:
+  AllowForAlignment: true
+Layout/AccessModifierIndentation:
+  EnforcedStyle: indent
+Layout/DotPosition:
+  EnforcedStyle: trailing
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Layout/IndentHash:
+  Enabled: false
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+## [0.5.6] - 2020-06-xx
+
+### Added
+  - this `CHANGELOG.md` file
+  - person model: `freemium` core property
+### Changed
+### Fixed

data/bin/console

@@ -10,5 +10,5 @@ require "ecoportal/api"
 # require "pry"
 # Pry.start
 
-require "irb"
-IRB.start(__FILE__)
+require "pry"
+Pry.start(__FILE__)

data/ecoportal-api.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "ecoportal-api"
   spec.version       = Ecoportal::API::VERSION
   spec.authors       = ["Tapio Saarinen"]
-  spec.email         = ["tapio@ecoportal.co.nz"]
+  spec.email         = ["tapio@ecoportal.co.nz", "rien@ecoportal.co.nz", "oscar@ecoportal.co.nz", "bozydar@ecoportal.co.nz"]
 
   spec.summary       = %q{A collection of helpers for interacting with the ecoPortal MS's various APIs}
   spec.homepage      = "https://www.ecoportal.com"
@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec",     "~> 3.0"
   spec.add_development_dependency "yard",      "~> 0.9", ">= 0.9.18"
   spec.add_development_dependency "redcarpet", "~> 3.4", ">= 3.4.0"
+  spec.add_development_dependency "pry"
 
   spec.add_dependency 'http',          '~> 3'
   spec.add_dependency 'hash-polyfill', '~> 0'

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

@@ -3,17 +3,15 @@ module Ecoportal
     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,
+          :preferences, :prefilter, :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.
@@ -28,22 +26,6 @@ module Ecoportal
           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}"
-          end
-          doc["filter_tags"] = value.map do |tag|
-            unless tag.match(VALID_TAG_REGEX)
-              raise "Invalid filter tag #{tag.inspect}"
-            end
-            tag.upcase
-          end
-        end
-
         def as_json
           super.tap do |hash|
             if preset == "custom"

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

@@ -25,10 +25,7 @@ module Ecoportal
           when Internal::Account
             doc["account"] = JSON.parse(value.to_json)
           when Hash
-            # 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])
+            doc["account"] = value.slice(*%w[policy_group_ids default_tag landing_page_id permissions_preset permissions_custom preferences prefilter login_provider_ids starred_ids])
           else
             # TODO
             raise "Invalid set on account: Need nil, Account or Hash; got #{value.class}"

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

@@ -7,7 +7,16 @@ module Ecoportal
           :show_shortcuts,
           :show_coming_soon,
           :show_recently_visited_forms,
-          :show_tasks
+          :show_tasks,
+          :show_task_bubbles,
+          :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
         ].each do |field|
           define_method(field) do
             if doc.key?(field)

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

@@ -7,7 +7,10 @@ module Ecoportal
         include Enumerable
         include Common::DocHelpers
 
-        class_resolver :person_class,  "Ecoportal::API::V1::Person"
+        JOB_TIMEOUT = 60
+        DELAY_STATUS_CHECK = 5
+
+        class_resolver :person_class, "Ecoportal::API::V1::Person"
 
         attr_reader :client
 
@@ -19,7 +22,7 @@ module Ecoportal
 
         # Iterates all the people of the organization.
         # @note
-        #   - it ignores the key `results_from:` of `params:`.
+        #   - it ignores the key `cursor_id:` of `params:`.
         #   - `each` is called by `to_a`
         # @param params [Hash]
         # @option params [String] :per_page the number of people you get per request.
@@ -28,15 +31,15 @@ module Ecoportal
         # @yieldparam person [Person]
         def each(params: {}, &block)
           return to_enum(:each) unless block
-          results_from = nil          
+          cursor_id = nil
           loop do
-            params.update(results_from: results_from) if results_from
+            params.update(cursor_id: cursor_id) if cursor_id
             response = client.get("/people", params: params)
             raise "Request failed." unless response.success?
             response.body["results"].each do |person|
               yield person_class.new(person)
             end
-            break unless (results_from = response.body["next_results_from"])
+            break unless (cursor_id = response.body["cursor_id"])
           end
           self
         end
@@ -56,7 +59,7 @@ module Ecoportal
         # @param doc [String, Hash, Person] data containing an `id` (internal or external) of the target person.
         # @return [WrappedResponse] an object with the api response.
         def get(doc)
-          response = client.get("/people/"+CGI::escape(get_id(doc)))
+          response = client.get("/people/"+CGI.escape(get_id(doc)))
           Common::WrappedResponse.new(response, person_class)
         end
 
@@ -66,7 +69,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.
@@ -83,7 +86,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.
@@ -91,13 +94,14 @@ 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.
         # @yield [batch_op] adds multiple api requests for the current batch.
         # @yieldparam batch_op [BatchOperation]
-        def batch
+        def batch(job_mode: true, &block)
+          return job(&block) if job_mode
           operation = Common::BatchOperation.new("/people", person_class, logger: client.logger)
           yield operation
           # The batch operation is responsible for logging the output
@@ -108,12 +112,72 @@ module Ecoportal
           end
         end
 
+        def job
+          operation = Common::BatchOperation.new("/people", person_class, logger: client.logger)
+          yield operation
+          # The batch operation is responsible for logging the output
+          job_id = create_job(operation)
+          status = wait_for_job_completion(job_id)
+
+          if status&.complete?
+            operation.process_response job_result(job_id, operation)
+          else
+            raise "Job `#{job_id}` not complete. Probably timeout after #{JOB_TIMEOUT} seconds. Current status: #{status}"
+          end
+        end
+
         # Creates a new `Person` object.
         # @return [Person] new empty person object of the current version.
         def new
           person_class.new
         end
 
+        private
+
+        JobStatus = Struct.new(:id, :complete?, :errored?, :progress)
+        def job_status(job_id)
+          response = client.get("/people/job/#{CGI.escape(job_id)}/status")
+
+          raise "Status error" unless response.success?
+          JobStatus.new(
+            response.body["id"],
+            response.body["complete"],
+            response.body["errored"],
+            response.body["progress"]
+          )
+        end
+
+        def job_result(job_id, operation)
+          # The batch operation is responsible for logging the output
+          client.without_response_logging do
+            client.get("/people/job/#{CGI.escape(job_id)}").tap do |response|
+              operation.process_response(response)
+            end
+          end
+        end
+
+        def wait_for_job_completion(job_id)
+          # 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
+            status = job_status(job_id)
+            break status if status.complete?
+            break status if Time.now >= before + JOB_TIMEOUT
+            sleep(DELAY_STATUS_CHECK)
+            status
+          end
+        end
+
+        def create_job(operation)
+          job_id = nil
+          client.without_response_logging do
+            client.post("/people/job", data: operation.as_json).tap do |response|
+              job_id = response.body["id"]
+            end
+          end
+          job_id
+        end
       end
     end
   end

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

@@ -8,12 +8,14 @@ module Ecoportal
       # @attr_reader subordinates [Integer] the number of people this person is supervisor of.
       # @attr details [PersonDetails, nil] the details of the person or `nil` if missing.
       class Person < Common::BaseModel
-        passthrough :id, :external_id, :name, :email, :supervisor_id, :subordinates
+        passthrough :id, :external_id, :name, :email, :supervisor_id, :subordinates, :filter_tags, :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 &_'\/-]+$/
+
         # Gets the supervisor (`Person`) of this person, with given his `supervisor_id`.
         #
         # **Example Usage**:
@@ -39,6 +41,22 @@ module Ecoportal
           self.supervisor_id = person&.id || person&.external_id
         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}"
+          end
+          doc["filter_tags"] = value.map do |tag|
+            unless tag.match(VALID_TAG_REGEX)
+              raise "Invalid filter tag #{tag.inspect}"
+            end
+            tag.upcase
+          end
+        end
+
         def as_json
           super.merge "details" => details&.as_json
         end

data/lib/ecoportal/api/version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    VERSION = "0.4.3"
+    VERSION = "0.5.6"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.6
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-12 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,6 +92,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -123,14 +137,19 @@ dependencies:
 description: 
 email:
 - tapio@ecoportal.co.nz
+- rien@ecoportal.co.nz
+- oscar@ecoportal.co.nz
+- bozydar@ecoportal.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE