mrkt 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19c375fe88c8b99a1d7af83714409133424c3e7c
-  data.tar.gz: 88ebcda5a1b3dad3aaaf593552961d78a0e45512
+  metadata.gz: 7d3728f0e153f6f7f2cc24bdad8e72a88c71604f
+  data.tar.gz: d5b9cb48773b20627eae5ab686fa2306cb6df88f
 SHA512:
-  metadata.gz: a5ca3432d050e8caf2d44edb44fcef9ef4f7840ee66dd7516ec8c38bf11e1c52e31151ee2b9d299bb210ae047a95add038f06c18e997104c74b96c81dc69b898
-  data.tar.gz: e44bd10fec6bc3477fcaf42e2939c78cdd7efa6fa1f348d39561022856eb7d01d5487f440e19bdfaafe68dacb2c9bb2892b1a61b63c0ede684750c39747935d7
+  metadata.gz: 0c493d4c6d76bd816db9ae3b550ed15910a6c8e70c6baf4e10cb10a218d3cccad98f3a5a807c32fa7defd7694bba54cfbf7b8e4d401ccda8c82c040f696a3a71
+  data.tar.gz: 061a382925a6618d1616238ece57e074ace34096832b9c93b69eb62552d228f5d0156fc715c1c7cd5805d6877c5c08ba97b676a2a359147d1f5f56e128cc159b

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    mrkt (0.6.2)
+    mrkt (0.7.0)
+      faraday (> 0.9.0, < 0.11.0)
       faraday_middleware (> 0.9.0, < 0.11.0)
 
 GEM
@@ -25,7 +26,7 @@ GEM
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.10.0)
       faraday (>= 0.7.4, < 0.10)
-    json (1.8.2)
+    json (1.8.3)
     method_source (0.8.2)
     multipart-post (2.0.0)
     parser (2.2.2.6)
@@ -39,7 +40,7 @@ GEM
       byebug (~> 4.0)
       pry (~> 0.10)
     rainbow (2.0.0)
-    rake (10.1.1)
+    rake (10.5.0)
     rspec (3.2.0)
       rspec-core (~> 3.2.0)
       rspec-expectations (~> 3.2.0)
@@ -86,4 +87,4 @@ DEPENDENCIES
   webmock (~> 1.21.0)
 
 BUNDLED WITH
-   1.11.2
+   1.13.1

data/README.md

@@ -44,12 +44,35 @@ client = Mrkt::Client.new(
   client_secret: '7Gn0tuiHZiDHnzeu9P14uDQcSx9xIPPt')
 ```
 
-If you need verbosity during troubleshooting, set the client to debug mode
+If you need verbosity during troubleshooting, enable debug mode:
 
 ```ruby
-client.debug = true
+client = Mrkt::Client.new(
+  host: '123-abc-123.mktorest.com', 
+  client_id:  '4567e1cdf-0fae-4685-a914-5be45043f2d8', 
+  client_secret: '7Gn0tuiHZiDHnzeu9P14uDQcSx9xIPPt',
+  debug: true,
+  logger: ::Logger.new("log/marketo.log"), # optional, defaults to Faraday default of logging to STDOUT
+  log_options: {bodies: true}) # optional, defaults to Faraday default of only logging headers
+```
+
+### Retry authentication
+
+Since the Marketo API provides API access keys with a validity of 3600 seconds, if you are running an hourly cronjob it's possible that your subsequent call receives the same key from the previous hour, which is then immediately expired. If this is the case, you can configure the client to retry until receiving a valid key:
+
+```ruby
+client = Mrkt::Client.new(
+  host: '123-abc-123.mktorest.com',
+  client_id:  '4567e1cdf-0fae-4685-a914-5be45043f2d8',
+  client_secret: '7Gn0tuiHZiDHnzeu9P14uDQcSx9xIPPt',
+  retry_authentication: true,
+  retry_authentication_count: 3, # default: 3
+  retry_authentication_wait_seconds: 1, # default: 0
+  )
 ```
 
+This is turned off by default.
+
 ### Get leads matching an email, print their id and email
     
 ```ruby

data/lib/mrkt.rb

@@ -9,6 +9,7 @@ require 'mrkt/concerns/crud_leads'
 require 'mrkt/concerns/crud_lists'
 require 'mrkt/concerns/import_leads'
 require 'mrkt/concerns/crud_custom_objects'
+require 'mrkt/concerns/crud_custom_activities'
 require 'mrkt/concerns/crud_programs'
 
 module Mrkt
@@ -21,6 +22,7 @@ module Mrkt
     include CrudLists
     include ImportLeads
     include CrudCustomObjects
+    include CrudCustomActivities
     include CrudPrograms
 
     attr_accessor :debug
@@ -31,6 +33,15 @@ module Mrkt
       @client_id = options.fetch(:client_id)
       @client_secret = options.fetch(:client_secret)
 
+      @retry_authentication = options.fetch(:retry_authentication, false)
+      @retry_authentication_count = options.fetch(:retry_authentication_count, 3).to_i
+      @retry_authentication_wait_seconds = options.fetch(:retry_authentication_wait_seconds, 0).to_i
+
+      @debug = options[:debug]
+
+      @logger = options[:logger]
+      @log_options = options[:log_options]
+
       @options = options
     end
 

data/lib/mrkt/concerns/authentication.rb

@@ -1,7 +1,18 @@
 module Mrkt
   module Authentication
     def authenticate!
-      authenticate unless authenticated?
+      return if authenticated?
+
+      authenticate
+
+      if !authenticated? && @retry_authentication
+        @retry_authentication_count.times do
+          sleep(@retry_authentication_wait_seconds) if @retry_authentication_wait_seconds > 0
+          authenticate
+          break if authenticated?
+        end
+      end
+
       fail Mrkt::Errors::AuthorizationError, 'Client not authenticated' unless authenticated?
     end
 

data/lib/mrkt/concerns/connection.rb

@@ -11,7 +11,10 @@ module Mrkt
         conn.request :multipart
         conn.request :url_encoded
 
-        conn.response :logger if @debug
+        if @debug
+          conn.response :logger, @logger, (@log_options || {})
+        end
+
         conn.response :mkto, content_type: /\bjson$/
 
         conn.options.timeout = @options[:read_timeout] if @options.key?(:read_timeout)

data/lib/mrkt/concerns/crud_custom_activities.rb

@@ -0,0 +1,34 @@
+require 'time'
+
+module Mrkt
+  module CrudCustomActivities
+    def get_list_of_custom_activity_types
+      get('/rest/v1/activities/types.json')
+    end
+
+    def create_custom_activity(lead_id, activity_type_id, primary_attribute_value, attributes: {}, date: nil)
+      date ||= Time.now
+      date = date.utc.iso8601
+      converted_attributes = convert_attribute_hash(attributes)
+
+      input = [{
+        leadId: lead_id,
+        activityDate: date,
+        activityTypeId: activity_type_id,
+        primaryAttributeValue: primary_attribute_value,
+        attributes: converted_attributes
+      }]
+      post('/rest/v1/activities/external.json') do |req|
+        json_payload(req, input: input)
+      end
+    end
+
+    private
+
+    def convert_attribute_hash(attributes)
+      attributes.map do |key, value|
+        { name: key, value: value }
+      end
+    end
+  end
+end

data/lib/mrkt/concerns/crud_custom_objects.rb

@@ -1,6 +1,6 @@
 module Mrkt
   module CrudCustomObjects
-    def get_list_of_custom_objects(names=nil)
+    def get_list_of_custom_objects(names = nil)
       params = {}
       params[:names] = names.join(',') if names
 

data/lib/mrkt/version.rb

@@ -1,3 +1,3 @@
 module Mrkt
-  VERSION = '0.6.2'
+  VERSION = '0.7.0'
 end

data/mrkt.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '~> 2.0'
 
+  spec.add_dependency 'faraday', '> 0.9.0', '< 0.11.0'
   spec.add_dependency 'faraday_middleware', '> 0.9.0', '< 0.11.0'
 
   spec.add_development_dependency 'bundler', '~> 1.3'

data/spec/concerns/authentication_spec.rb

@@ -22,6 +22,49 @@ describe Mrkt::Authentication do
     end
   end
 
+  describe '#authenticate!' do
+    it 'should authenticate and then be authenticated?' do
+      expect(client.authenticated?).to_not be true
+      client.authenticate!
+      expect(client.authenticated?).to be true
+    end
+
+    context 'when the token has expired and @retry_authentication = true' do
+      before { remove_request_stub(@authentication_request_stub) }
+
+      let(:expired_authentication_stub) do
+        { access_token: SecureRandom.uuid, token_type: 'bearer', expires_in: 0, scope: 'RestClient' }
+      end
+
+      let(:valid_authentication_stub) do
+        { access_token: SecureRandom.uuid, token_type: 'bearer', expires_in: 1234, scope: 'RestClient' }
+      end
+
+      subject(:client) { Mrkt::Client.new(host: host, client_id: client_id, client_secret: client_secret, retry_authentication: true) }
+
+      before do
+        stub_request(:get, "https://#{host}/identity/oauth/token")
+          .with(query: { client_id: client_id, client_secret: client_secret, grant_type: 'client_credentials' })
+          .to_return(json_stub(expired_authentication_stub)).times(3).then
+          .to_return(json_stub(valid_authentication_stub))
+      end
+
+      it 'should retry until getting valid token and then be authenticated?' do
+        expect(client.authenticated?).to_not be true
+        client.authenticate!
+        expect(client.authenticated?).to be true
+      end
+
+      it 'should stop retrying after @retry_authentication_count tries and then raise an error' do
+        client = Mrkt::Client.new(host: host, client_id: client_id, client_secret: client_secret, retry_authentication: true, retry_authentication_count: 2)
+
+        expect(client.authenticated?).to_not be true
+
+        expect { client.authenticate! }.to raise_error(Mrkt::Errors::Error, 'Client not authenticated')
+      end
+    end
+  end
+
   describe '#authenticated?' do
     subject { client.authenticated? }
 

data/spec/concerns/crud_custom_activities_spec.rb

@@ -0,0 +1,170 @@
+describe Mrkt::CrudCustomObjects do
+  include_context 'initialized client'
+
+  describe '#get_list_of_custom_activity_types' do
+    let(:response_stub) do
+      {
+        requestId: '14ff3#1579a716c12',
+        result: [
+          {
+            id: 1,
+            name: 'Visit Webpage',
+            description: 'User visits a web page',
+            primaryAttribute: {
+              name: 'Webpage ID',
+              dataType: 'integer'
+            },
+            attributes: [
+              {
+                name: 'Client IP Address',
+                dataType: 'string'
+              },
+              {
+                name: 'Query Parameters',
+                dataType: 'string'
+              }
+            ]
+          },
+          {
+            id: 1,
+            name: 'Visit Webpage',
+            description: 'User visits a web page',
+            primaryAttribute: {
+              name: 'Webpage ID',
+              dataType: 'integer'
+            },
+            attributes: [
+              {
+                name: 'Client IP Address',
+                dataType: 'string'
+              },
+              {
+                name: 'Query Parameters',
+                dataType: 'string'
+              }
+            ]
+          }
+        ],
+        success: true
+      }
+    end
+
+    context 'all activities' do
+      before do
+        stub_request(:get, "https://#{host}/rest/v1/activities/types.json")
+          .to_return(json_stub(response_stub))
+      end
+
+      subject { client.get_list_of_custom_activity_types }
+
+      it { is_expected.to eq(response_stub) }
+    end
+  end
+
+  describe '#create_custom_activity' do
+    let(:response_stub) do
+      {
+        requestId: 'c245#14cd6830ae2',
+        result: [
+          {
+            activityDate: 'string',
+            activityTypeId: 0,
+            apiName: 'string',
+            attributes: [
+              {
+                apiName: 'string',
+                name: 'string',
+                value: {}
+              }
+            ],
+            id: 0,
+            leadId: 0,
+            primaryAttributeValue: 'string',
+            status: 'created'
+          }
+        ],
+        success: true
+      }
+    end
+
+    let(:lead_id) do
+      1
+    end
+
+    let(:activity_type_id) do
+      100_000
+    end
+
+    let(:primary_attribute_value) do
+      'Friday'
+    end
+
+    let(:date) do
+      Time.now
+    end
+
+    context 'with no additional attributes' do
+      let(:request_body) do
+        {
+          input: [{
+            leadId: lead_id,
+            activityDate: date.utc.iso8601,
+            activityTypeId: activity_type_id,
+            primaryAttributeValue: primary_attribute_value,
+            attributes: []
+          }]
+        }
+      end
+
+      before do
+        stub_request(:post, "https://#{host}/rest/v1/activities/external.json")
+          .with(json_stub(request_body))
+          .to_return(json_stub(response_stub))
+      end
+
+      subject { client.create_custom_activity(lead_id, activity_type_id, primary_attribute_value, date: date) }
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'with additional attributes' do
+      let(:request_body) do
+        {
+          input: [{
+            leadId: lead_id,
+            activityDate: date.utc.iso8601,
+            activityTypeId: activity_type_id,
+            primaryAttributeValue: primary_attribute_value,
+            attributes: [
+              {
+                name: 'percent',
+                value: '0.20'
+              },
+              {
+                name: 'resourceId',
+                value: '_Hy8Sfk9938005SSF'
+              }
+            ]
+          }]
+        }
+      end
+
+      before do
+        stub_request(:post, "https://#{host}/rest/v1/activities/external.json")
+          .with(json_stub(request_body))
+          .to_return(json_stub(response_stub))
+      end
+
+      let(:attributes) do
+        {
+          percent: '0.20',
+          resourceId: '_Hy8Sfk9938005SSF'
+        }
+      end
+
+      subject { client.create_custom_activity(lead_id, activity_type_id, primary_attribute_value, attributes: attributes, date: date) }
+
+      it { is_expected.to eq(response_stub) }
+    end
+  end
+end

data/spec/concerns/crud_custom_objects_spec.rb

@@ -5,35 +5,40 @@ describe Mrkt::CrudCustomObjects do
     let(:response_stub) do
       {
         requestId: 'c245#14cd6830ae2',
-        result: [{
-          name: 'device_c',
-          displayName: 'Device',
-          description: 'this is a device object',
-          createdAt: '2016-01-23T00:51:18Z',
-          updatedAt: '2016-01-23T00:51:18Z',
-          idField: 'marketoGUID',
-          dedupeFields: ['serialNumber'],
-          searchableFields: [['serialNumber'], ['marketoGUID']],
-          relationships: [{
-              field: 'email',
-              type: 'child',
-              relatedTo: { name: 'Lead', field: 'email' }
-          }],
-        },
-        {
-          name: 'manufacturer_c',
-          displayName: 'Manufacturer',
-          createdAt: '2016-01-23T00:55:18Z',
-          updatedAt: '2016-01-23T00:55:18Z',
-          idField: 'marketoGUID',
-          dedupeFields: ['name'],
-          searchableFields: [['name'], ['marketoGUID']],
-          relationships: [{
-            field: 'email',
-            type: 'child',
-            relatedTo: { name: 'Lead', field: 'email' }
-          }]
-        }],
+        result: [
+          {
+            name: 'device_c',
+            displayName: 'Device',
+            description: 'this is a device object',
+            createdAt: '2016-01-23T00:51:18Z',
+            updatedAt: '2016-01-23T00:51:18Z',
+            idField: 'marketoGUID',
+            dedupeFields: ['serialNumber'],
+            searchableFields: [['serialNumber'], ['marketoGUID']],
+            relationships: [
+              {
+                field: 'email',
+                type: 'child',
+                relatedTo: { name: 'Lead', field: 'email' }
+              }
+            ]
+          }, {
+            name: 'manufacturer_c',
+            displayName: 'Manufacturer',
+            createdAt: '2016-01-23T00:55:18Z',
+            updatedAt: '2016-01-23T00:55:18Z',
+            idField: 'marketoGUID',
+            dedupeFields: ['name'],
+            searchableFields: [['name'], ['marketoGUID']],
+            relationships: [
+              {
+                field: 'email',
+                type: 'child',
+                relatedTo: { name: 'Lead', field: 'email' }
+              }
+            ]
+          }
+        ],
         success: true
       }
     end
@@ -54,7 +59,7 @@ describe Mrkt::CrudCustomObjects do
 
       before do
         stub_request(:get, "https://#{host}/rest/v1/customobjects.json")
-          .with(query: {names: object_names.join(',')})
+          .with(query: { names: object_names.join(',') })
           .to_return(json_stub(response_stub))
       end
 
@@ -67,50 +72,56 @@ describe Mrkt::CrudCustomObjects do
   describe '#describe_custom_object' do
     let(:response_stub) do
       {
-        requestId: "eeef#152858b17d2",
-        result: [{
-          name: "device_c",
-          displayName: "Device",
-          description: "this is a device object",
-          createdAt: "2016-01-23T00:51:18Z",
-          updatedAt: "2016-01-23T00:51:18Z",
-          idField: "marketoGUID",
-          dedupeFields: ["serialNumber"],
-          searchableFields: [["serialNumber"], ["marketoGUID"]],
-          relationships: [{
-            field: "serialNumber",
-            type: "child",
-            relatedTo: {
-              name: "Lead",
-              field: "serialNumber"
-            }
-          }],
-          fields: [{
-            name: "createdAt",
-            displayName: "Created At",
-            dataType: "datetime",
-            updateable: false
-            },
-            { name: "marketoGUID",
-              displayName: "Marketo GUID",
-              dataType: "string",
-              length:36,
-              updateable: false
-            },
-            { name: "updatedAt",
-              displayName: "Updated At",
-              dataType: "datetime",
-              updateable: false
-            },
-            { name: "serialNumber",
-              displayName: "serial number",
-              dataType: "string",
-              length: 255,
-              updateable: true
-            }]
-          }],
-          success: true
-        }
+        requestId: 'eeef#152858b17d2',
+        result: [
+          {
+            name: 'device_c',
+            displayName: 'Device',
+            description: 'this is a device object',
+            createdAt: '2016-01-23T00:51:18Z',
+            updatedAt: '2016-01-23T00:51:18Z',
+            idField: 'marketoGUID',
+            dedupeFields: ['serialNumber'],
+            searchableFields: [['serialNumber'], ['marketoGUID']],
+            relationships: [
+              {
+                field: 'serialNumber',
+                type: 'child',
+                relatedTo: {
+                  name: 'Lead',
+                  field: 'serialNumber'
+                }
+              }
+            ],
+            fields: [
+              {
+                name: 'createdAt',
+                displayName: 'Created At',
+                dataType: 'datetime',
+                updateable: false
+              }, {
+                name: 'marketoGUID',
+                displayName: 'Marketo GUID',
+                dataType: 'string',
+                length: 36,
+                updateable: false
+              }, {
+                name: 'updatedAt',
+                displayName: 'Updated At',
+                dataType: 'datetime',
+                updateable: false
+              }, {
+                name: 'serialNumber',
+                displayName: 'serial number',
+                dataType: 'string',
+                length: 255,
+                updateable: true
+              }
+            ]
+          }
+        ],
+        success: true
+      }
     end
 
     before do
@@ -120,23 +131,22 @@ describe Mrkt::CrudCustomObjects do
 
     subject { client.describe_custom_object(object_name) }
 
-    context "when the object name is valid" do
+    context 'when the object name is valid' do
       let(:object_name) { :device_c }
 
       it { is_expected.to eq(response_stub) }
     end
 
-    context "when the object name is invalid" do
+    context 'when the object name is invalid' do
       let(:object_name) { nil }
 
       it 'should raise an Error' do
