cupid 0.2.4 → 0.3.2

data/.gitignore

@@ -0,0 +1,17 @@
+.test_account
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+tmp
+example.rb

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -1,4 +1,2 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in cupid.gemspec
+source 'http://rubygems.org'
 gemspec

data/README.md

@@ -6,91 +6,47 @@ Sponsored by Evil Martians <http://evilmartians.com>
 
 ## Usage
 
-Add cupid initializer to your config/initializers and now there only two parameters to configure:
+Get a new cupid object for every account you want to work with (usually
+it's the only one):
 
 ``` ruby
-Cupid.configure do |config|
-  config.username = 'username'
-  config.password = 'password'
-  config.account  = 'default_client_id'
-end
+  Cupid::MyAccount = Cupid.new :username, :password, :account
 ```
 
-After that you can create Cupid::Session object and do some stuff through it:
+Now you can send requests to ExactTarget through this object.
 
-``` ruby
-# Creating session
-et_translator = Cupid::Session.new
-
-# Retrieving folders for not default account (your_account_id can be nil - default account on ET)
-folders = et_translator.retrieve_email_folders
-
-# Retrieving email copies for not default account (your_account_id can be nil - default account on ET)
-copies = et_translator.retrieve_email_copies(name)
-
-# Retrieving emails from list for not default account (your_account_id can be nil - default account on ET)
-copies = et_translator.retrieve_emails_from_list(list_id)
-
-# Creating new folder
-# not required fields for folder: description, content_type, is_active, is_editable, allow_children
-new_folder_id = et_translator.create_folder('title', :parent => parent_directory_id)
-
-# Creating folders
-# not required fields for folders: description, content_type, is_active, is_editable, allow_children
-new_folder_ids = et_translator.create_folders(['title', 'title2'], :parent => parent_directory_id)
-
-# Creating new email
-# not required fields for email: email_type, is_html_paste, character_set, name, description, category_id
-new_email_id = et_translator.create_email('subject', 'body')
-
-# Creating emails
-# not required fields for emails: email_type, is_html_paste, character_set, name, description, category_id
-new_email_ids = et_translator.create_emails({'subject' => 'body', 'subject2' => 'body2'})
+Small example:
 
-# User object:
-{
-  :email => 'email@email.com',
-  :lists => [list_id1, list_id2...],
-  :first_name => 'Name',
-  :last_name => 'Lastname'
-}
-
-# Creating new subscriber
-# not required fields for subscriber: first_name, last_name, client_id
-new_subscriber_id = et_translator.create_subscriber(user_object)
-
-# Creating subscribers
-# not required fields for subscriber: first_name, last_name, client_id
-new_subscriber_ids = et_translator.create_subscribers([user_object1, user_object2...])
-
-# Send email to list
-# not required fields for send: account
-send_tracking_id = et_translator.send_email_to_list(email_id, list_id)
-
-# Send emails to lists
-# not required fields for send: account
-send_tracking_ids = et_translator.send_emails_to_lists({'email_id' => 'list_id','email_id' => 'list_id'...})
+``` ruby
+  Cupid::MyAccount.tap do |it|
+    list = it.lists.last
+    new_email = it.create_email :subject, :body
+    it.create_delivery list, new_email
+    it.delete_emails *it.emails
+  end
 ```
 
+There is much more underneath. See specs for some examples.
+
 ## Installation
 
 Puts this line into `Gemfile` then run `$ bundle`:
 
 ``` ruby
-gem 'cupid', '0.2.4'
+gem 'cupid'
 ```
 
 Or if you are old-school Rails 2 developer put this into `config/environment.rb` and run `$ rake gems:install`:
 
 ``` ruby
-config.gem 'cupid', :version => '0.2.4'
+config.gem 'cupid'
 ```
 
 Or manually install cupid gem: `$ gem install cupid`
 
 ## Contributors
 
-* @gazay
+* @gazay, @brainopia
 
 ## License
 
@@ -103,3 +59,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/Rakefile

@@ -1,4 +1,11 @@
-require 'rubygems'
-require 'rake'
-require 'bundler'
-Bundler::GemHelper.install_tasks
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+desc 'Clean up test account'
+task :clean_et do
+  Bundler.require :default, :development
+  require './spec/spec_helper'
+  api = Cupid::Test
+  api.delete_emails *api.emails
+  api.delete_folders *api.folders.reject(&:root?)
+end

data/cupid.gemspec

@@ -1,25 +1,23 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "cupid/version"
+require File.expand_path('../lib/cupid/version', __FILE__)
 
 Gem::Specification.new do |s|
-  s.name        = "cupid"
-  s.version     = Cupid::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ['gazay']
+  s.name        = 'cupid'
+  s.authors     = ['gazay', 'brainopia']
   s.email       = ['gazay@evilmartians.com']
-  s.homepage    = ""
-  s.summary     = %q{Create, organize and send emails through Exact Target SOAP API}
-  s.description = %q{Send love, not war. This version of cupid can only work with ET SOAP API with s4.}
+  s.homepage    = 'http://github.com/evilmartians/cupid'
+  s.summary     = 'Create, organize and send emails through Exact Target SOAP API'
+  s.description = 'Send love, not war. This version of cupid works with ET SOAP API s4.'
 
-  s.rubyforge_project = "cupid"
+  s.add_dependency 'builder',   '>= 2'
+  s.add_dependency 'nokogiri',  '~> 1'
+  s.add_dependency 'savon',     '~> 0.9'
 
-  s.add_dependency("builder",   ">= 2.1.2")
-  s.add_dependency("nokogiri",  ">= 1.4.1")
-  s.add_dependency("savon",     ">= 0.9.0")
+  s.add_development_dependency 'rspec', '~> 2'
 
   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"]
+  s.require_paths = ['lib']
+  s.version     = Cupid::VERSION
 end

data/lib/cupid.rb

@@ -1,10 +1,41 @@
-require("cupid/configuration")
+require 'savon'
+Dir[File.expand_path '../cupid/**/*.rb', __FILE__].each {|it| require it }
 
-module Cupid
-  extend Configuration
+class Cupid
+  NAMESPACE = 'http://exacttarget.com/wsdl/partnerAPI'
+  ENDPOINT  = 'https://webservice.s4.exacttarget.com/Service.asmx'
 
-  def self.configure
-    yield self if block_given?
+  include Create, Update, Delete, Retrieve , Schedule
+
+  attr_reader :client, :server
+
+  def initialize(username, password, account)
+    @client = client_with username, password
+    @server = Server.new account
+  end
+
+  def resources(action, xml)
+    Response.parse raw_request(action, xml).body
+  end
+
+  def resource(*args)
+    resources(*args).first
   end
 
+  private
+
+  def raw_request(action, xml)
+    client.request action do
+      soap.input = server.input action
+      soap.body  = xml
+    end
+  end
+
+  def client_with(username, password)
+    Savon::Client.new.tap do |client|
+      client.wsdl.namespace = NAMESPACE
+      client.wsdl.endpoint  = ENDPOINT
+      client.wsse.credentials username, password
+    end
+  end
 end

data/lib/cupid/create.rb

@@ -0,0 +1,67 @@
+class Cupid
+  module Create
+    def create(type, data)
+      resource :create, server.object(type, data)
+    end
+
+    def create_folder(title, parent, options={})
+      create 'DataFolder', folder(title, parent, options)
+    end
+
+    def create_email(title, body, options={})
+      create 'Email', email(title, body, options)
+    end
+
+    def create_delivery(email, list)
+      create 'Send', delivery(email, list)
+    end
+
+    def create_path(*folder_names)
+      children = folders.select(&:root?)
+      folder_names.inject(nil) do |parent, name|
+        folder = children.find {|it| it.name == name }
+        children = folder ? folder.children : []
+        folder or create_folder(name, parent)
+      end
+    end
+
+    private
+
+    def folder(title, parent, options)
+      raise ArgumentError unless title and parent and options
+
+      {
+        :name           => title,
+        :content_type   => :email,
+        :description    => nil,
+        :is_active      => true,
+        :is_editable    => true,
+        :allow_children => true,
+        :parent_folder  => {
+          'ID' => parent
+        }
+      }.merge options
+    end
+
+    def email(title, body, options)
+      raise ArgumentError unless title and body and options
+
+      {
+        :email_type    => 'HTML',
+        :character_set => 'utf-8',
+        :subject       => title,
+        'HTMLBody'     => body,
+        'IsHTMLPaste'  => true
+      }.merge options
+    end
+
+    def delivery(email, list)
+      raise ArgumentError unless email and list
+
+      {
+        :email => { 'ID' => email },
+        :list  => { 'ID' => list }
+      }
+    end
+  end
+end

data/lib/cupid/delete.rb

@@ -0,0 +1,16 @@
+class Cupid
+  module Delete
+    def delete_folders(*objects)
+      resources :delete, server.folders(objects)
+    end
+
+    def delete_emails(*objects)
+      resources :delete, server.emails(objects)
+    end
+
+    def delete_emails_like(name)
+      objects = emails name
+      objects.empty? ? [] : delete_emails(*objects)
+    end
+  end
+end

data/lib/cupid/gyoku.rb

@@ -0,0 +1,2 @@
+# ExactTarget follows camelcase convention for soap objects
+Gyoku.convert_symbols_to :camelcase

data/lib/cupid/response.rb

@@ -0,0 +1,23 @@
+class Cupid
+  module Response
+    class << self
+      def parse(body)
+        cast formatted extracted body
+      end
+
+      private
+
+      def extracted(body)
+        Data.from body
+      end
+
+      def formatted(raw_data)
+        raw_data.map {|it| Format.apply it }
+      end
+
+      def cast(data)
+        data.map {|it| Caster.create it }
+      end
+    end
+  end
+end

data/lib/cupid/response/caster.rb

@@ -0,0 +1,34 @@
+class Cupid
+  module Response
+    module Caster
+      class << self
+        def create(data)
+          klass = class_for data[:type]
+          klass.new data
+        end
+
+        private
+
+        def class_for(type)
+          fetch_constant class_name(type)
+        end
+
+        def fetch_constant(name)
+          if namespace.const_defined? name
+            namespace.const_get name
+          else
+            namespace::Object
+          end
+        end
+
+        def namespace
+          Cupid::Response
+        end
+
+        def class_name(type)
+          (type || :object).to_s.camelcase
+        end
+      end
+    end
+  end
+end

data/lib/cupid/response/data.rb

@@ -0,0 +1,48 @@
+class Cupid
+  module Response
+    class Data
+      Error = Class.new StandardError
+
+      def self.from(wrapped_body)
+        new(wrapped_body).results
+      end
+
+      def initialize(wrapped_body)
+        extract wrapped_body
+        check_status!
+      end
+
+      def results
+        [raw_results].compact.flatten
+      end
+
+      private
+
+      attr_reader :body
+
+      def extract(wrapped_body)
+        @body = wrapped_body.values.first
+      end
+
+      def check_status!
+        raise Error.new error_message unless success?
+      end
+
+      def success?
+        %w(MoreDataAvailable OK).include? status
+      end
+
+      def status
+        body[:overall_status]
+      end
+
+      def raw_results
+        body[:results]
+      end
+
+      def error_message
+        raw_results ? raw_results[:status_message] : status
+      end
+    end
+  end
+end

data/lib/cupid/response/data_folder.rb

@@ -0,0 +1,56 @@
+require 'cupid/response/object'
+
+class Cupid
+  module Response
+    class DataFolder < Object
+      ALL = []
+
+      attr_reader :parent, :children
+      fields :parent_data, :name
+
+      def self.new(data)
+        find(data[:id]) || super
+      end
+
+      def self.find(id)
+        ALL.find {|it| it.id == id }
+      end
+
+      def initialize(data)
+        super
+        assign_children
+        extract_parent
+        add_to_identity_map
+      end
+
+      def root?
+        not parent
+      end
+
+      private
+
+      def assign_children
+        @children = ALL.select {|it| it.parent == self }
+      end
+
+      def extract_parent
+        if parent_data
+          create_parent
+          attach_to_parent
+        end
+      end
+
+      def add_to_identity_map
+        ALL << self
+      end
+
+      def create_parent
+        @parent = self.class.new parent_data
+      end
+
+      def attach_to_parent
+        parent.children << self
+      end
+    end
+  end
+end