streamsend 0.1.2 → 0.2.0

data/spec/lib/streamsend/api/list_spec.rb

@@ -0,0 +1,179 @@
+require File.join(File.dirname(__FILE__), "../../../spec_helper")
+
+module StreamSend
+  module Api
+    describe "List" do
+      let(:app_host) { "http://test.host" }
+      before do
+        WebMock.enable!
+        stub_http_request(:any, //).to_return(:body => "Page not found.", :status => 404)
+
+        @username = "scott"
+        @password = "topsecret"
+        @host = "test.host"
+
+        xml = <<-XML
+        <?xml version="1.0" encoding="UTF-8"?>
+        <audiences type="array">
+          <audience>
+            <id type="integer">2</id>
+          </audience>
+        </audiences>
+        XML
+        stub_http_request(:get, "http://#{@username}:#{@password}@#{@host}/audiences.xml").to_return(:body => xml)
+        StreamSend::Api::List.stub(:audience_id).and_return(2)
+
+        StreamSend::Api.configure(@username, @password, @host)
+      end
+
+      after do
+        WebMock.disable!
+      end
+
+      describe ".audience_id" do
+        it "returns the id of the first audience" do
+          StreamSend::Api::List.audience_id.should == 2
+        end
+      end
+
+      describe ".all" do
+        describe "with lists" do
+          before(:each) do
+            xml = <<-XML
+<?xml version="1.0" encoding="UTF-8"?>
+<lists type="array">
+  <list>
+    <active-people-count type="integer">11</active-people-count>
+    <checked-by-default type="boolean" nil="true"></checked-by-default>
+    <created-at type="datetime">2012-01-14T18:11:50Z</created-at>
+    <deleted-at type="datetime" nil="true"></deleted-at>
+    <description nil="true"></description>
+    <id type="integer">42</id>
+    <inactive-people-count type="integer">0</inactive-people-count>
+    <name>First list</name>
+    <pending-people-count type="integer">0</pending-people-count>
+    <public type="boolean" nil="true"></public>
+    <status type="enum">idle</status>
+    <unsubscribed-people-count type="integer">0</unsubscribed-people-count>
+    <updated-at type="datetime">2012-01-14T18:11:50Z</updated-at>
+    <audience-id type="integer">2</audience-id>
+  </list>
+</lists>
+            XML
+
+            stub_http_request(:get, "http://#{@username}:#{@password}@#{@host}/audiences/2/lists.xml").to_return(:body => xml)
+          end
+
+          it "should return array of one list object" do
+            lists = StreamSend::Api::List.all
+            lists.size.should == 1
+
+            lists.first.should be_instance_of(StreamSend::Api::List)
+            lists.first.id.should == 42
+            lists.first.name.should == "First list"
+            lists.first.created_at.should == Time.parse("2012-01-14T18:11:50Z")
+          end
+        end
+
+        describe "with no lists" do
+          before(:each) do
+            xml = <<-XML
+            <?xml version="1.0" encoding="UTF-8"?>
+            <lists type="array"/>
+            XML
+
+            stub_http_request(:get, "http://#{@username}:#{@password}@#{@host}/audiences/2/lists.xml").to_return(:body => xml)
+          end
+
+          it "should return an empty array" do
+            StreamSend::Api::List.all.should == []
+          end
+        end
+
+        describe "with invalid audience" do
+          before(:each) do
+            xml = <<-XML
+            <?xml version="1.0" encoding="UTF-8"?>
+            <people type="array"/>
+            XML
+
+            stub_http_request(:get, "http://#{@username}:#{@password}@#{@host}/audiences/99/people.xml").to_return(:body => xml)
+          end
+
+          it "should raise an exception" do
+            lambda { StreamSend::Api::List.all }.should raise_error
+          end
+        end
+      end
+
+      describe ".find" do
+        describe "with matching list" do
+          before(:each) do
+            xml = <<-XML
+<?xml version="1.0" encoding="UTF-8"?>
+  <list>
+    <active-people-count type="integer">11</active-people-count>
+    <checked-by-default type="boolean" nil="true"></checked-by-default>
+    <created-at type="datetime">2012-01-14T18:11:50Z</created-at>
+    <deleted-at type="datetime" nil="true"></deleted-at>
+    <description nil="true"></description>
+    <id type="integer">42</id>
+    <inactive-people-count type="integer">0</inactive-people-count>
+    <name>First list</name>
+    <pending-people-count type="integer">0</pending-people-count>
+    <public type="boolean" nil="true"></public>
+    <status type="enum">idle</status>
+    <unsubscribed-people-count type="integer">0</unsubscribed-people-count>
+    <updated-at type="datetime">2012-01-14T18:11:50Z</updated-at>
+    <audience-id type="integer">2</audience-id>
+  </list>
+            XML
+
+            stub_http_request(:get, /audiences\/2\/lists\/42.xml/).with(:id => "42").to_return(:body => xml)
+          end
+
+          it "should return list" do
+            list = StreamSend::Api::List.find(42)
+
+            list.should be_instance_of(StreamSend::Api::List)
+            list.id.should == 42
+            list.name.should == "First list"
+            list.created_at.should == Time.parse("2012-01-14T18:11:50Z")
+          end
+        end
+
+        describe "with no matching list" do
+          before(:each) do
+            xml = <<-XML
+            <?xml version="1.0" encoding="UTF-8"?>
+            <lists type="array"\>
+            XML
+
+            stub_http_request(:get, "http://#{@username}:#{@password}@#{@host}/audiences/2/people.xml?email_address=bad.email@gmail.com").to_return(:status => 404)
+          end
+
+          it "should return throw an exception" do
+            lambda {
+              StreamSend::Api::List.find(-1)
+            }.should raise_error
+          end
+        end
+
+        describe "with invalid audience" do
+          before(:each) do
+            xml = <<-XML
+            <?xml version="1.0" encoding="UTF-8"?>
+            <people type="array"\>
+            XML
+
+            stub_http_request(:get, "http://#{@username}:#{@password}@#{@host}/audiences/99/people.xml?email_address=bad.email@gmail.com").to_return(:body => xml)
+          end
+
+          it "should raise an exception" do
+            lambda { StreamSend::Api::List.find("scott@gmail.com") }.should raise_error
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/streamsend/api/resource_spec.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__), "../../../spec_helper")
+
+module StreamSend
+  module Api
+    describe "Resource" do
+      describe "with missing method" do
+        before(:each) do
+          @resource = StreamSend::Api::Resource.new({"name" => "scott"})
+        end
+
+        it "should return value" do
+          @resource.name.should == "scott"
+        end
+      end
+
+      describe "#id" do
+        it "should return id" do
+          StreamSend::Api::Resource.new({"id" => 99}).id.should == 99
+        end
+      end
+
+    end
+  end
+end

data/spec/lib/streamsend/api/subscriber_spec.rb

@@ -0,0 +1,274 @@
+require File.join(File.dirname(__FILE__), "../../../spec_helper")
+require "ostruct"
+
+module StreamSend
+  module Api
+    describe "Subscriber" do
+      before do
+        WebMock.enable!
+        stub_http_request(:any, //).to_return(:body => "Page not found.", :status => 404)
+
+        @username = "scott"
+        @password = "topsecret"
+        @host = "test.host"
+
+        xml = <<-XML
+        <?xml version="1.0" encoding="UTF-8"?>
+        <audiences type="array">
+          <audience>
+            <id type="integer">2</id>
+          </audience>
+        </audiences>
+        XML
+        stub_http_request(:get, "http://#{@username}:#{@password}@#{@host}/audiences.xml").to_return(:body => xml)
+
+        StreamSend::Api.configure(@username, @password, @host)
+      end
+
+      after do
+        WebMock.disable!
+      end
+
+      describe ".audience_id" do
+        it "should return the id of the first audience" do
+          StreamSend::Api::Subscriber.audience_id.should == 2
+        end
+      end
+
+      describe ".clear_audience" do
+        it "allows the audience_id to be retrieved again" do
+          @resource = StreamSend::Api::Resource.new({"name" => "jeff"})
+          StreamSend::Api.should_receive(:get).with("/audiences.xml").and_return(OpenStruct.new(:parsed_response => { "audiences" => [{"id" => 2}] }))
+          StreamSend::Api::Resource.audience_id.should == 2
+          StreamSend::Api.should_receive(:get).with("/audiences.xml").and_return(OpenStruct.new(:parsed_response => { "audiences" => [{"id" => 1}] }))
+          StreamSend::Api::Resource.audience_id.should == 2
+          StreamSend::Api::Resource.clear_audience
+          StreamSend::Api::Resource.audience_id.should == 1
+        end
+      end
+
+      describe ".all" do
+        describe "with subscribers" do
+          before(:each) do
+            xml = <<-XML
+            <?xml version="1.0" encoding="UTF-8"?>
+            <people type="array">
+              <person>
+                <id type="integer">2</id>
+                <email-address>scott@gmail.com</email-address>
+                <created-at type="datetime">2009-09-18T01:27:05Z</created-at>
+              </person>
+            </people>
+            XML
+
+            stub_http_request(:get, "http://#{@username}:#{@password}@#{@host}/audiences/2/people.xml").to_return(:body => xml)
+          end
+
+          it "should return array of one subscriber object" do
+            subscribers = StreamSend::Api::Subscriber.all
+            subscribers.size.should == 1
+
+            subscribers.first.should be_instance_of(StreamSend::Api::Subscriber)
+            subscribers.first.id.should == 2
+            subscribers.first.email_address.should == "scott@gmail.com"
+            subscribers.first.created_at.should == Time.parse("2009-09-18T01:27:05Z")
+          end
+        end
+
+        describe "with no subscribers" do
+          before(:each) do
+            xml = <<-XML
+            <?xml version="1.0" encoding="UTF-8"?>
+            <people type="array"/>
+            XML
+
+            stub_http_request(:get, "http://#{@username}:#{@password}@#{@host}/audiences/2/people.xml").to_return(:body => xml)
+          end
+
+          it "should return an empty array" do
+            StreamSend::Api::Subscriber.all.should == []
+          end
+        end
+
+        describe "with invalid audience" do
+          before(:each) do
+            xml = <<-XML
+            <?xml version="1.0" encoding="UTF-8"?>
+            <people type="array"/>
+            XML
+
+            stub_http_request(:get, "http://#{@username}:#{@password}@#{@host}/audiences/99/people.xml").to_return(:body => xml)
+          end
+
+          it "should raise an exception" do
+            lambda { StreamSend::Api::Subscriber.all }.should raise_error
+          end
+        end
+      end
+
+      describe ".find" do
+        describe "with matching subscriber" do
+          before(:each) do
+            xml = <<-XML
+            <?xml version="1.0" encoding="UTF-8"?>
+            <people type="array">
+              <person>
+                <id type="integer">2</id>
+                <email-address>scott@gmail.com</email-address>
+                <created-at type="datetime">2009-09-18T01:27:05Z</created-at>
+              </person>
+            </people>
+            XML
+
+            stub_http_request(:get, "http://#{@username}:#{@password}@#{@host}/audiences/2/people.xml?email_address=scott@gmail.com").to_return(:body => xml)
+          end
+
+          it "should return subscriber" do
+            subscriber = StreamSend::Api::Subscriber.find("scott@gmail.com")
+
+            subscriber.should be_instance_of(StreamSend::Api::Subscriber)
+            subscriber.id.should == 2
+            subscriber.email_address.should == "scott@gmail.com"
+            subscriber.created_at.should == Time.parse("2009-09-18T01:27:05Z")
+          end
+        end
+
+        describe "with invalid audience" do
+          before(:each) do
+            xml = <<-XML
+            <?xml version="1.0" encoding="UTF-8"?>
+            <people type="array"\>
+            XML
+
+            stub_http_request(:get, "http://#{@username}:#{@password}@#{@host}/audiences/99/people.xml?email_address=bad.email@gmail.com").to_return(:body => xml)
+          end
+
+          it "should raise an exception" do
+            lambda { StreamSend::Api::Subscriber.find("scott@gmail.com") }.should raise_error
+          end
+        end
+      end
+
+      describe ".create" do
+        describe "with valid subscriber parameters" do
+          describe "with no existing subscribers using the given email address" do
+            before(:each) do
+              stub_http_request(:post, /audiences\/2\/people.xml/).with(:person => {"email_address" => "foo@bar.com", "first_name" => "JoeBob"}).to_return(:body => "", :headers => {"location" => "http://test.host/audiences/2/people/1"}, :status => 201)
+            end
+
+            it "should return the new subscriber's id" do
+              subscriber_id = StreamSend::Api::Subscriber.create({"email_address" => "foo@bar.com", "first_name" => "JoeBob"})
+
+              subscriber_id.should_not be_nil
+              subscriber_id.should == 1
+            end
+          end
+
+          describe "with an existing subscriber using the given email address" do
+            before(:each) do
+              stub_http_request(:post, /audiences\/2\/people.xml/).with(:person => {"email_address" => "foo@bar.com", "first_name" => "JoeBob"}).to_return(:body => "<error>Email address has already been taken<error>")
+            end
+
+            it "should raise an exception" do
+              lambda {
+                subscriber_id = StreamSend::Api::Subscriber.create({"email_address" => "foo@bar.com", "first_name" => "JoeBob"})
+              }.should raise_error
+            end
+          end
+        end
+
+        describe "with invalid subscriber parameters" do
+          before(:each) do
+            stub_http_request(:post, /audiences\/2\/people.xml/).with({"email_address" => "foo.com", "first_name" => "JoeBob"}).to_return(:body => "<error>Email address does not appear to be valid</error>")
+          end
+
+          it "should raise an exception" do
+            lambda {
+              subscriber_id = StreamSend::Api::Subscriber.create({"email_address" => "foo@bar.com", "first_name" => "JoeBob"})
+            }.should raise_error
+          end
+        end
+      end
+
+      describe "#show" do
+        describe "with valid subscriber instance" do
+          before(:each) do
+            xml = <<-XML
+            <?xml version="1.0" encoding="UTF-8"?>
+            <person>
+              <id type="integer">2</id>
+              <email-address>scott@gmail.com</email-address>
+              <created-at type="datetime">2009-09-18T01:27:05Z</created-at>
+              <first-name>Scott</first-name>
+              <last-name>Albertson</last-name>
+            </person>
+            XML
+
+            stub_http_request(:get, "http://#{@username}:#{@password}@#{@host}/audiences/1/people/2.xml").to_return(:body => xml)
+          end
+
+          it "should return subscriber" do
+            subscriber = StreamSend::Api::Subscriber.new({"id" => 2, "audience_id" => 1}).show
+
+            subscriber.should be_instance_of(StreamSend::Api::Subscriber)
+            subscriber.id.should == 2
+            subscriber.email_address.should == "scott@gmail.com"
+            subscriber.created_at.should == Time.parse("2009-09-18T01:27:05Z")
+            subscriber.first_name.should == "Scott"
+            subscriber.last_name.should == "Albertson"
+          end
+        end
+
+        describe "with invalid subscriber instance" do
+          it "should raise exception" do
+            lambda { StreamSend::Api::Subscriber.new({"id" => 99, "audience_id" => 1}).show }.should raise_error
+          end
+        end
+
+        describe "with invalid audience" do
+          it "should raise exception" do
+            lambda { StreamSend::Api::Subscriber.new({"id" => 2}).show }.should raise_error
+          end
+        end
+      end
+
+      describe "#activate" do
+        before(:each) do
+          stub_http_request(:post, "http://#{@username}:#{@password}@#{@host}/audiences/1/people/2/activate.xml").to_return(:body => nil)
+        end
+
+        describe "with valid subscriber" do
+          it "should be successful" do
+            response = StreamSend::Api::Subscriber.new({"id" => 2, "audience_id" => 1}).activate
+            response.should be_true
+          end
+        end
+
+        describe "with invalid subscriber" do
+          it "should raise exception" do
+            lambda { StreamSend::Api::Subscriber.new({"id" => 99, "audience_id" => 1}).activate }.should raise_error
+          end
+        end
+      end
+
+      describe "#unsubscribe" do
+        before(:each) do
+          stub_http_request(:post, "http://#{@username}:#{@password}@#{@host}/audiences/1/people/2/unsubscribe.xml").to_return(:body => nil)
+        end
+
+        describe "with valid subscriber" do
+          it "should be successful" do
+            response = StreamSend::Api::Subscriber.new({"id" => 2, "audience_id" => 1}).unsubscribe
+            response.should be_true
+          end
+        end
+
+        describe "with invalid subscriber" do
+          it "should raise exception" do
+            lambda { StreamSend::Api::Subscriber.new({"id" => 99, "audience_id" => 1}).unsubscribe }.should raise_error
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/streamsend/api/user_spec.rb

@@ -0,0 +1,149 @@
+require File.join(File.dirname(__FILE__), "../../../spec_helper")
+require "webmock"
+require "active_support/core_ext/hash"
+
+module StreamSend
+  module Api
+    describe "User" do
+      let(:app_host) { "http://test.host" }
+
+      before do
+        WebMock.enable!
+        @username = "jeff"
+        @password = "topsecret"
+        @host = "test.host"
+        StreamSend::Api.configure(@username, @password, @host)
+      end
+
+      after do
+        WebMock.disable!
+      end
+
+      describe "#all" do
+        describe "with two users" do
+          before do
+            users = <<-XML
+<?xml version="1.0" encoding="UTF-8"?>
+<users type="array">
+  <user>
+    <administrator type="boolean">true</administrator>
+    <title>Administrator</title>
+    <last-name>User</last-name>
+    <updated-at type="datetime">2012-11-29T17:14:55-08:00</updated-at>
+    <may-export type="boolean">true</may-export>
+    <id type="integer">1</id>
+    <email-address>admin@streamsend.com</email-address>
+    <first-name>Admin</first-name>
+    <company-name>Not Random BS</company-name>
+    <created-at type="datetime">2012-11-29T17:14:55-08:00</created-at>
+  </user>
+
+  <user>
+    <administrator type="boolean">false</administrator>
+    <title>regular user</title>
+    <last-name>User2</last-name>
+    <updated-at type="datetime">2012-11-29T17:14:55-08:00</updated-at>
+    <may-export type="boolean">true</may-export>
+    <id type="integer">1</id>
+    <email-address>joe@streamsend.com</email-address>
+    <first-name>Joe</first-name>
+    <company-name>Not Random BS</company-name>
+    <created-at type="datetime">2012-11-29T17:14:55-08:00</created-at>
+  </user>
+</users>
+            XML
+
+            stub_http_request(:get, "http://#{@username}:#{@password}@#{@host}/users.xml").to_return(:body => users)
+          end
+
+          it "should return an array of two users" do
+            users = StreamSend::Api::User.all
+            users.size.should == 2
+          end
+
+          it "should return an array with the two users" do
+            users = StreamSend::Api::User.all
+            users.first.id.should == 1
+          end
+        end
+
+        describe "with no users" do
+          before do
+            stub_http_request(:get, "http://#{@username}:#{@password}@#{@host}/users.xml").to_return(:body => "Page not found.", :status => 404)
+          end
+
+          it "should raise an error" do
+            lambda do
+              users = StreamSend::Api::User.all
+            end.should raise_error
+          end
+
+        end
+      end
+
+      describe "#show" do
+        describe "with a single user" do
+          before do
+            xml = <<-XML
+  <?xml version="1.0" encoding="UTF-8"?>
+    <user>
+      <id>2</id>
+      <email-address>john2@example.com</email-address>
+      <first-name>John2</first-name>
+      <last-name>Doe</last-name>
+    </user>
+            XML
+            stub_http_request(:get, "http://#{@username}:#{@password}@#{@host}/users/2.xml").to_return(:body => xml)
+          end
+
+          it "returns the user" do
+            user = StreamSend::Api::User.show(2)
+            user.id.should == "2"
+            user.first_name.should == "John2"
+          end
+        end
+
+        describe "with an invalid user" do
+          before do
+            stub_http_request(:post, "http://#{@username}:#{@password}@#{@host}/users/2.xml").to_return(:body => "Page not found.")
+          end
+
+          it "should raise an error" do
+            lambda do
+              user = StreamSend::Api::User.show(30)
+            end.should raise_error
+          end
+        end
+      end
+
+      describe ".create" do
+        describe "with valid user parameters" do
+          describe "with an existing users" do
+            before(:each) do
+              stub_http_request(:post, /accounts\/1\/users.xml/).with(:person => {"email_address" => "foo@bar.com", "first_name" => "JoeBob"}).to_return(:body => "", :headers => {"location" => "http://test.host/accounts/2/users/1"}, :status => 201)
+            end
+
+            it "should return the new user's id" do
+              user_id = StreamSend::Api::User.create({"account_id" => 1, "email_address" => "foo@bar.com", "first_name" => "JoeBob"})
+
+              user_id.should_not be_nil
+              user_id.should == 1
+            end
+          end
+        end
+
+        describe "with invalid user parameters" do
+          before(:each) do
+            stub_http_request(:post, "/account/1/users.xml").with(:person => {"email_address" => "foo@bar.com", "first_name" => "JoeBob"}).to_return(:status => 422)
+          end
+
+          it "should raise an error" do
+            lambda do
+              user_id = StreamSend::Api::User.create({"account_id" => 1, "email_address" => "foo@bar.com", "first_name" => "JoeBob"})
+            end.should raise_error
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/streamsend/api_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe StreamSend::Api do
+  describe ".configure" do
+    let( :test_host ) { "http://host.example.com" }
+    let( :test_user ) { "John+Carter@example.com" }
+    let( :test_password ) { "this-is-a-really-secure-password" }
+
+    it "should set username" do
+      StreamSend::Api.configure( test_user, test_password )
+      StreamSend::Api.default_options[:basic_auth][:username].should == test_user
+    end
+
+    it "should set password" do
+      StreamSend::Api.configure( test_user, test_password )
+      StreamSend::Api.default_options[:basic_auth][:password].should == test_password
+    end
+
+    context "host" do
+      it "sets the host when specified" do
+        StreamSend::Api.configure( test_user, test_password, test_host )
+        StreamSend::Api.base_uri.should == test_host
+      end
+
+      it "uses the default host when not specified" do
+        StreamSend::Api.configure( test_user, test_password )
+        StreamSend::Api.base_uri.should == "http://app.streamsend.com"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,17 @@
 require 'uri'
 require 'rspec/expectations'
-require 'webmock/rspec'
+require "vcr"
+require "webmock/rspec"
 
 require File.join(File.dirname(__FILE__), "../lib/streamsend")
+
+VCR.configure do |c|
+  c.default_cassette_options = { :record => :new_episodes }
+  c.cassette_library_dir = 'spec/integration/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+  c.debug_logger = File.open("logfile.log", "w")
+  c.filter_sensitive_data("<STREAMSEND_PASSWORD>") do
+    ENV['STREAMSEND_PASSWORD']
+  end
+end
+