ruby-pardot 1.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in ruby-pardot.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    ruby-pardot (1.0)
+      crack
+      httparty
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    fakeweb (1.3.0)
+    httparty (0.7.4)
+      crack (= 0.1.8)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  fakeweb
+  rspec
+  ruby-pardot!

data/README.rdoc

@@ -0,0 +1,82 @@
+== Install
+
+Add the following to your Gemfile
+
+  gem "ruby-pardot"
+
+== Usage
+
+=== 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
+  
+=== Object Types
+
+The available objects are:
+
+* lists
+* opportunities
+* prospects
+* users
+* visitor_activities
+* visitors
+* 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
+
+=== Creating, editing, and reading objects
+
+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
+  
+=== 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
+    prospect = client.prospects.create("user@test.com")
+  rescue Pardot::ResponseError => e
+    # the request went through, but Pardot responded with an error, possibly because this email is already in use
+  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
+    # the API request failed
+    #   - socket broke before the request was completed
+    #   - pi.pardot.com is under heavy load
+    #   - many number of other reasons
+  end

data/Rakefile

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

data/lib/pardot/authentication.rb

@@ -0,0 +1,19 @@
+module Pardot
+  module Authentication
+    
+    def authenticate
+      resp = post "login", nil, :email => @email, :password => @password, :user_key => @user_key
+      @api_key = resp["api_key"]
+    end
+    
+    def authenticated?
+      @api_key != nil
+    end
+    
+    def reauthenticate
+      @api_key = nil
+      authenticate
+    end
+    
+  end
+end

data/lib/pardot/client.rb

@@ -0,0 +1,32 @@
+module Pardot
+  
+  class Client
+    
+    include HTTParty
+    base_uri 'https://pi.pardot.com'
+    format :xml
+    
+    include Authentication
+    include Http
+
+    include Objects::Lists
+    include Objects::Opportunities
+    include Objects::Prospects
+    include Objects::Users
+    include Objects::Visitors
+    include Objects::Visits
+    include Objects::VisitorActivities
+    
+    attr_accessor :email, :password, :user_key, :api_key, :format
+    
+    def initialize email, password, user_key
+      @email = email
+      @password = password
+      @user_key = user_key
+      
+      @format = "simple"
+    end
+    
+    
+  end
+end

data/lib/pardot/error.rb

@@ -0,0 +1,8 @@
+module Pardot
+  
+  class Error < StandardError; end
+  class NetError < Error; end
+  class ResponseError < Error; end
+  class ExpiredApiKeyError < Error; end
+  
+end

data/lib/pardot/http.rb

@@ -0,0 +1,69 @@
+module Pardot
+  module Http
+    
+    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)
+      
+    rescue Pardot::ExpiredApiKeyError => e
+      handle_expired_api_key :get, object, path, params, num_retries, e
+      
+    rescue SocketError, Interrupt, EOFError, SystemCallError => e
+      raise Pardot::NetError.new(e)
+    end
+    
+    def post object, path, params = {}, num_retries = 0
+      smooth_params object, params
+      full_path = fullpath object, path
+      check_response self.class.post(full_path, :query => params)
+      
+    rescue Pardot::ExpiredApiKeyError => e
+      handle_expired_api_key :post, object, path, params, num_retries, e
+      
+    rescue SocketError, Interrupt, EOFError, SystemCallError => e
+      raise Pardot::NetError.new(e)
+    end
+    
+    protected
+    
+    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"
+      
+      authenticate unless authenticated?
+      params.merge! :user_key => @user_key, :api_key => @api_key, :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"
+      
+      if error == "Invalid API key or user key" && @api_key
+        raise ExpiredApiKeyError.new @api_key
+      end
+      
+      raise ResponseError.new error if error
+      
+      rsp
+    end
+    
+    def fullpath object, path, version = 3
+      full = File.join("/api", object, "version", version.to_s)
+      unless path.nil?
+        full = File.join(full, path)
+      end
+      full
+    end
+    
+  end
+end

data/lib/pardot/objects/lists.rb

@@ -0,0 +1,50 @@
+module Pardot
+  module Objects
+    
+    module Lists
+      
+      def lists
+        @lists ||= Lists.new self
+      end
+      
+      class Lists
+        
+        def initialize client
+          @client = client
+        end
+        
+        def create id, params = {}
+          post "/do/create", params
+        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_id id, params = {}
+          get "/do/read/id/#{id}", params
+        end
+        
+        def update id, params = {}
+          post "/do/update/#{id}"
+        end
+        
+        protected
+        
+        def get path, params = {}, result = "list"
+          response = @client.get "list", path, params
+          result ? response[result] : response
+        end
+        
+        def post path, params = {}, result = "list"
+          response = @client.post "list", path, params
+          result ? response[result] : response
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/pardot/objects/opportunities.rb

@@ -0,0 +1,54 @@
+module Pardot
+  module Objects
+    
+    module Opportunities
+      
+      def opportunities
+        @opportunities ||= Opportunities.new self
+      end
+      
+      class Opportunities
+        
+        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 create_by_email email, params = {}
+          post "/do/create/prospect_email/#{email}", params
+        end
+        
+        def create_by_id prospect_id, params = {}
+          post "/do/create/prospect_id/#{prospect_id}", params
+        end
+        
+        def read_by_id id, params = {}
+          post "/do/read/id/#{id}", params
+        end
+        
+        def update_by_id id, params = {}
+          post "/do/update/id/#{id}", params
+        end
+        
+        protected
+        
+        def get path, params = {}, result = "opportunity"
+          response = @client.get "opportunity", path, params
+          result ? response[result] : response
+        end
+        
+        def post path, params = {}, result = "opportunity"
+          response = @client.post "opportunity", path, params
+          result ? response[result] : response
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/pardot/objects/prospects.rb

@@ -0,0 +1,73 @@
+module Pardot
+  module Objects
+    module Prospects
+      
+      def prospects
+        @prospects ||= Prospects.new self
+      end
+      
+      class Prospects
+        
+        def initialize client
+          @client = client
+        end
+        
+        def query search_criteria
+          result = get "/do/query", search_criteria, "result"
+          result["total_results"] = result["total_results"].to_i if result["total_results"]
+          result
+        end
+        
+        def assign_by_email email, params
+          post "/do/assign/email/#{email}", params
+        end
+        
+        def assign_by_id id, params
+          post "/do/assign/id/#{id}", params
+        end
+        
+        def create email, params = {}
+          post "/do/create/email/#{email}", params
+        end
+        
+        def read_by_email email, params = {}
+          post "/do/read/email/#{email}", params
+        end
+        
+        def read_by_id id, params = {}
+          post "/do/read/id/#{id}", params
+        end
+        
+        def update_by_email email, params = {}
+          post "/do/update/email/#{email}", params
+        end
+        
+        def update_by_id id, params = {}
+          post "/do/update/id/#{id}", params
+        end
+        
+        def upsert_by_email email, params = {}
+          post "/do/upsert/email/#{email}", params
+        end
+        
+        def upsert_by_id id, params = {}
+          post "/do/upsert/id/#{id}", params
+        end
+        
+        protected
+        
+        def get path, params = {}, result = "prospect"
+          response = @client.get "prospect", path, params
+          result ? response[result] : response
+        end
+        
+        def post path, params = {}, result = "prospect"
+          response = @client.post "prospect", path, params
+          result ? response[result] : response
+        end
+        
+      end
+      
+    end
+  end
+end