urbanairship 2.4.1 → 3.0.1

data/lib/urbanairship/push/push.rb

@@ -0,0 +1,192 @@
+require 'json'
+
+require 'ext/object'
+require 'urbanairship/common'
+require 'urbanairship/loggable'
+
+module Urbanairship
+  module Push
+
+    # A Push Notification.
+    class Push
+      attr_writer :client, :audience, :notification, :options,
+                  :device_types, :message
+      attr_reader :device_types
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+
+      # Initialize a Push Object
+      #
+      # @param [Object] client
+      def initialize(client)
+        @client = client
+      end
+
+      def payload
+        {
+          audience: @audience,
+          notification: @notification,
+          options: @options,
+          device_types: @device_types,
+          message: @message
+        }.compact
+      end
+
+      # Send the Push Object
+      #
+      # @raise [AirshipFailure] if the request failed
+      # @raise [Unauthorized] if authentication failed
+      # @raise [Forbidden] if app does not have entitlement
+      # @return [PushResponse] with `push_ids` and other response data.
+      def send_push
+        response = @client.send_request(
+          method: 'POST',
+          body: JSON.dump(payload),
+          url: PUSH_URL,
+          content_type: 'application/json',
+          version: 3
+        )
+        pr = PushResponse.new(http_response_body: response['body'], http_response_code: response['code'].to_s)
+        logger.info { pr.format }
+        pr
+      end
+    end
+
+
+    class ScheduledPush
+      attr_writer :schedule, :name, :push, :url
+      attr_reader :url, :push
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+
+      # Initialize a Scheduled Push Object
+      #
+      # @param [Object] client
+      def initialize(client)
+        @client = client
+      end
+
+      def payload
+        {
+          name: @name,
+          schedule: @schedule,
+          push: @push.payload
+        }.compact
+      end
+
+      # Schedule the Push Notification
+      #
+      # @raise [AirshipFailure] if the request failed
+      # @raise [Unauthorized] if authentication failed
+      # @raise [Forbidden] if app does not have entitlement
+      # @return [PushResponse] with `schedule_url` and other response data.
+      def send_push
+        response = @client.send_request(
+          method: 'POST',
+          body: JSON.dump(payload),
+          url: SCHEDULES_URL,
+          content_type: 'application/json',
+          version: 3
+        )
+        pr = PushResponse.new(http_response_body: response['body'], http_response_code: response['code'].to_s)
+        logger.info { pr.format }
+        @url = pr.schedule_url
+        pr
+      end
+
+      # Build a Scheduled Push Notification object its existing Scheduled Push URL
+      #
+      # @param [Object] client The Client
+      # @param [Object] url The existing Scheduled Push URL
+      # @return [Object] Scheduled Push Object
+      def self.from_url(client: required('client'), url: required('url'))
+        scheduled_push = ScheduledPush.new(client)
+        response_body = client.send_request(
+          method: 'GET',
+          body: nil,
+          url: url,
+          version: 3
+        )
+        payload = JSON.load(response_body)
+
+        p = Push.new(client)
+        p.audience = payload['push']['audience']
+        p.notification = payload['push']['notification']
+        p.device_types = payload['push']['device_types']
+        p.message = payload['push']['message']
+        p.options = payload['push']['options']
+
+        scheduled_push.name = payload['name']
+        scheduled_push.schedule = payload['schedule']
+        scheduled_push.push = p
+        scheduled_push.url = url
+        scheduled_push
+      end
+
+      # Cancel the Scheduled Push
+      #
+      # @return [Object] Push Response
+      def cancel
+        fail ArgumentError,
+             'Cannot cancel ScheduledPush without a url.' if @url.nil?
+
+        response = @client.send_request(
+          method: 'DELETE',
+          body: nil,
+          url: @url,
+          content_type: 'application/json',
+          version: 3
+        )
+        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}]" }
+        pr
+      end
+
+      # Update the Scheduled Push
+      #
+      # @return [Object]
+      def update
+        fail ArgumentError,
+             'Cannot update a ScheduledPush without a url.' if @url.nil?
+        response = @client.send_request(
+          method: 'PUT',
+          body: JSON.dump(self.payload),
+          url: @url,
+          content_type: 'application/json',
+          version: 3
+        )
+        pr = PushResponse.new(http_response_body: response['body'], http_response_code: response['code'].to_s)
+        logger.info { pr.format }
+        pr
+      end
+    end
+
+
+    # Response to a successful push notification send or schedule.
+    class PushResponse
+      attr_reader :ok, :push_ids, :schedule_url, :operation_id, :payload, :status_code
+
+      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 = @payload['schedule_urls'].try(:first) || "None"
+        @operation_id = @payload['operation_id'] || "None"
+        @status_code = http_response_code
+      end
+
+      # String Formatting of the PushResponse
+      #
+      # @return [Object] String Formatted PushResponse
+      def format
+        base = "Received [#{@status_code}] response code. \nHeaders: \tBody:\n"
+        payload.each do |key, value|
+          safe_value = value.to_s || "None"
+          base << "#{key}:\t#{safe_value}\n"
+        end
+        base
+      end
+
+    end
+  end
+end

