ecoportal-api 0.8.5 → 0.9.2

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

@@ -1,112 +1,112 @@
-require 'elastic-apm'
-module Ecoportal
-  module API
-    module Common
-      module ElasticApmIntegration
-
-        class UnexpectedServerError < StandardError
-          def initialize(code, msg)
-            super("Code: #{code} -- Error: #{msg}")
-          end
-        end
-
-        APM_SERVICE_NAME = 'ecoportal-api-gem'
-
-        # Log only errors that are only server's responsibility
-        def log_unexpected_server_error(response)
-          raise "Expecting Ecoportal::API::Common::Response. Given: #{response.class}" unless response.is_a?(Common::Response)
-          return nil unless elastic_apm_service
-          return nil unless unexpected_server_error?(response.status)
-          if ElasticAPM.running?
-            ElasticAPM.report(UnexpectedServerError.new(response.status, response.body))
-          end
-        end
-
-        private
-
-        def unexpected_server_error?(code)
-          !code || ((code >= 500) && (code <= 599)) || (code <= 99)
-        end
-
-        # finalizer to stop the agent
-        close_elastic_apm = Proc.new do |id|
-          begin
-            if ElasticAPM.running?
-              puts "Stopping ElasticAPM service"
-              ElasticAPM.stop
-            end
-          rescue StandardError => e
-            # Silent
-          end
-        end
-        ObjectSpace.define_finalizer("ElasticAPM", close_elastic_apm)
-
-        def elastic_apm_service
-          return false if @disable_apm
-          begin
-            ElasticAPM.start(**elastic_apm_options) unless ElasticAPM.running?
-          rescue StandardError => e
-            @disable_apm = true
-            puts "ElasticAPM services not available: #{e}"
-          end
-        end
-
-        def elastic_apm_options
-          {
-            service_name: APM_SERVICE_NAME,
-            server_url:   elastic_apm_url,
-            secret_token: elastic_apm_key,
-            environment:  environment,
-            #http_compression: false,
-            transaction_sample_rate:  0.1,
-            transaction_max_spans:    100,
-            span_frames_min_duration: "5ms"
-          }.tap do |options|
-            options.merge!({
-              log_level: Logger::DEBUG,
-              log_path:  File.join(__dir__, "elastic_apm.log")
-            }) if false
-          end
-        end
-
-        def elastic_apm_url
-          @elastic_apm_url ||= "https://".tap do |url|
-            url << "#{elastic_apm_account_id}"
-            url << ".#{elastic_apm_base_url}"
-            url << ":#{elastic_apm_port}"
-          end
-        end
-
-        def elastic_apm_key
-          @elastic_apm_key ||= ENV['ELASTIC_APM_KEY']
-        end
-
-        def elastic_apm_account_id
-          @elastic_apm_account_id ||= ENV['ELASTIC_APM_ACCOUNT_ID']
-        end
-
-        def elastic_apm_base_url
-          @elastic_apm_base_url ||= "apm.#{elastic_apm_region}.aws.cloud.es.io"
-        end
-
-        def elastic_apm_region
-          @elastic_apm_region ||= ENV['ELASTIC_APM_REGION'] || "ap-southeast-2"
-        end
-
-
-        def elastic_apm_port
-          @elastic_apm_port ||= ENV['ELASTIC_APM_PORT'] || "443"
-        end
-
-        def environment
-          @environment ||= "unknown".tap do |value|
-            if instance_variable_defined?(:@host) && env = @host.gsub(".ecoportal.com", '')
-              value.clear << env
-            end
-          end
-        end
-
-      end
-    end
-  end
-end
+require 'elastic-apm'
+module Ecoportal
+  module API
+    module Common
+      module ElasticApmIntegration
+
+        class UnexpectedServerError < StandardError
+          def initialize(code, msg)
+            super("Code: #{code} -- Error: #{msg}")
+          end
+        end
+
+        APM_SERVICE_NAME = 'ecoportal-api-gem'
+
+        # Log only errors that are only server's responsibility
+        def log_unexpected_server_error(response)
+          raise "Expecting Ecoportal::API::Common::Response. Given: #{response.class}" unless response.is_a?(Common::Response)
+          return nil unless elastic_apm_service
+          return nil unless unexpected_server_error?(response.status)
+          if ElasticAPM.running?
+            ElasticAPM.report(UnexpectedServerError.new(response.status, response.body))
+          end
+        end
+
+        private
+
+        def unexpected_server_error?(code)
+          !code || ((code >= 500) && (code <= 599)) || (code <= 99)
+        end
+
+        # finalizer to stop the agent
+        close_elastic_apm = Proc.new do |id|
+          begin
+            if ElasticAPM.running?
+              puts "Stopping ElasticAPM service"
+              ElasticAPM.stop
+            end
+          rescue StandardError => e
+            # Silent
+          end
+        end
+        ObjectSpace.define_finalizer("ElasticAPM", close_elastic_apm)
+
+        def elastic_apm_service
+          return false if @disable_apm
+          begin
+            ElasticAPM.start(**elastic_apm_options) unless ElasticAPM.running?
+          rescue StandardError => e
+            @disable_apm = true
+            puts "ElasticAPM services not available: #{e}"
+          end
+        end
+
+        def elastic_apm_options
+          {
+            service_name: APM_SERVICE_NAME,
+            server_url:   elastic_apm_url,
+            secret_token: elastic_apm_key,
+            environment:  environment,
+            #http_compression: false,
+            transaction_sample_rate:  0.1,
+            transaction_max_spans:    100,
+            span_frames_min_duration: "5ms"
+          }.tap do |options|
+            options.merge!({
+              log_level: Logger::DEBUG,
+              log_path:  File.join(__dir__, "elastic_apm.log")
+            }) if false
+          end
+        end
+
+        def elastic_apm_url
+          @elastic_apm_url ||= "https://".tap do |url|
+            url << "#{elastic_apm_account_id}"
+            url << ".#{elastic_apm_base_url}"
+            url << ":#{elastic_apm_port}"
+          end
+        end
+
+        def elastic_apm_key
+          @elastic_apm_key ||= ENV['ELASTIC_APM_KEY']
+        end
+
+        def elastic_apm_account_id
+          @elastic_apm_account_id ||= ENV['ELASTIC_APM_ACCOUNT_ID']
+        end
+
+        def elastic_apm_base_url
+          @elastic_apm_base_url ||= "apm.#{elastic_apm_region}.aws.cloud.es.io"
+        end
+
+        def elastic_apm_region
+          @elastic_apm_region ||= ENV['ELASTIC_APM_REGION'] || "ap-southeast-2"
+        end
+
+
+        def elastic_apm_port
+          @elastic_apm_port ||= ENV['ELASTIC_APM_PORT'] || "443"
+        end
+
+        def environment
+          @environment ||= "unknown".tap do |value|
+            if instance_variable_defined?(:@host) && env = @host.gsub(".ecoportal.com", '')
+              value.clear << env
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,41 +1,41 @@
-module Ecoportal
-  module API
-    module Common
-      module HashDiff
-        ID_KEYS = %w[id]
-
-        class << self
-
-          def diff(a, b, ignore: [])
-            case a
-            when Hash
-              {}.tap do |diffed|
-                a.each do |key, a_value|
-                  b_value    = b && b[key]
-                  no_changes = (a_value == b_value) || ignore.include?(key)
-                  next if !ID_KEYS.include?(key) && no_changes
-                  diffed[key] = diff(a_value, b_value, ignore: ignore)
-                  diffed.delete(key) if diffed[key] == {}
-                end
-                # All keys are IDs, so it's actually blank
-                if (diffed.keys - ID_KEYS).empty?
-                  return {}
-                end
-              end
-            when Array
-              return a unless b.is_a?(Array) && a.length == b.length
-              a.map.with_index do |a_value, idx|
-                b_value = b[idx]
-                diff(a_value, b_value, ignore: ignore)
-              end.reject do |el|
-                el == {}
-              end
-            else
-              a
-            end
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    module Common
+      module HashDiff
+        ID_KEYS = %w[id]
+
+        class << self
+
+          def diff(a, b, ignore: [])
+            case a
+            when Hash
+              {}.tap do |diffed|
+                a.each do |key, a_value|
+                  b_value    = b && b[key]
+                  no_changes = (a_value == b_value) || ignore.include?(key)
+                  next if !ID_KEYS.include?(key) && no_changes
+                  diffed[key] = diff(a_value, b_value, ignore: ignore)
+                  diffed.delete(key) if diffed[key] == {}
+                end
+                # All keys are IDs, so it's actually blank
+                if (diffed.keys - ID_KEYS).empty?
+                  return {}
+                end
+              end
+            when Array
+              return a unless b.is_a?(Array) && a.length == b.length
+              a.map.with_index do |a_value, idx|
+                b_value = b[idx]
+                diff(a_value, b_value, ignore: ignore)
+              end.reject do |el|
+                el == {}
+              end
+            else
+              a
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,12 +1,12 @@
-module Ecoportal
-  module API
-    module Common
-      module Logging
-        private
-        def default_logger
-          Ecoportal::API::Logger.new
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    module Common
+      module Logging
+        private
+        def default_logger
+          Ecoportal::API::Logger.new
+        end
+      end
+    end
+  end
+end

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

