courier-notifications 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5bb95c354f6cd88b09abb11e744567f9a9f5b895
+  data.tar.gz: e496939b785f81bcb1d09e4eec189c8d104c2d1d
+SHA512:
+  metadata.gz: 68777203feaf4e4274068206baf9f95be56ed461d491a1be40215ab10b742a8d08c7514fc070abe67dd6f03420be7294cd055d07e80ee1504a10a0acda875e68
+  data.tar.gz: 93ef5b42dbd039e7f6062b6d550233d286b175727b9cc461362a9ab654ba76e847c510cc91b1b18fb8c5608a134906f249fce952c71e16107ef35f10a18ffeac

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.yardopts

@@ -0,0 +1,3 @@
+--markup markdown
+--private
+--protected

data/CONTRIBUTING.md

@@ -0,0 +1,20 @@
+We love pull requests from everyone. Follow the thoughtbot [code of conduct] while contributing.
+
+[code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
+
+## Contributing
+
+1. Fork the repo.
+2. Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate.
+3. Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need a test.
+4. Make the test pass.
+5. Push to your fork and submit a pull request.
+
+At this point you're waiting on us. We like to at least comment on, if not accept, pull requests within three business days (and, typically, one business day). We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted,
+
+* Include tests that fail without your code, and pass with it
+* Update the documentation, the surrounding one, examples elsewhere, guides, whatever is affected by your contribution
+* Follow the existing style of the project
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 thoughtbot, inc.
+
+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 @@
+# Courier 
+
+Ruby gem for interacting with the [Courier] API.
+
+[Courier]: https://courier.thoughtbot.com
+
+[![Build Status](https://circleci.com/gh/thoughtbot/courier-gem.svg?style=shield&circle-token=b09feb2f03dbc8fa7aa16d1977da3771b47c675c)](https://circleci.com/gh/thoughtbot/courier-gem)
+[![Code Climate](https://codeclimate.com/repos/572a0503b781dc24b0000564/badges/db6744d185fd35deb8da/gpa.svg)](https://codeclimate.com/repos/572a0503b781dc24b0000564/feed)
+[![Inline docs](http://inch-ci.org/github/thoughtbot/courier-gem.svg?branch=master)](http://inch-ci.org/github/thoughtbot/courier-gem)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'courier-notifications'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install courier-notifications
+
+## Usage
+
+Instantiate a Courier instance with your app's API token and an environment:
+
+```ruby
+courier = Courier::Client.new(api_token: "[YOUR_API_TOKEN]", environment: :development)
+```
+
+For the environment choose `:development` if you're sending notifications to a development build of an app. If you're sending notifications to an app signed with a distribution certificate (TestFlight, HockeyApp, AppStore, etc) use `:production`.
+
+Broadcast a notification to a channel:
+
+```ruby
+broadcast = courier.broadcast("[CHANNEL_NAME]", alert: "Hello from Courier")
+
+if broadcast.sent?
+  # How do you handle success?
+else
+  # Interpret broadcast.status_code
+end
+```
+
+Courier will send anything after the channel name argument as the push notification payload. See Apple's [remote notification payload documentation] for more information.
+
+[remote notification payload documentation]: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/TheNotificationPayload.html
+
+Note that delivery of notifications is a “best effort”. It is possible for `broadcast.sent?` to return true, but no notification to be delivered.
+
+## 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.
+
+## Contributing
+
+Please see [CONTRIBUTING.md](/CONTRIBUTING.md).
+
+## License
+
+Courier is Copyright © 2016 thoughtbot. It is free software, and may be redistributed under the terms specified in the [LICENSE](/LICENSE) file.
+
+## About thoughtbot
+
+![thoughtbot](https://thoughtbot.com/logo.png)
+
+Courier is maintained and funded by thoughtbot, inc.
+The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+
+We love open source software! See [our other projects][community] or [hire us][hire] to design, develop, and grow your product.
+
+[community]: https://thoughtbot.com/community?utm_source=github
+[hire]: https://thoughtbot.com?utm_source=github

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,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "courier"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/courier-notifications.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'courier/version'
+
+Gem::Specification.new do |spec|
+  spec.name                  = "courier-notifications"
+  spec.version               = Courier::VERSION
+  spec.authors               = ["Klaas Pieter Annema"]
+  spec.email                 = ["support@thoughtbot.com"]
+
+  spec.summary               = %q{Interact with the Courier API}
+  spec.description           = %q{Easy push notifications}
+  spec.homepage              = "https://courier.thoughtbot.com"
+  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.required_ruby_version = "~> 2.2"
+
+  spec.add_dependency "faraday_middleware", "~> 0.8"
+  spec.add_dependency "activesupport", "~> 4.2"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "webmock", "~> 1.24"
+end

data/lib/courier.rb

@@ -0,0 +1,10 @@
+require "courier/version"
+require "courier/client"
+require "courier/broadcast"
+
+# Courier is a Ruby client for interacting with the [Courier web
+# service](https://courier.thoughtbot.com).
+#
+# See the {file:README.md} for usage instructions.
+module Courier
+end

data/lib/courier/broadcast.rb

@@ -0,0 +1,63 @@
+module Courier
+
+  # A Broadcast instance reflects the state of a broadcast to a channel.
+  #
+  # Use `status_code` and `sent?` to determine the state of a broadcast.
+  #
+  # You do not create Broadcast instances directly. Instead, a Client creates
+  # them for you to reflect the state of a broadcast it sent.
+  class Broadcast
+
+    # @return [Fixnum]  HTTP status code of the request.
+    attr_reader :status_code
+
+    # Create a Broadcast for a channel, payload and status code.
+    #
+    # @param [String] channel (see #channel)
+    #
+    # @param {String: String, Hash, Array} payload (see #payload)
+    #
+    # @param (Fixnum) status_code (see #status_code)
+    #
+    # @!visibility private
+    def initialize(channel:, payload:, status_code:)
+      @channel = channel
+      @payload = payload
+      @status_code = status_code
+    end
+
+    # Wether the broadcast was sent successfuly or not.
+    # Note that delivery of notifications is a “best effort”. It is possible for
+    # broadcast.sent? to return true, but no notification to be delivered.
+    #
+    # @return [Bool]
+    #         true if the broadcast was sent to Courier, false otherwise.
+    def sent?
+      (200..299).cover?(status_code)
+    end
+
+    # Compare two Broadcast instance. Broadcasts are considered equal if their
+    # `class`, `channel`, `payload` and `status_code` are equal.
+    #
+    # @param [Object] other
+    #        the object to be compare to the receiver.
+    #
+    # @return [Bool]
+    #          true if the receiver and `other` are equal, otherwise false.
+    def ==(other)
+      self.class == other.class &&
+        channel == other.channel &&
+        payload == other.payload &&
+        status_code == other.status_code
+    end
+
+    protected
+
+    # @return [String] channel the broadcast was sent too.
+    attr_reader :channel
+
+    # @return {String: String, Hash, Array}
+    #         payload that was sent to the channel.
+    attr_reader :payload
+  end
+end

data/lib/courier/client.rb

@@ -0,0 +1,88 @@
+require "faraday_middleware"
+require "active_support/inflector"
+
+module Courier
+
+  # Client object manages authenticating and communicating with the Courier API.
+  class Client
+
+    # The Courier API base URL.
+    # @private_constant
+    DEFAULT_BASE_URL = "https://courier.thoughtbot.com".freeze
+
+    # Create a Client configured with an app's `api_token` and an `environment`.
+    #
+    # @param [String] api_token
+    #        The app's API token for authenticating with the Courier API.
+    #
+    # @param [:development, :production] environment
+    #        environment to use when communicating with the Courier API. Use
+    #        `:development` when interacting with an app signed with a
+    #        development certificate. Use `production` when an app is signed
+    #        with a distribution certificate.
+    #
+    # @param [String] base_url
+    #        The base_url to connect to. Primarily used for testing purposes.
+    #        You should not have to change this.
+    #
+    # Example
+    #
+    # Courier::Client.new(api_token: "[YOUR API_TOKEN]", environment:
+    # :development)
+    #
+    # @return [Client] A new Client instance
+    def initialize(api_token:, environment:, base_url: DEFAULT_BASE_URL)
+      @api_token = api_token
+      @base_url = base_url
+      @environment = environment
+    end
+
+    # Send a notification to all devices registered with a channel
+    #
+    # @param [String] channel
+    #        name of the channel. Names are automatically parameterized
+    #        using
+    #        [ActiveSupport::Inflector](http://apidock.com/rails/ActiveSupport/Inflector).
+    #
+    # @param {String: String, Hash, Array} payload
+    #        The
+    #        [APNs](https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/TheNotificationPayload.html#//apple_ref/doc/uid/TP40008194-CH107-SW1)
+    #        payload to broadcast.
+    #        See [lowdown](http://www.rubydoc.info/gems/lowdown/Lowdown%2FNotification%3Aformatted_payload)
+    #        documentation for more information on how the payload is processed.
+    #
+    # @return [Broadcast] a broadcast instance.
+    #
+    # @see http://apidock.com/rails/ActiveSupport/Inflector/parameterize
+    # @see http://www.rubydoc.info/gems/lowdown/Lowdown%2FNotification%3Aformatted_payload
+    # @see https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/TheNotificationPayload.html#//apple_ref/doc/uid/TP40008194-CH107-SW1
+    #
+    def broadcast(channel, payload)
+      response = http.post("/broadcast/#{channel.parameterize}",
+                           broadcast: { payload: payload })
+      Broadcast.new(channel: channel,
+                    payload: payload,
+                    status_code: response.status)
+    end
+
+    private
+
+    attr_reader :api_token, :base_url, :environment
+
+    # Make authenticated requests to the Courier API.
+    #
+    # @return [Faraday::Connection]
+    #         a Faraday::Connection configured to authenticate and communicate
+    #         with the Courier API.
+    def http
+      Faraday.new(url: base_url) do |conn|
+        conn.headers["Accept"] = "application/json version=1"
+        conn.headers["Content-Type"] = "application/json"
+        conn.request :json
+        conn.params["environment"] = environment
+        conn.token_auth api_token
+        conn.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/courier/version.rb

@@ -0,0 +1,3 @@
+module Courier
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: courier-notifications
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Klaas Pieter Annema
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+description: Easy push notifications
+email:
+- support@thoughtbot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".yardopts"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- courier-notifications.gemspec
+- lib/courier.rb
+- lib/courier/broadcast.rb
+- lib/courier/client.rb
+- lib/courier/version.rb
+homepage: https://courier.thoughtbot.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Interact with the Courier API
+test_files: []
+has_rdoc: