urbanairship 3.0.2 → 3.1.0

data/lib/urbanairship/client.rb

@@ -1,6 +1,6 @@
 require 'unirest'
-require 'urbanairship/common'
-require 'urbanairship/loggable'
+require 'urbanairship'
+
 
 module Urbanairship
     class Client
@@ -28,10 +28,9 @@ module Urbanairship
       # @param [Object] url Request URL
       # @param [Object] content_type Content-Type
       # @param [Object] version API Version
-      # @param [Object] params Parameters
       # @return [Object] Push Response
-      def send_request(method: required('method'), body: required('body'), url: required('url'),
-                       content_type: nil, version: nil, params: nil)
+      def send_request(method: required('method'), url: required('url'), body: nil,
+                       content_type: nil)
         req_type = case method
           when 'GET'
             :get
@@ -45,26 +44,30 @@ module Urbanairship
             fail 'Method was not "GET" "POST" "PUT" or "DELETE"'
         end
 
-        logger.debug("Making #{method} request to #{url}. \n\tHeaders:\n\tcontent-type: #{content_type}\n\tversion=#{version.to_s}\nBody:\n\t#{body}")
+        headers = {'User-agent' => 'UARubyLib/' + UA::VERSION}
+        headers['Accept'] = 'application/vnd.urbanairship+json; version=3'
+
+        if content_type
+          headers['Content-type'] = content_type
+        end
+
+        logger.debug("Making #{method} request to #{url}. \n\tHeaders:\n\tcontent-type: #{content_type}\n\tversion=3\nBody:\n\t#{body}")
 
         response = Unirest.method(req_type).call(
-            url,
-            headers:{
-                "Content-type" => content_type,
-                "Accept" => "application/vnd.urbanairship+json; version=" + version.to_s
-            },
-            auth:{
-                :user=>@key,
-                :password=>@secret
-            },
-            parameters: body
+          url,
+          headers: headers,
+          auth:{
+            :user=>@key,
+            :password=>@secret
+          },
+          parameters: body
         )
 
         logger.debug("Received #{response.code} response. Headers:\n\t#{response.headers}\nBody:\n\t#{response.body}")
 
         Response.check_code(response.code, response)
 
-        {'body'=>response.body, 'code'=>response.code}
+        {'body'=>response.body, 'code'=>response.code, 'headers'=>response.headers}
       end
 
       # Create a Push Object

data/lib/urbanairship/common.rb

@@ -1,5 +1,6 @@
 require 'urbanairship/loggable'
 
+
 module Urbanairship
   # Features mixed in to all classes
   module Common
@@ -13,8 +14,9 @@ module Urbanairship
     DT_FEEDBACK_URL = BASE_URL + '/device_tokens/feedback/'
     APID_FEEDBACK_URL = BASE_URL + '/apids/feedback/'
     SCHEDULES_URL = BASE_URL + '/schedules/'
-    TAGS_URL = BASE_URL + '/tags/'
     SEGMENTS_URL = BASE_URL + '/segments/'
+    NAMED_USER_URL = BASE_URL + '/named_users/'
+    REPORTS_URL = BASE_URL + '/reports/'
 
     # Helper method for required keyword args in Ruby 2.0 that is compatible with 2.1+
     # @example
@@ -92,14 +94,56 @@ module Urbanairship
       # Parse Response Codes and trigger appropriate actions.
       def self.check_code(response_code, response)
         if response_code == 401
-          raise Unauthorized, "Client is not authorized to make this request. The authorization credentials are incorrect or missing."
+          raise Unauthorized, 'Client is not authorized to make this request. The authorization credentials are incorrect or missing.'
         elsif response_code == 403
-          raise Forbidden, "Client is not forbidden from making this request. The application does not have the proper entitlement to access this feature."
+          raise Forbidden, 'Client is forbidden from making this request. The application does not have the proper entitlement to access this feature.'
         elsif !((200...300).include?(response_code))
           raise AirshipFailure.new.from_response(response)
         end
       end
     end
 
+    class PageIterator
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+      include Enumerable
+      attr_accessor :data_attribute
+
+      def initialize(client: required('client'))
+        @client = client
+        @next_page = nil
+        @data_list = nil
+        @data_attribute = nil
+      end
+
+      def load_page
+        return false unless @next_page
+        response = @client.send_request(
+            method: 'GET',
+            url: @next_page
+        )
+        logger.info("Retrieving data from: #{@next_page}")
+        check_next_page = response['body']['next_page']
+        if check_next_page != @next_page
+          @next_page = check_next_page
+        elsif check_next_page
+          # if check_page = next_page, we have repeats in the response.
+          # and we don't want to load them
+          return false
+        else
+          @next_page = nil
+        end
+        @data_list = response['body'][@data_attribute]
+        true
+      end
+
+      def each
+        while load_page
+          @data_list.each do | value |
+            yield value
+          end
+        end
+      end
+    end
   end
 end

data/lib/urbanairship/devices/channel_tags.rb

@@ -0,0 +1,73 @@
+require 'urbanairship'
+
+
+module Urbanairship
+  module Devices
+    class ChannelTags
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+      attr_writer :client
+      attr_reader :audience, :add_group, :remove_group, :set_group
+
+      def initialize(client: required('client'))
+        @client = client
+        @audience = {}
+        @add_group = {}
+        @remove_group = {}
+        @set_group = {}
+        @url = CHANNEL_URL + 'tags/'
+      end
+
+      def set_audience(ios: nil, android: nil, amazon: nil)
+        if ios
+          @audience['ios_channel'] = ios
+        end
+        if android
+          @audience['android_channel'] = android
+        end
+        if amazon
+          @audience['amazon_channel'] = amazon
+        end
+      end
+
+      def add(group_name: required('group_name'), tags: required('tags'))
+        @add_group[group_name] = tags
+      end
+
+      def remove(group_name: required('group_name'), tags: required('tags'))
+        @remove_group[group_name] = tags
+      end
+
+      def set(group_name: required('group_name'), tags: required('tags'))
+        @set_group[group_name] = tags
+      end
+
+      def send_request
+        payload = {}
+
+        fail ArgumentError,
+          'An audience is required for modifying tags' if @audience.empty?
+        fail ArgumentError,
+          'A tag request cannot both add and set tags' if !@add_group.empty? and !@set_group.empty?
+        fail ArgumentError,
+          'A tag request cannot both remove and set tags' if !@remove_group.empty? and !@set_group.empty?
+        fail ArgumentError,
+          'A tag request must add, remove, or set a tag' if @remove_group.empty? and @add_group.empty? and @set_group.empty?
+
+        payload['audience'] = @audience
+        payload['add'] = @add_group unless @add_group.empty?
+        payload['remove'] = @remove_group unless @remove_group.empty?
+        payload['set'] = @set_group unless @set_group.empty?
+
+        response = @client.send_request(
+          method: 'POST',
+          body: JSON.dump(payload),
+          url: @url,
+          content_type: 'application/json'
+        )
+        logger.info("Set tags for audience: #{@audience}")
+        response
+      end
+    end
+  end
+end

data/lib/urbanairship/devices/channel_uninstall.rb

@@ -0,0 +1,35 @@
+require 'json'
+require 'urbanairship'
+
+module Urbanairship
+  module Devices
+    class ChannelUninstall
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+      attr_reader :client
+
+      # Initialize a ChannelUninstall Object
+      #
+      # @param [Object] client
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def uninstall(channels: required('channels'))
+        chan_num = channels.length
+        fail ArgumentError,
+             'Maximum of 200 channel uninstalls exceeded.' if chan_num > 200
+
+        response = @client.send_request(
+          method: 'POST',
+          body: JSON.dump(channels),
+          url: CHANNEL_URL + 'uninstall/',
+          content_type: 'application/json'
+        )
+
+        logger.info { "Successfully uninstalled #{chan_num} channels." }
+        response
+      end
+    end
+  end
+end

data/lib/urbanairship/devices/devicelist.rb

@@ -0,0 +1,61 @@
+require 'urbanairship'
+
+
+module Urbanairship
+  module Devices
+    class ChannelInfo
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+      attr_writer :client
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def lookup(uuid: required('uuid'))
+        response = @client.send_request(
+          method: 'GET',
+          url: CHANNEL_URL + uuid
+        )
+        logger.info("Retrieved channel information for #{uuid}")
+        response['body']['channel']
+      end
+    end
+
+    class ChannelList < Urbanairship::Common::PageIterator
+      def initialize(client: required('client'))
+        super(client: client)
+        @next_page = CHANNEL_URL
+        @data_attribute = 'channels'
+      end
+    end
+
+    class Feedback
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def device_token(since: required('device token'))
+        url = DT_FEEDBACK_URL + '?since=' + since
+        get_feedback(url: url)
+      end
+
+      def apid(since: required('since'))
+        url = APID_FEEDBACK_URL + '?since=' + since
+        get_feedback(url: url)
+      end
+
+      def get_feedback(url: required('url'))
+        response = @client.send_request(
+            method: 'GET',
+            url: url
+        )
+        logger.info("Requested feedback at url #{url}")
+        response
+      end
+    end
+  end
+end

data/lib/urbanairship/devices/named_user.rb

@@ -0,0 +1,87 @@
+require 'urbanairship'
+
+
+module Urbanairship
+  module Devices
+    class NamedUser
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+      attr_accessor :named_user_id
+
+      def initialize(client: required('client'))
+        @client = client
+        @named_user_id =  nil
+      end
+
+      def associate(channel_id: required('channel_id'), device_type: required('device_type'))
+        fail ArgumentError,
+             'named_user_id is required for association' if @named_user_id.nil?
+
+        payload = {}
+        payload['channel_id'] = channel_id
+        payload['device_type'] = device_type
+        payload['named_user_id'] = @named_user_id
+
+        response = @client.send_request(
+          method: 'POST',
+          body: JSON.dump(payload),
+          url: NAMED_USER_URL + '/associate',
+          content_type: 'application/json'
+        )
+        logger.info { "Associated channel_id #{channel_id} with named_user #{@named_user_id}" }
+        response
+      end
+
+      def disassociate(channel_id: required('channel_id'), device_type: required('device_type'))
+        payload = {}
+        payload['channel_id'] = channel_id
+        payload['device_type'] = device_type
+        payload['named_user_id'] = @named_user_id unless @named_user_id.nil?
+        response = @client.send_request(
+          method: 'POST',
+          body: JSON.dump(payload),
+          url: NAMED_USER_URL + '/disassociate',
+          content_type: 'application/json'
+        )
+        logger.info { "Dissociated channel_id #{channel_id}" }
+        response
+      end
+
+      def lookup
+        fail ArgumentError,
+           'named_user_id is required for lookup' if @named_user_id.nil?
+        response = @client.send_request(
+            method: 'GET',
+            url: NAMED_USER_URL + '?id=' + @named_user_id,
+        )
+        logger.info { "Retrieved information on named_user_id #{@named_user_id}" }
+        response
+      end
+    end
+
+
+    class NamedUserTags < ChannelTags
+      include Urbanairship::Common
+
+      def initialize(client: required('client'))
+        super(client: client)
+        @url = NAMED_USER_URL + 'tags/'
+      end
+
+      def set_audience(user_ids: required('user_ids'))
+        @audience['named_user_id'] = user_ids
+      end
+    end
+
+
+    class NamedUserList < Urbanairship::Common::PageIterator
+      include Urbanairship::Common
+
+      def initialize(client: required('client'))
+        super(client: client)
+        @next_page = NAMED_USER_URL
+        @data_attribute = 'named_users'
+      end
+    end
+  end
+end

data/lib/urbanairship/devices/segment.rb

@@ -0,0 +1,109 @@
+require 'json'
+require 'urbanairship'
+
+
+module Urbanairship
+  module Devices
+    class Segment
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+      attr_accessor :display_name, :criteria
+      attr_reader :id
+
+      def initialize(client: required('client'))
+        @client = client
+        @display_name = nil
+        @criteria = nil
+        @id = nil
+      end
+
+      # Build a Segment from the display_name and criteria attributes
+      #
+      # @param [Object] client The Client
+      # @return [Object] response HTTP response
+      def create
+        fail ArgumentError,
+          'Both display_name and criteria must be set to a value' if display_name.nil? or criteria.nil?
+        payload = {
+          :display_name => @display_name,
+          :criteria => @criteria
+        }
+        response = @client.send_request(
+          method: 'POST',
+          body: JSON.dump(payload),
+          url: SEGMENTS_URL,
+          content_type: 'application/json'
+        )
+        logger.info { "Successful segment creation: #{@display_name}" }
+        seg_url = response['headers'][:location]
+        @id = seg_url.split('/')[-1]
+        response
+      end
+
+      # Build a Segment from the display_name and criteria attributes
+      #
+      # @param [Object] id The id of the segment being looked up
+      def from_id(id: required('id'))
+        fail ArgumentError,
+          'id must be set to a valid string' if id.nil?
+        response = @client.send_request(
+          method: 'GET',
+          url: SEGMENTS_URL + id
+        )
+        logger.info("Retrieved segment information for #{id}")
+        @id = id
+        @criteria = response['body']['criteria']
+        @display_name = response['body']['display_name']
+        response
+      end
+
+      # Update a segment with new criteria/display_name
+      #
+      # @ returns [Object] response HTTP response
+      def update
+        fail ArgumentError,
+          'id cannot be nil' if @id.nil?
+        fail ArgumentError,
+          'Either display_name or criteria must be set to a value' if display_name.nil? and criteria.nil?
+
+        data = {}
+        data['display_name'] = @display_name
+        data['criteria'] = @criteria
+        response = @client.send_request(
+          method: 'PUT',
+          body: JSON.dump(data),
+          url: SEGMENTS_URL + @id,
+          content_type: 'application/json'
+        )
+        logger.info { "Successful segment update: #{@display_name}" }
+        response
+      end
+
+      # Delete a segment
+      #
+      # @ returns [Object] response HTTP response
+      def delete
+        fail ArgumentError,
+          'id cannot be nil' if @id.nil?
+
+        url = SEGMENTS_URL + @id
+        response = @client.send_request(
+          method: 'DELETE',
+          url: url
+        )
+        logger.info { "Successful segment deletion: #{@display_name}" }
+        response
+      end
+    end
+
+    class SegmentList < Urbanairship::Common::PageIterator
+      include Urbanairship::Common
+
+      def initialize(client: required('client'))
+        super(client: client)
+        @next_page = SEGMENTS_URL
+        @data_attribute = 'segments'
+      end
+    end
+  end
+end