mercurius 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fff5a024bedc9602172b080681a4ed8b28f8d45
-  data.tar.gz: 06d8f0cd9206fc23c70cf66e48c2c1912bd3458e
+  metadata.gz: e9a83b6fe0b488197398d7f81294ff118c63509c
+  data.tar.gz: d641b9ab3f5b2651b7454f72d3399f932b2e9ef8
 SHA512:
-  metadata.gz: 66e282ada6fef6296cf21380105f067aae9a54c27e0f0058f28b1fe467fc6595531c1aa7eef4d16017fb675ed4ef276522752436d557ef2fae0a206c40b6abb7
-  data.tar.gz: 8caff3a87dd456736a0777607998f75a5e8b3a3dd1ef7cc2b280b776b05ac2c3bf05b4de8496050d42aefa7ebe8a2165e6ca3f8070ae4bc673ffc3228de54ede
+  metadata.gz: 54ef3d103e7d6a1f18bf198c7369f0a3a901eeec99bd045199f49336d5a93ad39d9992d4c5058363454f290bd17a6c25b96d59aa90a986bf602ccc5afc8c5ad8
+  data.tar.gz: cf40a5d26640d9de5cfc936a8fc9b7060693553d36110d828d3a2084db5787a595daf84ae3d1c4d1f18e16fd99b26bb876ddc14a1949e18f4ae141582e59549e

data/README.md

@@ -2,6 +2,8 @@
 
 ### Send push messages to Android, iOS devices.
 
+This gem is designed to be easy to configure for simple operation when your needs are simple, but also allow more complicated cases such as when you need to send to multiple applications with different configurations. The interface is designed to be as similar as possible for GCM and APNS.
+
 ## Installation
 
     $ gem install mercurius
@@ -14,15 +16,64 @@ and install it with
 
     $ bundle install
 
-## Contributing
+## GCM
 
-Please fork, modify, and send a pull request if you want to help improve this gem.
+Set up the default GCM configuration. (All GCM::Services will be created with this configuration, but the configuration can be overridden per-service if you need to.)
+
+    GCM.key = 'your_gcm_key'
+
+Create the service with:
+
+    gcm_service = GCM::Service.new
+
+Now create the notification that you wish to send:
+
+    gcm_notification = GCM::Notification.new(alert: 'Hey')
+
+You can deliver the gcm_notification in the following manners:
+
+    gcm_service.deliver gcm_notification, 'token123'              # single recipient
+    gcm_service.deliver gcm_notification, 'token123', 'token456'  # multiple recipients
+    token_array = ['token123', 'token456']
+    gcm_service.deliver gcm_notification, token_array             # multiple recipients
+
+## APNS
+
+The typical APNS configuration is set automatically, but you need to set the host with with either:
+
+    APNS.set_mode(:develop) # gateway.sandbox.push.apple.com
 
-## Thanks
+or
 
-This gem is based off of the 'pushmeup' gem by Nicos Karalis
+    APNS.set_mode(:production) # gateway.push.apple.com
 
-https://github.com/NicosKaralis/pushmeup
+Next, you'll need to set your PEM information. This can either be with a file or with a text buffer:
+
+    pem = APNS::Pem.new(path: 'sandbox.pem', password: 'test123')
+    pem = APNS::Pem.new(data: pem_data_buffer, password: 'test123')
+
+Set the default configuration:
+
+    APNS.pem = pem
+
+Now you are ready to create the APNS::Service, which will allow you to send notifications:
+
+    apns_service = APNS::Service.new
+
+The APNS::Service object is created with the settings from earlier, but any of them can be overridden if you need more control (for instance if you need to send with multiple PEMs)
+
+    apns_notification = APNS::Notification.new(alert: 'Hey')
+
+The deliver method can be called in the following ways:
+
+    apns_service.deliver apns_notification, 'token123'              # single recipient
+    apns_service.deliver apns_notification, 'token123', 'token456'  # multiple recipients
+    token_array = ['token123', 'token456']
+    apns_service.deliver apns_notification, token_array             # multiple recipients
+
+## Contributing
+
+Please fork, modify, and send a pull request if you want to help improve this gem.
 
 ## License
 

data/lib/mercurius/apns.rb

@@ -1,10 +1,22 @@
 module APNS
+  HOSTS = {
+    develop: 'gateway.sandbox.push.apple.com',
+    production: 'gateway.push.apple.com',
+  }
+
   @host = ''
   @port = 2195
   @pem = nil
 
   class << self
     attr_accessor :host, :port, :pem
+
+    def set_mode(mode)
+      host = HOSTS.fetch(mode, nil)
+      raise InvalidApnsModeError.new if host.nil?
+      @host = host
+    end
+
   end
 
-end
+end

data/lib/mercurius/errors/invalid_apns_mode_error.rb

@@ -0,0 +1,7 @@
+class InvalidApnsModeError < StandardError
+
+  def initialize
+    super 'Tried to set invalid APNS mode.'
+  end
+
+end

data/lib/mercurius/version.rb

@@ -1,3 +1,3 @@
 module Mercurius
-  VERSION = '0.0.9'
+  VERSION = '0.1.0'
 end

data/lib/mercurius.rb

@@ -7,6 +7,7 @@ require 'json'
 
 require 'mercurius/version'
 
+require 'mercurius/errors/invalid_apns_mode_error'
 require 'mercurius/errors/pem_not_configured_error'
 require 'mercurius/errors/pem_not_found_error'
 require 'mercurius/errors/too_many_retries_error'

data/spec/lib/apns_service_spec.rb

@@ -10,9 +10,9 @@ describe APNS::Service do
   end
 
   it 'should default to the APNS module configs' do
-    expect(service.host).to eq 'gateway.sandbox.push.apple.com'
-    expect(service.port).to eq 2195
-    expect(service.pem.password).to eq 'test123'
+    expect(service.host).to eq APNS.host
+    expect(service.port).to eq APNS.port
+    expect(service.pem.password).to eq APNS.pem.password
   end
 
   describe '#send' do

data/spec/lib/apns_spec.rb

@@ -0,0 +1,19 @@
+describe APNS do
+
+  it 'sets up the develop mode' do
+    APNS.set_mode(:develop)
+    expect(APNS.host).to eq APNS::HOSTS[:develop]
+  end
+
+  it 'sets up the production mode' do
+    APNS.set_mode(:production)
+    expect(APNS.host).to eq APNS::HOSTS[:production]
+  end
+
+  it 'will not change the host if an invalid mode is specified' do
+    APNS.host = 'host'
+    expect { APNS.set_mode(:overdrive) }.to raise_error
+    expect(APNS.host).to eq 'host'
+  end
+
+end

data/spec/lib/gcm_service_spec.rb

@@ -3,8 +3,8 @@ describe GCM::Service do
   let(:message) { GCM::Notification.new(alert: 'Hey') }
 
   it 'should default to the GCM module configs' do
-    expect(service.host).to eq 'https://android.googleapis.com/'
-    expect(service.key).to be_nil
+    expect(service.host).to eq GCM.host
+    expect(service.key).to GCM.key
   end
 
   describe '#send' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mercurius
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - John Beck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-04 00:00:00.000000000 Z
+date: 2015-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -145,6 +145,7 @@ files:
 - lib/mercurius/apns/notification.rb
 - lib/mercurius/apns/pem.rb
 - lib/mercurius/apns/service.rb
+- lib/mercurius/errors/invalid_apns_mode_error.rb
 - lib/mercurius/errors/pem_not_configured_error.rb
 - lib/mercurius/errors/pem_not_found_error.rb
 - lib/mercurius/errors/too_many_retries_error.rb
@@ -161,9 +162,10 @@ files:
 - lib/mercurius/testing/service.rb
 - lib/mercurius/version.rb
 - mercurius.gemspec
+- spec/lib/apns_notification_spec.rb
 - spec/lib/apns_service_spec.rb
+- spec/lib/apns_spec.rb
 - spec/lib/gcm_service_spec.rb
-- spec/lib/notification_spec.rb
 - spec/lib/testing_spec.rb
 - spec/spec_helper.rb
 - spec/support/apns.pem
@@ -192,9 +194,10 @@ signing_key:
 specification_version: 4
 summary: Send push notifications to mobile devices through native services
 test_files:
+- spec/lib/apns_notification_spec.rb
 - spec/lib/apns_service_spec.rb
+- spec/lib/apns_spec.rb
 - spec/lib/gcm_service_spec.rb
-- spec/lib/notification_spec.rb
 - spec/lib/testing_spec.rb
 - spec/spec_helper.rb
 - spec/support/apns.pem