urbanairship 5.6.1 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65cc3a3fd4338610d0689454dad88addc5529cd5e8011e839360be5ab49146f3
-  data.tar.gz: af48efa2117b79b9bac9f9c634cff5ce43e572a6eaf46d4d1e940f8678adcaa7
+  metadata.gz: fffdb1489ab1f833e816db52d94b9aea7dac527f07bde6507af1dee57f491140
+  data.tar.gz: 2255e7731044332f60b883568929e197905a690c45d905d0a75214806163434a
 SHA512:
-  metadata.gz: 295d9fc6469ce209e9c2b3a108641089e65993a9e6a54673702d8f7fc97c0204a7ee2b22c2e5fed80985c262ee4690586992d0f57d7ccb8fce98fcaa548b0f53
-  data.tar.gz: f91849ee2e0b5f0e8cb4e5897058937b71c140bb25de8c283c450e16971dffc3fa996a179804eed2e6bf765817f6efbe5c4f85294ac8de2741bae71f88b2349b
+  metadata.gz: c39e8417e51bd08077a8658589cdee0db2639e5e5d60e6de2596aa361e9640f16cb25ff284cfa55da044dd814b1b01001b84bc7b1c1dbcbbdc441c1dab7b6405
+  data.tar.gz: 209ebf90c4d266092557e387d0479ccaf8fbd3d07d05f12f78e74186c4fd0c32a00a83b306994c64de9961554cd7eb39b115dc32b5130cc9c2f564553df72eb5

data/CHANGELOG

@@ -1,3 +1,33 @@
+--------------------
+7.0.0
+--------------------
+- Refactors base url naming
+
+--------------------
+6.0.0
+--------------------
+- Creates custom base url, and refactors urls within classes
+- Adds support for sending custom events
+
+--------------------
+5.9.0
+--------------------
+- Adds support for bearer token auth
+- Updates broken code for static lists
+- Adds support for update sms channel 
+
+--------------------
+5.8.0
+--------------------
+- Adds scheudling support for PTSO
+- Adds attribute support 
+
+--------------------
+5.7.0
+--------------------
+- Adds Automation support
+- Adds A/B test support
+
 --------------------
 5.6.1
 --------------------

data/README.rst

@@ -38,17 +38,23 @@ 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::
+Gemfile:
 
-    >>> gem 'urbanairship'
+.. code-block::
 
-And then execute::
+   >>> $ gem 'urbanairship'
 
-    >>> $ bundle
+And then execute:
 
-OR install it yourself as::
+.. code-block::
 
-    >>> gem install urbanairship
+   >>> $ bundle
+
+OR install it yourself as:
+
+.. code-block::
+
+   >>> $ gem install urbanairship
 
 
 Configuration
@@ -56,27 +62,35 @@ Configuration
 
 In your app initialization, you can do something like the following:
 
-    >>> require 'urbanairship'
-    >>> Urbanairship.configure do |config|
-    >>>   config.log_path = '/path/to/your/logfile'
-    >>>   config.log_level = Logger::WARN
-    >>>   config.timeout = 60
-    >>> end
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship.configure do |config|
+     config.server = 'go.airship.eu'
+     config.log_path = '/path/to/your/logfile'
+     config.log_level = Logger::WARN
+     config.timeout = 60
+   end
+
 
 If you want to use a custom logger (e.g Rails.logger), you can do:
 
-    >>> require 'urbanairship'
-    >>> Urbanairship.configure do |config|
-    >>>   config.custom_logger = Rails.logger
-    >>>   config.log_level = Logger::WARN
-    >>>   config.timeout = 60
-    >>> end
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship.configure do |config|
+     config.custom_logger = Rails.logger
+     config.log_level = Logger::WARN
+   end
 
 Available Configurations
 ------------------------
 
 - **log_path**: Allows to define the folder where the log file will be created (the default is nil).
 - **log_level**: Allows to define the log level and only messages at that level or higher will be printed (the default is INFO).
+- **server**: Allow to define the Airship server you want to use ("go.airship.eu" or "go.urbanairship.com")
 - **timeout**: Allows to define the request timeout in seconds (the default is 5).
 
 
@@ -96,28 +110,71 @@ information.
 Broadcast to All Devices
 ------------------------
 
-    >>> 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
+.. code-block:: 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
 ---------------
 
-    >>> 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
+.. code-block:: 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
+
+Specify the Airship server used to make your requests
+-----------------------------------------------------
+By default, the request will be sent to the 'go.airship.us' server:
+
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship::Client.new(key:'application_key', secret:'master_secret')
+
+You can change the server globally in the Urbanairship configuration:
+
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship.configure do |config|
+     config.server = 'go.airship.eu'
+   end
+
+   Urbanairship::Client.new(key:'application_key', secret:'master_secret')
+   # request will be sent to the 'go.airship.eu' server
+
+Finally, you can change the targeted server on a request basis:
+
+.. code-block:: ruby
+
+   require 'urbanairship'
+
+   Urbanairship.configure do |config|
+     config.server = 'go.airship.eu'
+   end
 
+   Urbanairship::Client.new(key:'application_key', secret:'master_secret', server: 'go.airship.us')
+   # The Urbanairship configuration is overridden by the client and the
+   # request will be sent to the 'go.airship.us' server
 
 Contributing
 ============

data/docs/ab_tests.rst

@@ -0,0 +1,162 @@
+A/B Tests
+=========
+
+In this client, we format A/B tests with three nesting components. The first is the Variant,
+the difference between one kind of push and another. The Variant is a part of the Experiment
+object, with many variants in an array. Lastly. AbTest handles what Experiments along with their Variants 
+get sent to the various API endpoints. Basic pushes can be added straight to the Variant object
+on the push instance variable, or a Push object can be created, and the payload applied to the
+Variant object. For more information on this please visit: https://docs.airship.com/api/ua/#tag/a/b-tests
+
+List Existing A/B Tests
+-----------------------
+
+This endpoint will return the existing A/B tests on a project. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    ab_test = UA::AbTest.new(client: airship)
+    ab_test.limit = 5
+    ab_test.list_ab_test
+
+.. note::
+
+  Should return a 200 HTTP status code as well as a list of existing A/B tests with a
+  default offset and a limit of 5. The limit and offset are optional here. 
+
+Create A/B Test
+----------------
+
+As described above, the creation of an A/B Test consists of creating a few objects, grabbing
+pertinent data out of them, and creating an A/B Test that is as complicated or as simple as you
+like. In some cases, it might be easier to assign the payload values yourself, but as pushes,
+and the tests themselves get more complicated, it is easier to let the objects do the work for you.
+
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    variant_one = UA::Variant.new(client: airship)
+    variant_one.push = {
+        "notification": {
+            "alert": "I love cereal"
+        }
+    }
+    variant_two = UA::Variant.new(client: airship)
+    variant_two.push = {
+        "notification": {
+            "alert": "I prefer oatmeal"
+        }
+    }
+    experiment = UA::Experiment.new(client: airship)
+    experiment.name = 'Neat experiment'
+    experiment.description = 'See how neat we can get'
+    experiment.audience = 'all'
+    experiment.device_types = 'all'
+    experiment.variants << variant_one.payload
+    experiment.variants << variant_two.payload 
+    ab_test = UA::AbTest.new(client: airship)
+    ab_test.experiment_object = experiment.payload 
+    ab_test.create_ab_test
+    
+.. note::
+  
+  Should return a 201 HTTP status code as well as other information detailing specific
+  information (such as push_id) for the newly created A/B Test. 
+
+List Scheduled A/B Tests
+------------------------
+
+This will list all the scheduled A/B Tests for a project. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    ab_test = UA::AbTest.new(client: airship)
+    ab_test.list_scheduled_ab_test
+
+.. note::
+
+  Should return a 200 HTTP status code. Here, you can also apply limit and offset by assigning
+  values to the instance variables on the AbTest object. 
+
+Delete A/B Test
+----------------
+
+This will delete an A/B Test with a given experiment ID. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    ab_test = UA::AbTest.new(client: airship)
+    ab_test.experiment_id = '<experiment_id>'
+    ab_test.delete_ab_test
+
+.. note::
+
+    Response should be a 200 HTTP Response
+
+Validate A/B Test
+------------------
+
+Very similar to the create A/B Test endpoint, this will validate an A/B Test to 
+see if it is formatted properly. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    variant_one = UA::Variant.new(client: airship)
+    variant_one.push = {
+        "notification": {
+            "alert": "I love cereal"
+        }
+    }
+    variant_two = UA::Variant.new(client: airship)
+    variant_two.push = {
+        "notification": {
+            "alert": "I prefer oatmeal"
+        }
+    }
+    experiment = UA::Experiment.new(client: airship)
+    experiment.name = 'Neat experiment'
+    experiment.description = 'See how neat we can get'
+    experiment.audience = 'all'
+    experiment.device_types = 'all'
+    experiment.variants << variant_one.payload
+    experiment.variants << variant_two.payload 
+    ab_test = UA::AbTest.new(client: airship)
+    ab_test.experiment_object = experiment.payload 
+    ab_test.validate_ab_test
+
+.. note::
+  
+  Should return a 200 HTTP status code. 
+
+Individual A/B Test Lookup
+--------------------------
+
+This will lookup a specific A/B Test with a given experiment_id
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    ab_test = UA::AbTest.new(client: airship)
+    ab_test.experiment_id = '<experiment_id>'
+    ab_test.lookup_ab_test
+
+.. note::
+
+  Should return a 200 HTTP status code

data/docs/attributes.rst

@@ -0,0 +1,52 @@
+Attributes
+==========
+
+Set Attribute for a Channel
+---------------------------
+
+The following will set an attribute for a given channel ID.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'app_key', secret:'secret_key')
+    channel_info = UA::ChannelInfo.new(client: airship)
+    channel_info.audience = {"ios_channel": "b8f9b663-0a3b-cf45-587a-be880946e881"}
+    channel_info.attributes =  {
+        "action": "set",
+        "key": "favorite_food",
+        "value": "cake"
+    }
+    channel_info.set_attributes
+
+.. note::
+
+    This should return a 200 response
+
+Send Push to Audience with Attribute Specifications
+---------------------------------------------------
+
+This will send a push to an audience who meet the specifications of attribute we
+set here. This example is using a text attribute where we are looking for audience
+members whose favorite food includes 'apple'. Some examples of what this could return
+would be 'apple', 'pineapple',  or 'apple pie'. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'app_key', secret:'secret_key')
+    new_attribute = UA::Attribute.new(client: airship)
+    new_attribute.attribute = 'favorite_food'
+    new_attribute.operator = 'contains'
+    new_attribute.value = 'apple'
+    push = airship.create_push
+    push.audience = new_attribute.payload
+    push.notification = UA.notification(alert: 'Hello')
+    push.device_types = ['android', 'ios', 'web']
+    push.send_push
+
+.. note::
+
+    This should return a 202 response

data/docs/automations.rst

@@ -0,0 +1,212 @@
+Automations
+===========
+
+The Automation class harnesses the Pipeline class in order to provide functionality
+for creating, listing, validating, updating, and deleting pipelines. There are a lot 
+of moving parts that go into creating a pipeline, so please view our docs on that 
+topic here: https://docs.airship.com/api/ua/#schemas%2fpipelineobject
+
+List Existing Automations
+-------------------------
+
+This is for viewing existing pipeleines for a project. There are optional parameters
+that can be passed into the URI to have control over what pipelines are returned. In the
+following example a limit query of 5 will be added to the URI. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    automation = UA::Automation.new(client: airship)
+    automation.limit = 5
+    automation.list_automations
+
+.. note::
+
+  Should return a 200 HTTP status code, and 5 of the most recent Automations
+
+Create Automation 
+-----------------
+
+This will use the Pipeline model to create an automation. You may add several
+pipelines objects to create several automations/pipelines at once. The example 
+below adds two. If you would like to just add one pipeline, forgo the array,
+and assign the pipeline payload directly to automation.pipeline_object.  
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<app_secret>')
+    pipeline_one = UA::Pipeline.new(client: airship)
+    pipeline_one.enabled = true
+    pipeline_one.immediate_trigger = {
+        "tag_added": {
+            "tag": "new_customer",
+            "group": "crm"
+        }
+    }
+    pipeline_one.outcome = {
+        "push": {
+            "audience": "triggered",
+            "device_types": "all",
+            "notification": {
+                "alert": "Hello new customer!"
+            }
+        }
+    }
+    pipeline_two = UA::Pipeline.new(client: airship)
+    pipeline_two.enabled = true
+    pipeline_two.immediate_trigger = {
+        "tag_added": {
+            "tag": "new_customer",
+            "group": "crm"
+        }
+    }
+    pipeline_two.outcome = {
+        "push": {
+            "audience": "triggered",
+            "device_types": "all",
+            "notification": {
+                "alert": "Here is a different second alert!"
+            }
+        }
+    }
+    pipelines = [pipeline_one.payload, pipeline_two.payload]
+    automation = UA::Automation.new(client: airship)
+    automation.pipeline_object = pipelines 
+    automation.create_automation
+
+.. note::
+  
+  Should return a 201 HTTP status code. 
+
+List Deleted Automations
+------------------------
+
+This is for viewing deleted pipeleines for a project. The optional param here is for "start";
+a timestamp of the starting element for paginating results in the format of YYYY-MM-DD. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    automation = UA::Automation.new(client: airship)
+    automation.start = 2020-02-20
+    automation.list_deleted_automations
+
+.. note::
+
+  Should return a 200 HTTP status code, and the deleted automations from either most current
+  or from a given start date.
+
+Validate Automation
+-------------------
+
+This endpoint is a lot like the create automation endpoint, the basic set up is the same,
+only difference here is the method selected. 
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<app_secret>')
+  pipeline = UA::Pipeline.new(client: airship)
+  pipeline.enabled = true
+  pipeline.immediate_trigger = {
+      "tag_added": {
+          "tag": "new_customer",
+          "group": "crm"
+      }
+  }
+  pipeline.outcome = {
+      "push": {
+          "audience": "triggered",
+          "device_types": "all",
+          "notification": {
+              "alert": "Hello new customer!"
+          }
+      }
+  }
+  automation = UA::Automation.new(client: airship)
+  automation.pipeline_object = pipeline.payload
+  automation.validate_automation 
+
+.. note::
+  
+  Should return a 200 HTTP status code. 
+
+Individual Automation Lookup
+----------------------------
+
+This is for looking up a single automation with a given ID. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    automation = UA::Automation.new(client: airship)
+    automation.pipeline_id = '86ad9239-373d-d0a5-d5d8-04fed18f79bc'
+    automation.lookup_automation
+
+.. note::
+
+  Should return a 200 HTTP status code, and the payload for the automation in question. 
+
+Update Automation
+-----------------
+
+This is for updating an existing automation. You must include the full payload from a POST 
+response, with the updates that you want to make within the payload. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    pipeline = UA::Pipeline.new(client: airship)
+    pipeline.enabled = true
+    pipeline.immediate_trigger = {
+      "tag_added": {
+         "tag": "new_tag_update",
+         "group": "Locale"
+        }
+    }
+    pipeline.outcome = {
+      "push": {
+         "audience": "triggered",
+         "device_types": "all",
+         "notification": {
+             "alert": "Newly created alert message!"
+            }
+        }
+    }
+    automation = UA::Automation.new(client: airship)
+    automation.pipeline_id = '0f927674-918c-31ef-51ca-e96fdd234da4'
+    automation.pipeline_object = pipeline.payload 
+    automation.update_automation
+
+.. note::
+  
+  Should return a 200 HTTP status code.   
+
+Delete Automation
+-----------------
+
+This is for deleting a pipeline with a given ID. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    automation = UA::Automation.new(client: airship)
+    automation.pipeline_id = '86ad9239-373d-d0a5-d5d8-04fed18f79bc'
+    automation.delete_automation
+
+.. note::
+
+    Response should be a 204 No Content