bothersme_list 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cf8537a4e0b22a10c739916b91b93aa979ad0f2
-  data.tar.gz: ded5e7d892a90f4d896dee4d745e5bbc3f9bb757
+  metadata.gz: dfcf599dded8856826d8164d69d81621226ed4e8
+  data.tar.gz: e045ba2a228ba63a08194fcbbb4e53d3fbf6dc5a
 SHA512:
-  metadata.gz: 0db4d4209d842475eadd4738825934287543c77fdb0cb4a2aee4b716624186f2cb10ef0c5ae206bba9711733b1b139f0da00985dc465cea8aafb9acff801d824
-  data.tar.gz: 28903bc465dda748a2f9c40a82cf158cff0751a9855f7204ef763a9476ab05020897c1ea9a81c5f3b9a30e5af246caf99bcdbf2fdf8d5a6d4a2e6e45edd85845
+  metadata.gz: 7ec88bec0a0e0cb2bae99ac31f0e5345336f8f5d627c864284c0c4d7c56fcf17b503811715111715f32ad44ac28bd854f06b23624e9e044abc1c9fccb28b1f9e
+  data.tar.gz: 8a6917ebd224a9d0768ffcddb541b12174c3831d65dcce1fc1820d8fd73befce02d77c60de218e60278d1ae21b4fa14c18eeccc981ce3da2d07afed416df4a62

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: NeJOLpDexmJMxDm28lp4hnlRHLP8TNPfi

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.2
+  - 2.1.4

data/.yardopts

@@ -0,0 +1 @@
+- CHANGELOG*

data/CHANGELOG.md

@@ -1,3 +1,9 @@
 ## v0.0.1
 
-* Initial release
+* Initial release
+
+## v0.0.2
+
+* Updated documentation
+* Fixed issue with html encoding of the script tag
+* Added unit test to check tag

data/Gemfile

@@ -2,3 +2,14 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in bothersme_list.gemspec
 gemspec
+
+gem "rake"
+gem "bundler"
+
+group :test do
+  gem "rspec"
+
+  if ENV["CI"]
+    gem "coveralls", require: false
+  end
+end

data/README.md

@@ -1,4 +1,4 @@
-# BothersmeList
+# Bothersme List [![Build Status](https://travis-ci.org/BothersMe/bothersme_list.svg?branch=master)](https://travis-ci.org/BothersMe/bothersme_list) [![Code Climate](https://codeclimate.com/github/BothersMe/bothersme_list/badges/gpa.svg)](https://codeclimate.com/github/BothersMe/bothersme_list) [![Coverage Status](https://coveralls.io/repos/BothersMe/bothersme_list/badge.svg)](https://coveralls.io/r/BothersMe/bothersme_list) [![Dependency Status](https://www.versioneye.com/user/projects/5598d2186166340022000087/badge.svg?style=flat)](https://www.versioneye.com/user/projects/5598d2186166340022000087)
 
  Inserts "Track an Issue" button on a side
 
@@ -42,3 +42,7 @@ At the end of your layout (usually application.hmtl.erb file) before ```</body>`
 ## CHANGELOG
 
 See [here](CHANGELOG.md).
+
+## Ruby Doc
+
+Is [here](http://www.rubydoc.info/github/BothersMe/bothersme_list/master/BothersmeList)

data/Rakefile

@@ -1,2 +1,4 @@
 require "bundler/gem_tasks"
-
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/bothersme_list.gemspec

@@ -17,7 +17,4 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
   spec.rubyforge_project = "bothersme_list"
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
 end

data/lib/bothersme_list.rb

@@ -2,14 +2,23 @@ require "bothersme_list/version"
 
 module BothersmeList
   # Inserts "Track an Issue" button on a side
+  # @see http://bothers.me as an example
   #
-  # Parameters:
-  #  type: 'website', 'camera', 'wearable'
-  #  company: 'YourCompanyName'
-  #  product: 'YourProductName' or nil if used for all products
+  # Usage:
   #
+  #    <%= issues_list('website', 'MyWebsite.com', 'MyProduct') %>
+  #
+  # right before "</body>" to asynchronously add "Track an Issue" button.
+  #
+  # @param [String, #read] type indicates the type of the product. Supported types are: 'website', 'camera', 'wearable'
+  # @param [String, #read] company is your company name camel case like 'MyCompany'
+  # @param [optional, String, #read] product name of your product came case like "My Product", you can pass nil to render issues for all products
+  # @param [optional, String, #read] side which side to render on, supported 'left', 'right', default: 'right'
+  # @param [optional, String, #read] textColor CSS color to render as foreground color. default 'white'
+  # @param [optional, String, #read] bgColor CSS color to render as background color, default '#55B055'
+  # @return [String] the HTML safe <script> tag containing code to add the button
   def issues_list(type, company, product=nil, side='right', textColor='white', bgColor='#55B055')
-    %{
+    button_script = %{
       <!-- Bothers.Me button -->
       <script>
           (function(w,d,fn,params) {
@@ -34,6 +43,8 @@ module BothersmeList
                             'user': '' }});
       </script>
     }
+    button_script = button_script.html_safe if defined?(Rails)
+    return button_script
   end
 end
 

data/lib/bothersme_list/version.rb

@@ -1,3 +1,3 @@
 module BothersmeList
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/bothersme_list_spec.rb

@@ -14,5 +14,8 @@ describe BothersmeList do
     it "should include product" do
       expect(test_instance.issues_list("a", "b", "zzzz")).to include("zzzz")
     end
+    it "should include script tag unencoded" do
+      expect(test_instance.issues_list("a", "b")).to include("</script>")
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1 +1,3 @@
 require 'bothersme_list'
+require 'coveralls'
+Coveralls.wear!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bothersme_list
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Bothers.Me
@@ -9,49 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2015-07-05 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+dependencies: []
 description: Adds 'Report an Issue' button to your website to allow reporting issues
   published on bothers.me
 email:
@@ -60,7 +18,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
+- ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt