andpush 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5906e62af1538446835164d870e6ad5208c273b8
-  data.tar.gz: 152292ea0800e0ea8b8ea5646fde079488f9a29e
+SHA256:
+  metadata.gz: d034631f3463f8f106814846df48e8c5478b3b3fcc93abca065d8119bfa1fec7
+  data.tar.gz: ef0c8920fd6c3f67dc530defb3862eee3fc6e72c6b0b66a0fc8460e38cfd7ae8
 SHA512:
-  metadata.gz: 1388a7d47b11a593d3bf831be5f95a302aae5abae28c4edde8823575e263f89d7945089cf288d8ada21f88f3c39bfbcbf5089849b2edefa4940a05856b48ddc8
-  data.tar.gz: 8466478c030432ceeb73bdc59a2314bd5a09a964ccd355d92badc2792bdc76beb77a07ad9f9dbec3664e31956d11a88220878bdb3816dcf837caecab620001c3
+  metadata.gz: 3c6c4d56ef8135fee5385d3e94a42e017c9f79f0ea0263a73fb3da70dbae1c4f5c53129c711193cb3b1411335692014723dae8d75ed2107b4e8012d86b93b02c
+  data.tar.gz: 121b05f40b5c143a73d495eccbe4469388d41ef5e0d6668671dbfdf0f2d1673cf4e2239e39b4146ffaceab5e72b7ac83bd59dea3ee5ff51fa4aff2e701dad09d

data/.travis.yml

@@ -3,16 +3,21 @@ cache:    bundler
 script:   bundle exec rake test
 sudo:     false
 
+before_install:
+  - gem update --system
+  - gem pristine bundler
+
 rvm:
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
   - ruby-head
-  - jruby-9.1.10.0
+  - jruby-9.1.16.0
   - jruby-head
 
 matrix:
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby-9.1.10.0
+    - rvm: jruby-9.1.16.0
     - rvm: jruby-head

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## [v0.1.0: First release](https://github.com/yuki24/andpush/tree/v0.1.0)
+
+_<sup>released on 2017-06-03 02:04:28 UTC</sup>_
+

data/README.md

@@ -1,6 +1,10 @@
-# Andpush
+# Andpush [![Build Status](https://travis-ci.org/yuki24/andpush.svg?branch=master)](https://travis-ci.org/yuki24/andpush)
 
-Andpush is an HTTP client for FCM (Firebase Cloud Messaging). It implements [Firebase Cloud Messaging HTTP Protocol](https://firebase.google.com/docs/cloud-messaging/http-server-ref).
+Andpush is an HTTP client for FCM (Firebase Cloud Messaging). It implements [the Firebase Cloud Messaging HTTP Protocol](https://firebase.google.com/docs/cloud-messaging/http-server-ref).
+
+The `andpush` gem performs **about 3.7x faster** than [the fcm gem](https://github.com/spacialdb/fcm) in a single-threaded environment. In a multi-threaded environment, it could perform **10x or even faster!**
+
+**If you are thining to send push notifications from Rails, consider using the [pushing gem](https://github.com/yuki24/pushing), a push notification framework that does not hurt.**
 
 ## Installation
 
@@ -10,10 +14,6 @@ Add this line to your application's Gemfile:
 gem 'andpush'
 ```
 
-And then execute:
-
-    $ bundle
-
 Or install it yourself as:
 
     $ gem install andpush
@@ -28,8 +28,20 @@ require 'andpush'
 server_key   = "..." # Your server key
 device_token = "..." # The device token of the device you'd like to push a message to
 
-client   = Andpush.build(server_key)
-response = client.push(to: device_token, notification: { title: "Update", body: "Your weekly summary is ready" }, data: { extra: "data" })
+client  = Andpush.new(server_key, pool_size: 25)
+payload = {
+  to: device_token,
+  notification: {
+    title: "Update",
+    body: "Your weekly summary is ready"
+  },
+  data: { extra: "data" }
+}
+
+response = client.push(payload)
+
+headers = response.headers
+headers['Retry-After'] # => returns 'Retry-After'
 
 json = response.json
 json[:canonical_ids] # => 0
@@ -42,6 +54,38 @@ result[:error]           # => nil, "InvalidRegistration" or something else
 result[:registration_id] # => nil
 ```
 
+### Topic Messaging:
+
+```ruby
+topic   = "/topics/foo-bar"
+payload = {
+  to: topic,
+  data: {
+    message: "This is a Firebase Cloud Messaging Topic Message!",
+  }
+}
+
+response = client.push(payload) # => sends a message to the topic
+```
+
+## Performance
+
+The andpush gem uses [HTTP persistent connections](https://en.wikipedia.org/wiki/HTTP_persistent_connection) to improve performance. This is done by [the net-http-persistent gem](https://github.com/drbrain/net-http-persistent). [A simple benchmark](https://gist.github.com/yuki24/e0db97e887b8b6eb1932c41b4cea4a99) shows that the andpush gem performs at least 3x faster than the fcm gem:
+
+```sh
+$ ruby bench.rb
+Warming up --------------------------------------
+             andpush     2.000  i/100ms
+                 fcm     1.000  i/100ms
+Calculating -------------------------------------
+             andpush     28.009  (± 7.1%) i/s -    140.000  in   5.019399s
+                 fcm      7.452  (±13.4%) i/s -     37.000  in   5.023139s
+
+Comparison:
+             andpush:       28.0 i/s
+                 fcm:        7.5 i/s - 3.76x  slower
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/yuki24/andpush. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/andpush.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test)/}) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'net-http-persistent'
+  spec.add_dependency 'net-http-persistent', '>= 3.0.0'
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/lib/andpush.rb

@@ -6,10 +6,13 @@ require 'andpush/client'
 module Andpush
   DOMAIN = 'https://fcm.googleapis.com'.freeze
 
-  def self.build(server_key, domain: nil, request_handler: ConnectionPool.new)
-    ::Andpush::Client
-      .new(domain || DOMAIN, request_handler: request_handler)
-      .register_interceptor(Authenticator.new(server_key))
+  class << self
+    def build(server_key, domain: nil, name: nil, proxy: nil, pool_size: Net::HTTP::Persistent::DEFAULT_POOL_SIZE)
+      ::Andpush::Client
+        .new(domain || DOMAIN, request_handler: ConnectionPool.new(name: name, proxy: proxy, pool_size: pool_size))
+        .register_interceptor(Authenticator.new(server_key))
+    end
+    alias new build
   end
 
   class Authenticator

data/lib/andpush/version.rb

@@ -1,3 +1,3 @@
 module Andpush
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: andpush
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yuki Nishijima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-29 00:00:00.000000000 Z
+date: 2018-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -110,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: FCM HTTP client