restforce 1.0.5 → 1.0.6

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 1.0.6 (Feb 16, 2013)
+
+*   Added `url` method.
+
+    Example
+
+        # Url to a record id
+        client.url('0013000000rRz')
+        # => https://na1.salesforce.com/0013000000rRz
+
+        # Url to an object that responds to `to_sparam`
+        record = Struct.new(:to_sparam).new('0013000000rRz')
+        client.url('0013000000rRz')
+        # => https://na1.salesforce.com/0013000000rRz
+
+
 ## 1.0.5 (Jan 11, 2013)
 
 *   Added `picklist_values` method.

data/README.md

@@ -1,6 +1,6 @@
 # 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) [![Dependency Status](https://gemnasium.com/ejholmes/restforce.png)](https://gemnasium.com/ejholmes/restforce)
+[![travis-ci](https://travis-ci.org/ejholmes/restforce.png?branch=master)](https://travis-ci.org/ejholmes/restforce) [![Code Climate](https://codeclimate.com/github/ejholmes/restforce.png)](https://codeclimate.com/github/ejholmes/restforce) [![Dependency Status](https://gemnasium.com/ejholmes/restforce.png)](https://gemnasium.com/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) that offers
@@ -127,10 +127,7 @@ works similarly to ActiveRecord.
 
 * * *
 
-### query(soql)
-
-Performs a soql query and returns the result. The result will be a
-[Restforce::Collection][], which can be iterated over.
+### query
 
 ```ruby
 accounts = client.query("select Id, Something__c from Account where Id = 'someid'")
@@ -153,16 +150,7 @@ account.destroy
 # => true
 ```
 
-_See also: http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_query.htm_
-
-* * *
-
-### find(sobject, id, field=nil)
-
-Finds the record with the specified id and the specified sobject type and
-returns all fields for the sobject. An external id field can be used instead
-of the default Id field by specifiying the name of the external id field as the
-last parameter.
+### find
 
 ```ruby
 client.find('Account', '001D000000INjVe')
@@ -172,14 +160,7 @@ client.find('Account', '1234', 'Some_External_Id_Field__c')
 # => #<Restforce::SObject Id="001D000000INjVe" Name="Test" LastModifiedBy="005G0000002f8FHIAY" ... >
 ```
 
-_See also: http://www.salesforce.com/us/developer/docs/api_rest/Content/resources_sobject_upsert.htm_
-
-* * *
-
-### search(sosl)
-
-Performs a sosl query and returns the result. The result will be a
-[Restforce::Collection][].
+### search
 
 ```ruby
 # Find all occurrences of 'bar'
@@ -191,16 +172,7 @@ client.search('FIND {genepoint} RETURNING Account (Name)').map(&:Name)
 # => ['GenePoint']
 ```
 
-_See also: http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_search.htm_
-
-* * *
-
-### 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.
+### create
 
 ```ruby
 # Add a new account
@@ -208,14 +180,7 @@ client.create('Account', Name: 'Foobar Inc.')
 # => '0016000000MRatd'
 ```
 
-_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. An 'Id' key is required in attrs (either a string or symbol). Returns true if the record was successfully
-updated.
+### update
 
 ```ruby
 # Update the Account with Id '0016000000MRatd'
@@ -223,28 +188,14 @@ 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)
-
-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.
+### upsert
 
 ```ruby
 # Update the record with external ID of 12
 client.upsert('Account', 'External__c', External__c: 12, Name: 'Foobar')
 ```
 
-_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.
+### destroy
 
 ```ruby
 # Delete the Account with Id '0016000000MRatd'
@@ -252,14 +203,7 @@ client.destroy('Account', '0016000000MRatd')
 # => true
 ```
 
-_See also: http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_delete_record.htm_
-
-* * *
-
-### describe(sobject)
-
-If no parameter is given, it will return the global describe. If the name of an
-sobject is given, it will return the describe for that sobject.
+### describe
 
 ```ruby
 # get the global describe for all sobjects
@@ -271,18 +215,7 @@ client.describe('Account')
 # => { ... }
 ```
 
-_See also: http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_describeGlobal.htm, http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_sobject_describe.htm_
-
-* * *
-
-### picklist\_values(sobject, field, options = {})
-
-Takes the name of an sobject and the name of a picklist field and returns the
-valid picklist values for that field.
-
-If a :valid\_for key is specified in the options, it will filter the picklist
-values to only return picklist values that are valid for the controlling
-picklist field.
+### picklist\_values
 
 
 ```ruby

data/lib/restforce/client.rb

@@ -78,6 +78,20 @@ module Restforce
       @options.merge! opts
     end
 
+    def instance_url
+      authenticate! unless @options[:instance_url]
+      @options[:instance_url]
+    end
+
+    # Public: Returns a url to the resource.
+    #
+    # resource - A record that responds to to_sparam or a String/Fixnum.
+    #
+    # Returns the url to the resource.
+    def url(resource)
+      "#{instance_url}/#{(resource.respond_to?(:to_sparam) ? resource.to_sparam : resource)}"
+    end
+
     def inspect
       "#<#{self.class} @options=#{@options.inspect}>"
     end

data/lib/restforce/sobject.rb

@@ -49,6 +49,10 @@ module Restforce
       self.to_hash.reject { |key, _| key =~ /.*__r/ || key =~ /^attributes$/ }
     end
 
+    def to_sparam
+      self.Id
+    end
+
   private
 
     def ensure_id

data/lib/restforce/version.rb

@@ -1,3 +1,3 @@
 module Restforce
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'
 end

data/spec/lib/client_spec.rb

@@ -1,25 +1,5 @@
 require 'spec_helper'
 
-RSpec::Matchers.define :include_picklist_values do |expected|
-  match do |actual|
-    actual.all? { |picklist_value| expected.include? picklist_value['value'] }
-  end
-end
-
-class MockCache
-  def initialize
-    @storage = {}
-  end
-
-  def fetch(key, &block)
-    @storage[key] ||= block.call
-  end
-
-  def delete(key)
-    @storage.delete(key)
-  end
-end
-
 shared_examples_for 'methods' do
   describe '#new' do
     context 'without options passed in' do
@@ -51,6 +31,25 @@ shared_examples_for 'methods' do
     its([:security_token]) { should eq security_token }
   end
 
+  describe '.instance_url' do
+    subject { client.instance_url }
+    it { should eq 'https://na1.salesforce.com' }
+  end
+
+  describe '.url' do
+    subject { client.url(resource) }
+
+    context 'when given something that responds to to_sparam' do
+      let(:resource) { Struct.new(:to_sparam).new('1234') }
+      it { should eq 'https://na1.salesforce.com/1234' }
+    end
+
+    context 'when given a string' do
+      let(:resource) { '4321' }
+      it { should eq 'https://na1.salesforce.com/4321' }
+    end
+  end
+
   describe '.authentication_middleware' do
     subject { client.send :authentication_middleware }
 

data/spec/lib/sobject_spec.rb

@@ -1,11 +1,5 @@
 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'
 

data/spec/spec_helper.rb

@@ -14,6 +14,10 @@ WebMock.disable_net_connect!
 Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each {|f| require f}
 
 RSpec.configure do |config|
+  config.before do
+    EventMachine.stub(:connect) if defined?(EventMachine)
+  end
+
   config.around :eventmachine => true do |example|
     EM.run {
       example.run

data/spec/support/matchers.rb

@@ -0,0 +1,11 @@
+RSpec::Matchers.define :include_picklist_values do |expected|
+  match do |actual|
+    actual.all? { |picklist_value| expected.include? picklist_value['value'] }
+  end
+end
+
+RSpec::Matchers.define :have_client do |expected|
+  match do |actual|
+    actual.instance_variable_get(:@client) == expected
+  end
+end

data/spec/support/mock_cache.rb

@@ -0,0 +1,13 @@
+class MockCache
+  def initialize
+    @storage = {}
+  end
+
+  def fetch(key, &block)
+    @storage[key] ||= block.call
+  end
+
+  def delete(key)
+    @storage.delete(key)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-11 00:00:00.000000000 Z
+date: 2013-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -233,7 +233,9 @@ files:
 - spec/spec_helper.rb
 - spec/support/basic_client.rb
 - spec/support/fixture_helpers.rb
+- spec/support/matchers.rb
 - spec/support/middleware.rb
+- spec/support/mock_cache.rb
 homepage: https://github.com/ejholmes/restforce
 licenses: []
 post_install_message: 
@@ -246,12 +248,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3883981851438487723
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3883981851438487723
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -308,4 +316,6 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/basic_client.rb
 - spec/support/fixture_helpers.rb
+- spec/support/matchers.rb
 - spec/support/middleware.rb
+- spec/support/mock_cache.rb