urbanairship 9.2.0 → 9.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8a262b36f56dcbbe4cd38fb926cff9ec835900abf5cc5564d780c3ea655fc32
-  data.tar.gz: 7ffe155e6edd97f0a8899401b3bdc68a83e7cfd46073cf430dd129116a235111
+  metadata.gz: 979edbaca3a95cc2b422ae5f1c3fda149f0eccc9b3aada416b26a50dc1e360a6
+  data.tar.gz: 002a4f86ec42e19c23c60f368a3175bd9c789312c43400705989d173b50e8ddb
 SHA512:
-  metadata.gz: 7d3aaef8a3b3dea1058a9062b84c183bd8a9d97466c4f308c200f39f691cd6f510951541e5584a0ba0359c1f41cb10a5773ce4ef21925e6b38d4e67da35f1073
-  data.tar.gz: b93ed256288f1ec16f97fd3e8bd4b0eeae0c57a1070534302c2386deb8098131e70f55fc55396f34b0e20950c4170b6f0335d2a98b9d0c8301a047b641a4f3cd
+  metadata.gz: 7ba953bb68f8c20f2c5854447fd95419311ef27c8c898bb9453e35f3d00b6d23cd8febc08e47661f8e1ba50128fcc89d89159a6fefe2c76a7b4ae96a974b78f5
+  data.tar.gz: b59971c8adcd4b59f93b79bc69a1d0adbf35e5c0938729d7f213d8bb7d0f6ae3c000384c3aee604bfadfde94363ecea27942300531b35f4acaed9bd5a082aa5e

data/.github/workflows/ci.yaml

@@ -17,6 +17,9 @@ jobs:
         uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
         with:
           ruby-version: ${{ matrix.ruby-version }}
+          bundler: none
+      - name: Install bundler 2.4
+        run: gem install bundler -v 2.4.22
       - name: Install dependencies
         run: bundle install
       - name: Run tests

data/CHANGELOG

@@ -1,3 +1,17 @@
+## 9.4.0
+
+- Adds email replace method
+- Updates Email class along with register and update methods to accept more parameters
+
+---
+
+## 9.3.0
+
+- Adds Oauth support
+- Changes default base URL from "go.airship.com" to "api.asnapius.com"
+
+---
+
 ## 9.2.0
 
 - Adds support for iOS Live Activity and Android Live Update

data/README.rst

@@ -66,7 +66,8 @@ In your app initialization, you can do something like the following:
    require 'urbanairship'
 
    Urbanairship.configure do |config|
-     config.server = 'go.airship.eu'
+     config.server = 'api.asnapieu.com'
+     config.oauth_server = 'oauth2.asnapieu.com'
      config.log_path = '/path/to/your/logfile'
      config.log_level = Logger::WARN
      config.timeout = 60
@@ -87,10 +88,11 @@ If you want to use a custom logger (e.g Rails.logger), you can do:
 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).
+- **log_path**: Allows you to define the folder where the log file will be created (the default is nil).
+- **log_level**: Allows you to define the log level and only messages at that level or higher will be printed (the default is INFO).
+- **server**: Allows you to define the Airship server you want to use ("api.asnapieu.com" for EU or "api.asnapius.com" for US)
+- **oauth_server** Allows you to define the Airship Oauth server you want to use ("oauth2.asnapieu.com" for EU or "oauth2.asnapius.com" for US)
+- **timeout**: Allows you to define the request timeout in seconds (the default is 5).
 
 
 Usage
@@ -140,7 +142,7 @@ Simple Tag Push
 
 Specify the Airship server used to make your requests
 -----------------------------------------------------
-By default, the request will be sent to the 'go.urbanairship.com' server:
+By default, the request will be sent to the 'api.asnapius.com' server:
 
 .. code-block:: ruby
 
@@ -155,11 +157,11 @@ You can change the server globally in the Urbanairship configuration:
    require 'urbanairship'
 
    Urbanairship.configure do |config|
