restforce 0.1.0 → 0.1.1

data/README.md

@@ -150,6 +150,8 @@ _See also: http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_sea
 
 ### create(sobject, attrs)
 
+_Alias: insert_
+
 Takes an sobject name and a hash of attributes to create a record. Returns the
 Id of the newly created reocrd if the record was successfully created.
 
@@ -195,6 +197,8 @@ _See also: http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_ups
 
 ### destroy(sobject, id)
 
+_Alias: delete_
+
 Takes an sobject name and an Id and deletes the record. Returns true if the
 record was successfully deleted.
 
@@ -257,14 +261,24 @@ Restforce supports the [Streaming API](http://wiki.developerforce.com/page/Getti
 pub/sub with Salesforce a trivial task:
 
 ```ruby
-# Initialize a client with your username/password/oauth token/etc
+# Initialize a client with your username/password/oauth token/etc.
 client = Restforce.new
 
-# Force an authentication request
+# Force an authentication request.
 client.authenticate!
 
+# Create a PushTopic for subscribing to Account changes.
+client.create! 'PushTopic', {
+  ApiVersion: '23.0',
+  Name: 'AllAccounts',
+  Description: 'All account records',
+  NotifyForOperations: 'All',
+  NotifyForFields: 'All',
+  Query: "select Id from Account"
+}
+
 EM.run {
-  # Assuming you've setup a PushTopic called 'AllAccounts' (See the link above.)
+  # Subscribe to the PushTopic.
   client.subscribe 'AllAccounts' do |message|
     puts message.inspect
   end

data/lib/restforce/client.rb

@@ -162,6 +162,7 @@ module Restforce
     rescue *exceptions
       false
     end
+    alias_method :insert, :create
 
     # See .create
     #
@@ -171,6 +172,7 @@ module Restforce
       response = api_post "sobjects/#{sobject}", attrs
       response.body['id']
     end
+    alias_method :insert!, :create!
 
     # Public: Update a record.
     #
@@ -192,6 +194,7 @@ module Restforce
     # otherwise.
     def update!(sobject, attrs)
       id = attrs.has_key?(:Id) ? attrs.delete(:Id) : attrs.delete('Id')
+      raise 'Id field missing.' unless id
       api_patch "sobjects/#{sobject}/#{id}", attrs
       true
     end
@@ -240,6 +243,7 @@ module Restforce
     rescue *exceptions
       false
     end
+    alias_method :delete, :destroy
 
     # See .destroy
     #
@@ -249,6 +253,7 @@ module Restforce
       api_delete "sobjects/#{sobject}/#{id}"
       true
     end
+    alias_method :delete!, :destroy!
 
     # Public: Runs the block with caching disabled.
     #
@@ -355,7 +360,7 @@ module Restforce
         builder.use Restforce::Middleware::RaiseError
         builder.response :json
         builder.use Restforce::Middleware::Caching, cache, @options if cache
-        builder.use Restforce::Middleware::Logger, Restforce.configuration.logger if Restforce.log?
+        builder.use Restforce::Middleware::Logger, Restforce.configuration.logger, @options if Restforce.log?
         builder.adapter Faraday.default_adapter
       end
       @connection
@@ -406,7 +411,9 @@ module Restforce
 
     # Internal: Faye client to use for subscribing to PushTopics
     def faye
+      raise 'Instance URL missing. Call .authenticate! first.' unless @options[:instance_url]
       @faye ||= Faye::Client.new("#{@options[:instance_url]}/cometd/#{@options[:api_version]}").tap do |client|
+        raise 'OAuth token missing. Call .authenticate! first.' unless @options[:oauth_token]
         client.set_header 'Authorization', "OAuth #{@options[:oauth_token]}"
         client.bind 'transport:down' do
           Restforce.log "[COMETD DOWN]"

data/lib/restforce/middleware/authentication.rb

@@ -32,7 +32,7 @@ module Restforce
     def connection
       @connection ||= Faraday.new(:url => "https://#{@options[:host]}") do |builder|
         builder.response :json
-        builder.use Restforce::Middleware::Logger, Restforce.configuration.logger if Restforce.log?
+        builder.use Restforce::Middleware::Logger, Restforce.configuration.logger, @options if Restforce.log?
         builder.adapter Faraday.default_adapter
       end
     end

data/lib/restforce/middleware/logger.rb

@@ -1,16 +1,40 @@
+require 'forwardable'
+
 module Restforce
-  class Middleware::Logger < Faraday::Response::Logger
+  class Middleware::Logger < Faraday::Response::Middleware
+    extend Forwardable
+
+    def initialize(app, logger = nil, options)
+      super(app)
+      @options = options
+      @logger = logger || begin
+        require 'logger'
+        ::Logger.new(STDOUT)
+      end
+    end
+
+    def_delegators :@logger, :debug, :info, :warn, :error, :fatal
+
     def call(env)
-      info "#{env[:method]} #{env[:url].to_s}"
-      debug('request headers') { dump_headers env[:request_headers] }
-      debug('request body') { env[:body] }
+      debug('request') do
+        dump url: env[:url].to_s,
+          method: env[:method],
+          headers: env[:request_headers],
+          body: env[:body]
+      end
       super
     end
 
     def on_complete(env)
-      info('Status') { env[:status].to_s }
-      debug('response headers') { dump_headers env[:response_headers] }
-      debug('response body') { env[:body] }
+      debug('response') do
+        dump status: env[:status].to_s,
+          headers: env[:response_headers],
+          body: env[:body]
+      end
+    end
+
+    def dump(hash)
+      "\n" + hash.map { |k, v| "  #{k}: #{v.inspect}" }.join("\n")
     end
   end
 end

data/lib/restforce/version.rb

@@ -1,3 +1,3 @@
 module Restforce
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/lib/client_spec.rb

@@ -179,7 +179,10 @@ shared_examples_for 'methods' do
   end
 
   describe '.update' do
-    pending 'with missing Id'
+    context 'with missing Id' do
+      subject { client.update('Account', Name: 'Foobar') }
+      specify { expect { subject }.to raise_error RuntimeError, 'Id field missing.' }
+    end
 
     context 'with invalid Id' do
       before do
@@ -371,6 +374,27 @@ shared_examples_for 'methods' do
     subject { client.without_caching { client.query('SELECT some, fields FROM object') } }
     it { should be_an Array }
   end
+
+  describe '.faye' do
+    subject { client.send(:faye) }
+
+    context 'with missing oauth token' do
+      let(:instance_url) { 'foobar' }
+      let(:oauth_token) { nil }
+      specify { expect { subject }.to raise_error RuntimeError, 'OAuth token missing. Call .authenticate! first.' }
+    end
+
+    context 'with missing instance url' do
+      let(:instance_url) { nil }
+      specify { expect { subject }.to raise_error RuntimeError, 'Instance URL missing. Call .authenticate! first.' }
+    end
+
+    context 'with oauth token and instance url' do
+      let(:instance_url) { 'foo' }
+      let(:oauth_token) { 'bar' }
+      specify { expect { subject }.to_not raise_error }
+    end
+  end
 end
 
 describe 'with mashify middleware' do

data/spec/lib/middleware/logger_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Restforce::Middleware::Logger do
+  let(:app)        { double('app')            }
+  let(:env)        { { }  }
+  let(:logger)     { double('logger') }
+  let(:options)    { { host: 'login.salesforce.com', client_secret: 'foo', password: 'bar' } }
+  let(:middleware) { described_class.new app, logger, options }
+
+  describe 'logging' do
+    before do
+      app.should_receive(:call).once.and_return(app)
+      app.should_receive(:on_complete).once { middleware.on_complete(env) }
+      logger.should_receive(:debug).with('request')
+      logger.should_receive(:debug).with('response')
+    end
+
+    it 'logs the request and response' do
+      middleware.call(env)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-21 00:00:00.000000000 Z
+date: 2012-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -229,6 +229,7 @@ files:
 - spec/lib/middleware/authentication_spec.rb
 - spec/lib/middleware/authorization_spec.rb
 - spec/lib/middleware/instance_url_spec.rb
+- spec/lib/middleware/logger_spec.rb
 - spec/lib/middleware/mashify_spec.rb
 - spec/lib/middleware/raise_error_spec.rb
 - spec/lib/sobject_spec.rb
@@ -301,6 +302,7 @@ test_files:
 - spec/lib/middleware/authentication_spec.rb
 - spec/lib/middleware/authorization_spec.rb
 - spec/lib/middleware/instance_url_spec.rb
+- spec/lib/middleware/logger_spec.rb
 - spec/lib/middleware/mashify_spec.rb
 - spec/lib/middleware/raise_error_spec.rb
 - spec/lib/sobject_spec.rb