urbanairship 4.1.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 13da53469054b43b5611d4d3a1a32a05ee1adcc0dbead577b29defafd27d84b7
-  data.tar.gz: 74b10314d1e4a466ca06e942359d02f98d86b8423cd6fbda1dc57267d6d34670
+SHA1:
+  metadata.gz: 6f0d564484013c5bd00e79332ba4627eed3c88d6
+  data.tar.gz: 5539b387ffb95fe9275f16e26cd0d742d0ccce6d
 SHA512:
-  metadata.gz: 923a889b3334c877cca88a5e491649270a0113b570cefbfeb3d9561205bc17567cda2c1f92cf6e4be25eff464633ab7d607b46beba4de85615e741f6ad50cce4
-  data.tar.gz: 1c812031883eb303a6a090c422252b3550eee1d592b34d2f787979c6047f6012082865dec3d7035d3223197dda0fc1c0167a2f28b8bc88362f41423c2bb9b504
+  metadata.gz: a85f430e036579a1b331a8b80d119407deec4a3c4c4757a7af5819e39d5ac0aa7ece81e7be79735f9039abfab61fe040b9b518292c54435a5f4acd4f68f3e805
+  data.tar.gz: c960ef78dda1bd889d8aae622b929bd1412fd7033e8612afa5ad9aed9210469887dd5de1e9bd04bd07ac70001e0fb5da658d8fce8e729c57d16bba962394825f

data/CHANGELOG

@@ -1,15 +1,20 @@
+--------------------
+5.0.0
+--------------------
+- Add support for Web Notify, expand Open Platform support
+- Removing support for Feedback API (EOL July 2018)
+- Removing support for Device Token Count (also EOL in 2018)
+
 --------------------
 4.1.1
 --------------------
 - Added configuration value for timeout.
 
-
 --------------------
 4.1.0
 --------------------
 - Added support for Open Channels
 
-
 --------------------
 4.0.0
 --------------------
@@ -22,47 +27,38 @@
 - Removed support for Blackberry and MPNS platforms
 - Removed support for per-push reports
 
-
 --------------------
 3.2.4
 --------------------
 - Replace unirest dependency with rest-client
 
-
 --------------------
 3.2.3
 --------------------
 - Added support for named user audience selector
 
-
 --------------------
 3.2.2
 --------------------
 - Bug fix: only open a single copy of the log file
 
-
 --------------------
 3.2.1
 --------------------
 - Bug fix: allow audience tag selector to specify tag group if desired
 
-
 --------------------
 3.2.0
 --------------------
 - Added support for static lists
-- Added support for device tokens, apids, and blackberry pins
+- Added support for device tokens, APIDs, and Blackberry PINs
 - Added support for locations
 
-
-
 --------------------
 3.1.1
 --------------------
 - Changed UA to Urbanairship in client.rb to fix aliasing issue
 
-
-
 --------------------
 3.1.0
 --------------------
@@ -75,22 +71,16 @@
 - Added support for named user
 - Added support for reports
 
-
-
 --------------------
 3.0.2
 --------------------
 - Resolve compatibility issues with Rails ActiveSupport
 
-
-
 --------------------
 3.0.1
 --------------------
 - Updating Gemspec to show required Ruby Version correctly
 
-
-
 --------------------
 3.0.0
 --------------------

data/README.rst

@@ -23,7 +23,7 @@ Newer versions should work as well.
 Functionality
 =============
 
-Version 4.0 is a major upgrade, as some features have been removed that were present in earlier versions. A more detailed list of changes can be found in the CHANGELOG.
+Version 5.0 is a major upgrade, as some features have been removed that were present in earlier versions. A more detailed list of changes can be found in the CHANGELOG.
 
 
 Installation

data/docs/devices.rst

@@ -37,26 +37,6 @@ Device metadata is fetched for a specific channel by using
     channel_info = channel_client.lookup(uuid: 'uuid')
     puts(channel_info)
 
