restforce 1.0.1 → 1.0.2

data/lib/restforce.rb

@@ -2,20 +2,21 @@ require 'faraday'
 require 'faraday_middleware'
 require 'json'
 
-require 'openssl'
-require 'base64'
-
 require 'restforce/version'
 require 'restforce/config'
-require 'restforce/mash'
-require 'restforce/collection'
-require 'restforce/sobject'
-require 'restforce/upload_io'
-require 'restforce/client'
-
-require 'restforce/middleware'
 
 module Restforce
+  autoload :SignedRequest, 'restforce/signed_request'
+  autoload :Collection,    'restforce/collection'
+  autoload :Middleware,    'restforce/middleware'
+  autoload :UploadIO,      'restforce/upload_io'
+  autoload :SObject,       'restforce/sobject'
+  autoload :Client,        'restforce/client'
+  autoload :Mash,          'restforce/mash'
+
+  AuthenticationError = Class.new(StandardError)
+  UnauthorizedError   = Class.new(StandardError)
+
   class << self
     # Alias for Restforce::Client.new
     #
@@ -24,25 +25,11 @@ module Restforce
       Restforce::Client.new(options)
     end
 
-    # Public: Decodes a signed request received from Force.com Canvas.
-    #
-    # message       - The POST message containing the signed request from Salesforce.
-    # client_secret - The oauth client secret used to encrypt the message.
-    #
-    # Returns the Hash context if the message is valid.
-    def decode_signed_request(message, client_secret)
-      signature, payload = message.split('.')
-      signature = Base64.decode64(signature)
-      digest = OpenSSL::Digest::Digest.new('sha256')
-      hmac = OpenSSL::HMAC.digest(digest, client_secret, payload)
-      return nil if signature != hmac
-      JSON.parse(Base64.decode64(payload))
+    def decode_signed_request(signed_request, client_secret)
+      SignedRequest.decode(signed_request, client_secret)
     end
   end
 
-  class AuthenticationError < StandardError; end
-  class UnauthorizedError < StandardError; end
-
   # Add .tap method in Ruby 1.8
   module CoreExtensions
     def tap

data/lib/restforce/client/api.rb

@@ -57,7 +57,7 @@ module Restforce
       #   # => { ... }
       #
       # Returns the Hash representation of the describe call.
-      def describe(sobject=nil)
+      def describe(sobject = nil)
         if sobject
           api_get("sobjects/#{sobject.to_s}/describe").body
         else
@@ -116,25 +116,37 @@ module Restforce
       
       # Public: Insert a new record.
       #
+      # sobject - String name of the sobject.
+      # attrs   - Hash of attributes to set on the new record.
+      #
       # Examples
       #
       #   # Add a new account
       #   client.create('Account', Name: 'Foobar Inc.')
       #   # => '0016000000MRatd'
       #
-      # Returns the String Id of the newly created sobject. Returns false if
-      # something bad happens
-      def create(sobject, attrs)
-        create!(sobject, attrs)
+      # Returns the String Id of the newly created sobject.
+      # Returns false if something bad happens.
+      def create(*args)
+        create!(*args)
       rescue *exceptions
         false
       end
       alias_method :insert, :create
 
-      # See .create
+      # Public: Insert a new record.
+      #
+      # sobject - String name of the sobject.
+      # attrs   - Hash of attributes to set on the new record.
+      #
+      # Examples
+      #
+      #   # Add a new account
+      #   client.create!('Account', Name: 'Foobar Inc.')
+      #   # => '0016000000MRatd'
       #
-      # Returns the String Id of the newly created sobject. Raises an error if
-      # something bad happens.
+      # Returns the String Id of the newly created sobject.
+      # Raises exceptions if an error is returned from Salesforce.
       def create!(sobject, attrs)
         api_post("sobjects/#{sobject}", attrs).body['id']
       end
@@ -142,22 +154,34 @@ module Restforce
 
       # Public: Update a record.
       #
+      # sobject - String name of the sobject.
+      # attrs   - Hash of attributes to set on the record.
+      #
       # Examples
       #
       #   # Update the Account with Id '0016000000MRatd'
       #   client.update('Account', Id: '0016000000MRatd', Name: 'Whizbang Corp')
       #
-      # Returns true if the sobject was successfully updated, false otherwise.
-      def update(sobject, attrs)
-        update!(sobject, attrs)
+      # Returns true if the sobject was successfully updated.
+      # Returns false if there was an error.
+      def update(*args)
+        update!(*args)
       rescue *exceptions
         false
       end
 
-      # See .update
+      # Public: Update a record.
+      #
+      # sobject - String name of the sobject.
+      # attrs   - Hash of attributes to set on the record.
+      #
+      # Examples
+      #
+      #   # Update the Account with Id '0016000000MRatd'
+      #   client.update!('Account', Id: '0016000000MRatd', Name: 'Whizbang Corp')
       #
