urbanairship 5.5.0 → 5.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 473e83567cb51164c9ed471d2e5ecbd73902624f231fd6463a07d2626d6233a6
-  data.tar.gz: dd676b778158ed24687223009942bdff1ec105bfc485987767c27f10c6de0344
+  metadata.gz: 0e4a3dfc0a925ebcaf22800eabbc1fec1c8c59f5fd52e26f24ca87ff7eec2d5c
+  data.tar.gz: 593f328489aaffcfad92e1da6c9a86351aabee461ab408bf94d66a374bef8625
 SHA512:
-  metadata.gz: e0ca4c22e57d83a0d89fa0e32ecb19db0f3ffa3b3ff5913b6f4df38df3dd73dc862b5d526cbb9654ff9fa92535dbad29b50cb516a8772ccdcbc50f416cca6068
-  data.tar.gz: 1ce0f4984b438dd40df90ccc29eeb0e4f10c99ef8a9e2f85a5af601f6ad241aa47586f78c4c2b089e989b0e01f5a595414faae82c1b6643271daf213a7b9a92a
+  metadata.gz: 5441fa97e0611f195f39d06022e30fa7a32d55a6d8a6052c0d5f366d97a687f6e789e9de9c4ceebe0f6cc192414cf706a24a0b8572bf4d5b914e147acec94c39
+  data.tar.gz: ff5234432140b9cabac03ed2df6ef29d5398f6e8ea886d1a161fc31ee0f0c758bbc10647e736597d8524b43b9d34a1be17887af24f9a9376b1d1b75c11dd196c

data/CHANGELOG

@@ -1,3 +1,31 @@
+--------------------
+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
+--------------------
+- Updates EmailNotification templating 
+
+--------------------
+5.6.0
+--------------------
+- Refactors EmailNotification class
+- Adds Create and Send implementation to Open Channel class
+
+--------------------
+5.5.1
+--------------------
+- Updates validate_url method 
+
 --------------------
 5.5.0
 --------------------

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