-     config.server = 'go.airship.eu'
+     config.server = 'api.asnapieu.com'
    end
 
    Urbanairship::Client.new(key:'application_key', secret:'master_secret')
-   # request will be sent to the 'go.airship.eu' server
+   # request will be sent to the 'api.asnapieu.com' server
 
 Finally, you can change the targeted server on a request basis:
 
@@ -168,12 +170,12 @@ Finally, you can change the targeted server on a request basis:
    require 'urbanairship'
 
    Urbanairship.configure do |config|
-     config.server = 'go.airship.eu'
+     config.server = 'api.asnapieu.com'
    end
 
-   Urbanairship::Client.new(key:'application_key', secret:'master_secret', server: 'go.urbanairship.com')
+   Urbanairship::Client.new(key:'application_key', secret:'master_secret', server: 'api.asnapius.com')
    # The Urbanairship configuration is overridden by the client and the
-   # request will be sent to the 'go.urbanairship.com' server
+   # request will be sent to the 'api.asnapius.com' server
 
 Using Bearer Token Auth
 -----------------------
@@ -191,6 +193,32 @@ will use bearer token auth. Bearer token auth is required for some
 endpoints, but not supported by others. Please check `the Airship
 docs site <https://docs.airship.com/>`_ to see where it is supported.
 
+Using Oauth
+-----------
+.. code-block:: ruby
+
+    require 'urbanairship'
+
+    UA = Urbanairship
+    app_key = 'application_key'
+
+    oauth = UA::Oauth.new(
+      client_id: 'client_id',
+      key: app_key,
+      assertion_private_key: 'your_private_key',
+      scopes: ['psh', 'chn'], # Optional
+      ip_addresses: ['23.74.131.15/22'], # Optional
+      oauth_server: 'api.asnapieu.com' # Optional
+    )
+    airship = UA::Client.new(key: app_key, oauth: oauth)
+    # Then continue as you would otherwise
+
+**Note**: You can not use both Oauth and bearer token auth
+at the same time. Oauth also cannot be used with the older
+'api.urbanairship.com' and 'api.airship.eu' base URLs. Lastly
+there are some endpoints in which Oauth is not supported.
+Please check `the Airship docs site <https://docs.airship.com/>`_ to see where it is supported.
+
 Contributing
 ============
 

data/docs/email.rst

@@ -66,7 +66,6 @@ Update Email Channel
     email_channel.channel_id = '01234567-890a-bcde-f012-3456789abc0'
     email_channel.type = 'email'
     email_channel.commercial_opted_in = '2018-10-28T10:34:22'
-    email_channel.address = 'new.name@new.domain.com'
     email_channel.timezone = 'America/Los_Angeles'
     email_channel.locale_country = 'US'
     email_channel.locale_language = 'en'
@@ -75,7 +74,36 @@ Update Email Channel
 .. note::
 
   The only thing required to make a request is the channel_id. However, anything
-  that needs to be updated must also be included.
+  that needs to be updated must also be included. Please note that you cannot
+  update an email address with this method. Please use the replace method instead.
+
+Replace Email Channel
+--------------------
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    email_channel = UA::Email.new(client: airship)
+    email_channel.channel_id = '01234567-890a-bcde-f012-3456789abc0'
+    email_channel.address = 'new.name@new.domain.com'
+    email_channel.type = 'email'
+    email_channel.commercial_opted_in = '2018-10-28T10:34:22'
+    email_channel.timezone = 'America/Los_Angeles'
+    email_channel.locale_country = 'US'
+    email_channel.locale_language = 'en'
+    email_channel.update
+
+.. note::
+
+  This will replace an existing email channel and will do the following actions:
+
+  - Register a new channel
+  - Associate the new email channel with the same user as the source channel
+  - Uninstall the source channel
+
+   Address, Channel ID and type are all required parameters for this method.
 
 Email Tags
 ----------

data/lib/urbanairship/client.rb

@@ -1,11 +1,12 @@
 require 'json'
 require 'rest-client'
 require 'urbanairship'
+require 'jwt'
 
 
 module Urbanairship
     class Client
