urbanairship 3.2.3 → 3.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90725801ea0a0dcd8d3d9dee004e27490f1702af
-  data.tar.gz: aa29329c6d1e0f8d842470eeae4841a9f5784879
+  metadata.gz: 4088c7ba66111c0c9711aecb5147d3b94983b475
+  data.tar.gz: d1b98a68f237ee6d2e29855e9ce8ed36f4538947
 SHA512:
-  metadata.gz: 45a73240b851d941b6cec9632d3bd3161e1c2c850241c583d0eff2f0b3371fb512c58d795a30c309870ff4cd8c5039e0cafd90651d3f518f5be648ccbcbb972e
-  data.tar.gz: 73a0470ec770e2d1b96f6d60b0b88c8c1520d7af3c102f206550c66dfd7c08cd378f291afdcfa9181d2696df0f8d50a85a50b499ace632112e23a9ccf3885f52
+  metadata.gz: 7159f0a5100b974628d1a0afebd5841250ced0a4f7ecc1d1cc2a53b77acd39601af7041bd0e05df48bb08fd82f186581a32537ec6f66914ffd50cb9211bd1891
+  data.tar.gz: 0576569d8278abe88be7f38edbdfbf21048634eae6550a4d1bbfe87ef173ab541028138bcbac9b31a9b7e79c75e86a237a80c64635a2b11661924d0474255028

data/CHANGELOG

@@ -1,3 +1,9 @@
+--------------------
+3.2.4
+--------------------
+- Replace unirest dependency with rest-client
+
+
 --------------------
 3.2.3
 --------------------

data/README.rst

@@ -5,30 +5,40 @@ About
 =====
 
 ``urbanairship`` is a Ruby library for using the `Urban Airship
-<http://urbanairship.com/>`_ web service API for push notifications and rich
-app pages.
+<http://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.
+We officially support the following Ruby versions::
+
+   2.1.10
+   2.2.5
+   2.3.1
+
 
 Functionality
 =============
 
-Version 3.0 is a major upgrade and backwards incompatible with earlier versions.
+Version 3.0 is a major upgrade and backwards incompatible with earlier
+versions.
 
 To encourage the use of our SDK, which takes care of proper channel
 registration, support for device token registration has been removed.
-Support for v1 endpoints will also be removed and transitioned to their v3
-equivalents where possible.
+Support for v1 endpoints will also be removed and transitioned to their
+v3 equivalents where possible.
 
 A more detailed list of changes can be found in the CHANGELOG.
 
+
 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::
+If you have the ``bundler`` gem (if not you can get it with
+``$ gem install bundler``) add this line to your application's
+Gemfile::
 
     >>> gem 'urbanairship'
 
@@ -40,18 +50,20 @@ OR install it yourself as::
 
     >>> gem install urbanairship
 
+
 Usage
 =====
 
 Once the gem has been installed you can start sending pushes!
 See the `full documentation
-<http://docs.urbanairship.com/reference/libraries/ruby>`_, 
+<http://docs.urbanairship.com/reference/libraries/ruby>`_,
 `api examples
 <http://docs.urbanairship.com/topic-guides/api-examples.html>`_, as well as the
 `Urban Airship API Documentation
 <http://docs.urbanairship.com/api/>`_ for more
 information.
 
+
 Broadcast to All Devices
 ------------------------
 
@@ -64,8 +76,9 @@ Broadcast to All Devices
     >>> p.device_types = UA.all
     >>> p.send_push
 
+
 Simple Tag Push
--------------------------------------------------
+---------------
 
     >>> require 'urbanairship'
     >>> UA = Urbanairship
@@ -76,12 +89,14 @@ Simple Tag Push
     >>> p.device_types = UA.all
     >>> p.send_push
 
+
 Questions
 =========
 
 The best place to ask questions is our support site:
 http://support.urbanairship.com/
 
+
 Contributing
 ============
 
@@ -90,14 +105,18 @@ Contributing
 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://docs.urbanairship.com/contribution-agreement.html>`_.
+6. Sign Urban Airship's `contribution agreement
+   <http://docs.urbanairship.com/contribution-agreement.html>`_.
+
+**Note**: Changes will not be approved and merged without a signed
+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::
+After checking out the repo, ensure you have ``bundler`` installed
+(``$ gem install bundler``) run::
 
     >>> $ bin/setup
 
@@ -112,5 +131,6 @@ 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.
+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/docs/push.rst

@@ -195,75 +195,121 @@ single piece of text:
 
 .. code-block:: ruby
 
-    push.notification = UA.notification(alert="Hello, world!")
+    push.notification = UA.notification(alert: "Hello, world!")
 
-You can override the payload with platform-specific values as well.
+You can override the notification payload with one of the following platform
+keys::
+
+   ios, amazon, android, blackberry, wns, mpns
+
+In the examples below, we override the general ``'Hello World!'`` alert with
+platform-specific alerts, and we set a number of other platform-specific options.
+
+**Example iOS Override**
 
 .. code-block:: ruby
 
-    push.notification = UA.ios(
-        alert: 'hello world',
-        badge: 123,
-        sound: 'sound file',
-        extra: { 'key' => 'value', 'key2' => 'value2' }
-        expiry: '2012-01-01 12:45',
-        category: 'category_name',
-        interactive: UA.interactive(
-            type: 'ua_share',
-            button_actions: {
-                share: { share: 'Sharing is caring!' }
-            }
-        ),
-        content_available: true
+    push.notification = UA.notification(
+        alert: 'Hello World!',
+        ios: UA.ios(
+            alert: 'Hello iOS!',
+            badge: 123,
+            sound: 'sound file',
+            extra: { 'key' => 'value', 'key2' => 'value2' }
+            expiry: '2012-01-01 12:45',
+            category: 'category_name',
+            interactive: UA.interactive(
+                type: 'ua_share',
+                button_actions: {
+                    share: { share: 'Sharing is caring!' }
+                }
+            ),
+            content_available: true
+        )
     )
 
-    push.notification = UA.amazon(
-        alert: 'hello world',
-        consolidation_key: 'key',
-        expires_after: '2012-01-01 12:45',
-        extra: { 'key' => 'value', 'key2' => 'value2' },
-        title: 'title',
-        summary: 'summary',
-        interactive: UA.interactive(
-            type: 'ua_share',
-            button_actions: {
-                share: { share: 'Sharing is caring!' }
-            }
+**Example Amazon Override**
+
+.. code-block:: ruby
+
+    push.notification = UA.notification(
+        alert: 'Hello World!',
+        amazon: UA.amazon(
+            alert: 'Hello Amazon!',
+            consolidation_key: 'key',
+            expires_after: '2012-01-01 12:45',
+            extra: { 'key' => 'value', 'key2' => 'value2' },
+            title: 'title',
+            summary: 'summary',
+            interactive: UA.interactive(
+                type: 'ua_share',
+                button_actions: {
+                    share: { share: 'Sharing is caring!' }
+                }
+            )
         )
     )
 
-    push.notification = UA.android(
-        alert: 'hello world',
-        collapse_key: 'key',
-        time_to_live: 123,
-        extra: { 'key' => 'value', 'key2' => 'value2' },
-        delay_while_idle: false,
-        interactive: UA.interactive(
-            type: 'ua_share',
-            button_actions: {
-                share: { share: 'Sharing is caring!' }
-            }
+**Example Android Override**
+
+.. code-block:: ruby
+
+    push.notification = UA.notification(
+        alert: 'Hello World!',
+        android: UA.android(
+            alert: 'Hello Android!',
+            collapse_key: 'key',
+            time_to_live: 123,
+            extra: { 'key' => 'value', 'key2' => 'value2' },
+            delay_while_idle: false,
+            interactive: UA.interactive(
+                type: 'ua_share',
+                button_actions: {
+                    share: { share: 'Sharing is caring!' }
+                }
+            )
         )
     )
 
-    push.notification = UA.blackberry(
-        alert: 'hello world',
-        body: 'body',
-        content_type: 'text/plain'
+**Example BlackBerry Override**
+
+.. code-block:: ruby
+
+    push.notification = UA.notification(
+        alert: 'Hello World!',
+        blackberry: UA.blackberry(
+            alert: 'Hello BlackBerry!',
+            body: 'body',
+            content_type: 'text/plain'
+        )
     )
 
-    push.notification = UA.wns_payload(
-        alert: 'hello world',
-        tile: nil,
-        toast: nil,
-        badge: nil
+**Example WNS Override**
+
+.. code-block:: ruby
+
+    push.notification = UA.notification(
+        alert: 'Hello World!',
+        wns: UA.wns_payload(
+            alert: 'Hello WNS!',
+            tile: nil,
+            toast: nil,
+            badge: nil
+        )
     )
 
-    push.notification = UA.mpns_payload(
-        alert: 'hello world',
-        tile: nil,
-        toast: nil,
-        badge: nil
+**Example MPNS Override**
+
+.. code-block:: ruby
+
+    push.notification = UA.notification(
+        alert: 'Hello World!',
+        mpns: UA.mpns_payload(
+            alert: 'Hello MPNS!',
+            tile: nil,
+            toast: nil,
+            badge: nil
+        )
     )
 
 .. note::
@@ -311,8 +357,8 @@ Example:
 .. code-block:: ruby
 
     push.notification = UA.notification(
-        alert="Hello, world!",
-        interactive=UA.interactive(
+        alert: "Hello, world!",
+        interactive: UA.interactive(
             type: "ua_share",
             button_actions: {
                 share: {share: "Sharing is caring!"}
@@ -324,12 +370,12 @@ Button actions can also be mapped to *actions* objects as shown below:
 
 .. code-block:: ruby
 
-    shared = ua.actions(share="Sharing is caring!")
+    shared = ua.actions(share: "Sharing is caring!")
     push.notification = ua.notification(
-        alert="Hello, world!",
-        interactive=ua.interactive(
-            type = "ua_share",
-            button_actions = {
+        alert: "Hello, world!",
+        interactive: ua.interactive(
+            type: "ua_share",
+            button_actions: {
                     "share" : shared
             }
         )

data/lib/urbanairship/client.rb

@@ -1,4 +1,5 @@
-require 'unirest'
+require 'json'
+require 'rest-client'
 require 'urbanairship'
 
 
@@ -8,9 +9,6 @@ module Urbanairship
       include Urbanairship::Common
       include Urbanairship::Loggable
 
-      # set default client timeout to 5 seconds
-      Unirest.timeout(5)
-
       # Initialize the Client
       #
       # @param [Object] key Application Key
@@ -58,21 +56,20 @@ module Urbanairship
 
         logger.debug(debug)
 
-        response = Unirest.method(req_type).call(
-          url,
+        response = RestClient::Request.execute(
+          method: method,
+          url: url,
           headers: headers,
-          auth:{
-            :user=>@key,
-            :password=>@secret
-          },
-          parameters: body
+          user: @key,
+          password: @secret,
+          payload: body,
+          timeout: 5
         )
 
         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, 'headers'=>response.headers}
+        self.class.build_response(response)
       end
 
       # Create a Push Object
@@ -88,5 +85,26 @@ module Urbanairship
       def create_scheduled_push
         Push::ScheduledPush.new(self)
       end
+
+      # Build a hash from the response object
+      #
+      # @return [Hash] The response body.
+      def self.build_response(response)
+        response_hash = {'code'=>response.code.to_s, 'headers'=>response.headers}
+
+        begin
+          body = JSON.parse(response.body)
+        rescue JSON::ParserError
+          if response.body.nil? || response.body.empty?
+            body = {}
+          else
+            body = response.body
+            response_hash['error'] = 'could not parse response JSON'
+          end
+        end
+
+        response_hash['body'] = body
+        response_hash
+      end
     end
   end

data/lib/urbanairship/version.rb

@@ -1,3 +1,3 @@
 module Urbanairship
-  VERSION = '3.2.3'
+  VERSION = '3.2.4'
 end

data/urbanairship.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   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_runtime_dependency 'rest-client', '>= 1.4', '< 4.0'
 
   spec.add_development_dependency 'bundler', '~> 1'
   spec.add_development_dependency 'guard-rspec'

metadata

@@ -1,35 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 3.2.3
+  version: 3.2.4
 platform: ruby
 authors:
 - Urban Airship
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2016-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: unirest
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: '1.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   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
+        version: '1.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -188,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby Gem for using the Urban Airship API