feed_satisfaction 0.1.0

data/app/controllers/feed_satisfaction/feedbacks_controller.rb

@@ -0,0 +1,7 @@
+module FeedSatisfaction
+  class FeedbacksController < ::ApplicationController
+    def show
+      @user = current_user if defined? current_user
+    end
+  end
+end

data/app/views/feed_satisfaction/feedbacks/_fast_pass.html.erb

@@ -0,0 +1,3 @@
+<% if @user %>
+  <%= FeedSatisfaction::FastPass.script(@user.email, @user.name, @user.username) %>
+<% end %>

data/app/views/feed_satisfaction/feedbacks/_feedback_form.html.erb

@@ -0,0 +1,20 @@
+<script type="text/javascript">
+  var is_ssl = ("https:" == document.location.protocol);
+  var asset_host = is_ssl ? "https://s3.amazonaws.com/getsatisfaction.com/" : "http://s3.amazonaws.com/getsatisfaction.com/";
+  document.write(unescape("%3Cscript src='" + asset_host + "javascripts/feedback-v2.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+
+<script type="text/javascript">
+  var feedback_widget_options = {};
+  feedback_widget_options.display = "inline";
+  feedback_widget_options.company = "<%= FeedSatisfaction.company %>";
+  feedback_widget_options.product = "<%= FeedSatisfaction.product %>";
+  feedback_widget_options.style = "<%= FeedSatisfaction.default_tab %>";
+  feedback_widget_options.custom_css = "<%= FeedSatisfaction.custom_css %>";
+  feedback_widget_options.limit = "<%= FeedSatisfaction.question_limit %>";
+  
+  GSFN.feedback_widget.prototype.local_base_url = "http://<%= FeedSatisfaction.domain %>";
+  GSFN.feedback_widget.prototype.local_ssl_base_url = "http://<%= FeedSatisfaction.domain %>";
+  
+  var feedback_widget = new GSFN.feedback_widget(feedback_widget_options);
+</script>

data/app/views/feed_satisfaction/feedbacks/_sidebar.html.erb

@@ -0,0 +1,16 @@
+<% if FeedSatisfaction.sidebar_name %>
+  <% content_for(FeedSatisfaction.sidebar_name) do %>
+    <div id="gsfn_list_widget">
+      <h2><a class="widget_title" href="<%= FeedSatisfaction.account_url %>">Active Discussions</a></h2>
+      <div id="gsfn_content">Loading...</div>
+      <div class="powered_by">
+        <a href="<%= FeedSatisfaction.account_url %>">
+          <img alt="Favicon" src="http://getsatisfaction.com/favicon.gif" style="vertical-align: middle;"/>
+        </a>
+        <a href="<%= FeedSatisfaction.account_url %>">Get Satisfaction support network</a>
+      </div>
+    </div>
+    <script src="<%= FeedSatisfaction.account_url %>widgets/javascripts/<%= FeedSatisfaction.widget_id %>/widgets.js" type="text/javascript"></script>
+    <script src="<%= FeedSatisfaction.account_url %>topics.widget?callback=gsfnTopicsCallback&amp;length=0&amp;limit=10&amp;sort=recently_active" type="text/javascript"></script>
+  <% end %>
+<% end %>

data/app/views/feed_satisfaction/feedbacks/show.html.erb

@@ -0,0 +1,5 @@
+<%= render 'fast_pass' %>
+
+<%= render 'feedback_form' %>
+
+<%= render 'sidebar' %>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  scope ENV['RAILS_RELATIVE_URL_ROOT'] || '/' do
+    get 'feedback' => 'feed_satisfaction/feedbacks#show', :as=>:feedback
+  end
+end

data/lib/feed_satisfaction/engine.rb

@@ -0,0 +1,7 @@
+require 'feed_satisfaction'
+require 'rails'
+
+module FeedSatisfaction
+  class Engine < Rails::Engine
+  end
+end

data/lib/feed_satisfaction/fast_pass.rb

@@ -0,0 +1,86 @@
+require 'rubygems'
+require 'active_support'
+require 'oauth'
+require 'oauth/client/net_http'
+require 'erb'
+
+#
+# Helper module for integrating Get Satisfaction's FastPass single-sign-on service into a Ruby web 
+# app. Use #url to create a signed FastPass URL, and #script to generate the JS-based integration.
+#
+module FeedSatisfaction
+  module FastPass
+    extend ERB::Util
+    
+    def self.domain
+      FeedSatisfaction.domain
+    end
+    
+    #
+    # Generates a FastPass URL with the given +email+, +name+, and +uid+ signed with the provided
+    #
+    def self.url(email, name, uid, secure=false, additional_fields={})
+      consumer = OAuth::Consumer.new(FeedSatisfaction.fastpass_key, FeedSatisfaction.fastpass_secret)
+      uri = URI.parse(secure ? "https://#{domain}/fastpass" : "http://#{domain}/fastpass")
+      params = additional_fields.merge(:email => email, :name => name, :uid => uid)
+      
+      uri.query = params.to_query
+      
+      http      = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.scheme == "https"
+      request   = Net::HTTP::Get.new(uri.request_uri)
+      request.oauth!(http, consumer, nil, :scheme => 'query_string')
+      
+      signature = request.oauth_helper.signature
+      #re-apply params with signature to the uri
+      query = params.merge(request.oauth_helper.oauth_parameters).merge("oauth_signature" => signature)
+      uri.query = query.to_query
+      return uri.to_s
+    end
+    
+    #
+    # Generates a FastPass IMG tag. This integration method is likely to be deprecated, unless strong
+    # use cases are presented. Be warned.
+    #
+    def self.image(*args)
+      url = url(*args)
+      %Q{<img src="#{h url}" alt="" />}
+    end
+    
+    #
+    # Generates a FastPass SCRIPT tag. The script will automatically rewrite all GetSatisfaction
+    # URLs to include a 'fastpass' query parameter with a signed fastpass URL.
+    #
+    def self.script(email, name, uid, secure=false, additional_fields={})
+      url = url(email, name, uid, secure, additional_fields)
+      
+      html = <<-EOS
+      <script type="text/javascript">
+        var GSFN;
+        if(GSFN == undefined) { GSFN = {}; }
+
+        (function(){
+          add_js = function(jsid, url) {
+            var head = document.getElementsByTagName("head")[0];
+            script = document.createElement('script');
+            script.id = jsid;
+            script.type = 'text/javascript';
+            script.src = url;
+            head.appendChild(script);
+          }
+          add_js("fastpass_common", document.location.protocol + "//#{domain}/javascripts/fastpass.js");
+
+          if(window.onload) { var old_load = window.onload; }
+          window.onload = function() {
+            if(old_load) old_load();
+            add_js("fastpass", #{url.to_json});
+          }
+        })()
+
+      </script>
+      EOS
+      
+      html.html_safe
+    end
+  end
+end

data/lib/feed_satisfaction/version.rb

@@ -0,0 +1,5 @@
+module FeedSatisfaction
+
+  VERSION = '0.1.0'
+
+end

data/lib/feed_satisfaction.rb

@@ -0,0 +1,38 @@
+module FeedSatisfaction
+  require 'feed_satisfaction/fast_pass'
+  
+  # Settings
+  mattr_accessor(:domain)
+  self.domain = 'getsatisfaction.com'
+  mattr_accessor(:company)
+  mattr_accessor(:product)
+  
+  # single sign on
+  mattr_accessor(:fastpass_key)
+  mattr_accessor(:fastpass_secret)
+  
+  mattr_accessor(:widget_id)
+  mattr_accessor(:custom_css)
+  mattr_accessor(:default_tab)
+  self.default_tab = 'question'
+  mattr_accessor(:question_limit)
+  self.question_limit = 5
+  
+  # if you want a list of community discussions to show up in your sidebar
+  mattr_accessor(:sidebar_name)
+  
+  def self.account_url
+    url = URI.parse ''
+    url.scheme = 'http'
+    url.host = self.domain
+    url.path = "/#{self.company}/"
+    url.to_s
+  end
+  
+  # for easy configuration
+  def self.config
+    yield self
+  end
+  
+  require 'feed_satisfaction/engine' if defined?(Rails)
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: feed_satisfaction
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Adam Crownoble
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-05 00:00:00.000000000 -07:00
+default_executable: 
+dependencies: []
+description: Simple Ruby on Rails engine that allows you to easily add a Get Satisfaction
+  feedback page to your app
+email: adam@obledesign.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/views/feed_satisfaction/feedbacks/_sidebar.html.erb
+- app/views/feed_satisfaction/feedbacks/_feedback_form.html.erb
+- app/views/feed_satisfaction/feedbacks/show.html.erb
+- app/views/feed_satisfaction/feedbacks/_fast_pass.html.erb
+- app/controllers/feed_satisfaction/feedbacks_controller.rb
+- lib/feed_satisfaction/version.rb
+- lib/feed_satisfaction/engine.rb
+- lib/feed_satisfaction/fast_pass.rb
+- lib/feed_satisfaction.rb
+- config/routes.rb
+has_rdoc: true
+homepage: http://obledesign.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Get Satisfaction feedback Rails engine
+test_files: []