pushr-core 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ffb7fb3c92d6c74cd952b1e2db925518a24b75b
-  data.tar.gz: b167c999e085a9017a5ba924aa6b2769ced36e70
+  metadata.gz: d6e254858fcb2c4dc190b0fa1a6a296e57e91b59
+  data.tar.gz: aa3314e0f9fb385870eeb764ec2bbf87a4133a30
 SHA512:
-  metadata.gz: 8da5f1a457ff6bdf6926318df3b3d8757d27651d7ca11a1e472d4d2587452b6e543e28d42d2bc524d0055f6e13f265b34bf546df6360a78b76a0d81d5822550c
-  data.tar.gz: 6f2a17440d22d992863a6cd4f3ac0f5a7dd5c61b32a3764f025db1d559902a04231d24dad422c1fa7ff885561b5da443d67e762711638394196dd75f440fe0e9
+  metadata.gz: c97e2a1940e91880215a3d55d489260df0e5e04e1e61f818b4468d876c857229a2c3ed60f07f41d72707c3fae7f25c033297c13fd9f0421f3a214af99226fe34
+  data.tar.gz: 2fa7792d71e250b1e63c2389f2533459f13651b153997a9a99ba4b89c6e3bef7c5c0b193cfa75215e453d77531807b3d09a372b3be96a69b4f6bc0acb31bc1bd

data/README.md

@@ -1,15 +1,12 @@
 # Pushr
 
-Please note: We're in the process of updating this gem. The current code is not yet stable. Please contact us if you
-want to test or contribute to this project.
-
 [![Build Status](https://travis-ci.org/9to5/pushr-core.svg?branch=master)](https://travis-ci.org/9to5/pushr-core)
 [![Code Climate](https://codeclimate.com/github/9to5/pushr-core.png)](https://codeclimate.com/github/9to5/pushr-core)
 [![Coverage Status](https://coveralls.io/repos/9to5/pushr-core/badge.png)](https://coveralls.io/r/9to5/pushr-core)
 
 ## Features
 
-* Lightening fast push notification delivery
+* Lightning fast push notification delivery
 * Redis for queueing
 * Redis or YAML for configuration
 * Multi-App
@@ -133,18 +130,21 @@ Where `<options>` can be:
 
 ## Sending notifications
 
+Use the `new` and `save` methods to create a message or use the `create` and `create!` methods. These methods are
+similar to the ActiveRecord model methods.
+
 APNS:
 ```ruby
 Pushr::MessageApns.create(
-    app: 'app_name',
-    device: '<APNS device_token here>',
-    alert: 'Hello World',
-    sound: '1.aiff',
-    badge: 1,
-    expiry: 1.day.from_now.to_i,
-    attributes_for_device: {key: 'MSG'},
-    priority: 10,
-    content_available: 1)
+    app: 'app_name',                      # required: String, the name of the configuration
+    device: '<APNS device_token here>',   # required: String, token of the device
+    expiry: 1.day.from_now.to_i,          # required: Integer, A UNIX epoch date expressed in seconds
+    priority: 10,                         # required: Integer, 10 or 5 (should be 10 if message includes an alert, sound or badge)
+    alert: 'Hello World',                 # optional: String or Hash, read APNS documentation for more information
+    sound: '1.aiff',                      # optional: String, sound to play
+    badge: 1,                             # optional: Integer, display badge on homescreen
+    attributes_for_device: {key: 'MSG'},  # optional: Hash, send additional parameters
+    content_available: 1)                 # optional: Integer, 1 if device should be notified if new content is available
 ```
 
 
@@ -168,15 +168,15 @@ Use `content_available: 1` if the iOS device should start your app upon receivin
 GCM:
 ```ruby
 Pushr::MessageGcm.create(
-    app: 'app_name',
-    registration_ids: ['<GCM registration_id here>', '<GCM registration_id here>'],
-    notification_key: 'notification_key_name',
-    delay_while_idle: true,
-    data: { message: 'Hello World' },
-    time_to_live: 24 * 60 * 60,
-    restricted_package_name: 'com.example.gcm',
-    dry_run: false,
-    collapse_key: 'MSG')
+    app: 'app_name',                                # required: String, the name of the configuration
+    registration_ids: ['<registration_id>', '...'], # required: Array of registration ids
+    notification_key: 'notification_key_name',      # optional: String, Use with User Notifications
+    delay_while_idle: true,                         # optional: Boolean, message is received if device is active
+    data: { message: 'Hello World' },               # optional: Hash, contains information for the app
+    time_to_live: 24 * 60 * 60,                     # optional: Integer, in seconds how long the message will be stored
+    restricted_package_name: 'com.example.gcm',     # optional: String, message will only be received with this package name
+    dry_run: false,                                 # optional: Boolean, do not actually deliver the message to the app
+    collapse_key: 'MSG')                            # optional: String, messages with the same key can be collapsed into one
 ```
 
 ## Feedback processing

data/lib/pushr/configuration.rb

@@ -33,6 +33,14 @@ module Pushr
       m
     end
 
+    def self.create!(attributes = {})
+      m = new(attributes)
+      unless m.save
+        raise Pushr::Error::RecordInvalid
+      end
+      m
+    end
+
     def delete
       Pushr::Core.redis { |conn| conn.hdel('pushr:configurations', key) }
     end

data/lib/pushr/core.rb

@@ -2,6 +2,7 @@ require 'yaml'
 require 'active_model'
 require 'multi_json'
 require 'pushr/version'
+require 'pushr/error'
 require 'pushr/configuration'
 require 'pushr/message'
 require 'pushr/feedback'

data/lib/pushr/error.rb

@@ -0,0 +1,10 @@
+module Pushr
+
+  # Module containing Pushr::Error classes, all of which extend StandardError.
+  module Error
+
+    # Raised if the entered authentication details (API key or username and password) are incorrect. (Error code: 2)
+    class RecordInvalid < StandardError
+    end
+  end
+end

data/lib/pushr/feedback.rb

@@ -29,6 +29,14 @@ module Pushr
       m
     end
 
+    def self.create!(attributes = {})
+      m = new(attributes)
+      unless m.save
+        raise Pushr::Error::RecordInvalid
+      end
+      m
+    end
+
     def to_json
       MultiJson.dump(to_hash)
     end

data/lib/pushr/message.rb

@@ -26,6 +26,14 @@ module Pushr
       m
     end
 
+    def self.create!(attributes = {})
+      m = new(attributes)
+      unless m.save
+        raise Pushr::Error::RecordInvalid
+      end
+      m
+    end
+
     def to_json
       MultiJson.dump(to_hash)
     end

data/lib/pushr/version.rb

@@ -1,3 +1,3 @@
 module Pushr
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/spec/lib/pushr/configuration_spec.rb

@@ -49,6 +49,28 @@ describe Pushr::Configuration do
     end
   end
 
+  describe 'create!' do
+    subject { Pushr::ConfigurationDummy.create!(app: app_name, connections: 2, enabled: true) }
+
+    context 'with app name' do
+      let(:app_name) { 'app_name' }
+      it 'should create a message' do
+        expect(subject.valid?).to eql true
+      end
+
+      it 'should create a ConfigurationDummy class' do
+        expect(subject.class).to eql Pushr::ConfigurationDummy
+      end
+    end
+
+    context 'without app name' do
+      let(:app_name) { nil }
+      it 'should raise error' do
+        expect { subject }.to raise_error Pushr::Error::RecordInvalid
+      end
+    end
+  end
+
   describe 'find' do
     let!(:config) { Pushr::ConfigurationDummy.new(app: 'app_name', connections: 2, enabled: true) }
     it 'should find a configuration' do

data/spec/lib/pushr/feedback_spec.rb

@@ -35,4 +35,26 @@ describe Pushr::Feedback do
       expect(subject.class).to eql Pushr::FeedbackDummy
     end
   end
+
+  describe 'create!' do
+    subject { Pushr::FeedbackDummy.create!(app: app_name, device: 'a' * 64, follow_up: 'delete', failed_at: Time.now) }
+
+    context 'with app name' do
+      let(:app_name) { 'app_name' }
+      it 'should create a message' do
+        expect(subject.valid?).to eql true
+      end
+
+      it 'should create a FeedbackDummy class' do
+        expect(subject.class).to eql Pushr::FeedbackDummy
+      end
+    end
+
+    context 'without app name' do
+      let(:app_name) { nil }
+      it 'should raise error' do
+        expect { subject }.to raise_error Pushr::Error::RecordInvalid
+      end
+    end
+  end
 end

data/spec/lib/pushr/message_spec.rb

@@ -41,4 +41,26 @@ describe Pushr::Message do
       expect(subject.class).to eql Pushr::MessageDummy
     end
   end
+
+  describe 'create!' do
+    subject { Pushr::MessageDummy.create!(app: app_name) }
+
+    context 'with app name' do
+      let(:app_name) { 'app_name' }
+      it 'should create a message' do
+        expect(subject.valid?).to eql true
+      end
+
+      it 'should create a MessageDummy class' do
+        expect(subject.class).to eql Pushr::MessageDummy
+      end
+    end
+
+    context 'without app name' do
+      let(:app_name) { nil }
+      it 'should raise error' do
+        expect { subject }.to raise_error Pushr::Error::RecordInvalid
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pushr-core
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Tom Pesman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-27 00:00:00.000000000 Z
+date: 2015-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -28,16 +28,16 @@ dependencies:
   name: redis-namespace
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +84,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -201,6 +201,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.md
+- bin/pushr
 - lib/generators/templates/feedback_processor.rb
 - lib/generators/templates/pushr.yml
 - lib/pushr/configuration.rb
@@ -213,12 +216,11 @@ files:
 - lib/pushr/daemon/message_handler.rb
 - lib/pushr/daemon/pid_file.rb
 - lib/pushr/daemon/settings.rb
+- lib/pushr/error.rb
 - lib/pushr/feedback.rb
 - lib/pushr/message.rb
 - lib/pushr/redis_connection.rb
 - lib/pushr/version.rb
-- README.md
-- MIT-LICENSE
 - spec/lib/pushr/configuration_spec.rb
 - spec/lib/pushr/daemon/app_spec.rb
 - spec/lib/pushr/daemon/delivery_error_spec.rb
@@ -238,7 +240,6 @@ files:
 - spec/support/pushr_feedback_processor_dummy.rb
 - spec/support/pushr_invalid_configuration_dummy.rb
 - spec/support/pushr_message_dummy.rb
-- bin/pushr
 homepage: https://github.com/9to5/pushr-core
 licenses:
 - MIT
@@ -259,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Core of the pushr daemon.