ruby-pardot 1.2.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33f862629251e35bc4abea0f50af5fbd34e83d2b561529107dda17f5c5fe5bf8
-  data.tar.gz: 773061f478695e10e26c2f17ea36ba1a81ee2a241797426e1581a02ac59f24d1
+  metadata.gz: f3bbcca81ecfa08ef3cfb444a8117ef8a708f3e6975336e0f48fd480972449a6
+  data.tar.gz: 1f4b717f3150591b35ae17d96a5da3382235988afbe06c646cb84dfd198a7461
 SHA512:
-  metadata.gz: 439fc348827c87938b93035b7b1d6bcdb6a043e49897041b9b45029b9f95dd3b562db3a3cad345b58dde4b9bb0c21823d311f18c90d4f593562b8d7e695f7f29
-  data.tar.gz: b63c4c6083d3c86d2204ea43638a3133bf619a746d5c355d29a47c4c2dd326a68e1a5a77322183655829be0d0959b335a67f816a5bd7ad30609ef23b7b4325e3
+  metadata.gz: e0da946b746fed6cd5091b6d6e55d978a6cee69f641aa7e01040013d3ca81538eeec91424b6e23ca7232975cc100716681eba97007dd60d68f35f9c2bb5e0c6f
+  data.tar.gz: 519af7a9e7870b7a8da0242c7c6fd2f011ac46251a24f1fcd5f82117191f596c565032927bbdd152b76a3137038679d02355b750389ecd6d74c600d136c7d17c

data/.gitignore

@@ -1,3 +1,5 @@
 pkg/*
 *.gem
 .bundle
+.vscode
+bin

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  NewCops: enable
+
+Metrics/BlockLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Layout/LineLength:
+  Enabled: false

data/Gemfile

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

data/Gemfile.lock

@@ -1,40 +1,47 @@
 PATH
   remote: .
   specs:
-    ruby-pardot (1.2.0)
+    ruby-pardot (1.4.0)
       crack (= 0.4.3)
-      httparty (= 0.13.1)
+      httparty (= 0.18.1)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    diff-lcs (1.1.2)
+    diff-lcs (1.4.4)
     fakeweb (1.3.0)
-    httparty (0.13.1)
-      json (~> 1.8)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    json (1.8.6)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.1104)
     multi_xml (0.6.0)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
-    safe_yaml (1.0.4)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    safe_yaml (1.0.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (>= 1.10)
-  fakeweb
-  rspec
+  fakeweb (= 1.3.0)
+  rspec (= 3.5.0)
   ruby-pardot!
 
 BUNDLED WITH
-   2.0.1
+   2.2.7

data/README.rdoc

@@ -8,18 +8,23 @@ Add the following to your Gemfile
 
 === Authentication
 
-The client will authenticate before performing other API calls, but you can manually authenticate as well
-
-  client = Pardot::Client.new email, password, user_key
-  
-  # will raise a Pardot::ResponseError if login fails
-  # will raise a Pardot::NetError if the http call fails
-  client.authenticate
-  
+In order to use this client, an access token retrieved from Salesforce OAuth must be specified. See
+the [authetication documentation on developer.pardot.com](https://developer.pardot.com/kb/authentication/) for more information.
+
+  require "ruby-pardot"
+
+  version = 3 # or 4
+  access_token = '<access_token>' # Retrieve an access token from Salesforce using OAuth
+  business_unit_id = '<business_unit_id>' # Specify the Business Unit ID of the account to access
+  client = Pardot::Client.new nil, nil, nil, version, access_token, business_unit_id
+
+Usage of the username, password, and API key authentication is deprecated and will be removed in an upcoming release.
+
 === Object Types
 
 The available objects are:
 
+* custom_fields 
 * emails
 * lists
 * opportunities
@@ -30,15 +35,15 @@ The available objects are:
 * visits
 
 === Querying Objects
-  
+
 http://developer.pardot.com/kb/api-version-3/querying-prospects
-  
+
 Most objects accept limit, offset, sort_by, and sord_order parameters
 
   prospects = client.prospects.query(:assigned => false, :sort_by => "last_activity_at", :limit => 20)
-  
+
   prospects["total_results"] # number of prospects found
-  
+
   prospects["prospect"].each do |prospect|
     puts prospect["first_name"]
   end
@@ -50,11 +55,11 @@ See each individual object's API reference page for available methods
 http://developer.pardot.com/kb/api-version-3/using-prospects
 
   prospect = client.prospects.create("user@test.com", :first_name => "John", :last_name => "Doe")
-  
+
   prospect.each do |key, value|
     puts "#{key} is #{value}"
   end
-  
+
 === Emails
 
 See each individual call's [API reference page](http://developer.pardot.com/kb/api-version-3/introduction-table-of-contents).
@@ -63,15 +68,15 @@ See each individual call's [API reference page](http://developer.pardot.com/kb/a
   @pardot.emails.read_by_id(email_id)
   @pardot.emails.send_to_list(:email_template_id => template_id, 'list_ids[]' => list_id, :campaign_id => campaign_id)
   @pardot.emails.send_to_prospect(prospect_id, :campaign_id => campaign_id, :email_template_id => template_id)
-  
+
 === Output formats
-  
+
   client.format = "simple" # default
   client.format = "mobile"
   client.format = "full"
 
 === Error handling
-  
+
 Pardot will respond with an error message when you provide invalid parameters
 
   begin
@@ -81,7 +86,7 @@ Pardot will respond with an error message when you provide invalid parameters
   end
 
 Performing API calls across the internet is inherently unsafe, so be sure to catch the exceptions
-  
+
   begin
     visitor = client.visitors.query(:id_greater_than => 200)
   rescue Pardot::NetError => e

data/Rakefile

@@ -1,11 +1,10 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-
 require 'rspec/core'
 require 'rspec/core/rake_task'
 
-desc "Run all specs"
+desc 'Run all specs'
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = "./spec/**/*_spec.rb"
+  t.pattern = './spec/**/*_spec.rb'
 end

