salesforce_fsdb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9202234becb758cb247e79a0c299c33718f3cb5
+  data.tar.gz: 5e2049d2b4f535dc1841128c479040678e809466
+SHA512:
+  metadata.gz: a570ecbd949fb17204ea58681c5a4bb7100bbfc3113f40d46e7dd20bed05fde7e5d8640916e5661bc05e41e9d2077656783b7f37b5681c9a5ee274964f79d5c4
+  data.tar.gz: a5df11edcd11aa61c5dfa4965be04dbe69a3db18c9be6cdb48b923dba1dbba844b22269f899d62fe8c84c2158a07e53f63acb5d94b327b9ec895dae6038ae3e1

data/CHANGELOG

@@ -0,0 +1,3 @@
+= 0.0.1
+- Initial release
+- Filesystem cache of Account, Contact, Opportunity and User sObjects.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 John Wang
+ 
+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.rdoc

@@ -0,0 +1,68 @@
+= SalesforceFsdb
+
+Salesforce SObject system to retrieve and cache SObjects.
+
+== Installation
+
+=== Gem Installation
+
+Download and install salesforce_fsdb with the following:
+
+  gem install salesforce_fsdb
+
+== Usage
+
+  require 'salesforce_fsdb/client'
+
+  paramsGeneral    =  {
+    :api_fqdn      => 'na1.salesforce.com',
+    :api_version   => '29.0',
+    :data_dir      => '/path/to/sf_data',
+    :max_age       => 60*60*24*7
+  }
+
+  paramsToken      =  {
+    :grant_type    => 'password',
+    :client_id     => 'my_client_id',
+    :client_secret => 'my_client_secret',
+    :username      => 'my_username',
+    :password      => 'my_password'
+  }
+
+  # using the filesystem cache with max_age
+  sfFsdbClient = SalesforceFsdb::Client.new(paramsGeneral,paramsToken)
+  sObjectHash  = sfFsdbClient.getSobjectForSfidAndType('my_sobject_id','Account')
+
+  # without using a filesystem cache
+  sfRestClient = SalesforceFsdb::RestClient.new(paramsGeneral,paramsToken)
+  sObjectHash  = sfRestClient.getSobjectForSfidAndType('my_sobject_id','Account')
+
+== Notes
+
+=== Object Size
+
+Some large Salesforce Objects may generate Salesforce errors. A future release will allow specifying specific fields for retrieval.
+
+== Links
+
+Salesforce REST API Reference
+
+http://www.salesforce.com/us/developer/docs/api_rest/
+
+== Problems, Comments, Suggestions?
+
+All of the above are most welcome. mailto:johncwang@gmail.com
+
+== Credits
+
+John Wang - http://johnwang.com
+
+== License
+
+SalesforceFsdb is available under an MIT-style license.
+
+:include: MIT-LICENSE 
+
+== Warranty
+
+This software is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantibility and fitness for a particular purpose.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the Base58GMP library.'
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = false
+end
+
+desc 'Generate RDoc documentation.'
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'salesforce_fsdb'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/salesforce_fsdb/client.rb

@@ -0,0 +1,73 @@
+require 'fileutils'
+require 'json'
+require 'salesforce_fsdb/rest_client'
+
+module SalesforceFsdb
+  class Client
+    attr_accessor :oSfRestClient
+    def initialize(dParamsGeneral={},dParamsToken={})
+      @oSfRestClient  = SalesforceFsdb::RestClient.new(dParamsGeneral,dParamsToken)
+      @sFsdbBaseDir   = dParamsGeneral[:data_dir] || '.'
+      @iMaxAgeSec     = dParamsGeneral[:max_age]  || 3600*24*7
+      @dType3ToType   = {
+        'Account'     => 'act',
+        'Contact'     => 'con',
+        'Opportunity' => 'opp',
+        'User'        => 'usr'
+      }
+    end
+    def getFileForSfidAndType(sSfid=nil,sType3=nil)
+      sType3 = @dType3ToType[sType3] || sType3
+      sFile  = %Q{sf_#{sType3}_#{sSfid}.json}
+      return sFile
+    end
+    def getDirForType(sType3=nil)
+      sType3 = @dType3ToType[sType3] || sType3
+      sDir   = File.join(@sFsdbBaseDir,sType3)
+      return sDir
+    end
+    def getPathForSfidAndType(sSfid=nil,sType3=nil)
+      sType3 = @dType3ToType[sType3] || sType3
+      sPath  = File.join( self.getDirForType(sType3), self.getFileForSfidAndType(sSfid,sType3))
+      return sPath
+    end
+    def getSobjectForSfidAndType(sSfid=nil,sType3=nil)
+      sType3    = @dType3ToType[sType3] || sType3
+      sPath     = self.getPathForSfidAndType(sSfid,sType3)
+      dObj      = { :meta => { :iEpochRetrieved => -1, :iStatus => 404 } }
+      iEpochNow = Time.now.to_i
+      if File.exists?(sPath)
+        jTop    = File.open(sPath,'r').read
+        dTop    = JSON.parse(jTop,:symbolize_names=>true)
+        if dTop.has_key?(:source) && dTop.has_key?(:meta) && dObj[:meta].has_key?(:iEpochRetrieved)
+          iEpochRetrieved = dObj[:meta][:iEpochRetrieved]
+          iEpochNow       = Time.now.to_i
+          iAgeSec         = iEpochNow - iEpochRetrieved
+          if iAgeSec < @iMaxAgeSec && dTop[:source].has_key?(:Id)
+            dObj = dTop[:source]
+            return dObj
+          end
+        end
+      end
+      return self.getSobjectForSfidAndTypeFromRemote(sSfid,sType3)
+    end
+    def getSobjectForSfidAndTypeFromRemote(sSfid=nil,sType3=nil)
+      dObj = @oSfRestClient.getSobjectForSfidAndType(sSfid,sType3)
+      if dObj.has_key?(:Id)
+        sDir        = self.getDirForType(sType3)
+        sPath       = self.getPathForSfidAndType(sSfid,sType3)
+        FileUtils.mkdir_p(sDir) if ! Dir.exists?(sDir)
+        File.open(sPath,'w') do |fTop|
+          dTop      =  {
+            :meta   => { :iEpochRetrieved => Time.now.to_i, :iStatus => 200 },
+            :source => dObj
+          }
+          jTop = JSON.dump(dTop)
+          fTop.puts(jTop)
+        end
+        return dObj
+      end
+      return {}
+    end
+  end
+end

data/lib/salesforce_fsdb/rest_client.rb

@@ -0,0 +1,62 @@
+require 'faraday'
+require 'json'
+
+module SalesforceFsdb
+  class RestClient
+    attr_accessor :sSfTokenUrl
+    attr_accessor :dTokenRes
+    def initialize(dParamsGeneral={},dParamsToken={})
+      @dParamsToken = dParamsToken
+      @sSfTokenUrl  = dParamsGeneral.has_key?(:token_url)   ? dParamsGeneral[:token_url] \
+                    : 'https://login.salesforce.com/services/oauth2/token'
+      @sApiFqdn     = dParamsGeneral.has_key?(:api_fqdn)    ? dParamsGeneral[:api_fqdn] : 'na5.salesforce.com'
+      @sApiVersion  = dParamsGeneral.has_key?(:api_version) ? dParamsGeneral[:api_version] : '27.0'
+      @dTokenRes    = {}
+      @dType3ToType = {
+        'act' => 'Account',
+        'con' => 'Contact',
+        'opp' => 'Opportunity',
+        'usr' => 'User'
+      }
+      self.loadToken()
+    end
+    def loadToken()
+      oRes       = Faraday.post(@sSfTokenUrl,@dParamsToken) 
+      @dTokenRes = JSON.parse(oRes.body,:symbolize_names=>true)
+      return self
+    end
+    def getAttr(yKey=nil)
+      yKey  = yKey.to_sym if yKey.is_a?(String)
+      xxVal = @dTokenRes.has_key?(yKey) ? @dTokenRes[yKey] : nil
+      return xxVal
+    end
+    def getHeaders()
+      dHeaders = { 'Authorization' => 'Bearer ' + self.getAttr(:access_token) }
+      return dHeaders
+    end
+    def getSoqlResults(sSoql=nil)
+      dQry = { :q => sSoql}
+      sUrl = "https://#{@sApiFqdn}/services/data/v#{@sApiVersion}/query"
+      oRes = Faraday.get(sUrl,dQry)
+      dRes = JSON.parse(oRes.body,:symbolize_names=>true)
+      return dRes
+    end
+    def getNormalizedType(sType=nil)
+      #sType = @dType3ToType[sType] if @dType3ToType.has_key?(sType)
+      sType = @dType3ToType[sType] || sType
+      return sType  
+    end
+    def getSfUrlForSfidAndType(sSfid=nil,sType=nil)
+      sType = self.getNormalizedType(sType)
+      sUrl  = "https://#{@sApiFqdn}/services/data/v#{@sApiVersion}/sobjects/#{sType}/#{sSfid}/"
+      return sUrl
+    end
+    def getSobjectForSfidAndType(sSfid=nil,sType=nil)
+      sUrl  = self.getSfUrlForSfidAndType(sSfid,sType)
+      sHead = self.getHeaders()
+      oRes  = Faraday.get(sUrl,{},sHead)
+      dRes  = JSON.parse(oRes.body,:symbolize_names=>true)
+      return dRes
+    end
+  end
+end

data/salesforce_fsdb.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name        = 'salesforce_fsdb'
+  s.version     = '0.0.1'
+  s.date        = '2014-01-27'
+  s.summary     = 'Salesforce Filesystem DB'
+  s.description = 'Filesystem cache manager for Salesforce sObjects'
+  s.authors     = ['John Wang']
+  s.email       = 'johncwang@gmail.com'
+  s.files       = [
+    'CHANGELOG',
+    'MIT-LICENSE',
+    'README.rdoc',
+    'Rakefile',
+    'VERSION',
+    'salesforce_fsdb.gemspec',
+    'lib/salesforce_fsdb/client.rb',
+    'lib/salesforce_fsdb/rest_client.rb',
+    'test/test_setup.rb'
+  ]
+  s.homepage    = 'http://johnwang.com/'
+  s.license     = 'MIT'
+end

data/test/test_setup.rb

@@ -0,0 +1,29 @@
+require 'test/unit'
+require 'salesforce_fsdb/client'
+
+class SalesforceFsdbTest < Test::Unit::TestCase
+  def testSetup
+    paramsGeneral    =  {
+      :api_fqdn      => 'na1.salesforce.com',
+      :api_version   => '29.0',
+      :data_dir      => '/path/to/sf_data',
+      :max_age       => 60*60*24*7
+    }
+
+    paramsToken      =  {
+      :grant_type    => 'password',
+      :client_id     => 'my_client_id',
+      :client_secret => 'my_client_secret',
+      :username      => 'my_username',
+      :password      => 'my_password'
+    }
+
+    sfFsdbClient = SalesforceFsdb::Client.new(paramsGeneral,paramsToken)
+    accountDir   = sfFsdbClient.getDirForType('Account')
+
+    assert_equal accountDir, File.join(paramsGeneral[:data_dir],'act')
+
+    tokenUrl     = 'https://login.salesforce.com/services/oauth2/token'
+    assert_equal tokenUrl, sfFsdbClient.oSfRestClient.sSfTokenUrl
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: salesforce_fsdb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-27 00:00:00.000000000 Z
+dependencies: []
+description: Filesystem cache manager for Salesforce sObjects
+email: johncwang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/salesforce_fsdb/client.rb
+- lib/salesforce_fsdb/rest_client.rb
+- salesforce_fsdb.gemspec
+- test/test_setup.rb
+homepage: http://johnwang.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Salesforce Filesystem DB
+test_files: []