restforce 1.0.4 → 1.0.5

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+## 1.0.5 (Jan 11, 2013)
+
+*   Added `picklist_values` method.
+
+    Example
+
+        client.picklist_values('Account', 'Type')
+
+        client.picklist_values('Automobile__c', 'Model__c', :valid_for => 'Honda')
+
+*   Added CHANGELOG.md
+
+## 1.0.4 (Jan 8, 2013)
+
+*   `Restforce::Client#inspect` now only prints out the options and not the
+    Faraday connection.
+
+*   The Faraday adapter is now configurabled:
+
+    Example:
+
+        Restforce.configure do |config|
+          config.adapter = :excon
+        end
+
+*   The http connection read/open timeout is now configurabled.
+
+    Example:
+    
+        Restforce.configure do |config|
+          config.timeout = 300
+        end
+
+## 1.0.3 (Jan 7, 2013)
+
+*   Fixed typo in method call.
+
+## 1.0.2 (Jan 7, 2013)
+
+*   Minor cleanup.
+*   Moved decoding of signed requests into it's own class.
+
+## 1.0.1 (Dec 31, 2012)
+
+*   `username`, `password`, `security_token`, `client_id` and `client_secret`
+    options now obtain defaults from environment variables.
+*   Add `head` verb.
+
+## 1.0.0 (Dec 23, 2012)
+
+*   Default api version changed from 24.0 to 26.0.
+*   Fixed tests for streaming api to work with latest versions of faye.
+*   Added .find method to obtain all fields from an sobject.

data/README.md

@@ -16,9 +16,10 @@ Features include:
 * Support for blob data types.
 * Support for GZIP compression.
 * Support for [custom Apex REST endpoints](#custom-apex-rest-endpoints).
+* Support for dependent picklists.
 * Support for decoding [Force.com Canvas](http://www.salesforce.com/us/developer/docs/platform_connectpre/canvas_framework.pdf) signed requests. (NEW!)
 
-[Documentation](http://rubydoc.info/gems/restforce/frames) | [Changelog](http://revision.io/restforce)
+[Documentation](http://rubydoc.info/gems/restforce/frames) | [Changelog](https://github.com/ejholmes/restforce/tree/master/CHANGELOG.md)
 
 ## Installation
 
@@ -274,6 +275,29 @@ _See also: http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_des
 
 * * *
 
+### 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.
+
+
+```ruby
+client.picklist_values('Account', 'Type')
+# => [#<Restforce::Mash label="Prospect" value="Prospect">]
+
+# Given a custom object named Automobile__c with picklist fields
+# Model__c and Make__c, where Model__c depends on the value of
+# Make__c.
+client.picklist_values('Automobile__c', 'Model__c', :valid_for => 'Honda')
+# => [#<Restforce::Mash label="Civic" value="Civic">, ... ]
+```
+
+* * *
+
 ### authenticate!
 
 Performs an authentication and returns the response. In general, calling this

data/lib/restforce.rb

@@ -25,8 +25,9 @@ module Restforce
       Restforce::Client.new(options)
     end
 
-    def decode_signed_request(signed_request, client_secret)
-      SignedRequest.decode(signed_request, client_secret)
+    # Helper for decoding signed requests.
+    def decode_signed_request(*args)
+      SignedRequest.decode(*args)
     end
   end
 

data/lib/restforce/client.rb

@@ -1,6 +1,7 @@
 require 'restforce/client/connection'
 require 'restforce/client/authentication'
 require 'restforce/client/streaming'
+require 'restforce/client/picklists'
 require 'restforce/client/caching'
 require 'restforce/client/canvas'
 require 'restforce/client/api'
@@ -10,6 +11,7 @@ module Restforce
     include Restforce::Client::Connection
     include Restforce::Client::Authentication
     include Restforce::Client::Streaming
+    include Restforce::Client::Picklists
     include Restforce::Client::Caching
     include Restforce::Client::Canvas
     include Restforce::Client::API

data/lib/restforce/client/picklists.rb

@@ -0,0 +1,90 @@
+module Restforce
+  class Client
+    module Picklists
+
+      # Public: Get the available picklist values for a picklist or multipicklist field.
+      #
+      # sobject - The String name of the sobject.
+      # field   - The String name of the picklist/multipicklist field.
+      # options - A hash of options. (default: {}).
+      #           :valid_for - If specified, will only return picklist values
+      #                        that are valid for the controlling picklist
+      #                        value
+      #
+      # Examples
+      #
+      #   client.picklist_values('Account', 'Type')
+      #   # => [#<Restforce::Mash label="Prospect" value="Prospect">]
+      #
+      #   # Given a custom object named Automobile__c with picklist fields
+      #   # Model__c and Make__c, where Model__c depends on the value of
+      #   # Make__c.
+      #   client.picklist_values('Automobile__c', 'Model__c', :valid_for => 'Honda')
+      #   # => [#<Restforce::Mash label="Civic" value="Civic">, ... ]
+      #
+      # Returns an array of Restforce::Mash objects.
+      def picklist_values(sobject, field, options = {})
+        PicklistValues.new(describe(sobject)['fields'], field, options)
+      end
+
+    private
+
+      class PicklistValues < Array
+
+        def initialize(fields, field, options = {})
+          @fields, @field = fields, field
+          @valid_for = options.delete(:valid_for)
+          raise "#{field} is not a dependent picklist" if @valid_for && !dependent?
+          replace(picklist_values)
+        end
+
+      private
+
+        attr_reader :fields
+
+        def picklist_values
+          if valid_for?
+            field['picklistValues'].select { |picklist_entry| valid? picklist_entry }
+          else
+            field['picklistValues']
+          end
+        end
+
+        # Returns true of the given field is dependent on another field.
+        def dependent?
+          !!field['dependentPicklist']
+        end
+
+        def valid_for?
+          !!@valid_for
+        end
+
+        def controlling_picklist
+          @_controlling_picklist ||= controlling_field['picklistValues'].find { |picklist_entry| picklist_entry['value'] == @valid_for }
+        end
+
+        def index
+          @_index ||= controlling_field['picklistValues'].index(controlling_picklist)
+        end
+
+        def controlling_field
+          @_controlling_field ||= fields.find { |f| f['name'] == field['controllerName'] }
+        end
+
+        def field
+          @_field ||= fields.find { |f| f['name'] == @field }
+        end
+
+        # Returns true if the picklist entry is valid for the controlling picklist.
+        #
+        # See http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_describesobjects_describesobjectresult.htm
+        def valid?(picklist_entry)
+          valid_for = picklist_entry['validFor'].ljust(16, 'A').unpack('m').first.unpack('q*')
+          (valid_for[index >> 3] & (0x80 >> index % 8)) != 0
+        end
+
+      end
+
+    end
+  end
+end

data/lib/restforce/mash.rb

@@ -10,7 +10,7 @@ module Restforce
       # Restforce::Mash objects.
       def build(val, client)
         if val.is_a?(Array)
-          val.collect { |e| self.klass(e).new(e, client) }
+          val.collect { |val| self.build(val, client) }
         elsif val.is_a?(Hash)
           self.klass(val).new(val, client)
         else

data/lib/restforce/version.rb

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

data/spec/fixtures/sobject/sobject_describe_success_response.json

@@ -837,6 +837,64 @@
     "writeRequiresMasterRead" : false,
     "sortable" : false
   }, {
+	    "length" : 255,
+	    "name" : "Dependent_Picklist_Field",
+	    "type" : "picklist",
+	    "defaultValue" : null,
+	    "label" : "Dependent Picklist Label",
+	    "updateable" : true,
+	    "calculated" : false,
+	    "controllerName" : "Picklist_Field",
+	    "nillable" : true,
+	    "unique" : false,
+	    "precision" : 0,
+	    "scale" : 0,
+	    "caseSensitive" : false,
+	    "byteLength" : 765,
+	    "inlineHelpText" : null,
+	    "nameField" : false,
+	    "externalId" : false,
+	    "idLookup" : false,
+	    "filterable" : true,
+	    "soapType" : "xsd:string",
+	    "createable" : true,
+	    "deprecatedAndHidden" : false,
+	    "autoNumber" : false,
+	    "calculatedFormula" : null,
+	    "defaultValueFormula" : null,
+	    "defaultedOnCreate" : false,
+	    "digits" : 0,
+	    "groupable" : true,
+	    "picklistValues" : [ {
+	      "value" : "seven",
+	      "active" : true,
+	      "label" : "seven",
+	      "defaultValue" : false,
+	      "validFor" : "gAAA"
+	    }, {
+	      "value" : "eight",
+	      "active" : true,
+	      "label" : "eight",
+	      "defaultValue" : false,
+	      "validFor" : "gAAA"
+	    }, {
+	      "value" : "nine",
+	      "active" : true,
+	      "label" : "nine",
+	      "defaultValue" : false,
+	      "validFor" : "QAAA"
+	    } ],
+	    "referenceTo" : [ ],
+	    "relationshipName" : null,
+	    "relationshipOrder" : null,
+	    "restrictedPicklist" : false,
+	    "namePointing" : false,
+	    "custom" : true,
+	    "htmlFormatted" : false,
+	    "dependentPicklist" : true,
+	    "writeRequiresMasterRead" : false,
+	    "sortable" : true
+	  }, {
     "length" : 80,
     "name" : "Text_Field",
     "type" : "string",

data/spec/lib/client_spec.rb

@@ -1,5 +1,11 @@
 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 = {}
@@ -264,6 +270,42 @@ shared_examples_for 'methods' do
     end
   end
 
+  describe '.picklist_values' do
+    requests 'sobjects/Account/describe',
+      :fixture => 'sobject/sobject_describe_success_response'
+
+    context 'when given a picklist field' do
+      subject { client.picklist_values('Account', 'Picklist_Field') }
+      it { should be_an Array }
+      its(:length) { should eq 3 }
+      it { should include_picklist_values ['one', 'two', 'three'] }
+    end
+
+    context 'when given a multipicklist field' do
+      subject { client.picklist_values('Account', 'Picklist_Multiselect_Field') }
+      it { should be_an Array }
+      its(:length) { should eq 3 }
+      it { should include_picklist_values ['four', 'five', 'six'] }
+    end
+
+    describe 'dependent picklists' do
+      context 'when given a picklist field that has a dependency' do
+        subject { client.picklist_values('Account', 'Dependent_Picklist_Field', :valid_for => 'one') }
+        it { should be_an Array }
+        its(:length) { should eq 2 }
+        it { should include_picklist_values ['seven', 'eight'] }
+        it { should_not include_picklist_values ['nine'] }
+      end
+
+      context 'when given a picklist field that does not have a dependency' do
+        subject { client.picklist_values('Account', 'Picklist_Field', :valid_for => 'one') }
+        it 'raises an exception' do
+          expect { subject }.to raise_error(/Picklist_Field is not a dependent picklist/)
+        end
+      end
+    end
+  end
+
   describe '.authenticate!' do
     subject { client.authenticate! }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-08 00:00:00.000000000 Z
+date: 2013-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -149,6 +149,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -160,6 +161,7 @@ files:
 - lib/restforce/client/caching.rb
 - lib/restforce/client/canvas.rb
 - lib/restforce/client/connection.rb
+- lib/restforce/client/picklists.rb
 - lib/restforce/client/streaming.rb
 - lib/restforce/client/verbs.rb
 - lib/restforce/collection.rb
@@ -307,4 +309,3 @@ test_files:
 - spec/support/basic_client.rb
 - spec/support/fixture_helpers.rb
 - spec/support/middleware.rb
-has_rdoc: