rhoconnect-adapters 1.0.0.beta1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/CHANGELOG

@@ -0,0 +1,4 @@
+## 0.1.0
+
+* #15178091 - Integration of OracleCRM backend, specs for generator
+* #14613211 - Initial creation of the rhoconnect-adapters

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rhoconnect-adapters.gemspec
+gemspec
+gem 'rake'
+
+group :test do
+  gem 'rspec', '~> 2.6.0'
+  gem 'rcov', '>= 0.9.8'
+  gem 'sugarcrm', '>= 0.9.15'
+end
+
+group :development do
+  gem 'rspec', '~> 2.6.0'
+  gem 'rcov', '>= 0.9.8'
+  gem 'sugarcrm', '>= 0.9.15'
+end
+

data/README.md

@@ -0,0 +1,239 @@
+rhoconnect-adapters
+===
+
+rhoconnect-adapters is a ruby library containing a collection of the out-of-box [RhoConnect](http://rhomobile.com/products/rhoconnect) applications 
+for various needs.  
+
+With rhoconnect-adapters, you can utilize the pre-built set of [RhoConnect](http://rhomobile.com/products/rhoconnect/) applications 
+for popular CRM backends (SalesForce, Oracle CRM On Demand, Sugar CRM, etc.). Also, this library includes support for writing your own [RhoConnect](http://rhomobile.com/products/rhoconnect/)
+CRM applications to extend or customize the default functionality.
+
+## Setup
+Install the 'rhoconnect-adapters' gem by using the following command:
+
+	$ [sudo] gem install rhoconnect-adapters
+
+
+## Usage
+The 'rhoconnect-adapters' command creates pre-built [RhoConnect](http://rhomobile.com/products/rhoconnect/) applications.
+Visit the [RhoConnect](http://rhomobile.com/products/rhoconnect/) website for more information.
+
+### Generating Standard CRM Application
+
+To create a standard out-of-the-box rhoconnect CRM application use the following command:
+
+	$ rhoconnect-adapters crmapp <app_name> <CRM-backend>
+
+Here, the \<CRM\-backend\> parameter specifies the CRM backend that your application will use.
+Currently, the following CRM backends are supported:
+
+   - OracleOnDemand (for [Oracle CRM On Demand](http://crmondemand.oracle.com))
+   - MsDynamics (for [Microsoft Dynamics CRM](http://www.microsoft.com/en-us/dynamics/default.aspx))
+   - Salesforce (for [Salesforce CRM](http://www.salesforce.com/))
+   - Sugar (for [Sugar CRM](http://www.sugarcrm.com/crm/))
+
+The generated Rhoconnect CRM application structure will include typical [RhoConnect](http://rhomobile.com/products/rhoconnect/)
+files (for example, application.rb and settings.yml). It will also create a special vendor directory `vendor/\<CRM\-backend\>`
+containing all support files specific for the corresponding CRM backend.
+
+By default, the Rhoconnect CRM application will be generated with four standard source adapters corresponding
+to the following CRM objects:
+	
+	- Account
+	- Contact
+	- Lead
+	- Opportunity
+
+
+### Generating CRM Application without pre-built source adapters
+
+In some cases, it is necessary to generate an application without any standard sources.
+For this purpose, use the `--bare` option to generate just the application's skeleton.
+
+	rhoconnect-adapters crmapp <app_name> <CRM-backend> --bare
+	
+	
+### Generating CRM source adapters for the Rhoconnect CRM application
+
+Once you create your Rhoconnect CRM application, you can generate the desired source adapters
+based on the CRM objects by typing the following command in your application's directory:
+
+	rhoconnect-adapters crmsource <CRM-object-name> <CRM-backend>
+	
+Here, \<CRM\-object\-name\> must exactly correspond to the name of the CRM object you're trying to
+build the source adapter for.
+
+## Preparing the Rhoconnect CRM Application
+
+### OracleOnDemand settings
+All OracleOnDemand-specific settings are located in the `vendor/oracle_on_demand/settings` directory.
+In the file `settings.yml` you'll find the entries that you must customize before running the app.
+These are:
+
+- **:oraclecrm_service_url:** <oracle_web_services_integration_url> - substitute the default URL with your OracleOnDemand account URL.
+
+For every source adapter based on CRM object there is a corresponding *'vendor/oracle_on_demand/settings/\<CRM\-object\-name\>.yml'*
+file containing the descriptions for the OracleOnDemand CRM object.
+Every CRM object file has the following entries:
+
+	Query_Fields: hash of the objects's fields 
+			(each field's element has the value 
+			 in a form of the hash with the field's options , 
+			containing the following data):
+      	Label => <val> - display name of the field
+      	Type => <val> - type of the field data 
+			(textinput, textarea, Picklist, id, etc.)
+			
+	NonQuery_MappingWS_Fields: object's fields that can not be used
+	 		in OracleCRM Queries 
+			(however, Oracle returns them in GetMapping API)
+
+	StaticPickList: Normally, all picklist fields are queried 
+			for the allowed values using GetPicklistValues API
+            However, for certain fields OracleCRM API 
+			returns the error 'not a valid picklist'
+            This entry is a workaround for this error - 
+			fields's picklist values are statically hard-coded here.
+
+	ObjectFields: this one specifies a hash of fields 
+			that are actually references to other objects. 
+         	For example, AccountName field for Contact object 
+			is really a reference to the corresponding Account object.'
+	
+	TitleFields: this setting specifies an array of fields
+				used in constructing the object's title in the 'Show' page
+				using the Metadata method. Typically, you will want to put 
+				`name` fields in here.
+
+For the default generated CRM object adapters, this file is pre-filled with information. However, you can customize it by including or excluding
+options. For custom adapters, you need to fill this file with relevant information. List of object's fields, for example, can be obtained
+from the Oracle CRM On Demand documentation and then later used to fill the Query_Fields setting. Alternatively, user can customize the adapter and obtain 
+the list of fields using the GetMapping API.
+ 
+
+### MsDynamics settings
+All MsDynamics-specific settings are located in the **'vendor/ms_dynamics/settings'** directory.
+In the file *'settings.yml'* you'll find the entries that are necessary to customize before running the app.
+These are:
+
+- **:msdynamics_ticket_url:** <msdynamics_web_services_integration_url> - substitute the default URL with your MsDynamics account URL.
+
+For every source adapter based on CRM object there is a corresponding *'vendor/msdynamics/settings/\<CRM\-object\-name\>.yml'*
+file containing the descriptions for the Sugar CRM object.
+Every CRM object file has the following entries:
+
+	Query_Fields: hash of the objects's fields 
+			(each field's element has the value 
+			 in a form of the hash with the field's options , 
+			containing the following data):
+      	Label => <val> - display name of the field
+      	Type => <val> - type of the field data 
+			(textinput, textarea, Picklist, id, etc.)
+	
+	AttributeTypePicklists: this is a hash of picklist arrays
+			for artificially constructed fields
+	    	that are really represent some other field's type
+			for example, `customerid` field can be either
+			`account` or `contact`. In this case
+			field `customertype_attrtype` will represent `customerid` field's type
+			and will take values from the `AttributeTypePicklists`
+			array for the field `customerid_attrtype`
+
+	ObjectFields: this one specifies a hash of fields 
+			that are actually references to other objects. 
+         	For example, `account_name` field for Contact object 
+			is really a reference to the corresponding Account object.
+	
+	TitleFields: this setting specifies an array of fields
+				used in constructing the object's title in the 'Show' page
+				using the Metadata method. Typically, you will want to put 
+				`name` fields in here.
+
+For the default generated CRM object adapters, this file is pre-filled with information. However, you can customize it by including or excluding
+options. For custom adapters, you need to fill this file with relevant information. List of object's fields, for example, can be obtained
+from the MsDynamics documentation and then later used to fill the Query_Fields setting. Alternatively, user can customize the adapter and obtain 
+the desired list of object's fields using the MsDynamics SOAP API.
+
+### Sugar settings
+All Sugar-specific settings are located in the **'vendor/sugar/settings'** directory.
+In the file *'settings.yml'* you'll find the entries that are necessary to customize before running the app.
+These are:
+
+- **:sugarcrm_uri:** <oracle_web_services_integration_url> - substitute the default URL with your OracleOnDemand account URL.
+- **:debug_enabled:** <true/false> - enable debug output of the backend HTTP transactions.
+
+For every source adapter based on CRM object there is a corresponding *'vendor/sugar/settings/\<CRM\-object\-name\>.yml'*
+file containing the descriptions for the Sugar CRM object.
+Every CRM object file has the following entries:
+
+	Query_Fields: hash of the objects's fields 
+			(each field's element has the value 
+			 in a form of the hash with the field's options , 
+			containing the following data):
+      	Label => <val> - display name of the field
+      	Type => <val> - type of the field data 
+			(textinput, textarea, Picklist, id, etc.)
+
+	ObjectFields: this one specifies a hash of fields 
+			that are actually references to other objects. 
+         	For example, `account_name` field for Contact object 
+			is really a reference to the corresponding Account object.
+	
+	TitleFields: this setting specifies an array of fields
+				used in constructing the object's title in the 'Show' page
+				using the Metadata method. Typically, you will want to put 
+				`name` fields in here.
+
+For the default generated CRM object adapters, this file is pre-filled with information. However, you can customize it by including or excluding
+options. For custom adapters, you need to fill this file with relevant information. List of object's fields, for example, can be obtained
+from the SugarCRM documentation and then later used to fill the Query_Fields setting. Alternatively, user can customize the adapter and obtain 
+the desired list of object's fields using the SugarCRM REST API.
+
+### Salesforce settings
+All Salesforce-specific settings are located in the `vendor/salesforce/settings` directory.
+In the file `settings.yml` you'll find the entries that you must customize before running the app.
+These are:
+
+- **:salesforce_login_url:** <salesforce_soap_login_url> - Currently, this parameter is pre-defined to 
+`https://login.salesforce.com/services/Soap/c/22.0` for simple SOAP web service authentication. 
+Rhoconnect-adapters is not using `OAuth2` scheme at this point.
+
+For every source adapter based on CRM object there is a corresponding *'vendor/salesforce/settings/\<CRM\-object\-name\>.yml'*
+file containing the descriptions for the OracleOnDemand CRM object.
+Every CRM object file has the following entries:
+
+	Query_Fields: hash of the objects's fields 
+			(each field's element has the value 
+			 in a form of the hash with the field's options , 
+			containing the following data):
+      	Label => <val> - display name of the field
+      	Type => <val> - type of the field data 
+			(textinput, textarea, Picklist, datetime, id, etc.)
+			
+	ObjectFields: this one specifies a hash of fields 
+			that are actually references to other objects. 
+         	For example, AccountId field for Contact object 
+			is really a reference to the corresponding Account object.'
+	
+	TitleFields: this setting specifies an array of fields
+				used in constructing the object's title in the 'Show' page
+				using the Metadata method. Typically, you will want to put 
+				`name` fields in here.
+
+For the default generated CRM object adapters, this file is pre-filled with sample information. However, you can customize it by including or excluding
+different fields. For custom adapters, you need to fill this file with relevant information. List of object's fields, for example, can be obtained
+from the Salesforce documentation and then later used to fill the Query_Fields setting. Alternatively, user can customize the adapter and obtain 
+the list of fields using the `/sobjects/\<CRM\-object\-name\>/describe/` API.
+
+
+## Running the CRM Application
+Once your Rhoconnect application is customized and ready to run, you can start it like any other Rhoconnect app.
+Type the following command in the CRM application's root directory:
+
+	rake rhoconnect:start
+	
+
+## Meta
+Created and maintained by Rhomobile Inc.
+
+Released under the [MIT License](http://www.opensource.org/licenses/mit-license.php).

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'bundler'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+require 'rcov/rcovtask'
+       
+TYPES = { 
+  :gen   => 'spec/generator/*_spec.rb',
+  :oracle => 'spec/apps/oracle_on_demand*_spec.rb',
+  :ms => 'spec/apps/ms_dynamics*_spec.rb',
+  :sugar => 'spec/apps/sugar*_spec.rb',
+  :salesforce => 'spec/apps/salesforce*_spec.rb'
+}
+
+TYPES.each do |type,files|
+  desc "Run specs in #{files}"
+  RSpec::Core::RakeTask.new("spec:#{type}") do |t|
+    t.rspec_opts = ["-b", "-c", "-fd"]
+    t.pattern = FileList[TYPES[type]]
+  end
+end
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new("spec:all") do |t|
+  t.rspec_opts = ["-b", "-c", "-fd"]
+  t.pattern = FileList[TYPES.values]
+end
+
+task :default => 'spec:all'

data/bin/rhoconnect-adapters

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'templater'
+
+require File.join(File.dirname(__FILE__), '..','generators','rhoconnect-adapters')
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+require File.join(File.dirname(__FILE__), '..','lib','rhoconnect-adapters')
+
+# Stub this method to force 1.8 compatibility (come on templater!)
+class Encoding
+  def find
+    "utf-8"
+  end
+
+  def dummy?
+    false
+  end
+end
+
+class String
+  def force_encoding(enc)
+    return self
+  end
+  def encoding
+    if RUBY_VERSION =~ /1\.8/ and Encoding.responds_to?('new')
+      Encoding.new
+    else
+      Encoding.default_external
+    end
+  end
+end
+
+RhoconnectAdapters.run_cli(Dir.pwd, 'rhoconnect-adapters', RhoconnectAdapters::VERSION, ARGV)
+

data/generators/crm/templates/application/application.rb

@@ -0,0 +1,34 @@
+require 'vendor/<%=underscore_crm%>/application'
+
+class Application < RhoconnectAdapters::CRM::<%=crm_name%>::Application
+  class << self
+    def backend
+      '<%=underscore_crm%>'
+    end
+    
+    def authenticate(username,password,session=nil)
+      super(username, password, session) 
+      # override the default behaviour here
+    end
+    
+    # Add hooks for application startup here
+    # Don't forget to call super at the end!
+    def initializer(path)
+      super
+    end
+    
+    # Calling super here returns rack tempfile path:
+    # i.e. /var/folders/J4/J4wGJ-r6H7S313GEZ-Xx5E+++TI
+    # Note: This tempfile is removed when server stops or crashes...
+    # See http://rack.rubyforge.org/doc/Multipart.html for more info
+    # 
+    # Override this by creating a copy of the file somewhere
+    # and returning the path to that file (then don't call super!):
+    # i.e. /mnt/myimages/soccer.png
+    def store_blob(object,field_name,blob)
+      super #=> returns blob[:tempfile]
+    end
+  end
+end
+
+Application.initializer(ROOT_PATH)

data/generators/crm/templates/source/source_adapter.rb

@@ -0,0 +1,10 @@
+require 'vendor/<%=underscore_crm%>/adapter'
+
+class <%=class_name%> < RhoconnectAdapters::CRM::<%=crm_name%>::Adapter
+  def initialize(source)
+    super(source)
+    @crm_object = self.class.name
+    @fields = configure_fields
+  end
+ 
+end

data/generators/crm/templates/source/source_spec.rb

@@ -0,0 +1,25 @@
+require File.join(File.dirname(__FILE__),'..','spec_helper')
+
+describe "<%=class_name%>" do
+  it_should_behave_like "SpecHelper" do
+    before(:each) do
+      setup_test_for <%=class_name%>,'testuser'
+    end
+
+    it "should process <%=class_name%> query" do
+      pending
+    end
+
+    it "should process <%=class_name%> create" do
+      pending
+    end
+
+    it "should process <%=class_name%> update" do
+      pending
+    end
+
+    it "should process <%=class_name%> delete" do
+      pending
+    end
+  end  
+end

data/generators/crm/templates/spec/spec_helper.rb

@@ -0,0 +1,64 @@
+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
+  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
+  end
+  
+  before(:each) do
+    Store.db.flushdb
+    Application.initializer(ROOT_PATH)
+  end  
+end