added users, visitor activities, visitors, visits API calls

Author: dcunning

lib/pardot/client.rb

@@ -10,6 +10,10 @@ class Client
     include Http
     include Prospects
     include Opportunities
+    include Visitors
+    include Users
+    include Visits
+    include VisitorActivities
 
     attr_accessor :email, :password, :user_key, :api_key, :format
 

lib/pardot/users.rb

@@ -0,0 +1,43 @@
+module Pardot
+  module Users
+    
+    def users
+      @users ||= Users.new self
+    end
+    
+    class Users
+      
+      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"]
+        result
+      end
+      
+      def read_by_email email, params = {}
+        post "/do/read/email/#{email}", params
+      end
+      
+      def readby_id id, params = {}
+        post "/do/read/id/#{id}", params
+      end
+      
+      protected
+      
+      def get path, params = {}, result = "user"
+        response = @client.get "user", path, params
+        result ? response[result] : response
+      end
+      
+      def post path, params = {}, result = "user"
+        response = @client.post "user", path, params
+        result ? response[result] : response
+      end
+      
+    end
+    
+  end
+end

lib/pardot/visitor_activities.rb

@@ -0,0 +1,39 @@
+module Pardot
+  module VisitorActivities
+    
+    def visitor_activities
+      @visitor_activities ||= VisitorActivities.new self
+    end
+    
+    class VisitorActivities
+      
+      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"]
+        result
+      end
+      
+      def read id, params = {}
+        post "/do/read/id/#{id}", params
+      end
+      
+      protected
+      
+      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
+        result ? response[result] : response
+      end
+      
+    end
+    
+  end
+end

lib/pardot/visitors.rb

@@ -0,0 +1,43 @@
+module Pardot
+  module Visitors
+    
+    def visitors
+      @visitors ||= Visitors.new self
+    end
+    
+    class Visitors
+      
+      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"]
+        result
+      end
+      
+      def assign id, params = {}
+        post "/do/assign/id/#{id}", params
+      end
+      
+      def read id, params = {}
+        post "/do/read/id/#{id}", params
+      end
+      
+      protected
+      
+      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
+        result ? response[result] : response
+      end
+      
+    end
+    
+  end
+end

lib/pardot/visits.rb

@@ -0,0 +1,39 @@
+module Pardot
+  module Visits
+    
+    def visits
+      @visits ||= Visits.new self
+    end
+    
+    class Visits
+      
+      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"]
+        result
+      end
+      
+      def read id, params = {}
+        post "/do/read/id/#{id}", params
+      end
+      
+      protected
+      
+      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
+        result ? response[result] : response
+      end
+      
+    end
+    
+  end
+end

lib/ruby-pardot.rb

@@ -10,5 +10,9 @@
 
 require 'pardot/prospects'
 require 'pardot/opportunities'
+require 'pardot/visitors'
+require 'pardot/users'
+require 'pardot/visits'
+require 'pardot/visitor_activities'
 
 require 'pardot/client'

spec/pardot/users_spec.rb

@@ -0,0 +1,64 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Pardot::Users do
+  
+  before do
+    @client = create_client
+  end
+  
+  describe "query" do
+    
+    def sample_results
+      %(<?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="ok" version="1.0">
+        <result>
+          <total_results>2</total_results>
+          <user>
+            <email>[email protected]</email>
+            <first_name>Jim</first_name>
+          </user>
+          <user>
+            <email>[email protected]</email>
+            <first_name>Sue</first_name>
+          </user>
+        </result>
+      </rsp>)
+    end
+    
+    before do
+      @client = create_client
+    end
+    
+    it "should take in some arguments" do
+      fake_get "/api/user/version/3/do/query?api_key=my_api_key&user_key=bar&id_greater_than=200&format=simple", sample_results
+      
+      @client.users.query(:id_greater_than => 200).should == {"total_results" => 2, 
+        "user"=>[
+          {"email"=>"[email protected]", "first_name"=>"Jim"}, 
+          {"email"=>"[email protected]", "first_name"=>"Sue"}
+        ]}
+    end
+    
+  end
+  
+  describe "read_by_email" do
+    
+    def sample_results
+      %(<?xml version="1.0" encoding="UTF-8"?>
+      <rsp stat="ok" version="1.0">
+        <user>
+          <email>[email protected]</email>
+          <first_name>Sue</first_name>
+        </user>
+      </rsp>)
+    end
+    
+    it "should return the prospect" do
+      fake_post "/api/user/version/3/do/read/email/[email protected]?api_key=my_api_key&user_key=bar&format=simple", sample_results
+      
+      @client.users.read_by_email("[email protected]").should == {"email"=>"[email protected]", "first_name"=>"Sue"}
+      
+    end
+    
+  end
+  
+end

spec/pardot/visitor_activities_spec.rb

@@ -0,0 +1,64 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Pardot::VisitorActivities do
+  
+  before do
+    @client = create_client
+  end
+  
+  describe "query" do
+    
+    def sample_results
+      %(<?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="ok" version="1.0">
+        <result>
+          <total_results>2</total_results>
+          <visitorActivity>
+            <type_name>Read</type_name>
+            <details>Some details</details>
+          </visitorActivity>
+          <visitorActivity>
+            <type_name>Write</type_name>
+            <details>More details</details>
+          </visitorActivity>
+        </result>
+      </rsp>)
+    end
+    
+    before do
+      @client = create_client
+    end
+    
+    it "should take in some arguments" do
+      fake_get "/api/visitorActivity/version/3/do/query?user_key=bar&api_key=my_api_key&id_greater_than=200&format=simple", sample_results
+      
+      @client.visitor_activities.query(:id_greater_than => 200).should == {"total_results" => 2, 
+        "visitorActivity"=>[
+          {"type_name"=>"Read", "details"=>"Some details"}, 
+          {"type_name"=>"Write", "details"=>"More details"}
+        ]}
+    end
+    
+  end
+  
+  describe "read" do
+    
+    def sample_results
+      %(<?xml version="1.0" encoding="UTF-8"?>
+      <rsp stat="ok" version="1.0">
+        <visitorActivity>
+          <type_name>Write</type_name>
+          <details>More details</details>
+        </visitorActivity>
+      </rsp>)
+    end
+    
+    it "should return the prospect" do
+      fake_post "/api/visitorActivity/version/3/do/read/id/10?user_key=bar&api_key=my_api_key&format=simple", sample_results
+      
+      @client.visitor_activities.read(10).should == {"details"=>"More details", "type_name"=>"Write"}
+      
+    end
+    
+  end
+  
+end

spec/pardot/visitors_spec.rb

@@ -0,0 +1,64 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Pardot::Visitors do
+  
+  before do
+    @client = create_client
+  end
+  
+  describe "query" do
+    
+    def sample_results
+      %(<?xml version="1.0" encoding="UTF-8"?>\n<rsp stat="ok" version="1.0">
+        <result>
+          <total_results>2</total_results>
+          <visitor>
+            <browser>Firefox</browser>
+            <language>en</language>
+          </visitor>
+          <visitor>
+            <browser>Chrome</browser>
+            <language>es</language>
+          </visitor>
+        </result>
+      </rsp>)
+    end
+    
+    before do
+      @client = create_client
+    end
+    
+    it "should take in some arguments" do
+      fake_get "/api/visitor/version/3/do/query?api_key=my_api_key&user_key=bar&id_greater_than=200&format=simple", sample_results
+      
+      @client.visitors.query(:id_greater_than => 200).should == {"total_results" => 2, 
+        "visitor"=>[
+          {"browser"=>"Firefox", "language"=>"en"}, 
+          {"browser"=>"Chrome", "language"=>"es"}
+        ]}
+    end
+    
+  end
+  
+  describe "assign" do
+    
+    def sample_results
+      %(<?xml version="1.0" encoding="UTF-8"?>
+      <rsp stat="ok" version="1.0">
+        <visitor>
+          <browser>Chrome</browser>
+          <language>es</language>
+        </visitor>
+      </rsp>)
+    end
+    
+    it "should return the prospect" do
+      fake_post "/api/visitor/version/3/do/assign/id/10?type=Good&api_key=my_api_key&user_key=bar&format=simple&name=Jim", sample_results
+      
+      @client.visitors.assign(10, :name => "Jim", :type => "Good").should == {"browser"=>"Chrome", "language"=>"es"}
+      
+    end
+    
+  end
+  
+end