one_signal 0.0.14 → 1.2.1

data/README.md

@@ -1,6 +1,8 @@
 # OneSignal Ruby bindings
 
-This gem provides a simple SDK to access the [OneSignal API](https://documentation.onesignal.com/docs/server-api-overview).
+This gem provides a simple SDK to access the [OneSignal API](https://documentation.onesignal.com/reference).
+
+Also check my [onesignal-go](https://github.com/tbalthazar/onesignal-go) library.
 
 ## Installation
 
@@ -18,11 +20,15 @@ bundle exec rake
 
 ## Basic usage
 
-See basic examples in [example.rb](/example.rb)
+See basic examples in [example.rb](/example.rb).
+To run it:
+- rename [.env.example](/.env.example) into `.env`
+- set your `USER_AUTH_KEY` and `API_KEY` in the `.env` file
+- run `ruby example.rb`
 
 ## Documentation
 
-Specify your User Auth key to deal with Apps :
+Specify your User Auth key to deal with Apps:
 
 ```ruby
 OneSignal::OneSignal.user_auth_key = YOUR_USER_AUTH_KEY
@@ -35,7 +41,23 @@ 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 `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/reference)
+
+Each method also accepts an optional `opts` hash that allows you to specify the `user_auth_key`/`api_key` on a per method basis. It allows a ruby app to talk to several different OneSignal apps:
+
+```ruby
+app_1_api_key = "fake api key 1"
+app_2_api_key = "fake api key 2"
+
+# by default, method calls will use app_1_api_key
+OneSignal::OneSignal.api_key = app_1_api_key
+
+# get player with id "123" in app_1
+OneSignal::Player.get(id: "123")
+
+# get player with id "456" in app_2
+OneSignal::Player.get(id: "123", opts: {auth_key: app_2_api_key})
+```
 
 The return value of each method is a `Net::HTTPResponse`.
 
@@ -52,7 +74,7 @@ The return value of each method is a `Net::HTTPResponse`.
 
 ```ruby
 - OneSignal::Player.all(params:)
-- OneSignal::Player.csv_export(app_id:)
+- OneSignal::Player.csv_export(params:)
 - OneSignal::Player.get(id:)
 - OneSignal::Player.create(params:)
 - OneSignal::Player.create_session(id:, params:)

data/example.rb

@@ -1,309 +1,53 @@
 require 'one_signal'
 require 'dotenv'
 
+# load your keys with https://github.com/bkeepers/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']
 
+# configure OneSignal
 OneSignal::OneSignal.api_key = api_key
 OneSignal::OneSignal.user_auth_key = user_auth_key
 
-def create_player
-  params = {
-    app_id: @app_id,
-    device_type: 0,
-    identifier: @device_token,
-    tags: {
-      user_id: 'test2',
-      device_type: 'chrome'
-    }
-  }
-
-  begin 
-    response = OneSignal::Player.create(params: params)
-    puts "code : #{response.code}"
-    puts "message : #{response.message}"
-    puts "body : #{response.body}"
-    puts "id : #{JSON.parse(response.body).class}"
-    return JSON.parse(response.body)["id"]
-  rescue OneSignal::OneSignalError => e
-    puts "-- message : #{e.message}"
-    puts "-- status : #{e.http_status}"
-    puts "-- body : #{e.http_body}"
-  end
-end
-
-def create_player_session(id:)
-  params = {
-    # app_id: @app_id,
-    # device_type: 0,
-    # identifier: @device_token,
-    # tags: {
-    #   user_id: 'test2',
-    #   device_type: 'chrome'
-    # }
-    device_os: 'iPhone5,1',
-    game_version: '1.0.6',
-    timezone: -28800
-  }
-
-  begin 
-    response = OneSignal::Player.create_session(id: id, params: params)
-    puts "code : #{response.code}"
-    puts "message : #{response.message}"
-    puts "body : #{response.body}"
-  rescue OneSignal::OneSignalError => e
-    puts "-- message : #{e.message}"
-    puts "-- status : #{e.http_status}"
-    puts "-- body : #{e.http_body}"
-  end
-end
-
-def create_player_purchase(id:)
-  params = {
-    purchases: [
-      {
-        sku: 'SKU123',
-        iso: 'USD',
-        amount: '0.99'
-      }
-    ]
-  }
-
-  begin 
-    response = OneSignal::Player.create_purchase(id: id, params: params)
-    puts "code : #{response.code}"
-    puts "message : #{response.message}"
-    puts "body : #{response.body}"
-  rescue OneSignal::OneSignalError => e
-    puts "-- message : #{e.message}"
-    puts "-- status : #{e.http_status}"
-    puts "-- body : #{e.http_body}"
-  end
-end
-
-def create_player_focus(id:)
-  params = {
-    state: 'ping',
-    active_time: 60
-  }
-
-  begin 
-    response = OneSignal::Player.create_focus(id: id, params: params)
-    puts "code : #{response.code}"
-    puts "message : #{response.message}"
-    puts "body : #{response.body}"
-  rescue OneSignal::OneSignalError => e
-    puts "-- message : #{e.message}"
-    puts "-- status : #{e.http_status}"
-    puts "-- body : #{e.http_body}"
-  end
-end
-
-def update_player(id:)
-  params = {
-    app_id: @app_id,
-    device_type: 0,
-    identifier: @device_token,
-    tags: {
-      user_id: 'test2updated',
-      device_type: 'chrome'
-    }
-  }
-
-  begin 
-    response = OneSignal::Player.update(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_notifs
-  params = {
-    app_id: @app_id,
-    limit: 5,
-    offset: 0
-  }
-
-  begin 
-    response = OneSignal::Notification.all(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 get_notif(id:)
-  params = {
-    app_id: @app_id
-  }
-
-  begin 
-    response = OneSignal::Notification.get(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 notify
-  params = {
-    app_id: @app_id,
-    contents: {
-      en: 'hey buddy'
-    },
-    ios_badgeType: 'None',
-    ios_badgeCount: 1,
-    tags: [
-      {
-        key: 'user_id',
-        relation: '=',
-        value: "2"
-      },
-      { operator: 'AND' },
-      {
-        key: 'device_type',
-        relation: '=',
-        value: 'ios'
-      }
-    ]
-  }
-
-  begin 
-    response = OneSignal::Notification.create(params: params)
-    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}"
-    puts "-- status : #{e.http_status}"
-    puts "-- body : #{e.http_body}"
-  rescue OneSignal::OneSignalError => e
-    puts "--- OneSignalError  : #{e.inspect}"
-    puts "-- message : #{e.message}"
-    puts "-- status : #{e.http_status}"
-    puts "-- body : #{e.http_body}"
-  end
-end
-
-def csv_export
-  response = OneSignal::Player.csv_export(app_id: @app_id)
-  puts response.body
-end
-
-def all_players
-  response = OneSignal::Player.all(params: {app_id: @app_id, limit: 3})
-  puts response.body
+# create app
+params = {
+  name: 'test-app'
+}
+response = OneSignal::App.create(params: params)
+app_id = JSON.parse(response.body)["id"]
+puts "--- created app id: #{app_id}"
+
+# add a player
+device_token = "abcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabcdabc1"
+params = {
+  app_id: app_id,
+  device_type: 0,
+  identifier: device_token,
+  tags: {
+    user_id: '123'
+  }
+}
+response = OneSignal::Player.create(params: params)
+player_id = JSON.parse(response.body)["id"]
+puts "--- created player id: #{player_id}"
+
+# notify the player (this will fail because we haven't configured the app yet)
+params = {
+  app_id: app_id,
+  contents: {
+    en: 'hello player'
+  },
+  ios_badgeType: 'None',
+  ios_badgeCount: 1,
+  include_player_ids: [player_id]
+}
+begin
+  response = OneSignal::Notification.create(params: params)
+  notification_id = JSON.parse(response.body)["id"]
+rescue OneSignal::OneSignalError => e
+  puts "--- OneSignalError  :"
+  puts "-- message : #{e.message}"
+  puts "-- status : #{e.http_status}"
+  puts "-- body : #{e.http_body}"
 end
-
-def get_player(id:)
-  response = OneSignal::Player.get(id: id)
-  puts response.body
-end
-
-def update_notif(id:)
-  params = {
-    app_id: @app_id,
-    opened: true
-  }
-  response = OneSignal::Notification.update(id: id, params: params)
-  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' 
-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)
-# notification_id = notify
-# puts "--- notif id: #{notification_id}"
-# csv_export
-# all_players
-# get_player(id: player_id)
-# all_notifs
-# 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

@@ -2,12 +2,14 @@ module OneSignal
   
   class App < OneSignal
 
-    def self.all(params: {})
+    def self.all(params: {}, opts: {})
+      opts[:auth_key] ||= @@user_auth_key
+
       uri_string = @@base_uri
       uri_string += "/apps"
       uri = URI.parse(uri_string)
 
-      response = send_get_request(uri: uri, params: params)
+      response = send_get_request(uri: uri, params: params, opts: opts)
 
       ensure_http_status(response: response,
                          status: '200',
@@ -18,13 +20,15 @@ module OneSignal
       return response
     end
 
-    def self.get(id:)
+    def self.get(id: "", opts: {})
+      opts[:auth_key] ||= @@user_auth_key
+
       uri_string = @@base_uri
       uri_string += "/apps"
       uri_string += "/#{id}"
       uri = URI.parse(uri_string)
     
-      response = send_get_request(uri: uri, params: nil)
+      response = send_get_request(uri: uri, params: nil, opts: opts)
 
       ensure_http_status(response: response,
                          status: '200',
@@ -35,12 +39,14 @@ module OneSignal
       return response
     end
 
-    def self.create(params: {})
+    def self.create(params: {}, opts: {})
+      opts[:auth_key] ||= @@user_auth_key
+
       uri_string = @@base_uri
       uri_string += "/apps"
       uri = URI.parse(uri_string)
 
-      response = send_post_request(uri: uri, body: params)
+      response = send_post_request(uri: uri, body: params, opts: opts)
 
       ensure_http_status(response: response,
                          status: '200',
@@ -51,13 +57,15 @@ module OneSignal
       return response
     end
     
-    def self.update(id:, params: {})
+    def self.update(id: "", params: {}, opts: {})
+      opts[:auth_key] ||= @@user_auth_key
+
       uri_string = @@base_uri
       uri_string += "/apps"
       uri_string += "/#{id}"
       uri = URI.parse(uri_string)
 
-      response = send_put_request(uri: uri, body: params)
+      response = send_put_request(uri: uri, body: params, opts: opts)
 
       ensure_http_status(response: response,
                          status: '200',
@@ -68,12 +76,6 @@ module OneSignal
       return response
     end
 
-    private
-
-    def self.auth_key
-      return @@user_auth_key
-    end
-
   end
 
 end