restforce 1.4.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55b1c7df7f025b501b8b56290e75934efdc400c8
-  data.tar.gz: 49759852d78eb73a8a305d04cc8d951dbd1ba5a1
+  metadata.gz: bce56a3151368be7fe420c60a276e63a348758b5
+  data.tar.gz: 802b3c908611a9080478ffef024357bd50b5a9c2
 SHA512:
-  metadata.gz: c6ed3ca069f40e557f566da9cb4da84f87c2640e3569afbd60484160cde66fc6fc1e1812f49d7589394aa17050e76700ca25af2cdccd58f30db3b7e13fc3a614
-  data.tar.gz: f1bad005c4550aa56465c5f20a86c78d621ee6932bb4c485a177845c94e1d7af70fab109478f9aaaf6f1e47d21426423e5502f9d34f2d9a022ea4f66f495e22d
+  metadata.gz: 3a9082092a16f81a4de95d7a893e301e89e09ea183829bbd9b9693b9f520605994a87ddfc84700ed154b26781e0b541ea58e308d22ec7cf60cc9898718332811
+  data.tar.gz: 7066d91312f46b082a49bc4f0f3edeb64b3a58a015dbf47daab070d016a2d2af7cc55a4d282bbae837bb3673a02549b4deca4b7c186be5415ace3f6ccabb90a3

data/.gitignore

@@ -16,3 +16,6 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.rspec
+.ruby-version
+*.swp

data/.travis.yml

@@ -4,9 +4,11 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.2
   - jruby-18mode
   - jruby-19mode
   - ree
-  - rbx-18mode
-  - rbx-19mode
+  - rbx-2
+gemfile:
+  - Gemfile.travis
 script: bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.5.0 (Oct 15, 2014)
+
+*   Upgrade faraday dependency to 0.9 #124 @zenchild
+
 ## 1.4.1 (Jun 18, 2013)
 
 *   Fixed a bug with HTTP 413 responses #75 @patronmanager

data/Gemfile

@@ -1,6 +1,4 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in restforce.gemspec
 gemspec
 
 gem 'rake'

data/Gemfile.travis

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'rake'
+gem 'jruby-openssl', :platforms => :jruby

data/README.md

@@ -267,6 +267,14 @@ client.picklist_values('Automobile__c', 'Model__c', :valid_for => 'Honda')
 # => [#<Restforce::Mash label="Civic" value="Civic">, ... ]
 ```
 
+### user_info
+
+```ruby
+# get info about the logged-in user
+client.user_info
+# => #<Restforce::Mash active=true display_name="Chatty Sassy" email="user@example.com" ... >
+```
+
 * * *
 
 ### authenticate!
@@ -462,6 +470,13 @@ call `Restforce.tooling` instead of `Restforce.new`:
 client = Restforce.tooling(...)
 ```
 
+## Links
+
+If you need a full Active Record experience, may be you can use
+[ActiveForce](https://github.com/ionia-corporation/active_force) that wraps
+Restforce and adds Associations, Query Building (like AREL), Validations and
+Callbacks.
+
 ## Contributing
 
 1. Fork it

data/lib/restforce/concerns/api.rb

@@ -29,6 +29,19 @@ module Restforce
       # Returns the Faraday::Response.
       define_verbs :get, :post, :put, :delete, :patch, :head
 
+      # Public: Get info about the logged-in user.
+      #
+      # Examples
+      #
+      #   # get the email of the logged-in user
+      #   client.user_info.email
+      #   # => user@example.com
+      #
+      # Returns an Array of String names for each SObject.
+      def user_info
+        get(api_get.body.identity).body
+      end
+
       # Public: Get the names of all sobjects on the org.
       #
       # Examples

data/lib/restforce/concerns/base.rb

@@ -34,6 +34,8 @@ module Restforce
       #                                  before raising an exception (default: 3).
       #
       #        :compress               - Set to true to have Salesforce compress the response (default: false).
+      #        :mashify                - Set to false to skip the conversion of Salesforce responses to
+      #                                  Restforce::Sobjects and Restforce::Collections. (default: nil).
       #        :timeout                - Faraday connection request read/open timeout. (default: nil).
       #
       #        :proxy_uri              - Proxy URI: 'http://proxy.example.com:port' or 'http://user@pass:proxy.example.com:port'

data/lib/restforce/concerns/connection.rb

@@ -22,7 +22,7 @@ module Restforce
       def connection
         @connection ||= Faraday.new(options[:instance_url], connection_options) do |builder|
           # Parses JSON into Hashie::Mash structures.
-          builder.use      Restforce::Middleware::Mashify, self, options
+          builder.use      Restforce::Middleware::Mashify, self, options unless (options[:mashify] == false)
           # Handles multipart file uploads for blobs.
           builder.use      Restforce::Middleware::Multipart
           # Converts the request into JSON.

data/lib/restforce/concerns/streaming.rb

@@ -16,6 +16,7 @@ module Restforce
       def faye
         raise 'Instance URL missing. Call .authenticate! first.' unless options[:instance_url]
         @faye ||= Faye::Client.new("#{options[:instance_url]}/cometd/#{options[:api_version]}").tap do |client|
+          client.set_header 'Authorization', "OAuth #{options[:oauth_token]}"
           client.bind 'transport:down' do
             Restforce.log "[COMETD DOWN]"
             client.set_header 'Authorization', "OAuth #{authenticate!.access_token}"

data/lib/restforce/config.rb

@@ -117,6 +117,10 @@ module Restforce
     # Set to true if you want responses from Salesforce to be gzip compressed.
     option :compress
 
+    # Set to false if you want to skip conversion to Restforce::Sobjects and
+    # Restforce::Collections.
+    option :mashify
+
     # Faraday request read/open timeout.
     option :timeout
 

data/lib/restforce/middleware/mashify.rb

@@ -4,15 +4,9 @@ module Restforce
   class Middleware::Mashify < Restforce::Middleware
 
     def call(env)
-      @env = env
-      response = @app.call(env)
-      env[:body] = Restforce::Mash.build(body, client)
-      response
+      @app.call(env).on_complete do |env|
+        env[:body] = Restforce::Mash.build(env[:body], client)
+      end
     end
-
-    def body
-      @env[:body]
-    end
-  
   end
 end

data/lib/restforce/middleware/multipart.rb

@@ -1,7 +1,8 @@
 module Restforce
   class Middleware::Multipart < Faraday::Request::UrlEncoded
     self.mime_type = 'multipart/form-data'.freeze
-    DEFAULT_BOUNDARY = "--boundary_string".freeze
+    DEFAULT_BOUNDARY  = "--boundary_string".freeze
+    JSON_CONTENT_TYPE = {"Content-Type" => "application/json"}
 
     def call(env)
       match_content_type(env) do |params|
@@ -36,7 +37,7 @@ module Restforce
       parts = []
 
       # Fields
-      parts << Faraday::Parts::Part.new(boundary, 'entity_content', params.reject { |k,v| v.respond_to? :content_type }.to_json)
+      parts << Faraday::Parts::Part.new(boundary, 'entity_content', params.reject { |k,v| v.respond_to? :content_type }.to_json, JSON_CONTENT_TYPE)
 
       # Files
       params.each do |k,v|

data/lib/restforce/patches/parts.rb

@@ -0,0 +1,31 @@
+module Faraday
+  module Parts
+
+    module Part
+      def self.new(boundary, name, value, headers = {})
+        headers ||= {}
+        if value.respond_to? :content_type
+          FilePart.new(boundary, name, value)
+        else
+          ParamPart.new(boundary, name, value, headers)
+        end
+      end
+    end
+
+    class ParamPart
+      def initialize(boundary, name, value, headers = {})
+        @part = build_part(boundary, name, value, headers)
+        @io = StringIO.new(@part)
+      end
+
+      def build_part(boundary, name, value, headers = {})
+        part = ''
+        part << "--#{boundary}\r\n"
+        part << "Content-Disposition: form-data; name=\"#{name.to_s}\"\r\n"
+        part << "Content-Type: #{headers["Content-Type"]}\r\n" if headers["Content-Type"]
+        part << "\r\n"
+        part << "#{value}\r\n"
+      end
+    end
+  end
+end

data/lib/restforce/signed_request.rb

@@ -27,7 +27,7 @@ module Restforce
       return nil if signature != hmac
       JSON.parse(Base64.decode64(payload))
     end
-    
+
   private
     attr_reader :client_secret, :signature, :payload
 
@@ -41,7 +41,15 @@ module Restforce
     end
 
     def digest
-      OpenSSL::Digest::Digest.new('sha256')
+      digest_class.new('sha256')
+    end
+
+    def digest_class
+      if RUBY_VERSION < '2.1'
+        OpenSSL::Digest::Digest
+      else
+        OpenSSL::Digest
+      end
     end
 
   end

data/lib/restforce/upload_io.rb

@@ -4,17 +4,6 @@ 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
+unless Parts::Part.method(:new).arity.abs == 4
+  require 'restforce/patches/parts'
 end

data/lib/restforce/version.rb

@@ -1,3 +1,3 @@
 module Restforce
-  VERSION = '1.4.3'
+  VERSION = '1.5.0'
 end

data/restforce.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Restforce::VERSION
 
-  gem.add_dependency 'faraday', '~> 0.8.4'
+  gem.add_dependency 'faraday', '~> 0.9.0'
   gem.add_dependency 'faraday_middleware', '>= 0.8.8'
   gem.add_dependency 'json', ['>= 1.7.5', '< 1.9.0']
   gem.add_dependency 'hashie', ['>= 1.2.0', '< 2.1']

data/spec/integration/abstract_client_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 shared_examples_for Restforce::AbstractClient do
+
   describe '.list_sobjects' do
     requests :sobjects, :fixture => 'sobject/describe_sobjects_success_response'
 
@@ -61,7 +62,7 @@ shared_examples_for Restforce::AbstractClient do
     context 'with multipart' do
       requests 'sobjects/Account',
         :method => :post,
-        :with_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),
+        :with_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),
         :fixture => 'sobject/create_success_response'
 
       subject { client.create('Account', :Name => 'Foobar', :Blob => Restforce::UploadIO.new(File.expand_path('../../fixtures/blob.jpg', __FILE__), 'image/jpeg')) }

data/spec/integration/data/client_spec.rb

@@ -48,7 +48,12 @@ shared_examples_for Restforce::Data::Client do
     context 'with oauth token and instance url' do
       let(:instance_url) { 'http://google.com' }
       let(:oauth_token) { 'bar' }
-      specify { expect { subject }.to_not raise_error }
+
+      it 'should not raise error' do
+        client.stub(:authorize!)
+        client.faye.stub(:set_header).with('Authorization', "OAuth token")
+        expect { subject }.to_not raise_error
+      end
     end
 
     context 'when the connection goes down' do

data/spec/support/client_integration.rb

@@ -39,7 +39,7 @@ module ClientIntegrationExampleGroup
       }
 
     config.before :mashify => false do
-      client.middleware.delete(Restforce::Middleware::Mashify)
+      base_options.merge!(:mashify => false)
     end
   end
 end

data/spec/unit/concerns/api_spec.rb

@@ -3,6 +3,22 @@ require 'spec_helper'
 describe Restforce::Concerns::API do
   let(:response) { double('Faraday::Response', :body => double('Body')) }
 
+  describe '.user_info' do
+    subject(:user_info) { client.user_info }
+
+    it 'returns the user info from identity url' do
+      identity_url = double('identity_url')
+      response.body.stub(:identity).and_return(identity_url)
+      client.should_receive(:api_get).with().and_return(response)
+
+      identity = double('identity')
+      identity.stub(:body).and_return(identity)
+      client.should_receive(:get).with(identity_url).and_return(identity)
+
+      expect(user_info).to eq identity
+    end
+  end
+
   describe '.list_sobjects' do
     subject { client.list_sobjects }
 

data/spec/unit/concerns/connection_spec.rb

@@ -12,6 +12,48 @@ describe Restforce::Concerns::Connection do
     it { should eq builder }
   end
 
+  describe 'private #connection' do
+
+    describe ':mashify option' do
+      let(:options) { {:adapter => Faraday.default_adapter} }
+
+      before(:each) do
+        client.stub(:authentication_middleware)
+        client.stub(:cache)
+        client.stub(:options => options)
+      end
+
+      describe 'with mashify not specified' do
+        it 'includes the Mashify middleware' do
+          client.middleware.handlers.index(Restforce::Middleware::Mashify).
+              should_not be_nil
+        end
+      end
+
+      describe 'with mashify=true' do
+        before(:each) do
+          options.merge!(:mashify => true)
+        end
+
+        it 'includes the Mashify middleware' do
+          client.middleware.handlers.index(Restforce::Middleware::Mashify).
+              should_not be_nil
+        end
+      end
+
+      describe 'without mashify' do
+        before(:each) do
+          options.merge!(:mashify => false)
+        end
+
+        it 'does not include the Mashify middleware' do
+          client.middleware.handlers.index(Restforce::Middleware::Mashify).
+              should be_nil
+        end
+      end
+    end
+  end
+
   describe '#adapter' do
     before do
       client.stub :options => {:adapter => :typhoeus}
@@ -19,4 +61,4 @@ describe Restforce::Concerns::Connection do
 
     its(:adapter) { should eq(:typhoeus) }
   end
-end
+end

data/spec/unit/concerns/streaming_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Restforce::Concerns::Streaming, :event_machine => true do
+  describe '.subscribe' do
+    let(:channels)        { %w( channel1 channel2 ) }
+    let(:topics)          { channels.map { |c| "/topic/#{c}" } }
+    let(:subscribe_block) { lambda{ 'subscribe' } }
+    let(:faye_double)     { double('Faye') }
+
+    it 'subscribes to the topics with faye' do
+      faye_double.
+        should_receive(:subscribe).
+        with(topics, &subscribe_block)
+      client.stub :faye => faye_double
+
+      client.subscribe(channels, &subscribe_block)
+    end
+  end
+
+  describe '.faye' do
+    subject { client.faye }
+
+    context 'when authenticate! has already been called' do
+      before do
+        client.stub :options => {
+          :instance_url => '/url',
+          :api_version  => '30.0',
+          :oauth_token  => 'secret'
+        }
+      end
+
+      it 'connects to the streaming api' do
+        client.stub :authenticate! => OpenStruct.new({ :access_token => 'secret2' })
+        faye_double = double('Faye::Client')
+        Faye::Client.
+          should_receive(:new).
+          with("/url/cometd/30.0").
+          and_return(faye_double)
+        faye_double.should_receive(:set_header).with('Authorization', 'OAuth secret')
+        faye_double.should_receive(:set_header).with('Authorization', 'OAuth secret2')
+        faye_double.should_receive(:bind).with('transport:down').and_yield
+        faye_double.should_receive(:bind).with('transport:up').and_yield
+        subject
+      end
+    end
+
+    context 'when authenticate! has not been called' do
+      it 'raises an error' do
+        expect { subject }.to raise_error
+      end
+    end
+  end
+end

data/spec/unit/config_spec.rb

@@ -25,7 +25,7 @@ describe Restforce do
       its(:adapter)                { should eq Faraday.default_adapter }
       [:username, :password, :security_token, :client_id, :client_secret,
        :oauth_token, :refresh_token, :instance_url, :compress, :timeout,
-       :proxy_uri, :authentication_callback].each do |attr|
+       :proxy_uri, :authentication_callback, :mashify].each do |attr|
         its(attr) { should be_nil }
       end
     end
@@ -55,7 +55,7 @@ describe Restforce do
   describe '#configure' do
     [:username, :password, :security_token, :client_id, :client_secret, :compress, :timeout,
      :oauth_token, :refresh_token, :instance_url, :api_version, :host, :authentication_retries,
-     :proxy_uri, :authentication_callback].each do |attr|
+     :proxy_uri, :authentication_callback, :mashify].each do |attr|
       it "allows #{attr} to be set" do
         Restforce.configure do |config|
           config.send("#{attr}=", 'foobar')

data/spec/unit/middleware/authentication_spec.rb

@@ -39,7 +39,10 @@ describe Restforce::Middleware::Authentication do
     subject(:connection) { middleware.connection }
 
     its(:url_prefix)     { should eq(URI.parse('https://login.salesforce.com')) }
-    its(:proxy)          { should eq({ :uri => URI.parse('https://not-a-real-site.com') }) }
+
+    it "should have a proxy URI" do
+      connection.proxy[:uri].should eq(URI.parse('https://not-a-real-site.com'))
+    end
 
     describe '.builder' do
       subject(:builder) { connection.builder }

data/spec/unit/middleware/mashify_spec.rb

@@ -2,10 +2,15 @@ require 'spec_helper'
 
 describe Restforce::Middleware::Mashify do
   let(:env) { { :body => JSON.parse(fixture('sobject/query_success_response')) } }
+  subject(:middleware) {
+    described_class.new(lambda {|env|
+      Faraday::Response.new(env)
+    }, client, options)
+  }
 
   describe '.call' do
-    subject { lambda { middleware.call(env) } }
-
-    it { should change { env[:body] }.to(kind_of(Restforce::Collection)) }
+    it "should change the body to a Restforce::Collection" do
+      expect( middleware.call(env).body ).to be_kind_of(Restforce::Collection)
+    end
   end
 end

data/spec/unit/signed_request_spec.rb

@@ -2,8 +2,15 @@ require 'spec_helper'
 
 describe Restforce::SignedRequest do
   let(:client_secret) { 'foo' }
+  let(:digest) do
+    if RUBY_VERSION < '2.1'
+      OpenSSL::Digest::Digest.new('sha256')
+    else
+      OpenSSL::Digest.new('sha256')
+    end
+  end
+
   let(:message) do
-    digest = OpenSSL::Digest::Digest.new('sha256')
     signature = Base64.encode64(OpenSSL::HMAC.digest(digest, client_secret, data))
     "#{signature}.#{data}"
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.0
 platform: ruby
 authors:
 - Eric J. Holmes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-05 00:00:00.000000000 Z
+date: 2014-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.4
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.4
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -142,10 +142,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rspec
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
+- Gemfile.travis
 - Guardfile
 - LICENSE
 - README.md
@@ -179,6 +179,7 @@ files:
 - lib/restforce/middleware/mashify.rb
 - lib/restforce/middleware/multipart.rb
 - lib/restforce/middleware/raise_error.rb
+- lib/restforce/patches/parts.rb
 - lib/restforce/signed_request.rb
 - lib/restforce/sobject.rb
 - lib/restforce/tooling/client.rb
@@ -236,6 +237,7 @@ files:
 - spec/unit/concerns/caching_spec.rb
 - spec/unit/concerns/canvas_spec.rb
 - spec/unit/concerns/connection_spec.rb
+- spec/unit/concerns/streaming_spec.rb
 - spec/unit/config_spec.rb
 - spec/unit/data/client_spec.rb
 - spec/unit/mash_spec.rb
@@ -326,6 +328,7 @@ test_files:
 - spec/unit/concerns/caching_spec.rb
 - spec/unit/concerns/canvas_spec.rb
 - spec/unit/concerns/connection_spec.rb
+- spec/unit/concerns/streaming_spec.rb
 - spec/unit/config_spec.rb
 - spec/unit/data/client_spec.rb
 - spec/unit/mash_spec.rb

data/.rspec

@@ -1 +0,0 @@
---color