pusher 1.4.2 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81a153328f0e5452bcdd87e9cd09339464a26679566f1d14f087fee9a29a69b2
-  data.tar.gz: f5e282e3a9f0d60d441da0ef023073cefa1d4ebd2ada5b7fcb82a258a53c402a
+  metadata.gz: b567f2d8e33ab63ee101f1d463ee826ef9deb173509724a0df6996b73fac1249
+  data.tar.gz: 9e0e443c7769c8520be0f9f72b2db5d95c9a9f221f0221df48b0eee0267f60a1
 SHA512:
-  metadata.gz: 87ed04a2e5bd63cfffd67798066dc9d014d119a00f7b6caad6c7d9a0d1a64c0a251c5f5b9706d883025532758e53f9a5d2f34579b555a206bb341182c624f58d
-  data.tar.gz: 7776a1f8477dc5d7d33efb0cb46edd3dfe0d77d7c40d691eb8cb525d71998216eb4fc7832b546fb7c43f7ec1bb1db5db32e169ed1d4d1c2cdd1291d89e9f8b73
+  metadata.gz: 9b9d18e469e431fd495fee4eadb33ed0f982fbc796033d036fb3366853a72634a88be4b77fd21bd4c1387b02f00b6f635fbc766bb783cb36987fb81415717fb4
+  data.tar.gz: 762bb0188b7ee29aa1ff87d235383fc0ca1ded17b251171b091d44d621796faf06b176db4580e2cef6c44c44da8bc5296ec7c3867315faa87ff42a200558425f

data/CHANGELOG.md

@@ -1,133 +1,129 @@
-1.4.2 / 2020-10-20
+# Changelog
+
+## 2.0.2
+
+* [CHANGED] made encryption_master_key_base64 globally configurable 
+
+## 2.0.1
+
+* [CHANGED] Only include lib and essential docs in gem.
+
+## 2.0.0
+
+* [CHANGED] Use TLS by default.
+* [REMOVED] Support for Ruby 2.4 and 2.5.
+* [FIXED] Handle empty or nil  configuration.
+* [REMOVED] Legacy Push Notification integration.
+* [ADDED] Stalebot and Github actions. 
+
+## 1.4.3
+
+  * [FIXED] Remove newline from end of base64 encoded strings, some decoders don't like
+    them.
+
+## 1.4.2
 ==================
 
-  * Return `shared_secret` to support authenticating encrypted channels. Thanks
+  * [FIXED] Return `shared_secret` to support authenticating encrypted channels. Thanks
     @Benjaminpjacobs
 
-1.4.1 / 2020-10-05
-==================
+## 1.4.1
 
-  * Remove rbnacl from dependencies so we don't get errors when it isn't
+  * [CHANGED] Remove rbnacl from dependencies so we don't get errors when it isn't
     required. Thanks @y-yagi!
 
-1.4.0 / 2020-09-29
-==================
+## 1.4.0
 
-  * Support for end-to-end encryption.
+  * [ADDED] Support for end-to-end encryption.
 
-1.3.3 / 2019-07-02
-==================
+## 1.3.3
 
-  * Rewording to clarify "Pusher Channels" or simply "Channels" product name.
+  * [CHANGED] Rewording to clarify "Pusher Channels" or simply "Channels" product name.
 
-1.3.2 / 2018-10-17
-==================
+## 1.3.2
 
-  * Return a specific error for "Request Entity Too Large" (body over 10KB).
-  * Add a `use_tls` option for SSL (defaults to false).
-  * Add a `from_url` client method (in addition to existing `from_env` option).
-  * Improved documentation and fixed typos.
-  * Add Ruby 2.4 to test matrix.
+  * [FIXED] Return a specific error for "Request Entity Too Large" (body over 10KB).
+  * [ADDED] Add a `use_tls` option for SSL (defaults to false).
+  * [ADDED] Add a `from_url` client method (in addition to existing `from_env` option).
+  * [CHANGED] Improved documentation and fixed typos.
+  * [ADDED] Add Ruby 2.4 to test matrix.
 
