party_resource 0.0.2 → 0.0.3

data/lib/party_resource/connector/base.rb

@@ -11,7 +11,9 @@ module PartyResource
       end
 
       def fetch(request)
-        response = HTTParty.send(request.verb, request.path, request.http_data(options))
+        params = request.http_data(options)
+        log "** PartyResource #{request.verb.to_s.upcase} call to #{request.path} with #{params.inspect}"
+        response = HTTParty.send(request.verb, request.path, params)
         unless (200..399).include? response.code
           raise PartyResource::Exceptions::ConnectionError.build(response)
         end
@@ -20,6 +22,16 @@ module PartyResource
 
     private
 
+      def log(message)
+        unless PartyResource.logger.nil?
+          if PartyResource.logger.is_a? Proc
+            PartyResource.logger.call message
+          else
+            PartyResource.logger.debug message
+          end
+        end
+      end
+
       def options=(options)
         @options = {}
         @options[:base_uri] = HTTParty.normalize_base_uri(options[:base_uri]) if options.has_key?(:base_uri)

data/lib/party_resource/connector.rb

@@ -12,6 +12,17 @@ module PartyResource
       end
 
       # Add a new named connector
+      # @param [Symbol] name Name for new connector
+      # @param [Hash] options
+      # @option options [String] :base_uri ('') URI to append to all routes using this connector
+      # @option options [String] :username HTTP basic auth username
+      # @option options [String] :password HTTP basic auth password
+      # @option options [Boolean] :default (false) Set this connector as the default
+      # @example
+      #   PartyResource::Connector.add(:other_connector, {:base_uri => 'http://otherserver/'})
+      # @example
+      #   PartyResource::Connector.add(:my_connector, {:base_uri => 'http://myserver/path', :username => 'fred', :password => 'pass', :default => true})
+
       def add(name, options)
         repository.new_connector(name, options)
       end

data/lib/party_resource/party_resource.rb

@@ -3,11 +3,60 @@ Hash.send(:include, ActiveSupport::CoreExtensions::Hash::IndifferentAccess) unle
 
 module PartyResource
 
+  # Set logger to use
+  # @param logger One of:
+  #
+  #   nil - no logging
+  #
+  #   Proc - log using logger.call(message)
+  #
+  #   Object - log using logger.debug(message)
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  # @private
+  def self.logger
+    @logger
+  end
+
   module ClassMethods
     include MethodDefine
 
     # Connect a method call to a restful uri
+    # @param [Symbol] name for method
+    # @param [Hash] options the options to use to create the route
+    # @option options [String] :get/:put/:post/:delete URI to attach to (key provides the HTTP verb)
+    # @option options :as (:self) How to build data returned by the route
+    #
+    #   :raw - raw data
+    #
+    #   :self - self.new(data)
+    #
+    #   class - class.new(data)
+    #
+    #   Array(class, method_name) - class.method_name(data)
+    #
+    #   lambda - lambda.call(data)
+    # @option options [Array/Symbol] :with ([]) List of parameter names
+    # @option options :on (:class) Where to attach the method (:class/:instance)
+    # @option options [Hash<Symbol, Symbol>] :including ({}) Hash of extra values to pass into object creation
+    # @option options [Hash<String, Object>] :rescue ({}) Hash of {Exceptions Exception} names to catch and the value to return
     # @return [nil]
+    # @example
+    #   connect :find, :get => '/find/:id.ext', :with => :id, :on => :class
+    # @example
+    #   connect :update, :put => '/update/:var.ext', :on => :instance, :as => OtherClass
+    # @example
+    #   connect :save, :post => '/save/file', :with => :data, :as => :raw
+    # @example
+    #   connect :destroy, :delete => '/delete', :as => [OtherClass, :make_boolean]
+    # @example
+    #   connect :foo, :get => '/foo', :with => :value, :as => lambda {|data| "New #{data} Improved" }
+    # @example
+    #   connect :fetch_json, :get => '/big_data', :as => [:self, :from_json], :rescue => {'ResourceNotFound' => nil}
+    # @example
+    #   connect :include, :get => '/include', :on => :instance, :as => OtherClass, :including => {:thing => :value2}
     def connect(name, options={})
       level = options.delete(:on)
       options = {:as => :self, :connector => @party_connector}.merge(options)
@@ -44,6 +93,18 @@ module PartyResource
     #     symbol - name
     #
     #     array - list of nested hash keys
+    #   @example
+    #    property :value, :from => :input_name
+    #   @example
+    #    property :value2, :value3
+    #   @example
+    #    property :nested_value, :from => [:block, :var]
+    #   @example
+    #    property :other, :as => OtherClass
+    #   @example
+    #    property :processed, :as => lambda { |data| "Processed: #{data}" }, :to => :output_name
+    #   @example
+    #    property :child, :as => OtherPartyClass
     #   @return [nil]
     def property(*names)
       options = names.pop if names.last.is_a?(Hash)
@@ -59,6 +120,9 @@ module PartyResource
     end
 
     # Set the name of the connector to use for this class
+    # @param [Symbol] name Name of connector
+    # @example
+    #   party_connector :my_shiny_connector
     # @return [nil]
     def party_connector(name)
       @party_connector = name
@@ -76,7 +140,9 @@ module PartyResource
     end
   end
 
+  @private
   module ParameterValues
+    @private
     def parameter_values(list)
       list.inject({}) do |out, var|
         begin

data/spec/integration/integration_spec.rb

@@ -7,6 +7,10 @@ describe TestClass do
 
   let(:object) {TestClass.new(:foo)}
 
+  after do
+    PartyResource.logger = nil
+  end
+
   describe 'class level call' do
     it 'raises an argument error when called with the wrong number of arguments' do
       lambda { TestClass.find }.should raise_error(ArgumentError)
@@ -170,4 +174,40 @@ describe TestClass do
       obj.to_properties_hash.should == {:input_name => 'v1', :value2 => 'v2', :block => {:var => 'nv'}, :output_name => 'Processed: Milk', :child => {:thing => 'Happiness'}}
     end
   end
+
+  describe 'logging' do
+    context 'with no logger' do
+      it 'does not fail' do
+        stub_request(:get, "http://fred:pass@myserver/path/find/99.ext").to_return(:body => 'some data')
+        TestClass.find(99)
+      end
+    end
+
+    context 'with a logger object' do
+      before do
+        @logger = mock(:logger)
+        PartyResource.logger = @logger
+      end
+
+      it 'logs all api calls to debug' do
+        stub_request(:get, "http://fred:pass@myserver/path/find/99.ext").to_return(:body => 'some data')
+        @logger.should_receive(:debug).with('** PartyResource GET call to /find/99.ext with {:basic_auth=>{:username=>"fred", :password=>"pass"}, :base_uri=>"http://myserver/path"}')
+        TestClass.find(99)
+      end
+    end
+
+    context 'with a logger lambda' do
+      before do
+        @logger = mock(:logger)
+        PartyResource.logger = lambda {|message| @logger.log(message) }
+      end
+
+      it 'logs all api calls to debug' do
+        stub_request(:get, "http://fred:pass@myserver/path/find/99.ext").to_return(:body => 'some data')
+        @logger.should_receive(:log).with('** PartyResource GET call to /find/99.ext with {:basic_auth=>{:username=>"fred", :password=>"pass"}, :base_uri=>"http://myserver/path"}')
+        TestClass.find(99)
+      end
+    end
+
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Tristan Harris
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-26 00:00:00 +01:00
+date: 2010-06-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency