rhoconnect 3.0.0.beta1

data/examples/simple/config.ru

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+path = File.join(File.dirname(__FILE__),'..','..','lib')
+$:.unshift path
+
+# Try to load vendor-ed rhoconnect, otherwise load the gem
+begin
+  require 'vendor/rhoconnect/lib/rhoconnect/server'
+  require 'vendor/rhoconnect/lib/rhoconnect/console/server'
+rescue LoadError
+  require 'rhoconnect/server'
+  require 'rhoconnect/console/server'
+end
+
+require 'x_domain_session_wrapper'
+use XDomainSessionWrapper
+
+# By default, turn on the resque web console
+require 'resque/server'
+
+ROOT_PATH = File.expand_path(File.dirname(__FILE__))
+
+# Rhoconnect server flags
+Rhoconnect::Server.disable :run
+Rhoconnect::Server.disable :clean_trace
+Rhoconnect::Server.enable  :raise_errors
+Rhoconnect::Server.set     :root,        ROOT_PATH
+Rhoconnect::Server.enable  :stats
+Rhoconnect::Server.set     :secret, '3ddaa72a36466bae3fc5e54c09324db50cfc30588d8dee1a2700e61195bdbbb5eeb65da2a184d274ce644b20b0e986046c2447730c85555ce18a4eb2fce7ebf5'
+Rhoconnect::Server.use     Rack::Static, :urls => ["/data"], :root => Rhoconnect::Server.root
+                     
+# configure Cross-Domain Resource Sharing
+require 'cors'
+use Rack::Cors do |cfg|
+  cfg.allow do |allow|
+    allow.origins /.*/
+    allow.resource '/application',   :headers => :any, :methods => [:get, :post, :put, :delete], :credentials => true
+    allow.resource '/application/*', :headers => :any, :methods => [:get, :post, :put, :delete], :credentials => true
+  end
+end                     
+                           
+# Load our rhoconnect application
+require './application'
+
+# Setup the url map
+run Rack::URLMap.new \
+	"/"         => Rhoconnect::Server.new,
+	"/resque"   => Resque::Server.new, # If you don't want resque frontend, disable it here
+	"/console"  => RhoconnectConsole::Server.new # If you don't want rhoconnect frontend, disable it here

data/examples/simple/settings/license.key

@@ -0,0 +1 @@
+858fc60fadfde40273d0ac505906969318aa4931d1a2c4aeb24d98393c74379f60e226651601969874257f7f1fbda9b099ecd551a641519aa46819947fda0191

data/examples/simple/settings/settings.yml

@@ -0,0 +1,23 @@
+:sources:
+  SimpleAdapter:
+    :poll_interval: 300
+  SampleAdapter:
+    :partition_type: app    
+    :poll_interval: 500
+
+:development:
+  :licensefile: settings/license.key
+  :redis: localhost:6379
+  :syncserver: http://localhost:9292/api/application/
+  :api_token: sometokenforme
+:test: 
+  :licensefile: settings/license.key
+  :redis: localhost:6379
+  :syncserver: http://localhost:9292/api/application/
+  :api_token: sometokenforme
+:production: 
+  :licensefile: settings/license.key
+  :redis: localhost:6379
+  :syncserver: http://localhost:9292/api/application/
+  :api_token: sometokenforme
+  

data/examples/simple/sources/sample_adapter.rb

@@ -0,0 +1,5 @@
+class SampleAdapter < SourceAdapter
+  def initialize(source)
+    super(source)
+  end
+end

data/examples/simple/sources/simple_adapter.rb

@@ -0,0 +1,5 @@
+class SimpleAdapter < SourceAdapter
+  def initialize(source)
+    super(source)
+  end
+end

data/generators/rhoconnect.rb

@@ -0,0 +1,119 @@
+require 'rubygems'
+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 
+    
+    alias_method :module_name, :class_name
+  end
+  
+  class AppGenerator < BaseGenerator
+    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|
+      require 'securerandom' rescue nil
+      @secret = SecureRandom.hex(64) rescue '<changeme>'
+      template.source = 'config.ru'
+      template.destination = "#{name}/config.ru"
+    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"
+    end
+    
+    template :spec_helper do |template|
+      template.source = 'spec/spec_helper.rb'
+      template.destination = "#{name}/spec/spec_helper.rb"
+    end
+  end
+  
+  class SourceGenerator < BaseGenerator
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates', 'source')
+    end
+
+    desc <<-DESC
+      Generates a new source adapter.
+      
+      Required:
+        name        - source name(i.e. product)
+    DESC
+
+    first_argument :name, :required => true, :desc => "source name"
+
+    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|
+      template.source = 'source_spec.rb'
+      template.destination = "spec/sources/#{underscore_name}_spec.rb"
+    end
+  end
+  
+  add :app, AppGenerator
+  add :source, SourceGenerator
+end

data/generators/templates/application/Gemfile

@@ -0,0 +1,21 @@
+source 'http://rubygems.org'
+
+gem 'rhoconnect', '<%=gem_version%>'
+
+gem 'warbler', "~> 1.3.0", :platforms => :jruby
+
+group :development do
+  # By default to run application thin web server is used
+  gem 'thin', :platforms => :ruby
+
+  # For jruby trinidad JRuby web server is used
+  gem 'trinidad',  :platforms => :jruby
+  # Alternative for jruby
+  # gem 'jetty-rackup',  :platforms => :jruby
+end
+
+group :test do
+  gem 'rack-test', '>= 0.5.3', :require => "rack/test"
+  gem 'rspec', '~> 2.6.0'
+  gem 'rcov', '>= 0.9.8'
+end

data/generators/templates/application/Rakefile

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler/setup'
+
+begin
+  require 'vendor/rhoconnect/lib/rhoconnect/tasks'
+  require 'vendor/rhoconnect/lib/rhoconnect'
+rescue LoadError
+  require 'rhoconnect/tasks'
+  require 'rhoconnect'
+end
+
+ROOT_PATH = File.expand_path(File.dirname(__FILE__))
+
+begin
+  require 'resque/tasks'
+  task "resque:setup" do
+    require 'application'
+  end
+rescue LoadError
+  puts "Resque not available. Install it with: "
+  puts "gem install resque\n\n"
+end

data/generators/templates/application/application.rb

@@ -0,0 +1,39 @@
+class Application < Rhoconnect::Base
+  class << self
+    def authenticate(username,password,session)
+      true # do some interesting authentication 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)
+
+# Support passenger smart spawning/fork mode:
+if defined?(PhusionPassenger)
+  PhusionPassenger.on_event(:starting_worker_process) do |forked|
+    if forked
+      # We're in smart spawning mode.
+      Store.db.client.reconnect
+    else
+      # We're in conservative spawning mode. We don't need to do anything.
+    end
+  end
+end

data/generators/templates/application/config.ru

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'bundler'
+Bundler.require
+
+# Try to load vendor-ed rhoconnect, otherwise load the gem
+begin
+  require 'vendor/rhoconnect/lib/rhoconnect/server'
+  require 'vendor/rhoconnect/lib/rhoconnect/console/server'
+rescue LoadError
+  require 'rhoconnect/server'
+  require 'rhoconnect/console/server'
+end
+
+# By default, turn on the resque web console
+require 'resque/server'
+
+ROOT_PATH = File.expand_path(File.dirname(__FILE__))
+
+# Rhoconnect server flags
+Rhoconnect::Server.disable :run
+Rhoconnect::Server.disable :clean_trace
+Rhoconnect::Server.enable  :raise_errors
+Rhoconnect::Server.set     :secret,      '<%= @secret %>'
+Rhoconnect::Server.set     :root,        ROOT_PATH
+Rhoconnect::Server.use     Rack::Static, :urls => ["/data"], :root => Rhoconnect::Server.root
+
+# Load our rhoconnect application
+$:.unshift ROOT_PATH if RUBY_VERSION =~ /1.9/ # FIXME: see PT story #16682771
+require 'application'
+
+# Setup the url map
+run Rack::URLMap.new \
+	"/"         => Rhoconnect::Server.new,
+	"/resque"   => Resque::Server.new, # If you don't want resque frontend, disable it here
+	"/console"  => RhoconnectConsole::Server.new # If you don't want rhoconnect frontend, disable it here

data/generators/templates/application/settings/license.key

@@ -0,0 +1 @@
+858fc60fadfde40273d0ac505906969318aa4931d1a2c4aeb24d98393c74379f60e226651601969874257f7f1fbda9b099ecd551a641519aa46819947fda0191

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

@@ -0,0 +1,14 @@
+:sources: 
+
+:development:
+  :licensefile: settings/license.key
+  :redis: localhost:6379
+  :syncserver: http://localhost:9292/api/application/
+:test:
+  :licensefile: settings/license.key
+  :redis: localhost:6379
+  :syncserver: http://localhost:9292/api/application/
+:production: 
+  :licensefile: settings/license.key
+  :redis: localhost:6379
+  :syncserver: http://localhost:9292/api/application/

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

@@ -0,0 +1,42 @@
+require 'rubygems'
+
+# Set environment to test
+ENV['RHO_ENV'] = 'test'
+ROOT_PATH = File.expand_path(File.join(File.dirname(__FILE__),'..'))
+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
+
+shared_examples_for "SpecHelper" do
+  include Rhoconnect::TestMethods
+  
+  before(:each) do
+    Store.db.flushdb
+    Application.initializer(ROOT_PATH)
+  end  
+end

data/generators/templates/source/source_adapter.rb

@@ -0,0 +1,47 @@
+class <%=class_name%> < SourceAdapter
+  def initialize(source) 
+    super(source)
+  end
+ 
+  def login
+    # TODO: Login to your data source here if necessary
+  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"}
+    # }
+    raise SourceAdapterException.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"
+  end
+ 
+  def update(update_hash)
+    # TODO: Update an existing record in your backend data source
+    raise "Please provide some code to update a single record in the backend data source using the update_hash"
+  end
+ 
+  def delete(delete_hash)
+    # TODO: write some code here if applicable
+    # be sure to have a hash key and value for "object"
+    # for now, we'll say that its OK to not have a delete operation
+    # raise "Please provide some code to delete a single object in the backend application using the object_id"
+  end
+ 
+  def logoff
+    # TODO: Logout from the data source if necessary
+  end
+end

data/generators/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