streamsend 0.1.2 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8f5e42bd6932da70daf32dd3550c7e7823c559b
+  data.tar.gz: 755c92dc260b78049bdc446a2043d84f0a97ff65
+SHA512:
+  metadata.gz: e409054d8e1ebad47497c99bad42ba8b3618149defd0b95878531c8414f42aabc0bc88b9b4caf03588822e05ae84dfa74dcbcf9c1308cb687885e2eacda49030
+  data.tar.gz: 112fddfa2ff633eea42cd41052d4fd59d375360ae92e31d4646b779d6a0eee409969fe6f7c95f582edba6ee8eba06ce2de0a8c5f01f3bce6689661c0b373f0f1

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+tags

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -1,3 +1,3 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec

data/Gemfile.lock

@@ -1,33 +1,55 @@
 PATH
   remote: .
   specs:
-    streamsend (0.1.1)
-      httparty (= 0.7.4)
+    streamsend (0.1.4)
+      activesupport (~> 3.2)
+      builder
+      httparty
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.2.7)
-    crack (0.1.8)
-    diff-lcs (1.1.3)
-    httparty (0.7.4)
-      crack (= 0.1.8)
-    rspec (2.9.0)
-      rspec-core (~> 2.9.0)
-      rspec-expectations (~> 2.9.0)
-      rspec-mocks (~> 2.9.0)
-    rspec-core (2.9.0)
-    rspec-expectations (2.9.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.9.0)
-    webmock (1.8.4)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    addressable (2.3.5)
+    builder (3.2.2)
+    columnize (0.3.6)
+    crack (0.4.0)
+      safe_yaml (~> 0.9.0)
+    debugger (1.6.0)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.1)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.3)
+    diff-lcs (1.2.4)
+    httparty (0.11.0)
+      multi_json (~> 1.0)
+      multi_xml (>= 0.5.2)
+    i18n (0.6.1)
+    multi_json (1.7.7)
+    multi_xml (0.5.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    safe_yaml (0.9.3)
+    vcr (2.5.0)
+    webmock (1.12.3)
       addressable (>= 2.2.7)
-      crack (>= 0.1.7)
+      crack (>= 0.3.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  rspec (~> 2.9)
+  debugger
+  rspec
   streamsend!
+  vcr
   webmock (~> 1.6)

data/lib/streamsend/api/account.rb

@@ -0,0 +1,62 @@
+require "active_support/core_ext/hash"
+require File.expand_path(__FILE__, "exception")
+
+module StreamSend
+  module Api
+    class Account < Resource
+      def self.all
+        response = StreamSend::Api.get("/accounts.xml")
+
+        case response.code
+        when 200
+          response["accounts"].collect { |data| new(data) }
+        else
+          raise StreamSend::Api::Exception.new("Could not find any accounts. Make sure your api username and password are correct. (#{response.code})")
+        end
+      end
+
+      def self.show(id)
+        response = StreamSend::Api.get("/accounts/#{id}.xml")
+        case response.code
+        when 200
+          new(response["account"])
+        else
+          raise StreamSend::Api::Exception.new("Could not find the account. Make sure your account ID is correct. (#{response.code})")
+        end
+      end
+
+      def self.update(account_hash)
+        response = StreamSend::Api.put("/accounts/#{account_hash['account_id']}/users/#{account_hash['user_id']}.xml", :body => account_hash.to_xml)
+        case response.code
+        when 200
+          true
+        else
+          false
+        end
+      end
+
+      def self.create(account_hash)
+        response = StreamSend::Api.post("/accounts.xml", :body => {:account => account_hash})
+        case response.code
+        when 201
+          response.headers["location"] =~ %r(/accounts/(\d+))
+          account_id = $1
+          account_id.to_i
+        else
+          raise StreamSend::Api::Exception.new("Could not create the account. (#{response.code})")
+        end
+      end
+
+      def self.destroy(id)
+        id = id.to_i
+        response = StreamSend::Api.delete("/accounts/#{id}.xml")
+        case response.code
+        when 200
+          true
+        else
+          raise StreamSend::Api::Exception.new("Could not delete the account. (#{response.code})")
+        end
+      end
+    end
+  end
+end

data/lib/streamsend/api/exception.rb

@@ -0,0 +1,2 @@
+class StreamSend::Api::Exception < Exception
+end

data/lib/streamsend/api/list.rb

@@ -0,0 +1,55 @@
+require File.expand_path(__FILE__, "exception")
+
+module StreamSend
+  module Api
+    class List < Resource
+      def self.all
+        response = StreamSend::Api.get("/audiences/#{audience_id}/lists.xml")
+
+        case response.code
+        when 200
+          response["lists"].collect { |data| new(data) }
+        else
+          raise StreamSend::Api::Exception.new("Could not find any lists. (#{response.code})")
+        end
+      end
+
+      def self.find(list_id)
+        response = StreamSend::Api.get("/audiences/#{audience_id}/lists/#{list_id}.xml")
+
+        case response.code
+        when 200
+          new(response["list"])
+        else
+          raise StreamSend::Api::Exception.new("Could not find any lists. (#{response.code})")
+        end
+      end
+
+      def self.create(list_name)
+        response = StreamSend::Api.post("/audiences/#{audience_id}/lists.xml", :query => {:list => {:name => list_name}})
+
+        if response.code == 201
+          response.headers["location"] =~ /audiences\/\d\/lists\/(\d+)$/
+          new_list_id = $1.to_i
+        else
+          raise StreamSend::Api::Exception.new("Could not create a list. (#{response.body})")
+        end
+      end
+
+      def destroy
+        self.class.destroy( id )
+      end
+
+      def self.destroy( id )
+        id_as_integer = id.to_i
+        response = StreamSend::Api.delete("/audiences/#{audience_id}/lists/#{id_as_integer}.xml")
+        case response.code
+        when 200
+          true
+        else
+          raise StreamSend::Api::Exception.new "Could not delete list (#{response.code})."
+        end
+      end
+    end
+  end
+end

data/lib/streamsend/api/resource.rb

@@ -0,0 +1,38 @@
+require File.expand_path(__FILE__, "exception")
+
+module StreamSend
+  module Api
+    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
+
+      def self.clear_audience
+        @audience_id = nil
+      end
+
+      def self.audience_id
+        if @audience_id.nil?
+          audiences_repsonse = StreamSend::Api.get("/audiences.xml")
+          audiences_entity = audiences_repsonse.parsed_response
+          audiences = audiences_entity["audiences"]
+          audience = audiences.first
+          @audience_id = audience["id"]
+        end
+        @audience_id
+      end
+    end
+  end
+end

data/lib/streamsend/api/subscriber.rb

@@ -0,0 +1,86 @@
+require File.expand_path(__FILE__, "exception")
+require 'debugger'
+
+module StreamSend
+  module Api
+    class Subscriber < Resource
+      def self.all
+        response = StreamSend::Api.get("/audiences/#{audience_id}/people.xml")
+
+        case response.code
+        when 200
+          response["people"].collect { |data| new(data) }
+        else
+          raise StreamSend::Api::Exception.new("Could not find any subscribers. Make sure your audience ID is correct. (#{response.code})")
+        end
+      end
+
+      def self.find(email_address)
+        response = StreamSend::Api.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 StreamSend::Api::Exception.new("Could not find the subscriber. Make sure your audience ID is correct. (#{response.code})")
+        end
+      end
+
+      def self.create(person_hash)
+        response = StreamSend::Api.post("/audiences/#{audience_id}/people.xml", :query => {:person => person_hash})
+
+        case response.code
+        when 201
+          response.headers["location"] =~ /audiences\/\d+\/people\/(\d+)$/
+          subscriber_id = $1
+          unless subscriber_id.nil?
+            subscriber_id.to_i
+          end
+        else
+          raise StreamSend::Api::Exception.new("Could not create the subscriber. (#{response.code})")
+        end
+      end
+
+      def show
+        response = StreamSend::Api.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 StreamSend::Api::Exception.new("Could not show the subscriber. (#{response.code})")
+        end
+      end
+
+      def activate
+        response = StreamSend::Api.post("/audiences/#{audience_id}/people/#{id}/activate.xml")
+
+        case response.code
+        when 200
+          true
+        else
+          raise StreamSend::Api::Exception.new("Could not activate the subscriber. (#{response.code})")
+        end
+      end
+
+      def unsubscribe
+        response = StreamSend::Api.post("/audiences/#{audience_id}/people/#{id}/unsubscribe.xml")
+
+        case response.code
+        when 200
+          true
+        else
+          raise StreamSend::Api::Exception("Could not subscribe the subscriber. (#{response.code})")
+        end
+      end
+    end
+  end
+end

data/lib/streamsend/api/user.rb

@@ -0,0 +1,56 @@
+require "active_support/core_ext/hash"
+require File.expand_path(__FILE__, "exception")
+
+module StreamSend
+  module Api
+    class User < Resource
+      def self.all
+        response = StreamSend::Api.get("/users.xml")
+
+        case response.code
+        when 200
+          response["users"].collect { |data| new(data) }
+        else
+          raise StreamSend::Api::Exception.new("Could not find any users. Make sure your account ID is correct. (#{response.code})")
+        end
+      end
+
+      def self.show(id)
+        response = StreamSend::Api.get("/users/#{id}.xml")
+        case response.code
+        when 200
+          new(response["user"])
+        else
+          raise StreamSend::Api::Exception.new("Could not find the user. Make sure your account ID and user ID are correct. (#{response.code})")
+        end
+      end
+
+      def self.update(user_hash)
+        user_properties = user_hash.clone
+        user_properties.delete 'user_id'
+        user_properties.delete 'account_id'
+
+        xml_hash = user_properties.to_xml :root => "user"
+        response = StreamSend::Api.put("/accounts/#{user_hash['account_id']}/users/#{user_hash['user_id']}.xml", :body => xml_hash, :headers => {'Content-Type' => 'application/xml', 'Accept' => 'application/xml'})
+        case response.code
+        when 200
+          true
+        else
+          false
+        end
+      end
+
+      def self.create(user_hash)
+        response = StreamSend::Api.post("/accounts/#{user_hash['account_id']}/users.xml", :body => {:user => user_hash})
+        case response.code
+        when 201
+          response.headers["location"] =~ /\/accounts\/\d+\/users\/(\d+)/
+          user_id = $1
+          user_id.to_i
+        else
+          raise StreamSend::Api::Exception.new("Could not create the user. (#{response.code})")
+        end
+      end
+    end
+  end
+end

data/lib/streamsend.rb

@@ -1,16 +1,22 @@
 require 'rubygems'
 require 'httparty'
 
-require "streamsend/resource"
-require "streamsend/subscriber"
-require "streamsend/list"
+require "streamsend/api/resource"
+require "streamsend/api/subscriber"
+require "streamsend/api/list"
+require "streamsend/api/user"
+require "streamsend/api/account"
+require "streamsend/api/exception"
 
 module StreamSend
-  include HTTParty
-  format :xml
+  module Api
+    include HTTParty
+    format :xml
 
-  def self.configure(username, password, host = "app.streamsend.com")
-    base_uri host
-    basic_auth username, password
+    def self.configure(username, password, host = "app.streamsend.com")
+      base_uri host
+      basic_auth username, password
+      StreamSend::Api::Subscriber.clear_audience
+    end
   end
 end

data/spec/integration/account_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+require File.join(Dir.pwd, "lib/streamsend")
+require "integration/spec_helper"
+require File.expand_path(__FILE__, "../../exception")
+
+describe "user via api" do
+  before do
+    @account = StreamSend::Api::IntegrationConfiguration.root_account
+    StreamSend::Api.configure(@account.api_username, @account.api_password, @account.app_host)
+  end
+
+  let(:create_account) do
+    pending "TODO -> Broken 2013-04-05"
+    create_result = StreamSend::Api::Account.create(
+      :name => "account2",
+      :automated_email_address => "admin@localhost.com",
+      :quota => 100,
+      :quota_cap => 100,
+      :plan_id => 1,
+      :owner => {
+        "password" => "password2",
+        "password_confirmation" => "password2",
+        "email_address" => "joe+#{Time.now.to_i}@gmail.com",
+        "first_name" => "Joe",
+        "last_name" => "user",
+        "may_export" => true,
+        "administrator" => true
+      })
+  end
+
+  describe ".all" do
+    it "lists all accounts" do
+      VCR.use_cassette('streamsend') do
+        accounts = StreamSend::Api::Account.all
+        accounts.count.should > 0
+      end
+    end
+  end
+
+  describe ".show" do
+    it "finds the root account" do
+      VCR.use_cassette('streamsend') do
+        root_account = StreamSend::Api::Account.show(1)
+        root_account.name.should == "EZ Publishing"
+      end
+    end
+  end
+
+  describe ".create" do
+    it "creates a new account" do
+      VCR.use_cassette('streamsend') do
+        id = create_account
+        StreamSend::Api::Account.destroy(id)
+      end
+    end
+  end
+
+  describe ".destroy" do
+    it "deletes an account" do
+      VCR.use_cassette('streamsend') do
+        id = create_account
+        response = StreamSend::Api::Account.destroy(id)
+        response.should == true
+        expect { StreamSend::Api::Account.show(id) }.to raise_exception(StreamSend::Api::Exception, /could not find/i)
+      end
+    end
+  end
+end

data/spec/integration/integration.yml

@@ -0,0 +1,5 @@
+root_account:
+  api_username: "rootapiuser"
+  api_password: <%= ENV['STREAMSEND_PASSWORD'] %>
+  app_host: "localhost:3000"
+  account_id: 1

data/spec/integration/list_spec.rb

@@ -0,0 +1,68 @@
+require "spec_helper"
+require File.join(Dir.pwd, "lib/streamsend")
+require "integration/spec_helper"
+require File.expand_path(__FILE__, "../../exception")
+
+describe "List API" do
+  let( :test_list_prefix ) { "Ruby Gem Client API List #" }
+  let( :test_list_name ) { test_list_prefix }
+
+  before do
+    account = StreamSend::Api::IntegrationConfiguration.root_account
+    StreamSend::Api.configure(account.api_username, account.api_password, account.app_host)
+  end
+
+  after do
+    VCR.use_cassette('streamsend') do
+      StreamSend::Api::List.all.select do | list |
+        list.name == test_list_name
+      end.each do | list |
+        list.destroy
+      end
+    end
+  end
+
+  context "#create" do
+    it "creates a list when given a unique name" do
+      VCR.use_cassette('streamsend') do
+        expect {
+          StreamSend::Api::List.create test_list_name
+        }.not_to raise_error
+      end
+    end
+
+    it "returns the list id" do
+      VCR.use_cassette('streamsend') do
+        id = StreamSend::Api::List.create test_list_name
+        id.should_not be_nil
+      end
+    end
+
+    it "creating a new list with an existing name raises an error" do
+      VCR.use_cassette('streamsend') do
+        StreamSend::Api::List.create test_list_name
+        expect {
+          StreamSend::Api::List.create test_list_name
+        }.to raise_error
+      end
+    end
+
+    it "name is properly set on the list" do
+      VCR.use_cassette('streamsend') do
+        id = StreamSend::Api::List.create test_list_name
+        list = StreamSend::Api::List.find id
+        list.name.should == test_list_name
+      end
+    end
+  end
+
+  context "#delete" do
+    it "removes the list" do
+      VCR.use_cassette('streamsend') do
+        list_id = StreamSend::Api::List.create test_list_name
+        list = StreamSend::Api::List.find list_id
+        list.destroy.should be_true
+      end
+    end
+  end
+end

data/spec/integration/spec_helper.rb

@@ -0,0 +1,16 @@
+require "yaml"
+require "ostruct"
+
+module StreamSend
+  module Api
+    class IntegrationConfiguration
+      def self.config
+        @config ||= YAML.load(ERB.new(IO.read("spec/integration/integration.yml")).result)
+      end
+
+      def self.root_account
+        OpenStruct.new(config["root_account"])
+      end
+    end
+  end
+end

data/spec/integration/user_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+require File.join(Dir.pwd, "lib/streamsend")
+require "integration/spec_helper.rb"
+require "debugger"
+
+describe "user via api" do
+  before do
+    account = StreamSend::Api::IntegrationConfiguration.root_account
+    StreamSend::Api.configure(account.api_username, account.api_password, account.app_host)
+  end
+
+  it "exists" do
+    VCR.use_cassette('streamsend') do
+      the_user = StreamSend::Api::User.all.first
+      the_user.first_name.should == "Admin"
+    end
+  end
+
+  it "gets created" do
+    VCR.use_cassette('streamsend') do
+      the_user = StreamSend::Api::User.create(
+        "password" => "password2",
+        "password_confirmation" => "password2",
+        "email_address" => "joe#{Time.now.to_i}@gmail.com",
+        "first_name" => "Joe",
+        "last_name" => "user",
+        "account_id" => 1,
+        "may_export" => true,
+        "administrator" => true
+      )
+
+      saved_user = find_by_email_address("joe@gmail.com")
+      saved_user.first.id.should > 0
+    end
+  end
+
+  it "can be found" do
+    VCR.use_cassette('streamsend') do
+      user = StreamSend::Api::User.show(1)
+      expect(user.class).to eq(StreamSend::Api::User)
+    end
+  end
+
+  it "allows us to change the last name" do
+    VCR.use_cassette('streamsend') do
+      the_user = StreamSend::Api::User.all.last
+      expect(the_user.last_name).to eq("user")
+      response = StreamSend::Api::User.update("account_id" => StreamSend::Api::IntegrationConfiguration.root_account.account_id, "last-name" => "smithy", "user_id" => the_user.id)
+      new_user = StreamSend::Api::User.show(the_user.id)
+      expect(new_user.last_name).to eq("smithy")
+    end
+  end
+
+  def find_by_email_address(email_address)
+    the_user = StreamSend::Api::User.all.each do |user|
+      return user if user.email_address == email_address
+    end
+  end
+end