salesforce_fsdb 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5800738a75803b32473b3cf8004f4132922692b0
+  data.tar.gz: 2bb44d97b73ec6c5d266ff908af62f3d6c7a53de
+SHA512:
+  metadata.gz: 3af6c597ceacb8b27a0c8896b0f374300442e9b4a8ff8bcca61d68b858d45f7054a7c302f6e5d5d2e49abbbb1139635922c403dda741c565beb9bea9804965af
+  data.tar.gz: f6d3d8dee9c54328bc014eb2a1537082af1d04f1edaacce6bdd3dc35fecc1c6c9b36fcdf2fa356970370c992d7bf7c71201febc0f60d9860626611a31828d05c

data/CHANGELOG

@@ -1,5 +1,8 @@
+= 0.0.3
+- Add SOQL result caching.
+
 = 0.0.2
-- Use SObject types in filenames
+- Use SObject types in filenames.
 
 = 0.0.1
 - Initial release

data/README.rdoc

@@ -1,6 +1,6 @@
 = SalesforceFsdb
 
-Salesforce SObject system to retrieve and cache SObjects.
+Salesforce SObject system to retrieve and cache queries from Salesforce.com including SObjects and SOQL results.
 
 == Installation
 
@@ -33,12 +33,28 @@ Download and install salesforce_fsdb with the following:
   sfFsdbClient = SalesforceFsdb::Client.new(paramsGeneral,paramsToken)
   sObjectHash  = sfFsdbClient.getSobjectForSfidAndType('my_sobject_id','Account')
 
+  sSfid = '1234567890'
+  sSoql = %{ SELECT Id,AccountId,Name,IsWon,StageName,CloseDate from Opportunity where AccountId='#{sSfid}' }
+  sPath = "AccountOpportunities/sf_act_#{sSfid}_opps.jff"
+
+  dResults = sfFsdbClient.getResForSoqlAndPath( sSoql, sPath )
+
   # without using a filesystem cache
   sfRestClient = SalesforceFsdb::RestClient.new(paramsGeneral,paramsToken)
   sObjectHash  = sfRestClient.getSobjectForSfidAndType('my_sobject_id','Account')
 
 == Notes
 
+=== Max Age
+
+The :max_age parameter is used to indicate the maximum age in seconds for cached data. If local data exceeds maximum age, a new copy of the data is retrieved from Salesforce.com. To ensure retrieval of a new copy, use :max_age=-1.
+
+=== Directory Paths
+
+Salesforce Sobjects are stored on the file system under File.join( paramsGeneral[:data_dir], Sobject_type ).
+
+SOQL results are stored in the path indicated. Sub-directories are created for SOQL paths. If a relative directory is provided, it is appended to the :data_dir. If an absolute directory is provided, it is used as an absolute directory in its entirety.
+
 === Object Size
 
 Some large Salesforce Objects may generate Salesforce errors. A future release will allow specifying specific fields for retrieval.

data/Rakefile

@@ -5,7 +5,7 @@ require 'rdoc/task'
 desc 'Default: run unit tests.'
 task :default => :test
 
-desc 'Test the Base58GMP library.'
+desc 'Test the SalesforceFsdb library.'
 Rake::TestTask.new do |t|
   t.libs << 'lib'
   t.pattern = 'test/**/test_*.rb'

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/salesforce_fsdb/client.rb

@@ -5,32 +5,84 @@ 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
     end
+
     def getFileForSfidAndType(sSfid=nil,sType=nil)
       sFile  = %Q{sf_#{sType}_#{sSfid}.json}
       return sFile
     end
+
     def getDirForType(sType=nil)
       sDir   = File.join(@sFsdbBaseDir,sType)
       return sDir
     end
+
     def getPathForSfidAndType(sSfid=nil,sType=nil)
       sPath  = File.join( self.getDirForType(sType), self.getFileForSfidAndType(sSfid,sType))
       return sPath
     end
+
+    def getResForSoqlAndPath(sSoql=nil,sPath=nil)
+      return nil if sSoql.nil?
+      if ! sPath.nil? && sPath !~ /^\s*\//
+        sPath.strip!
+        sPath = File.join(@sFsdbBaseDir,sPath)
+      end
+      dRes      = { :meta => { :iEpochRetrieved => -1, :iStatus => 404 } }
+      if !sPath.nil? && 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) && dTop[:meta].has_key?(:iEpochRetrieved)
+          iEpochRetrieved = dTop[:meta][:iEpochRetrieved]
+          iEpochNow       = Time.now.to_i
+          iAgeSec         = iEpochNow - iEpochRetrieved
+          if iAgeSec < @iMaxAgeSec && dTop[:source].has_key?(:done)
+            dRes = dTop[:source]
+            return dRes
+          end
+        end
+      end
+      return self.getResForSoqlAndPathFromRemote(sSoql,sPath)
+    end
+
+    def getResForSoqlAndPathFromRemote(sSoql=nil,sPath=nil)
+      return nil if sSoql.nil?
+      if ! sPath.nil? && sPath !~ /^\s*\//
+        sPath.strip!
+        sPath = File.join(@sFsdbBaseDir,sPath)
+      end
+      dRes = @oSfRestClient.getSoqlResults(sSoql)
+      if ! dRes.nil? && dRes.has_key?(:done) && dRes[:done] == true && ! sPath.nil?
+        if sPath =~ /^([\S]+)\/[^\/]+$/
+          sDir   = $1
+          FileUtils.mkdir_p(sDir) if ! Dir.exists?(sDir)
+        end
+        File.open(sPath,'w') do |fTop|
+          dTop      =  {
+            :meta   => { :iEpochRetrieved => Time.now.to_i, :iStatus => 200 },
+            :source => dRes
+          }
+          jTop = JSON.dump(dTop)
+          fTop.puts(jTop)
+        end
+        return dRes
+      end
+      return nil
+    end
+
     def getSobjectForSfidAndType(sSfid=nil,sType=nil)
       sPath     = self.getPathForSfidAndType(sSfid,sType)
       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]
+        if dTop.has_key?(:source) && dTop.has_key?(:meta) && dTop[:meta].has_key?(:iEpochRetrieved)
+          iEpochRetrieved = dTop[:meta][:iEpochRetrieved]
           iEpochNow       = Time.now.to_i
           iAgeSec         = iEpochNow - iEpochRetrieved
           if iAgeSec < @iMaxAgeSec && dTop[:source].has_key?(:Id)
@@ -41,6 +93,7 @@ module SalesforceFsdb
       end
       return self.getSobjectForSfidAndTypeFromRemote(sSfid,sType)
     end
+
     def getSobjectForSfidAndTypeFromRemote(sSfid=nil,sType=nil)
       dObj = @oSfRestClient.getSobjectForSfidAndType(sSfid,sType)
       if dObj.has_key?(:Id)
@@ -57,7 +110,8 @@ module SalesforceFsdb
         end
         return dObj
       end
-      return {}
+      return nil
     end
+
   end
 end

data/lib/salesforce_fsdb/rest_client.rb

@@ -3,8 +3,10 @@ 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] \
@@ -14,20 +16,24 @@ module SalesforceFsdb
       @dTokenRes    = {}
       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"
@@ -36,10 +42,12 @@ module SalesforceFsdb
       dRes  = JSON.parse(oRes.body,:symbolize_names=>true)
       return dRes
     end
+
     def getSfUrlForSfidAndType(sSfid=nil,sType=nil)
       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()
@@ -47,5 +55,6 @@ module SalesforceFsdb
       dRes  = JSON.parse(oRes.body,:symbolize_names=>true)
       return dRes
     end
+
   end
 end

data/salesforce_fsdb.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'salesforce_fsdb'
-  s.version     = '0.0.2'
-  s.date        = '2014-01-28'
+  s.version     = '0.0.3'
+  s.date        = '2014-02-06'
   s.summary     = 'Salesforce Filesystem DB'
   s.description = 'Filesystem cache manager for Salesforce sObjects'
   s.authors     = ['John Wang']
@@ -19,4 +19,4 @@ Gem::Specification.new do |s|
   ]
   s.homepage    = 'http://johnwang.com/'
   s.license     = 'MIT'
-end
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_fsdb
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-28 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies: []
 description: Filesystem cache manager for Salesforce sObjects
 email: johncwang@gmail.com
@@ -22,33 +21,32 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- salesforce_fsdb.gemspec
 - 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
-  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.23
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Salesforce Filesystem DB
 test_files: []