marketo_chef 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c36b0fb24e96ea385f40fa34880052e0d01908f
+  data.tar.gz: 9dcf3329d2f194cdf092713d783475c0d543adcc
+SHA512:
+  metadata.gz: bb2b0184f2497951fb2ab25ee12f619eaca6b120bf31fb61af55c428de5f15d85a78cf557e6d1a3bcb7c9993d8f4272642daa6a053f2b20ce7abbd08ebca5d1a
+  data.tar.gz: 67a90747de4831b81b40f11f4d1da75fbd514ba2998d90799a130196fcbd90e648f51e006a1f3906d1065a9251a9a07a8dd061f882798c4b1eaf7a2077cbcc3d

data/.env.example

@@ -0,0 +1,4 @@
+MARKETO_HOST="123-ABC-456.mktorest.com"
+MARKETO_CLIENT_ID="c4206ec5-be87-465c-a0cc-99486a4c4e1b"
+MARKETO_CLIENT_SECRET="Z5bzTySMrFdgcFZkSNvBywMuUen9ah7Q"
+MARKETO_CAMPAIGN_ID="1234"

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-gemset

@@ -0,0 +1 @@
+marketo_chef

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -0,0 +1,3 @@
+sudo: false
+language: ruby
+before_install: gem install bundler -v 1.14.6

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [1.0.2] - 2017.07.06
+### Changed
+- Marketo error codes are declared as Strings
+- Pass the `reasons` array from the response to `handle_skipped`
+
+## [1.0.1] - 2017.06.27
+### Added
+- Release history via CHANGELOG.md
+- Documentation via README.md
+- Checking response for communication failure (2d9f5c822a95187968944420998dc741fb8f2024)
+
+### Changed
+- Error handling around response-level errors
+- Lower required Faraday version due to transitive dependencies in client
+  applications (ce4109847c3569c1f2b442d32a530e32b8ae74bd)
+
+## [0.1.0] - 2017.05.05
+### Added
+- Method to add lead, assign to campaign

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in marketo_chef.gemspec
+gemspec

data/README.md

@@ -0,0 +1,85 @@
+# MarketoChef
+
+This gem defines a Marketo API client providing a simple interface to our
+single common use case: adding a lead to the Marketo database and assigning it
+to a specific campaign.
+
+[![Build Status](https://travis-ci.com/chef/marketo_chef.svg?token=QMKWuXEPx23uB8JGd4tb&branch=master)](https://travis-ci.com/chef/marketo_chef)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby gem 'marketo_chef' ```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install marketo_chef
+
+## Usage
+
+The gem expects client code to configure it before use. Like so:
+```ruby
+MarketoChef.configure do |c|
+  c.host          = ENV['MARKETO_HOST']
+  c.client_id     = ENV['MARKETO_CLIENT_ID']
+  c.client_secret = ENV['MARKETO_CLIENT_SECRET']
+  c.campaign_id   = ENV['MARKETO_CAMPAIGN_ID']
+end
+```
+Conventionally this would be added to an initializer in Rails or Hanami, for
+example in a file `config/initializers/01_marketo_chef.rb`, with Rails. This
+ensures the application will attempt to configure the gem at start time rather
+than later, when discovering that configuration values aren't available
+(perhaps an environment variable name is incorrect) will generate unexpected
+errors.
+
+Required environment variables, with bogus example values:
+```shell
+MARKETO_HOST="123-ABC-456.mktorest.com"
+MARKETO_CLIENT_ID="c4206ec5-be87-465c-a0cc-99486a4c4e1b"
+MARKETO_CLIENT_SECRET="Z5bzTySMrFdgcFZkSNvBywMuUen9ah7Q"
+MARKETO_CAMPAIGN_ID="1234"
+```
+
+The gem exposes a single method for lead tracking, which accepts a hash of lead
+data, creates or updates the lead in Marketo, and adds it to the specified
+campaign.
+
+```ruby
+MarketoChef.add_lead(
+  'formname':         'Some Form',
+  'product-interest': 'some-interest',
+  'firstName':        'Jane',
+  'lastName':         'Doe',
+  'email':            'jdoe@example.com',
+  'company':          'ExampleCo'
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+You can also run `rubocop` to verify style guide adherence. It happens along
+with the tests in CI, but better to catch those problems before committing and
+pushing and so on.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `version.rb`, then
+create a git tag for the version, and update CHANGELOG.md to document the
+release. Finally, push git commits and tags to GitHub.
+
+This gem is not public and should not be published to rubygems.org.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/chef/marketo_chef.

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+desc 'continuous integration tasks'
+task ci: %i[test rubocop] do
+end
+
+task :rubocop do
+  sh 'rubocop'
+end
+
+task default: :ci

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'marketo_chef'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/marketo_chef.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+require 'marketo_chef/client'
+require 'marketo_chef/configuration'
+require 'marketo_chef/version'
+
+# Common usage of the Marketo API for our web properties
+module MarketoChef
+  # http://developers.marketo.com/rest-api/error-codes/#response_level_errors
+  # 607: Daily API Request Limit Reached
+  # 611: System Error (generic unhandled exception)
+  RESPONSE_ERROR_CODES = %w[607 611].freeze
+
+  # http://developers.marketo.com/rest-api/error-codes/#record_level_errors
+  # 1001: Invalid value '%s'. Required of type '%s'
+  # 1002: Missing value for required parameter '%s'
+  # 1003: Invalid data
+  # 1006: Field '%s' not found
+  # 1007: Multiple leads match the lookup criteria
+  # ...these are the only ones we might need to care about currently
+  MAYBE_OUR_FAULT_CODES   = %w[1003 1006].freeze
+  MAYBE_THEIR_FAULT_CODES = %w[1001 1002].freeze
+
+  class << self
+    extend Forwardable
+
+    def_delegators :configuration,
+                   :campaign_id, :client_id, :client_secret, :host
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+
+      configuration.validate
+    end
+
+    def add_lead(lead)
+      result = sync(lead)
+
+      return unless result
+
+      handle_skipped(lead, result['reasons']) if result['status'] == 'skipped'
+
+      trigger_campaign(campaign_id, result['id']) if result.key?('id')
+    end
+
+    private
+
+    def sync(lead)
+      response = Client.instance.sync_lead(lead)
+
+      if response.key?('errors')
+        handle_response_err(response)
+      else
+        response['result']&.first
+      end
+    end
+
+    def trigger_campaign(campaign_id, lead_id)
+      response = Client.instance.trigger_campaign(campaign_id, lead_id)
+
+      campaign_error(campaign_id, lead_id, response) if response.key?('errors')
+
+      response
+    end
+
+    def capture_error(message)
+      puts message
+      Raven.capture_exception(Exception.new(message))
+    end
+
+    def handle_response_err(response)
+      codes      = ->(c) { c['code'] }
+      known      = ->(c) { RESPONSE_ERROR_CODES.include?(c) }
+      feedback   = ->(r) { "#{r['code']}: #{r['message']}" }
+
+      return if reasons.collect(&codes).any?(&known)
+
+      response_error(response.reject(&known).collect(&feedback))
+    end
+
+    def handle_skipped(lead, reasons)
+      codes      = ->(c) { c['code'] }
+      reportable = ->(c) { MAYBE_OUR_FAULT_CODES.include?(c) }
+      feedback   = ->(r) { "#{r['code']}: #{r['message']}" }
+
+      return unless reasons.collect(&codes).any?(&reportable)
+
+      skipped_lead_error(lead, reasons.collect(&feedback))
+    rescue TypeError => error
+      skipped_lead_type_error(lead, reasons, error)
+    end
+
+    def response_error(reasons)
+      capture_error <<~ERR
+        Response Error:\n
+        \t#{reasons.join("\n\t")}
+      ERR
+    end
+
+    def campaign_error(campaign_id, lead, errors)
+      capture_error <<~ERR
+        Campaign Triggering Error: #{errors}\n
+        \tcampaign id: #{campaign_id}\n
+        \tlead: #{lead}
+      ERR
+    end
+
+    def skipped_lead_error(lead, reasons)
+      capture_error <<~ERR
+        Lead Submission Skipped:\n
+        \tinput: #{lead}\n
+        \t#{reasons.join("\n\t")}
+      ERR
+    end
+
+    def skipped_lead_type_error(lead, reasons, error)
+      capture_error <<~ERR
+        Something went wrong trying to parse this skipped lead response:\n
+        \tLead: #{lead}\n
+        \tReasons: #{reasons}\n
+        \tError: #{error}
+      ERR
+    end
+  end
+end

data/lib/marketo_chef/client.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'singleton'
+
+require 'faraday'
+require 'faraday_middleware'
+
+module MarketoChef
+  # Faraday wrapper to handle communication with Marketo API
+  class Client
+    include Singleton
+    extend Forwardable
+
+    def_delegators :MarketoChef, :client_id, :client_secret, :host
+
+    def sync_lead(lead)
+      authenticate!
+
+      connection.post do |req|
+        req.url '/rest/v1/leads.json'
+        req.headers[:authorization] = "Bearer #{@token}"
+        req.body = { action: 'createOrUpdate', input: [lead] }
+      end.body
+    end
+
+    def trigger_campaign(campaign_id, lead_id)
+      authenticate!
+
+      connection.post do |req|
+        req.url "/rest/v1/campaigns/#{campaign_id}/trigger.json"
+        req.headers[:authorization] = "Bearer #{@token}"
+        req.body = { input: { leads: [{ id: lead_id }] } }
+      end.body
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(url: "https://#{host}") do |conn|
+        conn.request  :multipart
+        conn.request  :json
+        conn.response :json, content_type: /\bjson$/
+        conn.adapter  Faraday.default_adapter
+      end
+    end
+
+    def authenticate!
+      authenticate unless authenticated?
+    end
+
+    def authenticated?
+      @token && valid_token?
+    end
+
+    def valid_token?
+      return false unless defined?(@valid_until)
+
+      Time.now < @valid_until
+    end
+
+    def authenticate
+      connection.get('/identity/oauth/token', auth_params).tap do |res|
+        inspect_auth_response(res.body)
+
+        save_authentication(res.body)
+      end
+    end
+
+    def inspect_auth_response(body)
+      # res.body may be an HTML string, "The document has moved" message,
+      # which occurs if the host is mktoapi.com instead of mktorest.com.
+      raise body if body.is_a?(String)
+      raise body['errors'][0]['message'] if body.key?('errors')
+    end
+
+    def auth_params
+      {
+        grant_type:    'client_credentials',
+        client_id:     client_id,
+        client_secret: client_secret
+      }
+    end
+
+    def save_authentication(data)
+      @token       = data.fetch('access_token')
+      @token_type  = data.fetch('token_type')
+      @valid_until = Time.now + data.fetch('expires_in')
+      @scope       = data.fetch('scope')
+    end
+  end
+end

data/lib/marketo_chef/configuration.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module MarketoChef
+  # Store and validate Marketo client configuration data
+  class Configuration
+    FIELDS = %i[host client_id client_secret campaign_id].freeze
+
+    attr_accessor :client_id, :client_secret, :campaign_id
+    attr_reader :host
+
+    def initialize(config = {})
+      return unless config.any?
+
+      config.map { |k, v| send("#{k}=", v) if FIELDS.include?(k) }
+    end
+
+    def host=(value)
+      value = value.sub('mktoapi', 'mktorest')
+
+      match = %r{https?:\/\/(.+)}.match(value)
+
+      @host = match ? match[1] : value
+    end
+
+    def validate
+      missing = ->(f) { !instance_variable_defined?(:"@#{f}") }
+      bomb    = ->(f) { raise "Required Marketo configuration undefined: #{f}" }
+
+      FIELDS.select(&missing).map(&bomb)
+    end
+  end
+end

data/lib/marketo_chef/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MarketoChef
+  VERSION = '1.0.2'
+end

data/marketo_chef.gemspec

@@ -0,0 +1,51 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'marketo_chef/version'
+
+# rubocop:disable Style/GuardClause
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  spec.name     = 'marketo_chef'
+  spec.version  = MarketoChef::VERSION
+  spec.authors  = ['Trevor Bramble']
+  spec.email    = ['tbramble@chef.io']
+
+  spec.summary  = 'Marketo API client for our common uses and error handling'
+  spec.homepage = 'https://github.com/chef/marketo_chef'
+
+  spec.licenses = [] # closed-source
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
+  # 'allowed_push_host' to allow pushing to a single host or delete this
+  # section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = 'https://ixnay.ushpay'
+  # else
+  #   raise 'RubyGems >= 2.0 required to protect against public gem pushes.'
+  # end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # This gem needs to be compatible with OmniAuth (used on the Learn Chef site)
+  # which depends on the OAuth2 gem, which requires faraday ['>= 0.8', '< 0.12']
+  # https://github.com/intridea/oauth2/blob/v1.3.1/oauth2.gemspec
+  spec.add_runtime_dependency 'faraday',            '~> 0.11.0'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.11'
+
+  spec.add_development_dependency 'bundler',            '~> 1.14'
+  spec.add_development_dependency 'minitest',           '~> 5.10'
+  spec.add_development_dependency 'rake',               '~> 12.0'
+  spec.add_development_dependency 'rspec-expectations', '~> 3.6'
+  spec.add_development_dependency 'rubocop',            '~> 0.48'
+  spec.add_development_dependency 'travis',             '~> 1.8'
+end
+# rubocop:enable Metrics/BlockLength
+# rubocop:enable Style/GuardClause

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: marketo_chef
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Trevor Bramble
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.11.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+- !ruby/object:Gem::Dependency
+  name: travis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: 
+email:
+- tbramble@chef.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/marketo_chef.rb
+- lib/marketo_chef/client.rb
+- lib/marketo_chef/configuration.rb
+- lib/marketo_chef/version.rb
+- marketo_chef.gemspec
+homepage: https://github.com/chef/marketo_chef
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Marketo API client for our common uses and error handling
+test_files: []