catapult-rails 0.0.1 → 0.0.2

data/README.md

@@ -16,23 +16,60 @@ Finally, add this to one of your initliazation files
     Catapult.username = "c@apult.com"
     Catapult.password = "MyShinyPassword"
 
-## Usage
+## Methods
 
 The gem should explicitly follow [the api](http://client.vibes.com/toolkit/api/update-subscriber.shtml). 
 
-For example under the subscription section we have a create subscription method.To call this method use: 
+For example under the subscription section we have a create_subscription method. To call this method use: 
 
     Catapult::Subscription.create_subscription(campaign_id, phone)
 
 
 Finished:
 
+* Campaign.list_campaigns(account_list=nil, status_filter=nil, type_filter=nil)
 * Subscription.list_subscribers(campaign)
 * Subscription.create_subscription(campaign, phone)
-* Subscription.delete_subscriber(campaign, phone, suppress_message)
+* Subscription.read_subscription(campaign, phone)
+* Subscription.delete_subscriber(campaign, phone, suppress_message=false)
 * Subscription.update_subscriber(campaign, phone, opts = {})
 
+opts in the update_subscriber call mirrors the api as well: {"first-name" => "Lisbeth"}
+
+
+## Usage
+One way to find a users subscriptions:
+
+    @campaigns = Hash.new
+
+    MyTextAlerts.all.each do |ta|
+      sub = Catapult::Subscription.read_subscription(ta.campaign_id, phone_number)
+      @campaigns[ta.campaign_id] = (sub['subscription'].blank? ? false : true)
+    end
+
+    puts @campaigns
+    =>
+    {
+      12345 => false,
+      23456 => true
+    }
+
+Create a subscription:
+
+    Catapult::Subscription.create_subscription(campaign_id, phone_number)
+    => true
+
+Update a subscription:
+
+As far as I can tell this does not create a subscription even though the docs imply that it does
+
+    Catapult::Subscription.update_subscriber(campaign_id, phone_number, options)
+    => true
+
+Delete a subscription:
 
+    Catapult::Subscription.delete_subscriber(campaign_id, phone_number)
+    => true
 
 ## Contributing
 

data/lib/catapult.rb

@@ -2,6 +2,7 @@ require "net/http"
 require "uri"
 require 'catapult/catapult_methods'
 require 'catapult/subscription'
+require 'catapult/campaign'
 require 'catapult/version'
 
 

data/lib/catapult/campaign.rb

@@ -0,0 +1,17 @@
+module Catapult
+  class Campaign
+    extend CatapultMethods
+
+    def self.list_campaigns(account_list=nil, status_filter=nil, type_filter=nil)
+      req_str = "/api/campaigns.xml?"
+      arr = {}
+      arr[:accounts] = account_list if account_list
+      arr[:status] = status_filter if status_filter
+      arr[:type] = type_filter if type_filter
+      http, request = build_request(req_str + arr.to_query)
+      response = http.request(request)
+      Hash.from_xml(response.body)
+    end
+
+  end
+end

data/lib/catapult/catapult_methods.rb

@@ -21,7 +21,7 @@ module Catapult
     end
 
     def handle_response(response)
-      if response.code.to_i == 200
+      if response.code.to_i == 200 && response.body.blank?
         return true
       else
         return Hash.from_xml(response.body)

data/lib/catapult/subscription.rb

@@ -8,6 +8,10 @@ module Catapult
       Hash.from_xml(response.body)
     end
 
+    # returns:
+    #  true on success
+    #  hash on false
+    #
     def self.create_subscription(campaign, phone)
       http, request = build_request("/api/subscription_campaigns/#{campaign}/subscriptions.xml", "POST")
       xml = Nokogiri::XML::Builder.new do |x|
@@ -22,7 +26,20 @@ module Catapult
       handle_response(response)
     end
 
+    # returns:
+    #  true on success
+    #  hash on false
+    #
+    def self.read_subscription(campaign, phone)
+      http, request = build_request("/api/subscription_campaigns/#{campaign}/subscriptions/#{phone}.xml", "GET")
+      response = http.request(request)
+      handle_response(response)
+    end
 
+    # returns:
+    #  true on success
+    #  hash on false
+    #
     def self.delete_subscriber(campaign, phone, suppress_message = false)
       http, request = build_request("/api/subscription_campaigns/#{campaign}/subscriptions/#{phone}.xml?suppress_message=#{suppress_message}", "DELETE")
       response = http.request(request)
@@ -30,10 +47,10 @@ module Catapult
     end
 
     # options = {
-      #   'birthday-on' => '02/18/1978',
-      #   'email' => 'fake@fake.co',
-      #   'gender' => "M"
-      # }
+    #   'birthday-on' => '02/18/1978',
+    #   'email' => 'fake@fake.co',
+    #   'gender' => "M"
+    # }
     def self.update_subscriber(campaign, phone, options = {})
       http, request = build_request("/api/subscription_campaigns/#{campaign}/subscriptions/#{phone}.xml", "PUT")
       xml = Nokogiri::XML::Builder.new do |x|

data/lib/catapult/version.rb

@@ -1,3 +1,3 @@
 module Catapult
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: catapult-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-06 00:00:00.000000000 Z
+date: 2013-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,6 +59,7 @@ files:
 - catapult-rails.gemspec
 - lib/catapult.rb
 - lib/catapult/.DS_Store
+- lib/catapult/campaign.rb
 - lib/catapult/catapult_methods.rb
 - lib/catapult/subscription.rb
 - lib/catapult/version.rb
@@ -75,12 +76,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2871894567716705260
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2871894567716705260
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23