sf-username-password-authentication-and-rest-api 0.0.1 → 0.0.2

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 salesforce_config.rb
+.rvmrc

data/README.md

@@ -1,6 +1,6 @@
 # Purpose
 
-I wanted a simple easy way to interact with the [Salesforce REST API](http://www.salesforce.com/us/developer/docs/api_rest/index_Left.htm) using their [Username-Password OAuth Authentication Flow](http://www.salesforce.com/us/developer/docs/api_rest/Content/intro_understanding_username_password_oauth_flow.htm).
+I wanted a simply easy way to interact with the [Salesforce REST API](http://www.salesforce.com/us/developer/docs/api_rest/index_Left.htm) using their [Username-Password OAuth Authentication Flow](http://www.salesforce.com/us/developer/docs/api_rest/Content/intro_understanding_username_password_oauth_flow.htm).
 
 # Goal
 
@@ -62,8 +62,7 @@ _Note:_ options will be used over ENV variables if both are available.
       client_id: "client_id", 
       client_secret: "client_secret",
       host: "test.salesforce.com"
-
-    }
+    })
 
 ### REST API Examples
 
@@ -80,7 +79,7 @@ Once you have a SalesforceAPI::Caller instance you can make calls like:
     caller.query "Select Id, ParentId, OwnerId, Name, Body From Attachment where ParentId = 'a0Ce00000005b9P'"
 
     # get a specific attachment as a binary/string
-    caller.attachment("Attachment", "00Pe0000000IVTyEAO").class
+    caller.attachment("Attachment", "00Pe0000000IVTyEAO")
 
 Responses are for the most part just JSON which is easily parsed like: 
     

data/lib/salesforce-api.rb

@@ -5,6 +5,13 @@ require "json"
 require "active_support/core_ext/hash/indifferent_access"
 require 'salesforce-api/caller'
 
+# Ruby 1.9.3 introduces "hostname" this provides it for earlier versions of ruby.
+class URI::Generic
+  if !URI.respond_to?(:hostname) && URI.respond_to?(:host) 
+    alias_method :hostname, :host
+  end
+end
+
 module SalesforceAPI
   def self.api_versions host = "na1.salesforce.com"
     JSON.parse(Net::HTTP.get(host, "/services/data"))

data/lib/salesforce-api/caller.rb

@@ -2,6 +2,7 @@ module SalesforceAPI
   
   class ConnectionException < StandardError; end
   class ErrorReceivedException < StandardError; end
+  class Error400 < StandardError; end
 
   class Caller
 
@@ -47,6 +48,23 @@ module SalesforceAPI
       end
     end
 
+    def http_patch uri, body, auto_authorize = true
+      req = Net::HTTPGenericRequest.new("PATCH", nil, nil, uri.request_uri)
+      req["Authorization"] = "Bearer #{access_token}"
+      req["Content-Type"] = "application/json"
+      req.body = body.to_json
+      response = Net::HTTP.start( uri.hostname, uri.port, :use_ssl => true ) do |http|
+        http.request( req )
+      end
+
+      if response.instance_of?(Net::HTTPUnauthorized) && auto_authorize
+        authorize
+        http_patch uri, body, false
+      else
+        response
+      end
+    end
+
     def sobject name, id, fields = ""
       uri = URI("#{instance_url}/services/data/v#{api_version}/sobjects/#{name}/#{id}")
       uri.query = {:fields => fields}.to_query unless fields.empty?
@@ -69,6 +87,14 @@ module SalesforceAPI
       }.delete_if{|k,v| v.to_s.empty?} : @token_request_parameters
     end
 
+    def update name, id, body = {}
+      uri = URI("#{instance_url}/services/data/v#{api_version}/sobjects/#{name}/#{id}")
+      response = http_patch( uri, body )
+      if response.instance_of? Net::HTTPBadRequest
+        raise Error400, "The request could not be understood, usually because the JSON or XML body contains an error. Code[#{response.code}]."
+      end
+    end
+
     private
 
     def parse_authorization_response json

data/lib/salesforce-api/version.rb

@@ -1,3 +1,3 @@
 module SalesforceAPI
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/test_salesforce_api.rb

@@ -79,6 +79,5 @@ describe SalesforceAPI::Caller do
         response.must_equal mock_response
       end
     end
-
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sf-username-password-authentication-and-rest-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-03 00:00:00.000000000 Z
+date: 2013-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &19944440 !ruby/object:Gem::Requirement
+  requirement: &23347140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19944440
+  version_requirements: *23347140
 description: Easy to use Salesforce REST API caller, using the Username-Password OAuth
   Authentication Flow.
 email: