push_bot 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e065854bc27948088fbb46998f9d938540739268
-  data.tar.gz: 3c4f45347da77397b8a3f40ea04df2b2c76517a5
+  metadata.gz: 2a18a2a8074b095dc89b6967c33cb7a01f75c549
+  data.tar.gz: 238aa353d064729a861f86c4b5888fdf99fd3912
 SHA512:
-  metadata.gz: 1e24692a953b753c62b614cdcfc3febb768857223c56d4242ee916eead25f3967e549561768d7a3ae8d8a589ec68e8453cd4ae5c5573a669c9efa9a3f8dc0729
-  data.tar.gz: 40ca316c939f63c13cddac4ff62dbab1e565522c2e3770a58e762d2ce4c2a3c17ffb801297d2c31ff5933c532e1a288b94333405bc79d01150c24f6657fc6b55
+  metadata.gz: 8629003eec5a8a0ae9e8ec7efc4a4c4d0b6ab8a8002be35d6f7810ed12564e5f37e374e1c34d8136af53b66f78bed934a0e35289d3860087ed966eb05c5ae664
+  data.tar.gz: 59a53aac57c678831e176312819ca7d6ed52226afbbd65b6903d84de030b4b3d21398ee7c9eb4e357e18a632e0aea9741cb3b0058ac2a9271d239076a51d6dc2

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile.lock

@@ -1,16 +1,29 @@
 PATH
   remote: .
   specs:
-    push_bot (0.4.0)
+    push_bot (0.4.1)
       typhoeus (~> 0.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    diff-lcs (1.2.5)
     ethon (0.7.1)
       ffi (>= 1.3.0)
     ffi (1.9.5)
     rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.5)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.2)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.1)
     typhoeus (0.6.9)
       ethon (>= 0.7.1)
 
@@ -21,3 +34,4 @@ DEPENDENCIES
   bundler (~> 1.7)
   push_bot!
   rake (~> 10.0)
+  rspec (~> 3.1)

data/README.md

@@ -35,6 +35,7 @@ end
 # push token is the token given my the phone's OS
 # platform is :ios or :android
 
+device = PushBot::Device.new('USER TOKEN', :ios)
 device = PushBot::Device.new(user.push_token, user.platform)
 device.add
 ```

data/lib/push_bot.rb

@@ -1,3 +1,5 @@
+require 'forwardable'
+
 require 'push_bot/api'
 require 'push_bot/config'
 require 'push_bot/device'

data/lib/push_bot/device.rb

@@ -11,14 +11,19 @@ module PushBot
         :platform => platform
       ), :batch
 
-      if user?
+      if user? && !(Array === token)
         type = nil
         options[:token] = token
+      else
+        options[:tokens] = token
       end
 
       Request.new(:deviceToken).put(type, options)
     end
 
+    # Retrieve information about the device with this token
+    #
+    # @return {PushBot::Response}
     def info
       Request.new(:deviceToken).get(:one, :token => token)
     end

data/lib/push_bot/platform.rb

@@ -2,6 +2,10 @@ module PushBot
   class Platform
     VALUES = %w(ios android)
 
+    # Translate an array of :ios / :android into an array of integer strings
+    #
+    # @param platforms any of `:ios` and `:android`
+    # @return Array[<String>]
     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?)

data/lib/push_bot/request.rb

@@ -28,7 +28,7 @@ module PushBot
         :headers => {
           :'X-PushBots-AppID' => Config.config.id,
           :'X-PushBots-Secret' => Config.config.secret,
-          :'Content-Type' => 'application/json'
+          :'Content-Type' => :'application/json'
         }
       }
 
@@ -36,11 +36,9 @@ module PushBot
         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)
+      Response.new { request.run }
     end
   end
 end

data/lib/push_bot/response.rb

@@ -1,11 +1,11 @@
 module PushBot
   class Response
-    attr_reader :raw_response, :error
+    extend Forwardable
 
-    def initialize(request)
-      @raw_response = request.run
+    attr_reader :raw_response, :error
 
-      @success = raw_response.success?
+    def initialize
+      @raw_response = yield
     rescue => e
       @error = e
     end
@@ -15,20 +15,16 @@ module PushBot
     end
 
     # Did the request complete successfully or have issues
-    def success?
-      defined?(@success) && @success
-    end
+    delegate :success? => :raw_response
+
+    # The raw response body string
+    delegate :body => :raw_response
 
     # 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

data/lib/push_bot/version.rb

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

data/push_bot.gemspec

@@ -8,11 +8,10 @@ Gem::Specification.new do |spec|
   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.summary       = 'A Ruby interface to the PushBots API'
+  spec.description   = 'Register, Push to and get information about devices on your account.'
+  spec.homepage      = 'https://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)/})
@@ -20,5 +19,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_runtime_dependency 'typhoeus', '~> 0.6'
 end

data/spec/lib/device_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe PushBot::Device do
+  let(:user_token) { 'user token' }
+
+  subject { described_class.new(user_token, :ios) }
+
+  let(:request) { double(PushBot::Request) }
+
+  describe '#add' do
+    let(:message) { 'Push Message' }
+    let(:options) { { :extra => 'value' } }
+
+    let(:add) { subject.add(options) }
+
+    before do
+      allow(PushBot::Request).to receive(:new).with(:deviceToken).and_return(request)
+    end
+
+    it 'should send the given attributes' do
+      expect(request).to receive(:put).with(nil, hash_including(:token => 'user token', :platform => '0'))
+
+      add
+    end
+
+    it 'should send the extra attributes' do
+      expect(request).to receive(:put).with(anything, hash_including(:extra => 'value'))
+
+      add
+    end
+
+    describe 'when given multiple tokens' do
+      let(:user_token) { %w(abc 123) }
+
+      it 'should send the batch request' do
+        expect(request).to receive(:put).with(:batch, hash_including(:tokens => %w(abc 123), :platform => '0'))
+
+        add
+      end
+
+      it 'should not send the token' do
+        expect(request).to receive(:put).with(anything, hash_excluding(:token))
+
+        add
+      end
+    end
+  end
+
+  describe '#info' do
+    let(:info) { subject.info }
+
+    before do
+      allow(PushBot::Request).to receive(:new).with(:deviceToken).and_return(request)
+    end
+
+    it 'should send request the information' do
+      expect(request).to receive(:get).with(:one, hash_including(:token => 'user token'))
+
+      info
+    end
+  end
+
+  describe '#remove' do
+    let(:remove) { subject.remove }
+
+    before do
+      allow(PushBot::Request).to receive(:new).with(:deviceToken).and_return(request)
+    end
+
+    it 'should send request the remove' do
+      expect(request).to receive(:put).with(:del, hash_including(:token => 'user token', :platform => '0'))
+
+      remove
+    end
+  end
+end

data/spec/lib/push_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe PushBot::Push do
+  let(:user_token) { 'user token' }
+
+  subject { described_class.new(user_token, :ios) }
+
+  let(:request) { double(PushBot::Request) }
+
+  describe '#notify' do
+    let(:message) { 'Push Message' }
+    let(:options) { { } }
+
+    let(:notify) { subject.notify(message, options) }
+
+    before do
+      allow(PushBot::Request).to receive(:new).with(:push).and_return(request)
+    end
+
+    it 'should send the given attributes' do
+      expect(request).to receive(:post).with(:one, hash_including(:token => 'user token', :platform => '0', :badge => '0', :sound => ''))
+
+      notify
+    end
+
+    it 'should send the extra attributes' do
+      expect(request).to receive(:post).with(anything, hash_including(:msg => message))
+
+      notify
+    end
+
+    describe 'when the token is not given' do
+      let(:user_token) { nil }
+
+      it 'should send the batch request' do
+        expect(request).to receive(:post).with(:all, hash_including(:msg => message, :platform => ['0']))
+
+        notify
+      end
+
+      it 'should not send the token' do
+        expect(request).to receive(:post).with(anything, hash_excluding(:token))
+
+        notify
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'push_bot'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.profile_examples = 1
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: push_bot
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Brian Norton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-06 00:00:00.000000000 Z
+date: 2014-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-description: ''
+description: Register, Push to and get information about devices on your account.
 email:
 - brian.nort@gmail.com
 executables: []
@@ -60,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
 - CONTRIBUTING.md
@@ -80,7 +95,10 @@ files:
 - lib/push_bot/tag.rb
 - lib/push_bot/version.rb
 - push_bot.gemspec
-homepage: http://github.com/push_bot
+- spec/lib/device_spec.rb
+- spec/lib/push_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/push_bot
 licenses:
 - MIT
 metadata: {}
@@ -103,5 +121,8 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: ''
-test_files: []
+summary: A Ruby interface to the PushBots API
+test_files:
+- spec/lib/device_spec.rb
+- spec/lib/push_spec.rb
+- spec/spec_helper.rb