Adds notification resources

Author: coding-chimp

lib/onesignal.rb

@@ -6,9 +6,11 @@
 require 'onesignal/models/base_model'
 require 'onesignal/models/app'
 require 'onesignal/models/player'
+require 'onesignal/models/notification'
 require 'onesignal/resources/base_resource'
 require 'onesignal/resources/app_resource'
 require 'onesignal/resources/player_resource'
+require 'onesignal/resources/notification_resource'
 
 module OneSignal
   DEVICE_TYPES = %w(

lib/onesignal/client.rb

@@ -19,6 +19,12 @@ def players
       @players ||= PlayerResource.new(self)
     end
 
+    def notifications
+      ensure_app_id_presence
+
+      @notifications ||= NotificationResource.new(self)
+    end
+
     private
 
     def ensure_app_id_presence

lib/onesignal/models/notification.rb

@@ -0,0 +1,14 @@
+module OneSignal
+  class Notification < BaseModel
+    attr_accessor :canceled, :contents, :converted, :data, :failed, :headings,
+      :id, :queued_at, :remaining, :send_after, :successful, :url
+
+    def queued_at=(time)
+      @queued_at = Time.at(time)
+    end
+
+    def send_after=(time)
+      @send_after = Time.at(time)
+    end
+  end
+end

lib/onesignal/request.rb

@@ -28,6 +28,18 @@ def put(path, params)
       request(uri, Net::HTTP::Put, params)
     end
 
+    def delete(path, params = {})
+      uri = uri(path)
+
+      if @client.app_id
+        params[:app_id] = @client.app_id
+      end
+
+      uri.query = URI.encode_www_form(params)
+
+      request(uri, Net::HTTP::Delete, params)
+    end
+
     private
 
     def uri(path)

lib/onesignal/resources/base_resource.rb

@@ -20,6 +20,10 @@ def post(path, params)
       @response = request.post(path, params)
     end
 
+    def delete(path)
+      @response = request.delete(path)
+    end
+
     def request
       @request ||= OneSignal::Request.new(@client)
     end

lib/onesignal/resources/notification_resource.rb

@@ -0,0 +1,33 @@
+module OneSignal
+  class NotificationResource < BaseResource
+    def all(params = {})
+      get('/notifications', params)
+
+      response_body['notifications'].map(&OneSignal::Notification)
+    end
+
+    def find(id)
+      get("/notifications/#{id}")
+
+      OneSignal::Notification.new(response_body)
+    end
+
+    def track_open(id, params)
+      put("/notifications/#{id}", params)
+
+      true
+    end
+
+    def create(params)
+      post('/notifications', params)
+
+      response_body
+    end
+
+    def cancel(id)
+      delete("/notifications/#{id}")
+
+      true
+    end
+  end
+end

test/client_test.rb

@@ -18,4 +18,16 @@ def test_players_throws_error_when_app_id_missing
 
     assert_raises(OneSignal::AppIdMissingError) { client.players }
   end
+
+  def test_notifications_returns_a_notification_resource
+    client = OneSignal::Client.new(auth_token: 'test', app_id: '1')
+
+    assert_instance_of OneSignal::NotificationResource, client.notifications
+  end
+
+  def test_notifications_throws_error_when_app_id_missing
+    client = OneSignal::Client.new(auth_token: 'test')
+
+    assert_raises(OneSignal::AppIdMissingError) { client.notifications }
+  end
 end

test/fixtures/notifications/all.json

@@ -0,0 +1,54 @@
+{
+  "total_count":3,
+  "offset":2,
+  "limit":2,
+  "notifications":
+    [
+    {
+      "id":"481a2734-6b7d-11e4-a6ea-4b53294fa671",
+      "successful":15,
+      "failed":1,
+      "converted":3,
+      "remaining":0,
+      "queued_at":1415914655,
+      "send_after":1415914655,
+      "canceled": false,
+      "url": "https://yourWebsiteToOpen.com",
+      "data": {
+        "abc": "123",
+        "foo": "bar"
+      },
+      "headings":{
+        "en":"English and default langauge heading",
+        "es":"Spanish language heading"
+      },
+      "contents":{
+        "en":"English and default content",
+        "es":"Hola"
+      }
+    },
+    {
+      "id":"b6b326a8-40aa-13e5-b91b-bf8bc3fa26f7",
+      "successful":5,
+      "failed":2,
+      "converted":0,
+      "remaining":0,
+      "queued_at":1415915123,
+      "send_after":1415915123,
+      "canceled": false,
+      "url": "http://foo.com",
+      "data":{
+        "foo":"bar",
+        "your":"custom metadata"
+      },
+      "headings":{
+        "en":"English and default langauge heading",
+        "es":"Spanish language heading"
+      },
+      "contents":{
+        "en":"English and default content",
+        "es":"Hola"
+      }
+    }
+  ]
+}

test/fixtures/notifications/cancel.json

@@ -0,0 +1 @@
+{'success': "true"}

test/fixtures/notifications/create.json

@@ -0,0 +1,4 @@
+{
+  "id": "458dcec4-cf53-11e3-add2-000c2940e62c",
+  "recipients": 5
+}