urbanairship 5.9.0 → 8.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dbcc6fe1884df9f5beb53e6bc29406d2d4cb51aabfab22cc45f67b714104064
-  data.tar.gz: d147e04cbeadbb51e13325ff9cd5b7af458aa22531b8aab2e4ef0c19544ae15c
+  metadata.gz: a1da985a2097fce219436538dbaa215aae47b9649ae658dd5ae16af3c3675bd8
+  data.tar.gz: ecf18938527e132580ed887081a89db81aab4665286431b06d268c3a2a6b7505
 SHA512:
-  metadata.gz: 7109db5053551032e3c6f933d07e39496b1f8d530349dba64a0b0b1d0b09ed5d2cbec46f89bd3adfe340cbfc0601d0ca089bcf17d302ad498959790915819096
-  data.tar.gz: 2e6366c2f3cbb0b35bbb68e78a1752fd32ddfeefe7316ddbcaa609b5971947d8e01c898672eee1eec617ecef222bc36928a972fefcb2b18bad0406993813536b
+  metadata.gz: a3f2dad9fb10c281a0e10c1eacddb2fd26f0ec76af4c1a6a4fe0da3ddf83648f29e6762b0cbd756d81a2fadf2a0499fb8ead0c2a873d199ec2df05f16449edea
+  data.tar.gz: 4ec1e9d2b3f145446e6a6f5bbbb1d13bc79676186335aad7e5b36779f76a34ee41fff2e48cb15eac6dbf89013a27d71ad66742534999dba654f8c656811bcc05

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/.gitignore

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

data/CHANGELOG

@@ -1,3 +1,28 @@
+--------------------
+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
+--------------------
+- Refactors base url naming
+
+--------------------
+6.0.0
+--------------------
+- Creates custom base url, and refactors urls within classes
+- Adds support for sending custom events
+
 --------------------
 5.9.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
@@ -38,17 +37,23 @@ Installation
 
 If you have the ``bundler`` gem (if not you can get it with
 ``$ gem install bundler``) add this line to your application's
-Gemfile::
+Gemfile:
+
+.. code-block::
+
+   >>> $ gem 'urbanairship'
+
+And then execute:
 
-    >>> gem 'urbanairship'
+.. code-block::
 
-And then execute::
+   >>> $ bundle
 
-    >>> $ bundle
+OR install it yourself as:
 
-OR install it yourself as::
+.. code-block::
 
-    >>> gem install urbanairship
+   >>> $ gem install urbanairship
 
 
 Configuration
@@ -56,27 +61,35 @@ 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
-    >>>   config.timeout = 60
-    >>> end
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship.configure do |config|
+     config.server = 'go.airship.eu'
+     config.log_path = '/path/to/your/logfile'
+     config.log_level = Logger::WARN
+     config.timeout = 60
+   end
+
 
 If you want to use a custom logger (e.g Rails.logger), you can do:
 
-    >>> require 'urbanairship'
-    >>> Urbanairship.configure do |config|
-    >>>   config.custom_logger = Rails.logger
-    >>>   config.log_level = Logger::WARN
-    >>>   config.timeout = 60
-    >>> end
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship.configure do |config|
+     config.custom_logger = Rails.logger
+     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).
+- **server**: Allow to define the Airship server you want to use ("go.airship.eu" or "go.urbanairship.com")
 - **timeout**: Allows to define the request timeout in seconds (the default is 5).
 
 
@@ -96,28 +109,71 @@ information.
 Broadcast to All Devices
 ------------------------
 
-    >>> require 'urbanairship'
-    >>> UA = Urbanairship
-    >>> airship = UA::Client.new(key:'application_key', secret:'master_secret')
-    >>> p = airship.create_push
-    >>> p.audience = UA.all
-    >>> p.notification = UA.notification(alert: 'Hello')
-    >>> p.device_types = UA.all
-    >>> p.send_push
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   UA = Urbanairship
 
+   airship = UA::Client.new(key:'application_key', secret:'master_secret')
+   p = airship.create_push
+   p.audience = UA.all
+   p.notification = UA.notification(alert: 'Hello')
+   p.device_types = UA.all
+   p.send_push
 
 Simple Tag Push
 ---------------
 
-    >>> require 'urbanairship'
-    >>> UA = Urbanairship
-    >>> airship = UA::Client.new(key:'application_key', secret:'master_secret')
-    >>> p = airship.create_push
-    >>> p.audience = UA.tag('some_tag')
-    >>> p.notification = UA.notification(alert: 'Hello')
-    >>> p.device_types = UA.all
-    >>> p.send_push
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   UA = Urbanairship
+
+   airship = UA::Client.new(key:'application_key', secret:'master_secret')
+   p = airship.create_push
+   p.audience = UA.tag('some_tag')
+   p.notification = UA.notification(alert: 'Hello')
+   p.device_types = UA.all
+   p.send_push
+
+Specify the Airship server used to make your requests
+-----------------------------------------------------
+By default, the request will be sent to the 'go.urbanairship.com' server:
+
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship::Client.new(key:'application_key', secret:'master_secret')
+
+You can change the server globally in the Urbanairship configuration:
+
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship.configure do |config|
+     config.server = 'go.airship.eu'
+   end
+
+   Urbanairship::Client.new(key:'application_key', secret:'master_secret')
+   # request will be sent to the 'go.airship.eu' server
+
+Finally, you can change the targeted server on a request basis:
+
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship.configure do |config|
+     config.server = 'go.airship.eu'
+   end
 
+   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.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/ab_tests/ab_test.rb

@@ -11,7 +11,7 @@ module Urbanairship
                       :offset,
                       :experiment_object,
                       :experiment_id
-                      
+
             def initialize(client: required('client'))
                 @client = client
             end
@@ -19,7 +19,7 @@ module Urbanairship
             def list_ab_test
                 response = @client.send_request(
                     method: 'GET',
-                    url: EXPERIMENTS_URL + format_url_with_params
+                    path: experiments_path(format_url_with_params)
                 )
                 logger.info("Looking up A/B Tests for project")
                 response
@@ -29,7 +29,7 @@ module Urbanairship
                 response = @client.send_request(
                     method: 'POST',
                     body: JSON.dump(experiment_object),
-                    url: EXPERIMENTS_URL,
+                    path: experiments_path,
                     content_type: 'application/json'
                 )
                 logger.info("Created A/B Test")
@@ -39,7 +39,7 @@ module Urbanairship
             def list_scheduled_ab_test
                 response = @client.send_request(
                     method: 'GET',
-                    url: EXPERIMENTS_URL + 'scheduled' + format_url_with_params
+                    path: experiments_path('scheduled' + format_url_with_params)
                 )
                 logger.info("Looking up scheduled A/B Tests for project")
                 response
@@ -49,7 +49,7 @@ module Urbanairship
                 fail ArgumentError, 'experiment_id must be set to delete individual A/B test' if @experiment_id.nil?
                 response = @client.send_request(
                     method: 'DELETE',
-                    url: EXPERIMENTS_URL + 'scheduled/' + experiment_id
+                    path: experiments_path('scheduled/' + experiment_id)
                 )
                 logger.info("Deleting A/B test with ID #{experiment_id}")
                 response
@@ -59,7 +59,7 @@ module Urbanairship
                 response = @client.send_request(
                     method: 'POST',
                     body: JSON.dump(experiment_object),
-                    url: EXPERIMENTS_URL + 'validate',
+                    path: experiments_path('validate'),
                     content_type: 'application/json'
                 )
                 logger.info("Validating A/B Test")
@@ -70,7 +70,7 @@ module Urbanairship
                 fail ArgumentError, 'experiment_id must be set to lookup individual A/B Test' if @experiment_id.nil?
                 response = @client.send_request(
                     method: 'GET',
-                    url: EXPERIMENTS_URL + experiment_id
+                    path: experiments_path(experiment_id)
                 )
                 logger.info("Looking up A/B test with ID #{experiment_id}")
                 response
@@ -85,5 +85,4 @@ module Urbanairship
             end
         end
     end
-end 
-    
+end

data/lib/urbanairship/automations/automation.rb

@@ -22,7 +22,7 @@ module Urbanairship
                 response = @client.send_request(
                     method: 'POST',
                     body: JSON.dump(pipeline_object),
-                    url: PIPELINES_URL,
+                    path: pipelines_path,
                     content_type: 'application/json'
                 )
                 logger.info("Created Automation")
