mercurius 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 65ff200559fb5130010b47d7d2be2cc1e524b0de
+  data.tar.gz: 8a28049240b58317298775619721978b80cb7ce7
+SHA512:
+  metadata.gz: ce55894987fecb4a496c014681d07dbea9375e805e2a1523b2d2495fe09a8bfb9a13254f6a78fd720ab3d994311903c5a0ace2415a2edf8b21b7b81dfaf10bd1
+  data.tar.gz: 334217c4278902311a45fed9ae873b912246354f25972d04dab17356fdca3f68fd0d6d0a214f103d7fd399d617253d99858ddc35a3bc19038d0c7edadbb34173

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+NEW_README.md

data/.ruby-gemset

@@ -0,0 +1 @@
+mercurius

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.5

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+#  - 1.9.3
+  - 2.0.0
+#  - jruby-19mode # JRuby in 1.9 mode
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mercurius.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+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,31 @@
+# Mercurius
+
+### Send push messages to Android, iOS devices.
+
+## Installation
+
+    $ gem install mercurius
+
+or add to your ``Gemfile``
+
+    gem 'mercurius'
+
+and install it with
+
+    $ bundle install
+
+## Contributing
+
+Please fork, modify, and send a pull request if you want to help improve this gem.
+
+## Thanks
+
+This gem is based off of the 'pushmeup' gem by Nicos Karalis
+
+https://github.com/NicosKaralis/pushmeup
+
+## License
+
+Mercurius is released under the MIT license:
+
+http://www.opensource.org/licenses/MIT

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec
+
+desc 'Open an IRB session preloaded with this library'
+task :console do
+  sh "irb -rubygems -I lib -r mercurius.rb"
+end

data/lib/mercurius/android.rb

@@ -0,0 +1,2 @@
+require "mercurius/gcm/core"
+require "mercurius/gcm/notification"

data/lib/mercurius/apns/core.rb

@@ -0,0 +1,128 @@
+require 'socket'
+require 'openssl'
+require 'json'
+
+module APNS
+  class Error < Exception; end
+  class ConfigurationError < Error; end
+
+  @host = 'gateway.sandbox.push.apple.com'
+  @port = 2195
+  @pem_path = nil
+  @pem_password = nil
+  @pem_data = nil
+
+  @persistent = false
+  @mutex = Mutex.new
+  @retries = 3 # TODO: check if we really need this
+
+  @sock = nil
+  @ssl = nil
+
+  class << self
+    attr_accessor :host, :port, :pem_path, :pem_password, :pem_data
+  end
+
+  def self.start_persistence
+    @persistent = true
+  end
+
+  def self.stop_persistence
+    @persistent = false
+    self.close_connection
+  end
+
+  def self.send_notification(device_token, message)
+    notification = APNS::Notification.new(device_token, message)
+    send_notifications([notification])
+  end
+
+  def self.send_notifications(notifications)
+    @mutex.synchronize do
+      with_connection do
+        notifications.each do |n|
+          @ssl.write(n.packaged_notification)
+        end
+      end
+    end
+  end
+
+  def self.feedback
+    sock, ssl = feedback_connection
+    apns_feedback = []
+
+    # read lines from the socket
+    while line = ssl.read(38)
+      line.strip!
+      f = line.unpack('N1n1H140')
+      apns_feedback << { timestamp: Time.at(f[0]), token: f[2] }
+    end
+
+    ssl.close
+    sock.close
+
+    apns_feedback
+  end
+
+protected
+
+  def self.with_connection
+    attempts = 1
+
+    begin
+      open_connection if connection_closed?
+      yield
+    rescue StandardError, Errno::EPIPE
+      raise Error.new("Failed after #{@retries} attempts.") unless attempts < @retries
+      close_connection
+      attempts += 1
+      retry
+    end
+
+    close_connection unless @persistent
+  end
+
+  def self.open_connection
+    @sock = TCPSocket.new(self.host, self.port)
+    @ssl = OpenSSL::SSL::SSLSocket.new(@sock, context)
+    @ssl.connect
+  end
+
+  def self.close_connection
+    @ssl.close
+    @ssl = nil
+    @sock.close
+    @sock = nil
+  end
+
+  def self.connection_closed?
+    @ssl.nil? || @sock.nil? || @ssl.closed? || @sock.closed?
+  end
+
+  def self.feedback_connection
+    fhost = self.host.gsub('gateway','feedback')
+    sock = TCPSocket.new(fhost, 2196)
+    ssl = OpenSSL::SSL::SSLSocket.new(sock, context)
+    ssl.connect
+    return sock, ssl
+  end
+
+  def self.context
+    context = OpenSSL::SSL::SSLContext.new
+    context.cert = OpenSSL::X509::Certificate.new(pem_data)
+    context.key = OpenSSL::PKey::RSA.new(pem_data, pem_password)
+    context
+  end
+
+  def self.pem_data
+    return @pem_data if @pem_data
+
+    if @pem_path
+      raise ConfigurationError.new('The specified PEM file does not exist.') unless File.exist?(@pem_path)
+      @pem_data = File.read(@pem_path)
+    else
+      raise ConfigurationError.new('PEM not configured properly.')
+    end
+  end
+
+end

data/lib/mercurius/apns/notification.rb

@@ -0,0 +1,47 @@
+module APNS
+  class Notification
+    attr_accessor :device_token, :alert, :badge, :sound, :other
+
+    def initialize(device_token, message)
+      self.device_token = device_token
+      if message.is_a?(Hash)
+        self.alert = message[:alert]
+        self.badge = message[:badge]
+        self.sound = message[:sound]
+        self.other = message[:other]
+      elsif message.is_a?(String)
+        self.alert = message
+      else
+        raise "Notification needs to have either a Hash or String"
+      end
+    end
+
+    def packaged_notification
+      pt = self.packaged_token
+      pm = self.packaged_message
+      [0, 0, 32, pt, 0, pm.bytesize, pm].pack("ccca*cca*")
+    end
+
+    def packaged_token
+      [device_token.gsub(/[\s|<|>]/,'')].pack('H*')
+    end
+
+    def packaged_message
+      aps = {'aps'=> {} }
+      aps['aps']['alert'] = self.alert if self.alert
+      aps['aps']['badge'] = self.badge if self.badge
+      aps['aps']['sound'] = self.sound if self.sound
+      aps.merge!(self.other) if self.other
+      aps.to_json.gsub(/\\u([\da-fA-F]{4})/) {|m| [$1].pack("H*").unpack("n*").pack("U*")}
+    end
+
+    def ==(that)
+      device_token == that.device_token &&
+      alert == that.alert &&
+      badge == that.badge &&
+      sound == that.sound &&
+      other == that.other
+    end
+
+  end
+end

data/lib/mercurius/apple.rb

@@ -0,0 +1,2 @@
+require "mercurius/apns/core"
+require "mercurius/apns/notification"

data/lib/mercurius/gcm/core.rb

@@ -0,0 +1,113 @@
+require 'httparty'
+require 'json'
+
+module GCM
+  include HTTParty
+
+  @host = 'https://android.googleapis.com/gcm/send'
+  @format = :json
+  @key = nil
+
+  class << self
+    attr_accessor :host, :format, :key
+
+    def key(identity = nil)
+      if @key.is_a?(Hash)
+        raise %{If your key is a hash of keys you'll need to pass a identifier to the notification!} if identity.nil?
+        return @key[identity]
+      else
+        return @key
+      end
+    end
+
+    def key_identities
+      if @key.is_a?(Hash)
+        return @key.keys
+      else
+        return nil
+      end
+    end
+  end
+
+  def self.send_notification(device_tokens, data = {}, options = {})
+    n = GCM::Notification.new(device_tokens, data, options)
+    self.send_notifications([n])
+  end
+
+  def self.send_notifications(notifications)
+    responses = []
+    notifications.each do |n|
+      responses << self.prepare_and_send(n)
+    end
+    responses
+  end
+
+  private
+
+  def self.prepare_and_send(n)
+    if n.device_tokens.count < 1 || n.device_tokens.count > 1000
+      raise "Number of device tokens must be between 1 and 1000"
+    end
+    if !n.collapse_key.nil? && n.time_to_live.nil?
+      raise %q{If you are defining a "collapse key" you need a "time to live"}
+    end
+    if @key.is_a?(Hash) && n.identity.nil?
+      raise %{If your key is a Hash of keys you'll need to pass a identifier to the notification!}
+    end
+
+    if self.format == :json
+      self.send_push_as_json(n)
+    elsif self.format == :text
+      self.send_push_as_plain_text(n)
+    else
+      raise "Invalid format"
+    end
+  end
+
+  def self.send_push_as_json(n)
+    headers = {
+      'Authorization' => "key=#{ self.key(n.identity) }",
+      'Content-Type' => 'application/json',
+    }
+    body = {
+      registration_ids: n.device_tokens,
+      data: n.data,
+      collapse_key: n.collapse_key,
+      time_to_live: n.time_to_live,
+      delay_while_idle: n.delay_while_idle
+    }
+    return self.send_to_server(headers, body.to_json)
+  end
+
+  def self.send_push_as_plain_text(n)
+    raise "Still has to be done: http://developer.android.com/guide/google/gcm/gcm.html"
+    headers = {
+      # TODO: Aceitar key ser um hash
+      'Authorization' => "key=#{ self.key(n.identity) }",
+      'Content-Type' => 'application/x-www-form-urlencoded;charset=UTF-8',
+    }
+    return self.send_to_server(headers, body)
+  end
+
+  def self.send_to_server(headers, body)
+    params = { headers: headers, body: body}
+    response = self.post(self.host, params)
+    build_response(response)
+  end
+
+  def self.build_response(response)
+    case response.code
+      when 200
+        { response:  'success', body: JSON.parse(response.body), headers: response.headers, status_code: response.code }
+      when 400
+        { response: 'Only applies for JSON requests. Indicates that the request could not be parsed as JSON, or it contained invalid fields.', status_code: response.code }
+      when 401
+        { response: 'There was an error authenticating the sender account.', status_code: response.code }
+      when 500
+        { response: 'There was an internal error in the GCM server while trying to process the request.', status_code: response.code }
+      when 503
+        { response: 'Server is temporarily unavailable.', status_code: response.code }
+    end
+  end
+
+end

data/lib/mercurius/gcm/notification.rb

@@ -0,0 +1,55 @@
+module GCM
+  class Notification
+    attr_accessor :device_tokens, :data, :collapse_key, :time_to_live, :delay_while_idle, :identity
+
+    def initialize(tokens, data, options = {})
+      self.device_tokens = tokens
+      self.data = data
+
+      @collapse_key = options[:collapse_key]
+      @time_to_live = options[:time_to_live]
+      @delay_while_idle = options[:delay_while_idle]
+      @identity = options[:identity]
+    end
+
+    def device_tokens=(tokens)
+      if tokens.is_a?(Array)
+        @device_tokens = tokens
+      elsif tokens.is_a?(String)
+        @device_tokens = [tokens]
+      else
+        raise "device_tokens needs to be either an Array or a String"
+      end
+    end
+
+    def data=(data)
+      if data.is_a?(Hash)
+        @data = data
+      else
+        raise "data parameter must be the type of Hash"
+      end
+    end
+
+    def delay_while_idle=(delay_while_idle)
+      @delay_while_idle = (delay_while_idle == true || delay_while_idle == :true)
+    end
+
+    def time_to_live=(time_to_live)
+      if time_to_live.is_a?(Integer)
+        @time_to_live = time_to_live
+      else
+        raise %q{"time_to_live" must be seconds as an integer value, like "100"}
+      end
+    end
+
+    def ==(that)
+      device_tokens == that.device_tokens &&
+      data == that.data &&
+      collapse_key == that.collapse_key &&
+      time_to_live == that.time_to_live &&
+      delay_while_idle == that.delay_while_idle &&
+      identity == that.identity
+    end
+
+  end
+end

data/lib/mercurius/version.rb

@@ -0,0 +1,3 @@
+module Mercurius
+  VERSION = '0.0.1'
+end

data/lib/mercurius.rb

@@ -0,0 +1,3 @@
+require "mercurius/version"
+require "mercurius/apple"
+require "mercurius/android"

data/mercurius.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mercurius/version"
+
+Gem::Specification.new do |s|
+  s.name            = 'mercurius'
+  s.version         = Mercurius::VERSION
+  s.authors         = ["John Beck"]
+  s.email           = ["jbeck@live.com"]
+
+  s.homepage        = "https://github.com/jrbeck/mercurius"
+  s.summary         = %q{Send push notifications to mobile devices through native services}
+  s.description     = <<-DESC
+                        This gem is a wrapper to send push notifications to devices through native push services.
+                      DESC
+
+  s.rubyforge_project = "mercurius"
+
+  s.files             = `git ls-files`.split("\n")
+  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.add_dependency 'httparty'
+  s.add_dependency 'json'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+end

data/spec/lib/mercurius_spec.rb

@@ -0,0 +1,148 @@
+require 'spec_helper'
+
+describe Mercurius do
+  describe "APNS" do
+    it "should have an APNS object" do
+      defined?(APNS).should_not be_false
+    end
+
+    it "should not forget the APNS default parameters" do
+      APNS.host.should == "gateway.sandbox.push.apple.com"
+      APNS.port.should == 2195
+      APNS.pem_path.should be_equal(nil)
+      APNS.pem_password.should be_equal(nil)
+    end
+
+    describe "Notifications" do
+      describe "#==" do
+        it "should properly equate objects without caring about object identity" do
+          a = APNS::Notification.new("123", {:alert => "hi"})
+          b = APNS::Notification.new("123", {:alert => "hi"})
+          a.should eq(b)
+        end
+      end
+    end
+
+    describe '.send_notification' do
+      let(:token) { 'token' }
+      let(:message) { 'message' }
+      let(:pem_data) { 'pem_data' }
+      let(:cert) { double }
+      let(:key) { double }
+      let(:sock) { double(close: nil) }
+      let(:ssl) { double(connect: nil, write: nil, close: nil) }
+      let(:packaged) { 'packaged' }
+
+      after do
+        APNS.pem_path = nil
+        APNS.pem_data = nil
+      end
+
+      before do
+        allow(OpenSSL::X509::Certificate).to receive(:new).
+          with(pem_data).and_return(cert)
+        allow(OpenSSL::PKey::RSA).to receive(:new).
+          with(pem_data, anything).and_return(key)
+        allow(TCPSocket).to receive(:new).and_return(sock)
+        allow(OpenSSL::SSL::SSLSocket).to receive(:new).and_return(ssl)
+      end
+
+      shared_examples 'notifications' do
+        it 'notifications are sent' do
+          expect(ssl).to have_received(:write).with(/"#{message}"/)
+        end
+      end
+
+      context 'with pem setting' do
+        context 'with an existing pem file' do
+          let(:path) { '/good/path' }
+
+          before do
+            allow(File).to receive(:exist?).with(path).and_return(true)
+            allow(File).to receive(:read).with(path).and_return(pem_data)
+          end
+
+          before { APNS.pem_path = '/good/path' }
+          before { APNS.send_notification(token, message) }
+
+          include_examples 'notifications'
+        end
+
+        context 'when the pem does not exist' do
+          before { APNS.pem_path = '/bad/path' }
+
+          it 'fails' do
+            expect do
+              APNS.send_notification(token, message)
+            end.to raise_error(APNS::ConfigurationError, /does not exist/)
+          end
+        end
+      end
+
+      context 'with pem_data' do
+        before { APNS.pem_data = pem_data }
+        before { APNS.send_notification(token, message) }
+
+        include_examples 'notifications'
+      end
+
+      context 'without pem or pem_data' do
+        before { APNS.pem_path = nil }
+
+        it 'fails' do
+          expect do
+            APNS.send_notification(token, message)
+          end.to raise_error(APNS::ConfigurationError, /PEM not configured properly/)
+        end
+      end
+    end
+
+  end
+
+  describe "GCM" do
+    it "should have a GCM object" do
+      defined?(GCM).should_not be_false
+    end
+
+    describe "Notifications" do
+
+      before do
+        @options = {:data => "dummy data"}
+      end
+
+      it "should allow only notifications with device_tokens as array" do
+        n = GCM::Notification.new("id", @options)
+        n.device_tokens.is_a?(Array).should be_true
+
+        n.device_tokens = ["a" "b", "c"]
+        n.device_tokens.is_a?(Array).should be_true
+
+        n.device_tokens = "a"
+        n.device_tokens.is_a?(Array).should be_true
+      end
+
+      it "should allow only notifications with data as hash with :data root" do
+        n = GCM::Notification.new("id", { :data => "data" })
+
+        n.data.is_a?(Hash).should be_true
+        n.data.should == {:data => "data"}
+
+        n.data = {:a => ["a", "b", "c"]}
+        n.data.is_a?(Hash).should be_true
+        n.data.should == {:a => ["a", "b", "c"]}
+
+        n.data = {:a => "a"}
+        n.data.is_a?(Hash).should be_true
+        n.data.should == {:a => "a"}
+      end
+
+      describe "#==" do
+        it "should properly equate objects without caring about object identity" do
+          a = GCM::Notification.new("id", { :data => "data" })
+          b = GCM::Notification.new("id", { :data => "data" })
+          a.should eq(b)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'mercurius'

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: mercurius
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Beck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  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: 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: |2
+                          This gem is a wrapper to send push notifications to devices through native push services.
+email:
+- jbeck@live.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mercurius.rb
+- lib/mercurius/android.rb
+- lib/mercurius/apns/core.rb
+- lib/mercurius/apns/notification.rb
+- lib/mercurius/apple.rb
+- lib/mercurius/gcm/core.rb
+- lib/mercurius/gcm/notification.rb
+- lib/mercurius/version.rb
+- mercurius.gemspec
+- spec/lib/mercurius_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jrbeck/mercurius
+licenses: []
+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: mercurius
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Send push notifications to mobile devices through native services
+test_files:
+- spec/lib/mercurius_spec.rb
+- spec/spec_helper.rb