salesforklift 0.0.8

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "mocha", "0.9.10"
+  gem "rspec", "~> 2.0"
+  gem 'rdoc'
+end

data/README.md

@@ -0,0 +1,40 @@
+#salesforklift
+
+## A Salesforce Bulk API Ruby Wrapper
+
+Salesforce provides Bulk API to ease massive data synchronization from a data store to salesforce. This project provides a gem to use Salesforce Bulk API in a ruby app.
+
+## How to build salesforklift gem
+To build a gem, run ��gem build salesforklift.gemspec
+
+## How to use salesforklift gem
+
+```ruby
+require 'salesforklift'
+
+# login
+login = Salesforklift::Login.new
+result = login.login_sforce(TEST_USER_NAME, TEST_USER_PW, TEST_LOGIN_URL)    
+
+# create a job to bulk insert Contact objects    
+job = Salesforklift::Job.new(result.server_instance,
+                          result.session_id,
+                          "Contact",
+                          :insert)
+job.create
+puts job.sf_job_id
+
+# create batches
+batch = Salesforklift::Batch.new(result.server_instance, result.session_id, job.sf_job_id)
+batch.create_from_file("spec/data/contact.csv")
+
+# close job
+job.close
+
+# check result
+batch_response = batch.query_status
+
+```
+
+## Copyright
+See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rspec/core/rake_task'
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/unit/*_spec.rb" # exclude integration specs
+  # Put spec opts in a file named .rspec in root
+end
+
+desc "Run integration specs (make sure you have valid Salesforce login in spec_helper.rb)"
+RSpec::Core::RakeTask.new(:integration) do |t|
+  t.pattern = "./spec/integration/*_spec.rb" # run integration specs
+end
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Salesforklift'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/salesforklift.rb

@@ -0,0 +1,7 @@
+require "salesforklift/logging"
+require "salesforklift/login_response"
+require "salesforklift/job_response"
+require "salesforklift/batch_response"
+require "salesforklift/login"
+require "salesforklift/job"
+require "salesforklift/batch"

data/lib/salesforklift/batch.rb

@@ -0,0 +1,69 @@
+require 'restclient'
+
+module Salesforklift
+
+  class Batch
+    include Salesforklift::Logging
+
+    attr_accessor :server_instance, :session_id, :sf_job_id, :batch_id
+
+    def initialize(server_instance, session_id, sf_job_id)
+      @server_instance = server_instance
+      @session_id = session_id
+      @sf_job_id = sf_job_id
+    end
+
+    def create_from_file(data_file)
+      batch_content = ""
+      File.open(data_file, "r") do |infile|
+        while (line = infile.gets)
+          batch_content += line
+        end
+      end
+
+      logger.debug batch_content
+      create(batch_content)
+    end
+
+    def create(batch_content)
+      response = RestClient.post("https://#{@server_instance}.salesforce.com/services/async/21.0/job/#{@sf_job_id}/batch",
+                                 batch_content.lstrip,
+                                {"Content-Type" => "text/csv;charset=UTF-8", "X-SFDC-Session" => @session_id})
+      return false if (response.code/100 != 2)
+      response = BatchResponse.fromXML(response.body)
+      @batch_id = response.batch_id
+    end
+
+    def query_status
+      http = Net::HTTP.new("#{@server_instance}.salesforce.com", 443)
+      http.use_ssl = true
+
+      response = http.get("/services/async/21.0/job/#{@sf_job_id}/batch/#{@batch_id}",
+                          {"X-SFDC-Session" => @session_id})
+
+      return response.body if response.class != Net::HTTPOK
+
+      return BatchResponse.fromXML(response.body)
+    end
+
+    def query_result
+      http = Net::HTTP.new("#{@server_instance}.salesforce.com", 443)
+      http.use_ssl = true
+
+      response = http.get("/services/async/21.0/job/#{@sf_job_id}/batch/#{@batch_id}/result",
+                          {"X-SFDC-Session" => @session_id})
+      return response.body if response.class != Net::HTTPOK
+
+      result = Array.new
+      response.body.each_line do |line|
+        one_record = line.split(",")
+        result << {:id => one_record[0], :success => one_record[1],
+                   :created => one_record[2], :error => one_record[3]}
+      end
+
+      result.drop(1)  # drop header
+    end
+
+  end
+
+end

data/lib/salesforklift/batch_response.rb

@@ -0,0 +1,18 @@
+require 'rexml/document'
+
+module Salesforklift
+
+  class BatchResponse
+    attr_accessor :batch_id, :state
+
+    def self.fromXML(xml)
+      doc = REXML::Document.new(xml)
+
+      response = BatchResponse.new
+      response.batch_id = doc.elements['//id'].text
+      response.state = doc.elements['//state'].text
+      response
+    end
+  end
+
+end

data/lib/salesforklift/job.rb

@@ -0,0 +1,81 @@
+require 'net/http'
+require 'uri'
+
+module Salesforklift
+
+  class Job
+    include Salesforklift::Logging
+
+    attr_accessor :server_instance, :session_id, :sf_object, :sf_action,
+                  :sf_format, :sf_job_id, :external_id, :concurrency_mode
+
+    def initialize(server_instance, session_id, sf_object, sf_action,
+        external_id = nil, sf_format = :CSV, concurrency_mode = :Serial)
+      @server_instance = server_instance
+      @session_id = session_id
+      @sf_object = sf_object
+      @sf_action = sf_action
+      @sf_format = sf_format
+      @external_id = external_id
+      @concurrency_mode = concurrency_mode
+    end
+
+    def generate_create_request
+      request = <<-eos
+<?xml version="1.0" encoding="UTF-8"?>
+<jobInfo xmlns="http://www.force.com/2009/06/asyncapi/dataload">
+  <operation>#{@sf_action}</operation>
+  <object>#{@sf_object}</object>
+      eos
+
+      if @external_id
+        request += <<-eos
+  <externalIdFieldName>#{@external_id}</externalIdFieldName>
+        eos
+      end
+
+      request += <<-eos
+  <concurrencyMode>#{@concurrency_mode.to_s}</concurrencyMode>
+  <contentType>#{@sf_format.to_s}</contentType>
+</jobInfo>
+      eos
+    end
+
+    def generate_close_request
+      request = <<-eos
+<?xml version="1.0" encoding="UTF-8"?>
+<jobInfo xmlns="http://www.force.com/2009/06/asyncapi/dataload">
+  <state>Closed</state>
+</jobInfo>
+      eos
+    end
+
+    # Create a Salesforce Job
+    def create
+      http = Net::HTTP.new("#{@server_instance}.salesforce.com", 443)
+      http.use_ssl = true
+
+      job_request = generate_create_request.lstrip
+      logger.debug job_request
+      response = http.post('/services/async/21.0/job',
+                              job_request,
+                              {"Content-Type" => "application/xml;charset=UTF-8", "X-SFDC-Session" => @session_id})
+
+      return response.body if response.class != Net::HTTPCreated
+
+      job_response = JobResponse.fromXML(response.body)
+      @sf_job_id = job_response.job_id
+      job_response
+    end
+
+    def close
+      http = Net::HTTP.new("#{@server_instance}.salesforce.com", 443)
+      http.use_ssl = true
+
+      response = http.post("/services/async/21.0/job/#{@sf_job_id}",
+                            generate_close_request.lstrip,
+                            {"Content-Type" => "application/xml;charset=UTF-8", "X-SFDC-Session" => @session_id})
+      return response.class == Net::HTTPOK
+    end
+  end
+end

data/lib/salesforklift/job_response.rb

@@ -0,0 +1,17 @@
+require 'rexml/document'
+
+module Salesforklift
+
+  class JobResponse
+    attr_accessor :job_id
+
+    def self.fromXML(xml)
+      doc = REXML::Document.new(xml)
+
+      response = JobResponse.new
+      response.job_id = doc.elements['//id'].text
+      response
+    end
+
+  end
+end

data/lib/salesforklift/logging.rb

@@ -0,0 +1,17 @@
+require 'logger'
+
+module Salesforklift
+  module Logging
+
+    @@defalut_logger = Logger.new(STDOUT)
+    @@defalut_logger.level = Logger::INFO
+    
+    def logger
+      @logger ||= @@defalut_logger
+    end
+
+    def self.logger=(value)
+      @@defalut_logger = value
+    end
+  end
+end

data/lib/salesforklift/login.rb

@@ -0,0 +1,36 @@
+require 'net/http'
+require 'uri'
+
+module Salesforklift
+  class Login
+    include Salesforklift::Logging
+
+    def login_sforce(user, pass, url)
+      loginRequest = <<-eos
+        <?xml version="1.0" encoding="utf-8" ?>
+        <env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
+          <env:Body>
+            <n1:login xmlns:n1="urn:partner.soap.sforce.com">
+              <n1:username>#{user}</n1:username>
+              <n1:password>#{pass}</n1:password>
+            </n1:login>
+          </env:Body>
+        </env:Envelope>
+        eos
+
+      http = Net::HTTP.new(url, 443)
+      http.use_ssl = true
+
+      response = http.post('/services/Soap/u/21.0',
+                              loginRequest.lstrip,
+                              {"Content-Type" => "text/xml;charset=UTF-8", "SOAPAction" => "login"})
+      
+      return false if response.class != Net::HTTPOK
+
+      return LoginResponse.fromXML(response.body)
+    end
+    
+  end
+end

data/lib/salesforklift/login_response.rb

@@ -0,0 +1,23 @@
+require 'rexml/document'
+
+module Salesforklift
+
+  class LoginResponse
+
+    attr_accessor :server_instance, :session_id, :server_url
+
+    def self.fromXML(xml)
+      doc = REXML::Document.new(xml)
+
+      response = LoginResponse.new
+      response.server_url = doc.elements["//serverUrl"].text
+
+      if /(https:\/\/)(.+)(.salesforce.com)(.*)/.match(response.server_url)
+        response.server_instance = $2
+      end
+      response.session_id = doc.elements['//sessionId'].text
+      response
+    end
+  end
+
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: salesforklift
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.8
+platform: ruby
+authors: 
+- Max Mao
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-11-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Salesforce Bulk API ruby wrapper.
+email: jmao@brightcove.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/salesforklift/batch.rb
+- lib/salesforklift/batch_response.rb
+- lib/salesforklift/job.rb
+- lib/salesforklift/job_response.rb
+- lib/salesforklift/logging.rb
+- lib/salesforklift/login.rb
+- lib/salesforklift/login_response.rb
+- lib/salesforklift.rb
+- Rakefile
+- Gemfile
+- README.md
+homepage: 
+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.15
+signing_key: 
+specification_version: 3
+summary: Salesforce Bulk API ruby wrapper
+test_files: []
+