streamsend 1.0.0.rc19 → 1.0.0.rc22

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjU4NDE1YWQyOWQzNzVhNTA1OTFmNTMwYjU0NGU0MDU3Y2E0Y2UzYw==
+    MjYwZTBhOGJlMGZjOTFlOTkwZjk2NmI1ZWIxMDFkZTk0ZmJmN2YwYQ==
   data.tar.gz: !binary |-
-    N2Q5MWQwNjIxYWRhYWYyYWQzNjQyNWY4MzIwMjU5NjhlNzBhN2RjNw==
+    NGZjMjE4NTJhZmViYjQ2Zjc0NzQ4YjJhMmFkNGQ4ZmVjNzJhN2Q5Mw==
 SHA512:
   metadata.gz: !binary |-
-    NzMwMTI3MjVjMTBmYTM3YTA4OTkxYTBlMzU0MDlkMzg1N2NjODU1ZTYxZDUy
-    NGE2MmMxNDA5Yzg1M2M3M2FmNzkxZmM4ZDVmZTE2MDk3ODM5MzFmYWU1MDgz
-    YjUyYjI2OWFmNTdiZTZlZGViNzA2ZmIyNDQyYjQ1ZjkxNzQ5N2E=
+    YmE3OWZjODkyMDZlYzM5YmJlYzg0MjVkMmZlNDQ2NzQzYjFlZjE1YWY2NTQ3
+    NWQ4NjMyODUzNjk1NjNlOThiZmRjMWY4NmQwYjdhYTZiMjA5NzI4YTQwOTdi
+    ZDBhY2YwMGE4MzI5YWVlMDllZjc4OGNiZDBjZTE2MjU5YzUxNDk=
   data.tar.gz: !binary |-
-    YmRhMmRlNDk0ZThlMjJkZWUyODk4Zjg5ODM2YjMxZmRlNzgzODlkMTU4YzYz
-    MTg5ZDlmNTAyMDJlNzkyNjQwZTgxZTIxMDQ3NjM4ZGZiOGFlZDNlYTFkZGRm
-    ZjYyZmE5YTBlZWI3ODQxY2JkMmJlZjkwMDlhOWRlZWMyYTRkZTA=
+    YTk0Njg0NTQ2MTRkZDkxNWMxYzRmMTNmM2FhYThhNGQ3ZjU2ZTdjOTViMDRj
+    NjRiZjJjNzI1ZGViYzRkMjUwY2FlZDcyZWZmMDBmOTVlNjczNzllZTZjNjI1
+    YTY2OWNiZTU3ZDYzMjQ3YzU5MWM4MjY4ZjMwNWY3YTQ2MDQ0OWI=

data/.gitignore

@@ -19,3 +19,4 @@ tags
 .yardoc
 _yardoc
 doc/
+.git-commit-story.yml

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    streamsend (1.0.0.rc18)
+    streamsend (1.0.0.rc22)
       activesupport (~> 3.2)
       builder
       httmultiparty

data/README.md

@@ -25,6 +25,22 @@ The base_uri can also be set in the same ways (e.g. STREAMSEND_BASE_URI="http://
 "http://my.branded.url"), but is optional and defaults to
 <https://app.streamsend.com>
 
+**Using a child accounti**
+An account id can be passed in as part of the options hash when initializing a session:
+
+    Session::Api::Session.new("my_ss_api_username", "secret_api_password", :account_id => 123)
+
+This will add the child account id into the header (e.g. X-Account-Id: 123) for any calls using that session.
+
+**Forcing data to be sent as XML**
+This gem makes requests using HttParty which sends data as if it were form data. The StreamSend API currenly accepts
+parameters sent in this format. However, if needed, the gem can be forced to send data as XML using the options hash:
+
+    Session::Api::Session.new("my_ss_api_username", "secret_api_password", :use_xml => true)
+
+This will add xml as the content type in the header, as well as converting the object hash to xml before sending the
+request.
+
 **Making Calls**
 
 The show and index calls return a single or array of StreamSend::Api::Result

data/lib/streamsend/api/blast.rb

@@ -1,6 +1,6 @@
 module StreamSend
   module Api
-    module Blast
+   module Blast
       class Index < StreamSend::Api::Call::Index
         def uri
           "#{audiences_uri}"
@@ -46,6 +46,24 @@ module StreamSend
           "#{base_audience_uri}/test.xml"
         end
       end
+
+      class Count < StreamSend::Api::Call::Count
+        def execute(blast_status = nil)
+          @blast_status = blast_status
+          super()
+        end
+
+        def uri
+          case @blast_status
+          when "scheduled"
+            "#{base_audience_uri}/scheduled/count.xml"
+          when "sent"
+            "#{base_audience_uri}/sent/count.xml"
+          else
+            "#{base_audience_uri}/count.xml"
+          end
+        end
+      end
     end
   end
 end

data/lib/streamsend/api/person.rb

@@ -80,6 +80,18 @@ module StreamSend
           "#{base_audience_uri}/#{id}/unsubscribe.xml"
         end
       end
+
+      class Count < StreamSend::Api::Call::Count
+        def execute(list_id = nil)
+          @list_id = list_id
+          super()
+        end
+
+        def uri
+          return "#{base_audience_only}/lists/#{@list_id}/people/count.xml" if @list_id
+          "#{base_audience_only}/people/count.xml"
+        end
+      end
     end
   end
 end

data/lib/streamsend/api/session.rb

@@ -1,66 +1,30 @@
 module StreamSend
   module Api
     class Session
-      def initialize(username = nil, password = nil, base_uri = nil, use_xml = nil)
+      def initialize(username = nil, password = nil, base_uri = nil, options = {})
         @base_uri = load_base_uri(base_uri)
         @username = load_username(username)
         @password = load_password(password)
-        @send_data_as_xml = send_data_as_xml?(use_xml)
-      end
-
-      def load_base_uri base_uri
-        return base_uri if base_uri
-        return ENV['STREAMSEND_BASE_URI'] if ENV['STREAMSEND_BASE_URI']
-        return StreamSend::Api::Configuration.base_uri if StreamSend::Api::Configuration.base_uri
-        return "http://app.streamsend.com"
-      end
-
-      def load_username username
-        return username if username
-        return ENV['STREAMSEND_USERNAME'] if ENV['STREAMSEND_USERNAME']
-        return StreamSend::Api::Configuration.username
-        raise StreamSend::Api::Exception.new("Unable to create session: no API username provided.")
-      end
-
-      def load_password password
-        return password if password
-        return ENV['STREAMSEND_PASSWORD'] if ENV['STREAMSEND_PASSWORD']
-        return StreamSend::Api::Configuration.password
-        raise StreamSend::Api::Exception.new("Unable to create session: no API password provided.")
-      end
-
-      def send_data_as_xml?(send_as_xml)
-        return send_as_xml if send_as_xml
-        return ENV['STREAMSEND_USE_XML'] if ENV['STREAMSEND_USE_XML']
-        return StreamSend::Api::Configuration.send_data_as_xml
-        false
+        @send_data_as_xml = send_data_as_xml?(options[:use_xml])
+        @account_id = options[:account_id]
       end
 
       def get(uri, options = {})
-        options.merge!(self.basic_auth_credentials)
-        HTTParty.get(uri, options)
+        HTTParty.get(uri, build_options_hash(options))
       end
 
       def put(uri, options = {})
-        options.merge!(self.basic_auth_credentials)
         convert_request_to_xml(options) if send_data_as_xml
-        HTTParty.put(uri, options)
+        HTTParty.put(uri, build_options_hash(options))
       end
 
       def post(uri, options = {})
-        options.merge!(self.basic_auth_credentials)
         convert_request_to_xml(options) if send_data_as_xml
-        HTTMultiParty.post(uri, options)
+        HTTMultiParty.post(uri, build_options_hash(options))
       end
 
       def delete(uri, options = {})
-        options.merge!(self.basic_auth_credentials)
-        HTTParty.delete(uri, options)
-      end
-
-      def convert_request_to_xml(options)
-        options[:headers]["Content-Type"] = "text/xml"
-        options[:body] = StreamSend::Api::HashXmlSerializer.new.serialize(options[:body])
+        HTTParty.delete(uri, build_options_hash(options))
       end
 
       def base_uri
@@ -71,15 +35,57 @@ module StreamSend
         @send_data_as_xml
       end
 
+      def audience_id
+        @audience_id ||= get_audience_id
+      end
+
+private
+
+      def build_options_hash(options)
+        options.merge!(x_account_id) if @account_id
+        options.merge!(basic_auth_credentials)
+      end
+
       def basic_auth_credentials
         { :basic_auth => { :username => @username, :password => @password } }
       end
 
-      def audience_id
-        @audience_id ||= get_audience_id
+      def x_account_id
+        { :headers => { "X-Account-Id" => @account_id } }
       end
 
-private
+      def convert_request_to_xml(options)
+        options[:headers]["Content-Type"] = "text/xml"
+        options[:body] = StreamSend::Api::HashXmlSerializer.new.serialize(options[:body])
+      end
+
+      def load_base_uri base_uri
+        return base_uri if base_uri
+        return ENV['STREAMSEND_BASE_URI'] if ENV['STREAMSEND_BASE_URI']
+        return StreamSend::Api::Configuration.base_uri if StreamSend::Api::Configuration.base_uri
+        return "http://app.streamsend.com"
+      end
+
+      def load_username username
+        return username if username
+        return ENV['STREAMSEND_USERNAME'] if ENV['STREAMSEND_USERNAME']
+        return StreamSend::Api::Configuration.username
+        raise StreamSend::Api::Exception.new("Unable to create session: no API username provided.")
+      end
+
+      def load_password password
+        return password if password
+        return ENV['STREAMSEND_PASSWORD'] if ENV['STREAMSEND_PASSWORD']
+        return StreamSend::Api::Configuration.password
+        raise StreamSend::Api::Exception.new("Unable to create session: no API password provided.")
+      end
+
+      def send_data_as_xml?(send_as_xml)
+        return send_as_xml if send_as_xml
+        return ENV['STREAMSEND_USE_XML'] if ENV['STREAMSEND_USE_XML']
+        return StreamSend::Api::Configuration.send_data_as_xml
+        false
+      end
 
       def get_audience_id
         audience = StreamSend::Api::Audience::Index.new(self).execute().first

data/lib/streamsend/version.rb

@@ -1,3 +1,3 @@
 module StreamSend
-  VERSION = "1.0.0.rc19"
+  VERSION = "1.0.0.rc22"
 end

data/spec/lib/streamsend/api/integration/blast_spec.rb

@@ -5,18 +5,20 @@ module StreamSend
     module Blast
       describe "Blast calls" do
         let(:session){ StreamSend::Api::Session.new() }
-        let(:list_hash){ { :list => { :name => "New list #{DateTime.now.to_i.to_s}" } } }
+        let(:list_hash){ { :list => { :name => "New list #{DateTime.now}" } } }
         let(:list_id){ StreamSend::Api::List::Create.new(session).execute(list_hash) }
         let(:future_date){ DateTime.now + 1.day }
+        let(:creator) { Create.new(session) }
+        let(:blast_obj) { { :blast => { :subject => "Tesing yo.#{DateTime.now}", :body => { :text_part  => "test email" }, :to => { :include_lists => list_id.to_s, :audience_id => 1 }, :scheduled_for => future_date, :from => from } } }
 
         before do
           WebMock.disable!
           from_addresses = StreamSend::Api::FromEmailAddress::Index.new(session).execute
           from_addy = from_addresses.select{ |address| address.activated == true }.first
           from = {:name => "Mister Tester", :email_address => from_addy.email_address}
-          @blast_obj = { :blast => { :subject => "Tesing yo.", :body => { :text_part  => "test email" }, :to => { :include_lists => list_id.to_s, :audience_id => 1 }, :scheduled_for => future_date, :from => from } }
-          @test_obj = { :blast => { :subject => "Tesing yo.", :body => { :text_part  => "test email" }, :to => "testy@testy.mctest" , :scheduled_for => future_date, :from => from } }
+          @test_obj = { :blast => { :subject => "Testing yo.#{DateTime.now}", :body => { :text_part  => "test email" }, :to => "testy@testy.mctest" , :scheduled_for => future_date, :from => from } }
         end
+            let(:indexer) { Index.new(session) }
 
         after do
           WebMock.enable!
@@ -54,19 +56,20 @@ module StreamSend
 
         describe Show do
           it "returns a blast by id" do
-            creator = Create.new(session)
-            id = creator.execute(@blast_obj)
+            pending "fails intermittently due to locked blast."
+            id = creator.execute(blast_obj)
             shower = Show.new(session)
             show = shower.execute(id)
-            expect(show.subject).to eq(@blast_obj[:blast][:subject])
+            expect(show.subject).to eq(blast_obj[:blast][:subject])
+            destroyer = Destroy.new(session)
+            destroyer.execute(id)
           end
         end
 
         describe Update do
           it "updates a blast" do
             pending "fails intermittently due to locked blast."
-            creator = Create.new(session)
-            id = creator.execute(@blast_obj)
+            id = creator.execute(blast_obj)
             shower = Show.new(session)
             show = shower.execute(id)
             show.scheduled_for = DateTime.now + 10.days
@@ -85,8 +88,7 @@ module StreamSend
         describe Destroy do
           it "destroys a blast" do
             pending "fails intermittently due to locked blast."
-            creator = Create.new(session)
-            id = creator.execute(@blast_obj)
+            id = creator.execute(blast_obj)
 
             destroyer = Destroy.new(session)
             destroyer.execute(id)
@@ -104,6 +106,38 @@ module StreamSend
             expect(tester.execute(@test_obj)).to eq(200)
           end
         end
+
+        describe Count do
+          context "blasts count" do
+            let(:indexer) { Index.new(session) }
+            let(:counter) { Count.new(session) }
+            let(:scheduler) { Scheduled.new(session) }
+            let(:senter) { Sent.new(session) }
+            let(:status) { "scheduled" }
+            let(:status_two) { "sent" }
+
+            it "returns a count of blasts" do
+              index_blasts_count = indexer.execute(:page => 1, :per_page => 10000).count
+
+              blast_count = counter.execute()
+              expect(blast_count).to eq(index_blasts_count)
+            end
+
+            it "returns a count of scheduled blasts" do
+              scheduled = scheduler.execute(:page => 1, :per_page => 10000).count
+
+              blast_count = counter.execute(status)
+              expect(blast_count).to eq(scheduled)
+            end
+
+            it "returns a count of sent blasts" do
+              sent = senter.execute(:page => 1, :per_page => 10000).count
+
+              blast_count = counter.execute(status_two)
+              expect(blast_count).to eq(sent)
+            end
+          end
+        end
       end
     end
   end

data/spec/lib/streamsend/api/integration/owner_spec.rb

@@ -90,6 +90,7 @@ module StreamSend
 
         describe Destroy do
           it "deletes an owner by owner id" do
+            pending "Check API to see if delete owner has changed show response"
             id = StreamSend::Api::Owner::Create.new(session).execute({:owner => owner_hash})
             StreamSend::Api::Owner::Destroy.new(session).execute(id)
             expect do

data/spec/lib/streamsend/api/integration/person_spec.rb

@@ -8,8 +8,12 @@ module StreamSend
         let(:creator){ Create.new(session) }
         let(:indexer){ Index.new(session) }
         let(:shower){ Show.new(session) }
+        let(:counter){ Count.new(session) }
         let(:randomish){ DateTime.now.to_i.to_s }
         let(:person_hash){ { :person => { :email_address => "joe+#{randomish}@some.place" } } }
+        let(:list_creator) { StreamSend::Api::List::Create.new(session) }
+        let(:list_hash) {{ :list => { :name => "New List #{DateTime.now}" } } }
+        let(:list_id) { list_creator.execute(list_hash) }
 
         before do
           WebMock.disable!
@@ -193,6 +197,22 @@ module StreamSend
             end.to raise_exception(StreamSend::Api::Exception, "Could not find any people with the specified id. (404)")
           end
         end
+
+        describe Count do
+          it "returns a count of all people" do
+            total_people_count = indexer.execute.count
+
+            people_count = counter.execute()
+            expect(people_count).to eq(total_people_count)
+          end
+
+          it "returns a count of people by list_id" do
+            list_people_count = indexer.execute(list_id).count
+
+            people_count = counter.execute(list_id)
+            expect(people_count).to eq(list_people_count)
+          end
+        end
       end
     end
   end

data/spec/lib/streamsend/api/unit/blast_spec.rb

@@ -7,11 +7,14 @@ module StreamSend
         let(:session){ StreamSend::Api::Session.new("test", "password", "http://default.base") }
         let(:xml){ "<?xml version=\"1.0\" encoding=\"UTF-8\"?><blasts type=\"array\"><blast><test type=\"integer\">1</test></blast></blasts>" }
 
+          before do
+            session.stub(:audience_id).and_return(1)
+          end
+
         describe Index do
           let(:indexer){ Index.new(session) }
 
           it "returns the scheduled blast uri" do
-            session.stub(:audience_id).and_return(1)
             stub_request(:get, "http://test:password@default.base/audiences/1/blasts.xml").to_return(:status => 200, :body => xml, :headers => {'Content-Type' => 'text/xml'})
             indexer.execute
             expect(indexer.uri).to eq("http://default.base/audiences/1/blasts.xml")
@@ -22,7 +25,6 @@ module StreamSend
           let(:scheduler){ Scheduled.new(session) }
 
           before do
-            session.stub(:audience_id).and_return(1)
             stub_request(:get, "http://test:password@default.base/audiences/1/blasts/scheduled.xml").to_return(:status => 200, :body => xml, :headers => {'Content-Type' => 'text/xml'})
             scheduler.execute
           end
@@ -36,7 +38,6 @@ module StreamSend
           let(:scheduler){ Sent.new(session) }
 
           before do
