emarsys 0.1.0

data/lib/emarsys/data_objects/export.rb

@@ -0,0 +1,22 @@
+module Emarsys
+
+  # Methods for the Export API
+  #
+  #
+  class Export < DataObject
+    class << self
+
+      # Find a specific export
+      #
+      # @param id [Integer, String] The internal emarsys id
+      # @return [Hash] Result data
+      # @example
+      #   Emarsys::Export.resource(2)
+      def resource(id)
+        get "export/#{id}", {}
+      end
+    end
+
+  end
+
+end

data/lib/emarsys/data_objects/field.rb

@@ -0,0 +1,39 @@
+module Emarsys
+
+  # Methods for the Field API
+  #
+  #
+  class Field < DataObject
+    class << self
+
+      # List data fields
+      #
+      # @param params [Hash] optional translation params
+      # @option params [Integer, String] :translate translate to another language
+      # @return [Hash] List of fields
+      # @example
+      #   Emarsys::Field.collection
+      #   Emarsys::Field.collection(:translate => 'en')
+      def collection(params = {})
+        params = params.stringify_keys
+        if params['translate']
+          get "field/translate/#{params['translate'].to_s}", {}
+        else
+          get 'field', {}
+        end
+      end
+
+      # Query the choice option for a specific field
+      #
+      # @param id [Integer, String] id of the field
+      # @return [Hash] Result Data
+      # @example
+      #   Emarsys::Field.choice(3)
+      def choice(id)
+        get "field/#{id}/choice", {}
+      end
+    end
+
+  end
+
+end

data/lib/emarsys/data_objects/file.rb

@@ -0,0 +1,39 @@
+module Emarsys
+
+  # Methods for the File API
+  #
+  #
+  class File < DataObject
+    class << self
+
+      # List files
+      #
+      # @param params [Hash] optional search params
+      # @option params [Integer, String] :folder filter by folder
+      # @return [Hash] List of files
+      # @example
+      #   Emarsys::File.collection
+      #   Emarsys::File.collection(:folder => 3)
+      def collection(params = {})
+        get 'file', params
+      end
+
+      # Upload a file to the media database
+      #
+      # @param filename [String] The filename
+      # @param base64_encoded_file [String] Base64 encoded version of the file
+      # @param folder_id [Integer, String] optinal folder to out te file into
+      # @return [Hash] Result data
+      # @example
+      #   Emarsys::File.create("my_file.jpg", "asdhkajsh...")
+      #   Emarsys::File.create("my_file.jpg", "asdhkajsh...", 3)
+      def create(filename, base64_encoded_file, folder_id = nil)
+        params = {:filename => filename, :file => base64_encoded_file}
+        params.merge!({:folder => folder_id}) unless folder_id.nil?
+        post 'file', params
+      end
+    end
+
+  end
+
+end

data/lib/emarsys/data_objects/folder.rb

@@ -0,0 +1,24 @@
+module Emarsys
+
+  # Methods for the Folder API
+  #
+  #
+  class Folder < DataObject
+    class << self
+
+      # List folders
+      #
+      # @param params [Hash] optional search params
+      # @option params [Integer, String] :folder filter by parent folder
+      # @return [Hash] List of folders
+      # @example
+      #   Emarsys::Folder.collection
+      #   Emarsys::Folder.collection(:folder => 3)
+      def collection(params = {})
+        get 'folder', params
+      end
+    end
+
+  end
+
+end

data/lib/emarsys/data_objects/form.rb

@@ -0,0 +1,21 @@
+module Emarsys
+
+  # Methods for the Form API
+  #
+  #
+  class Form < DataObject
+    class << self
+
+      # List segments
+      #
+      # @return [Hash] List of forms
+      # @example
+      #   Emarsys::Form.collection
+      def collection
+        get 'form', {}
+      end
+
+    end
+  end
+
+end

data/lib/emarsys/data_objects/language.rb

@@ -0,0 +1,20 @@
+module Emarsys
+
+  # Methods for the Lanugage API
+  #
+  #
+  class Language < DataObject
+    class << self
+
+      # List languages
+      #
+      # @return [Hash] List of languages
+      # @example
+      #   Emarsys::Language.collection
+      def collection
+        get 'language', {}
+      end
+
+    end
+  end
+end

data/lib/emarsys/data_objects/segment.rb

@@ -0,0 +1,21 @@
+module Emarsys
+
+  # Methods for the Segment API
+  #
+  #
+  class Segment < DataObject
+    class << self
+
+      # List segments
+      #
+      # @return [Hash] List of segments
+      # @example
+      #   Emarsys::Segment.collection
+      def collection
+        get 'filter', {}
+      end
+
+    end
+  end
+
+end

data/lib/emarsys/data_objects/source.rb

@@ -0,0 +1,40 @@
+module Emarsys
+
+  # Methods for the Source API
+  #
+  #
+  class Source < DataObject
+    class << self
+
+      # List sources
+      #
+      # @return [Hash] List of sources
+      # @example
+      #   Emarsys::Source.collection
+      def collection
+        get 'source', {}
+      end
+
+      # Create a new source
+      #
+      # @param name [String] Name of the new source
+      # @return [Hash] Result data
+      # @example
+      #   Emarsys::Source.create("My new source")
+      def create(name)
+        post 'source/create', {:name => name}
+      end
+
+      # Destroy a specific source
+      #
+      # @param id [Integer, String] The internal emarsys id
+      # @return [Hash] Result data
+      # @example
+      #   Emarsys::Source.destroy(2)
+      def destroy(id)
+        delete "source/#{id}", {}
+      end
+
+    end
+  end
+end

data/lib/emarsys/error.rb

@@ -0,0 +1,24 @@
+module Emarsys
+  # Custom error class for rescuing from Emarsys errors
+  class Error < StandardError
+    def initialize(code, text, status)
+      @code = code
+      @text = text
+      @status = status
+      super(build_error_message)
+    end
+
+    def build_error_message
+      "HTTP-Code: #{@status}, Emarsys-Code: #{@code} - #{@text}"
+    end
+  end
+
+  # Raised when Emarsys returns a 400 HTTP status code
+  class BadRequest < Error; end
+
+  # Raised when Emarsys returns a 401 HTTP status code
+  class Unauthorized < Error; end
+
+  # Raised when Emarsys returns a 500 HTTP status code
+  class InternalServerError < Error; end
+end

data/lib/emarsys/extensions.rb

@@ -0,0 +1,8 @@
+class Hash
+  def stringify_keys
+    inject({}) do |options, (key, value)|
+      options[key.to_s] = value
+      options
+    end
+  end
+end

data/lib/emarsys/field_mapping.rb

@@ -0,0 +1,55 @@
+module Emarsys::FieldMapping
+
+  ATTRIBUTES = [
+    {:id => 0,   :identifier => '_interests',                  :name => 'Interests'},
+    {:id => 1,   :identifier => '_firstname',                  :name => 'First Name'},
+    {:id => 2,   :identifier => '_lastname',                   :name => 'Last Name'},
+    {:id => 3,   :identifier => '_email',                      :name => 'E-Mail'},
+    {:id => 4,   :identifier => '_date_of_birth',              :name => 'Date of Birth'},
+    {:id => 5,   :identifier => '_gender',                     :name => 'Gender'},
+    {:id => 6,   :identifier => '_marital_status',             :name => 'Marital Status'},
+    {:id => 7,   :identifier => '_children',                   :name => 'Children'},
+    {:id => 8,   :identifier => '_education',                  :name => 'Education'},
+    {:id => 9,   :identifier => '_title',                      :name => 'Title'},
+    {:id => 10,  :identifier => '_address',                    :name => 'Address'},
+    {:id => 11,  :identifier => '_city',                       :name => 'City'},
+    {:id => 12,  :identifier => '_region',                     :name => 'Region'},
+    {:id => 13,  :identifier => '_zip',                        :name => 'ZIP Code'},
+    {:id => 14,  :identifier => '_country',                    :name => 'Country'},
+    {:id => 15,  :identifier => '_phone',                      :name => 'Phone'},
+    {:id => 16,  :identifier => '_fax',                        :name => 'Fax'},
+    {:id => 17,  :identifier => '_job_position',               :name => 'Job Position'},
+    {:id => 18,  :identifier => '_company',                    :name => 'Company'},
+    {:id => 19,  :identifier => '_department',                 :name => 'Department'},
+    {:id => 20,  :identifier => '_industry',                   :name => 'Industry'},
+    {:id => 21,  :identifier => '_phone_office',               :name => 'Phone (office)'},
+    {:id => 22,  :identifier => '_fax_office',                 :name => 'Fax (office)'},
+    {:id => 23,  :identifier => '_number_of_employees',        :name => 'Number of Employees'},
+    {:id => 24,  :identifier => '_annual_revenue',             :name => 'Annual Revenue (in 000 EUR)'},
+    {:id => 25,  :identifier => '_url',                        :name => 'URL'},
+    {:id => 26,  :identifier => '_preferred_mail_format',      :name => 'Preferred Mail Format'},
+    {:id => 27,  :identifier => '_avg_length_of_visit',        :name => 'Avg. length of visit (minutes)'},
+    {:id => 28,  :identifier => '_page_views_per_day',         :name => 'Page views per day'},
+    {:id => 29,  :identifier => '_days_since_last_email_sent', :name => 'Days since last e-mail sent'},
+    {:id => 30,  :identifier => '_response_rate',              :name => 'Response rate (% of campaigns sent)'},
+    {:id => 31,  :identifier => '_opt_in',                     :name => 'Opt-In'},
+    {:id => 32,  :identifier => '_user_status',                :name => 'User status'},
+    {:id => 33,  :identifier => '_contact_source',             :name => 'Contact source'},
+    {:id => 34,  :identifier => '_contact_form',               :name => 'Contact form'},
+    {:id => 35,  :identifier => '_registration_language',      :name => 'Registration Language'},
+    {:id => 36,  :identifier => '_newsletter',                 :name => 'Newsletter'},
+    {:id => 37,  :identifier => '_mobile',                     :name => 'Mobile'},
+    {:id => 38,  :identifier => '_first_name_of_partner',      :name => 'First Name of Partner'},
+    {:id => 39,  :identifier => '_birthdate_of_partner',       :name => 'Birthdate of Partner'},
+    {:id => 40,  :identifier => '_anniversary',                :name => 'Anniversary'},
+    {:id => 41,  :identifier => '_company_address',            :name => 'Company Address'},
+    {:id => 42,  :identifier => '_zip_official',               :name => 'Zip Code (office)'},
+    {:id => 43,  :identifier => '_city_official',              :name => 'City (office)'},
+    {:id => 44,  :identifier => '_state_official',             :name => 'State (office)'},
+    {:id => 45,  :identifier => '_country_official',           :name => 'Country (office)'},
+    {:id => 46,  :identifier => '_salutation',                 :name => 'Salutation'},
+    {:id => 47,  :identifier => '_email_valid',                :name => 'E-Mail valid'},
+    {:id => 48,  :identifier => '_date_of_first_registration', :name => 'Date of first registration'}
+  ]
+
+end

data/lib/emarsys/params_converter.rb

@@ -0,0 +1,29 @@
+module Emarsys
+  class ParamsConverter
+
+    attr_accessor :params
+
+    def initialize(params={})
+      self.params = params
+    end
+
+    def convert_to_ids
+      new_hash = {}
+      params.each do |key, value|
+        matching_attributes = Emarsys::FieldMapping::ATTRIBUTES.find{|elem| elem[:identifier] == key.to_s}
+        new_hash.merge!({ (matching_attributes.nil? ? key : matching_attributes[:id]) => value })
+      end
+      new_hash
+    end
+
+    def convert_to_identifiers
+      new_hash = {}
+      params.each do |key, value|
+        matching_attributes = Emarsys::FieldMapping::ATTRIBUTES.find{|elem| elem[:id] == key.to_i && key.to_i != 0}
+        new_hash.merge!({ (matching_attributes.nil? ? key : matching_attributes[:identifier]) => value })
+      end
+      new_hash
+    end
+
+  end
+end

data/lib/emarsys/request.rb

@@ -0,0 +1,46 @@
+module Emarsys
+
+  class Request
+    attr_accessor :http_verb, :path, :params
+
+    def initialize(http_verb, path, params = {})
+      self.path = path
+      self.http_verb = http_verb
+      self.params = params
+    end
+
+    def send_request
+      case http_verb.to_sym
+      when :post
+        RestClient.post(emarsys_uri, converted_params.to_json, :content_type => :json, :x_wsse => client.x_wsse_string) do |response, request, result, &block|
+          Emarsys::Response.new(response).result
+        end
+      when :put
+        RestClient.put emarsys_uri, converted_params.to_json, :content_type => :json, :x_wsse => client.x_wsse_string do |response, request, result, &block|
+          Emarsys::Response.new(response).result
+        end
+      when :delete
+        RestClient.delete(emarsys_uri, :content_type => :json, :x_wsse => client.x_wsse_string) do |response, request, result, &block|
+          Emarsys::Response.new(response).result
+        end
+      else
+        RestClient.get(emarsys_uri, :content_type => :json, :x_wsse => client.x_wsse_string) do |response, request, result, &block|
+          Emarsys::Response.new(response).result
+        end
+      end
+    end
+
+    def client
+      Emarsys::Client.new
+    end
+
+    def emarsys_uri
+      [Emarsys.api_endpoint, @path].join('/')
+    end
+
+    def converted_params
+      Emarsys::ParamsConverter.new(params).convert_to_ids
+    end
+  end
+
+end

data/lib/emarsys/response.rb

@@ -0,0 +1,24 @@
+module Emarsys
+  class Response
+    attr_accessor :code, :text, :data, :status
+
+    def initialize(response)
+      json = JSON.parse(response)
+      self.code = json['replyCode']
+      self.text = json['replyText']
+      self.data = json['data']
+      self.status = response.code if response.respond_to?(:code)
+    end
+
+    def result
+      if code == 0
+        data
+      elsif !status.nil? && status == 401
+        raise Emarsys::Unauthorized.new(code, text, status)
+      else
+        raise Emarsys::BadRequest.new(code, text, status)
+      end
+    end
+
+  end
+end

data/lib/emarsys/version.rb

@@ -0,0 +1,3 @@
+module Emarsys
+  VERSION = "0.1.0"
+end

data/spec/emarsys/client_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+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")
+      expect(Emarsys::Client.new.username).to eq("my_username")
+    end
+
+    it 'inherits password from module' do
+      Emarsys.stub(: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)
+      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)
+      expect{Emarsys::Client.new.password}.to raise_error(ArgumentError, 'Emarsys.api_password is not set')
+    end
+  end
+
+  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")
+        expect(Emarsys::Client.new.x_wsse_string).to eq(
+          '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")
+      end
+
+      it 'encodes string with Base64' do
+        Base64.should_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(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
+      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")
+      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")
+        Emarsys::Client.new.calculated_digest
+      end
+    end
+
+  end
+
+end
+