simple_gcm 0.0.0

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.10.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.1.4"
+  gem "jeweler", "~> 1.8.4"
+end
+
+gem "faraday"

data/Gemfile.lock

@@ -0,0 +1,35 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    faraday (0.8.1)
+      multipart-post (~> 1.1)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    multipart-post (1.1.5)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.1.4)
+  faraday
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  rspec (~> 2.10.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Leonardo Bessa
+
+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,54 @@
+# gcm (Google Cloud Messaging)
+
+simple_gcm sends push notifications to Android devices via google [gcm](http://developer.android.com/guide/google/gcm/index.html).
+
+##Installation
+
+```console
+$ gem install simple_gcm
+```
+
+##Requirements
+
+An Android device running 2.2 or newer, its registration token, and a google API Key registered for gcm.
+
+##Usage
+
+Sending one notification at a time:
+
+```ruby
+require 'simple_gcm'
+sender  = SimpleGCM::Sender.new(api_key: "your_api_key")
+message = SimpleGCM::Message.new(:data => {alert => "your message"})
+begin
+  result  = sender.send(:registration_id => "your_phone_registration_id", :message => message)
+  puts result.message_id
+  puts result.registration_id
+rescue SimpleGCM::Error::MissingRegistration => e; puts e
+rescue SimpleGCM::Error::InvalidRegistration => e; puts e
+rescue SimpleGCM::Error::MismatchSenderId => e; puts e
+rescue SimpleGCM::Error::NotRegistered => e; puts e
+rescue SimpleGCM::Error::MessageTooBig => e; puts e
+rescue SimpleGCM::Error::AuthenticationError => e; puts e
+rescue SimpleGCM::Error::ServerUnavailable => e; puts e
+rescue SimpleGCM::Error::Unkown => e; puts e
+rescue Exception => e
+end
+```
+
+
+## Contributing to gcm
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Leonardo Bessa. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+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 = "simple_gcm"
+  gem.homepage = "http://github.com/leobessa/simple_gcm"
+  gem.license = "MIT"
+  gem.summary = %Q{Sends push notifications to Android devices.}
+  gem.description = %Q{simple_gcm sends push notifications to Android devices via google GCM}
+  gem.email = "leobessa@gmail.com"
+  gem.authors = ["Leonardo Bessa"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "simple_gcm #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/simple_gcm/error.rb

@@ -0,0 +1,40 @@
+module SimpleGCM::Error
+  class BaseError < StandardError
+    attr_reader :response
+
+    def initialize(ex, response = nil)
+      @wrapped_exception = nil
+      @response = response
+
+      if ex.respond_to?(:backtrace)
+        super(ex.message)
+        @wrapped_exception = ex
+      elsif ex.respond_to?(:each_key)
+        super("GCM server responded with error #{ex[:error]} and status #{ex[:status]}")
+        @response = ex
+      else
+        super(ex.to_s)
+      end
+    end
+
+    def backtrace
+      if @wrapped_exception
+        @wrapped_exception.backtrace
+      else
+        super
+      end
+    end
+
+    def inspect
+      %(#<#{self.class}>)
+    end
+  end
+  class MissingRegistration < BaseError; end
+  class InvalidRegistration < BaseError; end
+  class MismatchSenderId < BaseError; end
+  class NotRegistered < BaseError; end
+  class MessageTooBig < BaseError; end
+  class AuthenticationError < BaseError; end
+  class ServerUnavailable < BaseError; end
+  class Unkown < BaseError; end
+end

data/lib/simple_gcm/message.rb

@@ -0,0 +1,26 @@
+class SimpleGCM::Message
+  ATTRIBUTES = [:data, :collapse_key, :delay_while_idle, :time_to_live].freeze
+  ATTRIBUTES.each do |attr|
+    attr_accessor attr
+  end
+
+  def initialize(args = {})
+    @data = {}
+    ATTRIBUTES.each do |attr|
+      if (args.key?(attr))
+        instance_variable_set("@#{attr}", args[attr])
+      end
+    end
+  end
+
+  def inspect
+    ATTRIBUTES.inject({ }) do |h, attr|
+      h[attr] = instance_variable_get("@#{attr}")
+      h
+    end
+  end
+
+  def to_json
+    self.inspect.to_json
+  end
+end

data/lib/simple_gcm/result.rb

@@ -0,0 +1,17 @@
+##
+# Result of a GCM message request that returned HTTP status code 200.
+#
+# There are cases when a request is accept and the message successfully
+# created, but GCM has a canonical registration id for that device. In this
+# case, the server should update the registration id to avoid rejected requests
+# in the future.
+
+class SimpleGCM::Result
+  attr_accessor :message_id, :registration_id
+  def inspect
+    { message_id: message_id, registration_id: registration_id }
+  end
+  def to_s
+    "#<#{self.class} #{inspect.to_s}>"
+  end
+end

data/lib/simple_gcm/result_middleware.rb

@@ -0,0 +1,39 @@
+module SimpleGCM
+  class ResultMiddleware < ::Faraday::Response::Middleware
+    def on_complete(env)
+      case env[:status]
+      when 200
+        values = response_values(env)
+        if values[:error]
+          if Error.constants.include?(values[:error].to_sym)
+            raise Error.const_get(values[:error]), values
+          else
+            raise Error::Unkown, values
+          end
+        else
+          result = Result.new
+          result.message_id = values[:id] if values[:id]
+          result.registration_id = values[:registration_id] if values[:registration_id]
+          env[:gcm_result] = result
+        end
+      when 401
+        raise Error::AuthenticationError, response_values(env)
+      when 500,503
+        raise Error::ServerUnavailable, response_values(env)
+      when 400...600
+        raise Error::Unkown, response_values(env)
+      end
+    end
+
+    def response_values(env)
+      body = env[:body]
+      base = {:status => env[:status], :headers => env[:response_headers], :body => body}
+      response_body = Array(body.lines.map{ |l| Hash[l.scan(/(.*)=(.*)/)] }.inject(&:merge)).inject({}) do |m,(k,v)|
+        m[k.downcase.to_sym] = v
+        m
+      end
+      response_body.merge(base)
+    end
+
+  end
+end

data/lib/simple_gcm/sender.rb

@@ -0,0 +1,37 @@
+class SimpleGCM::Sender
+  BASE_ENDPOINT_URL = 'https://android.googleapis.com'
+  SEND_PATH = '/gcm/send'
+
+  attr_accessor :api_key, :connection
+
+  def initialize(options)
+    @api_key = options.delete(:api_key)
+  end
+
+  def send(options)
+    registration_id = options.delete(:registration_id)
+    message         = options.delete(:message)
+    http_parameters = { :registration_id => registration_id }
+    message.data.each_pair do |k,v|
+      http_parameters["data.#{k}"] = v.to_s
+    end
+    http_parameters[:collapse_key] = message.collapse_key if message.collapse_key
+    http_parameters[:delay_while_idle] = "1" if message.delay_while_idle
+    http_parameters[:time_to_live] = message.time_to_live if message.time_to_live
+    response = connection.post SEND_PATH do |req|
+      req.headers['Content-Type']  = 'text/plain'
+      req.headers['Authorization'] = "key=#{api_key}"
+      req.params = http_parameters
+    end
+    response.env[:gcm_result]
+  end
+
+  def connection
+    @connection ||= ::Faraday.new(:url => BASE_ENDPOINT_URL) do |faraday|
+      faraday.request  :url_encoded             # form-encode POST params
+      faraday.adapter  ::Faraday.default_adapter  # make requests with Net::HTTP
+      faraday.use SimpleGCM::ResultMiddleware
+    end
+  end
+
+end

data/lib/simple_gcm.rb

@@ -0,0 +1,10 @@
+require 'faraday'
+
+module SimpleGCM
+end
+
+require_relative 'simple_gcm/message'
+require_relative 'simple_gcm/sender'
+require_relative 'simple_gcm/result_middleware'
+require_relative 'simple_gcm/result'
+require_relative 'simple_gcm/error'

data/simple_gcm.gemspec

@@ -0,0 +1,68 @@
+# 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 = "simple_gcm"
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Leonardo Bessa"]
+  s.date = "2012-07-03"
+  s.description = "simple_gcm sends push notifications to Android devices via google GCM"
+  s.email = "leobessa@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/simple_gcm.rb",
+    "lib/simple_gcm/error.rb",
+    "lib/simple_gcm/message.rb",
+    "lib/simple_gcm/result.rb",
+    "lib/simple_gcm/result_middleware.rb",
+    "lib/simple_gcm/sender.rb",
+    "simple_gcm.gemspec",
+    "spec/gcm_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/leobessa/simple_gcm"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Sends push notifications to Android devices."
+
+  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<faraday>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.10.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.4"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+    else
+      s.add_dependency(%q<faraday>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.10.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.4"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    end
+  else
+    s.add_dependency(%q<faraday>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.10.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.4"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+  end
+end
+

data/spec/gcm_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "SimpleGCM::Sender" do
+  subject { SimpleGCM::Sender.new(api_key: "fake_api_key") }
+  context "#send" do
+    context "The message is processed successfully" do
+      it "returns a SimpleGCM::Response with message_id" do
+        message_id = "1:08"
+        subject.connection.builder.adapter :test do |stub|
+          stub.post('/gcm/send') { [200, {}, "id=#{message_id}"] }
+        end
+        reponse = subject.send(:registration_id => "fake_registration_id", :message => SimpleGCM::Message.new)
+        reponse.message_id.should == message_id
+      end
+      it "returns a SimpleGCM::Response with message_id and registration_id" do
+        message_id = "1:2342"
+        registration_id = "32"
+        subject.connection.builder.adapter :test do |stub|
+          stub.post('/gcm/send') { [200, {}, "id=#{message_id}\nregistration_id=#{registration_id}"] }
+        end
+        reponse = subject.send(:registration_id => "fake_registration_id", :message => SimpleGCM::Message.new)
+        reponse.message_id.should == message_id
+        reponse.registration_id.should == registration_id
+      end
+    end
+    context "The message is not processed due errors" do
+      %w(MissingRegistration InvalidRegistration MismatchSenderId NotRegistered MessageTooBig).each do |error|
+        it "raises a SimpleGCM::Error::#{error}" do
+          subject.connection.builder.adapter(:test){ |stub| stub.post('/gcm/send') { [200, {}, "Error=#{error}"] } }
+          expect {  subject.send(:registration_id => "fake_registration_id", :message => SimpleGCM::Message.new) }.to raise_error(SimpleGCM::Error.const_get(error))
+        end
+      end
+      it "raises a SimpleGCM::Error::AuthenticationError if return status is 401" do
+        subject.connection.builder.adapter(:test){ |stub| stub.post('/gcm/send') { [401, {}, ""] } }
+        expect {  subject.send(:registration_id => "fake_registration_id", :message => SimpleGCM::Message.new) }.to raise_error(SimpleGCM::Error::AuthenticationError)
+      end
+      it "raises a SimpleGCM::Error::ServerUnavailable if return status is 500" do
+        subject.connection.builder.adapter(:test){ |stub| stub.post('/gcm/send') { [500, {}, ""] } }
+        expect {  subject.send(:registration_id => "fake_registration_id", :message => SimpleGCM::Message.new) }.to raise_error(SimpleGCM::Error::ServerUnavailable)
+      end
+      it "raises a SimpleGCM::Error::ServerUnavailable if return status is 503" do
+        subject.connection.builder.adapter(:test){ |stub| stub.post('/gcm/send') { [503, {}, ""] } }
+        expect {  subject.send(:registration_id => "fake_registration_id", :message => SimpleGCM::Message.new) }.to raise_error(SimpleGCM::Error::ServerUnavailable)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'simple_gcm'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: simple_gcm
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Leonardo Bessa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: simple_gcm sends push notifications to Android devices via google GCM
+email: leobessa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/simple_gcm.rb
+- lib/simple_gcm/error.rb
+- lib/simple_gcm/message.rb
+- lib/simple_gcm/result.rb
+- lib/simple_gcm/result_middleware.rb
+- lib/simple_gcm/sender.rb
+- simple_gcm.gemspec
+- spec/gcm_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/leobessa/simple_gcm
+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: -4556715408940629349
+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: Sends push notifications to Android devices.
+test_files: []