bookingsync-api 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 172be2a9be7aabe819db717e1a3fcda0d7b24b31
-  data.tar.gz: 2af6c9daa8e298c8efe97ddbaf6fd5d38ebb5559
+  metadata.gz: 657a1fe08c85da356e964602580b31d892e9a0c9
+  data.tar.gz: 09bd00b34418d232944dcd0f790b19233cffb735
 SHA512:
-  metadata.gz: 57f428b0028fb34272143e65dc42f7edd8b21060b330892235ac1bd51a21aa38fff85487527ffded9a432c92b3c3055c0c1eb6ee8dca211f7611bac73ac30325
-  data.tar.gz: f503f807b4cff7bcdc5a748c9a87a8480fc6fc366124ddb114aef39e01702392bf4138217024fd502997a04e870ecd22cc3fc385e089b09df2f6caa07ed6d0b1
+  metadata.gz: eec8bc8666f9b3c79f1a2771f671df6a0c3fbfbcf1795ca85400128751c3e2c33dd3272c03d017c9300a156f19b89eff9a68e37200eed507b39e531c45ee2d6e
+  data.tar.gz: 71251e0ff150dfc367788e047a0038794634d14a0fe1065c61938fb4d3544df20a1cc1977a98c26534307c42a5b469fb119f68b88ed9f725c5d609aa5664d485

data/README.md

@@ -58,6 +58,17 @@ There are two ways to enable logging:
 
         api = BookingSync::API.new("OAUTH_TOKEN", logger: Rails.logger)
 
+### Instrumentation
+
+BookingSync::API exposes instrumentation information that can be consumed
+by various instrumentation libraries. By default it doesn't send the
+information anywhere.
+
+To hook instrumentations into `ActiveSupport::Notifications`, pass the
+module into the API client initializer:
+
+    api = BookingSync::API.new("OAUTH_TOKEN", instrumenter: ActiveSupport::Notifications)
+
 #### Log levels
 
 `INFO` - Logged are only request method and the URL.

data/lib/bookingsync/api/client.rb

@@ -29,6 +29,7 @@ require "logger"
 
 module BookingSync::API
   class Client
+    extend Forwardable
     include BookingSync::API::Client::Amenities
     include BookingSync::API::Client::Availabilities
     include BookingSync::API::Client::BillingAddresses
@@ -54,6 +55,8 @@ module BookingSync::API
 
     attr_reader :token, :logger
 
+    def_delegator :@instrumenter, :instrument
+
     # Initialize new Client
     #
     # @param token [String] OAuth token
@@ -61,10 +64,13 @@ module BookingSync::API
     # @option options [String] base_url: Base URL to BookingSync site
     # @option options [Logger] logger: Logger where headers and body of every
     #   request and response will be logged.
+    # @option options [Module] instrumenter: A module that responds to
+    #   instrument, usually ActiveSupport::Notifications.
     # @return [BookingSync::API::Client] New BookingSync API client
     def initialize(token, options = {})
       @token = token
       @logger = options[:logger] || default_logger
+      @instrumenter = options[:instrumenter] || NoopInstrumenter
       @base_url = options[:base_url]
       @serializer = Serializer.new
       @conn = Faraday.new(faraday_options)
@@ -142,8 +148,10 @@ module BookingSync::API
     # @param options [Hash] A customizable set of request options.
     # @return [Array<BookingSync::API::Resource>] Array of resources.
     def request(method, path, data = nil, options = nil)
-      response = call(method, path, data, options)
-      response.respond_to?(:resources) ? response.resources : response
+      instrument("request.bookingsync_api", method: method, path: path) do
+        response = call(method, path, data, options)
+        response.respond_to?(:resources) ? response.resources : response
+      end
     end
 
     # Make a HTTP GET request to a path with pagination support.
@@ -157,25 +165,27 @@ module BookingSync::API
     # @yieldreturn [Array<BookingSync::API::Resource>] Batch of resources
     # @return [Array<BookingSync::API::Resource>] Batch of resources
     def paginate(path, options = {}, &block)
-      auto_paginate = options.delete(:auto_paginate)
-      response = call(:get, path, query: options)
-      data = response.resources.dup
+      instrument("paginate.bookingsync_api", path: path) do
+        auto_paginate = options.delete(:auto_paginate)
+        response = call(:get, path, query: options)
+        data = response.resources.dup
 
-      if (block_given? or auto_paginate) && response.rels[:next]
-        first_request = true
-        loop do
-          if block_given?
-            yield(response.resources)
-          elsif auto_paginate
-            data.concat(response.resources) unless first_request
-            first_request = false
+        if (block_given? or auto_paginate) && response.rels[:next]
+          first_request = true
+          loop do
+            if block_given?
+              yield(response.resources)
+            elsif auto_paginate
+              data.concat(response.resources) unless first_request
+              first_request = false
+            end
+            break unless response.rels[:next]
+            response = response.rels[:next].get
           end
-          break unless response.rels[:next]
-          response = response.rels[:next].get
         end
-      end
 
-      data
+        data
+      end
     end
 
     # Make a HTTP request to given path and returns Response object.
@@ -187,37 +197,39 @@ module BookingSync::API
     # @param options [Hash] A customizable set of request options.
     # @return [BookingSync::API::Response] A Response object.
     def call(method, path, data = nil, options = nil)
-      if [:get, :head].include?(method)
-        options = data
-        data = nil
-      end
-      options ||= {}
-
-      if options.has_key?(:query)
-        if options[:query].has_key?(:ids)
-          ids = Array(options[:query].delete(:ids)).join(',')
-          path = "#{path}/#{ids}"
+      instrument("call.bookingsync_api", method: method, path: path) do
+        if [:get, :head].include?(method)
+          options = data
+          data = nil
         end
-        options[:query].keys.each do |key|
-          if options[:query][key].is_a?(Array)
-            options[:query][key] = options[:query][key].join(",")
+        options ||= {}
+
+        if options.has_key?(:query)
+          if options[:query].has_key?(:ids)
+            ids = Array(options[:query].delete(:ids)).join(',')
+            path = "#{path}/#{ids}"
+          end
+          options[:query].keys.each do |key|
+            if options[:query][key].is_a?(Array)
+              options[:query][key] = options[:query][key].join(",")
+            end
           end
         end
-      end
 
-      url = expand_url(path, options[:uri])
-      res = @conn.send(method, url) do |req|
-        if data
-          req.body = data.is_a?(String) ? data : encode_body(data)
-        end
-        if params = options[:query]
-          req.params.update params
-        end
-        if headers = options[:headers]
-          req.headers.update headers
+        url = expand_url(path, options[:uri])
+        res = @conn.send(method, url) do |req|
+          if data
+            req.body = data.is_a?(String) ? data : encode_body(data)
+          end
+          if params = options[:query]
+            req.params.update params
+          end
+          if headers = options[:headers]
+            req.headers.update headers
+          end
         end
+        handle_response(res)
       end
-      handle_response(res)
     end
 
     private
@@ -294,5 +306,12 @@ module BookingSync::API
     def default_logger
       Logger.new(debug? ? STDOUT : nil)
     end
+
+    # Default instrumenter which does nothing.
+    module NoopInstrumenter
+      def self.instrument(name, payload = {})
+        yield payload if block_given?
+      end
+    end
   end
 end

data/lib/bookingsync/api/version.rb

@@ -1,5 +1,5 @@
 module BookingSync
   module API
-    VERSION = "0.0.12"
+    VERSION = "0.0.13"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bookingsync-api
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Sébastien Grosjean
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-30 00:00:00.000000000 Z
+date: 2014-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday