ecoportal-api 0.5.1 → 0.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7169c71eba9b00510c284c1561fea403cdecb456cf929b4039f27d758a47801c
-  data.tar.gz: e160bb67d93052c68be9cfb33b3cdc9e582aceaa0685309021ffa24d1af14cfd
+  metadata.gz: 168542de09c5a87edcd4952acdf84cdf01944c03339238a27c310e29b71e9c14
+  data.tar.gz: 2f43b32d289f6232eccff32516717ab82cd86cbe0144d6f8f2eac74f30637cd8
 SHA512:
-  metadata.gz: 6e2c2aa49ba1f1a1b1492bce6933df97a142ad3b05f102697607b58307361d2349cbb076bf5e2ffbb734cc6582e83effc897497a549746c8e1ddb653d95d2df1
-  data.tar.gz: d414cf5182137cecf1e82a7289af347ad1329ea4c917abe14879672788359189a496c8896e9049ad2e18fb504920f945c849e1b0021bb5cdb21d0d9745f071c7
+  metadata.gz: 1c539315189039d7baed7c48db646969525a47d51cdd88b63a2ac53b651f089aa6e219fa91624943700c1c73144525d9482f4cff8b9e1ca5cbbc9862c0a138e4
+  data.tar.gz: 3c145a2fcea2c476fb39ad914b6b3ec2ff390ffe5378ab9795ddd466238f0af55fbbae59a5e87cadb415a49165cf0e05d6697e45dc74bd6235581c30268d1e45

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,34 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+## [0.5.8] - 2020-06-23
+
+### Added
+### Changed
+### Fixed
+- `Ecoportal::API::V1::Person#filter_tags=`: `original_doc["filter_tags"]` is `nil` when creating a person
+- `Ecoportal::API::Internal::Account#policy_group_ids=`: `original_doc["account"]` is `nil` when creating a person
+
+
+## [0.5.7] - 2020-06-22
+
+### Added
+  - `Ecoportal::API::V1::PersonSchema`: added `enable_tags` & `tags` properties
+  - `Ecoportal::API::Internal::Preferences`: added missing fields for **kiosk**
+### Changed
+  - `Ecoportal::API::V1::People::JOB_TIMEOUT`: from 1 minute to 3 minutes
+  - `Ecoportal::API::V1::Person#filter_tags=`: will preserve the original order of the matching tags
+    * this change is to prevent `as_update` to generate false update positives
+  - `Ecoportal::API::Internal::Account#policy_group_ids=`: will preserve the original order of the matching ids
+    * this change is to prevent `as_update` to generate false update positives
+### Fixed
+  - `Ecoportal::API::Internal::Preferences`: access `doc` using string keys (not with `symbol` keys)
+
+
+## [0.5.6] - 2020-06-08
+
+### 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", "rien@ecoportal.co.nz", "oscar@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"
@@ -20,11 +20,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler",   "~> 1.16"
-  spec.add_development_dependency "rake",      "~> 10.0"
-  spec.add_development_dependency "rspec",     "~> 3.0"
+  spec.add_development_dependency "bundler",   "~> 2.1", ">= 2.1.3"
+  spec.add_development_dependency "rake",      "~> 12.0"
+  spec.add_development_dependency "rspec",     "~> 3",   ">= 3.9"
   spec.add_development_dependency "yard",      "~> 0.9", ">= 0.9.18"
-  spec.add_development_dependency "redcarpet", "~> 3.4", ">= 3.4.0"
+  spec.add_development_dependency "redcarpet", "~> 3.5", ">= 3.5.0"
+  spec.add_development_dependency "pry"
 
   spec.add_dependency 'http',          '~> 3'
   spec.add_dependency 'hash-polyfill', '~> 0'

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

@@ -12,6 +12,17 @@ module Ecoportal
         embeds_one  :permissions, key: "permissions_custom", klass: :permissions_class
         embeds_one  :preferences, klass: :preferences_class
 
+        # Sets the `policy_group_ids`
+        def policy_group_ids=(value)
+          unless value.is_a?(Array)
+            raise "policy_group_ids= needs to be passed an Array, got #{value.class}"
+          end
+
+          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)
+        end
+
         # 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.

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

@@ -7,8 +7,17 @@ module Ecoportal
           :show_shortcuts,
           :show_coming_soon,
           :show_recently_visited_forms,
-          :show_tasks
-        ].each do |field|
+          :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
+        ].map(&:to_s).each do |field|
           define_method(field) do
             if doc.key?(field)
               doc[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 = 240
+        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,7 +8,7 @@ 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, :filter_tags
+        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"
@@ -49,12 +49,16 @@ module Ecoportal
           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|
+          end_tags = value.map do |tag|
             unless tag.match(VALID_TAG_REGEX)
               raise "Invalid filter tag #{tag.inspect}"
             end
             tag.upcase
           end
+
+          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)
         end
 
         def as_json

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

@@ -3,6 +3,7 @@ module Ecoportal
     class V1
       class PersonSchema < Common::BaseModel
         passthrough :id, :name
+        passthrough :enable_tags, :tags
 
         class_resolver :schema_field_class, "Ecoportal::API::V1::SchemaField"
 

data/lib/ecoportal/api/version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    VERSION = "0.5.1"
+    VERSION = "0.5.8"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.8
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-01 00:00:00.000000000 Z
+date: 2020-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,42 +16,54 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -78,20 +90,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.5.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.5.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
+- !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
@@ -125,14 +151,17 @@ 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