-Feedback
---------
-
-Feedback returns a list of dictionaries of device tokens/APIDs that the
-respective push provider has told us are uninstalled since the given
-timestamp. For more information, see `the API documentation for feedback
-<http://docs.urbanairship.com/api/ua.html#feedback>`_
-
-.. code-block:: ruby
-
-    require 'urbanairship'
-    require 'time'
-    UA = Urbanairship
-    airship = UA::Client.new(key:'application_key', secret:'master_secret')
-    since = (Time.now.utc - (60 * 60 * 24 * 3)).iso8601
-    feedback = UA::Feedback.new(client: airship)
-    tokens = feedback.device_token(since: since)
-    apids = feedback.apid(since: since)
-
-
 Device Token Lookup
 -------------------
 
@@ -90,21 +70,6 @@ Get a list of iOS device tokens for the application:
     end
 
 
-Device Token Count
-------------------
-
-Get the total iOS device tokens registered to the application.
-
-.. code-block:: ruby
-
-    require 'urbanairship'
-
-    UA = Urbanairship
-    airship = UA::Client.new(key:'application_key', secret:'master_secret')
-    device_token_list = UA::DeviceTokenList.new(client: airship)
-    puts(device_token_list.count)
-
-
 APID Lookup
 -----------
 

data/docs/named_user.rst

@@ -31,14 +31,14 @@ Associate a channel with a named user ID. For more information, see
 
     require 'urbanairship'
     UA = Urbanairship
-    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    airship = UA::Client.new(key:'application_key', secret:'app_or_master_secret')
     named_user = UA::NamedUser.new(client: airship)
     named_user.named_user_id = 'named_user'
     named_user.associate(channel_id: 'channel_id', device_type: 'ios')
 
 .. note::
 
-    You may only associate up to 20 channels to a Named User.
+    Do not include a ``device_type`` for Web and Open platform associations.
 
 Disassociation
 --------------
@@ -51,7 +51,7 @@ For more information, see `the API documentation
 
     require 'urbanairship'
     UA = Urbanairship
-    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    airship = UA::Client.new(key:'application_key', secret:'app_or_master_secret')
     named_user = UA::NamedUser.new(client: airship)
     named_user.disassociate(channel_id: 'channel_id', device_type: 'ios')
 
@@ -59,6 +59,7 @@ For more information, see `the API documentation
 
     ``named_user_id`` does not have to be set on the named_user object for this
     method call since ``channel_id`` can only be associated with one named user.
+    Do not include a ``device_type`` for Web and Open platform disassociations.
 
 Lookup
 ------

data/docs/push.rst

@@ -59,6 +59,18 @@ Select a single Amazon Channel:
 
     push.audience = UA.amazon_channel(uuid)
 
+Select a single Web Channel:
+
+.. code-block:: ruby
+
+    push.audience = UA.channel(uuid)
+
+Select a single Open Channel:
+
+.. code-block:: ruby
+
+    push.audience = UA.open_channel(uuid)
+
 Select a single iOS device token:
 
 .. code-block:: ruby
@@ -71,7 +83,7 @@ Select a single Android APID:
 
     push.audience = UA.apid(uuid)
 
-Select a single Windows 8 APID:
+Select a single Windows APID:
 
 .. code-block:: ruby
 
@@ -204,7 +216,7 @@ platform-specific alerts, and we set a number of other platform-specific options
             badge: 123,
             sound: 'sound file',
             extra: { 'key' => 'value', 'key2' => 'value2' },
-            expiry: '2012-01-01 12:45:00',
+            expiry: '2019-01-01 12:45:00',
             category: 'category_name',
             interactive: UA.interactive(
                 type: 'ua_share',
@@ -226,7 +238,7 @@ platform-specific alerts, and we set a number of other platform-specific options
         amazon: UA.amazon(
             alert: 'Hello Amazon!',
             consolidation_key: 'key',
-            expires_after: '2012-01-01 12:45:00',
+            expires_after: '2019-01-01 12:45:00',
             extra: { 'key' => 'value', 'key2' => 'value2' },
             title: 'title',
             summary: 'summary',
@@ -260,6 +272,47 @@ platform-specific alerts, and we set a number of other platform-specific options
         )
     )
 
+**Example Web Override**
+
+.. code-block:: ruby
+
+    push.notification = UA.notification(
+        alert: 'Hello World!',
+        web: UA.web(
+            alert: 'Hello Web!',
+            title: 'My Title',
+            extra: { 'key' => 'value', 'key2' => 'value2' },
+            require_interaction: true,
+            icon: { 'url' => 'https://www.urbanairship.com'}
+        )
+    )
+
+**Example Open Platform Override**
+
+.. code-block:: ruby
+
+    push.notification = UA.notification(
+        alert: 'Hello World!',
+        open_platforms: {
+            'open::toaster': UA.open_platform(
+                alert: 'Hello Toaster',
+                title: 'My Title',
+                summary: 'My Summary',
+                extra: { 'key' => 'value', 'key2' => 'value2' },
+                media_attachment: 'https://media.giphy.com/media/JYsWwF82EGnpC/giphy.gif',
+                interactive: UA.interactive(
+                    type: 'ua_share',
+                    button_actions: {
+                        share: { share: 'Sharing is caring!' }
+                    }
+                )
+            ),
+            'open::refrigerator': UA.open_platform(
+                alert: 'Hello Fridge'
+            )
+        }
+    )
+
 **Example WNS Override**
 
 .. code-block:: ruby
@@ -351,7 +404,7 @@ types you wish to target with a list of strings:
 
 .. code-block:: ruby
 
-    push.device_types = UA.device_types(['ios', 'android'])
+    push.device_types = UA.device_types(['ios', 'android', 'web', 'open::example'])
 
 or with the ``all`` shortcut.
 

data/lib/urbanairship/common.rb

@@ -11,8 +11,6 @@ module Urbanairship
     DEVICE_TOKEN_URL = BASE_URL + '/device_tokens/'
     APID_URL = BASE_URL + '/apids/'
     PUSH_URL = BASE_URL + '/push/'
-    DT_FEEDBACK_URL = BASE_URL + '/device_tokens/feedback/'
-    APID_FEEDBACK_URL = BASE_URL + '/apids/feedback/'
     SCHEDULES_URL = BASE_URL + '/schedules/'
     SEGMENTS_URL = BASE_URL + '/segments/'
     NAMED_USER_URL = BASE_URL + '/named_users/'

data/lib/urbanairship/devices/devicelist.rb

@@ -30,34 +30,6 @@ module Urbanairship
       end
     end
 
-    class Feedback
-      include Urbanairship::Common
-      include Urbanairship::Loggable
-
-      def initialize(client: required('client'))
-        @client = client
-      end
-
-      def device_token(since: required('device token'))
-        url = DT_FEEDBACK_URL + '?since=' + since
-        get_feedback(url: url)
-      end
-
-      def apid(since: required('since'))
-        url = APID_FEEDBACK_URL + '?since=' + since
-        get_feedback(url: url)
-      end
-
-      def get_feedback(url: required('url'))
-        response = @client.send_request(
-            method: 'GET',
-            url: url
-        )
-        logger.info("Requested feedback at url #{url}")
-        response
-      end
-    end
-
     class DeviceToken
       include Urbanairship::Common
       include Urbanairship::Loggable
@@ -87,15 +59,6 @@ module Urbanairship
         @next_page = DEVICE_TOKEN_URL
         @data_attribute = 'device_tokens'
       end
-
-      def count
-        resp = @client.send_request(
-          method: 'GET',
-          url: DEVICE_TOKEN_URL + 'count/'
-        )
-        logger.info("Retrieved count of Device Token List.")
-        resp
-      end
     end
 
     class APID

data/lib/urbanairship/devices/named_user.rb

@@ -13,13 +13,13 @@ module Urbanairship
         @named_user_id =  nil
       end
 
