emarsys 0.1.0

data/spec/emarsys/data_object_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Emarsys::DataObject do
+  context "as a class" do
+
+    describe '.get' do
+      it "delegates to the instance request method" do
+        Emarsys::DataObject.any_instance.should_receive(:request).with('get', 'test_method', {}).and_return(nil)
+        Emarsys::DataObject.get('test_method', {})
+      end
+
+      it "transfers params to specific emarsys params format" do
+        Emarsys::DataObject.any_instance.should_receive(:request).with('get', 'test_method/a=1&b=2', {}).and_return(nil)
+        Emarsys::DataObject.get('test_method', {'a' => 1, 'b' => 2})
+      end
+    end
+
+    describe '.post' do
+      it "delegates to the instance request method" do
+        Emarsys::DataObject.any_instance.should_receive(:request).with('post', 'test_method', {}).and_return(nil)
+        Emarsys::DataObject.post('test_method', {})
+      end
+    end
+
+    describe '.put' do
+      it "delegates to the instance request method" do
+        Emarsys::DataObject.any_instance.should_receive(:request).with('put', 'test_method', {}).and_return(nil)
+        Emarsys::DataObject.put('test_method', {})
+      end
+    end
+
+    describe '.delete' do
+      it "delegates to the instance request method" do
+        Emarsys::DataObject.any_instance.should_receive(:request).with('delete', 'test_method', {}).and_return(nil)
+        Emarsys::DataObject.delete('test_method', {})
+      end
+    end
+
+    describe '.parameterize_params' do
+      it "converts hash to params string" do
+        params = {"a" => 1, "b" => 2, "c" => 3}
+        expect(Emarsys::DataObject.parameterize_params(params)).to eq("a=1&b=2&c=3")
+      end
+    end
+  end
+
+  context "as an instance" do
+    let(:data_object) { Emarsys::DataObject.new }
+
+    it "provides a simpel #request that delegates to Emarsys::Request" do
+      Emarsys::Request.any_instance.should_receive(:send_request).and_return(nil)
+      data_object.request('get', 'test_method', {})
+    end
+  end
+end

data/spec/emarsys/data_objects/condition_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Emarsys::Condition do
+  describe ".collection" do
+    it "requests all conditions" do
+      stub_get("condition") { Emarsys::Condition.collection }.should have_been_requested.once
+    end
+  end
+end

data/spec/emarsys/data_objects/contact_list_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Emarsys::ContactList do
+  describe ".collection" do
+    it "requests all contactlists" do
+      stub_get("contactlist") { Emarsys::ContactList.collection }.should have_been_requested.once
+    end
+  end
+end

data/spec/emarsys/data_objects/contact_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Emarsys::Contact do
+  describe ".create" do
+    it "requests contact creation with parameters" do
+      stub_params = {1 => 'John', 2 => "Doe"}
+      stub = stub_request(:post, "https://suite5.emarsys.net/api/v2/contact").with(:body => stub_params.merge!({'key_id' => 3, 3 => 'john.doe@example.com'}).to_json).to_return(standard_return_body)
+      Emarsys::Contact.create(3, "john.doe@example.com", stub_params)
+      stub.should have_been_requested.once
+    end
+  end
+
+  describe ".emarsys_id" do
+    it "requests emarsys_id of a contact" do
+      stub = stub_request(:get, "https://suite5.emarsys.net/api/v2/contact/3=jane.doe@example.com").to_return(standard_return_body)
+      Emarsys::Contact.emarsys_id(3, 'jane.doe@example.com')
+      stub.should have_been_requested.once
+    end
+  end
+
+  describe ".update" do
+    it "requests contact update with parameters" do
+      stub_params = {1 => 'Jane', 2 => "Doe"}
+      stub = stub_request(:put, "https://suite5.emarsys.net/api/v2/contact").with(:body => stub_params.merge!({'key_id' => 3, 3 => 'jane.doe@example.com'}).to_json).to_return(standard_return_body)
+      Emarsys::Contact.update(3, 'jane.doe@example.com', stub_params)
+      stub.should have_been_requested.once
+    end
+  end
+
+  describe ".create_batch" do
+    it "requests contact batch creation with parameters" do
+      stub_params = [{1 => 'Jane', 2 => "Doe"}, {1 => 'Paul', 2 => 'Tester'}]
+      stub = stub_request(:post, "https://suite5.emarsys.net/api/v2/contact").with(:body => {'key_id' => 3, 'contacts' => stub_params}.to_json).to_return(standard_return_body)
+      Emarsys::Contact.create_batch(3, stub_params)
+      stub.should have_been_requested.once
+    end
+  end
+
+  describe ".update_batch" do
+    it "requests contact batch update with parameters" do
+      stub_params = [{1 => 'Jane', 2 => "Doe"}, {1 => 'Paul', 2 => 'Tester'}]
+      stub = stub_request(:put, "https://suite5.emarsys.net/api/v2/contact").with(:body => {'key_id' => 3, 'contacts' => stub_params}.to_json).to_return(standard_return_body)
+      Emarsys::Contact.update_batch(3, stub_params)
+      stub.should have_been_requested.once
+    end
+  end
+
+  describe ".contact_history" do
+    it "requests contact histories" do
+      stub_params = [1,2,3]
+      stub = stub_request(:post, "https://suite5.emarsys.net/api/v2/contact/getcontacthistory").with(:body => {'contacts' => stub_params}.to_json).to_return(standard_return_body)
+      Emarsys::Contact.contact_history(stub_params)
+      stub.should have_been_requested.once
+    end
+  end
+
+  describe ".search" do
+    it "requests contact data based on search params" do
+      stub = stub_request(:post, "https://suite5.emarsys.net/api/v2/contact/getdata").with(:body => {'keyId' => '3', 'keyValues' => ['jane.doe@example.com'], 'fields' => []}.to_json).to_return(standard_return_body)
+      Emarsys::Contact.search('3', ['jane.doe@example.com'])
+      stub.should have_been_requested.once
+    end
+  end
+
+  describe ".export_registrations" do
+    it "requests contact data export based on parameters" do
+      stub_params = {distribution_method: 'local', time_range: ["2013-01-01","2013-12-31"], contact_fields: [1,2,3]}
+      stub = stub_request(:post, "https://suite5.emarsys.net/api/v2/contact/getregistrations").with(:body => stub_params.to_json).to_return(standard_return_body)
+      Emarsys::Contact.export_registrations(stub_params)
+      stub.should have_been_requested.once
+    end
+  end
+
+
+
+  def contact_history(contact_ids_array)
+    post "contact/getcontacthistory", {'contacts' => contact_ids_array}
+  end
+end

data/spec/emarsys/data_objects/email_category_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Emarsys::EmailCategory do
+  describe ".collection" do
+    it "requests all email_categories" do
+      stub_get("emailcategory") { Emarsys::EmailCategory.collection }.should have_been_requested.once
+    end
+  end
+end

data/spec/emarsys/data_objects/email_launch_status_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Emarsys::EmailLaunchStatus do
+  describe "CODES constant" do
+    it "is an array of size 4" do
+      expect(Emarsys::EmailLaunchStatus::CODES.size).to eq(4)
+    end
+  end
+
+  describe ".collection" do
+    it "requests all email_launch_status" do
+      expect(Emarsys::EmailLaunchStatus.collection).to eq(Emarsys::EmailLaunchStatus::CODES)
+    end
+  end
+
+  describe ".resource" do
+    it "requests a single email launch status" do
+      expect(Emarsys::EmailLaunchStatus.resource(0)).to eq({'0'   => 'Not launched'})
+    end
+
+    it "returns nil if it cannot find a launch code" do
+      expect(Emarsys::EmailLaunchStatus.resource(100)).to eq(nil)
+    end
+  end
+end

data/spec/emarsys/data_objects/email_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Emarsys::Email do
+  describe ".collection" do
+    it "requests all emails" do
+      stub_get('email') { Emarsys::Email.collection }.should have_been_requested.once
+    end
+
+    it "requests all emails to the given status parameter" do
+      stub_get('email/status=3') { Emarsys::Email.collection({:status => 3}) }.should have_been_requested.once
+    end
+
+    it "requests all emails to the given contactlist parameter" do
+      stub_get('email/contactlist=123') { Emarsys::Email.collection({:contactlist => 123}) }.should have_been_requested.once
+    end
+
+    it "requests all emails - even with combined parameters" do
+      stub_get('email/status=3&contactlist=123') { Emarsys::Email.collection({:status => 3, :contactlist => 123}) }.should have_been_requested.once
+    end
+  end
+
+  describe ".resource" do
+    it "requests a single email" do
+      stub_get('email/123') { Emarsys::Email.resource(123) }.should have_been_requested.once
+    end
+  end
+
+  describe ".create" do
+    it "requests email creation" do
+      stub = stub_request(:post, "https://suite5.emarsys.net/api/v2/email").to_return(standard_return_body)
+      Emarsys::Email.create
+      stub.should have_been_requested.once
+    end
+
+    it "requests email creation with parameters" do
+      stub_params = {:language => 'de', :name => "Something"}
+      stub = stub_request(:post, "https://suite5.emarsys.net/api/v2/email").with(:body => stub_params.to_json).to_return(standard_return_body)
+      Emarsys::Email.create(stub_params)
+      stub.should have_been_requested.once
+    end
+  end
+
+  describe ".launch" do
+    it "requests an email launch" do
+      stub = stub_request(:post, "https://suite5.emarsys.net/api/v2/email/123/launch").to_return(standard_return_body)
+      Emarsys::Email.launch(123)
+      stub.should have_been_requested.once
+    end
+
+    it "requests an email launch with parameters" do
+      stub_params = {:schedule => "2013-12-01 23:00:00", :time_zone => "Europe/Berlin"}
+      stub = stub_request(:post, "https://suite5.emarsys.net/api/v2/email/123/launch").with(:body => stub_params.to_json).to_return(standard_return_body)
+      Emarsys::Email.launch(123, stub_params)
+      stub.should have_been_requested.once
+    end
+  end
+
+  describe ".preview" do
+    it "requests an email preview" do
+      stub_params = {:version => 'html'}
+      stub = stub_request(:post, "https://suite5.emarsys.net/api/v2/email/123/preview").with(:body => stub_params.to_json).to_return(standard_return_body)
+      Emarsys::Email.preview(123, 'html')
+      stub.should have_been_requested.once
+    end
+  end
+
+  describe ".send_test_mail" do
+    it "requests an email test sending with custom recipient list" do
+      stub_params = {:recipientlist => 'john.doe@example.com;jane.doe@example.com'}
+      stub = stub_request(:post, "https://suite5.emarsys.net/api/v2/email/123/sendtestmail").with(:body => stub_params.to_json).to_return(standard_return_body)
+      Emarsys::Email.send_test_mail(123, stub_params)
+      stub.should have_been_requested.once
+    end
+  end
+
+  describe ".response_summary" do
+    it "requests a single email" do
+      stub_get('email/123/responsesummary') { Emarsys::Email.response_summary(123) }.should have_been_requested.once
+    end
+  end
+
+
+
+end

data/spec/emarsys/data_objects/email_status_code_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Emarsys::EmailStatusCode do
+  describe "CODES constant" do
+    it "is an array of size 5" do
+      expect(Emarsys::EmailStatusCode::CODES.size).to eq(5)
+    end
+  end
+
+  describe ".collection" do
+    it "requests all email_status_codes" do
+      expect(Emarsys::EmailStatusCode.collection).to eq(Emarsys::EmailStatusCode::CODES)
+    end
+  end
+
+  describe ".resource" do
+    it "requests a single email status code hash" do
+      expect(Emarsys::EmailStatusCode.resource(1)).to eq({'1'   => 'In design'})
+    end
+
+    it "returns nil if it cannot find a status code" do
+      expect(Emarsys::EmailStatusCode.resource(100)).to eq(nil)
+    end
+  end
+end

data/spec/emarsys/data_objects/event_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Emarsys::Event do
+  describe ".collection" do
+    it "requests all events" do
+      stub_get("event") { Emarsys::Event.collection }.should have_been_requested.once
+    end
+  end
+
+  describe ".trigger" do
+    it "requests event trigger with parameters" do
+      stub = stub_request(:post, "https://suite5.emarsys.net/api/v2/event/123/trigger").with(:body => {'key_id' => 3, 'external_id' => "jane.doe@example.com"}.to_json).to_return(standard_return_body)
+      Emarsys::Event.trigger(123, 3, 'jane.doe@example.com')
+      stub.should have_been_requested.once
+    end
+
+    it "requests event trigger with additional data parameters" do
+      stub = stub_request(:post, "https://suite5.emarsys.net/api/v2/event/123/trigger").with(:body => {'key_id' => 3, 'external_id' => "jane.doe@example.com", :data => {'global' => {'my_placeholder' => 'Something'}}}.to_json).to_return(standard_return_body)
+      Emarsys::Event.trigger(123, 3, 'jane.doe@example.com', {'global' => {'my_placeholder' => 'Something'}})
+      stub.should have_been_requested.once
+    end
+  end
+end

