usersnap-rails 0.0.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c845d049ae07e8fc6d75769493a2848507e67bf
+  data.tar.gz: 224a330732000541b5ddb77401d228a807646fe8
+SHA512:
+  metadata.gz: 079516e6f9eb44062fa54daa02d54c54f996c06f43466acfaf7345680d245aaafeaaee19d1fe9cd66ebcc904bda8fb351b927446a23de2dd9c240115e71f362d
+  data.tar.gz: 088a06a5e26763b46ea675db65d10e461c8d75955934c98143430030e8b5e06b091d191c9b1f8eb0652c97d17e01954e1a144185cc432f5155e09101675119e1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in usersnap_rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 r11runner
+
+MIT License
+
+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.md

@@ -0,0 +1,77 @@
+# usersnap-rails
+
+The usersnap-rails gem integrates the [Usersnap](https://usersnap.com/) widget with the Rails asset pipeline.  
+In order to use it you have to [register an account at Usersnap](https://usersnap.com/#signup) and add your project. Each project has its own API-key.  
+This gem isn't maintained by the official Usersnap team, and it comes without any guarantee.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'usersnap-rails'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+### Include JavaScript assets
+Add to your app/assets/javascripts/application.js
+```
+//= require usersnap-rails
+```
+
+### Include stylesheet assets
+Add to your app/assets/stylesheets/application.css
+```
+*= require usersnap-rails
+```
+
+Or if your manifest file is .scss
+```
+@import "usersnap-rails";
+```
+
+### Configure your Usersnap API key
+usersnap-rails assumes that your Usersnap API key is stored in a config variable called usersnap_api_key
+Set its value in an initializer (e.g. config/initializers/usersnap.rb) or in the environment-specific config files:
+```
+Rails.application.config.usersnap_api_key = "x1x2a1-whatever-aa55";
+```
+Restart the application.
+
+### Activate the Usersnap widget in views
+On the pages where the Usersnap widget should appear, add an element with the ID "include-usersnap-widget".
+```
+<div id="include-usersnap-widget"></div>
+```
+If you want it to appear an all pages, add it to app/views/layouts/application.html.erb.
+If you want to make the Usersnap widget available only to specific users, you can write something like this:
+```
+<% if current_user.is_allowed_to_report_bug? %>
+  <div id="include-usersnap-widget"></div>
+<% end %>
+```
+
+The positioning of the hidden element doesn't influence where the Usersnap widget will appear.
+
+### Customizing
+Usersnap provides a [JavaScript API](https://usersnap.com/docs) to customize the widget: position, language, several event handlers etc. e.g.
+```
+var _usersnapconfig = {
+    halign: 'left',
+    btnText: 'Report a bug'
+ };
+```
+Add your customizing code to an arbitrary js-file and reference it in your JavaScript manifest file.  
+The [Usersnap Developer API and Documentation](https://usersnap.com/docs) gives an overview about the customizing possibilities.
+
+## Contributing
+
+1. Fork it ( https://github.com/r11runner/usersnap-rails/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/app/assets/javascripts/usersnap-rails.js.erb

@@ -0,0 +1,8 @@
+//= require usersnap
+
+$(document).on('page:change', function(event) {
+    var usersnapTags = $(document).find("#include-usersnap-widget");
+    if (usersnapTags.length){
+	loadUsersnapWidget('<%= Rails.application.config.usersnap_api_key %>');
+    }
+});

data/app/assets/stylesheets/usersnap-rails.css

@@ -0,0 +1,3 @@
+#include-usersnap-widget{
+  display: none;
+}

data/lib/usersnap-rails.rb

@@ -0,0 +1,6 @@
+require "usersnap-rails/version"
+
+module UsersnapRails
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/usersnap-rails/version.rb

@@ -0,0 +1,3 @@
+module UsersnapRails
+  VERSION = "0.0.11"
+end

data/usersnap-rails.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'usersnap-rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "usersnap-rails"
+  spec.version       = UsersnapRails::VERSION
+  spec.authors       = ["r11runner"]
+  spec.email         = ["r11runner@gmail.com"]
+  spec.summary       = %q{Integrate the Usersnap-widget with Rails}
+  spec.homepage      = "https://github.com/r11runner/usersnap-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">=4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/vendor/assets/javascripts/usersnap.js

@@ -0,0 +1,8 @@
+function loadUsersnapWidget(apiKey){
+    var s = document.createElement("script");
+    s.type = "text/javascript";
+    s.async = true;
+    s.src = '//api.usersnap.com/load/' + apiKey + '.js';
+    var x = document.getElementsByTagName('script')[0];
+    x.parentNode.insertBefore(s, x);
+};

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: usersnap-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.11
+platform: ruby
+authors:
+- r11runner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !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'
+description: 
+email:
+- r11runner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/usersnap-rails.js.erb
+- app/assets/stylesheets/usersnap-rails.css
+- lib/usersnap-rails.rb
+- lib/usersnap-rails/version.rb
+- usersnap-rails.gemspec
+- vendor/assets/javascripts/usersnap.js
+homepage: https://github.com/r11runner/usersnap-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Integrate the Usersnap-widget with Rails
+test_files: []