urbanairship 3.0.2 → 3.1.0

data/lib/urbanairship/loggable.rb

@@ -1,5 +1,6 @@
 require 'logger'
 
+
 module Urbanairship
   module Loggable
 

data/lib/urbanairship/push/audience.rb

@@ -1,6 +1,7 @@
 require 'urbanairship/util'
 require 'urbanairship/common'
 
+
 module Urbanairship
   module Push
     module Audience

data/lib/urbanairship/push/push.rb

@@ -1,8 +1,8 @@
 require 'json'
-
 require 'urbanairship/common'
 require 'urbanairship/loggable'
 
+
 module Urbanairship
   module Push
 
@@ -42,8 +42,7 @@ module Urbanairship
           method: 'POST',
           body: JSON.dump(payload),
           url: PUSH_URL,
-          content_type: 'application/json',
-          version: 3
+          content_type: 'application/json'
         )
         pr = PushResponse.new(http_response_body: response['body'], http_response_code: response['code'].to_s)
         logger.info { pr.format }
@@ -84,8 +83,7 @@ module Urbanairship
           method: 'POST',
           body: JSON.dump(payload),
           url: SCHEDULES_URL,
-          content_type: 'application/json',
-          version: 3
+          content_type: 'application/json'
         )
         pr = PushResponse.new(http_response_body: response['body'], http_response_code: response['code'].to_s)
         logger.info { pr.format }
@@ -103,8 +101,7 @@ module Urbanairship
         response_body = client.send_request(
           method: 'GET',
           body: nil,
-          url: url,
-          version: 3
+          url: url
         )
         payload = JSON.load(response_body)
 
@@ -133,8 +130,7 @@ module Urbanairship
           method: 'DELETE',
           body: nil,
           url: @url,
-          content_type: 'application/json',
-          version: 3
+          content_type: 'application/json'
         )
         pr = PushResponse.new(http_response_body: response['body'], http_response_code: response['code'].to_s)
         logger.info { "Result of canceling scheduled push: #{@url} was a: [#{pr.status_code}]" }
@@ -151,8 +147,7 @@ module Urbanairship
           method: 'PUT',
           body: JSON.dump(self.payload),
           url: @url,
-          content_type: 'application/json',
-          version: 3
+          content_type: 'application/json'
         )
         pr = PushResponse.new(http_response_body: response['body'], http_response_code: response['code'].to_s)
         logger.info { pr.format }
@@ -167,11 +162,11 @@ module Urbanairship
       include Urbanairship::Common
 
       def initialize(http_response_body: nil, http_response_code: nil)
-        @payload = http_response_body || "No Content"
-        @ok = @payload['ok'] || "None"
-        @push_ids = @payload['push_ids'] || "None"
-        @schedule_url = try_helper(:first, @payload['schedule_urls']) || "None"
-        @operation_id = @payload['operation_id'] || "None"
+        @payload = ((http_response_body.nil? || http_response_body.empty?) ? {} : http_response_body)
+        @ok = @payload['ok']
+        @push_ids = @payload['push_ids']
+        @schedule_url = try_helper(:first, @payload['schedule_urls'])
+        @operation_id = @payload['operation_id']
         @status_code = http_response_code
       end
 
@@ -181,12 +176,11 @@ module Urbanairship
       def format
         base = "Received [#{@status_code}] response code. \nHeaders: \tBody:\n"
         payload.each do |key, value|
-          safe_value = value.to_s || "None"
+          safe_value = value.to_s || 'None'
           base << "#{key}:\t#{safe_value}\n"
         end
         base
       end
-
     end
   end
 end

data/lib/urbanairship/push/schedule.rb

@@ -1,5 +1,6 @@
 require 'urbanairship/util'
 
+
 module Urbanairship
   module Push
     module Schedule

data/lib/urbanairship/reports/per_push.rb

@@ -0,0 +1,97 @@
+require 'urbanairship'
+require 'time'
+
+
+module Urbanairship
+  module Reports
+    class PerPushDetail
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def get_single(push_id: required('push_id'))
+        fail ArgumentError,
+           'push_id cannot be empty' if push_id.nil?
+        url = REPORTS_URL + 'perpush/detail/' + push_id
+        response = @client.send_request(
+          method: 'GET',
+          url: url
+        )
+        logger.info("Requested per-push details for #{push_id}")
+        response
+      end
+
+      def get_batch(push_ids: required('push_ids'))
+        fail ArgumentError,
+             'push_ids must be an array' unless push_ids.kind_of?(Array)
+        fail ArgumentError,
+           'push_ids cannot be empty' if push_ids.empty?
+        fail ArgumentError,
+          'push_ids cannot contain more than 100 IDs' if push_ids.count > 100
+
+        response = @client.send_request(
+          method: 'POST',
+          body: JSON.dump('push_ids' => push_ids),
+          url: REPORTS_URL + 'perpush/detail/',
+          content_type: 'application/json'
+        )
+        logger.info("Requested info for push ids: #{push_ids}")
+        response
+      end
+    end
+
+    class PerPushSeries
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+
+      def initialize(client: required)
+        @client = client
+      end
+
+      def get(push_id: required('push_id'), precision:nil, start_date:nil, end_date:nil)
+        fail ArgumentError,
+           'push_id cannot be empty' if push_id.nil?
+        url = REPORTS_URL + 'perpush/series/' + push_id
+
+        if precision
+          precision_array = %w(HOURLY DAILY MONTHLY)
+          fail ArgumentError,
+             "Precision must be 'HOURLY', 'DAILY', or 'MONTHLY'" unless precision_array.include?(precision)
+          url += '?precision=' + precision
+        end
+
+        if start_date
+          fail ArgumentError,
+             'Precision must be included with start date' if precision.nil?
+          start_parsed = nil
+          end_parsed = nil
+
+          begin
+            start_parsed = Time.parse(start_date)
+            end_parsed = Time.parse(end_date) unless end_date.nil?
+          rescue ArgumentError
+            fail ArgumentError,
+               'start_date and end_date must be valid date strings'
+          end
+
+          fail ArgumentError,
+             'End date must be after start date' if !end_date.nil? and end_parsed <= start_parsed
+          url += '&start=' + start_parsed.iso8601
+          url += '&end=' + end_parsed.iso8601 unless end_parsed.nil?
+        end
+
+        response = @client.send_request(
+          method: 'GET',
+          url: url
+        )
+        logger.info("Send per push series request for push_id #{push_id} and url #{url}")
+        response
+      end
+    end
+  end
+end
+
+

data/lib/urbanairship/reports/response_statistics.rb

