markety 1.0.0

data/lib/markety.rb

@@ -0,0 +1,8 @@
+require 'savon'
+require 'markety/authentication_header'
+require 'markety/client'
+require 'markety/enums'
+require 'markety/lead_key'
+require 'markety/lead_record'
+
+

data/lib/markety/authentication_header.rb

@@ -0,0 +1,47 @@
+module Markety
+  # This class exists only to encapsulate the authentication header part of a soap request to marketo
+  class AuthenticationHeader
+    DIGEST = OpenSSL::Digest::Digest.new('sha1')
+
+    def initialize(access_key, secret_key, time = DateTime.now)
+      @access_key = access_key
+      @secret_key = secret_key
+      @time       = time
+    end
+
+    public
+    # time should be a DateTime instance
+    def set_time(time)
+      @time = time
+    end
+
+    def get_mktows_user_id
+      @access_key
+    end
+
+    def get_request_signature
+      calculate_signature
+    end
+
+    def get_request_timestamp
+      @time.to_s
+    end
+
+    def to_hash
+      { "ns1:AuthenticationHeader" =>
+        {
+          "mktowsUserId"     => get_mktows_user_id,
+          "requestSignature" => get_request_signature,
+          "requestTimestamp" => get_request_timestamp
+        }
+      }
+    end
+
+    private
+    def calculate_signature
+      request_timestamp = get_request_timestamp
+      string_to_encrypt = request_timestamp + @access_key
+      OpenSSL::HMAC.hexdigest(DIGEST, @secret_key, string_to_encrypt)
+    end
+  end
+end

data/lib/markety/client.rb

@@ -0,0 +1,145 @@
+module Markety
+  def self.new_client(access_key, secret_key, end_point, api_version = '2_2')
+    client = Savon.client do
+      endpoint end_point
+      wsdl "http://app.marketo.com/soap/mktows/#{api_version}?WSDL"
+      namespaces("xmlns:ns1" => "http://www.marketo.com/mktows/")
+    end
+    
+    Client.new(client, Markety::AuthenticationHeader.new(access_key, secret_key))
+  end
+  
+  class Client
+    def initialize(savon_client, authentication_header)
+      @client = savon_client
+      @header = authentication_header
+    end
+
+    public
+
+    def get_lead_by_idnum(idnum)
+      get_lead(LeadKey.new(LeadKeyType::IDNUM, idnum))
+    end
+
+
+    def get_lead_by_email(email)
+      get_lead(LeadKey.new(LeadKeyType::EMAIL, email))
+    end
+
+    def set_logger(logger)
+      @logger = logger
+    end
+
+    def sync_lead(email, first, last, company, mobile)
+      lead_record = LeadRecord.new(email)
+      lead_record.set_attribute('FirstName', first)
+      lead_record.set_attribute('LastName', last)
+      lead_record.set_attribute('Email', email)
+      lead_record.set_attribute('Company', company)
+      lead_record.set_attribute('MobilePhone', mobile)
+      sync_lead_record(lead_record)
+    end
+
+    def sync_lead_record(lead_record)
+      begin
+        attributes = []
+        lead_record.each_attribute_pair do |name, value|
+          attributes << {:attr_name => name, :attr_type => 'string', :attr_value => value}
+        end
+
+        response = send_request(:sync_lead, {
+          :return_lead => true,
+          :lead_record => {
+            :email => lead_record.email,
+            :lead_attribute_list => {
+              :attribute => attributes
+            }
+          }
+        })
+        return LeadRecord.from_hash(response[:success_sync_lead][:result][:lead_record])
+      rescue Exception => e
+        @logger.log(e) if @logger
+        return nil
+      end
+    end
+
+    def sync_lead_record_on_id(lead_record)
+      idnum = lead_record.idnum
+      raise 'lead record id not set' if idnum.nil?
+
+      begin
+        attributes = []
+        lead_record.each_attribute_pair do |name, value|
+          attributes << {:attr_name => name, :attr_type => 'string', :attr_value => value}
+        end
+
+        attributes << {:attr_name => 'Id', :attr_type => 'string', :attr_value => idnum.to_s}
+
+        response = send_request(:sync_lead, {
+          :return_lead => true,
+          :lead_record =>
+          {
+            :lead_attribute_list => { :attribute => attributes},
+            :id => idnum
+          }
+        })
+        return LeadRecord.from_hash(response[:success_sync_lead][:result][:lead_record])
+      rescue Exception => e
+        @logger.log(e) if @logger
+        return nil
+      end
+    end
+
+    def add_to_list(list_key, email)
+      list_operation(list_key, ListOperationType::ADD_TO, email)
+    end
+
+    def remove_from_list(list_key, email)
+      list_operation(list_key, ListOperationType::REMOVE_FROM, email)
+    end
+
+    def is_member_of_list?(list_key, email)
+      list_operation(list_key, ListOperationType::IS_MEMBER_OF, email)
+    end
+
+    private
+      def list_operation(list_key, list_operation_type, email)
+        begin
+          response = send_request(:list_operation, {
+            :list_operation   => list_operation_type,
+            :list_key         => list_key,
+            :strict           => 'false',
+            :list_member_list => {
+              :lead_key => [
+              {:key_type => 'EMAIL', :key_value => email}
+            ]
+          }
+        })
+        return response
+      rescue Exception => e
+        @logger.log(e) if @logger
+        return nil
+      end
+    end
+
+    def get_lead(lead_key)
+      begin
+        response = send_request(:get_lead, {"leadKey" => lead_key.to_hash})
+        return LeadRecord.from_hash(response[:success_get_lead][:result][:lead_record_list][:lead_record])
+      rescue Exception => e
+        @logger.log(e) if @logger
+        return nil
+      end
+    end
+
+    def send_request(namespace, message)
+      @header.set_time(DateTime.now)
+      response = request(namespace, message, @header.to_hash)
+      response.to_hash
+    end
+
+    def request(namespace, message, header)
+      @client.call(namespace, :message => message, :soap_header => header)
+    end
+  end
+end

