urbanairship 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73153c441702ad4679dde1b5f9628389010e5da1
-  data.tar.gz: 9a7fe2752efe87fb2f40bfc48c14e170a903b925
+  metadata.gz: 976658dd2efc281297b56b178d85d548a2c7122e
+  data.tar.gz: 8389f2788b640c2cafd9ba036701a69fc8c90740
 SHA512:
-  metadata.gz: fe0efd6d6d0823bcd5a31089d19d2363a6750fa767f3f778143021cb25bc3c9182bf8e082fa5e91ca8d490cce095521cd2388036854a11ee9a9b8ca94a05ffcd
-  data.tar.gz: 3ea326e7bbb0107567f870f317399b920917984b78f9d75ae63fea0c94204e86f93158525e84f16244608295791eb20bd5d5b62e281a050c980ac179df604f5e
+  metadata.gz: 1db5563ad0b87e7f5ca1ef2b8485622f401b6630180627385157f7e5ad8d1b6b569c727c0a7761995215a004b6bada2681ab83efb183959b25a5e07223ec2564
+  data.tar.gz: 13ff6a7e2d6cb7405c63764732f79e3037418195cc45026639606f97472544d70628cb9cb8343c0b6c11ee8851c8a7eef873963162a2b596e51990ade15fc721

data/CHANGELOG

@@ -1,9 +1,20 @@
+--------------------
+3.2.0
+--------------------
+- Added support for static lists
+- 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
 --------------------
 - Added documentation files

data/docs/devices.rst

@@ -5,8 +5,9 @@ Channel Listing
 ---------------
 
 Device lists are fetched by instantiating an iterator object
-using :rb:class:`ChannelList`. For more information, see:
-http://docs.urbanairship.com/api/ua.html#channels
+using :rb:class:`ChannelList`. For more information, see `the API
+documentation for channels <http://docs.urbanairship.com/api/ua.html#channels>`_.
+The ``count`` method will give you the number of channels over which you have iterated.
 
 .. code-block:: ruby
 
@@ -19,6 +20,8 @@ http://docs.urbanairship.com/api/ua.html#channels
         puts(channel)
     end
 
+    puts(channel_list.count)
+
 Channel Lookup
 --------------
 
@@ -39,8 +42,8 @@ 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:
-http://docs.urbanairship.com/api/ua.html#feedback
+timestamp. For more information, see `the API documentation for feedback
+<http://docs.urbanairship.com/api/ua.html#feedback>`_
 
 .. code-block:: ruby
 
@@ -51,4 +54,162 @@ http://docs.urbanairship.com/api/ua.html#feedback
     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)
+    apids = feedback.apid(since: since)
+
+
+Device Token Lookup
+-------------------
+
+Get information on a particular iOS device token:
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+
+    UA = Urbanairship
+    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    device_token = UA::DeviceToken.new(client: airship)
+    resp = device_token.lookup(token: 'device_token')
+    puts(resp)
+
+
+Device Token List
+-----------------
+
+Get a list of iOS device tokens for 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)
+    device_token_list.each do |token|
+        puts(token)
+    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
+-----------
+
+Get information on a particular Android APID:
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+
+    UA = Urbanairship
+    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    apid = UA::APID.new(client: airship)
+    resp = apid.lookup(apid: 'apid')
+    puts(resp)
+
+
+APID List
+---------
+
+List all APIDs for the application. Afterwards, you can get the number of apids
+that have been iterated over by using the ``count`` method.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+
+    UA = Urbanairship
+    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    apid_list = UA::APIDList.new(client: airship)
+    apid_list.each do |apid|
+        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/index.rst

@@ -65,6 +65,8 @@ Contents:
    tags.rst
    named_user.rst
    reports.rst
+   static_lists.rst
+   location.rst
    exceptions.rst
    examples.rst
 

data/docs/location.rst

@@ -0,0 +1,127 @@
+Locations
+=========
+
+This class allows you to search for location information in
+various ways.
+
+
+Name Lookup
+-----------
+
+Search for a location boundary by name. The search primarily
+uses the location names, but you can also filter the results
+by boundary type. See `the API documentation on location
+<http://docs.urbanairship.com/api/ua.html#location>`_
+for more information.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    location = UA::Location.new(client: airship)
+    location.name_lookup(name: 'name', type: 'type')
+
+.. note::
+
+    ``name`` is a required parameter, but ``type`` is optional
+
+
+Coordinates Lookup
+------------------
+
+Search for a location by latitude and longitude coordinates. Type is
+an optional parameter. See `the API documentation on coordinates lookup
+<http://docs.urbanairship.com/api/ua.html#lat-long-lookup>`_
+for more information.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    location = UA::Location.new(client: airship)
+    location.coordinates_lookup(latitude: 123.45, longitude: 123.45, type: 'type')
+
+.. note::
+
+    ``longitude`` and ``latitude`` are required parameters that must be numbers.
+    ``Type`` is an optional parameter.
+
+
+Bounding Box Lookup
+-------------------
+
+Search for location using a bounding box. See `the documentation on
+bounding box lookup
+<http://docs.urbanairship.com/api/ua.html#bounding-box-lookup>`_
+for more information.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    location = UA::Location.new(client: airship)
+    location.bounding_box_lookup(lat1: 123.45, long1: 123.45,
+      lat2: 321.45, long2: 321.45, type: 'type')
+
+.. note::
+
+    ``lat1``, ``long1``, ``lat2``, and ``long2`` and are required parameters that must be numbers.
+    ``Type`` is an optional parameter.
+
+
+Alias Lookup
+------------
+
+Search for location by alias. See `the documentation on alias lookup
+<http://docs.urbanairship.com/api/ua.html#alias-lookup>`_
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    location = UA::Location.new(client: airship)
+    location.alias_lookup(from_alias: 'us_state=CA')
+
+.. note::
+
+    ``from_alias`` can either be a single alias or an array of aliases.
+
+
+Polygon Lookup
+--------------
+
+Search for location by polygon id. See `the documentation on polygon
+lookup <http://docs.urbanairship.com/api/ua.html#polygon-lookup>`_
+for more information.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    location = UA::Location.new(client: airship)
+    location.polygon_lookup(polygon_id: 'id', zoom: 1)
+
+.. note::
+
+    ``polygon_id`` needs to be a string. ``Zoom`` is a number ranging from 1-20.
+
+
+Location Date Ranges
+--------------------
+
+Get the possible date ranges that can be used with location endpoints. See `the documentation
+on location date ranges <http://docs.urbanairship.com/api/ua.html#location-date-ranges>`__
+for more information.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    l = UA::Location.new(client: airship)
+    l.date_ranges

data/docs/push.rst

@@ -414,3 +414,34 @@ notification, you can update or cancel it before it's sent.
 
    # Cancel
    schedule.cancel
+
+
+Listing a Particular Schedule
+-----------------------------
+
+If you have the schedule id, you can use it to list the details of a
+particular schedule.
+
+.. code-block:: ruby
+
+    airship = UA::Client.new(key: '123', secret: 'abc')
+    scheduled_push = UA::ScheduledPush.new(airship)
+    schedule_details = scheduled_push.list(schedule_id: 'id')
+    puts(schedule_details)
+
+.. note::
+    The schedule_id can be obtained from the url of the schedule.
+
+
+Listing all Schedules
+---------------------
+
+You can list all schedules with the ``ScheduledPushList`` class:
+
+.. code-block:: ruby
+
+    airship = UA::Client.new(key: '123', secret: 'abc')
+    scheduled_push_list = UA::ScheduledPushList.new(client: airship)
+    scheduled_push_list.each do |schedule|
+        puts(schedule)
+    end

data/docs/reports.rst

@@ -8,7 +8,7 @@ Individual Push Response Stats
 Returns detailed report information about a specific push notification.
 Use the push_id, which is the identifier returned by the API that represents a
 specific push message delivery.
-For more information, see `the API documentation
+For more information, see `the API documentation on individual push statistics
 <http://docs.urbanairship.com/api/ua.html#individual-push-response-statistics>`_
 
 .. code-block:: ruby
@@ -20,12 +20,12 @@ For more information, see `the API documentation
     statistics = d.get(push_id: 'push_id')
 
 
-Devices Report 
+Devices Report
 ==============
 
 Returns an app’s opted-in and installed device counts broken out by device
 type. This endpoint returns the same data that populates the Devices Report.
-For more information, see `the API documentation
+For more information, see `the API documentation on device reports
 <http://docs.urbanairship.com/api/ua.html#devices-report-api>`_
 
 .. code-block:: ruby
