outbound 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0880d96cb2a3a97eab063a1bb7f5b2528e945a74
-  data.tar.gz: 296c46923e1fa4061f56932b84e6b1ab2140c45b
+  metadata.gz: c71e5b2056a5a319a0dfc927aa93afdd35f9ea85
+  data.tar.gz: 59fe333eb515f8649661f479c829f0592ee3d4ca
 SHA512:
-  metadata.gz: 4cf9dff2e7df82501cffe497ce61962baa9587cdb84d88d89122971fb2394954e85abe3eeede3e45b9723f254b8f25f0b56b5e53f7646fde2708706c9ee94066
-  data.tar.gz: dc781b782d9406d93ba570a7c8c8ddc7ecb61900fe4c8575377ac5f2a0578b7498f930ce0d1d160abc2e69d97ad13eb2356ac4b64e435d3200a9092bec410910
+  metadata.gz: 7aa2993b6c0b23d5d1533b1a285e6fdad5affb5394e377b3a642f640c99d45df488b673c3327f747b3bfe74089813bc2c939b38539e94651bdc718b41526b07f
+  data.tar.gz: 1229904ebc79bd02eff8c48bef23696f62208e70a1abe301c76567064144b19d87be2a81f5ad578247ce6dc28570f08df3966545a906b64ddd1216246859cede

data/lib/outbound.rb

@@ -4,7 +4,7 @@ require 'net/http'
 require 'uri'
 
 module Outbound
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
   BASE_URL = 'https://api.outbound.io/v2'
 
   APNS = "apns"
@@ -16,6 +16,7 @@ module Outbound
   ERROR_INIT = "Must call init() before identify() or track()."
   ERROR_TOKEN = "Token must be a string."
   ERROR_PLATFORM = "Unsupported platform specified."
+  ERROR_CAMPAIGN_IDS = "At least one campaign ID is required."
 
   @ob = nil
   @logger = Logger.new $stdout
@@ -61,6 +62,15 @@ module Outbound
     return @ob.disable(platform, user_id, token)
   end
 
+  def Outbound.disable_all(platform, user_id)
+    if @ob == nil
+      res = Result.new Outbound::ERROR_INIT, false
+      @logger.error res.error
+      return res
+    end
+    return @ob.disable_all(platform, user_id)
+  end
+
   def Outbound.register(platform, user_id, token)
     if @ob == nil
       res = Result.new Outbound::ERROR_INIT, false
@@ -70,6 +80,24 @@ module Outbound
     return @ob.register(platform, user_id, token)
   end
 
+  def Outbound.unsubscribe user_id, all=false, campaign_ids=nil
+    if @ob == nil
+      res = Result.new Outbound::ERROR_INIT, false
+      @logger.error res.error
+      return res
+    end
+    return @ob.subscription user_id, true, all, campaign_ids
+  end
+
+  def Outbound.subscribe user_id, all=false, campaign_ids=nil
+    if @ob == nil
+      res = Result.new Outbound::ERROR_INIT, false
+      @logger.error res.error
+      return res
+    end
+    return @ob.subscription user_id, false, all, campaign_ids
+  end
+
   class Result
     include Defaults
 
@@ -108,6 +136,10 @@ module Outbound
     def platform_error?
       return @error == Outbound::ERROR_PLATFORM
     end
+
+    def campaign_id_error?
+      return @error == Outbound::ERROR_CAMPAIGN_IDS
+    end
   end
 
   class Client
@@ -187,6 +219,22 @@ module Outbound
       return post(@api_key, "/#{platform}/disable", {:token => token, :user_id => user_id})
     end
 
+    def disable_all(platform, user_id)
+      unless user_id.is_a? String or user_id.is_a? Numeric
+        res = Result.new Outbound::ERROR_USER_ID, false
+        @logger.error res.error
+        return res
+      end
+
+      unless [Outbound::APNS, Outbound::GCM].include? platform
+        res = Result.new Outbound::ERROR_PLATFORM, false
+        @logger.error res.error
+        return res
+      end
+
+      return post(@api_key, "/#{platform}/disable", {:all => true, :user_id => user_id})
+    end
+
     def register(platform, user_id, token)
       unless user_id.is_a? String or user_id.is_a? Numeric
         res = Result.new Outbound::ERROR_USER_ID, false
@@ -209,6 +257,29 @@ module Outbound
       return post(@api_key, "/#{platform}/register", {:token => token, :user_id => user_id})
     end
 
+    def subscription user_id, unsubscribe=false, all=false, campaign_ids=nil
+      unless user_id.is_a? String or user_id.is_a? Numeric
+        res = Result.new Outbound::ERROR_USER_ID, false
+        @logger.error res.error
+        return res
+      end
+
+      if !all
+        unless !campaign_ids.nil? && campaign_ids.is_a?(Array) && campaign_ids.length > 0
+          res = Result.new Outbound::ERROR_CAMPAIGN_IDS, false
+          @logger.error res.error
+          return res
+        end
+      end
+
+      url = '/' + (unsubscribe ? 'unsubscribe' : 'subscribe') + '/' + (all ? 'all' : 'campaigns')
+      data = {:user_id => user_id}
+      if !all
+        data[:campaign_ids] = campaign_ids
+      end
+      return post(@api_key, url, data)
+    end
+
     private
 
     def post(api_key, path, data)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: outbound
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Travis Beauvais