gd_salesforce 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+my-bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in salesforce.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,47 @@
+This is a wrapper for couple of things I usually do with SF
+===========================================================
+
+Installation
+------------
+
+Prerequisite is having git, ruby and gems installed (also you should have XCode installed since there probably will be need to compile some C code in the background).
+
+    gem install bundler
+    git clone git://github.com/fluke777/salesforce.git
+    cd salesforce
+    bundle install
+    rake install
+
+
+Grabbing fields of a module
+---------------------------
+Since Force.com explorer cannot search in fields and I love my text editor too much. I created a command how to download the list of fields
+
+    require 'rubygems'
+    require 'salesforce'
+    
+    client = Salesforce::Client.new('login', 'pass+token')
+    fields = client.fields('Account')
+  
+    # if you are looking for a specific one
+    fields.grep /Customer/i
+  
+    # if you did not want a api name you can do whatever you want with describe. For example here I am grabbing label
+    response = client.describe('Account')
+    response[:describeSObjectResponse][:result][:fields].map {|field| field[:label]}
+
+Downloading data
+----------------
+You can grab easily some data. Paging is implemented so it will download all the data.
+
+    # grabbing into array (this should probably be the default and it should return the field rather than pasing a reference inside)
+    x = []
+    client.grab :module => "User", :output => x, :fields => 'Id, Name'
+    x.count
+    
+    # storing it into a file as CSV is easy as well
+    require 'fastercsv'
+    
+    FasterCSV.open('my-csv.csv', 'w') do |csv|
+        client.grab :module => "User", :output => csv, :fields => 'Id, Name'
+    end

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/salesforce/version.rb

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

data/lib/salesforce.rb

