aws-xray 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5206b637f5168433db8876d3d0c80652a3593ac2
-  data.tar.gz: e9e0ab2d86436141fbaea9b0145f05c2e43c007b
+  metadata.gz: b263ae80bfea7fa1cee9f95c26d5ca57dd136098
+  data.tar.gz: ce94410321f8fa5a3b29219d6e17f12b0f004e36
 SHA512:
-  metadata.gz: 772cdd8ee4b5e722b373ebbaaba3203f44f514a263f6db70b8773c83a877ff858ae898f97bf9041245a516d31e4a91e1ca36400e8f900198abfb8b963867219d
-  data.tar.gz: 9a1c16c6676a6f8cb0aadbafd97a41efca10032ca47391334eb8a31449c2618e56bc37683f7137d42211994f6f86e2cd2b95120273283b52f3ca1826ca92fecb
+  metadata.gz: 45715f823e2b871f17826b85e37cf7e02885de7669423bacbf33d17fc227db01de3807c81cc3c932ea1bb6770621637587bf4150ef8736cd4f44bc5fdbaf919a
+  data.tar.gz: dba1945e5aa2130fb1a1add974475407ec492bafaeda31a885de9e50da21cae022774a4bc249bd61d33528bb8321c8321690fd7c07c983555ea0d0d3839a92f3

data/lib/aws/xray/annotation_normalizer.rb

@@ -0,0 +1,37 @@
+module Aws
+  module Xray
+    # For specification: http://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html
+    module AnnotationNormalizer
+      extend self
+
+      # @param [Hash] h annotation hash.
+      # @return [Hash]
+      def call(h)
+        h.inject({}) {|init, (k, v)| init[normalize_key(k)] = normalize_value(v); init }
+      end
+
+      private
+
+      INVALID_PATTERN = /[^A-Za-z0-9_]+/
+      # - Convert keys which including '-' to '_'
+      #   because it might be common pit-fall.
+      # - Remove invalid chars.
+      def normalize_key(k)
+        k.to_s.gsub('-', '_').gsub(INVALID_PATTERN, '').to_sym
+      end
+
+      def normalize_value(v)
+        case v
+        when nil
+          nil
+        when Integer, Float
+          v
+        when true, false
+          v
+        else
+          v.to_s
+        end
+      end
+    end
+  end
+end

data/lib/aws/xray/configuration.rb

@@ -1,5 +1,5 @@
 require 'socket'
-require 'aws/xray/annotation_validator'
+require 'aws/xray/annotation_normalizer'
 
 module Aws
   module Xray
@@ -59,8 +59,7 @@ module Aws
       end
       # @param [Hash] h default annotation Hash.
       def default_annotation=(annotation)
-        AnnotationValidator.call(annotation)
-        @default_annotation = annotation
+        @default_annotation = AnnotationNormalizer.call(annotation)
       end
 
       DEFAULT_METADATA = {

data/lib/aws/xray/segment.rb

@@ -3,7 +3,7 @@ require 'securerandom'
 require 'aws/xray/request'
 require 'aws/xray/response'
 require 'aws/xray/error'
-require 'aws/xray/annotation_validator'
+require 'aws/xray/annotation_normalizer'
 
 module Aws
   module Xray
@@ -55,8 +55,7 @@ module Aws
       # @param [Hash] annotation Keys must consist of only alphabets and underscore.
       #   Values must be one of String or Integer or Boolean values.
       def set_annotation(annotation)
-        AnnotationValidator.call(annotation)
-        @annotation = @annotation.merge(annotation)
+        @annotation = @annotation.merge(AnnotationNormalizer.call(annotation))
       end
 
       # @param [Hash] metadata

data/lib/aws/xray/version.rb

@@ -1,5 +1,5 @@
 module Aws
   module Xray
-    VERSION = '0.8.1'
+    VERSION = '0.9.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-xray
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Taiki Ono
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-31 00:00:00.000000000 Z
+date: 2017-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -122,7 +122,7 @@ files:
 - example/user_app_config.ru
 - lib/aws-xray.rb
 - lib/aws/xray.rb
-- lib/aws/xray/annotation_validator.rb
+- lib/aws/xray/annotation_normalizer.rb
 - lib/aws/xray/cause.rb
 - lib/aws/xray/client.rb
 - lib/aws/xray/configuration.rb

data/lib/aws/xray/annotation_validator.rb

@@ -1,16 +0,0 @@
-module Aws
-  module Xray
-    module AnnotationValidator
-      extend self
-
-      # @param [Hash] h annotation hash.
-      # @raise RuntimeError
-      def call(h)
-        invalid_keys = h.keys.reject {|k| k.to_s.match(/\A[A-Za-z0-9_]+\z/) }
-        raise 'Keys must be alphanumeric and underscore string' unless invalid_keys.empty?
-        invalid_values = h.values.reject {|v| v.is_a?(String) || v.is_a?(Integer) || (v == true || v == false) }
-        raise 'Values must be one of String or Integer or Boolean values' unless invalid_values.empty?
-      end
-    end
-  end
-end