rhoconnect-adapters 1.0.0.beta1

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

@@ -0,0 +1,315 @@
+require 'rhoconnect-adapters'
+require 'rest-client'
+
+module RhoconnectAdapters
+  module CRM
+    module Salesforce
+      class Adapter < SourceAdapter
+        attr_accessor :crm_object
+        attr_accessor :fields
+      
+        def initialize(source)
+          super(source)
+          @crm_object = self.class.name
+          @fields = {}   
+          @title_fields = ["#{crm_object.downcase}id"]   
+        end
+    
+        def configure_fields
+          # initialize fields map
+          @fields = get_object_settings['Query_Fields']
+          @field_picklists = {}
+        
+          @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','salesforce','settings',"#{crm_object.downcase}.yml"))
+          rescue Exception => e
+            puts "Error opening CRMObjects settings file: #{e}"
+            puts e.backtrace.join("\n")
+            raise e
+          end
+        end
+      
+        def get_picklists
+          begin 
+            already_described = Store.get_value("#{crm_object}:already_described")
+            return if already_described
+            
+            # call describe method to retrieve the object's metadata
+            request_url = "#{@resturl}/sobjects/#{crm_object}/describe/"
+            parsed = JSON.parse(RestClient.get(request_url, @restheaders).body)
+            parsed["fields"].each do |field|
+              element_name = field['name']
+              
+              #puts " we have field #{element_name}"
+              #puts " picklist values are : #{field["picklistValues"].inspect}"
+              
+              next unless fields[element_name] != nil
+              data_type = fields[element_name]['Type']
+              if data_type == 'Picklist' and not @field_picklists.has_key?(element_name)
+                @field_picklists[element_name] = get_picklist(element_name, field)
+              end
+            end
+            Store.put_value("#{crm_object}:already_described", true)    
+          rescue RestClient::Exception => e
+            raise e
+          end
+        end
+ 
+        def get_picklist(element_name, field_data)
+          # check if we already have it in Store
+          picklist = Store.get_data("#{crm_object}:#{element_name}_picklist",Array)
+          return picklist if picklist.size != 0
+        
+          field_values = []
+          field_data["picklistValues"].each do |v|
+            field_values << v['value']
+          end
+          Store.put_data("#{crm_object}:#{element_name}_picklist", field_values)
+          field_values
+        end
+      
+        def login
+          @session_id = Store.get_value("#{current_user.login}:session_id")
+          @resturl = Store.get_value("#{current_user.login}:service_url")
+          @restheaders = {
+            "Accept" => "*/*", 
+            "Authorization" => "OAuth #{@session_id}", 
+            "X-PrettyPrint" => "1"
+          }
+
+          @postheaders = {
+            "Accept" => "*/*", 
+            "Content-Type" => "application/json", 
+            "Authorization" => "OAuth #{@session_id}", 
+            "X-PrettyPrint" => "1"
+          }
+          
+          # query picklist values
+          get_picklists
+        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 = {}
+
+          fieldquery = ""
+          @fields.each do |element_name, element_def|
+            fieldquery << ",#{element_name}"
+          end
+          fieldquery[0] = " "
+
+          querystr = "SELECT #{fieldquery} from #{crm_object}"
+
+          requesturl = @resturl + "/query/?q=" + CGI::escape(querystr)
+          raw_data = RestClient.get(requesturl, @restheaders)
+          parsed_data = JSON.parse raw_data
+
+          parsed_data["records"].each do |record|
+            record_hash = {}
+            @fields.each do |element_name, element_def|
+              record_hash[element_name] = record[element_name]
+            end
+            @result[record['Id']] = record_hash
+          end
+          
+          @result
+        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 blank 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 = {}
+          field_types = {}
+          fields.each do |element_name, element_def|
+            field_value = create_hash[element_name]
+            next unless (element_name != "Id" and field_value != nil)
+            
+            # special case for Datetime types - they need to 
+            # be converted to W3C XML trailing Z
+            if element_def['Type'] == 'datetime'
+              field_value = Date.parse(field_value).strftime '%Y-%m-%dT%H:%M:%S.000Z'
+            end  
+            request_fields[element_name] = field_value
+          end
+          
+          begin 
+            requesturl = "#{@resturl}/sobjects/#{crm_object}/"
+            raw_data = RestClient.post(requesturl, request_fields.to_json, @postheaders) do |response,request, result, &block| 
+              case response.code 
+              when 400
+                raise response.body
+              end
+              response.body
+            end
+            parsed = JSON.parse raw_data
+            created_object_id = parsed['id']
+          rescue Exception => e
+            raise e
+          end
+          created_object_id
+        end
+        
+        def update(update_hash)
+          # it may be there as 'id' field
+          updated_object_id = update_hash['Id'] || update_hash['id']
+          if updated_object_id == nil
+            raise SourceAdapterObjectConflictError.new("Either 'Id' or 'id' field must be specified for the Update request")
+          end
+        
+          request_fields = {}
+          field_types = {}
+          fields.each do |element_name,element_def|
+            next if (element_name == "Id" or element_name == 'id')
+          
+            field_value = update_hash[element_name]
+            next unless field_value != nil
+            # special case for Datetime types - they need to 
+            # be converted to W3C XML trailing Z
+            if element_def['Type'] == 'datetime'
+              field_value = Date.parse(field_value).strftime '%Y-%m-%dT%H:%M:%S.000Z'
+            end
+            request_fields[element_name] = field_value
+          end
+          
+          requesturl = @resturl + "/sobjects/#{crm_object}/#{updated_object_id}?_HttpMethod=PATCH"
+          RestClient.post(requesturl, request_fields.to_json, @postheaders)
+          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("Either 'Id' or 'id' field must be specified for the Delete request")
+          end
+        
+          requesturl = @resturl + "/sobjects/#{crm_object}/#{deleted_object_id}?_HttpMethod=DELETE"
+          RestClient.post(requesturl, "", @postheaders)
+          deleted_object_id
+        end
+ 
+        def logoff
+          # logoff if necessary
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+require 'rhoconnect-adapters'
+require 'rhoconnect-adapters/soap_service'
+require 'active_support/core_ext'
+
+module RhoconnectAdapters
+  module CRM
+    module Salesforce
+      RhoconnectAdapters::SoapService.envelope_namespaces += <<-DESC
+        xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\"
+      DESC
+      
+      class Application < Rhoconnect::Base
+        class << self
+          def authenticate(username,password,session=nil)
+            begin
+              salesforce_login_url = Application.get_settings[:salesforce_login_url]
+              
+              request_body = "<login xmlns=\"urn:enterprise.soap.sforce.com\"> 
+                                <username>#{username}</username> 
+                                <password>#{password}</password> 
+                              </login>"
+              
+              soap_message = RhoconnectAdapters::SoapService.compose_message(nil, request_body)
+              response = RhoconnectAdapters::SoapService.send_request_raw(salesforce_login_url, soap_message, '""')
+              res_hash = Hash.from_xml(response)['Envelope']['Body']['loginResponse']['result']
+              
+              # obtain session id and endpoint url
+              session_id = res_hash['sessionId'].split('!')[1]
+              # here, requestUrl is formatted for SOAP requests
+              # and we removing Soap part for it (which is suffix after services)
+              # since we will user REST after that
+              endpoint_url = res_hash['serverUrl'].split('services')[0] + 'services/data/v22.0'
+              
+              # store password to be used by SourceAdaptors
+              Store.put_value("#{username}:session_id", session_id)
+              Store.put_value("#{username}:service_url", endpoint_url)
+            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','salesforce','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
+
+
+{"result"=>{"metadataServerUrl"=>"https://na3-api.salesforce.com/services/Soap/m/22.0/00D50000000Iyfx", 
+            "passwordExpired"=>"false", 
+            "sandbox"=>"false", 
+            "serverUrl"=>"https://na3-api.salesforce.com/services/Soap/c/22.0/00D50000000Iyfx", 
+            "sessionId"=>"00D50000000Iyfx!ARwAQHbIfRD2GDMENzerpqNEYhbArnxFZjjfdHJAakSRy0pfqjqAZfwxCaBlUB8b2kQ0UQlKlUOi1F9isT5BUEczvvFnXq4r", 
+            "userId"=>"00550000001J8xJAAS", 
+            "userInfo"=>{"accessibilityMode"=>"false", "currencySymbol"=>"$", "orgAttachmentFileSizeLimit"=>"5242880", 
+              "orgDefaultCurrencyIsoCode"=>"USD", "orgDisallowHtmlAttachments"=>"false", "orgHasPersonAccounts"=>"false", 
+              "organizationId"=>"00D50000000IyfxEAC", "organizationMultiCurrency"=>"false", "organizationName"=>"Rhomobile", "profileId"=>"00e50000001876vAAA", 
+              "roleId"=>{"xsi:nil"=>"true"}, "sessionSecondsValid"=>"7200", "userDefaultCurrencyIsoCode"=>{"xsi:nil"=>"true"}, 
+              "userEmail"=>"brian@rhomobile.com", "userFullName"=>"Brian Moore", 
+              "userId"=>"00550000001J8xJAAS", "userLanguage"=>"en_US", "userLocale"=>"en_US", "userName"=>"brian@rhomobile.com", 
+              "userTimeZone"=>"America/Los_Angeles", "userType"=>"Standard", "userUiSkin"=>"Theme3"}}}
+

data/generators/crm/vendor/salesforce/settings/Account.yml

@@ -0,0 +1,53 @@
+Query_Fields:
+    # This is just a sample list of fields 
+    # that are used in Query request
+    Id:
+        Label: Id
+        Type: id
+    Name:
+        Label: Account Name
+        Type: textinput
+    Type:
+        Label: Account Type
+        Type: Picklist
+    Industry:
+        Label: Industry
+        Type: Picklist
+    Ownership:
+        Label: Ownership
+        Type: Picklist
+    AnnualRevenue:
+        Label: Annual Revenue
+        Type: textinput
+    NumberOfEmployees:
+        Label: Number Of Employees
+        Type: textinput
+    Phone:
+        Label: Phone
+        Type: textinput
+    Website:
+        Label: Website
+        Type: textinput
+    BillingStreet:
+        Label: Billing Street
+        Type: textinput
+    BillingCity:
+        Label: Billing City
+        Type: textinput
+    BillingState:
+        Label: Billing State
+        Type: textinput
+    BillingPostalCode:
+        Label: Billing Postal Code
+        Type: textinput
+    BillingCountry:
+        Label: Billing Country
+        Type: textinput
+
+ObjectFields:
+    # these are reference fields to the other objects
+
+TitleFields:
+    # these fields are concatenated to show the record
+    # in the Index form
+    - Name

data/generators/crm/vendor/salesforce/settings/Contact.yml

@@ -0,0 +1,61 @@
+Query_Fields:
+    # This is just a sample list of fields 
+    # that are used in Query request
+    Id:
+        Label: Id
+        Type: id
+    Salutation:
+        Label: Salutation
+        Type: Picklist
+    FirstName:
+        Label: First Name
+        Type: textinput
+    LastName:
+        Label: Last Name
+        Type: textinput
+    Title:
+        Label: Title
+        Type: textinput
+    Email:
+        Label: Email
+        Type: textinput
+    Phone:
+        Label: Phone
+        Type: textinput
+    MailingStreet:
+        Label: Mailing Street
+        Type: textinput
+    MailingCity:
+        Label: Mailing City
+        Type: textinput
+    MailingState:
+        Label: Mailing State
+        Type: textinput
+    MailingPostalCode:
+        Label: Mailing Postal Code
+        Type: textinput
+    MailingCountry:
+        Label: Mailing Country
+        Type: textinput
+    LeadSource:
+        Label: Lead Source
+        Type: Picklist
+    Description:
+        Label: Description
+        Type: textarea
+    AccountId:
+        Lable: Account Id
+        Type: object
+        Object: Account    
+    
+ObjectFields:
+    # these are reference fields to the other objects
+    AccountId:
+
+TitleFields:
+    # these fields are concatenated to show the record
+    # in the Index form
+    - FirstName
+    - LastName
+     
+     

data/generators/crm/vendor/salesforce/settings/GenericObject.yml

