rhoconnect-adapters 1.0.0.beta1

data/generators/rhoconnect-adapters.rb

@@ -0,0 +1,217 @@
+require 'rubygems'
+require 'rhoconnect'
+
+require File.join('rhoconnect', '..','..','generators','rhoconnect')
+require 'templater'
+
+require 'rhoconnect-adapters'
+
+module RhoconnectAdapters
+  extend Templater::Manifold
+  extend RhoconnectAdapters
+  
+  desc <<-DESC
+    Rhoconnect-adapters generator
+  DESC
+  
+  class NotSupportedBackendError < Templater::MalformattedArgumentError
+  end
+  
+  class BaseGenerator < Templater::Generator
+    def class_name
+      name.gsub('-', '_').camel_case
+    end
+    
+    def underscore_name
+      Rhoconnect.under_score(name)
+    end
+    
+    def configure_gemfile
+      gem_file = File.join(@destination_root,"#{name}",'Gemfile')
+      doc = "\ngem 'rhoconnect-adapters', '#{gem_version}'\n"
+      File.open(gem_file, 'a') {|f| f.write(doc) }
+    end
+    
+    def self.invoke_generator(gen_name, excludes = nil)
+      invoke gen_name do |ext_gen| 
+        if not excludes.nil?
+          ext_gen.templates.delete_if {|t| excludes.index(t.name) != nil }
+        end
+        ext_gen.new(destination_root, {}, name)
+      end
+    end
+  end
+    
+  class CRMBaseGenerator < BaseGenerator
+    def underscore_crm
+      Rhoconnect.under_score(crm)
+    end
+    
+    def crm_name
+      crm
+    end
+
+    def gem_version
+      VERSION
+    end
+    
+    def self.check_valid_backend(name)
+      if not RhoconnectAdapters::CRM.valid_backend?(name)
+        puts "Requested CRM backend '#{name}' is not supported."
+        puts ''
+        puts 'List of supported backends:'
+        RhoconnectAdapters::CRM.registered_backends.each do |crm|
+          puts "    - #{crm}"
+        end
+        puts ''
+        raise NotSupportedBackendError
+      end
+    end
+    
+    def configure_gemfile
+      super
+      
+      # also call vendor-defined method
+      gem_file = File.join(@destination_root,"#{name}",'Gemfile')
+      vendor_module = RhoconnectAdapters::CRM.const_get(crm_name.to_sym)
+      vendor_dependencies = vendor_module.configure_gemfile
+      doc = ''
+      vendor_dependencies.each do |key, val|
+        doc += "gem '#{key}', '#{val}'\n"
+      end
+      
+      File.open(gem_file, 'a') {|f| f.write(doc) }
+    end
+    
+    def self.add_vendor_templates(verb, tname, &block)
+      send verb, "#{tname}_vendor_custom".to_sym do |t|
+        yield t,name,crm
+      end
+    end
+    
+    def initialize(generator_name, generator_class, *arguments)
+      super(generator_name, generator_class, *arguments)
+      RhoconnectAdapters::CRMBaseGenerator.check_valid_backend(arguments[1])
+    end
+  end
+  
+  class CRMAppGenerator < CRMBaseGenerator
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'crm', 'templates', 'application')
+    end
+    
+    desc <<-DESC
+      Generates a new rhoconnect CRM application.
+      
+      Required:
+        name        - application name
+        CRM backend - supported CRM backend #{RhoconnectAdapters::CRM.registered_backends.inspect}
+    DESC
+    
+    first_argument :name, :required => true, :desc => "application name"
+    second_argument :crm, :required => true, :desc => "supported CRM backend #{RhoconnectAdapters::CRM.registered_backends.inspect}"
+    #third_argument :__bare, :required => false, :desc => "generate CRM application without standard sources", :as => :boolean
+    option :bare, :default => false, :desc => "generate CRM application without standard sources", :as => :boolean
+    
+    # to prevent re-loading on subsequent loads
+    actions.clear
+    
+    # purpose of this call is to invoke all templates in 
+    # the Rhoconnect::Generator except the :application - which is overriden here
+    invoke_generator :rhoconnect_app, [:application, :spec_helper]
+    template :application do |template|
+      template.source = 'application.rb'
+      template.destination = "#{name}/application.rb"
+    end
+    template :spec_helper do |template|
+      source_filename = File.join('..','..','vendor',underscore_crm,'spec','spec_helper.rb')
+      if File.exists? File.join(CRMAppGenerator.source_root, source_filename)
+        template.source = source_filename
+      else
+        template.source = File.join('..','spec','spec_helper.rb')
+      end
+      template.destination = "#{name}/spec/spec_helper.rb"
+    end
+    template :vendor_application do |template|
+      template.source = File.join('..','..','vendor',"#{underscore_crm}",'application.rb')
+      template.destination = File.join("#{name}",'vendor',"#{underscore_crm}",'application.rb')
+    end
+    template :vendor_adapter do |template|
+      template.source = File.join('..','..','vendor',"#{underscore_crm}",'adapter.rb')
+      template.destination = File.join("#{name}",'vendor',"#{underscore_crm}",'adapter.rb')
+    end
+    
+    def after_run
+      configure_gemfile
+      # after app is generated , generate the standard sources
+      # but only if --bare is not specified
+      if not bare
+        RhoconnectAdapters::CRM.standard_sources.each do |source|
+          RhoconnectAdapters.run_cli(File.join(destination_root,name), 'rhoconnect-adapters', RhoconnectAdapters::VERSION, ['crmsource', "#{source}", crm])
+        end
+      end
+    end
+  end
+     
+  class CRMSourceGenerator < CRMBaseGenerator
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'crm', 'templates', 'source')
+    end
+
+    desc <<-DESC
+      Generates a new source adapter based on CRM object.
+      
+      Required:
+        name        - source name(i.e. Account)
+        CRM backend - supported CRM backend #{RhoconnectAdapters::CRM.registered_backends.inspect}
+    DESC
+
+    first_argument :name, :required => true, :desc => "source name"
+    second_argument :crm, :required => true, :desc => "supported CRM backend #{RhoconnectAdapters::CRM.registered_backends.inspect}"
+    
+    # to prevent re-loading on subsequent loads
+    actions.clear
+    
+    invoke_generator :rhoconnect_source, [:source, :source_spec]
+    template :source do |template|
+      template.source = 'source_adapter.rb'
+      template.destination = "sources/#{underscore_name}.rb"
+      settings_file = File.join(@destination_root,'settings','settings.yml')
+      settings = YAML.load_file(settings_file)
+      settings[:sources] ||= {}
+      settings[:sources][class_name] = {:poll_interval => 300}
+      File.open(settings_file, 'w' ) do |file|
+        file.write "#Sources" + {:sources => settings[:sources]}.to_yaml[3..-1]
+        envs = {}
+        [:development,:test,:production].each do |env|
+          envs[env] = settings[env]
+        end
+        file.write envs.to_yaml[3..-1]
+      end
+    end
+    template :source_spec do |template|
+      source_filename = File.join('..','..','vendor',underscore_crm,'spec','sources',"#{underscore_name}_spec.rb")
+      if File.exists? File.join(CRMSourceGenerator.source_root, source_filename)
+        template.source = source_filename
+      else
+        template.source = 'source_spec.rb'
+      end
+      template.destination = "spec/sources/#{underscore_name}_spec.rb"
+    end
+  end
+  
+  add_private :rhoconnect_app, Rhoconnect::AppGenerator
+  add_private :rhoconnect_source, Rhoconnect::SourceGenerator
+  add :crmapp, CRMAppGenerator
+  add :crmsource, CRMSourceGenerator
+end
+
+include RhoconnectAdapters
+
+if ARGV[0] == 'crmapp' || ARGV[0] == 'crmsource'
+  backend_arg = ARGV.last 
+  if backend_arg == '--bare'
+    backend_arg = ARGV[2]
+  end
+  Dir[File.join(File.dirname(__FILE__),'crm','vendor',"#{Rhoconnect.under_score(backend_arg)}",'templates.rb')].each { |vendor_templates| load vendor_templates }
+end

data/lib/rhoconnect-adapters/crm/crm.rb

@@ -0,0 +1,31 @@
+module RhoconnectAdapters
+  module CRM
+    class << self 
+      attr_reader :registered_backends
+      attr_reader :standard_sources
+
+      def valid_backend?(name)
+        registered_backends.index(name) != nil
+      end
+      def standard_source?(name)
+        standard_sources.index(name) != nil
+      end
+    end
+    @registered_backends = ['MsDynamics','OracleOnDemand','Salesforce','Sugar'];
+    @standard_sources = ['Account','Contact','Opportunity','Lead'];
+  
+    class Field
+      class << self
+        def create(name,type,label=nil)
+          { name => { :type => type,
+                      :label => label.nil? ? name : label }}
+        end
+      
+        def load_file(filename,key=nil)
+          contents = YAML.load_file(filename)
+          return key.nil? ? contents : contents[key]
+        end
+      end
+    end    
+  end
+end

data/lib/rhoconnect-adapters/soap_service.rb

@@ -0,0 +1,70 @@
+require 'rest-client'
+require 'nokogiri'
+
+module RhoconnectAdapters
+  class SoapService
+    @node_namespaces = {
+        'wsu' => 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd',
+        'wsse'=> 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd',
+    };
+    @envelope_namespaces = <<-DESC
+       xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" 
+       xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" 
+       xmlns:wsse=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd\"
+       xmlns:wsu=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd\"
+    DESC
+
+    class << self
+      # use node_namespaces attribute to specify namespaces used 
+      # by SoapService's select_node and select_node_text methods 
+      attr_accessor :node_namespaces
+      # use envelope namespaces to be passed with the SOAP request
+      attr_accessor :envelope_namespaces
+       
+      def select_node(doc,node_name)
+        doc.xpath("#{node_name}",SoapService.node_namespaces)
+      end
+
+      def select_node_text(doc,node_name)
+        doc.xpath("#{node_name}/text()",SoapService.node_namespaces).to_s.strip
+      end
+
+      def compose_wsse_header(username,password)
+        "<wsse:Security>
+          <wsse:UsernameToken wsu:Id=\"UsernameToken-1\">
+            <wsse:Username>#{username}</wsse:Username>
+            <wsse:Password Type=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText\">#{password}</wsse:Password>
+          </wsse:UsernameToken>
+        </wsse:Security>"
+      end
+
+      def compose_message(header,body,namespaces=RhoconnectAdapters::SoapService.envelope_namespaces)
+        hdr = header ? "<s:Header>#{header}</s:Header>" : ""
+        bdy = body ? "<s:Body>#{body}</s:Body>" : ""
+        "<?xml version=\"1.0\"?>
+         <s:Envelope #{namespaces}>
+           #{hdr}
+           #{bdy}
+         </s:Envelope>"        
+      end
+    
+      def send_request(endpoint,message,action=nil,content_type='text/xml; charset=UTF-8',cookie=nil)
+        response = send_request_raw(endpoint, message, action, content_type, cookie)
+        Nokogiri::XML(response)
+      end
+    
+      def send_request_raw(endpoint,message,action=nil,content_type='text/xml; charset=UTF-8',cookie=nil)
+        begin
+          headers = { :content_type => content_type }
+          headers.merge!({ "SOAPAction" => action }) if action
+          headers.merge!({ "Cookie" => cookie }) if cookie
+          response = RestClient.post(endpoint, message, headers)
+        rescue RestClient::Exception => ex
+          warn "#{self.name} error: " + ex.inspect.strip
+          ex.backtrace.each { |line| warn 'from ' + line } 
+          raise ex
+        end
+      end
+    end    
+  end
+end

data/lib/rhoconnect-adapters/version.rb

@@ -0,0 +1,3 @@
+module RhoconnectAdapters
+  VERSION = "1.0.0.beta1"
+end

data/lib/rhoconnect-adapters.rb

@@ -0,0 +1,2 @@
+require 'rhoconnect-adapters/version'
+require 'rhoconnect-adapters/crm/crm.rb'

data/rhoconnect-adapters.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rhoconnect-adapters/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rhoconnect-adapters"
+  s.version     = RhoconnectAdapters::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Rhomobile"]
+  s.date        = Time.now.strftime('%Y-%m-%d')
+  s.email       = %q{dev@rhomobile.com}
+  s.homepage    = %q{http://rhomobile.com/products/rhoconnect-adapters}
+  s.summary     = %q{Rhoconnect adapters}
+  s.description = %q{Rhoconnect out-of-the box adapters}
+
+  s.rubyforge_project = nil
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = %q{1.5.0}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+
+  s.add_dependency('bundler', '~> 1.0')  
+  s.add_dependency('rhoconnect', '>= 3.0.0.beta1')
+  s.add_dependency('activesupport', '>= 3.0.9')
+  s.add_dependency('i18n', '>= 0.6.0')
+  s.add_dependency('rake', '~> 0.9.2')
+  s.add_dependency('nokogiri', '>= 1.4.6')
+  s.add_dependency('templater', '~> 1.0.0')
+end

data/spec/apps/ms_dynamics_spec.rb

@@ -0,0 +1,19 @@
+require File.join(File.dirname(__FILE__),'..','spec_helper')
+
+describe "MsDynamics App RUNNER" do
+  appname = "mynewapp"
+  backend = 'MsDynamics'
+  
+  after(:all) do
+    FileUtils.rm_rf("/tmp/#{appname}")
+  end
+  
+  it "should run all the specs for standard #{backend} app " do
+    RhoconnectAdapters::CRM::TestHelpers.load_templater(backend)
+    @app_generator = RhoconnectAdapters::CRM::TestHelpers.generate_sample_app('/tmp',{},appname,backend)
+    cmdline = "cd /tmp/#{appname}; rake rhoconnect:spec"
+    res = system "#{cmdline}"
+    res.should == true
+  end
+end 
+

data/spec/apps/oracle_on_demand_spec.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__),'..','spec_helper')
+
+describe "OracleOnDemand App RUNNER" do
+  appname = "mynewapp"
+  backend = 'OracleOnDemand'
+  
+  after(:all) do
+    FileUtils.rm_rf("/tmp/#{appname}")
+  end
+  
+  it "should run all the specs for standard #{backend} app " do
+    RhoconnectAdapters::CRM::TestHelpers.load_templater(backend)
+    @app_generator = RhoconnectAdapters::CRM::TestHelpers.generate_sample_app('/tmp',{},appname,backend)
+    cmdline = "cd /tmp/#{appname}; rake rhoconnect:spec"
+    res = system "#{cmdline}"
+    res.should == true
+  end
+end 
+
+  

data/spec/apps/salesforce_spec.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__),'..','spec_helper')
+
+describe "Salesforce App RUNNER" do
+  appname = "mynewapp"
+  backend = 'Salesforce'
+  
+  after(:all) do
+    FileUtils.rm_rf("/tmp/#{appname}")
+  end
+  
+  it "should run all the specs for standard #{backend} app " do
+    RhoconnectAdapters::CRM::TestHelpers.load_templater(backend)
+    @app_generator = RhoconnectAdapters::CRM::TestHelpers.generate_sample_app('/tmp',{},appname,backend)
+    cmdline = "cd /tmp/#{appname}; rake rhoconnect:spec"
+    res = system "#{cmdline}"
+    res.should == true
+  end
+end 

data/spec/apps/sugar_spec.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__),'..','spec_helper')
+
+describe "Sugar App RUNNER" do
+  appname = "mynewapp"
+  backend = 'Sugar'
+  
+  after(:all) do
+    FileUtils.rm_rf("/tmp/#{appname}")
+  end
+  
+  it "should run all the specs for standard #{backend} app " do
+    RhoconnectAdapters::CRM::TestHelpers.load_templater(backend)
+    @app_generator = RhoconnectAdapters::CRM::TestHelpers.generate_sample_app('/tmp',{},appname,backend)
+    cmdline = "cd /tmp/#{appname}; rake rhoconnect:spec"
+    res = system "#{cmdline}"
+    res.should == true
+  end
+end 

data/spec/generator/generator_spec.rb

