citygate 0.0.4 → 0.0.5

data/README.rdoc

@@ -2,4 +2,69 @@
 
 Citygate is a rails engine that provides your application with user authentication (on the site or through facebook or google) using Devise and fully customizable authorization using CanCan.
 
-It also provides a customizable backend for administrating all your users, using pjax and pushState making your website as fast as responsive as you ever wanted it to be.
+It also provides a customizable backend for administrating all your users, using pjax and pushState making your website as fast as responsive as you ever wanted it to be.
+
+== Instalation
+
+First add the gem to your Gemfile to get the latest stable version
+
+  gem "citygate"
+
+or go on the edge with
+
+  gem "citygate", :git => "https://zamith@github.com/zamith/citygate.git"
+
+== Database Configuration
+
+In order to get the database ready to run citygate you will need to fetch the migrations
+
+  rake citygate:install:migrations
+
+and run them
+
+  rake db:migrate
+
+then drop this line at your +db/seeds.rb+ file in order to be able to populate the db with the needed records
+
+  Citygate::Engine.load_seed
+
+and finally run the seeds command to actually populate the db
+
+  rake db:seed
+
+== Routes Configuration
+
+To get all the citygate routes working you just need to mount them by adding the following line to your +config/routes.rb+ file
+
+  mount Citygate::Engine => "/"
+
+== Environment Configuration
+
+Since citygate will send confirmation emails to any user that signs up, you will need to have your email configured.
+
+In case of development add this to +config/environments/development.rb+
+
+  config.action_mailer.default_url_options = { :host => 'localhost:3000' }
+
+== Citygate Options
+
+You can change citygate's defaults by editing your +config/application.rb+ file like so
+
+  Citygate::Engine.configure do
+    config.option = value
+  end
+
+=== Options
+
+The available options are:
+
+will_paginate_options:: an hash with any option supported by paginate[https://github.com/mislav/will_paginate/wiki]
+mount_path:: if you mount the engine in any other path than "/", must define it here as well so that omniauth can be aware of it
+
+== Running Citygate
+
+Users in citygate will not be able to login with their google account if you use WEBrick, due to its url length limitation. Therefore run your server in development with <tt>rails s thin</tt>, to run the thin server.
+
+---
+
+*Note:* Do not forget to check the routes made available to you by Citygate with <tt>rake routes</tt> and to take a look at the doc at RubyDoc[http://rubydoc.info/github/zamith/citygate/master/frames]

data/Rakefile

@@ -1,7 +1,6 @@
 #!/usr/bin/env rake
 begin
   require 'bundler/setup'
-  require 'bundler/gem_tasks'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end

data/app/assets/javascripts/citygate/admin_users.coffee

@@ -1,14 +1,2 @@
 $ ->
-  # Every link that is click in the users area must push the state for the previous location and update the URL, 
-  # since everything is AJAXified
-  $("#users a").live "click", ->
-    # Push the state before the click (when it's the first page load it starts the stack)
-    history.pushState buildState(), "", window.location.href
-
-    # Gets the content for the container through AJAX
-    $.getScript @href, =>
-      # If the last url to be pushed to the history is different the one we're at, then push the new state
-      history.replaceState buildState(), "", @href if history.state.page isnt @href
-
-    # Prevent the page refresh
-    false
+  $("a").pjax("[data-pjax-container]")

data/app/assets/javascripts/citygate/application.js

@@ -12,5 +12,6 @@
 //
 //= require jquery
 //= require jquery_ujs
-//= require citygate/global
-//= require_tree .
+//= require citygate/jquery.pjax
+//= require citygate/admin_users
+