@@ -0,0 +1,13 @@
+Query_Fields:
+    # This is just a sample list of fields 
+    # that are used in Query request
+    Id:
+        Label: Id
+        Type: id
+
+ObjectFields:
+    # these are reference fields to the other objects
+
+TitleFields:
+    # these fields are concatenated to show the record
+    # in the Index form

data/generators/crm/vendor/salesforce/settings/Lead.yml

@@ -0,0 +1,73 @@
+Query_Fields:
+    # This is just a sample list of fields 
+    # that are used in Query request
+    Id:
+        Label: Id
+        Type: id
+    Salutation:
+        Label: Salutation
+        Type: Picklist
+    FirstName:
+        Label: First Name
+        Type: textinput
+    LastName:
+        Label: Last Name
+        Type: textinput
+    Title:
+        Label: Title
+        Type: textinput
+    Company:
+        Label: Company
+        Type: textinput
+    Industry:
+        Label: Industry
+        Type: Picklist
+    AnnualRevenue:
+        Label: Annual Revenue
+        Type: textinput
+    NumberOfEmployees:
+        Label: Number Of Employees
+        Type: textinput
+    Street:
+        Label: Street
+        Type: textinput
+    City:
+        Label: City
+        Type: textinput
+    State:
+        Label: State
+        Type: textinput
+    PostalCode:
+        Label: Postal Code
+        Type: textinput
+    Country:
+        Label: Country
+        Type: textinput
+    Email:
+        Label: Email
+        Type: textinput
+    Phone:
+        Label: Phone
+        Type: textinput
+    Description:
+        Label: Description
+        Type: textarea
+    LeadSource:
+        Label: Lead Source
+        Type: Picklist
+    Status:
+        Label: Status
+        Type: Picklist
+    Rating:
+        Label: Rating
+        Type: Picklist
+
+
+ObjectFields:
+    # these are reference fields to the other objects
+
+TitleFields:
+    # these fields are concatenated to show the record
+    # in the Index form
+    - FirstName
+    - LastName

data/generators/crm/vendor/salesforce/settings/Opportunity.yml

@@ -0,0 +1,48 @@
+Query_Fields:
+    # This is just a sample list of fields 
+    # that are used in Query request
+    Id:
+        Label: Id
+        Type: id
+    Name:
+        Label: Opportunity Name
+        Type: textinput
+    AccountId:
+        Label: Account Id
+        Type: object
+        Object: Account
+    StageName:
+        Label: Stage
+        Type: Picklist
+    Amount:
+        Label: Amount
+        Type: textarea
+    Probability:
+        Label: Probability
+        Type: textarea
+    CloseDate:
+        Label: Close Date
+        Type: datetime
+    Type:
+        Label: Opportunity Type
+        Type: Picklist
+    NextStep:
+        Label: Next Step
+        Type: textinput
+    LeadSource:
+        Label: Lead Source
+        Type: Picklist
+    Description:
+        Label: Description
+        Type: textarea
+    
+
+ObjectFields:
+    # these are reference fields to the other objects
+    AccountId:
+
+TitleFields:
+    # these fields are concatenated to show the record
+    # in the Index form
+    - Name
+

data/generators/crm/vendor/salesforce/settings/settings.yml

@@ -0,0 +1,6 @@
+:test: 
+  :salesforce_login_url: https://login.salesforce.com/services/Soap/c/22.0
+:production: 
+  :salesforce_login_url: https://login.salesforce.com/services/Soap/c/22.0
+:development:
+  :salesforce_login_url: https://login.salesforce.com/services/Soap/c/22.0

data/generators/crm/vendor/salesforce/spec/application_spec.rb

@@ -0,0 +1,14 @@
+require File.join(File.dirname(__FILE__),'spec_helper')
+
+describe "Application" do
+  it_should_behave_like "SpecHelper" do
+    it "should authenticate" do 
+      Application.authenticate(@test_user,@test_password,nil).should be_true
+    end
+    
+    it "should not authenticate with wrong credentials" do
+      Application.should_receive(:warn).once.with(/Can't authenticate user wrong_user: 500 Internal Server Error/)
+      Application.authenticate('wrong_user','wrong_password',nil).should be_false
+    end
+  end
+end