@@ -0,0 +1,113 @@
+require File.join(File.dirname(__FILE__),'..','spec_helper')
+
+describe "Generator" do
+  appname = 'mynewapp'
+  source = 'CustomObj'
+  
+  before(:each) do
+    FileUtils.mkdir_p '/tmp'
+  end
+  
+  after(:all) do
+    FileUtils.rm_rf("/tmp/#{appname}")
+  end
+  
+  describe "AppGenerator Command-line" do
+    it "should complain if no name is specified" do
+      lambda {
+        RhoconnectAdapters::CRMAppGenerator.new('/tmp',{})
+      }.should raise_error(Templater::TooFewArgumentsError)
+    end
+    
+    it "should complain if no CRM backend is specified" do
+      lambda {
+        RhoconnectAdapters::CRMAppGenerator.new('/tmp',{},appname)
+      }.should raise_error(Templater::TooFewArgumentsError)
+    end
+    
+    it "should complain if CRM backend is not valid" do
+      lambda {
+        RhoconnectAdapters::CRMAppGenerator.new('/tmp',{},appname,"foo")
+      }.should raise_error(RhoconnectAdapters::NotSupportedBackendError)
+    end
+  end
+     
+  RhoconnectAdapters::CRM.registered_backends.each do |backend|      
+    describe "Bare #{backend} App Generator" do
+      before(:all) do
+        RhoconnectAdapters::CRM::TestHelpers.load_templater(backend)
+        @generator = RhoconnectAdapters::CRM::TestHelpers.generate_sample_app('/tmp',{:bare => true},appname,backend)
+      end
+        
+      it "should not generate any sources with --bare option for #{backend}" do
+        SecureRandom.should_receive(:hex).with(64).any_number_of_times
+        RhoconnectAdapters::CRM.standard_sources.each do |source|
+          source_name = Rhoconnect.under_score(source)
+          @generator.should_not create("/tmp/#{appname}/sources/#{source}.rb")
+        end
+      end
+    end
+       
+    describe "Default #{backend} App Generator" do 
+      before(:all) do
+        RhoconnectAdapters::CRM::TestHelpers.load_templater(backend)
+        @generator = RhoconnectAdapters::CRM::TestHelpers.generate_sample_app('/tmp',{},appname,backend)
+      end
+        
+      it "should create new #{backend} standard application files" do
+        SecureRandom.should_receive(:hex).with(64).any_number_of_times
+        [ 
+          'application.rb',
+          "vendor/#{Rhoconnect.under_score(backend)}/application.rb",
+          "vendor/#{Rhoconnect.under_score(backend)}/adapter.rb",
+          'spec/spec_helper.rb'
+          ].each do |template|
+            @generator.should create("/tmp/#{appname}/#{template}")
+          end
+      end
+            
+      it "should generate standard #{RhoconnectAdapters::CRM.standard_sources.inspect} sources by default for #{backend}" do
+        SecureRandom.should_receive(:hex).with(64).any_number_of_times
+        RhoconnectAdapters::CRM.standard_sources.each do |source|
+          source_name = Rhoconnect.under_score(source)
+          File.should be_exist("/tmp/#{appname}/sources/#{source_name}.rb")
+        end
+      end
+    end
+  end
+  
+  describe "SourceGenerator Command-Line" do
+    it "should complain if no name is specified" do
+      lambda {
+        RhoconnectAdapters::CRMSourceGenerator.new('/tmp',{})
+      }.should raise_error(Templater::TooFewArgumentsError)
+    end
+    
+    it "should complain if no CRM backend is specified" do
+      lambda {
+        RhoconnectAdapters::CRMSourceGenerator.new('/tmp',{},source)
+      }.should raise_error(Templater::TooFewArgumentsError)
+    end
+    
+    it "should complain if CRM backend is not valid" do
+      lambda {
+        RhoconnectAdapters::CRMSourceGenerator.new('/tmp',{},source,"foo")
+      }.should raise_error(RhoconnectAdapters::NotSupportedBackendError)
+    end
+  end
+  
+  RhoconnectAdapters::CRM.registered_backends.each do |backend|     
+    describe "#{backend} Source Generator" do
+      before(:each) do
+        RhoconnectAdapters::CRM::TestHelpers.load_templater(backend)
+        @app_generator = RhoconnectAdapters::CRM::TestHelpers.generate_sample_app('/tmp',{:bare => true},appname,backend)
+        @generator = RhoconnectAdapters::CRMSourceGenerator.new("/tmp/#{appname}",{},source,backend)
+      end
+        
+      it "should create new source adapter and spec" do
+        @generator.should create("/tmp/#{appname}/sources/#{Rhoconnect.under_score(source)}.rb")
+        @generator.should create("/tmp/#{appname}/spec/sources/#{Rhoconnect.under_score(source)}_spec.rb")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,57 @@
+#$:.unshift File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'rspec'
+require 'templater/spec/helpers'
+
+include Templater::Spec::Helpers
+require 'rhoconnect-adapters'
+require File.join(File.dirname(__FILE__),'..','generators','rhoconnect-adapters')
+
+
+ENV['RACK_ENV'] = 'test'
+
+# this method removes all vendor-specific actions
+# from the generator, thus, cleaning up the templater
+# in order to prepare it to run next batch
+# of vendor-specific specs
+def cleanup_templater(templater)
+  standard_actions = {}
+  templater.actions.each do |type,actions|
+    standard_actions_array = []
+    actions.each do |action|
+      standard_actions_array << action unless action.name.to_s.index('vendor_custom') != nil
+    end
+    standard_actions[type] = standard_actions_array
+  end
+  templater.actions.clear
+  standard_actions.each do |type,actions|
+    templater.actions[type] = actions
+  end
+  templater
+end
+
+# in order to run the generator
+# it is necessary to remove any previously loaded 
+# vendor-specific actions and load the new ones
+module RhoconnectAdapters
+  module CRM
+    class TestHelpers
+      class << self
+        def load_templater(backend)
+          cleanup_templater(RhoconnectAdapters::CRMAppGenerator)
+          cleanup_templater(RhoconnectAdapters::CRMSourceGenerator)
+          Dir[File.join(File.dirname(__FILE__),'..','generators','crm','vendor',"#{Rhoconnect.under_score(backend)}",'templates.rb')].each { |vendor_templates| load vendor_templates }
+        end
+
+        def generate_sample_app(destination_root,options,appname,backend)
+          FileUtils.rm_rf "#{destination_root}/#{appname}"
+
+          generator = RhoconnectAdapters::CRMAppGenerator.new(destination_root,options,appname,backend)
+          generator.invoke!
+          generator.after_run
+          generator
+        end
+      end
+    end
+  end
+end