urbanairship 5.8.0 → 5.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e4a3dfc0a925ebcaf22800eabbc1fec1c8c59f5fd52e26f24ca87ff7eec2d5c
-  data.tar.gz: 593f328489aaffcfad92e1da6c9a86351aabee461ab408bf94d66a374bef8625
+  metadata.gz: 6dbcc6fe1884df9f5beb53e6bc29406d2d4cb51aabfab22cc45f67b714104064
+  data.tar.gz: d147e04cbeadbb51e13325ff9cd5b7af458aa22531b8aab2e4ef0c19544ae15c
 SHA512:
-  metadata.gz: 5441fa97e0611f195f39d06022e30fa7a32d55a6d8a6052c0d5f366d97a687f6e789e9de9c4ceebe0f6cc192414cf706a24a0b8572bf4d5b914e147acec94c39
-  data.tar.gz: ff5234432140b9cabac03ed2df6ef29d5398f6e8ea886d1a161fc31ee0f0c758bbc10647e736597d8524b43b9d34a1be17887af24f9a9376b1d1b75c11dd196c
+  metadata.gz: 7109db5053551032e3c6f933d07e39496b1f8d530349dba64a0b0b1d0b09ed5d2cbec46f89bd3adfe340cbfc0601d0ca089bcf17d302ad498959790915819096
+  data.tar.gz: 2e6366c2f3cbb0b35bbb68e78a1752fd32ddfeefe7316ddbcaa609b5971947d8e01c898672eee1eec617ecef222bc36928a972fefcb2b18bad0406993813536b

data/CHANGELOG

@@ -1,3 +1,10 @@
+--------------------
+5.9.0
+--------------------
+- Adds support for bearer token auth
+- Updates broken code for static lists
+- Adds support for update sms channel 
+
 --------------------
 5.8.0
 --------------------

data/docs/sms.rst

@@ -21,6 +21,25 @@ request with an opted_in key.
     sms_channel.opted_in = '2018-02-13T11:58:59'
     sms_channel.register
 
+Update SMS Channel
+-------------------
+
+To update an SMS channel you need a sender, MSISDN, and a channel ID. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    sms_channel = UA::Sms.new(client: airship)
+    sms_channel.msisdn = '15035556789'
+    sms_channel.sender = '12345'
+    sms_channel.opted_in = '2020-12-14T11:58:59'
+    sms_channel.timezone = 'America/Denver'
+    sms_channel.channel_id = 'a1b2c3d4e5f6'
+    sms_channel.update
+
+
 Opt-Out of SMS Messages
 -----------------------
 

data/docs/static_lists.rst

@@ -28,7 +28,7 @@ string keys to arbitrary JSON values.
     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' })
+    static_list.create(description: 'description', extra: {'key': 'value'})
 
 
 Upload List
@@ -71,7 +71,7 @@ Updates the metadata of a static list.
     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' })
+    static_list.update(description: 'new description', 'extra': {'new_key': 'new_value' })
 
 
 Delete List

data/lib/urbanairship/client.rb

@@ -13,10 +13,12 @@ module Urbanairship
       #
       # @param [Object] key Application Key
       # @param [Object] secret Application Secret
+      # @param [String] token Application Auth Token (for custom events endpoint)
       # @return [Object] Client
-      def initialize(key: required('key'), secret: required('secret'))
+      def initialize(key: required('key'), secret: required('secret'), token: nil)
         @key = key
         @secret = secret
+        @token = token
       end
 
       # Send a request to Airship's API
@@ -25,10 +27,11 @@ module Urbanairship
       # @param [Object] body Request Body
       # @param [Object] url Request URL
       # @param [Object] content_type Content-Type
-      # @param [Object] version API Version
+      # @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,
-                       content_type: nil, encoding: nil)
+                       content_type: nil, encoding: nil, auth_type: :basic)
         req_type = case method
           when 'GET'
             :get
@@ -46,9 +49,14 @@ module Urbanairship
         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 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
 
-        debug = "Making #{method} request to #{url}.\n"+
-            "\tHeaders:\n"
+        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"
@@ -56,15 +64,20 @@ module Urbanairship
 
         logger.debug(debug)
 
-        response = RestClient::Request.execute(
+        params = {
           method: method,
           url: url,
           headers: headers,
-          user: @key,
-          password: @secret,
           payload: body,
           timeout: Urbanairship.configuration.timeout
-        )
+        }
+
+        if auth_type == :basic
+          params[:user] = @key
+          params[:password] = @secret
+        end
+
+        response = RestClient::Request.execute(params)
 
         logger.debug("Received #{response.code} response. Headers:\n\t#{response.headers}\nBody:\n\t#{response.body}")
         Response.check_code(response.code, response)

data/lib/urbanairship/devices/channel_uninstall.rb

@@ -57,7 +57,7 @@ module Urbanairship
           content_type: 'application/json'
         )
         
-        logger.info { "Successfully unintalled open channel with address: #{address}"}
+        logger.info { "Successfully uninstalled open channel with address: #{address}"}
         response
       end
     end

data/lib/urbanairship/devices/sms.rb

@@ -5,7 +5,14 @@ module Urbanairship
     class Sms
       include Urbanairship::Common
       include Urbanairship::Loggable
-      attr_accessor :msisdn, :sender, :opted_in, :sender
+      attr_accessor :msisdn, 
+                    :sender, 
+                    :opted_in, 
+                    :sender,
+                    :locale_country,
+                    :locale_language,
+                    :timezone,
+                    :channel_id
 
       def initialize(client: required('client'))
         @client = client
@@ -31,9 +38,33 @@ module Urbanairship
         response
       end
 
+      def update
+        fail ArgumentError, 'sender must be set to update sms channel' if sender.nil?
+        fail ArgumentError, 'msisdn must be set to update sms channel' if msisdn.nil?
+        fail ArgumentError, 'channel_id must be set to update sms channel' if channel_id.nil?
+
+        payload = {
+          'msisdn': msisdn,
+          'sender': sender,
+          'opted_in': opted_in,
+          'locale_country': locale_country,
+          'locale_language': locale_language,
+          'timezone': timezone
+        }.delete_if {|key, value| value.nil?} #this removes the nil key value pairs
+
+        response = @client.send_request(
+          method: 'PUT',
+          body: JSON.dump(payload),
+          url: CHANNEL_URL + 'sms/' + channel_id,
+          content_type: 'application/json'
+        )
+        logger.info("Updating SMS channel with msisdn #{@channel_id}")
+        response
+      end
+
       def opt_out
-        fail ArgumentError, 'sender must be set to register sms channel' if sender.nil?
-        fail ArgumentError, 'msisdn must be set to register sms channel' if msisdn.nil?
+        fail ArgumentError, 'sender must be set to opt out sms channel' if sender.nil?
+        fail ArgumentError, 'msisdn must be set to opt out sms channel' if msisdn.nil?
 
         payload = {
           'msisdn': msisdn,
@@ -51,8 +82,8 @@ module Urbanairship
       end
 
       def uninstall
-        fail ArgumentError, 'sender must be set to register sms channel' if sender.nil?
-        fail ArgumentError, 'msisdn must be set to register sms channel' if msisdn.nil?
+        fail ArgumentError, 'sender must be set to uninstall sms channel' if sender.nil?
+        fail ArgumentError, 'msisdn must be set to uninstall sms channel' if msisdn.nil?
 
         payload = {
           'msisdn': msisdn,

data/lib/urbanairship/devices/static_lists.rb

@@ -13,11 +13,11 @@ module Urbanairship
         @client = client
       end
 
-      def create(description: nil, extras: nil)
+      def create(description: nil, extra: 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?
+        payload['extra'] = extra unless extra.nil?
 
         response = @client.send_request(
           method: 'POST',
@@ -51,13 +51,13 @@ module Urbanairship
         response
       end
 
-      def update(description: nil, extras: nil)
+      def update(description: nil, extra: 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?
+           'Either description or extras must be set to a value' if description.nil? and extra.nil?
         payload = {}
         payload['description'] = description unless description.nil?
-        payload['extras'] = extras unless extras.nil?
+        payload['extra'] = extra unless extra.nil?
         response = @client.send_request(
           method: 'PUT',
           body: JSON.dump(payload),

data/lib/urbanairship/version.rb

@@ -1,3 +1,3 @@
 module Urbanairship
-  VERSION = '5.8.0'
+  VERSION = '5.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 5.8.0
+  version: 5.9.0
 platform: ruby
 authors:
 - Airship
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-02 00:00:00.000000000 Z
+date: 2020-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client