stackdriver-core 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4bb62b8cdb5f28de4f303da6a8ff2e0a31d6cbcd
-  data.tar.gz: 2e6eda3a499805fef92f27a3d0b5167d8d508e31
+SHA256:
+  metadata.gz: 6c6ef552f209b36ad5abc3ccbad6df179289ce5632b031fe33380aeea6dd695d
+  data.tar.gz: 4cfb1f1ff935e105789df3d93420cf788a08acf7939b6c7b5f1fc8eca4083b86
 SHA512:
-  metadata.gz: 122c12d22560686b2a45f63aca85b33d68876d5d3a513dc5bf8deef952fa060dd4065f948447dc096ef96ec0e29102fb70d429bbdba0b18becda93c141e2faa8
-  data.tar.gz: c88f340bd0a325928c9d94d2587e8c7c72a38f1735631416541070a1b8ed30999b725b871bbca1e5580d8baeaff451708ed4c3c761f3a206e1500ef9e44c4037
+  metadata.gz: af74f8cd44085dad4f62c112ad2c0d7ef041583e04f4b4d575a16c01b6308258b98ab91468b9a7fec9305dfa0433bf063c3c7ecf3bb7c7ed19a2c9a4ea35bc94
+  data.tar.gz: 82d6b7a67de239556611a318aa979deba3efeba24bc300b68ca000e4837ab98395afa52b9535a04b52cab676730c2ceb0b209627b280f77b470fda6ad049a079

data/LICENSE

@@ -1,6 +1,6 @@
                                  Apache License
                            Version 2.0, January 2004
-                        http://www.apache.org/licenses/
+                        https://www.apache.org/licenses/
 
    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
@@ -192,7 +192,7 @@
    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
+       https://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,

data/lib/stackdriver-core.rb

@@ -1,10 +1,10 @@
-# Copyright 2016 Google Inc. All rights reserved.
+# Copyright 2016 Google LLC
 #
 # Licensed 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
+#     https://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,

data/lib/stackdriver/core.rb

@@ -1,10 +1,10 @@
-# Copyright 2016 Google Inc. All rights reserved.
+# Copyright 2016 Google LLC
 #
 # Licensed 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
+#     https://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,
@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-require "google/cloud/configuration"
+require "stackdriver/core/configuration"
 require "stackdriver/core/async_actor"
 require "stackdriver/core/configuration"
 require "stackdriver/core/trace_context"

data/lib/stackdriver/core/async_actor.rb

@@ -1,10 +1,10 @@
-# Copyright 2017 Google Inc. All rights reserved.
+# Copyright 2017 Google LLC
 #
 # Licensed 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
+#     https://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,
@@ -228,7 +228,7 @@ module Stackdriver
       # This should be the main task job that will be run asynchronously and
       # repeatly.
       def run_backgrounder
-        fail "#{self.class} class should override #run_backgrounder method"
+        raise "#{self.class} class should override #run_backgrounder method"
       end
 
       ##
@@ -302,7 +302,7 @@ module Stackdriver
       #   to run async_run_job. Also make calls register_for_cleanup on the
       #   async job to make sure it exits properly.
       def ensure_thread
-        fail "async_actor not initialized" if @startup_lock.nil?
+        raise "async_actor not initialized" if @startup_lock.nil?
         @startup_lock.synchronize do
           if (@thread.nil? || !@thread.alive?) && @async_state != :stopped
             @lock_cond = new_cond
@@ -352,8 +352,7 @@ module Stackdriver
       # @private Default abstract definition of this function that's a no-op.
       # The extending classes can override this method to handle state changing
       # logic.
-      def on_async_state_change
-      end
+      def on_async_state_change; end
     end
   end
 end

data/lib/stackdriver/core/configuration.rb

@@ -1,10 +1,10 @@
-# Copyright 2017 Google Inc. All rights reserved.
+# Copyright 2017 Google LLC
 #
 # Licensed 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.0oud
+#     https://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,
@@ -13,115 +13,12 @@
 # limitations under the License.
 
 
+require "google/cloud/config"
+
 module Stackdriver
   module Core
     ##
