soapforce 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ad9594a32904ff7305f9fed654cc0a71148e7e0
-  data.tar.gz: 0fb2ff0b93f97172a1e6ce0eb53591e91e9c3441
+  metadata.gz: 92708d194ae913cf1c8b95690ba30e45baaa4a8d
+  data.tar.gz: 447d8ed94094138eb2ce5e61c823926acff32b1d
 SHA512:
-  metadata.gz: 56920bf8ee1aa09ef84d071011b39c8a9a791cb183659bad3de9924adb9f1dd5599f5373db8e64fcd8ca42437e96a42c17c16ad61373f7db916457bf51deeeca
-  data.tar.gz: fda094cc5420a8a8848549937f5207d31b9fbdf1cb786b8eb2361fe3fb41aea2c4005872fd909224344ba300904e3116dc9fa1fd0c8314d245edf5d96e4b8d3f
+  metadata.gz: d34fbfb9303880a6105d4b07e3cc00783de06355cf3f89537f26c9d8bdd529fd31ad2bff3eeb4afc2bad1e7efad0f518df4779c1f145649f49c0ebb430955725
+  data.tar.gz: 51e41d674182269bc3767224add6e7049ced6ef2adc3637aed1db29782a753ff3ab1358721fb3a3324920c7583e8ef6532437068793b5d1c5e41b693b33644d6

data/.travis.yml

@@ -1,6 +1,9 @@
 language: ruby
+sudo: false
 rvm:
-  - 1.9.3
+  - 2.0.0
+  - 2.1.5
+  - 2.2.4
 notifications:
   email:
     recipients:

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.5.0 (Mar 4, 2016)
+
+* Default ssl_version to TLSv1_2
+* Switch to Ruby 2, updates rspec syntax, and update dependencies. #8
+* Add support for original message tag names #7
+
 ## 0.3.0 (Mar 25, 2015)
 
 * Adds merge command.

data/lib/soapforce.rb

@@ -4,6 +4,7 @@ require "soapforce/version"
 require "soapforce/configuration"
 
 require "soapforce/client"
+require "soapforce/result"
 require "soapforce/query_result"
 require "soapforce/sobject"
 

data/lib/soapforce/client.rb

@@ -3,6 +3,7 @@ module Soapforce
 
     attr_reader :client
     attr_reader :headers
+    attr_reader :tag_style
     attr_accessor :logger
 
     # The partner.wsdl is used by default but can be changed by passing in a new :wsdl option.
@@ -26,13 +27,22 @@ module Soapforce
       @login_url = "https://#{@host}/services/Soap/u/#{@version}"
 
       @logger = options[:logger] || false
-      # Due to recent SSLv3 POODLE vulnerabilty we default to TLSv1
-      @ssl_version = options[:ssl_version] || :TLSv1
+      # Due to SSLv3 POODLE vulnerabilty and disabling of TLSv1, use TLSv1_2
+      @ssl_version = options[:ssl_version] || :TLSv1_2
+
+      if options[:tag_style] == :raw
+        @tag_style = :raw
+        @response_tags = lambda { |key| key }
+      else
+        @tag_style = :snakecase
+        @response_tags = lambda { |key| key.snakecase.to_sym }
+      end
 
       @client = Savon.client(
         wsdl: @wsdl,
         soap_header: @headers,
         convert_request_keys_to: :none,
+        convert_response_tags_to: @response_tags,
         pretty_print_xml: true,
         logger: @logger,
         log: (@logger != false),
@@ -67,11 +77,10 @@ module Soapforce
           locals.message :username => options[:username], :password => options[:password]
         end
 
-        result = response.to_hash[:login_response][:result]
-        returned_endpoint = result[:server_url]
+        result = response.to_hash[key_name(:login_response)][key_name(:result)]
+        @session_id = result[key_name(:session_id)]
+        @server_url = result[key_name(:server_url)]
 
-        @session_id = result[:session_id]
-        @server_url = result[:server_url]
       elsif options[:session_id] && options[:server_url]
         @session_id = options[:session_id]
         @server_url = options[:server_url]
@@ -85,6 +94,7 @@ module Soapforce
         wsdl: @wsdl,
         soap_header: @headers,
         convert_request_keys_to: :none,
+        convert_response_tags_to: @response_tags,
         logger: @logger,
         log: (@logger != false),
         endpoint: @server_url,
@@ -111,7 +121,7 @@ module Soapforce
     # Returns an Array of String names for each SObject.
     def list_sobjects
       response = describe_global # method_missing
-      response[:sobjects].collect { |sobject| sobject[:name] }
+      response[key_name(:sobjects)].collect { |sobject| sobject[key_name(:name)] }
     end
 
     # Public: Get the current organization's Id.
@@ -123,10 +133,8 @@ module Soapforce
     #
     # Returns the String organization Id
     def org_id
-      object = query('select id from Organization').first
-      if object && object[:id]
-        return object[:id].is_a?(Array) ? object[:id].first : object[:id]
-      end
+      object = query('SELECT Id FROM Organization').first
+      object.Id if object
     end
 
     # Public: Returns a detailed describe result for the specified sobject
@@ -146,14 +154,11 @@ module Soapforce
     # Returns the Hash representation of the describe call.
     def describe(sobject_type)
       if sobject_type.is_a?(Array)
-        list = sobject_type.map do |type|
-          {:sObjectType => type}
-        end
-        response = call_soap_api(:describe_s_objects, :sObjectType => sobject_type)
+        response = call_soap_api(:describe_s_objects, sObjectType: sobject_type)
       else
         # Cache objects to avoid repeat lookups.
         if @describe_cache[sobject_type].nil?
-          response = call_soap_api(:describe_s_object, :sObjectType => sobject_type)
+          response = call_soap_api(:describe_s_object, sObjectType: sobject_type)
           @describe_cache[sobject_type] = response
         else
           response = @describe_cache[sobject_type]
@@ -194,19 +199,16 @@ module Soapforce
     end
 
     def query(soql)
-      result = call_soap_api(:query, {:queryString => soql})
-      QueryResult.new(result)
+      call_soap_api(:query, {:queryString => soql})
     end
 
     # Includes deleted (isDeleted) or archived (isArchived) records
     def query_all(soql)
-      result = call_soap_api(:query_all, {:queryString => soql})
-      QueryResult.new(result)
+      call_soap_api(:query_all, {:queryString => soql})
     end
 
     def query_more(locator)
-      result = call_soap_api(:query_more, {:queryLocator => locator})
-      QueryResult.new(result)
+      call_soap_api(:query_more, {:queryLocator => locator})
     end
 
     def search(sosl)
@@ -228,7 +230,7 @@ module Soapforce
     # Returns false if something bad happens.
     def create(sobject_type, properties)
       create!(sobject_type, properties)
-    rescue => e
+    rescue
       false
     end
 
@@ -263,7 +265,7 @@ module Soapforce
     # Returns false if there was an error.
     def update(sobject_type, properties)
       update!(sobject_type, properties)
-    rescue => e
+    rescue
       false
     end
 
@@ -316,7 +318,7 @@ module Soapforce
     # Returns false if an error is returned from Salesforce.
     def delete(id)
       delete!(id)
-    rescue => e
+    rescue
       false
     end
     alias_method :destroy, :delete
@@ -375,7 +377,7 @@ module Soapforce
     # Raises an exception if an error is returned from Salesforce.
     def merge(sobject_type, master_record_hash, ids)
       merge!(sobject_type, master_record_hash, ids)
-    rescue => e
+    rescue
       false
     end
 
@@ -433,8 +435,8 @@ module Soapforce
         field_names = select_fields
       end
 
-      soql = "Select #{field_names.join(", ")} From #{sobject} Where #{where_clause}"
-      result = query(soql)
+      soql = "SELECT #{field_names.join(", ")} FROM #{sobject} WHERE #{where_clause}"
+      query(soql)
     end
 
     # Public: Finds a single record and returns all fields.
@@ -449,14 +451,14 @@ module Soapforce
       field_details = field_details(sobject, field_name)
       field_names = field_list(sobject).join(", ")
 
-      if ["int", "currency", "double", "boolean", "percent"].include?(field_details[:type])
+      if ["int", "currency", "double", "boolean", "percent"].include?(field_details[key_name(:type)])
         search_value = id
       else
         # default to quoted value
         search_value = "'#{id}'"
       end
 
-      soql = "Select #{field_names} From #{sobject} Where #{field_name} = #{search_value}"
+      soql = "SELECT #{field_names} FROM #{sobject} WHERE #{field_name} = #{search_value}"
       result = query(soql)
       # Return first query result.
       result ? result.first : nil
@@ -471,8 +473,7 @@ module Soapforce
     # Returns Hash of sobject record.
     def retrieve(sobject, id)
       ids = id.is_a?(Array) ? id : [id]
-      sobject = call_soap_api(:retrieve, {fieldList: field_list(sobject).join(","), sObjectType: sobject, ids: ids})
-      sobject ? SObject.new(sobject) : nil
+      call_soap_api(:retrieve, {fieldList: field_list(sobject).join(","), sObjectType: sobject, ids: ids})
     end
 
     # ProcessSubmitRequest
@@ -515,13 +516,15 @@ module Soapforce
 
     def field_list(sobject)
       description = describe(sobject)
-      field_list = description[:fields].collect {|c| c[:name] }
+      name_key = key_name(:name)
+      description[key_name(:fields)].collect {|c| c[name_key] }
     end
 
     def field_details(sobject, field_name)
       description = describe(sobject)
-      fields = description[:fields]
-      fields.find {|f| field_name.downcase == f[:name].downcase }
+      fields = description[key_name(:fields)]
+      name_key = key_name(:name)
+      fields.find {|f| field_name.downcase == f[name_key].downcase }
     end
 
     # Supports the following No Argument methods:
@@ -535,26 +538,51 @@ module Soapforce
       call_soap_api(method, *args)
     end
 
+    def key_name(key)
+      if @tag_style == :snakecase
+        key.is_a?(Symbol) ? key : key.snakecase.to_sym
+      else
+        if key.to_s.include?('_')
+          camel_key = key.to_s.gsub(/\_(\w{1})/) {|cap| cap[1].upcase }
+        else
+          key.to_s
+        end
+      end
+    end
+
     def call_soap_api(method, message_hash={})
 
       response = @client.call(method.to_sym) do |locals|
         locals.message message_hash
       end
+
       # Convert SOAP XML to Hash
       response = response.to_hash
 
       # Get Response Body
-      response_body = response["#{method}_response".to_sym]
+      key = key_name("#{method}Response")
+      response_body = response[key]
 
       # Grab result section if exists.
-      result = response_body ? response_body[:result] : nil
+      result = response_body ? response_body[key_name(:result)] : nil
 
       # Raise error when response contains errors
-      if result && result.is_a?(Hash) && result[:success] == false && result[:errors]
-        raise Savon::Error.new("#{result[:errors][:status_code]}: #{result[:errors][:message]}")
+      if result.is_a?(Hash)
+        xsi_type = result[key_name(:"@xsi:type")].to_s
+
+        if result[key_name(:success)] == false && result[key_name(:errors)]
+          errors = result[key_name(:errors)]
+          raise Savon::Error.new("#{errors[key_name(:status_code)]}: #{errors[key_name(:message)]}")
+        elsif xsi_type.include?("sObject")
+          result = SObject.new(result)
+        elsif xsi_type.include?("QueryResult")
+          result = QueryResult.new(result)
+        else
+          result = Result.new(result)
+        end
       end
 
-      return result
+      result
     end
 
     def sobjects_hash(sobject_type, sobject_hash)

data/lib/soapforce/query_result.rb

@@ -4,39 +4,68 @@ module Soapforce
 
     attr_reader :raw_result
 
-    def initialize(result_hash={})
-      @raw_result = result_hash
+    def initialize(result={})
+      if result.is_a?(Soapforce::Result)
+        @raw_result = result.to_hash
+      else
+        @raw_result = result
+      end
+
       @result_records = [] # Default for 0 size response.
-      if @raw_result[:size].to_i == 1
-        @result_records = [@raw_result[:records]]
-      elsif @raw_result[:records]
-        @result_records = @raw_result[:records]
+      @key_type = @raw_result.key?(:size) ? :symbol : :string
+
+      records_key = key_name("records")
+
+      if @raw_result[records_key]
+        @result_records = @raw_result[records_key]
+        # Single records come back as a Hash. Wrap in array.
+        if @result_records.is_a?(Hash)
+          @result_records = [@result_records]
+        end
       end
 
       # Convert to SObject type.
       @result_records.map! {|hash| SObject.new(hash) }
     end
 
+    def records
+      @result_records
+    end
+
     # Implmentation for Enumerable mix-in.
     def each(&block)
       @result_records.each(&block)
     end
 
+    def map(&block)
+      @result_records.map(&block)
+    end
+
     def size
-      @raw_result[:size].to_i || 0
+      @raw_result[key_name("size")].to_i || 0
     end
 
     def done?
-      @raw_result[:done] || true
+      @raw_result[key_name("done")] || true
     end
 
     def query_locator
-      @raw_result[:query_locator]
+      @raw_result[key_name("queryLocator")]
     end
 
     def method_missing(method, *args, &block)
-      @result_records.send(method, *args, &block)
+      if @result_records.respond_to?(method)
+        @result_records.send(method, *args, &block)
+      end
+    end
+
+    def key_name(key)
+      if @key_type == :symbol
+        key.is_a?(String) ? key.snakecase.to_sym : key
+      else
+        key.to_s
+      end
     end
   end
 
-end
+end

data/lib/soapforce/result.rb

@@ -0,0 +1,36 @@
+module Soapforce
+  class Result
+    extend Forwardable
+
+    attr_reader :raw_hash
+
+    def_delegators :@raw_hash, :key?, :has_key?, :each, :map, :to_hash
+
+    def initialize(result_hash={})
+      @raw_hash = result_hash
+    end
+
+    def [](index)
+      # If index is a symbol, try :field_name, "fieldName", "field_name"
+      if index.is_a?(Symbol)
+        if @raw_hash.key?(index)
+          @raw_hash[index]
+        elsif index.to_s.include?('_')
+          camel_key = index.to_s.gsub(/\_(\w{1})/) {|cap| cap[1].upcase }
+          @raw_hash[camel_key]
+        else
+          @raw_hash[index.to_s]
+        end
+      elsif index.is_a?(String)
+        # If index is a String, try fieldName, :fieldName, :field_name
+        if @raw_hash.key?(index)
+          @raw_hash[index]
+        elsif @raw_hash.key?(index.to_sym)
+          @raw_hash[index.to_sym]
+        else
+          @raw_hash[index.snakecase.to_sym]
+        end
+      end
+    end
+  end
+end

data/lib/soapforce/sobject.rb

@@ -4,32 +4,60 @@ module Soapforce
 
     def initialize(hash)
       @raw_hash = hash || {}
+      id_key = @raw_hash.key?(:id) ? :id : 'Id'
+
+      # For some reason the Id field is coming back twice and stored in an array.
+      if @raw_hash[id_key].is_a?(Array)
+        @raw_hash[id_key] = @raw_hash[id_key].compact.uniq
+        # Remove empty id array if nothing exists.
+        if @raw_hash[id_key].empty?
+          @raw_hash.delete(id_key)
+        elsif @raw_hash[id_key].size == 1
+          @raw_hash[id_key] = @raw_hash[id_key].first
+        end
+      end
     end
 
-    # For some reason the Id field is coming back twice and stored in an array.
     def Id
-      @raw_hash[:id].is_a?(Array) ? @raw_hash[:id].first : @raw_hash[:id]
+      @raw_hash[:id] || @raw_hash['Id']
     end
 
     def [](index)
-      @raw_hash[index.to_sym]
+      val = @raw_hash[index]
+
+      # When fetching a child relationship, wrap it in QueryResult
+      if val.is_a?(Hash) && (val.has_key?(:records) || val.has_key?("records"))
+        val = QueryResult.new(val)
+      end
+      val
     end
 
     def []=(index, value)
-      @raw_hash[index.to_sym] = value
+      @raw_hash[index] = value
+    end
+
+    def has_key?(key)
+      @raw_hash.has_key?(key)
     end
 
     # Allows method-like access to the hash using camelcase field names.
     def method_missing(method, *args, &block)
-
+      # Check string keys first, original and downcase
       string_method = method.to_s
+
+      if raw_hash.key?(string_method)
+        return self[string_method]
+      elsif raw_hash.key?(string_method.downcase)
+        return self[string_method.downcase]
+      end
+
       if string_method =~ /[A-Z+]/
-        string_method = underscore(string_method)
+        string_method = string_method.snakecase
       end
 
       index = string_method.downcase.to_sym
-      # First return local hash entry.
-      return raw_hash[index] if raw_hash.has_key?(index)
+      # Check symbol key and return local hash entry.
+      return self[index] if raw_hash.has_key?(index)
       # Then delegate to hash object.
       if raw_hash.respond_to?(method)
         return raw_hash.send(method, *args)
@@ -38,15 +66,5 @@ module Soapforce
       nil
     end
 
-    protected
-
-    def underscore(str)
-      str.gsub(/::/, '/').
-        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-        gsub(/([a-z\d])([A-Z])/,'\1_\2').
-        tr("-", "_").
-        downcase
-    end
-
   end
 end