urbanairship 7.0.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fffdb1489ab1f833e816db52d94b9aea7dac527f07bde6507af1dee57f491140
-  data.tar.gz: 2255e7731044332f60b883568929e197905a690c45d905d0a75214806163434a
+  metadata.gz: 5417adc316435f2d47f4962983571399b1bf4dea0015cd126ea12077260e50eb
+  data.tar.gz: ccbaafa7f7f6bb5820c3a9e1834c23b5a8972debc6b964a204a73cb7630dc2b8
 SHA512:
-  metadata.gz: c39e8417e51bd08077a8658589cdee0db2639e5e5d60e6de2596aa361e9640f16cb25ff284cfa55da044dd814b1b01001b84bc7b1c1dbcbbdc441c1dab7b6405
-  data.tar.gz: 209ebf90c4d266092557e387d0479ccaf8fbd3d07d05f12f78e74186c4fd0c32a00a83b306994c64de9961554cd7eb39b115dc32b5130cc9c2f564553df72eb5
+  metadata.gz: 36063a93db8505fa64180ef1980068112d3e14b6b0330e97fa772bd7081c25ab0500aaa7db442ba086a7b12ae8e2c588bbdce7f34144998287a242e401c49c6c
+  data.tar.gz: d0cccf9b2713aa344d268c8a997a549525166f88e98e78d63b2a16a12e4123ce999e9be430c0c63a167cf5ff09505cc846755fc02ec822504b898146389aa799

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -15,8 +15,8 @@ Please include link to open issue if applicable.
 
 * I've tested for Ruby versions:
 
