soapforce 0.1.3 → 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTk2ZjA2ZjNkY2IzMzI0ZWRiNmY5ZTNhYmRhNzlmN2Q2ZWM5NjllOA==
+  data.tar.gz: !binary |-
+    ZGQyZTNhZjdkMzU0MDVmZDNjNWJiMTQ3NjhkNzYyYzgxZTg5ODc3NQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZWVmMzlmZGUxNTFmZWY4ZDlmNGFjN2ZhOTcyYzM0YjNhYTU2YjE2ZTA1NzQ0
+    MjIyM2YyZWFkOTkzZTU0ODk5N2UwYWZkNWFmZjFkY2YzZDBjNTI0NDlhMTky
+    ODg5Yjk5MDViNTg1YmQ3YjFmYTVkNWM5OWMxNThkNzRmZTUzNmM=
+  data.tar.gz: !binary |-
+    NDFhMTRmYjE1MTQ0NzNkM2QzM2Q2ZGYyMjdjOWE0ZmQ2MDBkMzBkODdhZTI1
+    Mjk0ZGQ5MTc5YmIwN2MyY2VkNGQ0YTBjNGM1MDI0NWMwZDE1MzU5NTUwNzEz
+    ZDhiYmNjY2QwODJhMTRlNzRjOTQ0MzE3ZTJhMGYyYTg4OWYyZGQ=

data/.rspec

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

data/README.md

@@ -28,7 +28,7 @@ Or install it yourself as:
 
 ## Usage
 
-For ISV Partners you can specify your client_id in a configuration block which will get included in the CallOptions header of every request.  
+For ISV Partners you can specify your client_id in a configuration block which will get included in the CallOptions header of every request.
 
     # config/initializers/soapforce.rb
     # This is your ISV Partner Client ID.
@@ -37,6 +37,21 @@ For ISV Partners you can specify your client_id in a configuration block which w
       config.client_id     = "ParterName/SomeValue/"
     end
 
+### Sandbox Orgs
+
+You can connect to sandbox orgs by specifying a host. The default host is 'login.salesforce.com':
+
+```ruby
+client = Soapforce::Client.new(:host => 'test.salesforce.com')
+```
+
+### Logging
+
+You can specify a logger by passing a logger. Logging is disabled by default.
+
+```ruby
+client = Soapforce::Client.new(:logger => 'test.salesforce.com')
+```
 
 #### Username/Password authentication
 
@@ -130,6 +145,18 @@ client.describe(['Account', 'Opportunity'])
 # => [{ ... },{ ... }]
 ```
 
+### describe_layout
+
+```ruby
+# get layouts for an sobject type
+client.describe_layout('Account')
+# => { ... }
+
+# get the details for a specific layout
+client.describe_layout('Account', '012000000000000AAA')
+# => { ... }
+```
+
 ### logout
 
 ```ruby

data/lib/soapforce/client.rb

@@ -3,26 +3,38 @@ module Soapforce
 
     attr_reader :client
     attr_reader :headers
+    attr_accessor :logger
 
     # The partner.wsdl is used by default but can be changed by passing in a new :wsdl option.
-    # A client_id can be 
+    # A client_id can be
     def initialize(options={})
       @describe_cache = {}
+      @describe_layout_cache = {}
       @headers = {}
+
       @wsdl = options[:wsdl] || File.dirname(__FILE__) + "/../../resources/partner.wsdl.xml"
 
-      # If a client_id is provided then it needs to be included 
+      # If a client_id is provided then it needs to be included
       # in the header for every request.  This allows ISV Partners
       # to make SOAP calls in Professional/Group Edition organizations.
 
       client_id = options[:client_id] || Soapforce.configuration.client_id
       @headers = {"tns:CallOptions" => {"tns:client" => client_id}} if client_id
 
+      @version = options[:version] || Soapforce.configuration.version || 28.0
+      @host = options[:host] || "login.salesforce.com"
+      @login_url = "https://#{@host}/services/Soap/u/#{@version}"
+
+      @logger = options[:logger] || false
+
       @client = Savon.client(
         wsdl: @wsdl,
         soap_header: @headers,
         convert_request_keys_to: :none,
-        pretty_print_xml: true
+        pretty_print_xml: true,
+        logger: @logger,
+        log: (@logger != false),
+        endpoint: @login_url
         )
     end
 
@@ -70,6 +82,8 @@ module Soapforce
         wsdl: @wsdl,
         soap_header: @headers,
         convert_request_keys_to: :none,
+        logger: @logger,
+        log: (@logger != false),
         endpoint: @server_url
       )
 
@@ -129,7 +143,7 @@ module Soapforce
     def describe(sobject_type)
       if sobject_type.is_a?(Array)
         list = sobject_type.map do |type|
-          {:sObjectType => type} 
+          {:sObjectType => type}
         end
         response = call_soap_api(:describe_s_objects, :sObjectType => sobject_type)
       else
@@ -145,6 +159,36 @@ module Soapforce
       response
     end
 
+    # Public: Returns the layout for the specified object
+    #
+    # sobject - String name of the sobject.
+    #
+    # Examples
+    #
+    #   # get layouts for an sobject type
+    #   client.describe_layout('Account')
+    #   # => { ... }
+    #
+    #   # get layouts for an sobject type
+    #   client.describe_layout('Account', '012000000000000AAA')
+    #   # => { ... }
+    #
+    # Returns the Hash representation of the describe call.
+    def describe_layout(sobject_type, layout_id=nil)
+      # Cache objects to avoid repeat lookups.
+      @describe_layout_cache[sobject_type] ||={}
+
+      # nil key is for full object.
+      if @describe_layout_cache[sobject_type][layout_id].nil?
+        response = call_soap_api(:describe_layout, :sObjectType => sobject_type, :recordTypeIds => layout_id)
+        @describe_layout_cache[sobject_type][layout_id] = response
+      else
+        response = @describe_layout_cache[sobject_type][layout_id]
+      end
+
+      response
+    end
+
     def query(soql)
       result = call_soap_api(:query, {:queryString => soql})
       QueryResult.new(result)

data/lib/soapforce/configuration.rb

@@ -1,6 +1,7 @@
 module Soapforce
   class Configuration
     attr_accessor :client_id
+    attr_accessor :version
 
     def initialize
       @client_id = nil
@@ -9,7 +10,7 @@ module Soapforce
 
   class << self
     def configuration
-      @configuration ||= Configuration.new 
+      @configuration ||= Configuration.new
     end
 
     def configure

data/lib/soapforce/version.rb

@@ -1,3 +1,3 @@
 module Soapforce
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/soapforce.gemspec

@@ -3,32 +3,24 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'soapforce/version'
 
-Gem::Specification.new do |gem|
-  gem.name          = "soapforce"
-  gem.version       = Soapforce::VERSION
-  gem.authors       = ["Joe Heth"]
-  gem.email         = ["joeheth@gmail.com"]
-  gem.description   = %q{A ruby client for the Salesforce SOAP API based on Savon.}
-  gem.summary       = %q{Wraps Savon with helper methods and custom types for interacting with the Salesforce SOAP API.}
-  gem.homepage      = "https://github.com/TinderBox/soapforce"
-  gem.license       = 'MIT'
+Gem::Specification.new do |spec|
+  spec.name          = "soapforce"
+  spec.version       = Soapforce::VERSION
+  spec.authors       = ["Joe Heth"]
+  spec.email         = ["joeheth@gmail.com"]
+  spec.description   = %q{A ruby client for the Salesforce SOAP API based on Savon.}
+  spec.summary       = %q{Wraps Savon with helper methods and custom types for interacting with the Salesforce SOAP API.}
+  spec.homepage      = "https://github.com/TinderBox/soapforce"
+  spec.license       = 'MIT'
 
-  ignores  = File.readlines('.gitignore').grep(/\S+/).map(&:chomp)
-  dotfiles = %w[.gitignore .travis.yml]
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  all_files_without_ignores = Dir['**/*'].reject { |f|
-    File.directory?(f) || ignores.any? { |i| File.fnmatch(i, f) }
-  }
+  spec.add_runtime_dependency "savon", "~>2.3.0", '>= 2.3.0'
 
-  gem.files = (all_files_without_ignores + dotfiles).sort
-
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-
-  gem.add_dependency("savon", "~>2.3.0")
-
-  gem.add_development_dependency 'rspec', '~> 2.14.0'
-  gem.add_development_dependency 'webmock', '~> 1.13.0'
-  gem.add_development_dependency 'simplecov', '~> 0.7.1'
+  spec.add_development_dependency 'rspec', '~> 2.14.0', '>= 2.14.0'
+  spec.add_development_dependency 'webmock', '~> 1.17.0', '>= 1.17.0'
+  spec.add_development_dependency 'simplecov', '~> 0.9.0', '>= 0.9.0'
 end

data/spec/fixtures/describe_layout_response.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns="urn:partner.soap.sforce.com" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <soapenv:Body>
+    <describeLayoutResponse>
+      <result>
+        <!-- Lots of layout data here -->
+      </result>
+    </describeLayoutResponse>
+  </soapenv:Body>
+</soapenv:Envelope>

data/spec/lib/client_spec.rb

@@ -83,6 +83,28 @@ describe Soapforce::Client do
     end
   end
 
+  describe "#descibeLayout" do
+
+    it "gets layouts for an sobject type" do
+
+      body = %Q{<tns:describeLayout><tns:sObjectType>Account</tns:sObjectType><tns:recordTypeIds xsi:nil="true"/></tns:describeLayout>}
+      stub = stub_api_request(endpoint, {with_body: body, fixture: 'describe_layout_response'})
+
+      subject.describe_layout("Account")
+
+      # Hit cache.
+      subject.describe_layout("Account")
+    end
+
+    it "get the details for a specific layout" do
+
+      body = %Q{<tns:describeLayout><tns:sObjectType>Account</tns:sObjectType><tns:recordTypeIds>012000000000000AAA</tns:recordTypeIds></tns:describeLayout>}
+      stub = stub_api_request(endpoint, {with_body: body, fixture: 'describe_layout_response'})
+
+      subject.describe_layout('Account', '012000000000000AAA')
+    end
+  end
+
   describe "#retrieve" do
 
     it "should retrieve object by id" do

metadata

@@ -1,80 +1,95 @@
 --- !ruby/object:Gem::Specification
 name: soapforce
 version: !ruby/object:Gem::Version
-  version: 0.1.3
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Joe Heth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-25 00:00:00.000000000 Z
+date: 2014-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.3.0
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.3.0
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.0
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.0
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: 1.17.0
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: 1.17.0
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.17.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.9.0
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.9.0
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 description: A ruby client for the Salesforce SOAP API based on Savon.
 email:
 - joeheth@gmail.com
@@ -83,13 +98,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/soapforce.rb
-- lib/soapforce/actions
 - lib/soapforce/client.rb
 - lib/soapforce/configuration.rb
 - lib/soapforce/query_result.rb
@@ -102,6 +117,7 @@ files:
 - spec/fixtures/delete_response.xml
 - spec/fixtures/delete_response_failure.xml
 - spec/fixtures/describe_global_response.xml
+- spec/fixtures/describe_layout_response.xml
 - spec/fixtures/describe_s_object_response.xml
 - spec/fixtures/describe_s_objects_response.xml
 - spec/fixtures/get_user_info_response.xml
@@ -123,31 +139,29 @@ files:
 - spec/lib/sobject_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixture_helpers.rb
-- test.rb
 homepage: https://github.com/TinderBox/soapforce
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Wraps Savon with helper methods and custom types for interacting with the
   Salesforce SOAP API.
 test_files:
@@ -156,6 +170,7 @@ test_files:
 - spec/fixtures/delete_response.xml
 - spec/fixtures/delete_response_failure.xml
 - spec/fixtures/describe_global_response.xml
+- spec/fixtures/describe_layout_response.xml
 - spec/fixtures/describe_s_object_response.xml
 - spec/fixtures/describe_s_objects_response.xml
 - spec/fixtures/get_user_info_response.xml

data/lib/soapforce/actions

@@ -1,38 +0,0 @@
-login
-describe_s_object
-describe_s_objects
-describe_global
-describe_data_category_groups
-describe_data_category_group_structures
-describe_layout
-describe_softphone_layout
-describe_search_layouts
-describe_search_scope_order
-describe_tabs
-create
-update
-upsert
-merge
-delete
-undelete
-empty_recycle_bin
-retrieve
-process
-convert_lead
-logout
-invalidate_sessions
-get_deleted
-get_updated
-query
-query_all
-query_more
-search
-get_server_timestamp
-set_password
-reset_password
-get_user_info
-send_email_message
-send_email
-perform_quick_actions
-describe_quick_actions
-describe_available_quick_actions

data/test.rb

@@ -1,58 +0,0 @@
-require 'soapforce'
-
-Soapforce.configure do |config|
-	config.client_id = "TinderBox/TinderBox/"
-end
-
-client = Soapforce::Client.new
-puts client.operations
-
-user_result = client.login(username: "joe.heth@gettinderbox.com", password: "t1nd3rb0x1uzAgNZt8mT7G0MZlIr1Zq0oG") #   1Qn2uKB1DGZBF8WNGMFz1CS42s")
-
-client.invalidate_sessions
-
-exit
-#ap client.get_user_info
-
-#ap client.list_sobjects
-#ap client.org_id
-#ap client.field_list("Opportunity")
-#ap client.field_details("Opportunity", "Name")
-#ap client.find_by_field("Opportunity", "006A000000LbkT5IAJ", "Id")
-
-#ap client.find_where("Opportunity", {Id: "006A000000LbkT5IAJ", Amount: nil}).first
-ap client.retrieve("Opportunity", "006A000000LbkT5IAJ")
-
-exit
-
-opp = client.describe("Opportunity")
-ap opp
-
-objects = client.describe(["Account", "Contact"])
-ap objects.first
-ap objects.last
-
-result = client.query("Select Id, Name, StageName From Opportunity WHERE Id = '006A000000LZhwN' OR Id = '006A000000LaF4x'")
-result.each do |opp|
-	ap opp
-end
-
-#result = client.search("FIND {Name} IN ALL FIELDS RETURNING Account (Id, Name), Contact, Opportunity, Lead")
-#ap result
-
-ap client.create("Opportunity", {
-	Name: "SOAPForce Opportunity",
-	CloseDate: Date.today,
-	StageName: 'Prospecting'
-	})
-
-=begin
-ap client.update("Opportunity", {
-	Id: "006A000000LbiizIAB",
-	tinderbox__OrderNumber__c: "12345",
-	tinderbox__TrackingNumber__c: "ABCDEF",
-	Amount: 12.50
-})
-
-ap client.delete("006A000000LbiizIAB")
-=end