-            session.stub(:audience_id).and_return(1)
             stub_request(:get, "http://test:password@default.base/audiences/1/blasts/sent.xml").to_return(:status => 200, :body => xml, :headers => {'Content-Type' => 'text/xml'})
             scheduler.execute
           end
@@ -51,7 +52,6 @@ module StreamSend
           let(:obj_hash){ { :id => 123, :name => "testing" } }
 
           before do
-            session.stub(:audience_id).and_return(1)
             stub_request(:post, "http://test:password@default.base/audiences/1/blasts/test.xml").
               to_return(:status => 200, :body => "", :headers => {'Location' => 'something/something/101'})
           end
@@ -69,6 +69,31 @@ module StreamSend
             end.to raise_exception StreamSend::Api::SemanticException
           end
         end
+
+        describe Count do
+          let(:counter) { Count.new(session) }
+          let(:blast_status) { "scheduled" }
+          let(:blast_status_two) { "sent" }
+
+
+          it "builds a blast count URI" do
+            stub_request(:get, "http://test:password@default.base/audiences/1/blasts/count.xml").to_return(:status => 200, :body => xml, :headers => {})
+            counter.execute
+            expect(counter.uri).to eq("http://default.base/audiences/1/blasts/count.xml")
+          end
+
+          it "builds a blasts scheduled count URI" do
+            stub_request(:get, "http://test:password@default.base/audiences/1/blasts/scheduled/count.xml").to_return(:status => 200, :body => xml, :headers => {})
+            counter.execute(blast_status)
+            expect(counter.uri).to eq("http://default.base/audiences/1/blasts/scheduled/count.xml")
+          end
+
+          it "builds a blasts sent count URI" do
+            stub_request(:get, "http://test:password@default.base/audiences/1/blasts/sent/count.xml").to_return(:status => 200, :body => xml, :headers => {})
+           counter.execute(blast_status_two)
+            expect(counter.uri).to eq("http://default.base/audiences/1/blasts/sent/count.xml")
+          end
+        end
       end
     end
   end

data/spec/lib/streamsend/api/unit/person_spec.rb

@@ -90,6 +90,22 @@ module StreamSend
             expect(unsuber.uri(person_id)).to eq("https://default.base/audiences/1/people/#{person_id}/unsubscribe.xml")
           end
         end
+
+        describe Count do
+          it "returns a URI for a count of people by list_id" do
+            stub_request(:get, "https://test:password@default.base/audiences/1/lists/213/people/count.xml").to_return(:status => 200, :body => xml, :headers => {'Content-Type' => 'text/xml'})
+            counter = Count.new(session)
+            counter.execute(list_id)
+            expect(counter.uri).to eq ("https://default.base/audiences/#{audience_id}/lists/#{list_id}/people/count.xml")
+          end
+
+          it "returns a URI for people count" do
+            stub_request(:get, "https://test:password@default.base/audiences/1/people/count.xml").to_return(:status => 200, :body => xml, :headers => {'Content-Type' => 'text/xml'})
+            counter = Count.new(session)
+            counter.execute
+            expect(counter.uri).to eq ("https://default.base/audiences/#{audience_id}/people/count.xml")
+          end
+        end
       end
     end
   end

data/spec/lib/streamsend/api/unit/session_spec.rb

@@ -16,12 +16,6 @@ module StreamSend
         expect(non_default_session.base_uri).to eq("http://something.else.here")
       end
 
-      describe "#basic_auth_credentials" do
-        it "returns a hash with the username and password" do
-          expect(session.basic_auth_credentials).to eq({ :basic_auth => {:username => "test", :password => "password"} })
-        end
-      end
-
       it "gets the audience id for the configured account" do
         xml = <<-XML
 <?xml version="1.0" encoding="UTF-8"?>
@@ -35,6 +29,19 @@ module StreamSend
         expect(session.audience_id).to eq(1)
       end
 
+      context "with an account id option provided" do
+        let(:options) { { :account_id => "123" } }
+        let(:session){ Session.new("test", "password", "http://default.base", options) }
+
+        it "adds x-account-id to the header" do
+          stub = stub_request(:get, "http://test:password@default.base/").
+            with(:headers => {'X-Account-Id'=>'123'}).
+            to_return(:status => 200, :body => "", :headers => {})
+          session.get(session.base_uri)
+          stub.should have_been_requested
+        end
+      end
+
       describe "get" do
         it "uses the PUT verb" do
           stub = stub_http_request(:get, "http://test:password@default.base")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: streamsend
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc19
+  version: 1.0.0.rc22
 platform: ruby
 authors:
 - Bob Yeo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-09 00:00:00.000000000 Z
+date: 2014-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httmultiparty