rhoconnect 3.4.5 → 4.0.0.beta.10

data/generators/rhoconnect.rb

@@ -4,96 +4,111 @@ require 'templater'
 module Rhoconnect
   extend Templater::Manifold
   extend Rhoconnect
-  
+
   desc <<-DESC
     Rhoconnect generator
   DESC
-  
+
   class BaseGenerator < Templater::Generator
     def class_name
       name.gsub('-', '_').camel_case
     end
-    
+
     def underscore_name
       Rhoconnect.under_score(name)
     end
 
     def gem_version
       VERSION
-    end 
-    
+    end
+
+    # Callback method to run ERB on destination file
+    def run_erb(action)
+      template = ERB.new(File.read(action.destination))
+      File.open(action.destination, "w") { |f| f << template.result(binding) }
+    end
+
+    def self.install_js_option(klass)
+      klass.option :js, :required => false, :default => false, :desc => "generate JavaScript code", :as => :boolean
+    end
+
+    def self.install_app_options(klass)
+      klass.first_argument :name, :required => true, :desc => "application name"
+      install_js_option(klass)
+    end
+
+    def self.install_source_options(klass)
+      klass.first_argument :name, :required => true, :desc => "source name"
+      install_js_option(klass)
+    end
+
     alias_method :module_name, :class_name
   end
-  
+
   class AppGenerator < BaseGenerator
+    install_app_options(self)
+
     def self.source_root
       File.join(File.dirname(__FILE__), 'templates', 'application')
     end
-    
+
     desc <<-DESC
       Generates a new rhoconnect application.
-      
+
       Required:
         name        - application name
     DESC
-    
-    first_argument :name, :required => true, :desc => "application name"
-    
-    template :configru do |template|
+
+    # 'template' does not work under jruby. Using 'file' and after hook instead
+    file :configru, :after => :run_erb  do |template|
       require 'securerandom' rescue nil
       @secret = SecureRandom.hex(64) rescue '<changeme>'
       template.source = 'config.ru'
       template.destination = "#{name}/config.ru"
-    end    
-    
+    end
+
     template :gitignore do |template|
       template.source = 'gitignore'
       template.destination = "#{name}/.gitignore"
     end
-    
+
     template :settings do |template|
       template.source = 'settings/settings.yml'
       template.destination = "#{name}/settings/settings.yml"
     end
-    
+
     template :license do |template|
       template.source = 'settings/license.key'
       template.destination = "#{name}/settings/license.key"
     end
-    
-    template :application do |template|
-      template.source = 'application.rb'
-      template.destination = "#{name}/application.rb"
-    end
-    
+
     template :rakefile do |template|
       template.source = 'Rakefile'
       template.destination = "#{name}/Rakefile"
     end
-    
-    template :gemfile do |template|
-      template.source = 'Gemfile'
-      template.destination = "#{name}/Gemfile"
+
+    # 'template' does not work under jruby. Using 'file' and after hook instead
+    file :gemfile, :after => :run_erb do |file|
+      file.source = 'Gemfile'
+      file.destination = "#{name}/Gemfile"
     end
-    
+
     template :gemfile_app do |template|
       template.source = 'rcgemfile'
       template.destination = "#{name}/.rcgemfile"
     end
 
-    template :spec_helper do |template|
-      template.source = 'spec/spec_helper.rb'
-      template.destination = "#{name}/spec/spec_helper.rb"
-    end
-
     empty_directory :public do |dir|
       dir.destination = File.join("#{name}", 'public')
     end
 
+    invoke :js_app, :js => true
+    invoke :ruby_app, :js => false
+
     def after_run
       install_gems_note = <<_BUNDLE_INSTALL_
 
-In the future, to ensure that all the dependencies in your rhoconnect application 
+In the future, to ensure that all the dependencies in your rhoconnect application
 are available execute these commands:
     cd #{name} && bundle install
 
@@ -114,49 +129,135 @@ _RUN_BUNDLER
       puts install_gems_note
     end
   end
-  
+
+  class RubyAppGenerator < AppGenerator
+    install_app_options(self)
+
+    template :application do |template|
+      template.source = 'controllers/ruby/application_controller.rb'
+      template.destination = "#{name}/controllers/ruby/application_controller.rb"
+    end
+
+    template :application_spec do |template|
+      template.source = 'spec/application_controller_spec.rb'
+      template.destination = "#{name}/spec/controllers/ruby/application_controller_spec.rb"
+    end
+
+    template :spec_helper do |template|
+      template.source = 'spec/spec_helper.rb'
+      template.destination = "#{name}/spec/spec_helper.rb"
+    end
+  end
+
+  class JsAppGenerator < AppGenerator
+    install_app_options(self)
+
+    file :packagejson, :after => :npm_install do |template|
+      template.source = 'package.json'
+      template.destination = "#{name}/package.json"
+    end
+
+    template :application do |template|
+      template.source = 'controllers/js/application_controller.js'
+      template.destination = "#{name}/controllers/js/application_controller.js"
+    end
+
+    def npm_install(action)
+      npm_install_note = <<_NPM_INSTALL_
+
+In the future, to ensure that all the JavaScript dependencies in your
+rhoconnect application are available execute these commands:
+    cd #{name} && npm install
+
+_NPM_INSTALL_
+      puts npm_install_note
+      FileUtils.chdir(name)
+      system("npm install")
+      FileUtils.chdir('..')
+    end
+  end
+
   class SourceGenerator < BaseGenerator
+    install_source_options(self)
+
     def self.source_root
       File.join(File.dirname(__FILE__), 'templates', 'source')
     end
 
     desc <<-DESC
-      Generates a new source adapter.
-      
+      Generates a new source adapter (Controller/Model pair).
+
       Required:
-        name        - source name(i.e. product)
+        name        - source name (i.e. product)
     DESC
 
-    first_argument :name, :required => true, :desc => "source name"
+    invoke :ruby_source, :js => false
+    invoke :js_source, :js => true
+  end
+
+  class RubySourceGenerator < SourceGenerator
+    install_source_options(self)
 
-    template :source do |template|
-      template.source = 'source_adapter.rb'
-      template.destination = "sources/#{underscore_name}.rb"
+    # 'template' does not work under jruby. Using 'file' and after hook instead
+    file :model, :after => :run_erb do |file|
+      file.source = 'models/ruby/model.rb'
+      file.destination = "models/ruby/#{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]
+      File.open(settings_file, 'w' ) do |f|
+        f.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]
+        f.write envs.to_yaml[3..-1]
         # write all other settings
         [:development, :test, :production, :sources].each do |key|
           settings.delete(key)
         end
-        file.write settings.to_yaml[3..-1] unless settings.empty?
+        f.write settings.to_yaml[3..-1] unless settings.empty?
       end
     end
-    
-    template :source_spec do |template|
-      template.source = 'source_spec.rb'
-      template.destination = "spec/sources/#{underscore_name}_spec.rb"
+
+    file :controller, :after => :run_erb do |file|
+      file.source = 'controllers/ruby/controller.rb'
+      file.destination = "controllers/ruby/#{underscore_name}_controller.rb"
+    end
+
+    # 'template' does not work under jruby. Using 'file' and after hook instead
+    file :model_spec, :after => :run_erb do |file|
+      file.source = 'models/ruby/model_spec.rb'
+      file.destination = "spec/models/ruby/#{underscore_name}_spec.rb"
+    end
+
+    # 'template' does not work under jruby. Using 'file' and after hook instead
+    file :controller_spec, :after => :run_erb do |file|
+      file.source = 'controllers/ruby/controller_spec.rb'
+      file.destination = "spec/controllers/ruby/#{underscore_name}_controller_spec.rb"
     end
   end
-  
+
+  class JsSourceGenerator < SourceGenerator
+    install_source_options(self)
+
+    file :model, :after => :run_erb do |file|
+      file.source = 'models/js/model.js'
+      file.destination = "models/js/#{underscore_name}.js"
+    end
+
+    file :controller, :after => :run_erb do |file|
+      file.source = 'controllers/js/controller.js'
+      file.destination = "controllers/js/#{underscore_name}_controller.js"
+    end
+  end
+
   add :app, AppGenerator
+  add_private :ruby_app, RubyAppGenerator
+  add_private :js_app, JsAppGenerator
+
   add :source, SourceGenerator
+  add_private :ruby_source, RubySourceGenerator
+  add_private :js_source, JsSourceGenerator
 end

data/generators/templates/application/Gemfile

@@ -1,8 +1,8 @@
 source 'http://rubygems.org'
 
 gem 'rhoconnect', '<%=gem_version%>'
-gemfile_path = File.join(File.dirname(__FILE__), ".rcgemfile")
 
+gemfile_path = File.join(File.dirname(__FILE__), ".rcgemfile")
 begin
   eval(IO.read(gemfile_path))
 rescue Exception => e

data/generators/templates/application/Rakefile

@@ -9,9 +9,9 @@ ROOT_PATH = File.expand_path(File.dirname(__FILE__))
 task 'resque:setup' do
   # The number of redis connections you want a job to have
   Rhoconnect.connection_pool_size = 1
-  require './application'
-
+  require 'rhoconnect/application/init'
+  
   Resque.after_fork do
-    Store.db.client.reconnect
+    Store.reconnect
   end
 end

data/generators/templates/application/config.ru

@@ -12,8 +12,5 @@ Rhoconnect::Server.set     :secret,      '<%= @secret %>'
 # uncomment the following line to disable Rhoconnect Front-end console
 #Rhoconnect.disable_rc_console = true
 
-# Load RhoConnect application
-require './application'
-
 # run RhoConnect Application
-run Rhoconnect.app
+run Rhoconnect.app

data/generators/templates/application/controllers/application_controller.rb

@@ -0,0 +1,17 @@
+class ApplicationController < Rhoconnect::Controller::AppBase
+  register Rhoconnect::EndPoint
+
+  post "/login", :rc_handler => :authenticate,
+                 :deprecated_route => {:verb => :post, :url => ['/application/clientlogin', '/api/application/clientlogin']} do
+    login = params[:login]
+    password = params[:password]
+    true # do some interesting authentication here...
+  end
+
+  get "/rps_login", :rc_handler => :rps_authenticate, 
+                    :login_required => true do
+    login = params[:login]
+    password = params[:password]
+    true # optionally handle rhoconnect push authentication...
+  end
+end

data/generators/templates/application/controllers/js/application_controller.js

@@ -0,0 +1,14 @@
+var app = require("ballroom");
+app.controllerName("Application");
+
+app.post("/login",{"rc_handler":"authenticate"}, function(req,resp){
+  var login = req.params.login;
+  var password = req.params.password;
+  resp.send(true);
+});
+
+app.get("/rps_login",{"rc_handler":"rps_authenticate"}, function(req,resp){
+  var login = req.params.login;
+  var password = req.params.password;
+  resp.send(true);
+});

data/generators/templates/application/controllers/ruby/application_controller.rb

@@ -0,0 +1,17 @@
+class ApplicationController < Rhoconnect::Controller::AppBase
+  register Rhoconnect::EndPoint
+
+  post "/login", :rc_handler => :authenticate,
+                 :deprecated_route => {:verb => :post, :url => ['/application/clientlogin', '/api/application/clientlogin']} do
+    login = params[:login]
+    password = params[:password]
+    true # do some interesting authentication here...
+  end
+
+  get "/rps_login", :rc_handler => :rps_authenticate, 
+                    :login_required => true do
+    login = params[:login]
+    password = params[:password]
+    true # optionally handle rhoconnect push authentication...
+  end
+end

data/generators/templates/application/package.json

@@ -0,0 +1,8 @@
+{
+  "name" : "rhoconnect",
+  "version" :"1.0.0",
+  "main": "rhoconnect",
+  "dependencies": {
+    "redis" : "*"
+  }
+}

data/generators/templates/application/rcgemfile

@@ -1,9 +1,6 @@
 # Rhoconnect app runtime dependencies
 # DO NOT edit this file unless you know what are you doing!
 
-# Helps with some of the limitations of green threads, not needed in ruby 1.9.x
-gem 'SystemTimer', '~> 1.2.3', :platforms => :ruby_18
-
 # v0.7.x removes Process.fork, need this version for now
 gem 'win32-process', '= 0.6.6', :platforms => [:mswin, :mingw]
 
@@ -25,8 +22,7 @@ platforms :jruby do
   gem 'jdbc-sqlite3', ">= 3.7.2"
   gem 'dbi', ">= 0.4.5"
   gem 'dbd-jdbc', ">= 0.1.4"
-  gem 'jruby-openssl', ">= 0.7.4"
-  gem 'trinidad'
+  gem 'puma', "~> 1.6.0"
   gem 'warbler'
 end
 
@@ -41,4 +37,5 @@ group :test do
   gem 'rspec', '~> 2.10.0'
   gem 'rack-test', '>= 0.5.3', :require => "rack/test"
   gem 'rhomobile-debug', ">= 1.0.2"
+	gem 'capybara'
 end

data/generators/templates/application/settings/settings.yml

@@ -3,17 +3,17 @@
 :development:
   :licensefile: settings/license.key
   :redis: localhost:6379
-  :syncserver: http://localhost:9292/api/application/
+  :syncserver: http://localhost:9292
   :push_server: http://someappname@localhost:8675/
   :api_token: my-rhoconnect-token
 :test:
   :licensefile: settings/license.key
   :redis: localhost:6379
-  :syncserver: http://localhost:9292/api/application/
+  :syncserver: http://localhost:9292
   :push_server: http://someappname@localhost:8675/
   :api_token: my-rhoconnect-token
 :production:
   :licensefile: settings/license.key
   :redis: localhost:6379
-  :syncserver: http://localhost:9292/api/application/
+  :syncserver: http://localhost:9292
   :push_server: http://someappname@localhost:8675/

data/generators/templates/application/spec/application_controller_spec.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__),'..','..','spec_helper')
+
+describe "ApplicationController" do
+  it_should_behave_like "SpecHelper" do
+  	include Rack::Test::Methods
+  	include Rhoconnect
+
+    def app
+      @app = Rack::URLMap.new Rhoconnect.url_map
+    end
+
+    it "should process ApplicationController /login" do
+      post "/rc/#{Rhoconnect::API_VERSION}/app/login", {"login" => 'testuser', "password" => ''}.to_json, 
+            {'CONTENT_TYPE'=>'application/json; charset=UTF-8'}
+      last_response.status.should == 200
+    end
+
+    it "should process ApplicationController /rps_login" do
+      pending
+    end
+
+  end  
+end

data/generators/templates/application/spec/js_spec.rb

@@ -0,0 +1,25 @@
+require File.join(File.dirname(__FILE__),'..','spec_helper')
+
+describe "<%=class_name%>", :type => :feature do
+  it_should_behave_like "SpecHelper" do
+    before :each do
+      setup_test_for '<%=class_name%>','testuser'
+    end
+  
+    it "queries <%=class_name%>" do
+    
+    end
+  
+    it "creates <%=class_name%>" do
+    
+    end
+  
+    it "updates <%=class_name%>" do
+    
+    end
+  
+    it "deletes <%=class_name%>" do
+    
+    end
+  end
+end

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

@@ -13,17 +13,31 @@ rescue LoadError
 end
 
 $:.unshift File.join(File.dirname(__FILE__), "..")
-# Load our rhoconnect application
-require 'application'
 include Rhoconnect
-
+require 'rhoconnect/application/init'
 require 'rhoconnect/test_methods'
 
+require 'capybara'
+require 'capybara/dsl'
+
+Capybara.app = Sinatra::Application
+
+RSpec.configure do |config|
+  config.include Capybara
+end
+
 shared_examples_for "SpecHelper" do
   include Rhoconnect::TestMethods
-  
+
   before(:each) do
-    Store.db.flushdb
-    Application.initializer(ROOT_PATH)
-  end  
+    Store.create
+    Store.flush_all
+    Rhoconnect.bootstrap(ROOT_PATH)
+
+    # setup server's test settings
+    Rhoconnect::Server.set :environment, :test
+    Rhoconnect::Server.set :run, false
+    Rhoconnect::Server.set :use_async_model, false
+    Rhoconnect::Server.set :secret, "secure!"
+  end
 end

data/generators/templates/source/controllers/js/controller.js

