one_signal 1.0.0 → 1.2.2

data/README.md

@@ -1,6 +1,8 @@
-# OneSignal Ruby bindings [![Build Status](https://travis-ci.org/tbalthazar/onesignal-ruby.svg?branch=master)](https://travis-ci.org/tbalthazar/onesignal-ruby)
+# 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
 
@@ -10,23 +12,26 @@ gem install one_signal
 
 ## Development
 
+Run `bin/setup` to install dependencies and set your API keys.
+
 Run the tests
 
 ```
 bundle exec rake
 ```
 
+You can also run `bin/console` for an interactive prompt that will allow you to experiment with authenticated library methods.
+
 ## Basic usage
 
-See basic examples in [example.rb](/example.rb).
+See some 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`
+- run `bin/setup` to set your API keys
+- then 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
@@ -39,7 +44,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`.
 
@@ -56,13 +77,14 @@ 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:)
 - OneSignal::Player.create_purchase(id:, params:)
 - OneSignal::Player.create_focus(id:, params:)
 - OneSignal::Player.update(id:, params:)
+- OneSignal::Player.delete(id:, params:)
 ```
 
 ### Notifications
@@ -85,4 +107,4 @@ They are [listed here](https://github.com/tbalthazar/onesignal-ruby/graphs/contr
 
 ## License
 
-Please see [LICENSE](/LICENSE) for licensing details. 
+Please see [LICENSE](/LICENSE) for licensing details.

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dotenv/load"
+require "one_signal"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+OneSignal::OneSignal.user_auth_key = ENV['USER_AUTH_KEY']
+OneSignal::OneSignal.api_key = ENV['API_KEY']
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+echo "Enter your OneSignal credentials."
+echo "For dealing with Apps, you'll need a user auth key."
+read -p 'User Auth Key: ' user_auth_key
+echo "For dealing with Players and Notifications, you'll need an API key."
+read -p 'API Key: ' api_key
+
+cp .env.example .env
+
+sed -i '' -e "s/YOUR_USER_AUTH_KEY_HERE/$user_auth_key/g" .env
+sed -i '' -e "s/YOUR_API_KEY_HERE/$api_key/g" .env
+
+echo "Done."

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

data/lib/one_signal/notification.rb

@@ -2,12 +2,14 @@ module OneSignal
 
   class Notification < OneSignal
 
-    def self.all(params: {})
+    def self.all(params: {}, opts: {})
+      opts[:auth_key] ||= @@api_key
+
       uri_string = @@base_uri
       uri_string += "/notifications"
       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:, params:)
+    def self.get(id: "", params: {}, opts: {})
+      opts[:auth_key] ||= @@api_key
+
       uri_string = @@base_uri
       uri_string += "/notifications"
       uri_string += "/#{id}"
       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',
@@ -35,12 +39,14 @@ module OneSignal
       return response
     end
 
-    def self.create(params: {})
+    def self.create(params: {}, opts: {})
+      opts[:auth_key] ||= @@api_key
+      
       uri_string = @@base_uri
       uri_string += "/notifications"
       uri = URI.parse(uri_string)
-      
-      response = send_post_request(uri: uri, body: params)
+
+      response = send_post_request(uri: uri, body: params, opts: opts)
 
       if response.code != '200'
         handle_error(uri: uri, params: params, response: response)
@@ -49,13 +55,15 @@ module OneSignal
       return response
     end
 
-    def self.update(id:, params: {})
+    def self.update(id: "", params: {}, opts: {})
+      opts[:auth_key] ||= @@api_key
+
       uri_string = @@base_uri
       uri_string += "/notifications"
       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',
@@ -66,13 +74,15 @@ module OneSignal
       return response
     end
 
-    def self.delete(id:, params:)
+    def self.delete(id: "", params: {}, opts: {})
+      opts[:auth_key] ||= @@api_key
+
       uri_string = @@base_uri
       uri_string += "/notifications"
       uri_string += "/#{id}"
       uri = URI.parse(uri_string)
     
-      response = send_delete_request(uri: uri, params: params)
+      response = send_delete_request(uri: uri, params: params, opts: opts)
 
       ensure_http_status(response: response,
                          status: '200',
@@ -85,21 +95,26 @@ module OneSignal
 
     private
 
-    def self.handle_error(uri:, params:, response:)
+    def self.handle_error(uri: nil, params: {}, response: nil)
       msg = "Create Notification error - uri: #{uri} params: #{params}"
+      unless response.nil?
+        code = response.code
+        body = response.body
+      end
       if is_no_recipients_error(response: response)
         raise NoRecipientsError.new(message: msg,
-                                    http_status: response.code,
-                                    http_body: response.body)
+                                    http_status: code,
+                                    http_body: body)
       else
         raise OneSignalError.new(message: msg,
-                                 http_status: response.code,
-                                 http_body: response.body)
+                                 http_status: code,
+                                 http_body: body)
       end
     end
 
-    def self.is_no_recipients_error(response:)
-      return false if response.code != '400' ||
+    def self.is_no_recipients_error(response: nil)
+      return false if response.nil? ||
+                      response.code != '400' ||
                       response.body.nil?
 
       body = JSON.parse(response.body)

data/lib/one_signal/one_signal.rb

@@ -43,7 +43,9 @@ module OneSignal
       @@read_timeout
     end
 
-    def self.http_object(uri:)
+    def self.http_object(uri: nil)
+      return nil if uri.nil?
+
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = uri.scheme == 'https'
       http.open_timeout = @@open_timeout
@@ -51,49 +53,61 @@ module OneSignal
       return http
     end
 
-    def self.send_post_request(uri:, body:)
+    def self.send_post_request(uri: nil, body: nil, opts: {})
+      return nil if uri.nil?
+
       request = Net::HTTP::Post.new(uri.request_uri)
       request.body = body.to_json
-      request = request_with_headers(request: request)
+      request = request_with_headers(request: request, opts: opts)
       
       http = http_object(uri: uri)
 
-      response = http.request(request)
+      return http.request(request)
     end
 
-    def self.send_delete_request(uri:, params: {})
+    def self.send_delete_request(uri: nil, params: {}, opts: {})
+      return nil if uri.nil?
+
       uri.query = URI.encode_www_form(params) unless params.nil?
       request = Net::HTTP::Delete.new(uri.request_uri)
-      request = request_with_headers(request: request)
+      request = request_with_headers(request: request, opts: opts)
       
       http = http_object(uri: uri)
 
-      response = http.request(request)
+      return http.request(request)
     end
 
-    def self.send_put_request(uri:, body:)
+    def self.send_put_request(uri: nil, body: nil, opts: {})
+      return nil if uri.nil?
+
       request = Net::HTTP::Put.new(uri.request_uri)
       request.body = body.to_json
-      request = request_with_headers(request: request)
+      request = request_with_headers(request: request, opts: opts)
       
       http = http_object(uri: uri)
 
-      response = http.request(request)
+      return http.request(request)
     end
 
-    def self.send_get_request(uri:, params: {})
+    def self.send_get_request(uri: nil, params: {}, opts: {})
+      return nil if uri.nil?
+
       uri.query = URI.encode_www_form(params) unless params.nil?
       request = Net::HTTP::Get.new(uri.request_uri)
-      request = request_with_headers(request: request)
+      request = request_with_headers(request: request, opts: opts)
       
       http = http_object(uri: uri)
 
-      response = http.request(request)
+      return http.request(request)
     end
 
     private
 
-    def self.ensure_http_status(response:, status:, method_name:, uri:, params:)
+    def self.ensure_http_status(response: nil, status: nil, method_name: "", uri: "", params: {})
+      if response.nil? || status.nil?
+        raise OneSignalError.new(message: "Please provide a response (#{response}) and a status (#{status})")
+      end
+
       if response.code != status.to_s
         msg = "#{self.name}##{method_name} error - uri: #{uri} params: #{params}"
         raise OneSignalError.new(message: msg,
@@ -102,16 +116,14 @@ module OneSignal
       end
     end
 
-    def self.request_with_headers(request:)
+    def self.request_with_headers(request: nil, opts: {})
+      return nil if request.nil?
+
       request.add_field("Content-Type", "application/json")
-      request.add_field("Authorization", "Basic #{self.auth_key}")
+      request.add_field("Authorization", "Basic #{opts[:auth_key]}")
       return request
     end
 
-    def self.auth_key
-      return @@api_key
-    end
-
   end
 
 end

data/lib/one_signal/player.rb

@@ -2,12 +2,14 @@ module OneSignal
 
   class Player < OneSignal
 
-    def self.csv_export(params:)
+    def self.csv_export(params: {}, opts: {})
+      opts[:auth_key] ||= @@api_key
+
       uri_string = @@base_uri
       uri_string += "/players/csv_export"
       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',
@@ -18,12 +20,14 @@ module OneSignal
       return response
     end
 
-    def self.all(params: {})
+    def self.all(params: {}, opts: {})
+      opts[:auth_key] ||= @@api_key
+
       uri_string = @@base_uri
       uri_string += "/players"
       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',
@@ -34,13 +38,15 @@ module OneSignal
       return response
     end
 
-    def self.get(id:)
+    def self.get(id: "", opts: {})
+      opts[:auth_key] ||= @@api_key
+
       uri_string = @@base_uri
       uri_string += "/players"
       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',
@@ -51,12 +57,14 @@ module OneSignal
       return response
     end
 
-    def self.create(params: {})
+    def self.create(params: {}, opts: {})
+      opts[:auth_key] ||= @@api_key
+
       uri_string = @@base_uri
       uri_string += "/players"
       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',
@@ -67,14 +75,16 @@ module OneSignal
       return response
     end
 
-    def self.create_session(id:, params: {})
+    def self.create_session(id: "", params: {}, opts: {})
+      opts[:auth_key] ||= @@api_key
+
       uri_string = @@base_uri
       uri_string += "/players"
       uri_string += "/#{id}"
       uri_string += "/on_session"
       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',
@@ -85,14 +95,16 @@ module OneSignal
       return response
     end
 
-    def self.create_purchase(id:, params: {})
+    def self.create_purchase(id: "", params: {}, opts: {})
+      opts[:auth_key] ||= @@api_key
+
       uri_string = @@base_uri
       uri_string += "/players"
       uri_string += "/#{id}"
       uri_string += "/on_purchase"
       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',
@@ -103,14 +115,16 @@ module OneSignal
       return response
     end
 
-    def self.create_focus(id:, params: {})
+    def self.create_focus(id: "", params: {}, opts: {})
+      opts[:auth_key] ||= @@api_key
+
       uri_string = @@base_uri
       uri_string += "/players"
       uri_string += "/#{id}"
       uri_string += "/on_focus"
       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',
@@ -121,13 +135,15 @@ module OneSignal
       return response
     end
 
-    def self.update(id:, params: {})
+    def self.update(id: "", params: {}, opts: {})
+      opts[:auth_key] ||= @@api_key
+
       uri_string = @@base_uri
       uri_string += "/players"
       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',
@@ -138,6 +154,25 @@ module OneSignal
       return response
     end
 
+    def self.delete(id: "", params: {}, opts: {})
+      opts[:auth_key] ||= @@api_key
+
+      uri_string = @@base_uri
+      uri_string += "/players"
+      uri_string += "/#{id}"
+      uri = URI.parse(uri_string)
+
+      response = send_delete_request(uri: uri, params: params, opts: opts)
+
+      ensure_http_status(response: response,
+                         status: '200',
+                         method_name: 'Delete',
+                         uri: uri,
+                         params: nil)
+
+      return response
+    end
+
   end
 
 end