@@ -0,0 +1,157 @@
+require 'urbanairship'
+require 'time'
+
+module Urbanairship
+  module Reports
+    class Helper
+      def get_url(start_date, end_date, precision)
+        fail ArgumentError,
+           'the parameters cannot be set to nil' if start_date.nil? or end_date.nil? or precision.nil?
+        precision_array = %w(HOURLY DAILY MONTHLY)
+        fail ArgumentError,
+             "Precision must be 'HOURLY', 'DAILY', or 'MONTHLY'" unless precision_array.include?(precision)
+
+        begin
+          start_parsed = Time.parse(start_date)
+          end_parsed = Time.parse(end_date)
+        rescue ArgumentError
+          fail ArgumentError,
+             'start_date and end_date must be valid date strings'
+        end
+        url = '?start=' + start_parsed.iso8601 + '&end=' + end_parsed.iso8601
+        url += '&precision=' + precision
+      end
+    end
+
+    class IndividualResponseStats
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def get(push_id: required('push_id'))
+        fail ArgumentError,
+           'push_id cannot be nil' if push_id.nil?
+
+        url = REPORTS_URL + 'responses/' + push_id
+        response = @client.send_request(method: 'GET', url: url)
+        logger.info("Retrieved info on push_id: #{push_id}")
+        response
+      end
+    end
+
+    class ResponseList < Urbanairship::Common::PageIterator
+      def initialize(client: required('client'), start_date: required('start_date'),
+          end_date: required('end_date'), limit: nil, push_id_start: nil)
+        super(client: client)
+        fail ArgumentError,
+           'start_date and end_date are required fields' if start_date.nil? or end_date.nil?
+        fail ArgumentError,
+           'limit must be a number' if !limit.nil? and !limit.is_a? Numeric
+        fail ArgumentError,
+           'push_id_start must be a string' if !push_id_start.nil? and !push_id_start.is_a? String
+
+        begin
+          start_parsed = Time.parse(start_date)
+          end_parsed = Time.parse(end_date)
+        rescue ArgumentError
+          fail ArgumentError,
+               'start_date and end_date must be valid date strings'
+        end
+        url = REPORTS_URL + 'responses/list?start=' + start_parsed.iso8601 + '&end=' + end_parsed.iso8601
+        url += '&limit' + limit.to_s unless limit.nil?
+        url += '&push_id_start&' + push_id_start unless push_id_start.nil?
+        @next_page = url
+        @data_attribute = 'pushes'
+      end
+    end
+
+    class DevicesReport
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def get(date: required('date'))
+        fail ArgumentError,
+           'date cannot be set to nil' if date.nil?
+        begin
+          date_parsed = Time.parse(date)
+        rescue ArgumentError
+          fail ArgumentError,
+               'date must be a valid date string'
+        end
+        response = @client.send_request(
+          method: 'GET',
+          url: REPORTS_URL + 'devices/?date=' + date_parsed.iso8601
+        )
+        logger.info("Retrieved device report for date #{date}")
+        response
+      end
+    end
+
+    class OptInList < Urbanairship::Common::PageIterator
+      def initialize(client: required('client'), start_date: required('start_date'),
+                     end_date: required('end_date'), precision: required('precision'))
+        super(client: client)
+        url = Helper.new.get_url(start_date, end_date, precision)
+        @next_page = REPORTS_URL + 'optins/' + url
+        @data_attribute = 'optins'
+      end
+    end
+
+    class OptOutList < Urbanairship::Common::PageIterator
+      def initialize(client: required('client'), start_date: required('start_date'),
+                     end_date: required('end_date'), precision: required('precision'))
+        super(client: client)
+        url = Helper.new.get_url(start_date, end_date, precision)
+        @next_page = REPORTS_URL + 'optouts/' + url
+        @data_attribute = 'optouts'
+      end
+    end
+
+    class PushList < Urbanairship::Common::PageIterator
+      def initialize(client: required('client'), start_date: required('start_date'),
+                     end_date: required('end_date'), precision: required('precision'))
+        super(client: client)
+        url = Helper.new.get_url(start_date, end_date, precision)
+        @next_page = REPORTS_URL + 'sends/' + url
+        @data_attribute = 'sends'
+      end
+    end
+
+    class ResponseReportList < Urbanairship::Common::PageIterator
+      def initialize(client: required('client'), start_date: required('start_date'),
+                     end_date: required('end_date'), precision: required('precision'))
+        super(client: client)
+        url = Helper.new.get_url(start_date, end_date, precision)
+        @next_page = REPORTS_URL + 'responses/' + url
+        @data_attribute = 'responses'
+      end
+    end
+
+    class AppOpensList < Urbanairship::Common::PageIterator
+      def initialize(client: required('client'), start_date: required('start_date'),
+                     end_date: required('end_date'), precision: required('precision'))
+        super(client: client)
+        url = Helper.new.get_url(start_date, end_date, precision)
+        @next_page = REPORTS_URL + 'opens/' + url
+        @data_attribute = 'opens'
+      end
+    end
+
+    class TimeInAppList < Urbanairship::Common::PageIterator
+      def initialize(client: required('client'), start_date: required('start_date'),
+                     end_date: required('end_date'), precision: required('precision'))
+        super(client: client)
+        url = Helper.new.get_url(start_date, end_date, precision)
+        @next_page = REPORTS_URL + 'timeinapp/' + url
+        @data_attribute = 'timeinapp'
+      end
+    end
+  end
+end

data/lib/urbanairship/version.rb

@@ -1,3 +1,3 @@
 module Urbanairship
-  VERSION = '3.0.2'
+  VERSION = '3.1.0'
 end

data/lib/urbanairship.rb

@@ -2,19 +2,24 @@ require 'urbanairship/push/audience'
 require 'urbanairship/push/payload'
 require 'urbanairship/push/schedule'
 require 'urbanairship/push/push'
+require 'urbanairship/devices/segment'
+require 'urbanairship/devices/channel_uninstall'
 require 'urbanairship/client'
 require 'urbanairship/common'
 require 'urbanairship/loggable'
 require 'urbanairship/util'
 require 'urbanairship/version'
+require 'urbanairship/devices/devicelist'
+require 'urbanairship/devices/channel_tags'
+require 'urbanairship/devices/named_user'
+require 'urbanairship/reports/per_push'
+require 'urbanairship/reports/response_statistics'
 
 module Urbanairship
-  # Make these functions available in the
-  # `Urbanairship` namespace, as in the Python
-  # library.
   extend Urbanairship::Push::Audience
   extend Urbanairship::Push::Payload
   extend Urbanairship::Push::Schedule
   extend Urbanairship::Push
-
+  include Urbanairship::Devices
+  include Urbanairship::Reports
 end

data/urbanairship.gemspec

@@ -12,12 +12,12 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Ruby Gem for using the Urban Airship API'
   spec.description   = 'A Ruby Library for using the Urban Airship web service API for push notifications and rich app pages.'
-  spec.homepage      = "https://github.com/urbanairship/ruby-library"
+  spec.homepage      = 'https://github.com/urbanairship/ruby-library'
 
   spec.required_ruby_version = '>= 2.0.0'
 
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
     fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
   end

metadata

@@ -1,117 +1,117 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Urban Airship
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-29 00:00:00.000000000 Z
+date: 2015-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unirest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.1'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.1'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   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'
 - !ruby/object:Gem::Dependency
   name: pry
   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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: terminal-notifier-guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1'
 description: A Ruby Library for using the Urban Airship web service API for push notifications
@@ -122,25 +122,44 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - CHANGELOG
 - Gemfile
 - Guardfile
 - LICENSE
-- README.md
+- README.rst
 - Rakefile
 - bin/console
 - bin/setup
+- docs/Makefile
+- docs/channel_uninstall.rst
+- docs/conf.py
+- docs/devices.rst
+- docs/examples.rst
+- docs/exceptions.rst
+- docs/index.rst
+- docs/named_user.rst
+- docs/push.rst
+- docs/reports.rst
+- docs/segment.rst
+- docs/tags.rst
 - lib/urbanairship.rb
 - lib/urbanairship/client.rb
 - lib/urbanairship/common.rb
+- lib/urbanairship/devices/channel_tags.rb
+- lib/urbanairship/devices/channel_uninstall.rb
+- lib/urbanairship/devices/devicelist.rb
+- lib/urbanairship/devices/named_user.rb
+- lib/urbanairship/devices/segment.rb
 - lib/urbanairship/loggable.rb
 - lib/urbanairship/push/audience.rb
 - lib/urbanairship/push/payload.rb
 - lib/urbanairship/push/push.rb
 - lib/urbanairship/push/schedule.rb
+- lib/urbanairship/reports/per_push.rb
+- lib/urbanairship/reports/response_statistics.rb
 - lib/urbanairship/util.rb
 - lib/urbanairship/version.rb
 - urbanairship.gemspec
@@ -155,17 +174,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Ruby Gem for using the Urban Airship API