pushio 0.0.2

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Push IO LLC
+
+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,48 @@
+# PushIoClient
+
+An easy to use client for integrating push notifications into Ruby-based applications. This gem uses the Push IO API to trigger notification delivery to whatever audience you specify. In order to get full use of this gem you will need to have an active account on https://manage.push.io and have recipient devices registered to receive notifications. Learn more at http://push.io
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pushio'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pushio
+
+## Usage
+
+Configure the client:
+
+```
+PushIo::Client.configure do |config|
+  config.app_guid = [your app guid from https://manage.push.io]
+  config.sender_secret = [for your app on https://manage.push.io]
+end
+```
+
+Send a broadcast push to everyone registered for your app:
+```
+push_client = PushIo::Client.new
+notification_id = push_client.broadcast :message => "Hello everyone!"
+```
+
+Send a push to an audience:
+```
+push_client.deliver_to_audience "friends", :message => "Howdy friends", :count => 8
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/push_io.rb

@@ -0,0 +1,10 @@
+module PushIo
+  require 'multi_json'
+  require 'httpclient'
+  require 'push_io/version'
+  require 'push_io/errors'
+  require 'push_io/configuration'
+  require 'push_io/client'
+
+
+end

data/lib/push_io/client.rb

@@ -0,0 +1,45 @@
+module PushIo
+  class Client
+    attr_reader :config
+    def initialize(attributes = {})
+      @config = PushIo::Client.config.dup
+      attributes.each do |name, value|
+        @config.send("#{name}=", value) if @config.respond_to?("#{name}=")
+      end
+      if (@config.app_guid.nil? || @config.app_guid == '' || @config.sender_secret.nil? || @config.sender_secret == '')
+        raise UnconfiguredClientError, "You must specify a Push IO service app_guid and sender_secret either in an initializer or when creating your PushIo::Client instance"
+      end
+    end
+
+    class << self
+      attr_accessor :configuration
+
+      def config
+        self.configuration ||= Configuration.new
+      end
+
+      def configure
+        yield(config)
+      end
+    end
+
+    def broadcast(*payload)
+      send_post(payload, {:audience => "broadcast"})
+    end
+
+    def deliver_to_audience(audience, *payload)
+      send_post(payload, {:audience => audience})
+    end
+
+    private
+    def send_url
+      "#{@config.endpoint_url}#{PushIo::NOTIFY_APP_PATH}#{@config.app_guid}/#{@config.sender_secret}"
+    end
+    def send_post(payload, args)
+      response = HTTPClient.new.post(send_url, {:body => build_post(args, payload)})
+    end
+    def build_post(args, payload)
+      args.merge({:payload => MultiJson.dump(payload)})
+    end
+  end
+end

data/lib/push_io/configuration.rb

@@ -0,0 +1,17 @@
+module PushIo
+  class Configuration
+
+    attr_accessor :app_guid
+    attr_accessor :sender_secret
+    attr_writer :endpoint_url
+
+    def endpoint_url
+      @endpoint_url || PushIo::ENDPOINT_URL
+    end
+  end
+end
+
+module PushIo
+  ENDPOINT_URL = "https://manage.push.io"
+  NOTIFY_APP_PATH = "/api/v1/notify_app/"
+end

data/lib/push_io/errors.rb

@@ -0,0 +1,4 @@
+module PushIo
+  class UnconfiguredClientError < StandardError
+  end
+end

data/lib/push_io/version.rb

@@ -0,0 +1,3 @@
+module PushIo
+  VERSION = "0.0.2"
+end

data/pushio.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/push_io/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Push IO LLC", "Sean McKibben"]
+  gem.email         = ["sean@push.io"]
+  gem.description   = %q{Ruby client library to send push notifications via the Push IO API. See: http://push.io for more information and to set up your account.}
+  gem.summary       = %q{This gem enables developers to easily create new notifications and send them via the Push IO API from Ruby apps.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "pushio"
+  gem.require_paths = ["lib"]
+  gem.version       = PushIo::VERSION
+
+  gem.add_dependency("httpclient", '>= 2.2.7')
+  gem.add_dependency("multi_json", '>= 1.3.0')
+
+  gem.add_development_dependency("rspec", '>= 2.11.0')
+end

data/spec/push_io_spec.rb

@@ -0,0 +1,39 @@
+require "rspec"
+require 'push_io'
+
+describe PushIo do
+  context "unconfigured" do
+    it "should tell you how to configure" do
+      expect{PushIo::Client.new}.to raise_error(PushIo::UnconfiguredClientError)
+
+    end
+  end
+  context "configured" do
+    before :each do
+      PushIo::Client.configure do |config|
+        config.app_guid = "1234"
+        config.sender_secret = "5678"
+      end
+    end
+    it "should allow configuration" do
+      client = PushIo::Client.new
+      client.config.app_guid.should == "1234"
+      client.config.sender_secret.should == "5678"
+    end
+    it "should allow configuration override" do
+      client = PushIo::Client.new(:app_guid => "aaaa", :sender_secret => "qqqq")
+      client.config.app_guid.should == "aaaa"
+      client.config.sender_secret.should == "qqqq"
+    end
+    it "makes a send url" do
+      client = PushIo::Client.new
+      client.send(:send_url).should == "https://manage.push.io/api/v1/notify_app/1234/5678"
+      client = PushIo::Client.new(:app_guid => "aaaa", :sender_secret => "qqqq")
+      client.send(:send_url).should == "https://manage.push.io/api/v1/notify_app/aaaa/qqqq"
+      client = PushIo::Client.new(:endpoint_url => "http://somewhere.else.entirely.org")
+      client.send(:send_url).should == "http://somewhere.else.entirely.org/api/v1/notify_app/1234/5678"
+    end
+  end
+
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: pushio
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Push IO LLC
+- Sean McKibben
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: &70259231551220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *70259231551220
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70259231550500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70259231550500
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70259231549820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: *70259231549820
+description: ! 'Ruby client library to send push notifications via the Push IO API.
+  See: http://push.io for more information and to set up your account.'
+email:
+- sean@push.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/push_io.rb
+- lib/push_io/client.rb
+- lib/push_io/configuration.rb
+- lib/push_io/errors.rb
+- lib/push_io/version.rb
+- pushio.gemspec
+- spec/push_io_spec.rb
+homepage: ''
+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.15
+signing_key: 
+specification_version: 3
+summary: This gem enables developers to easily create new notifications and send them
+  via the Push IO API from Ruby apps.
+test_files:
+- spec/push_io_spec.rb