ruby-pardot 1.3.2 → 1.4.0

data/lib/pardot/objects/visitor_activities.rb

@@ -1,41 +1,37 @@
 module Pardot
   module Objects
     module VisitorActivities
-      
       def visitor_activities
         @visitor_activities ||= VisitorActivities.new self
       end
-      
+
       class VisitorActivities
-        
-        def initialize client
+        def initialize(client)
           @client = client
         end
-        
-        def query params
-          result = get "/do/query", params, "result"
-          result["total_results"] = result["total_results"].to_i if result["total_results"]
+
+        def query(params)
+          result = get '/do/query', params, 'result'
+          result['total_results'] = result['total_results'].to_i if result['total_results']
           result
         end
-        
-        def read id, params = {}
+
+        def read(id, params = {})
           post "/do/read/id/#{id}", params
         end
-        
+
         protected
-        
-        def get path, params = {}, result = "visitorActivity"
-          response = @client.get "visitorActivity", path, params
+
+        def get(path, params = {}, result = 'visitorActivity')
+          response = @client.get 'visitorActivity', path, params
           result ? response[result] : response
         end
-        
-        def post path, params = {}, result = "visitorActivity"
-          response = @client.post "visitorActivity", path, params
+
+        def post(path, params = {}, result = 'visitorActivity')
+          response = @client.post 'visitorActivity', path, params
           result ? response[result] : response
         end
-        
       end
-      
     end
   end
 end

data/lib/pardot/objects/visitors.rb

@@ -1,45 +1,41 @@
 module Pardot
   module Objects
     module Visitors
-      
       def visitors
         @visitors ||= Visitors.new self
       end
-      
+
       class Visitors
-        
-        def initialize client
+        def initialize(client)
           @client = client
         end
-        
-        def query params
-          result = get "/do/query", params, "result"
-          result["total_results"] = result["total_results"].to_i if result["total_results"]
+
+        def query(params)
+          result = get '/do/query', params, 'result'
+          result['total_results'] = result['total_results'].to_i if result['total_results']
           result
         end
-        
-        def assign id, params = {}
+
+        def assign(id, params = {})
           post "/do/assign/id/#{id}", params
         end
-        
-        def read id, params = {}
+
+        def read(id, params = {})
           post "/do/read/id/#{id}", params
         end
-        
+
         protected
-        
-        def get path, params = {}, result = "visitor"
-          response = @client.get "visitor", path, params
+
+        def get(path, params = {}, result = 'visitor')
+          response = @client.get 'visitor', path, params
           result ? response[result] : response
         end
-        
-        def post path, params = {}, result = "visitor"
-          response = @client.post "visitor", path, params
+
+        def post(path, params = {}, result = 'visitor')
+          response = @client.post 'visitor', path, params
           result ? response[result] : response
         end
-        
       end
-      
     end
   end
 end

data/lib/pardot/objects/visits.rb

@@ -1,41 +1,37 @@
 module Pardot
   module Objects
     module Visits
-      
       def visits
         @visits ||= Visits.new self
       end
-      
+
       class Visits
-        
-        def initialize client
+        def initialize(client)
           @client = client
         end
-        
-        def query params
-          result = get "/do/query", params, "result"
-          result["total_results"] = result["total_results"].to_i if result["total_results"]
+
+        def query(params)
+          result = get '/do/query', params, 'result'
+          result['total_results'] = result['total_results'].to_i if result['total_results']
           result
         end
-        
-        def read id, params = {}
+
+        def read(id, params = {})
           post "/do/read/id/#{id}", params
         end
-        
+
         protected
-        
-        def get path, params = {}, result = "visit"
-          response = @client.get "visit", path, params
+
+        def get(path, params = {}, result = 'visit')
+          response = @client.get 'visit', path, params
           result ? response[result] : response
         end
-        
-        def post path, params = {}, result = "visit"
-          response = @client.post "visit", path, params
+
+        def post(path, params = {}, result = 'visit')
+          response = @client.post 'visit', path, params
           result ? response[result] : response
         end
-        
       end
-      
     end
   end
 end

data/lib/pardot/version.rb

@@ -1,3 +1,3 @@
 module Pardot
-  VERSION = "1.3.2"
+  VERSION = '1.4.0'
 end

data/ruby-pardot.gemspec

