streamsend 0.1.0

data/Manifest

@@ -0,0 +1,5 @@
+README.rdoc
+Rakefile
+lib/streamsend.rb
+spec/streamsend_spec.rb
+Manifest

data/README.rdoc

@@ -0,0 +1 @@
+Ruby wrapper for the StreamSend API.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('streamsend', '0.1.0') do |p|
+  p.description    = "Ruby wrapper for the StreamSend API."
+  p.url            = "http://github.com/salbertson/streamsend-ruby"
+  p.author         = "Scott Albertson"
+  p.email          = "salbertson@streamsend.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/streamsend.rb

@@ -0,0 +1,95 @@
+require 'rubygems'
+require 'httparty'
+
+module StreamSend
+  include HTTParty
+  format :xml
+
+  def self.configure(username, password, host = "app.streamsend.com")
+    base_uri host
+    basic_auth username, password
+  end
+
+  class Resource
+    def initialize(data)
+      @data = data
+    end
+
+    def method_missing(method, *args, &block)
+      if @data.include?(method.to_s)
+        @data[method.to_s]
+      else
+        super
+      end
+    end
+
+    def id
+      @data["id"]
+    end
+  end
+
+  class Subscriber < Resource
+    def self.all(audience_id)
+      response = StreamSend.get("/audiences/#{audience_id}/people.xml")
+
+      case response.code
+      when 200
+        response["people"].collect { |data| new(data) }
+      else
+        raise "Could not find any subscribers. Make sure your audience ID is correct. (#{response.code})"
+      end
+    end
+
+    def self.find(audience_id, email_address)
+      response = StreamSend.get("/audiences/#{audience_id}/people.xml?email_address=#{email_address}")
+
+      case response.code
+      when 200
+        if subscriber = response["people"].first
+          new(subscriber)
+        else
+          nil
+        end
+      else
+        raise "Could not find the subscriber. Make sure your audience ID is correct. (#{response.code})"
+      end
+    end
+
+    def show
+      response = StreamSend.get("/audiences/#{audience_id}/people/#{id}.xml")
+
+      case response.code
+      when 200
+        if subscriber = response["person"]
+          self.class.new(subscriber)
+        else
+          nil
+        end
+      else
+        raise "Could not show the subscriber. (#{response.code})"
+      end
+    end
+
+    def activate
+      response = StreamSend.post("/audiences/#{audience_id}/people/#{id}/activate.xml")
+
+      case response.code
+      when 200
+        true
+      else
+        raise "Could not activate the subscriber. (#{response.code})"
+      end
+    end
+
+    def unsubscribe
+      response = StreamSend.post("/audiences/#{audience_id}/people/#{id}/unsubscribe.xml")
+
+      case response.code
+      when 200
+        true
+      else
+        raise "Could not subscribe the subscriber. (#{response.code})"
+      end
+    end
+  end
+end

data/spec/streamsend_spec.rb

@@ -0,0 +1,214 @@
+require 'uri'
+require 'webmock/rspec'
+require 'streamsend'
+
+describe "StreamSend" do
+  describe "Resource" do
+    describe "with missing method" do
+      before(:each) do
+        @resource = StreamSend::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::Resource.new({"id" => 99}).id.should == 99
+      end
+    end
+  end
+
+  describe "Subscriber" do
+    before(:each) do
+      stub_http_request(:any, //).to_return(:body => "Page not found.", :status => 404)
+
+      @username = "scott"
+      @password = "topsecret"
+      @host = "test.host"
+
+      StreamSend.configure(@username, @password, @host)
+    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/1/people.xml").to_return(:body => xml)
+        end
+
+        it "should return array of one subscriber object" do
+          subscribers = StreamSend::Subscriber.all(1)
+          subscribers.size.should == 1
+
+          subscribers.first.should be_instance_of(StreamSend::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/1/people.xml").to_return(:body => xml)
+        end
+
+        it "should return an empty array" do
+          StreamSend::Subscriber.all(1).should == []
+        end
+      end
+
+      describe "with invalid audience" do
+        it "should raise an exception" do
+          lambda { StreamSend::Subscriber.all(99) }.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/1/people.xml?email_address=scott@gmail.com").to_return(:body => xml)
+        end
+
+        it "should return subscriber" do
+          subscriber = StreamSend::Subscriber.find(1, "scott@gmail.com")
+
+          subscriber.should be_instance_of(StreamSend::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 no matching subscriber" 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/1/people.xml?email_address=bad.email@gmail.com").to_return(:body => xml)
+        end
+
+        it "should return nil" do
+          StreamSend::Subscriber.find(1, "bad.email@gmail.com").should == nil
+        end
+      end
+
+      describe "with invalid audience" do
+        it "should raise an exception" do
+          lambda { StreamSend::Subscriber.find(99, "scott@gmail.com") }.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::Subscriber.new({"id" => 2, "audience_id" => 1}).show
+
+          subscriber.should be_instance_of(StreamSend::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::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::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::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::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::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::Subscriber.new({"id" => 99, "audience_id" => 1}).unsubscribe }.should raise_error
+        end
+      end
+    end
+  end
+end

data/streamsend.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{streamsend}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Albertson"]
+  s.date = %q{2012-02-10}
+  s.description = %q{Ruby wrapper for the StreamSend API.}
+  s.email = %q{salbertson@streamsend.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/streamsend.rb"]
+  s.files = ["README.rdoc", "Rakefile", "lib/streamsend.rb", "spec/streamsend_spec.rb", "Manifest", "streamsend.gemspec"]
+  s.homepage = %q{http://github.com/salbertson/streamsend-ruby}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Streamsend", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{streamsend}
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Ruby wrapper for the StreamSend API.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: streamsend
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Scott Albertson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-10 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Ruby wrapper for the StreamSend API.
+email: salbertson@streamsend.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/streamsend.rb
+files: 
+- README.rdoc
+- Rakefile
+- lib/streamsend.rb
+- spec/streamsend_spec.rb
+- Manifest
+- streamsend.gemspec
+has_rdoc: true
+homepage: http://github.com/salbertson/streamsend-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Streamsend
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: streamsend
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the StreamSend API.
+test_files: []
+