-      # Returns true if the sobject was successfully updated, raises an error
-      # otherwise.
+      # Returns true if the sobject was successfully updated.
+      # Raises an exception if an error is returned from Salesforce.
       def update!(sobject, attrs)
         id = attrs.delete(attrs.keys.find { |k| k.to_s.downcase == 'id' })
         raise 'Id field missing.' unless id
@@ -165,7 +189,7 @@ module Restforce
         true
       end
 
-      # Public: Update or Create a record based on an external ID
+      # Public: Update or create a record based on an external ID
       #
       # sobject - The name of the sobject to created.
       # field   - The name of the external Id field to match against.
@@ -179,17 +203,26 @@ module Restforce
       # Returns true if the record was found and updated.
       # Returns the Id of the newly created record if the record was created.
       # Returns false if something bad happens.
-      def upsert(sobject, field, attrs)
-        upsert!(sobject, field, attrs)
+      def upsert(*args)
+        upsert!(*args)
       rescue *exceptions
         false
       end
 
-      # See .upsert
+      # Public: Update or create a record based on an external ID
+      #
+      # sobject - The name of the sobject to created.
+      # field   - The name of the external Id field to match against.
+      # attrs   - Hash of attributes for the record.
+      #
+      # Examples
+      #
+      #   # Update the record with external ID of 12
+      #   client.upsert!('Account', 'External__c', External__c: 12, Name: 'Foobar')
       #
       # Returns true if the record was found and updated.
       # Returns the Id of the newly created record if the record was created.
-      # Raises an error if something bad happens.
+      # Raises an exception if an error is returned from Salesforce.
       def upsert!(sobject, field, attrs)
         external_id = attrs.delete(attrs.keys.find { |k| k.to_s.downcase == field.to_s.downcase })
         response = api_patch "sobjects/#{sobject}/#{field.to_s}/#{external_id}", attrs
@@ -198,22 +231,34 @@ module Restforce
 
       # Public: Delete a record.
       #
+      # sobject - String name of the sobject.
+      # id      - The Salesforce ID of the record.
+      #
       # Examples
       #
       #   # Delete the Account with Id '0016000000MRatd'
-      #   client.delete('Account', '0016000000MRatd')
+      #   client.destroy('Account', '0016000000MRatd')
       #
-      # Returns true if the sobject was successfully deleted, false otherwise.
-      def destroy(sobject, id)
-        destroy!(sobject, id)
+      # Returns true if the sobject was successfully deleted.
+      # Returns false if an error is returned from Salesforce.
+      def destroy(*args)
+        destroy!(*args)
       rescue *exceptions
         false
       end
 
-      # See .destroy
+      # Public: Delete a record.
+      #
+      # sobject - String name of the sobject.
+      # id      - The Salesforce ID of the record.
+      #
+      # Examples
+      #
+      #   # Delete the Account with Id '0016000000MRatd'
+      #   client.destroy('Account', '0016000000MRatd')
       #
-      # Returns true of the sobject was successfully deleted, raises an error
-      # otherwise.
+      # Returns true of the sobject was successfully deleted.
+      # Raises an exception if an error is returned from Salesforce.
       def destroy!(sobject, id)
         api_delete "sobjects/#{sobject}/#{id}"
         true

data/lib/restforce/client/authentication.rb

@@ -4,7 +4,7 @@ module Restforce
 
       # Public: Force an authentication
       def authenticate!
-        raise 'No authentication middleware present' unless authentication_middleware
+        raise AuthenticationError, 'No authentication middleware present' unless authentication_middleware
         middleware = authentication_middleware.new nil, self, @options
         middleware.authenticate!
       end

data/lib/restforce/client/canvas.rb

@@ -2,14 +2,9 @@ module Restforce
   class Client
     module Canvas
 
-      # Public: Decodes a signed request received from Force.com Canvas.
-      #
-      # message - The POST message containing the signed request from Salesforce.
-      #
-      # Returns the Hash context if the message is valid.
-      def decode_signed_request(message)
+      def decode_signed_request(signed_request)
         raise 'client_secret not set' unless @options[:client_secret]
-        Restforce.decode_signed_request(message, @options[:client_secret])
+        SignedRequestd.decode(signed_request, @options[:client_secret])
       end
 
     end

data/lib/restforce/signed_request.rb

@@ -0,0 +1,48 @@
+require 'openssl'
+require 'base64'
+require 'json'
+
+module Restforce
+  class SignedRequest
+    # Public: Initializes and decodes the signed request
+    #
+    # signed_request - The POST message containing the signed request from Salesforce.
+    # client_secret  - The oauth client secret used to encrypt the signed request.
+    #
+    # Returns the parsed JSON context.
+    def self.decode(signed_request, client_secret)
+      new(signed_request, client_secret).decode
+    end
+
+    def initialize(signed_request, client_secret)
+      @client_secret = client_secret
+      split_components(signed_request)
+    end
+
+    # Public: Decode the signed request.
+    #
+    # Returns the parsed JSON context.
+    # Returns nil if the signed request is invalid.
+    def decode
+      return nil if signature != hmac
+      JSON.parse(Base64.decode64(payload))
+    end
+    
+  private
+    attr_reader :client_secret, :signature, :payload
+
+    def split_components(signed_request)
+      @signature, @payload = signed_request.split('.')
+      @signature = Base64.decode64(@signature)
+    end
+
+    def hmac
+      OpenSSL::HMAC.digest(digest, client_secret, payload)
+    end
+
+    def digest
+      OpenSSL::Digest::Digest.new('sha256')
+    end
+
+  end
+end

data/lib/restforce/version.rb

@@ -1,3 +1,3 @@
 module Restforce
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/spec/lib/client_spec.rb

@@ -265,19 +265,31 @@ shared_examples_for 'methods' do
   end
 
   describe '.authenticate!' do
-    before do
-      @request = stub_login_request(:with_body => "grant_type=password&client_id=client_id&client_secret=" \
-        "client_secret&username=foo&password=barsecurity_token").
-        to_return(:status => 200, :body => fixture(:auth_success_response))
-    end
+    subject { client.authenticate! }
 
-    after do
-      expect(@request).to have_been_requested
+    context 'when successful' do
+      before do
+        @request = stub_login_request(:with_body => "grant_type=password&client_id=client_id&client_secret=" \
+          "client_secret&username=foo&password=barsecurity_token").
+          to_return(:status => 200, :body => fixture(:auth_success_response))
+      end
+
+      after do
+        expect(@request).to have_been_requested
+      end
+
+      it { should be_a Hash }
     end
 
-    subject { client.authenticate! }
-    specify { expect { subject }.to_not raise_error }
-    it { should be_a Hash }
+    context 'when no authentication middleware is present' do
+      before do
+        client.stub(:authentication_middleware).and_return(nil)
+      end
+
+      it 'should raise an exception' do
+        expect { subject }.to raise_error Restforce::AuthenticationError, 'No authentication middleware present'
+      end
+    end
   end
 
   describe '.cache' do
@@ -287,26 +299,6 @@ shared_examples_for 'methods' do
     it { should eq cache }
   end
 
-  describe '.decode_signed_request' do
-    subject { client.decode_signed_request(message) }
-
-    context 'when the message is valid' do
-      let(:data) { Base64.encode64('{ "key": "value" }') }
-      let(:message) do
-        digest = OpenSSL::Digest::Digest.new('sha256')
-        signature = Base64.encode64(OpenSSL::HMAC.digest(digest, client_secret, data))
-        "#{signature}.#{data}"
-      end
-
-      it { should eq('key' => 'value') }
-    end
-
-    context 'when the message is invalid' do
-      let(:message) { 'foobar.awdkjkj' }
-      it { should be_nil }
-    end
-  end
-
   describe '.middleware' do
     subject { client.middleware }
     it { should eq client.send(:connection).builder }

data/spec/lib/signed_request_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Restforce::SignedRequest do
+  let(:client_secret) { 'foo' }
+  let(:message) do
+    digest = OpenSSL::Digest::Digest.new('sha256')
+    signature = Base64.encode64(OpenSSL::HMAC.digest(digest, client_secret, data))
+    "#{signature}.#{data}"
+  end
+
+  describe '.decode' do
+    subject { described_class.new(message, client_secret).decode }
+
+    context 'when the message is valid' do
+      let(:data) { Base64.encode64('{"key": "value"}') }
+      it { should eq('key' => 'value') }
+    end
+
+    context 'when the message is invalid' do
+      let(:message) { 'foobar.awdkjkj' }
+      it { should be_nil }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-31 00:00:00.000000000 Z
+date: 2013-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -177,6 +177,7 @@ files:
 - lib/restforce/middleware/mashify.rb
 - lib/restforce/middleware/multipart.rb
 - lib/restforce/middleware/raise_error.rb
+- lib/restforce/signed_request.rb
 - lib/restforce/sobject.rb
 - lib/restforce/upload_io.rb
 - lib/restforce/version.rb
@@ -225,6 +226,7 @@ files:
 - spec/lib/middleware/logger_spec.rb
 - spec/lib/middleware/mashify_spec.rb
 - spec/lib/middleware/raise_error_spec.rb
+- spec/lib/signed_request_spec.rb
 - spec/lib/sobject_spec.rb
 - spec/spec_helper.rb
 - spec/support/basic_client.rb
@@ -299,6 +301,7 @@ test_files:
 - spec/lib/middleware/logger_spec.rb
 - spec/lib/middleware/mashify_spec.rb
 - spec/lib/middleware/raise_error_spec.rb
+- spec/lib/signed_request_spec.rb
 - spec/lib/sobject_spec.rb
 - spec/spec_helper.rb
 - spec/support/basic_client.rb