data/lib/markety/enums.rb

@@ -0,0 +1,21 @@
+module Markety
+  # Types of operations you can do on a marketo list
+  module ListOperationType
+    ADD_TO       = 'ADDTOLIST'
+    REMOVE_FROM  = 'REMOVEFROMLIST'
+    IS_MEMBER_OF = 'ISMEMBEROFLIST'
+  end
+
+  # Types of keys that can be used to look up a lead
+  module LeadKeyType
+    IDNUM           = "IDNUM"
+    COOKIE          = "COOKIE"
+    EMAIL           = "EMAIL"
+    LEADOWNEREMAIL  = "LEADOWNEREMAIL"
+    SFDCACCOUNTID   = "SFDCACCOUNTID"
+    SFDCCONTACTID   = "SFDCCONTACTID"
+    SFDCLEADID      = "SFDCLEADID"
+    SFDCLEADOWNERID = "SFDCLEADOWNERID"
+    SFDCOPPTYID     = "SFDCOPPTYID"
+  end
+end

data/lib/markety/lead_key.rb

@@ -0,0 +1,29 @@
+module Markety
+  # Encapsulates a key used to look up or describe a specific marketo lead.
+  class LeadKey
+    # - *key_type* the type of key to use see LeadKeyType
+    # - *key_value* normally a string value for the given type
+    def initialize(key_type, key_value)
+      @key_type = key_type
+      @key_value = key_value
+    end
+
+    # get the key type
+    def key_type
+      @key_type
+    end
+
+    # get the key value
+    def key_value
+      @key_value
+    end
+
+    # create a hash from this instance, for sending this object to marketo using savon
+    def to_hash
+      {
+          "keyType" => @key_type,
+          "keyValue" => @key_value
+      }
+    end
+  end
+end

data/lib/markety/lead_record.rb

@@ -0,0 +1,55 @@
+module Markety
+  # Represents a record of the data known about a lead within marketo
+  class LeadRecord
+    def initialize(email, idnum = nil)
+      @idnum      = idnum
+      @attributes = {}
+      set_attribute('Email', email)
+    end
+
+    # hydrates an instance from a savon hash returned form the marketo API
+    def self.from_hash(savon_hash)
+      lead_record = LeadRecord.new(savon_hash[:email], savon_hash[:id].to_i)
+      savon_hash[:lead_attribute_list][:attribute].each do |attribute|
+        lead_record.set_attribute(attribute[:attr_name], attribute[:attr_value])
+      end
+      lead_record
+    end
+
+    # get the record idnum
+    def idnum
+      @idnum
+    end
+
+    # get the record email
+    def email
+      get_attribute('Email')
+    end
+
+    def attributes
+      @attributes
+    end
+
+    # update the value of the named attribute
+    def set_attribute(name, value)
+      @attributes[name] = value
+    end
+
+    # get the value for the named attribute
+    def get_attribute(name)
+      @attributes[name]
+    end
+
+    # will yield pairs of |attribute_name, attribute_value|
+    def each_attribute_pair(&block)
+      @attributes.each_pair do |name, value|
+        block.call(name, value)
+      end
+    end
+
+    def ==(other)
+      @attributes == other.attributes &&
+      @idnum == other.idnum
+    end
+  end
+end

data/lib/markety/version.rb

@@ -0,0 +1,5 @@
+module Markety
+
+  VERSION = "1.0.0"
+
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: markety
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- David Santoso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+description: A client to allow easy integration with Marketo's SOAP API
+email: david.e.santoso@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/markety/authentication_header.rb
+- lib/markety/client.rb
+- lib/markety/enums.rb
+- lib/markety/lead_key.rb
+- lib/markety/lead_record.rb
+- lib/markety/version.rb
+- lib/markety.rb
+homepage: https://github.com/davidsantoso/markety
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Marketo SOAP API integration
+test_files: []