urbanairship 3.2.4 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4088c7ba66111c0c9711aecb5147d3b94983b475
-  data.tar.gz: d1b98a68f237ee6d2e29855e9ce8ed36f4538947
+  metadata.gz: 692d6774c618680475e856b748d6565f38278c2a
+  data.tar.gz: 44cbb4e3aa1adf9382a9616fc540b675591e71a1
 SHA512:
-  metadata.gz: 7159f0a5100b974628d1a0afebd5841250ced0a4f7ecc1d1cc2a53b77acd39601af7041bd0e05df48bb08fd82f186581a32537ec6f66914ffd50cb9211bd1891
-  data.tar.gz: 0576569d8278abe88be7f38edbdfbf21048634eae6550a4d1bbfe87ef173ab541028138bcbac9b31a9b7e79c75e86a237a80c64635a2b11661924d0474255028
+  metadata.gz: e354ef63c9665715631ec9647692c8148aea180dedb43159afdd041da68e5e1a206158fee15ac4ba589f1c0e90cbf389f3270e4b94ddd3710fb3f01bd276116c
+  data.tar.gz: 1d77961f636470f64cc8372d08b56adaeab8b4ffa5607e1825e007c5ad6c3700dc48a405a923510f8cc7c3455a9db2d15f340a38dd0e8f9e48095ae6b49324e4

data/.github/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contribution Agreement
+
+## What is the Contributor License Agreement, and what does it mean?
+
+The Contributor License Agreement (CLA) below is to ensure that when someone contributes code to one of our open source libraries that we have a clear record of the license to use it. This is necessary so that we can ensure to all of our customers that they can make use of our libraries and tools without worry. You retain copyright of all of your code.
+
+Please read through the agreement at the URL below. 
+
+If you have questions about this agreement or why we need it please contact us at https://support.urbanairship.com/.
+
+[Contribution Agreement](https://docs.urbanairship.com/contribution-agreement/)

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,33 @@
+We only accept issues for bug reporting purposes. 
+
+**All feature requests, implementation concerns or general queries should be sent to our [support team](https://support.urbanairship.com/).**
+
+Before completing the form below, please check the following:
+
+- [ ] You are using the most recent version of the library. 
+- [ ] You are using a supported version of Ruby for that library version. 
+- [ ] This issue is reproducible. 
+
+## Expected Behavior
+<!--- Tell us what should happen -->
+
+## Current Behavior
+<!--- Tell us what happens instead of the expected behavior -->
+
+## Possible Solution
+<!--- Not required, but gives us a place to begin investigating -->
+
+## Steps to Reproduce
+<!--- Provide a link to a live example, or an unambiguous set of steps to -->
+<!--- reproduce this bug. Include your implementation code if possible and relevant -->
+1.
+2.
+3.
+4.
+
+## Detailed Description
+<!--- Provide a detailed description. If possible full logs showing the behavior.-->
+
+## Possible Fix
+<!--- Not required, but suggest your possible solution if possible. -->
+<!--  If your fix is known to work, we accept pull requests with a completed contribution agreement. -->

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,21 @@
+### What does this do and why?
+Please include link to open issue if applicable.
+
+### Additional notes for reviewers
+* If applicable
+
+### Testing
+- [ ] I wrote tests covering these changes
+
+* I've tested for Ruby versions:
+
+- [ ] 2.2.5
+- [ ] 2.3.1
+
+### Urban Airship Contribution Agreement
+https://docs.urbanairship.com/contribution-agreement/
+
+- [ ] I've filled out and signed UA's contribution agreement form.
+
+### Screenshots
+* If applicable

data/.github/SUPPORT.md

@@ -0,0 +1,10 @@
+# Support Requests
+
+All requests for support including implementation support and feature requests are made to the Urban Airship support team. 
+
+You can contact them by visiting https://support.urbanairship.com/
+
+# Documentation
+
+Documentation for the library can be found here:
+https://docs.urbanairship.com/reference/libraries/ruby/

data/.gitignore

@@ -12,3 +12,4 @@
 
 # App
 urbanairship.log
+.DS_Store

data/.travis.yml

@@ -1,6 +1,4 @@
 language: ruby
 rvm:
-  - 2.1
-  - 2.2.1
-  - 2.2.2
-script: bundle exec rspec
+  - 2.2.5
+  - 2.3.1

data/CHANGELOG

@@ -1,3 +1,16 @@
+--------------------
+4.0.0
+--------------------
+- Added support for in-app messages
+- Added support for iOS priority
+- Added config class, allowing you to define log level and log location
+- Added templates for Github pull requests and issues, contribution information
+- Fixed ability to create a new scheduled push from an existing scheduled push URL
+- Various docs and tests fixes
+- Removed support for Blackberry and MPNS platforms
+- Removed support for per-push reports
+
+
 --------------------
 3.2.4
 --------------------

data/README.rst

@@ -14,23 +14,16 @@ Requirements
 
 We officially support the following Ruby versions::
 
-   2.1.10
    2.2.5
    2.3.1
 
+Newer versions should work as well.
+
 
 Functionality
 =============
 
-Version 3.0 is a major upgrade and backwards incompatible with earlier
-versions.
-
-To encourage the use of our SDK, which takes care of proper channel
-registration, support for device token registration has been removed.
-Support for v1 endpoints will also be removed and transitioned to their
-v3 equivalents where possible.
-
-A more detailed list of changes can be found in the CHANGELOG.
+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.
 
 
 Installation
@@ -51,6 +44,25 @@ OR install it yourself as::
     >>> gem install urbanairship
 
 
+Configuration
+=============
+
+In your app initialization, you can do something like the following:
+
+    >>> require 'urbanairship'
+    >>> Urbanairship.configure do |config|
+    >>>   config.log_path = '/path/to/your/logfile'
+    >>>   config.log_level = Logger::WARN
+    >>> end
+
+
+Available Configurations
+------------------------
+
+- **log_path**: Allows to define the folder where the log file will be created (the default is nil).
+- **log_level**: Allows to define the log level and only messages at that level or higher will be printed (the default is INFO).
+
+
 Usage
 =====
 

data/docs/devices.rst

@@ -138,78 +138,3 @@ that have been iterated over by using the ``count`` method.
         puts(apid)
     end
     puts(apid_list.count)
-
-
-Blackberry PIN Register
------------------------
-
-Register a PIN with the application. This will mark the PIN as active in
-the system. You can also set up an alias and tags for the pin.
-
-.. code-block:: ruby
-
-    require 'urbanairship'
-
-    UA = Urbanairship
-    airship = UA::Client.new(key:'application_key', secret:'master_secret')
-    device_pin = UA::DevicePin.new(client: airship)
-    resp = device_pin.register(pin: '12345678', pin_alias: nil, tags: nil)
-    puts(resp)
-
-.. note::
-    ``pin_alias`` and ``tags`` are optional parameters for this command.
-    If no ``pin_alias`` is provided, any existing alias will be removed from the device
-    record. To empty the tag set, send an empty array of tags. If the tags
-    array is missing from the request, the tags will not be modified.
-
-
-Blackberry PIN Lookup
----------------------
-
-Get information on a particular BlackBerry PIN:
-
-.. code-block:: ruby
-
-    require 'urbanairship'
-
-    UA = Urbanairship
-    airship = UA::Client.new(key:'application_key', secret:'master_secret')
-    device_pin = UA::DevicePin.new(client: airship)
-    resp = device_pin.lookup(pin: 'device_pin')
-    puts(resp)
-
-
-Blackberry PIN Deactivate
--------------------------
-
-Deactive a Blackberry pin for the application.
-
-.. code-block:: ruby
-
-    require 'urbanairship'
-
-    UA = Urbanairship
-    airship = UA::Client.new(key:'application_key', secret:'master_secret')
-    device_pin = UA::DevicePin.new(client: airship)
-    resp = device_pin.deactivate(pin: 'device_pin')
-    puts(resp)
-
-
-Blackberry PIN List
--------------------
-
-Get a list of all Blackberry PINs registered to the application. After you
-have iterated over the list, you can get the total count of PINs by using the
-``count`` method.
-
-.. code-block:: ruby
-
-    require 'urbanairship'
-
-    UA = Urbanairship
-    airship = UA::Client.new(key:'application_key', secret:'master_secret')
-    device_pin_list = UA::DevicePinList.new(client: airship)
-    device_pin_list.each do |pin|
-        puts(pin)
-    end
-    puts(device_pin_list.count)

data/docs/push.rst

@@ -65,12 +65,6 @@ Select a single iOS device token:
 
     push.audience = UA.device_token(token)
 
-Select a single BlackBerry PIN:
-
-.. code-block:: ruby
-
-    push.audience = UA.device_pin(pin)
-
 Select a single Android APID:
 
 .. code-block:: ruby
@@ -83,12 +77,6 @@ Select a single Windows 8 APID:
 
     push.audience = UA.wns(uuid)
 
-Select a single Windows Phone 8 APID:
-
-.. code-block:: ruby
-
-    push.audience = UA.mpns(uuid)
-
 Select a single tag:
 
 .. code-block:: ruby
@@ -200,7 +188,7 @@ single piece of text:
 You can override the notification payload with one of the following platform
 keys::
 
-   ios, amazon, android, blackberry, wns, mpns
+   ios, amazon, android, wns
 
 In the examples below, we override the general ``'Hello World!'`` alert with
 platform-specific alerts, and we set a number of other platform-specific options.
@@ -215,8 +203,8 @@ platform-specific alerts, and we set a number of other platform-specific options
             alert: 'Hello iOS!',
             badge: 123,
             sound: 'sound file',
-            extra: { 'key' => 'value', 'key2' => 'value2' }
-            expiry: '2012-01-01 12:45',
+            extra: { 'key' => 'value', 'key2' => 'value2' },
+            expiry: '2012-01-01 12:45:00',
             category: 'category_name',
             interactive: UA.interactive(
                 type: 'ua_share',
@@ -224,6 +212,7 @@ platform-specific alerts, and we set a number of other platform-specific options
                     share: { share: 'Sharing is caring!' }
                 }
             ),
+            priority: 5,
             content_available: true
         )
     )
@@ -237,7 +226,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',
+            expires_after: '2012-01-01 12:45:00',
             extra: { 'key' => 'value', 'key2' => 'value2' },
             title: 'title',
             summary: 'summary',
@@ -271,19 +260,6 @@ platform-specific alerts, and we set a number of other platform-specific options
         )
     )
 
-**Example BlackBerry Override**
-
-.. code-block:: ruby
-
-    push.notification = UA.notification(
-        alert: 'Hello World!',
-        blackberry: UA.blackberry(
-            alert: 'Hello BlackBerry!',
-            body: 'body',
-            content_type: 'text/plain'
-        )
-    )
-
 **Example WNS Override**
 
 .. code-block:: ruby
@@ -298,26 +274,11 @@ platform-specific alerts, and we set a number of other platform-specific options
         )
     )
 
-**Example MPNS Override**
-
-.. code-block:: ruby
-
-    push.notification = UA.notification(
-        alert: 'Hello World!',
-        mpns: UA.mpns_payload(
-            alert: 'Hello MPNS!',
-            tile: nil,
-            toast: nil,
-            badge: nil
-        )
-    )
 
 .. note::
     The input for wns_payload must include exactly one of
     alert, toast, tile, or badge.
 
-    The input for mpns_payload must include exactly one of
-    alert, toast, or tile.
 
 Actions
 -------
