urbanairship 7.0.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fffdb1489ab1f833e816db52d94b9aea7dac527f07bde6507af1dee57f491140
-  data.tar.gz: 2255e7731044332f60b883568929e197905a690c45d905d0a75214806163434a
+  metadata.gz: 8c91f31ef623a57075fe0acde9fe467d17dc2b0bbb634070c8da11cad54b08f5
+  data.tar.gz: eefb6b294cd953148c27fa91bae207888cbb163c6ec620301aa41b243046b46a
 SHA512:
-  metadata.gz: c39e8417e51bd08077a8658589cdee0db2639e5e5d60e6de2596aa361e9640f16cb25ff284cfa55da044dd814b1b01001b84bc7b1c1dbcbbdc441c1dab7b6405
-  data.tar.gz: 209ebf90c4d266092557e387d0479ccaf8fbd3d07d05f12f78e74186c4fd0c32a00a83b306994c64de9961554cd7eb39b115dc32b5130cc9c2f564553df72eb5
+  metadata.gz: 1c19a821551da7ad1593c91ef7dd0c922dd2f4637ee74a2f29a1fcecce0db4185b09e0fa908fedcc6b124897c3bcd9a41c1070d841b6cef45436ac26a5ba3382
+  data.tar.gz: 15bd6f34bf76d038d359b79443f7c12464345ea1cf3cc959254a2350b597a5a91be89940713d3de4a5caba50495cd66ea3cb39cbb6e91ad067d511f8c69af4f8

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.2
 
 ### Airship Contribution Agreement
 [Link here](https://docs.google.com/forms/d/e/1FAIpQLScErfiz-fXSPpVZ9r8Di2Tr2xDFxt5MgzUel0__9vqUgvko7Q/viewform)

data/.travis.yml

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

data/CHANGELOG

@@ -1,3 +1,12 @@
+--------------------
+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

@@ -14,16 +14,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
@@ -141,7 +141,7 @@ Simple Tag 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 +172,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/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/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'

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}
         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

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/version.rb

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

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: 8.0.0
 platform: ruby
 authors:
 - Airship
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-22 00:00:00.000000000 Z
+date: 2021-07-02 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:
@@ -171,6 +185,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
@@ -199,7 +214,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 +229,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.1.4
+signing_key: 
 specification_version: 4
 summary: Ruby Gem for using the Airship API
 test_files: []