-      attr_accessor :key, :secret
+      attr_accessor :key, :secret, :token
       include Urbanairship::Common
       include Urbanairship::Loggable
 
@@ -13,15 +14,21 @@ 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").
+      # @param [String] server Airship server to use ("api.asnapieu.com" for EU or "api.asnapius.com" for US).
       #                        Used only when the request is sent with a "path", not an "url".
       # @param [String] token Application Auth Token
+      # @param [Object] oauth Oauth object
       # @return [Object] Client
-      def initialize(key: required('key'), secret: nil, server: Urbanairship.configuration.server, token: nil)
+      def initialize(key: required('key'), secret: nil, server: Urbanairship.configuration.server, token: nil, oauth: nil)
         @key = key
         @secret = secret
         @server = server
         @token = token
+        @oauth = oauth
+
+        if @oauth != nil && @token != nil
+          raise ArgumentError.new("oauth and token can't both be used at the same time.")
+        end
       end
 
       # Send a request to Airship's API
@@ -56,6 +63,16 @@ module Urbanairship
         headers['Content-Type'] = content_type unless content_type.nil?
         headers['Content-Encoding'] = encoding unless encoding.nil?
 
+        unless @oauth.nil?
+          begin
+            @token = @oauth.get_token
+          rescue RestClient::Exception => e
+            new_error = RestClient::Exception.new(e.response, e.response.code)
+            new_error.message = "error while getting oauth token: #{e.message}"
+            raise new_error
+          end
+        end
+
         if @token != nil
           auth_type = :bearer
         end

data/lib/urbanairship/configuration.rb

@@ -1,9 +1,10 @@
 module Urbanairship
   class Configuration
-    attr_accessor :custom_logger, :log_path, :log_level, :server, :timeout
+    attr_accessor :custom_logger, :log_path, :log_level, :server, :oauth_server, :timeout
 
     def initialize
-      @server = 'go.urbanairship.com'
+      @server = 'api.asnapius.com'
+      @oauth_server = 'oauth2.asnapius.com'
       @custom_logger = nil
       @log_path = nil
       @log_level = Logger::INFO

data/lib/urbanairship/devices/email.rb

@@ -7,10 +7,15 @@ module Urbanairship
       include Urbanairship::Common
       include Urbanairship::Loggable
       attr_accessor :address,
+                    :click_tracking_opted_in,
+                    :click_tracking_opted_out,
                     :commercial_opted_in,
                     :commercial_opted_out,
                     :locale_country,
                     :locale_language,
+                    :open_tracking_opted_in,
+                    :open_tracking_opted_out,
+                    :suppression_state,
                     :timezone,
                     :transactional_opted_in,
                     :transactional_opted_out,
@@ -27,10 +32,15 @@ module Urbanairship
         payload = {
           'channel': {
             'address': address,
+            'click_tracking_opted_in': click_tracking_opted_in,
+            'click_tracking_opted_out': click_tracking_opted_out,
             'commercial_opted_in': commercial_opted_in,
             'commercial_opted_out': commercial_opted_out,
             'locale_country': locale_country,
             'locale_language': locale_language,
+            'open_tracking_opted_in': open_tracking_opted_in,
+            'open_tracking_opted_out': open_tracking_opted_out,
+            'suppression_state': suppression_state,
             'timezone': timezone,
             'transactional_opted_in': transactional_opted_in,
             'transactional_opted_out': transactional_opted_out,
@@ -77,18 +87,19 @@ module Urbanairship
       end
 
       def update
-        fail ArgumentError, 'address must be set to update email channel' if channel_id.nil?
+        fail ArgumentError, 'channel_id must be set to update email channel' if channel_id.nil?
 
         channel_data =  {
           'address': address,
           'commercial_opted_in': commercial_opted_in,
           'commercial_opted_out': commercial_opted_out,
-          'localte_country': locale_country,
+          'locale_country': locale_country,
           'locale_language': locale_language,
           'timezone': timezone,
           'transactional_opted_in': transactional_opted_in,
           'transactional_opted_out': transactional_opted_out,
-          'type': type
+          'device_type': type,
+          'suppression_state': suppression_state
       }.delete_if {|key, value| value.nil?} #this removes the nil key value pairs
 
         payload = {'channel': channel_data}
@@ -102,6 +113,40 @@ module Urbanairship
         logger.info("Updating email channel with address #{@address}")
         response
       end
+
+      def replace
+        fail ArgumentError, 'channel_id must be set to update email channel' if channel_id.nil?
+        fail ArgumentError, 'address must be set to update email channel' if address.nil?
+        fail ArgumentError, 'type must be set to update email channel' if type.nil?
+
+        channel_data = {
+          'address': address,
+          'click_tracking_opted_in': click_tracking_opted_in,
+          'click_tracking_opted_out': click_tracking_opted_out,
+          'commercial_opted_in': commercial_opted_in,
+          'commercial_opted_out': commercial_opted_out,
+          'locale_country': locale_country,
+          'locale_language': locale_language,
+          'open_tracking_opted_in': open_tracking_opted_in,
+          'open_tracking_opted_out': open_tracking_opted_out,
+          'suppression_state': suppression_state,
+          'timezone': timezone,
+          'transactional_opted_in': transactional_opted_in,
+          'transactional_opted_out': transactional_opted_out,
+          'type': type
+        }.delete_if {|key, value| value.nil?} #this removes the nil key value pairs
+
+        payload = {'channel': channel_data}
+
+        response = @client.send_request(
+          method: 'POST',
+          path: channel_path('email/replace/' + channel_id),
+          body: JSON.dump(payload),
+          content_type: 'application/json'
+        )
+        logger.info("Replacing email channel with address #{@address}")
+        response
+      end
     end
 
     class EmailTags < ChannelTags

data/lib/urbanairship/oauth.rb

@@ -0,0 +1,129 @@
+require 'urbanairship'
+require 'base64'
+require 'rest-client'
+
+module Urbanairship
+  class Oauth
+    attr_accessor :client_id, :sub, :assertion_private_key, :ip_addresses, :scopes, :oauth_server
+
+    # Initialize Oauth class
+    #
+    # @param [String] client_id The Client ID found when creating Oauth credentials in the dashboard.
+    # @param [String] key The app key for the project.
+    # @param [String] assertion_private_key The private key found when creating Oauth credentials in the dashboard. Used for assertion token auth.
+    # @param [Array<String>] ip_addresses A list of CIDR representations of valid IP addresses to which the issued token is restricted. Example: ['24.20.40.0/22', '34.17.3.0/22']
+    # @param [Array<String>] scopes A list of scopes to which the issued token will be entitled. Example: ['psh', 'lst']
+    # @param [String] oauth_server The server to send Oauth token requests to. By default is 'oauth2.asnapius.com', but can be set to 'oauth2.asnapieu.com' if using the EU server.
+    # @return [Object] Oauth object
+    def initialize(client_id:, key:, assertion_private_key:, ip_addresses: [], scopes: [], oauth_server: Urbanairship.configuration.oauth_server)
+      @grant_type = 'client_credentials'
+      @client_id = client_id
+      @assertion_private_key = assertion_private_key
+      @ip_addresses = ip_addresses
+      @scopes = scopes
+      @sub = "app:#{key}"
+      @oauth_server = oauth_server
+      @token = nil
+    end
+
+    # Get an Oauth token from Airship Oauth servers.
+    #
+    # @return [String] JSON web token to be used in further Airship API requests.
+    def get_token
+      unless @token.nil?
+        decoded_jwt = JWT.decode(@token, nil, false)
+        current_time = Time.now.to_i
+        expiry_time = decoded_jwt[0]['exp']
+
+        if current_time < expiry_time
+          return @token
+        end
+      end
+
+      assertion_jwt = build_assertion_jwt
+
+      url = "https://#{@oauth_server}/token"
+      headers = {
+        'Host': @oauth_server,
+        'Content-Type': 'application/x-www-form-urlencoded',
+        'Accept': 'application/json'
+      }
+
+      params = {
+        method: :post,
+        url: url,
+        headers: headers,
+        payload: {
+          grant_type: @grant_type,
+          assertion: assertion_jwt
+        },
+        timeout: 60
+      }
+
+      retries = 0
+      max_retries = 3
+      begin
+        response = RestClient::Request.execute(params)
+        @token = JSON.parse(response.body)['access_token']
+        return @token
+      rescue RestClient::ExceptionWithResponse => e
+        if [400, 401, 406].include?(e.response.code)
+          raise e
+        else
+          retries += 1
+          if retries <= max_retries
+            sleep(retries ** 2)
+            retry
+          else
+            new_error = RestClient::Exception.new(e.response, e.response.code)
+            new_error.message = "failed after 3 attempts with error: #{e}"
+            raise new_error
+          end
+        end
+      end
+    end
+
+    # Build an assertion JWT
+    #
+    # @return [String] Assertion JWT to be used when requesting an Oauth token from Airship servers.
+    def build_assertion_jwt
+      assertion_expiration = 61
+      private_key = OpenSSL::PKey::EC.new(@assertion_private_key)
+
+      headers = {
+        alg: 'ES384',
+        kid: @client_id
+      }
+
+      claims = {
+        aud: "https://#{@oauth_server}/token",
+        exp: Time.now.to_i + assertion_expiration,
+        iat: Time.now.to_i,
+        iss: @client_id,
+        nonce: SecureRandom.uuid,
+        sub: @sub
+      }
+
+      claims[:scope] = @scopes.join(' ') if @scopes.any?
+      claims[:ipaddr] = @ip_addresses.join(' ') if @ip_addresses.any?
+
+      JWT.encode(claims, private_key, 'ES384', headers)
+    end
+
+    # Verify a public key
+    #
+    # @param [String] key_id The key ID ('kid') found in the header when decoding an Oauth token granted from Airship's servers.
+    # @return [String] The public key associated with the Key ID.
+    def verify_public_key(key_id)
+      url = "https://#{@oauth_server}/verify/public_key/#{key_id}"
+
+      headers = {
+        'Host': @oauth_server,
+        'Accept': 'text/plain'
+      }
+
+      response = RestClient.get(url, headers)
+      response.body
+    end
+  end
+end

data/lib/urbanairship/version.rb

@@ -1,3 +1,3 @@
 module Urbanairship
-  VERSION = '9.2.0'
+  VERSION = '9.4.0'
 end

data/lib/urbanairship.rb

@@ -15,6 +15,7 @@ require 'urbanairship/devices/create_and_send'
 require 'urbanairship/devices/attribute'
 require 'urbanairship/devices/attributes'
 require 'urbanairship/client'
+require 'urbanairship/oauth'
 require 'urbanairship/common'
 require 'urbanairship/configuration'
 require 'urbanairship/loggable'

data/urbanairship.gemspec

@@ -28,8 +28,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'rest-client', '>= 1.4', '< 4.0'
+  spec.add_runtime_dependency 'jwt', '>= 2.0', '< 3.0'
 
-  spec.add_development_dependency 'bundler', '>= 1'
+  spec.add_development_dependency 'bundler', '>= 1', '< 2.5'
   spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'pry', '~> 0'
   spec.add_development_dependency 'rake', '~> 12.3.3'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 9.2.0
+  version: 9.4.0
 platform: ruby
 authors:
 - Airship
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-23 00:00:00.000000000 Z
+date: 2025-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -30,6 +30,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -37,6 +57,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,6 +67,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +228,7 @@ files:
 - lib/urbanairship/devices/static_lists.rb
 - lib/urbanairship/devices/tag_lists.rb
 - lib/urbanairship/loggable.rb
+- lib/urbanairship/oauth.rb
 - lib/urbanairship/push/audience.rb
 - lib/urbanairship/push/payload.rb
 - lib/urbanairship/push/push.rb
@@ -230,7 +257,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Ruby Gem for using the Airship API