cupid 0.2.4 → 0.3.2

data/spec/cupid/response/format_spec.rb

@@ -0,0 +1,45 @@
+describe Cupid::Response::Format, '.apply' do
+  def apply(data)
+    described_class.apply data
+  end
+
+  it 'should return hash with original data' do
+    simple_data = { :a => 1 }
+    apply(simple_data).should include :a => 1
+  end
+
+  it 'should rename specified fields' do
+    described_class::RENAME[:old] = :new
+    data_with_renaming = { :old => 33 }
+    apply(data_with_renaming).should include :new => 33
+  end
+
+  it 'should delete ignore fields' do
+    described_class::IGNORE << :extra
+    data_with_deletion = { :extra => 103 }
+    apply(data_with_deletion).should_not include :extra
+  end
+
+  it 'should delete empty parents' do
+    data_with_empty_parent = { :parent_data => { :id => '0' }}
+    apply(data_with_empty_parent).should_not include :parent_data
+  end
+
+  context 'contains nested data' do
+    it 'should extract nested object to the top level' do
+      nested_data = { :a => 1, :object => { :b => 2 }}
+      apply(nested_data).should include :a => 1, :b => 2
+    end
+
+    it 'should use new_id from nested definition' do
+      new_nested_data = { :object => { :new_id => 24 }}
+      apply(new_nested_data).should include :id => 24
+    end
+
+    it 'should delete ignored fields' do
+      described_class::IGNORE << :nested_extra
+      nested_data_with_deletion = { :nexted_extra => 17 }
+      apply(nested_data_with_deletion).should_not include :nested_extra
+    end
+  end
+end

data/spec/cupid/response/object_spec.rb

@@ -0,0 +1,23 @@
+describe Cupid::Response::Object do
+  subject { described_class.new data }
+
+  describe 'accessor for attributes' do
+    let(:data) {{ :foo => :bar }}
+
+    it { subject[:foo].should == :bar }
+  end
+
+  context 'direct accessors' do
+    let(:data) {{ :id => 42, :type => 'Email' }}
+
+    its(:id) { should == 42 }
+    its(:type) { should == 'Email' }
+  end
+
+  context 'gyoku compatibility' do
+    let(:id) { 77 }
+    let(:data) {{ :id => id }}
+
+    it { Gyoku.xml(:object => subject).should == "<Object>#{id}</Object>" }
+  end
+end

data/spec/cupid/retrieve_spec.rb

@@ -0,0 +1,12 @@
+describe Cupid::Retrieve do
+  subject { Cupid::Test }
+
+  its(:folders)     { should be }
+  its(:emails)      { should be }
+  its(:lists)       { should be }
+  its(:deliveries)  { should be }
+  its(:ui_folders)  { should be }
+  its(:ui_emails)   { should be }
+
+  it { subject.emails('unexisting name').should == [] }
+end

data/spec/cupid/server_spec.rb

@@ -0,0 +1,22 @@
+describe Cupid::Server do
+  subject { Cupid::Server.new 'account' }
+
+  its(:account) { 'account' }
+
+  context '#input' do
+    let(:input) { subject.input action }
+
+    context '#for :get_system_status action' do
+      let(:action) { :get_system_status }
+      let(:tag_name) { 'SystemStatusRequestMsg' }
+
+      it { input.should == [tag_name, :xmlns => Cupid::NAMESPACE] }
+    end
+
+    context '#for :unexisting action' do
+      let(:action) { :unexisting }
+
+      it { expect { input }.to raise_error }
+    end
+  end
+end

data/spec/cupid_spec.rb

@@ -0,0 +1,8 @@
+describe Cupid do
+  subject { Cupid.new 'bob', 'x123', 42 }
+
+  its(:client)                { should be }
+  its('client.wsse.username') { should == 'bob' }
+  its('client.wsse.password') { should == 'x123' }
+  its('server.account')       { should == 42 }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'cupid'
+
+Savon.log = false
+HTTPI.log = false
+
+test_credentials = YAML.load_file('.test_account')
+Cupid::Test = Cupid.new *test_credentials
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -1,127 +1,131 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: cupid
-version: !ruby/object:Gem::Version 
-  hash: 31
+version: !ruby/object:Gem::Version
+  version: 0.3.2
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 4
-  version: 0.2.4
 platform: ruby
-authors: 
+authors:
 - gazay
+- brainopia
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-28 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: builder
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70340244020260 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 1
-        - 2
-        version: 2.1.2
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: nokogiri
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70340244020260
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70340244012760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 1
-        - 4
-        - 1
-        version: 1.4.1
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: savon
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70340244012760
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: &70340244012160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 59
-        segments: 
-        - 0
-        - 9
-        - 0
-        version: 0.9.0
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :runtime
-  version_requirements: *id003
-description: Send love, not war. This version of cupid can only work with ET SOAP API with s4.
-email: 
+  prerelease: false
+  version_requirements: *70340244012160
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70340244011580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: *70340244011580
+description: Send love, not war. This version of cupid works with ET SOAP API s4.
+email:
 - gazay@evilmartians.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- .gitignore
+- .rspec
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - cupid.gemspec
 - lib/cupid.rb
-- lib/cupid/configuration.rb
-- lib/cupid/methods.rb
-- lib/cupid/methods/email.rb
-- lib/cupid/methods/list.rb
-- lib/cupid/methods/subscriber.rb
-- lib/cupid/session.rb
+- lib/cupid/create.rb
+- lib/cupid/delete.rb
+- lib/cupid/gyoku.rb
+- lib/cupid/response.rb
+- lib/cupid/response/caster.rb
+- lib/cupid/response/data.rb
+- lib/cupid/response/data_folder.rb
+- lib/cupid/response/format.rb
+- lib/cupid/response/object.rb
+- lib/cupid/retrieve.rb
+- lib/cupid/schedule.rb
+- lib/cupid/server.rb
+- lib/cupid/update.rb
 - lib/cupid/version.rb
-- spec/cupid/cupid_spec.rb
-- tmp/dancing_with_ET.rb
-homepage: ""
+- spec/cupid/create_spec.rb
+- spec/cupid/delete_spec.rb
+- spec/cupid/response/caster_spec.rb
+- spec/cupid/response/data_spec.rb
+- spec/cupid/response/format_spec.rb
+- spec/cupid/response/object_spec.rb
+- spec/cupid/retrieve_spec.rb
+- spec/cupid/server_spec.rb
+- spec/cupid_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/evilmartians/cupid
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: cupid
-rubygems_version: 1.8.6
+rubyforge_project: 
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Create, organize and send emails through Exact Target SOAP API
-test_files: 
-- spec/cupid/cupid_spec.rb
+test_files:
+- spec/cupid/create_spec.rb
+- spec/cupid/delete_spec.rb
+- spec/cupid/response/caster_spec.rb
+- spec/cupid/response/data_spec.rb
+- spec/cupid/response/format_spec.rb
+- spec/cupid/response/object_spec.rb
+- spec/cupid/retrieve_spec.rb
+- spec/cupid/server_spec.rb
+- spec/cupid_spec.rb
+- spec/spec_helper.rb

data/Gemfile.lock

@@ -1,37 +0,0 @@
-PATH
-  remote: .
-  specs:
-    cupid (0.0.8)
-      builder (>= 2.1.2)
-      nokogiri (>= 1.4.1)
-      savon (>= 0.9.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    akami (1.0.0)
-      gyoku (>= 0.4.0)
-    builder (3.0.0)
-    gyoku (0.4.4)
-      builder (>= 2.1.2)
-    httpi (0.9.5)
-      rack
-    nokogiri (1.5.0)
-    nori (1.0.2)
-    rack (1.3.3)
-    savon (0.9.7)
-      akami (~> 1.0)
-      builder (>= 2.1.2)
-      gyoku (>= 0.4.0)
-      httpi (~> 0.9)
-      nokogiri (>= 1.4.0)
-      nori (~> 1.0)
-      wasabi (~> 2.0)
-    wasabi (2.0.0)
-      nokogiri (>= 1.4.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  cupid!

data/lib/cupid/configuration.rb

@@ -1,19 +0,0 @@
-require 'erb'
-require 'uri'
-require 'savon'
-require 'builder'
-require 'nokogiri'
-require 'cupid/session'
-
-include(ERB::Util)
-
-module Cupid
-  module Configuration
-    attr_accessor(
-      :username,
-      # :api_type, #now it's only soap s4. But i want MOAR
-      :password,
-      :account
-    )
-  end
-end

data/lib/cupid/methods.rb

@@ -1,3 +0,0 @@
-require("cupid/methods/email")
-require("cupid/methods/subscriber")
-require("cupid/methods/list")

data/lib/cupid/methods/email.rb

@@ -1,215 +0,0 @@
-module Cupid
-  class Session
-    def retrieve_email_folders(account=nil, properties=nil)
-      account ||= @account
-      properties ||= ['ID', 'Name', 'ParentFolder.ID', 'ParentFolder.Name']
-      filters = '<Filter xsi:type="SimpleFilterPart">' +
-                  '<Property>ContentType</Property>' +
-                  '<SimpleOperator>like</SimpleOperator>' +
-                  '<Value>email</Value>' +
-                '</Filter>'
-
-      soap_body = build_retrieve(account.to_s, 'DataFolder', properties, filters)
-      response = build_request('Retrieve', 'RetrieveRequestMsg', soap_body)
-      response = Nokogiri::XML(response.http.body).remove_namespaces!
-      all_folders = response.css('Results').map{|f| {f.css('Name').to_a.map(&:text).join('/') => f.css('ID')[0].text}}
-    end
-
-    def retrieve_email_copies(name, account=nil, properties=nil)
-      account ||= @account
-      properties ||= ['ID', 'Name']
-      filters = '<Filter xsi:type="SimpleFilterPart">' +
-                  '<Property>Name</Property>' +
-                  '<SimpleOperator>like</SimpleOperator>' +
-                  '<Value>' + name + '</Value>' +
-                '</Filter>'
-
-      soap_body = build_retrieve(account.to_s, 'Email', properties, filters)
-      response = build_request('Retrieve', 'RetrieveRequestMsg', soap_body)
-      response = Nokogiri::XML(response.http.body).remove_namespaces!
-      all_copies = response.css('Results').map{|f| {f.css('Name').to_a.map(&:text).join('/') => f.css('ID')[0].text}}
-    end
-
-    def retrieve_emails_from_folder(folder, account=nil, properties=nil)
-      account ||= @account
-      properties ||= ['ID', 'Name']
-      filters = '<Filter xsi:type="SimpleFilterPart">' +
-                  '<Property>CategoryID</Property>' +
-                  '<SimpleOperator>equals</SimpleOperator>' +
-                  '<Value>' + folder + '</Value>' +
-                '</Filter>'
-
-      soap_body = build_retrieve(account.to_s, 'Email', properties, filters)
-      response = build_request('Retrieve', 'RetrieveRequestMsg', soap_body)
-      response = Nokogiri::XML(response.http.body).remove_namespaces!
-      all_copies = response.css('Results').map{|f| {f.css('Name').to_a.map(&:text).join('/') => f.css('ID')[0].text}}
-    end
-
-    def create_email(subject, body, *args)
-      soap_body = prepare_email(subject, body, args)
-
-      response = build_request('Create', 'CreateRequest', soap_body)
-      response = Nokogiri::XML(response.http.body).remove_namespaces!
-      created_email_id = response.css('NewID').text
-    end
-
-    def create_folder(title, *args)
-      soap_body = prepare_folder(title, args)
-
-      response = build_request('Create', 'CreateRequest', soap_body)
-      response = Nokogiri::XML(response.http.body).remove_namespaces!
-      created_folder_id = response.css('NewID').text
-    end
-
-    def send_email_to_list(email_id, list_id, account=nil)
-      soap_body = prepare_send(email_id, list_id, account)
-
-      response = build_request('Create', 'CreateRequest', soap_body)
-      response = Nokogiri::XML(response.http.body).remove_namespaces!
-      created_send_id = response.css('NewID').text
-    end
-
-    def create_emails(subject_bodies, *args)
-      soap_body = ''
-      subject_bodies.each{ |subject, body| soap_body += prepare_email(subject, body, args) }
-
-      response = build_request('Create', 'CreateRequest', soap_body)
-      response = Nokogiri::XML(response.http.body).remove_namespaces!
-      response.css('Results').map{ |f| f.css('NewID').text }
-    end
-
-    def create_folders(titles, *args)
-      soap_body = titles.map{ |title| prepare_folder(title, args) }.join('')
-
-      response = build_request('Create', 'CreateRequest', soap_body)
-      response = Nokogiri::XML(response.http.body).remove_namespaces!
-      response.css('Results').map{ |f| f.css('NewID').text }
-    end
-
-    def send_emails_to_lists(emails_lists, account=nil)
-      soap_body = ''
-      emails_lists.each{ |email_id, list_id| soap_body += prepare_send(email_id, list_id, account) }
-
-      response = build_request('Create', 'CreateRequest', soap_body)
-      response = Nokogiri::XML(response.http.body).remove_namespaces!
-      response.css('Results').map{ |f| f.css('NewID').text }
-    end
-
-    def delete_email(email_id, account=nil)
-      soap_body = prepare_delete_email(email_id, account)
-
-      response = build_request('Delete', 'DeleteRequest', soap_body)
-      response = Nokogiri::XML(response.http.body).remove_namespaces!
-      response.css('Results').css('StatusCode').text == 'OK'
-    end
-
-    def delete_emails(emails, account=nil)
-      soap_body = emails.map{ |email_id| prepare_delete_email(email_id, account) }.join('')
-
-      response = build_request('Delete', 'DeleteRequest', soap_body)
-      response = Nokogiri::XML(response.http.body).remove_namespaces!
-      response.css('Results').map{ |f| f.css('StatusCode').text == 'OK' }
-    end
-
-    private
-
-    def prepare_email(subject, body, args)
-      options = args.extract_options!
-      options[:subject] = CGI.escapeHTML subject.to_s
-      options[:body] = CGI.escapeHTML body.to_s
-      options[:client_id] ||= @account
-
-      options[:email_type] ||= 'HTML'
-      options[:is_html_paste] ||= 'true' # ??
-      options[:character_set] ||= 'utf-8'
-
-      create_email_object(options)
-    end
-
-    def create_email_object(options)
-      email_object =   '<Objects xsi:type="Email"><ObjectID xsi:nil="true"/>'
-      email_object +=  '<Client><ID>' + options[:client_id].to_s + '</ID></Client>' if options[:client_id]
-      email_object +=  '<CategoryID>' + options[:category_id].to_s + '</CategoryID>' if options[:category_id]
-      email_object +=  '<Name>' + options[:name].to_s + '</Name>' if options[:name]
-      email_object +=  '<Description>' + options[:description].to_s + '</Description>' if options[:description]
-      email_object +=  '<Subject>' + options[:subject] + '</Subject>' +
-                       '<HTMLBody>' + options[:body] + '</HTMLBody>' +
-                       '<EmailType>' + options[:email_type] + '</EmailType>' +
-                       '<IsHTMLPaste>' + options[:is_html_paste] + '</IsHTMLPaste>' +
-                       '<CharacterSet>' + options[:character_set] + '</CharacterSet></Objects>'
-    end
-
-    def prepare_folder(title, args)
-      options = args.extract_options!
-      options[:title] = CGI.escapeHTML title.to_s
-      options[:description] ||= 'description'
-      options[:client_id] ||= @account
-
-      options[:content_type] ||= 'email'
-      options[:is_active] ||= 'true'
-      options[:is_editable] ||= 'true'
-      options[:allow_children] ||= 'true'
-
-      create_folder_object(options)
-    end
-
-    def create_folder_object(options)
-      folder_object =   '<Objects xsi:type="DataFolder"><ObjectID xsi:nil="true"/>'
-      folder_object +=  '<Client><ID>' + options[:client_id].to_s + '</ID></Client>' if options[:client_id]
-      folder_object +=  '<CustomerKey>' + options[:title].to_s + '</CustomerKey>' if options[:title]
-      folder_object +=  '<Name>' + options[:title].to_s + '</Name>' +
-                        '<Description>' + options[:description].to_s + '</Description>' +
-                        '<ContentType>' + options[:content_type].to_s + '</ContentType>' +
-                        '<IsActive>' + options[:is_active].to_s + '</IsActive>' +
-                        '<IsEditable>' + options[:is_editable].to_s + '</IsEditable>' +
-                        '<AllowChildren>' + options[:allow_children].to_s + '</AllowChildren>'
-
-      if options[:parent]
-        folder_object +=  '<ParentFolder>
-                              <PartnerKey xsi:nil="true"/>
-                              <ModifiedDate xsi:nil="true"/>
-                              <ID>' + options[:parent].to_s + '</ID>
-                              <ObjectID xsi:nil="true"/>
-                           </ParentFolder>'
-      end
-      folder_object += '</Objects>'
-    end
-
-    def prepare_send(email_id, list_id, account=nil)
-      account ||= @account
-      create_send_object(email_id, list_id, account)
-    end
-
-    def create_send_object(email_id, list_id, account)
-      '<Objects xsi:type="Send"><PartnerKey xsi:nil="true"/>' +
-       '<ObjectID xsi:nil="true"/>' +
-       '<Client><ID>' + account.to_s + '</ID></Client>' +
-       '<Email>' +
-         '<PartnerKey xsi:nil="true"/>' +
-         '<ID>' + email_id.to_s + '</ID>' +
-         '<ObjectID xsi:nil="true"/>' +
-       '</Email>' +
-       '<List>' +
-         '<PartnerKey xsi:nil="true"/>' +
-         '<ObjectID xsi:nil="true"/>' +
-         '<ID>' + list_id.to_s + '</ID>' +
-       '</List>' +
-      '</Objects>'
-    end
-
-    def prepare_delete_email(email_id, account=nil)
-      account ||= @account
-      create_delete_email_object(email_id, account)
-    end
-
-    def create_delete_email_object(email_id, account)
-      '<Objects xsi:type="Email">' +
-        '<Client>' +
-          '<ID>' + account.to_s + '</ID>' +
-        '</Client>' +
-        '<ID>' + email_id.to_s + '</ID>' +
-        '<ObjectID xsi:nil="true"/>' +
-      '</Objects>'
-    end
-  end
-end