one_signal 0.0.14 → 1.2.1

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(app_id:)
+    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: {app_id: app_id})
+      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: "", 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: nil, opts: opts)
+
+      ensure_http_status(response: response,
+                         status: '200',
+                         method_name: 'Delete',
+                         uri: uri,
+                         params: nil)
+
+      return response
+    end
+
   end
 
 end

data/lib/one_signal/version.rb

@@ -1,3 +1,3 @@
 module OneSignal
-  VERSION = "0.0.14"
+  VERSION = '1.2.1'
 end

data/one_signal.gemspec

@@ -1,9 +1,8 @@
 require File.expand_path('lib/one_signal/version')
 
 Gem::Specification.new do |s|
-  s.required_ruby_version = '>= 2.1.0'
-  s.add_runtime_dependency 'json', '~> 1.8'
-  s.add_development_dependency 'rake', '~> 10.4'
+  s.required_ruby_version = '>= 2.0.0'
+  s.add_development_dependency 'rake', '~> 12.0'
   s.add_development_dependency 'mocha', '~> 1.1'
   s.add_development_dependency 'dotenv', '~> 2.0'
   s.add_development_dependency 'minitest', '~> 5.8'

data/test/app_test.rb

@@ -15,40 +15,81 @@ class AppTest < MiniTest::Test
       widget: "acme"
     }
 
-    @user_auth_key = "fake user auth key"
-    OneSignal::OneSignal.user_auth_key  = @user_auth_key 
+    @user_auth_key = "fake user auth key 123"
+    @user_auth_key_2 = "fake user auth key 456"
+    @opts = {
+      key1: "value1",
+      key2: "vaue2",
+      auth_key: @user_auth_key_2
+    }
+    @default_opts = {
+      auth_key: @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)
+                        .with(uri: @all_uri, params: @params, opts: @default_opts)
                         .returns(response)
     assert_equal response, OneSignal::App.all(params: @params)
   end
 
+  def test_all_with_auth_key
+    response = mock_response_ok
+    OneSignal::OneSignal.expects(:send_get_request)
+                        .with(uri: @all_uri, params: @params, opts: @opts)
+                        .returns(response)
+    assert_equal response, OneSignal::App.all(params: @params, opts: @opts)
+  end
+
   def test_get
     response = mock_response_ok
     OneSignal::OneSignal.expects(:send_get_request)
-                        .with(uri: @get_uri, params: nil)
+                        .with(uri: @get_uri, params: nil, opts: @default_opts)
                         .returns(response)
     assert_equal response, OneSignal::App.get(id: @app_id)
   end
 
+  def test_get_with_auth_key
+    response = mock_response_ok
+    OneSignal::OneSignal.expects(:send_get_request)
+                        .with(uri: @get_uri, params: nil, opts: @opts)
+                        .returns(response)
+    assert_equal response, OneSignal::App.get(id: @app_id, opts: @opts)
+  end
+
   def test_create
     response = mock_response_ok
     OneSignal::OneSignal.expects(:send_post_request)
-                        .with(uri: @create_uri, body: @params)
+                        .with(uri: @create_uri, body: @params, opts: @default_opts)
                         .returns(response)
     assert_equal response, OneSignal::App.create(params: @params)
   end
 
+  def test_create_with_auth_key
+    response = mock_response_ok
+    OneSignal::OneSignal.expects(:send_post_request)
+                        .with(uri: @create_uri, body: @params, opts: @opts)
+                        .returns(response)
+    assert_equal response, OneSignal::App.create(params: @params, opts: @opts)
+  end
+
   def test_update
     response = mock_response_ok
     OneSignal::OneSignal.expects(:send_put_request)
-                        .with(uri: @update_uri, body: @params)
+                        .with(uri: @update_uri, body: @params, opts: @default_opts)
                         .returns(response)
     assert_equal response, OneSignal::App.update(id: @app_id, params: @params)
   end
 
+  def test_update_with_auth_key
+    response = mock_response_ok
+    OneSignal::OneSignal.expects(:send_put_request)
+                        .with(uri: @update_uri, body: @params, opts: @opts)
+                        .returns(response)
+    assert_equal response, OneSignal::App.update(id: @app_id, params: @params, opts: @opts)
+  end
+
 end