uservoice 0.2.2 → 0.3.0

data/README.rdoc

@@ -26,19 +26,17 @@ Your API key <api_key> can be found in the API section of the admin documentatio
 Default properties are stored in a file named uservoice.yml in the config
 directory of your Rails application. Make it fitting to your needs.
 
-Link Uservoice javascript file and add configuration to HTML HEAD
-section of your template file:
-  <%= javascript_include_tag 'uservoice' %>
+Add javascript function and configuration to HTML HEAD section of your template file:
   <%= uservoice_config_javascript %>
 
 You can override default uservoice settings in your view:
   <%= uservoice_config_javascript(:alignment => 'right', :forum => 12983) %>
 
 
-== Single Sign-on
+== Single Sign-On
 
 Single sign-on authenticates your users automatically against the Uservoice
-service. The second login is not needed any more.
+service. A second login is not needed any more.
 
 Uservoice is allowing single sign-on starting from the Bronze plan.
 http://uservoice.com/signup?ref=nav
@@ -47,12 +45,10 @@ 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
+The user properties can be set via the :sso parameter.
+     <%= uservoice_config_javascript(:sso => {:guid => @current_user.id, :email => @current_user.email}) %>
 
-Parameter <em>:guid</em> should be unique identifier for example the user id in your
+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
@@ -70,6 +66,10 @@ available.
   commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
+
+This project is using {Semantic Versioning}[http://semver.org].
+
+
 == Copyright
 
 Copyright (c) 2010 {il tempo}[http://github.com/iltempo] -

data/Rakefile

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'rake'
 
 begin
@@ -11,8 +10,11 @@ begin
     gem.email = 'alexxx@iltempo.de'
     gem.homepage = 'http://github.com/iltempo/uservoice'
     gem.authors = ['Alexander Greim']
-    gem.version = '0.2.2'
+    gem.version = '0.3.0'
     gem.add_dependency('ezcrypto', '>= 0.7.2')
+    gem.add_dependency('activesupport', '>= 2.1')
+    gem.add_dependency('actionpack', '>= 2.1')
+    gem.add_dependency('rails', '>= 2.1')
     gem.has_rdoc = true
     gem.extra_rdoc_files = ["README.rdoc", "CHANGELOG.rdoc", "LICENSE"]
   end

data/generators/uservoice/uservoice_generator.rb

@@ -1,4 +1,5 @@
 class UservoiceGenerator < Rails::Generator::Base
+
   def manifest
     unless [2, 3].include?(args.length)
       puts usage_message
@@ -8,9 +9,7 @@ class UservoiceGenerator < Rails::Generator::Base
     record do |m|
       m.directory('config')
       m.template 'uservoice_template.yml', 'config/uservoice.yml'
-
-      m.directory('public/javascripts')
-      m.file 'uservoice.js', 'public/javascripts/uservoice.js'
     end
   end
+
 end

data/lib/uservoice/instance_methods.rb

@@ -9,14 +9,11 @@
 module Uservoice
   module InstanceMethods
 
-    # Loads uservoice configuration into a controller
-    # instance variable
+    # Making helper method available when module
+    # gets included into ActionController::Base.
     #
-    def load_uservoice_config
-      @uservoice_configuration = begin
-        configuration = YAML::load(IO.read(uservoice_configuration_file))
-        HashWithIndifferentAccess.new(configuration)
-      end
+    def self.included(mod)
+      mod.send(:helper_method, :uservoice_configuration)
     end
 
     # Set uservoice configuration file path.
@@ -26,16 +23,14 @@ module Uservoice
       "#{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.
+    # Returns the uservoice configuration hash.
+    # It's been lazy loaded and cached in the controller class.
     #
-    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)
+    def uservoice_configuration
+      @@uservoice_configuration ||= begin
+        configuration = YAML::load(IO.read(uservoice_configuration_file))
+        HashWithIndifferentAccess.new(configuration)
+      end
     end
 
   end

data/lib/uservoice/view_helpers.rb

@@ -0,0 +1,44 @@
+# This module holds all frontend helper methods
+# for 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 UservoiceViewHelpers
+
+    # 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['uservoice_options'].dup
+      config.merge!(options)
+
+      if config[:sso] && config[:sso][:guid]
+        config.merge!(:params => {:sso => Uservoice::Token.new(
+          uservoice_configuration['uservoice_options']['key'],
+          uservoice_configuration['uservoice_api']['api_key'],
+          config.delete(:sso)).to_s})
+      end
+
+      <<-EOS
+        <script type=\"text/javascript\">
+          function _loadUserVoice() {
+            var s = document.createElement('script');
+            s.setAttribute('type', 'text/javascript');
+            s.setAttribute('src', ("https:" == document.location.protocol ? "https://" : "http://") + "cdn.uservoice.com/javascripts/widgets/tab.js");
+            document.getElementsByTagName('head')[0].appendChild(s);
+          }
+          _loadSuper = window.onload;
+          window.onload = (typeof window.onload != 'function') ? _loadUserVoice : function() { _loadSuper(); _loadUserVoice(); };
+          var uservoiceOptions = #{config.to_json};
+        </script>
+      EOS
+    end
+
+  end
+end

data/lib/uservoice.rb

@@ -1,26 +1,11 @@
-path = File.join(File.dirname(__FILE__), 'uservoice')
-$LOAD_PATH << path
-ActiveSupport::Dependencies.load_paths << path
-ActiveSupport::Dependencies.load_once_paths.delete(path)
-
 module Uservoice
 end
 
 require 'cgi'
-require 'rubygems'
 require 'ezcrypto'
-require 'uservoice_token'
-require 'instance_methods'
-
-module ActionController #:nodoc:
-  class Base #:nodoc:
-    helper :uservoice
-    before_filter :load_uservoice_config
+require 'uservoice/token'
+require 'uservoice/instance_methods'
+require 'uservoice/view_helpers'
 
-    include Uservoice::InstanceMethods
-
-    def self.enable_uservoice
-      warn "[DEPRECATION] 'enable_uservoice' is deprecated. Uservoice is loaded by default in every controller now."
-    end
-  end
-end
+ActionController::Base.send(:include, Uservoice::InstanceMethods)
+ActionView::Base.send(:include, Uservoice::UservoiceViewHelpers)

data/test/test_uservoice.rb

@@ -42,23 +42,22 @@ class UservoiceControllerTest < ActionController::TestCase
 
   def test_config_javascript_default
     get :config_js_default
-    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
+    assert_match Regexp.new('^\s*<script type="text/javascript">(.*)</script>\s*$', Regexp::MULTILINE), @response.body
+    assert_match /var uservoiceOptions = \{.*\}/, @response.body
+    assert_match /"host":"test.uservoice.com"/, @response.body
+    assert_match /"forum":12345/, @response.body
   end
 
   def test_config_custom_forum
     get :config_js_custom_forum
-    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
+    assert_match /"forum":815/, @response.body
+    assert_no_match /"forum":12345/, @response.body
   end
 
   def test_config_custom_alignment
     get :config_js_custom_alignment
-    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
+    assert_match /"forum":12345/, @response.body
+    assert_match /"alignment":"right"/, @response.body
   end
 end
 

data/test/test_uservoice_generator.rb

@@ -15,10 +15,7 @@ class UservoiceGeneratorTest < Test::Unit::TestCase
     run_generator('uservoice', 'test', '12345')
     new_files = file_list - @original_files
     expected_files = ['config',
-                      'config/uservoice.yml',
-                      'public',
-                      'public/javascripts',
-                      'public/javascripts/uservoice.js']
+                      'config/uservoice.yml']
 
     assert_equal expected_files, new_files
   end

data/test/test_uservoice_sso.rb

@@ -3,12 +3,11 @@ require 'helper'
 class MyUservoiceSsoController < ActionController::Base
 
   def uservoice_configuration_file
-    File.dirname(__FILE__) + '/uservoice_sso_test.yml'
+    File.dirname(__FILE__) + '/uservoice_test.yml'
   end
 
   def action_with_sso
-    set_uservoice_sso(:guid => 123, :display_name => 'Bancheff', :email => 'chef@bahn.de')
-    render :inline => '<%= uservoice_config_javascript %>'
+    render :inline => '<%= uservoice_config_javascript(:sso => {:guid => 123, :display_name => "Bancheff", :email => "chef@bahn.de"}) %>'
   end
 
 end
@@ -28,8 +27,8 @@ class UservoiceSsoTest < ActionController::TestCase
 
   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
+    assert_match Regexp.new('<script type="text/javascript">.*var uservoiceOptions = .*\s*</script>', Regexp::MULTILINE), @response.body
+    assert_match /"params":\{"sso":".*"\}/, @response.body
   end
 
   def test_api_key_not_to_appear

data/test/uservoice_test.yml

@@ -8,3 +8,6 @@ uservoice_options:
   text_color: white
   hover_color: "#06C"
   lang: en
+
+uservoice_api:
+  api_key: testapikey

data/uservoice.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{uservoice}
-  s.version = "0.2.2"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alexander Greim"]
-  s.date = %q{2010-05-25}
+  s.date = %q{2010-06-09}
   s.description = %q{This adds Uservoice support to your Rails application
       including single sign-on.}
   s.email = %q{alexxx@iltempo.de}
@@ -25,20 +25,18 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "generators/uservoice/USAGE",
-     "generators/uservoice/templates/uservoice.js",
      "generators/uservoice/templates/uservoice_template.yml",
      "generators/uservoice/uservoice_generator.rb",
      "init.rb",
      "lib/uservoice.rb",
      "lib/uservoice/instance_methods.rb",
-     "lib/uservoice/uservoice_helper.rb",
-     "lib/uservoice/uservoice_token.rb",
+     "lib/uservoice/token.rb",
+     "lib/uservoice/view_helpers.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"
   ]
@@ -61,11 +59,20 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<ezcrypto>, [">= 0.7.2"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.1"])
+      s.add_runtime_dependency(%q<actionpack>, [">= 2.1"])
+      s.add_runtime_dependency(%q<rails>, [">= 2.1"])
     else
       s.add_dependency(%q<ezcrypto>, [">= 0.7.2"])
+      s.add_dependency(%q<activesupport>, [">= 2.1"])
+      s.add_dependency(%q<actionpack>, [">= 2.1"])
+      s.add_dependency(%q<rails>, [">= 2.1"])
     end
   else
     s.add_dependency(%q<ezcrypto>, [">= 0.7.2"])
+    s.add_dependency(%q<activesupport>, [">= 2.1"])
+    s.add_dependency(%q<actionpack>, [">= 2.1"])
+    s.add_dependency(%q<rails>, [">= 2.1"])
   end
 end
 

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Alexander Greim
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-25 00:00:00 +02:00
+date: 2010-06-09 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,6 +34,51 @@ dependencies:
         version: 0.7.2
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 1
+        version: "2.1"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 1
+        version: "2.1"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 1
+        version: "2.1"
+  type: :runtime
+  version_requirements: *id004
 description: |-
   This adds Uservoice support to your Rails application
         including single sign-on.
@@ -53,20 +98,18 @@ files:
 - README.rdoc
 - Rakefile
 - generators/uservoice/USAGE
-- generators/uservoice/templates/uservoice.js
 - generators/uservoice/templates/uservoice_template.yml
 - generators/uservoice/uservoice_generator.rb
 - init.rb
 - lib/uservoice.rb
 - lib/uservoice/instance_methods.rb
-- lib/uservoice/uservoice_helper.rb
-- lib/uservoice/uservoice_token.rb
+- lib/uservoice/token.rb
+- lib/uservoice/view_helpers.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

data/generators/uservoice/templates/uservoice.js

@@ -1,8 +0,0 @@
-function _loadUserVoice() {
-  var s = document.createElement('script');
-  s.setAttribute('type', 'text/javascript');
-  s.setAttribute('src', ("https:" == document.location.protocol ? "https://" : "http://") + "cdn.uservoice.com/javascripts/widgets/tab.js");
-  document.getElementsByTagName('head')[0].appendChild(s);
-}
-_loadSuper = window.onload;
-window.onload = (typeof window.onload != 'function') ? _loadUserVoice : function() { _loadSuper(); _loadUserVoice(); };

data/lib/uservoice/uservoice_helper.rb

@@ -1,31 +0,0 @@
-# This module holds all frontend helper methods
-# for 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 UservoiceHelper
-
-  # 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['uservoice_options'].dup
-    config.merge!(options)
-
-    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/test/uservoice_sso_test.yml

@@ -1,13 +0,0 @@
-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