atatus 1.3.0 → 1.4.0

data/lib/atatus/config/bytes.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module Atatus

data/lib/atatus/config/duration.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module Atatus

data/lib/atatus/config/options.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module Atatus
@@ -33,9 +50,9 @@ module Atatus
 
         private
 
-        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+        # rubocop:disable Metrics/CyclomaticComplexity
         def normalize(val)
-          return unless val
+          return if val.nil?
 
           if @converter
             return @converter.call(val)
@@ -48,12 +65,13 @@ module Atatus
           when :bool then normalize_bool(val)
           when :list then normalize_list(val)
           when :dict then normalize_dict(val)
+          when :url then normalize_url(val)
           else
             # raise "Unknown options type '#{type.inspect}'"
             val
           end
         end
-        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength
+        # rubocop:enable Metrics/CyclomaticComplexity
 
         def normalize_bool(val)
           return val unless val.is_a?(String)
@@ -69,6 +87,11 @@ module Atatus
           return val unless val.is_a?(String)
           Hash[val.split(/[&,]/).map { |kv| kv.split('=') }]
         end
+
+        def normalize_url(val)
+          val = val.to_s
+          val.end_with?('/') ? val.chomp('/') : val
+        end
       end
 
       # @api private
@@ -77,9 +100,8 @@ module Atatus
           @schema ||= {}
         end
 
-        def option(*args)
-          key = args.shift
-          schema[key] = *args
+        def option(key, **args)
+          schema[key] = args
         end
       end
 
@@ -87,11 +109,10 @@ module Atatus
       module InstanceMethods
         def load_schema
           Hash[self.class.schema.map do |key, args|
-            [key, Option.new(key, *args)]
+            [key, Option.new(key, **args)]
           end]
         end
 
-        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         def method_missing(name, *value)
           name_str = name.to_s
 
@@ -110,7 +131,6 @@ module Atatus
             super
           end
         end
-        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
         def [](key)
           options[key]

data/lib/atatus/config/regexp_list.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module Atatus

data/lib/atatus/config/wildcard_pattern_list.rb

@@ -0,0 +1,64 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+module Atatus
+  class Config
+    # @api private
+    class WildcardPatternList
+      # @api private
+      class WildcardPattern
+        def initialize(str)
+          @pattern = convert(str)
+        end
+
+        def match?(other)
+          !!@pattern.match(other)
+        end
+
+        alias :match :match?
+
+        private
+
+        def convert(str)
+          case_sensitive = false
+
+          if str.start_with?('(?-i)')
+            str = str.gsub(/^\(\?-\i\)/, '')
+            case_sensitive = true
+          end
+
+          parts =
+            str.chars.each_with_object([]) do |char, arr|
+              arr << (char == '*' ? '.*' : Regexp.escape(char))
+            end
+
+          Regexp.new(
+            '\A' + parts.join + '\Z',
+            case_sensitive ? nil : Regexp::IGNORECASE
+          )
+        end
+      end
+
+      def call(value)
+        value = value.is_a?(String) ? value.split(',') : Array(value)
+        value.map(&WildcardPattern.method(:new))
+      end
+    end
+  end
+end

data/lib/atatus/context.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 require 'atatus/context/request'
@@ -9,25 +26,39 @@ require 'atatus/context/user'
 module Atatus
   # @api private
   class Context
-    def initialize(custom: {}, labels: {}, user: nil)
+    def initialize(custom: {}, labels: {}, user: nil, service: nil)
       @custom = custom
       @labels = labels
       @user = user || User.new
+      @service = service
     end
 
+    Service = Struct.new(:framework)
+    Framework = Struct.new(:name, :version)
+
     attr_accessor :request
     attr_accessor :response
     attr_accessor :user
     attr_reader :custom
     attr_reader :labels
+    attr_reader :service
 
+    # rubocop:disable Metrics/CyclomaticComplexity
     def empty?
       return false if labels.any?
       return false if custom.any?
       return false if user.any?
+      return false if service
       return false if request || response
 
       true
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
+
+    def set_service(framework_name: nil, framework_version: nil)
+      @service = Service.new(
+        Framework.new(framework_name, framework_version)
+      )
+    end
   end
 end

data/lib/atatus/context/request.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module Atatus

data/lib/atatus/context/request/socket.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module Atatus
@@ -8,7 +25,7 @@ module Atatus
       # @api private
       class Socket
         def initialize(req)
-          @remote_addr = req.ip
+          @remote_addr = req.env['REMOTE_ADDR']
           @encrypted = req.scheme == 'https'
         end
 

data/lib/atatus/context/request/url.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module Atatus

data/lib/atatus/context/response.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module Atatus
@@ -11,12 +28,20 @@ module Atatus
         finished: true
       )
         @status_code = status_code
-        @headers = headers
         @headers_sent = headers_sent
         @finished = finished
+
+        self.headers = headers
       end
 
-      attr_accessor :status_code, :headers, :headers_sent, :finished
+      attr_accessor :status_code, :headers_sent, :finished
+      attr_reader :headers
+
+      def headers=(headers)
+        @headers = headers&.each_with_object({}) do |(k, v), hsh|
+          hsh[k] = v.to_s
+        end
+      end
     end
   end
 end

data/lib/atatus/context/user.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module Atatus

data/lib/atatus/context_builder.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module Atatus
@@ -20,7 +37,6 @@ module Atatus
 
     private
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def apply_to_request(context, rack_env:, for_type:)
       req = rails_req?(rack_env) ? rack_env : Rack::Request.new(rack_env)
 
@@ -38,11 +54,10 @@ module Atatus
       request.headers = headers if config.capture_headers?
       request.env = env if config.capture_env?
 
-      request.cookies = req.cookies
+      request.cookies = req.cookies.dup
 
       context
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     def should_capture_body?(for_type)
       option = config.capture_body
@@ -61,7 +76,7 @@ module Atatus
       else
         body = req.body.read
         req.body.rewind
-        body.byteslice(0, MAX_BODY_LENGTH).force_encoding('utf-8')
+        body.byteslice(0, MAX_BODY_LENGTH).force_encoding('utf-8').scrub
       end
     end