-        object_name = []
         expect { subject }.to raise_error(Mrkt::Errors::Unknown)
       end
     end
   end
 
-  describe "#createupdate_custom_objects" do
+  describe '#createupdate_custom_objects' do
     let(:object_name) { 'device' }
 
     let(:devices) do
@@ -179,7 +189,7 @@ describe Mrkt::CrudCustomObjects do
     it { is_expected.to eq(response_stub) }
   end
 
-  describe "#delete_custom_objects" do
+  describe '#delete_custom_objects' do
     let(:object_name) { 'device' }
 
     let(:search_fields) do
@@ -199,8 +209,8 @@ describe Mrkt::CrudCustomObjects do
         success: true,
         result: [{
           seq: 0,
-          status: "deleted",
-          marketoGUID: "1fc49d4fcb86"
+          status: 'deleted',
+          marketoGUID: '1fc49d4fcb86'
         }]
       }
     end
@@ -216,8 +226,8 @@ describe Mrkt::CrudCustomObjects do
     it { is_expected.to eq(response_stub) }
   end
 
-  describe "#get_custom_objects" do
-    let(:object_name) { 'device'}
+  describe '#get_custom_objects' do
+    let(:object_name) { 'device' }
 
     let(:filter_values) do
       [{
@@ -234,13 +244,13 @@ describe Mrkt::CrudCustomObjects do
 
     let(:response_stub) do
       {
-        requestId: "1490d#1528af5232",
+        requestId: '1490d#1528af5232',
         result: [{
           seq: 0,
-          marketoGUID: "163b231LPr23200e570",
-          serialNumber: "serial_number_1",
-          createdAt: "2016-01-23T05:01:01Z",
-          updatedAt: "2016-01-29T00:26:00Z"
+          marketoGUID: '163b231LPr23200e570',
+          serialNumber: 'serial_number_1',
+          createdAt: '2016-01-23T05:01:01Z',
+          updatedAt: '2016-01-29T00:26:00Z'
         }],
         success: true
       }

data/spec/support/initialized_client.rb

@@ -12,7 +12,7 @@ shared_context 'initialized client' do
   subject(:client) { Mrkt::Client.new(host: host, client_id: client_id, client_secret: client_secret) }
 
   before do
-    stub_request(:get, "https://#{host}/identity/oauth/token")
+    @authentication_request_stub = stub_request(:get, "https://#{host}/identity/oauth/token")
       .with(query: { client_id: client_id, client_secret: client_secret, grant_type: 'client_credentials' })
       .to_return(json_stub(authentication_stub))
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mrkt
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - KARASZI István
@@ -9,8 +9,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-10 00:00:00.000000000 Z
+date: 2016-11-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +184,7 @@ files:
 - lib/mrkt/concerns/authentication.rb
 - lib/mrkt/concerns/connection.rb
 - lib/mrkt/concerns/crud_campaigns.rb
+- lib/mrkt/concerns/crud_custom_activities.rb
 - lib/mrkt/concerns/crud_custom_objects.rb
 - lib/mrkt/concerns/crud_helpers.rb
 - lib/mrkt/concerns/crud_leads.rb
@@ -177,6 +198,7 @@ files:
 - mrkt.gemspec
 - spec/concerns/authentication_spec.rb
 - spec/concerns/crud_campaigns_spec.rb
+- spec/concerns/crud_custom_activities_spec.rb
 - spec/concerns/crud_custom_objects_spec.rb
 - spec/concerns/crud_leads_spec.rb
 - spec/concerns/crud_lists_spec.rb
@@ -214,6 +236,7 @@ summary: Marketo REST API Facade
 test_files:
 - spec/concerns/authentication_spec.rb
 - spec/concerns/crud_campaigns_spec.rb
+- spec/concerns/crud_custom_activities_spec.rb
 - spec/concerns/crud_custom_objects_spec.rb
 - spec/concerns/crud_leads_spec.rb
 - spec/concerns/crud_lists_spec.rb