rhoconnect-adapters 1.0.0.beta1

data/generators/crm/vendor/ms_dynamics/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+require 'rubygems'
+
+# Set environment to test
+ENV['RHO_ENV'] = 'test'
+ROOT_PATH = File.expand_path(File.join(File.dirname(__FILE__),'..'))
+
+require 'bundler'
+Bundler.require(:default, ENV['RHO_ENV'].to_sym)
+
+# Try to load vendor-ed rhoconnect, otherwise load the gem
+begin
+  require 'vendor/rhoconnect/lib/rhoconnect'
+rescue LoadError
+  require 'rhoconnect'
+end
+
+$:.unshift File.join(File.dirname(__FILE__), "..") # FIXME:
+# Load our rhoconnect application
+require 'application'
+include Rhoconnect
+
+require 'rhoconnect/test_methods'
+
+# Monkey patch to fix the following issue:
+# /Library/Ruby/Gems/1.8/gems/rspec-core-2.5.1/lib/rspec/core/shared_example_group.rb:45:
+# in `ensure_shared_example_group_name_not_taken': Shared example group '...' already exists (ArgumentError)
+module RSpec
+  module Core
+    module SharedExampleGroup
+    private
+      def ensure_shared_example_group_name_not_taken(name)
+      end
+    end
+  end
+end
+
+module TestHelpers
+  class << self
+    @created_records = {}
+    attr_accessor :created_records
+    
+    @already_authenticated = false
+    attr_accessor :already_authenticated
+  end
+end
+
+shared_examples_for "SpecHelper" do
+  include Rhoconnect::TestMethods
+  
+  def load_credentials(backend)
+    file = YAML.load_file(File.join(ROOT_PATH,'..','rhoconnect-adapters-test',"#{Rhoconnect.under_score(backend)}.yml"))
+    return file.nil? ? {} : file
+  end
+  
+  before(:all) do
+    credentials = load_credentials(Application.backend)
+    @test_user = "#{credentials[:test_user]}"
+    @test_password = "#{credentials[:test_password]}"
+    puts "Specify test user before running these specs" unless @test_user.length > 0
+    puts "Specify test user password before running these specs" unless @test_password.length > 0
+    unless TestHelpers.already_authenticated
+      Store.db.flushdb
+      if @test_user.length > 0 and @test_password.length > 0
+        puts "Performing authentication with #{Application.backend} CRM instance for the user [#{@test_user}]"
+        TestHelpers.already_authenticated = Application.authenticate(@test_user,@test_password) 
+      end
+    end
+  end
+    
+  before(:each) do
+    # preserving auth info 
+    auth_info = RhoconnectAdapters::CRM::MsDynamics.load_auth_info(@test_user)
+    Store.db.flushdb
+    Application.initializer(ROOT_PATH)
+    # restoring auth info in the DB
+    RhoconnectAdapters::CRM::MsDynamics.save_auth_info(@test_user,auth_info) unless auth_info.nil?
+  end
+end

data/generators/crm/vendor/ms_dynamics/spec_data/Account.yml

@@ -0,0 +1,6 @@
+Account:
+  name: ACME Co.
+  numberofemployees: 30
+  telephone1: (333)-333-3333
+  websiteurl: www.acme.com
+  accountcategorycode: Standard

data/generators/crm/vendor/ms_dynamics/spec_data/Contact.yml

@@ -0,0 +1,7 @@
+Contact:
+  gendercode: Male
+  firstname: John
+  lastname: Smith
+  emailaddress1: myemail@domain.com
+  jobtitle: Sales Assistant
+  telephone1: (333)-333-3333

data/generators/crm/vendor/ms_dynamics/spec_data/GenericObject.yml

@@ -0,0 +1,3 @@
+<%=class_name%>:
+    # put all of your sample data for specs here in the form of hash
+    # { field_name => sample_field_value }

data/generators/crm/vendor/ms_dynamics/spec_data/Lead.yml

@@ -0,0 +1,12 @@
+Lead:
+  firstname: John
+  lastname: Smith
+  mobilephone: (555)111-1111
+  emailaddress1: john.smith@example.com
+  companyname: ABC Company
+  jobtitle: Sales Assistant
+  estimatedvalue: 40000
+  estimatedclosedate: 5/15/2011
+  address1_country: USA
+  address1_city: San Francisco
+  address1_line1: 111 Market St.

data/generators/crm/vendor/ms_dynamics/spec_data/Opportunity.yml

@@ -0,0 +1,6 @@
+Opportunity:
+    name: 600 Hard Drives
+    estimatedvalue: 5000
+    closeprobability: 75
+    description: close-out sale
+

data/generators/crm/vendor/ms_dynamics/templates.rb

@@ -0,0 +1,57 @@
+# these are MsDynamics-specific Templater::Generator templates
+module RhoconnectAdapters
+  module CRM
+    module MsDynamics
+      class << self
+        def configure_gemfile
+          # put all specific dependencies here
+          # in the form of hash {'gem' => 'version'}
+          {}
+        end
+      end
+    end
+  end
+end
+
+RhoconnectAdapters::CRMAppGenerator.add_vendor_templates :directory, :msdynamics_lib_files do |dir,name,crm|
+  dir.source = File.join('..','..','vendor','ms_dynamics','lib')
+  dir.destination = File.join("#{name}", 'vendor','ms_dynamics','lib')
+end
+
+RhoconnectAdapters::CRMAppGenerator.add_vendor_templates :file, :ms_dynamics_main_require do |file,name,crm|
+  file.source = File.join('..','..','vendor','ms_dynamics','ms_dynamics.rb')
+  file.destination = File.join("#{name}", 'vendor','ms_dynamics','ms_dynamics.rb')
+end
+
+RhoconnectAdapters::CRMAppGenerator.add_vendor_templates :file, :settings_yml do |file,name,crm|
+  file.source = File.join('..','..','vendor','ms_dynamics','settings','settings.yml')
+  file.destination = File.join("#{name}", 'vendor','ms_dynamics','settings','settings.yml')
+end
+
+RhoconnectAdapters::CRMAppGenerator.add_vendor_templates :file, :application_spec do |file,name,crm|
+  file.source = File.join('..','..','vendor','ms_dynamics','spec','application_spec.rb')
+  file.destination = File.join("#{name}", 'spec','application_spec.rb')
+end
+
+RhoconnectAdapters::CRMSourceGenerator.add_vendor_templates :file, :object_yml do |file,name,crm|
+  source_name = name.gsub('-', '_').camel_case
+  source_filename = File.join('..','..','vendor','ms_dynamics','settings',"#{source_name}.yml")
+  if File.exists? File.join(CRMSourceGenerator.source_root, source_filename)
+    file.source = source_filename
+  else
+    file.source = File.join('..','..','vendor','ms_dynamics','settings',"GenericObject.yml")
+  end
+  file.destination = File.join('vendor','ms_dynamics','settings', "#{source_name}.yml")
+end
+
+RhoconnectAdapters::CRMSourceGenerator.add_vendor_templates :template, :spec_data do |template,name,crm|
+  source_name = name.gsub('-', '_').camel_case
+  source_filename = File.join('..','..','vendor','ms_dynamics','spec_data',"#{source_name}.yml")
+  if File.exists? File.join(CRMSourceGenerator.source_root, source_filename)
+    template.source = source_filename
+  else
+    template.source = File.join('..','..','vendor','ms_dynamics','spec_data',"GenericObject.yml")
+  end
+  template.destination = File.join('vendor','ms_dynamics','spec_data', "#{source_name}.yml")
+end
+

data/generators/crm/vendor/oracle_on_demand/adapter.rb

@@ -0,0 +1,421 @@
+require 'rhoconnect-adapters'
+require 'rhoconnect-adapters/soap_service'
+require 'active_support/inflector'
+
+module RhoconnectAdapters
+  module CRM
+    module OracleOnDemand
+      RhoconnectAdapters::SoapService.node_namespaces.merge!({'s'   => 'http://schemas.xmlsoap.org/soap/envelope/',
+                                                  'plns' => 'urn:crmondemand/ws/picklist/',
+                                                  'pldoc' => 'urn:/crmondemand/xml/picklist'});
+      RhoconnectAdapters::SoapService.envelope_namespaces += <<-DESC
+        xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\"
+      DESC
+    
+      class Adapter < SourceAdapter
+        @picklist_namespaces = RhoconnectAdapters::SoapService.envelope_namespaces + "\nxmlns:wsdl=\"urn:crmondemand/ws/picklist/\""
+        attr_accessor :crm_object
+        attr_accessor :crm_object_namespaces
+        attr_accessor :fields
+      
+        class << self
+          attr_accessor :picklist_namespaces
+        
+          def get_columns(fields)
+            columns = ""
+            fields.each do |key,val|
+              columns += "<wsdl:#{key}></wsdl:#{key}>"
+            end
+            columns
+          end
+        
+          def get_columns_values(fields)
+            columns = ""
+            fields.each do |key,val|
+              if not val
+                next
+              end
+              columns += "<wsdl:#{key}>#{val}</wsdl:#{key}>"
+            end
+            columns
+          end
+        end
+                        
+        def initialize(source)
+          super(source)
+          @fields = {}   
+          @crm_object = self.class.name
+          @title_fields = ['Id']
+        end
+      
+        def configure_fields
+          # this is going to be used in XPath searches
+          RhoconnectAdapters::SoapService.node_namespaces.merge!({"#{crm_object}doc" => "urn:/crmondemand/xml/#{crm_object}/Data"});
+        
+          # this is going to be passed in SOAP requests
+          @crm_object_namespaces = RhoconnectAdapters::SoapService.envelope_namespaces
+          @crm_object_namespaces += "\nxmlns:wsdl=\"urn:crmondemand/ws/ecbs/#{crm_object.downcase}/\""
+        
+          # initialize fields map
+          @fields = get_object_settings['Query_Fields']
+    
+          @field_picklists = {}
+          static_picklists = get_object_settings['StaticPicklist']
+          if static_picklists != nil
+            static_picklists.each do |element_name, values|
+              @field_picklists[element_name] = values
+            end
+          end
+    
+          @object_fields = get_object_settings['ObjectFields']
+          @object_fields = {} if @object_fields == nil
+        
+          # title fields are used in metadata to show 
+          # records in the list
+          @title_fields = get_object_settings['TitleFields']
+        
+          @fields
+        end
+
+        def get_object_settings
+          return @object_settings if @object_settings
+          begin
+            @object_settings = RhoconnectAdapters::CRM::Field.load_file(File.join(ROOT_PATH,'vendor','oracle_on_demand','settings',"#{crm_object}.yml"))
+          rescue Exception => e
+            puts "Error opening CRMObjects settings file: #{e}"
+            puts e.backtrace.join("\n")
+            raise e
+          end
+        end
+
+        def get_picklists
+          begin  
+            nonquery_fields = get_object_settings['NonQuery_MappingWS_Fields']
+            fields.each do |element_name, element_def|
+              # use object field only of it has not been excluded
+              # explicitly in the object's settings
+              next if nonquery_fields.has_key? element_name
+      
+              data_type = element_def['Type']
+              # for picklists - get values
+              # but only for those that are not 
+              # already defined statically
+              if data_type == 'Picklist' and not @field_picklists.has_key?(element_name)
+                @field_picklists[element_name] = get_picklist(element_name)
+              end
+            end    
+          rescue RestClient::Exception => e
+            raise e
+          end
+        end
+ 
+        def get_picklist(element_name)
+          # check if we already have it in Store
+          picklist = Store.get_data("#{crm_object}:#{element_name}_picklist",Array)
+          return picklist if picklist.size != 0
+        
+          password = Store.get_value("#{current_user.login}:password")
+          wsse = RhoconnectAdapters::SoapService.compose_wsse_header(current_user.login, password)
+          body = "<wsdl:PicklistWS_GetPicklistValues_Input>
+                     <wsdl:RecordType>#{crm_object}</wsdl:RecordType>
+                     <wsdl:FieldName>#{element_name}</wsdl:FieldName>
+                   </wsdl:PicklistWS_GetPicklistValues_Input>"
+          req = RhoconnectAdapters::SoapService.compose_message(wsse, body, Adapter.picklist_namespaces)
+        
+          field_values = []
+          response = nil
+          begin
+            response = RhoconnectAdapters::SoapService.send_request_raw("#{@endpoint_url}/GetPicklistValues",
+                                                req, 
+                                                "\"document/urn:crmondemand/ws/picklist/:GetPicklistValues\"",
+                                                @session_cookie);
+          
+            oracle_rec = RhoconnectAdapters::SoapService.select_node(Nokogiri::XML(response), '//pldoc:PicklistValue')
+            oracle_rec.each do |pval|
+              disabled = RhoconnectAdapters::SoapService.select_node_text(pval, 'pldoc:Disabled')
+              field_values << RhoconnectAdapters::SoapService.select_node_text(pval, 'pldoc:DisplayValue') if not disabled == 'Y'
+            end
+    
+          rescue RestClient::Exception => e
+            raise e
+          end
+          # server stateless session id is returned with the response
+          @session_cookie = response.cookies
+          Store.put_data("#{crm_object}:#{element_name}_picklist", field_values)
+          field_values
+        end
+ 
+        def login
+          @endpoint_url = Store.get_value("#{current_user.login}:service_url")
+    
+          # get types information from the GetPicklistValues WS
+          get_picklists
+        end
+
+        def execute_soap_action(action, soap_body)
+          action_prefix = "#{crm_object}" + action
+          soapaction = "\"document/urn:crmondemand/ws/ecbs/#{crm_object.downcase}/:"
+          soapaction += action_prefix + '"'
+        
+          password = Store.get_value("#{current_user.login}:password")
+          wsse = RhoconnectAdapters::SoapService.compose_wsse_header(current_user.login, password)
+          body = "<wsdl:#{crm_object}#{action}_Input>
+                  #{soap_body}
+                </wsdl:#{crm_object}#{action}_Input>"
+          req = RhoconnectAdapters::SoapService.compose_message(wsse, body, crm_object_namespaces)
+        
+          response = nil
+          begin
+            response = RhoconnectAdapters::SoapService.send_request_raw("#{@endpoint_url}/#{crm_object}",
+                                                req, 
+                                                soapaction,
+                                                @session_cookie);
+          rescue RestClient::Exception => e
+            raise e
+          end
+          # server stateless session id is returned with the response
+          @session_cookie = response.cookies
+        
+          RhoconnectAdapters::SoapService.select_node(Nokogiri::XML(response), "//#{crm_object}doc:ListOf#{crm_object}")[0]
+        end  
+
+        def query(params=nil)
+          # TODO: Query your backend data source and assign the records 
+          # to a nested hash structure called @result. For example:
+          # @result = { 
+          #   "1"=>{"name"=>"Acme", "industry"=>"Electronics"},
+          #   "2"=>{"name"=>"Best", "industry"=>"Software"}
+          # }
+          @result = {}
+          fetch_more = 'true'
+          start_row = 0
+          begin 
+          
+            soap_body = "<wsdl:ListOf#{crm_object} recordcountneeded=\"true\" pagesize=\"100\" startrownum=\"#{start_row.to_s}\">
+              <wsdl:#{crm_object} searchspec=\"\">
+                #{Adapter.get_columns(fields)}
+              </wsdl:#{crm_object}>
+            </wsdl:ListOf#{crm_object}>"
+
+            query_results = execute_soap_action('QueryPage', soap_body)
+            fetch_more = query_results['lastpage'] == 'true' ? false : true;
+          
+            query_results.children.each do |record|
+              if record.name == "#{crm_object}"
+                 id_field = RhoconnectAdapters::SoapService.select_node_text(record, "#{crm_object}doc:Id")
+                 converted_record = {}
+                 # grab only the allowed fields 
+                 fields.each do |element_name,element_def|
+                   converted_record[element_name] = RhoconnectAdapters::SoapService.select_node_text(record, "#{crm_object}doc:#{element_name}")
+                 end
+                 @result[id_field] = converted_record
+               end
+             end
+             start_row = @result.size
+           end while fetch_more
+           @result
+         end
+          
+        def sync
+          # Manipulate @result before it is saved, or save it 
+          # yourself using the Rhoconnect::Store interface.
+          # By default, super is called below which simply saves @result
+          super
+        end
+  
+        def metadata
+          # define the metadata
+          show_fields = []
+          new_fields = []
+          edit_fields = []
+          model_name = "" + crm_object
+          model_name[0] = model_name[0,1].downcase
+          record_sym = '@' + "#{model_name}"
+      
+          fields.each do |element_name,element_def|
+            next if element_name == 'Id'
+      
+            # 1) - read-only show fields
+            field_type = 'labeledvalueli'
+            field = {
+              :name => "#{model_name}\[#{element_name}\]",
+              :label => element_def['Label'],
+              :type => field_type,
+              :value => "{{#{record_sym}/#{element_name}}}"
+            }
+            show_fields << field
+      
+            new_field = field.clone
+            new_field[:type] = 'labeledinputli'
+            new_field.delete(:value) 
+            case element_def['Type']
+            when 'Picklist'
+              new_field[:type] = 'select'
+              values = []
+              # make first element a blanc value
+              values[0] = nil
+              values.concat @field_picklists[element_name]
+              new_field[:values] = values
+              new_field[:value] = values[0]
+            when 'object'
+            end
+             
+            new_fields << new_field if not element_def['Type'] == 'object'
+      
+            edit_field = new_field.clone
+            edit_field[:value] = "{{#{record_sym}/#{element_name}}}"
+            edit_fields << edit_field
+          end
+    
+          # Show
+          show_list = { :name => 'list', :type => 'list', :children => show_fields }
+          show_form = { 
+            :name => "#{crm_object}_show",
+            :type => 'show_form',
+            :title => "#{crm_object} details",
+            :object => "#{crm_object}",
+            :model => "#{model_name}",
+            :id => "{{#{record_sym}/object}}",
+            :children => [show_list]
+          }
+    
+          # New
+          new_list = show_list.clone
+          new_list[:children] = new_fields
+          new_form = {
+            :type => 'new_form',
+            :title => "New #{crm_object}",
+            :object => "#{crm_object}",
+            :model => "#{model_name}",
+            :children => [new_list]
+          }
+    
+          # Edit
+          edit_list = show_list.clone
+          edit_list[:children] = edit_fields
+          edit_form = { 
+            :type => 'update_form',
+            :title => "Edit #{crm_object}",
+            :object => "#{crm_object}",
+            :model => "#{model_name}",
+            :id => "{{#{record_sym}/object}}",
+            :children => [edit_list]
+          }
+        
+          # Index
+          title_field_metadata = @title_fields.collect { |field_name | "{{#{field_name.to_s}}} " }.join(' ')
+          object_rec = {
+            :object => "#{crm_object}",
+            :id => "{{object}}",
+            :type => 'linkobj', 
+            :text => "#{title_field_metadata}" 
+          }
+
+          index_form = {
+            :object => "#{crm_object}",
+            :title => "#{crm_object.pluralize}",
+            :type => 'index_form',
+            :children => [object_rec],
+            :repeatable => "{{#{record_sym.pluralize}}}"
+          }
+
+          # return JSON
+          { 'index' => index_form, 'show' => show_form, 'new' => new_form, 'edit' => edit_form }.to_json
+        end
+ 
+        def create(create_hash,blob=nil)
+          # TODO: Create a new record in your backend data source
+          # If your rhodes rhom object contains image/binary data 
+          # (has the image_uri attribute), then a blob will be provided
+          created_object_id = nil
+          request_fields = {}
+          fields.each do |element_name, element_def|
+            field_value = create_hash[element_name]
+            if field_value != nil and element_name != 'Id'
+              request_fields[element_name] = field_value
+            end
+          end
+        
+          soap_body = "<wsdl:ListOf#{crm_object}>
+              <wsdl:#{crm_object}>
+                #{Adapter.get_columns_values(request_fields)}
+              </wsdl:#{crm_object}>
+            </wsdl:ListOf#{crm_object}>"
+
+          begin 
+            oracle_rec = execute_soap_action('Insert', soap_body)
+            created_object_id = RhoconnectAdapters::SoapService.select_node_text(oracle_rec, "//#{crm_object}doc:Id").to_s
+          rescue RestClient::Exception => e
+            raise e
+          end
+        
+          # return new object ids
+          created_object_id
+        end
+ 
+        def update(update_hash)
+          updated_object_id = nil
+          request_fields = {}
+          fields.each do |element_name,element_def|
+            field_value = update_hash[element_name]
+            if field_value != nil
+              request_fields[element_name] = field_value
+            end
+          end
+          # check if 'Id' is present
+          # it may be available as an 'id'
+          if request_fields['Id'] == nil
+            request_fields['Id'] = update_hash['id']
+          end
+        
+          if request_fields['Id'] == nil
+            raise SourceAdapterObjectConflictError.new("'Id' field must be specified for the Update request")
+          end
+        
+          soap_body = "<wsdl:ListOf#{crm_object}>
+              <wsdl:#{crm_object}>
+                #{Adapter.get_columns_values(request_fields)}
+              </wsdl:#{crm_object}>
+            </wsdl:ListOf#{crm_object}>"
+
+          begin 
+            oracle_rec = execute_soap_action('Update', soap_body)
+            updated_object_id = RhoconnectAdapters::SoapService.select_node_text(oracle_rec, "#{crm_object}doc:Id")
+          rescue RestClient::Exception => e
+            raise e
+          end
+          updated_object_id
+        end
+ 
+        def delete(delete_hash)
+          deleted_object_id = delete_hash['Id'] || delete_hash['id']
+        
+          if deleted_object_id == nil
+            raise SourceAdapterObjectConflictError.new("'Id' field must be specified for the Delete request")
+          end
+        
+          request_fields = {}
+          request_fields['Id'] = deleted_object_id
+        
+          soap_body = "<wsdl:ListOf#{crm_object}>
+              <wsdl:#{crm_object}>
+                #{Adapter.get_columns_values(request_fields)}
+              </wsdl:#{crm_object}>
+            </wsdl:ListOf#{crm_object}>"
+
+          begin 
+            execute_soap_action('Delete', soap_body)
+          rescue RestClient::Exception => e
+            raise e
+          end
+        
+          deleted_object_id
+        end
+ 
+        def logoff
+          # logoff if necessary
+        end
+      end
+    end
+  end
+end

data/generators/crm/vendor/oracle_on_demand/application.rb

@@ -0,0 +1,64 @@
+require 'rhoconnect-adapters'
+require 'rest-client'
+
+module RhoconnectAdapters
+  module CRM
+    module OracleOnDemand
+      class Application < Rhoconnect::Base
+        class << self
+          def authenticate(username,password,session)
+            begin
+              oraclecrm_url = Application.get_settings[:oraclecrm_service_url]
+              request_url = oraclecrm_url + "?command=" + 'login'
+        
+              # here we just verifying the credetials
+              # by logging in and immediately logging out
+              in_headers = {
+                "UserName" => username,
+                "Password" => password
+              };
+
+              RestClient.get(request_url, in_headers) do |response,request,result,&block|
+                case response.code
+                when 200
+                  # store password to be used by SourceAdaptors
+                  Store.put_value("#{username}:password", password)
+                  Store.put_value("#{username}:service_url", oraclecrm_url)
+            
+                  # since we established the session only 
+                  # to verify the credentials - close the session here
+                  request_url = "#{oraclecrm_url}" + '?command=' + 'logoff'
+                  in_headers = { "Cookie" => response.headers[:set_cookie] };
+                  RestClient.get(request_url, in_headers)
+                else
+                  raise "LOGIN/PASSWORD ERROR : #{response.code} : #{response}" 
+                end  
+              end
+            rescue Exception => e
+              warn "Can't authenticate user #{username}: " + e.inspect
+              return false
+            end
+            true
+          end
+          def get_settings
+            return @settings if @settings
+            begin
+              file = YAML.load_file(File.join(ROOT_PATH,'settings','settings.yml'))
+              env = (ENV['RHO_ENV'] || :development).to_sym
+              @settings = file[env]
+            
+              # vendor-specific settings
+              file = YAML.load_file(File.join(ROOT_PATH,'vendor','oracle_on_demand','settings','settings.yml'))
+              @settings.merge!(file[env])
+            rescue Exception => e
+              puts "Error opening settings file: #{e}"
+              puts e.backtrace.join("\n")
+              raise e
+            end
+          end
+        end
+      end
+    end
+  end
+end
+