@@ -1,31 +1,31 @@
-module Ecoportal
-  module API
-    module Common
-      class Response
-
-        attr_reader :status, :body
-
-        def initialize(response)
-          @status = response.status
-          @body   = [].tap do |body_data|
-            response.body.each do |chunk|
-              body_data << chunk
-            end
-          end.join("")
-          @body   = JSON.parse(@body.to_s) rescue nil
-          response
-        end
-
-        def success?
-          @status.success?
-        end
-
-        def print_pretty
-          puts "Status: #{@status.code}"
-          puts "Body:"
-          puts JSON.pretty_generate(@body)
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    module Common
+      class Response
+
+        attr_reader :status, :body
+
+        def initialize(response)
+          @status = response.status
+          @body   = [].tap do |body_data|
+            response.body.each do |chunk|
+              body_data << chunk
+            end
+          end.join("")
+          @body   = JSON.parse(@body.to_s) rescue nil
+          response
+        end
+
+        def success?
+          @status.success?
+        end
+
+        def print_pretty
+          puts "Status: #{@status.code}"
+          puts "Body:"
+          puts JSON.pretty_generate(@body)
+        end
+      end
+    end
+  end
+end

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

@@ -1,54 +1,54 @@
-module Ecoportal
-  module API
-    module Common
-      class WrappedResponse
-        include Enumerable
-
-        attr_reader :response, :result
-
-        def initialize(response, klass)
-          @response = response
-          @klass    = klass
-
-          if @response.success?
-            @result =
-              if @response.body.is_a?(Array)
-                @response.body.map do |doc|
-                  @klass.new(doc)
-                end
-              else
-                @klass.new(@response.body)
-              end
-          end
-        end
-
-        def body
-          response.body.to_s
-        end
-
-        def each
-          [*result].each do |doc|
-            yield doc
-          end
-        end
-
-        def status
-          response.status.code
-        end
-
-        def success?
-          response.success?
-        end
-
-        def print_pretty
-          if success?
-            each(&:print_pretty)
-          else
-            puts "Request failed."
-          end
-        end
-
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    module Common
+      class WrappedResponse
+        include Enumerable
+
+        attr_reader :response, :result
+
+        def initialize(response, klass)
+          @response = response
+          @klass    = klass
+
+          if @response.success?
+            @result =
+              if @response.body.is_a?(Array)
+                @response.body.map do |doc|
+                  @klass.new(doc)
+                end
+              else
+                @klass.new(@response.body)
+              end
+          end
+        end
+
+        def body
+          response.body.to_s
+        end
+
+        def each
+          [*result].each do |doc|
+            yield doc
+          end
+        end
+
+        def status
+          response.status.code
+        end
+
+        def success?
+          response.success?
+        end
+
+        def print_pretty
+          if success?
+            each(&:print_pretty)
+          else
+            puts "Request failed."
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ecoportal/api/common.rb

@@ -1,18 +1,18 @@
-module Ecoportal
-  module API
-    module Common
-    end
-  end
-end
-
-require 'ecoportal/api/common/base_class'
-require 'ecoportal/api/common/hash_diff'
-require 'ecoportal/api/common/base_model'
-require 'ecoportal/api/common/doc_helpers'
-require 'ecoportal/api/common/logging'
-require 'ecoportal/api/common/elastic_apm_integration'
-require 'ecoportal/api/common/client'
-require 'ecoportal/api/common/response'
-require 'ecoportal/api/common/wrapped_response'
-require 'ecoportal/api/common/batch_response'
-require 'ecoportal/api/common/batch_operation'
+module Ecoportal
+  module API
+    module Common
+    end
+  end
+end
+
+require 'ecoportal/api/common/base_class'
+require 'ecoportal/api/common/hash_diff'
+require 'ecoportal/api/common/base_model'
+require 'ecoportal/api/common/doc_helpers'
+require 'ecoportal/api/common/logging'
+require 'ecoportal/api/common/elastic_apm_integration'
+require 'ecoportal/api/common/client'
+require 'ecoportal/api/common/response'
+require 'ecoportal/api/common/wrapped_response'
+require 'ecoportal/api/common/batch_response'
+require 'ecoportal/api/common/batch_operation'

data/lib/ecoportal/api/errors/base.rb

@@ -1,8 +1,8 @@
-module Ecoportal
-  module API
-    module Errors
-      class Base < StandardError
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    module Errors
+      class Base < StandardError
+      end
+    end
+  end
+end

data/lib/ecoportal/api/errors/time_out.rb

@@ -1,8 +1,8 @@
-module Ecoportal
-  module API
-    module Errors
-      class TimeOut < Errors::Base
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    module Errors
+      class TimeOut < Errors::Base
+      end
+    end
+  end
+end

data/lib/ecoportal/api/errors.rb

@@ -1,9 +1,9 @@
-module Ecoportal
-  module API
-    module Errors
-    end
-  end
-end
-
-require 'ecoportal/api/errors/base'
-require 'ecoportal/api/errors/time_out'
+module Ecoportal
+  module API
+    module Errors
+    end
+  end
+end
+
+require 'ecoportal/api/errors/base'
+require 'ecoportal/api/errors/time_out'