android-services 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,14 @@
+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 "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.1.5"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.4)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    shoulda (3.1.1)
+      shoulda-context (~> 1.0)
+      shoulda-matchers (~> 1.2)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.2.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.1.5)
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 krishna rokhale
+
+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,48 @@
+## android-services 
+
+Android services gem is a ruby wrapper over the google services for android.
+  
+### QuickStart
+You can install the gem using
+gem install android-services
+You will need a google API key for communicating with the google services, which you can get from here
+http://developer.android.com/guide/google/gcm/gs.html
+	
+After getting the API key, you can initialize it in the rails app using an initializer file.
+
+    AndroidServices.configure do |config|
+	     config.api_key = '<API KEY>'
+   	  	 config.secure = true
+    end	
+	
+### Sending a simple message
+
+Sending a message to an Android device is easy! The simplest message you can send is:
+
+    CloudMessage.new(:registration_ids => [])
+	
+Other Options you might want to use:
+	
++ collapse_key: An arbitrary 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. This is intended to avoid sending too many messages to the phone when it comes back online. 
+
++ data: A JSON object whose fields represents the key-value pairs of the message's payload data. If present, the payload data it will be included in the Intent as application data, with the key being the extra's name. 
+
++ delay_while_idle: If included, indicates that the message should not be sent immediately if the device is idle. The server will wait for the device to become active, and then only the last message for each collapse_key value will be sent.
+
++ time_to_live: How long (in seconds) the message should be kept on GCM storage if the device is offline.
+
+### Contributing to android-services
+ 
+* 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 krishna rokhale. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# 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 = "android-services"
+  gem.homepage = "http://github.com/krokhale/android-services"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby wrapper for the google android services.}
+  gem.description = %Q{The gem aims to provide an API for google services including google play which interact with Android devices.}
+  gem.email = "krishna.rokhale@gmail.com"
+  gem.authors = ["krishna rokhale"]
+  # dependencies defined in Gemfile
+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
+
+# require 'require/rcovtask'
+# Rcov::RcovTask.new do |test|
+  # test.libs << 'test'
+  # test.pattern = 'test/**/test_*.rb'
+  # test.verbose = true
+  # test.rcov_opts << '--exclude "gems/*"'
+# 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 = "android-services #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/android-services.gemspec

@@ -0,0 +1,67 @@
+# 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 = "android-services"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["krishna rokhale"]
+  s.date = "2012-08-20"
+  s.description = "The gem aims to provide an API for google services including google play which interact with Android devices."
+  s.email = "krishna.rokhale@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "android-services.gemspec",
+    "lib/android_services.rb",
+    "lib/android_services/cloud_message/cloud_message.rb",
+    "lib/android_services/cloud_message/request.rb",
+    "lib/android_services/cloud_message/response.rb",
+    "lib/android_services/configuration.rb",
+    "lib/android_services/exceptions.rb",
+    "test/helper.rb",
+    "test/test_android_services.rb"
+  ]
+  s.homepage = "http://github.com/krokhale/android-services"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Ruby wrapper for the google android services."
+
+  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_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.5"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.5"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.5"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/android_services/cloud_message/cloud_message.rb

@@ -0,0 +1,59 @@
+module AndroidServices
+  module GoogleCloudMessaging
+    class CloudMessage
+      attr_accessor :options
+
+
+      def initialize(options)
+        validating options
+        [ :registration_ids,
+          :dry_run,
+          :collapse_key,
+          :data,
+          :delay_while_idle,
+          :time_to_live].each do |option|
+            instance_variable_set("@#{option}", options[option])
+          end
+        end
+
+        def send!
+          build_request
+          post_request!
+        end
+        
+
+        private
+
+        def validating options
+          raise AndroidServices::Exceptions::RegistrationIdBlank.new("Atleast one registration id required to send message.") if options[:registration_ids].nil?
+          raise AndroidServices::Exceptions::RegistrationIdLimit.new("You cannot define more than 1000 registration ids.") if options[:registration_ids].size > 1000
+        end
+        
+        def build_request
+          instance_variable_set("@request", AndroidServices::GoogleCloudMessaging::Request.new(payload))
+          self.class.instance_eval do
+            define_method(:request) { @request }
+          end
+        end
+        
+        def payload
+          params = instance_variables_hash.select {|k,v| ["registration_ids", "dry_run", "collapse_key", "data", "delay_while_idle", "time_to_live"].include?(k) && !v.nil?}
+          params.to_json
+        end
+        
+        def post_request!
+          response_object = @request.send :post!
+          instance_variable_set("@response", response_object)
+          self.class.instance_eval do
+            define_method(:response) { @request }
+          end
+          @response
+        end  
+        
+        def instance_variables_hash
+          Hash[instance_variables.map { |name| [name.to_s.gsub("@",""), instance_variable_get(name)] } ]
+        end
+
+      end
+    end
+end

data/lib/android_services/cloud_message/request.rb

@@ -0,0 +1,35 @@
+module AndroidServices
+  module GoogleCloudMessaging
+    class Request
+      
+      def initialize payload
+        @payload ||= payload
+      end
+      
+      private
+      
+      def post!
+        handle post_to uri
+      end
+      
+      def handle response
+        AndroidServices::GoogleCloudMessaging::Response.new(response)
+      end
+      
+      def uri
+        URI(AndroidServices.configuration.messaging_endpoint)
+      end
+      
+      def post_to uri
+        Net::HTTP.start(uri.hostname, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+            req = Net::HTTP::Post.new(uri.path)
+            req.body =  @payload
+            req['Content-Type'] = AndroidServices.configuration.content_type
+            req["Authorization"] = "key=#{AndroidServices.configuration.api_key}"
+            http.request(req)
+        end
+      end
+      
+    end
+  end
+end

data/lib/android_services/cloud_message/response.rb

@@ -0,0 +1,49 @@
+module AndroidServices
+  module GoogleCloudMessaging
+    class Response
+      
+      def initialize response
+        unless response.body.nil?
+          @body ||= response.body
+          instantiate_attributes
+        end
+        @status ||= response.code
+        eval_response
+      end
+      
+      private
+      
+      def instantiate_attributes
+        JSON.parse(@body).each do |attr, value|
+          instance_variable_set("@#{attr}", value)
+        end
+        var_hash = instance_variables_hash
+        self.class.instance_eval do
+          var_hash.each do |var, value|
+            define_method(var) { value }
+          end
+        end
+      end
+      
+      def instance_variables_hash
+        Hash[instance_variables.map { |name| [name.to_s.gsub("@",""), instance_variable_get(name)] } ]
+      end
+      
+      def eval_response
+        if @status.eql? 200
+          true
+        elsif @status.eql? 400
+          "STATUS:400 Request could not be parsed as JSON."
+        elsif @status.eql? 401
+          "STATUS:401 There was an error authenticating the sender account."
+        elsif @status.eql? 500
+          "STATUS:500 There was an internal error in the GCM server while trying to process the request."
+        elsif @status.eql? 500
+          "STATUS:503 The GCM server took too long to process the request."
+          # TODO Implement exponential backoff algorithm to retry sending.  
+        end
+      end
+      
+    end
+  end
+end

data/lib/android_services/configuration.rb

@@ -0,0 +1,45 @@
+module AndroidServices
+  class Configuration
+    OPTIONS = [:api_key, :messaging_endpoint, :secure, :port, :protocol].freeze
+    attr_accessor :api_key
+    
+    attr_accessor :messaging_endpoint
+    
+    attr_accessor :secure
+    
+    attr_accessor :port
+    
+    attr_accessor :content_type
+    
+    alias_method :secure?, :secure
+    
+    def initialize
+      @secure = true
+      @messaging_endpoint = "#{protocol}://android.googleapis.com/gcm/send"
+      @content_type = 'application/json'
+    end
+    
+    def port
+      @port || default_port
+    end
+    
+    def protocol
+      if secure?
+        'https'
+      else
+        'http'
+      end
+    end
+    
+    private
+    
+    def default_port
+      if secure?
+        443
+      else
+        80
+      end
+    end
+    
+  end
+end

data/lib/android_services/exceptions.rb

@@ -0,0 +1,6 @@
+module AndroidServices
+  module Exceptions
+    class RegistrationIdBlank < StandardError; end
+    class RegistrationIdLimit < StandardError; end
+  end
+end

data/lib/android_services.rb

@@ -0,0 +1,34 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'net/http'
+require 'json'
+
+require 'android_services/cloud_message/cloud_message'
+require 'android_services/cloud_message/request'
+require 'android_services/cloud_message/response'
+
+require 'android_services/configuration'
+require 'android_services/exceptions'
+
+
+module AndroidServices
+
+  class << self
+    attr_writer :configuration
+    
+    # @example
+    # AndroidServices.configure do |config|
+    #   config.api_key = '1232fsd23asd'
+    #   config.secure = true
+    # end
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    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 'android-services'
+
+class Test::Unit::TestCase
+end

data/test/test_android_services.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestAndroidServices < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: android-services
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- krishna rokhale
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '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.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+- !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
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The gem aims to provide an API for google services including google play
+  which interact with Android devices.
+email: krishna.rokhale@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- android-services.gemspec
+- lib/android_services.rb
+- lib/android_services/cloud_message/cloud_message.rb
+- lib/android_services/cloud_message/request.rb
+- lib/android_services/cloud_message/response.rb
+- lib/android_services/configuration.rb
+- lib/android_services/exceptions.rb
+- test/helper.rb
+- test/test_android_services.rb
+homepage: http://github.com/krokhale/android-services
+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: 4052475533325376823
+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: Ruby wrapper for the google android services.
+test_files: []