pushlayer 0.9.0

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle/
+log/*.log
+pkg/
+rdoc/
+.DS_Store
+.yardoc/
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--format progress
+--color

data/.yardopts

@@ -0,0 +1,6 @@
+--no-private
+
+lib/**/*.rb
+-
+README.md
+MIT-LICENSE

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    pushlayer (0.9.0)
+      multi_json (~> 1.5.0)
+      rest-client (~> 1.6.7)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.2)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    mime-types (1.19)
+    multi_json (1.5.0)
+    redcarpet (2.2.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    webmock (1.9.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pushlayer!
+  redcarpet (~> 2.2.2)
+  rspec (~> 2.0)
+  webmock (~> 1.9.0)
+  yard (~> 0.8.3)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Draconis Software, LLC
+
+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,73 @@
+# Pushlayer
+
+Send iOS push notifications using the [PushLayer.com](https://www.pushlayer.com) service.
+
+## Installation
+
+Add `pushlayer` to your Gemfile:
+
+```ruby
+gem pushlayer
+```
+
+Be sure to run `bundle install` afterwards.
+
+Alernatively, you can install it locally:
+
+```shell
+gem install pushlayer
+```
+
+## Requirements
+
+PushLayer depends on ruby 1.9+, `rest-client`, and `multi_json`.
+
+## Getting Started
+
+First, you need an account with [PushLayer.com](https://www.pushlayer.com), and an application. An application defines the certificate to use with Apple, and gives you a corresponding api_key to reference when sending push notifications. Lastly, each application has a unique ID, and can be found by clicking on your application name. The URL will look something like `https://www.pushlayer.com/applications/123`, where 123 is the application ID.
+
+Second, you need to tell the Pushlayer library about your ID and api_key:
+
+```ruby
+Pushlayer.api_id = 123
+Pushlayer.api_key = 'my api key'
+```
+
+Third, you need to know the device token you wish to send a notification to. A device token is generated by iOS in response to the user agreeing to receive push notifications from your app. Check out [the documentation on how to request this permission](https://www.pushlayer.com/pages/docs#Askingforpermission).
+
+## Sending a notification
+
+To send a notification, simply:
+
+```ruby
+Pushlayer.post_notification 'device_token', 'Hello iOS!'
+```
+
+This will tell PushLayer to construct a payload consisting of the alert message 'Hello iOS!' and send it to the specified device token. If everything goes well, your iOS app should receive the notification.
+
+The result will be a Ruby hash of the PushLayer notification object, similar to:
+
+```ruby
+{
+  "action_loc_key":null,
+  "alert_body":"Hello from PushLayer!",
+  "application_id":1,
+  "badge":null,
+  "created_at":
+  "2013-01-08T03:50:06Z",
+  "custom_payload":null,
+  "device_token":"123abc",
+  "id":3,
+  "launch_image":null,
+  "loc_args":null,
+  "loc_key":null,
+  "sound":null,
+  "state":"pending",
+  "status_code":null,
+  "updated_at":"2013-01-08T03:50:06Z"
+}
+```
+
+## Help
+
+If you find a bug, open an Issue. Pull Requests are welcome. If you get stuck and need help, feel free to contact us at [info@pushlayer.com](mailto:info@pushlayer.com).

data/Rakefile

@@ -0,0 +1,43 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Pushlayer'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+namespace :spec do
+  desc 'Run unit specs'
+  RSpec::Core::RakeTask.new('unit') do |t|
+    t.pattern = 'spec/unit/**/*_spec.rb'
+  end
+
+  desc 'Run functional specs'
+  RSpec::Core::RakeTask.new('functional') do |t|
+    t.pattern = 'spec/functional/**/*_spec.rb'
+  end
+end
+
+desc 'Run unit and functional specs'
+task spec: ['spec:unit', 'spec:functional']
+
+task default: :spec

data/lib/pushlayer/version.rb

@@ -0,0 +1,3 @@
+module Pushlayer
+  VERSION = '0.9.0'
+end

data/lib/pushlayer.rb

@@ -0,0 +1,61 @@
+require 'rest_client'
+require 'multi_json'
+
+require 'pushlayer/version'
+
+module Pushlayer
+  # @private
+  @@api_base = 'https://www.pushlayer.com'
+
+  @@api_id = ''
+  @@api_key = ''
+
+  def self.api_id=(id)
+    @@api_id = id
+  end
+
+  def self.api_key=(key)
+    @@api_key = key
+  end
+
+  # Send a push notification
+  #
+  # @example
+  #   Pushlayer.post_notification 'abc123', 'Hello from PushLayer!'
+  #
+  # @param [String] device_token The device_token from the iOS device, returned by the system in
+  #   response to the user giving your app permission to send push notifications.
+  # @param [String] alert_body A string to send in the APNS alert_body payload param. Typically
+  #   this is a message you want to display to the user in an alert.
+  # @param [Hash] opts A hash of all remaining valid APNS payload parameters to include, such as
+  #   badge, sound, etc.
+  #
+  # @option opts [String] :badge
+  # @option opts [String] :sound
+  # @option opts [String] :action_loc_key
+  # @option opts [String] :loc_key
+  # @option opts [String] :loc_args
+  # @option opts [String] :launch_image
+  # @option opts [String] :custom_payload
+  #
+  # Upon success, a Ruby hash object will be returned representing the notification object sent.
+  #
+  # Under the hood, Pushlayer is using rest_client to communicate with the service. Be sure to
+  # familiarize yourself with rest_client's behavior in terms of exceptions:
+  def self.post_notification(device_token, alert_body, opts={})
+    params = { device_token: device_token, alert_body: alert_body }.merge opts
+    headers = { accept: :json, content_type: :json, user_agent: user_agent }
+
+    RestClient.post endpoint, MultiJson.dump(params), headers
+  end
+
+  private
+
+  def self.endpoint
+    "#{@@api_base}/applications/#{@@api_id}/notifications.json?api_key=#{@@api_key}"
+  end
+
+  def self.user_agent
+    "PushLayer/v1 RubyBindings/#{Pushlayer::VERSION}"
+  end
+end

data/pushlayer.gemspec

@@ -0,0 +1,31 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'pushlayer/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'pushlayer'
+  s.version     = Pushlayer::VERSION
+  s.authors     = ['Ryan Twomey, Costa Walcott']
+  s.email       = ['info@pushlayer.com']
+  s.homepage    = 'https://www.pushlayer.com'
+  s.summary     = 'pushlayer sends iOS push notifications using PushLayer.com'
+
+  s.description = <<-eodescription
+PushLayer is a service for sending, managing, and debugging iOS push notifications. This gem
+adds a wrapper around the service, making it simple to send iOS push notifications from within
+your Ruby applications.
+eodescription
+
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {spec}/*`.split("\n")
+
+  s.required_ruby_version = Gem::Requirement.new('>= 1.9.2')
+  s.require_paths = ['lib']
+
+  s.add_dependency 'multi_json', '~> 1.5.0'
+  s.add_dependency 'rest-client', '~> 1.6.7'
+
+  s.add_development_dependency 'redcarpet', '~> 2.2.2'
+  s.add_development_dependency 'rspec', '~> 2.0'
+  s.add_development_dependency 'webmock', '~> 1.9.0'
+  s.add_development_dependency 'yard', '~> 0.8.3'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__))
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rspec'
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!
+
+require 'pushlayer'

data/spec/unit/pushlayer_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Pushlayer do
+  describe '.post_notification' do
+    before do
+      api_id = 123
+      api_key = '123abc'
+
+      Pushlayer.api_id = api_id
+      Pushlayer.api_key = api_key
+
+      @expected_url = post_notification_url(api_id, api_key)
+      stub_request :any, @expected_url
+
+      @device_token = '1a2b3c'
+      @alert_body = 'test message'
+
+      Pushlayer.post_notification @device_token, @alert_body
+    end
+
+    it 'POSTs to the correct URL' do
+      body = { device_token: @device_token, alert_body: @alert_body }
+      headers = { content_type: 'application/json', user_agent: user_agent }
+
+      WebMock.should have_requested(:post, @expected_url).with(body: body, headers: headers).once
+    end
+  end
+
+  def post_notification_url(id, key)
+    "https://www.pushlayer.com/applications/#{id}/notifications.json?api_key=#{key}"
+  end
+
+  def user_agent
+    "PushLayer/v1 RubyBindings/#{Pushlayer::VERSION}"
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: pushlayer
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Twomey, Costa Walcott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+description: ! 'PushLayer is a service for sending, managing, and debugging iOS push
+  notifications. This gem
+
+  adds a wrapper around the service, making it simple to send iOS push notifications
+  from within
+
+  your Ruby applications.
+
+'
+email:
+- info@pushlayer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .yardopts
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/pushlayer.rb
+- lib/pushlayer/version.rb
+- pushlayer.gemspec
+- spec/spec_helper.rb
+- spec/unit/pushlayer_spec.rb
+homepage: https://www.pushlayer.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+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: pushlayer sends iOS push notifications using PushLayer.com
+test_files: []
+has_rdoc: