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

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+salesforce_config.rb

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sf-username-password-authentication-and-rest-api.gemspec
+gemspec
+
+
+group :development do
+  gem 'guard-minitest'
+  gem 'rb-inotify'
+end
+
+group :test do
+  gem 'minitest'
+  gem 'mocha'
+end 

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'minitest' do
+  # with Minitest::Unit
+  watch(%r|^test/(.*)\/?test_(.*)\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r|^test/test_helper\.rb|)    { "test" }
+
+  # with Minitest::Spec
+  # watch(%r|^spec/(.*)_spec\.rb|)
+  # watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  # watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+
+  # Rails 3.2
+  # watch(%r|^app/controllers/(.*)\.rb|) { |m| "test/controllers/#{m[1]}_test.rb" }
+  # watch(%r|^app/helpers/(.*)\.rb|)     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r|^app/models/(.*)\.rb|)      { |m| "test/unit/#{m[1]}_test.rb" }  
+  
+  # Rails
+  # watch(%r|^app/controllers/(.*)\.rb|) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r|^app/helpers/(.*)\.rb|)     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r|^app/models/(.*)\.rb|)      { |m| "test/unit/#{m[1]}_test.rb" }  
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Vallance
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,99 @@
+# 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).
+
+# Goal
+
+1. Handle authorization and re-authorization when the callers session token expires.
+2. Provide a generic low level method to make API calls, and provide some of the more common calls (so far I have only added a couple which is all I needed).
+
+# Assumptions
+
+I try to never have any, I simple expose the REST API calls in a easy manor and return JSON results.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sf-username-password-authentication-and-rest-api', :git => "git://github.com/dvallance/sf-username-password-authentication-and-rest-api.git", :require => "salesforce-api" 
+
+Require the code if necessary (note: some frameworks like rails are set to auto-require gems for you by default)
+
+    require 'salesforce-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sf-username-password-authentication-and-rest-api
+
+## Usage
+
+You need to supply your credentials in one of two ways and instantiate a SalesforceAPI::Caller.
+
+### Version
+
+You can see a list of available Salesforce Rest API Versions like this:
+
+    SalesforceAPI::versions("na1.salesforce.com") # defaults to this host if not supplied.
+
+### Credentials from Environmental Values
+    
+    # Example of pointing to a sandbox.
+    ENV["SALESFORCE_API_VERSION"] = "26.0" 
+    ENV["SALESFORCE_USERNAME"] = "username@mycompany.sandboxname"
+    ENV["SALESFORCE_PASSWORD"] = "password"
+    ENV["SALESFORCE_CLIENT_ID"] = "client_id"
+    ENV["SALESFORCE_CLIENT_SECRET"] = "client_secret"
+    ENV["SALESFORCE_HOST"] = "test.salesforce.com" #pointing to a sandbox
+
+    caller = SalesforceAPI::Caller.new
+
+### Credentials supplied as Options
+
+_Note:_ options will be used over ENV variables if both are available.
+
+    caller = SalesforceAPI::Caller.new({
+      api_version: "26.0",
+      username: "username@mycompany.sandboxname",
+      password: "password",
+      client_id: "client_id", 
+      client_secret: "client_secret",
+      host: "test.salesforce.com"
+
+    }
+
+### REST API Examples
+
+Once you have a SalesforceAPI::Caller instance you can make calls like:
+    
+    # get an object by its type and its id.
+    caller.sobject "Communication_Log__c", "a0Ce00000005c9G" 
+    caller.sobject "Communication_Log__c", "a0Ce00000005c9G", "Email" # ask for only 1 field instead of all by default 
+
+    # get an attachment
+    caller.attachment("Attachment", "00Pe0000000IVTyEAH")
+    
+    # running a query to get all attachments that belong to a specific parent
+    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
+
+Responses are for the most part just JSON which is easily parsed like: 
+    
+    JSON.parse(response)
+
+### Want more API Methods?
+
+This is all I needed for my current project but if there is a demand/need for more let me know I'll add them or better yet contribute!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r salesforce-api.rb"
+end

data/lib/salesforce-api.rb

@@ -0,0 +1,12 @@
+require 'net/http'
+require 'uri'
+require "active_support/core_ext/object/to_query"
+require "json"
+require "active_support/core_ext/hash/indifferent_access"
+require 'salesforce-api/caller'
+
+module SalesforceAPI
+  def self.api_versions host = "na1.salesforce.com"
+    JSON.parse(Net::HTTP.get(host, "/services/data"))
+  end
+end

data/lib/salesforce-api/caller.rb

@@ -0,0 +1,85 @@
+module SalesforceAPI
+  
+  class ConnectionException < StandardError; end
+  class ErrorReceivedException < StandardError; end
+
+  class Caller
+
+    attr_reader :api_version, :username, :password, :client_id, :client_secret, :host, :instance_url, :id, :issued_at, :access_token, :signature
+
+    def initialize options = {} 
+      @api_version = options[:api_version] ||= ENV["SALESFORCE_API_VERSION"] 
+      @username = options[:username] ||= ENV["SALESFORCE_USERNAME"]
+      @password = options[:password] ||= ENV["SALESFORCE_PASSWORD"]
+      @client_id = options[:client_id] ||= ENV["SALESFORCE_CLIENT_ID"]
+      @client_secret = options[:client_secret] ||= ENV["SALESFORCE_CLIENT_SECRET"]
+      @host = options[:host] ||= ENV["SALESFORCE_HOST"]
+      authorize
+    end
+
+    def attachment name, id
+      http_get( URI("#{instance_url}/services/data/v#{api_version}/sobjects/#{name}/#{id}/body")).body
+    end
+
+    def authorize
+      begin
+        parse_authorization_response( Net::HTTP.new(@host, 443).tap { |http|
+          http.use_ssl = true
+        }.post("/services/oauth2/token", token_request_parameters.to_query).body)
+      rescue Errno::ECONNREFUSED
+        raise ConnectionException, "Connection problem, did you supply a host?"
+      end
+      self
+    end
+
+    def http_get uri, auto_authorize = true
+      req = Net::HTTP::Get.new(uri.request_uri)
+      req["Authorization"] = "Bearer #{access_token}"
+      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_get uri, 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?
+      http_get(uri).body
+    end
+
+    def query query_string
+      uri = URI("#{instance_url}/services/data/v#{api_version}/query")
+      uri.query = "q=#{URI::escape(query_string)}"
+      http_get(uri).body
+    end
+
+    def token_request_parameters
+      @token_request_parameters.nil? ? @token_request_parameters = {
+        :grant_type => "password",
+        :username => @username,
+        :password => @password,
+        :client_id => @client_id,
+        :client_secret => @client_secret
+      }.delete_if{|k,v| v.to_s.empty?} : @token_request_parameters
+    end
+
+    private
+
+    def parse_authorization_response json
+      hash = JSON.parse(json)
+      raise ErrorReceivedException, "Authentication error: #{hash["error"]}" if hash["error"]
+      @instance_url = hash["instance_url"]
+      @id = hash["id"]
+      @issued_at = hash["issued_at"]
+      @access_token = hash["access_token"]
+      @signature = hash["signature"]
+    end
+
+  end
+end

data/lib/salesforce-api/version.rb

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

data/sf-username-password-authentication-and-rest-api.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'salesforce-api/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sf-username-password-authentication-and-rest-api"
+  gem.version       = SalesforceAPI::VERSION
+  gem.authors       = ["David Vallance"]
+  gem.email         = ["dvallance@infotech.com\n"]
+  gem.description   = %q{Easy to use Salesforce REST API caller, using the Username-Password OAuth Authentication Flow.}
+  gem.summary       = %q{See the homepage for details.}
+  gem.homepage      = "https://github.com/dvallance/sf-username-password-authentication-and-rest-api"
+
+  gem.files         = `git ls-files`.split($/)
+  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("activesupport")
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/spec'
+require 'salesforce-api'
+require "mocha"

data/test/test_salesforce_api.rb

@@ -0,0 +1,84 @@
+require 'test_helper'
+
+describe SalesforceAPI::Caller do
+
+  describe "not supplying any authentication parameters" do
+
+    it "causes a connection exception if Net:Http.post barfs" do
+      Net::HTTP.any_instance.stubs(:post).raises(Errno::ECONNREFUSED)
+      -> {SalesforceAPI::Caller.new()}.must_raise SalesforceAPI::ConnectionException
+    end
+
+    it "causes a error received exception if there is a json error response" do
+      Net::HTTP.any_instance.stubs(:post).returns(stub(:body => '{"error":"unsupported_grant_type"}'))
+
+      -> {SalesforceAPI::Caller.new(:host => "test.salesforce.com" )}.must_raise SalesforceAPI::ErrorReceivedException
+
+    end
+  end
+
+  describe "supplying configuration values" do
+
+    before do
+      SalesforceAPI::Caller.any_instance.stubs(:authorize)
+    end
+
+    it "uses environment variables if no options are supplied" do
+      ENV["SALESFORCE_API_VERSION"] = "version" 
+      ENV["SALESFORCE_USERNAME"] = "username"
+      ENV["SALESFORCE_PASSWORD"] = "password"
+      ENV["SALESFORCE_CLIENT_ID"] = "client_id"
+      ENV["SALESFORCE_CLIENT_SECRET"] = "client_secret"
+      ENV["SALESFORCE_HOST"] = "host"
+
+      caller = SalesforceAPI::Caller.new
+      caller.api_version.must_equal "version"
+      caller.username.must_equal "username"
+      caller.password.must_equal "password"
+      caller.client_id.must_equal "client_id"
+      caller.client_secret.must_equal "client_secret"
+      caller.host.must_equal "host"
+    end
+
+    it "uses options over environment variables if they are supplied" do
+      caller = SalesforceAPI::Caller.new({
+        api_version: "opt_version",
+        username: "opt_username",
+        password: "opt_password",
+        client_id: "opt_client_id", 
+        client_secret: "opt_client_secret",
+        host: "opt_host"
+      })
+      caller.api_version.must_equal "opt_version"
+      caller.username.must_equal "opt_username"
+      caller.password.must_equal "opt_password"
+      caller.client_id.must_equal "opt_client_id"
+      caller.client_secret.must_equal "opt_client_secret"
+      caller.host.must_equal "opt_host"
+    end
+
+    describe "#http_get" do
+      it "should try and authorize if we receive a HTTPUnauthorized response" do
+        caller = SalesforceAPI::Caller.new
+        mock_response = mock()
+        mock_response.expects(:instance_of?).twice.with(Net::HTTPUnauthorized).returns(true,false)
+        Net::HTTP.any_instance.stubs(:start).returns(mock_response)
+        caller.expects(:authorize)
+        uri = URI("https://www.fake.com")
+        response = caller.http_get(uri)
+        response.must_equal mock_response
+      end
+
+      it "won't try and authorize if we explicitly tell it not too" do
+        caller = SalesforceAPI::Caller.new
+        mock_response = stub(:instance_of? => true)
+        Net::HTTP.any_instance.stubs(:start).returns(mock_response)
+        caller.expects(:authorize).never
+        uri = URI("https://www.fake.com")
+        response = caller.http_get(uri,false)
+        response.must_equal mock_response
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: sf-username-password-authentication-and-rest-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Vallance
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &19944440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19944440
+description: Easy to use Salesforce REST API caller, using the Username-Password OAuth
+  Authentication Flow.
+email:
+- ! 'dvallance@infotech.com
+
+'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/salesforce-api.rb
+- lib/salesforce-api/caller.rb
+- lib/salesforce-api/version.rb
+- sf-username-password-authentication-and-rest-api.gemspec
+- test/test_helper.rb
+- test/test_salesforce_api.rb
+homepage: https://github.com/dvallance/sf-username-password-authentication-and-rest-api
+licenses: []
+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.10
+signing_key: 
+specification_version: 3
+summary: See the homepage for details.
+test_files:
+- test/test_helper.rb
+- test/test_salesforce_api.rb