streamsend 0.2.3 → 1.0.0.rc1

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

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+module StreamSend
+  module Api
+    module List
+      describe "List calls" do
+        let(:session){ StreamSend::Api::Session.new("test", "password", "https://default.base") }
+        let(:indexer){ Index.new(session) }
+        let(:audience_id){ 1 }
+        let(:person_id){ 543 }
+        let(:xml){ "<?xml version=\"1.0\" encoding=\"UTF-8\"?><lists type=\"array\"><list><test type=\"integer\">1</test></list></lists>" }
+
+        before do
+          session.stub(:audience_id).and_return(audience_id)
+        end
+
+        describe Index do
+          it "creates a uri for lists" do
+            stub_request(:get, "https://test:password@default.base/audiences/1/lists.xml").to_return(:status => 200, :body => xml, :headers => {})
+            indexer.execute
+            expect(indexer.uri).to eq("https://default.base/audiences/#{audience_id}/lists.xml")
+          end
+
+          it "creates a uri for a persons lists" do
+            stub_request(:get, "https://test:password@default.base/audiences/1/people/543/lists.xml").to_return(:status => 200, :body => xml, :headers => {})
+            indexer.execute(person_id)
+            expect(indexer.uri).to eq("https://default.base/audiences/#{audience_id}/people/#{person_id}/lists.xml")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+module StreamSend
+  module Api
+    module Membership
+      describe "Membership calls" do
+        let(:session){ StreamSend::Api::Session.new("test", "password", "https://default.base") }
+        let(:person_id){ 123 }
+        let(:list_id){ 456 }
+        let(:audience_id){ 1 }
+        let(:options){ { :page => 12, :per_page => 200 } }
+        let(:xml){ "<?xml version=\"1.0\" encoding=\"UTF-8\"?><memberships type=\"array\"><membership><test type=\"integer\">1</test></membership></memberships>" }
+
+        before do
+          session.stub(:audience_id).and_return(audience_id)
+        end
+
+        describe Index do
+          it "returns a uri for an index of memberships" do
+            stub_request(:get, "https://test:password@default.base/audiences/1/people/123/memberships.xml?page=1&per_page=100").
+              to_return(:status => 200, :body => xml, :headers => {})
+            indexer = Index.new(session)
+            indexer.execute(person_id)
+            expect(indexer.uri).to eq("https://default.base/audiences/#{audience_id}/people/#{person_id}/memberships.xml?page=1&per_page=100")
+          end
+
+          it "returns a uri for an index of memberships with custom paging" do
+            stub_request(:get, "https://test:password@default.base/audiences/1/people/123/memberships.xml?page=12&per_page=200").
+              to_return(:status => 200, :body => xml, :headers => {})
+            indexer = Index.new(session)
+            indexer.execute(person_id, nil, options)
+            expect(indexer.uri).to eq("https://default.base/audiences/#{audience_id}/people/#{person_id}/memberships.xml?page=12&per_page=200")
+          end
+
+          it "returns a uri for an index of memberships by list id" do
+            stub_request(:get, "https://test:password@default.base/audiences/1/people/123/lists/456/memberships.xml?page=1&per_page=100").
+              to_return(:status => 200, :body => xml, :headers => {})
+            indexer = Index.new(session)
+            indexer.execute(person_id, list_id)
+            expect(indexer.uri).to eq("https://default.base/audiences/#{audience_id}/people/#{person_id}/lists/#{list_id}/memberships.xml?page=1&per_page=100")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+require "spec_helper"
+
+module StreamSend
+  module Api
+    module Person
+      describe "Person calls" do
+        let(:session){ StreamSend::Api::Session.new("test", "password", "https://default.base") }
+        let(:indexer){ Index.new(session) }
+        let(:activator){ Activate.new(session) }
+        let(:unsuber){ Unsubscribe.new(session) }
+        let(:options){ { :page => 12, :per_page => 222 } }
+        let(:xml){ "<?xml version=\"1.0\" encoding=\"UTF-8\"?><people type=\"array\"><person><test type=\"integer\">1</test></person></people>" }
+        let(:audience_id){ 1 }
+        let(:person_id){ 421 }
+        let(:blast_id){ 1 }
+        let(:link_id){ 1 }
+
+        before do
+          session.stub(:audience_id).and_return(audience_id)
+        end
+        describe Index do
+          it "returns a uri for a person index" do
+            stub_request(:get, "https://test:password@default.base/audiences/1/people.xml?page=1&per_page=100").
+              to_return(:status => 200, :body => xml, :headers => {})
+            indexer.execute
+            expect(indexer.uri).to eq("https://default.base/audiences/1/people.xml?page=1&per_page=100")
+          end
+
+          it "returns a uri for a person index by email address" do
+            stub_request(:get, "https://test:password@default.base/audiences/1/people.xml?email_address=myemail@address.none&page=1&per_page=100").
+              to_return(:status => 200, :body => xml, :headers => {})
+            indexer.execute("myemail@address.none", nil, {})
+            expect(indexer.uri).to eq("https://default.base/audiences/1/people.xml?page=1&per_page=100&email_address=myemail@address.none")
+          end
+
+          it "returns a uri for a person index by tracking hash" do
+            stub_request(:get, "https://test:password@default.base/audiences/1/people.xml?page=1&per_page=100&tracking_hash=xyz").
+              to_return(:status => 200, :body => xml, :headers => {})
+            indexer.execute(nil, "xyz", {})
+            expect(indexer.uri).to eq("https://default.base/audiences/1/people.xml?page=1&per_page=100&tracking_hash=xyz")
+          end
+
+          it "returns a uri with custom paging" do
+            stub_request(:get, "https://test:password@default.base/audiences/1/people.xml?page=12&per_page=222").
+              to_return(:status => 200, :body => xml, :headers => {})
+            indexer.execute(nil, nil, options)
+            expect(indexer.uri).to eq("https://default.base/audiences/1/people.xml?page=12&per_page=222")
+          end
+        end
+
+        describe Click do
+          let(:clicker){ StreamSend::Api::Person::Click.new(session) }
+          it "creates a uri for blast click people" do
+            stub_request(:get, "https://test:password@default.base/blasts/1/clicks/people.xml?page=1&per_page=100").
+              to_return(:status => 200, :body => xml, :headers => {})
+            clicker.execute(blast_id)
+            expect(clicker.uri).to eq("https://default.base/blasts/#{blast_id}/clicks/people.xml?page=1&per_page=100")
+          end
+
+          it "creates  uri for specific link click people" do
+            stub_request(:get, "https://test:password@default.base/blasts/1/links/1/clicks/people.xml?page=1&per_page=100").
+              to_return(:status => 200, :body => xml, :headers => {"Content-type" => "text/xml"})
+            clicker.execute(blast_id, link_id)
+            expect(clicker.uri).to eq("https://default.base/blasts/#{blast_id}/links/#{link_id}/clicks/people.xml?page=1&per_page=100")
+          end
+        end
+
+        describe View do
+        let(:session){ StreamSend::Api::Session.new("test", "password", "https://default.base") }
+        let(:peopler){ StreamSend::Api::Person::View.new(session) }
+        let(:options){ {:page => 234, :per_page => 444 } }
+        let(:blast_id){ 1 }
+
+          it "creates a uri for blast view people" do
+            stub_request(:get, "https://test:password@default.base/blasts/1/views/people.xml?page=1&per_page=100").
+              to_return(:status => 200, :body => xml, :headers => {})
+            peopler.execute(blast_id)
+            expect(peopler.uri).to eq("https://default.base/blasts/#{blast_id}/views/people.xml?page=1&per_page=100")
+          end
+        end
+
+        describe Activate do
+          it "returns a uri for activating the person by id" do
+            stub_request(:post, "https://test:password@default.base/audiences/1/people/421/activate.xml").
+              to_return(:status => 200, :body => "", :headers => {})
+            activator.execute(person_id)
+            expect(activator.uri(person_id)).to eq("https://default.base/audiences/1/people/#{person_id}/activate.xml")
+          end
+        end
+
+        describe Unsubscribe do
+          it "returns a uri for unsubscribing a person by id" do
+            stub_request(:post, "https://test:password@default.base/audiences/1/people/421/unsubscribe.xml").
+              to_return(:status => 200, :body => "", :headers => {})
+            unsuber.execute(person_id)
+            expect(unsuber.uri(person_id)).to eq("https://default.base/audiences/1/people/#{person_id}/unsubscribe.xml")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+module StreamSend
+  module Api
+    describe Result do
+      it "returns the hash value for id when called not the Ruby id" do
+        hash = { :id => 101, :name => "test" }
+        result = Result.new(hash)
+        expect(result.id).to eq(101)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+require "spec_helper"
+
+module StreamSend
+  module Api
+    describe Session do
+      let(:session){ Session.new("test", "password", "http://default.base") }
+
+      it "uses the default base_uri if none is provided" do
+        no_base_session = Session.new("test", "password")
+        expect(no_base_session.base_uri).to eq("http://app.streamsend.com")
+      end
+
+      it "uses the specified base_uri if one is specified" do
+        non_default_session = Session.new("test", "pass", "http://something.else.here")
+        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"?>
+  <audiences type="array">
+    <audience>
+      <id type="integer">1</id>
+    </audience>
+</audiences>
+          XML
+        stub_request(:get, "http://test:password@default.base/audiences.xml").to_return(:status => 200, :body => xml, :headers => {'Content-Type' => 'text/xml'})
+        expect(session.audience_id).to eq(1)
+      end
+
+      describe "get" do
+        it "uses the PUT verb" do
+          stub = stub_http_request(:get, "http://test:password@default.base")
+          session.get(session.base_uri)
+          stub.should have_been_requested
+        end
+      end
+
+      describe "post" do
+        it "uses the PUT verb" do
+          stub = stub_http_request(:post, "http://test:password@default.base")
+          session.post(session.base_uri)
+          stub.should have_been_requested
+        end
+      end
+
+      describe "put" do
+        it "uses the PUT verb" do
+          stub = stub_http_request(:put, "http://test:password@default.base")
+          session.put(session.base_uri)
+          stub.should have_been_requested
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+module StreamSend
+  module Api
+    module Unsubscribe
+      describe "Unsubscribe calls" do
+        let(:session){ StreamSend::Api::Session.new("test", "password", "https://default.base") }
+        let(:manual){ Manual.new(session) }
+        let(:complainer){ Complaint.new(session) }
+        let(:xml){ "<?xml version=\"1.0\" encoding=\"UTF-8\"?><unsubscribes type=\"array\"><unsubscribe><test type=\"integer\">1</test></unsubscribe></unsubscribes>" }
+        let(:blast_id){ 231 }
+
+        describe Manual do
+          it "creates a uri for manual blast unsubscribes" do
+            stub_request(:get, "https://test:password@default.base/blasts/231/unsubscribes/manual.xml?page=1&per_page=100").
+              to_return(:status => 200, :body => xml, :headers => {})
+            manual.execute(blast_id)
+            expect(manual.uri).to eq("https://default.base/blasts/#{blast_id}/unsubscribes/manual.xml?page=1&per_page=100")
+          end
+        end
+
+        describe Complaint do
+          it "creates a uri for complaint blast unsubscribes" do
+            stub_request(:get, "https://test:password@default.base/blasts/231/unsubscribes/complaint.xml?page=1&per_page=100").
+              to_return(:status => 200, :body => xml, :headers => {})
+            complainer.execute(blast_id)
+            expect(complainer.uri).to eq("https://default.base/blasts/#{blast_id}/unsubscribes/complaint.xml?page=1&per_page=100")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+require "spec_helper"
+
+module StreamSend
+  module Api
+    module User
+      describe "User calls" do
+        let(:session){ StreamSend::Api::Session.new("test", "password", "https://default.base") }
+        let(:indexer){ Index.new(session) }
+        let(:shower){ Show.new(session) }
+        let(:deleter){ Destroy.new(session) }
+        let(:loginer){ Login.new(session) }
+        let(:creator){ Create.new(session) }
+        let(:updater){ Update.new(session) }
+        let(:randomish){ DateTime.now.to_i.to_s }
+        let(:user_hash){ { :user => { :email_address => "you+#{randomish}@are.here", :password => "lulz1234", :administrator => false } } }
+        let(:account_id){ 543 }
+        let(:user_id){ 12 }
+        let(:xml){ "<?xml version=\"1.0\" encoding=\"UTF-8\"?><users type=\"array\"><user><test type=\"integer\">1</test></user></users>" }
+
+        describe Index do
+          it "returns a user index uri with account id" do
+            stub_request(:get, "https://test:password@default.base/accounts/543/users.xml").
+              to_return(:status => 200, :body => xml, :headers => {})
+            indexer.execute(account_id)
+            expect(indexer.uri).to eq("https://default.base/accounts/543/users.xml")
+          end
+
+          it "returns a index uri wihtout account id" do
+            stub_request(:get, "https://test:password@default.base/users.xml").
+              to_return(:status => 200, :body => xml, :headers => {})
+            indexer.execute()
+            expect(indexer.uri).to eq("https://default.base/users.xml")
+          end
+        end
+
+        describe Show do
+          it "returns a user show uri with account id" do
+            stub_request(:get, "https://test:password@default.base/accounts/543/users/12.xml").
+              to_return(:status => 200, :body => xml, :headers => {})
+            shower.execute(user_id, account_id)
+            expect(shower.uri).to eq("https://default.base/accounts/543/users/12.xml")
+          end
+
+          it "returns a show uri wihtout account id" do
+            stub_request(:get, "https://test:password@default.base/users/12.xml").
+              to_return(:status => 200, :body => xml, :headers => {})
+            shower.execute(user_id)
+            expect(shower.uri).to eq("https://default.base/users/12.xml")
+          end
+        end
+
+        describe Create do
+          it "returns a user create uri with account id" do
+            stub_request(:post, "https://test:password@default.base/users.xml").
+              to_return(:status => 201, :body => "", :headers => {'Location' => 'something/something/101'})
+            creator.execute(user_hash)
+            expect(creator.uri).to eq("https://default.base/users.xml")
+          end
+
+          it "returns a user create uri without account id" do
+            stub_request(:post, "https://test:password@default.base/accounts/543/users.xml").
+              to_return(:status => 201, :body => "", :headers => {'Location' => 'something/something/101'})
+            creator.execute(user_hash, account_id)
+            expect(creator.uri).to eq("https://default.base/accounts/#{account_id}/users.xml")
+          end
+        end
+
+        describe Update do
+          it "returns a user update uri with account id" do
+            stub_request(:put, "https://test:password@default.base/users/12.xml").
+              to_return(:status => 200, :body => "")
+            updater.execute(user_id, user_hash)
+            expect(updater.uri).to eq("https://default.base/users/#{user_id}.xml")
+          end
+
+          it "returns a user update uri without account id" do
+            stub_request(:put, "https://test:password@default.base/accounts/#{account_id}/users/12.xml").
+            to_return(:status => 200, :body => "")
+            updater.execute(user_id, user_hash, account_id)
+            expect(updater.uri).to eq("https://default.base/accounts/#{account_id}/users/#{user_id}.xml")
+          end
+        end
+
+        describe Destroy do
+          it "returns a user destroy uri with account id" do
+            stub_request(:delete, "https://test:password@default.base/accounts/543/users/12.xml").
+              to_return(:status => 200, :body => xml, :headers => {})
+            deleter.execute(user_id, account_id)
+            expect(deleter.uri).to eq("https://default.base/accounts/543/users/12.xml")
+          end
+
+          it "returns a destroy uri wihtout account id" do
+            stub_request(:delete, "https://test:password@default.base/users/12.xml").
+              to_return(:status => 200, :body => xml, :headers => {})
+            deleter.execute(user_id)
+            expect(deleter.uri).to eq("https://default.base/users/12.xml")
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,17 +1,14 @@
 require 'uri'
+require 'ruby-debug'
 require 'rspec/expectations'
-require "vcr"
-require "webmock/rspec"
+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
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
 
+  config.order = 'ordered'
+end

data/streamsend.gemspec

@@ -1,28 +1,27 @@
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "streamsend/version"
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["Scott Albertson", "Jeff Roush", "Mark Eschbach", "Bob Yeo"]
-  gem.email         = %q{jroush@ezpublishing.com}
-  gem.summary       = %q{Ruby wrapper for the StreamSend API.}
-  gem.description   = %q{Ruby wrapper for the StreamSend API.}
-  gem.homepage      = %q{https://github.com/Jeff-R/streamsend-ruby}
-  gem.date          = %q{2013-07-09}
+Gem::Specification.new do |s|
+  s.name        = "streamsend"
+  s.version     = StreamSend::VERSION
+  s.authors     = ["Bob Yeo"]
+  s.email       = ["ryeo@ezpublishing.com"]
+  s.homepage    = ""
+  s.summary     = %q{Ruby wrapper for the StreamSend API.}
+  s.description = %q{Ruby wrapper for the StreamSend API.}
 
-  gem.add_dependency "httparty"
-  gem.add_dependency "activesupport", "~>3.2"
-  gem.add_dependency "builder"
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "git-commit-story"
-  gem.add_development_dependency "webmock", "~> 1.6"
-  gem.add_development_dependency "vcr"
-  gem.add_development_dependency "watchr"
-  gem.add_development_dependency "ruby-fsevent"
-  gem.add_development_dependency "pair-salad"
+  s.add_dependency "httmultiparty"
+  s.add_dependency "activesupport", "~>3.2"
+  s.add_dependency "builder"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "git-commit-story"
+  s.add_development_dependency "webmock", "~> 1.6"
+  s.add_development_dependency "pair-salad"
+  s.add_development_dependency "ruby-debug"
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "streamsend"
-  gem.require_paths = ["lib"]
-  gem.version       = "0.2.3"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
 end