restforce 0.0.6 → 0.0.7

data/README.md

@@ -13,6 +13,8 @@ It attempts to solve a couple of key issues that the databasedotcom gem has been
 * Support for blob data types.
 * A clean and modular architecture using [Faraday middleware](https://github.com/technoweenie/faraday)
 
+[Documentation](http://rubydoc.info/gems/restforce/frames)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -94,7 +96,12 @@ Restforce.configure do |config|
 end
 ```
 
-### Query
+* * *
+
+### query(soql)
+
+Performs a soql query and returns the result. The result will be a
+[Restforce::Collection][], which can be iterated over.
 
 ```ruby
 accounts = client.query("select Id, Something__c from Account where Id = 'someid'")
@@ -114,7 +121,14 @@ account.destroy
 # => true
 ```
 
-### Search
+_See also: http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_query.htm_
+
+* * *
+
+### search(sosl)
+
+Performs a sosl query and returns the result. The result will be a
+[Restforce::Collection][].
 
 ```ruby
 # Find all occurrences of 'bar'
@@ -126,7 +140,14 @@ client.search('FIND {genepoint} RETURNING Account (Name)').map(&:Name)
 # => ['GenePoint']
 ```
 
-### Create
+_See also: http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_search.htm_
+
+* * *
+
+### create(sobject, attrs)
+
+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.
 
 ```ruby
 # Add a new account
@@ -134,7 +155,15 @@ client.create('Account', Name: 'Foobar Inc.')
 # => '0016000000MRatd'
 ```
 
-### Update
+_See also: http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_sobject_create.htm_
+
+* * *
+
+### update(sobject, attrs)
+
+Takes an sobject name and a hash of attributes to update a record. The
+'Id' field is required to update. Returns true if the record was successfully
+updated.
 
 ```ruby
 # Update the Account with Id '0016000000MRatd'
@@ -142,15 +171,28 @@ client.update('Account', Id: '0016000000MRatd', Name: 'Whizbang Corp')
 # => true
 ```
 
+_See also: http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_update_fields.htm_
+
+* * *
+
+### upsert(sobject, field, attrs)
 
-### Upsert
+Takes an sobject name, an external id field, and a hash of attributes and
+either inserts or updates the record depending on the existince of the record.
+Returns true if the record was updated or the Id of the record if the record was
+created.
 
 ```ruby
 # Update the record with external ID of 12
 client.upsert('Account', 'External__c', External__c: 12, Name: 'Foobar')
 ```
 
-### Destroy
+_See also: http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_upsert.htm_
+
+### destroy(sobject, id)
+
+Takes an sobject name and an Id and deletes the record. Returns true if the
+record was successfully deleted.
 
 ```ruby
 # Delete the Account with Id '0016000000MRatd'
@@ -158,6 +200,10 @@ client.destroy('Account', '0016000000MRatd')
 # => true
 ```
 
+_See also: http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_delete_record.htm_
+
+* * *
+
 ### File Uploads
 
 Using the new [Blob Data](http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_sobject_insert_update_blob.htm) api feature (500mb limit):
@@ -178,6 +224,10 @@ client.create 'Document', FolderId: '00lE0000000FJ6H',
   Body: Base64::encode64(File.read('image.jpg'))
 ```
 
+_See also: http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_sobject_insert_update_blob.htm_
+
+* * *
+
 ### Streaming
 
 Restforce supports the [Streaming API](http://wiki.developerforce.com/page/Getting_Started_with_the_Force.com_Streaming_API), and makes implementing
@@ -201,24 +251,26 @@ EM.run {
 Boom, you're now receiving push notifications when Accounts are
 created/updated.
 
+_See also: http://www.salesforce.com/us/developer/docs/api_streaming/index.htm_
+
+* * *
+
 ### Caching
 
 The gem supports easy caching of GET requests (e.g. queries):
 
 ```ruby
-# Memcached example:
-
-cache = Dalli::Client.new
-
-client = Restforce.new cache: cache
+# rails example:
+client = Restforce.new cache: Rails.cache
 
 # or
-
 Restforce.configure do |config|
-  config.cache = cache
+  config.cache = Rails.cache
 end
 ```
 
+* * *
+
 ### Logging/Debugging
 
 You can easily inspect what Restforce is sending/receiving by setting
@@ -255,3 +307,5 @@ client = Restforce.new.query('select Id, Name from Account')
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+[Restforce::Collection]: https://github.com/ejholmes/restforce/blob/master/lib/restforce/collection.rb "Restforce::Collection"

data/lib/restforce/middleware/authentication.rb

@@ -8,12 +8,14 @@ module Restforce
 
     def call(env)
       request_body = env[:body]
+      request = env[:request]
       begin
         return authenticate! if force_authenticate?(env)
         @app.call(env)
       rescue Restforce::UnauthorizedError
         authenticate!
         env[:body] = request_body
+        env[:request] = request
         @app.call(env)
       end
     end

data/lib/restforce/version.rb

@@ -1,3 +1,3 @@
 module Restforce
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/lib/middleware/authentication_spec.rb

@@ -28,12 +28,13 @@ describe Restforce::Middleware::Authentication do
     context 'when an exception is thrown' do
       before do
         env[:body] = 'foo'
+        env[:request] = {proxy: nil}
       end
 
       it 'attempts to authenticate' do
-        app.should_receive(:call).once { |env| env[:body] = 'bar'; raise Restforce::UnauthorizedError.new('something bad') }
+        app.should_receive(:call).once { |env| env[:body] = 'bar'; env[:request] = 'foo'; raise Restforce::UnauthorizedError.new('something bad') }
         middleware.should_receive(:authenticate!)
-        app.should_receive(:call).with(:body => 'foo').once
+        app.should_receive(:call).with(body: 'foo', request: { proxy: nil }).once
         middleware.call(env)
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-17 00:00:00.000000000 Z
+date: 2012-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake