exponent-server-sdk 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e290026a253948ce4a49f205bb465c4fdff55ca9
-  data.tar.gz: 685948552e549b3e73a661a6926566995a9f8242
+  metadata.gz: 61012c4117f2e3c9357a2b99e92ad363fb956844
+  data.tar.gz: 7c565d390d7e8d2b737c6c6a684a14c1f988ff97
 SHA512:
-  metadata.gz: abdab3e84de434c00a58110af875108e3f04cfe0df00e32d52c1d71b96673843de012c422849f108fa515730e253ad75d088d89c9895e9f8909dec6acdf7b409
-  data.tar.gz: b8140c4d97ab32205fbd9b77a51b632d92264d05d5f1e642d0fecc644f85413c12c36fe4b11f394e3a85581c9de2ed314516cedbf489b8cdcd4d2b36f088fd46
+  metadata.gz: 0a21006404a04267901a8c607dd9dfd7c154e57f93c07da8d0299c4c26a3292a13393d6bbe60a0471f66e53efa21529f7b1919a9b55b1d463203f88d2cfe594b
+  data.tar.gz: 30730a58b90f42f5cb20382abeb4affd59275d6ec78be59e511e06249ffb5324b5554d39a5e21c850ba2bc8be5cf747c2bb7e9d271eb32b247ebcae6e7d60ebc

data/.gitignore

@@ -17,3 +17,4 @@ test/version_tmp
 tmp
 *.log
 .ruby-version
+/.idea

data/README.md

@@ -3,8 +3,6 @@
 
 Use to send push notifications to Exponent Experiences from a Ruby server.
 
-If you have problems with the code in this repository, please file issues & bug reports at https://github.com/expo/expo. Thanks!
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -32,7 +30,7 @@ $ gem install exponent-server-sdk
 The push client is the preferred way.  This hits the latest version of the api.
 
 ```ruby
-exponent = Exponent::Push::Client.new
+client = Exponent::Push::Client.new
 
 messages = [{
   to: "ExponentPushToken[xxxxxxxxxxxxxxxxxxxxxx]",
@@ -44,7 +42,12 @@ messages = [{
   body: "You've got mail"
 }]
 
-exponent.publish messages
+client.publish messages
 ```
 
-The complete format of the messages can be found [here.](https://docs.expo.io/versions/v16.0.0/guides/push-notifications.html#http2-api)
+The complete format of the messages can be found [here.](https://docs.expo.io/versions/latest/index.html#http2-api)
+
+## Contributing
+
+If you have problems with the code in this repository, please file issues & bug reports. We encourage you
+to submit a solution or a failing test to reproduce your issue. Thanks!

data/lib/exponent-server-sdk.rb

@@ -8,104 +8,144 @@ module Exponent
   end
 
   module Push
-    Error = Class.new(StandardError)
 
     class Client
-
-      def initialize(new_http_client = nil)
-        @http_client = new_http_client || Typhoeus
+      def initialize(http_client      = Typhoeus,
+                     response_handler = ResponseHandler.new)
+        @http_client      = http_client
+        @response_handler = response_handler
       end
 
       def publish(messages)
-        handle_response(push_notifications(messages))
+        response_handler.handle(push_notifications(messages))
       end
 
       private
 
-      attr_reader :http_client
+      attr_reader :http_client, :response_handler
+
+      def push_notifications(messages)
+        http_client.post(
+          push_url,
+          body: messages.to_json,
+          headers: headers
+        )
+      end
+
+      def push_url
+        'https://exp.host/--/api/v2/push/send'
+      end
+
+      def headers
+        {
+          'Content-Type' => 'application/json',
+          'Accept'       => 'application/json'
+        }
+      end
+    end
+
+    class ResponseHandler
+      def initialize(error_builder = ErrorBuilder.new)
+        @error_builder = error_builder
+      end
 
-      def handle_response(response)
+      def handle(response)
         case response.code.to_s
         when /(^4|^5)/
-          raise Error, build_error_from_failure(parse_json(response))
+          raise build_error_from_failure(parse_json(response))
         else
           handle_success(parse_json(response))
         end
       end
 
+      private
+
+      attr_reader :error_builder
+
       def parse_json(response)
         JSON.parse(response.body)
       end
 
       def build_error_from_failure(response)
-        build_error_with_handling(response) do
-          extract_error_from_response(response)
-        end
+        error_builder.build_from_erroneous(response)
       end
 
-      def extract_error_from_response(response)
-        error = response.fetch('errors').first { unknown_error_format(response) }
-        "#{error.fetch('code')} -> #{error.fetch('message')}"
+      def handle_success(response)
+        extract_data(response).tap do |data|
+          validate_status(data.fetch('status'), response)
+        end
       end
 
-      def build_error_with_handling(response)
-        yield(response)
-      rescue KeyError
-        unknown_error_format(response)
+      def extract_data(response)
+        response.fetch('data').first
       end
 
-      def push_notifications(messages)
-        http_client.post(
-          push_url,
-          body: messages.to_json,
-          headers: headers
-        )
+      def validate_status(status, response)
+        raise build_error_from_success(response) unless status == 'ok'
       end
 
-      def push_url
-        'https://exp.host/--/api/v2/push/send'
+      def build_error_from_success(response)
+        error_builder.build_from_successful(response)
       end
+    end
 
-      def headers
-        {
-          'Content-Type'    => 'application/json',
-          'Accept'          => 'application/json'
-        }
+    class ErrorBuilder
+      %i[erroneous successful].each do |selector|
+        define_method(:"build_from_#{selector}") do |response|
+          with_error_handling(response) do
+            send "from_#{selector}_response", response
+          end
+        end
       end
 
-      def handle_success(response)
-        data = extract_data(response)
-        if data.fetch('status') == 'ok'
-          data
-        else
-          raise Error, build_error_from_success(response)
-        end
+      private
+
+      def with_error_handling(response)
+        yield(response)
+      rescue KeyError
+        unknown_error_format(response)
       end
 
-      def build_error_from_success(response)
-        build_error_with_handling(response) do
-          extract_error_from_success(response)
-        end
+      def from_erroneous_response(response)
+        error      = response.fetch('errors').first
+        error_name = error.fetch('code')
+        message    = error.fetch('message')
+
+        get_error_class(error_name).new(message)
       end
 
-      def extract_error_from_success(response)
-        data = extract_data(response)
+      def from_successful_response(response)
+        data    = response.fetch('data').first
         message = data.fetch('message')
 
-        if data['details']
-          "#{data.fetch('details').fetch('error')} -> #{message}"
-        else
-          "#{data.fetch('status')} -> #{message}"
-        end
+        get_error_class(data.fetch('details').fetch('error')).new(message)
       end
 
-      def extract_data(response)
-        response.fetch('data').first
+      def validate_error_name(condition)
+        condition ? yield : Exponent::Push::UnknownError
+      end
+
+      def get_error_class(error_name)
+        validate_error_name(Exponent::Push.error_names.include?(error_name)) do
+          Exponent::Push.const_get("#{error_name}Error")
+        end
       end
 
       def unknown_error_format(response)
-        "Unknown error format: #{response}"
+        Exponent::Push::UnknownError.new("Unknown error format: #{response}")
       end
     end
+
+    Error = Class.new(StandardError)
+
+    def self.error_names
+      %w[DeviceNotRegistered MessageTooBig
+         MessageRateExceeded InvalidCredentials
+         Unknown]
+    end
+
+    error_names.each do |error_name|
+      const_set "#{error_name}Error", Class.new(Error)
+    end
   end
 end

data/lib/exponent-server-sdk/version.rb

@@ -1,3 +1,3 @@
 module Exponent
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'.freeze
 end

data/test/exponent-server-sdk-test.rb

@@ -19,14 +19,14 @@ class ExponentServerSdkTest < Minitest::Test
     @mock.verify
   end
 
-  def test_publish_with_error
+  def test_publish_with_unknown_error
     @response_mock.expect(:code, 400)
     @response_mock.expect(:body, error_body.to_json)
-    message = 'INTERNAL_SERVER_ERROR -> An unknown error occurred.'
+    message = 'An unknown error occurred.'
 
     @mock.expect(:post, @response_mock, client_args)
 
-    exception = assert_raises Exponent::Push::Error do
+    exception = assert_raises Exponent::Push::UnknownError do
       @exponent.publish(messages)
     end
 
@@ -35,14 +35,14 @@ class ExponentServerSdkTest < Minitest::Test
     @mock.verify
   end
 
-  def test_publish_with_success_and_errors
+  def test_publish_with_device_not_registered_error
     @response_mock.expect(:code, 200)
-    @response_mock.expect(:body, success_with_error_body.to_json)
-    message = 'DeviceNotRegistered -> "ExponentPushToken[42]" is not a registered push notification recipient'
+    @response_mock.expect(:body, not_registered_device_error_body.to_json)
+    message = '"ExponentPushToken[42]" is not a registered push notification recipient'
 
     @mock.expect(:post, @response_mock, client_args)
 
-    exception = assert_raises Exponent::Push::Error do
+    exception = assert_raises Exponent::Push::DeviceNotRegisteredError do
       @exponent.publish(messages)
     end
 
@@ -51,14 +51,14 @@ class ExponentServerSdkTest < Minitest::Test
     @mock.verify
   end
 
-  def test_publish_with_success_and_apn_error
+  def test_publish_with_message_too_big_error
     @response_mock.expect(:code, 200)
-    @response_mock.expect(:body, success_with_apn_error_body.to_json)
-    message = 'error -> Could not find APNs credentials for you (your_app). Check whether you are trying to send a notification to a detached app.'
+    @response_mock.expect(:body, message_too_big_error_body.to_json)
+    message = 'Message too big'
 
     @mock.expect(:post, @response_mock, client_args)
 
-    exception = assert_raises Exponent::Push::Error do
+    exception = assert_raises Exponent::Push::MessageTooBigError do
       @exponent.publish(messages)
     end
 
@@ -67,6 +67,53 @@ class ExponentServerSdkTest < Minitest::Test
     @mock.verify
   end
 
+  def test_publish_with_message_rate_exceeded_error
+    @response_mock.expect(:code, 200)
+    @response_mock.expect(:body, message_rate_exceeded_error_body.to_json)
+    message = 'Message rate exceeded'
+
+    @mock.expect(:post, @response_mock, client_args)
+
+    exception = assert_raises Exponent::Push::MessageRateExceededError do
+      @exponent.publish(messages)
+    end
+
+    assert_equal(message, exception.message)
+
+    @mock.verify
+  end
+
+  def test_publish_with_invalid_credentials_error
+    @response_mock.expect(:code, 200)
+    @response_mock.expect(:body, invalid_credentials_error_body.to_json)
+    message = 'Invalid credentials'
+
+    @mock.expect(:post, @response_mock, client_args)
+
+    exception = assert_raises Exponent::Push::InvalidCredentialsError do
+      @exponent.publish(messages)
+    end
+
+    assert_equal(message, exception.message)
+
+    @mock.verify
+  end
+
+  def test_publish_with_apn_error
+    @response_mock.expect(:code, 200)
+    @response_mock.expect(:body, apn_error_body.to_json)
+
+    @mock.expect(:post, @response_mock, client_args)
+
+    exception = assert_raises Exponent::Push::UnknownError do
+      @exponent.publish(messages)
+    end
+
+    assert_match(/Unknown error format/, exception.message)
+
+    @mock.verify
+  end
+
   private
 
   def success_body
@@ -82,17 +129,26 @@ class ExponentServerSdkTest < Minitest::Test
     }
   end
 
-  def success_with_error_body
-    {
-      'data' => [{
-        'status'  => 'error',
-        'message' => '"ExponentPushToken[42]" is not a registered push notification recipient',
-        'details' => { 'error' => 'DeviceNotRegistered' }
-      }]
-    }
+  def message_too_big_error_body
+    build_error_body('MessageTooBig', 'Message too big')
   end
 
-  def success_with_apn_error_body
+  def not_registered_device_error_body
+    build_error_body(
+      'DeviceNotRegistered',
+      '"ExponentPushToken[42]" is not a registered push notification recipient'
+    )
+  end
+
+  def message_rate_exceeded_error_body
+    build_error_body('MessageRateExceeded', 'Message rate exceeded')
+  end
+
+  def invalid_credentials_error_body
+    build_error_body('InvalidCredentials', 'Invalid credentials')
+  end
+
+  def apn_error_body
     {
       'data' => [{
         'status' => 'error',
@@ -126,4 +182,14 @@ class ExponentServerSdkTest < Minitest::Test
       body: "You've got mail"
     }]
   end
+
+  def build_error_body(error_code, message)
+    {
+      'data' => [{
+        'status' => 'error',
+        'message' => message,
+        'details' => { 'error' => error_code }
+      }]
+    }
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exponent-server-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Jesse Ruder
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-26 00:00:00.000000000 Z
+date: 2018-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus