knotify 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 875eb4639f8b58c6849023b6294ef80b70061224
+  data.tar.gz: faa813e250df012ccf39b1042f679d003bd21198
+SHA512:
+  metadata.gz: 6ab327146234a1649f1fdc64632ad5582f121315f69328ac40d1e534c18a5dc73f8cd3d633600ccee633b23bf69e763f6fd3a2dcaa24232e3f79fad169577139
+  data.tar.gz: f520fdf5cb78785412d1825f5b4f409b42676dd123a1203c45aeede3f9d426b9d2ebdf2b5cef34182bf29c6021a04e137f38f9cbf776d461c43e01f6bf1322ea

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brandon Dennis
+
+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,65 @@
+# Knotify
+
+Knotify is a simple js library for displaying web notifications. [Check browser support](http://caniuse.com/#search=notification)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'knotify'
+
+And then execute:
+
+    $ bundle
+
+Add the following directive to your JavaScript manifest file (application.js):
+
+    //= require knotify
+
+## Usage
+
+The user has to enable notifications before any can be created. This example has a user click a button labeled ````Enable Notifications````.
+
+````html
+<button id='#webkit-permission'>Enable Notifications</button>
+````
+
+In your ````.coffee```` file, create a new ````KnotifyPermission```` object, passing it the id of the button. Once the user clicks this button, notifications will be enabled. After that, you can fire off notifications by creating a new ````Knotify```` object passing it a json object with the options for the notification.
+
+````coffeescript
+jQuery ->
+  new KnotifyPermission("#webkit-permission")
+
+  options =
+    image: 'my_image.png'
+    title: 'This is a notification'
+    content: 'This is only a test'
+    now: true
+
+  new Knotify(options)
+````
+
+_If you don't set_ ````now: true```` _then you'll need to store the notification in a variable and call ````show()```` when you are ready to display it._
+
+## Knotify Options
+
+| Key      | Description                                            | Default Value |
+|----------|--------------------------------------------------------|---------------|
+| onDisplay| function to execute when the notification is displayed | empty function|
+| onClose  | function to execute when the notification is closed    | empty function|
+| onClick  | function to execute if the notification is clicked     | empty function|
+| onError  | function to execute if an error has occured            | empty function|
+| image    | path to an image to use                                | empty string  |
+| title    | title text to be displayed                             | empty string  |
+| content  | the content body to be displayed                       | empty string  |
+| now      | if true, display the notification immediately          | undefined     |
+
+_Note: These options are largely based on the spec as implemented by [Chromium](http://www.chromium.org/developers/design-documents/desktop-notifications/api-specification)_
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/knotify.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'knotify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "knotify"
+  spec.version       = Knotify::Rails::VERSION
+  spec.authors       = ["Brandon Dennis"]
+  spec.email         = ["toady00@gmail.com"]
+  spec.description   = %q{Web Notification Gem}
+  spec.summary       = %q{Knotify is a simple js library for using web notifications.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "railties", ">= 3.0", "< 5.0"
+end

data/lib/knotify.rb

@@ -0,0 +1,8 @@
+require "knotify/version"
+
+module Knotify
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/knotify/version.rb

@@ -0,0 +1,5 @@
+module Knotify
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

data/vendor/assets/javascript/knotify.coffee

@@ -0,0 +1,38 @@
+class Knotify
+  constructor: (options = {}) ->
+    @wbktNote  = window.webkitNotifications
+
+    @onDisplay = options.onDisplay ? (->)
+    @onClose   = options.onClose   ? (->)
+    @onClick   = options.onClick   ? (->)
+    @onError   = options.onError   ? (->)
+    @img       = options.image     ? ''
+    @title     = options.title     ? ''
+    @content   = options.content   ? ''
+
+    @_createNotification()
+    @show() if options.now?
+
+  show: ->
+    @notification.show()
+
+  _createNotification: ->
+    @notification = @wbktNote.createNotification(@img, @title, @body)
+    @notification.ondisplay = @onDisplay
+    @notification.onclose   = @onClose
+    @notification.onclick   = @onClick
+    @notification.onerror   = @onError
+
+class KnotifyPermission
+  constructor: (target, event = 'click') ->
+    document.querySelector(target).addEventListener event, ->
+      @_getPermission() unless @_checkPermission() == 0
+
+  _getPermission: ->
+    window.webkitNotifications.requestPermission()
+
+  _checkPermission: ->
+    window.webkitNotifications.checkPermission()
+
+window.Knotify = Knotify
+window.KnotifyPermission = KnotifyPermission

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: knotify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brandon Dennis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Web Notification Gem
+email:
+- toady00@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- knotify.gemspec
+- lib/knotify.rb
+- lib/knotify/version.rb
+- vendor/assets/javascript/knotify.coffee
+homepage: ''
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Knotify is a simple js library for using web notifications.
+test_files: []