thredded-pushover-notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14c7d00afee25b4c123a25999d6d8c586d82cb93
+  data.tar.gz: 4a991a5f59392f765a36927d5559e29c4bbe3250
+SHA512:
+  metadata.gz: 45d3ac6bbe84efb64d1630764e17636426b03522e356361789a59c15b43cfff43ae886b58bd1da208b7ce8e48c48305506895fc92e0405f3b74febc60aca7184
+  data.tar.gz: a1a519717bf7fb696ed70d11c81726083c7021e8ecd25929013dca7a24d4dd7d20b17de515479a26457ad5999f528308af83fe87be226b278a75e3269caaa9ea

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - './spec/dummy/**/*'
+  DisplayCopNames: true
+Metrics/BlockLength:
+  Enabled: false
+Metrics/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.3.1
+cache: bundler
+bundler_args: --path ../../vendor/bundle --without debug
+gemfile:
+  - Gemfile
+
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at tim@red56.co.uk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in thredded-pushover-notifier.gemspec
+# gem 'thredded', github: 'thredded/thredded', branch: 'master'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tim Diggins
+
+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,58 @@
+# Thredded Pushover Notifier [![Build Status](https://travis-ci.org/thredded/thredded-pushover-notifier.svg?branch=master)](https://travis-ci.org/thredded/thredded-pushover-notifier)
+
+
+A notifier for [Thredded](https://github.com/thredded/thredded/) allowing push notifications to be sent via [Pushover](https://pushover.net/)
+
+## Installation
+
+Add this line to your application's Gemfile
+
+```ruby
+gem 'thredded-pushover-notifier'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install thredded-pushover-notifier
+
+## Usage
+
+* You will need a Pushover app token (see the first option on https://pushover.net/api)
+* Let's assume you've added your Pushover app token as an environment variable `PUSHOVER_APP_TOKEN`.
+* You will need to have Thredded working already (at least v0.13.4) and have an initializer already in your rails app.
+* Let's assume your app is being served at http://example.com
+
+To setup two notifiers - email and pushover, add the following to the bottom of your thredded.rb initializer:
+
+```ruby
+Thredded::Engine.config.to_prepare do
+  require 'thredded/pushover_notifier/content_helper'
+  Thredded::PushoverNotifier::ContentHelper.include Thredded::Engine.routes.url_helpers
+  pushover_notifier = Thredded::PushoverNotifier.new(ENV['PUSHOVER_APP_TOKEN'],  'http://example.com')
+  Thredded.notifiers = [Thredded::EmailNotifier.new, pushover_notifier]
+end
+```
+
+
+ 
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/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/thredded/thredded-pushover-notifier. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'thredded/pushover/notifier'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/thredded/pushover_notifier.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'net/https'
+
+module Thredded
+  class PushoverNotifier
+    VERSION = '0.1.0'
+
+    def initialize(pushover_app_token, root_url)
+      @pushover_app_token = pushover_app_token
+      @root_url = root_url
+    end
+
+    def key
+      'pushover'
+    end
+
+    def human_name
+      I18n.t('pushover_notifier.by_pushover')
+    end
+
+    def new_post(post, users)
+      require 'thredded/pushover_notifier/content_helper'
+      helper = Thredded::PushoverNotifier::ContentHelper.new(@root_url, post)
+      args = [helper.message_for_new_topic_post, helper.title_for_new_topic_post, helper.post_url]
+      users.map(&:pushover_user_key).each do |user_key|
+        send_message(user_key, *args) if user_key.present?
+      end
+    end
+
+    def new_private_post; end
+
+    def send_message(user_key, message, title, url)
+      pushover_url = URI.parse('https://api.pushover.net/1/messages.json')
+      req = Net::HTTP::Post.new(pushover_url.path)
+      data = {
+        token: @pushover_app_token,
+        user: user_key,
+        message: message,
+        title: title,
+        url: url,
+        url_title: 'View topic'
+      }
+      req.set_form_data(data)
+      res = Net::HTTP.new(pushover_url.host, pushover_url.port)
+      res.use_ssl = true
+      res.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      res.start { |http| http.request(req) }
+    end
+  end
+end

data/lib/thredded/pushover_notifier/content_helper.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'rails'
+require 'action_view'
+
+module Thredded
+  class PushoverNotifier
+    class ContentHelper
+      include ActionView::Helpers::TextHelper
+
+      attr_reader :post, :root_url
+
+      def initialize(root_url, post)
+        @root_url = root_url
+        @post = post
+      end
+
+      def message_for_new_topic_post
+        content_truncated(replace_images)
+      end
+
+      def title_for_new_topic_post
+        "#{post.postable.title} by @#{post.user.thredded_display_name} [#{post.messageboard.name}]"
+      end
+
+      def post_url
+        "#{root_url}#{post_permalink_path(post.id)}"
+      end
+
+      protected
+
+      def replace_images
+        post.content.gsub(/!\[[^\]]*?\]\(([^)]*?)\)/, '[IMAGE]')
+      end
+
+      def content_truncated(content)
+        truncate(content, length: 100, separator: ' ')
+      end
+    end
+  end
+end

data/thredded-pushover-notifier.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'thredded/pushover_notifier'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'thredded-pushover-notifier'
+  spec.version       = Thredded::PushoverNotifier::VERSION
+  spec.authors       = ['Tim Diggins', 'Ella Schofield']
+  spec.email         = ['tim@red56.uk']
+
+  spec.summary       = 'A notifier for Thredded to push new post notifications to the Pushover app'
+  spec.homepage      = 'https://github.com/thredded/thredded-pushover-notifier'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'thredded', '~> 0.13', '>= 0.13.4'
+  spec.add_runtime_dependency 'actionview'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'rubocop', '~> 0.49.1'
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: thredded-pushover-notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Diggins
+- Ella Schofield
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thredded
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.4
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+description: 
+email:
+- tim@red56.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/thredded/pushover_notifier.rb
+- lib/thredded/pushover_notifier/content_helper.rb
+- thredded-pushover-notifier.gemspec
+homepage: https://github.com/thredded/thredded-pushover-notifier
+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.6.10
+signing_key: 
+specification_version: 4
+summary: A notifier for Thredded to push new post notifications to the Pushover app
+test_files: []