exponent-server-sdk 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 937bd4d5dcc76c2a2f25ffb7add009d83c70f9b5
-  data.tar.gz: 2548e5f9f910985944b64556f650e8eea7f40730
+  metadata.gz: 88ec6ffe5bd4602818f88d05b6ce235631cd4951
+  data.tar.gz: b5cf4200640d97ca8136dbe2788c60b1a28d1531
 SHA512:
-  metadata.gz: 27e84460a044e4ffa79ac433ef2e1c77a19bd6048232b837ce4443374332e0a7bb3154e198b7987c910ed6d2e79b35637f7946d4036ef981b041f9ddb8c23317
-  data.tar.gz: 0b0b4926c5a3a426192cc29f754cb7564106a4f695041ab7f89e45dcb7fa02a316d3e74be8f7aaae5068051b79eb42515ed5b39e0ec0620cceaedb941554dd14
+  metadata.gz: 51937e0397c547c37f7a6da6dc0b94897cf578ef47ca4271f5ee2b15c216cea04a9071893cd45e2a3ca2f729feffa60bc1b0c893640fdd72a15d4e8605caa04f
+  data.tar.gz: 15b4e65065e9526a407b9f274f7bb9d56427cd2ee7dd842962d1be4f0ff9812f3e65d9f6c4e6bad8b9ef45047543a6ee401ef7a0698deece9cb0de44da90ffec

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+*.log
+.ruby-version

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.3.0
+  - 2.2.0
+  - 2.1.0
+  - 2.0.0

data/README.md

@@ -1,17 +1,50 @@
 # Exponent Server SDK Ruby
+[![Build Status](https://travis-ci.org/expo/exponent-server-sdk-ruby.svg?branch=master)](https://travis-ci.org/expo/exponent-server-sdk-ruby)
 
 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:
 
-    gem 'exponent-server-sdk'
+```ruby
+gem 'exponent-server-sdk'
+```
 
 And then execute:
 
-    $ bundle
+```shell
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install exponent-server-sdk
+```shell
+$ gem install exponent-server-sdk
+```
+
+## Usage
+
+### Client
+
+The push client is the preferred way.  This hits the latest version of the api.
+
+```ruby
+exponent = Exponent::Push::Client.new
+
+messages = [{
+  to: "ExponentPushToken[xxxxxxxxxxxxxxxxxxxxxx]",
+  sound: "default",
+  body: "Hello world!"
+}, {
+  to: "ExponentPushToken[yyyyyyyyyyyyyyyyyyyyyy]",
+  badge: 1,
+  body: "You've got mail"
+}]
+
+exponent.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)

data/Rakefile

@@ -1 +1,10 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*-test.rb']
+end
+
+task :default => :test

data/exponent-server-sdk.gemspec

@@ -4,22 +4,23 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'exponent-server-sdk/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "exponent-server-sdk"
+  spec.name          = 'exponent-server-sdk'
   spec.version       = Exponent::VERSION
-  spec.authors       = ["Jesse Ruder"]
-  spec.email         = ["jesse@sixfivezero.net"]
+  spec.authors       = ['Jesse Ruder', 'Pablo Gomez']
+  spec.email         = ['jesse@sixfivezero.net', 'pablonahuelgomez@gmail.com']
   spec.summary       = %q{Exponent Server SDK}
   spec.description   = %q{Exponent Server SDK}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.homepage      = ''
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "httparty"
+  spec.add_dependency 'typhoeus'
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
 end

data/lib/exponent-server-sdk.rb

@@ -1,32 +1,111 @@
 require 'exponent-server-sdk/version'
-
-require 'httparty'
+require 'typhoeus'
+require 'json'
 
 module Exponent
+  def self.is_exponent_push_token?(token)
+    token.start_with?('ExponentPushToken')
+  end
+
   module Push
-    def self.is_exponent_push_token?(token)
-      token.start_with?('ExponentPushToken')
-    end
+    Error = Class.new(StandardError)
 
     class Client
-      def publish options
-        data = options.delete(:data)
-        response = HTTParty.post('https://exp.host/--/api/notify/' + ERB::Util.url_encode([options].to_json),
-          :body => data.to_json,
-          :headers => {
-            'Content-Type' => 'application/json'
-          }
+
+      def initialize(new_http_client = nil)
+        @http_client = new_http_client || Typhoeus
+      end
+
+      def publish(messages)
+        handle_response(push_notifications(messages))
+      end
+
+      private
+
+      attr_reader :http_client
+
+      def handle_response(response)
+        case response.code.to_s
+        when /(^4|^5)/
+          raise Error, build_error_from_failure(parse_json(response))
+        else
+          handle_success(parse_json(response))
+        end
+      end
+
+      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
+      end
+
+      def extract_error_from_response(response)
+        error = response.fetch('errors').first { unknown_error_format(response) }
+        "#{error.fetch('code')} -> #{error.fetch('message')}"
+      end
+
+      def build_error_with_handling(response)
+        yield(response)
+      rescue KeyError
+        unknown_error_format(response)
+      end
+
+      def push_notifications(messages)
+        http_client.post(
+          push_url,
+          body: messages.to_json,
+          headers: headers
         )
+      end
 
-        case response.code
-          when 400
-            raise Exponent::Push::Errors::InvalidPushTokenError
+      def push_url
+        'https://exp.host/--/api/v2/push/send'
+      end
+
+      def headers
+        {
+          'Content-Type'    => 'application/json',
+          'Accept'          => 'application/json',
+          'Accept-Encoding' => 'gzip, deflate'
+        }
+      end
+
+      def handle_success(response)
+        data = extract_data(response)
+        if data.fetch('status') == 'ok'
+          data
+        else
+          raise Error, build_error_from_success(response)
         end
       end
-    end
 
-    module Errors
-      class InvalidPushTokenError < StandardError
+      def build_error_from_success(response)
+        build_error_with_handling(response) do
+          extract_error_from_success(response)
+        end
+      end
+
+      def extract_error_from_success(response)
+        data = extract_data(response)
+        message = data.fetch('message')
+
+        if data['details']
+          "#{data.fetch('details').fetch('error')} -> #{message}"
+        else
+          "#{data.fetch('status')} -> #{message}"
+        end
+      end
+
+      def extract_data(response)
+        response.fetch('data').first
+      end
+
+      def unknown_error_format(response)
+        "Unknown error format: #{response}"
       end
     end
   end

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

@@ -1,3 +1,3 @@
 module Exponent
-  VERSION = "0.0.2"
+  VERSION = '0.0.3'
 end

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

@@ -0,0 +1,130 @@
+require 'minitest/autorun'
+require 'exponent-server-sdk'
+
+class ExponentServerSdkTest < Minitest::Test
+  def setup
+    @mock = MiniTest::Mock.new
+    @response_mock = MiniTest::Mock.new
+    @exponent = Exponent::Push::Client.new(@mock)
+  end
+
+  def test_publish_with_success
+    @response_mock.expect(:code, 200)
+    @response_mock.expect(:body, success_body.to_json)
+
+    @mock.expect(:post, @response_mock, client_args)
+
+    @exponent.publish(messages)
+
+    @mock.verify
+  end
+
+  def test_publish_with_error
+    @response_mock.expect(:code, 400)
+    @response_mock.expect(:body, error_body.to_json)
+    message = 'INTERNAL_SERVER_ERROR -> An unknown error occurred.'
+
+    @mock.expect(:post, @response_mock, client_args)
+
+    exception = assert_raises Exponent::Push::Error do
+      @exponent.publish(messages)
+    end
+
+    assert_equal(message, exception.message)
+
+    @mock.verify
+  end
+
+  def test_publish_with_success_and_errors
+    @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'
+
+    @mock.expect(:post, @response_mock, client_args)
+
+    exception = assert_raises Exponent::Push::Error do
+      @exponent.publish(messages)
+    end
+
+    assert_equal(message, exception.message)
+
+    @mock.verify
+  end
+
+  def test_publish_with_success_and_apn_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.'
+
+    @mock.expect(:post, @response_mock, client_args)
+
+    exception = assert_raises Exponent::Push::Error do
+      @exponent.publish(messages)
+    end
+
+    assert_equal(message, exception.message)
+
+    @mock.verify
+  end
+
+  private
+
+  def success_body
+    { 'data' => [{ 'status' => 'ok' }] }
+  end
+
+  def error_body
+    {
+      'errors' => [{
+        'code' => 'INTERNAL_SERVER_ERROR',
+        'message' => 'An unknown error occurred.'
+      }]
+    }
+  end
+
+  def success_with_error_body
+    {
+      'data' => [{
+        'status'  => 'error',
+        'message' => '"ExponentPushToken[42]" is not a registered push notification recipient',
+        'details' => { 'error' => 'DeviceNotRegistered' }
+      }]
+    }
+  end
+
+  def success_with_apn_error_body
+    {
+      'data' => [{
+        'status' => 'error',
+        'message' =>
+          'Could not find APNs credentials for you (your_app). Check whether you are trying to send a notification to a detached app.'
+      }]
+    }
+  end
+
+  def client_args
+    [
+      'https://exp.host/--/api/v2/push/send',
+      {
+        body: messages.to_json,
+        headers: {
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json',
+          'Accept-Encoding' => 'gzip, deflate'
+        }
+      }
+    ]
+  end
+
+  def messages
+    [{
+      to: 'ExponentPushToken[xxxxxxxxxxxxxxxxxxxxxx]',
+      sound: 'default',
+      body: 'Hello world!'
+    }, {
+      to: 'ExponentPushToken[yyyyyyyyyyyyyyyyyyyyyy]',
+      badge: 1,
+      body: "You've got mail"
+    }]
+  end
+end

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: exponent-server-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jesse Ruder
+- Pablo Gomez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-20 00:00:00.000000000 Z
+date: 2018-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -28,16 +29,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,14 +53,30 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Exponent Server SDK
 email:
 - jesse@sixfivezero.net
+- pablonahuelgomez@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -68,6 +85,7 @@ files:
 - lib/exponent-server-sdk.rb
 - lib/exponent-server-sdk/version.rb
 - manual-testing.txt
+- test/exponent-server-sdk-test.rb
 homepage: ''
 licenses:
 - MIT
@@ -88,8 +106,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Exponent Server SDK
-test_files: []
+test_files:
+- test/exponent-server-sdk-test.rb