restforce 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffde6a2ff06c51931a6bab34f4d1f65cca529dab
-  data.tar.gz: fe9a373b83dbfef51434a2045c4dfa698094d0fb
+  metadata.gz: 88a93138f74a67b4da1371232281d45950539b18
+  data.tar.gz: f3603bbb017e9864ce6873524c4206ddf4142b61
 SHA512:
-  metadata.gz: d2215c530292416152291284e81842411a02cc9e19a29b1e08ce745a63d53abb9fd68cea37f13b52138849e537c57aa255c80562c6a0a78062469541e3b74e2d
-  data.tar.gz: 09a8ae9879b0dca63e789f6bdb8ffdd9d2c92f9a297fcbafe051f240ff5c0a01c58108cf796d2b11791025b8922e34f53c4d61d4350d082d3a91a549b051ae73
+  metadata.gz: 14cbc34c3bc5bd7b766cfc71c3ecae01fbb370be79b4c02078493949c21f3ad8df4679422f574b587e15344f9388b09c311214f1a6935d5c0dfe364556dc164f
+  data.tar.gz: 47fce31a67fe328abe6a992b2c9030dd01b190d719526571f4e7ef98cd4e5a337b28749a1cd460d7ec019cb5ae52c7ffe63c1d228befb4ada31fa16db88d3157

data/.travis.yml

@@ -4,6 +4,7 @@ rvm:
   - 2.0.0
   - 2.1
   - 2.2
+  - 2.3.1
   - jruby-19mode
   - rbx-2
 gemfile:

data/CHANGELOG.md

@@ -1,7 +1,13 @@
+# 2.3.0 (Jul 15, 2016)
+
+* Allow the Salesforce API version to be specified with a `SALESFORCE_API_VERSION` environment variable (@jhelbig)
+
 ## 2.2.1 (Jun 6, 2016)
 
 * Added support for `get_deleted` call (@adambird)
 
+*(This should have been a minor version rather than a patch version, following format MAJOR.MINOR.PATCH, since we use [Semantic Versioning](http://semver.org/) and this adds functionality. Sorry! @timrogers)*
+
 ## 2.2.0 (Mar 16, 2016)
 
 * Raise a `Faraday::Error::ClientError` for `300` responses triggered by a conflicting external ID, providing access to the response, which contains an array of the conflicting IDs (@timrogers, @michaelminter)

data/Gemfile.travis

@@ -2,4 +2,5 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
+gem 'rack', '~> 1.6.4'
 gem 'jruby-openssl', :platforms => :jruby

data/README.md

@@ -39,6 +39,8 @@ Or install it yourself as:
 
 __As of [version 2.0.0](https://github.com/ejholmes/restforce/blob/master/CHANGELOG.md#200-jun-27-2015), this gem is only compatible with Ruby 1.9.3 and later.__ To use Ruby 1.9.2 and below, you'll need to manually specify that you wish to use version 1.5.3.
 
+This gem is versioned using [Semantic Versioning](http://semver.org/), so you can be confident when updating that there will not be breaking changes outside of a major version (following format MAJOR.MINOR.PATCH, so for instance moving from 2.3.0 to 3.0.0 would be allowed to include incompatible API changes). See the [changelog](https://github.com/ejholmes/restforce/tree/master/CHANGELOG.md) for details on what has changed in each version.
+
 ## Usage
 
 Restforce is designed with flexibility and ease of use in mind. By default, all API calls will
@@ -108,8 +110,8 @@ client = Restforce.new :username => 'foo',
   :client_secret  => 'client_secret'
 ```
 
-You can also set the username, password, security token, client ID and client
-secret in environment variables:
+You can also set the username, password, security token, client ID, client
+secret and API version in environment variables:
 
 ```bash
 export SALESFORCE_USERNAME="username"
@@ -117,6 +119,7 @@ export SALESFORCE_PASSWORD="password"
 export SALESFORCE_SECURITY_TOKEN="security token"
 export SALESFORCE_CLIENT_ID="client id"
 export SALESFORCE_CLIENT_SECRET="client secret"
+export SALESFORCE_API_VERSION="37.0"
 ```
 
 ```ruby

data/lib/restforce/concerns/api.rb

@@ -1,3 +1,4 @@
+require 'uri'
 require 'restforce/concerns/verbs'
 
 module Restforce
@@ -364,7 +365,7 @@ module Restforce
           fetch(attrs.keys.find { |k, v| k.to_s.downcase == field.to_s.downcase }, nil)
         attrs_without_field = attrs.
           reject { |k, v| k.to_s.downcase == field.to_s.downcase }
-        response = api_patch "sobjects/#{sobject}/#{field}/#{external_id}",
+        response = api_patch "sobjects/#{sobject}/#{field}/#{URI.encode(external_id)}",
                              attrs_without_field
 
         (response.body && response.body['id']) ? response.body['id'] : true
@@ -414,7 +415,11 @@ module Restforce
       #
       # Returns the Restforce::SObject sobject record.
       def find(sobject, id, field = nil)
-        url = field ? "sobjects/#{sobject}/#{field}/#{id}" : "sobjects/#{sobject}/#{id}"
+        if field
+          url = "sobjects/#{sobject}/#{field}/#{URI.encode(id)}"
+        else
+          url = "sobjects/#{sobject}/#{id}"
+        end
         api_get(url).body
       end
 
@@ -428,7 +433,11 @@ module Restforce
       # field   - External ID field to use (default: nil).
       #
       def select(sobject, id, select, field = nil)
-        path = field ? "sobjects/#{sobject}/#{field}/#{id}" : "sobjects/#{sobject}/#{id}"
+        if field
+          path = "sobjects/#{sobject}/#{field}/#{URI.encode(id)}"
+        else
+          path = "sobjects/#{sobject}/#{id}"
+        end
         path << "?fields=#{select.join(',')}" if select && select.any?
 
         api_get(path).body

data/lib/restforce/config.rb

@@ -88,7 +88,7 @@ module Restforce
       end
     end
 
-    option :api_version, default: '26.0'
+    option :api_version, default: lambda { ENV['SALESFORCE_API_VERSION'] || '26.0' }
 
     # The username to use during login.
     option :username, default: lambda { ENV['SALESFORCE_USERNAME'] }

data/lib/restforce/version.rb

@@ -1,3 +1,3 @@
 module Restforce
-  VERSION = '2.2.1'
+  VERSION = '2.3.0'
 end

data/spec/unit/concerns/api_spec.rb

@@ -344,6 +344,23 @@ describe Restforce::Concerns::API do
     end
   end
 
+  describe '.upsert! with multi bytes character' do
+    let(:sobject)    { 'Whizbang' }
+    let(:field)      { :External_ID__c }
+    let(:attrs)      { { 'External_ID__c' => "\u{3042}" } }
+    subject(:result) { client.upsert!(sobject, field, attrs) }
+
+    context 'when the record is found and updated' do
+      it 'returns true' do
+        response.body.stub :[]
+        client.should_receive(:api_patch).
+          with('sobjects/Whizbang/External_ID__c/%E3%81%82', {}).
+          and_return(response)
+        expect(result).to be_true
+      end
+    end
+  end
+
   describe '.destroy!' do
     let(:id)         { '1234' }
     let(:sobject)    { 'Whizbang' }
@@ -381,6 +398,17 @@ describe Restforce::Concerns::API do
         expect(result).to eq response.body
       end
     end
+
+    context 'when an external id which contains multibyte characters is specified' do
+      let(:field) { :External_ID__c }
+      let(:id)    { "\u{3042}" }
+      it 'returns the full representation of the object' do
+        client.should_receive(:api_get).
+          with('sobjects/Whizbang/External_ID__c/%E3%81%82').
+          and_return(response)
+        expect(result).to eq response.body
+      end
+    end
   end
 
   describe '.select' do
@@ -430,6 +458,28 @@ describe Restforce::Concerns::API do
         end
       end
     end
+
+    context 'when an external id which contains multibyte characters is specified' do
+      let(:field) { :External_ID__c }
+      let(:id) { "\u{3042}" }
+      context 'when no select list is specified' do
+        it 'returns the full representation of the object' do
+          client.should_receive(:api_get).
+            with('sobjects/Whizbang/External_ID__c/%E3%81%82').
+            and_return(response)
+          expect(result).to eq response.body
+        end
+      end
+      context 'when select list is specified' do
+        let(:select) { [:External_ID__c] }
+        it 'returns the full representation of the object' do
+          client.should_receive(:api_get).
+            with('sobjects/Whizbang/External_ID__c/%E3%81%82?fields=External_ID__c').
+            and_return(response)
+          expect(result).to eq response.body
+        end
+      end
+    end
   end
 
   describe "#recent" do

data/spec/unit/config_spec.rb

@@ -7,6 +7,7 @@ describe Restforce do
     ENV['SALESFORCE_SECURITY_TOKEN'] = nil
     ENV['SALESFORCE_CLIENT_ID']      = nil
     ENV['SALESFORCE_CLIENT_SECRET']  = nil
+    ENV['SALESFORCE_API_VERSION']    = nil
   end
 
   after do
@@ -39,7 +40,8 @@ describe Restforce do
           'SALESFORCE_CLIENT_ID'      => 'client id',
           'SALESFORCE_CLIENT_SECRET'  => 'client secret',
           'SALESFORCE_PROXY_URI'      => 'proxy',
-          'SALESFORCE_HOST'           => 'test.host.com' }.
+          'SALESFORCE_HOST'           => 'test.host.com',
+          'SALESFORCE_API_VERSION'    => '37.0' }.
         each { |var, value| ENV.stub(:[]).with(var).and_return(value) }
       end
 
@@ -50,6 +52,7 @@ describe Restforce do
       its(:client_secret)  { should eq 'client secret' }
       its(:proxy_uri)      { should eq 'proxy' }
       its(:host)           { should eq 'test.host.com' }
+      its(:api_version)    { should eq '37.0' }
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Eric J. Holmes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-06 00:00:00.000000000 Z
+date: 2016-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday