apsis-on-steroids 0.0.1 → 0.0.3

data/Gemfile

@@ -3,7 +3,7 @@ source "http://rubygems.org"
 # Example:
 #   gem "activesupport", ">= 2.3.5"
 
-gem "http2", ">= 0.0.16"
+gem "http2", "~> 0.0.17"
 gem "string-cases"
 
 # Add dependencies to develop your gem here.

data/Gemfile.lock

@@ -3,7 +3,7 @@ GEM
   specs:
     diff-lcs (1.1.3)
     git (1.2.5)
-    http2 (0.0.16)
+    http2 (0.0.17)
     jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
@@ -28,7 +28,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (>= 1.0.0)
-  http2 (>= 0.0.16)
+  http2 (~> 0.0.17)
   jeweler (~> 1.8.4)
   rdoc (~> 3.12)
   rspec (~> 2.8.0)

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.3

data/apsis-on-steroids.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "apsis-on-steroids"
-  s.version = "0.0.1"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["kaspernj"]
-  s.date = "2013-06-21"
+  s.date = "2013-07-25"
   s.description = "A Ruby API for the Apsis mail service. "
   s.email = "k@spernj.org"
   s.extra_rdoc_files = [
@@ -43,14 +43,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<http2>, [">= 0.0.16"])
+      s.add_runtime_dependency(%q<http2>, ["~> 0.0.17"])
       s.add_runtime_dependency(%q<string-cases>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
     else
-      s.add_dependency(%q<http2>, [">= 0.0.16"])
+      s.add_dependency(%q<http2>, ["~> 0.0.17"])
       s.add_dependency(%q<string-cases>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
@@ -58,7 +58,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
     end
   else
-    s.add_dependency(%q<http2>, [">= 0.0.16"])
+    s.add_dependency(%q<http2>, ["~> 0.0.17"])
     s.add_dependency(%q<string-cases>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.8.0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])

data/include/mailing_list.rb

@@ -1,57 +1,161 @@
+require "uri"
+
 class ApsisOnSteroids::MailingList < ApsisOnSteroids::SubBase
   def create_subscribers(data)
-    aos.req_json("v1/subscribers/mailinglist/#{data(:id)}/queue", :post, :json => data)
+    res = aos.req_json("v1/subscribers/mailinglist/#{data(:id)}/queue", :post, :json => data)
+
+    url = URI.parse(res["Result"]["PollURL"])
+    data_subscribers = nil
+    
+    Timeout.timeout(300) do
+      loop do
+        sleep 1
+        res = aos.req_json(url.path)
+        debugs "Result: #{res}"
+
+        if res["State"] == "2"
+          data_url = URI.parse(res["DataUrl"])
+          data_subscribers = aos.req_json(data_url.path)
+          break
+        elsif res["State"] == "0" || res["State"] == "1"
+          # Keep waiting.
+        else
+          raise "Unknown state: '#{res["State"]}': #{res}."
+        end
+      end
+    end
+
+    data_subscribers
   end
   
   def subscribers
     res = aos.req_json("v1/mailinglists/#{data(:id)}/subscribers/all", :post, :json => {
-      "AllDemographics" => true,
+      "AllDemographics" => false,
       "FieldNames" => []
     })
     
     url = URI.parse(res["Result"]["PollURL"])
+    data_subscribers = nil
     
-    Timeout.timeout(30) do
+    Timeout.timeout(300) do
       loop do
-        sleep 0.5
+        sleep 1
         res = aos.req_json(url.path)
         
-        puts "Status res: #{res}"
-        
         if res["State"] == "2"
+          data_url = URI.parse(res["DataUrl"])
+          data_subscribers = aos.req_json(data_url.path)
           break
+        elsif res["State"] == "0" || res["State"] == "1"
+          # Keep waiting.
+        else
+          raise "Unknown state: '#{res["State"]}': #{res}."
         end
       end
     end
+
+    data_subscribers.each do |sub_data|
+      sub = ApsisOnSteroids::Subscriber.new(
+        :aos => self.aos,
+        :data => aos.parse_obj(sub_data)
+      )
+      
+      yield sub
+    end
+  end
+  
+  # Adds the given email as a new subscriber and subscribes the created subscriber to the mailing list.
+  def subscriber_by_email(email)
+    sub = aos.subscriber_by_email(email)
+
+    res = aos.req_json("v1/subscribers/#{sub.data(:id)}/mailinglists")
+    if res["Result"]
+      mailinglist_ids = res["Result"]["Mailinglists"].map { |m| m["Id"].to_i }
+      return sub if mailinglist_ids.include?(self.data(:id))
+    end
     
-    puts "Test: #{res}"
-    raise "Finish me!"
+    raise "Could not find subscriber by that email: '#{email}' on this mailing list '#{self.data(:name)}'."
+  end
+  
+  # Adds the given subscriber to the mailing list.
+  def add_subscriber(subscriber)
+    res = aos.req_json("v1/mailinglists/#{self.data(:id)}/subscriptions/#{subscriber.data(:id)}", :post)
+    if res["Message"] == "Succesfully created Subscription"
+      res["Result"].to_i > 0
+    else
+      raise "Unexpected result: '#{res["Result"]}'."
+    end
   end
   
+  # Removes the given subscriber from the mailing list.
   def remove_subscriber(subscriber)
     res = aos.req_json("v1/mailinglists/#{self.data(:id)}/subscriptions/#{subscriber.data(:id)}", :delete)
-    if res["Result"] == "Deleted"
-      return nil
+    if res["Message"] == "Successfully deleted Subscription"
+      true
     else
       raise "Unexpected result: '#{res["Result"]}'."
     end
   end
   
+  # Removes all subscribers from the mailing list.
+  def remove_all_subscribers
+    res = aos.req_json("v1/mailinglists/#{self.data(:id)}/subscriptions/all", :delete)
+    raise "Unexpected result: #{res}" if res["Code"] != 1
+    url = URI.parse(res["Result"]["PollURL"])
+    data = nil
+    
+    Timeout.timeout(300) do
+      loop do
+        sleep 1
+        
+        res = aos.req_json(url.path)
+        
+        if res["State"] == "2"
+          url_data = URI.parse(res["DataUrl"])
+          data = aos.req_json(url_data.path)
+          break
+        elsif res["State"] == "0" || res["State"] == "1"
+          # Keep waiting.
+        else
+          raise "Unknown state '#{res["State"]}': #{res}"
+        end
+      end
+    end
+    
+    return nil
+  end
+  
+  # Returns true if the given subscriber is a member of the mailing list.
+  def member?(sub)
+    sub.mailing_lists.each do |mlist|
+      if mlist.data(:id) == self.data(:id)
+        return true
+      end
+    end
+    
+    return false
+  end
+  
+  # Deletes the mailing list from APSIS.
   def delete
     res = aos.req_json("v1/mailinglists/", :delete, :json => [data(:id)])
     
     url = URI.parse(res["Result"]["PollURL"])
     data = nil
     
-    Timeout.timeout(30) do
+    Timeout.timeout(300) do
       loop do
-        sleep 0.5
+        sleep 1
         res = aos.req_json(url.path)
         
         if res["State"] == "2"
           data_url = URI.parse(res["DataUrl"])
           data = aos.req_json(data_url.path)
           break
+        elsif res["State"] == "0" || res["State"] == "1"
+          # Keep waiting.
+        else
+          raise "Unknown state: '#{res["State"]}': #{res}"
         end
       end
     end
@@ -60,4 +164,4 @@ class ApsisOnSteroids::MailingList < ApsisOnSteroids::SubBase
       raise "Unexpected result: '#{data}'." if element["Value"] != "Succefully deleted"
     end
   end
-end
+end

data/include/sub_base.rb

@@ -15,11 +15,10 @@ class ApsisOnSteroids::SubBase
   def data(name)
     name = name.to_sym
     return @data[name] if @data.key?(name)
-    raise "No such data: '#{name}'."
+    raise "No such data: '#{name}' in fields: #{@data.keys}"
   end
   
-  def method_missing(name, *args, &blk)
-    return @data[name.to_sym] if @data && @data.key?(name.to_sym)
-    raise "No such method: '#{name}'."
+  def debugs(str)
+    self.aos.debugs(str)
   end
-end
+end

data/include/subscriber.rb

@@ -24,14 +24,19 @@ class ApsisOnSteroids::Subscriber < ApsisOnSteroids::SubBase
     url = URI.parse(res["Result"]["PollURL"])
     data = nil
     
-    Timeout.timeout(30) do
+    Timeout.timeout(300) do
       loop do
+        sleep 1
         res = aos.req_json(url.path)
         
         if res["State"] == "2"
           url_data = URI.parse(res["DataUrl"])
           data = aos.req_json(url_data.path)
           break
+        elsif res["State"] == "0" || res["State"] == "1"
+          # Keep waiting.
+        else
+          raise "Unknown state '#{res["State"]}': #{res}"
         end
       end
     end
@@ -39,4 +44,19 @@ class ApsisOnSteroids::Subscriber < ApsisOnSteroids::SubBase
     raise data["FailedUpdatedSubscribers"].to_s if data["FailedUpdatedSubscribers"] && data["FailedUpdatedSubscribers"].any?
     return nil
   end
+  
+  # Returns an array of mailing lists that the sucscriber is subscribed to.
+  def mailing_lists
+    ret = []
+    
+    res = aos.req_json("v1/subscribers/#{self.data(:id)}/mailinglists")
+    raise "Unexpected result: #{res}" if res["Code"] != 1 || !res["Result"].is_a?(Hash)
+    
+    res["Result"]["Mailinglists"].each do |mlist_data|
+      mlist = ApsisOnSteroids::MailingList.new(:data => mlist_data, :aos => aos)
+      ret << mlist
+    end
+    
+    return ret
+  end
 end

data/lib/apsis-on-steroids.rb

@@ -42,6 +42,16 @@ class ApsisOnSteroids
     end
   end
   
+  # Closes connection and removes all references to resource-objects.
+  def destroy
+    @http.destroy if @http
+    @http = nil
+  end
+  
+  def debugs(str)
+    puts str if @args[:debug]
+  end
+  
   def mailing_lists
     res = req_json("v1/mailinglists/1/999")
     
@@ -67,62 +77,19 @@ class ApsisOnSteroids
   
   def mailing_list_by_name(name)
     self.mailing_lists.each do |mlist|
-      return mlist if name.to_s == mlist.name.to_s
+      return mlist if name.to_s == mlist.data(:name).to_s
     end
     
     raise "Could not find mailing list by that name: '#{name}'."
   end
-  
-  def subscribers
-    # Request a list of all subs.
-    res = req_json("v1/subscribers/all", :post, :json => {
-      "AllDemographics" => true,
-      "FieldNames" => []
-    })
-    
-    # Wait for the server to generate the list.
-    url = URI.parse(res["Result"]["PollURL"])
-    data = nil
-    
-    Timeout.timeout(30) do
-      loop do
-        sleep 0.5
-        res = req_json(url.path)
-        
-        if res["State"] == "2"
-          url_data = URI.parse(res["DataUrl"])
-          data = req_json(url_data.path)
-          break
-        end
-      end
-    end
     
-    # Parse the list of subscribers.
-    ret = [] unless block_given?
-    
-    data.each do |sub_data|
-      sub = ApsisOnSteroids::Subscriber.new(
-        :aos => self,
-        :data => sub_data
-      )
-      
-      if block_given?
-        yield sub
-      else
-        ret << sub
-      end
-    end
-    
-    if block_given?
-      return nil
-    else
-      return ret
+  def subscriber_by_email(email)
+    begin
+      res = req_json("v1/subscribers/email/lookup/#{CGI.escape(email)}")
+    rescue
+      raise "Could not find subscriber by that email in the system"
     end
-  end
   
-  def subscriber_by_email(email)
-    res = req_json("v1/subscribers/email/lookup/#{CGI.escape(email)}")
-    
     sub = ApsisOnSteroids::Subscriber.new(
       :aos => self,
       :data => {
@@ -136,7 +103,7 @@ class ApsisOnSteroids
   
   def req_json(url, type = :get, method_args = {})
     # Parse arguments, send and parse the result.
-    args = {:url => url}.merge(method_args)
+    args = { :url => url.start_with?('/') ? url[1..-1] : url }.merge(method_args)
     http_res = @http.__send__(type, args)
     
     begin
@@ -152,4 +119,32 @@ class ApsisOnSteroids
     # Return the result.
     return res
   end
+  
+  def parse_obj(obj)
+    if obj.is_a?(Array)
+      ret = []
+      obj.each do |obj_i|
+        ret << parse_obj(obj_i)
+      end
+      
+      return ret
+    elsif obj.is_a?(Hash)
+      ret = {}
+      obj.each do |key, val|
+        ret[key] = parse_obj(val)
+      end
+      
+      return ret
+    elsif obj.is_a?(String)
+      # Automatically convert dates.
+      if match = obj.match(/^\/Date\((\d+)\+(\d+)\)\//)
+        unix_t = match[1].to_i / 1000
+        return Time.at(unix_t)
+      end
+      
+      return obj
+    else
+      return obj
+    end
+  end
 end

data/spec/apsis-on-steroids_spec.rb

@@ -1,82 +1,115 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "ApsisOnSteroids" do
-  it "can connect" do
-    $aos = ApsisOnSteroids.new(
+  let(:aos) do
+    ApsisOnSteroids.new(
       :api_key => File.read("#{File.dirname(__FILE__)}/api_key.txt").strip,
       :debug => false
     )
   end
+
+  it "can connect" do
+    aos
+  end
   
   it "should create and delete a mailing list" do
     name = "create-mlist-#{Time.now.to_f.to_s}"
     
-    $aos.create_mailing_list(
+    aos.create_mailing_list(
       :Name => name,
       :FromName => "Kasper Johansen",
       :FromEmail => "kj@naoshi-dev.com",
       :CharacterSet => "utf-8"
     )
     
-    mlist = $aos.mailing_list_by_name(name)
+    mlist = aos.mailing_list_by_name(name)
     
     sleep 1
     mlist.delete
   end
-  
+
   it "can get a mailing list" do
-    $mlist = $aos.mailing_list_by_name("kj")
-  end
-  
-  it "can create subscribers" do
-    $mlist.create_subscribers([{
-      :Email => "kj@gfish.com",
-      :Name => "Kasper Johansen"
-    }])
-  end
-  
-  it "can get subscribers and their details" do
-    $sub = $aos.subscriber_by_email("kj@gfish.com")
-    details = $sub.details
-    details.is_a?(Hash).should eql(true)
-    details.key?(:pending).should eql(false)
-  end
-  
-  it "can update subscribers" do
-    new_email = "kaspernj#{Time.now.to_f}@naoshi-dev.com"
-    $sub.update(:Email => new_email)
-    $sub.details[:Email].should eql(new_email)
-    $sub.details[:Name].should eql("Kasper Johansen")
+    mlist = aos.mailing_list_by_name("kj")
   end
+
+  context do
+    let(:mlist) do
+      mlist = aos.mailing_list_by_name("kj")
+      mlist.remove_all_subscribers
+      mlist
+    end
+    
+    let(:sub) do
+      email = "kaspernj#{Time.now.to_f}@naoshi-dev.com"
+      mlist.create_subscribers([{
+        :Email => email,
+        :Name => "Kasper Johansen"
+      }])
+      aos.subscriber_by_email(email)
+    end
   
-  it "should not overwrite data when updating" do
-    phone = Time.now.to_i.to_s
-    $sub.update(:PhoneNumber => phone)
-    $sub.details[:PhoneNumber].should eql(phone)
+    it "can create subscribers" do
+      sub
+    end
+
+    it "can get subscribers and their details" do
+      details = sub.details
+      details.is_a?(Hash).should eql(true)
+      details.key?(:pending).should eql(false)
+    end
+
+    it "can update subscribers" do
+      new_email = "kaspernj#{Time.now.to_f}-updated@naoshi-dev.com"
+      sub.update(:Email => new_email)
+      sleep 1
+      sub.details[:Email].should eql(new_email)
+      sub.details[:Name].should eql("Kasper Johansen")
+    end
+
+    it "should not overwrite data when updating" do
+      phone = Time.now.to_i.to_s
+      sub.update(:PhoneNumber => phone)
+      sub.details[:PhoneNumber].should eql(phone)
+
+      new_email = "kaspernj#{Time.now.to_f}-updated@naoshi-dev.com"
+      sub.update(:Email => new_email)
+      sub.details[:Email].should eql(new_email)
+
+      sub.details[:PhoneNumber].should eql(phone)
+    end
+
+    it "can lookup the subscriber on the list" do
+      mlist.subscriber_by_email(sub.data(:email)).should_not eq nil
+    end
     
-    new_email = "kaspernj#{Time.now.to_f}@naoshi-dev.com"
-    $sub.update(:Email => new_email)
-    $sub.details[:Email].should eql(new_email)
+    it "can get lists of subscribers from lists" do
+      original_sub = sub
+      
+      count = 0
+      mlist.subscribers do |sub_i|
+        count += 1
+        #puts "Subscriber: #{sub_i}"
+      end
+      
+      raise "Expected more than one." if count <= 1
+    end
+
+    it "can remove subscribers from lists" do
+      mlist.remove_subscriber(sub)
+    end
+
+    it "can validate if a subscriber is active or not" do
+      sub.active?.should eql(true)
+    end
     
-    $sub.details[:PhoneNumber].should eql(phone)
-  end
-  
-  it "can remove subscribers from lists" do
-    $mlist.remove_subscriber($sub)
-  end
-  
-  it "can get lists of subscribers from lists" do
-    $mlist.subscribers do |sub|
-      puts "Subscriber: #{sub}"
+    it "can subscribe, remove and then re-subscribe" do
+      sub.active?.should eql(true)
+      
+      mlist.remove_subscriber(sub)
+      mlist.add_subscriber(sub)
+      
+      sub.active?.should eql(true)
+      mlist.member?(sub).should eql(true)
     end
   end
-  
-  it "can validate if a subscriber is active or not" do
-    $sub.active?.should eql(true)
-  end
-  
-  it "can get a list of all subscribers" do
-    total_list = $aos.subscribers
-    total_list.is_a?(Array).should eql(true)
-  end
 end

metadata

@@ -2,31 +2,31 @@
 name: apsis-on-steroids
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-21 00:00:00.000000000 Z
+date: 2013-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.16
+        version: 0.0.17
   name: http2
   type: :runtime
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.16
+        version: 0.0.17
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -144,7 +144,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: -2130577314090490558
+      hash: -867617378324524175
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false