ruby-pardot 1.0 → 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b5a3bceaeff6bb81efc73dfc2ee2fb51e3fce2e
+  data.tar.gz: cdc11f89e0415c6b3d0484d7fe67147a3b8a087e
+SHA512:
+  metadata.gz: 69f994887ac58cf22de6f963d1793f4dfb0ba35cb3adedc4d3baf3fcabd766ce187bb31047de526545488cbe951c7e31d29872bfe75d5029a675254c7fe60817
+  data.tar.gz: 013ffa24e4853541125c89bcb08c90ce88de3db3a0cd2475fba4bc787682f1e8fd1a9e91550cc1ea702e74c282b8b818e2fa254cba29699a0471a612cc108b16

data/Gemfile.lock

@@ -1,18 +1,22 @@
 PATH
   remote: .
   specs:
-    ruby-pardot (1.0)
+    ruby-pardot (1.0.2)
       crack
       httparty
 
 GEM
   remote: http://rubygems.org/
   specs:
-    crack (0.1.8)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
     diff-lcs (1.1.2)
     fakeweb (1.3.0)
-    httparty (0.7.4)
-      crack (= 0.1.8)
+    httparty (0.13.1)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.1)
+    multi_xml (0.5.5)
     rspec (2.5.0)
       rspec-core (~> 2.5.0)
       rspec-expectations (~> 2.5.0)
@@ -21,6 +25,7 @@ GEM
     rspec-expectations (2.5.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.5.0)
+    safe_yaml (1.0.3)
 
 PLATFORMS
   ruby

data/README.rdoc

@@ -20,6 +20,7 @@ The client will authenticate before performing other API calls, but you can manu
 
 The available objects are:
 
+* emails
 * lists
 * opportunities
 * prospects
@@ -54,6 +55,15 @@ http://developer.pardot.com/kb/api-version-3/using-prospects
     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).
+
+  # Sample usage
+  @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
@@ -79,4 +89,21 @@ Performing API calls across the internet is inherently unsafe, so be sure to cat
     #   - socket broke before the request was completed
     #   - pi.pardot.com is under heavy load
     #   - many number of other reasons
-  end
+  end
+
+=== License
+The MIT License (MIT)
+Copyright (c) 2012 Pardot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy,
+modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the 
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE 
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR 
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/pardot/authentication.rb

@@ -3,7 +3,7 @@ module Pardot
     
     def authenticate
       resp = post "login", nil, :email => @email, :password => @password, :user_key => @user_key
-      @api_key = resp["api_key"]
+      @api_key = resp && resp["api_key"]
     end
     
     def authenticated?

data/lib/pardot/client.rb

@@ -1,32 +1,35 @@
 module Pardot
-  
+
   class Client
-    
+
     include HTTParty
     base_uri 'https://pi.pardot.com'
     format :xml
-    
+
     include Authentication
     include Http
 
+    include Objects::Emails
     include Objects::Lists
+    include Objects::ListMemberships
     include Objects::Opportunities
     include Objects::Prospects
+    include Objects::ProspectAccounts
     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

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

data/lib/pardot/http.rb

@@ -9,7 +9,7 @@ module Pardot
     rescue Pardot::ExpiredApiKeyError => e
       handle_expired_api_key :get, object, path, params, num_retries, e
       
-    rescue SocketError, Interrupt, EOFError, SystemCallError => e
+    rescue SocketError, Interrupt, EOFError, SystemCallError, Timeout::Error, MultiXml::ParseError => e
       raise Pardot::NetError.new(e)
     end
     
@@ -21,7 +21,7 @@ module Pardot
     rescue Pardot::ExpiredApiKeyError => e
       handle_expired_api_key :post, object, path, params, num_retries, e
       
-    rescue SocketError, Interrupt, EOFError, SystemCallError => e
+    rescue SocketError, Interrupt, EOFError, SystemCallError, Timeout::Error, MultiXml::ParseError => e
       raise Pardot::NetError.new(e)
     end
     
@@ -47,8 +47,9 @@ module Pardot
       
       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 == "Invalid API key or user key" && @api_key
+      if [error, content].include?("Invalid API key or user key") && @api_key
         raise ExpiredApiKeyError.new @api_key
       end
       

data/lib/pardot/objects/emails.rb

