emarsys 0.1.0 → 0.2.0

data/lib/emarsys/data_objects/email_category.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Emarsys
 
   # Methods for the EmailCategory API
@@ -17,4 +18,4 @@ module Emarsys
 
     end
   end
-end
+end

data/lib/emarsys/data_objects/email_launch_status.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Emarsys
 
   # Internal helper class for valid email launch status.
@@ -35,4 +36,4 @@ module Emarsys
     end
 
   end
-end
+end

data/lib/emarsys/data_objects/email_status_code.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Emarsys
 
   # Internal helper class for valid email status codes.
@@ -36,4 +37,4 @@ module Emarsys
     end
 
   end
-end
+end

data/lib/emarsys/data_objects/event.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Emarsys
 
   # Methods for the Event API
@@ -33,6 +34,22 @@ module Emarsys
         post "event/#{event_id}/trigger", params
       end
 
+      # Trigger an external event for multiple contacts
+      #
+      # @param event_id [Integer, String] The internal emarsys id
+      # @param key_id [Integer, String] The identifer of the key field (e.g. 3 for 'email')
+      # @param contacts [Array, Hash] An array with hashes containing the contacts and optional data per contact
+      # @return [Hash] Result data
+      # @example
+      #   Emarsys::Event.trigger_multiple(2, 3, [{:external_id => "test@example.com"},{:external_id => "test2@example.com", :data => {:name => "Special Name"}}])
+      def trigger_multiple(event_id, key_id, contacts)
+        external_id = ""
+        transformed_key_id = transform_key_id(key_id)
+        params = {:key_id => transformed_key_id, :external_id => external_id, :data => nil}
+        params.merge!(:contacts => contacts)
+        post "event/#{event_id}/trigger", params
+      end
+
       # @private
       def transform_key_id(key_id)
         matching_attributes = Emarsys::FieldMapping::ATTRIBUTES.find{|elem| elem[:identifier] == key_id.to_s}
@@ -41,4 +58,4 @@ module Emarsys
     end
 
   end
-end
+end

data/lib/emarsys/data_objects/export.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Emarsys
 
   # Methods for the Export API
@@ -19,4 +20,4 @@ module Emarsys
 
   end
 
-end
+end

data/lib/emarsys/data_objects/field.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Emarsys
 
   # Methods for the Field API
@@ -36,4 +37,4 @@ module Emarsys
 
   end
 
-end
+end

data/lib/emarsys/data_objects/file.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Emarsys
 
   # Methods for the File API
@@ -36,4 +37,4 @@ module Emarsys
 
   end
 
-end
+end

data/lib/emarsys/data_objects/folder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Emarsys
 
   # Methods for the Folder API
@@ -21,4 +22,4 @@ module Emarsys
 
   end
 
-end
+end

data/lib/emarsys/data_objects/form.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Emarsys
 
   # Methods for the Form API
@@ -18,4 +19,4 @@ module Emarsys
     end
   end
 
-end
+end

data/lib/emarsys/data_objects/language.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Emarsys
 
   # Methods for the Lanugage API
@@ -17,4 +18,4 @@ module Emarsys
 
     end
   end
-end
+end

data/lib/emarsys/data_objects/segment.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Emarsys
 
   # Methods for the Segment API
@@ -18,4 +19,4 @@ module Emarsys
     end
   end
 
-end
+end

data/lib/emarsys/data_objects/source.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Emarsys
 
   # Methods for the Source API
@@ -37,4 +38,4 @@ module Emarsys
 
     end
   end
-end
+end

data/lib/emarsys/error.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Emarsys
   # Custom error class for rescuing from Emarsys errors
   class Error < StandardError
@@ -21,4 +22,4 @@ module Emarsys
 
   # Raised when Emarsys returns a 500 HTTP status code
   class InternalServerError < Error; end
-end
+end

data/lib/emarsys/extensions.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Hash
   def stringify_keys
     inject({}) do |options, (key, value)|
@@ -5,4 +6,4 @@ class Hash
       options
     end
   end
-end
+end

data/lib/emarsys/field_mapping.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Emarsys::FieldMapping
 
   ATTRIBUTES = [
@@ -52,4 +53,4 @@ module Emarsys::FieldMapping
     {:id => 48,  :identifier => '_date_of_first_registration', :name => 'Date of first registration'}
   ]
 
-end
+end

data/lib/emarsys/params_converter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Emarsys
   class ParamsConverter
 
@@ -26,4 +27,4 @@ module Emarsys
     end
 
   end
-end
+end

data/lib/emarsys/request.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Emarsys
 
   class Request
@@ -43,4 +44,4 @@ module Emarsys
     end
   end
 
-end
+end

data/lib/emarsys/response.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Emarsys
   class Response
     attr_accessor :code, :text, :data, :status
@@ -21,4 +22,4 @@ module Emarsys
     end
 
   end
-end
+end

data/lib/emarsys/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Emarsys
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/emarsys.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
 require "base64"
 require 'json'
 require 'rest_client'
 require 'uri'
 
 require 'emarsys/client'
+require 'emarsys/country'
 require 'emarsys/data_object'
 require 'emarsys/error'
 require 'emarsys/extensions'
@@ -36,7 +38,7 @@ module Emarsys
   class << self
 
     # @!attribute api_endpoint
-    #   @return [String] Base URL for emarsys URLs. default: https://suite5.emarsys.net/api/v2
+    #   @return [String] Base URL for emarsys URLs. default: https://api.emarsys.net/api/v2
     # @!attribute api_password
     #   @return [String] API Username given by Emarsys
     # @!attribute api_username
@@ -48,7 +50,7 @@ module Emarsys
     #
     # @return [String] domain which should be used to query the API
     def api_endpoint
-      @api_endpoint ||= 'https://suite5.emarsys.net/api/v2'
+      @api_endpoint ||= 'https://api.emarsys.net/api/v2'
     end
 
     # Set configuration options using a block
@@ -57,4 +59,4 @@ module Emarsys
     end
 
   end
-end
+end

data/spec/emarsys/client_spec.rb

@@ -4,22 +4,22 @@ describe Emarsys::Client do
 
   describe 'configs for username and password' do
     it 'inherits username from module' do
-      Emarsys.stub(:api_username).and_return("my_username")
+      allow(Emarsys).to receive(:api_username).and_return("my_username")
       expect(Emarsys::Client.new.username).to eq("my_username")
     end
 
     it 'inherits password from module' do
-      Emarsys.stub(:api_password).and_return("my_password")
+      allow(Emarsys).to receive(:api_password).and_return("my_password")
       expect(Emarsys::Client.new.password).to eq("my_password")
     end
 
     it 'raises error if api_username is not set' do
-      Emarsys.stub(:api_username).and_return(nil)
+      allow(Emarsys).to receive(:api_username).and_return(nil)
       expect{Emarsys::Client.new.username}.to raise_error(ArgumentError, 'Emarsys.api_username is not set')
     end
 
     it 'raises error if api_password is not set' do
-      Emarsys.stub(:api_password).and_return(nil)
+      allow(Emarsys).to receive(:api_password).and_return(nil)
       expect{Emarsys::Client.new.password}.to raise_error(ArgumentError, 'Emarsys.api_password is not set')
     end
   end
@@ -27,54 +27,56 @@ describe Emarsys::Client do
   context 'client authentication' do
     describe '#x_wsse_string' do
       it 'builds x_wsse_string with specific format' do
-        Emarsys::Client.any_instance.stub(:username).and_return("my_username")
-        Emarsys::Client.any_instance.stub(:header_password_digest).and_return("12345689")
-        Emarsys::Client.any_instance.stub(:header_nonce).and_return("some_header_nonce")
-        Emarsys::Client.any_instance.stub(:header_created).and_return("2013-01-01")
+        allow_any_instance_of(Emarsys::Client).to receive(:username).and_return("my_username")
+        allow_any_instance_of(Emarsys::Client).to receive(:header_password_digest).and_return("12345689")
+        allow_any_instance_of(Emarsys::Client).to receive(:header_nonce).and_return("some_header_nonce")
+        allow_any_instance_of(Emarsys::Client).to receive(:header_created).and_return("2013-01-01")
         expect(Emarsys::Client.new.x_wsse_string).to eq(
-          'UsernameToken Username = "my_username", PasswordDigest = "12345689", Nonce = "some_header_nonce", Created = "2013-01-01"'
+          'UsernameToken Username="my_username", PasswordDigest="12345689", Nonce="some_header_nonce", Created="2013-01-01"'
         )
       end
     end
 
     describe '#header_password_digest' do
       before :each do
-        Emarsys::Client.any_instance.stub(:calculated_digest).and_return("something")
+        allow_any_instance_of(Emarsys::Client).to receive(:calculated_digest).and_return("something")
       end
 
       it 'encodes string with Base64' do
-        Base64.should_receive(:encode64).with("something").and_return("something_base64_encoded")
+        expect(Base64).to receive(:encode64).with("something").and_return("something_base64_encoded")
         Emarsys::Client.new.header_password_digest
       end
 
       it 'strips of \n character' do
-        Base64.should_receive(:encode64).with("something").and_return("something_base64_encoded\n")
+        expect(Base64).to receive(:encode64).with("something").and_return("something_base64_encoded\n")
         expect(Emarsys::Client.new.header_password_digest).to eq("something_base64_encoded")
       end
     end
 
     describe '#header_nonce' do
-      it 'uses md5 hash auf current time (as integer)' do
-        Time.any_instance.stub(:to_i).and_return(123456789)
-        Digest::MD5.should_receive(:hexdigest).with("123456789").and_return("25f9e794323b453885f5181f1b624d0b")
-        Emarsys::Client.new.header_nonce
+      it 'uses 16 random bytes to generate a 32 char hex string' do
+        expect(Emarsys::Client.new.header_nonce).to match(/^[0-9a-f]{32}$/i)
+      end
+
+      it 'only creates the nonce once' do
+        client = Emarsys::Client.new
+        nonce = client.header_nonce
+        expect(client.header_nonce).to eq nonce
       end
     end
 
     describe '#header_created' do
       it 'uses current timestamp format' do
-        time = Time.parse("2013-01-01 01:00:01")
-        Time.stub(:new).and_return(time)
-        expect(Emarsys::Client.new.header_created).to eq("2013-01-01 01:00:01")
+        expect(Emarsys::Client.new.header_created).to eq(Time.now.utc.iso8601)
       end
     end
 
     describe '#calculated_digest' do
       it 'runs sha1 on header_nonce + header_created + password' do
-        Emarsys::Client.any_instance.stub(:header_nonce).and_return("some_header_nonce")
-        Emarsys::Client.any_instance.stub(:header_created).and_return("12345689")
-        Emarsys::Client.any_instance.stub(:password).and_return("my_password")
-        Digest::SHA1.should_receive(:hexdigest).with("some_header_nonce12345689my_password")
+        allow_any_instance_of(Emarsys::Client).to receive(:header_nonce).and_return("some_header_nonce")
+        allow_any_instance_of(Emarsys::Client).to receive(:header_created).and_return("12345689")
+        allow_any_instance_of(Emarsys::Client).to receive(:password).and_return("my_password")
+        expect(Digest::SHA1).to receive(:hexdigest).with("some_header_nonce12345689my_password")
         Emarsys::Client.new.calculated_digest
       end
     end
@@ -82,4 +84,3 @@ describe Emarsys::Client do
   end
 
 end
-

data/spec/emarsys/country_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Emarsys::Country do
+
+  describe 'from_iso' do
+    it 'maps ISO-3166-1 alpha-2 country code to equivalent Emarsys internal country ID' do
+      expect(Emarsys::Country.from_iso('AF')).to eq( { id: 1, name: 'Afghanistan'} )
+    end
+
+    it 'supports passing ISO country code as a symbol' do
+      expect(Emarsys::Country.from_iso(:AF)).to eq( { id: 1, name: 'Afghanistan'} )
+    end
+
+    it 'ignores case of the ISO country code' do
+      expect(Emarsys::Country.from_iso('aF')).to eq( { id: 1, name: 'Afghanistan'} )
+    end
+
+    it 'returns nil for an unknown/invalid code' do
+      expect(Emarsys::Country.from_iso('XY')).to eq nil
+    end
+  end
+end

data/spec/emarsys/data_object_spec.rb

@@ -5,33 +5,33 @@ describe Emarsys::DataObject 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)
+        allow_any_instance_of(Emarsys::DataObject).to 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)
+        allow_any_instance_of(Emarsys::DataObject).to 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)
+        allow_any_instance_of(Emarsys::DataObject).to 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)
+        allow_any_instance_of(Emarsys::DataObject).to 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)
+        allow_any_instance_of(Emarsys::DataObject).to receive(:request).with('delete', 'test_method', {}).and_return(nil)
         Emarsys::DataObject.delete('test_method', {})
       end
     end
@@ -39,7 +39,12 @@ describe Emarsys::DataObject do
     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")
+        expect(Emarsys::DataObject.parameterize_params(params)).to eq("?a=1&b=2&c=3")
+      end
+
+      it "url_encodes params" do
+        params = {"email" => "best/email@mail.org"}
+        expect(Emarsys::DataObject.parameterize_params(params)).to eq("?email=best%2Femail%40mail.org")
       end
     end
   end
@@ -47,9 +52,9 @@ describe Emarsys::DataObject do
   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)
+    it "provides a simple #request that delegates to Emarsys::Request" do
+      allow_any_instance_of(Emarsys::Request).to receive(:send_request).and_return(nil)
       data_object.request('get', 'test_method', {})
     end
   end
-end
+end

data/spec/emarsys/data_objects/condition_spec.rb

@@ -3,7 +3,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
+      expect(
+        stub_get("condition") { Emarsys::Condition.collection }
+      ).to have_been_requested.once
     end
   end
-end
+end

data/spec/emarsys/data_objects/contact_list_spec.rb

@@ -3,7 +3,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
+      expect(
+        stub_get("contactlist") { Emarsys::ContactList.collection }
+      ).to have_been_requested.once
     end
   end
-end
+end

data/spec/emarsys/data_objects/contact_spec.rb

@@ -4,70 +4,70 @@ 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)
+      stub = stub_request(:post, "https://api.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
+      expect(stub).to 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)
+      stub = stub_request(:get, "https://api.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
+      expect(stub).to 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)
+      stub = stub_request(:put, "https://api.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
+      expect(stub).to 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)
+      stub = stub_request(:post, "https://api.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
+      expect(stub).to 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)
+      stub = stub_request(:put, "https://api.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
+      expect(stub).to 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)
+      stub = stub_request(:post, "https://api.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
+      expect(stub).to 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)
+      stub = stub_request(:post, "https://api.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
+      expect(stub).to 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)
+      stub = stub_request(:post, "https://api.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
+      expect(stub).to have_been_requested.once
     end
   end
 
@@ -76,4 +76,4 @@ describe Emarsys::Contact do
   def contact_history(contact_ids_array)
     post "contact/getcontacthistory", {'contacts' => contact_ids_array}
   end
-end
+end

data/spec/emarsys/data_objects/email_category_spec.rb

@@ -3,7 +3,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
+      expect(
+        stub_get("emailcategory") { Emarsys::EmailCategory.collection }
+      ).to have_been_requested.once
     end
   end
-end
+end