@@ -32,7 +32,7 @@ module Urbanairship
             def list_automations
                 response = @client.send_request(
                     method: 'GET',
-                    url: PIPELINES_URL + format_url_with_params
+                    path: pipelines_path(format_url_with_params)
                 )
                 logger.info("Looking up automations for project")
                 response
@@ -41,7 +41,7 @@ module Urbanairship
             def list_deleted_automations
                 response = @client.send_request(
                     method: 'GET',
-                    url: PIPELINES_URL + 'deleted' + format_url_with_params
+                    path: pipelines_path('deleted' + format_url_with_params)
                 )
                 logger.info("Looking up deleted automations for project")
                 response
@@ -51,18 +51,18 @@ module Urbanairship
                 response = @client.send_request(
                     method: 'POST',
                     body: JSON.dump(pipeline_object),
-                    url: PIPELINES_URL + 'validate',
+                    path: pipelines_path('validate'),
                     content_type: 'application/json'
                 )
                 logger.info("Validating Automation")
                 response
             end
 
-            def lookup_automation 
+            def lookup_automation
                 fail ArgumentError, 'pipeline_id must be set to lookup individual automation' if @pipeline_id.nil?
                 response = @client.send_request(
                     method: 'GET',
-                    url: PIPELINES_URL + pipeline_id
+                    path: pipelines_path(pipeline_id)
                 )
                 logger.info("Looking up automation with id #{pipeline_id}")
                 response
@@ -70,22 +70,22 @@ module Urbanairship
 
             def update_automation
                 fail ArgumentError, 'pipeline_id must be set to update individual automation' if @pipeline_id.nil?
-                
+
                 response = @client.send_request(
                     method: 'PUT',
                     body: JSON.dump(pipeline_object),
-                    url: PIPELINES_URL + pipeline_id,
+                    path: pipelines_path(pipeline_id),
                     content_type: 'application/json'
                 )
                 logger.info("Validating Automation")
                 response
             end
 
-            def delete_automation 
+            def delete_automation
                 fail ArgumentError, 'pipeline_id must be set to delete individual automation' if @pipeline_id.nil?
                 response = @client.send_request(
                     method: 'DELETE',
-                    url: PIPELINES_URL + pipeline_id
+                    path: pipelines_path(pipeline_id)
                 )
                 logger.info("Deleting automation with id #{pipeline_id}")
                 response
@@ -102,4 +102,4 @@ module Urbanairship
             end
         end
     end
-end
+end

data/lib/urbanairship/client.rb

@@ -13,11 +13,15 @@ module Urbanairship
       #
       # @param [Object] key Application Key
       # @param [Object] secret Application Secret
+      # @param [String] server Airship server to use ("go.airship.eu" or "go.urbanairship.com").
+      #                        Used only when the request is sent with a "path", not an "url".
       # @param [String] token Application Auth Token (for custom events endpoint)
       # @return [Object] Client
-      def initialize(key: required('key'), secret: required('secret'), token: nil)
+      def initialize(key: required('key'), secret: required('secret'),
+                     server: Urbanairship.configuration.server, token: nil)
         @key = key
         @secret = secret
+        @server = server
         @token = token
       end
 
@@ -25,12 +29,13 @@ module Urbanairship
       #
       # @param [Object] method HTTP Method
       # @param [Object] body Request Body
+      # @param [Object] path Request path
       # @param [Object] url Request URL
       # @param [Object] content_type Content-Type
       # @param [Object] encoding Encoding
       # @param [Symbol] auth_type (:basic|:bearer)
       # @return [Object] Push Response
-      def send_request(method: required('method'), url: required('url'), body: nil,
+      def send_request(method: required('method'), path: nil, url: nil, body: nil,
                        content_type: nil, encoding: nil, auth_type: :basic)
         req_type = case method
           when 'GET'
@@ -45,17 +50,21 @@ module Urbanairship
             fail 'Method was not "GET" "POST" "PUT" or "DELETE"'
         end
 
-        headers = {'User-agent' => 'UARubyLib/' + Urbanairship::VERSION}
+        raise ArgumentError.new("path and url can't be both nil") if path.nil? && url.nil?
+
+        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
           raise ArgumentError.new('token must be provided as argument if auth_type=bearer') if @token.nil?
           headers['X-UA-Appkey'] = @key
           headers['Authorization'] = "Bearer #{@token}"
         end
 
+        url = "https://#{@server}/api#{path}" unless path.nil?
+
         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?