streamsend 0.2.3 → 1.0.0.rc1

data/lib/streamsend/api/email.rb

@@ -0,0 +1,20 @@
+module StreamSend
+  module Api
+    module Email
+      class Index < StreamSend::Api::Call::Index
+      end
+
+      class Show < StreamSend::Api::Call::Show
+      end
+
+      class Update < StreamSend::Api::Call::Update
+      end
+
+      class Destroy < StreamSend::Api::Call::Destroy
+      end
+
+      class Create < StreamSend::Api::Call::Create
+      end
+    end
+  end
+end

data/lib/streamsend/api/exception.rb

@@ -6,9 +6,12 @@ module StreamSend
     class ApiException < Exception
     end
 
+    class LockedError <  ApiException
+    end
+
     class SemanticException < ApiException
       def initialize(other_errors)
-       @errors = [other_errors].flatten
+        @errors = [other_errors].flatten
       end
 
       def errors
@@ -20,9 +23,6 @@ module StreamSend
       end
     end
 
-    class LockedError <  ApiException
-    end
-
     class UnexpectedResponse < ApiException
     end
   end

data/lib/streamsend/api/field.rb

@@ -0,0 +1,20 @@
+module StreamSend
+  module Api
+    module Field
+      class Index < StreamSend::Api::Call::AudienceIndex
+      end
+
+      class Show < StreamSend::Api::Call::AudienceShow
+      end
+
+      class Update < StreamSend::Api::Call::AudienceUpdate
+      end
+
+      class Create < StreamSend::Api::Call::AudienceCreate
+      end
+
+      class Destroy < StreamSend::Api::Call::AudienceDestroy
+      end
+    end
+  end
+end

data/lib/streamsend/api/field_option.rb

@@ -0,0 +1,60 @@
+module StreamSend
+  module Api
+    module Option
+      class Index < StreamSend::Api::Call::Index
+        def execute(field_id)
+          @field_id = field_id
+          super()
+        end
+
+        def uri
+          "#{base_audience_only}/fields/#{@field_id}/options.xml"
+        end
+      end
+
+      class Show < StreamSend::Api::Call::Show
+        def execute(field_id, option_id)
+          @field_id = field_id
+          super(option_id)
+        end
+
+        def uri
+          "#{base_audience_only}/fields/#{@field_id}/options/#{id}.xml"
+        end
+      end
+
+      class Update < StreamSend::Api::Call::Update
+        def execute(field_id, option_id, object_hash)
+          @field_id = field_id
+          super(option_id, object_hash)
+        end
+
+        def uri
+          "#{base_audience_only}/fields/#{@field_id}/options/#{id}.xml"
+        end
+      end
+
+      class Create < StreamSend::Api::Call::Create
+        def execute(field_id, object_hash)
+          @field_id = field_id
+          super(object_hash)
+        end
+
+        def uri
+          "#{base_audience_only}/fields/#{@field_id}/options.xml"
+        end
+      end
+
+      class Destroy < StreamSend::Api::Call::Destroy
+        def execute(field_id, option_id)
+          @field_id = field_id
+          super(option_id)
+        end
+
+        def uri
+          "#{base_audience_only}/fields/#{@field_id}/options/#{id}.xml"
+        end
+      end
+    end
+  end
+end

data/lib/streamsend/api/filter.rb

@@ -0,0 +1,20 @@
+module StreamSend
+  module Api
+    module Filter
+      class Index < StreamSend::Api::Call::AudienceIndex
+      end
+
+      class Show < StreamSend::Api::Call::AudienceShow
+      end
+
+      class Update < StreamSend::Api::Call::AudienceUpdate
+      end
+
+      class Destroy < StreamSend::Api::Call::AudienceDestroy
+      end
+
+      class Create < StreamSend::Api::Call::AudienceCreate
+      end
+    end
+  end
+end

data/lib/streamsend/api/from_email_address.rb

@@ -0,0 +1,24 @@
+module StreamSend
+  module Api
+    module FromEmailAddress
+      class Index < StreamSend::Api::Call::Index
+      end
+
+      class ResendActivationEmail < StreamSend::Api::Call::BaseCall
+        def execute(from_email_address_id)
+          session.post(uri(from_email_address_id))
+        end
+
+        def uri id
+          "#{base_uri}/#{id}/resend_activation_email.xml"
+        end
+      end
+
+      class Show < StreamSend::Api::Call::Show
+      end
+
+      class Create < StreamSend::Api::Call::Create
+      end
+    end
+  end
+end

data/lib/streamsend/api/import.rb

@@ -0,0 +1,11 @@
+module StreamSend
+  module Api
+    module Import
+      class Show < StreamSend::Api::Call::AudienceShow
+      end
+
+      class Create < StreamSend::Api::Call::AudienceCreate
+      end
+    end
+  end
+end

data/lib/streamsend/api/link.rb

@@ -0,0 +1,11 @@
+module StreamSend
+  module Api
+    module Link
+      class Index < StreamSend::Api::Call::BlastIndex
+      end
+
+      class Show < StreamSend::Api::Call::BlastShow
+      end
+    end
+  end
+end

data/lib/streamsend/api/list.rb

@@ -1,54 +1,28 @@
-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})")
+    module List
+      class Index < StreamSend::Api::Call::AudienceIndex
+        def execute(person_id = nil)
+          @person_id = person_id
+          super()
         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})")
+        def uri
+          return "#{base_audience_only}/people/#{@person_id}/lists.xml" if @person_id
+          audiences_uri
         end
       end
 
-      def self.create(list_name)
-        response = StreamSend::Api.post("/audiences/#{audience_id}/lists.xml", :query => {:list => {:name => list_name}})
+      class Show < StreamSend::Api::Call::AudienceShow
+      end
 
-        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
+      class Update < StreamSend::Api::Call::AudienceUpdate
       end
 
-      def destroy
-        self.class.destroy( id )
+      class Create < StreamSend::Api::Call::AudienceCreate
       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
+      class Destroy < StreamSend::Api::Call::AudienceDestroy
       end
     end
   end

data/lib/streamsend/api/membership.rb

@@ -0,0 +1,28 @@
+module StreamSend
+  module Api
+    module Membership
+      class Index < StreamSend::Api::Call::AudienceIndex
+        def execute(person_id, list_id = nil, options = {})
+          @person_id = person_id
+          @list_id = list_id
+          super(options)
+        end
+
+        def uri
+          base = "#{base_audience_only}/people/#{@person_id}/"
+           return "#{base}lists/#{@list_id}/memberships.xml#{paging_query_string}" if @list_id
+          "#{base}memberships.xml#{paging_query_string}"
+        end
+      end
+
+      class Show < StreamSend::Api::Call::AudienceShow
+      end
+
+      class Destroy < StreamSend::Api::Call::AudienceDestroy
+      end
+
+      class Create < StreamSend::Api::Call::AudienceCreate
+      end
+    end
+  end
+end

data/lib/streamsend/api/person.rb

@@ -0,0 +1,66 @@
+module StreamSend
+  module Api
+    module Person
+      class Create < StreamSend::Api::Call::AudienceCreate
+      end
+
+      class Update < StreamSend::Api::Call::AudienceUpdate
+      end
+
+      class Show < StreamSend::Api::Call::AudienceShow
+      end
+
+      class Destroy < StreamSend::Api::Call::AudienceDestroy
+      end
+
+      class Index < StreamSend::Api::Call::AudienceIndex
+        def execute(email_address = nil, tracking_hash = nil, options = {})
+          @email_address = email_address
+          @tracking_hash = tracking_hash
+          super(options)
+        end
+
+        def uri
+          full_uri = super << paging_query_string
+          full_uri << "&email_address=#{@email_address}" if @email_address
+          full_uri << "&tracking_hash=#{@tracking_hash}" if @tracking_hash
+          full_uri
+        end
+      end
+
+      class Activate < StreamSend::Api::Call::BaseCall
+        def execute(person_id)
+           session.post(uri(person_id))
+        end
+
+        def uri id
+          "#{base_audience_uri}/#{id}/activate.xml"
+        end
+      end
+
+      class Click < StreamSend::Api::Click::Index
+        def uri
+          base = "#{session.base_uri}/blasts/#{@blast_id}"
+          return "#{base_blast_only_for(@blast_id)}/links/#{@link_id}/clicks/people.xml#{paging_query_string}" if @link_id
+          "#{base_blast_only_for(@blast_id)}/clicks/people.xml#{paging_query_string}"
+        end
+      end
+
+      class View < StreamSend::Api::Call::BlastIndex
+        def uri
+          "#{base_blast_only_for(@blast_id)}/views/people.xml#{paging_query_string}"
+        end
+      end
+
+      class Unsubscribe < StreamSend::Api::Call::BaseCall
+        def execute(person_id)
+          session.post(uri(person_id))
+        end
+
+        def uri id
+          "#{base_audience_uri}/#{id}/unsubscribe.xml"
+        end
+      end
+    end
+  end
+end

data/lib/streamsend/api/result.rb

@@ -0,0 +1,13 @@
+module StreamSend
+  module Api
+    class Result < OpenStruct
+      def id
+        self.marshal_dump[:id].to_i || super
+      end
+
+      def to_hash
+        self.marshal_dump
+      end
+    end
+  end
+end

data/lib/streamsend/api/session.rb

@@ -0,0 +1,73 @@
+module StreamSend
+  module Api
+    class Session
+      def initialize(username = nil, password = nil, base_uri = nil)
+        @base_uri = load_base_uri(base_uri)
+        @username = load_username(username)
+        @password = load_password(password)
+      end
+
+      def load_base_uri base_uri
+        return base_uri if base_uri
+        return ENV['STREAMSEND_BASE_URI'] if ENV['STREAMSEND_BASE_URI']
+        return StreamSend::Api::Configuration.base_uri if StreamSend::Api::Configuration.base_uri
+        return "http://app.streamsend.com"
+      end
+
+      def load_username username
+        return username if username
+        return ENV['STREAMSEND_USERNAME'] if ENV['STREAMSEND_USERNAME']
+        return StreamSend::Api::Configuration.username
+        raise StreamSend::Api::Exception.new("Unable to create session: no API username provided.")
+      end
+
+      def load_password password
+        return password if password
+        return ENV['STREAMSEND_PASSWORD'] if ENV['STREAMSEND_PASSWORD']
+        return StreamSend::Api::Configuration.password
+        raise StreamSend::Api::Exception.new("Unable to create session: no API password provided.")
+      end
+
+      def get(uri, options = {})
+        options.merge!(self.basic_auth_credentials)
+        HTTParty.get(uri, options)
+      end
+
+      def put(uri, options = {})
+        options.merge!(self.basic_auth_credentials)
+        HTTParty.put(uri, options)
+      end
+
+      def post(uri, options = {})
+        options.merge!(self.basic_auth_credentials)
+        HTTMultiParty.post(uri, options)
+      end
+
+      def delete(uri, options = {})
+        options.merge!(self.basic_auth_credentials)
+        HTTParty.delete(uri, options)
+      end
+
+      def base_uri
+        @base_uri
+      end
+
+      def basic_auth_credentials
+        { :basic_auth => { :username => @username, :password => @password } }
+      end
+
+      def audience_id
+        @audience_id ||= get_audience_id
+      end
+private
+      def get_audience_id
+        audience = StreamSend::Api::Audience::Index.new(self).execute().first
+        if audience
+          return audience.id
+        else
+          raise StreamSend::Api::Exception.new("Invalid response when fetching audience. Are your credentials valid?")
+        end
+      end
+    end
+  end
+end

data/lib/streamsend/api/unsubscribe.rb

@@ -0,0 +1,20 @@
+module StreamSend
+  module Api
+    module  Unsubscribe
+      class Index < StreamSend::Api::Call::BlastIndex
+      end
+
+      class Manual < StreamSend::Api::Call::BlastIndex
+        def uri
+          "#{base_blast_uri_for(@blast_id)}/manual.xml#{paging_query_string}"
+        end
+      end
+
+      class Complaint < StreamSend::Api::Call::BlastIndex
+        def uri
+          "#{base_blast_uri_for(@blast_id)}/complaint.xml#{paging_query_string}"
+        end
+      end
+    end
+  end
+end

data/lib/streamsend/api/upload.rb

@@ -0,0 +1,13 @@
+module StreamSend
+  module Api
+    module Upload
+      class Create < StreamSend::Api::Call::Create
+        def execute(filepath)
+          upload_hash = nil
+          options = { :query => { :data => File.new(filepath) } }
+          super(upload_hash, options)
+        end
+      end
+    end
+  end
+end

data/lib/streamsend/api/user.rb

@@ -1,54 +1,83 @@
-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")
+    module User
+      class Index < StreamSend::Api::Call::Index
+        def execute(account_id = nil)
+          @account_id = account_id
+          super()
+        end
+
+        def uri
+          return users_uri(@account_id) if @account_id
+          super
+        end
+      end
+
+      class Show < StreamSend::Api::Call::Show
+        def execute(user_id, account_id = nil)
+          @account_id = account_id
+          super(user_id)
+        end
+
+        def uri
+          return user_uri_for(@account_id, id) if @account_id
+          super
+        end
+      end
+
+      class Destroy < StreamSend::Api::Call::Destroy
+        def execute(user_id, account_id = nil)
+          @account_id = account_id
+          super(user_id)
+        end
 
-        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})")
+        def uri
+          return user_uri_for(@account_id, id) if @account_id
+          super
         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})")
+      class Create < StreamSend::Api::Call::Create
+        def execute(user_hash, account_id = nil)
+          @account_id = account_id
+          super(user_hash)
+        end
+
+        def uri
+          return users_uri(@account_id) if @account_id
+          super
         end
       end
 
-      def self.update(user_hash)
-        user_properties = user_hash.clone
-        user_properties.delete 'user_id'
-        user_properties.delete 'account_id'
+      class Update < StreamSend::Api::Call::Update
+        def execute(user_id, user_hash, account_id = nil)
+          @account_id = account_id
+          super(user_id, user_hash)
+        end
 
-        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
+        def uri
+          return user_uri_for(@account_id, id) if @account_id
+          super
         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})")
+      class Login < StreamSend::Api::Call::BaseCall
+        def execute(user_id, account_id = nil)
+          @user_id = user_id
+          @account_id = account_id
+          response = session.post(uri, :follow_redirects => false)
+
+          case response.code
+          when 302
+            response.headers["location"].split("/").last
+          else
+            raise StreamSend::Api::Exception.new("Could not log the user in.")
+          end
+        end
+
+        def uri
+          return "#{session.base_uri}/accounts/#{@account_id}/users/#{@user_id}/login.xml" if @account_id
+          "#{session.base_uri}/users/#{@user_id}/login.xml"
         end
       end
     end

data/lib/streamsend/api/view.rb

@@ -0,0 +1,8 @@
+module StreamSend
+  module Api
+    module View
+      class Index < StreamSend::Api::Call::BlastIndex
+      end
+    end
+  end
+end

data/lib/streamsend/version.rb

@@ -0,0 +1,3 @@
+module StreamSend
+  VERSION = "1.0.0.rc1"
+end

data/lib/streamsend.rb

@@ -1,22 +1,41 @@
-require 'rubygems'
-require 'httparty'
+require "rubygems"
+require "httmultiparty"
+require "ostruct"
+require "active_support/inflector"
+require "active_support/core_ext"
 
-require "streamsend/api/resource"
-require "streamsend/api/subscriber"
+require "streamsend/version"
+require "streamsend/api/configuration"
+require "streamsend/api/result"
+require "streamsend/api/exception"
+require "streamsend/api/base/base_call"
+require "streamsend/api/base/index"
+require "streamsend/api/base/show"
+require "streamsend/api/base/update"
+require "streamsend/api/base/create"
+require "streamsend/api/base/destroy"
+require "streamsend/api/audience"
+require "streamsend/api/session"
+
+require "streamsend/api/account"
+require "streamsend/api/blast"
+require "streamsend/api/bounce"
+require "streamsend/api/click"
+require "streamsend/api/email"
+require "streamsend/api/field"
+require "streamsend/api/field_option"
+require "streamsend/api/filter"
+require "streamsend/api/from_email_address"
+require "streamsend/api/link"
 require "streamsend/api/list"
+require "streamsend/api/import"
+require "streamsend/api/membership"
+require "streamsend/api/person"
+require "streamsend/api/unsubscribe"
+require "streamsend/api/upload"
+require "streamsend/api/view"
 require "streamsend/api/user"
-require "streamsend/api/account"
-require "streamsend/api/exception"
 
 module StreamSend
-  module Api
-    include HTTParty
-    format :xml
-
-    def self.configure(username, password, host = "app.streamsend.com")
-      base_uri host
-      basic_auth username, password
-      StreamSend::Api::Subscriber.clear_audience
-    end
-  end
+  PER_PAGE_DEFAULT = 100
 end