data/spec/emarsys/data_objects/export_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Emarsys::Export do
+  describe ".resource" do
+    it "requests a single export" do
+      stub_get('export/123') { Emarsys::Export.resource(123) }.should have_been_requested.once
+    end
+  end
+end

data/spec/emarsys/data_objects/field_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Emarsys::Field do
+  describe ".collection" do
+    it "requests all fields" do
+      stub_get("field") { Emarsys::Field.collection }.should have_been_requested.once
+    end
+
+    it "requests all fields with translate parameter" do
+      stub_get("field/translate/en") { Emarsys::Field.collection('translate' => 'en') }.should have_been_requested.once
+    end
+  end
+
+  describe ".choice" do
+    it "requests the choice options of a field" do
+      stub_get("field/1/choice") { Emarsys::Field.choice(1) }.should have_been_requested.once
+    end
+  end
+end

data/spec/emarsys/data_objects/file_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Emarsys::File do
+  describe ".collection" do
+    it "requests all files" do
+      stub_get("file") { Emarsys::File.collection }.should have_been_requested.once
+    end
+
+    it "requests all files with parameter" do
+      stub_get("file/folder=3") { Emarsys::File.collection(:folder => 3) }.should have_been_requested.once
+    end
+  end
+
+  describe ".create" do
+    it "requests file creation with parameters" do
+      stub_params = {:filename => 'my_file.jpg', :file => 'base_64_encoded_string'}
+      stub = stub_request(:post, "https://suite5.emarsys.net/api/v2/file").with(:body => stub_params.to_json).to_return(standard_return_body)
+      Emarsys::File.create('my_file.jpg', 'base_64_encoded_string')
+      stub.should have_been_requested.once
+    end
+
+    it "requests file creation with optional folder parameter" do
+      stub_params = {:filename => 'my_file.jpg', :file => 'base_64_encoded_string', :folder => 3}
+      stub = stub_request(:post, "https://suite5.emarsys.net/api/v2/file").with(:body => stub_params.to_json).to_return(standard_return_body)
+      Emarsys::File.create('my_file.jpg', 'base_64_encoded_string', 3)
+      stub.should have_been_requested.once
+    end
+  end
+end

data/spec/emarsys/data_objects/folder_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Emarsys::Folder do
+  describe ".collection" do
+    it "requests all folders" do
+      stub_get("folder") { Emarsys::Folder.collection }.should have_been_requested.once
+    end
+
+    it "requests all folders with parameters" do
+      stub_get("folder/folder=3") { Emarsys::Folder.collection(:folder => 3) }.should have_been_requested.once
+    end
+  end
+end

data/spec/emarsys/data_objects/form_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Emarsys::Form do
+  describe ".collection" do
+    it "requests all languages" do
+      stub_get("form") { Emarsys::Form.collection }.should have_been_requested.once
+    end
+  end
+end

data/spec/emarsys/data_objects/language_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Emarsys::Language do
+  describe ".collection" do
+    it "requests all languages" do
+      stub_get("language") { Emarsys::Language.collection }.should have_been_requested.once
+    end
+  end
+end

data/spec/emarsys/data_objects/segment_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Emarsys::Segment do
+  describe ".collection" do
+    it "requests all segments" do
+      stub_get("filter") { Emarsys::Segment.collection }.should have_been_requested.once
+    end
+  end
+end

data/spec/emarsys/data_objects/source_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Emarsys::Source do
+  describe ".collection" do
+    it "requests all sources" do
+      stub_get("source") { Emarsys::Source.collection }.should have_been_requested.once
+    end
+  end
+
+  describe ".create" do
+    it "requests source creation with parameters" do
+      stub = stub_request(:post, "https://suite5.emarsys.net/api/v2/source/create").with(:body => {:name => 'test_source'}.to_json).to_return(standard_return_body)
+      Emarsys::Source.create('test_source')
+      stub.should have_been_requested.once
+    end
+  end
+
+  describe ".delete" do
+    it "requests source deletion" do
+      stub = stub_request(:delete, "https://suite5.emarsys.net/api/v2/source/123").to_return(standard_return_body)
+      Emarsys::Source.destroy(123)
+      stub.should have_been_requested.once
+    end
+  end
+end