push_bot 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e065854bc27948088fbb46998f9d938540739268
+  data.tar.gz: 3c4f45347da77397b8a3f40ea04df2b2c76517a5
+SHA512:
+  metadata.gz: 1e24692a953b753c62b614cdcfc3febb768857223c56d4242ee916eead25f3967e549561768d7a3ae8d8a589ec68e8453cd4ae5c5573a669c9efa9a3f8dc0729
+  data.tar.gz: 40ca316c939f63c13cddac4ff62dbab1e565522c2e3770a58e762d2ce4c2a3c17ffb801297d2c31ff5933c532e1a288b94333405bc79d01150c24f6657fc6b55

data/.gitignore

@@ -0,0 +1,30 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp
+
+.idea
+.rbx
+
+.sass-cache
+.scss-cache
+
+_Yardoc
+.DS_Store
+*.rbc
+*.pdf
+.yardoc
+*.gem
+
+/pkg
+/doc
+/doc_guide
+/coverage

data/.ruby-gemset

@@ -0,0 +1 @@
+push_bot

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.2

data/CONTRIBUTING.md

@@ -0,0 +1,10 @@
+Contributions to this project will be taken based on adherence to the style already used and subjective code quality.
+
+If you need a feature chances are others need it too
+
+The Process goes:
+1. Fork it ( https://github.com/[my-github-username]/push_bot/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    push_bot (0.4.0)
+      typhoeus (~> 0.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ethon (0.7.1)
+      ffi (>= 1.3.0)
+    ffi (1.9.5)
+    rake (10.3.2)
+    typhoeus (0.6.9)
+      ethon (>= 0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  push_bot!
+  rake (~> 10.0)

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brian Norton
+
+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,67 @@
+# PushBot
+
+PushBot is the Ruby Gem for connecting to the PushBots push notification service 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'push_bot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install push_bot
+
+## Usage
+
+#### Configuration
+```ruby
+# config/initializers/push_bot.rb
+
+PushBot.configure do |config|
+  config.id = 'Your Application ID'
+  config.secret = 'Your Application Secret'
+end
+```
+
+#### Register a Device Token
+```ruby
+# push token is the token given my the phone's OS
+# platform is :ios or :android
+
+device = PushBot::Device.new(user.push_token, user.platform)
+device.add
+```
+
+####Push a notification to a token
+```ruby
+push = PushBot::Push.new(user.push_token, user.platform)
+push.notify('Hello and Welcome to the App!')
+```
+
+#### Register a Device Token to an alias
+```ruby
+# push token is the token given my the phone's OS
+# platform is :ios or :android
+
+device = PushBot::Device.new(user.push_token, user.platform)
+device.add(:alias => user.email)
+```
+
+####Push a notification to an alias
+```ruby
+push = PushBot::Push.new(nil, user.platform)
+push.notify('Hello and Welcome to the App!', :alias => user.email)
+```
+
+####Device Info
+```ruby
+device = PushBot::Device.new(user.push_token, user.platform)
+device.info
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/lib/push_bot.rb

@@ -0,0 +1,15 @@
+require 'push_bot/api'
+require 'push_bot/config'
+require 'push_bot/device'
+require 'push_bot/location'
+require 'push_bot/platform'
+require 'push_bot/push'
+require 'push_bot/request'
+require 'push_bot/response'
+require 'push_bot/tag'
+
+module PushBot
+  def self.configure(&block)
+    Config.configure(&block)
+  end
+end

data/lib/push_bot/api.rb

@@ -0,0 +1,30 @@
+module PushBot
+  class Api
+    attr_accessor :token, :platforms, :platform
+
+    # Create a new Api object with an associated token and platform
+    #
+    # @param token the user identifier for your platform
+    # @param platform one of `:ios` or `:android` to indicate which platform the user uses
+    def initialize(token, platform)
+      @token = token
+      @platforms = Platform.parse(platform)
+      @platform = platforms.first
+    end
+
+    # Does this request represent a tokened single user or is it a batch request
+    def token?
+      (defined?(@token) && @token) ? true : false
+    end
+
+    # Does this request apply to a single user
+    def user?
+      token?
+    end
+
+    # Does this batch apply to a segment
+    def batch?
+      !token?
+    end
+  end
+end

data/lib/push_bot/config.rb

@@ -0,0 +1,15 @@
+module PushBot
+  class Config
+    attr_accessor :id, :secret
+
+    def self.config
+      @config ||= new
+    end
+
+    def self.configure
+      yield(config) if block_given?
+
+      config
+    end
+  end
+end

data/lib/push_bot/device.rb

@@ -0,0 +1,35 @@
+module PushBot
+  class Device < Api
+    # Add a specific user or batch of users to PushBots
+    #
+    # @param registration_options Any of the options available {https://pushbots.com/developer/rest Rest Docs @ PushBots}
+    # @return {PushBot::Response}
+    def add(registration_options={})
+      raise(ArgumentError, 'Batch device add should only be to a single platform') if Array === token && platforms.size != 1
+
+      options, type = registration_options.merge(
+        :platform => platform
+      ), :batch
+
+      if user?
+        type = nil
+        options[:token] = token
+      end
+
+      Request.new(:deviceToken).put(type, options)
+    end
+
+    def info
+      Request.new(:deviceToken).get(:one, :token => token)
+    end
+
+    # Remove a specific user from PushBots
+    #
+    # @return {PushBot::Response}
+    def remove
+      raise(ArgumentError, 'A token and platform is required for removal') unless token && token
+
+      Request.new(:deviceToken).put(:del, :token => token, :platform => platform)
+    end
+  end
+end

data/lib/push_bot/location.rb

@@ -0,0 +1,5 @@
+module PushBot
+  class Location
+
+  end
+end

data/lib/push_bot/platform.rb

@@ -0,0 +1,12 @@
+module PushBot
+  class Platform
+    VALUES = %w(ios android)
+
+    def self.parse(*platforms)
+      platforms = platforms.flatten.map! {|p| VALUES.index(p.to_s.downcase) }
+      raise(ArgumentError, 'Platform must be ios or android') if platforms.any?(&:nil?)
+
+      platforms.map!(&:to_s)
+    end
+  end
+end

data/lib/push_bot/push.rb

@@ -0,0 +1,25 @@
+module PushBot
+  class Push < Api
+    # Push a new message to the Segment
+    #
+    # @param message The message to alert the user with
+    # @param push_options Any of the options available {https://pushbots.com/developer/rest Rest Docs @ PushBots}
+    # @return {PushBot::Response}
+    def notify(message, push_options={})
+      options = { :sound => '' }
+      options, type = options.merge(push_options).merge(
+        :msg => message,
+        :platform => platforms
+      ), :all
+
+      unless batch?
+        type = :one
+        options[:badge] ||= '0'
+        options[:token] = token
+        options[:platform] = platform
+      end
+
+      Request.new(:push).post(type, options)
+    end
+  end
+end

data/lib/push_bot/request.rb

@@ -0,0 +1,46 @@
+module PushBot
+  class Request
+    def initialize(base)
+      @base = base
+    end
+
+    def get(name, options)
+      request(:get, name, options)
+    end
+
+    def post(name, options)
+      request(:post, name, options)
+    end
+
+    def put(name, options)
+      request(:put, name, options)
+    end
+
+    private
+
+    def request(type, name, options)
+      url = "https://api.pushbots.com/#{@base}"
+      url << "/#{name}" if name
+
+      request_options = {
+        :method => type,
+        :body => JSON.dump(options),
+        :headers => {
+          :'X-PushBots-AppID' => Config.config.id,
+          :'X-PushBots-Secret' => Config.config.secret,
+          :'Content-Type' => 'application/json'
+        }
+      }
+
+      if type == :get
+        request_options[:headers][:Token] = options[:token]
+      end
+
+      puts "Sending request:#{type} url:#{url} options:#{request_options.inspect}"
+
+      request = Typhoeus::Request.new(url, request_options)
+
+      Response.new(request)
+    end
+  end
+end

data/lib/push_bot/response.rb

@@ -0,0 +1,39 @@
+module PushBot
+  class Response
+    attr_reader :raw_response, :error
+
+    def initialize(request)
+      @raw_response = request.run
+
+      @success = raw_response.success?
+    rescue => e
+      @error = e
+    end
+
+    def inspect
+      "#<#{self.class}:#{object_id} @success=#{success?} @json=#{json}>"
+    end
+
+    # Did the request complete successfully or have issues
+    def success?
+      defined?(@success) && @success
+    end
+
+    # Did the response complete with an error
+    def error?
+      defined?(@error) && @error
+    end
+
+    # The raw response body string
+    def body
+      raw_response.try(:body)
+    end
+
+    # The result of the request as a JSON Object
+    #
+    # @return [Hash, Array] the JSON Object
+    def json
+      @json ||= body.present? ? JSON.parse(body) : {}
+    end
+  end
+end

data/lib/push_bot/tag.rb

@@ -0,0 +1,5 @@
+module PushBot
+  class Tag
+
+  end
+end

data/lib/push_bot/version.rb

@@ -0,0 +1,3 @@
+module PushBot
+  VERSION = '0.4.0'
+end

data/push_bot.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'push_bot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'push_bot'
+  spec.version       = PushBot::VERSION
+  spec.authors       = ['Brian Norton']
+  spec.email         = ['brian.nort@gmail.com']
+  spec.summary       = ''
+  spec.description   = ''
+  spec.homepage      = 'http://github.com/push_bot'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_runtime_dependency 'typhoeus', '~> 0.6'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: push_bot
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Brian Norton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: ''
+email:
+- brian.nort@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/push_bot.rb
+- lib/push_bot/api.rb
+- lib/push_bot/config.rb
+- lib/push_bot/device.rb
+- lib/push_bot/location.rb
+- lib/push_bot/platform.rb
+- lib/push_bot/push.rb
+- lib/push_bot/request.rb
+- lib/push_bot/response.rb
+- lib/push_bot/tag.rb
+- lib/push_bot/version.rb
+- push_bot.gemspec
+homepage: http://github.com/push_bot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []