marketo-api-ruby 0.8 → 0.9

data.tar.gz.sig

@@ -1,2 +1,2 @@
-^ �޼p��'*h⻖�2xX��"8�
�Qb���a��ܑa�mٺ�$�s���OfB�~�.q_�`Ԗ=���!�$b�bGރ��n,lB�ndD�O��E��������G�z]}��P@��LM���n��rO�e�j�3�)��^'���2o�ɤmra
-�׆����C��>�C�nc*3�C~qs�j��
7�平��TXg�!)B��Hb�b��������a_ڌI�[���8��s��iG����.�c<t����
+���q��p+�����n�IU|њ�
����IR–%�-�N�iM��xnD�]�c��=A���fgCa�rQ*��MF'Yf�*�T�� iRh�k0>IJ��
+?����Y����1I�b����@LOk�r���P�����/�[P/���j�ʙ���cļŠ@T+��i.���xŊ���#� 6�ktϧ�28�{���<�wR'���U^��0�O}��K�~�%�[��}�p±P�<��

data/.coveralls.yml

@@ -0,0 +1,2 @@
+---
+service_name: travis-ci

data/.hoerc

@@ -0,0 +1,2 @@
+---
+exclude: !ruby/regexp /(tmp|swp)$|CVS|TAGS|\.(svn|git|hg|DS_Store|idea)|Gemfile\.lock|type-lists\/|\.gemspec/

data/.travis.yml

@@ -0,0 +1,33 @@
+---
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+  - rbx-2
+matrix:
+  allow_failures:
+    - rvm:
+      - rbx-2
+gemfile:
+  - Gemfile
+before_script:
+  - |
+    case "${TRAVIS_RUBY_VERSION}" in
+      rbx*)
+        gem install psych
+        ;;
+    esac
+  - rake travis:before -t
+script: rake travis
+after_script:
+  - rake travis:after -t
+notifications:
+  recipients:
+    - austin@clearfit.com
+  email:
+    - on_success: change
+    - on_failure: always

data/History.rdoc

@@ -1,3 +1,14 @@
+=== 0.9 / 2014-MM-DD
+
+* Bug Fixes:
+  * Fix #15, where Marketo uses inconsistent camelcasing.
+
+* Infrastructure:
+  * While marketo-api-ruby may work on 1.9.2, it's being removed from Travis
+    due to ongoing test failures that I can't replicate (I can't get a 1.9.2
+    Ruby built, and it's no longer a supported Ruby in any case).
+  * Fixed rbx tests.
+
 === 0.8 / 2014-04-08
 
 * First release as marketo-api-ruby. Features a substantially restructured API.

data/Manifest.txt

@@ -1,4 +1,7 @@
+.coveralls.yml
 .gemtest
+.hoerc
+.travis.yml
 Contributing.rdoc
 Gemfile
 History.rdoc
@@ -16,11 +19,6 @@ lib/marketo_api/leads.rb
 lib/marketo_api/lists.rb
 lib/marketo_api/mobject.rb
 lib/marketo_api/mobjects.rb
-spec/marketo/authentication_header_spec.rb
-spec/marketo/client_spec.rb
-spec/marketo/lead_key_spec.rb
-spec/marketo/lead_record_spec.rb
-spec/spec_helper.rb
 test/marketo_api/test_campaigns.rb
 test/marketo_api/test_client.rb
 test/marketo_api/test_lead.rb

data/README.rdoc

@@ -15,8 +15,13 @@ MarketoAPI (marketo-api-ruby) provides a native Ruby interface to the
 API is necessary for using marketo-api-ruby, it is an explicit goal that
 working with MarketoAPI not feel like working with a hinky Java port.
 
-This is release 0.8, targeting Marketo API version
-{2.3}[http://app.marketo.com/soap/mktows/2_3?WSDL].
+This is release 0.9, targeting Marketo API version
+{2.3}[http://app.marketo.com/soap/mktows/2_3?WSDL], fixing a +syncLead+ problem
+where +Id+, +Email+, and +ForeignSysPersonId+ are inconsistent with other
++syncLead+ parameters.
+
+Please note that Ruby 1.9.2 is not officially supported, but MarketoAPI will
+install on any version of Ruby 1.9.2 or later.
 
 === Features/Problems
 

data/lib/marketo_api.rb

@@ -6,7 +6,7 @@
 #
 #   require 'marketo_api'
 module MarketoAPI
-  VERSION = "0.8"
+  VERSION = "0.9"
 
   MINIMIZE_HASH = ->(k, v) { #:nodoc:
     v.nil? or (v.respond_to?(:empty?) and v.empty?)

data/lib/marketo_api/campaigns.rb

@@ -18,6 +18,13 @@ class MarketoAPI::Campaigns < MarketoAPI::ClientProxy
   ENUMS = MarketoAPI.freeze(*SOURCES.values) #:nodoc:
   private_constant :ENUMS
 
+  REQUEST_PARAM_XF = { #:nodoc:
+    campaign_id:   :campaignId,
+    campaign_name: :campaignName,
+    program_name:  :programName,
+  }
+  private_constant :REQUEST_PARAM_XF
+
   # Implements
   # {+getCampaignsForSource+}[http://developers.marketo.com/documentation/soap/getcampaignsforsource/].
   #
@@ -33,7 +40,7 @@ class MarketoAPI::Campaigns < MarketoAPI::ClientProxy
       {
         source:      resolve_source(source),
         name:        name,
-        exact_name:  exact_name
+        exactName:   exact_name
       }.delete_if(&MarketoAPI::MINIMIZE_HASH)
     )
   end
@@ -115,12 +122,14 @@ class MarketoAPI::Campaigns < MarketoAPI::ClientProxy
       end
     end
 
+    REQUEST_PARAM_XF.each { |o, n| options[n] = options.delete(o) }
+
     call(
-      :request_campaign,
+      :RequestCampaign,
       options.merge(
-        source:              resolve_source(source),
-        lead_list:           transform_param_list(:get, leads),
-        program_token_list:  tokens
+        source:           resolve_source(source),
+        leadList:         transform_param_list(:get, leads),
+        programTokenList: tokens
       ).delete_if(&MarketoAPI::MINIMIZE_HASH)
     )
   end
@@ -160,12 +169,12 @@ class MarketoAPI::Campaigns < MarketoAPI::ClientProxy
   #   schedule(program_name, campaign_name, options = {})
   def schedule(program_name, campaign_name, options = {})
     call(
-      :schedule_campaign,
+      :ScheduleCampaign,
       {
-        program_name: program_name,
-        campaign_name: campaign_name,
-        campaign_run_at: options[:run_at],
-        program_token_list: options[:program_tokens]
+        programName:      program_name,
+        campaignName:     campaign_name,
+        campaignRunAt:    options[:run_at],
+        programTokenList: options[:program_tokens]
       }.delete_if(&MarketoAPI::MINIMIZE_HASH)
     )
   end

data/lib/marketo_api/client.rb

@@ -5,17 +5,18 @@ require 'openssl'
 # The client to the Marketo SOAP API.
 class MarketoAPI::Client
   DEFAULT_CONFIG = {
-    api_subdomain:     '123-ABC-456',
-    api_version:       '2_3',
-    user_id:           nil,
-    encryption_key:    nil,
-    read_timeout:      90,
-    open_timeout:      90,
-    headers:           { 'Connection' => 'Keep-Alive' },
-    env_namespace:     'SOAP-ENV',
-    namespaces:        { 'xmlns:ns1' => 'http://www.marketo.com/mktows/' },
-    pretty_print_xml:  true,
-    ssl_verify_mode:   :none,
+    api_subdomain:           '123-ABC-456',
+    api_version:             '2_3',
+    user_id:                 nil,
+    encryption_key:          nil,
+    read_timeout:            90,
+    open_timeout:            90,
+    headers:                 { 'Connection' => 'Keep-Alive' },
+    env_namespace:           'SOAP-ENV',
+    namespaces:              { 'xmlns:ns1' => 'http://www.marketo.com/mktows/' },
+    pretty_print_xml:        true,
+    ssl_verify_mode:         :none,
+    convert_request_keys_to: :none,
   }.freeze
   DEFAULT_CONFIG.values.each(&:freeze)
   private_constant :DEFAULT_CONFIG

data/lib/marketo_api/lead.rb

@@ -192,19 +192,19 @@ class MarketoAPI::Lead
   # Returns the parameters required for use with MarketoAPI::Leads#sync.
   def params_for_sync
     {
-      return_lead: true,
-      marketo_cookie: cookie,
-      lead_record: {
-        email:                  email,
-        id:                     id,
-        foreign_sys_person_id:  foreign[:id],
-        foreign_sys_type:       foreign[:type],
-        lead_attribute_list: {
+      returnLead:    true,
+      marketoCookie: cookie,
+      leadRecord:    {
+        Email:              email,
+        Id:                 id,
+        ForeignSysPersonId: foreign[:id],
+        ForeignSysType:     foreign[:type],
+        leadAttributeList:  {
           attribute: attributes.map { |key, value|
             {
-              attr_name:   key.to_s,
-              attr_type:   types[key],
-              attr_value:  value
+              attrName:  key.to_s,
+              attrType:  types[key],
+              attrValue: value
             }
           }
         }
@@ -234,9 +234,9 @@ class MarketoAPI::Lead
     # API calls.
     def key(key, value)
       {
-        lead_key: {
-          key_type:   key_type(key),
-          key_value:  value
+        leadKey: {
+          keyType:  key_type(key),
+          keyValue: value
         }
       }
     end

data/lib/marketo_api/leads.rb

@@ -13,8 +13,8 @@ class MarketoAPI::Leads < MarketoAPI::ClientProxy
   def get(type_or_key, value = nil)
     key = case type_or_key
           when Hash
-            if lk = type_or_key[:lead_key]
-              if MarketoAPI::Lead.send(:key_type, lk[:key_type])
+            if lk = type_or_key[:leadKey]
+              if MarketoAPI::Lead.send(:key_type, lk[:keyType])
                 type_or_key
               end
             end
@@ -25,7 +25,7 @@ class MarketoAPI::Leads < MarketoAPI::ClientProxy
           end
 
     unless key
-      raise ArgumentError, ':type_or_key is not a valid lead key'
+      raise ArgumentError, "#{type_or_key} is not a valid lead key"
     end
     extract_from_response(call(:get_lead, key), :lead_record_list) { |record|
       MarketoAPI::Lead.from_soap_hash(record[:lead_record]) do |lead|
@@ -64,8 +64,8 @@ class MarketoAPI::Leads < MarketoAPI::ClientProxy
   def sync_multiple(leads, options = { dedup_enabled: true })
     response = call(
       :sync_multiple_leads,
-      dedup_enabled: options[:dedup_enabled],
-      lead_record_list: transform_param_list(:sync, leads)
+      dedupEnabled:   options[:dedup_enabled],
+      leadRecordList: transform_param_list(:sync, leads)
     )
     extract_from_response(response, :lead_record_list) do |list|
       list.each do |record|

data/lib/marketo_api/lists.rb

@@ -71,9 +71,9 @@ class MarketoAPI::Lists < MarketoAPI::ClientProxy
   class << self
     def key(type, value)
       {
-        list_key: {
-          key_type: key_type(type),
-          key_value: value
+        listKey: {
+          keyType:  key_type(type),
+          keyValue: value
         }
       }
     end
@@ -100,10 +100,10 @@ class MarketoAPI::Lists < MarketoAPI::ClientProxy
 
     call(
       :list_operation,
-      list_operation:    operation,
-      list_key:          list_key,
-      strict:            false,
-      list_member_list:  transform_param_list(:get, leads)
+      listOperation:  operation,
+      listKey:        list_key,
+      strict:         false,
+      listMemberList: transform_param_list(:get, leads)
     )
   end
 end

data/lib/marketo_api/mobject.rb

@@ -121,12 +121,13 @@ class MarketoAPI::MObject
   def params_for_get #:nodoc:
     ensure_valid_type!(type, GET_TYPES)
     {
-      type:                    type,
-      id:                      id,
-      include_details:         include_details,
-      m_obj_criteria_list:     criteria.compact.uniq.map(&:to_h),
-      m_obj_association_list:  associations.compact.uniq.map(&:to_h),
-      stream_position:         stream_position
+      type:                type,
+      id:                  id,
+      includeDetails:      include_details,
+      mObjCriteriaList:    criteria.compact.uniq.map(&:to_h),
+      mObjAssociationList: associations.compact.uniq.map(&:to_h),
+      streamPosition:      stream_position,
+      externalKey:         nil
     }.delete_if(&MarketoAPI::MINIMIZE_HASH)
   end
 
@@ -214,9 +215,9 @@ class MarketoAPI::MObject
 
     def to_h
       {
-        attr_name:   name,
-        attr_value:  value,
-        comparison:  comparison
+        attrName:   name,
+        attrValue:  value,
+        comparison: comparison
       }
     end
   end
@@ -255,9 +256,9 @@ class MarketoAPI::MObject
 
     def to_h
       {
-        m_obj_type:    type,
-        id:            id,
-        external_key:  external_key,
+        mObjType:    type,
+        id:          id,
+        externalKey: external_key,
       }
     end
   end

data/lib/marketo_api/mobjects.rb

@@ -22,7 +22,7 @@ class MarketoAPI::MObjects < MarketoAPI::ClientProxy
     end
     response = call(
       :delete_m_objects,
-      m_object_list: transform_param_list(__method__, mobjects)
+      mObjectList: transform_param_list(__method__, mobjects)
     )
     extract_mobject_status_list(response)
   end
@@ -47,7 +47,7 @@ class MarketoAPI::MObjects < MarketoAPI::ClientProxy
     end
 
     extract_from_response(
-      call(:describe_m_object, object_name: name),
+      call(:describe_m_object, objectName: name),
       :metadata
     )
   end
@@ -69,7 +69,7 @@ class MarketoAPI::MObjects < MarketoAPI::ClientProxy
   def sync(operation, *mobjects) #:nodoc:
     # http://developers.marketo.com/documentation/soap/sync-mobjects/
     raise NotImplementedError,
-      ":sync_m_objects is not implemented in this version."
+      ":syncMObjects is not implemented in this version."
     response = call(
       :sync_m_objects,
       transform_param_list(__method__, mobjects)

data/test/marketo_api/test_campaigns.rb

@@ -48,7 +48,7 @@ class TestMarketoAPICampaigns < Minitest::Test
     stub_soap_call do
       method, options = subject.for_source :marketo, 'John', true
       assert_equal :get_campaigns_for_source, method
-      assert_equal({ source: :MKTOWS, name: 'John', exact_name: true },
+      assert_equal({ source: :MKTOWS, name: 'John', exactName: true },
                    options)
     end
   end
@@ -70,31 +70,34 @@ class TestMarketoAPICampaigns < Minitest::Test
   end
 
   def test_request_missing_leads
-    assert_raises(ArgumentError) {
+    assert_raises_with_message(ArgumentError, ':lead or :leads must be provided') {
       subject.request
     }
   end
 
   def test_request_missing_campaign_or_program
-    assert_raises(ArgumentError) {
+    assert_raises(ArgumentError,
+                  ':campaignId, :campaignName, or :programName must be provided') {
       subject.request(lead: :foo)
     }
   end
 
-  def test_request_program_token_with_no_program_name
-    assert_raises(KeyError) {
+  def test_request_program_tokens_with_no_program_name
+    assert_raises_with_message(KeyError,
+                               ':program_name must be provided when using :program_tokens') {
       subject.request(lead: :foo, campaign_id: 5, program_tokens: [ 3 ])
     }
   end
 
   def test_request_with_campaign_id_and_name
-    assert_raises(ArgumentError) {
+    assert_raises_with_message(ArgumentError,
+                               ':campaign_id and :campaign_name are mutually exclusive') {
       subject.request(lead: :foo, campaign_id: 5, campaign_name: 'Five')
     }
   end
 
   def test_request_bad_source
-    assert_raises(ArgumentError) {
+    assert_raises_with_message(ArgumentError, 'Invalid source bad_source') {
       subject.request(lead: :foo, campaign_id: 5, source: :bad_source)
     }
   end
@@ -104,12 +107,13 @@ class TestMarketoAPICampaigns < Minitest::Test
       method, options = subject.request(lead:        lead_key(3),
                                         leads:       lead_keys(4, 5),
                                         campaign_id: 3)
-      assert_equal :request_campaign, method
+      assert_equal :RequestCampaign, method
+      refute_missing_keys options, :source, :leadList, :campaignId
       assert_equal :MKTOWS, options[:source]
-      assert_equal lead_keys(4, 5, 3), options[:lead_list]
-      assert_equal 3, options[:campaign_id]
-      assert_missing_keys options, :campaign_name, :program_name,
-        :program_tokens
+      assert_equal lead_keys(4, 5, 3), options[:leadList]
+      assert_equal 3, options[:campaignId]
+      assert_missing_keys options, :campaignName, :programName,
+        :programTokens
     end
   end
 
@@ -117,12 +121,12 @@ class TestMarketoAPICampaigns < Minitest::Test
     stub_soap_call do
       method, options = subject.request(lead:          lead_key(3),
                                         campaign_name: 'earthday')
-      assert_equal :request_campaign, method
+      assert_equal :RequestCampaign, method
       assert_equal :MKTOWS, options[:source]
-      assert_equal [ lead_key(3) ], options[:lead_list]
-      assert_equal 'earthday', options[:campaign_name]
-      assert_missing_keys options, :campaign_id, :program_name,
-        :program_tokens
+      assert_equal [ lead_key(3) ], options[:leadList]
+      assert_equal 'earthday', options[:campaignName]
+      assert_missing_keys options, :campaignId, :programName,
+        :programTokens
     end
   end
 
@@ -130,31 +134,32 @@ class TestMarketoAPICampaigns < Minitest::Test
     stub_soap_call do
       method, options = subject.request(lead:         lead_key(3),
                                         program_name: 'earthday')
-      assert_equal :request_campaign, method
+      assert_equal :RequestCampaign, method
+      refute_missing_keys options, :source, :leadList, :programName
       assert_equal :MKTOWS, options[:source]
-      assert_equal [ lead_key(3) ], options[:lead_list]
-      assert_equal 'earthday', options[:program_name]
-      assert_missing_keys options, :campaign_name, :campaign_id,
-        :program_tokens
+      assert_equal [ lead_key(3) ], options[:leadList]
+      assert_equal 'earthday', options[:programName]
+      assert_missing_keys options, :campaignName, :campaignId,
+        :programTokens
     end
   end
 
   def test_schedule
     stub_soap_call do
       method, options = subject.schedule('program', 'campaign')
-      assert_equal :schedule_campaign, method
-      assert_equal({ program_name: 'program', campaign_name: 'campaign' }, options)
+      assert_equal :ScheduleCampaign, method
+      assert_equal({ programName: 'program', campaignName: 'campaign' }, options)
     end
   end
 
   def test_schedule_with_run_at
     stub_soap_call do
       method, options = subject.schedule('program', 'campaign', run_at: 3)
-      assert_equal :schedule_campaign, method
+      assert_equal :ScheduleCampaign, method
       assert_equal({
-        program_name:    'program',
-        campaign_name:   'campaign',
-        campaign_run_at: 3
+        programName:   'program',
+        campaignName:  'campaign',
+        campaignRunAt: 3
       }, options)
     end
   end
@@ -162,11 +167,11 @@ class TestMarketoAPICampaigns < Minitest::Test
   def test_schedule_with_program_tokens
     stub_soap_call do
       method, options = subject.schedule('program', 'campaign', program_tokens: [ :x ])
-      assert_equal :schedule_campaign, method
+      assert_equal :ScheduleCampaign, method
       assert_equal({
-        program_name:       'program',
-        campaign_name:      'campaign',
-        program_token_list: [ :x ]
+        programName:      'program',
+        campaignName:     'campaign',
+        programTokenList: [ :x ]
       }, options)
     end
   end