streamsend-ruby 0.0.1 → 0.0.2.pre1

data/README.md

@@ -0,0 +1,40 @@
+The Streamsend Ruby Gem
+====================
+A Ruby wrapper for the [Streamsend API](http://app.streamsend.com/docs/api/index.html).
+
+Installation
+------------
+    gem install streamsend-ruby
+
+Documentation
+-------------
+[http://github.com/gaslightsoftware/streamsend-ruby](http://github.com/gaslightsoftware/streamsend-ruby)
+
+What's new in 0.0.2?
+------------------
+
+Added create method to Subscriber, added StreamSend::Audience, moved find method into Resource, and added a default rake task.
+
+**0.0.1**
+
+Everything! This is the initial gemified version forked from the original author [salbertson](http://github.com/salbertson/streamsend-ruby).
+
+Usage Examples
+--------------
+    require "rubygems"
+    require "streamsend"
+
+    login_id = '1234567890AB'
+    key      = 'AbCdEfGhIjKlMnOp'
+    audience = 2
+
+    # Configure the connection
+    StreamSend.configure(login_id, key)
+
+    # Get all subscribers for a specific audience
+    subscribers = StreamSend::Subscriber.all(audience)
+    puts subscribers.count # 100 <- current page limit
+
+    # Find a subscriber
+    subscriber = StreamSend::Subscriber.find(audience, 'bob@example.com')
+    puts subscriber.opt_status # "unsubscribed"

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler'
+require 'rake'
+require 'spec'
+
+Bundler::GemHelper.install_tasks
+
+namespace :spec do
+  spec_files = Dir[File.dirname(__FILE__) + '/spec/**/*_spec.rb'].join(' ')
+  sh exec "spec #{spec_files}"
+end
+
+task :test => :spec
+task :default => :spec

data/lib/spec/version.rb

@@ -3,8 +3,8 @@ module Spec # :nodoc:
     unless defined? MAJOR
       MAJOR = 0
       MINOR = 0
-      TINY  = 1
-      PRE   = nil # or pre1, pre2, etc.
+      TINY  = 2
+      PRE   = "pre1" # VALID VALUES: nil, "pre1", "pre2", ...
 
       STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
 

data/lib/streamsend.rb

@@ -11,62 +11,139 @@ module StreamSend
   end
 
   class Resource
-    def initialize(data)
+    def initialize(data, from_api=nil)
       @data = data
+      @new_record = !from_api
+    end
+
+    def new_record?
+      @new_record
+    end
+
+    def saved!
+      @new_record = false
     end
 
     def method_missing(method, *args, &block)
-      if @data.include?(method.to_s)
+      if method.to_s.match(/^(.*)=$/)
+        @data[$1] = *args
+      elsif @data.has_key?(method.to_s)
         @data[method.to_s]
       else
         super
       end
     end
 
+    def attributes
+      @data
+    end
+
     def id
       @data["id"]
     end
+
+    def self.find(options={})
+      response = StreamSend.get(resource_path(options))
+      case response.code
+      when 200
+        if resource = response[resource_name]
+          self.new(resource, true)
+        elsif resources = response['people']
+          results = []
+          resources.each { |r| results << self.new(r, true)  }
+          results.count == 1 ? results.first : results
+        else
+          nil
+        end
+      else
+        raise "Could not find the #{resource_name}. Make sure the ID is correct. (#{response.code})"
+      end
+    end
+
+    def save
+      if self.new_record?
+        attributes = StreamSend.post(self.class.resource_path("audience_id" => self.audience_id),
+                                                   self.attributes)
+        self.id = attributes["id"]
+        self.created_at = Time.now
+        self.saved!
+      else
+        attributes = StreamSend.put(self.class.resource_path({ "id" => self.id,
+                                                    "audience_id" => self.audience_id,
+                                                  }.merge( self.attributes)))
+        self.updated_at = TIme.now
+        self.saved!
+      end
+    end
+
+    def self.resource_name
+      # we will need to deal with CamelCased names eventually
+      self.name.downcase.split('::').last
+    end
+
+    def self.resource_path(options={})
+      ""
+    end
+  end
+
+  class Audience < Resource
+    def self.resource_path(options={})
+      "/audiences/#{options["id"]}.xml"
+    end
   end
 
   class Subscriber < Resource
+
+    def email_address
+      @data['email_address']
+    end
+
+    def email_address=(val)
+      @data['email_address'] = val
+    end
+
+    def to_s
+      "#{self.email_address}#{%{ (#{self.email_content_format})} unless self.email_content_format.blank?}"
+    end
+
     def self.all(audience_id)
       response = StreamSend.get("/audiences/#{audience_id}/people.xml")
 
       case response.code
       when 200
-        response["people"].collect { |data| new(data) }
+        response["people"].collect { |data| new(data, true) }
       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
+    def self.create(audience_id, subscriber_hash)
+      if attributes = StreamSend.post(resource_path("audience_id" => audience_id), subscriber_hash)
+        new(attributes, true)
       else
-        raise "Could not find the subscriber. Make sure your audience ID is correct. (#{response.code})"
+        raise("Could not create the subscriber.")
       end
     end
 
-    def show(audience_id)
-      response = StreamSend.get("/audiences/#{audience_id}/people/#{id}.xml")
+    def self.find_by_email_address(email_address, options={})
+      audience_id = options["audience_id"] || 1
+      result = find("audience_id" => audience_id, "email_address" => email_address )
+      result == [] ? nil : result
+    end
 
-      case response.code
-      when 200
-        if subscriber = response["person"]
-          self.class.new(subscriber)
-        else
-          nil
-        end
+    def self.resource_name
+      "person"
+    end
+
+    def self.resource_path(options={})
+      opts = options.dup
+      audience_id = opts.delete("audience_id") || 1
+      id = opts.delete('id')
+      if id.nil?
+        params = opts.collect {|k,v| "#{k}=#{v}" }
+        "/audiences/#{audience_id}/people.xml?#{params.join('&')}"
       else
-        raise "Could not show the subscriber. (#{response.code})"
+        "/audiences/#{audience_id}/people/#{id}.xml"
       end
     end
   end

data/spec/streamsend_spec.rb

@@ -3,6 +3,16 @@ require 'webmock/rspec'
 require 'streamsend'
 
 describe "StreamSend" 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 "Resource" do
     describe "with missing method" do
       before(:each) do
@@ -19,23 +29,59 @@ describe "StreamSend" do
         StreamSend::Resource.new({"id" => 99}).id.should == 99
       end
     end
+
+    describe "#attributes" do
+      before do
+        @attributes = { "id" => 99, "email_address" => "foo@example.org" }
+      end
+      it "should return a hash of attributes" do
+        StreamSend::Resource.new(@attributes).attributes.should == @attributes
+      end
+    end
   end
 
-  describe "Subscriber" do
-    before(:each) do
-      stub_http_request(:any, //).to_return(:body => "Page not found.", :status => 404)
+  describe "Audience" do
+    before do
+      @audience = StreamSend::Audience.new({"id"=> 1, "name" => "subscriber_list" })
+    end
 
-      @username = "scott"
-      @password = "topsecret"
-      @host = "test.host"
+    describe "#find" do
+      before(:each) do
+        xml = <<-"XML".gsub(/^\s+/,'')
+          <?xml version="1.0" encoding="UTF-8"?>
+            <audience>
+              <active-people-count type="integer">121677</active-people-count>
+              <created-at type="datetime">2009-07-23T18:07:46Z</created-at>
+              <description nil="true"></description>
+              <id type="integer">1</id>
+              <inactive-people-count type="integer">23768</inactive-people-count>
+              <name>subscriber_list</name>
+              <pending-people-count type="integer">8</pending-people-count>
+              <status type="enum">active</status>
+              <tracking-hash encoding="base64" type="binary">ek1Q
+            </tracking-hash>
+              <unsubscribed-people-count type="integer">4328</unsubscribed-people-count>
+              <updated-at type="datetime">2009-07-23T18:08:16Z</updated-at>
+            </audience>
+        XML
+
+        stub_http_request(:any, //).to_return(:body => xml, :status => 200)
+      end
 
-      StreamSend.configure(@username, @password, @host)
+      it "should return an audience object" do
+        audience = StreamSend::Audience.find("id" => 1)
+        audience.should be_instance_of(StreamSend::Audience)
+        audience.id.should == @audience.id
+        audience.created_at.should == Time.parse("2009-07-23T18:07:46Z")
+      end
     end
+  end
 
+  describe "Subscriber" do
     describe ".all" do
       describe "with subscribers" do
         before(:each) do
-          xml = <<-XML
+          xml = <<-"XML".gsub(/^\s+/,'')
             <?xml version="1.0" encoding="UTF-8"?>
             <people type="array">
               <person>
@@ -62,7 +108,7 @@ describe "StreamSend" do
 
       describe "with no subscribers" do
         before(:each) do
-          xml = <<-XML
+          xml = <<-"XML".gsub(/^\s+/,'')
             <?xml version="1.0" encoding="UTF-8"?>
             <people type="array"/>
           XML
@@ -82,10 +128,10 @@ describe "StreamSend" do
       end
     end
 
-    describe ".find" do
+    describe ".find_by_email_address" do
       describe "with matching subscriber" do
         before(:each) do
-          xml = <<-XML
+          xml = <<-"XML".gsub(/^\s+/,'')
             <?xml version="1.0" encoding="UTF-8"?>
             <people type="array">
               <person>
@@ -100,8 +146,7 @@ describe "StreamSend" do
         end
 
         it "should return subscriber" do
-          subscriber = StreamSend::Subscriber.find(1, "scott@gmail.com")
-
+          subscriber = StreamSend::Subscriber.find_by_email_address("scott@gmail.com")
           subscriber.should be_instance_of(StreamSend::Subscriber)
           subscriber.id.should == 2
           subscriber.email_address.should == "scott@gmail.com"
@@ -111,7 +156,7 @@ describe "StreamSend" do
 
       describe "with no matching subscriber" do
         before(:each) do
-          xml = <<-XML
+          xml = <<-"XML".gsub(/^\s+/,'')
             <?xml version="1.0" encoding="UTF-8"?>
             <people type="array"\>
           XML
@@ -120,21 +165,22 @@ describe "StreamSend" do
         end
 
         it "should return nil" do
-          StreamSend::Subscriber.find(1, "bad.email@gmail.com").should == nil
+          StreamSend::Subscriber.find_by_email_address("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
+          lambda { StreamSend::Subscriber.find_by_email_address("scott@gmail.com", :audience_id => 99) }.should raise_error
         end
       end
     end
 
+=begin
     describe "#show" do
       describe "with valid subscriber instance" do
         before(:each) do
-          xml = <<-XML
+          xml = <<-"XML".gsub(/^\s+/,'')
             <?xml version="1.0" encoding="UTF-8"?>
             <person>
               <id type="integer">2</id>
@@ -172,5 +218,32 @@ describe "StreamSend" do
         end
       end
     end
+=end
+
+    describe "#create" do
+      before(:each) do
+        @subscriber = StreamSend::Subscriber.new(:email_address =>"scott@example.com")
+        stub_http_request(:post, "http://#{@username}:#{@password}@#{@host}/audiences/1/people.xml").with(:body => @subscriber).to_return({ :response => true })
+
+        @bad_subscriber = StreamSend::Subscriber.new(:email_address =>"scott@example")
+        stub_http_request(:post, "http://#{@username}:#{@password}@#{@host}/audiences/1/people.xml").with(:body => @bad_subscriber).to_return({ :response => Exception })
+      end
+
+      describe "with valid subscriber instance" do
+        it "should return instance of subscriber" do
+          s = StreamSend::Subscriber.new(@subscriber.attributes.merge("audience_id" => 1))
+          s.should be_instance_of(StreamSend::Subscriber)
+          s.should be_new_record
+          s.save
+          s.should_not be_new_record
+        end
+      end
+
+      describe "with an invalid email address" do
+        it "should raise exception" do
+          StreamSend::Subscriber.create(1, @bad_subscriber.attributes).should raise_error
+        end
+      end
+    end
   end
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: streamsend-ruby
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: 
+  hash: 270495464
+  prerelease: true
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  - pre1
+  version: 0.0.2.pre1
 platform: ruby
 authors: 
 - Gaslight Software
@@ -16,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-28 00:00:00 -04:00
+date: 2011-08-04 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,6 +75,8 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- README.md
+- Rakefile
 - lib/spec/version.rb
 - lib/streamsend.rb
 - spec/streamsend_spec.rb
@@ -99,18 +102,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: streamsend-ruby
-rubygems_version: 1.4.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: streamsend-ruby 0.0.1
+summary: streamsend-ruby 0.0.2.pre1
 test_files: 
 - spec/streamsend_spec.rb