@@ -41,7 +41,7 @@ Push Report
 ===========
 
 Get the number of pushes you have sent within a specified time period.
-For more information, see `the API documentation
+For more information, see `the API documentation on push reports
 <http://docs.urbanairship.com/api/ua.html#push-report>`_
 
 .. code-block:: ruby
@@ -60,89 +60,91 @@ For more information, see `the API documentation
     end
 
 .. note::
+
     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
+   ==================
 
-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>`_
 
-Retrieve data specific to the performance of an individual push.
-For more information, see `the API documentation
-<http://docs.urbanairship.com/api/ua.html#per-push-reporting>`_
+   ---------------
+   Per Push Detail
+   ---------------
 
----------------
-Per Push Detail
----------------
 
+   Single Request
+   --------------
 
-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>`_
 
-Get the analytics detail for a specific Push ID. For more information, see `the
-API documentation
-<http://docs.urbanairship.com/api/ua.html#single-request>`_
+   .. code-block:: ruby
 
-.. 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')
+       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
--------------
+   Batch Request
+   -------------
 
-Get the analytics details for an array of Push IDs. For more information,
-see `the API documentation <http://docs.urbanairship.com/api/ua.html#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
+   .. 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'])
+       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::
+   .. note::
 
-    There is a maximum of 100 Push IDs per request
+       There is a maximum of 100 Push IDs per request
 
----------------
-Per Push Series
----------------
+   ---------------
+   Per Push Series
+   ---------------
 
-Get the default time series data. For more information,
-see `the API documentation
-<http://docs.urbanairship.com/api/ua.html#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
+   .. 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'
-    )
+       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::
+   .. 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'].
+       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
 ===============
 
 Get the number of direct and influenced opens of your app. For more 
-information, see `the API documentation
+information, see `the API documentation on reponse reports
 <http://docs.urbanairship.com/api/ua.html#response-report>`_
 
 .. code-block:: ruby
@@ -169,9 +171,9 @@ Response Listing
 ================
 
 Get a listing of all pushes and basic response information in a given
-timeframe by instantiating an iterator object using ResponseList. 
+timeframe by instantiating an iterator object using ResponseList.
 Start and end date times are required parameters.
-For more information, see `the API documentation
+For more information, see `the API documentation on response listings
 <http://docs.urbanairship.com/api/ua.html#response-listing>`_
 
 .. code-block:: ruby
@@ -200,7 +202,7 @@ App Opens Report
 ================
 
 Get the number of users who have opened your app within the specified time 
-period. For more information, see `the API documentation
+period. For more information, see `the API documentation on app open reports
 <http://docs.urbanairship.com/api/ua.html#app-opens-report>`_
 
 .. code-block:: ruby
@@ -227,6 +229,7 @@ Time In App Report
 
 Get the average amount of time users have spent in your app within the 
 specified time period. For more information, see `the API documentation
+on time-in-app reports
 <http://docs.urbanairship.com/api/ua.html#time-in-app-report>`_
 
 .. code-block:: ruby
@@ -253,7 +256,7 @@ Opt-In Report
 
 Get the number of opted-in push users who access the app within the specified 
 time period.
-For more information, see `the API documentation
+For more information, see `the API documentation on opt-in reports
 <http://docs.urbanairship.com/api/ua.html#opt-in-report>`_
 
 .. code-block:: ruby
@@ -278,9 +281,9 @@ For more information, see `the API documentation
 Opt-Out Report
 ==============
 
-Get the number of opted-out push users who access the app within the specified 
+Get the number of opted-out push users who access the app within the specified
 time period.
-For more information, see `the API documentation
+For more information, see `the API documentation on opt-out reports
 <http://docs.urbanairship.com/api/ua.html#opt-out-report>`_
 
 .. code-block:: ruby
@@ -300,4 +303,3 @@ For more information, see `the API documentation
 .. note::
 
     precision needs to be a member of ['HOURLY', 'DAILY', 'MONTHLY']
-

data/docs/static_lists.rst

@@ -0,0 +1,137 @@
+Static Lists
+============
+
+With the Static List endpoint, you can easily target and manage
+lists of devices that are defined in your systems outside of Urban Airship.
+Any list or grouping of devices for which the canonical source of data about
+the members is elsewhere is a good candidate for Static Lists, e.g., members
+of a customer loyalty program.
+For more information, see: `the API documentation on Static Lists
+<http://docs.urbanairship.com/api/ua.html#static-lists>`__
+
+
+Create List
+-----------
+
+Creates a static list. The body of the request will contain several of the list
+object parameters, but the actual list content will be provided by a second call
+to the upload endpoint.
+
+The create method has two optional parameters including 'description,' which is a
+user-provided description of the list, and 'extras,' which is a dictionary of
+string keys to arbitrary JSON values.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    static_list = UA::StaticList.new(client: airship)
+    static_list.name = 'list_name'
+    static_list.create(description: 'description', extras: { 'key' => 'value' })
+
+
+Upload List
+-----------
+
+Lists target identifiers are specified or replaced with an upload to this endpoint.
+Uploads must be newline delimited identifiers (text/CSV) as described in RFC 4180,
+with commas as the delimiter. The ``StaticList.upload csvfile`` parameter takes an
+open file descriptor. A second optional ``gzip`` parameter specifies whether the csvfile
+to be uploaded is gzipped. This parameter defaults to false.
+
+The CSV format consists of two columns: 'identifier_type' and 'identifier'.
+'identifier_type' must be one of 'alias', 'named_user', 'ios_channel', 'android_channel',
+or 'amazon_channel'. 'identifier' is the associated identifier you wish to send to.
+
+The maximum number of 'identifier_type,identifier' pairs that may be uploaded to a list
+is 10 million.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    static_list = UA::StaticList.new(client: airship)
+    static_list.name = 'list_name'
+    File.open('csv_file', 'rb') do |csv|
+        static_list.upload(csv_file: csv, gzip: false)
+    end
+
+
+Update List
+-----------
+
+Updates the metadata of a static list.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    static_list = UA::StaticList.new(client: airship)
+    static_list.name = 'list_name'
+    static_list.update(description: 'description', { 'key' => 'value' })
+
+
+Delete List
+-----------
+
+Delete a static list.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    static_list = UA::StaticList.new(client: airship)
+    static_list.name = 'list_name'
+    static_list.delete
+
+.. note::
+
+    If you are attempting to update a current list by deleting it
+    and then recreating it with new data, stop and go to the upload
+    endpoint. There is no need to delete a list before uploading a
+    new CSV file. 
+
+
+Lookup List
+-----------
+Retrieve information about one static list.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    static_list = UA::StaticList.new(client: airship)
+    static_list.name = 'list_name'
+    static_list.lookup
+
+.. note::
+
+    When looking up lists, the returned information may actually be a combination
+    of values from both the last uploaded list and the last successfully processed
+    list. If you create a list successfully, and then you update it and the
+    processing step fails, then the list status will read "failed", but the
+    channel_count and last_modified fields will contain information on the last
+    successfully processed list.
+
+
+Lookup All Lists
+----------------
+
+Retrieve information about all static lists. This call returns a paginated list of
+metadata that will not contain the actual lists of users.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    static_lists = UA::StaticLists.new(client: airship)
+
+    static_lists.each do |static_list|
+        puts(static_list)
+    end

data/lib/urbanairship.rb

@@ -14,6 +14,8 @@ 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'
 
 module Urbanairship
   extend Urbanairship::Push::Audience
@@ -22,4 +24,5 @@ module Urbanairship
   extend Urbanairship::Push
   include Urbanairship::Devices
   include Urbanairship::Reports
+  include Urbanairship::Push
 end

data/lib/urbanairship/client.rb

@@ -30,7 +30,7 @@ module Urbanairship
       # @param [Object] version API Version
       # @return [Object] Push Response
       def send_request(method: required('method'), url: required('url'), body: nil,
-                       content_type: nil)
+                       content_type: nil, encoding: nil)
         req_type = case method
           when 'GET'
             :get
@@ -46,12 +46,17 @@ module Urbanairship
 
         headers = {'User-agent' => 'UARubyLib/' + Urbanairship::VERSION}
         headers['Accept'] = 'application/vnd.urbanairship+json; version=3'
+        headers['Content-type'] = content_type unless content_type.nil?
+        headers['Content-Encoding'] = encoding unless encoding.nil?
 