-- [ ] 2.2.5
-- [ ] 2.3.1
+- [ ] 2.6.7
+- [ ] 2.7.3
 
 ### Airship Contribution Agreement
 [Link here](https://docs.google.com/forms/d/e/1FAIpQLScErfiz-fXSPpVZ9r8Di2Tr2xDFxt5MgzUel0__9vqUgvko7Q/viewform)

data/.github/workflows/ci.yaml

@@ -0,0 +1,23 @@
+name: Ruby Build
+
+on: [ push ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: [2.7.3, 2.6.7]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake

data/.github/workflows/release.yaml

@@ -0,0 +1,31 @@
+name: Ruby Release
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: [2.7.3, 2.6.7]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake
+      - name: Publish to RubyGems
+        uses: cadwallion/publish-rubygems-action@master
+        env:
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+          GUTHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          RELEASE_COMMAND: rake release

data/.gitignore

@@ -10,6 +10,7 @@
 /spec/reports/
 /tmp/
 /csv_file
+.vscode/
 
 # App
 urbanairship.log

data/CHANGELOG

@@ -1,3 +1,22 @@
+9.0.0
+--------------------
+- Adds Tag List API Support
+- Removes location lookup endpoints
+- Removes location-based audience selectors
+--------------------
+8.0.1
+--------------------
+- Adds app key to user agent string on request
+
+--------------------
+8.0.0
+--------------------
+- Updates officially supported versions to 2.6.7 and 2.7.2
+- Fixes headers to reduce warning messages
+- Fixes for multiple mis-set named user urls
+- Fix to automatically convert an integer named user to a string so it can be successfully submitted
+- Adds attribute support for named users
+
 --------------------
 7.0.0
 --------------------

data/README.rst

@@ -1,6 +1,5 @@
-.. image:: https://travis-ci.org/urbanairship/ruby-library.svg?branch=master
-    :target: https://travis-ci.org/urbanairship/ruby-library
-
+.. image:: https://github.com/urbanairship/ruby-library/actions/workflows/ci.yaml/badge.svg
+    :target: https://github.com/urbanairship/ruby-library/
 About
 =====
 
@@ -14,16 +13,16 @@ Requirements
 
 We officially support the following Ruby versions::
 
-   2.2.5
-   2.3.1
+   2.6.7
+   2.7.2
 
-Newer versions should work as well.
+Newer 2.x versions should work as well.
 
 
 Functionality
 =============
 
-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.
+Version 8.0 is a major upgrade, as we have changed the tested/supported versions of Ruby. A more detailed list of changes can be found in the CHANGELOG.
 
 
 Questions
@@ -120,7 +119,7 @@ Broadcast to All Devices
    p = airship.create_push
    p.audience = UA.all
    p.notification = UA.notification(alert: 'Hello')
-   p.device_types = UA.all
+   p.device_types = UA.device_types(['ios','android'])
    p.send_push
 
 Simple Tag Push
@@ -136,12 +135,12 @@ Simple Tag Push
    p = airship.create_push
    p.audience = UA.tag('some_tag')
    p.notification = UA.notification(alert: 'Hello')
-   p.device_types = UA.all
+   p.device_types = UA.device_types(['ios','android'])
    p.send_push
 
 Specify the Airship server used to make your requests
 -----------------------------------------------------
-By default, the request will be sent to the 'go.airship.us' server:
+By default, the request will be sent to the 'go.urbanairship.com' server:
 
 .. code-block:: ruby
 
@@ -172,9 +171,9 @@ Finally, you can change the targeted server on a request basis:
      config.server = 'go.airship.eu'
    end
 
-   Urbanairship::Client.new(key:'application_key', secret:'master_secret', server: 'go.airship.us')
+   Urbanairship::Client.new(key:'application_key', secret:'master_secret', server: 'go.urbanairship.com')
    # The Urbanairship configuration is overridden by the client and the
-   # request will be sent to the 'go.airship.us' server
+   # request will be sent to the 'go.urbanairship.com' server
 
 Contributing
 ============

data/docs/attributes.rst

@@ -24,6 +24,27 @@ The following will set an attribute for a given channel ID.
 
     This should return a 200 response
 
+Set or Remove Attributes for a Named User
+-----------------------------------------
+
+The following example shows you how to set and remove attributes on a given named user.
+    
+.. code-block:: ruby
+    
+    require 'urbanairship'
+    airship = Urbanairship::Client.new(key: 'application_key', secret: 'master_secret')
+    named_user = Urbanairship::NamedUser.new(client: airship)
+    named_user.named_user_id = 'named_user'
+    named_user.update_attributes(attributes: [
+        { action: 'set', key: 'first_name', value: 'Firstname' },
+        { action: 'remove', key: 'nickname' },
+        { action: 'set', key: 'last_name', value: 'Lastname', timestamp: Time.now.utc }
+    ])
+    
+.. note::
+
+    Timestamp is optional, if missing it will default to 'now'
+
 Send Push to Audience with Attribute Specifications
 ---------------------------------------------------
 

data/docs/examples.rst

@@ -18,7 +18,7 @@ Simple broadcast to all devices
     push = airship.create_push
     push.audience = UA.all
     push.notification = UA.notification(alert: "Hello, world!")
-    push.device_types = UA.all
+    push.device_types = UA.device_types(['ios','android'])
     push.send_push
 
 
@@ -92,7 +92,7 @@ Rich Push with extra and without notification
 
     push = airship.create_push
     push.audience = UA.all
-    push.device_types = UA.all
+    push.device_types = UA.device_types(['ios','android'])
     push.message = UA.message(
       title: "Your package is on its way!",
       body: "<h1>Would you please complete our customer survey?</h1>",

data/docs/index.rst

@@ -27,7 +27,7 @@ Using the library
 
 The library is intended to be used with the small footprint of a single
 import. To get started, import the package, and create an
-:rb:class:`Airship` object representing a single UA application.
+:rb:class:`Airship` object representing a single Airship project.
 
 Note that channels are preferred over ``device_token`` and ``apid``. See:
 `documentation on channels <channels>`_.
@@ -40,7 +40,7 @@ Note that channels are preferred over ``device_token`` and ``apid``. See:
     p = airship.create_push
     p.audience = UA.all
     p.notification = UA.notification(alert: 'Hello')
-    p.device_types = UA.all
+    p.device_types = UA.device_types(['ios','android'])
     p.send_push
 
 The library uses `unirest`_ for communication with the UA API.
@@ -66,7 +66,7 @@ Contents:
    named_user.rst
    reports.rst
    static_lists.rst
-   location.rst
+   tag_lists.rst
    exceptions.rst
    examples.rst
    create_and_send.rst

data/docs/named_user.rst

@@ -100,3 +100,25 @@ see `the API documentation
 
     A single request may contain an add or remove field, both, or a single set
     field.
+
+Attributes
+----------
+
+Set or remove attributes on a named user. For more information, see `the API documentation
+https://docs.airship.com/api/ua/#operation-api-named_users-named_user_id-attributes-post>`__
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  airship = Urbanairship::Client.new(key: 'application_key', secret: 'master_secret')
+  named_user = Urbanairship::NamedUser.new(client: airship)
+  named_user.named_user_id = 'named_user'
+  named_user.update_attributes(attributes: [
+      { action: 'set', key: 'first_name', value: 'Firstname' },
+      { action: 'remove', key: 'nickname' },
+      { action: 'set', key: 'last_name', value: 'Lastname', timestamp: Time.now.utc }
+  ])
+
+.. note::
+
+    Timestamp is optional, if missing it will default to 'now'.

data/docs/push.rst

@@ -22,7 +22,7 @@ and device types:
     push = airship.create_push
     push.audience = UA.all
     push.notification = UA.notification(alert: 'Hello')
-    push.device_types = UA.all
+    push.device_types = UA.device_types(['ios','android'])
     push.send_push
 
 
@@ -443,12 +443,6 @@ types you wish to target with a list of strings:
 
     push.device_types = UA.device_types(['ios', 'android', 'web', 'open::example'])
 
-or with the ``all`` shortcut.
-
-.. code-block:: ruby
-
-    push.device_types = UA.all
-
 
 Delivery
 --------

data/docs/tag_lists.rst

@@ -0,0 +1,76 @@
+Tag Lists
+=========
+
+Bulk add and/or remove tags by uploading a CSV file of Airship users. For more
+information about the use of this endpoint, incluiding CSV file formatting requirements
+please see `the Airship Tag Lists API documentation 
+<https://docs.airship.com/api/ua/#tag-tag-lists>`__
+
+
+Create List
+-----------
+
+Add tags to your contacts by creating a list and uploading CSV file with user identifiers. 
+The body of the request contains the name, description, and optional metadata for the 
+list. After you define a list, you populate it with a call to the Upload Tag List method.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key: 'app_key', secret: 'master_secret')
+    tags = {'tag_group_name': ['tag1', 'tag2']}
+
+    tag_list = UA::TagList.new(client: airship)
+    tag_list.name = 'ua_tags_list_name'
+    tag_list.create(description: 'description', extra: {'key': 'value'}, add: tags)
+
+
+Upload List
+-----------
+
+Upload a CSV that will set tag values on the specified channels or named users. See `the
+Airship API documentation <https://docs.airship.com/api/ua/#operation-api-tag-lists-list_name-csv-put>`__ for CSV formatting requirements. Set 
+the optional `gzip` parameter to `true` if your file is gzip compressed.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key: 'app_key', secret: 'master_secret')
+
+    tag_list = UA::TagList.new(client: airship)
+    tag_list.name = 'ua_tags_list_name'
+    tag_list.upload(csv_file: 'file_content', gzip: true)
+
+
+Dowload List Errors
+-------------------
+
+During processing, after a list is uploaded, errors can occur. Depending on the type 
+of list processing, an error file may be created, showing a user exactly what went wrong.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key: 'app_key', secret: 'master_secret')
+
+    tag_list = UA::TagList.new(client: airship)
+    error_csv = tag_list.errors
+
+
+Retrieve All Tag Lists
+----------------------
+
+Retrieve information about all tag lists. This call returns a list of metadata that 
+will not contain the actual lists of users.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key: 'app_key', secret: 'master_secret')
+
+    tag_list = UA::TagList.new(client: airship)
+    list_response = tag_list.list

data/example/pusher.rb

@@ -3,19 +3,15 @@ class Pusher
 	require 'urbanairship'
 	UA = Urbanairship
 
-	def send_message
+	def send_broadcast_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.device_types = UA.device_types(['ios','android'])
 		p.send_push
 	end
 
 end
 
-Pusher.new.send_message
+Pusher.new.send_broadcast_message

data/lib/urbanairship/client.rb

@@ -52,9 +52,9 @@ module Urbanairship
 
         raise ArgumentError.new("path and url can't be both nil") if path.nil? && url.nil?
 
-        headers = {'User-agent' => 'UARubyLib/' + Urbanairship::VERSION}
+        headers = {'User-Agent' => 'UARubyLib/' + Urbanairship::VERSION + ' ' + @key}
         headers['Accept'] = 'application/vnd.urbanairship+json; version=3'
-        headers['Content-type'] = content_type unless content_type.nil?
+        headers['Content-Type'] = content_type unless content_type.nil?
         headers['Content-Encoding'] = encoding unless encoding.nil?
 
         if auth_type == :bearer

data/lib/urbanairship/common.rb

@@ -4,6 +4,8 @@ require 'urbanairship/loggable'
 module Urbanairship
   # Features mixed in to all classes
   module Common
+    CONTENT_TYPE = 'application/json'
+
     def apid_path(path='')
       "/apids/#{path}"
     end