@@ -1,27 +1,29 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path("../lib/pardot/version", __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('lib/pardot/version', __dir__)
 
 Gem::Specification.new do |s|
-  s.name        = "ruby-pardot"
+  s.name        = 'ruby-pardot'
   s.version     = Pardot::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Dan Cunning"]
-  s.email       = ["support@pardot.com"]
-  s.homepage    = "http://github.com/pardot/ruby-pardot"
-  s.summary     = "Library for interacting with the Pardot API"
-  s.description = "Library for interacting with the Pardot API"
+  s.authors     = ['Dan Cunning']
+  s.email       = ['support@pardot.com']
+  s.homepage    = 'http://github.com/pardot/ruby-pardot'
+  s.summary     = 'Library for interacting with the Pardot API'
+  s.description = 'Library for interacting with the Pardot API'
 
+  s.required_ruby_version = '>= 2.6'
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project         = "ruby-pardot"
 
-  s.add_dependency "crack", "0.4.3"
-  s.add_dependency "httparty", "0.18.1"
+  s.add_dependency 'crack', '0.4.3'
+  s.add_dependency 'httparty', '0.18.1'
 
   s.add_development_dependency "bundler", ">= 1.10"
   s.add_development_dependency "rspec", "3.5.0"
-  s.add_development_dependency "fakeweb"
+  s.add_development_dependency "fakeweb", "1.3.0"
 
   s.files        = `git ls-files`.split("\n")
-  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.executables  = `git ls-files`.split("\n").map { |f| f =~ %r{^bin/(.*)} ? Regexp.last_match(1) : nil }.compact
   s.require_path = 'lib'
 end

data/spec/pardot/authentication_spec.rb

@@ -1,91 +1,125 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+# frozen_string_literal: true
+
+require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
 
 describe Pardot::Authentication do
-  
   def create_client
-    @client = Pardot::Client.new "user@test.com", "foo", "bar"
+    @client = Pardot::Client.new 'user@test.com', 'foo', 'bar'
+  end
+
+  def create_client_using_salesforce_access_token
+    @client = Pardot::Client.new nil, nil, nil, 3, 'access_token_value', '0Uv000000000001CAA'
   end
-  
-  describe "authenticate" do
-    
+
+  describe 'authenticate with Salesforce access_token' do
+    before do
+      @client = create_client_using_salesforce_access_token
+    end
+
+    it 'raises error when calling authenticate' do
+      expect do
+        @client.authenticate
+      end.to raise_error.with_message(/Authentication not available when using Salesforce access token/)
+    end
+
+    it 'raises error when calling reauthenticate' do
+      expect do
+        @client.reauthenticate
+      end.to raise_error.with_message(/Reauthentication not available when using Salesforce access token/)
+    end
+
+    it 'returns true for authenticated' do
+      expect(@client.authenticated?).to eq(true)
+    end
+
+    it 'returns true for using_salesforce_access_token' do
+      expect(@client.using_salesforce_access_token?).to eq(true)
+    end
+  end
+
+  describe 'authenticate' do
     before do
       @client = create_client
-      
-      fake_post "/api/login/version/3",
+
+      fake_post '/api/login/version/3',
                 %(<?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="ok" version="1.0">\n   <api_key>my_api_key</api_key>\n</rsp>\n)
     end
-    
+
     def authenticate
       @client.authenticate
     end
 
-    def verifyBody
+    def verify_body
       expect(FakeWeb.last_request.body).to eq('email=user%40test.com&password=foo&user_key=bar')
     end
-    
-    it "should return the api key" do
-      expect(authenticate).to eq("my_api_key")
+
+    it 'should return the api key' do
+      expect(authenticate).to eq('my_api_key')
     end
-    
-    it "should set the api key" do
+
+    it 'should set the api key' do
       authenticate
-      expect(@client.api_key).to eq("my_api_key")
-      verifyBody
+      expect(@client.api_key).to eq('my_api_key')
+      verify_body
     end
-    
-    it "should make authenticated? true" do
+
+    it 'should make authenticated? true' do
       authenticate
       expect(@client.authenticated?).to eq(true)
-      verifyBody
+      verify_body
     end
 
-    it "should use version 3" do
+    it 'should use version 3' do
       authenticate
       expect(@client.version.to_i).to eq(3)
-      verifyBody
+      verify_body
+    end
+
+    it 'returns false for using_salesforce_access_token' do
+      expect(@client.using_salesforce_access_token?).to eq(false)
+
+      authenticate
+      expect(@client.using_salesforce_access_token?).to eq(false)
+      verify_body
     end
-    
   end
 
-  describe "authenticateV4" do
-    
+  describe 'authenticateV4' do
     before do
       @client = create_client
-      
-      fake_post "/api/login/version/3",
+
+      fake_post '/api/login/version/3',
                 %(<?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="ok" version="1.0">\n   <api_key>my_api_key</api_key>\n<version>4</version>\n</rsp>\n)
     end
-    
+
     def authenticate
       @client.authenticate
     end
 
-    def verifyBody
+    def verify_body
       expect(FakeWeb.last_request.body).to eq('email=user%40test.com&password=foo&user_key=bar')
     end
-    
-    it "should return the api key" do
-      expect(authenticate).to eq("my_api_key")
+
+    it 'should return the api key' do
+      expect(authenticate).to eq('my_api_key')
     end
-    
-    it "should set the api key" do
+
+    it 'should set the api key' do
       authenticate
-      expect(@client.api_key).to eq("my_api_key")
-      verifyBody
+      expect(@client.api_key).to eq('my_api_key')
+      verify_body
     end
-    
-    it "should make authenticated? true" do
+
+    it 'should make authenticated? true' do
       authenticate
       expect(@client.authenticated?).to eq(true)
-      verifyBody
+      verify_body
     end
 
-    it "should use version 4" do
+    it 'should use version 4' do
       authenticate
       expect(@client.version.to_i).to eq(4)
-      verifyBody
+      verify_body
     end
-    
   end
-  
-end
+end

data/spec/pardot/client_spec.rb

@@ -1,28 +1,63 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+# frozen_string_literal: true
+
+require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
 
 describe Pardot::Client do
-  
   def create_client
-    @client = Pardot::Client.new "user@test.com", "foo", "bar"
+    @client = Pardot::Client.new 'user@test.com', 'foo', 'bar'
+  end
+
+  describe 'client with Salesforce access_token' do
+    it 'should set properties' do
+      @client = Pardot::Client.new nil, nil, nil, 3, 'access_token_value', '0Uv000000000001CAA'
+      expect(@client.email).to eq(nil)
+      expect(@client.password).to eq(nil)
+      expect(@client.user_key).to eq(nil)
+      expect(@client.api_key).to eq(nil)
+      expect(@client.version).to eq(3)
+      expect(@client.salesforce_access_token).to eq('access_token_value')
+      expect(@client.business_unit_id).to eq('0Uv000000000001CAA')
+      expect(@client.format).to eq('simple')
+    end
+
+    it 'raises error with nil business_unit_id' do
+      expect do
+        Pardot::Client.new nil, nil, nil, 3, 'access_token_value',
+                           nil
+      end.to raise_error.with_message(/business_unit_id required when using Salesforce access_token/)
+    end
+
+    it 'raises error with invalid business_unit_id due to length' do
+      expect do
+        Pardot::Client.new nil, nil, nil, 3, 'access_token_value',
+                           '0Uv1234567890'
+      end.to raise_error.with_message(/Invalid business_unit_id value. Expected ID to start with '0Uv' and be length of 18 characters./)
+    end
+
+    it 'raises error with invalid business_unit_id due to invalid prefix' do
+      expect do
+        Pardot::Client.new nil, nil, nil, 3, 'access_token_value',
+                           '001000000000001AAA'
+      end.to raise_error.with_message(/Invalid business_unit_id value. Expected ID to start with '0Uv' and be length of 18 characters./)
+    end
   end
-  
-  describe "client" do
+
+  describe 'client' do
     after do
-      expect(@client.email).to eq("user@test.com")
-      expect(@client.password).to eq("password")
-      expect(@client.user_key).to eq("user_key")
-      expect(@client.format).to eq("simple")
+      expect(@client.email).to eq('user@test.com')
+      expect(@client.password).to eq('password')
+      expect(@client.user_key).to eq('user_key')
+      expect(@client.format).to eq('simple')
     end
 
-    it "should set variables without version" do
-      @client = Pardot::Client.new "user@test.com", "password", "user_key"
+    it 'should set variables without version' do
+      @client = Pardot::Client.new 'user@test.com', 'password', 'user_key'
       expect(@client.version).to eq(3)
     end
-    
-    it "should set variables with version" do
-      @client = Pardot::Client.new "user@test.com", "password", "user_key", 4
+
+    it 'should set variables with version' do
+      @client = Pardot::Client.new 'user@test.com', 'password', 'user_key', 4
       expect(@client.version).to eq(4)
     end
-
   end
 end