-        if content_type
-          headers['Content-type'] = content_type
-        end
+        debug = "Making #{method} request to #{url}.\n"+
+            "\tHeaders:\n"
+        debug += "\t\tcontent-type: #{content_type}\n" unless content_type.nil?
+        debug += "\t\tcontent-encoding: gzip\n" unless encoding.nil?
+        debug += "\t\taccept: application/vnd.urbanairship+json; version=3\n"
+        debug += "\tBody:\n#{body}" unless body.nil?
 
-        logger.debug("Making #{method} request to #{url}. \n\tHeaders:\n\tcontent-type: #{content_type}\n\tversion=3\nBody:\n\t#{body}")
+        logger.debug(debug)
 
         response = Unirest.method(req_type).call(
           url,

data/lib/urbanairship/common.rb

@@ -17,6 +17,10 @@ module Urbanairship
     SEGMENTS_URL = BASE_URL + '/segments/'
     NAMED_USER_URL = BASE_URL + '/named_users/'
     REPORTS_URL = BASE_URL + '/reports/'
+    LISTS_URL = BASE_URL + '/lists/'
+    PIPELINES_URL = BASE_URL + '/pipelines/'
+    FEEDS_URL = BASE_URL + '/feeds/'
+    LOCATION_URL = BASE_URL + '/location/'
 
     # Helper method for required keyword args in Ruby 2.0 that is compatible with 2.1+
     # @example
@@ -114,6 +118,7 @@ module Urbanairship
         @next_page = nil
         @data_list = nil
         @data_attribute = nil
+        @count = 0
       end
 
       def load_page
@@ -140,10 +145,15 @@ module Urbanairship
       def each
         while load_page
           @data_list.each do | value |
+            @count += 1
             yield value
           end
         end
       end
+
+      def count
+        @count
+      end
     end
   end
 end

data/lib/urbanairship/devices/devicelist.rb

@@ -57,5 +57,126 @@ module Urbanairship
         response
       end
     end
+
+    class DeviceToken
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def lookup(token: required('token'))
+        fail ArgumentError, 'token needs to be a string' unless token.is_a? String
+
+        resp = @client.send_request(
+          method: 'GET',
+          url: DEVICE_TOKEN_URL + token
+        )
+        logger.info("Looking up info on device token #{token}")
+        resp
+      end
+    end
+
+    class DeviceTokenList < Urbanairship::Common::PageIterator
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+
+      def initialize(client: required('client'))
+        super(client: client)
+        @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
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def lookup(apid: required('apid'))
+        fail ArgumentError, 'apid needs to be a string' unless apid.is_a? String
+
+        resp = @client.send_request(
+          method: 'GET',
+          url: APID_URL + apid
+        )
+        logger.info("Retrieved info on apid #{apid}")
+        resp
+      end
+    end
+
+    class APIDList < Urbanairship::Common::PageIterator
+      def initialize(client: required('client'))
+        super(client: client)
+        @next_page = APID_URL
+        @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/devices/static_lists.rb

@@ -0,0 +1,101 @@
+require 'urbanairship'
+require 'tempfile'
+
+
+module Urbanairship
+  module Devices
+    class StaticList
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+      attr_accessor :name
+      def initialize(client: required('client'))
+        fail ArgumentError, 'Client cannot be set to nil' if client.nil?
+        @client = client
+        @name = nil
+      end
+
+      def create(description: nil, extras: nil)
+        fail ArgumentError, 'Name must be set' if @name.nil?
+        payload = {'name' => @name}
+        payload['description'] = description unless description.nil?
+        payload['extras'] = extras unless extras.nil?
+
+        response = @client.send_request(
+          method: 'POST',
+          body: JSON.dump(payload),
+          url: LISTS_URL,
+          content_type: 'application/json'
+        )
+        logger.info("Created static list for #{@name}")
+        response
+      end
+
+      def upload(csv_file: required('csv_file'), gzip: false)
+        fail ArgumentError, 'Name must be set' if @name.nil?
+        if gzip
+          response = @client.send_request(
+              method: 'PUT',
+              body: csv_file,
+              url: LISTS_URL + @name + '/csv/',
+              content_type: 'text/csv',
+              encoding: gzip
+          )
+        else
+          response = @client.send_request(
+              method: 'PUT',
+              body: csv_file,
+              url: LISTS_URL + @name + '/csv/',
+              content_type: 'text/csv'
+          )
+        end
+        logger.info("Uploading a list for #{@name}")
+        response
+      end
+
+      def update(description: nil, extras: nil)
+        fail ArgumentError, 'Name must be set' if @name.nil?
+        fail ArgumentError,
+           'Either description or extras must be set to a value' if description.nil? and extras.nil?
+        payload = {}
+        payload['description'] = description unless description.nil?
+        payload['extras'] = extras unless extras.nil?
+        response = @client.send_request(
+          method: 'PUT',
+          body: JSON.dump(payload),
+          url: LISTS_URL + @name,
+          content_type: 'application/json'
+        )
+        logger.info("Updating the metadata for list #{@name}")
+        response
+      end
+
+      def lookup
+        fail ArgumentError, 'Name must be set' if @name.nil?
+        response = @client.send_request(
+          method: 'GET',
+          url: LISTS_URL + @name
+        )
+        logger.info("Retrieving info for list #{@name}")
+        response
+      end
+
+      def delete
+        fail ArgumentError, 'Name must be set' if @name.nil?
+        response = @client.send_request(
+          method: 'DELETE',
+          url: LISTS_URL + @name
+        )
+        logger.info("Deleted list #{@name}")
+        response
+      end
+    end
+
+    class StaticLists < Urbanairship::Common::PageIterator
+      def initialize(client: required('client'))
+        super(client: client)
+        @next_page = LISTS_URL
+        @data_attribute = 'lists'
+      end
+    end
+  end
+end

data/lib/urbanairship/push/location.rb

@@ -0,0 +1,103 @@
+require 'urbanairship'
+
+
+module Urbanairship
+  module Push
+    class Location
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def name_lookup(name: required('name'), type: nil)
+        fail ArgumentError, 'name needs to be a string' unless name.is_a? String
+        fail ArgumentError, 'type needs to be a string' unless type.nil? or type.is_a? String
+        url = LOCATION_URL + '?q=' + name
+        url += '&type=' + type unless type.nil?
+        resp = @client.send_request(
+          method: 'GET',
+          url: url
+        )
+        logger.info("Retrieved location information for #{name}")
+        resp
+      end
+
+      def coordinates_lookup(latitude: required('latitude'), longitude: required('longitude'), type: nil)
+        fail ArgumentError,
+          'latitude and longitude need to be numbers' unless latitude.is_a? Numeric and longitude.is_a? Numeric
+        fail ArgumentError, 'type needs to be a string' unless type.nil? or type.is_a? String
+        url = LOCATION_URL + latitude.to_s + ',' + longitude.to_s
+        url += '?type=' + type unless type.nil?
+        resp = @client.send_request(
+          method: 'GET',
+          url: url
+        )
+        logger.info("Retrieved location information for latitude #{latitude} and longitude #{longitude}")
+        resp
+      end
+
+      def bounding_box_lookup(lat1: required('lat1'), long1: required('long1'),
+                              lat2: required('lat2'), long2: required('long2'), type: nil)
+
+        fail ArgumentError,
+           'lat1, long1, lat2, and long2 need to be numbers' unless lat1.is_a? Numeric and long2.is_a? Numeric\
+           and lat2.is_a? Numeric and long2.is_a? Numeric
+        fail ArgumentError, 'type needs to be a string' unless type.nil? or type.is_a? String
+        url = LOCATION_URL + lat1.to_s + ',' + long1.to_s + ',' + lat2.to_s + ',' + long2.to_s
+        url += '?type=' + type unless type.nil?
+        resp = @client.send_request(
+          method: 'GET',
+          url: url
+        )
+        logger.info("Retrieved location information for bounding box with lat1 #{lat1}, long1 #{long1}," +
+          " lat2 #{lat2}, and long2 #{long2}")
+        resp
+      end
+
+      def alias_lookup(from_alias: required('from_alias'))
+        fail ArgumentError, 'from_alias needs to be a string or an array of strings' unless from_alias.is_a? String or from_alias.is_a? Array
+        url = LOCATION_URL + 'from-alias?'
+        if from_alias.is_a? Array
+          from_alias.each do |a|
+            fail ArgumentError, 'from_alias needs to be a string or an array of strings' unless a.is_a? String
+            url += a + '&'
+          end
+          url = url.chop
+        else
+          url += from_alias
+        end
+
+        resp = @client.send_request(
+          method: 'GET',
+          url: url
+        )
+        logger.info("Retrieved location info from alias #{from_alias}")
+        resp
+      end
+
+      def polygon_lookup(polygon_id: required('polygon_id'), zoom: required('zoom'))
+        fail ArgumentError, 'polygon_id needs to be a string' unless polygon_id.is_a? String
+        fail ArgumentError, 'zoom needs to be an integer' unless zoom.is_a? Integer
+
+        url = LOCATION_URL + polygon_id + '?zoom=' + zoom.to_s
+        resp = @client.send_request(
+          method: 'GET',
+          url: url
+        )
+        logger.info("Retrieved location info for polygon #{polygon_id} and zoom level #{zoom}")
+        resp
+      end
+
+      def date_ranges
+        resp = @client.send_request(
+          method: 'GET',
+          url: SEGMENTS_URL + 'dates/'
+        )
+        logger.info('Retrieved location date ranges')
+        resp
+      end
+    end
+  end
+end

data/lib/urbanairship/push/push.rb

@@ -10,7 +10,7 @@ module Urbanairship
     class Push
       attr_writer :client, :audience, :notification, :options,
                   :device_types, :message
-      attr_reader :device_types
+      attr_reader :device_types, :audience
       include Urbanairship::Common
       include Urbanairship::Loggable
 
@@ -124,7 +124,7 @@ module Urbanairship
       # @return [Object] Push Response
       def cancel
         fail ArgumentError,
-             'Cannot cancel ScheduledPush without a url.' if @url.nil?
+           'Cannot cancel ScheduledPush without a url.' if @url.nil?
 
         response = @client.send_request(
           method: 'DELETE',
@@ -142,7 +142,7 @@ module Urbanairship
       # @return [Object]
       def update
         fail ArgumentError,
-             'Cannot update a ScheduledPush without a url.' if @url.nil?
+           'Cannot update a ScheduledPush without a url.' if @url.nil?
         response = @client.send_request(
           method: 'PUT',
           body: JSON.dump(self.payload),
@@ -153,9 +153,28 @@ module Urbanairship
         logger.info { pr.format }
         pr
       end
+
+      def list(schedule_id: required('schedule_id'))
+        fail ArgumentError,
+           'schedule_id must be a string' unless schedule_id.is_a? String
+        resp = @client.send_request(
+          method: 'GET',
+          url: SCHEDULES_URL + schedule_id
+        )
+        logger.info("Retrieved info for schedule_id #{schedule_id}")
+        resp
+      end
     end
 
 
+    class ScheduledPushList < Urbanairship::Common::PageIterator
+      def initialize(client: required('client'))
+        super(client: client)
+        @next_page = SCHEDULES_URL
+        @data_attribute = 'schedules'
+      end
+    end
+
     # Response to a successful push notification send or schedule.
     class PushResponse
       attr_reader :ok, :push_ids, :schedule_url, :operation_id, :payload, :status_code

data/lib/urbanairship/version.rb

@@ -1,3 +1,3 @@
 module Urbanairship
-  VERSION = '3.1.1'
+  VERSION = '3.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Urban Airship
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-05 00:00:00.000000000 Z
+date: 2015-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unirest
@@ -140,10 +140,12 @@ files:
 - docs/examples.rst
 - docs/exceptions.rst
 - docs/index.rst
+- docs/location.rst
 - docs/named_user.rst
 - docs/push.rst
 - docs/reports.rst
 - docs/segment.rst
+- docs/static_lists.rst
 - docs/tags.rst
 - lib/urbanairship.rb
 - lib/urbanairship/client.rb
@@ -153,8 +155,10 @@ files:
 - lib/urbanairship/devices/devicelist.rb
 - lib/urbanairship/devices/named_user.rb
 - lib/urbanairship/devices/segment.rb
+- lib/urbanairship/devices/static_lists.rb
 - lib/urbanairship/loggable.rb
 - lib/urbanairship/push/audience.rb
+- lib/urbanairship/push/location.rb
 - lib/urbanairship/push/payload.rb
 - lib/urbanairship/push/push.rb
 - lib/urbanairship/push/schedule.rb