unagi-notifications 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3902435573c80a3be0426000abb3d1503ee39985
+  data.tar.gz: 3a5c22e2fd5268616c2949c032fab23aa3bef8bf
+SHA512:
+  metadata.gz: c02a69a3a07afa1bcd303cd728642d5260c814dde6eb909bb87ffe5610365304155e8948144be8661f950e8d09c1337d1ba2d1d1ba43e1b736d4efa16a32facf
+  data.tar.gz: f96e3014cd93a8a8413ea9d74501700350639eff4d1a125891308a091d3a0d14277adbdc11315ec0cf7fb2cedbf662b5c692d19ddc1fcace805bf19e445781a9

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+source 'https://rails-assets.org'
+
+gemspec
+
+gem 'faraday'
+gem 'rails-assets-jquery', '1.11.1'
+gem 'rails-assets-jquery-ui', '1.10.4'
+gem 'sprockets-rails'

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    unagi-notifications (0.1.0)
+      actionpack (>= 3.2)
+      faraday
+      railties (>= 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  remote: https://rails-assets.org/
+  specs:
+    actionpack (5.1.5)
+      actionview (= 5.1.5)
+      activesupport (= 5.1.5)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.5)
+      activesupport (= 5.1.5)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.3)
+    erubi (1.7.1)
+    faraday (0.14.0)
+      multipart-post (>= 1.2, < 3)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.4)
+    rack-test (0.8.3)
+      rack (>= 1.0, < 3)
+    rails-assets-jquery (1.11.1)
+    rails-assets-jquery-ui (1.10.4)
+      rails-assets-jquery (>= 1.6)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.5)
+      actionpack (= 5.1.5)
+      activesupport (= 5.1.5)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  faraday
+  rails-assets-jquery (= 1.11.1)
+  rails-assets-jquery-ui (= 1.10.4)
+  rake (~> 10.0)
+  sprockets-rails
+  unagi-notifications!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Unagi (http://www.unagi.com.ar/)
+
+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,84 @@
+# Unagi Notifications
+
+**Unagi Notifications** is a gem developed by [Unagi](http://www.unagi.com.ar/) for Ruby on Rails applications. It integrates a simple real-time notifications system based on Google's Firebase platform.
+
+The gem allows Rails applications to upload notifications on server-side and get them on client-sife using simple and customizable view helpers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'notifications'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install notifications
+
+## Configuration
+
+Add the following code in order to configure the gem:
+
+```ruby
+Notifications.configure do |config|
+  config.firebase_project_id = '' # You must set the Firebase project ID here
+  config.firebase_api_key    = '' # You must set the Firebase API key here
+end
+```
+
+## Usage
+
+### Notification creation
+
+```ruby
+Notification::Uploader.call(
+  origin:      'your_origin',
+  destination: 'your_destination',
+  text:        'This is an awesome notification text!',
+  link:        'your.awesome.website.com/posts/1',
+  created_at:  Time.now
+)
+```
+
+### Notifications reading
+We provide two helpers that can be used on Rails views for users' unread notifications with HTML customization:
+
+**Notifications list**
+
+```erb
+<%= notifications_for current_user.id,
+  container:                    :ul, # The notifications wrapper tag
+  container_class:              'dropdown-menu', # The notifications wrapper class
+  notification_container:       :li, # The wrapper tag of a notification
+  notification_container_class: 'dropdown-item', # The wrapper class of a notification
+  notification_class:           'text-bold' # The notification link class
+%>
+```
+
+**Notifications counter**
+
+```erb
+<%= notifications_count_for current_user.id,
+  container:       :span, # The counter wrapper tag
+  container_class: 'u-bold' # The counter wrapper class
+%>
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests. You can also run `bundle console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lucashour/notifications.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test