-      def associate(channel_id: required('channel_id'), device_type: required('device_type'))
+      def associate(channel_id: required('channel_id'), device_type: nil)
         fail ArgumentError,
              'named_user_id is required for association' if @named_user_id.nil?
 
         payload = {}
         payload['channel_id'] = channel_id
-        payload['device_type'] = device_type
+        payload['device_type'] = @device_type unless @device_type.nil?
         payload['named_user_id'] = @named_user_id
 
         response = @client.send_request(
@@ -32,10 +32,10 @@ module Urbanairship
         response
       end
 
-      def disassociate(channel_id: required('channel_id'), device_type: required('device_type'))
+      def disassociate(channel_id: required('channel_id'), device_type: nil)
         payload = {}
         payload['channel_id'] = channel_id
-        payload['device_type'] = device_type
+        payload['device_type'] = @device_type unless @device_type.nil?
         payload['named_user_id'] = @named_user_id unless @named_user_id.nil?
         response = @client.send_request(
           method: 'POST',

data/lib/urbanairship/push/audience.rb

@@ -12,12 +12,12 @@ module Urbanairship
 
 
       # Methods to select a single iOS Channel, Android Channel, Amazon Channel,
-      # Android APID, Windows 8 APID, or Windows Phone 8 APID respectively.
+      # Web Channel, Open Channel, Android APID, or Windows APID respectively.
       #
       # @example
       #   ios_channel(<channel>) # ==>
       #     {:ios_channel=>"<channel>"}
-      %w(ios_channel android_channel amazon_channel apid wns).each do |name|
+      %w(ios_channel android_channel amazon_channel channel open_channel apid wns).each do |name|
         define_method(name) do |uuid|
           { name.to_sym => cleanup(uuid) }
         end

data/lib/urbanairship/push/payload.rb

@@ -7,16 +7,23 @@ module Urbanairship
 
       # Notification Object for a Push Payload
       def notification(alert: nil, ios: nil, android: nil, amazon: nil,
-                       wns: nil, actions: nil, interactive: nil)
+                       web: nil, wns: nil, open_platforms: nil,
+                       actions: nil, interactive: nil)
         payload = compact_helper({
           alert: alert,
-          actions: actions,
           ios: ios,
           android: android,
           amazon: amazon,
+          web: web,
           wns: wns,
+          actions: actions,
           interactive: interactive
         })
+        if open_platforms
+          open_platforms.each {|platform, overrides| 
+            payload[platform] = overrides
+          }
+        end
         fail ArgumentError, 'Notification body is empty' if payload.empty?
         payload
       end
@@ -93,6 +100,17 @@ module Urbanairship
         })
       end
 
+      # Web Notify specific portion of Push Notification Object
+      def web(alert: nil, title: nil, extra: nil, require_interaction: nil, icon: nil)
+        compact_helper({
+          alert: alert,
+          title: title,
+          extra: extra,
+          require_interaction: require_interaction,
+          icon: icon
+        })
+      end
+
       # WNS specific portion of Push Notification Object
       def wns_payload(alert: nil, toast: nil, tile: nil, badge: nil)
         payload = compact_helper({
@@ -105,6 +123,19 @@ module Urbanairship
         payload
       end
 
+      # Open Platform specific portion of Push Notification Object.
+      def open_platform(alert: nil, title: nil, summary: nil, 
+                        extra: nil, media_attachment: nil, interactive: nil)
+        compact_helper({
+          alert: alert,
+          title: title,
+          summary: summary,
+          extra: extra,
+          media_attachment: media_attachment,
+          interactive: interactive
+        })
+      end
+
       # Rich Message specific portion of Push Notification Object
       def message(title: required('title'), body: required('body'), content_type: nil, content_encoding: nil,
                   extra: nil, expiry: nil, icons: nil, options: nil)

data/lib/urbanairship/version.rb

@@ -1,3 +1,3 @@
 module Urbanairship
-  VERSION = '4.1.1'
+  VERSION = '5.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 5.0.0
 platform: ruby
 authors:
 - Urban Airship
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-18 00:00:00.000000000 Z
+date: 2018-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -194,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Ruby Gem for using the Urban Airship API