restforce 0.0.1 → 0.0.2

data/README.md

@@ -1,4 +1,4 @@
-# Restforce [![travis-ci](https://secure.travis-ci.org/ejholmes/restforce.png)](https://secure.travis-ci.org/ejholmes/restforce)
+# Restforce [![travis-ci](https://secure.travis-ci.org/ejholmes/restforce.png)](https://secure.travis-ci.org/ejholmes/restforce) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/ejholmes/restforce)
 
 Restforce is a ruby gem for the [Salesforce REST api](http://www.salesforce.com/us/developer/docs/api_rest/index.htm).
 It's meant to be a lighter weight alternative to the [databasedotcom gem](https://github.com/heroku/databasedotcom).
@@ -10,13 +10,14 @@ It attempts to solve a couple of key issues that the databasedotcom gem has been
 * Support for aggregate queries.
 * Remove the need to materialize constants.
 * Support for the Streaming API
+* Support for blob data types.
 * A clean and modular architecture using [Faraday middleware](https://github.com/technoweenie/faraday)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'restforce
+    gem 'restforce'
 
 And then execute:
 
@@ -43,8 +44,6 @@ If you're using the gem to interact with a single org (maybe you're building som
 salesforce integration internally?) then you should use the username/password
 authentication method.
 
-If you have an access token and an instance url obtained through oauth:
-
 #### OAuth token authentication
 
 ```ruby
@@ -151,6 +150,14 @@ client.destroy('Account', '0016000000MRatd')
 # => true
 ```
 
+### File Uploads
+
+```ruby
+client.create 'Document', FolderId: '00lE0000000FJ6H',
+  Description: 'Document test',
+  Name: 'My image',
+  Body: Restforce::UploadIO.new(File.expand_path('image.jpg', __FILE__), 'image/jpeg'))
+```
 
 ## Contributing
 

data/lib/restforce.rb

@@ -7,6 +7,7 @@ require 'restforce/config'
 require 'restforce/mash'
 require 'restforce/collection'
 require 'restforce/sobject'
+require 'restforce/upload_io'
 require 'restforce/client'
 
 require 'restforce/middleware'

data/lib/restforce/client.rb

@@ -163,10 +163,20 @@ module Restforce
     #   # Update the Account with Id '0016000000MRatd'
     #   client.update('Account', Id: '0016000000MRatd', Name: 'Whizbang Corp')
     #
-    # Returns true if the sobject was successfully update, false otherwise.
+    # Returns true if the sobject was successfully updated, false otherwise.
     def update(sobject, attrs)
+      update!(sobject, attrs)
+    rescue Faraday::Error::ResourceNotFound
+      false
+    end
+
+    # See .update
+    #
+    # Returns true if the sobject was successfully updated, raises an error
+    # otherwise.
+    def update!(sobject, attrs)
       id = attrs.has_key?(:Id) ? attrs.delete(:Id) : attrs.delete('Id')
-      response = api_patch "sobjects/#{sobject}/#{id}", attrs
+      api_patch "sobjects/#{sobject}/#{id}", attrs
       true
     end
 
@@ -179,7 +189,17 @@ module Restforce
     #
     # Returns true if the sobject was successfully deleted, false otherwise.
     def destroy(sobject, id)
-      response = api_delete "sobjects/#{sobject}/#{id}"
+      destroy!(sobject, id)
+    rescue Faraday::Error::ResourceNotFound
+      false
+    end
+
+    # See .destroy
+    #
+    # Returns true of the sobject was successfully deleted, raises an error
+    # otherwise.
+    def destroy!(sobject, id)
+      api_delete "sobjects/#{sobject}/#{id}"
       true
     end
 
@@ -237,6 +257,7 @@ module Restforce
     def connection
       @connection ||= Faraday.new do |builder|
         builder.use Restforce::Middleware::Mashify, self, @options
+        builder.use Restforce::Middleware::Multipart
         builder.request :json
         builder.use authentication_middleware, self, @options if authentication_middleware
         builder.use Restforce::Middleware::Authorization, self, @options
@@ -246,7 +267,6 @@ module Restforce
         builder.response :json
         builder.adapter Faraday.default_adapter
       end
-      @connection.headers['Content-Type'] = 'application/json'
       @connection
     end
 

data/lib/restforce/middleware.rb

@@ -28,3 +28,4 @@ require 'restforce/middleware/authentication/oauth'
 require 'restforce/middleware/authorization'
 require 'restforce/middleware/instance_url'
 require 'restforce/middleware/mashify'
+require 'restforce/middleware/multipart'

data/lib/restforce/middleware/multipart.rb

@@ -0,0 +1,53 @@
+module Restforce
+  class Middleware::Multipart < Faraday::Request::UrlEncoded
+    self.mime_type = 'multipart/form-data'.freeze
+    DEFAULT_BOUNDARY = "--boundary_string".freeze
+
+    def call(env)
+      match_content_type(env) do |params|
+        env[:request] ||= {}
+        env[:request][:boundary] ||= DEFAULT_BOUNDARY
+        env[:request_headers][CONTENT_TYPE] += ";boundary=#{env[:request][:boundary]}"
+        env[:body] = create_multipart(env, params)
+      end
+      @app.call env
+    end
+
+    def process_request?(env)
+      type = request_type(env)
+      env[:body].respond_to?(:each_key) and !env[:body].empty? and (
+        (type.empty? and has_multipart?(env[:body])) or
+        type == self.class.mime_type
+      )
+    end
+
+    def has_multipart?(obj)
+      # string is an enum in 1.8, returning list of itself
+      if obj.respond_to?(:each) && !obj.is_a?(String)
+        (obj.respond_to?(:values) ? obj.values : obj).each do |val|
+          return true if (val.respond_to?(:content_type) || has_multipart?(val))
+        end
+      end
+      false
+    end
+
+    def create_multipart(env, params)
+      boundary = env[:request][:boundary]
+
+      parts = []
+      skip  = []
+      params.each do |key, value|
+        if value.respond_to? :content_type
+          parts << Faraday::Parts::Part.new(boundary, key.to_s, value); skip << key
+        end
+      end
+      parts << Faraday::Parts::Part.new(boundary, 'entity_content', params.reject { |key, _| skip.include? key }.to_json)
+      parts.reverse!
+      parts << Faraday::Parts::EpiloguePart.new(boundary)
+
+      body = Faraday::CompositeReadIO.new(parts)
+      env[:request_headers]['Content-Length'] = body.length.to_s
+      return body
+    end
+  end
+end

data/lib/restforce/upload_io.rb

@@ -0,0 +1,20 @@
+require 'faraday/upload_io'
+
+module Restforce
+  UploadIO = Faraday::UploadIO
+end
+
+module Faraday
+  module Parts
+    class ParamPart
+      def build_part(boundary, name, value)
+        part = ''
+        part << "--#{boundary}\r\n"
+        part << "Content-Disposition: form-data; name=\"#{name.to_s}\";\r\n"
+        part << "Content-Type: application/json\r\n"
+        part << "\r\n"
+        part << "#{value}\r\n"
+      end
+    end
+  end
+end

data/lib/restforce/version.rb

@@ -1,3 +1,3 @@
 module Restforce
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/restforce.gemspec

@@ -23,6 +23,5 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'webmock'
-  gem.add_development_dependency 'mocha'
   gem.add_development_dependency 'simplecov'
 end

data/spec/lib/client_spec.rb

@@ -55,7 +55,11 @@ shared_examples_for 'methods' do
   
   describe '.describe_sobjects' do
     before do
-      stub_api_request :sobjects, with: 'sobject/describe_sobjects_success_response'
+      @request = stub_api_request :sobjects, with: 'sobject/describe_sobjects_success_response'
+    end
+
+    after do
+      @request.should have_been_requested
     end
 
     subject { client.describe_sobjects }
@@ -64,7 +68,11 @@ shared_examples_for 'methods' do
 
   describe '.list_sobjects' do
     before do
-      stub_api_request :sobjects, with: 'sobject/describe_sobjects_success_response'
+      @request = stub_api_request :sobjects, with: 'sobject/describe_sobjects_success_response'
+    end
+
+    after do
+      @request.should have_been_requested
     end
 
     subject { client.list_sobjects }
@@ -74,7 +82,11 @@ shared_examples_for 'methods' do
 
   describe '.describe' do
     before do
-      stub_api_request 'sobject/Whizbang/describe', with: 'sobject/sobject_describe_success_response'
+      @request = stub_api_request 'sobject/Whizbang/describe', with: 'sobject/sobject_describe_success_response'
+    end
+
+    after do
+      @request.should have_been_requested
     end
 
     subject { client.describe('Whizbang') }
@@ -83,7 +95,11 @@ shared_examples_for 'methods' do
 
   describe '.query' do
     before do
-      stub_api_request :query, with: 'sobject/query_success_response'
+      @request = stub_api_request 'query\?q=SELECT%20some,%20fields%20FROM%20object', with: 'sobject/query_success_response'
+    end
+
+    after do
+      @request.should have_been_requested
     end
 
     subject { client.query('SELECT some, fields FROM object') }
@@ -92,7 +108,11 @@ shared_examples_for 'methods' do
 
   describe '.search' do
     before do
-      stub_api_request :search, with: 'sobject/search_success_response'
+      @request = stub_api_request 'search\?q=FIND%20%7Bbar%7D', with: 'sobject/search_success_response'
+    end
+
+    after do
+      @request.should have_been_requested
     end
 
     subject { client.search('FIND {bar}') }
@@ -102,7 +122,11 @@ shared_examples_for 'methods' do
 
   describe '.org_id' do
     before do
-      stub_api_request :query, with: 'sobject/org_query_response'
+      @request = stub_api_request 'query\?q=select%20id%20from%20Organization', with: 'sobject/org_query_response'
+    end
+
+    after do
+      @request.should have_been_requested
     end
 
     subject { client.org_id }
@@ -110,21 +134,64 @@ shared_examples_for 'methods' do
   end
 
   describe '.create' do
-    before do
-      @request = stub_api_request 'sobjects/Account', with: 'sobject/create_success_response', method: :post, body: "{\"Name\":\"Foobar\"}"
+    context 'without multipart' do
+      before do
+        @request = stub_api_request 'sobjects/Account', with: 'sobject/create_success_response', method: :post, body: "{\"Name\":\"Foobar\"}"
+      end
+
+      after do
+        @request.should have_been_requested
+      end
+
+      subject { client.create('Account', Name: 'Foobar') }
+      it { should eq 'some_id' }
     end
 
-    after do
-      @request.should have_been_requested
+    context 'with multipart' do
+      before do
+        @request = stub_api_request 'sobjects/Account', with: 'sobject/create_success_response', method: :post, body: %r(----boundary_string\r\nContent-Disposition: form-data; name=\"entity_content\";\r\nContent-Type: application/json\r\n\r\n{\"Name\":\"Foobar\"}\r\n----boundary_string\r\nContent-Disposition: form-data; name=\"Blob\"; filename=\"blob.jpg\"\r\nContent-Length: 42171\r\nContent-Type: image/jpeg\r\nContent-Transfer-Encoding: binary)
+      end
+
+      after do
+        @request.should have_been_requested
+      end
+
+      subject { client.create('Account', Name: 'Foobar', Blob: Restforce::UploadIO.new(File.expand_path('../../fixtures/blob.jpg', __FILE__), 'image/jpeg')) }
+      it { should eq 'some_id' }
     end
+  end
+
+  describe '.update!' do
+    context 'with invalid Id' do
+      before do
+        @request = stub_api_request 'sobjects/Account/001D000000INjVe', with: 'sobject/delete_error_response', method: :patch, body: "{\"Name\":\"Foobar\"}", status: 404
+      end
+
+      after do
+        @request.should have_been_requested
+      end
 
-    subject { client.create('Account', Name: 'Foobar') }
-    it { should eq 'some_id' }
+      subject { client.update!('Account', Id: '001D000000INjVe', Name: 'Foobar') }
+      specify { expect { subject }.to raise_error Faraday::Error::ResourceNotFound }
+    end
   end
 
   describe '.update' do
-    pending 'with invalid Id'
     pending 'with missing Id'
+
+    context 'with invalid Id' do
+      before do
+        @request = stub_api_request 'sobjects/Account/001D000000INjVe', with: 'sobject/delete_error_response', method: :patch, body: "{\"Name\":\"Foobar\"}", status: 404
+      end
+
+      after do
+        @request.should have_been_requested
+      end
+
+      subject { client.update('Account', Id: '001D000000INjVe', Name: 'Foobar') }
+      it { should be_false }
+    end
+
     context 'with success' do
       before do
         @request = stub_api_request 'sobjects/Account/001D000000INjVe', method: :patch, body: "{\"Name\":\"Foobar\"}"
@@ -146,8 +213,48 @@ shared_examples_for 'methods' do
     end
   end
 
+  describe '.destroy!' do
+    subject { client.destroy!('Account', '001D000000INjVe') }
+
+    context 'with invalid Id' do
+      before do
+        @request = stub_api_request 'sobjects/Account/001D000000INjVe', with: 'sobject/delete_error_response', method: :delete, status: 404
+      end
+
+      after do
+        @request.should have_been_requested
+      end
+
+      specify { expect { subject }.to raise_error Faraday::Error::ResourceNotFound }
+    end
+
+    context 'with success' do
+      before do 
+        @request = stub_api_request 'sobjects/Account/001D000000INjVe', method: :delete
+      end
+
+      after do
+        @request.should have_been_requested
+      end
+
+      it { should be_true }
+    end
+  end
+
   describe '.destroy' do
-    pending 'with invalid Id'
+    subject { client.destroy('Account', '001D000000INjVe') }
+
+    context 'with invalid Id' do
+      before do
+        @request = stub_api_request 'sobjects/Account/001D000000INjVe', with: 'sobject/delete_error_response', method: :delete, status: 404
+      end
+
+      after do
+        @request.should have_been_requested
+      end
+
+      it { should be_false }
+    end
 
     context 'with success' do
       before do 
@@ -158,7 +265,6 @@ shared_examples_for 'methods' do
         @request.should have_been_requested
       end
 
-      subject { client.destroy('Account', '001D000000INjVe') }
       it { should be_true }
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-03 00:00:00.000000000 Z
+date: 2012-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70254027887340 !ruby/object:Gem::Requirement
+  requirement: &70194283587720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70254027887340
+  version_requirements: *70194283587720
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70254027886840 !ruby/object:Gem::Requirement
+  requirement: &70194283586980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.8.4
   type: :runtime
   prerelease: false
-  version_requirements: *70254027886840
+  version_requirements: *70194283586980
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70254027886340 !ruby/object:Gem::Requirement
+  requirement: &70194283586260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.8.8
   type: :runtime
   prerelease: false
-  version_requirements: *70254027886340
+  version_requirements: *70194283586260
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70254027885880 !ruby/object:Gem::Requirement
+  requirement: &70194283585800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.7.5
   type: :runtime
   prerelease: false
-  version_requirements: *70254027885880
+  version_requirements: *70194283585800
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70254027885420 !ruby/object:Gem::Requirement
+  requirement: &70194283601640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70254027885420
+  version_requirements: *70194283601640
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70254027885040 !ruby/object:Gem::Requirement
+  requirement: &70194283601040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70254027885040
+  version_requirements: *70194283601040
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70254027884580 !ruby/object:Gem::Requirement
+  requirement: &70194283600360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,21 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70254027884580
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: &70254027884160 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70254027884160
+  version_requirements: *70194283600360
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70254027883740 !ruby/object:Gem::Requirement
+  requirement: &70194283599880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70254027883740
+  version_requirements: *70194283599880
 description: A lightweight ruby client for the Salesforce REST api.
 email:
 - eric@ejholmes.net
@@ -136,12 +125,15 @@ files:
 - lib/restforce/middleware/authorization.rb
 - lib/restforce/middleware/instance_url.rb
 - lib/restforce/middleware/mashify.rb
+- lib/restforce/middleware/multipart.rb
 - lib/restforce/middleware/raise_error.rb
 - lib/restforce/sobject.rb
+- lib/restforce/upload_io.rb
 - lib/restforce/version.rb
 - restforce.gemspec
 - spec/fixtures/auth_error_response.json
 - spec/fixtures/auth_success_response.json
+- spec/fixtures/blob.jpg
 - spec/fixtures/expired_session_response.json
 - spec/fixtures/reauth_success_response.json
 - spec/fixtures/refresh_error_response.json
@@ -212,6 +204,7 @@ summary: A lightweight ruby client for the Salesforce REST api.
 test_files:
 - spec/fixtures/auth_error_response.json
 - spec/fixtures/auth_success_response.json
+- spec/fixtures/blob.jpg
 - spec/fixtures/expired_session_response.json
 - spec/fixtures/reauth_success_response.json
 - spec/fixtures/refresh_error_response.json