@@ -337,7 +298,7 @@ http://docs.urbanairship.com/api/ua.html#actions, example:
         share: 'Check out Urban Airship!',
         open_: {
             type: 'url',
-            content: 'http://www.urbanairship.com'
+            content: 'http://www.example.com'
         },
         app_defined: {
             some_app_defined_action: 'some_values'
@@ -390,7 +351,7 @@ types you wish to target with a list of strings:
 
 .. code-block:: ruby
 
-    push.device_types = UA.device_types(['ios', 'blackberry'])
+    push.device_types = UA.device_types(['ios', 'android'])
 
 or with the ``all`` shortcut.
 
@@ -465,7 +426,7 @@ notification, you can update or cancel it before it's sent.
 
 .. code-block:: ruby
 
-   schedule = UA.ScheduledPush.from_url(airship, url)
+   schedule = UA::ScheduledPush.from_url(client: airship, url: 'http://www.example.com')
    # change scheduled time to tomorrow
    schedule.schedule = UA.scheduled_time(Time.now.utc + (60 * 60 * 24))
    schedule.update

data/docs/reports.rst

@@ -63,82 +63,6 @@ For more information, see `the API documentation on push reports
 
     precision needs to be a member of ['HOURLY', 'DAILY', 'MONTHLY']
 
-.. Hiding the perpush endpoints for now per GAG-705 (until rate limiting is in place)
-
-   Per Push Reporting
-   ==================
-
-   Retrieve data specific to the performance of an individual push.
-   For more information, see `the API documentationa on per push
-   reporting
-   <http://docs.urbanairship.com/api/ua.html#per-push-reporting>`_
-
-   ---------------
-   Per Push Detail
-   ---------------
-
-
-   Single Request
-   --------------
-
-   Get the analytics detail for a specific Push ID. For more information, see `the
-   API documentation on single requests
-   <http://docs.urbanairship.com/api/ua.html#single-request>`_
-
-   .. code-block:: ruby
-
-       require 'urbanairship'
-       UA = Urbanairship
-       airship = UA::Client.new(key:'application_key', secret:'master_secret')
-       d = UA::PerPushDetail.new(client: airship)
-       details = d.get_single(push_id:'push_id')
-
-
-   Batch Request
-   -------------
-
-   Get the analytics details for an array of Push IDs. For more information,
-   see `the API documentation on batch requests <http://docs.urbanairship.com/api/ua.html#batch-request>`_
-
-   .. code-block:: ruby
-
-       require 'urbanairship'
-       UA = Urbanairship
-       airship = UA::Client.new(key:'application_key', secret:'master_secret')
-       d = UA::PerPushDetail.new(client: airship)
-       details = d.get_batch(push_ids: ['push_id', 'push_id2', 'push_id3'])
-
-   .. note::
-
-       There is a maximum of 100 Push IDs per request
-
-   ---------------
-   Per Push Series
-   ---------------
-
-   Get the default time series data. For more information,
-   see `the API documentation on per push series
-   <http://docs.urbanairship.com/api/ua.html#per-push-series>`_
-
-   .. code-block:: ruby
-
-       require 'urbanairship'
-       UA = Urbanairship
-       airship = UA::Client.new(key:'application_key', secret:'master_secret')
-       s = UA::PerPushSeries.new(client: airship)
-       series = s.get(
-           push_id: 'push_id',
-           precision: 'HOURLY',
-           start_date: '2015-06-01',
-           end_date: '2015-08-01'
-       )
-
-   .. note::
-
-       precision, start_date, and end_date are optional parameters. However, if specifying
-       a date range, precision, start_date and end_date must all be specified. Precision
-       can be specified without start_date and end_date but must be a member of
-       ['HOURLY', 'DAILY', 'MONTHLY'].
 
 Response Report
 ===============

data/example/pusher.rb

@@ -0,0 +1,21 @@
+class Pusher
+
+	require 'urbanairship'
+	UA = Urbanairship
+
+	def send_message
+		airship = UA::Client.new(key:'app_key', secret:'master_secret')
+		p = airship.create_push
+		p.audience = UA.all
+		p.notification = UA.notification(alert: 'Hello')
+		p.device_types = UA.all
+		p.in_app = UA.in_app(
+				alert: 'This is a test message!',
+				display_type: 'banner'
+				)
+		p.send_push
+	end
+
+end
+
+Pusher.new.send_message

data/lib/urbanairship.rb

@@ -6,13 +6,13 @@ require 'urbanairship/devices/segment'
 require 'urbanairship/devices/channel_uninstall'
 require 'urbanairship/client'
 require 'urbanairship/common'
+require 'urbanairship/configuration'
 require 'urbanairship/loggable'
 require 'urbanairship/util'
 require 'urbanairship/version'
 require 'urbanairship/devices/devicelist'
 require 'urbanairship/devices/channel_tags'
 require 'urbanairship/devices/named_user'
-require 'urbanairship/reports/per_push'
 require 'urbanairship/reports/response_statistics'
 require 'urbanairship/devices/static_lists'
 require 'urbanairship/push/location'
@@ -25,4 +25,16 @@ module Urbanairship
   include Urbanairship::Devices
   include Urbanairship::Reports
   include Urbanairship::Push
+
+  class << self
+    attr_accessor :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
 end

data/lib/urbanairship/common.rb

@@ -9,7 +9,6 @@ module Urbanairship
     CHANNEL_URL = BASE_URL + '/channels/'
     DEVICE_TOKEN_URL = BASE_URL + '/device_tokens/'
     APID_URL = BASE_URL + '/apids/'
-    DEVICE_PIN_URL = BASE_URL + '/device_pins/'
     PUSH_URL = BASE_URL + '/push/'
     DT_FEEDBACK_URL = BASE_URL + '/device_tokens/feedback/'
     APID_FEEDBACK_URL = BASE_URL + '/apids/feedback/'

data/lib/urbanairship/configuration.rb

@@ -0,0 +1,10 @@
+module Urbanairship
+  class Configuration
+    attr_accessor :log_path, :log_level
+
+    def initialize
+      @log_path = nil
+      @log_level = Logger::INFO
+    end
+  end
+end

data/lib/urbanairship/devices/devicelist.rb

@@ -125,58 +125,5 @@ module Urbanairship
         @data_attribute = 'apids'
       end
     end
-
-    class DevicePin
-      include Urbanairship::Common
-      include Urbanairship::Loggable
-
-      def initialize(client: required('client'))
-        @client = client
-      end
-
-      def lookup(pin: required('pin'))
-        fail ArgumentError, 'Device pin must be an 8 digit hex string' if pin[/\H/] or pin.length != 8
-        resp = @client.send_request(
-          method: 'GET',
-          url: DEVICE_PIN_URL + pin
-        )
-        logger.info("Retrieved info on device pin #{pin}")
-        resp
-      end
-
-      def register(pin: required('pin'), pin_alias: nil, tags: nil)
-        fail ArgumentError, 'Device pin must be an 8 digit hex string' if pin[/\H/] or pin.length != 8
-        payload = {}
-        payload['alias'] = pin_alias unless pin_alias.nil?
-        payload['tags'] = tags unless tags.nil?
-
-        resp = @client.send_request(
-          method: 'PUT',
-          url: DEVICE_PIN_URL + pin,
-          body: JSON.dump(payload),
-          content_type: 'application/json'
-        )
-        logger.info("Registered device pin #{pin}")
-        resp
-      end
-
-      def deactivate(pin: required('pin'))
-        fail ArgumentError, 'Device pin must be an 8 digit hex string' if pin[/\H/] or pin.length != 8
-        resp = @client.send_request(
-          method: 'DELETE',
-          url: DEVICE_PIN_URL + pin
-        )
-        logger.info("Deactivated device pin #{pin}")
-        resp
-      end
-    end
-
-    class DevicePinList < Urbanairship::Common::PageIterator
-      def initialize(client: required('client'))
-        super(client: client)
-        @next_page = DEVICE_PIN_URL
-        @data_attribute = 'device_pins'
-      end
-    end
   end
 end

data/lib/urbanairship/loggable.rb

@@ -13,9 +13,11 @@ module Urbanairship
     end
 
     def self.create_logger
-      logger = Logger.new('urbanairship.log')
+      log_uri = [Urbanairship.configuration.log_path, 'urbanairship.log'].compact
+      logger = Logger.new(File.join(*log_uri))
       logger.datetime_format = '%Y-%m-%d %H:%M:%S'
       logger.progname = 'Urbanairship'
+      logger.level = Urbanairship.configuration.log_level
       logger
     end
   end

data/lib/urbanairship/push/audience.rb

@@ -8,7 +8,6 @@ module Urbanairship
       include Urbanairship::Common
       UUID_PATTERN = /^\h{8}-\h{4}-\h{4}-\h{4}-\h{12}$/
       DEVICE_TOKEN_PATTERN = /^\h{64}$/
-      DEVICE_PIN_PATTERN = /^\h{8}$/
       DATE_TERMS = %i(minutes hours days weeks months years)
 
 
@@ -18,7 +17,7 @@ module Urbanairship
       # @example
       #   ios_channel(<channel>) # ==>
       #     {:ios_channel=>"<channel>"}
-      %w(ios_channel android_channel amazon_channel apid wns mpns).each do |name|
+      %w(ios_channel android_channel amazon_channel apid wns).each do |name|
         define_method(name) do |uuid|
           { name.to_sym => cleanup(uuid) }
         end
@@ -30,12 +29,6 @@ module Urbanairship
         { device_token: token.upcase.strip }
       end
 
-      # Select a single BlackBerry PIN
-      def device_pin(pin)
-        Util.validate(pin, 'pin', DEVICE_PIN_PATTERN)
-        { device_pin: pin.downcase.strip }
-      end
-
       # Select a single tag
       def tag(tag, group: nil)
         tag_params = { tag: tag }

data/lib/urbanairship/push/payload.rb

@@ -7,17 +7,14 @@ module Urbanairship
 
       # Notification Object for a Push Payload
       def notification(alert: nil, ios: nil, android: nil, amazon: nil,
-                       blackberry: nil, wns: nil, mpns: nil, actions: nil,
-                       interactive: nil)
+                       wns: nil, actions: nil, interactive: nil)
         payload = compact_helper({
           alert: alert,
           actions: actions,
           ios: ios,
           android: android,
           amazon: amazon,
-          blackberry: blackberry,
           wns: wns,
-          mpns: mpns,
           interactive: interactive
         })
         fail ArgumentError, 'Notification body is empty' if payload.empty?
@@ -26,7 +23,7 @@ module Urbanairship
 
       # iOS specific portion of Push Notification Object
       def ios(alert: nil, badge: nil, sound: nil, extra: nil, expiry: nil,
-              category: nil, interactive: nil, content_available: nil)
+              category: nil, interactive: nil, content_available: nil, priority: nil)
         compact_helper({
           alert: alert,
           badge: badge,
@@ -35,7 +32,8 @@ module Urbanairship
           expiry: expiry,
           category: category,
           interactive: interactive,
-          'content-available' => content_available
+          'content-available' => content_available,
+          priority: priority
         })
       end
 
@@ -66,11 +64,6 @@ module Urbanairship
         })
       end
 
-      # BlackBerry specific portion of Push Notification Object
-      def blackberry(alert: nil, body: nil, content_type: 'text/plain')
-        { body: alert || body, content_type: content_type }
-      end
-
       # WNS specific portion of Push Notification Object
       def wns_payload(alert: nil, toast: nil, tile: nil, badge: nil)
         payload = compact_helper({
@@ -83,17 +76,6 @@ module Urbanairship
         payload
       end
 
-      # MPNS specific portion of Push Notification Object
-      def mpns_payload(alert: nil, toast: nil, tile: nil)
-        payload = compact_helper({
-          alert: alert,
-          toast: toast,
-          tile: tile
-        })
-        fail ArgumentError, 'Must specify one message type' if payload.size != 1
-        payload
-      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)
@@ -109,6 +91,20 @@ module Urbanairship
         })
       end
 
+      # In-app message specific portion of Push Notification Object
+      def in_app(alert: nil, display_type: nil, display: nil, expiry: nil,
+                 actions: nil, interactive: nil, extra: nil)
+        compact_helper({
+          alert: alert,
+          display_type: display_type,
+          display: display,
+          expiry: expiry,
+          actions: actions,
+          interactive: interactive,
+          extra: extra
+        })
+      end
+
       # Interactive Notification portion of Push Notification Object
       def interactive(type: required('type'), button_actions: nil)
         fail ArgumentError, 'type must not be nil' if type.nil?

data/lib/urbanairship/push/push.rb

@@ -9,7 +9,7 @@ module Urbanairship
     # A Push Notification.
     class Push
       attr_writer :client, :audience, :notification, :options,
-                  :device_types, :message
+                  :device_types, :message, :in_app
       attr_reader :device_types, :audience
       include Urbanairship::Common
       include Urbanairship::Loggable
@@ -27,7 +27,8 @@ module Urbanairship
           notification: @notification,
           options: @options,
           device_types: @device_types,
-          message: @message
+          message: @message,
+          in_app: @in_app
         })
       end
 
@@ -91,29 +92,29 @@ module Urbanairship
         pr
       end
 
-      # Build a Scheduled Push Notification object its existing Scheduled Push URL
+      # Build a Scheduled Push Notification object from its existing Scheduled Push URL
       #
       # @param [Object] client The Client
       # @param [Object] url The existing Scheduled Push URL
       # @return [Object] Scheduled Push Object
       def self.from_url(client: required('client'), url: required('url'))
         scheduled_push = ScheduledPush.new(client)
-        response_body = client.send_request(
+        response_payload = client.send_request(
           method: 'GET',
           body: nil,
           url: url
         )
-        payload = JSON.load(response_body)
+        payload = JSON.load(response_payload.to_json)
 
         p = Push.new(client)
-        p.audience = payload['push']['audience']
-        p.notification = payload['push']['notification']
-        p.device_types = payload['push']['device_types']
-        p.message = payload['push']['message']
-        p.options = payload['push']['options']
-
-        scheduled_push.name = payload['name']
-        scheduled_push.schedule = payload['schedule']
+        p.audience = payload['body']['push']['audience']
+        p.notification = payload['body']['push']['notification']
+        p.device_types = payload['body']['push']['device_types']
+        p.message = payload['body']['push']['message']
+        p.options = payload['body']['push']['options']
+
+        scheduled_push.name = payload['body']['name']
+        scheduled_push.schedule = payload['body']['schedule']
         scheduled_push.push = p
         scheduled_push.url = url
         scheduled_push

data/lib/urbanairship/version.rb

@@ -1,3 +1,3 @@
 module Urbanairship
-  VERSION = '3.2.4'
+  VERSION = '4.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 3.2.4
+  version: 4.0.0
 platform: ruby
 authors:
 - Urban Airship
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-24 00:00:00.000000000 Z
+date: 2017-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -122,6 +122,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CONTRIBUTING.md"
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/SUPPORT.md"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -147,9 +151,11 @@ files:
 - docs/segment.rst
 - docs/static_lists.rst
 - docs/tags.rst
+- example/pusher.rb
 - lib/urbanairship.rb
 - lib/urbanairship/client.rb
 - lib/urbanairship/common.rb
+- lib/urbanairship/configuration.rb
 - lib/urbanairship/devices/channel_tags.rb
 - lib/urbanairship/devices/channel_uninstall.rb
 - lib/urbanairship/devices/devicelist.rb
@@ -162,7 +168,6 @@ files:
 - lib/urbanairship/push/payload.rb
 - lib/urbanairship/push/push.rb
 - lib/urbanairship/push/schedule.rb
-- lib/urbanairship/reports/per_push.rb
 - lib/urbanairship/reports/response_statistics.rb
 - lib/urbanairship/util.rb
 - lib/urbanairship/version.rb
@@ -188,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Ruby Gem for using the Urban Airship API

data/lib/urbanairship/reports/per_push.rb

@@ -1,97 +0,0 @@
-require 'urbanairship'
-require 'time'
-
-
-module Urbanairship
-  module Reports
-    class PerPushDetail
-      include Urbanairship::Common
-      include Urbanairship::Loggable
-
-      def initialize(client: required('client'))
-        @client = client
-      end
-
-      def get_single(push_id: required('push_id'))
-        fail ArgumentError,
-           'push_id cannot be empty' if push_id.nil?
-        url = REPORTS_URL + 'perpush/detail/' + push_id
-        response = @client.send_request(
-          method: 'GET',
-          url: url
-        )
-        logger.info("Requested per-push details for #{push_id}")
-        response
-      end
-
-      def get_batch(push_ids: required('push_ids'))
-        fail ArgumentError,
-             'push_ids must be an array' unless push_ids.kind_of?(Array)
-        fail ArgumentError,
-           'push_ids cannot be empty' if push_ids.empty?
-        fail ArgumentError,
-          'push_ids cannot contain more than 100 IDs' if push_ids.count > 100
-
-        response = @client.send_request(
-          method: 'POST',
-          body: JSON.dump('push_ids' => push_ids),
-          url: REPORTS_URL + 'perpush/detail/',
-          content_type: 'application/json'
-        )
-        logger.info("Requested info for push ids: #{push_ids}")
-        response
-      end
-    end
-
-    class PerPushSeries
-      include Urbanairship::Common
-      include Urbanairship::Loggable
-
-      def initialize(client: required)
-        @client = client
-      end
-
-      def get(push_id: required('push_id'), precision:nil, start_date:nil, end_date:nil)
-        fail ArgumentError,
-           'push_id cannot be empty' if push_id.nil?
-        url = REPORTS_URL + 'perpush/series/' + push_id
-
-        if precision
-          precision_array = %w(HOURLY DAILY MONTHLY)
-          fail ArgumentError,
-             "Precision must be 'HOURLY', 'DAILY', or 'MONTHLY'" unless precision_array.include?(precision)
-          url += '?precision=' + precision
-        end
-
-        if start_date
-          fail ArgumentError,
-             'Precision must be included with start date' if precision.nil?
-          start_parsed = nil
-          end_parsed = nil
-
-          begin
-            start_parsed = Time.parse(start_date)
-            end_parsed = Time.parse(end_date) unless end_date.nil?
-          rescue ArgumentError
-            fail ArgumentError,
-               'start_date and end_date must be valid date strings'
-          end
-
-          fail ArgumentError,
-             'End date must be after start date' if !end_date.nil? and end_parsed <= start_parsed
-          url += '&start=' + start_parsed.iso8601
-          url += '&end=' + end_parsed.iso8601 unless end_parsed.nil?
-        end
-
-        response = @client.send_request(
-          method: 'GET',
-          url: url
-        )
-        logger.info("Send per push series request for push_id #{push_id} and url #{url}")
-        response
-      end
-    end
-  end
-end
-
-