-1.3.1 / 2017-03-15
-==================
+## 1.3.1
 
-  * Added missing client batch methods to default client delegations
-  * Document raised exception in the `authenticate` method
-  * Fixes em-http-request from using v2.5.0 of `addressable` breaking builds.
+  * [FIXED] Added missing client batch methods to default client delegations
+  * [CHANGED] Document raised exception in the `authenticate` method
+  * [FIXED] Fixes em-http-request from using v2.5.0 of `addressable` breaking builds.
 
-1.3.0 / 2016-08-23
-==================
+## 1.3.0
 
-  * Add support for sending push notifications on up to 10 interests.
+  * [ADDED] Add support for sending push notifications on up to 10 interests.
 
-1.2.1 / 2016-08-22
-==================
+## 1.2.1
 
-  * Fixes Rails 5 compatibility. Use duck-typing to detect request object
+  * [FIXED] Fixes Rails 5 compatibility. Use duck-typing to detect request object
 
-1.2.0 / 2016-08-15
-==================
+## 1.2.0
 
-  * Minor release for Native notifications
+  * [CHANGED] Minor release for Native notifications
 
-1.2.0.rc1 / 2016-07-18
-==================
+## 1.2.0.rc1
 
-  * Add support for Native notifications
+  * [ADDED] Add support for Native notifications
 
-1.1.0 / 2016-05-20
-==================
+## 1.1.0
 
-  * Add support for batch events
+  * [ADDED] Add support for batch events
 
-1.0.0 / 2016-05-19
-==================
+## 1.0.0
 
-No breaking changes, this release is just to follow semver and show that we
+ * [CHANGED] No breaking changes, this release is just to follow semver and show that we
 are stable.
 
-0.18.0 / 2016-05-15
-==================
+## 0.18.0
 
-  * Introduce `Pusher::Client.from_env`
-  * Improve error handling on missing config
+  * [ADDED] Introduce `Pusher::Client.from_env`
+  * [FIXED] Improve error handling on missing config
 
-0.17.0 / 2016-02-22
-==================
+## 0.17.0
 
-  * Introduce the `cluster` option.
+  * [ADDED] Introduce the `cluster` option.
 
-0.16.0 / 2016-01-21
-==================
+## 0.16.0
 
-  * Bump httpclient version to 2.7
-  * Ruby 1.8.7 is not supported anymore.
+  * [CHANGED] Bump httpclient version to 2.7
+  * [REMOVED] Ruby 1.8.7 is not supported anymore.
 
-0.15.2 / 2015-12-03
-==================
+## 0.15.2
 
-  * Documented `Pusher.channel_info`, `Pusher.channels`
-  * Added `Pusher.channel_users`
+  * [CHANGED] Documented `Pusher.channel_info`, `Pusher.channels`
+  * [ADDED] Added `Pusher.channel_users`
 
-0.15.1 / 2015-11-03
-==================
+## 0.15.1
 
-  * Fixed a bug where the `authenticate` method added in 0.15.0 wasn't exposed on the Pusher class.
+  * [FIXED] Fixed a bug where the `authenticate` method added in 0.15.0 wasn't exposed on the Pusher class.
 
-0.15.0 / 2015-11-02
-==================
+## 0.15.0
 
-  * Added `Pusher.authenticate` method for authenticating private and presence channels.
+  * [ADDED] Added `Pusher.authenticate` method for authenticating private and presence channels.
     This is prefered over the older `Pusher['a_channel'].authenticate(...)` style.
 
-0.14.6 / 2015-09-29
-==================
-  * Updated to use the `pusher-signature` gem instead of `signature`.
-    This resolves namespace related issues.
-
-0.14.5 / 2015-05-11
-==================
-
-  * SECURITY: Prevent auth delegation trough crafted socket IDs
+## 0.14.6
 
-0.14.4 / 2015-01-20
-==================
+  * [CHANGED] Updated to use the `pusher-signature` gem instead of `signature`.
+    This resolves namespace related issues.
 
-  * SECURITY: Prevent timing attack, update signature to v0.1.8
-  * SECURITY: Prevent POODLE. Disable SSLv3, update httpclient to v2.5
-  * Fix channel name character limit.
-  * Adds support for listing users on a presence channel
+## 0.14.5
 
-0.14.3 / 2015-01-20
-==================
+  * [SECURITY] Prevent auth delegation trough crafted socket IDs
 
-Yanked, bad release
+## 0.14.4
 
-0.14.2 / 2014-10-16
-==================
+  * [SECURITY] Prevent timing attack, update signature to v0.1.8
+  * [SECURITY] Prevent POODLE. Disable SSLv3, update httpclient to v2.5
+  * [FIXED] Fix channel name character limit.
+  * [ADDED] Adds support for listing users on a presence channel
 
-First release with a changelog !
+## 0.14.2
 
-  * Bump httpclient to v2.4. See #62 (POODLE SSL)
-  * Fix limited channel count at README.md. Thanks @tricknotes
+  * [CHANGED] Bump httpclient to v2.4. See #62 (POODLE SSL)
+  * [CHANGED] Fix limited channel count at README.md. Thanks @tricknotes

data/README.md

@@ -2,7 +2,11 @@
 
 This Gem provides a Ruby interface to [the Pusher HTTP API for Pusher Channels](https://pusher.com/docs/channels/library_auth_reference/rest-api).
 
-[![Build Status](https://secure.travis-ci.org/pusher/pusher-http-ruby.svg?branch=master)](http://travis-ci.org/pusher/pusher-http-ruby) [![Gem Version](https://badge.fury.io/rb/pusher.svg)](https://badge.fury.io/rb/pusher)
+[![Build Status](https://github.com/pusher/pusher-http-ruby/workflows/Tests/badge.svg)](https://github.com/pusher/pusher-http-ruby/actions?query=workflow%3ATests+branch%3Amaster) [![Gem](https://img.shields.io/gem/v/pusher)](https://rubygems.org/gems/pusher) [![Gem](https://img.shields.io/gem/dt/pusher)](https://rubygems.org/gems/pusher)
+
+## Supported Platforms
+
+* Ruby - supports **Ruby 2.6 or greater**.
 
 ## Installation and Configuration
 
@@ -36,7 +40,7 @@ pusher = Pusher::Client.new(
 )
 ```
 
-The `cluster` value will set the `host` to `api-<cluster>.pusher.com`. The `use_tls` value is optional and defaults to `false`. It will set the `scheme` and `port`. Custom `scheme` and `port` values take precendence over `use_tls`.
+The `cluster` value will set the `host` to `api-<cluster>.pusher.com`. The `use_tls` value is optional and defaults to `true`. It will set the `scheme` and `port`. A custom `port` value takes precendence over `use_tls`.
 
 If you want to set a custom `host` value for your client then you can do so when instantiating a Pusher Channels client like so:
 
@@ -79,11 +83,11 @@ If you need to make requests via a HTTP proxy then it can be configured
 Pusher.http_proxy = 'http://(user):(password)@(host):(port)'
 ```
 
-By default API requests are made over HTTP. HTTPS can be used by setting `encrypted` to `true`.
+By default API requests are made over HTTPS. HTTP can be used by setting `use_tls` to `false`.
 Issuing this command is going to reset `port` value if it was previously specified.
 
 ``` ruby
-Pusher.encrypted = true
+Pusher.use_tls = false
 ```
 
 As of version 0.12, SSL certificates are verified when using the synchronous http client. If you need to disable this behaviour for any reason use:
@@ -295,6 +299,3 @@ pusher.trigger(
 ```
 
 Rationale: the methods in this library map directly to individual Channels HTTP API requests. If we allowed triggering a single event on multiple channels (some encrypted, some unencrypted), then it would require two API requests: one where the event is encrypted to the encrypted channels, and one where the event is unencrypted for unencrypted channels.
-
-## Supported Ruby versions
-2.4+

data/lib/pusher/client.rb

@@ -1,15 +1,19 @@
 require 'base64'
-
 require 'pusher-signature'
 
 module Pusher
   class Client
-    attr_accessor :scheme, :host, :port, :app_id, :key, :secret, :notification_host, :notification_scheme, :encryption_master_key
+    attr_accessor :scheme, :host, :port, :app_id, :key, :secret, :encryption_master_key
     attr_reader :http_proxy, :proxy
     attr_writer :connect_timeout, :send_timeout, :receive_timeout,
                 :keep_alive_timeout
 
     ## CONFIGURATION ##
+    DEFAULT_CONNECT_TIMEOUT = 5
+    DEFAULT_SEND_TIMEOUT = 5
+    DEFAULT_RECEIVE_TIMEOUT = 5
+    DEFAULT_KEEP_ALIVE_TIMEOUT = 30
+    DEFAULT_CLUSTER = "mt1"
 
     # Loads the configuration from an url in the environment
     def self.from_env(key = 'PUSHER_URL')
@@ -25,51 +29,35 @@ module Pusher
     end
 
     def initialize(options = {})
-      default_options = {
-        :scheme => 'http',
-        :port => 80,
-      }
+      @scheme = "https"
+      @port = options[:port] || 443
 
-      if options[:use_tls] || options[:encrypted]
-        default_options[:scheme] = "https"
-        default_options[:port] = 443
+      if options.key?(:encrypted)
+        warn "[DEPRECATION] `encrypted` is deprecated and will be removed in the next major version. Use `use_tls` instead."
       end
 
-      merged_options = default_options.merge(options)
-
-      if options.has_key?(:host)
-        merged_options[:host] = options[:host]
-      elsif options.has_key?(:cluster)
-        merged_options[:host] = "api-#{options[:cluster]}.pusher.com"
-      else
-        merged_options[:host] = "api.pusherapp.com"
+      if options[:use_tls] == false || options[:encrypted] == false
+        @scheme = "http"
+        @port = options[:port] || 80
       end
 
-      # TODO: Change host name when finalized
-      merged_options[:notification_host] =
-        options.fetch(:notification_host, "nativepush-cluster1.pusher.com")
+      @app_id = options[:app_id]
+      @key = options[:key]
+      @secret = options[:secret]
 
-      merged_options[:notification_scheme] =
-        options.fetch(:notification_scheme, "https")
+      @host = options[:host]
+      @host ||= "api-#{options[:cluster]}.pusher.com" unless options[:cluster].nil? || options[:cluster].empty?
+      @host ||= "api-#{DEFAULT_CLUSTER}.pusher.com"
 
-      @scheme, @host, @port, @app_id, @key, @secret, @notification_host, @notification_scheme =
-        merged_options.values_at(
-          :scheme, :host, :port, :app_id, :key, :secret, :notification_host, :notification_scheme
-        )
+      @encryption_master_key = Base64.strict_decode64(options[:encryption_master_key_base64]) if options[:encryption_master_key_base64]
 
-      if options.has_key?(:encryption_master_key_base64)
-        @encryption_master_key =
-          Base64.decode64(options[:encryption_master_key_base64])
-      end
-
-      @http_proxy = nil
-      self.http_proxy = options[:http_proxy] if options[:http_proxy]
+      @http_proxy = options[:http_proxy]
 
       # Default timeouts
-      @connect_timeout = 5
-      @send_timeout = 5
-      @receive_timeout = 5
-      @keep_alive_timeout = 30
+      @connect_timeout = DEFAULT_CONNECT_TIMEOUT
+      @send_timeout = DEFAULT_SEND_TIMEOUT
+      @receive_timeout = DEFAULT_RECEIVE_TIMEOUT
+      @keep_alive_timeout = DEFAULT_KEEP_ALIVE_TIMEOUT
     end
 
     # @private Returns the authentication token for the client
@@ -83,10 +71,10 @@ module Pusher
     def url(path = nil)
       raise ConfigurationError, :app_id unless @app_id
       URI::Generic.build({
-        :scheme => @scheme,
-        :host => @host,
-        :port => @port,
-        :path => "/apps/#{@app_id}#{path}"
+        scheme: @scheme,
+        host: @host,
+        port: @port,
+        path: "/apps/#{@app_id}#{path}"
       })
     end
 
@@ -110,13 +98,12 @@ module Pusher
       @http_proxy = http_proxy
       uri = URI.parse(http_proxy)
       @proxy = {
-        :scheme => uri.scheme,
-        :host => uri.host,
-        :port => uri.port,
-        :user => uri.user,
-        :password => uri.password
+        scheme: uri.scheme,
+        host: uri.host,
+        port: uri.port,
+        user: uri.user,
+        password: uri.password
       }
-      @http_proxy
     end
 
     # Configure whether Pusher API calls should be made over SSL
@@ -136,6 +123,8 @@ module Pusher
     end
 
     def cluster=(cluster)
+      cluster = DEFAULT_CLUSTER if cluster.nil? || cluster.empty?
+
       @host = "api-#{cluster}.pusher.com"
     end
 
@@ -148,7 +137,7 @@ module Pusher
     # Set an encryption_master_key to use with private-encrypted channels from
     # a base64 encoded string.
     def encryption_master_key_base64=(s)
-      @encryption_master_key = s ? Base64.decode64(s) : nil
+      @encryption_master_key = s ? Base64.strict_decode64(s) : nil
     end
 
     ## INTERACT WITH THE API ##
@@ -330,24 +319,6 @@ module Pusher
       post_async('/batch_events', trigger_batch_params(events.flatten))
     end
 
-    def notification_client
-      @notification_client ||=
-        NativeNotification::Client.new(@app_id, @notification_host, @notification_scheme, self)
-    end
-
-
-    # Send a push notification
-    #
-    # POST /apps/[app_id]/notifications
-    #
-    # @param interests [Array] An array of interests
-    # @param message [String] Message to send
-    # @param options [Hash] Additional platform specific options
-    #
-    # @return [Hash]
-    def notify(interests, data = {})
-      notification_client.notify(interests, data)
-    end
 
     # Generate the expected response for an authentication endpoint.
     # See http://pusher.com/docs/authenticating_users for details.
@@ -386,9 +357,9 @@ module Pusher
 
     # @private Construct a net/http http client
     def sync_http_client
-      @client ||= begin
-        require 'httpclient'
+      require 'httpclient'
 
+      @client ||= begin
         HTTPClient.new(@http_proxy).tap do |c|
           c.connect_timeout = @connect_timeout
           c.send_timeout = @send_timeout
@@ -407,14 +378,14 @@ module Pusher
         require 'em-http' unless defined?(EventMachine::HttpRequest)
 
         connection_opts = {
-          :connect_timeout => @connect_timeout,
-          :inactivity_timeout => @receive_timeout,
+          connect_timeout: @connect_timeout,
+          inactivity_timeout: @receive_timeout,
         }
 
         if defined?(@proxy)
           proxy_opts = {
-            :host => @proxy[:host],
-            :port => @proxy[:port]
+            host: @proxy[:host],
+            port: @proxy[:port]
           }
           if @proxy[:user]
             proxy_opts[:authorization] = [@proxy[:user], @proxy[:password]]
@@ -483,8 +454,8 @@ module Pusher
       ciphertext = secret_box.encrypt(nonce, encoded_data)
 
       MultiJson.encode({
-        "nonce" => Base64::encode64(nonce),
-        "ciphertext" => Base64::encode64(ciphertext),
+        "nonce" => Base64::strict_encode64(nonce),
+        "ciphertext" => Base64::strict_encode64(ciphertext),
       })
     end