ecoportal-api 0.5.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7169c71eba9b00510c284c1561fea403cdecb456cf929b4039f27d758a47801c
-  data.tar.gz: e160bb67d93052c68be9cfb33b3cdc9e582aceaa0685309021ffa24d1af14cfd
+  metadata.gz: a89994e76cf541159975756271aa254c709696347e1a5eb9b2181dbea8b54d25
+  data.tar.gz: 4ef1d5c9ad068faad4922fac5dae85f6fc6e629271b0680c1ee5010a4aadf424
 SHA512:
-  metadata.gz: 6e2c2aa49ba1f1a1b1492bce6933df97a142ad3b05f102697607b58307361d2349cbb076bf5e2ffbb734cc6582e83effc897497a549746c8e1ddb653d95d2df1
-  data.tar.gz: d414cf5182137cecf1e82a7289af347ad1329ea4c917abe14879672788359189a496c8896e9049ad2e18fb504920f945c849e1b0021bb5cdb21d0d9745f071c7
+  metadata.gz: 21db065f98ef0aa1afe59b5b4766474691eaad98c78d0175f7d1161585f8f8bfa07426ee9edd4f056439e5dffc1d94bd608a2124411bd68fc051537b11048aa5
+  data.tar.gz: 32b98b96710d3147ab2fde5f32b982e2d8a3ea234cd8c2c1eb707bdb98cf46a62a9f905caae2cfeb2889b62793bb1285c5c8215598da917f7ff944f951328828

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/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"
@@ -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/preferences.rb

@@ -7,7 +7,8 @@ module Ecoportal
           :show_shortcuts,
           :show_coming_soon,
           :show_recently_visited_forms,
-          :show_tasks
+          :show_tasks,
+          :show_task_bubbles
         ].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
 
@@ -28,7 +31,7 @@ module Ecoportal
         # @yieldparam person [Person]
         def each(params: {}, &block)
           return to_enum(:each) unless block
-          results_from = nil          
+          results_from = nil
           loop do
             params.update(results_from: results_from) if results_from
             response = client.get("/people", params: params)
@@ -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/version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    VERSION = "0.5.1"
+    VERSION = "0.5.3"
   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.3
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-01 00:00:00.000000000 Z
+date: 2019-10-16 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
@@ -125,12 +139,14 @@ 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"
 - Gemfile
@@ -199,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: A collection of helpers for interacting with the ecoPortal MS's various APIs