api_smith 1.0.0 → 1.1.0

data/lib/api_smith/client.rb

@@ -110,7 +110,10 @@ module APISmith
           request_options[type] = merged_options_for(type, options)
         end
         # Finally, use HTTParty to get the response
-        response = self.class.send method, full_path, request_options
+        response = nil
+        instrument_request method, full_path, options do
+          response = self.class.send method, full_path, request_options
+        end
         # Pre-process the response to check for errors.
         check_response_errors response
         # Unpack the response using the :response_container option
@@ -121,6 +124,15 @@ module APISmith
 
       private
 
+      # Provides a hook developers can utilitise to implement logging / instrumentation.
+      # @param [Symbol] method the HTTP method to use
+      # @param [String] full_path the full path being hit
+      # @param [Hash] options an options being passed to the request
+      # @param [#call] the block to invoke it with.
+      def instrument_request(method, full_path, options)
+        yield if block_given?
+      end
+
       # Provides a hook to handle checking errors on API responses. This is called
       # post-fetch and pre-unpacking / transformation. It is passed the apis response
       # post-decoding (meaning JSON etc have been parsed into normal ruby objects).

data/lib/api_smith/version.rb

@@ -1,4 +1,4 @@
 module APISmith
   # The current version of API Smith
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.0".freeze
 end

data/lib/api_smith/web_mock_extensions.rb

@@ -13,7 +13,9 @@ module APISmith
       subject.is_a?(Class) ? subject : subject.class
     end
 
-    # Returns an instance of the subject class, created via allocate (vs. new)
+    # Returns an instance of the subject class, created via allocate (vs. new). Useful
+    # for giving access to utility methods used inside of the class without having to\
+    # initialize a new client.
     # @return [Object] the instance
     def subject_class_instance
       @subject_class_instance ||= subject_api_class.allocate
@@ -35,7 +37,7 @@ module APISmith
     # @param [String] the relative path for the api
     # @return [Object] the result from stub_request
     def stub_api(type, path)
-      stub_request(type, api_url_for(path))
+      stub_request type, api_url_for(path)
     end
 
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: api_smith
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Darcy Laycock
@@ -16,8 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-21 00:00:00 +08:00
-default_executable: 
+date: 2011-12-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httparty
@@ -107,7 +106,6 @@ files:
 - lib/api_smith/version.rb
 - lib/api_smith/web_mock_extensions.rb
 - lib/api_smith.rb
-has_rdoc: true
 homepage: http://github.com/thefrontiergroup
 licenses: []
 
@@ -139,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A simple layer on top of HTTParty for building API's