@@ -0,0 +1,7 @@
+var app = require("ballroom");
+var helpers = require("rhoconnect_helpers");
+
+app.controllerName("<%=class_name%>");
+app.registerHandler("sync");
+
+// Add your custom routes here

data/generators/templates/source/controllers/ruby/controller.rb

@@ -0,0 +1,8 @@
+class <%=class_name%>Controller < Rhoconnect::Controller::Base
+  register Rhoconnect::EndPoint
+
+  # register SYNC routes
+  register Rhoconnect::Handler::Sync
+
+  # add your custom routes here
+end

data/generators/templates/source/controllers/ruby/controller_spec.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__),'..','..','spec_helper')
+
+describe "<%=class_name%>Controller" do
+  it_should_behave_like "SpecHelper" do
+  	include Rack::Test::Methods
+  	include Rhoconnect
+
+    def app
+      @app = Rack::URLMap.new Rhoconnect.url_map
+    end
+
+    before(:each) do
+      setup_test_for <%=class_name%>,'testuser'
+      # login user to establish session cookie before each test
+      post "/rc/#{Rhoconnect::API_VERSION}/app/login", {"login" => 'testuser', "password" => ''}.to_json, {'CONTENT_TYPE'=>'application/json; charset=UTF-8'}
+      last_response.status.should == 200
+    end
+
+    it "should process <%=class_name%>Controller GET" do
+      pending
+    end
+
+    it "should process <%=class_name%>Controller POST" do
+      pending
+    end
+  end  
+end

data/generators/templates/source/models/js/model.js

@@ -0,0 +1,46 @@
+var <%=class_name%> = function() {
+
+  this.login = function(resp){
+    // TODO: Login to your data source here if necessary
+    resp.send(true);
+  };
+
+  this.query = function(resp){
+    var result = {};
+    // TODO: Query your backend data source and assign the records
+    // to a nested hash structure. Then return your result.
+    // For example:
+    //
+    // {
+    //   "1": {"name": "Acme", "industry": "Electronics"},
+    //   "2": {"name": "Best", "industry": "Software"}
+    // }
+    resp.send(result);
+  };
+
+  this.create = function(resp){
+    // TODO: Create a new record in your backend data source.  Then
+    // return the result.
+    resp.send('someId');
+  };
+
+  this.update = function(resp){
+    // TODO: Update an existing record in your backend data source.
+    // Then return the result.
+    resp.send(true);
+  };
+
+  this.del = function(resp){
+    // TODO: Delete an existing record in your backend data source
+    // if applicable.  Be sure to have a hash key and value for
+    // "object" and return the result.
+    resp.send(true);
+  };
+
+  this.logoff = function(resp){
+    // TODO: Logout from the data source if necessary.
+    resp.send(true);
+  };
+};
+
+module.exports = new <%=class_name%>();

data/generators/templates/source/{source_adapter.rb → models/ruby/model.rb}

@@ -1,4 +1,4 @@
-class <%=class_name%> < SourceAdapter
+class <%=class_name%> < Rhoconnect::Model::Base
   def initialize(source) 
     super(source)
   end
@@ -14,16 +14,9 @@ class <%=class_name%> < SourceAdapter
     #   "1"=>{"name"=>"Acme", "industry"=>"Electronics"},
     #   "2"=>{"name"=>"Best", "industry"=>"Software"}
     # }
-    raise SourceAdapterException.new("Please provide some code to read records from the backend data source")
+    raise Rhoconnect::Model::Exception.new("Please provide some code to read records from the backend data source")
   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 create(create_hash)
     # TODO: Create a new record in your backend data source
     raise "Please provide some code to create a single record in the backend data source using the create_hash"
@@ -44,4 +37,16 @@ class <%=class_name%> < SourceAdapter
   def logoff
     # TODO: Logout from the data source if necessary
   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
+  #
+  # Uncomment this code and override it 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

data/generators/templates/source/{source_spec.rb → models/ruby/model_spec.rb}

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__),'..','spec_helper')
+require File.join(File.dirname(__FILE__),'..','..','spec_helper')
 
 describe "<%=class_name%>" do
   it_should_behave_like "SpecHelper" do