apsis-on-steroids 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e150569ffc4bf9ff06badd74b15b7ab414db7789
-  data.tar.gz: ffbbffa2cc6023e61eac06626971797e00713cc1
+  metadata.gz: 7222efc62bbf76dd9716343cc6ff40b9da839fea
+  data.tar.gz: 2107858d19cd4ecbeb3815c2a1e31f584bbaa545
 SHA512:
-  metadata.gz: cbf00b7cbca932973b1ea682bd935099f7b0cd0e6e5be3b24935083fecec94b253fbc5ac8e4516194647d7d10955f12ede9ab3d953e32980d119e8cfc694129b
-  data.tar.gz: 68f363ed6c83b39cc3354a1d182c718cae522038aa7dfbcc202b588149bc50f901ead658a00dcc1c82f49f5e0dfc576a7f6a4ab9e452e2d5443c7eae0b7c17e0
+  metadata.gz: 1a4b44a4f25ebdfdadbba1a55acdeb6b074350de838cb057c0cb411716ed6d531341fa575ddbaf29cbc5c22c716ae9cd520b2f7c00f027d02efe002b1ddf3f0f
+  data.tar.gz: e8655a0feb8c2b51c452475cea4bf388cacf6ba5a9b1d450ca6fa86db616fcec07cce4fc19b9ef9422c5eed3c4a4cac2e95d8fcc95aa27fe1eee5a56d9f1466d

data/Gemfile

@@ -5,6 +5,7 @@ source "http://rubygems.org"
 
 gem "http2", "~> 0.0.25"
 gem "string-cases"
+gem "tretry", "0.0.2"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/Gemfile.lock

@@ -52,6 +52,7 @@ GEM
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
     string-cases (0.0.0)
+    tretry (0.0.2)
 
 PLATFORMS
   ruby
@@ -63,3 +64,4 @@ DEPENDENCIES
   rdoc (~> 3.12)
   rspec (~> 2.8.0)
   string-cases
+  tretry (= 0.0.2)

data/README.md

@@ -43,6 +43,11 @@ mlist.delete
 sub = mlist.subscriber_by_email("some@email.com")
 ```
 
+### Get a specific subscriber without dealing with mailing lists:
+```ruby
+sub = aos.subscriber_by_email("some@email.com")
+```
+
 ### Create one or more subscribers in a mailing list.
 ```ruby
 mlist.create_subscribers(
@@ -58,6 +63,11 @@ mlist.create_subscribers(
 )
 ```
 
+### Count subscribers on a mailing list.
+```ruby
+mlist.count_subscribers #=> 105
+```
+
 ### Get details about subscribers.
 ```ruby
 puts "Details: #{sub.details}"

data/VERSION

@@ -1 +1 @@
-0.0.11
+0.0.12

data/apsis-on-steroids.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: apsis-on-steroids 0.0.11 ruby lib
+# stub: apsis-on-steroids 0.0.12 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "apsis-on-steroids"
-  s.version = "0.0.11"
+  s.version = "0.0.12"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["kaspernj"]
-  s.date = "2014-08-21"
+  s.date = "2014-11-21"
   s.description = "A Ruby API for the Apsis mail service. "
   s.email = "k@spernj.org"
   s.extra_rdoc_files = [
@@ -52,6 +52,7 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<http2>, ["~> 0.0.25"])
       s.add_runtime_dependency(%q<string-cases>, [">= 0"])
+      s.add_runtime_dependency(%q<tretry>, ["= 0.0.2"])
       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"])
@@ -59,6 +60,7 @@ Gem::Specification.new do |s|
     else
       s.add_dependency(%q<http2>, ["~> 0.0.25"])
       s.add_dependency(%q<string-cases>, [">= 0"])
+      s.add_dependency(%q<tretry>, ["= 0.0.2"])
       s.add_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, [">= 1.0.0"])
@@ -67,6 +69,7 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<http2>, ["~> 0.0.25"])
     s.add_dependency(%q<string-cases>, [">= 0"])
+    s.add_dependency(%q<tretry>, ["= 0.0.2"])
     s.add_dependency(%q<rspec>, ["~> 2.8.0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, [">= 1.0.0"])

data/include/mailing_list.rb

@@ -2,11 +2,11 @@ require "uri"
 
 class ApsisOnSteroids::MailingList < ApsisOnSteroids::SubBase
   def create_subscribers(data)
-    res = 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
@@ -27,22 +27,22 @@ class ApsisOnSteroids::MailingList < ApsisOnSteroids::SubBase
 
     data_subscribers
   end
-  
+
   # Returns the subscribers of the mailing list.
   def subscribers
-    res = aos.req_json("v1/mailinglists/#{data(:id)}/subscribers/all", :post, :json => {
+    res = aos.req_json("v1/mailinglists/#{data(:id)}/subscribers/all", :post, json: {
       "AllDemographics" => false,
       "FieldNames" => []
     })
-    
+
     url = URI.parse(res["Result"]["PollURL"])
     data_subscribers = nil
-    
+
     Timeout.timeout(300) do
       loop do
         sleep 1
         res = aos.req_json(url.path)
-        
+
         if res["State"] == "2"
           data_url = URI.parse(res["DataUrl"])
           data_subscribers = aos.req_json(data_url.path)
@@ -54,24 +54,24 @@ class ApsisOnSteroids::MailingList < ApsisOnSteroids::SubBase
         end
       end
     end
-    
+
     ret = []
     data_subscribers.each do |sub_data|
       sub = ApsisOnSteroids::Subscriber.new(
-        :aos => self.aos,
-        :data => aos.parse_obj(sub_data)
+        aos: self.aos,
+        data: aos.parse_obj(sub_data)
       )
-      
+
       if block_given?
         yield sub
       else
         ret << sub
       end
     end
-    
+
     return ret
   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)
@@ -81,10 +81,10 @@ class ApsisOnSteroids::MailingList < ApsisOnSteroids::SubBase
       mailinglist_ids = res["Result"]["Mailinglists"].map { |m| m["Id"].to_i }
       return sub if mailinglist_ids.include?(self.data(:id))
     end
-    
+
     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)
@@ -94,7 +94,7 @@ class ApsisOnSteroids::MailingList < ApsisOnSteroids::SubBase
       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)
@@ -104,20 +104,20 @@ class ApsisOnSteroids::MailingList < ApsisOnSteroids::SubBase
       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)
@@ -129,10 +129,16 @@ class ApsisOnSteroids::MailingList < ApsisOnSteroids::SubBase
         end
       end
     end
-    
+
     return nil
   end
-  
+
+  def count_subscribers
+    res = aos.req_json("v1/mailinglists/#{self.data(:id)}/subscriptions/count")
+    raise "Unexpected result: #{res}" if res["Code"] != 1
+    return res["Result"]
+  end
+
   # Returns true if the given subscriber is a member of the mailing list.
   def member?(sub)
     sub.mailing_lists.each do |mlist|
@@ -140,22 +146,22 @@ class ApsisOnSteroids::MailingList < ApsisOnSteroids::SubBase
         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)])
-    
+    res = aos.req_json("v1/mailinglists/", :delete, json: [data(:id)])
+
     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"
           data_url = URI.parse(res["DataUrl"])
           data = aos.req_json(data_url.path)
@@ -167,15 +173,15 @@ class ApsisOnSteroids::MailingList < ApsisOnSteroids::SubBase
         end
       end
     end
-    
+
     data.each do |element|
       raise "Unexpected result: '#{data}'." if element["Value"] != "Succefully deleted"
     end
   end
-  
+
   # Moves a subscriber to the opt-out-list.
   def opt_out_subscriber(sub)
-    res = aos.req_json("v1/optouts/mailinglists/#{data(:id)}/subscribers/queued", :post, :json => [{
+    res = aos.req_json("v1/optouts/mailinglists/#{data(:id)}/subscribers/queued", :post, json: [{
       "ExternalId" => "",
       "Reason" => "",
       "SendQueueId" => 0,
@@ -183,42 +189,42 @@ class ApsisOnSteroids::MailingList < ApsisOnSteroids::SubBase
     }])
     raise "Unexpected result: #{res}" if res["Code"] != 1
     data = aos.read_queued_response(res["Result"]["PollURL"])
-    
+
     raise data if data["FailedSubscriberIds"] && data["FailedSubscriberIds"].any?
   end
-  
+
   # Returns a list of subscribers on the opt-out-list.
   def opt_out_list
     res = aos.req_json("v1/optouts/mailinglists/#{data(:id)}/queued", :post)
     raise "Unexpected result: #{res}" if res["Code"] != 1
     data = aos.read_queued_response(res["Result"]["PollURL"])
-    
+
     ret = []
     data.each do |opt_out_data|
-      sub = ApsisOnSteroids::Subscriber.new(:aos => aos, :data => {:id => opt_out_data["Id"], :email => opt_out_data["Email"]})
-      
+      sub = ApsisOnSteroids::Subscriber.new(aos: aos, data: {id: opt_out_data["Id"], email: opt_out_data["Email"]})
+
       if block_given?
         yield sub
       else
         ret << sub
       end
     end
-    
+
     return ret
   end
-  
+
   # Returns true if the given subscriber is on the opt-out-list.
   def opt_out?(sub)
     opt_out_list do |sub_opt_out|
       return true if sub_opt_out.data(:email) == sub.data(:email) || sub.data(:id).to_i == sub_opt_out.data(:id).to_i
     end
-    
+
     return false
   end
-  
+
   # Removes the given subscriber from the opt-out-list.
   def opt_out_remove_subscriber(sub)
-    res = aos.req_json("v1/optouts/mailinglists/#{data(:id)}/subscribers/queued", :delete, :json => [
+    res = aos.req_json("v1/optouts/mailinglists/#{data(:id)}/subscribers/queued", :delete, json: [
       sub.data(:email)
     ])
     data = aos.read_queued_response(res["Result"]["PollURL"])

data/include/subscriber.rb

@@ -3,50 +3,50 @@ class ApsisOnSteroids::Subscriber < ApsisOnSteroids::SubBase
   def details
     if !@details
       res = aos.req_json("v1/subscribers/id/#{data(:id)}")
-      
+
       ret = {}
       res["Result"].each do |key, val|
         ret[key.to_sym] = val
       end
-      
+
       @details = ret
     end
-    
+
     return @details
   end
-  
+
   # Returns the DemDataField by the given key.
   def dem_data(key)
     key = key.to_s.downcase
-    
+
     self.details[:DemDataFields].each do |dem_data|
       if dem_data["Key"].to_s.downcase == key
         return dem_data["Value"]
       end
     end
-    
+
     return nil
   end
-  
+
   # Returns true if the subscriber is active.
   def active?
     details = self.details
     return false if details[:pending]
     return true
   end
-  
+
   # Update one or more details on the subscriber.
   def update(data)
     begin
-      res = aos.req_json("v1/subscribers/queue", :post, :json => [data.merge(:Id => self.data(:id))])
+      res = aos.req_json("v1/subscribers/queue", :post, json: [data.merge(:Id => self.data(:id))])
       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)
@@ -58,10 +58,10 @@ class ApsisOnSteroids::Subscriber < ApsisOnSteroids::SubBase
           end
         end
       end
-      
+
       if data["FailedUpdatedSubscribers"] && data["FailedUpdatedSubscribers"].any?
         msg = raise data["FailedUpdatedSubscribers"].to_s
-        
+
         if msg.include?("Timeout expired.")
           raise Errno::EAGAIN, msg
         else
@@ -71,23 +71,23 @@ class ApsisOnSteroids::Subscriber < ApsisOnSteroids::SubBase
     rescue Errno::EAGAIN
       retry
     end
-    
+
     @details = nil
     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)
+      mlist = ApsisOnSteroids::MailingList.new(data: mlist_data, aos: aos)
       ret << mlist
     end
-    
+
     return ret
   end
 end

data/lib/apsis-on-steroids.rb

@@ -3,6 +3,7 @@ require "http2"
 require "string-cases"
 require "timeout"
 require "cgi"
+require "tretry"
 
 class ApsisOnSteroids
   STRFTIME_FORMAT = "%Y%m%dT%H%M%S"
@@ -19,21 +20,7 @@ class ApsisOnSteroids
     raise "Invalid API key: '#{args[:api_key]}' from: '#{args}'." if args[:api_key].to_s.strip.empty?
 
     @args = args
-    @http = Http2.new(
-      host: "se.api.anpdm.com",
-      port: 8443,
-      ssl: true,
-      follow_redirects: false,
-      debug: args[:debug],
-      extra_headers: {
-        "Accept" => "text/json, application/json"
-      },
-      basic_auth: {
-        user: @args[:api_key],
-        passwd: ""
-      },
-      skip_port_in_host_header: true
-    )
+    reconnect
 
     if block_given?
       begin
@@ -143,13 +130,28 @@ class ApsisOnSteroids
 
   def req_json(url, type = :get, method_args = {})
     # Parse arguments, send and parse the result.
-    args = { :url => url.start_with?('/') ? url[1..-1] : url }.merge(method_args)
-    http_res = @http.__send__(type, args)
+    args = {url: url.start_with?('/') ? url[1..-1] : url}.merge(method_args)
+    try = ::Tretry.new
+    try.timeout = 300
 
-    begin
-      res = JSON.parse(http_res.body)
-    rescue JSON::ParserError
-      raise "Invalid JSON given: '#{http_res.body}'."
+    if type == :get
+      try.tries = 3
+      try.before_retry { @http.reconnect }
+    else
+      # Don't retry a manipulatable method!
+      try.tries = 1
+    end
+
+    res = nil
+    try.try do
+      http_res = @http.__send__(type, args)
+
+      # Throw custom JSON error for debugging if the JSON was corrupt (this actually happens!).
+      begin
+        res = JSON.parse(http_res.body)
+      rescue JSON::ParserError
+        raise "Invalid JSON given: '#{http_res.body}'."
+      end
     end
 
     # Check for various kind of server errors and raise them as Ruby errors if present.
@@ -180,7 +182,7 @@ class ApsisOnSteroids
     end
   end
 
-  def read_resources_from_array resource_class_name, resource_array
+  def read_resources_from_array(resource_class_name, resource_array)
     Enumerator.new do |yielder|
       resource_array.each do |resource_data|
         resource = ApsisOnSteroids.const_get(resource_class_name).new(aos: self, data: resource_data)
@@ -219,4 +221,26 @@ class ApsisOnSteroids
       return obj
     end
   end
+
+private
+
+  def reconnect
+    @http.destroy if @http
+
+    @http = Http2.new(
+      host: "se.api.anpdm.com",
+      port: 8443,
+      ssl: true,
+      follow_redirects: false,
+      debug: @args[:debug],
+      extra_headers: {
+        "Accept" => "text/json, application/json"
+      },
+      basic_auth: {
+        user: @args[:api_key],
+        passwd: ""
+      },
+      skip_port_in_host_header: true
+    )
+  end
 end

data/spec/apsis-on-steroids_spec.rb

@@ -3,8 +3,8 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 describe "ApsisOnSteroids" do
   let(:aos) do
     ApsisOnSteroids.new(
-      :api_key => File.read("#{File.dirname(__FILE__)}/api_key.txt").strip,
-      :debug => false
+      api_key: File.read("#{File.dirname(__FILE__)}/api_key.txt").strip,
+      debug: false
     )
   end
 
@@ -40,7 +40,7 @@ describe "ApsisOnSteroids" do
     raise "list is empty!?" if list.empty?
 
     sending = list.first
-    puts "Sending data: #{sending.data_hash}"
+    # puts "Sending data: #{sending.data_hash}"
 
     # Test the call doesnt fail.
     sending.mailing_lists.first
@@ -49,7 +49,6 @@ describe "ApsisOnSteroids" do
     bounce = sending.bounces.first
 
     opt_outs_count = sending.opt_outs(count: true)
-    puts "Opt outs count: #{opt_outs_count}"
   end
 
   context do
@@ -102,6 +101,11 @@ describe "ApsisOnSteroids" do
       mlist.subscriber_by_email(sub.data(:email)).should_not eq nil
     end
 
+    it "should count subscribers on mailing lists" do
+      count = mlist.count_subscribers
+      count.is_a?(Integer).should eq true
+    end
+
     it "can get lists of subscribers from lists" do
       original_sub = sub
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apsis-on-steroids
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-21 00:00:00.000000000 Z
+date: 2014-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http2
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tretry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement