uservoice 0.1.0 → 0.2.0

data/.gitignore

@@ -1,4 +1,4 @@
 .DS_Store
 rdoc/
 coverage/
-pkg/uservoice-0.1.0.gem
+pkg/

data/CHANGELOG.rdoc

@@ -0,0 +1,14 @@
+== v0.2.0 (2010-05-25)
+
+* Enhancements
+
+  * added single sign-on support
+
+* Changes
+
+  * enable_uservoice depricated as config will be loaded by default
+  * new config parameter uservoice_api[:api_key] in uservoice.yml
+
+== v0.1.0 (2010-01-01)
+
+* initial release including support for feedback button

data/README.rdoc

@@ -1,9 +1,7 @@
 = Uservoice feedback for Ruby on Rails
 
-This adds {Uservoice}[http://www.uservoice.com] feedback to your
-Rails application. You can set Uservoice properties in a central configuration
-file and override settings like forum id (for payed accounts) in your layout or
-view.
+This adds {Uservoice}[http://www.uservoice.com] support to your
+Rails application including single sign-on.
 
 == Installation
 
@@ -20,30 +18,44 @@ view.
 == Configuration
 
 Generate files for your app:
-  ./script/generate uservoice <key> <forum>
+  ./script/generate uservoice <key> <forum> [<api_key>]
 Where <key> is the Uservoice account name and <forum> the id of your main forum.
 Find both settings in widgets section of the admin interface of Uservoice.
+Your API key <api_key> can be found in the API section of the admin documentation.
 
-Default properties are stored in a file named uservoice.yml in the config directory
-of your Rails application. Make it fit to your needs.
+Default properties are stored in a file named uservoice.yml in the config
+directory of your Rails application. Make it fitting to your needs.
 
-Enable Uservoice in controllers of your choice. Add to ApplicationController
-directly to enable uservoice for every controller.
-
-  class MyController < ApplicationController
-    enable_uservoice
-    ...
-  end
-
-Link Uservoice javascript file and add configuration to HTML HEAD section of
-your template file:
+Link Uservoice javascript file and add configuration to HTML HEAD
+section of your template file:
   <%= javascript_include_tag 'uservoice' %>
   <%= uservoice_config_javascript %>
 
-You can even override default uservoice settings in your view:
+You can override default uservoice settings in your view:
   <%= uservoice_config_javascript(:alignment => 'right', :forum => 12983) %>
 
 
+== Single Sign-on
+
+Uservoice is allowing single sign-on starting from the Bronze plan.
+http://uservoice.com/signup?ref=nav
+
+To use single sign-on with on uservoice you have to set your api_key in 
+config/uservoice.yml. Find it on
+https://ACCOUNT.uservoice.com/admin2/docs#/legacy_api
+
+Set user data in your controller action.
+   def index
+     set_uservoice_sso(:guid => @current_user.id, :email => @current_user.email)
+   end
+
+Parameter <em>:guid</em> should be unique identifier for example the user id in your
+system. Uservoice recommends setting <em>:email</em> parameter to enable users to get
+updates and notifications via email.
+See https://ACCOUNT.uservoice.com/admin2/docs#/sso for a list of parameters
+available.
+
+
 == Note on Patches/Pull Requests
 
 * Fork the project.

data/Rakefile

@@ -6,13 +6,12 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "uservoice"
     gem.summary = %Q{Uservoice for your Rails application}
-    gem.description = %Q{This adds Uservoice user feedback to your Rails application.
-      You can set Uservoice properties in a central configuration file and override
-      settings like forum id (for payed accounts) in your layout or view.}
+    gem.description = %Q{This adds Uservoice support to your Rails application
+      including single sign-on.}
     gem.email = 'alexxx@iltempo.de'
     gem.homepage = 'http://github.com/iltempo/uservoice'
     gem.authors = ['Alexander Greim']
-    gem.version = '0.1.0'
+    gem.version = '0.2.0'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/generators/uservoice/USAGE

@@ -4,11 +4,11 @@ Name
 Description:
     This generator creates all files needed for uservoice integration.
 
-    ./script/generate uservoice <uservoice_key> <main_forum_id>
+    ./script/generate uservoice <uservoice_key> <main_forum_id> [<api_key>]
 
     Please add to head section of your layout file:
       <%= javascript_include_tag 'uservoice' %>
       <%= uservoice_config_javascript %>
 
 Example:
-    ./script/generate uservoice mypage 12345
+    ./script/generate uservoice mypage 12345 myapikey

data/generators/uservoice/templates/uservoice_template.yml

@@ -3,10 +3,13 @@ uservoice_options:
   key: <%= args.first %>
   host: <%= args.first %>.uservoice.com
   forum: <%= args.second %>
-  showTab: true
   # optional
+  showTab: true
   alignment: left
   background_color: "#f00"
   text_color: white
   hover_color: "#06C"
-  lang: en
+  lang: en
+
+uservoice_api:
+  api_key: <%= args.third %>

data/generators/uservoice/uservoice_generator.rb

@@ -1,6 +1,6 @@
 class UservoiceGenerator < Rails::Generator::Base
   def manifest
-    unless args.length == 2
+    unless [2, 3].include?(args.length)
       puts usage_message
       exit 1
     end

data/lib/uservoice/instance_methods.rb

@@ -9,11 +9,33 @@
 module Uservoice
   module InstanceMethods
 
-    # Enables uservoice configuration as controller
+    # Loads uservoice configuration into a controller
     # instance variable
     #
-    def uservoice_init
-      @uservoice_configuration ||= self.class.uservoice_configuration
+    def load_uservoice_config
+      @uservoice_configuration = begin
+        configuration = YAML::load(IO.read(uservoice_configuration_file))
+        HashWithIndifferentAccess.new(configuration)
+      end
+    end
+
+    # Set uservoice configuration file path.
+    # Can be overridden.
+    #
+    def uservoice_configuration_file #:nodoc:
+      "#{RAILS_ROOT}/config/uservoice.yml"
+    end
+
+    # Generates token for uservoice single sign-on
+    # that will be delivered by uservoice helper.
+    # See https://ACCOUNT.uservoice.com/admin2/docs#/sso for
+    # properties available.
+    #
+    def set_uservoice_sso(user_data)
+      @uservoice_sso_token = Uservoice::Token.new(
+        @uservoice_configuration['uservoice_options']['key'],
+        @uservoice_configuration['uservoice_api']['api_key'],
+        user_data)
     end
 
   end

data/lib/uservoice/uservoice_helper.rb

@@ -7,14 +7,25 @@
 
 module UservoiceHelper
 
-  # Renders javascript configuration to be integrated
-  # into layout file.
-  # Takes a forum id if different from default one.
+  # Renders javascript to configure uservoice feedback widget. Options
+  # can be used to override default settings like forum id.
+  # e.g. uservoice_config_javascript(forum_id => 12345)
+  # See https://ACCOUNT.uservoice.com/admin2/docs#/widget for options 
+  # available.
   #
   def uservoice_config_javascript(options={})
-    config = @uservoice_configuration.dup
+    config = @uservoice_configuration['uservoice_options'].dup
     config.merge!(options)
-    "<script type=\"text/javascript\"> var uservoiceOptions = #{config.to_json}; </script>"
+
+    if @uservoice_sso_token
+      config.merge!({:params => {:sso => @uservoice_sso_token.data}})
+    end
+
+    <<-EOS
+      <script type=\"text/javascript\">
+        var uservoiceOptions = #{config.to_json};
+      </script>
+    EOS
   end
 
 end

data/lib/uservoice/uservoice_token.rb

@@ -0,0 +1,32 @@
+# This module represents an encrypted token
+# to authenticate a user against the uservoice
+# service.
+#
+# Author::    Alexander Greim  (mailto:alexxx@iltempo.de)
+# Copyright:: Copyright (c) 2010 il tempo
+# License::   Distributes under the same terms as Ruby
+
+module Uservoice
+  class Token
+    attr_reader :data
+
+    # Creates a sign-in token to authenticate user against
+    # the uservoice service.
+    # See https://ACCOUNT.uservoice.com/admin2/docs#/sso for
+    # data properties available.
+    #
+    def initialize(key, api_key, data)
+      data.merge!({:expires => (Time.now + 5 * 60).to_s})
+
+      crypt_key = EzCrypto::Key.with_password(key, api_key)
+      encrypted_data = crypt_key.encrypt(data.to_json)
+
+      @data = CGI.escape(Base64.encode64(encrypted_data).gsub(/\n/, ''))
+    end
+
+    def to_s #:nodoc:
+      @data
+    end
+
+  end
+end

data/lib/uservoice.rb

@@ -6,16 +6,21 @@ ActiveSupport::Dependencies.load_once_paths.delete(path)
 module Uservoice
 end
 
-require 'class_methods'
+require 'cgi'
+require 'rubygems'
+require 'ezcrypto'
+require 'uservoice_token'
 require 'instance_methods'
 
 module ActionController #:nodoc:
   class Base #:nodoc:
-    cattr_accessor :uservoice_configuration
-    before_filter :uservoice_init
     helper :uservoice
+    before_filter :load_uservoice_config
 
     include Uservoice::InstanceMethods
-    extend Uservoice::ClassMethods
+
+    def self.enable_uservoice
+      warn "[DEPRECATION] 'enable_uservoice' is deprecated. Uservoice is loaded by default in every controller now."
+    end
   end
-end
+end

data/test/test_uservoice.rb

@@ -1,13 +1,13 @@
 require 'helper'
 
 class MyUservoiceController < ActionController::Base
-  def self.uservoice_configuration_file
+
+  def uservoice_configuration_file
     File.dirname(__FILE__) + '/uservoice_test.yml'
   end
-  enable_uservoice
 
   def assignment
-    render :text => nil
+    render :nothing => true
   end
 
   def config_js_default
@@ -23,26 +23,8 @@ class MyUservoiceController < ActionController::Base
   end
 end
 
-class UservoiceTest < ActiveSupport::TestCase
-
-  def setup
-    @my_controller = MyUservoiceController.new
-  end
-
-  ['uservoice_configuration_file'].each do |method|
-    test "should add class method '#{method}' to controller classes" do
-      assert MyUservoiceController.methods.include?(method)
-    end
-  end
-
-  ['uservoice_init'].each do |method|
-    test "should add instance method '#{method}' to controller classes" do
-      assert @my_controller.methods.include?(method)
-    end
-  end
-end
 
-class MyUservoiceControllerTest < ActionController::TestCase
+class UservoiceControllerTest < ActionController::TestCase
   tests MyUservoiceController
 
   def setup
@@ -58,30 +40,23 @@ class MyUservoiceControllerTest < ActionController::TestCase
     end
   end
 
-  def test_controller
-    get :assignment
-    config = assigns('uservoice_configuration')
-    assert config.is_a?(Hash)
-    assert_equal 'test', config['key']
-  end
-
   def test_config_javascript_default
     get :config_js_default
-    assert_match Regexp.new('<script type="text/javascript"> var uservoiceOptions = .*</script>'), @response.body
+    assert_match Regexp.new('<script type="text/javascript">\s*var uservoiceOptions = .*\s*</script>'), @response.body
     assert_match Regexp.new('"host":"test.uservoice.com"'), @response.body
     assert_match Regexp.new('"forum":12345'), @response.body
   end
 
   def test_config_custom_forum
     get :config_js_custom_forum
-    assert_match Regexp.new('<script type="text/javascript"> var uservoiceOptions = .*</script>'), @response.body
+    assert_match Regexp.new('<script type="text/javascript">\s*var uservoiceOptions = .*\s*</script>'), @response.body
     assert_match Regexp.new('"forum":815'), @response.body
     assert_no_match Regexp.new('"forum":12345'), @response.body
   end
 
   def test_config_custom_alignment
     get :config_js_custom_alignment
-    assert_match Regexp.new('<script type="text/javascript"> var uservoiceOptions = .*</script>'), @response.body
+    assert_match Regexp.new('<script type="text/javascript">\s*var uservoiceOptions = .*\s*</script>'), @response.body
     assert_match Regexp.new('"forum":12345'), @response.body
     assert_match Regexp.new('"alignment":"right"'), @response.body
   end

data/test/test_uservoice_generator.rb

@@ -26,9 +26,15 @@ class UservoiceGeneratorTest < Test::Unit::TestCase
   def test_config_file_contains_settings
     run_generator('uservoice', 'my_name', '98765')
     config = read_config_file
-    assert_equal 'my_name', config['key']
-    assert_equal 'my_name.uservoice.com', config['host']
-    assert_equal 98765, config['forum']
+    assert_equal 'my_name', config['uservoice_options']['key']
+    assert_equal 'my_name.uservoice.com', config['uservoice_options']['host']
+    assert_equal 98765, config['uservoice_options']['forum']
+  end
+
+  def test_config_file_contains_api_key_if_given
+    run_generator('uservoice', 'my_name', '98765', 'testapikey')
+    config = read_config_file
+    assert_equal 'testapikey', config['uservoice_api']['api_key']
   end
 
   private
@@ -44,11 +50,11 @@ class UservoiceGeneratorTest < Test::Unit::TestCase
     end
 
     def read_config_file
-      YAML::load(IO.read(File.join(fake_rails_root, 'config/uservoice.yml')))['uservoice_options']
+      YAML::load(IO.read(File.join(fake_rails_root, 'config/uservoice.yml')))
     end
 
     def run_generator(*options)
       Rails::Generator::Scripts::Generate.new.run(options, :destination => fake_rails_root, :quiet => true)
     end
 
-end
+end

data/test/test_uservoice_sso.rb

@@ -0,0 +1,39 @@
+require 'helper'
+
+class MyUservoiceSsoController < ActionController::Base
+
+  def uservoice_configuration_file
+    File.dirname(__FILE__) + '/uservoice_sso_test.yml'
+  end
+
+  def action_with_sso
+    set_uservoice_sso(:guid => 123, :display_name => 'Bancheff', :email => 'chef@bahn.de')
+    render :inline => '<%= uservoice_config_javascript %>'
+  end
+
+end
+
+class UservoiceSsoTest < ActionController::TestCase
+  tests MyUservoiceSsoController
+
+  def setup
+    @my_controller = MyUservoiceSsoController.new
+    @request = ActionController::TestRequest.new
+    @response = ActionController::TestResponse.new
+
+    ActionController::Routing::Routes.draw do |map|
+      map.connect 'action_with_sso', :controller => 'my_uservoice_sso', :action => :action_with_sso
+    end
+  end
+
+  def test_sso_token_set
+    get :action_with_sso
+    assert_match Regexp.new('<script type="text/javascript">\s*var uservoiceOptions = .*\s*</script>'), @response.body
+    assert_match Regexp.new('"params":\{"sso":".*"\}'), @response.body
+  end
+
+  def test_api_key_not_to_appear
+    get :action_with_sso
+    assert_no_match /api_key/, @response.body
+  end
+end

data/test/test_uservoice_token.rb

@@ -0,0 +1,24 @@
+require 'helper'
+
+class UservoiceTokenTest < Test::Unit::TestCase
+
+  def setup
+    @key = 'test'
+    @api_key = 'testapikey'
+    @user_data = {:guid => 123}
+    @token = Uservoice::Token.new(@key, @api_key, @user_data)
+  end
+
+  def test_token_does_not_contain_line_breaks
+    assert_no_match /\n/, @token.to_s
+  end
+
+  def test_can_be_decrypted
+    crypt_key = EzCrypto::Key.with_password(@key, @api_key)
+    encrypted_data = Base64::decode64(CGI.unescape(@token.data))
+    data = JSON.parse(crypt_key.decrypt(encrypted_data)).symbolize_keys
+
+    assert_equal @user_data, data
+  end
+
+end

data/test/uservoice_sso_test.yml

@@ -0,0 +1,13 @@
+uservoice_options:
+  key: test
+  host: test.uservoice.com
+  forum: 12345
+  showTab: true
+  alignment: left
+  background_color: "#f00"
+  text_color: white
+  hover_color: "#06C"
+  lang: en
+
+uservoice_api:
+  api_key: testapikey

data/test/uservoice_test.yml

@@ -1,12 +1,10 @@
 uservoice_options:
-  # required
   key: test
   host: test.uservoice.com
   forum: 12345
   showTab: true
-  # optional
   alignment: left
   background_color: "#f00"
   text_color: white
   hover_color: "#06C"
-  lang: en
+  lang: en

data/uservoice.gemspec

@@ -5,14 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{uservoice}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alexander Greim"]
-  s.date = %q{2010-01-01}
-  s.description = %q{This adds Uservoice user feedback to your Rails application.
-      You can set Uservoice properties in a central configuration file and override
-      settings like forum id (for payed accounts) in your layout or view.}
+  s.date = %q{2010-05-25}
+  s.description = %q{This adds Uservoice support to your Rails application
+      including single sign-on.}
   s.email = %q{alexxx@iltempo.de}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -20,6 +19,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".gitignore",
+     "CHANGELOG.rdoc",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
@@ -29,31 +29,36 @@ Gem::Specification.new do |s|
      "generators/uservoice/uservoice_generator.rb",
      "init.rb",
      "lib/uservoice.rb",
-     "lib/uservoice/class_methods.rb",
      "lib/uservoice/instance_methods.rb",
      "lib/uservoice/uservoice_helper.rb",
+     "lib/uservoice/uservoice_token.rb",
      "test/helper.rb",
      "test/test_uservoice.rb",
      "test/test_uservoice_generator.rb",
+     "test/test_uservoice_sso.rb",
+     "test/test_uservoice_token.rb",
+     "test/uservoice_sso_test.yml",
      "test/uservoice_test.yml",
      "uservoice.gemspec"
   ]
   s.homepage = %q{http://github.com/iltempo/uservoice}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Uservoice for your Rails application}
   s.test_files = [
     "test/helper.rb",
      "test/test_uservoice.rb",
-     "test/test_uservoice_generator.rb"
+     "test/test_uservoice_generator.rb",
+     "test/test_uservoice_sso.rb",
+     "test/test_uservoice_token.rb"
   ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
     else
     end
   else

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: uservoice
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Alexander Greim
@@ -9,14 +15,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-01 00:00:00 +01:00
+date: 2010-05-25 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
 description: |-
-  This adds Uservoice user feedback to your Rails application.
-        You can set Uservoice properties in a central configuration file and override
-        settings like forum id (for payed accounts) in your layout or view.
+  This adds Uservoice support to your Rails application
+        including single sign-on.
 email: alexxx@iltempo.de
 executables: []
 
@@ -27,6 +32,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .gitignore
+- CHANGELOG.rdoc
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -36,12 +42,15 @@ files:
 - generators/uservoice/uservoice_generator.rb
 - init.rb
 - lib/uservoice.rb
-- lib/uservoice/class_methods.rb
 - lib/uservoice/instance_methods.rb
 - lib/uservoice/uservoice_helper.rb
+- lib/uservoice/uservoice_token.rb
 - test/helper.rb
 - test/test_uservoice.rb
 - test/test_uservoice_generator.rb
+- test/test_uservoice_sso.rb
+- test/test_uservoice_token.rb
+- test/uservoice_sso_test.yml
 - test/uservoice_test.yml
 - uservoice.gemspec
 has_rdoc: true
@@ -54,21 +63,27 @@ 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"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Uservoice for your Rails application
@@ -76,3 +91,5 @@ test_files:
 - test/helper.rb
 - test/test_uservoice.rb
 - test/test_uservoice_generator.rb
+- test/test_uservoice_sso.rb
+- test/test_uservoice_token.rb

data/lib/uservoice/class_methods.rb

@@ -1,26 +0,0 @@
-# This module holds all class methods to be
-# included into ActionController::Base class
-# for enabling uservoice in a Rails app.
-#
-# Author::    Alexander Greim  (mailto:alexxx@iltempo.de)
-# Copyright:: Copyright (c) 2010 il tempo
-# License::   Distributes under the same terms as Ruby
-
-module Uservoice
-  module ClassMethods
-
-    # Loads uservoice configuration from yaml file.
-    #
-    def enable_uservoice
-      self.uservoice_configuration ||= begin
-        configuration = YAML::load(IO.read(self.uservoice_configuration_file))
-        HashWithIndifferentAccess.new(configuration['uservoice_options'])
-      end
-    end
-
-    def uservoice_configuration_file #:nodoc:
-      "#{RAILS_ROOT}/config/uservoice.yml"
-    end
-
-  end
-end