c2dm-rails 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+
+gem 'rails', "~> 3.1.0"
+gem 'httparty', "> 0.6.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+end

data/Gemfile.lock

@@ -0,0 +1,99 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.3)
+      actionpack (= 3.1.3)
+      mail (~> 2.3.0)
+    actionpack (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.5)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.3)
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    builder (3.0.0)
+    erubis (2.7.0)
+    git (1.2.5)
+    hike (1.2.1)
+    httparty (0.8.1)
+      multi_json
+      multi_xml
+    i18n (0.6.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.5)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.17.2)
+    multi_json (1.0.4)
+    multi_xml (0.4.1)
+    polyglot (0.3.3)
+    rack (1.3.6)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.1.3)
+      actionmailer (= 3.1.3)
+      actionpack (= 3.1.3)
+      activerecord (= 3.1.3)
+      activeresource (= 3.1.3)
+      activesupport (= 3.1.3)
+      bundler (~> 1.0)
+      railties (= 3.1.3)
+    railties (3.1.3)
+      actionpack (= 3.1.3)
+      activesupport (= 3.1.3)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    sprockets (2.0.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  httparty (> 0.6.0)
+  jeweler (~> 1.5.1)
+  rails (~> 3.1.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Heiko Moeller, empuxa gmbh
+
+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.markdown

@@ -0,0 +1,54 @@
+# c2dm-rails
+
+c2dm-rails provides infrastructure to send push notifications to Android devices via google [c2dm](http://code.google.com/android/c2dm/index.html).
+
+##Installation
+
+    $ gem install c2dm-rails
+    $ rake c2dm:install:migrations
+    $ rake db:migrate
+
+  After you installed the gem, you need to generate the migrations necessary for the gem to work and run them.
+    
+##Requirements
+
+An Android device running 2.2 or newer, its registration token, and a google account registered for c2dm.
+
+##Usage
+
+The gem is database driven. First of all, you need to create an app with the following credentials:
+
+    username: the username of the google account you entered in the c2dm registration
+    password: password for this account
+    application_id: the package of the android app (e.g. com.example)
+    sender_id: email account associated with the registration process. Can be the same as the user used to login
+    source: application identifier for google logging purposes. Should be of the form "companyName-applicationName-versionID"
+
+This can be done from the console, as these credentials won't change much.
+
+After you configured the app, you'll need to add devices to it. A device is identified by a `registration_id`, this can be send by the client each time it logs in, or can be done explicitly with a controller.
+
+Once you have the device, you are able to add messages to it, simply create a new `C2dm::Notification` object via `device.notifications.new` with the following information:
+
+    data: a hash, { :key1 => "value1", :key2 => "value2" }
+    delay_while_idle: boolean telling the google server if it should wake the device if it is idle
+    collapse_key: this details a group of messages. If the device is offline, it will only receive the "last" message. As there is now guarantee of delivering order, the "last" message might not be last message sent by your application
+
+Any other field is used to keep state by the delivery engine and should not be modified.
+
+After you added messages, get an instance of your app and send the messages:
+
+    app = C2dm::App.find(some_id)
+    app.deliver_notifications
+
+The app contains an exponential back-off mechanism for notifications that failed to deliver. It is of the form `last_sent_date + 10 ** tries`, with a maximum of 4 tries (about three hours).
+
+
+
+##Copyrights
+
+* Copyright (c) 2010-2011 Heiko Moeller, empuxa gmbh. See LICENSE.txt for details.
+
+##Thanks
+
+* [amro](https://github.com/amro/c2dm) for the basis of this gem

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "c2dm-rails"
+  gem.homepage = "https://github.com/Femaref/c2dm-rails"
+  gem.license = "MIT"
+  gem.summary = %Q{c2dm-rails provides infrastructure to send push notifications to android devices via google c2dm.}
+  gem.description = %Q{c2dm-rails provides infrastructure to send push notifications to android devices via google c2dm.}
+  gem.email = "femaref@gmail.com"
+  gem.authors = ["Heiko Moeller"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "c2dm-rails #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/app/models/c2dm/app.rb

@@ -0,0 +1,75 @@
+class C2dm::App < C2dm::Base  
+  set_table_name "c2dm_apps"
+  
+  has_many :devices, :class_name => "C2dm::Device", :dependent => :destroy
+  has_many :notifications, :through => :devices, :dependent => :destroy
+  
+  def deliver_notifications
+    connection = C2dm::Connection.new(username, password, source)
+    
+    self.notifications.deliverable.each do |notification|
+      if (notification.sent_at + (10 ** notification.tries).seconds) < Time.now
+        deliver_notification(notification, connection)
+      end
+    end 
+  end
+    
+  def deliver_notification (notification, connection = nil)
+    connection ||= C2dm::Connection.new(username, password, source)
+    
+    options = {
+      :registration_id => notification.device.registration_id,
+      :data => notification.data,
+      :collapse_key => notification.collapse_key,
+      :delay_while_idle => notification.delay_while_idle
+    }
+    
+    response = connection.send_notification(options)
+        
+    answer = Hash[response.body.scan(/(\w+)=(\w+)/).map{ |a| [a[0].downcase.to_sym, a[1]]}]
+    
+    notification.message_id = answer[:id]
+    notification.sent_at = Time.now
+    notification.deliver = false
+    
+    if response.response.code == 200 # request executed correctly
+      if answer.has_key? :error        
+        notification.error = answer[:error]
+        
+        # these are recoverable errors
+        if notification.error == "QuotaExceeded" || notification.error == "DeviceQuotaExceeded"
+          notification.try += 1
+          if notification.try <= 4
+            notification.deliver = true
+          else
+            notification.error = "TriesExceeded"
+          end
+        end
+        
+        # not a device connected with this app, delete it
+        if notification.error == "InvalidRegistration" || notification.error == "NotRegistered"
+          notification.device.delete
+        end
+        
+      end          
+    elsif response.response.code == 503 # service not available, redeliver message later
+      notification.error = "Service temporarily unavailable"
+      
+      notification.try += 1
+      
+      if notification.try <= 4
+        notification.deliver = true
+      else
+        notification.error = "TriesExceeded"
+      end
+      
+    elsif response.response.code == 401 # wrong api credentials
+      notification.error = "wrong authtoken, check corresponding login"   
+    else
+      notification.error = "unknown error"
+    end
+    
+    notification.save
+  end
+  
+end

data/app/models/c2dm/base.rb

@@ -0,0 +1,4 @@
+module C2dm
+  class Base < ActiveRecord::Base
+  end
+end

data/app/models/c2dm/device.rb

@@ -0,0 +1,6 @@
+class C2dm::Device < C2dm::Base  
+  set_table_name "c2dm_devices"
+  
+  belongs_to :app, :class_name => "C2dm::App"
+  has_many :notifications, :class_name => "C2dm::Notification", :dependent => :destroy
+end

data/app/models/c2dm/notification.rb

@@ -0,0 +1,9 @@
+class C2dm::Notification < C2dm::Base
+  set_table_name "c2dm_notifications"
+  
+  belongs_to :device, :class_name => "C2dm::Device"
+  
+  serialize :data, Hash
+  
+  scope :deliverable, ->() { where(:deliver => true) }
+end

data/c2dm-rails.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "c2dm-rails"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Heiko Moeller"]
+  s.date = "2012-02-08"
+  s.description = "c2dm-rails provides infrastructure to send push notifications to android devices via google c2dm."
+  s.email = "femaref@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "app/models/c2dm/app.rb",
+    "app/models/c2dm/base.rb",
+    "app/models/c2dm/device.rb",
+    "app/models/c2dm/notification.rb",
+    "c2dm-rails.gemspec",
+    "db/migrate/01_create_c2dm_apps.rb",
+    "db/migrate/02_create_c2dm_devices.rb",
+    "db/migrate/03_create_c2dm_notifications.rb",
+    "lib/c2dm-rails.rb",
+    "lib/connection.rb",
+    "test/helper.rb"
+  ]
+  s.homepage = "https://github.com/Femaref/c2dm-rails"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "c2dm-rails provides infrastructure to send push notifications to android devices via google c2dm."
+  s.test_files = [
+    "test/helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, ["~> 3.1.0"])
+      s.add_runtime_dependency(%q<httparty>, ["> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+    else
+      s.add_dependency(%q<rails>, ["~> 3.1.0"])
+      s.add_dependency(%q<httparty>, ["> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    end
+  else
+    s.add_dependency(%q<rails>, ["~> 3.1.0"])
+    s.add_dependency(%q<httparty>, ["> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+  end
+end
+

data/db/migrate/01_create_c2dm_apps.rb

@@ -0,0 +1,17 @@
+class CreateC2dmApps < ActiveRecord::Migration
+  def self.up
+    create_table :c2dm_apps do |t|
+      t.string :username
+      t.string :password
+      t.string :application_id
+      t.string :sender_id
+      t.string :source
+      
+      t.timestamps
+    end
+  end
+  
+  def self.down
+    drop_table :c2dm_apps
+  end
+end

data/db/migrate/02_create_c2dm_devices.rb

@@ -0,0 +1,14 @@
+class CreateC2dmDevices < ActiveRecord::Migration
+  def self.up
+    create_table :c2dm_devices do |t|
+      t.string :registration_id
+      t.integer :app_id
+      
+      t.timestamps
+    end
+  end
+  
+  def self.down
+    drop_table :c2dm_devices
+  end
+end

data/db/migrate/03_create_c2dm_notifications.rb

@@ -0,0 +1,22 @@
+class CreateC2dmNotifications < ActiveRecord::Migration
+  def self.up
+    create_table :c2dm_notifications do |t|  
+      t.string :collapse_key
+      t.text :data
+      t.boolean :delay_while_idle
+      t.integer :device_id
+    
+      t.integer :message_id
+      t.string :error
+      t.boolean :deliver, :default => true
+      t.datetime :sent_at
+      t.integer :try
+      
+      t.timestamps
+    end
+  end
+  
+  def self.down
+    drop_table :c2dm_notifications
+  end
+end

data/lib/c2dm-rails.rb

@@ -0,0 +1,24 @@
+require "c2dm-rails"
+require "connection"
+
+module C2dm
+  mattr_accessor :auth_url
+  mattr_accessor :push_url
+  
+  @@auth_url = 'https://www.google.com/accounts/ClientLogin'
+  @@push_url = 'https://android.apis.google.com/c2dm/send'
+  
+  def self.setup
+    yield self
+  end
+  
+  class Engine < Rails::Engine
+    engine_name "c2dm"
+    
+    config.c2dm = C2dm
+    
+    initializer "c2dm.initialize" do |app|
+      app.config.c2dm = C2dm
+    end
+  end
+end

data/lib/connection.rb

@@ -0,0 +1,92 @@
+require 'httparty'
+require 'cgi'
+
+module C2dm
+  class Connection
+    include HTTParty
+    default_timeout 30
+
+    attr_accessor :timeout, :username, :password, :source, :access_token
+
+    def initialize(username, password, source)
+      @username = username
+      @password = password
+      @source   = source
+
+      authenticate!
+    end
+
+    def authenticated?
+      !@auth_token.nil?
+    end
+
+    def authenticate!
+      auth_options = {
+        'accountType' => 'HOSTED_OR_GOOGLE',
+        'service'     => 'ac2dm',
+        'Email'       => self.username,
+        'Passwd'      => self.password,
+        'source'      => self.source
+      }
+      post_body = build_post_body(auth_options)
+
+      params = {
+        :body    => post_body,
+        :headers => {
+          'Content-type'   => 'application/x-www-form-urlencoded',
+          'Content-length' => post_body.length.to_s
+        }
+      }
+
+      response = self.class.post(C2dm.auth_url, params)
+
+      # check for authentication failures
+      raise response.parsed_response if response['Error=']
+
+      @auth_token = response.body.split("\n")[2].gsub('Auth=', '')
+    end
+
+    # {
+    #   :registration_id => "...",
+    #   :data => {
+    #     :some_message => "Hi!", 
+    #     :another_message => 7
+    #   }
+    #   :collapse_key => "optional collapse_key string"
+    # }
+    def send_notification(options)
+      options[:collapse_key] ||= 'foo'
+      post_body = build_post_body(options)
+
+      params = {
+        :body    => post_body,
+        :headers => {
+          'Authorization'  => "GoogleLogin auth=#{@auth_token}",
+          'Content-type'   => 'application/x-www-form-urlencoded',
+          'Content-length' => "#{post_body.length}"
+        }
+      }
+
+      self.class.post(C2dm.push_url, params)
+    end
+
+
+  private
+    def build_post_body(options={})
+      post_body = []
+
+      # data attributes need a key in the form of "data.key"...
+      data_attributes = options.delete(:data)
+      data_attributes.each_pair do |k,v|
+        post_body << "data.#{k}=#{CGI::escape(v.to_s)}"
+      end if data_attributes
+
+      options.each_pair do |k,v|
+        post_body << "#{k}=#{CGI::escape(v.to_s)}"
+      end
+
+      post_body.join('&')
+    end
+
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'c2dm-rails'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: c2dm-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Heiko Moeller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70282073720480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70282073720480
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70282073719080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70282073719080
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70282069687240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70282069687240
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70282069685320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *70282069685320
+description: c2dm-rails provides infrastructure to send push notifications to android
+  devices via google c2dm.
+email: femaref@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.markdown
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- app/models/c2dm/app.rb
+- app/models/c2dm/base.rb
+- app/models/c2dm/device.rb
+- app/models/c2dm/notification.rb
+- c2dm-rails.gemspec
+- db/migrate/01_create_c2dm_apps.rb
+- db/migrate/02_create_c2dm_devices.rb
+- db/migrate/03_create_c2dm_notifications.rb
+- lib/c2dm-rails.rb
+- lib/connection.rb
+- test/helper.rb
+homepage: https://github.com/Femaref/c2dm-rails
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2951700663620131590
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: c2dm-rails provides infrastructure to send push notifications to android
+  devices via google c2dm.
+test_files:
+- test/helper.rb