Add SubscriptionLists class

docs/devices.rst

@@ -103,3 +103,19 @@ that have been iterated over by using the ``count`` method.
         puts(apid)
     end
     puts(apid_list.count)
+
+
+Subscription Lists
+---------
+
+Subscribe or Unsubscribe Channels to/from Subscription Lists.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+
+    UA = Urbanairship
+    airship = UA::Client.new(key:'application_key', secret:'master_secret')
+    subscription_lists = UA::SubscriptionLists.new(client: airship)
+    response = subscription_lists.subscribe(list_id: "some-list", email_addresses: ["test1@example.com", "test2@example.com"])
+    puts(response)

lib/urbanairship.rb

@@ -26,6 +26,7 @@
 require 'urbanairship/devices/open_channel'
 require 'urbanairship/reports/response_statistics'
 require 'urbanairship/devices/static_lists'
+require 'urbanairship/devices/subscription_lists'
 require 'urbanairship/push/location'
 require 'urbanairship/automations/pipeline'
 require 'urbanairship/automations/automation'

lib/urbanairship/devices/subscription_lists.rb

@@ -0,0 +1,50 @@
+require 'urbanairship'
+
+
+module Urbanairship
+  module Devices
+    class SubscriptionLists
+      include Urbanairship::Common
+      include Urbanairship::Loggable
+      SUBSCRIBE = "subscribe"
+
+      def initialize(client: required('client'))
+        @client = client
+      end
+
+      def subscribe(list_id, email_addresses)
+        fail TypeError, 'list_id string must be privided' unless list_id.is_a? String
+        fail TypeError, 'email_addresses array must be privided' unless email_addresses.is_a? Array
+        fail TypeError, 'each email address must be a string' unless email_addresses&.all? { |email| email.is_a? String }
+
+        subscribe_payload = payload(SUBSCRIBE, list_id, email_addresses)
+
+        response = @client.send_request(
+          method: 'POST',
+          body: JSON.dump(subscribe_payload),
+          path: channel_path('subscription_lists'),
+          content_type: 'application/json'
+        )
+        logger.info("Subscribed #{email_addresses.count} users to #{list_id}")
+
+        response
+      end
+
+      private
+
+      def payload(action, list_id, email_addresses)
+        {
+          subscription_lists: [
+             {
+                action: action,
+                list_id: list_id
+             }
+          ],
+          audience: {
+             email_address: email_addresses
+          }
+        }
+      end
+    end
+  end
+end

spec/lib/urbanairship/devices/subscription_lists_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'urbanairship'
+
+describe Urbanairship::Devices do
+  UA = Urbanairship
+  airship = UA::Client.new(key: '123', secret: 'abc')
+
+  describe Urbanairship::Devices::SubscriptionLists do
+    let(:expected_response) do
+      {
+        body: {
+          ok: true
+        },
+        code: 202,
+      }
+    end
+    let(:list_id) { "some-list" }
+    let(:email_addresses) { ["email@example.com"] }
+
+    describe '#update_attributes' do
+      let(:payload) do
+        {
+          subscription_lists: [
+             {
+                action: "subscribe",
+                list_id: list_id
+             }
+          ],
+          audience: {
+             email_address: email_addresses
+          }
+        }
+      end
+
+      describe 'Request' do
+        it 'makes the expected request' do
+          allow(airship).to receive(:send_request) do |arguments|
+            expect(arguments).to eq(
+              method: 'POST',
+              body: payload.to_json,
+              path: '/channels/subscription_lists',
+              content_type: 'application/json',
+            )
+            expected_response
+          end
+          expect(described_class.new(client: airship).subscribe(list_id, email_addresses)).to eq(expected_response)
+        end
+
+        it 'fails and raises TypeError list_id is not a String' do
+          list_id = nil
+
+          expect{
+            described_class.new(client: airship).subscribe(list_id, email_addresses)
+          }.to raise_error(TypeError)
+        end
+
+        it 'fails and raises TypeError email_addresses is not an Array' do
+          email_addresses = nil
+
+          expect{
+            described_class.new(client: airship).subscribe(list_id, email_addresses)
+          }.to raise_error(TypeError)
+        end
+
+        it 'fails and raises TypeError an email address is not a String' do
+          email_addresses.push(123)
+
+          expect{
+            described_class.new(client: airship).subscribe(list_id, email_addresses)
+          }.to raise_error(TypeError)
+        end
+      end
+    end
+  end
+end