@@ -0,0 +1,44 @@
+module Pardot
+  module Objects
+
+    module Emails
+
+      def emails
+        @emails ||= Emails.new self
+      end
+
+      class Emails
+
+        def initialize client
+          @client = client
+        end
+
+        def read_by_id id
+          get "/do/read/id/#{id}"
+        end
+
+        def send_to_prospect prospect_id, params
+          post "/do/send/prospect_id/#{prospect_id}", params
+        end
+
+        def send_to_list params
+          post "/do/send", params
+        end
+
+        protected
+
+        def get path, params = {}, result = "email"
+          response = @client.get "email", path, params
+          result ? response[result] : response
+        end
+
+        def post path, params = {}, result = "email"
+          response = @client.post "email", path, params
+          result ? response[result] : response
+        end
+
+      end
+
+    end
+  end
+end

data/lib/pardot/objects/list_memberships.rb

@@ -0,0 +1,36 @@
+module Pardot
+  module Objects
+    module ListMemberships
+
+      def list_memberships
+        @list_memberships ||= ListMemberships.new self
+      end
+
+      class ListMemberships
+
+        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_id id, params = {}
+          get "/do/read/id/#{id}", params
+        end
+
+        protected
+
+        def get path, params = {}, result = "listMembership"
+          response = @client.get "listMembership", path, params
+          result ? response[result] : response
+        end
+
+      end
+
+    end
+  end
+end

data/lib/pardot/objects/prospect_accounts.rb

@@ -0,0 +1,55 @@
+module Pardot
+  module Objects
+    module ProspectAccounts
+      def prospect_accounts
+        @prospect_accounts ||= ProspectAccounts.new self
+      end
+
+      class ProspectAccounts
+
+        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 describe(params={})
+          post('/do/describe', params)
+        end
+
+        def create(params={})
+          post('/do/create', params)
+        end
+
+        # read_by_id
+        # update_by_id
+        [:read, :update].each do |verb|
+          define_method(verb) do |id, params={}|
+            post(api_url(verb, 'id', id), params)
+          end
+        end
+
+        private
+
+        def api_url(verb, direct_to, value)
+          "/do/#{verb}/#{direct_to}/#{value}"
+        end
+
+        def get(path, params={}, result='prospectAccount')
+          response = @client.get('prospectAccount', path, params)
+          result ? response[result] : response
+        end
+
+        def post(path, params={}, result='prospectAccount')
+          response = @client.post('prospectAccount', path, params)
+          result ? response[result] : response
+        end
+      end
+    end
+  end
+end

data/lib/pardot/version.rb

@@ -1,3 +1,3 @@
 module Pardot
-  VERSION = "1.0"
+  VERSION = "1.0.2"
 end

data/lib/ruby-pardot.rb

@@ -6,9 +6,12 @@ require 'pardot/http'
 require 'pardot/error'
 require 'pardot/authentication'
 
+require 'pardot/objects/emails'
 require 'pardot/objects/lists'
+require 'pardot/objects/list_memberships'
 require 'pardot/objects/opportunities'
 require 'pardot/objects/prospects'
+require 'pardot/objects/prospect_accounts'
 require 'pardot/objects/users'
 require 'pardot/objects/visitors'
 require 'pardot/objects/visitor_activities'

data/spec/pardot/error_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+describe Pardot::ResponseError do
+  before do
+    @res = {
+      "code" => "9",
+      "__content__" => "A prospect with the specified email address already exists"
+    }
+  end
+
+  describe '#code' do
+    subject do
+      described_class.new(@res).code
+    end
+    specify do
+      should == 9
+    end
+  end
+
+  describe '#to_s, #message' do
+    subject do
+      described_class.new(@res)
+    end
+    specify do
+      subject.to_s.should == @res["__content__"]
+    end
+    specify do
+      subject.message.should == @res["__content__"]
+    end
+  end
+
+  describe '#inspect' do
+    subject do
+      described_class.new(@res).inspect
+    end
+    specify do
+      should == @res.to_s
+    end
+  end
+end

data/spec/pardot/objects/emails_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+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
+
+  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"}
+  end
+
+end

data/spec/pardot/objects/prospect_accounts_spec.rb

