rack-push-notification 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05286ab87d68a0f660e6d6241bfffe08844243ac
-  data.tar.gz: e8026c2ace0bcbeab7a80cf6a114c38633ff10b1
+  metadata.gz: e465875b3138965e524b1a2f0955e967b3648d49
+  data.tar.gz: 9586b593cad69143d3fee2308930e9394cb1be7d
 SHA512:
-  metadata.gz: fb79e1cd9b958a3dcb8ab241247667e7bd046c231e2d65a6f053441cd00ce8b06a9df07b533dbad391326636eb9f38ad955a2bb61583473e48eaa12c4dd534b6
-  data.tar.gz: 58fbef1c87adc86f71bec550fc75a4dbb726488859c2fac56c1044f507951f0fe8706c792ee0756516cb6b5782558a1b61b69a55f1af082640b22cf224b6af28
+  metadata.gz: 166942f0e5d44a0ebd405c10fe22f96ead905c46bcc8a9b03e8c79137027a2203eaaecd20a2d63e09b0e7255a523e4a37013882734d5cd6504e7d190ddc5aae7
+  data.tar.gz: 0f1a3267da641c984b4b44f8e0344f6d0744affff501f56e82dd0742ab15abbe147e75cc516583ea2a600f0c02fdc7e63805a9d00dec6a5b7d896d30e95b0f31

data/Gemfile

@@ -1,3 +1,5 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rack-push-notification (0.5.3)
+    rack-push-notification (0.6.0)
       rack (~> 1.4)
       rack-contrib (~> 1.1)
       sequel (>= 3.0)
@@ -11,33 +11,34 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.2.5)
-    rack (1.5.2)
-    rack-contrib (1.1.0)
-      rack (>= 0.9.1)
-    rack-protection (1.5.3)
+    diff-lcs (1.3)
+    rack (1.6.11)
+    rack-contrib (1.8.0)
+      rack (~> 1.4)
+    rack-protection (1.5.5)
       rack
-    rake (10.4.2)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.4)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.4)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.4)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.4)
-    sequel (4.17.0)
-    sinatra (1.4.5)
-      rack (~> 1.4)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    sequel (5.22.0)
+    sinatra (1.4.8)
+      rack (~> 1.5)
       rack-protection (~> 1.4)
-      tilt (~> 1.3, >= 1.3.4)
+      tilt (>= 1.3, < 3)
     sinatra-param (0.1.3)
       sinatra (~> 1.3)
-    tilt (1.4.1)
+    tilt (2.0.9)
 
 PLATFORMS
   ruby
@@ -46,3 +47,6 @@ DEPENDENCIES
   rack-push-notification!
   rake
   rspec
+
+BUNDLED WITH
+   2.0.1

data/{LICENSE → LICENSE.md}

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Mattt Thompson (http://mattt.me/)
+Copyright (c) 2012 – 2019 Mattt (https://mat.tt/)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,33 +1,55 @@
-Rack::PushNotification
-======================
-**A Rack-mountable webservice for managing push notifications**
-
-`Rack::PushNotification` generates API endpoints that can be consumed by iOS apps to register and unregister for push notifications.
-
-## Example Record
-
-<table>
-  <tr><td><tt>token</tt></td><td>"ce8be627 2e43e855 16033e24 b4c28922 0eeda487 9c477160 b2545e95 b68b5969"</td></tr>
-  <tr><td><tt>alias</tt></td><td>mattt@heroku.com</td></tr>
-  <tr><td><tt>badge</tt></td><td>0</td></tr>
-  <tr><td><tt>locale</tt></td><td>en_US</td></tr>
-  <tr><td><tt>language</tt></td><td>en</td></tr>
-  <tr><td><tt>timezone</tt></td><td>America/Los_Angeles</td></tr>
-  <tr><td><tt>ip_address</tt></td><td>0.0.0.0</td></tr>
-  <tr><td><tt>lat</tt></td><td>37.7716</td></tr>
-  <tr><td><tt>lng</tt></td><td>-122.4137</td></tr>
-  <tr><td><tt>tags</tt></td><td><tt>["iPhone OS 6.0", "v1.0", "iPhone"]</tt></td></tr>
-</table>
+# Rack::PushNotification
 
-Each device has a `token`, which uniquely identifies the app installation on a particular device. This token can be associated with an `alias`, which can be a domain-specific piece of identifying information, such as a username or e-mail address. A running `badge` count is used to keep track of the badge count to show on the app icon.
-
-A device's `locale` & `language` can be used to localize outgoing communications to that particular user. Having `timezone` information gives you the ability to schedule messages for an exact time of day, to ensure maximum impact (and minimum annoyance). `ip_address` as well as `lat` and `lng` allows you to specifically target users according to their geographic location.
-
-**It is strongly recommended that you use `Rack::PushNotification` in conjunction with some sort of Rack authentication middleware, so that the administration endpoints are not accessible without some form of credentials.**
+**A Rack-mountable webservice for managing push notifications**
 
-## Example Usage
+`Rack::PushNotification` is Rack middleware that
+generates API endpoints that can be consumed by iOS apps
+to register and unregister for push notifications.
+
+**Example Record**
+
+| Field        | Value                                                                       |
+| ------------ | --------------------------------------------------------------------------- |
+| `token`      | `"ce8be627 2e43e855 16033e24 b4c28922 0eeda487 9c477160 b2545e95 b68b5969"` |
+| `alias`      | `mattt@heroku.com`                                                          |
+| `badge`      | `0`                                                                         |
+| `locale`     | `en_US`                                                                     |
+| `language`   | `en`                                                                        |
+| `timezone`   | `America/Los_Angeles`                                                       |
+| `ip_address` | `0.0.0.0`                                                                   |
+| `lat`        | `37.7716`                                                                   |
+| `lng`        | `-122.4137`                                                                 |
+| `tags`       | `["iPhone OS 6.0", "v1.0", "iPhone"]`                                       |
+
+- Each device has a `token`,
+  which uniquely identifies the app installation on a particular device.
+- This token can be associated with an `alias`,
+  which can be a domain-specific piece of identifying information,
+  such as a username or e-mail address.
+- A running `badge` count keeps track of the badge count to show on the app icon.
+- A device's `locale` & `language` can be used to
+  localize outgoing communications to that particular user.
+- Having `timezone` information gives you the ability to
+  schedule messages for an exact time of day and to
+  ensure maximum impact (and minimum annoyance).
+- An `ip_address` --- along with `lat` and `lng` ---
+  lets you to specifically target users according to their geographic location.
+
+> **Important**
+> Use `Rack::PushNotification` in conjunction with some kind of authentication,
+> so that the administration endpoints aren't publicly accessible.
+
+## Usage
+
+Rack::PushNotification can be run as Rack middleware or as a single web application.
+All that's required is a connection to a Postgres database.
+Define this with the environment variable `DATABASE_URL`.
+
+> For rails, use the
+> [`rails-database-url`](https://github.com/glenngillen/rails-database-url) gem
+> to define this from the `database.yml`.
 
-Rack::PushNotification can be run as Rack middleware or as a single web application. All that is required is a connection to a Postgres database. You must define this with the environment variable `DATABASE_URL`. For rails, use the [`rails-database-url`](https://github.com/glenngillen/rails-database-url) gem to define this from the `database.yml`.
+An example application can be found in the `/example` directory of this repository.
 
 ### config.ru
 
@@ -38,28 +60,6 @@ Bundler.require
 run Rack::PushNotification
 ```
 
-An example application can be found in the `/example` directory of this repository.
-
-## iOS Client Library
-
-To get the full benefit of `Rack::PushNotification`, use the [Orbiter](https://github.com/mattt/Orbiter) library to register for Push Notifications on iOS.
-
-```objective-c
-#import "Orbiter.h"
-
-- (void)application:(UIApplication *)application
-didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
-{
-    NSURL *serverURL = [NSURL URLWithString:@"http://raging-notification-3556.herokuapp.com/"]
-    Orbiter *orbiter = [[Orbiter alloc] initWithBaseURL:serverURL credential:nil];
-    [orbiter registerDeviceToken:deviceToken withAlias:nil success:^(id responseObject) {
-        NSLog(@"Registration Success: %@", responseObject);
-    } failure:^(NSError *error) {
-        NSLog(@"Registration Error: %@", error);
-    }];
-}
-```
-
 ## Deployment
 
 `Rack::PushNotification` can be deployed to Heroku with the following commands:
@@ -71,12 +71,9 @@ $ git push heroku master
 
 ## Contact
 
-Mattt Thompson
-
-- http://github.com/mattt
-- http://twitter.com/mattt
-- m@mattt.me
+[Mattt](https://twitter.com/mattt)
 
 ## License
 
-Rack::PushNotification is available under the MIT license. See the LICENSE file for more info.
+Rack::PushNotification is available under the MIT license.
+See the LICENSE file for more info.

data/Rakefile

@@ -1,10 +1,12 @@
-require "bundler"
+# frozen_string_literal: true
+
+require 'bundler'
 Bundler.setup
 
-gemspec = eval(File.read("rack-push-notification.gemspec"))
+gemspec = eval(File.read('rack-push-notification.gemspec'))
 
-task :build => "#{gemspec.full_name}.gem"
+task build: "#{gemspec.full_name}.gem"
 
-file "#{gemspec.full_name}.gem" => gemspec.files + ["rack-push-notification.gemspec"] do
-  system "gem build rack-push-notification.gemspec"
+file "#{gemspec.full_name}.gem" => gemspec.files + ['rack-push-notification.gemspec'] do
+  system 'gem build rack-push-notification.gemspec'
 end

data/lib/rack/push-notification.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rack'
 require 'rack/contrib'
 
@@ -35,27 +37,27 @@ module Rack
       param :tags, Array
 
       record = Device.find(token: params[:token]) || Device.new
-      record.set(params.update({ip_address: request.ip}))
+      record.set(params.update(ip_address: request.ip))
 
       code = record.new? ? 201 : 200
 
       if record.save
         status code
-        {device: record}.to_json
+        { device: record }.to_json
       else
         status 400
-        {errors: record.errors}.to_json
+        { errors: record.errors }.to_json
       end
     end
 
     delete '/devices/:token/?' do
-      record = Device.find(token: params[:token]) or halt 404
+      (record = Device.find(token: params[:token])) || halt(404)
 
       if record.destroy
         status 200
       else
         status 400
-        {errors: record.errors}.to_json
+        { errors: record.errors }.to_json
       end
     end
   end

data/lib/rack/push-notification/migrations/001_base_schema.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Sequel.migration do
   up do
     create_table :push_notification_devices do
@@ -5,7 +7,7 @@ Sequel.migration do
 
       column :token,      :varchar, empty: false, unique: true
       column :alias,      :varchar
-      column :badge,      :int4,    null: false, default: 0
+      column :badge,      :int4, null: false, default: 0
       column :locale,     :varchar
       column :language,   :varchar
       column :timezone,   :varchar, empty: false, default: 'UTC'
@@ -16,7 +18,7 @@ Sequel.migration do
 
       index :token
       index :alias
-      index [:lat, :lng]
+      index %i[lat lng]
     end
   end
 

data/lib/rack/push-notification/migrations/002_add_full_text_search.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 Sequel.migration do
   up do
     add_column :push_notification_devices, :tsv, 'TSVector'
-    add_index :push_notification_devices, :tsv, type: "GIN"
+    add_index :push_notification_devices, :tsv, type: 'GIN'
     create_trigger :push_notification_devices, :tsv, :tsvector_update_trigger,
-      args: [:tsv, :'pg_catalog.english', :token, :alias, :locale, :timezone],
-      events: [:insert, :update],
-      each_row: true
+                   args: %i[tsv pg_catalog.english token alias locale timezone],
+                   events: %i[insert update],
+                   each_row: true
   end
 
   down do

data/lib/rack/push-notification/models/device.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rack
   class PushNotification::Device < Sequel::Model
     plugin :json_serializer, naked: true, except: :id
@@ -24,7 +26,7 @@ module Rack
     private
 
     def normalize_token!
-      self.token = self.token.strip.gsub(/[<\s>]/, '')
+      self.token = token.strip.gsub(/[<\s>]/, '')
     end
   end
 end

data/lib/rack/push-notification/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rack
+  class PushNotification
+    VERSION = '0.6.0'
+  end
+end

data/rack-push-notification.gemspec

@@ -1,27 +1,30 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'rack/push-notification/version'
 
 Gem::Specification.new do |s|
-  s.name        = "rack-push-notification"
-  s.authors     = ["Mattt Thompson"]
-  s.email       = "m@mattt.me"
-  s.homepage    = "http://mattt.me"
-  s.version     = "0.5.3"
+  s.name        = 'rack-push-notification'
+  s.authors     = ['Mattt']
+  s.email       = 'mattt@me.com'
+  s.homepage    = 'https://mat.tt'
+  s.version     = Rack::PushNotification::VERSION
+  s.licenses    = 'MIT'
   s.platform    = Gem::Platform::RUBY
-  s.summary     = "Rack::PushNotification"
-  s.description = "Generate a REST API for registering and querying push notification device tokens."
+  s.summary     = 'Rack::PushNotification'
+  s.description = 'Generate a REST API for registering and querying push notification device tokens.'
 
-  s.add_dependency "rack", "~> 1.4"
-  s.add_dependency "rack-contrib", "~> 1.1"
-  s.add_dependency "sequel", ">= 3.0"
-  s.add_dependency "sinatra", "~> 1.3"
-  s.add_dependency "sinatra-param", "~> 0.1"
+  s.add_dependency 'rack', '~> 1.4'
+  s.add_dependency 'rack-contrib', '~> 1.1'
+  s.add_dependency 'sequel', '>= 3.0'
+  s.add_dependency 'sinatra', '~> 1.3'
+  s.add_dependency 'sinatra-param', '~> 0.1'
 
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "rake"
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
 
-  s.files         = Dir["./**/*"].reject { |file| file =~ /\.\/(bin|example|log|pkg|script|spec|test|vendor)/ }
+  s.files         = Dir['./**/*'].reject { |file| file =~ %r{\./(bin|example|log|pkg|script|spec|test|vendor)} }
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
 end

metadata

@@ -1,135 +1,134 @@
 --- !ruby/object:Gem::Specification
 name: rack-push-notification
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
-- Mattt Thompson
+- Mattt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2019-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rack-contrib
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: sinatra-param
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  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: rake
+  name: rspec
   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'
 description: Generate a REST API for registering and querying push notification device
   tokens.
-email: m@mattt.me
+email: mattt@me.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ./Gemfile
-- ./Gemfile.lock
-- ./lib/rack/push-notification/migrations/001_base_schema.rb
-- ./lib/rack/push-notification/migrations/002_add_full_text_search.rb
-- ./lib/rack/push-notification/models/device.rb
-- ./lib/rack/push-notification.rb
-- ./LICENSE
-- ./rack-push-notification-0.5.0.gem
-- ./rack-push-notification-0.5.1.gem
-- ./rack-push-notification-0.5.2.gem
-- ./rack-push-notification.gemspec
-- ./Rakefile
-- ./README.md
-homepage: http://mattt.me
-licenses: []
+- "./Gemfile"
+- "./Gemfile.lock"
+- "./LICENSE.md"
+- "./README.md"
+- "./Rakefile"
+- "./lib/rack/push-notification.rb"
+- "./lib/rack/push-notification/migrations/001_base_schema.rb"
+- "./lib/rack/push-notification/migrations/002_add_full_text_search.rb"
+- "./lib/rack/push-notification/models/device.rb"
+- "./lib/rack/push-notification/version.rb"
+- "./rack-push-notification.gemspec"
+homepage: https://mat.tt
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -137,17 +136,17 @@ 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.1.11
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Rack::PushNotification