data/lib/urbanairship/push/schedule.rb

@@ -0,0 +1,23 @@
+require 'urbanairship/util'
+
+module Urbanairship
+  module Push
+    module Schedule
+      # Select a date and time for Scheduled Push
+      def scheduled_time(datetime)
+        payload(:scheduled_time, datetime)
+      end
+
+      # Select a local date and time for Scheduled Push
+      def local_scheduled_time(datetime)
+        payload(:local_scheduled_time, datetime)
+      end
+
+      private
+
+      def payload(name, time)
+        { name => Util.time_format(time) }
+      end
+    end
+  end
+end

data/lib/urbanairship/util.rb

@@ -0,0 +1,15 @@
+module Urbanairship
+  module Util
+    module_function
+
+    # @raise [ArgumentError] unless obj matches the pattern.
+    def validate(obj, name, regex)
+      fail ArgumentError, "#{obj} isn't a valid #{name}" unless obj =~ regex
+    end
+
+    # @return [String] the datetime formatted as expected by the API
+    def time_format(datetime)
+      datetime.strftime('%Y-%m-%dT%H:%M:%S')
+    end
+  end
+end

data/lib/urbanairship/version.rb

@@ -0,0 +1,3 @@
+module Urbanairship
+  VERSION = '3.0.1'
+end

data/urbanairship.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'urbanairship/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'urbanairship'
+  spec.version       = Urbanairship::VERSION
+  spec.authors       = ['Urban Airship']
+  spec.email         = ['support@urbanairship.com']
+  spec.licenses      = ['Apache-2.0']
+
+  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.required_ruby_version = '>= 2.0.0'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'unirest', '~> 1.1', '>= 1.1.2'
+
+  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'pry', '~> 0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'terminal-notifier-guard', '~> 1'
+end

metadata

@@ -1,107 +1,174 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 2.4.1
-  prerelease: 
+  version: 3.0.1
 platform: ruby
 authors:
-- Groupon, Inc.
+- Urban Airship
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2014-10-14 00:00:00.000000000 Z
+date: 2015-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: unirest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     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
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fakeweb
+  name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: Urbanairship is a Ruby library for interacting with the Urban Airship
-  (http://urbanairship.com) API.
+- !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
+  and rich app pages.
 email:
-- rubygems@groupon.com
+- support@urbanairship.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.markdown
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG
+- Gemfile
+- Guardfile
 - LICENSE
+- README.md
 - Rakefile
-- lib/urbanairship/response.rb
+- bin/console
+- bin/setup
+- lib/ext/hash.rb
+- lib/ext/object.rb
 - lib/urbanairship.rb
-- spec/response_spec.rb
-- spec/spec_helper.rb
-- spec/urbanairship_spec.rb
-homepage: http://github.com/groupon/urbanairship
+- lib/urbanairship/client.rb
+- lib/urbanairship/common.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/util.rb
+- lib/urbanairship/version.rb
+- urbanairship.gemspec
+homepage: https://github.com/urbanairship/ruby-library
 licenses:
-- BSD
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.6
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: A Ruby wrapper for the Urban Airship API
-test_files:
-- spec/response_spec.rb
-- spec/spec_helper.rb
-- spec/urbanairship_spec.rb
-has_rdoc: 
+specification_version: 4
+summary: Ruby Gem for using the Urban Airship API
+test_files: []