Trace instrumentation

docs/manifest.json

@@ -190,6 +190,14 @@
         "v0.20.0"
       ]
     },
+    {
+      "id": "google-cloud-trace",
+      "name": "google-cloud-trace",
+      "defaultService": "google/cloud/trace",
+      "versions": [
+        "master"
+      ]
+    },
     {
       "id": "google-cloud-translate",
       "name": "google-cloud-translate",

google-cloud-trace/.autotest

@@ -0,0 +1,15 @@
+# -*- ruby -*-
+
+require "autotest/suffix"
+
+# Autotest.add_hook :initialize do |at|
+#   at.clear_mappings
+#
+#   at.add_mapping %r%^lib/(.*)\.rb$% do |_, m|
+#     at.files_matching %r%^test/#{m[1]}.*_test.rb$%
+#   end
+#
+#   at.add_mapping %r%^test/.*_test\.rb$% do |filename, _|
+#     filename
+#   end
+# end

google-cloud-trace/.rubocop.yml

@@ -46,5 +46,11 @@ Style/ClassVars:
   Enabled: false
 Style/TrivialAccessors:
   Enabled: false
+Style/CaseEquality:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
 Style/FileName:
   Enabled: false # for lib/google-cloud-trace.rb file
+Lint/RescueException:
+  Enabled: false # for lib/google/cloud/logging/rails.rb file

google-cloud-trace/.yardopts

@@ -1,5 +1,6 @@
 --no-private
---title=Stackdriver Trace 
+--title=Stackdriver Trace
+--markup markdown
 
 ./lib/**/*.rb
 -

google-cloud-trace/CHANGELOG.md

@@ -1,5 +1 @@
 # Release History
-
-### 0.21.0 / 2016-11-03
-
-* First release

google-cloud-trace/Gemfile

@@ -3,6 +3,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 11.0"
+gem "stackdriver-core", path: "../stackdriver-core"
 gem "gcloud-jsondoc",
     git: "https://github.com/GoogleCloudPlatform/google-cloud-ruby.git",
     branch: "gcloud-jsondoc"

google-cloud-trace/Rakefile

@@ -21,34 +21,79 @@ RuboCop::RakeTask.new
 
 desc "Run tests."
 task :test do
-  puts "The google-cloud-trace gem does not have tests."
+  $LOAD_PATH.unshift "lib", "test"
+  Dir.glob("test/**/*_test.rb").each { |file| require_relative file }
 end
 
 namespace :test do
-  desc "Run tests with coverage."
+  desc "Runs tests with coverage."
   task :coverage do
+    require "simplecov"
+    SimpleCov.start do
+      command_name "google-cloud-trace"
+      track_files "lib/**/*.rb"
+      add_filter "test/"
+    end
+
+    Rake::Task["test"].invoke
   end
 end
 
 # Acceptance tests
-desc "Run the trace acceptance tests."
-task :acceptance do
-  puts "The google-cloud-trace gem does not have acceptance tests."
+desc "Runs the trace acceptance tests."
+task :acceptance, :project, :keyfile do |t, args|
+  project = args[:project]
+  project ||= ENV["GCLOUD_TEST_PROJECT"] || ENV["TRACE_TEST_PROJECT"]
+  keyfile = args[:keyfile]
+  keyfile ||= ENV["GCLOUD_TEST_KEYFILE"] || ENV["TRACE_TEST_KEYFILE"]
+  if keyfile
+    keyfile = File.read keyfile
+  else
+    keyfile ||= ENV["GCLOUD_TEST_KEYFILE_JSON"] || ENV["TRACE_TEST_KEYFILE_JSON"]
+  end
+  if project.nil? || keyfile.nil?
+    fail "You must provide a project and keyfile. e.g. rake acceptance[test123, /path/to/keyfile.json] or TRACE_TEST_PROJECT=test123 TRACE_TEST_KEYFILE=/path/to/keyfile.json rake acceptance"
+  end
+  # always overwrite when running tests
+  ENV["TRACE_PROJECT"] = project
+  ENV["TRACE_KEYFILE"] = nil
+  ENV["TRACE_KEYFILE_JSON"] = keyfile
+
+  $LOAD_PATH.unshift "lib", "acceptance"
+  Dir.glob("acceptance/trace/**/*_test.rb").each { |file| require_relative file }
 end
 
 namespace :acceptance do
-  desc "Run acceptance tests with coverage."
-  task :coverage do
-  end
+  desc "Runs acceptance tests with coverage."
+  task :coverage, :project, :keyfile do |t, args|
+    require "simplecov"
+    SimpleCov.start do
+      command_name "google-cloud-trace"
+      track_files "lib/**/*.rb"
+      add_filter "acceptance/"
+    end
 
-  desc "Run acceptance cleanup."
-  task :cleanup do
+    Rake::Task["acceptance"].invoke
   end
 end
 
-desc "Run yard-doctest example tests."
+desc "Runs yard-doctest example tests."
 task :doctest do
-  puts "The google-cloud-trace gem does not have doctest tests."
+end
+
+desc "Start an interactive shell."
+task :console do
+  require "irb"
+  require "irb/completion"
+  require "pp"
+
+  $LOAD_PATH.unshift "lib"
+
+  require "google-cloud-trace"
+  def gcloud; @gcloud ||= Google::Cloud.new; end
+
+  ARGV.clear
+  IRB.start
 end
 
 require "yard"

google-cloud-trace/docs/toc.json

@@ -1,8 +1,71 @@
 {
-  "guides": [],
+  "guides": [
+    {
+      "title": "Troubleshooting",
+      "id": "troubleshooting",
+      "edit": "https://github.com/GoogleCloudPlatform/gcloud-common/edit/master/troubleshooting/readme.md",
+      "contents": "https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/troubleshooting/readme.md"
+    },
+    {
+      "title": "Contributing",
+      "id": "contributing",
+      "edit": "https://github.com/GoogleCloudPlatform/gcloud-common/edit/master/contributing/readme.md",
+      "contents": "https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/contributing/readme.md"
+    }
+  ],
   "services": [
     {
-      "title": "TraceServiceApi",
+      "title": "Google::Cloud",
+      "type": "google/cloud"
+    },
+    {
+      "title": "Google::Cloud::Trace",
+      "type": "google/cloud/trace",
+      "nav": [
+        {
+          "title": "LabelKey",
+          "type": "google/cloud/trace/labelkey"
+        },
+        {
+          "title": "Middleware",
+          "type": "google/cloud/trace/middleware"
+        },
+        {
+          "title": "Notifications",
+          "type": "google/cloud/trace/notifications"
+        },
+        {
+          "title": "Project",
+          "type": "google/cloud/trace/project"
+        },
+        {
+          "title": "Railtie",
+          "type": "google/cloud/trace/railtie"
+        },
+        {
+          "title": "ResultSet",
+          "type": "google/cloud/trace/resultset"
+        },
+        {
+          "title": "Span",
+          "type": "google/cloud/trace/span"
+        },
+        {
+          "title": "SpanKind",
+          "type": "google/cloud/trace/spankind"
+        },
+        {
+          "title": "TimeSampler",
+          "type": "google/cloud/trace/timesampler"
+        },
+        {
+          "title": "TraceRecord",
+          "type": "google/cloud/trace/tracerecord"
+        },
+      ]
+    },
+    {
+      "title": "Low-Level API",
       "type": "google/cloud/trace/v1/traceserviceapi"
     }
   ]

google-cloud-trace/google-cloud-trace.gemspec

@@ -1,14 +1,14 @@
-# -*- ruby -*-
-# encoding: utf-8
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/google/cloud/trace/version", __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name          = "google-cloud-trace"
-  gem.version       = "0.21.0"
+  gem.version       = Google::Cloud::Trace::VERSION
 
-  gem.authors       = ["Google Inc"]
-  gem.email         = ["googleapis-packages@google.com"]
+  gem.authors       = ["Daniel Azuma"]
+  gem.email         = ["dazuma@google.com"]
   gem.description   = "google-cloud-trace is the official library for Stackdriver Trace."
-  gem.summary       = "API Client library for Stackdriver Trace"
+  gem.summary       = "Application Instrumentation and API Client library for Stackdriver Trace"
   gem.homepage      = "http://googlecloudplatform.github.io/google-cloud-ruby/"
   gem.license       = "Apache-2.0"
 
@@ -24,6 +24,17 @@ Gem::Specification.new do |gem|
   gem.add_dependency "google-gax", "~> 0.6.0"
   gem.add_dependency "google-protobuf", "~> 3.0"
   gem.add_dependency "googleapis-common-protos", "~> 1.3"
+  gem.add_dependency "google-cloud-core", "~> 0.21.0"
+  gem.add_dependency "stackdriver-core", "~> 0.21.0"
 
+  gem.add_development_dependency "minitest", "~> 5.9"
+  gem.add_development_dependency "minitest-autotest", "~> 1.0"
+  gem.add_development_dependency "minitest-focus", "~> 1.1"
+  gem.add_development_dependency "minitest-rg", "~> 5.2"
+  gem.add_development_dependency "autotest-suffix", "~> 1.1"
+  gem.add_development_dependency "railties", "~> 4.0"
   gem.add_development_dependency "rubocop", "<= 0.35.1"
+  gem.add_development_dependency "simplecov", "~> 0.9"
+  gem.add_development_dependency "yard", "~> 0.9"
+  gem.add_development_dependency "yard-doctest", "~> 0.1.6"
 end

google-cloud-trace/lib/google-cloud-trace.rb

@@ -13,12 +13,85 @@
 # limitations under the License.
 
 ##
-# This file is here to be autorequired by bundler, so that the .logging and
-# #logging methods can be available, but the library and all dependencies won't
+# This file is here to be autorequired by bundler, so that the .trace and
+# #trace methods can be available, but the library and all dependencies won't
 # be loaded until required and used.
 
 
 gem "google-cloud-core"
 require "google/cloud"
 
-# There is no Google::Cloud integration to add.
+module Google
+  module Cloud
+    ##
+    # Creates a new object for connecting to the Stackdriver Trace service.
+    # Each call creates a new connection.
+    #
+    # For more information on connecting to Google Cloud see the [Authentication
+    # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
+    #
+    # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the
+    #   set of resources and operations that the connection can access. See
+    #   [Using OAuth 2.0 to Access Google
+    #   APIs](https://developers.google.com/identity/protocols/OAuth2).
+    #   The default scope is `https://www.googleapis.com/auth/cloud-platform`
+    # @param [Integer] timeout Default timeout to use in requests. Optional.
+    #
+    # @return [Google::Cloud::Trace::Project]
+    #
+    # @example
+    #   require "google/cloud"
+    #
+    #   gcloud = Google::Cloud.new
+    #   trace_client = gcloud.trace
+    #
+    #   traces = trace_client.list_traces Time.now - 3600, Time.now
+    #   traces.each do |trace|
+    #     puts "Retrieved trace ID: #{trace.trace_id}"
+    #   end
+    #
+    def trace scope: nil, timeout: nil, client_config: nil
+      Google::Cloud.trace @project, @keyfile, scope: scope,
+                                              timeout: (timeout || @timeout),
+                                              client_config: client_config
+    end
+
+    ##
+    # Creates a new object for connecting to the Stackdriver Trace service.
+    # Each call creates a new connection.
+    #
+    # For more information on connecting to Google Cloud see the [Authentication
+    # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
+    #
+    # @param [String] project Project identifier for the Stackdriver Trace
+    #   service.
+    # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud:
+    #   either the JSON data or the path to a readable file.
+    # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the
+    #   set of resources and operations that the connection can access. See
+    #   [Using OAuth 2.0 to Access Google
+    #   APIs](https://developers.google.com/identity/protocols/OAuth2).
+    #   The default scope is `https://www.googleapis.com/auth/cloud-platform`
+    # @param [Integer] timeout Default timeout to use in requests. Optional.
+    #
+    # @return [Google::Cloud::Trace::Project]
+    #
+    # @example
+    #   require "google/cloud"
+    #
+    #   trace_client = Google::Cloud.trace
+    #
+    #   traces = trace_client.list_traces Time.now - 3600, Time.now
+    #   traces.each do |trace|
+    #     puts "Retrieved trace ID: #{trace.trace_id}"
+    #   end
+    #
+    def self.trace project = nil, keyfile = nil, scope: nil, timeout: nil,
+                   client_config: nil
+      require "google/cloud/trace"
+      Google::Cloud::Trace.new project: project, keyfile: keyfile,
+                               scope: scope, timeout: timeout,
+                               client_config: client_config
+    end
+  end
+end