bugherd 0.0.2 → 0.0.3

data/README.md

@@ -1,6 +1,6 @@
 # BugHerd gem
 
-Add the BugHerd widget to your Rails site.
+Add the BugHerd widget to your Rails site. [Get a BugHerd account](http://www.bugherd.com/).
 
 ## Installation
 
@@ -20,6 +20,8 @@ BugHerd.configure do |config|
 end
 ```
 
+Alternatively you can set an environment variable called BUGHERD_PROJECT_KEY.
+
 You can obtain the project key from your project's installation options in BugHerd.
 
 Now add to the *head* tag in your layout(s):
@@ -27,3 +29,35 @@ Now add to the *head* tag in your layout(s):
 ```ruby
 <%= bugherd_tag %>
 ```
+
+## Meta data
+
+BugHerd allows you to pass in extra data which will be added as metadata to any bug your users may log on the page where the widget is rendered.
+
+```ruby
+<%= bugherd_tag :metadata => {
+  :user_id => current_user.id.to_s,
+  :controller => controller.controller_name
+} %>
+```
+
+## Translation
+
+If you are using the public "Send Feedback" option on your project, you can customise the display text:
+
+```ruby
+<%= bugherd_tag :feedback => {
+  :tab_text => "Stuur commentaar",
+  :option_title_text => "Kies een optie",
+  :option_pin_text => "Ik wil graag iets op deze pagina aanwijzen.",
+  :option_site_text => "Ik heb commentaar over deze pagina in z'n geheel.",
+  :feedback_entry_placeholder => "schrijf hier uw commentaar",
+  :feedback_email_placeholder => "uw email adres",
+  :feedback_submit_text => "verstuur commentaar",
+  :confirm_success_text => "Commentaar is verstuurd.",
+  :confirm_loading_text => "Commentaar wordt verstuurd...",
+  :confirm_close_text => "sluiten",
+  :confirm_error_text => "Er is een fout opgetreden en commentaar kon niet verstuurd worden.",
+  :confirm_retry_text => "Probeer opnieuw",
+} %>
+```

data/lib/bugherd/helpers/bugherd_helper.rb

@@ -1,12 +1,13 @@
 module BugHerdHelper
 
   def bugherd_tag(options = {})
+    key = ENV['BUGHERD_PROJECT_KEY'] || BugHerd.configuration.project_key
     javascript_tag "
       var BugHerdConfig = #{options.to_json};
       (function (d, t) {
         var bh = d.createElement(t), s = d.getElementsByTagName(t)[0];
         bh.type = 'text/javascript';
-        bh.src = '//www.bugherd.com/sidebarv2.js?apikey=#{BugHerd.configuration.project_key}';
+        bh.src = '//www.bugherd.com/sidebarv2.js?apikey=#{key}';
         s.parentNode.insertBefore(bh, s);
       })(document, 'script');
     "

data/lib/bugherd/version.rb

@@ -1,3 +1,3 @@
 module BugHerd
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/dummy/log/test.log

@@ -163,3 +163,19 @@ Completed 200 OK in 9ms (Views: 8.3ms | ActiveRecord: 0.0ms)
    (0.1ms)  rollback transaction
    (0.0ms)  begin transaction
    (0.0ms)  rollback transaction
+Connecting to database specified by database.yml
+   (0.3ms)  begin transaction
+Processing by MainController#index as HTML
+  Rendered main/index.html.erb within layouts/application (1.6ms)
+Completed 200 OK in 11ms (Views: 11.2ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+Connecting to database specified by database.yml
+   (0.3ms)  begin transaction
+Processing by MainController#index as HTML
+  Rendered main/index.html.erb within layouts/application (1.8ms)
+Completed 200 OK in 12ms (Views: 11.5ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bugherd
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-04 00:00:00.000000000 Z
+date: 2013-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -43,7 +43,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ''
+description: BugHerd lets you report and manage issues directly from any website it's
+  embedded on.
 email:
 - support@bugherd.com
 executables: []
@@ -106,24 +107,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1290492949082979729
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1290492949082979729
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Quick way to add BugHerd to your Rails project!
+summary: Embedded issue tracker for websites and web apps
 test_files:
 - test/bugherd_test.rb
 - test/dummy/app/assets/javascripts/application.js
@@ -160,3 +155,4 @@ test_files:
 - test/dummy/README.rdoc
 - test/dummy/script/rails
 - test/test_helper.rb
+has_rdoc: