one_signal 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36e9569d2a051f3e9fc4e2c70439c18322c89c21
-  data.tar.gz: a74e6c5eeb18553a235e03132b5003f03d8da20d
+  metadata.gz: bab389232fff84659f6f0343f8f880729fdb51d9
+  data.tar.gz: bad83e1ae89015acdc7309a3534deb5120ca8cbd
 SHA512:
-  metadata.gz: 2f6e387073ffe3c503f5e8d1fbc520e9f06a875bef9fe1ccf9ba22be608da56af328fa1852eb09f2c67efebeaed72fa3184df1c389d0d3c3f86c1b158a759a07
-  data.tar.gz: 23cc0acb614002fbee84cf298bd46a9e29e115c4b2cc9817ce9cfad2a73e24398dbfbe8d5bad5fef2c363bc400ae293c9c3121cefe056787f7a9c3ca2031c607
+  metadata.gz: 4b7f50a6a54b29f24dd05ba67daa16b5363cbb0c983f9e1155ede871f28a1f6b6ddd0722145585d2c06704c8f9bd9bd1d5120537e87ab470860f324fab1f9a09
+  data.tar.gz: 700aabec5ffe831e523389da25b4b6d93f292ed44e7eb4ae4c71b4e4edfe64863c9ea6f78218b850a4507f9db9f6392d50f57e527354e0f75f8a0216b18bea6b

data/CHANGELOG.txt

@@ -1,3 +1,10 @@
+=== 0.0.13 2016-02-18
+
+* Add App#all method
+* Add App#get method
+* Add App#create method
+* Add App#update method
+
 === 0.0.12 2016-02-16
 
 * Add Notification#update method

data/README.md

@@ -1,5 +1,6 @@
-# onesignal-ruby
-OneSignal Ruby bindings
+# OneSignal Ruby bindings
+
+This gem provides a simple SDK to access the [OneSignal API](https://documentation.onesignal.com/docs/server-api-overview).
 
 ## Installation
 
@@ -7,10 +8,63 @@ OneSignal Ruby bindings
 gem install one_signal
 ```
 
+## Development
+
+Run the tests
+
+```
+bundle exec rake
+```
+
 ## Basic usage
 
 See basic examples in [example.rb](/example.rb)
 
+## Documentation
+
+Specify your API key:
+
+```ruby
+OneSignal::OneSignal.api_key = YOUR_API_KEY
+```
+
+Then call the following methods on the `App`, `Player` and `Notification` classes.
+The `params` argument in those methods is a ruby hash and the accepted/required keys for this hash are documented in the [OneSignal API documentation](https://documentation.onesignal.com/docs/server-api-overview)
+
+The return value of each method is a `Net::HTTPResponse`.
+
+### Apps
+
+```ruby
+- OneSignal::App.all(params:)
+- OneSignal::App.get(id:)
+- OneSignal::App.create(params:)
+- OneSignal::App.update(id:, params:)
+```
+
+### Players
+
+```ruby
+- OneSignal::Player.all(params:)
+- OneSignal::Player.csv_export(app_id:)
+- OneSignal::Player.get(id:)
+- OneSignal::Player.create(params:)
+- OneSignal::Player.create_session(id:, params:)
+- OneSignal::Player.create_purchase(id:, params:)
+- OneSignal::Player.create_focus(id:, params:)
+- OneSignal::Player.update(id:, params:)
+```
+
+### Notifications
+
+```ruby
+- OneSignal::Notification.all(params:)
+- OneSignal::Notification.get(id:, params:)
+- OneSignal::Notification.create(params:)
+- OneSignal::Notification.update(id:, params:)
+- OneSignal::Notification.delete(id:, params:)
+```
+
 ## Changes
 
 See [CHANGELOG.txt](CHANGELOG.txt)

data/example.rb

@@ -3,11 +3,13 @@ require 'dotenv'
 
 Dotenv.load
 api_key = ENV['ONESIGNAL_API_KEY']
+user_auth_key = ENV['ONESIGNAL_USER_AUTH_KEY']
 @app_id = ENV['ONESIGNAL_APP_ID']
 @device_token = "abcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabc3"
 @example_player_id = ENV['EXAMPLE_PLAYER_ID']
 
 OneSignal::OneSignal.api_key = api_key
+OneSignal::OneSignal.user_auth_key = user_auth_key
 
 def create_player
   params = {
@@ -175,7 +177,7 @@ def notify
       {
         key: 'user_id',
         relation: '=',
-        value: "unknown"
+        value: "2"
       },
       { operator: 'AND' },
       {
@@ -191,6 +193,8 @@ def notify
     puts "code : #{response.code}"
     puts "message : #{response.message}"
     puts "body : #{response.body}"
+    body = JSON.parse(response.body)
+    return body["id"]
   rescue OneSignal::NoRecipientsError => e
     puts "--- NoRecipientsError: #{e.inspect}"
     puts "-- message : #{e.message}"
@@ -228,6 +232,60 @@ def update_notif(id:)
   puts response.body
 end
 
+def delete_notif(id:)
+  params = {
+    app_id: @app_id
+  }
+
+  begin 
+    response = OneSignal::Notification.delete(id: id, params: params)
+    puts "code : #{response.code}"
+    puts "message : #{response.message}"
+    puts "body : #{response.body}"
+    puts "id : #{JSON.parse(response.body).class}"
+  rescue OneSignal::OneSignalError => e
+    puts "-- message : #{e.message}"
+    puts "-- status : #{e.http_status}"
+    puts "-- body : #{e.http_body}"
+  end
+end
+
+def all_apps
+  begin 
+    response = OneSignal::App.all(params: nil)
+    puts "code : #{response.code}"
+    puts "message : #{response.message}"
+    puts "body : #{response.body}"
+    puts "id : #{JSON.parse(response.body).class}"
+  rescue OneSignal::OneSignalError => e
+    puts "-- message : #{e.message}"
+    puts "-- status : #{e.http_status}"
+    puts "-- body : #{e.http_body}"
+  end
+end
+
+def get_app(id:)
+  response = OneSignal::App.get(id: id)
+  puts response.body
+end
+
+def create_app
+  params = {
+    name: 'footest'
+  }
+  response = OneSignal::App.create(params: params)
+  puts response.body
+end
+
+def update_app
+  params = {
+    name: 'bartest'
+  }
+  response = OneSignal::App.update(id: "29203a07-8f1f-438a-9932-9549c6b28c14",
+                                   params: params)
+  puts response.body
+end
+
 # player_id = create_player
 # update_player(id: player_id)
 player_id = '9c9a3fb4-62e0-455d-865b-670ccea594a1' 
@@ -235,11 +293,17 @@ notification_id = 'c6e10bac-af7d-4879-a5e9-439de53e3cff'
 # create_player_session(id: player_id)
 # create_player_purchase(id: player_id)
 # create_player_focus(id: player_id)
-# notify
+# notification_id = notify
+# puts "--- notif id: #{notification_id}"
 # csv_export
 # all_players
 # get_player(id: player_id)
 # all_notifs
-get_notif(id: notification_id)
-update_notif(id: notification_id)
-get_notif(id: notification_id)
+# get_notif(id: notification_id)
+# delete_notif(id: notification_id)
+# update_notif(id: notification_id)
+# get_notif(id: notification_id)
+# all_apps
+# get_app(id: @app_id)
+# create_app
+update_app

data/lib/one_signal/app.rb

@@ -0,0 +1,79 @@
+module OneSignal
+  
+  class App < OneSignal
+
+    def self.all(params: {})
+      uri_string = @@base_uri
+      uri_string += "/apps"
+      uri = URI.parse(uri_string)
+
+      response = send_get_request(uri: uri, params: params)
+
+      ensure_http_status(response: response,
+                         status: '200',
+                         method_name: 'All',
+                         uri: uri,
+                         params: params)
+
+      return response
+    end
+
+    def self.get(id:)
+      uri_string = @@base_uri
+      uri_string += "/apps"
+      uri_string += "/#{id}"
+      uri = URI.parse(uri_string)
+    
+      response = send_get_request(uri: uri, params: nil)
+
+      ensure_http_status(response: response,
+                         status: '200',
+                         method_name: 'Get',
+                         uri: uri,
+                         params: nil)
+
+      return response
+    end
+
+    def self.create(params: {})
+      uri_string = @@base_uri
+      uri_string += "/apps"
+      uri = URI.parse(uri_string)
+
+      response = send_post_request(uri: uri, body: params)
+
+      ensure_http_status(response: response,
+                         status: '200',
+                         method_name: 'Create',
+                         uri: uri,
+                         params: params)
+
+      return response
+    end
+    
+    def self.update(id:, params: {})
+      uri_string = @@base_uri
+      uri_string += "/apps"
+      uri_string += "/#{id}"
+      uri = URI.parse(uri_string)
+
+      response = send_put_request(uri: uri, body: params)
+
+      ensure_http_status(response: response,
+                         status: '200',
+                         method_name: 'Update',
+                         uri: uri,
+                         params: params)
+
+      return response
+    end
+
+    private
+
+    def self.auth_key
+      return @@user_auth_key
+    end
+
+  end
+
+end

data/lib/one_signal/notification.rb

@@ -66,6 +66,23 @@ module OneSignal
       return response
     end
 
+    def self.delete(id:, params:)
+      uri_string = @@base_uri
+      uri_string += "/notifications"
+      uri_string += "/#{id}"
+      uri = URI.parse(uri_string)
+    
+      response = send_delete_request(uri: uri, params: params)
+
+      ensure_http_status(response: response,
+                         status: '200',
+                         method_name: 'Delete',
+                         uri: uri,
+                         params: nil)
+
+      return response
+    end
+
     private
 
     def self.handle_error(uri:, params:, response:)

data/lib/one_signal/one_signal.rb

@@ -7,6 +7,7 @@ module OneSignal
   class OneSignal
     @@base_uri = "https://onesignal.com/api/v1"
     @@api_key = nil
+    @@user_auth_key = nil
     @@open_timeout = 30
     @@read_timeout = 30
 
@@ -18,6 +19,14 @@ module OneSignal
       @@api_key
     end
 
+    def self.user_auth_key=(new_user_auth_key)
+      @@user_auth_key = new_user_auth_key
+    end
+
+    def self.user_auth_key
+      @@user_auth_key
+    end
+
     def self.open_timeout=(new_timeout)
       @@open_timeout = new_timeout
     end
@@ -43,8 +52,6 @@ module OneSignal
     end
 
     def self.send_post_request(uri:, body:)
-      ensure_api_key
-
       request = Net::HTTP::Post.new(uri.request_uri)
       request.body = body.to_json
       request = request_with_headers(request: request)
@@ -54,11 +61,9 @@ module OneSignal
       response = http.request(request)
     end
 
-    def self.send_delete_request(uri:, body:)
-      ensure_api_key
-
+    def self.send_delete_request(uri:, params: {})
+      uri.query = URI.encode_www_form(params) unless params.nil?
       request = Net::HTTP::Delete.new(uri.request_uri)
-      request.body = body.to_json
       request = request_with_headers(request: request)
       
       http = http_object(uri: uri)
@@ -67,8 +72,6 @@ module OneSignal
     end
 
     def self.send_put_request(uri:, body:)
-      ensure_api_key
-
       request = Net::HTTP::Put.new(uri.request_uri)
       request.body = body.to_json
       request = request_with_headers(request: request)
@@ -79,8 +82,6 @@ module OneSignal
     end
 
     def self.send_get_request(uri:, params: {})
-      ensure_api_key
-
       uri.query = URI.encode_www_form(params) unless params.nil?
       request = Net::HTTP::Get.new(uri.request_uri)
       request = request_with_headers(request: request)
@@ -94,26 +95,23 @@ module OneSignal
 
     def self.ensure_http_status(response:, status:, method_name:, uri:, params:)
       if response.code != status.to_s
-        msg = "#{method_name} error - uri: #{uri} params: #{params}"
+        msg = "#{self.name}##{method_name} error - uri: #{uri} params: #{params}"
         raise OneSignalError.new(message: msg,
                                  http_status: response.code,
                                  http_body: response.body)
       end
     end
 
-    def self.ensure_api_key
-      unless @@api_key && !@@api_key.strip.empty?
-        msg = "No API key provided"
-        raise OneSignalError.new(message: msg)
-      end
-    end
-
     def self.request_with_headers(request:)
       request.add_field("Content-Type", "application/json")
-      request.add_field("Authorization", "Basic #{@@api_key}")
+      request.add_field("Authorization", "Basic #{self.auth_key}")
       return request
     end
 
+    def self.auth_key
+      return @@api_key
+    end
+
   end
 
 end

data/lib/one_signal/version.rb

@@ -1,3 +1,3 @@
 module OneSignal
-  VERSION = "0.0.12"
+  VERSION = "0.0.13"
 end

data/lib/one_signal.rb

@@ -1,5 +1,6 @@
 require 'one_signal/version'
 require 'one_signal/one_signal'
+require 'one_signal/app'
 require 'one_signal/player'
 require 'one_signal/notification'
 

data/test/app_test.rb

@@ -0,0 +1,54 @@
+require File.dirname(__FILE__) + '/helper'
+
+class AppTest < MiniTest::Test
+
+  def setup
+    base_url = "https://onesignal.com/api/v1/apps"
+    @app_id = "fake-id-123"
+    @all_uri = URI.parse(base_url)
+    @get_uri = URI.parse(base_url + "/#{@app_id}")
+    @create_uri = URI.parse(base_url)
+    @update_uri = URI.parse(base_url + "/#{@app_id}")
+
+    @params = {
+      foo: "bar",
+      widget: "acme"
+    }
+
+    @user_auth_key = "fake user auth key"
+    OneSignal::OneSignal.user_auth_key  = @user_auth_key 
+  end
+
+  def test_all
+    response = mock_response_ok
+    OneSignal::OneSignal.expects(:send_get_request)
+                        .with(uri: @all_uri, params: @params)
+                        .returns(response)
+    assert_equal response, OneSignal::App.all(params: @params)
+  end
+
+  def test_get
+    response = mock_response_ok
+    OneSignal::OneSignal.expects(:send_get_request)
+                        .with(uri: @get_uri, params: nil)
+                        .returns(response)
+    assert_equal response, OneSignal::App.get(id: @app_id)
+  end
+
+  def test_create
+    response = mock_response_ok
+    OneSignal::OneSignal.expects(:send_post_request)
+                        .with(uri: @create_uri, body: @params)
+                        .returns(response)
+    assert_equal response, OneSignal::App.create(params: @params)
+  end
+
+  def test_update
+    response = mock_response_ok
+    OneSignal::OneSignal.expects(:send_put_request)
+                        .with(uri: @update_uri, body: @params)
+                        .returns(response)
+    assert_equal response, OneSignal::App.update(id: @app_id, params: @params)
+  end
+
+end

data/test/notification_test.rb

@@ -7,6 +7,7 @@ class NotificationTest < MiniTest::Test
     base_url = "https://onesignal.com/api/v1/notifications"
     @create_uri = URI.parse(base_url)
     @update_uri = URI.parse(base_url + "/#{@notification_id}")
+    @delete_uri = URI.parse(base_url + "/#{@notification_id}")
     @all_uri = URI.parse(base_url)
     @get_uri = URI.parse(base_url + "/#{@notification_id}")
     @params = {
@@ -71,4 +72,13 @@ class NotificationTest < MiniTest::Test
                                                           params: @params)
   end
 
+  def test_delete
+    response = mock_response_ok
+    OneSignal::OneSignal.expects(:send_delete_request)
+                        .with(uri: @delete_uri, params: @params)
+                        .returns(response)
+    assert_equal response, OneSignal::Notification.delete(id: @notification_id,
+                                                          params: @params)
+  end
+
 end

data/test/one_signal_test.rb

@@ -33,28 +33,6 @@ class OneSignalTest < MiniTest::Test
     return http
   end
 
-  def test_building_request_with_nil_api_key_raises_error
-    OneSignal::OneSignal.api_key = nil 
-
-    assert_raises OneSignal::OneSignalError do
-      OneSignal::OneSignal.send_post_request(uri: @uri, body: @body)
-    end
-    assert_raises OneSignal::OneSignalError do
-      OneSignal::OneSignal.send_put_request(uri: @uri, body: @body)
-    end
-  end
-  
-  def test_building_request_with_empty_api_key_raises_error
-    OneSignal::OneSignal.api_key = "  "
-
-    assert_raises OneSignal::OneSignalError do
-      OneSignal::OneSignal.send_post_request(uri: @uri, body: @body)
-    end
-    assert_raises OneSignal::OneSignalError do
-      OneSignal::OneSignal.send_put_request(uri: @uri, body: @body)
-    end
-  end
-
   def test_default_timeout
     assert_equal @default_timeout, OneSignal::OneSignal.open_timeout
     assert_equal @default_timeout, OneSignal::OneSignal.read_timeout
@@ -105,20 +83,24 @@ class OneSignalTest < MiniTest::Test
   end
 
   def test_send_delete_request
+    expected_uri = @uri.clone
+    expected_uri.query = URI.encode_www_form(@params)
+
     # test request creation
-    request = build_mock_request(body: @body)
-    Net::HTTP::Delete.expects(:new).with(@uri.request_uri).returns(request)
+    request = build_mock_request
+    Net::HTTP::Delete.expects(:new).with(expected_uri.request_uri).returns(request)
 
     # test http object creation
     http = build_mock_http_object
-    Net::HTTP.expects(:new).with(@uri.host, @uri.port).returns(http)
+    Net::HTTP.expects(:new).with(expected_uri.host, expected_uri.port).returns(http)
 
     # test send request
     response = mock()
     http.expects(:request).with(request).returns(response)
 
     OneSignal::OneSignal.api_key = @api_key
-    assert_equal response, OneSignal::OneSignal.send_delete_request(uri: @uri, body: @body)
+    assert_equal response, OneSignal::OneSignal.send_delete_request(uri: @uri,
+                                                                 params: @params)
   end
 
   def test_send_put_request

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: one_signal
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Thomas Balthazar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-16 00:00:00.000000000 Z
+date: 2016-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -94,6 +94,7 @@ files:
 - Rakefile
 - example.rb
 - lib/one_signal.rb
+- lib/one_signal/app.rb
 - lib/one_signal/errors/no_recipients_error.rb
 - lib/one_signal/errors/one_signal_error.rb
 - lib/one_signal/notification.rb
@@ -101,6 +102,7 @@ files:
 - lib/one_signal/player.rb
 - lib/one_signal/version.rb
 - one_signal.gemspec
+- test/app_test.rb
 - test/helper.rb
 - test/notification_test.rb
 - test/one_signal_test.rb