@@ -0,0 +1,174 @@
+require 'salesforce/version'
+require 'rforce'
+require 'fastercsv'
+require 'active_support/time'
+require 'pry'
+
+module Salesforce
+
+  class Client
+
+    attr_accessor :rforce_binding
+
+    def initialize(login, pass, options = {})
+      server = options[:server] || "www.salesforce.com"
+      url = options[:url] || "https://#{server}/services/Soap/u/26.0"
+      @rforce_binding = RForce::Binding.new url
+      @rforce_binding.login login, pass
+    end
+
+    def describe(mod)
+      @rforce_binding.describeSObject(:sObject => mod)
+    end
+
+    def modules
+      g = @rforce_binding.describeGlobal
+      modules = g[:describeGlobalResponse][:result][:sobjects]
+    end
+
+    def fields(mod)
+      result = @rforce_binding.describeSObject(:sObject => mod)
+      if result.has_key?(:Fault)
+        fail result
+      end
+      fields = result[:describeSObjectResponse][:result][:fields]
+      fields.map {|f| f[:name]}
+    end
+
+    def grab(options)
+      sf_module = options[:module] || fail("Specify SFDC module")
+      fields = options[:fields]
+      rforce_binding = @rforce_binding
+      output = options[:output]
+
+      if fields == :all
+        fields = fields(sf_module)
+      elsif fields.kind_of? String
+        fields = fields.split(',')
+        fields = fields.map {|f| f.strip}
+      end
+
+      values = fields.map {|v| v.to_sym}
+
+      query = "SELECT #{values.join(', ')} from #{sf_module}"
+      query(query, options.merge(:values => values))
+    end
+
+    def query(query, options)
+      values = options[:values]
+      as_hash = options[:as_hash]
+      counter = 1
+      fail "If you want to return array you need to specify fields in values key" if !as_hash && values.nil?
+      
+      rforce_binding = @rforce_binding
+      output = options[:output]
+      begin
+        answer = rforce_binding.query({:queryString => query, :batchSize => 2000})
+      rescue Timeout::Error => e
+        puts "Timeout occured retrying"
+        retry
+      end
+
+      if answer[:queryResponse].nil? || answer[:queryResponse][:result].nil?
+        fail answer[:Fault][:faultstring] if answer[:Fault] && answer[:Fault][:faultstring]
+        fail "An unknown error occured while querying salesforce."
+      end
+      
+      answer[:queryResponse][:result][:records].each {|row| output << (as_hash ? row : row.values_at(*values))} if answer[:queryResponse][:result][:size].to_i > 0
+
+      more_locator = answer[:queryResponse][:result][:queryLocator]
+
+      while more_locator do
+        answer_more = rforce_binding.queryMore({:queryLocator => more_locator, :batchSize => 2000})
+        answer_more[:queryMoreResponse][:result][:records].each do |row|
+          output << (as_hash ? row : row.values_at(*values))
+        end
+        more_locator = answer_more[:queryMoreResponse][:result][:queryLocator]
+      end
+    end
+
+    def get_deleted(options={})
+      rforce_binding = @rforce_binding
+      sf_module = options[:module]
+      end_time   = options[:end_time] || Time.now
+      start_time = options[:start_time] || end_time.advance(:days => -15)
+      fail "The specified start_time cannot be the same value as, or later than, the specified end_time value" unless end_time > start_time
+      puts "Downloading from #{start_time} to #{end_time}"
+      answer = rforce_binding.getDeleted([:sObjectType, sf_module, :startDate, start_time.utc.iso8601, :endDate, end_time.utc.iso8601])
+    end
+
+    def download_deleted(options={})
+      output_file = options[:output_file]
+      fail "Output file not specified" if output_file.nil?
+
+      answer = get_deleted(options)
+      if answer[:getDeletedResponse].nil?
+        fail answer[:Fault][:faultstring] if answer[:Fault] && answer[:Fault][:faultstring]
+        fail "An unknown error occured during deleted records extraction."
+      end
+
+      result = answer[:getDeletedResponse][:result]
+      FasterCSV.open(output_file,"w") do |csv|
+        csv << ["Timestamp", "Id", "IsDeleted"]
+        unless result[:deletedRecords].nil? then
+          result[:deletedRecords].each do |record|
+            timestamp = Time.parse(record[:deletedDate]).to_i
+            csv << [timestamp, record[:id], "true"]
+          end
+        end
+      end
+
+      return result[:earliestDateAvailable], result[:latestDateCovered]
+    end
+
+    def download_updated(options={})
+      module_name = options[:module]
+      end_time   = options[:end_time] || Time.now
+      start_time = options[:start_time] || end_time.advance(:days => -1)
+      fields_list = options[:fields] || []
+      puts "Downloading #{module_name} from #{start_time} to #{end_time}"
+      update_answer = rforce_binding.getUpdated([:sObjectType, module_name, :startDate, start_time.utc.iso8601, :endDate, end_time.utc.iso8601])
+      results = update_answer[:getUpdatedResponse][:result][:ids]
+      if results.nil?
+        puts "#{module_name} is empty"
+        FasterCSV.open(options[:output_file], 'w') do |csv|
+          csv << fields_list
+        end
+        return update_answer[:getUpdatedResponse][:result][:latestDateCovered]
+      end
+      puts "Found and downloaded #{results.size} records"
+      fields_list = fields_list.map {|x| x.strip.to_sym}
+
+      converters = {
+        "datetime"  => lambda {|f| Time.parse(f).utc.to_i rescue f},
+        "string"    => lambda {|f| f[0..128] rescue f},
+        "textarea"  => lambda {|f| f[0..128] rescue f},
+        "date"      => lambda {|f| Time.parse(f).utc.to_i + (12 * 3600) rescue f},
+      }
+
+      answer = describe(module_name)
+      fields_description = answer[:describeSObjectResponse][:result][:fields]
+      my_fields_description = fields_list.map {|f| fields_description.detect {|fl| fl[:name].to_sym == f}}
+
+      my_converters = my_fields_description.map {|fd| converters[fd[:type]]}
+      FasterCSV.open(options[:output_file], 'w') do |csv|
+        csv << ['Timestamp'] + fields_list
+        results.each_slice(2000) do |slice|
+          ids = slice.reduce([]) do |memo, item|
+            memo.concat [:ID, item]
+          end
+          result = rforce_binding.retrieve([:fieldList, fields_list.join(', '), :sObjectType, module_name].concat(ids) )
+          result[:retrieveResponse][:result].each do |line|
+
+            values = line.values_at(*fields_list).zip(my_converters).map do |value, converter|
+             converter.nil? ? value : converter.call(value)
+           end
+           csv << [Time.parse(update_answer[:getUpdatedResponse][:result][:latestDateCovered]).utc.to_i] + values
+          end
+        end
+      end
+      update_answer[:getUpdatedResponse][:result][:latestDateCovered]
+    end
+
+  end
+end

data/salesforce.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "salesforce/version"
+
+Gem::Specification.new do |s|
+  s.name        = "gd_salesforce"
+  s.version     = Salesforce::VERSION
+  s.authors     = ["Tomas Svarovsky"]
+  s.email       = ["svarovsky.tomas@gmail.com"]
+  s.homepage    = "https://github.com/fluke777/salesforce"
+  s.summary     = %q{Small gem that wraps common tasks that I do with Salesforce}
+  s.description = %q{Small gem that wraps common tasks that I do with Salesforce}
+
+  s.rubyforge_project = "salesforce"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "rforce"
+  s.add_runtime_dependency "fastercsv"
+  s.add_runtime_dependency "activesupport"
+  s.add_runtime_dependency "pry"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: gd_salesforce
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tomas Svarovsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rforce
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastercsv
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Small gem that wraps common tasks that I do with Salesforce
+email:
+- svarovsky.tomas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/salesforce.rb
+- lib/salesforce/version.rb
+- salesforce.gemspec
+homepage: https://github.com/fluke777/salesforce
+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: salesforce
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Small gem that wraps common tasks that I do with Salesforce
+test_files: []