apsis-on-steroids 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7222efc62bbf76dd9716343cc6ff40b9da839fea
-  data.tar.gz: 2107858d19cd4ecbeb3815c2a1e31f584bbaa545
+  metadata.gz: d2c97fee6983418cf2f499e0f3f901f5d51bda48
+  data.tar.gz: ddd8592da71bc82976ceb05ba2ec3ebe9209d1a0
 SHA512:
-  metadata.gz: 1a4b44a4f25ebdfdadbba1a55acdeb6b074350de838cb057c0cb411716ed6d531341fa575ddbaf29cbc5c22c716ae9cd520b2f7c00f027d02efe002b1ddf3f0f
-  data.tar.gz: e8655a0feb8c2b51c452475cea4bf388cacf6ba5a9b1d450ca6fa86db616fcec07cce4fc19b9ef9422c5eed3c4a4cac2e95d8fcc95aa27fe1eee5a56d9f1466d
+  metadata.gz: 9063c474acfba9d052f8186f76827753fc9d46f8f772104175551ea453e70a4593e4fded4d169913d4511cc2973221347503483a71f19033ec2532b2b04df0d7
+  data.tar.gz: b0506c2a5ae64f3e7a74858deae5809c2479eb7c3d6cc6a3c5735f4c54ec2b36ffe67d9be0eb4fc054f11dbf19c3f520232f794bd1bc5c6f6f189ceb7195b601

data/Gemfile

@@ -3,7 +3,7 @@ source "http://rubygems.org"
 # Example:
 #   gem "activesupport", ">= 2.3.5"
 
-gem "http2", "~> 0.0.25"
+gem "http2", "~> 0.0.31"
 gem "string-cases"
 gem "tretry", "0.0.2"
 

data/Gemfile.lock

@@ -1,12 +1,12 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.3.6)
+    addressable (2.3.8)
     builder (3.2.2)
     diff-lcs (1.1.3)
     faraday (0.8.9)
       multipart-post (~> 1.2.0)
-    git (1.2.8)
+    git (1.2.9.1)
     github_api (0.10.1)
       addressable
       faraday (~> 0.8.1)
@@ -14,10 +14,10 @@ GEM
       multi_json (~> 1.4)
       nokogiri (~> 1.5.2)
       oauth2
-    hashie (3.2.0)
-    highline (1.6.21)
-    http2 (0.0.25)
-      string-cases
+    hashie (3.4.1)
+    highline (1.7.2)
+    http2 (0.0.31)
+      string-cases (~> 0)
     jeweler (1.8.8)
       builder
       bundler (~> 1.0)
@@ -27,9 +27,9 @@ GEM
       nokogiri (= 1.5.10)
       rake
       rdoc
-    json (1.8.1)
-    jwt (1.0.0)
-    multi_json (1.10.1)
+    json (1.8.2)
+    jwt (1.5.0)
+    multi_json (1.11.0)
     multi_xml (0.5.5)
     multipart-post (1.2.0)
     nokogiri (1.5.10)
@@ -39,8 +39,8 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
-    rack (1.5.2)
-    rake (10.3.2)
+    rack (1.6.1)
+    rake (10.4.2)
     rdoc (3.12.2)
       json (~> 1.4)
     rspec (2.8.0)
@@ -51,7 +51,7 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
-    string-cases (0.0.0)
+    string-cases (0.0.1)
     tretry (0.0.2)
 
 PLATFORMS
@@ -59,9 +59,12 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (>= 1.0.0)
-  http2 (~> 0.0.25)
+  http2 (~> 0.0.31)
   jeweler (~> 1.8.4)
   rdoc (~> 3.12)
   rspec (~> 2.8.0)
   string-cases
   tretry (= 0.0.2)
+
+BUNDLED WITH
+   1.10.5

data/README.md

@@ -98,6 +98,20 @@ aos.subscribers do |sub|
 end
 ```
 
+### Bundle various field names in same request (which means they are already preloaded and won't cause an extra request each time you ask for the fields)
+```ruby
+aos.subscribers(field_names: ["MyData1", "MyData2"]) do |sub|
+  # do something
+end
+```
+
+### Bundle all data in same request
+```ruby
+aos.subscribers(all_demographics: true) do |sub|
+  # do something
+end
+```
+
 ### Get sendings
 ```ruby
 date_from = Date.new(2014, 6, 17)

data/VERSION

@@ -1 +1 @@
-0.0.12
+0.0.13

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.12 ruby lib
+# stub: apsis-on-steroids 0.0.13 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "apsis-on-steroids"
-  s.version = "0.0.12"
+  s.version = "0.0.13"
 
   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-11-21"
+  s.date = "2015-09-10"
   s.description = "A Ruby API for the Apsis mail service. "
   s.email = "k@spernj.org"
   s.extra_rdoc_files = [
@@ -50,7 +50,7 @@ Gem::Specification.new do |s|
     s.specification_version = 4
 
     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<http2>, ["~> 0.0.31"])
       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"])
@@ -58,7 +58,7 @@ Gem::Specification.new do |s|
       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.25"])
+      s.add_dependency(%q<http2>, ["~> 0.0.31"])
       s.add_dependency(%q<string-cases>, [">= 0"])
       s.add_dependency(%q<tretry>, ["= 0.0.2"])
       s.add_dependency(%q<rspec>, ["~> 2.8.0"])
@@ -67,7 +67,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
     end
   else
-    s.add_dependency(%q<http2>, ["~> 0.0.25"])
+    s.add_dependency(%q<http2>, ["~> 0.0.31"])
     s.add_dependency(%q<string-cases>, [">= 0"])
     s.add_dependency(%q<tretry>, ["= 0.0.2"])
     s.add_dependency(%q<rspec>, ["~> 2.8.0"])

data/include/mailing_list.rb

@@ -28,17 +28,33 @@ class ApsisOnSteroids::MailingList < ApsisOnSteroids::SubBase
     data_subscribers
   end
 
+  SUBSCRIBERS_VALID_ARGS = [:all_demographics, :timeout, :field_names, :allow_paginated]
+
   # Returns the subscribers of the mailing list.
-  def subscribers
+  def subscribers(args = {}, &blk)
+    args.each do |key, value|
+      raise "Invalid argument: '#{key}'." unless SUBSCRIBERS_VALID_ARGS.include?(key)
+    end
+
+    all_demographics = args.key?(:all_demographics) ? args[:all_demographics] : false
+    timeout = args[:timeout] || 300
+    field_names = args[:field_names] || []
+    allow_paginated = args.key?(:allow_paginated) ? args[:allow_paginated] : true
+
+    # Abort and do paginated if no reason to get everything as JSON.
+    if allow_paginated && !all_demographics && field_names.empty?
+      return subscribers_paginated(&blk)
+    end
+
     res = aos.req_json("v1/mailinglists/#{data(:id)}/subscribers/all", :post, json: {
-      "AllDemographics" => false,
-      "FieldNames" => []
+      "AllDemographics" => all_demographics,
+      "FieldNames" => field_names
     })
 
     url = URI.parse(res["Result"]["PollURL"])
     data_subscribers = nil
 
-    Timeout.timeout(300) do
+    Timeout.timeout(timeout) do
       loop do
         sleep 1
         res = aos.req_json(url.path)
@@ -62,6 +78,31 @@ class ApsisOnSteroids::MailingList < ApsisOnSteroids::SubBase
         data: aos.parse_obj(sub_data)
       )
 
+      if all_demographics || !field_names.empty?
+        sub.instance_variable_set(:@dem_data_fields, sub_data["DemographicData"])
+      end
+
+      if blk
+        blk.call(sub)
+      else
+        ret << sub
+      end
+    end
+
+    return ret
+  end
+
+  # Returns the subscribers of the mailing list.
+  def subscribers_paginated
+    resource_url = "v1/mailinglists/#{data(:id)}/subscribers/%{page}/%{size}"
+
+    ret = []
+    aos.read_paginated_response(resource_url) do |sub_data|
+      sub = ApsisOnSteroids::Subscriber.new(
+        aos: self.aos,
+        data: aos.parse_obj(sub_data)
+      )
+
       if block_given?
         yield sub
       else

data/include/open.rb

@@ -1,3 +1,2 @@
 class ApsisOnSteroids::Open < ApsisOnSteroids::SubBase
-
 end

data/include/opt_out.rb

@@ -1,3 +1,2 @@
 class ApsisOnSteroids::OptOut < ApsisOnSteroids::SubBase
-
 end

data/include/sending.rb

@@ -1,17 +1,17 @@
 class ApsisOnSteroids::Sending < ApsisOnSteroids::SubBase
-  def clicks args = {}
+  def clicks(args = {})
     list_for("v1/clicks/sendqueues/%{send_queue_id}/page/%{page}/size/%{size}", "v1/sendqueues/%{send_queue_id}/clicks", "Click", args)
   end
 
-  def opens args = {}
+  def opens(args = {})
     list_for("v1/opens/sendqueues/%{send_queue_id}/page/%{page}/size/%{size}", "v1/sendqueues/%{send_queue_id}/opens", "Open", args)
   end
 
-  def bounces args = {}
+  def bounces(args = {})
     list_for("v1/bounces/sendqueues/%{send_queue_id}/page/%{page}/size/%{size}", "v1/sendqueues/%{send_queue_id}/bounces", "Bounce", args)
   end
 
-  def opt_outs args = {}
+  def opt_outs(args = {})
     list_for("v1/optouts/sendqueues/%{send_queue_id}/%{page}/%{size}", "v1/sendqueues/%{send_queue_id}/optouts", "OptOut", args)
   end
 
@@ -26,7 +26,7 @@ class ApsisOnSteroids::Sending < ApsisOnSteroids::SubBase
 
 private
 
-  def list_for_with_dates resource_url, resource_name, args
+  def list_for_with_dates(resource_url, resource_name, args)
     resource_url = resource_url.gsub("%{send_queue_id}", data(:send_queue_id).to_s)
 
     ub = aos.new_url_builder
@@ -48,7 +48,7 @@ private
     end
   end
 
-  def list_for resource_url, resource_url_with_dates, resource_name, args = {}
+  def list_for(resource_url, resource_url_with_dates, resource_name, args = {})
     # OptOut counting does not work :-( We will have to do the date request to fix this...
     # If date-arguments are given, we will have to use the date request.
     if args[:date_from] || args[:date_to] || resource_name == "OptOut"

data/include/subscriber.rb

@@ -1,7 +1,7 @@
 class ApsisOnSteroids::Subscriber < ApsisOnSteroids::SubBase
   # Fetches the details from the server and returns them.
   def details
-    if !@details
+    unless @details
       res = aos.req_json("v1/subscribers/id/#{data(:id)}")
 
       ret = {}
@@ -19,18 +19,19 @@ class ApsisOnSteroids::Subscriber < ApsisOnSteroids::SubBase
   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
+    dem_data_fields.each do |dem_data|
+      return dem_data["Value"] if dem_data["Key"].to_s.downcase == key
     end
 
     return nil
   end
 
+  def dem_data_fields
+    @dem_data_fields ||= details[:DemDataFields]
+  end
+
   # Returns true if the subscriber is active.
   def active?
-    details = self.details
     return false if details[:pending]
     return true
   end

data/lib/apsis-on-steroids.rb

@@ -191,6 +191,27 @@ class ApsisOnSteroids
     end
   end
 
+  def read_paginated_response(resource_url)
+    page = 1
+    resource_url = resource_url.gsub("%{size}", "1000")
+
+    loop do
+      resource_url_to_use = resource_url.gsub("%{page}", page.to_s)
+      result = req_json(resource_url_to_use)
+
+      result["Result"]["Items"].each do |resource_data|
+        yield resource_data
+      end
+
+      size_no = result["Result"]["TotalPages"]
+      if page >= size_no
+        break
+      else
+        page += 1
+      end
+    end
+  end
+
   def parse_obj(obj)
     if obj.is_a?(Array)
       ret = []
@@ -231,6 +252,7 @@ private
       host: "se.api.anpdm.com",
       port: 8443,
       ssl: true,
+      ssl_skip_verify: true,
       follow_redirects: false,
       debug: @args[:debug],
       extra_headers: {
@@ -240,7 +262,8 @@ private
         user: @args[:api_key],
         passwd: ""
       },
-      skip_port_in_host_header: true
+      skip_port_in_host_header: true,
+      raise_errors: false
     )
   end
 end

data/spec/apsis-on-steroids_spec.rb

@@ -33,6 +33,8 @@ describe "ApsisOnSteroids" do
   end
 
   it "#sendings_by_date_interval" do
+    require 'date'
+
     date_from = Date.new(2013, 4, 1)
     date_to = Date.new(2013, 6, 2)
 
@@ -110,12 +112,47 @@ describe "ApsisOnSteroids" do
       original_sub = sub
 
       count = 0
-      mlist.subscribers do |sub_i|
+      mlist.subscribers(allow_paginated: false) do |sub_i|
         count += 1
         #puts "Subscriber: #{sub_i}"
       end
 
-      raise "Expected more than one." if count < 1
+      count.should > 0
+    end
+
+    it "should include demographics data when set" do
+      original_sub = sub
+
+      count = 0
+      mlist.subscribers(all_demographics: true) do |sub_i|
+        count += 1
+        sub_i.instance_variable_get(:@dem_data_fields).should_not eq nil
+      end
+
+      count.should > 0
+    end
+
+    it "should include optional fields as demographic data when set" do
+      original_sub = sub
+
+      count = 0
+      mlist.subscribers(field_names: ["NaoshiID"]) do |sub_i|
+        count += 1
+        sub_i.instance_variable_get(:@dem_data_fields).should eq [{"Key" => "NaoshiID", "Value" => ""}]
+      end
+
+      count.should > 0
+    end
+
+    it "should get subscribers paginated" do
+      original_sub = sub
+
+      count = 0
+      mlist.subscribers_paginated do |sub_i|
+        count += 1
+      end
+
+      count.should > 0
     end
 
     it "can remove subscribers from lists" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apsis-on-steroids
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-21 00:00:00.000000000 Z
+date: 2015-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http2
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.25
+        version: 0.0.31
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.25
+        version: 0.0.31
 - !ruby/object:Gem::Dependency
   name: string-cases
   requirement: !ruby/object:Gem::Requirement