ruby-pardot 1.2.0 → 1.4.1

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" do
-    after do
-      @client.email.should == "user@test.com"
-      @client.password.should == "password"
-      @client.user_key.should == "user_key"
-      @client.format.should == "simple"
+
+  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 "should set variables without version" do
-      @client = Pardot::Client.new "user@test.com", "password", "user_key"
-      @client.version.should == 3
+    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 "should set variables with version" do
-      @client = Pardot::Client.new "user@test.com", "password", "user_key", 4
-      @client.version.should == 4
+
+    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
+    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')
+    end
+
+    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
+      expect(@client.version).to eq(4)
+    end
   end
 end

data/spec/pardot/error_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 describe Pardot::ResponseError do
   before do
     @res = {
-      "code" => "9",
-      "__content__" => "A prospect with the specified email address already exists"
+      'code' => '9',
+      '__content__' => 'A prospect with the specified email address already exists'
     }
   end
 
@@ -21,10 +23,10 @@ describe Pardot::ResponseError do
       described_class.new(@res)
     end
     specify do
-      subject.to_s.should == @res["__content__"]
+      expect(subject.to_s).to eq(@res['__content__'])
     end
     specify do
-      subject.message.should == @res["__content__"]
+      expect(subject.message).to eq(@res['__content__'])
     end
   end
 

data/spec/pardot/http_spec.rb

@@ -1,132 +1,124 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+# frozen_string_literal: true
+
+require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
 
 describe Pardot::Http do
-  
   before do
     @client = create_client
-    fake_authenticate @client, "my_api_key"
+    fake_authenticate @client, 'my_api_key'
   end
-  
+
   def create_client
-    @client = Pardot::Client.new "user@test.com", "foo", "bar"
+    @client = Pardot::Client.new 'user@test.com', 'foo', 'bar'
   end
-  
-  describe "get" do
-    
-    def get object = "foo", path = "/bar", params = {}
+
+  describe 'get' do
+    def get(object = 'foo', path = '/bar', params = {})
       @client.get object, path, params
     end
-    
-    it "should notice errors and raise them as Pardot::ResponseError" do
-      fake_get "/api/foo/version/3/bar?api_key=my_api_key&format=simple&user_key=bar",
-               %(?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="fail" version="1.0">\n   <err code="15">Login failed</err>\n</rsp>\n)
-      
-      lambda { get }.should raise_error(Pardot::ResponseError)
-    end
-    
-    it "should catch and reraise SocketErrors as Pardot::NetError" do
-      Pardot::Client.should_receive(:get).and_raise(SocketError)
-      
-      lambda { get }.should raise_error(Pardot::NetError)
-    end
-    
-    it "should call handle_expired_api_key when the api key expires" do
-      fake_get "/api/foo/version/3/bar?api_key=my_api_key&format=simple&user_key=bar",
-               %(?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="fail" version="1.0">\n   <err code="15">Invalid API key or user key</err>\n</rsp>\n)
-      
-      @client.should_receive(:handle_expired_api_key)
+
+    it 'should notice errors and raise them as Pardot::ResponseError' do
+      fake_get '/api/foo/version/3/bar?format=simple',
+               %(<?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="fail" version="1.0">\n   <err code="15">Login failed</err>\n</rsp>\n)
+
+      expect(-> { get }).to raise_error(Pardot::ResponseError)
+    end
+
+    it 'should catch and reraise SocketErrors as Pardot::NetError' do
+      expect(Pardot::Client).to receive(:get).and_raise(SocketError)
+
+      expect(-> { get }).to raise_error(Pardot::NetError)
+    end
+
+    it 'should call handle_expired_api_key when the api key expires' do
+      fake_get '/api/foo/version/3/bar?format=simple',
+               %(<?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="fail" version="1.0">\n   <err code="15">Invalid API key or user key</err>\n</rsp>\n)
+
+      expect(@client).to receive(:handle_expired_api_key)
       get
     end
-    
   end
-  
-  describe "post" do
-    
-    def post object = "foo", path = "/bar", params = {}
+
+  describe 'post' do
+    def post(object = 'foo', path = '/bar', params = {})
       @client.post object, path, params
     end
-    
-    it "should notice errors and raise them as Pardot::ResponseError" do
-      fake_post "/api/foo/version/3/bar?api_key=my_api_key&format=simple&user_key=bar",
-                %(?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="fail" version="1.0">\n   <err code="15">Login failed</err>\n</rsp>\n)
-      
-      lambda { post }.should raise_error(Pardot::ResponseError)
-    end
-    
-    it "should catch and reraise SocketErrors as Pardot::NetError" do
-      Pardot::Client.should_receive(:post).and_raise(SocketError)
-      
-      lambda { post }.should raise_error(Pardot::NetError)
-    end
-    
-    it "should call handle_expired_api_key when the api key expires" do
-      fake_post "/api/foo/version/3/bar?api_key=my_api_key&format=simple&user_key=bar",
-                %(?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="fail" version="1.0">\n   <err code="15">Invalid API key or user key</err>\n</rsp>\n)
-      
-      @client.should_receive(:handle_expired_api_key)
+
+    it 'should notice errors and raise them as Pardot::ResponseError' do
+      fake_post '/api/foo/version/3/bar?format=simple',
+                %(<?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="fail" version="1.0">\n   <err code="15">Login failed</err>\n</rsp>\n)
+
+      expect(-> { post }).to raise_error(Pardot::ResponseError)
+    end
+
+    it 'should catch and reraise SocketErrors as Pardot::NetError' do
+      expect(Pardot::Client).to receive(:post).and_raise(SocketError)
+
+      expect(-> { post }).to raise_error(Pardot::NetError)
+    end
+
+    it 'should call handle_expired_api_key when the api key expires' do
+      fake_post '/api/foo/version/3/bar?format=simple',
+                %(<?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="fail" version="1.0">\n   <err code="15">Invalid API key or user key</err>\n</rsp>\n)
+
+      expect(@client).to receive(:handle_expired_api_key)
       post
     end
-    
   end
 
-  describe "getV4" do
-    
-    def get object = "foo", path = "/bar", params = {}
-      @client.version = "4"
+  describe 'getV4' do
+    def get(object = 'foo', path = '/bar', params = {})
+      @client.version = '4'
       @client.get object, path, params
     end
-    
-    it "should notice errors and raise them as Pardot::ResponseError" do
-      fake_get "/api/foo/version/4/bar?api_key=my_api_key&format=simple&user_key=bar",
-               %(?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="fail" version="1.0">\n   <err code="15">Login failed</err>\n</rsp>\n)
-      
-      lambda { get }.should raise_error(Pardot::ResponseError)
-    end
-    
-    it "should catch and reraise SocketErrors as Pardot::NetError" do
-      Pardot::Client.should_receive(:get).and_raise(SocketError)
-      
-      lambda { get }.should raise_error(Pardot::NetError)
-    end
-    
-    it "should call handle_expired_api_key when the api key expires" do
-      fake_get "/api/foo/version/4/bar?api_key=my_api_key&format=simple&user_key=bar",
-               %(?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="fail" version="1.0">\n   <err code="15">Invalid API key or user key</err>\n</rsp>\n)
-      
-      @client.should_receive(:handle_expired_api_key)
+
+    it 'should notice errors and raise them as Pardot::ResponseError' do
+      fake_get '/api/foo/version/4/bar?format=simple',
+               %(<?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="fail" version="1.0">\n   <err code="15">Login failed</err>\n</rsp>\n)
+
+      expect(-> { get }).to raise_error(Pardot::ResponseError)
+    end
+
+    it 'should catch and reraise SocketErrors as Pardot::NetError' do
+      expect(Pardot::Client).to receive(:get).and_raise(SocketError)
+
+      expect(-> { get }).to raise_error(Pardot::NetError)
+    end
+
+    it 'should call handle_expired_api_key when the api key expires' do
+      fake_get '/api/foo/version/4/bar?format=simple',
+               %(<?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="fail" version="1.0">\n   <err code="15">Invalid API key or user key</err>\n</rsp>\n)
+
+      expect(@client).to receive(:handle_expired_api_key)
       get
     end
-    
   end
-  
-  describe "postV4" do
-    
-    def post object = "foo", path = "/bar", params = {}
-      @client.version = "4"
+
+  describe 'postV4' do
+    def post(object = 'foo', path = '/bar', params = {})
+      @client.version = '4'
       @client.post object, path, params
     end
-    
-    it "should notice errors and raise them as Pardot::ResponseError" do
-      fake_post "/api/foo/version/4/bar?api_key=my_api_key&format=simple&user_key=bar",
-                %(?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="fail" version="1.0">\n   <err code="15">Login failed</err>\n</rsp>\n)
-      
-      lambda { post }.should raise_error(Pardot::ResponseError)
-    end
-    
-    it "should catch and reraise SocketErrors as Pardot::NetError" do
-      Pardot::Client.should_receive(:post).and_raise(SocketError)
-      
-      lambda { post }.should raise_error(Pardot::NetError)
-    end
-    
-    it "should call handle_expired_api_key when the api key expires" do
-      fake_post "/api/foo/version/4/bar?api_key=my_api_key&format=simple&user_key=bar",
-                %(?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="fail" version="1.0">\n   <err code="15">Invalid API key or user key</err>\n</rsp>\n)
-      
-      @client.should_receive(:handle_expired_api_key)
+
+    it 'should notice errors and raise them as Pardot::ResponseError' do
+      fake_post '/api/foo/version/4/bar?format=simple',
+                %(<?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="fail" version="1.0">\n   <err code="15">Login failed</err>\n</rsp>\n)
+
+      expect(-> { post }).to raise_error(Pardot::ResponseError)
+    end
+
+    it 'should catch and reraise SocketErrors as Pardot::NetError' do
+      expect(Pardot::Client).to receive(:post).and_raise(SocketError)
+
+      expect(-> { post }).to raise_error(Pardot::NetError)
+    end
+
+    it 'should call handle_expired_api_key when the api key expires' do
+      fake_post '/api/foo/version/4/bar?format=simple',
+                %(<?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="fail" version="1.0">\n   <err code="15">Invalid API key or user key</err>\n</rsp>\n)
+
+      expect(@client).to receive(:handle_expired_api_key)
       post
     end
-    
   end
-  
-end
+end

data/spec/pardot/objects/custom_fields_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require File.expand_path("#{File.dirname(__FILE__)}/../../spec_helper")
+
+describe Pardot::Objects::CustomFields do
+  create_auth_managers.each do |auth_manager|
+    context auth_manager.test_name_suffix do
+      let(:client) { auth_manager.create_client }
+
+      describe 'query' do
+        def sample_results
+          %(<?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="ok" version="1.0">
+            <result>
+              <total_results>1</total_results>
+                <customField>
+                  <created_at>2019-11-26 13:40:37</created_at>
+                  <crm_id null="true" />
+                  <field_id>CustomObject1574793618883</field_id>
+                  <id>8932</id>
+                  <is_record_multiple_responses>false</is_record_multiple_responses>
+                  <is_use_values>false</is_use_values>
+                  <name>Ω≈ç√∫˜µ≤≥÷</name>
+                  <type>Text</type>
+                  <type_id>1</type_id>
+                  <updated_at>2019-11-26 13:40:37</updated_at>
+              </customField>
+            </result>
+          </rsp>)
+        end
+
+        it 'should take in some arguments' do
+          fake_get '/api/customField/version/3/do/query?id_greater_than=200&format=simple', sample_results
+
+          expect(client.custom_fields.query(id_greater_than: 200)).to eq({ 'total_results' => 1,
+                                                                           'customField' =>
+              {
+                'id' => '8932',
+                'name' => 'Ω≈ç√∫˜µ≤≥÷',
+                'field_id' => 'CustomObject1574793618883',
+                'type' => 'Text',
+                'type_id' => '1',
+                'crm_id' => { 'null' => 'true' },
+                'is_record_multiple_responses' => 'false',
+                'is_use_values' => 'false',
+                'created_at' => '2019-11-26 13:40:37',
+                'updated_at' => '2019-11-26 13:40:37'
+              } })
+          assert_authorization_header auth_manager
+        end
+      end
+    end
+  end
+end

data/spec/pardot/objects/emails_spec.rb

@@ -1,36 +1,37 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+# frozen_string_literal: true
 
-describe Pardot::Objects::Emails do
-
-  before do
-    @client = create_client
-  end
-
-  def sample_response
-    %(<?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="ok" version="1.0">
-      <email>
-        <name>My Email</name>
-      </email>
-    </rsp>)
-  end
-
-  before do
-    @client = create_client
-  end
+require File.expand_path("#{File.dirname(__FILE__)}/../../spec_helper")
 
-  it "should take in the email ID" do
-    fake_get "/api/email/version/3/do/read/id/12?user_key=bar&api_key=my_api_key&format=simple", sample_response
-    @client.emails.read_by_id(12).should == {"name" => "My Email"}
-  end
-
-  it 'should send to a prospect' do
-    fake_post '/api/email/version/3/do/send/prospect_id/42?campaign_id=765&email_template_id=86&user_key=bar&api_key=my_api_key&format=simple', sample_response
-    @client.emails.send_to_prospect(42, :campaign_id => 765, :email_template_id => 86).should == {"name" => "My Email"}
-  end
-
-  it 'should send to a list' do
-    fake_post '/api/email/version/3/do/send?email_template_id=200&list_ids[]=235&campaign_id=654&user_key=bar&api_key=my_api_key&format=simple', sample_response
-    @client.emails.send_to_list(:email_template_id => 200, 'list_ids[]' => 235, :campaign_id => 654).should == {"name" => "My Email"}
+describe Pardot::Objects::Emails do
+  create_auth_managers.each do |auth_manager|
+    context auth_manager.test_name_suffix do
+      let(:client) { auth_manager.create_client }
+
+      def sample_response
+        %(<?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="ok" version="1.0">
+          <email>
+            <name>My Email</name>
+          </email>
+        </rsp>)
+      end
+
+      it 'should take in the email ID' do
+        fake_get '/api/email/version/3/do/read/id/12?format=simple', sample_response
+        expect(client.emails.read_by_id(12)).to eq({ 'name' => 'My Email' })
+        assert_authorization_header auth_manager
+      end
+
+      it 'should send to a prospect' do
+        fake_post '/api/email/version/3/do/send/prospect_id/42?campaign_id=765&email_template_id=86&format=simple', sample_response
+        expect(client.emails.send_to_prospect(42, campaign_id: 765, email_template_id: 86)).to eq({ 'name' => 'My Email' })
+        assert_authorization_header auth_manager
+      end
+
+      it 'should send to a list' do
+        fake_post '/api/email/version/3/do/send?email_template_id=200&list_ids%5B%5D=235&campaign_id=654&format=simple', sample_response
+        expect(client.emails.send_to_list(:email_template_id => 200, 'list_ids[]' => 235, :campaign_id => 654)).to eq({ 'name' => 'My Email' })
+        assert_authorization_header auth_manager
+      end
+    end
   end
-
-end
+end