urbanairship 2.4.1 → 3.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fcee0f1f419c973ed8f480899359df8205ef23f6
+  data.tar.gz: 70e3a0e2e5f3527d25e02afb522b65dd2dcf4e16
+SHA512:
+  metadata.gz: 7dd348a203f1f9cfaf1a4e796a4c44b8b303180a91b1e0a43fa00ca6daa6f746c97cbca7ed063bb1ce35e625b2022d4d5427321dec3282ad502d9f19d9855f7f
+  data.tar.gz: d64ec3eafef734228058582157ad9abbb13e425bbfc10cfdd05b724ab64d565e3a22c5777fd53e2cefea0d289d50d6afe471eb63617ea6180ed0da995e2b609c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# App
+urbanairship.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+-f d

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.2.1
+  - 2.2.2
+script: bundle exec rspec

data/CHANGELOG

@@ -0,0 +1,13 @@
+--------------------
+3.0.1
+--------------------
+- Updating Gemspec to show required Ruby Version correctly
+
+
+
+--------------------
+3.0.0
+--------------------
+- added CHANGELOG
+- rewrite with v3 support for push and scheduled push
+- backwards incompatible with previous versions of library

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -1,29 +1,13 @@
-Copyright (c) 2012, Groupon, Inc.
-All rights reserved.
+Copyright 2015 Urban Airship
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
 
-Redistributions of source code must retain the above copyright notice,
-this list of conditions and the following disclaimer.
+    http://www.apache.org/licenses/LICENSE-2.0
 