data/lib/pardot/authentication.rb

@@ -1,29 +1,40 @@
 module Pardot
   module Authentication
-    
+    # @deprecated Use of username and password authentication is deprecated.
     def authenticate
-      resp = post "login", nil, nil, nil, :email => @email, :password => @password, :user_key => @user_key
-      update_version(resp["version"]) if resp && resp["version"]
-      @api_key = resp && resp["api_key"]
+      if using_salesforce_access_token?
+        raise 'Authentication not available when using Salesforce access token. See https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_oauth_and_connected_apps.htm for more information.'
+      end
+
+      warn '[DEPRECATION] Use of username and password authentication is deprecated in favor of Salesforce OAuth. See https://developer.pardot.com/kb/authentication/ for more information.'
+      resp = post 'login', nil, nil, nil, email: @email, password: @password, user_key: @user_key
+      update_version(resp['version']) if resp && resp['version']
+      @api_key = resp && resp['api_key']
     end
-    
+
     def authenticated?
-      @api_key != nil
+      !@api_key.nil? || !@salesforce_access_token.nil?
+    end
+
+    def using_salesforce_access_token?
+      @salesforce_access_token != nil
     end
-    
+
     def reauthenticate
+      if using_salesforce_access_token?
+        raise 'Reauthentication not available when using Salesforce access token. See https://developer.salesforce.com/docs/atlas.en-us.mobile_sdk.meta/mobile_sdk/oauth_refresh_token_flow.htm for more information.'
+      end
+
+      warn '[DEPRECATION] Use Salesforce OAuth to refresh the Salesforce access token. See https://developer.salesforce.com/docs/atlas.en-us.mobile_sdk.meta/mobile_sdk/oauth_refresh_token_flow.htm for more information.'
       @api_key = nil
       authenticate
     end
 
     private
 
-    def update_version version
-      if version.is_a? Array
-        version = version.last
-      end
+    def update_version(version)
+      version = version.last if version.is_a? Array
       @version = version if version.to_i > 3
     end
-
   end
 end

data/lib/pardot/client.rb

@@ -1,7 +1,5 @@
 module Pardot
-
   class Client
-
     include HTTParty
     base_uri 'https://pi.pardot.com'
     format :xml
@@ -9,6 +7,7 @@ module Pardot
     include Authentication
     include Http
 
+    include Objects::CustomFields
     include Objects::Emails
     include Objects::Lists
     include Objects::ListMemberships
@@ -20,16 +19,29 @@ module Pardot
     include Objects::Visits
     include Objects::VisitorActivities
 
-    attr_accessor :email, :password, :user_key, :api_key, :version, :format
+    attr_accessor :email, :password, :user_key, :api_key, :version, :salesforce_access_token, :business_unit_id, :format
+
+    # @deprecated Arguments email, password and user_key are deprecated. Use salesforce_access_token with Salesforce OAuth.
+    def initialize(email = nil, password = nil, user_key = nil, version = 3, salesforce_access_token = nil, business_unit_id = nil)
+      unless email.nil? || password.nil? || user_key.nil?
+        warn '[DEPRECATION] Use of username and password authentication is deprecated in favor of Salesforce OAuth. See https://developer.pardot.com/kb/authentication/ for more information.'
+      end
+
+      if !salesforce_access_token.nil? && business_unit_id.nil?
+        raise 'business_unit_id required when using Salesforce access_token'
+      end
+      if !business_unit_id.nil? && (!business_unit_id.start_with?('0Uv') || business_unit_id.length != 18)
+        raise "Invalid business_unit_id value. Expected ID to start with '0Uv' and be length of 18 characters."
+      end
 
-    def initialize email, password, user_key, version = 3
       @email = email
       @password = password
       @user_key = user_key
       @version = version
+      @salesforce_access_token = salesforce_access_token
+      @business_unit_id = business_unit_id
 
-      @format = "simple"
+      @format = 'simple'
     end
-
   end
 end

data/lib/pardot/error.rb

@@ -1,19 +1,23 @@
 module Pardot
   class Error < StandardError; end
+
   class NetError < Error; end
+
   class ExpiredApiKeyError < Error; end
 
+  class AccessTokenExpiredError < Error; end
+
   class ResponseError < Error
     def initialize(res)
       @res = res
     end
 
     def to_s
-      @res["__content__"]
+      @res['__content__']
     end
 
     def code
-      @res["code"].to_i
+      @res['code'].to_i
     end
 
     def inspect

data/lib/pardot/http.rb

@@ -1,70 +1,80 @@
 module Pardot
   module Http
-    
-    def get object, path, params = {}, num_retries = 0
+    def get(object, path, params = {}, num_retries = 0)
       smooth_params object, params
       full_path = fullpath object, path
-      check_response self.class.get(full_path, :query => params)
-      
+      headers = create_auth_header object
+      check_response self.class.get(full_path, query: params, headers: headers)
     rescue Pardot::ExpiredApiKeyError => e
       handle_expired_api_key :get, object, path, params, num_retries, e
-      
     rescue SocketError, Interrupt, EOFError, SystemCallError, Timeout::Error, MultiXml::ParseError => e
-      raise Pardot::NetError.new(e)
+      raise Pardot::NetError, e
     end
-    
-    def post object, path, params = {}, num_retries = 0, bodyParams = {}
+
+    def post(object, path, params = {}, num_retries = 0, bodyParams = {})
       smooth_params object, params
       full_path = fullpath object, path
-      check_response self.class.post(full_path, :query => params, :body => bodyParams)
-      
+      headers = create_auth_header object
+      check_response self.class.post(full_path, query: params, body: bodyParams, headers: headers)
     rescue Pardot::ExpiredApiKeyError => e
       handle_expired_api_key :post, object, path, params, num_retries, e
-      
     rescue SocketError, Interrupt, EOFError, SystemCallError, Timeout::Error, MultiXml::ParseError => e
-      raise Pardot::NetError.new(e)
+      raise Pardot::NetError, e
     end
-    
+
     protected
-    
-    def handle_expired_api_key method, object, path, params, num_retries, e
+
+    # @deprecated With Salesforce OAuth, this method will never be invoked.
+    def handle_expired_api_key(method, object, path, params, num_retries, e)
       raise e unless num_retries == 0
-      
+
       reauthenticate
-      
+
       send(method, object, path, params, 1)
     end
-    
-    def smooth_params object, params
-      return if object == "login"
-      
+
+    def smooth_params(object, params)
+      return if object == 'login'
+
       authenticate unless authenticated?
-      params.merge! :user_key => @user_key, :api_key => @api_key, :format => @format
+      params.merge! format: @format
     end
-    
-    def check_response http_response
-      rsp = http_response["rsp"]
-      
-      error = rsp["err"] if rsp
-      error ||= "Unknown Failure: #{rsp.inspect}" if rsp && rsp["stat"] == "fail"
+
+    def create_auth_header(object)
+      return if object == 'login'
+
+      if using_salesforce_access_token?
+        {
+          :Authorization => "Bearer #{@salesforce_access_token}",
+          'Pardot-Business-Unit-Id' => @business_unit_id
+        }
+      else
+        { Authorization: "Pardot api_key=#{@api_key}, user_key=#{@user_key}" }
+      end
+    end
+
+    def check_response(http_response)
+      rsp = http_response['rsp']
+
+      error = rsp['err'] if rsp
+      error ||= "Unknown Failure: #{rsp.inspect}" if rsp && rsp['stat'] == 'fail'
       content = error['__content__'] if error.is_a?(Hash)
-      
-      if [error, content].include?("Invalid API key or user key") && @api_key
-        raise ExpiredApiKeyError.new @api_key
+
+      if [error, content].grep(/access_token is invalid/).any? && using_salesforce_access_token?
+        raise AccessTokenExpiredError,
+              'Access token is invalid. Use Salesforce OAuth to refresh the existing Salesforce access token or to retrieve a new token. See https://developer.salesforce.com/docs/atlas.en-us.mobile_sdk.meta/mobile_sdk/oauth_refresh_token_flow.htm for more information.'
       end
-      
-      raise ResponseError.new error if error
-      
+      raise ExpiredApiKeyError, @api_key if [error, content].include?('Invalid API key or user key') && @api_key
+
+      raise ResponseError, error if error
+
       rsp
     end
-    
-    def fullpath object, path
-      full = File.join("/api", object, "version", @version.to_s)
-      unless path.nil?
-        full = File.join(full, path)
-      end
+
+    def fullpath(object, path)
+      full = File.join('/api', object, 'version', @version.to_s)
+      full = File.join(full, path) unless path.nil?
       full
     end
-    
   end
 end