salesforce_connector 0.0.2 → 0.0.3

data/README.rdoc

@@ -2,14 +2,42 @@
 
 Rails gem to connect an application to Salesforce accounts.
 
-== Install
+== Install in your Gemfile
 
-  gem install salesforce_connector
+  gem 'salesforce_connector'
 
+== Dependencies
+
+Salesforce Connector is based on HTTParty to access Salesforce API and on OmniAuth to retrieve OAuth2 tokens.
 
 == Usage
 
+In your initiliazer (Rails3) or config.ru file (Sinatra or Padrino) add the 4 following elements
+
+Add the Forcedotcom OAuth Strategy 
+  module OmniAuth
+    module Strategies
+      #tell omniauth to load our strategy
+      autoload :Forcedotcom, '???'
+    end
+  end
+
+Define the current host:
+  OmniAuth.config.full_host = 'https://localhost:3000'
+
+Configure the Salesforce remote server URL and version
+  ENV['sfdc_instance_url'] = "https://eu1.salesforce.com"
+  ENV['sfdc_api_version']  = "21.0"
+
+Load the Forcedotcom OAuth strategy
+  use OmniAuth::Builder do
+    provider :forcedotcom, '3MVG9PhR6g6B7ps6in8a_o8S1IvXGM41y725iSJXhSWZm5GJ0gZgvuQkLdT7YWOLciMWxn5yDglwAcjkGzcal', '2539130913145733702'
+  end
+
+== Note
 
+Salesforce OAuth only implement https authentication. 
+Be sure that your server (requester) is also running behing https.
 
 == License
 

data/lib/forcedotcom.rb

@@ -0,0 +1,43 @@
+#require "salesforce_connector/version"
+require 'omniauth/oauth'
+require 'multi_json'
+
+
+# Omniauth strategy for using oauth2 and force.com
+# Author: vzmind@gmail.com
+#
+module OmniAuth
+  module Strategies
+    class Forcedotcom < OAuth2
+      # Initialize the middleware
+      #
+      # @option options [Boolean, true] :sign_in When true, use a sign-in flow instead of the authorization flow.
+      # @option options [Boolean, false] :mobile When true, use the mobile sign-in interface.
+      def initialize(app, client_id = nil, client_secret = nil, options = {}, &block)
+        client_options = {
+          :site => "https://login.salesforce.com",
+          :authorize_path => "/services/oauth2/authorize",
+          :access_token_path => "/services/oauth2/token"
+        }
+        super(app, :forcedotcom, client_id, client_secret, client_options, &block)
+      end
+
+      def request_phase
+        options[:response_type] ||= 'code'
+        super
+      end
+
+      def callback_phase
+        options[:grant_type] ||= 'authorization_code'
+        super
+      end
+
+       def auth_hash
+          OmniAuth::Utils.deep_merge(super, {
+            'instance_url' => @access_token['instance_url']
+          })
+       end
+      
+    end
+  end
+end

data/lib/salesforce_connector.rb

@@ -1,5 +1,7 @@
 require "salesforce_connector/version"
+require "salesforce_connector/account"
+require "forcedotcom"
 
 module SalesforceConnector
-  # Your code goes here...
+
 end

data/lib/salesforce_connector/account.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'httparty'
+
+module SalesforceConnector
+  class Account
+    include HTTParty
+    #doesn't seem to pick up env variable correctly if I set it here
+    #headers 'Authorization' => "OAuth #{ENV['sfdc_token']}"
+    format :json
+    #debug_output $stderr
+
+    def self.set_headers
+      headers 'Authorization' => "OAuth #{ENV['sfdc_token']}"
+    end
+
+    def self.root_url
+      @root_url = ENV['sfdc_instance_url']+"/services/data/v"+ENV['sfdc_api_version']
+    end
+
+    def self.get_first_hundred
+      SalesforceConnector::Account.set_headers
+      get(SalesforceConnector::Account.root_url+"/query/?q=#{CGI::escape('SELECT Name, Id from Account LIMIT 100')}")
+    end
+
+    def self.get_all_by_last_name(last_name)
+      #TODO
+    end
+  end
+end
+

data/lib/salesforce_connector/version.rb

@@ -1,3 +1,3 @@
 module SalesforceConnector
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: salesforce_connector
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Vzmind
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-01 00:00:00 Z
+date: 2011-08-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: omniauth
@@ -63,7 +63,9 @@ files:
 - Gemfile
 - README.rdoc
 - Rakefile
+- lib/forcedotcom.rb
 - lib/salesforce_connector.rb
+- lib/salesforce_connector/account.rb
 - lib/salesforce_connector/version.rb
 - salesforce_connector.gemspec
 homepage: http://github.com/vzmind