sanjose 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Min Kim
+
+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,50 @@
+# Sanjose
+**Google Cloud Message.**
+
+Sanjose is a simple gem for sending Google Cloud Message.
+
+> This project is inspired by [houston](https://github.com/mattt/houston) and named as following the series of world-class command-line utilities.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sanjose'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sanjose
+
+## Usage
+
+```ruby
+GCM = Sanjose::Client.new
+GCM.gcm_api_key = "AIzaSyApdin5fMuTSGtW-OTC9gJrm2qz1hJPUzk"
+
+# An example of the registration id sent back when a device registers for notifications
+registration_id = "APA91bH35MqYza3xfc2hfag6Rr8VQPSOmi2nrUOPABlFwowfVMZNHaBGBpx-zQ7nuv9qzCEosepUMPKyOrVn0UncZMa__E2sWuM2Q53fjJ5loqIY1QKCza3MkxAu1rvyhhzJP3meEqpmv-kjBuRTeWe_ysRUICupE-awrK1eiStmmm2Y_VBBSs4"
+
+# Create a notification that alerts a message to the user.
+notification = Sanjose::Notification.new(devices: [registration_id])
+notification.collapse_key = "Hello, World!"
+notification.data = {foo: "bar"}
+
+# And... sent! That's all it takes.
+GCM.push(notification)
+```
+
+## Contact
+
+Min Kim
+
+- http://github.com/minsikzzang
+- http://twitter.com/minsikzzang
+- minsikzzang@gmail.com
+
+## License
+
+Sanjose is available under the MIT license. See the LICENSE file for more info.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+Bundler.setup
+
+gemspec = eval(File.read("sanjose.gemspec"))
+
+task :build => "#{gemspec.full_name}.gem"
+
+file "#{gemspec.full_name}.gem" => gemspec.files + ["sanjose.gemspec"] do
+  system "gem build houston.gemspec"
+  system "gem install sanjose-#{Houston::VERSION}.gem"
+end

data/bin/gcm

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+require 'commander/import'
+
+require 'sanjose'
+
+HighLine.track_eof = false # Fix for built-in Ruby
+Signal.trap("INT") {} # Suppress backtrace when exiting command
+
+program :version, Sanjose::VERSION
+program :description, 'A command-line interface for sending push notifications for Android'
+
+program :help, 'Author', 'Min Kim <minsikzzang@gmail.com>'
+program :help, 'Website', 'https://github.com/minsikzzang'
+program :help_formatter, :compact
+
+default_command :help
+
+command :push do |c|
+  c.syntax = 'gcm push DEVICE [...]'
+  c.summary = 'Sends an Google Cloud Message to specified devices'
+  c.description = ''
+
+  c.example 'description', 'gcm push <registration_id> -d "{\"foo\":\"bar\"}"" -k "AIzaSyApdin5fMuTSGtW-OTC9gJrm2qz1hJPUzk" -c "Hello, World!"'
+  c.option '-k', '--key KEY', 'Google Cloud Message api key'
+  c.option '-c', '--collapse_key CK', 'An arbitrary string (such as "Updates Available") that is used to collapse a group of like messages when the device is offline'
+  c.option '-r', '--dry_run DRY_RUN', 'It allows developers to test their request without actually sending a message'
+  c.option '-t', '--time_to_live TTL', 'How long (in seconds) the message should be kept on GCM storage if the device is offline.'
+  c.option '-p', '--restricted_package_name RPN', 'A string containing the package name of your application.'
+  c.option '-d', '--data DATA', 'A JSON object whose fields represents the key-value pairs of the message\'s payload data'
+  
+  c.action do |args, options|
+    say_error "One or more device registration_id required" and abort if args.empty?
+
+    @key = options.key    
+    say_error "Google Cloud api key is required" and abort unless @key
+  
+    @data = options.data
+    @time_to_live = options.time_to_live
+    @collapse_key = options.collapse_key
+    @restricted_package_name = options.restricted_package_name
+    @dry_run = options.dry_run
+    
+    client = Sanjose::Client.new
+    client.gcm_api_key = @key
+    a = "APA91bH35MqYza3xfc2hfag6Rr8VQPSOmi2nrUOPABlFwowfVMZNHaBGBpx-zQ7nuv9qzCEosepUMPKyOrVn0UncZMa__E2sWuM2Q53fjJ5loqIY1QKCza3MkxAu1rvyhhzJP3meEqpmv-kjBuRTeWe_ysRUICupE-awrK1eiStmmm2Y_VBBSs4"
+    b = "APA91bHAX-Owu0Ulm5XubHs7BYy6a4O87Gk8-2JOW3eJ2TauVzWsB0d4yCxjzxMXl40elIIwG3E0Lpvd1_5xGldZm64UO4fqC0RNpvGWKUSr7hMNhavRS8w2NS2XUwYsluysVaXZU0rvmq0zSCH6JHGZiqd0qlUsmg"
+    
+    notification = Sanjose::Notification.new
+    args.each do |device|
+      notification.add_device(device)
+    end
+    
+    notification.data = JSON.parse(@data)
+    notification.collapse_key = @collapse_key
+    notification.dry_run = @dry_run
+    notification.restricted_package_name = @restricted_package_name
+    notification.time_to_live = @time_to_live
+    
+    begin
+      results = client.push(notification)
+      puts results.inspect
+    rescue => e
+      say_error "Exception sending notification: #{e}" and abort
+    end
+    
+    say_ok "Push notifications successfully sent"
+  end
+end

data/lib/sanjose/client.rb

@@ -0,0 +1,154 @@
+module Sanjose
+  GCM_GATEWAY_URI = "https://android.googleapis.com/gcm/send"
+  MULTICAST_SIZE = 1000
+  TOKEN_CANONICAL_REG_ID = 'registration_id'
+  JSON_SUCCESS = 'success'
+  JSON_FAILURE ='failure'
+  JSON_CANONICAL_IDS = 'canonical_ids'
+  JSON_MULTICAST_ID = 'multicast_id'
+  JSON_RESULTS = 'results'
+  JSON_MESSAGE_ID = 'message_id'
+  JSON_ERROR = 'error'
+  ERROR_UNAVAILABLE = "Unavailable";
+  
+  # Initial delay before first retry
+  BACKOFF_INITIAL_DELAY = 1000
+  
+  # Maximum delay before a retry.
+  MAX_BACKOFF_DELAY = 1024000
+  
+  class Client
+    attr_accessor :gcm_gateway_uri, :gcm_api_key
+    
+    def initialize
+      @gcm_gateway_uri = GCM_GATEWAY_URI
+      @gcm_api_key = ENV['GCM_API_KEY']
+    end
+    
+    def push(notification, retries = 5)
+      return if not notification or notification.sent?
+      
+      attempt = 0
+      try_again = true
+      muticast_ids = []
+      results = {}
+      unsent_reg_ids = notification.devices
+      backoff = BACKOFF_INITIAL_DELAY
+      
+      while try_again do
+        attempt += 1
+        multicast_result = push_no_retry(notification, 
+          connection_options_for_endpoint(:gateway), unsent_reg_ids)
+        
+        if multicast_result
+          muticast_ids << multicast_result.multicast_id
+          unsent_reg_ids = update_status(unsent_reg_ids, results, multicast_result)
+        end
+        
+        try_again = !unsent_reg_ids.empty? and attempt <= retries
+        
+        if try_again
+          sleep_time = backoff / 2 + rand(backoff)
+          sleep(sleep_time / 1000)
+          if 2 * backoff < MAX_BACKOFF_DELAY
+            backoff *= 2
+          end
+        end       
+      end    
+      
+      # calculate summary
+      success = 0
+      failure = 0
+      canonical_ids = 0
+      
+      results.values.each do |result|
+        if result.message_id
+          success += 1
+          if result.canonical_reg_id
+            canonical_ids += 1
+          end
+        else
+          failure += 1
+        end
+      end
+        
+      # build a new object with the overall result
+      multicast_id = muticast_ids.pop(0)
+      builder = MulticastResult.new(
+        :success => success, 
+        :failure => failure, 
+        :canonical_ids => canonical_ids,
+        :multicast_id => multicast_id)
+      builder.retry_multicast_ids = muticast_ids
+      
+      # add results, in the same order as the input
+      notification.devices.each do |device|
+        builder.add_result(results[device])
+      end
+      
+      builder
+    end
+      
+    private
+      def update_status(unsent_reg_ids, all_results, multicast_result)
+        results = multicast_result.results
+        if results.length != unsent_reg_ids.length
+          # should never heppan, unless there is a flaw in the algorithm
+          raise RuntimeError 
+            "internal error: sizes do not match. current_results: #{results}; unsent_reg_ids: #{unsent_reg_ids}"
+        end
+        
+        new_unsent_reg_ids = []
+        i = 0
+        unsent_reg_ids.each do |reg_id|
+          result = results.at(i)
+          all_results[reg_id] = result
+          i += 1
+          if result.error and result.error == ERROR_UNAVAILABLE
+            new_unsent_reg_ids << reg_id
+          end
+        end
+        
+        new_unsent_reg_ids        
+      end
+      
+      def push_no_retry(notification, uri, reg_ids)        
+        multicast_result = nil
+        messages = notification.clone
+        messages.devices = reg_ids
+        
+        Connection.open(uri) do |connection|
+          message = messages.message
+
+          # Need to put gcm api keyand content length in header 
+          headers = {"Authorization" => "key=#{@gcm_api_key}",
+                     "Content-type" => "application/json"}
+          response = connection.post(uri.path, message, headers)          
+          return nil if response.code != "200"            
+          
+          json = JSON.parse(response.body)          
+          multicast_result = MulticastResult.new(
+            :success => json[JSON_SUCCESS], 
+            :failure => json[JSON_FAILURE], 
+            :canonical_ids => json[JSON_CANONICAL_IDS],
+            :multicast_id => json[JSON_MULTICAST_ID])
+          results = json[JSON_RESULTS]
+          results.each do |result|
+            multicast_result.add_result(
+              Result.new(:message_id => result[JSON_MESSAGE_ID],
+                :canonical_reg_id => result[TOKEN_CANONICAL_REG_ID],
+                :error => result[JSON_ERROR]))
+          end
+        end
+        multicast_result
+      end
+      
+      def connection_options_for_endpoint(endpoint = :gateway)
+        uri = case endpoint
+                when :gateway then URI(@gcm_gateway_uri)
+                else
+                  raise ArgumentError
+              end        
+      end
+  end
+end

data/lib/sanjose/connection.rb

@@ -0,0 +1,26 @@
+require 'net/http'
+
+module Sanjose
+  class Connection
+    class << self
+      def open(uri)
+        return if uri == nil            
+                
+        connection = connection_for_uri(uri)
+        connection.start
+        
+        yield connection
+        
+        connection.finish
+      end
+    end
+    
+    private
+    
+      def self.connection_for_uri(uri)
+        connection = Net::HTTP.new(uri.host, uri.port)
+        connection.use_ssl = uri.scheme == 'https'
+        connection
+      end
+  end
+end

data/lib/sanjose/notification.rb

@@ -0,0 +1,104 @@
+require 'json'
+
+module Sanjose
+  class Notification
+    attr_accessor :data, :collapse_key, :delay_when_idle, :time_to_live,
+                  :dry_run, :restricted_package_name, :devices
+    attr_reader :sent_at
+    
+    def initialize(options = {})
+      # Required field
+      # A string array with the list of devices (registration IDs) receiving 
+      # the message. It must contain at least 1 and at most 1000 registration IDs.
+      if !options[:devices]
+        @devices = []
+      else
+        @devices = options[:devices]
+      end
+      
+      # Optional fields
+      # An arbitraru string (such as "Updates Available") that is used to 
+      # collapse a group of like messages when the device is offline, so 
+      # that only the last message gets sent to the client.
+      @collapse_key = options[:collapse_key] 
+      
+      # If included, indicates that the message should not be sent immediately 
+      # if the device is idle. 
+      @delay_when_idle = options[:delay_when_idle]
+      
+      # How long (in seconds) the message should be kept on GCM storage if the 
+      # device is offline. 
+      @time_to_live = options[:time_to_live]
+      
+      # If included, allows developers to test their request without actually 
+      # sending a message. Optional. The default value is false, and must be a 
+      # JSON boolean.      
+      @dry_run = options[:dry_run]
+      
+      # A string containing the package name of your application. When set, 
+      # messages will only be sent to registration IDs that match the package 
+      # name. 
+      @restricted_package_name = options[:restricted_package_name]
+      
+      # A JSON object whose fields represents the key-value pairs of the message's 
+      # payload data. There is no limit on the number of key/value pairs, though 
+      # there is a limit on the total size of the message (4kb).
+      @data = options[:data]
+    end
+    
+    def add_device(device)
+      @devices << device
+    end
+    
+    def device_size
+      @devices.length
+    end
+    
+    def message
+      # plan-text format
+      # 'registration_id=APA91bH35MqYza3xfc2hfag6Rr8VQPSOmi2nrUOPABlFwowfVMZNHaBGBpx-zQ7nuv9qzCEosepUMPKyOrVn0UncZMa__E2sWuM2Q53fjJ5loqIY1QKCza3MkxAu1rvyhhzJP3meEqpmv-kjBuRTeWe_ysRUICupE-awrK1eiStmmm2Y_VBBSs4'
+      # json format
+      # '{"registration_ids":["APA91bH35MqYza3xfc2hfag6Rr8VQPSOmi2nrUOPABlFwowfVMZNHaBGBpx-zQ7nuv9qzCEosepUMPKyOrVn0UncZMa__E2sWuM2Q53fjJ5loqIY1QKCza3MkxAu1rvyhhzJP3meEqpmv-kjBuRTeWe_ysRUICupE-awrK1eiStmmm2Y_VBBSs4","APA91bHAX-Owu0Ulm5XubHs7BYy6a4O87Gk8-2JOW3eJ2TauVzWsB0d4yCxjzxMXl40elIIwG3E0Lpvd1_5xGldZm64UO4fqC0RNpvGWKUSr7hMNhavRS8w2NS2XUwYsluysVaXZU0rvmq0zSCH6JHGZiqd0qlUsmg"]}'
+      
+      json = {}
+      if @devices.empty?
+        raise ArgumentError 'devices cannot be empty'
+      else
+        json['registration_ids'] = @devices
+      end
+      
+      if @collapse_key
+        json['collapse_key'] = @collapse_key
+      end
+      if @delay_when_idle
+        json['delay_when_idle'] = @delay_when_idle
+      end
+      
+      if @time_to_live
+        json['time_to_live'] = @time_to_live
+      end
+      
+      if @data
+        json['data'] = @data
+      end
+      
+      if @restricted_package_name
+        json['restricted_package_name'] = @restricted_package_name
+      end
+      
+      if @dry_run
+        json['dry_run'] = @dry_run
+      end
+      
+      json.to_json
+    end
+    
+    def mark_as_sent!
+      @sent_at = Time.now
+    end
+
+    def sent?
+      !!@sent_at
+    end
+  end
+end

data/lib/sanjose/version.rb

@@ -0,0 +1,3 @@
+module Sanjose
+  VERSION = "0.0.1"
+end

data/lib/sanjose.rb

@@ -0,0 +1,8 @@
+require "sanjose/version"
+require 'sanjose/client'
+require 'sanjose/connection'
+require 'sanjose/notification'
+require 'sanjose/multicast_result'
+require 'sanjose/result'
+
+

data/sanjose.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sanjose'
+
+Gem::Specification.new do |s|
+  s.name          = "sanjose"
+  s.version       = Sanjose::VERSION
+  s.authors       = ["Min Kim"]
+  s.email         = ["minsikzzang@gmail.com", "minsik.kim@livestation.com"]
+  s.description   = "Send Google Cloud Message"
+  s.summary       = "Sanjose is a simple gem for sending Google Cloud Message"
+  s.homepage      = "http://github.com/minsikzzang/sanjose"
+
+  s.add_dependency "commander", "~> 4.1.2"
+  s.add_dependency "json", "~> 1.7.3"
+  
+  s.add_development_dependency "rspec", "~> 0.6.1"
+  s.add_development_dependency "rake",  "~> 0.9.2"
+  
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: sanjose
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Min Kim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: Send Google Cloud Message
+email:
+- minsikzzang@gmail.com
+- minsik.kim@livestation.com
+executables:
+- gcm
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/gcm
+- lib/sanjose.rb
+- lib/sanjose/client.rb
+- lib/sanjose/connection.rb
+- lib/sanjose/notification.rb
+- lib/sanjose/version.rb
+- sanjose.gemspec
+homepage: http://github.com/minsikzzang/sanjose
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Sanjose is a simple gem for sending Google Cloud Message
+test_files: []