@@ -32,10 +34,6 @@ module Urbanairship
       "/lists/#{path}"
     end
 
-    def location_path(path='')
-      "/location/#{path}"
-    end
-
     def named_users_path(path='')
       "/named_users/#{path}"
     end
@@ -64,6 +62,10 @@ module Urbanairship
       "/segments/#{path}"
     end
 
+    def tag_lists_path(path='')
+      "/tag-lists/#{path}"
+    end
+
     # Helper method for required keyword args in Ruby 2.0 that is compatible with 2.1+
     # @example
     #   def say(greeting: required('greeting'))

data/lib/urbanairship/devices/attributes.rb

@@ -0,0 +1,53 @@
+
+module Urbanairship
+  module  Devices
+    class Attributes
+
+      SET = 'set'
+      REMOVE = 'remove'
+
+      def initialize(attributes)
+        @attributes = attributes
+      end
+
+      def payload
+        @payload ||= { attributes: attributes_list }
+      end
+
+      private
+
+      def attributes_list
+        @attributes.map{ |attribute| attribute_payload(attribute) }
+      end
+
+      def attribute_payload(attribute)
+        if REMOVE == attribute[:action]
+          remove_payload(attribute)
+        else
+          set_payload(attribute)
+        end
+      end
+
+      def set_payload(attribute)
+        {
+          action: SET,
+          key: attribute[:key],
+          value: attribute[:value],
+          timestamp: (attribute[:timestamp] || timestamp).iso8601,
+        }
+      end
+
+      def remove_payload(attribute)
+        {
+          action: REMOVE,
+          key: attribute[:key],
+          timestamp: (attribute[:timestamp] || timestamp).iso8601,
+        }
+      end
+
+      def timestamp
+        @timestamp ||= Time.now.utc
+      end
+    end
+  end
+end

data/lib/urbanairship/devices/named_user.rb

@@ -1,6 +1,5 @@
 require 'urbanairship'
 
-
 module Urbanairship
   module Devices
     class NamedUser
@@ -13,6 +12,17 @@ module Urbanairship
         @named_user_id =  nil
       end
 
+      def update_attributes(attributes: required('attributes'))
+        response = @client.send_request(
+          method: 'POST',
+          body: Urbanairship::Attributes.new(attributes).payload.to_json,
+          path: named_users_path("#{@named_user_id}/attributes"),
+          content_type: CONTENT_TYPE,
+        )
+        logger.info { "Updated attributes for named_user #{@named_user_id}" }
+        response
+      end
+
       def associate(channel_id: required('channel_id'), device_type: nil)
         fail ArgumentError,
              'named_user_id is required for association' if @named_user_id.nil?
@@ -20,13 +30,13 @@ module Urbanairship
         payload = {}
         payload['channel_id'] = channel_id
         payload['device_type'] = device_type unless device_type.nil?
-        payload['named_user_id'] = @named_user_id
+        payload['named_user_id'] = @named_user_id.to_s
 
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          path: named_users_path('/associate'),
-          content_type: 'application/json'
+          path: named_users_path('associate'),
+          content_type: CONTENT_TYPE
         )
         logger.info { "Associated channel_id #{channel_id} with named_user #{@named_user_id}" }
         response
@@ -40,8 +50,8 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          path: named_users_path('/disassociate'),
-          content_type: 'application/json'
+          path: named_users_path('disassociate'),
+          content_type: CONTENT_TYPE
         )
         logger.info { "Dissociated channel_id #{channel_id}" }
         response
@@ -51,8 +61,8 @@ module Urbanairship
         fail ArgumentError,
            'named_user_id is required for lookup' if @named_user_id.nil?
         response = @client.send_request(
-            method: 'GET',
-            path: named_users_path('?id=' + @named_user_id),
+          method: 'GET',
+          path: named_users_path('?id=' + @named_user_id),
         )
         logger.info { "Retrieved information on named_user_id #{@named_user_id}" }
         response
@@ -101,8 +111,8 @@ module Urbanairship
         response = @client.send_request(
           method: 'POST',
           body: JSON.dump(payload),
-          path: named_users_path('/uninstall'),
-          content_type: 'application/json'
+          path: named_users_path('uninstall'),
+          content_type: CONTENT_TYPE
         )
         logger.info { "Uninstalled named_user_ids #{@named_user_ids} " }
         response

data/lib/urbanairship/devices/tag_lists.rb

@@ -0,0 +1,82 @@
+require 'urbanairship'
+require 'tempfile'
+
+module Urbanairship
+  module Devices
+    class TagList
+      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
+      end
+
+      def create(description: nil, extra: nil, add:nil, remove: nil, set: nil)
+        fail ArgumentError, 'Name must be set' if name.nil?
+        payload = {'name': name}
+        payload['description'] = description unless description.nil?
+        payload['extra'] = extra unless extra.nil?
+        payload['add'] = add unless add.nil?
+        payload['remove'] = remove unless remove.nil?
+        payload['set'] = set unless set.nil?
+
+        response = @client.send_request(
+          method: 'POST',
+          body: JSON.dump(payload),
+          path: tag_lists_path,
+          content_type: 'application/json'
+        )
+        logger.info("Created Tag 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,
+            path: tag_lists_path(@name + '/csv/'),
+            content_type: 'text/csv',
+            encoding: gzip
+          )
+        else
+          response = @client.send_request(
+            method: 'PUT',
+            body: csv_file,
+            path: tag_lists_path(@name + '/csv/'),
+            content_type: 'text/csv'
+          )
+        end
+
+        logger.info("Uploaded a tag list for #{@name}")
+        response
+      end
+
+      def errors
+        fail ArgumentError, 'Name must be set' if name.nil?
+
+        response = @client.send_request(
+          method: 'GET',
+          path: tag_lists_path(@name + '/errors/')
+        )
+        logger.info("Got error CSV for tag list #{@name}")
+        response
+      end
+
+      def list
+        fail ArgumentError, 'Name must be set' if name.nil?
+
+        response = @client.send_request(
+          method: 'GET',
+          path: tag_lists_path
+        )
+        logger.info("Got tag lists listing")
+        response
+      end
+    end
+  end
+end

data/lib/urbanairship/push/audience.rb

@@ -78,67 +78,6 @@ module Urbanairship
         { not: child }
       end
 
-      # Select a recent date range for a location selector.
-      # Valid selectors are:
-      #   :minutes :hours :days :weeks :months :years
-      #
-      # @example
-      #   recent_date(months: 6)  # => { recent: { months: 6 }}
-      #   recent_date(weeks: 3)  # => { recent: { weeks: 3 }}
-      def recent_date(**params)
-        fail ArgumentError, 'Only one range allowed' if params.size != 1
-        k, v = params.first
-        unless DATE_TERMS.include?(k)
-          fail ArgumentError, "#{k} not in #{DATE_TERMS}"
-        end
-        { recent: { k => v } }
-      end
-
-      # Select an absolute date range for a location selector.
-      #
-      # @param resolution [Symbol] Time resolution specifier, one of
-      #                            :minutes :hours :days :weeks :months :years
-      # @param start [String] UTC start time in ISO 8601 format.
-      # @param the_end [String] UTC end time in ISO 8601 format.
-      #
-      # @example
-      #   absolute_date(resolution: :months, start: '2013-01', the_end: '2013-06')
-      #   #=> {months: {end: '2013-06', start: '2013-01'}}
-      #
-      #   absolute_date(resolution: :minutes, start: '2012-01-01 12:00',
-      #                 the_end: '2012-01-01 12:45')
-      #   #=> {minutes: {end: '2012-01-01 12:45', start: '2012-01-01 12:00'}}
-      def absolute_date(resolution: required('resolution'), start: required('start'), the_end: required('the_end'))
-        unless DATE_TERMS.include?(resolution)
-          fail ArgumentError, "#{resolution} not in #{DATE_TERMS}"
-        end
-        { resolution => { start: start, end: the_end } }
-      end
-
-      # Select a location expression.
-      #
-      # Location selectors are made up of either an id or an alias and a date
-      # period specifier. Use a date specification function to generate the time
-      # period specifier.
-      #
-      # @example ID location
-      #   location(id: '4oFkxX7RcUdirjtaenEQIV', date: recent_date(days: 4))
-      #   #=> {location: {date: {recent: {days: 4}},
-      #       id: '4oFkxX7RcUdirjtaenEQIV'}}
-      #
-      # @example Alias location
-      #   location(us_zip: '94103', date: absolute_date(
-      #            resolution: 'days', start: '2012-01-01', end: '2012-01-15'))
-      #   #=> {location: {date: {days: {end: '2012-01-15',
-      #       start: '2012-01-01'}}, us_zip: '94103'}}
-      def location(date: required('date'), **params)
-        unless params.size == 1
-          fail ArgumentError, 'One location specifier required'
-        end
-        params[:date] = date
-        { location: params }
-      end
-
       private
 
       # Clean up a UUID for use in the library

data/lib/urbanairship/version.rb

@@ -1,3 +1,3 @@
 module Urbanairship
-  VERSION = '7.0.0'
+  VERSION = '9.0.0'
 end

data/lib/urbanairship.rb

@@ -1,3 +1,4 @@
+require 'urbanairship/custom_events/custom_event'
 require 'urbanairship/custom_events/payload'
 require 'urbanairship/push/audience'
 require 'urbanairship/push/payload'
@@ -12,6 +13,7 @@ require 'urbanairship/devices/sms_notification'
 require 'urbanairship/devices/mms_notification'
 require 'urbanairship/devices/create_and_send'
 require 'urbanairship/devices/attribute'
+require 'urbanairship/devices/attributes'
 require 'urbanairship/client'
 require 'urbanairship/common'
 require 'urbanairship/configuration'
@@ -24,7 +26,7 @@ require 'urbanairship/devices/named_user'
 require 'urbanairship/devices/open_channel'
 require 'urbanairship/reports/response_statistics'
 require 'urbanairship/devices/static_lists'
