restforce 0.0.1

data/spec/lib/middleware/authentication_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Restforce::Middleware::Authentication do
+  let(:app)        { double('app')            }
+  let(:env)        { { }  }
+  let(:options)    { { host: 'login.salesforce.com' } }
+  let(:middleware) { described_class.new app, nil, options }
+
+  describe '.authenticate!' do
+    it 'raises an error' do
+      expect {
+        middleware.authenticate!
+      }.to raise_error RuntimeError, 'must subclass'
+    end
+  end
+
+  describe '.call' do
+    context 'when all is good' do
+      before do
+        app.should_receive(:call).once
+      end
+
+      it 'calls the next middlware' do
+        middleware.call(env)
+      end
+    end
+
+    context 'when an exception is thrown' do
+      before do
+        app.should_receive(:call).once.and_raise(Restforce::UnauthorizedError.new('something bad'))
+        middleware.should_receive(:authenticate!)
+        app.should_receive(:call).once
+      end
+
+      it 'attempts to authenticate' do
+        middleware.call(env)
+      end
+    end
+  end
+
+  describe '.connection' do
+    subject { middleware.connection }
+
+    its(:url_prefix) { should eq URI.parse('https://login.salesforce.com') }
+
+    describe '.builder' do
+      subject { middleware.connection.builder }
+
+      context 'with logging disabled' do
+        before do
+          Restforce.stub!(:log?).and_return(false)
+        end
+
+        its(:handlers) { should include FaradayMiddleware::ParseJson, Faraday::Adapter::NetHttp }
+        its(:handlers) { should_not include Faraday::Response::Logger  }
+      end
+
+      context 'with logging enabled' do
+        before do
+          Restforce.stub!(:log?).and_return(true)
+        end
+
+        its(:handlers) { should include FaradayMiddleware::ParseJson, Faraday::Response::Logger, Faraday::Adapter::NetHttp }
+      end
+    end
+  end
+end

data/spec/lib/middleware/authorization_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Restforce::Middleware::Authorization do
+  let(:app)        { double('app')            }
+  let(:env)        { { request_headers: {} }  }
+  let(:options)    { { oauth_token: 'token' } }
+  let(:middleware) { described_class.new app, nil, options }
+
+  before do
+    app.should_receive(:call)
+    middleware.call(env)
+  end
+
+  it 'adds the oauth token to the headers' do
+    env[:request_headers]['Authorization'].should eq 'OAuth token'
+  end
+end

data/spec/lib/middleware/instance_url_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Restforce::Middleware::InstanceURL do
+  let(:app)        { double('app') }
+  let(:client)     { double('client') }
+  let(:options)    { { :instance_url => instance_url } }
+  let(:middleware) { described_class.new app, client, options }
+  
+  context 'when the instance url is not set' do
+    let(:instance_url) { nil }
+
+    it 'raises an error' do
+      expect {
+        middleware.call(nil)
+      }.to raise_error Restforce::UnauthorizedError
+    end
+  end
+
+  context 'when the instance url is set' do
+    let(:instance_url) { 'https://foo.bar' }
+
+    before do
+      client.stub_chain(:connection, :url_prefix).and_return URI.parse(url_prefix)
+    end
+
+    context 'and it does not match the connection url prefix' do
+      let(:url_prefix) { 'https://whiz.bang' }
+
+      it 'raises an error' do
+        expect {
+          middleware.call(nil)
+        }.to raise_error Restforce::InstanceURLError
+      end
+    end
+
+    context 'and it matches the connection url prefix' do
+      let(:url_prefix) { 'https://foo.bar' }
+      
+      before do
+        app.should_receive(:call)
+      end
+
+      it 'calls tne next middleware' do
+        middleware.call(nil)
+      end
+    end
+  end
+end

data/spec/lib/middleware/mashify_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Restforce::Middleware::Mashify do
+  let(:app)        { double('app')            }
+  let(:options)    { { } }
+  let(:middleware) { described_class.new app, nil, options }
+
+  before do
+    app.should_receive(:call)
+    middleware.call(env)
+  end
+
+  context 'when the body contains a records key' do
+    let(:env) { { body: JSON.parse(fixture('sobject/query_success_response')) } }
+
+    it 'converts the response body into a restforce collection' do
+      env[:body].should be_a Restforce::Collection
+    end
+  end
+
+  context 'when the body does not contain records' do
+    let(:env) { { body: { 'foo' => 'bar' } } }
+
+    it 'does not touch the body' do
+      env[:body].foo.should eq 'bar'
+    end
+  end
+end

