notifiee-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67a5e002e44e81ec0d0816d115a1a2565009a6b530778c665cac8b7e6fc724bc
+  data.tar.gz: dd7e71b1d298766b69e19221f980877682ef6769e249108e8bc86a5a77422fb9
+SHA512:
+  metadata.gz: c4dffa3f1587ef1c9c3173b5e694e62b162d9820e53c17c3129a1ceec79a3f83898b6cee00dd0c3cf547e8c1925b658f85ef8518d84aa5493709584ee5258ed2
+  data.tar.gz: 11189ff7e04dffae218481fab5c292bda214e491b2ed94c7fd65305adecb983c7f42d2bad395b812ee6cc804550a288f13289cbf63d7ba0a84311e2724d03fb8

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hello@garethfuller.me. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in notifiee-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    notifiee-ruby (1.0.0)
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    safe_yaml (1.0.4)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  notifiee-ruby!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock (~> 2.3)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 garethfuller
+
+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,53 @@
+[![Build Status](https://travis-ci.org/Notifiee/notifiee-ruby.svg?branch=master)](https://travis-ci.org/Notifiee/notifiee-ruby)
+# Notifiee
+
+The Notifiee gem allows Ruby developers to programmatically send notifications to team members (via multiple channels like Email, SMS, Telegram, Slack, Messenger, and Twitter DMs) through the [Notifiee](https://notifiee.com) web service. The API is implemented as JSON over HTTP.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'notifiee'
+```
+
+then bundle:
+
+    $ bundle
+
+Or install globally:
+
+    $ gem install notifiee
+
+## Usage
+
+First configure your API client:
+
+```ruby
+Notifiee::Client.api_key = "YOUR_API_KEY"
+```
+
+In Rails projects this should go in a notifiee initializer and the API key should probably be set with an ENV variable:
+
+```ruby
+# config/initializers/notifiee.rb
+
+Notifiee::Client.api_key = ENV["YOUR_API_KEY"]
+```
+
+Your API key is associated with a project created within the [notifiee.com](https://notifiee.com) web interface. To get an API key you will need to sign up.
+
+Once the configuration is set you can send notifications in your code like this:
+
+```ruby
+Notifiee.notify(:bob, [:telegram], 'Something happened in our app!')
+
+# or with a subject
+Notifiee.notify(:bob, [:telegram], 'Something happened in our app!', subject: 'Our App Notification')
+```
+
+NOTE: `:bob` is a notifiee that you would have had to have created from within the [notifiee.com](https://notifiee.com) web interface and configured the Telegram channel for.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "notifiee"
+
+# 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(__FILE__)

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/notifiee.rb

@@ -0,0 +1,21 @@
+require "notifiee/version"
+require "notifiee/exceptions"
+require "notifiee/client"
+require "notifiee/notifications"
+
+module Notifiee
+
+  class << self
+
+    def notify(notifiees, channels, message, **params)
+      payload = params.merge(
+        notifiees: notifiees,
+        channels: channels,
+        message: message
+      )
+      Notifiee::Notifications.create(payload)
+    end
+
+  end
+
+end

data/lib/notifiee/client.rb

@@ -0,0 +1,75 @@
+require 'net/http'
+require 'json'
+
+module Notifiee
+  class Client
+
+    @base_url   = 'api.notifiee.com'
+    @version    = 'v1'
+    @api_key    = nil
+    @debug_mode = false
+
+    class << self
+
+      attr_accessor :base_url, :version, :debug_mode, :api_key
+
+      def get(endpoint, **payload)
+        endpoint += "?" + URI.encode_www_form(payload) unless payload.empty?
+        request "GET", endpoint
+      end
+
+      def post(endpoint, **payload)
+        body = JSON.generate(payload)
+        request "POST", endpoint, body
+      end
+
+      def put(endpoint, **payload)
+        body = JSON.generate(payload)
+        request "PUT", endpoint, body
+      end
+
+      def patch(endpoint, **payload)
+        body = JSON.generate(payload)
+        request "PATCH", endpoint, body
+      end
+
+      def delete(endpoint)
+        request "DELETE", endpoint
+      end
+
+      private
+
+        def request method, endpoint, payload=nil
+          req = Net::HTTP.const_get(method.capitalize).new("/#{@version}/#{endpoint}")
+          req = add_headers(req)
+          req.body = payload
+          handle connection.start{ |http| http.request(req) }
+        end
+
+        def connection
+          connection = Net::HTTP.new(@base_url, 443)
+          connection.use_ssl = true
+          connection.set_debug_output $stderr if @debug_mode
+          connection
+        end
+
+        def add_headers(request)
+          request['authorization'] = "Token #{@api_key}"
+          request['Content-Type'] = 'application/json'
+          request
+        end
+
+        def handle response
+          case response
+          when Net::HTTPSuccess
+            response.body
+          when Net::HTTPUnauthorized
+            raise Notifiee::Unauthorized.new response.body
+          else
+            raise Notifiee::Error.new response.body
+          end
+        end
+
+    end
+  end
+end

data/lib/notifiee/exceptions.rb

@@ -0,0 +1,9 @@
+module Notifiee
+
+  class Unauthorized < StandardError
+  end
+
+  class Error < StandardError
+  end
+
+end

data/lib/notifiee/notifications.rb

@@ -0,0 +1,12 @@
+module Notifiee
+  class Notifications
+
+    class << self
+
+      def create(payload)
+        Notifiee::Client.post 'notifications', payload
+      end
+
+    end
+  end
+end

data/lib/notifiee/version.rb

@@ -0,0 +1,3 @@
+module Notifiee
+  VERSION = "1.0.0"
+end

data/notifiee-ruby.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "notifiee/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "notifiee-ruby"
+  spec.version       = Notifiee::VERSION
+  spec.authors       = ["Gareth Fuller"]
+  spec.email         = ["gareth@notifiee.com"]
+
+  spec.summary       = %q{The Notifiee gem is a lightweight gem for accessing the Notifiee REST web service.}
+  spec.description   = %q{The Notifiee gem allows Ruby developers to programmatically send notifications to team members (via multiple channels like Email, SMS, Telegram, Slack, Messenger, and Twitter DMs) through the Notifiee web service. The API is implemented as JSON over HTTP.}
+  spec.homepage      = "https://github.com/Notifiee/notifiee-ruby.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.3"
+
+  spec.add_dependency "json"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: notifiee-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gareth Fuller
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: json
+  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'
+description: The Notifiee gem allows Ruby developers to programmatically send notifications
+  to team members (via multiple channels like Email, SMS, Telegram, Slack, Messenger,
+  and Twitter DMs) through the Notifiee web service. The API is implemented as JSON
+  over HTTP.
+email:
+- gareth@notifiee.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/notifiee.rb
+- lib/notifiee/client.rb
+- lib/notifiee/exceptions.rb
+- lib/notifiee/notifications.rb
+- lib/notifiee/version.rb
+- notifiee-ruby.gemspec
+homepage: https://github.com/Notifiee/notifiee-ruby.git
+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.7.2
+signing_key: 
+specification_version: 4
+summary: The Notifiee gem is a lightweight gem for accessing the Notifiee REST web
+  service.
+test_files: []