stackdriver-core 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a6a8a73f6206ebeaf00e0a79f66f05793dd0c11
-  data.tar.gz: 3f99877f0c26ddeba5666c5c947cab30bcb08b6a
+  metadata.gz: b45c580aedf6db0249b85c998c299b1b549e79fc
+  data.tar.gz: b0102ed722cc628e16836cdf64dde18493162399
 SHA512:
-  metadata.gz: c01a8d3ab1f9d720de99c6831a041ac37bfb3dbb625d29777916275a754fe617fcf6b988e35d3d3c53eda8e0b3c2398890f674171d20f5692ce03e6f7acd835a
-  data.tar.gz: 933cf1dc8bcaa82730989cc94f103b60881e971ffc74c2f0fd5152549bcebb468009fe0c03169b359c0a0a2d0c1a106467625cfdf958ca40accbf74c3ab42295
+  metadata.gz: 9a85f64d8201cfa290097d414d95c092be448b5eb6ad3ae55788f837be9da77bd7ef2a5fc5886453d0cc6f2cfcfea7a0b642c49063018ef2c3856ee87444244a
+  data.tar.gz: 5b616f814cf67f966d2ab60ec651a446e99df26acb85a8ee959e6dcfe32ecd15d3f47004da7342d482f9f94b7eaf5891c3f8fb690930fb9522f3783c78f471b4

data/lib/google/cloud/configuration.rb

@@ -0,0 +1,63 @@
+# 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

data/lib/stackdriver/core.rb

@@ -13,6 +13,8 @@
 # limitations under the License.
 
 
+require "google/cloud/configuration"
+require "stackdriver/core/configuration"
 require "stackdriver/core/trace_context"
 require "stackdriver/core/version"
 

data/lib/stackdriver/core/configuration.rb

@@ -0,0 +1,127 @@
+# 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.0oud
+#
+# 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.
+
+
+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
+  end
+end

data/lib/stackdriver/core/version.rb

@@ -15,6 +15,6 @@
 
 module Stackdriver
   module Core
-    VERSION = "1.0.0".freeze
+    VERSION = "1.1.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stackdriver-core
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-01 00:00:00.000000000 Z
+date: 2017-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -147,11 +147,13 @@ files:
 - ".yardopts"
 - LICENSE
 - README.md
+- lib/google/cloud/configuration.rb
 - lib/stackdriver-core.rb
 - lib/stackdriver/core.rb
+- lib/stackdriver/core/configuration.rb
 - lib/stackdriver/core/trace_context.rb
 - lib/stackdriver/core/version.rb
-homepage: http://googlecloudplatform.github.io/google-cloud-ruby/
+homepage: https://github.com/GoogleCloudPlatform/google-cloud-ruby/tree/master/stackdriver-core
 licenses:
 - Apache-2.0
 metadata: {}
@@ -171,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Internal shared library for Ruby Stackdriver integration