@@ -0,0 +1,78 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Pardot::Objects::ProspectAccounts do
+
+  before do
+    @client = create_client
+  end
+
+  describe "query" do
+
+    def sample_results
+      %(<?xml version="1.0" encoding="UTF-8"?>
+      <rsp stat="ok" version="1.0">
+        <result>
+          <total_results>2</total_results>
+          <prospectAccount>
+            <name>Spaceships R Us</name>
+          </prospectAccount>
+          <prospectAccount>
+            <name>Monsters Inc</name>
+          </prospectAccount>
+        </result>
+      </rsp>)
+    end
+
+    it "should take in some arguments and respond with valid items" do
+      fake_get "/api/prospectAccount/version/3/do/query?assigned=true&format=simple&user_key=bar&api_key=my_api_key", sample_results
+
+      @client.prospect_accounts.query(:assigned => true).should == {'total_results' => 2,
+        'prospectAccount'=>[
+          {'name'=>'Spaceships R Us'},
+          {'name'=>'Monsters Inc'}
+        ]}
+    end
+
+  end
+
+  describe 'read' do
+    def sample_results
+      %(<?xml version="1.0" encoding="UTF-8"?>
+      <rsp stat="ok" version="1.0">
+        <prospectAccount>
+          <id>1234</id>
+          <name>SupaDupaPanda</name>
+        </prospectAccount>
+        </rsp>)
+    end
+
+    it 'should return a valid account' do
+      fake_post '/api/prospectAccount/version/3/do/read/id/1234?assigned=true&format=simple&user_key=bar&api_key=my_api_key', sample_results
+
+      @client.prospect_accounts.read('1234', :assigned => true).should == {'id' => '1234', 'name' => 'SupaDupaPanda' }
+    end
+
+  end
+
+
+  describe 'create' do
+
+    def sample_results
+      %(<?xml version="1.0" encoding="UTF-8"?>
+      <rsp stat="ok" version="1.0">
+        <prospectAccount>
+          <name>SuperPanda</name>
+        </prospectAccount>
+      </rsp>)
+    end
+
+    it 'should return the prospect account' do
+      fake_post '/api/prospectAccount/version/3/do/create?api_key=my_api_key&user_key=bar&format=simple&name=SuperPanda', sample_results
+
+      @client.prospect_accounts.create(:name => 'SuperPanda').should == {"name"=>"SuperPanda"}
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -8,4 +8,4 @@ require 'httparty'
 
 require 'ruby-pardot'
 
-Dir[File.join("spec/support/**/*.rb")].each {|f| require f}
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

metadata

@@ -1,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pardot
 version: !ruby/object:Gem::Version
-  version: '1.0'
-  prerelease: 
+  version: 1.0.2
 platform: ruby
 authors:
 - Dan Cunning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-15 00:00:00.000000000 Z
+date: 2016-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: crack
-  requirement: &70243888377720 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70243888377720
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70243888377000 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70243888377000
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70243888376480 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70243888376480
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70243888375960 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70243888375960
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70243888375480 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70243888375480
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Library for interacting with the Pardot API
 email:
 - support@pardot.com
@@ -73,8 +87,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - Gemfile.lock
 - README.rdoc
@@ -83,8 +97,11 @@ files:
 - lib/pardot/client.rb
 - lib/pardot/error.rb
 - lib/pardot/http.rb
+- lib/pardot/objects/emails.rb
+- lib/pardot/objects/list_memberships.rb
 - lib/pardot/objects/lists.rb
 - lib/pardot/objects/opportunities.rb
+- lib/pardot/objects/prospect_accounts.rb
 - lib/pardot/objects/prospects.rb
 - lib/pardot/objects/users.rb
 - lib/pardot/objects/visitor_activities.rb
@@ -94,9 +111,12 @@ files:
 - lib/ruby-pardot.rb
 - ruby-pardot.gemspec
 - spec/pardot/authentication_spec.rb
+- spec/pardot/error_spec.rb
 - spec/pardot/http_spec.rb
+- spec/pardot/objects/emails_spec.rb
 - spec/pardot/objects/lists_spec.rb
 - spec/pardot/objects/opportunities_spec.rb
+- spec/pardot/objects/prospect_accounts_spec.rb
 - spec/pardot/objects/prospects_spec.rb
 - spec/pardot/objects/users_spec.rb
 - spec/pardot/objects/visitor_activities_spec.rb
@@ -107,26 +127,25 @@ files:
 - spec/support/fakeweb.rb
 homepage: http://github.com/pardot/ruby-pardot
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: ruby-pardot
-rubygems_version: 1.8.12
+rubygems_version: 2.4.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Library for interacting with the Pardot API
 test_files: []