google-dfp-api 1.1.0 → 1.2.0

data/lib/dfp_api/utils.rb

@@ -0,0 +1,56 @@
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2017, Google Inc. All Rights Reserved.
+#
+# License:: 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.
+#
+# Misc DFP utilities.
+
+require 'set'
+require 'thread'
+require 'singleton'
+
+
+module DfpApi
+  module Utils
+    # Class to keep a list of unique utilities used in order to perform tracking
+    # of client library features.
+    class UtilityRegistry
+      include Singleton
+      attr_accessor :enabled
+
+      def initialize
+        @enabled = true
+        @registry = Set.new
+        @lock = Mutex.new
+      end
+
+      def extract!
+        @lock.synchronize do
+          registry = @registry.dup
+          @registry.clear
+          return registry
+        end
+      end
+
+      def length
+        @lock.synchronize { @registry.length }
+      end
+
+      def add(util)
+        @lock.synchronize { @registry.add(util) if @enabled }
+      end
+    end
+  end
+end

data/lib/dfp_api/utils_reporter.rb

@@ -0,0 +1,52 @@
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2017, Google Inc. All Rights Reserved.
+#
+# License:: 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.
+#
+# Contains methods to help configure the user agent string to report on utility
+# usage.
+
+require 'dfp_api/credential_handler'
+
+module DfpApi
+  class UtilsReporter
+    # Default constructor.
+    #
+    # Args:
+    # - credential_handler: The CredentialHandler being used by the current
+    # DfpApi instance.
+    def initialize(credential_handler)
+      @credential_handler = credential_handler
+    end
+
+    # A callback method for StatementBuilder to indicate that it has been
+    # used, and that its usage should be recorded in the next user agent string.
+    def statement_builder_used()
+      @credential_handler.include_in_user_agent("StatementBuilder")
+    end
+
+    # A callback method for DfpDate to indicate that it has been
+    # used, and that its usage should be recorded in the next user agent string.
+    def dfp_date_used()
+      @credential_handler.include_in_user_agent("DfpDate")
+    end
+
+    # A callback method for DfpDateTime to indicate that it has been
+    # used, and that its usage should be recorded in the next user agent string.
+    def dfp_date_time_used()
+      @credential_handler.include_in_user_agent("DfpDateTime")
+    end
+  end
+end