restforce 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88a93138f74a67b4da1371232281d45950539b18
-  data.tar.gz: f3603bbb017e9864ce6873524c4206ddf4142b61
+  metadata.gz: b601d8c57cda8c40639e2167ff4e887d4ad8764b
+  data.tar.gz: abfa4a6ec6a1f098c35f1f83139686d8234bf28d
 SHA512:
-  metadata.gz: 14cbc34c3bc5bd7b766cfc71c3ecae01fbb370be79b4c02078493949c21f3ad8df4679422f574b587e15344f9388b09c311214f1a6935d5c0dfe364556dc164f
-  data.tar.gz: 47fce31a67fe328abe6a992b2c9030dd01b190d719526571f4e7ef98cd4e5a337b28749a1cd460d7ec019cb5ae52c7ffe63c1d228befb4ada31fa16db88d3157
+  metadata.gz: bdaacea3ebb0a83ffbd7bf6e3f73635fbb426616074d1fa7164e06312b5dd32caec5fea30a5b598fca6a6e4c4466f556a679c1600dc17f9b01239133af3b229b
+  data.tar.gz: 30cedb2942d22e55df574696d6a2d2fc23b5f7a34aa46f333e92dac3857c38093d26edcdfb579012717aa5f68f9961f1a44d1f351ea055fa575979a7931d3b8c

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-# 2.3.0 (Jul 15, 2016)
+## 2.4.0 (Jul 29, 2016)
+
+* Added ability to download documents attached to records, behaving like attachments (@jhelbig)
+
+## 2.3.0 (Jul 15, 2016)
 
 * Allow the Salesforce API version to be specified with a `SALESFORCE_API_VERSION` environment variable (@jhelbig)
 

data/README.md

@@ -439,14 +439,20 @@ _See also: [Inserting or updating blob data](http://www.salesforce.com/us/develo
 
 * * *
 
-### Downloading Attachments
+### Downloading Attachments and Documents
 
-Restforce also makes it incredibly easy to download Attachments:
+Restforce also makes it incredibly easy to download Attachments or Documents:
 
+##### Attachments
 ```ruby
 attachment = client.query('select Id, Name, Body from Attachment').first
 File.open(attachment.Name, 'wb') { |f| f.write(attachment.Body) }
 ```
+##### Documents
+```ruby
+document = client.query('select Id, Name, Body from Document').first
+File.open(document.Name, 'wb') { |f| f.write(document.Body) }
+```
 
 * * *
 

data/lib/restforce.rb

@@ -11,6 +11,7 @@ module Restforce
   autoload :Collection,     'restforce/collection'
   autoload :Middleware,     'restforce/middleware'
   autoload :Attachment,     'restforce/attachment'
+  autoload :Document,       'restforce/document'
   autoload :UploadIO,       'restforce/upload_io'
   autoload :SObject,        'restforce/sobject'
   autoload :Client,         'restforce/client'

data/lib/restforce/document.rb

@@ -0,0 +1,21 @@
+module Restforce
+  class Document < Restforce::SObject
+    # Public: Returns the body of the document.
+    #
+    # Examples
+    #
+    #   document = client.query('select Id, Name, Body from Document').first
+    #   File.open(document.Name, 'wb') { |f| f.write(document.Body) }
+    def Body
+      ensure_id && ensure_body
+      @client.get(super).body
+    end
+
+    private
+
+    def ensure_body
+      return true if self.Body?
+      raise 'You need to query the Body for the record first.'
+    end
+  end
+end

data/lib/restforce/mash.rb

@@ -24,8 +24,11 @@ module Restforce
           # of sobject records.
           Restforce::Collection
         elsif val.key? 'attributes'
-          if val['attributes']['type'] == 'Attachment'
+          case (val['attributes']['type'])
+          when "Attachment"
             Restforce::Attachment
+          when "Document"
+            Restforce::Document
           else
             # When the hash contains an attributes key, it should be considered an
             # sobject record

data/lib/restforce/version.rb

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

data/spec/unit/document_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Restforce::Document do
+  let(:client)   { double(Restforce::AbstractClient) }
+  let(:body_url) { '/services/data/v26.0/sobjects/Document/00PG0000006Hll5MAC/Body' }
+  let(:hash)     { { 'Id' => '1234', 'Body' => body_url } }
+  let(:sobject)  { described_class.new(hash, client) }
+
+  describe '.Body' do
+    it 'requests the body' do
+      client.should_receive(:get).with(body_url).
+        and_return(double('response').as_null_object)
+      sobject.Body
+    end
+  end
+end

data/spec/unit/mash_spec.rb

@@ -26,6 +26,11 @@ describe Restforce::Mash do
         let(:input) { { 'attributes' => { 'type' => 'Attachment' } } }
         it { should eq Restforce::Attachment }
       end
+
+      context 'when the sobject type is a Document' do
+        let(:input) { { 'attributes' => { 'type' => 'Document' } } }
+        it { should eq Restforce::Document }
+      end
     end
 
     context 'else' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Eric J. Holmes
@@ -9,144 +9,144 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-15 00:00:00.000000000 Z
+date: 2016-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.8.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.8.8
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.7.5
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: 1.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.7.5
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: 1.9.0
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.13.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.31.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.31.0
 - !ruby/object:Gem::Dependency
   name: faye
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A lightweight ruby client for the Salesforce REST API.
@@ -157,10 +157,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
+- .gitignore
+- .rubocop.yml
+- .rubocop_todo.yml
+- .travis.yml
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -186,6 +186,7 @@ files:
 - lib/restforce/concerns/verbs.rb
 - lib/restforce/config.rb
 - lib/restforce/data/client.rb
+- lib/restforce/document.rb
 - lib/restforce/mash.rb
 - lib/restforce/middleware.rb
 - lib/restforce/middleware/authentication.rb
@@ -266,6 +267,7 @@ files:
 - spec/unit/concerns/streaming_spec.rb
 - spec/unit/config_spec.rb
 - spec/unit/data/client_spec.rb
+- spec/unit/document_spec.rb
 - spec/unit/mash_spec.rb
 - spec/unit/middleware/authentication/password_spec.rb
 - spec/unit/middleware/authentication/token_spec.rb
@@ -289,17 +291,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: A lightweight ruby client for the Salesforce REST API.
@@ -360,6 +362,7 @@ test_files:
 - spec/unit/concerns/streaming_spec.rb
 - spec/unit/config_spec.rb
 - spec/unit/data/client_spec.rb
+- spec/unit/document_spec.rb
 - spec/unit/mash_spec.rb
 - spec/unit/middleware/authentication/password_spec.rb
 - spec/unit/middleware/authentication/token_spec.rb
@@ -373,4 +376,3 @@ test_files:
 - spec/unit/signed_request_spec.rb
 - spec/unit/sobject_spec.rb
 - spec/unit/tooling/client_spec.rb
-has_rdoc: