ecoportal-api 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70979654188cd5e24e5456f4f2a668e5327faac08574388d9336123cca93ee6a
-  data.tar.gz: e04b913a265037f1e57b7d52d606fd662eed8352459f2751b5c9a74f0dadccf6
+  metadata.gz: 4d25d42002423c85609bc9c4e436c614934239e62ae3b086f39c2073c0df925d
+  data.tar.gz: 53574533c9fe73a72c2eb2d8f5dd48f854e143482d3ce30a4acf2b1ebcdad63d
 SHA512:
-  metadata.gz: 3dc34740e68615fb0da65fe0c691b60af1a9c66f0b695d283645bb25757cbfecaef38b0f02dd19b9de280249b7e5e8e7ff62895fefe59cf6b8af0446844c68bb
-  data.tar.gz: 66a418368f6de049326e0fb7c3db9405acb57ecbbc8c2e3cc47b57aaf9212f8f0ec71be3958c2a03f2ce5607c306c8ed9ed2ec67b9709bdaf7b4a3f5f1c20563
+  metadata.gz: 9640f58bc1712869b3b2bacf7f6d3ec61afe439cdcf194ea8dacf29fba676f7828d2e2a636cea1ca919f0bf63a5687a3293c3e5148a8e77e9c32b66f2c0dcec9
+  data.tar.gz: 19059c77e63997094ab84d1b9f2f9ca14784001b37ebba753c7ed9bbad61dfab02e724bd38560add9a8e801f816af6cae0e20030e4a09f11186bf0cd78af4cfd

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

@@ -5,10 +5,11 @@ module Ecoportal
       class BatchOperation
         include Common::DocHelpers
 
-        def initialize(base_path, wrapper)
+        def initialize(base_path, wrapper, logger: nil)
           @base_path  = base_path
           @wrapper    = wrapper
           @operations = []
+          @logger     = logger
         end
 
         def as_json
@@ -20,21 +21,27 @@ module Ecoportal
         end
 
         def process_response(response)
-          raise "Total failure in batch operation" unless response.success?
+          unless response.success?
+            log(:error) { "Total failure in batch operation." }
+            raise "Total failure in batch operation"
+          end
 
-          response.body.each.with_index do |subresponse, idx|
-            next unless callback = @operations[idx][:callback]
+          log(:info) { "Processing batch responses" }
 
-            status = subresponse["status"]
-            body   = subresponse["response"]
-            method = @operations[idx][:method]
+          response.body.each.with_index do |subresponse, idx|
+            callback = @operations[idx][:callback]
+            status   = subresponse["status"]
+            body     = subresponse["response"]
+            method   = @operations[idx][:method]
 
             if status == 200 && method == "GET"
               batch_response = BatchResponse.new(status, body, @wrapper.new(body))
-              callback.call batch_response, batch_response.result
+              log_batch_response(@operations[idx], batch_response)
+              callback && callback.call(batch_response, batch_response.result)
             else
               batch_response = BatchResponse.new(status, body)
-              callback.call batch_response
+              log_batch_response(@operations[idx], batch_response)
+              callback && callback.call(batch_response)
             end
           end
         end
@@ -88,6 +95,19 @@ module Ecoportal
             callback: block_given? && Proc.new
           }
         end
+
+        private
+
+        def log_batch_response(operation, response)
+          level = response.success?? :debug : :warn
+          log(:info) { "BATCH #{operation[:method]} #{operation[:path]}" }
+          log(:info) { "Status #{response.status}" }
+          log(level) { "Response: #{JSON.pretty_generate(response.body)}" }
+        end
+
+        def log(level, &block)
+          @logger.send(level, &block) if @logger
+        end
       end
     end
   end

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

@@ -4,12 +4,12 @@ module Ecoportal
       class BatchResponse
         attr_reader :status, :body, :result
         def initialize(status, body, result = nil)
-          @status = status
+          @status = HTTP::Response::Status.new(status)
           @body   = body
           @result = result
         end
         def success?
-          (0..299).include?(status)
+          status.success?
         end
         def each
           [*@result].each do |doc|

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

@@ -3,6 +3,8 @@ module Ecoportal
   module API
     module Common
       class Client
+        attr_accessor :logger
+
         def initialize(api_key:, version: "v1", host: "live.ecoportal.com", logger: nil)
           @version  = version
           @api_key  = api_key
@@ -13,7 +15,10 @@ module Ecoportal
             @base_uri = "https://#{host}/api/"
           end
           log(:info) { "#{version} client initialized pointing at #{host}" }
-          log(:info) { "Api-key: #{@api_key}" }
+          if @api_key.nil? || @api_key.match(/\A\W*\z/)
+            log(:error) { "Api-key missing!" }
+          end
+          @response_logging_enabled = true
         end
 
         def log(level, &block)
@@ -68,6 +73,15 @@ module Ecoportal
           @base_uri+@version+path
         end
 
+        def without_response_logging(&block)
+          begin
+            @response_logging_enabled = false
+            yield self
+          ensure
+            @response_logging_enabled = true
+          end
+        end
+
         private
 
         def instrument(method, path, data = nil)
@@ -81,7 +95,7 @@ module Ecoportal
             end
             log(result.success?? :debug : :warn) do
               "Response: #{JSON.pretty_generate(result.body)}"
-            end
+            end if @response_logging_enabled
           end
         end
       end

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

@@ -53,10 +53,13 @@ module Ecoportal
         end
 
         def batch
-          operation = Common::BatchOperation.new("/people", person_class)
+          operation = Common::BatchOperation.new("/people", person_class, logger: @client.logger)
           yield operation
-          @client.post("/people/batch", data: operation.as_json).tap do |response|
-            operation.process_response(response)
+          # The batch operation is responsible for logging the output
+          @client.without_response_logging do
+            @client.post("/people/batch", data: operation.as_json).tap do |response|
+              operation.process_response(response)
+            end
           end
         end
 

data/lib/ecoportal/api/version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    VERSION = "0.3.4"
+    VERSION = "0.3.5"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Tapio Saarinen