RubyGems - bcms_intensedebate - Versions diffs - 0.5.0 - Mend

bcms_intensedebate 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

data/README.markdown +33 -0
data/app/controllers/application_controller.rb +10 -0
data/app/helpers/application_helper.rb +7 -0
data/app/portlets/intense_debate_comments_portlet.rb +10 -0
data/app/views/layouts/templates/default.html.erb +17 -0
data/app/views/portlets/intense_debate_comments/_form.html.erb +2 -0
data/app/views/portlets/intense_debate_comments/render.html.erb +1 -0
data/config/initializers/intense_debate_settings.rb +1 -0
data/lib/bcms_intensedebate.rb +3 -0
data/lib/bcms_intensedebate/intense_debate_comments_portlet_helper.rb +59 -0
data/lib/bcms_intensedebate/routes.rb +7 -0
data/public/bcms/intensedebate/README +1 -0
data/rails/init.rb +5 -0
metadata +79 -0

data/README.markdown ADDED

@@ -0,0 +1,33 @@
+# IntenseDebate plugin for BrowserCMS
+Provides IntenseDebate commenting features for your BrowserCMS site. It gives you:
+* A portlet to use on arbitrary pages,
+* View helpers you can use to emit IntenseDebate API calls in a more precise fashion in your views or content blocks.
+## Installation
+1. Create an intensedebate.com site key for your specific URL,
+2. Follow the generic module instructions here: http://guides.browsercms.org/installing_modules.html
+3. Edit BROWSER_CMS_ROOT/config/initializer/intense_debate_settings.rb to include your site key. Restart your rails app.
+4. There are no migrations to run.
+## Notes
+* Each IntenseDebateCommentsPortlet generates a unique idcomments_post_id value to be used by the IntenseDebate API. You may want to reuse or generate a new portlet for every page depending on your commenting goals.
+* Look in lib/bcms_intensedebate/intense_debate_comments_portlet_helper.rb for full docs, or just generate the rdoc for this plugin.
+## Uninstallation
+Nothing special. Be sure to remove calls to id_comments and id_comments_link in your views.
+## Author
+Dan Collis-Puro
+djcp@cyber.law.harvard.edu, dan@collispuro.com
+Created for http://www.lawlab.org/
+## License
+LGPL

data/app/controllers/application_controller.rb ADDED

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/app/helpers/application_helper.rb ADDED

@@ -0,0 +1,7 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+  def test_helper_djcp
+    "djcp foo bar"
+  end
+end

data/app/portlets/intense_debate_comments_portlet.rb ADDED

@@ -0,0 +1,10 @@
+class IntenseDebateCommentsPortlet < Portlet
+  # Mark this as 'true' to allow the portlet's template to be editable via the CMS admin UI.
+  enable_template_editor false
+  def render
+    # Your Code Goes Here
+  end
+end

data/app/views/layouts/templates/default.html.erb ADDED

@@ -0,0 +1,17 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+    <title><%= page_title %></title>
+    <%= yield :html_head %>
+  </head>
+  <body style="margin: 0; padding: 0; text-align: center;">
+    <%= cms_toolbar %>
+    <div id="wrapper" style="width: 700px; margin: 0 auto; text-align: left; padding: 30px">
+      Breadcrumbs: <%= render_breadcrumbs %>
+      Main Menu: <%= render_menu %>
+      <h1><%= page_title %></h1>
+      <%= container :main %>
+    </div>
+  </body>
+</html>

data/app/views/portlets/intense_debate_comments/_form.html.erb ADDED

	@@ -0,0 +1,2 @@
1	+ <%= f.cms_text_field :name, :instructions => 'The name is only used to identify this portlet in the backend.' %>
2	+ <%= f.cms_template_editor :template %>

data/app/views/portlets/intense_debate_comments/render.html.erb ADDED

	@@ -0,0 +1 @@
1	+ <%= id_comments @portlet %>

data/config/initializers/intense_debate_settings.rb ADDED

	@@ -0,0 +1 @@
1	+ ENV['INTENSEDEBATE_ACCOUNT'] = 'Your intense debate site account / key here'

data/lib/bcms_intensedebate.rb ADDED

@@ -0,0 +1,3 @@
+require 'bcms_intensedebate/routes'
+require 'bcms_intensedebate/intense_debate_comments_portlet_helper'
+ActionView::Base.send(:include, IntenseDebateCommentsPortletHelper)

data/lib/bcms_intensedebate/intense_debate_comments_portlet_helper.rb ADDED

@@ -0,0 +1,59 @@
+module IntenseDebateCommentsPortletHelper
+  # Add the full comments list to a page.
+  #
+  # *Options*
+  # * :url - The URL to the page. Optional.
+  # * :intensedebate_account - Probably already configured in the initializer. Optional.
+  # * :title - The title of the page. Optional.
+  #
+  def id_comments(obj, options = {})
+    options.symbolize_keys!
+    options.assert_valid_keys(:intensedebate_account, :url, :title)
+    options[:intensedebate_account] = acct_no unless options[:intensedebate_account]
+    raise ArgumentError, "You must specify an IntenseDebate account number", options if options[:intensedebate_account].nil?
+    raise "Intense Debate account no. doesn't look valid" unless options[:intensedebate_account] =~ /[\w]{32}/
+    %Q|
+<script type="text/javascript">
+  var idcomments_acct = "#{ options[:intensedebate_account] }";
+  var idcomments_post_id = "#{obj.class.name}-#{ obj.id }";
+  var idcomments_post_url #{ "='%s'" % options[:url] unless options[:url].nil? };
+  var idcomments_post_title #{ "='%s'" % options[:title] unless options[:title].nil? };
+</script>
+<span id="IDCommentsPostTitle" style="display:none"></span>
+<script type="text/javascript" src="http://www.intensedebate.com/js/genericCommentWrapperV2.js"></script>
+|
+  end
+  # Add a comments counter and link to the item.
+  #
+  # *Options*
+  # * :intensedebate_account - Probably already configured in the initializer. Optional.
+  # * :url - The URL. Optional, but required if obj is not RESTful.
+  #
+  def id_comments_link(obj, options = {})
+    options.symbolize_keys!
+    options.assert_valid_keys(:intensedebate_account, :url)
+    options[:intensedebate_account] = acct_no unless options[:intensedebate_account]
+    raise ArgumentError, "You must specify an IntenseDebate account number", options if options[:intensedebate_account].nil?
+    raise "Intense Debate account no. doesn't look valid" unless options[:intensedebate_account] =~ /[\w]{32}/
+    %Q|
+<script type="text/javascript">
+  var idcomments_acct = "#{ options[:intensedebate_account] }";
+  var idcomments_post_id = "#{ obj.id }";
+  var idcomments_post_url = "#{ options[:url] ? options[:url] : self.send( :"#{obj.class.to_s.underscore}_path", obj ) }";
+</script>
+<script type="text/javascript" src="http://www.intensedebate.com/js/genericLinkWrapperV2.js"></script>
+|
+  end
+  protected
+  def acct_no
+    raise "Please set ENV['INTENSEDEBATE_ACCOUNT'] in config/initializers/intense_debate_settings.rb" unless defined?(ENV['INTENSEDEBATE_ACCOUNT'])
+    ENV['INTENSEDEBATE_ACCOUNT']
+  end
+end

data/lib/bcms_intensedebate/routes.rb ADDED

@@ -0,0 +1,7 @@
+module Cms::Routes
+  def routes_for_bcms_intensedebate
+    namespace(:cms) do |cms|
+      #cms.content_blocks :intensedebates
+    end
+  end
+end

data/public/bcms/intensedebate/README ADDED

	@@ -0,0 +1 @@
1	+ Use this directory to add public files that should copied from the gem into the project.

data/rails/init.rb ADDED

@@ -0,0 +1,5 @@
+gem_root = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+Cms.add_to_rails_paths gem_root
+Cms.add_generator_paths gem_root, "db/migrate/[0-9]*_*.rb"
+Cms.add_generator_paths gem_root, "public/bcms/intensedebate/**/*"
+Cms.add_generator_paths gem_root, "config/initializers/intense_debate_settings.rb"

metadata ADDED

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: bcms_intensedebate
+version: !ruby/object:Gem::Version
+  hash: 11
+  prerelease: false
+  segments:
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors:
+- Dan Collis-Puro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-12-22 00:00:00 -05:00
+default_executable:
+dependencies: []
+description:
+email: dan@collispuro.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.markdown
+files:
+- app/portlets/intense_debate_comments_portlet.rb
+- app/helpers/application_helper.rb
+- app/views/portlets/intense_debate_comments/_form.html.erb
+- app/views/portlets/intense_debate_comments/render.html.erb
+- app/views/layouts/templates/default.html.erb
+- app/controllers/application_controller.rb
+- lib/bcms_intensedebate.rb
+- lib/bcms_intensedebate/routes.rb
+- lib/bcms_intensedebate/intense_debate_comments_portlet_helper.rb
+- config/initializers/intense_debate_settings.rb
+- rails/init.rb
+- public/bcms/intensedebate/README
+- README.markdown
+has_rdoc: true
+homepage: http://www.collispuro.com
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project: bcms_intensedebate
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: Integrate IntenseDebate commenting into your BrowserCMS site
+test_files: []