silverpop 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTNhZDM1YzIwY2RjODQwNjQ1MTY3NTk1NmQzYjBjYTFhOWYwMjk3Nw==
+    YzIwNDYxYmM2N2M4ZmVjNjQ1MzI2ZjZkOGNkM2M2YTgwYzM2OTc0MA==
   data.tar.gz: !binary |-
-    NWNkMWQwYmUwNTY4NDc0NmYwM2YyZTNlNjZhM2FjNmJlNjllYmQyNw==
+    NGFkYjI4NzRhNzI3NTZkN2NmNmI2NjgwZmY0NjZhYTc1M2FiYWMzMg==
 SHA512:
   metadata.gz: !binary |-
-    ZGFkZGM5ZTRiMjc5MzBiNTg1NWJlMGQ1MzJlYjhhMWY3MDVjYzUyNmFmZWZm
-    MmViNjA2ZjMyZTA5MzYyZGRlNmU5YmFhZTUxNzIxM2JiNzQ5ZWUyYjAyNWNk
-    YTY0Zjc5YzIwOGUyY2QyMTAxZTI4YTk3NDM3MzAyMmE2YjRlYmM=
+    NTMxNjRkMjc4NDQyMGQ1ZTVmODA4MjQyZWJkYTE2MmVlODA0NDA2M2RjNTU2
+    ZTAxNTA0ZGUzYmRlNmI0MzliNzgyN2FhMTE5NjAyNzQ0NDY5MmUyNDM4Mzk1
+    ZjhkZjIyYWNlMzdjNGQ3MjQ1NWYwNWI0NmNjOTI4NWNkYzlkZWM=
   data.tar.gz: !binary |-
-    M2U1ZjI2MzJiZDVjZmRhYjhiZDM2NGViYmU3MWZhNjdhMTljZTE2MzgzNGI2
-    OTg3NzA0MzkyZmJiNGY5ZWI4MTFhZGJmMzU5MDAzNGE2NDc3YzcxN2E4YjI4
-    M2NiMDE5NzZjNzQyY2EzZjliNDcwNTUyYzZjY2FmZDdjNDE5YjM=
+    MzRkYzc0NTcyZGYyNzFiZWEyNzI2MTU2OWU4MGFmNDAyMjY3OGRmM2ZlNGM0
+    YzViY2M4ZDZmYjAyZDk5YTZmYTQzZjU3YTM2ZmFmYTMyZjZmYzE0MGE5M2U1
+    MDIyZGFlOThlMjc0ZTkzNTlhOTEyNTFhMTAwNjcwZmFlZTcyZTY=

data/.travis.yml

@@ -0,0 +1,7 @@
+bundler_args: --without development
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/Gemfile

@@ -1,4 +1,12 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in silverpop.gemspec
+gem 'rake'
+
+group :test do
+  gem 'rspec'
+  gem 'simplecov', :require => false
+  gem 'webmock'
+  gem 'yardstick'
+end
+
 gemspec

data/README.md

@@ -1,9 +1,13 @@
 # SilverPop API
 A Ruby wrapper for the SilverPop API
 
+[![Build Status](https://secure.travis-ci.org/upworthy/silverpop.png?branch=master)][travis]
+[travis]: http://travis-ci.org/upworthy/silverpop
 
 ## Installation
 
+    $ gem install silverpop
+
 ## Documentation
 
 

data/lib/client/reporting.rb

@@ -2,6 +2,33 @@ module SilverPop
   class Client
     module Reporting
 
+      # GetSentMailingsForOrg - This interface extracts a listing of mailings sent for an organization for a specified date range.
+      #
+      # @param date_start [String]  Starting Date in the format “mm/dd/yyyy hh:mm:ss”
+      # @param date_end [String] Required Ending Date in the format “mm/dd/yyyy hh:mm:ss”
+      # @param options [Hash] Optional parameters to send
+      # @return [Mash] Mashify body from the API call
+      # @example Get sent mailing for organization for 1/1/2014 to 1/2/2014
+      #   s = SilverPop.new({access_token: "abc123", url: "https://api1.silverpop.com"})
+      #   s.get_sent_mailings_for_org("1/1/2014", "1/2/2014)
+      def get_sent_mailings_for_org(date_start, date_end, options={})
+        builder = Builder::XmlMarkup.new
+        xml = builder.Envelope {
+          builder.Body {
+            builder.GetSentMailingsForOrg {
+              unless options.empty?
+                options.each do |o|
+                    builder.tag! o[0], o[1]
+                end
+              end
+              builder.DATE_START date_start
+              builder.DATE_END date_end
+              }
+            }
+          }
+        post(xml)
+      end
+
       # RawRecipientDataExport - Allows exporting unique contact-level events and creates a .zip file containing a single flat file with all metrics
       #
       # @param query_params [Hash] The list of fields to run the query against MAILING_ID, REPORT_ID, etc.

data/lib/silverpop/version.rb

@@ -1,3 +1,3 @@
 module SilverPop
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/silverpop.gemspec

@@ -7,19 +7,17 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'faraday_middleware', '~> 0.8'
   gem.add_dependency 'hashie', '~> 2.0'
   gem.add_dependency 'builder', '~> 3.0'
+  gem.add_dependency 'multi_xml', '~> 0.5'
   gem.add_development_dependency 'oauth2'
-  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rdiscount'
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'simplecov'
-  gem.add_development_dependency 'webmock'
   gem.add_development_dependency 'yard'
   gem.author      = "Upworthy"
   gem.description = %q{A Ruby wrapper for the SilverPop API}
   gem.email       = 'webmaster@upworthy.com'
   gem.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
   gem.files       = `git ls-files`.split("\n")
-  gem.homepage    = ''
+  gem.homepage    = 'http://www.github.com/upworthy/silverpop'
+  gem.licenses    = ['BSD-3-Clause']
   gem.name        = 'silverpop'
   gem.require_paths = ['lib']
   gem.summary     = gem.description

data/spec/client/reporting_spec.rb

@@ -5,6 +5,36 @@ describe SilverPop::Client::Reporting do
     @client = SilverPop.new({access_token: "abc123",url: 'https://api1.silverpop.com'})
   end
 
+  describe ".get_sent_mailings_for_org" do
+    it "returns the mailingId for the given dates" do
+      stub_post("/XMLAPI?access_token=abc123").
+        with(:body => "<Envelope><Body><GetSentMailingsForOrg><DATE_START>1/1/2014 00:00:00</DATE_START><DATE_END>1/2/2014 23:59:59</DATE_END></GetSentMailingsForOrg></Body></Envelope>").
+        to_return(:status => 200, :body => fixture('sent_mailings_org.xml'), :headers => {'Content-type' => "text/xml"})
+
+      resp = @client.get_sent_mailings_for_org("1/1/2014 00:00:00", "1/2/2014 23:59:59")
+      resp.Envelope.Body.RESULT.Mailing[0].MailingId.should eql "5758"
+    end
+
+    it "returns the mailingId for the given dates when passing an option" do
+      stub_post("/XMLAPI?access_token=abc123").
+        with(:body => "<Envelope><Body><GetSentMailingsForOrg><PRIVATE/><DATE_START>1/1/2014 00:00:00</DATE_START><DATE_END>1/2/2014 23:59:59</DATE_END></GetSentMailingsForOrg></Body></Envelope>").
+        to_return(:status => 200, :body => fixture('sent_mailings_org.xml'), :headers => {'Content-type' => "text/xml"})
+
+      resp = @client.get_sent_mailings_for_org("1/1/2014 00:00:00", "1/2/2014 23:59:59", {PRIVATE: nil})
+      resp.Envelope.Body.RESULT.Mailing[0].MailingId.should eql "5758"
+    end
+
+    it "returns the SentMailingCount" do
+      stub_post("/XMLAPI?access_token=abc123").
+        with(:body => "<Envelope><Body><GetSentMailingsForOrg><MAILING_COUNT_ONLY/><DATE_START>1/1/2014 00:00:00</DATE_START><DATE_END>1/2/2014 23:59:59</DATE_END></GetSentMailingsForOrg></Body></Envelope>").
+        to_return(:status => 200, :body => "<Envelope><Body><RESULT><SUCCESS>TRUE</SUCCESS><SentMailingsCount>5758</SentMailingsCount></RESULT></Body></Envelope>", :headers => {'Content-type' => "text/xml"})
+
+      resp = @client.get_sent_mailings_for_org("1/1/2014 00:00:00", "1/2/2014 23:59:59", {MAILING_COUNT_ONLY: nil})
+      resp.Envelope.Body.RESULT.SentMailingsCount.should eql "5758"
+    end
+
+  end
+
   describe ".raw_recipient_data_export" do
     it "should return true when passing a MAILING_ID" do
       stub_post("/XMLAPI?access_token=abc123").

data/spec/fixtures/sent_mailings_org.xml

@@ -0,0 +1,33 @@
+<Envelope>
+  <Body>
+    <RESULT>
+      <SUCCESS>TRUE</SUCCESS>
+      <Mailing>
+        <MailingId>5758</MailingId>
+        <ReportId>109118</ReportId>
+        <ScheduledTS>2011-06-14 10:54:06.0</ScheduledTS>
+        <MailingName><![CDATA[This is the mailing name]]></MailingName>
+        <ListName><![CDATA[This is the database name]]></ListName>
+        <ListId>4615</ListId>
+        <UserName> John Doe </UserName>
+        <SentTS/>
+        <NumSent>0</NumSent>
+        <Subject><![CDATA[Summer Sale]]></Subject>
+        <Visibility>Private</Visibility>
+      </Mailing>
+      <Mailing>
+        <MailingId>5758</MailingId>
+        <ReportId>109118</ReportId>
+        <ScheduledTS>2011-06-14 10:54:06.0</ScheduledTS>
+        <MailingName><![CDATA[My Mailing 2]]></MailingName>
+        <ListName><![CDATA[This is the database name 2]]></ListName>
+        <ListId>4616</ListId>
+        <UserName>John Doe</UserName>
+        <SentTS/>
+        <NumSent>0</NumSent>
+        <Subject><![CDATA[Summer Sale]]></Subject>
+        <Visibility>Private</Visibility>
+      </Mailing>
+    </RESULT>
+  </Body>
+</Envelope>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: silverpop
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Upworthy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-06 00:00:00.000000000 Z
+date: 2014-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -81,21 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: oauth2
+  name: multi_xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '0.5'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -122,48 +122,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -187,6 +145,7 @@ files:
 - .gemtest
 - .gitignore
 - .rspec
+- .travis.yml
 - .yardopts
 - Gemfile
 - LICENSE.md
@@ -204,10 +163,12 @@ files:
 - spec/client/reporting_spec.rb
 - spec/fixtures/contact.xml
 - spec/fixtures/reporting.xml
+- spec/fixtures/sent_mailings_org.xml
 - spec/helper.rb
 - spec/silverpop_spec.rb
-homepage: ''
-licenses: []
+homepage: http://www.github.com/upworthy/silverpop
+licenses:
+- BSD-3-Clause
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -234,6 +195,7 @@ test_files:
 - spec/client/reporting_spec.rb
 - spec/fixtures/contact.xml
 - spec/fixtures/reporting.xml
+- spec/fixtures/sent_mailings_org.xml
 - spec/helper.rb
 - spec/silverpop_spec.rb
 has_rdoc: