RubyGems - simple-fluther - Versions diffs - 0.1.0 - Mend

simple-fluther 0.1.0

Files changed (6) hide show

data/MIT-LICENSE +20 -0
data/README.textile +85 -0
data/lib/simple-fluther.rb +6 -0
data/lib/simple-fluther/config.rb +36 -0
data/lib/simple-fluther/controller_methods.rb +91 -0
metadata +84 -0

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright 2009 Plataforma Tecnologia. http://blog.plataformatec.com.br
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile ADDED Viewed

@@ -0,0 +1,85 @@
+h1. Fluther Ruby/Rails Client
+h2. Introduction
+This gem provides an interface to the "Fluther discussion service":http://www.fluther.com/.  It is intended to be included into your controller (i.e. FlutherController) and called as a @before_filter@.  It handles proxying requests to Fluther and returning the response so that it can be included in your web application.
+It's based on the original "Fluther gem":http://github.com/Conceivian/Fluther but modified to not require Warden or Rack-integration.
+h2. Installation
+* Add the @simple-fluther@ gem to your application (i.e. in @Gemfile@ or @environment.rb@).
+* Create an initializer (e.g. @config/initializers/fluther.rb@) that sets the following configuration:
+<pre>
+class SimpleFluther::Config
+  # hostname of the Fluther server for this environment (provided by Fluther)
+  fluther_host 'fstage.fluther.com'
+  # the route for your app
+  prefix '/qna'
+  # federated API key (provided by Fluther)
+  app_key '2b6a0009c414c53e3d4fa8f8c3134d59'
+  # what method to call in the controller to get the current user model
+  method_to_get_current_user :current_user
+  # mapping of attributes in the User model to the Fluther user
+  user_fields :id => :id, :name => :name, :email => :email  # (defaults)
+end
+</pre>
+h2. Rails Integration
+In your controller, include the module @Fluther::ControllerMethods@ and add the @make_fluther_request@ @before_filter@ to your target action.
+The proxy provides three Rack variables that include the Fluther response: @fluther.header@, @fluther.title@, and
+@fluther.response@.  The first two (may) contain HTML blocks which should be inserted into the page @<head>@ and @<title>@ blocks,
+respectively, and the third is the HTML for the Fluther widget itself.
+To integrate the response into your application, you should add an action which is routed from the same path as the Fluther proxy.
+For this example, we assume the controller is @MainController@, the action is @fluther@, and as above, it is mounted at @/qna@.
+Also, we assume that the application layout includes @yield(:head)@ in the @<head>@ block:
+<pre>
+# config/routes.rb
+map.fluther '/qna/*_', :controller => 'fluther', :action => 'index'
+</pre>
+Your controller might look something like this:
+<pre>
+# app/controllers/fluther_controller.rb
+class FlutherController < ApplicationController
+  include SimpleFluther::ControllerMethods
+  before_filter :make_fluther_request, :only => :index
+  def index
+  end
+end
+</pre>
+<pre>
+# app/views/fluther/index.html.erb
+<%
+  if (header = request.env['fluther.header']).present?
+    content_for :head, header
+  end
+  if (title = request.env['fluther.title']).present?
+    content_for :head, content_tag(:title, title)
+  end
+%>
+<%= request.env['fluther.response'] -%>
+</pre>
+You should now be able to start your application, navigate to http://localhost:300/qna and see the Fluther page.
+h2. Credits
+Based on original "Fluther gem":http://github.com/Conceivian/Fluther by Steve Sloan.
+* Author: "Justin Chen":mailto:justin@menuism.com
+* License: MIT

data/lib/simple-fluther.rb ADDED Viewed

@@ -0,0 +1,6 @@
+require 'simple-fluther/config'
+require 'simple-fluther/controller_methods'
+module SimpleFluther
+  ClientVersion = '1.0.2'.freeze
+end

data/lib/simple-fluther/config.rb ADDED Viewed

@@ -0,0 +1,36 @@
+module SimpleFluther
+  class Config
+    def self.prefix( *args )
+      @@prefix = nil  unless defined? @@prefix
+      return @@prefix  if args.empty?
+      @@prefix = args.first
+      @@prefix = "/#{@@prefix}" unless @@prefix.starts_with?('/')
+      @@prefix
+    end
+    def self.fluther_host( *args )
+      @@fluther_host = nil  unless defined? @@fluther_host
+      return @@fluther_host  if args.empty?
+      @@fluther_host = args.first
+    end
+    def self.app_key( *args )
+      @@app_key = nil  unless defined? @@app_key
+      return @@app_key  if args.empty?
+      @@app_key = args.first
+    end
+    def self.method_to_get_current_user( *args)
+      @@method_to_get_current_user = nil  unless defined? @@method_to_get_current_user
+      return @@method_to_get_current_user  if args.empty?
+      @@method_to_get_current_user = args.first
+    end
+    def self.user_fields( *args )
+      @@user_fields = { :id => :id, :name => :name, :email => :email }  unless defined? @@user_fields
+      return @@user_fields  if args.empty?
+      @@user_fields.update args.first
+    end
+  end
+end

data/lib/simple-fluther/controller_methods.rb ADDED Viewed

@@ -0,0 +1,91 @@
+require 'em-http-request'
+module SimpleFluther
+  module ControllerMethods
+    def make_fluther_request
+      setup_fluther_user
+      return exec_request
+    end
+    def setup_fluther_user
+      @fluther_user = {}
+      if user = self.send(SimpleFluther::Config.method_to_get_current_user) rescue nil
+        SimpleFluther::Config.user_fields.each { |dest, src|  @fluther_user[dest] = user.send(src).to_s }
+      end
+    end
+    def build_request
+      fluther_params = request.params.dup.update(
+        :fed_key => SimpleFluther::Config.app_key
+      )
+      fluther_params[:fed_sessionid] = request.cookies['fed_sessionid']  if request.cookies['fed_sessionid']
+      if @fluther_user.present?
+        fluther_params[:fed_uid] = @fluther_user[:id].to_s
+        fluther_params[:fed_username] = @fluther_user[:name].to_s
+        fluther_params[:fed_email] = @fluther_user[:email].to_s
+      end
+      options = {
+        :redirects => 0,
+        :timeout => 10,
+        :head => {
+          'User-Agent' => "Fluther Federated Client #{SimpleFluther::ClientVersion} (Ruby)",
+          'X-Forwarded-For' => request.env['REMOTE_ADDR'],
+          'X-Forwarded-Host' => request.env['HTTP_HOST'],
+          'X-Forwarded-User-Agent' => request.user_agent
+        }
+      }
+      options[:head]['X-Requested-With'] = request.env['HTTP_X_REQUESTED_WITH']  if request.env['HTTP_X_REQUESTED_WITH']
+      options[request.post? ? :body : :query] = fluther_params
+      path = request.path.sub( %r{^#{SimpleFluther::Config.prefix}}, '' )
+      path = '/' + path  unless path.starts_with?('/')
+      path = path + '/' unless path.ends_with?('/')
+      url = "#{request.scheme}://#{SimpleFluther::Config.fluther_host}#{path}"
+      Rails.logger.debug request.request_method
+      Rails.logger.debug url
+      Rails.logger.debug options
+      EventMachine::HttpRequest.new( url ).send( request.request_method, options )
+    end
+    def exec_request
+      result = nil
+      em_running = EM.reactor_running?
+      EM.run  do
+        fluther = build_request
+        fluther.callback do
+          result = handle_response fluther
+          EM.stop
+        end
+      end
+      result
+    end
+    def handle_response( fluther )
+      Rails.logger.debug "Fluther HTTP Response Code: #{fluther.response_header.status}"
+      Rails.logger.debug fluther.response_header
+      type_header = fluther.response_header['CONTENT_TYPE']
+      content_type = type_header.split(';')[0] || 'text/html'
+      result = if [301, 302].include?( fluther.response_header.status )
+        redirect_to fluther.response_header['LOCATION'], :status => fluther.response_header.status
+        false
+      elsif request.xhr? || (content_type != 'text/html')
+        Rails.logger.debug "AJAX?"
+        render :text => fluther.response, :layout => false
+#        [ fluther.response_header.status, {'Content-Type' => type_header}, [fluther.response] ]
+        true
+      else
+        fluther.response.html_safe  if fluther.response.respond_to?(:html_safe)
+        request.env['fluther.response'] = fluther.response
+        request.env['fluther.title']  = fluther.response_header['FLUTHER_TITLE']  if fluther.response_header['FLUTHER_TITLE']
+        request.env['fluther.header'] = fluther.response_header['FLUTHER_HEADER']  if fluther.response_header['FLUTHER_HEADER']
+#        @app.call request.env
+        true
+      end
+      result
+    end
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: simple-fluther
+version: !ruby/object:Gem::Version
+  hash: 27
+  prerelease: false
+  segments:
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Chen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-08-22 00:00:00 -07:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Modified version of original fluther gem for integrating into Rails.
+email: justin@menuism.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.textile
+files:
+- MIT-LICENSE
+- README.textile
+- lib/simple-fluther.rb
+- lib/simple-fluther/config.rb
+- lib/simple-fluther/controller_methods.rb
+has_rdoc: true
+homepage: http://github.com/justinchen/simple-fluther
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+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:
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: Ruby interface to the Fluther discussion system
+test_files: []