-require 'urbanairship/push/location'
+require 'urbanairship/devices/tag_lists'
 require 'urbanairship/automations/pipeline'
 require 'urbanairship/automations/automation'
 require 'urbanairship/ab_tests/variant'

data/urbanairship.gemspec

@@ -35,4 +35,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'terminal-notifier-guard', '~> 1'
+  spec.add_development_dependency 'timecop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 9.0.0
 platform: ruby
 authors:
 - Airship
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-22 00:00:00.000000000 Z
+date: 2022-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -114,6 +114,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Ruby Library for using the Airship web service API for push notifications
   and rich app pages.
 email:
@@ -126,9 +140,10 @@ files:
 - ".github/ISSUE_TEMPLATE.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/SUPPORT.md"
+- ".github/workflows/ci.yaml"
+- ".github/workflows/release.yaml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - Guardfile
@@ -149,7 +164,6 @@ files:
 - docs/examples.rst
 - docs/exceptions.rst
 - docs/index.rst
-- docs/location.rst
 - docs/named_user.rst
 - docs/open_channels.rst
 - docs/push.rst
@@ -157,6 +171,7 @@ files:
 - docs/segment.rst
 - docs/sms.rst
 - docs/static_lists.rst
+- docs/tag_lists.rst
 - docs/tags.rst
 - example/pusher.rb
 - lib/urbanairship.rb
@@ -171,6 +186,7 @@ files:
 - lib/urbanairship/custom_events/custom_event.rb
 - lib/urbanairship/custom_events/payload.rb
 - lib/urbanairship/devices/attribute.rb
+- lib/urbanairship/devices/attributes.rb
 - lib/urbanairship/devices/channel_tags.rb
 - lib/urbanairship/devices/channel_uninstall.rb
 - lib/urbanairship/devices/create_and_send.rb
@@ -184,9 +200,9 @@ files:
 - lib/urbanairship/devices/sms.rb
 - lib/urbanairship/devices/sms_notification.rb
 - lib/urbanairship/devices/static_lists.rb
+- lib/urbanairship/devices/tag_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
@@ -199,7 +215,7 @@ licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -214,8 +230,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Ruby Gem for using the Airship API
 test_files: []

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.5
-  - 2.3.1

data/docs/location.rst

@@ -1,127 +0,0 @@
-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.airship.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.airship.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.airship.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.airship.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.airship.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.airship.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/lib/urbanairship/push/location.rb

@@ -1,103 +0,0 @@
-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
-        path = location_path('?q=' + name)
-        path += '&type=' + type unless type.nil?
-        resp = @client.send_request(
-          method: 'GET',
-          path: path
-        )
-        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
-        path = location_path(latitude.to_s + ',' + longitude.to_s)
-        path += '?type=' + type unless type.nil?
-        resp = @client.send_request(
-          method: 'GET',
-          path: path
-        )
-        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
-        path = location_path(lat1.to_s + ',' + long1.to_s + ',' + lat2.to_s + ',' + long2.to_s)
-        path += '?type=' + type unless type.nil?
-        resp = @client.send_request(
-          method: 'GET',
-          path: path
-        )
-        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
-        path = location_path('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
-            path += a + '&'
-          end
-          path = path.chop
-        else
-          path += from_alias
-        end
-
-        resp = @client.send_request(
-          method: 'GET',
-          path: path
-        )
-        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
-
-        path = location_path(polygon_id + '?zoom=' + zoom.to_s)
-        resp = @client.send_request(
-          method: 'GET',
-          path: path
-        )
-        logger.info("Retrieved location info for polygon #{polygon_id} and zoom level #{zoom}")
-        resp
-      end
-
-      def date_ranges
-        resp = @client.send_request(
-          method: 'GET',
-          path: segments_path('dates/')
-        )
-        logger.info('Retrieved location date ranges')
-        resp
-      end
-    end
-  end
-end