data/spec/lib/middleware/raise_error_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Restforce::Middleware::RaiseError do
+  let(:app)        { double('app') }
+  let(:body)       { JSON.parse(fixture('sobject/query_error_response')) }
+  let(:env)        { { status: status, body: body } }
+  let(:middleware) { described_class.new app }
+
+  describe '.on_complete' do
+    subject { middleware.on_complete(env) }
+
+    context 'when the status code is 404' do
+      let(:status) { 404 }
+      specify { expect { subject }.to raise_error Faraday::Error::ResourceNotFound, 'INVALID_FIELD: error_message' }
+    end
+
+    context 'when the status code is 400' do
+      let(:status) { 400 }
+      specify { expect { subject }.to raise_error Faraday::Error::ClientError, 'INVALID_FIELD: error_message' }
+    end
+
+    context 'when the status code is 401' do
+      let(:status) { 401 }
+      specify { expect { subject }.to raise_error Restforce::UnauthorizedError, 'INVALID_FIELD: error_message' }
+    end
+  end
+end

data/spec/lib/sobject_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+RSpec::Matchers.define :have_client do |expected|
+  match do |actual|
+    actual.instance_variable_get(:@client) == expected
+  end
+end
+
+describe Restforce::SObject do
+  include_context 'basic client'
+
+  let(:hash) { JSON.parse(fixture('sobject/query_success_response'))['records'].first }
+  let(:sobject) do
+    described_class.new(hash, client)
+  end
+
+  describe '#new' do
+    context 'with valid options' do
+      subject            { sobject }
+      it                 { should be_a Restforce::SObject }
+      its(:sobject_type) { should eq 'Whizbang' }
+      its(:Text_Label)   { should eq 'Hi there!' }
+      it { should have_client client }
+
+      describe 'children' do
+        subject { sobject.Whizbangs__r }
+
+        it { should be_a Restforce::Collection }
+
+        describe 'each child' do
+          it 'should be a Restforce::SObject' do
+            sobject.Whizbangs__r.each { |sobject| sobject.should be_a Restforce::SObject }
+          end
+
+          it 'should set the client' do
+            sobject.Whizbangs__r.each { |sobject| sobject.should have_client client }
+          end
+        end
+      end
+
+      describe 'parent' do
+        subject { sobject.ParentWhizbang__r }
+
+        it { should be_a Restforce::SObject }
+        its(:sobject_type) { should eq 'Whizbang' }
+        its(:Name) { should eq 'Parent Whizbang' }
+        it { should have_client client }
+      end
+    end
+  end
+
+  describe '.save' do
+    subject { sobject.save }
+
+    context 'when an Id was not queried' do
+      specify { expect { subject }.to raise_error RuntimeError, 'You need to query the Id for the record first.' }
+    end
+
+    context 'when an Id is present' do
+      before do
+        hash.merge!(Id: '001D000000INjVe')
+        @request = stub_api_request 'sobjects/Whizbang/001D000000INjVe', method: :patch, body: "{\"Checkbox_Label\":false,\"Text_Label\":\"Hi there!\",\"Date_Label\":\"2010-01-01\",\"DateTime_Label\":\"2011-07-07T00:37:00.000+0000\",\"Picklist_Multiselect_Label\":\"four;six\"}"
+      end
+
+      after do
+        @request.should have_been_requested
+      end
+
+      specify { expect { subject }.to_not raise_error }
+    end
+  end
+
+  describe '.destroy' do
+    subject { sobject.destroy }
+
+    context 'when an Id was not queried' do
+      specify { expect { subject }.to raise_error RuntimeError, 'You need to query the Id for the record first.' }
+    end
+
+    context 'when an Id is present' do
+      before do 
+        hash.merge!(Id: '001D000000INjVe')
+        @request = stub_api_request 'sobjects/Whizbang/001D000000INjVe', method: :delete
+      end
+
+      after do
+        @request.should have_been_requested
+      end
+
+      specify { expect { subject }.to_not raise_error }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'bundler/setup'
+Bundler.require :default, :test
+
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each {|f| require f}
+
+RSpec.configure do |config|
+  config.include FixtureHelpers
+end

data/spec/support/basic_client.rb

@@ -0,0 +1,35 @@
+shared_context 'basic client' do
+  let(:oauth_token)    { '00Dx0000000BV7z!AR8AQAxo9UfVkh8AlV0Gomt9Czx9LjHnSSpwBMmbRcgKFmxOtvxjTrKW19ye6PE3Ds1eQz3z8jr3W7_VbWmEu4Q8TVGSTHxs' }
+  let(:refresh_token)  { 'refresh' }
+  let(:instance_url)   { 'https://na1.salesforce.com' }
+  let(:username)       { 'foo'            }
+  let(:password)       { 'bar'            }
+  let(:security_token) { 'security_token' }
+  let(:client_id)      { 'client_id'      }
+  let(:client_secret)  { 'client_secret'  }
+
+  let(:base_options) do
+    {
+      :oauth_token    => oauth_token,
+      :refresh_token  => refresh_token,
+      :instance_url   => instance_url,
+      :username       => username,
+      :password       => password,
+      :security_token => security_token,
+      :client_id      => client_id,
+      :client_secret  => client_secret
+    }
+  end
+
+  let(:oauth_options) do
+    base_options.merge(:username => nil, :password => nil, :security_token => nil)
+  end
+
+  let(:password_options) do
+    base_options.merge(:oauth_token => nil, :refresh_token => nil, :instance_url => nil)
+  end
+
+  let(:client_options) { base_options }
+
+  let(:client) { Restforce::Client.new client_options }
+end

data/spec/support/fixture_helpers.rb

@@ -0,0 +1,20 @@
+module FixtureHelpers
+
+  def stub_api_request(endpoint, options = {})
+    options = {
+      :method => :get,
+      :status => 200,
+      :api_version => '24.0',
+      :with => nil
+    }.merge(options)
+
+    stub = stub_request(options[:method], %r{/services/data/v#{options[:api_version]}/#{endpoint}})
+    stub = stub.with(:body => options[:body]) if options[:body]
+    stub = stub.to_return(:status => options[:status], :body => options[:with] ? fixture(options[:with]) : '')
+  end
+
+  def fixture(f)
+    File.read(File.expand_path("../../fixtures/#{f}.json", __FILE__))
+  end
+
+end

data/spec/support/middleware.rb

@@ -0,0 +1,33 @@
+shared_examples_for 'authentication middleware' do
+  describe '.authenticate!' do
+    after do
+      request.should have_been_requested
+    end
+
+    context 'when successful' do
+      let!(:request) { success_request }
+
+      before do
+        middleware.authenticate!
+      end
+
+      describe '@options' do
+        subject { options }
+
+        its([:instance_url]) { should eq 'https://na1.salesforce.com' }
+        its([:oauth_token])  { should eq '00Dx0000000BV7z!AR8AQAxo9UfVkh8AlV0Gomt9Czx9LjHnSSpwBMmbRcgKFmxOtvxjTrKW19ye6PE3Ds1eQz3z8jr3W7_VbWmEu4Q8TVGSTHxs' }
+      end
+    end
+
+    context 'when unsuccessful' do
+      let!(:request) { fail_request }
+
+      it 'raises an exception' do
+        expect {
+          middleware.authenticate!
+        }.to raise_error Restforce::AuthenticationError
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,257 @@
+--- !ruby/object:Gem::Specification
+name: restforce
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eric J. Holmes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70254027887340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70254027887340
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70254027886840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *70254027886840
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: &70254027886340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: *70254027886340
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70254027885880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *70254027885880
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70254027885420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70254027885420
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70254027885040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70254027885040
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70254027884580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        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
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70254027883740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70254027883740
+description: A lightweight ruby client for the Salesforce REST api.
+email:
+- eric@ejholmes.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/restforce.rb
+- lib/restforce/client.rb
+- lib/restforce/collection.rb
+- lib/restforce/config.rb
+- lib/restforce/mash.rb
+- lib/restforce/middleware.rb
+- lib/restforce/middleware/authentication.rb
+- lib/restforce/middleware/authentication/oauth.rb
+- lib/restforce/middleware/authentication/password.rb
+- lib/restforce/middleware/authorization.rb
+- lib/restforce/middleware/instance_url.rb
+- lib/restforce/middleware/mashify.rb
+- lib/restforce/middleware/raise_error.rb
+- lib/restforce/sobject.rb
+- lib/restforce/version.rb
+- restforce.gemspec
+- spec/fixtures/auth_error_response.json
+- spec/fixtures/auth_success_response.json
+- spec/fixtures/expired_session_response.json
+- spec/fixtures/reauth_success_response.json
+- spec/fixtures/refresh_error_response.json
+- spec/fixtures/refresh_success_response.json
+- spec/fixtures/services_data_success_response.json
+- spec/fixtures/sobject/create_success_response.json
+- spec/fixtures/sobject/delete_error_response.json
+- spec/fixtures/sobject/describe_sobjects_success_response.json
+- spec/fixtures/sobject/list_sobjects_success_response.json
+- spec/fixtures/sobject/org_query_response.json
+- spec/fixtures/sobject/query_aggregate_success_response.json
+- spec/fixtures/sobject/query_empty_response.json
+- spec/fixtures/sobject/query_error_response.json
+- spec/fixtures/sobject/query_paginated_first_page_response.json
+- spec/fixtures/sobject/query_paginated_last_page_response.json
+- spec/fixtures/sobject/query_success_response.json
+- spec/fixtures/sobject/recent_success_response.json
+- spec/fixtures/sobject/search_error_response.json
+- spec/fixtures/sobject/search_success_response.json
+- spec/fixtures/sobject/sobject_describe_error_response.json
+- spec/fixtures/sobject/sobject_describe_success_response.json
+- spec/fixtures/sobject/sobject_find_error_response.json
+- spec/fixtures/sobject/sobject_find_success_response.json
+- spec/fixtures/sobject/upsert_created_success_response.json
+- spec/fixtures/sobject/upsert_error_response.json
+- spec/fixtures/sobject/upsert_multiple_error_response.json
+- spec/fixtures/sobject/upsert_updated_success_response.json
+- spec/fixtures/sobject/write_error_response.json
+- spec/lib/client_spec.rb
+- spec/lib/collection_spec.rb
+- spec/lib/config_spec.rb
+- spec/lib/middleware/authentication/oauth_spec.rb
+- spec/lib/middleware/authentication/password_spec.rb
+- spec/lib/middleware/authentication_spec.rb
+- spec/lib/middleware/authorization_spec.rb
+- spec/lib/middleware/instance_url_spec.rb
+- spec/lib/middleware/mashify_spec.rb
+- spec/lib/middleware/raise_error_spec.rb
+- spec/lib/sobject_spec.rb
+- spec/spec_helper.rb
+- spec/support/basic_client.rb
+- spec/support/fixture_helpers.rb
+- spec/support/middleware.rb
+homepage: https://github.com/ejholmes/restforce
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+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/expired_session_response.json
+- spec/fixtures/reauth_success_response.json
+- spec/fixtures/refresh_error_response.json
+- spec/fixtures/refresh_success_response.json
+- spec/fixtures/services_data_success_response.json
+- spec/fixtures/sobject/create_success_response.json
+- spec/fixtures/sobject/delete_error_response.json
+- spec/fixtures/sobject/describe_sobjects_success_response.json
+- spec/fixtures/sobject/list_sobjects_success_response.json
+- spec/fixtures/sobject/org_query_response.json
+- spec/fixtures/sobject/query_aggregate_success_response.json
+- spec/fixtures/sobject/query_empty_response.json
+- spec/fixtures/sobject/query_error_response.json
+- spec/fixtures/sobject/query_paginated_first_page_response.json
+- spec/fixtures/sobject/query_paginated_last_page_response.json
+- spec/fixtures/sobject/query_success_response.json
+- spec/fixtures/sobject/recent_success_response.json
+- spec/fixtures/sobject/search_error_response.json
+- spec/fixtures/sobject/search_success_response.json
+- spec/fixtures/sobject/sobject_describe_error_response.json
+- spec/fixtures/sobject/sobject_describe_success_response.json
+- spec/fixtures/sobject/sobject_find_error_response.json
+- spec/fixtures/sobject/sobject_find_success_response.json
+- spec/fixtures/sobject/upsert_created_success_response.json
+- spec/fixtures/sobject/upsert_error_response.json
+- spec/fixtures/sobject/upsert_multiple_error_response.json
+- spec/fixtures/sobject/upsert_updated_success_response.json
+- spec/fixtures/sobject/write_error_response.json
+- spec/lib/client_spec.rb
+- spec/lib/collection_spec.rb
+- spec/lib/config_spec.rb
+- spec/lib/middleware/authentication/oauth_spec.rb
+- spec/lib/middleware/authentication/password_spec.rb
+- spec/lib/middleware/authentication_spec.rb
+- spec/lib/middleware/authorization_spec.rb
+- spec/lib/middleware/instance_url_spec.rb
+- spec/lib/middleware/mashify_spec.rb
+- spec/lib/middleware/raise_error_spec.rb
+- spec/lib/sobject_spec.rb
+- spec/spec_helper.rb
+- spec/support/basic_client.rb
+- spec/support/fixture_helpers.rb
+- spec/support/middleware.rb