Browse files

Initial Open N2 commit

  • Loading branch information...
Russell committed Feb 2, 2010
0 parents commit 7753c3a72a57930d1ca797dc664acfc2a0f93716
Showing 3,590 changed files with 373,557 additions and 0 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
@@ -0,0 +1,37 @@
@@ -0,0 +1,3 @@
+load 'deploy' if respond_to?(:namespace) # cap2 differentiator
+Dir['vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
+load 'config/deploy' # remove this line to skip loading any of the default tasks
@@ -0,0 +1,251 @@
+== Welcome to N2
+N2 is the latest and greatest iteration of the Newscloud framework.
+== Getting Started
+1. Clone this application to your machine
+2. copy config/database.yml.sample to config/database.yml and configure your db.
+3. copy config/facebooker.yml.sample to config/facebook.yml and configure your facebook app.
+4. copy config/application_settings.yml.sample to config/application_settings.yml.
+This is your base config file where you set your site specific options related to the framework.
+4.b (optional)
+If you wish to configure outgoing email, copy config/smtp.yml.sample to config/smtp.yml
+and configure your outgoing mail settings. Google hosted email is supported!
+4.c (optional) There are also a number of *.yml.sample files in the config directory for advanced use.
+5. Next check that the gems are setup properly by running
+ rake gems
+If you don't see any error messages then you are good to go. You might have to run:
+ sudo rake gems:build
+ or
+ sudo rake gems:install
+to build the native extensions for some of the gems.
+6. Build the database
+If you have an existing newscloud application you would like to port over, run:
+rake n2:db:convert_and_create_database
+This will prompt you for the old database info and will migrate to the new database.
+This will _not_ harm your existing database, it will create a new database for rails
+and perform the conversions there, leaving your existing application intact.
+If you do not have an existing application you want to convert, simply run:
+rake db:setup
+and this will build the database for you.
+7. Now start the server with:
+ ruby script/server
+and you should be up and running
+8. Next you need to configure the admin interface.
+If you are converting an existing newscloud framework, and you already have
+an admin user account, you can login and access the admin interface just fine.
+As long as there are no existing admin users, there will be a default login account for you to use, which is configurable in your application_settings.yml file.
+By default the admin user is 'admin' and the password is 'n2adminpassword' and you will be prompted for that login when you reach the admin interface.
+First, you need to create a normal account, and then login into the admin interface with the default credentials. From there you can edit your user account and set the is_admin field to true, and then you will have direct access.
+(Optional): You may also now goto the featured items section of the admin interface and select featured items for the home page.
+== Web Servers
+By default, Rails will try to use Mongrel if it's are installed when started with script/server, otherwise Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails
+with a variety of other web servers.
+Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
+suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
+getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
+More info at:
+Say other Ruby web servers like Thin and Ebb or regular web servers like Apache or LiteSpeed or
+Lighttpd or IIS. The Ruby web servers are run through Rack and the latter can either be setup to use
+FCGI or proxy to a pack of Mongrels/Thin/Ebb servers.
+== Apache .htaccess example for FCGI/CGI
+# General Apache options
+AddHandler fastcgi-script .fcgi
+AddHandler cgi-script .cgi
+Options +FollowSymLinks +ExecCGI
+# If you don't want Rails to look in certain directories,
+# use the following rewrite rules so that Apache won't rewrite certain requests
+# Example:
+# RewriteCond %{REQUEST_URI} ^/notrails.*
+# RewriteRule .* - [L]
+# Redirect all requests not available on the filesystem to Rails
+# By default the cgi dispatcher is used which is very slow
+# For better performance replace the dispatcher with the fastcgi one
+# Example:
+# RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
+RewriteEngine On
+# If your Rails application is accessed via an Alias directive,
+# then you MUST also set the RewriteBase in this htaccess file.
+# Example:
+# Alias /myrailsapp /path/to/myrailsapp/public
+# RewriteBase /myrailsapp
+RewriteRule ^$ index.html [QSA]
+RewriteRule ^([^.]+)$ $1.html [QSA]
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
+# In case Rails experiences terminal errors
+# Instead of displaying this message you can supply a file here which will be rendered instead
+# Example:
+# ErrorDocument 500 /500.html
+ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
+== Debugging Rails
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+First area to check is the application log files. Have "tail -f" commands running
+on the server.log and development.log. Rails will automatically display debugging
+and runtime information to these files. Debugging info will also be shown in the
+browser on requests from
+You can also log your own messages directly into the log file from your code using
+the Ruby logger class from inside your controllers. Example:
+ class WeblogController < ActionController::Base
+ def destroy
+ @weblog = Weblog.find(params[:id])
+ @weblog.destroy
+"#{} Destroyed Weblog ID ##{}!")
+ end
+ end
+The result will be a message in your log file along the lines of:
+ Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
+More information on how to use the logger is at
+Also, Ruby documentation can be found at including:
+* The Learning Ruby (Pickaxe) Book:
+* Learn to Program: (a beginners guide)
+These two online (and free) books will bring you up to speed on the Ruby language
+and also on programming in general.
+== Debugger
+Debugger support is available through the debugger command when you start your Mongrel or
+Webrick server with --debugger. This means that you can break out of execution at any point
+in the code, investigate and change the model, AND then resume execution!
+You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'
+ class WeblogController < ActionController::Base
+ def index
+ @posts = Post.find(:all)
+ debugger
+ end
+ end
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+ >> @posts.inspect
+ => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
+ #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+ >> @posts.first.title = "hello from a debugger"
+ => "hello from a debugger"
+...and even better is that you can examine how your runtime objects actually work:
+ >> f = @posts.first
+ => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+ >> f.
+ Display all 152 possibilities? (y or n)
+Finally, when you're ready to resume execution, you enter "cont"
+== Console
+You can interact with the domain model by starting the console through <tt>script/console</tt>.
+Here you'll have all parts of the application configured, just like it is when the
+application is running. You can inspect domain models, change values, and save to the
+database. Starting the script without arguments will launch it in the development environment.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+== dbconsole
+You can go to the command line of your database directly through <tt>script/dbconsole</tt>.
+You would be connected to the database with the credentials defined in database.yml.
+Starting the script without arguments will connect you to the development database. Passing an
+argument will connect you to a different database, like <tt>script/dbconsole production</tt>.
+Currently works for mysql, postgresql and sqlite.
+== Description of Contents
+ Holds all the code that's specific to this particular application.
+ Holds controllers that should be named like weblogs_controller.rb for
+ automated URL mapping. All controllers should descend from ApplicationController
+ which itself descends from ActionController::Base.
+ Holds models that should be named like post.rb.
+ Most models will descend from ActiveRecord::Base.
+ Holds the template files for the view that should be named like
+ weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
+ syntax.
+ Holds the template files for layouts to be used with views. This models the common
+ header/footer method of wrapping views. In your views, define a layout using the
+ <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb,
+ call <% yield %> to render the view using this layout.
+ Holds view helpers that should be named like weblogs_helper.rb. These are generated
+ for you automatically when using script/generate for controllers. Helpers can be used to
+ wrap functionality for your views into methods.
+ Configuration files for the Rails environment, the routing map, the database, and other dependencies.
+ Contains the database schema in schema.rb. db/migrate contains all
+ the sequence of Migrations for your schema.
+ This directory is where your application documentation will be stored when generated
+ using <tt>rake doc:app</tt>
+ Application specific libraries. Basically, any kind of custom code that doesn't
+ belong under controllers, models, or helpers. This directory is in the load path.
+ The directory available for the web server. Contains subdirectories for images, stylesheets,
+ and javascripts. Also contains the dispatchers and the default HTML files. This should be
+ set as the DOCUMENT_ROOT of your web server.
+ Helper scripts for automation and generation.
+ Unit and functional tests along with fixtures. When using the script/generate scripts, template
+ test files will be generated for you and placed in this directory.
+ External libraries that the application depends on. Also includes the plugins subdirectory.
+ If the app has frozen rails, those gems also go here, under vendor/rails/.
+ This directory is in the load path.
@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'tasks/rails'
@@ -0,0 +1,68 @@
+class Admin::FeaturedItemsController < AdminController
+ skip_before_filter :admin_user_required
+ layout proc {|c| c.request.xhr? ? false : "new_admin" }
+ before_filter :set_featured_types, :only => :load_template
+ def index
+ end
+ def load_template
+ return false unless params[:id] =~ /^template_[0-9]+$/
+ @template_id = params[:id]
+ end
+ def load_items
+ case params[:id]
+ when
+ @items = Content.paginate :page => params[:page], :per_page => 12, :order => "created_at desc"
+ when
+ @items = Idea.paginate :page => params[:page], :per_page => 12, :order => "created_at desc"
+ else
+ return false
+ end
+ end
+ def save
+ FeaturedItem.all.each {|fi| fi.destroy}
+ data = ActiveSupport::JSON.decode(params['featured_items'])
+ @template_name = FeaturedItem.create({:name => 'featured_template', :featured_type => data['template']})
+ @section1 = @template_name.children.create({:name => "section1", :featured_type => "section1"})
+ @section2 = @template_name.children.create({:name => "section2", :featured_type => "section2"})
+ ['section1', 'section2'].each do |section|
+ section_data = instance_variable_get("@#{section}")
+ ['primary', 'secondary1', 'secondary2'].each do |box|
+ item_id = data[section][box]
+ next unless item = get_item(item_id)
+ item = get_item item_id
+ section_data.children.create({:name => "item_#{item_id}", :featured_type => "featured_item", :featurable => item})
+ end
+ end
+ render :json => {:success => "Success!"}.to_json and return
+ end
+ private
+ def get_item item
+ return false unless item and item =~ /^([^_]+)_([0-9]+)$/
+ case $1
+ when 'content'
+ return Content.find_by_id($2)
+ when 'idea'
+ return Idea.find_by_id($2)
+ else
+ return false
+ end
+ end
+ def set_featured_types
+ @featurables ||= [['Stories', 'contents'], ['Ideas', 'ideas']]
+ end
+ def set_current_tab
+ @current_tab = 'featured-items';
+ end
Oops, something went wrong.

0 comments on commit 7753c3a

Please sign in to comment.