-    # @private Helps organize configuration options for Stackdriver
-    # instrumentation libraries. It's initialized with a nested list of
-    # predefined category keys, then only allows getting and setting these
-    # predefined options.
-    #
-    # @example
-    #   nested_categories = [:cat1, {cat2: [:cat3]}]
-    #   config = Stackdriver::Core::Configuration.new nested_categories
-    #
-    #   config.opt1        #=> nil
-    #   config.opt1 = true #=> true
-    #   config.opt1        #=> true
-    #
-    #   config.cat1           #=> <Stackdriver::Core::Configuration>
-    #   config.cat2.cat3   #=> <Stackdriver::Core::Configuration>
-    #
-    class Configuration
-      ##
-      # Constructs a new instance of Configuration object.
-      #
-      # @param [Symbol, Array<Symbol, Hash>, Hash<Symbol, (Array, Hash)>]
-      #   categories A Symbol, or nested Array and Hash of sub configuration
-      #   categories. A single symbol, or symbols in array, will be key(s) to
-      #   next level of categories. Nested hash represent sub categories with
-      #   further nested sub categories.
-      #
-      def initialize categories = {}
-        @configs = {}
-
-        add_options categories
-      end
-
-      ##
-      # Add nested sub configuration categories to a Configuration object
-      #
-      # @param [Symbol, Array<Symbol, Hash>, Hash<Symbol, (Array, Hash)>]
-      #   categories A Symbol, or nested Array and Hash of sub configuration
-      #   categories. A single symbol, or symbols in array, will be key(s) to
-      #   next level of categories. Nested hash represent sub categories with
-      #   further nested sub categories.
-      #
-      # @example
-      #   config = Stackdriver::Core::Configuration.new
-      #   config.cat1 #=> nil
-      #   config.add_options {cat1: [:cat2]}
-      #   config.cat1 #=> <Stackdriver::Core::Configuration>
-      #   config.cat1.cat2 #=> <Stackdriver::Core::Configuration>
-      #
-      def add_options categories
-        categories = [categories].flatten(1)
-        categories.each do |sub_key|
-          case sub_key
-          when Symbol
-            self[sub_key] = self.class.new
-          when Hash
-            sub_key.each do |k, v|
-              self[k] = self.class.new v
-            end
-          else
-            fail ArgumentError \
-              "Configuration option can only be Symbol or Hash"
-          end
-        end
-      end
-
-      ##
-      # Assign an option with `key` to value, while forcing `key` to be a
-      # Symbol.
-      def []= key, value
-        @configs[key.to_sym] = value
-      end
-
-      ##
-      # Get the option with `key`, while forcing `key` to be a Symbol.
-      def [] key
-        @configs[key.to_sym]
-      end
-
-      ##
-      # Delete the option with `key`, while forcing `key` to be a Symbol.
-      def delete key
-        @configs.delete key.to_sym
-      end
-
-      ##
-      # Check if the Configuration object has this option
-      #
-      # @param [Symbol] key The key to check for.
-      #
-      # @return [Boolean] True if the inquired key is a valid option for this
-      #   Configuration object. False otherwise.
-      #
-      def option? key
-        @configs.key? key.to_sym
-      end
-
-      ##
-      # @private Dynamic getters and setters
-      def method_missing mid, *args
-        method_string = mid.to_s
-        if method_string.chomp!("=")
-          self[method_string] = args.first
-        else
-          self[mid]
-        end
-      end
-    end
+    # Keep this for backwards compatibility
+    Configuration = Google::Cloud::Config
   end
 end

data/lib/stackdriver/core/trace_context.rb

@@ -1,10 +1,10 @@
-# Copyright 2016 Google Inc. All rights reserved.
+# Copyright 2016 Google LLC
 #
 # Licensed 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
+#     https://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,
@@ -29,11 +29,11 @@ module Stackdriver
     class TraceContext
       ##
       # @private
-      HEADER_RACK_KEY = "HTTP_X_CLOUD_TRACE_CONTEXT"
+      HEADER_RACK_KEY = "HTTP_X_CLOUD_TRACE_CONTEXT".freeze
 
       ##
       # @private
-      MEMO_RACK_KEY = "google.cloud.trace_context"
+      MEMO_RACK_KEY = "google.cloud.trace_context".freeze
 
       ##
       # @private
@@ -70,11 +70,11 @@ module Stackdriver
       def initialize trace_id: nil, is_new: nil, span_id: nil, sampled: nil,
                      capture_stack: false
         @trace_id = trace_id || new_random_trace_id
-        if is_new.nil?
-          @is_new = !trace_id
-        else
-          @is_new = is_new ? true : false
-        end
+        @is_new = if is_new.nil?
+                    !trace_id
+                  else
+                    is_new ? true : false
+                  end
         @span_id = span_id ? span_id.to_i : nil
         @sampled = sampled
         if @sampled.nil?
@@ -145,7 +145,7 @@ module Stackdriver
           sampled? == other.sampled? &&
           capture_stack? == other.capture_stack?
       end
-      alias_method :==, :eql?
+      alias == eql?
 
       ##
       # Generate standard hash code for this object.
@@ -206,7 +206,7 @@ module Stackdriver
         end
         str
       end
-      alias_method :to_s, :to_string
+      alias to_s to_string
 
       ##
       # Attempts to parse the given string as a trace context representation.
@@ -226,21 +226,19 @@ module Stackdriver
       #
       def self.parse_string str
         match = %r|^(\w{32})(/(\d+))?(;o=(\d+))?|.match str
-        if match
-          trace_id = match[1]
-          span_id = match[3] ? match[3].to_i : nil
-          options = match[5] ? match[5].to_i : nil
-          if options.nil?
-            sampled = capture_stack = nil
-          else
-            sampled = options & 1 != 0
-            capture_stack = options & 2 != 0
-          end
-          new trace_id: trace_id, span_id: span_id, sampled: sampled,
-              capture_stack: capture_stack
+        return unless match
+
+        trace_id = match[1]
+        span_id = match[3] ? match[3].to_i : nil
+        options = match[5] ? match[5].to_i : nil
+        if options.nil?
+          sampled = capture_stack = nil
         else
-          nil
+          sampled = options & 1 != 0
+          capture_stack = options & 2 != 0
         end
+        new trace_id: trace_id, span_id: span_id, sampled: sampled,
+            capture_stack: capture_stack
       end
 
       ##

data/lib/stackdriver/core/version.rb

@@ -1,10 +1,10 @@
-# Copyright 2016 Google Inc. All rights reserved.
+# Copyright 2016 Google LLC
 #
 # Licensed 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
+#     https://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,
@@ -15,6 +15,6 @@
 
 module Stackdriver
   module Core
-    VERSION = "1.2.0".freeze
+    VERSION = "1.3.0".freeze
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: stackdriver-core
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-12 00:00:00.000000000 Z
+date: 2018-02-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-cloud-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +98,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.1
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.1
+        version: 0.50.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -147,7 +161,6 @@ files:
 - ".yardopts"
 - LICENSE
 - README.md
-- lib/google/cloud/configuration.rb
 - lib/stackdriver-core.rb
 - lib/stackdriver/core.rb
 - lib/stackdriver/core/async_actor.rb
@@ -174,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Internal shared library for Ruby Stackdriver integration

data/lib/google/cloud/configuration.rb

@@ -1,63 +0,0 @@
-# Copyright 2017 Google Inc. All rights reserved.
-#
-# Licensed 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.
-
-
-require "stackdriver/core/configuration"
-
-module Google
-  module Cloud
-    ##
-    # @private Defines Google::Cloud.configure method. This will be the root
-    # configuration object shared by Stackdriver instrumentation libraries'
-    # configurations.
-    module Configuration
-      ##
-      # @private The shared Configuration object that all the Stackdriver
-      # instrumentation libraries will build on top of.
-      @@config = ::Stackdriver::Core::Configuration.new
-
-      ##
-      # Configure the default parameter for Google::Cloud. The values defined on
-      # this top level will be shared across all Stackdriver instrumentation
-      # libraries (Debugger, ErrorReporting, Logging, and Trace). These other
-      # libraries may also add sub configuration options under this.
-      #
-      # Possible configuration parameters:
-      #   * project_id: The Google Cloud Project ID. Automatically discovered
-      #                 when running from GCP environments.
-      #   * keyfile: The service account JSON file path. Automatically
-      #              discovered when running from GCP environments.
-      #   * use_debugger: Explicitly enable or disable Stackdriver Debugger
-      #                   instrumentation
-      #   * use_error_reporting: Explicitly enable or disable Stackdriver Error
-      #                          Reporting instrumentation
-      #   * use_logging: Explicitly enable or disable Stackdriver Logging
-      #                  instrumentation
-      #   * use_trace: Explicitly enable or disable Stackdriver
-      #
-      # @return [Stackdriver::Core::Configuration] The configuration object
-      #   the Google::Cloud module uses.
-      #
-      def configure
-        yield @@config if block_given?
-
-        @@config
-      end
-    end
-
-    # Immediately extend Google::Cloud::Configuration#configure
-    # into Google::Cloud.configure
-    extend Configuration
-  end
-end