tla-sbuilder-salesforce 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d4d256a494f4333b3530162ee02b5a4c4452c86
+  data.tar.gz: b6461ca51c77841d44724decec1a824b47b1e02a
+SHA512:
+  metadata.gz: 1115fedbc63c901b4ca17639ef527ef59af7e63b13a6fb28149fac949d9b7327336a7d3757d4d86b066a515bee90c56ad7a2594d040611ca30c4ce0429876fd5
+  data.tar.gz: bbba7d806ce6a025b1b65edc8aa492ce05d39c97494bed8a3782d459b8002fe7cb61c13875b0a38b2e4e88ac9fa9074d77aaa9a43399380a517d7e3f2adb4757

data/README.md

@@ -0,0 +1,122 @@
+<link href="../site.css" rel="stylesheet"></link>
+[Up](../index.php) [Readme](README.html) [Releases](RELEASES.html) [Todo](TODO.html)
+
+
+# tla-sbuilder-salesforce - Salesforce API interface loader (for tla-sbuilder) - $Release:0.0.1$
+
+API loader plugin for
+[Sbuilder](https://github.com/jarjuk/tla-sbuilder) to load Salasforce
+API interfaces in a Sbuilder specification model.
+
+## <a id="USAGE">Usage</a>
+
+### Create Gemfile
+
+Create `Gemfile` with the following content
+
+```
+source "https://rubygems.org"
+gem 'tla-sbuilder-salesforce'
+```
+
+and run
+
+	bundle install
+
+### Include Plugin to Sbuilder
+
+To include the plugin into Sbuilder add an entry to `extend.loaders`
+array in `sbuilder.yaml` -configuration file as shown below:
+
+    extend:
+          loaders:
+              - gem: tla-sbuilder-salesforce
+                className: Sbuilder::Interfaces::Salesforce::SalesforceLoader
+                configuration:
+                      client_id: xxxxxxxxxxxxxxx
+                      client_secret: xxxxxxxxxx
+                      username: xxxxxxxe
+                      password: 'xxxxxxxx'
+                      security_token:  'xxxxxxxxxx'
+                    
+In the entry, modify following properties to match your environment:
+
+* `cliend_id`: salesforce client_id to use in connection
+* `client_secret` : salesforce client_secret to use in connection
+* `username`: username to login to salesforce
+* `password`: password to login to salesforce
+* `security_token`: additional security_token needed in salesforce login
+
+Additional confiuration properties supported:
+
+* `api_version`: api version to use (default 34.0)
+
+
+### Configure API Loader Instanace
+
+Add an array entry `interfaces` section in `sbuilder.yaml`
+-configuration file referring to an interface configuration file for
+the plugin:
+
+    interfaces:
+
+        - className: Sbuilder::Interfaces::Salesforce::SalesforceLoader
+          infrastructureServices: true
+          file: salesforce-api.yaml
+          cache: sf
+
+
+In the configuration above:
+
+* `className`: `Sbuilder::Interfaces::Salesforce::SalesforceLoader`
+  matches `className` property in `extend.loaders` section
+
+* `infrastructureServices`: value `true` when embedding Salesforce
+   services as part of composite service, value `false`, when
+   Salesforce services be called directly in the generated
+   specification model
+
+* `file`: name of configuration file in `cnf` -directory defining
+  Salesforce API (see below)
+	 
+* `cache`: optional cache file name prefix for the API loader to cache
+  Salesforce API descriptions
+
+## Define Salaseforce API
+
+Saleforce API Loader plugin uses a configuration file to define API
+operation on Salesforce sObjects. The configuration file is an array
+of entries with the following properties:
+
+* `sObject`: Salesforce sObject for the API operation
+* `path`: REST entrypoint for the interface
+* `action`: REST action (put, get, post, ..)
+* `request`: name of request attribute holding sObject
+* `reply`: name of reponse attribute holding replyt sObject
+
+
+For example, to access Salasesforce sObjects `Lead` and `Account` use
+configuration:
+
+      - sObject: Account
+        path: /sf/account
+        action: get
+        request: account
+        reply: account
+        
+      - sObject: Lead
+        path: /sf/lead
+        action: post
+        request: account
+        reply: account
+        
+      - sObject: Lead
+        path: /sf/lead        
+        action: put
+        request: account
+        reply: account
+        
+## License 
+
+MIT
+

data/VERSION

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

data/lib/sbuilder/config.rb

@@ -0,0 +1,70 @@
+require 'logger'
+
+module Sbuilder
+
+  module Interfaces
+
+    module Salesforce
+      
+      class Config
+        class << self
+
+          
+          # @return [Confugration] current configuration
+          def configuration
+            @configuration ||= Configuration.new
+          end
+
+          # yields configuration
+          def configure
+            yield configuration
+          end
+        end # static Config
+
+        # Configs for salesforce
+        class Configuration
+
+          extend ExtendAccessors
+
+          # [String] salesforce client_secret to use in connection
+          attr_accessor :client_secret      
+
+          # [String] salesforce client_id to use in connection
+          attr_accessor :client_id          
+
+
+          # [String] username to login to salesforce
+          attr_accessor :username
+
+          # [String] password to login to salesforce
+          attr_accessor :password
+          
+          # [String] additional security_token needed in salesforce login
+          attr_accessor :security_token
+
+          # default api version to use
+          attr_accessor_with_default :api_version, "34.0"
+
+          # [Proc] returining logger
+          attr_accessor_with_default :logger, lambda  { |progname|
+            l = ::Logger.new( STDOUT )
+            l.level = ::Logger::ERROR
+            l
+          }
+          
+          # attr_accessor_with_default :log_level, ::Logger::ERROR
+          
+          # # attr_accessor_with_default :log_level, ::Logger::DEBUG
+          # attr_accessor_with_default :logfile, "sbuilder-sf.log"
+          
+          # attr_accessor_with_default :home, lambda { ENV['HOME']  }
+          
+          attr_accessor_with_default :app, "sf-loader"
+
+        end
+        
+      end # class Config
+      
+    end # module Salesforce
+  end # module Interfaces
+end # module Sbuilder

data/lib/sbuilder/extend.rb

@@ -0,0 +1,29 @@
+# http://4thmouse.com/index.php/2011/01/31/attr_accessor-with-default-in-ruby/
+
+# use lamdba (and not block) to set default values
+
+          # attr_accessor_with_default :log_level, :debug
+          # attr_accessor_with_default :home, lambda { ENV['HOME']  }
+
+
+module ExtendAccessors
+  def attr_accessor_with_default name, *default, &block
+    if( default.size != 1)
+      raise "Must either provide a default value or a default code block"
+    end
+    if ! default[0].respond_to?( :call )
+      define_method name.to_sym do
+        instance_variable_set("@#{name}", default[0]) unless instance_variable_defined?("@#{name}")
+        instance_variable_get("@#{name}")
+      end
+    else
+      define_method name.to_sym do
+        instance_variable_set("@#{name}", default[0] ) unless instance_variable_defined?("@#{name}")
+        instance_variable_get("@#{name}")
+      end
+    end
+    define_method "#{name}=".to_sym do |value|
+      instance_variable_set("@#{name}",value)
+    end
+  end
+end

data/lib/sbuilder/logger.rb

@@ -0,0 +1,39 @@
+require 'logger'
+
+module Sbuilder
+
+  module Interfaces
+
+    module Salesforce
+
+      module Logger
+
+        # class NullLoger < Logger
+        #   def initialize(*args)
+        #   end
+
+        #   def add(*args, &block)
+        #   end
+
+        #   def debug?
+        #     false
+        #   end
+        # end
+
+        @@logfile = nil                          # absolute path to log file
+
+        def logger( options={} )
+          return @logger if @logger
+          # logger name format 'app:class-name'
+          progname = Config.configuration.app + ':' + self.class.name.split('::').last
+          # create logger - using default lamba or lambda set in SalesforceLoader#setFacade
+          @logger = Config.configuration.logger.call( progname )
+          @logger
+        end
+         
+        
+      end # module logger
+
+    end
+  end
+end

data/lib/sbuilder/reader.rb

@@ -0,0 +1,83 @@
+# loader.rb
+
+require 'restforce'
+require 'yaml'
+
+module Sbuilder
+
+  module Interfaces
+
+    module Salesforce
+      
+      class Reader
+
+        # [Hash:SObjectName->Describe]
+        attr_reader   :describes
+
+        # mix logge
+        include Sbuilder::Interfaces::Salesforce::Logger
+
+        
+        # ------------------------------------------------------------------
+        # constructore
+        
+        def initialize( options={} )
+          @describes = {}
+          # init logger
+          logger(options).info "initialized"
+        end
+        
+        # ------------------------------------------------------------------
+        # Restforce api authentication
+
+        # Create connection object to sales force
+        #
+        # @return [Restforce] client object
+        def connect( )
+          @client ||= Restforce.new :username => Config.configuration.username,
+                                 :password       => Config.configuration.password,
+                                 :security_token => Config.configuration.security_token, 
+                                 :client_id      => Config.configuration.client_id,
+                                 :client_secret  => Config.configuration.client_secret,
+                                 :api_version    => Config.configuration.api_version # "34.0"
+        end
+
+        
+        def client
+          connect
+        end
+
+        # ------------------------------------------------------------------
+        # cache api queries
+
+        # cache 'sObject' describes, use '&blk' to read if given
+        # (allow file cache)
+        def describe( sObject, &blk )
+          
+          logger.info "#{__method__}: sObject=#{sObject}" 
+
+          # object cache?
+          return describes[ sObject] unless describes[ sObject].nil?
+          logger.info "#{__method__}: not cached - sObject=#{sObject}"                       
+
+          # try file cachke if block_ive
+          if block_given?
+            logger.info "#{__method__}: block given, does yield have a cache for  sObject=#{sObject}"             
+            describes[ sObject] = yield( sObject )
+          end
+          if describes[sObject]
+            logger.info "#{__method__}: yield did return cached object=#{sObject}"                                             
+            return describes[ sObject]
+          end
+
+          # access salesforce
+          logger.info "#{__method__}: not cached - read start=#{sObject}"                                 
+          describes[ sObject] = client.describe( sObject )
+          logger.info "#{__method__}: not cached - read done=#{sObject}"                                           
+          return describes[ sObject]
+        end
+        
+      end
+    end
+  end
+end

data/lib/sbuilder/sales_force_loader.rb

@@ -0,0 +1,195 @@
+# loader.rb
+
+
+module Sbuilder
+
+  module Interfaces
+
+    module Salesforce
+      
+      class SalesforceLoader
+        
+        attr_reader   :facade               # [Sbuilder::ApiLoader]
+                                            # integration with sbuilder
+
+        attr_reader   :reader               # [Sbuilder::Interfaces::Salesforce::Reader]
+
+        # logger received from sbuilder facade
+        attr_reader   :logger
+
+        # ------------------------------------------------------------------
+        # constructore
+        
+        def initialize( options={} )
+          @reader = Sbuilder::Interfaces::Salesforce::Reader.new( options )
+          # init logger
+          # logger(options).info "initialized salesforce api"
+        end
+
+        # Configure sbuilder facade object implementing services, which
+        # allows loader to integrate with sbuilder
+        
+        def setFacade( facade )
+          @facade = facade
+          @logger = facade.createLogger( Config.configuration.app )
+          # create logger method replaced with facade version
+          Config.configuration.logger = lambda do |progname|
+            facade.createLogger( progname )
+          end
+        end
+
+        # ------------------------------------------------------------------
+        # class method to confiugre
+
+        # @param configuration [Hash] properties to configure
+        
+        def self.configure( configuration )
+          configuration.each do |k,v|
+            begin
+              Config.configuration.method( "#{k}=".to_sym ).call( v )
+            rescue NameError => e
+              msg = <<-EOS
+              #{e.message}
+              
+              in salesforce loader configuration #{configuration.to_yaml}
+              EOS
+              raise NameError, msg, e.backtrace
+            end
+          end
+        end
+        # ------------------------------------------------------------------
+        # Sbuilder intergration
+        # @param yamlFileUri [String] path or url to YAML file to process
+    
+        def load( yamlFileUri )
+          logger.info( "#{__method__} yamlFileUri=#{yamlFileUri}" )
+
+          # use facade services to read lines in 
+          yaml_lines = readLines( yamlFileUri )
+          
+          # YAML parse & schema validation
+          config_hash = YAML.load( yaml_lines )
+          
+          # and extract interfaces && definitions
+          doLoadDefinitions( config_hash )
+          doLoadInterfaces( config_hash )
+
+        end
+
+        # @param yamlFileUri [String] path or url to YAML file to process
+        private def readLines( yamlFileUri )
+          yaml_lines = facade.read_cached( yamlFileUri )
+          return yaml_lines
+        end
+
+        
+        # Iterate 'definitions': for each definition create
+        # 'newDefinition', for each field 'newParameter', add new
+        # definition to 'facadade'
+        
+        def doLoadDefinitions( config_hash )
+
+          # load unique 'sObjects' in operation defs
+          definitions = config_hash.map { |operationDef| operationDef['sObject']}.uniq
+          
+          definitions.each do |definition|
+            paramSet = facade.newDefinition( definition )
+            isArray = false
+            fields = fields( definition ).each do |field|
+              parameter = facade.newParameter( field[:name], isArray )
+              paramSet.addParameter( parameter )
+            end
+            facade.modelDefinition( paramSet )
+          end
+        end
+
+        # Iterate 'path': for each path create 'newInterface'
+        def doLoadInterfaces( config_hash )
+
+          operationDefs = config_hash
+          
+          operationDefs.each do |operationDef|
+
+            validateProperties( operationDef, ['action', 'sObject', 'request', 'reply', 'path' ] , [] )
+
+            # read salesforce [Hash:Array] of :path
+            valid_urls = read_urls( operationDef['sObject'] )
+
+            request = facade.newInterface( operationDef['path'], operationDef['action']  )
+            
+            input = facade.newParameterReference( operationDef['request'], operationDef['sObject'], false )
+            request.addParameter( input )
+
+            # add fully configured pojo to model
+            facade.modelInterface( request )
+          #     end # ops
+          #   end # urls
+
+          end
+        end
+
+        private
+
+        # @param sObject [String] name of sObject to read from salesforce
+        def read( sObject )
+          ret = facade.get_cached( sObject )
+          return YAML.load ret unless ret.nil?
+          
+          ret = reader.describe( sObject )
+          facade.cache_line( ret.to_yaml, sObject )
+          ret
+        end
+
+        # ------------------------------------------------------------------
+        # Fields in 'sObject'
+        #
+        # @param sObject [String] name of sObject from which fields
+        # are retrieved
+        #
+        # @return [Hash:Array] of :name, -properties in 'sObject'
+        def fields( sObject )
+          return nil unless o = read( sObject ) 
+          return nil unless o['fields']
+          o['fields'].map do |f|
+            {
+              :name => f['name']
+            }
+          end
+        end
+
+        # # Extract urls for sObject metadata
+        # #
+        # # @return [Hash:Array] with :name,:url -propertes
+        def read_urls( sObject )
+          return [] unless read( sObject ) && read( sObject )['urls']
+          read( sObject )['urls'].map do |name,url|
+            {
+              :name => name,
+              :url => url,
+            } 
+          end
+        end
+        
+        
+
+        # ------------------------------------------------------------------
+        # validate 'defintionHash' all 'required'/only 'allowed' props set
+        private def validateProperties( defintionHash, required, allowed=[] )
+
+          allowed = allowed + required
+
+          
+          missingProps = required - defintionHash.keys
+          raise LoaderException,  "Missing properties #{missingProps} in #{defintionHash} - required #{required}" if missingProps.any?
+
+          invalidProps = defintionHash.keys - allowed 
+          raise LoaderException,  "Unknown properties #{invalidProps} in #{defintionHash} - allowed #{allowed}" if invalidProps.any?
+
+        end
+        
+        
+      end # classs
+    end
+  end
+end
+

data/lib/tla-sbuilder-salesforce.rb

@@ -0,0 +1,8 @@
+
+require_relative 'sbuilder/logger'
+require_relative 'sbuilder/extend'
+require_relative 'sbuilder/config'
+require_relative 'sbuilder/reader'
+require_relative 'sbuilder/sales_force_loader'
+
+

data/tla-sbuilder-salesforce.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8; mode: ruby -*-
+
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+ 
+
+# http://guides.rubygems.org/make-your-own-gem/
+
+Gem::Specification.new do |s|
+
+  # version           = "0.0.1.pre"
+  version           = File.open( "VERSION", "r" ) { |f| f.read }.strip.gsub( "-SNAPSHOT", ".pre" )
+
+  s.name            = 'tla-sbuilder-salesforce'
+  s.version         = version
+  s.date            = Time.now.strftime( "%Y-%m-%d" )  #'2014-09-10'
+  s.summary         = "Sbuilder Salesforce API loader"
+  s.description     = <<EOF
+
+  Sbuilder Salasforce API loader interfaces with Salesforce Rest API,
+  extracts object definitions in Force.com platforms, and creates
+  interface operations and parameter definitions into Sbuilder.
+
+EOF
+  s.authors         = ["jarjuk"]
+  s.files           = ["README.md", "VERSION", "#{s.name}.gemspec" ] | Dir.glob("lib/**/*")  
+  s.require_paths   = [ "lib" ]
+  # s.executables     = [ "sbuilder.rb" ]
+  s.license         = 'MIT'
+
+  # s.homepage              = "https://github.com/jarjuk/tla-sbuilder"
+  
+  s.required_ruby_version = '~> 2'
+
+  s.add_runtime_dependency 'restforce', '~>2.1', ">=2.1.3"
+  s.add_runtime_dependency 'tla-sbuilder', '~>0.1', ">=0.1.1.pre"
+
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: tla-sbuilder-salesforce
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- jarjuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: restforce
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.3
+- !ruby/object:Gem::Dependency
+  name: tla-sbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1.pre
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1.pre
+description: |2+
+
+    Sbuilder Salasforce API loader interfaces with Salesforce Rest API,
+    extracts object definitions in Force.com platforms, and creates
+    interface operations and parameter definitions into Sbuilder.
+
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- VERSION
+- lib/sbuilder/config.rb
+- lib/sbuilder/extend.rb
+- lib/sbuilder/logger.rb
+- lib/sbuilder/reader.rb
+- lib/sbuilder/sales_force_loader.rb
+- lib/tla-sbuilder-salesforce.rb
+- tla-sbuilder-salesforce.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Sbuilder Salesforce API loader
+test_files: []
+has_rdoc: