pushbots 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fe7a02451bd030c89ec8006484c128096c9b529
-  data.tar.gz: 40c057b30a1a1f7b8b46e5870a8e21a9e34c9bd4
+  metadata.gz: 7b766d00b676a82fdcfea64e2c3baa7509f61900
+  data.tar.gz: b36715e61c9708936e41c9cc37e68fbe66fd423c
 SHA512:
-  metadata.gz: cbbbfa0bb86e57d74baa4925cfe38d13c6ab5f9f7275db35304d9cfc61b3d6d21d5dc83377d612e4167aa3f0f3278cb382ec76691f1316113cdbfb09139908a2
-  data.tar.gz: 83e7866a708206bc5c854d11d0c9de214460171a0bedb34f8f1b933b63e7b089d022b1e3477fccadea5489501d567a14230514fc1883ca7c76725b27b7db918e
+  metadata.gz: 1fcfa2c1a14c66a7c00462c500a3b4f4ed132f7c4b0078664ad54cad2a0e82e8dcf29d467d657a26b1d0f64c2c86f514c39eca5e8efa8a2859f4fe9b59a75f78
+  data.tar.gz: 688203201284b99fa6dfadb36f66278b124eefd283aed4e1fffef23facbaee275584ce44df026eb592a8c7ff6246982b3c5da1aa604edd46c9431eaa53e6e4c6

data/README.md

@@ -5,6 +5,22 @@ Ruby Wrapper for PushBots Rest API made with love by Kandiie
 PushBots is a Light SDK for mobile push notifications and now you can use
 this gem on your favorite Ruby on Rails Projects.
 
+## Table of Contents
+- [Installation](#installation)
+- [Configuration](#configuration)
+
+- [How to use](#how-to-use)
+  - [Device management](#device-management)
+    - [Register a device](#register-a-device)
+    - [Delete a device](#delete-a-device)
+    - [Device information](#device-information)
+
+  - [Notifications](#notifications)
+    - [Single device notification](#single-device-notification)
+    - [Multiple device notifications](#multiple-device-notification)
+    - [Read pushbots response](#read-pushbots-response)
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -21,9 +37,7 @@ Or install it yourself as:
 
     $ gem install pushbots
 
-
-## How to use:
-#### Configuration
+## Configuration
 ```ruby
 # config/initializers/pushbots.rb
 
@@ -32,6 +46,43 @@ Pushbots.configure do |config|
   config.application_secret = 'Application Secret'
 end
 ```
+
+# How to use:
+## Device management
+#### Register a device
+```ruby
+# token and platform are required to add a device
+device = Pushbots::Device.new(token, platform)
+# register the device to pushbots returns true/false
+# an attempt to register a device
+# that has been already registered returns false
+device.register
+```
+
+#### Delete a device
+```ruby
+# token and platform are required to delete a device
+device = Pushbots::Device.new(token, platform)
+# remove the device from pushbots
+# returns true if no errors occurred
+device.delete
+```
+
+#### Device information
+```ruby
+# token is required to get device information
+# platform is an optional parameter
+device = Pushbots::Device.new(token)
+# Get device information
+# Device token
+device.token
+# Device status
+device.platform
+# Device tags
+device.tags
+```
+
+## Notifications
 #### Single device notification
 ```ruby
 # Device token
@@ -44,7 +95,7 @@ message = 'Hello World!!!'
 # Build up the notification
 # platform, message, token and sound (required parameters).
 # options (custom fields) (optional parameter)
-push = PushBot::One.new(platform, token, message, sound, options)
+push = PushBots::One.new(platform, token, message, sound, options)
 push.send # Delivers the notification
 ```
 
@@ -60,11 +111,11 @@ schedule = DateTime.now
 # Build up the notification
 # platform, message, schedule (required parameters).
 # options (custom fields) (optional parameter)
-push = PushBot::All.new(platforms, message, schedule, options = {})
+push = PushBots::All.new(platforms, message, schedule, options = {})
 push.send # Delivers the notification
 ```
 
-##### You can read Pushbots API response using:
+##### Read pushbots response
 ```ruby
 # Your notification response
 push.response

data/lib/pushbots.rb

@@ -5,6 +5,7 @@ require 'pushbots/request'
 require 'pushbots/response'
 require 'pushbots/one'
 require 'pushbots/all'
+require 'pushbots/device'
 
 # Pushbots module
 module Pushbots

data/lib/pushbots/all.rb

@@ -17,8 +17,7 @@ module Pushbots
     end
 
     def send
-      request = Request.new(body, :all)
-      self.response = request.send
+      self.response = Request.send(:all, body)
       self.status =
         response.failed? ? STATUS[:failed] : STATUS[:delivered]
     end

data/lib/pushbots/device.rb

@@ -0,0 +1,34 @@
+module Pushbots
+  # Device class
+  class Device
+    attr_accessor :token, :platform, :tags
+    PLATFORM_TYPE = { ios: 0, android: 1 }.freeze
+    PLATFORM_TYPE_R = [:ios, :android].freeze
+
+    def initialize(token, platform = nil)
+      self.token = token
+      self.platform = platform if platform
+    end
+
+    def info
+      response = Request.info(token)
+      if response.code == 200
+        http_response = JSON.parse(response)
+        self.platform = PLATFORM_TYPE_R[http_response['platform']]
+        self.tags = http_response['tags']
+      end
+    end
+
+    def register
+      body = { token: token, platform: PLATFORM_TYPE[platform] }
+      response = Request.register(body)
+      response.code == 201
+    end
+
+    def delete
+      body = { token: token, platform: PLATFORM_TYPE[platform] }
+      response = Request.delete(body)
+      response.code == 200
+    end
+  end
+end

data/lib/pushbots/one.rb

@@ -12,8 +12,8 @@ module Pushbots
     end
 
     def send
-      request = Request.new(body, :one)
-      self.response = request.send
+      # request = Request.new(body, :one)
+      self.response = Request.send(:one, body)
       self.status =
         response.failed? ? STATUS[:failed] : STATUS[:delivered]
     end

data/lib/pushbots/push.rb

@@ -30,10 +30,11 @@ module Pushbots
     private
 
     def validates_platform(platform)
-      fail 'platform is not valid' if PLATFORM_TYPE[platform].nil?
+      raise 'platform is not valid' if PLATFORM_TYPE[platform].nil?
     end
 
     def validates_platforms(platforms)
+      raise 'platform is not valid' if platforms.empty?
       platforms.each do |t|
         validates_platform(t)
       end

data/lib/pushbots/request.rb

@@ -3,24 +3,45 @@ require 'http'
 module Pushbots
   # Request class
   class Request
-    attr_accessor :body, :base_url
+    def self.send(type, body)
+      url = "https://api.pushbots.com/push/#{type}"
+      header = header_base.merge(header_push)
+      response = HTTP.headers(header).post(url, json: body)
+      Response.new(response)
+    end
 
-    def initialize(body, base_url)
-      self.body = body
-      self.base_url = base_url
+    def self.info(token)
+      url = 'https://api.pushbots.com/deviceToken/one'
+      header = header_base.merge(header_info(token))
+      HTTP.headers(header).get(url)
     end
 
-    def send
-      url = "https://api.pushbots.com/push/#{base_url}"
-      response = HTTP.headers(header).post(url, json: body)
-      Response.new(response)
+    def self.register(body)
+      url = 'https://api.pushbots.com/deviceToken'
+      HTTP.headers(header_base).put(url, json: body)
+    end
+
+    def self.delete(body)
+      url = 'https://api.pushbots.com/deviceToken/del'
+      HTTP.headers(header_base).put(url, json: body)
+    end
+
+    def self.header_base
+      {
+        :'X-PushBots-AppID' => Config.config.application_id,
+        :'Content-Type' => 'application/json'
+      }
+    end
+
+    def self.header_push
+      {
+        :'X-PushBots-Secret' => Config.config.application_secret
+      }
     end
 
-    def header
+    def self.header_info(token)
       {
-        'X-PushBots-AppID' => Config.config.application_id,
-        'X-PushBots-Secret' => Config.config.application_secret,
-        'Content-Type' => 'application/json'
+        token: token
       }
     end
   end

data/lib/pushbots/version.rb

@@ -1,4 +1,4 @@
 # Pushbots gem version
 module Pushbots
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/pushbots.gemspec

@@ -9,14 +9,17 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Carlos Omana', 'Cesar Rodriguez']
   spec.email         = ['contact@kandiie.com']
   spec.summary       = 'Ruby Wrapper for PushBots Rest API.'
-  spec.description   = 'Ruby Wrapper for PushBots Rest API.'
+  spec.description   = 'Ruby Wrapper for PushBots Rest API. '\
+                       'Includes push notification methods for single and'\
+                       ' multiple devices simplifying notification management '\
+                       ' and pushbots api usage in your ruby projects.'
   spec.homepage      = 'https://github.com/Kandiie/pushbots'
   spec.license       = 'MIT'
 
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    fail 'RubyGems 2 or newer, required to protect against public gem pushes.'
+    raise 'RubyGems 2 or newer, required to protect against public gem pushes.'
   end
 
   spec.files         = `git ls-files -z`.split("\x0")

data/spec/external_request_single_device_spec.rb

@@ -0,0 +1,64 @@
+# spec/features/external_request_spec.rb
+require 'spec_helper'
+
+describe Pushbots do
+  let(:token) { 'token' }
+  let(:platform) { :android }
+  let(:message) { 'Hello World!!!' }
+  let(:sound) { 'sound' }
+  context 'request' do
+    context 'single device' do
+      context 'with valid data' do
+        it 'can push' do
+          push = described_class::One.new(platform, token, message, sound)
+          push.send
+          expect(push.response.code).to eq(200)
+        end
+      end
+
+      context 'with invalid data' do
+        context 'nil or empty token' do
+          it 'can not push (empty)' do
+            push = described_class::One.new(platform, '', message, sound)
+            push.send
+            expect(push.response.code).to eq(400)
+          end
+
+          it 'can not push (nil)' do
+            push = described_class::One.new(platform, nil, message, sound)
+            push.send
+            expect(push.response.code).to eq(400)
+          end
+        end
+
+        context 'nil or empty message' do
+          it 'can not push (empty)' do
+            push = described_class::One.new(platform, token, '', sound)
+            push.send
+            expect(push.response.code).to eq(400)
+          end
+
+          it 'can not push (nil)' do
+            push = described_class::One.new(platform, token, nil, sound)
+            push.send
+            expect(push.response.code).to eq(400)
+          end
+        end
+
+        context 'nil or empty sound' do
+          it 'can not push (empty)' do
+            push = described_class::One.new(platform, token, message, '')
+            push.send
+            expect(push.response.code).to eq(400)
+          end
+
+          it 'can not push (nil)' do
+            push = described_class::One.new(platform, token, message, nil)
+            push.send
+            expect(push.response.code).to eq(400)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/external_requests_multiple_device_spec.rb

@@ -0,0 +1,50 @@
+# spec/features/external_request_spec.rb
+require 'spec_helper'
+
+describe Pushbots do
+  let(:token) { 'token' }
+  let(:platforms) { [:ios] }
+  let(:message) { 'Hello World!!!' }
+  let(:schedule) { '2016-03-14T19:25:53-06:00' }
+  context 'request' do
+    context 'multiple devices' do
+      context 'with valid data' do
+        it 'can push' do
+          push = described_class::All.new(platforms, message, schedule)
+          push.send
+          expect(push.response.code).to eq(200)
+        end
+      end
+
+      context 'with invalid data' do
+        context 'nil or empty message' do
+          it 'can not push (nil)' do
+            push = described_class::All.new([:ios], nil, schedule)
+            push.send
+            expect(push.response.code).to eq(400)
+          end
+
+          it 'can not push (empty)' do
+            push = described_class::All.new([:ios], '', schedule)
+            push.send
+            expect(push.response.code).to eq(400)
+          end
+        end
+
+        context 'nil or empty schedule' do
+          it 'can not push (nil)' do
+            push = described_class::All.new([:ios], message, nil)
+            push.send
+            expect(push.response.code).to eq(400)
+          end
+
+          it 'can not push (empty)' do
+            push = described_class::All.new([:ios], message, '')
+            push.send
+            expect(push.response.code).to eq(400)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/pushbots_spec.rb

@@ -6,17 +6,56 @@ describe Pushbots do
   let(:message) { 'Hello World!!!' }
   let(:sound) { 'sound' }
   context 'initialize' do
-    context 'with invalid data' do
-      it 'raises wrong platform error' do
-        expect do
-          described_class::One.new(:other, token, message, sound)
-        end.to raise_error(RuntimeError, 'platform is not valid')
+    context 'single device' do
+      context 'with invalid paltform' do
+        it 'raises wrong platform error (empty)' do
+          expect do
+            described_class::One.new('', token, message, sound)
+          end.to raise_error(RuntimeError, 'platform is not valid')
+        end
+
+        it 'raises wrong platform error (nil)' do
+          expect do
+            described_class::One.new(nil, token, message, sound)
+          end.to raise_error(RuntimeError, 'platform is not valid')
+        end
+
+        it 'raises wrong platform error (wrong)' do
+          expect do
+            described_class::One.new(:other, token, message, sound)
+          end.to raise_error(RuntimeError, 'platform is not valid')
+        end
+      end
+      context 'with valid data' do
+        it 'initializes' do
+          described_class::One.new(:ios, token, message, sound)
+        end
       end
     end
+    context 'multiple device' do
+      context 'with invalid platform' do
+        it 'raises wrong platform error (empty)' do
+          expect do
+            described_class::All.new([], message, sound)
+          end.to raise_error(RuntimeError, 'platform is not valid')
+        end
 
-    context 'with valid data' do
-      it 'initializes' do
-        described_class::One.new(platform, token, message, sound)
+        it 'raises wrong platform error (nil)' do
+          expect do
+            described_class::All.new([], message, sound)
+          end.to raise_error(RuntimeError, 'platform is not valid')
+        end
+
+        it 'raises wrong platform error (wrong)' do
+          expect do
+            described_class::All.new([:ios, :androiid], message, sound)
+          end.to raise_error(RuntimeError, 'platform is not valid')
+        end
+      end
+      context 'with valid data' do
+        it 'initializes' do
+          described_class::All.new([:ios], message, sound)
+        end
       end
     end
   end

data/spec/requests.rb

@@ -0,0 +1,79 @@
+require 'webmock/rspec'
+module Requests
+  def single_device_requests
+    token = 'token'
+    message = 'Hello World!!!'
+    sound = 'sound'
+    # Valid data
+    pushbots_single_request(:post, token, message, sound, 200)
+    # Empty or nil token returns status 400
+    pushbots_single_request(:post, '', message, sound, 400)
+    pushbots_single_request(:post, nil, message, sound, 400)
+    # Empty or nil message returns status 400
+    pushbots_single_request(:post, token, '', sound, 400)
+    pushbots_single_request(:post, token, nil, sound, 400)
+    # Empty or nil sound returns status 400
+    pushbots_single_request(:post, token, message, '', 400)
+    pushbots_single_request(:post, token, message, nil, 400)
+  end
+
+  def multiple_device_requests
+    msg = 'Hello World!!!'
+    schedule = '2016-03-14T19:25:53-06:00'
+    # Multiple device requests
+    pushbots_multiple_request(:post, msg, schedule, 200)
+    # Empty or nil msg
+    pushbots_multiple_request(:post, nil, schedule, 400)
+    pushbots_multiple_request(:post, '', schedule, 400)
+    # Empty or nil schedule
+    pushbots_multiple_request(:post, msg, '', 400)
+    pushbots_multiple_request(:post, msg, nil, 400)
+  end
+
+  private
+
+  def common_headers
+    {
+      'Connection' => 'close',
+      'Content-Type' => 'application/json',
+      'Host' => 'api.pushbots.com',
+      'User-Agent' => /./,
+      'X-Pushbots-Appid' => 'Application ID',
+      'X-Pushbots-Secret' => 'Application Secret'
+    }
+  end
+
+  def single_device_content(token, msg, sound)
+    { 'platform' => 1,
+      'token' => token,
+      'msg' => msg,
+      'sound' => sound
+    }.to_json
+  end
+
+  def multiple_device_content(platforms, msg, schedule)
+    { 'platform' => platforms,
+      'msg' => msg,
+      'schedule' => schedule
+    }.to_json
+  end
+
+  def pushbots_single_request(method, token, message, sound, response)
+    stub_request(method, 'https://api.pushbots.com/push/one')
+      .with(body: single_device_content(token, message, sound),
+            headers: common_headers)
+      .to_return(status: response,
+                 body: '',
+                 headers: {})
+  end
+
+  def pushbots_multiple_request(method, msg, schedule, response)
+    stub_request(method, 'https://api.pushbots.com/push/all')
+      .with(body: multiple_device_content([0], msg,
+                                          schedule),
+            headers: common_headers)
+      .to_return(status: response,
+                 body: '',
+                 headers: {})
+  end
+end

data/spec/spec_helper.rb

@@ -1,104 +1,15 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'pushbots'
 require 'net/http'
-require 'webmock/rspec'
+require 'requests'
 WebMock.disable_net_connect!(allow_localhost: true)
 
 # Stub Request common headers
-common_headers = { 'Connection' => 'close',
-                   'Content-Type' => 'application/json',
-                   'Host' => 'api.pushbots.com',
-                   'User-Agent' => 'http.rb/1.0.2',
-                   'X-Pushbots-Appid' => 'Application ID',
-                   'X-Pushbots-Secret' => 'Application Secret' }
-
-api_path = 'https://api.pushbots.com/push/one'
-
 RSpec.configure do |config|
+  config.include Requests
   config.before(:each) do
-    # Valid data
-    content = { 'platform' => 0,
-                'token' => 'token',
-                'msg' => 'Hello World!!!',
-                'sound' => 'sound' }
-    stub_request(:post, api_path)
-      .with(body: content.to_json,
-            headers: common_headers)
-      .to_return(status: 200,
-                 body: '',
-                 headers: {})
-
-    # Empty token returns status 400
-    content = { 'platform' => 0,
-                'token' => '',
-                'msg' => 'Hello World!!!',
-                'sound' => 'sound' }
-    stub_request(:post, api_path)
-      .with(body: content.to_json,
-            headers: common_headers)
-      .to_return(status: 400,
-                 body: '',
-                 headers: {})
-
-    # Null token returns status 400
-    content = { 'platform' => 0,
-                'token' => nil,
-                'msg' => 'Hello World!!!',
-                'sound' => 'sound' }
-    stub_request(:post, api_path)
-      .with(body: content.to_json,
-            headers: common_headers)
-      .to_return(status: 400,
-                 body: '',
-                 headers: {})
-
-    # Empty message returns status 400
-    content = { 'platform' => 0,
-                'token' => 'token',
-                'msg' => '',
-                'sound' => 'sound' }
-    stub_request(:post, api_path)
-      .with(body: content.to_json,
-            headers: common_headers)
-      .to_return(status: 400,
-                 body: '',
-                 headers: {})
-
-    # Null message returns status 400
-    content = { 'platform' => 0,
-                'token' => 'token',
-                'msg' => nil,
-                'sound' => 'sound' }
-    stub_request(:post, api_path)
-      .with(body: content.to_json,
-            headers: common_headers)
-      .to_return(status: 400,
-                 body: '',
-                 headers: {})
-
-    # Empty sound returns status 400
-    content = { 'platform' => 0,
-                'token' => 'token',
-                'msg' => 'Hello World!!!',
-                'sound' => '' }
-    stub_request(:post, api_path)
-      .with(body: content.to_json,
-            headers: common_headers)
-      .to_return(status: 400,
-                 body: '',
-                 headers: {})
-
-    # Null sound returns status 400
-    content = { 'platform' => 0,
-                'token' => 'token',
-                'msg' => 'Hello World!!!',
-                'sound' => nil }
-    stub_request(:post, api_path)
-      .with(body: content.to_json,
-            headers: common_headers)
-      .to_return(status: 400,
-                 body: '',
-                 headers: {})
+    single_device_requests
+    multiple_device_requests
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pushbots
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Carlos Omana
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-12 00:00:00.000000000 Z
+date: 2016-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,7 +87,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.2
-description: Ruby Wrapper for PushBots Rest API.
+description: Ruby Wrapper for PushBots Rest API. Includes push notification methods
+  for single and multiple devices simplifying notification management  and pushbots
+  api usage in your ruby projects.
 email:
 - contact@kandiie.com
 executables: []
@@ -107,14 +109,17 @@ files:
 - lib/pushbots.rb
 - lib/pushbots/all.rb
 - lib/pushbots/config.rb
+- lib/pushbots/device.rb
 - lib/pushbots/one.rb
 - lib/pushbots/push.rb
 - lib/pushbots/request.rb
 - lib/pushbots/response.rb
 - lib/pushbots/version.rb
 - pushbots.gemspec
-- spec/external_request_spec.rb
+- spec/external_request_single_device_spec.rb
+- spec/external_requests_multiple_device_spec.rb
 - spec/pushbots_spec.rb
+- spec/requests.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Kandiie/pushbots
 licenses:

data/spec/external_request_spec.rb

@@ -1,62 +0,0 @@
-# spec/features/external_request_spec.rb
-require 'spec_helper'
-
-describe Pushbots do
-  let(:token) { 'token' }
-  let(:platform) { :ios }
-  let(:message) { 'Hello World!!!' }
-  let(:sound) { 'sound' }
-  context 'request' do
-    context 'with valid data' do
-      it 'can push to a single device' do
-        push = described_class::One.new(platform, token, message, sound)
-        push.send
-        expect(push.response.code).to eq(200)
-      end
-    end
-
-    context 'with invalid data' do
-      context 'nil or empty token' do
-        it 'can not push (empty)' do
-          push = described_class::One.new(platform, '', message, sound)
-          push.send
-          expect(push.response.code).to eq(400)
-        end
-
-        it 'can not push (nil)' do
-          push = described_class::One.new(platform, nil, message, sound)
-          push.send
-          expect(push.response.code).to eq(400)
-        end
-      end
-
-      context 'nil or empty message' do
-        it 'can not push (empty)' do
-          push = described_class::One.new(platform, token, '', sound)
-          push.send
-          expect(push.response.code).to eq(400)
-        end
-
-        it 'can not push (nil)' do
-          push = described_class::One.new(platform, token, nil, sound)
-          push.send
-          expect(push.response.code).to eq(400)
-        end
-      end
-
-      context 'nil or empty sound' do
-        it 'can not push (empty)' do
-          push = described_class::One.new(platform, token, message, '')
-          push.send
-          expect(push.response.code).to eq(400)
-        end
-
-        it 'can not push (nil)' do
-          push = described_class::One.new(platform, token, message, nil)
-          push.send
-          expect(push.response.code).to eq(400)
-        end
-      end
-    end
-  end
-end