bazarvoice 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  data.tar.gz: f699bda014b26c32c479e724172697bbf7b4a8ff
+  metadata.gz: f4df8da0dc0bb81c3e75a5f940053b819fd149b2
+SHA512: 
+  data.tar.gz: 6b495a137d14010fdf8ae1b77a4c5e2bd5c39ce6fc0f45fc33aba444c3cf76ed61712919426c574b4424a2a19f604952a4419c503d07cb9d419a2753da63a777
+  metadata.gz: 46a57405d17dad5e266f4b347c80d129aea4ffdce03db1e55d082fb28a79c6f7bf50db8271f56117de5f1a9c7679cbaad9d68be4925260eb38bb1290ca436a86

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+rdoc/
+coverage/
+pkg/
+.rvmrc
+*.rbc

data/CHANGELOG.rdoc

@@ -0,0 +1,6 @@
+== v0.0.1 (2013-10-16)
+
+* Enhancements
+
+  * added all conversion API
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 - Sapna Jadon
+
+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.rdoc

@@ -0,0 +1,82 @@
+= bazarvoice implementation for Ruby on Rails
+
+This adds {bazarvoice}[http://www.bazarvoice.com] support to your
+Rails application including single sign-on.
+
+== Installation
+
+=== As a gem
+  gem install bazarvoice
+
+=== As a Rails dependency
+  config.gem 'bazarvoice', :source => 'http://gemcutter.org'
+
+=== As a Rails plugin
+  ./script/plugin install http://github.com/iltempo/bazarvoice.git
+
+
+== Configuration
+
+Generate files for your app:
+  ./script/generate bazarvoice <key> <forum> [<api_key>]
+Where <key> is the bazarvoice account name and <forum> the id of your main forum.
+Find both settings in widgets section of the admin interface of bazarvoice.
+Your API key <api_key> can be found in the API section of the admin documentation.
+
+Default properties are stored in a file named bazarvoice.yml in the config
+directory of your Rails application. Make it fitting to your needs. Feel free to
+use erb expressions.
+
+Add javascript function and configuration to HTML HEAD section of your template file:
+  <%= bazarvoice_config_javascript %>
+
+You can override default bazarvoice settings in your view:
+  <%= bazarvoice_config_javascript(:alignment => 'right', :forum => 12983) %>
+
+
+== Single Sign-On
+
+Single sign-on authenticates your bazars automatically against the bazarvoice
+service. A second login is not needed any more.
+
+bazarvoice is allowing single sign-on starting from the Bronze plan.
+http://bazarvoice.com/signup?ref=nav
+
+To use single sign-on with on bazarvoice you have to set your api_key in 
+config/bazarvoice.yml. Find it on
+https://ACCOUNT.bazarvoice.com/admin2/docs#/legacy_api
+
+The bazar properties can be set via the :sso parameter.
+     <%= bazarvoice_config_javascript(:sso => {:guid => @current_bazar.id, :email => @current_bazar.email}) %>
+
+Parameter <em>:guid</em> should be unique identifier, for example the bazar id in your
+system. bazarvoice recommends setting <em>:email</em> parameter to enable bazars to get
+updates and notifications via email.
+See https://ACCOUNT.bazarvoice.com/admin2/docs#/sso for a list of parameters
+available.
+
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a
+  commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+
+==Author
+
+{Sapna Jadon}
+
+
+
+
+
+== Copyright
+
+Copyright (c) 2013

data/bazarvoice.gemspec

@@ -0,0 +1,59 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bazarvoice}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sapna Jadon"]
+  s.date = %q{2013-10-16}
+  s.description = %q{This adds bazarvoice support to your Rails application
+      including single sign-on.}  
+  s.extra_rdoc_files = [
+    "CHANGELOG.rdoc",
+     "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG.rdoc",
+     "LICENSE",
+     "README.rdoc",
+     "generators/bazarvoice/USAGE",
+     "generators/bazarvoice/templates/bazarvoice_template.yml",
+     "generators/bazarvoice/bazarvoice_generator.rb",
+     "init.rb",
+     "lib/bazarvoice.rb",
+     "lib/bazarvoice/instance_methods.rb",
+     "lib/bazarvoice/token.rb",
+     "lib/bazarvoice/view_helpers.rb",     
+     "bazarvoice.gemspec"
+  ]
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{bazarvoice for your Rails application}
+  
+  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
+      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
+

data/generators/bazarvoice/USAGE

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

data/generators/bazarvoice/bazarvoice_generator.rb

@@ -0,0 +1,15 @@
+class UservoiceGenerator < Rails::Generator::Base
+
+  def manifest
+    unless [2, 3].include?(args.length)
+      puts usage_message
+      exit 1
+    end
+
+    record do |m|
+      m.directory('config')
+      m.template 'bazarvoice_template.yml', 'config/bazarvoice.yml'
+    end
+  end
+
+end

data/generators/bazarvoice/templates/bazarvoice_template.yml

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

data/init.rb

@@ -0,0 +1 @@
+require 'bazarvoice'

data/lib/bazarvoice.rb

@@ -0,0 +1,11 @@
+module Bazarvoice
+end
+
+require 'cgi'
+require 'ezcrypto'
+require 'bazarvoice/token'
+require 'bazarvoice/instance_methods'
+require 'bazarvoice/view_helpers'
+
+ActionController::Base.send(:include, Bazarvoice::InstanceMethods)
+ActionView::Base.send(:include, Bazarvoice::BazarvoiceViewHelpers)

data/lib/bazarvoice/instance_methods.rb

@@ -0,0 +1,40 @@
+# This module holds all instance methods to be
+# included into ActionController::Base class
+# for enabling bazavoice in a Rails app.
+#
+# Author::    Sapna J 
+# Copyright:: Copyright (c) 2013 il tempo
+# License::   Distributes under the same terms as Ruby
+
+require "erb"
+
+module Bazarvoice
+  module InstanceMethods
+
+    # Making helper method available when module
+    # gets included into ActionController::Base.
+    #
+    def self.included(mod)
+      mod.send(:helper_method, :bazarvoice_configuration)
+    end
+
+    # Set bazarvoice configuration file path.
+    # Can be overridden.
+    #
+    def bazarvoice_configuration_file #:nodoc:
+      "#{::Rails.root}/config/bazarvoice.yml"
+    end
+
+    # Returns the bazarvoice configuration hash.
+    # It's been lazy loaded and cached in the controller class.
+    #
+    def bazarvoice_configuration
+      @@bazarvoice_configuration ||= begin
+        config = ERB.new(IO.read(bazarvoice_configuration_file)).result
+        configuration = YAML::load(config)
+        HashWithIndifferentAccess.new(configuration)
+      end
+    end
+
+  end
+end

data/lib/bazarvoice/token.rb

@@ -0,0 +1,32 @@
+# This module represents an encrypted token
+# to authenticate a bazar against the bazarvoice
+# service.
+#
+# Author::    Sapna J 
+# Copyright:: Copyright (c) 2013 il tempo
+# License::   Distributes under the same terms as Ruby
+
+module Bazarvoice
+  class Token
+    attr_reader :data
+
+    # Creates a sign-in token to authenticate bazar against
+    # the bazarvoice service.
+    # See https://ACCOUNT.bazarvoice.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/bazarvoice/view_helpers.rb

@@ -0,0 +1,45 @@
+# This module holds all frontend helper methods
+# for bazarvoice 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 Bazarvoice
+  module BazarvoiceViewHelpers
+
+    # Renders javascript to configure bazarvoice feedback widget. Options
+    # can be used to override default settings like forum id.
+    # e.g. bazarvoice_config_javascript(forum_id => 12345)
+    # See https://ACCOUNT.bazarvoice.com/admin2/docs#/widget for options
+    # available.
+    #
+    def bazarvoice_config_javascript(options={})
+      config = bazarvoice_configuration['bazarvoice_options'].dup
+      config.merge!(options)
+
+      if config[:sso] && config[:sso][:guid]
+        config.merge!(:params => {:sso => Bazarvoice::Token.new(
+          bazarvoice_configuration['bazarvoice_options']['key'],
+          bazarvoice_configuration['bazarvoice_api']['api_key'],
+          config.delete(:sso)).to_s})
+      end
+
+      <<-EOS
+        <script type="text/javascript">
+		$(document).ready(function() {
+		  $.ajaxSetup({ cache: true });
+		  $.getJSON(api_server+"/reviews.json?callback=?", 
+		   "apiversion=4.9&include=products,authors&filter=DisplayLocale:en_US&passkey=" + api_key + "&limit=" + num_items,
+		    function(json){
+		      jQuery.each(json.Results, function(index, review) {
+			$("#module").append("<h1>"+review['Title']+"</h1>");
+		      });
+		  });
+		});
+	</script>
+      EOS
+    end
+
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: bazarvoice
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Sapna Jadon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-10-16 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ezcrypto
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.7.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - &id003 !ruby/object:Gem::Version 
+        version: "2.1"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - *id003
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - *id003
+  type: :runtime
+  version_requirements: *id005
+description: |-
+  This adds bazarvoice support to your Rails application
+        including single sign-on.
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.rdoc
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- CHANGELOG.rdoc
+- LICENSE
+- README.rdoc
+- generators/bazarvoice/USAGE
+- generators/bazarvoice/templates/bazarvoice_template.yml
+- generators/bazarvoice/bazarvoice_generator.rb
+- init.rb
+- lib/bazarvoice.rb
+- lib/bazarvoice/instance_methods.rb
+- lib/bazarvoice/token.rb
+- lib/bazarvoice/view_helpers.rb
+- bazarvoice.gemspec
+homepage: 
+licenses: []
+
+metadata: {}
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - &id006 
+    - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id006
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.1.5
+signing_key: 
+specification_version: 3
+summary: bazarvoice for your Rails application
+test_files: []
+