aeonscope-btech_rest 0.3.0 → 0.4.1

data/CHANGELOG.rdoc

@@ -14,4 +14,10 @@
 * Fixed the btech_rest.rb requirements so that they are platform agnostic.
 * Added partial support for Rails 2.3 nested forms. You can at least build nested forms and this gem will handle them properly.
 
+= v0.4.0
+
+* Fixed an issue where the rest_setup Rails generator was not being packaged properly with the gem.
+* Added Rails 2.3.2 and above as a gem dependency as this gem will no longer work with previous versions.
+* Shortened the gem summary and added a more detailed description.
+* Updated the README file with minor setup and usage clarifications.
 

data/README.rdoc

@@ -29,15 +29,20 @@ See the CHANGELOG file for more info.
 
 = Requirements
 
-1. Knowledge of the {Representational State Transfer (REST)}[http://en.wikipedia.com/wiki/REST]. Download and read {RESTful Rails}[http://www.b-simple.de/documents] if you need further info.
+1. {Ruby on Rails}[http://rubyonrails.org]
 2. mislav-will_paginate[http://github.com/mislav/will_paginate/tree/master] gem. This is automatically installed/updated for you unless the correct version is detected.
+3. Knowledge of the {Representational State Transfer (REST)}[http://en.wikipedia.com/wiki/REST]. Download and read {RESTful Rails}[http://www.b-simple.de/documents] if you need further info.
 
 = Installation
 
 Type the following from the command line to install:
 
-* *UNIX*: sudo gem install btech_rest
-* *Windows*: gem install btech_rest
+* *UNIX*: sudo gem install aeonscope-btech_rest
+* *Windows*: gem install aeonscope-btech_rest
+
+Update your environment.rb file to include the new gem:
+
+* config.gem "btech_rest"
 
 Type the following from the command line to setup:
 
@@ -47,7 +52,7 @@ Type the following from the command line to setup:
 
 As mentioned in the overview, simply add the following line of code to your controller(s) to make them RESTful:
 
-	include BTech::Rest
+  include BTech::Rest
 	
 Example:
 

data/Rakefile

@@ -5,14 +5,16 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "btech_rest"
-    gem.summary = "Easily adhere to DRY principals and add default REST functionality to your controllers."
-		gem.required_ruby_version = ">= 1.8.6"
-		gem.add_dependency "mislav-will_paginate", ">= 2.3.7"
-		gem.rdoc_options << "CHANGELOG.rdoc"
+    gem.summary = "Enables REST functionality and keeps your code DRY."
+    gem.description = "Ruby on Rails supports RESTful routing out-of-the-box. However, as you move along, you will often find yourself repeating the code for the seven REST actions: index, show, new, create, edit, update, destroy. This gem allows you to get all of the code for free by simply typing 'include BTech::Rest' at top of your controller code. That's it! Even better, you can have nested resources as well by adding a 'belongs_to' statement to your controllers much like you would for ActiveRecord models. This is just the tip of the iceburg so make sure to read the RDoc for more info."
     gem.authors = ["Brooke Kuhlmann"]
     gem.email = "aeonscope@gmail.com"
     gem.homepage = "http://github.com/aeonscope/btech-rest"
-    # gem.install_message = "Now you're being resourcefull!"
+		gem.required_ruby_version = ">= 1.8.6"
+		gem.add_dependency "rails", ">= 2.3.2"
+		gem.add_dependency "mislav-will_paginate", ">= 2.3.7"
+		gem.rdoc_options << "CHANGELOG.rdoc"
+		gem.files = FileList["[A-Z]*", "{bin,lib,generators,rails_generators,test,spec}/**/*"]
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 3
-:patch: 0
+:minor: 4
+:patch: 1
 :major: 0

data/rails_generators/rest_setup/USAGE

@@ -0,0 +1,11 @@
+Berserk Technologies REST Setup Generator
+
+Description:
+    Configures unobtrusive jQuery support.
+
+Requirements
+	1. jQuery 1.3 or higher.
+	2. jQuery UI 1.7 or higher.
+	
+Usage:
+    script/generate rest_setup

data/rails_generators/rest_setup/rest_setup_generator.rb

@@ -0,0 +1,18 @@
+class RestSetupGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      # Controllers
+      m.file "app/controllers/javascripts_controller.rb", "app/controllers/javascripts_controller.rb" 
+
+      # Views
+      m.directory "app/views/javascripts"
+      m.file "app/views/javascripts/ujs.js.erb", "app/views/javascripts/ujs.js.erb" 
+
+      # JavaScripts
+      m.file "public/javascripts/rest.js", "public/javascripts/rest.js"
+
+      # Instructions
+      m.readme "README"
+    end
+  end
+end

data/rails_generators/rest_setup/templates/README

@@ -0,0 +1,17 @@
+
+Overview
+	REST setup is complete.
+
+Tasks You Need to Complete:
+    1.  Update your layouts/application.html.erb as follows:
+
+        <%= javascript_include_tag "jquery" %>
+        <%= javascript_include_tag "jquery-ui" %>
+        <%= javascript_include_tag "ujs" %>
+        <%= javascript_include_tag "rest" %>
+
+    2.  Add the following to the very bottom of your config/routes.rb file:
+
+        # Defaults
+        map.connect ":controller/:action/.:format"
+

data/rails_generators/rest_setup/templates/app/controllers/javascripts_controller.rb

@@ -0,0 +1,7 @@
+# Enables the ability to serve up dynamic javascript, namely Unobtrusive JavaScript
+# support for jQuery.
+class JavascriptsController < ApplicationController
+	# Serves global jQuery UJS settings.  See the /views/layouts/application.html.erb for usage.
+  def ujs
+  end
+end

data/rails_generators/rest_setup/templates/app/views/javascripts/ujs.js.erb

@@ -0,0 +1,18 @@
+// Ensures AJAX requests are properly formated so that Rails knows how to respond to them.
+$.ajaxSetup({
+  beforeSend: function(xhr) {xhr.setRequestHeader("Accept", "text/javascript")}
+});
+
+/* Ensures AJAX requests have the proper Rails authenticity token.  See the following
+   for more info:
+
+   http://henrik.nyh.se/2008/05/rails-authenticity-token-with-jquery
+   http://dev.jquery.com/ticket/3387
+*/
+$(document).ajaxSend(function(event, request, settings){
+  var authToken = "<%= form_authenticity_token %>";
+  if (authToken != null){
+    settings.data = settings.data || "";
+    settings.data += (settings.data ? "&" : "") + "authenticity_token=" + encodeURIComponent(authToken);
+  };
+});

data/rails_generators/rest_setup/templates/public/javascripts/rest.js

@@ -0,0 +1,26 @@
+$(document).ready(function(){
+	// UJS Destroy
+    $("a.destroy").click(function(){
+        var result = confirm("Are you sure you want to delete this?");
+        if (result) {
+			try {
+				var id = $(this).attr("id");
+				// Parent ID is determined from link ID. Example: post_3_link (link ID) yields post_3 (parent ID).
+				var endIndex = id.lastIndexOf('_');
+				if (endIndex > 1) {
+					var parent_id = '#' + id.slice(0, endIndex);
+					$(parent_id).animate({backgroundColor: "#FF0000"}, 500);
+					$(parent_id).fadeOut(500);
+				} else {
+					throw "Invalid ID";
+				}
+				// Finally, call the destroy action.
+	            $.post($(this).attr("href"), "_method=delete");
+			} catch (e) {
+				alert("Error: " + e + ". Check that parent ID is defined and/or the link ID includes parent ID as part of the link ID.");
+			}
+        }
+		// Ensure the default event does not fire.
+		return false;
+    });
+});

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aeonscope-btech_rest
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors: 
 - Brooke Kuhlmann
@@ -9,9 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-11 00:00:00 -07:00
+date: 2009-04-13 00:00:00 -07:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
 - !ruby/object:Gem::Dependency 
   name: mislav-will_paginate
   type: :runtime
@@ -22,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.3.7
     version: 
-description: 
+description: "Ruby on Rails supports RESTful routing out-of-the-box. However, as you move along, you will often find yourself repeating the code for the seven REST actions: index, show, new, create, edit, update, destroy. This gem allows you to get all of the code for free by simply typing 'include BTech::Rest' at top of your controller code. That's it! Even better, you can have nested resources as well by adding a 'belongs_to' statement to your controllers much like you would for ActiveRecord models. This is just the tip of the iceburg so make sure to read the RDoc for more info."
 email: aeonscope@gmail.com
 executables: []
 
@@ -41,6 +51,12 @@ files:
 - lib/btech_rest.rb
 - lib/class_methods.rb
 - lib/resource_helper.rb
+- rails_generators/rest_setup/USAGE
+- rails_generators/rest_setup/rest_setup_generator.rb
+- rails_generators/rest_setup/templates/README
+- rails_generators/rest_setup/templates/app/controllers/javascripts_controller.rb
+- rails_generators/rest_setup/templates/app/views/javascripts/ujs.js.erb
+- rails_generators/rest_setup/templates/public/javascripts/rest.js
 - test/btech_rest_test.rb
 - test/test_helper.rb
 has_rdoc: true
@@ -69,7 +85,7 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Easily adhere to DRY principals and add default REST functionality to your controllers.
+summary: Enables REST functionality and keeps your code DRY.
 test_files: 
 - test/btech_rest_test.rb
 - test/test_helper.rb