-Redistributions in binary form must reproduce the above copyright
-notice, this list of conditions and the following disclaimer in the
-documentation and/or other materials provided with the distribution.
-
-Neither the name of GROUPON nor the names of its contributors may be
-used to endorse or promote products derived from this software without
-specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
-IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
-TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
-PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
-TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,96 @@
+[![Build Status](https://travis-ci.org/urbanairship/ruby-library.svg?branch=master)](https://travis-ci.org/urbanairship/ruby-library)
+
+# Urbanairship
+
+`urbanairship` is a Ruby library for using the [Urban Airship](www.urbanairship.com) web service API for push notifications and rich app pages.
+
+## Requirements
+As of Version 3.0, a Ruby version >= 2.0 must be used.
+
+## Functionality
+
+####BETA Release
+Version 3.0 is a major upgrade and backwards incompatible with earlier versions. This BETA release focuses on support for the new version 3 push API. There is also a major reorganization of the codebase.
+
+Note: the BETA release only supports UA's ```/push/``` and ```/schedules/``` endpoints. Expanded support for UA's other endpoints will be in the forthcoming release. 
+
+####Forthcoming Release
+To encourage the use of our SDK, which takes care of proper channel registration, support for device token registration will be removed. Support for v1 endpoints will also be removed and transitioned to their v3 equivalents where possible.
+
+## Installation
+
+If you have the ```bundler``` gem (if not you can get it with ```$ gem install bundler```) add this line to your application's Gemfile:
+
+```ruby
+gem 'urbanairship'
+```
+
+And then execute:
+
+    $ bundle
+
+OR install it yourself as:
+
+    $ gem install urbanairship
+
+## Usage
+
+Once the gem has been installed you can start sending pushes! See http://docs.urbanairship.com/topic-guides/api-examples.html for more examples.
+
+####Broadcast to All Devices
+```ruby
+require 'urbanairship'
+UA = Urbanairship
+airship = UA::Client.new(key:'application_key', secret:'master_secret')
+p = airship.create_push
+p.audience = UA.all
+p.notification = UA.notification(alert: 'Hello')  
+p.device_types = UA.all
+p.send_push
+```
+
+####Simple Tag Push
+```ruby
+require 'urbanairship'
+UA = Urbanairship
+airship = UA::Client.new(key:'application_key', secret:'master_secret')
+p = airship.create_push
+p.audience = UA.tag('some_tag')
+p.notification = UA.notification(alert: 'Hello')  
+p.device_types = UA.all
+p.send_push
+```
+
+## Questions
+The best place to ask questions is our support site: http://support.urbanairship.com/
+
+## Contributing
+
+1. Fork it ( https://github.com/urbanairship/ruby-library )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+6. Sign Urban Airship's [contribution agreement](http://urbanairship.com/legal/contribution-agreement) 
+Note: Changes will not be approved and merged without a signed contribution agreement
+
+## Development
+
+After checking out the repo, ensure you have ```bundler``` installed (```$ gem install bundler```) run 
+    
+    $ bin/setup
+     
+to install dependencies. 
+Then, run 
+   
+    $ bin/console
+     
+for an interactive prompt that will allow you to experiment.
+
+OR you can build a local gem to play with:
+
+    $ gem build urbanairship.gemspec
+    $ gem install ./urbanairship-<VERSION>.gem
+
+Having a local build will give you better logging if you are running into issues, but be careful to make sure to use our released
+public gem in Production.

data/Rakefile

@@ -1,8 +1,7 @@
-desc 'Run all the tests'
-task :default => :spec
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new do |t|
-  t.rspec_opts = ['-c', '-f progress', '-r ./spec/spec_helper.rb']
-  t.pattern = 'spec/**/*_spec.rb'
+require 'bundler/gem_tasks'
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
 end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'urbanairship'
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/lib/ext/hash.rb

@@ -0,0 +1,5 @@
+class Hash
+  def compact
+    keep_if { |_, value| !value.nil? }
+  end
+end

data/lib/ext/object.rb

@@ -0,0 +1,5 @@
+class Object
+  def try(method)
+    send method if respond_to? method
+  end
+end

data/lib/urbanairship.rb

@@ -1,213 +1,20 @@
-require 'json'
-require 'net/https'
-require 'time'
-
-require File.join(File.dirname(__FILE__), 'urbanairship/response')
+require 'urbanairship/push/audience'
+require 'urbanairship/push/payload'
+require 'urbanairship/push/schedule'
+require 'urbanairship/push/push'
+require 'urbanairship/client'
+require 'urbanairship/common'
+require 'urbanairship/loggable'
+require 'urbanairship/util'
+require 'urbanairship/version'
 
 module Urbanairship
-  begin
-    require 'system_timer'
-    Timer = SystemTimer
-  rescue LoadError
-    require 'timeout'
-    Timer = Timeout
-  end
-
-  module ClassMethods
-    attr_accessor :application_key, :application_secret, :master_secret, :logger, :request_timeout, :provider
-
-    def register_device(device_token, options = {})
-      body = parse_register_options(options).to_json
-
-      if ( (options[:provider] || @provider) == :android ) || ( (options[:provider] || @provider) == 'android' )
-        do_request(:put, "/api/apids/#{device_token}", :body => body, :authenticate_with => :application_secret)
-      else
-        do_request(:put, "/api/device_tokens/#{device_token}", :body => body, :authenticate_with => :application_secret)
-      end
-    end
-
-    def unregister_device(device_token, options = {})
-      if ( (options[:provider] || @provider) == :android ) || ( (options[:provider] || @provider) == 'android' )
-        do_request(:delete, "/api/apids/#{device_token}", :authenticate_with => :application_secret)
-      else
-        do_request(:delete, "/api/device_tokens/#{device_token}", :authenticate_with => :application_secret)
-      end
-    end
-
-    def device_info(device_token, options = {})
-      if ( (options[:provider] || @provider) == :android ) || ( (options[:provider] || @provider) == 'android' )
-        do_request(:get, "/api/apids/#{device_token}", :authenticate_with => :application_secret)
-      else
-        do_request(:get, "/api/device_tokens/#{device_token}", :authenticate_with => :application_secret)
-      end
-    end
-
-    def delete_scheduled_push(param)
-      warn "[DEPRECATED] http://docs.urbanairship.com/reference/api/v3/api-v3-migration-guide.html#api-push-batch"
-      path = param.is_a?(Hash) ? "/api/push/scheduled/alias/#{param[:alias].to_s}" : "/api/push/scheduled/#{param.to_s}"
-      do_request(:delete, path, :authenticate_with => :master_secret)
-    end
-
-    def push(options = {})
-      body = parse_push_options(options.dup).to_json
-      do_request(:post, "/api/push/", :body => body, :authenticate_with => :master_secret, :version => options[:version])
-    end
-
-    def push_to_segment(options = {})
-      warn "[DEPRECATED] http://docs.urbanairship.com/reference/api/v3/api-v3-migration-guide.html#api-push-segments"
-      body = parse_push_options(options).to_json
-      do_request(:post, "/api/push/segments", :body => body, :authenticate_with => :master_secret)
-    end
-
-    def batch_push(notifications = [])
-      warn "[DEPRECATION] http://docs.urbanairship.com/reference/api/v3/api-v3-migration-guide.html#api-push-batch"
-      body = notifications.map{|notification| parse_push_options(notification)}.to_json
-      do_request(:post, "/api/push/batch/", :body => body, :authenticate_with => :master_secret)
-    end
-
-    def broadcast_push(options = {})
-      warn "[DEPRECATED] http://docs.urbanairship.com/reference/api/v3/api-v3-migration-guide.html#api-push-broadcast"
-      body = parse_push_options(options).to_json
-      do_request(:post, "/api/push/broadcast/", :body => body, :authenticate_with => :master_secret)
-    end
-
-    def feedback(time)
-      do_request(:get, "/api/device_tokens/feedback/?since=#{format_time(time)}", :authenticate_with => :master_secret)
-    end
-
-    def tags
-      do_request(:get, "/api/tags/", :authenticate_with => :master_secret)
-    end
-
-    def add_tag(tag)
-      do_request(:put, "/api/tags/#{tag}", :authenticate_with => :master_secret, :content_type => 'text/plain')
-    end
-
-    def remove_tag(tag)
-      do_request(:delete, "/api/tags/#{tag}", :authenticate_with => :master_secret)
-    end
-
-    def tags_for_device(device_token)
-      do_request(:get, "/api/device_tokens/#{device_token}/tags/", :authenticate_with => :master_secret)
-    end
-
-    def tag_device(params)
-      provider_field = ( (params[:provider] || @provider) == :android ) || ( (params[:provider] || @provider) == 'android' ) ? :apids : :device_tokens
-      do_request(:post, "/api/tags/#{params[:tag]}", :body => {provider_field => {:add => [params[:device_token]]}}.to_json, :authenticate_with => :master_secret)
-    end
-
-    def untag_device(params)
-      provider_field = ( (params[:provider] || @provider) == :android ) || ( (params[:provider] || @provider) == 'android' ) ? :apids : :device_tokens
-      do_request(:post, "/api/tags/#{params[:tag]}", :body => {provider_field => {:remove => [params[:device_token]]}}.to_json, :authenticate_with => :master_secret)
-    end
-
-    def device_tokens
-      do_request(:get, "/api/device_tokens/", :authenticate_with => :master_secret)
-    end
-
-    def device_tokens_count
-      do_request(:get, "/api/device_tokens/count/", :authenticate_with => :master_secret)
-    end
-
-    def segments
-      do_request(:get, "/api/segments", :authenticate_with => :master_secret)
-    end
-
-    def create_segment(segment)
-      do_request(:post, "/api/segments", :body => segment.to_json, :authenticate_with => :master_secret)
-    end
-
-    def segment(id)
-      do_request(:get, "/api/segments/#{id}", :authenticate_with => :master_secret)
-    end
-
-    def update_segment(id, segment)
-      do_request(:put, "/api/segments/#{id}", :body => segment.to_json, :authenticate_with => :master_secret)
-    end
-
-    def delete_segment(id)
-      do_request(:delete, "/api/segments/#{id}", :authenticate_with => :master_secret)
-    end
-
-    private
-
-    def do_request(http_method, path, options = {})
-      verify_configuration_values(:application_key, options[:authenticate_with])
-
-      klass = Net::HTTP.const_get(http_method.to_s.capitalize)
-
-      request = klass.new(path)
-      request.basic_auth @application_key, instance_variable_get("@#{options[:authenticate_with]}")
-      request.add_field "Content-Type", options[:content_type] || "application/json"
-      request.body = options[:body] if options[:body]
-      request["Accept"] = "application/vnd.urbanairship+json; version=#{options[:version]};"  if options[:version]
-
-      Timer.timeout(request_timeout) do
-        start_time = Time.now
-        response = http_client.request(request)
-        log_request_and_response(request, response, Time.now - start_time)
-        Urbanairship::Response.wrap(response)
-      end
-    rescue Timeout::Error
-      unless logger.nil?
-        logger.error "Urbanairship request timed out after #{request_timeout} seconds: [#{http_method} #{request.path} #{request.body}]"
-      end
-      Urbanairship::Response.wrap(nil, :body => {'error' => 'Request timeout'}, :code => '503')
-    end
-
-    def verify_configuration_values(*symbols)
-      absent_values = symbols.select{|symbol| instance_variable_get("@#{symbol}").nil? }
-      raise("Must configure #{absent_values.join(", ")} before making this request.") unless absent_values.empty?
-    end
-
-    def http_client
-      Net::HTTP.new("go.urbanairship.com", 443).tap{|http| http.use_ssl = true}
-    end
-
-    def parse_register_options(hash = {})
-      hash[:alias] = hash[:alias].to_s unless hash[:alias].nil?
-      hash
-    end
-
-    def parse_push_options(hash = {})
-      hash[:aliases] = hash[:aliases].map{|a| a.to_s} unless hash[:aliases].nil?
-      hash[:schedule_for] = hash[:schedule_for].map{|elem| process_scheduled_elem(elem)} unless hash[:schedule_for].nil?
-      hash.delete(:version)
-      hash
-    end
-
-    def log_request_and_response(request, response, time)
-      return if logger.nil?
-
-      time = (time * 1000).to_i
-      http_method = request.class.to_s.split('::')[-1]
-      logger.info "Urbanairship (#{time}ms): [#{http_method} #{request.path}, #{request.body}], [#{response.code}, #{response.body}]"
-      logger.flush if logger.respond_to?(:flush)
-    end
-
-    def format_time(time)
-      time = Time.parse(time) if time.is_a?(String)
-      time.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
-    end
-
-    def process_scheduled_elem(elem)
-      if elem.class == Hash
-        elem.merge!(:scheduled_time => format_time(elem[:scheduled_time]))
-      else
-        format_time(elem)
-      end
-    end
-
-    def request_timeout
-      @request_timeout || 5.0
-    end
-  end
-
-  class << self
-    include ClassMethods
-  end
+  # 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
 
-  class Client
-    include ClassMethods
-  end
 end