r_hapi 0.1.1 → 0.1.2

data/README.rdoc

@@ -10,6 +10,13 @@ RHapi is a Ruby wrapper for the HubSpot API (HAPI).
 
 == Using RHapi 
 
+Intsall 
+If you use RVM.
+  gem install r_hapi
+  
+If not you may need to do this:
+  sudo gem install r_hapi
+
 First configure RHapi to work with your Hubspot API Key.
 
   RHapi.configure do |config|
@@ -28,12 +35,33 @@ Then to get a list of leads.
 
 To find leads named Barny.
   leads = RHapi::Lead.find("Barny")
+  
+You can also pass additional options to the find method.
+  options = {
+    :sort       => "lastName",          # Possible sort values include: firstName, lastName, email, address, phone, insertedAt, lastConvertedAt, lastModifiedAt, closedAt
+    :dir        => "asc",               # Use desc for descending.
+    :max        => 25,                  # Maximum value is 100
+    :offset     => 50,                  # Used in combination with max for paging results. 
+    :startTime  => 1298721462000,       # Expressed as milliseconds since epoch time. Returned list will have only leads inserted after this time. Default is 0 and returns all leads up to max.
+    :stopTime   => 1298721462000,       # Expressed as milliseconds since epoch time. 
+    :timePivot  => "insertedAt",        # The field the start and stop times should be applied to in the search. Can be: insertedAt, firstConvertedAt, lastConvertedAt, lastModifiedAt, closedAt.
+    :excludeConversionEvents => false,  # Used to exclude all items in the leadConversionEvents collection from the API results.
+    :optout                  => false,  # Set to true to include only leads that have unsubscribed from lead nurturing. The default value, false, includes all leads. 
+    :eligibleForEmail        => false,  # Set to true to include only leads eligible for email marketing.
+    :bounced                 => false,  # Set to true to include only leads that HubSpot has tried to email, and the email bounced. The default value, false, includes all leads.
+    :notImported             => false  # Set to true to include only web leads. The default value, false, includes both imported and web leads.
+  }
+  leads = RHapi::Lead.find("Barny", options)
 
 To update a lead.
-  lead = leads.fist
+  lead = leads.first
   lead.first_name = "Fred"
   lead.last_name  = "Flintsone"
   lead.update
+  
+You can also pass a params hash to update a lead.
+  params = {:first_name => "Fred", :last_name => "Flintstone", :city => "Bedrock"}
+  lead.update(params)
 
 To get a single lead with a guid. Assumes the guid has be saved from a previous search.
   lead = RHapi::Lead.find_by_guid(lead.guid)

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/r_hapi.rb

@@ -1,6 +1,7 @@
 require File.expand_path('../r_hapi/lead', __FILE__)
 require File.expand_path('../r_hapi/configuration', __FILE__)
 require File.expand_path('../r_hapi/r_hapi_exception', __FILE__)
+
 require 'curb'
 require 'json'
 

data/lib/r_hapi/connection.rb

@@ -0,0 +1,56 @@
+require 'curb'
+require 'json'
+module RHapi
+  module Connection
+    
+    # Instance methods ---------------------------------------------------------------------------  
+      
+    def put(url, payload)
+      data = payload.to_json
+      response = Curl::Easy.http_put(url, data) do |curl| 
+        curl.headers["Content-Type"] = "application/json"
+        curl.on_failure do |response, err|
+          RHapi::ConnectionError.raise_error("#{response.response_code}\n Error is: #{err.inspect}")
+        end
+      end
+      RHapi::ConnectionError.raise_error(response.header_str) unless response.header_str =~ /2\d\d/
+    end
+    
+    # Class methods -----------------------------------------------------------------------------
+    
+    module ClassMethods
+    
+      def url_for(method, id=nil, options={})
+        url = "#{RHapi.options[:end_point]}/leads/#{RHapi.options[:version]}/#{method}"
+        url << "/#{id}" unless id.nil?
+        url << "?hapikey=#{RHapi.options[:api_key]}"
+        
+        raise(RHapi::UriError, "Options must be a hash in order to build the url.") unless options.is_a?(Hash)
+        url << append_options(options) unless options.empty?
+        url
+      end 
+      
+      def append_options(options)
+        query_string = ""
+        options.each do |key, value|
+          query_string << "&#{key.to_s}=#{value}"
+        end
+        query_string
+      end
+      
+      def get(url)
+        response = Curl::Easy.perform(url) do |curl|
+          curl.on_failure do |response, err|
+            RHapi::ConnectionError.raise_error("#{response.response_code}\n Error is: #{err.inspect}")
+          end
+        end
+        RHapi::ConnectionError.raise_error( response.header_str) unless response.header_str =~ /2\d\d/
+        RHapi::ConnectionError.raise_error(response.body_str) if response.body_str =~ /Error/i
+        response
+      end
+      
+    end # End class methods
+
+    
+  end
+end

data/lib/r_hapi/lead.rb

@@ -1,9 +1,13 @@
 require 'rubygems'
 require 'active_support'
 require 'active_support/inflector/inflections'
+require File.expand_path('../connection', __FILE__)
+
 module RHapi
   
   class Lead
+    include Connection
+    extend Connection::ClassMethods
     
     attr_accessor :attributes, :changed_attributes
     
@@ -18,11 +22,11 @@ module RHapi
     # An optional string value that is used to search several basic lead fields: first name, last name, email address, 
     # and company name. According to HubSpot docs, a more advanced search is coming in the future. 
     # The default value for is nil, meaning return all leads.
-    def self.find(search=nil)
-      url = "#{RHapi.options[:end_point]}/leads/#{RHapi.options[:version]}/list?hapikey=#{RHapi.options[:api_key]}&search=#{search}"
-      data = Curl::Easy.perform(url)
-      RHapi::RHapiException.raise_error(data.body_str) if data.body_str =~ /Error/i
-      lead_data = JSON.parse(data.body_str)
+    def self.find(search=nil, options={})  
+      options[:search] = search unless search.nil?
+      response = get(url_for("list", nil, options))
+ 
+      lead_data = JSON.parse(response.body_str)
       leads = []
       lead_data.each do |data|
         lead = Lead.new(data)
@@ -33,25 +37,28 @@ module RHapi
     
     # Finds specified lead by the guid.
     def self.find_by_guid(guid)
-      url = "#{RHapi.options[:end_point]}/leads/#{RHapi.options[:version]}/lead/#{guid}?hapikey=#{RHapi.options[:api_key]}"
-      c = Curl::Easy.perform(url)
-      RHapi::RHapiException.raise_error(c.body_str) if c.body_str =~ /Error/i
-      lead_data = JSON.parse(c.body_str)
+      response = get(url_for("lead", guid))
+      lead_data = JSON.parse(response.body_str)
       Lead.new(lead_data)
     end
     
     # Instance methods -------------------------------------------------------
-    def update
-      url = "#{RHapi.options[:end_point]}/leads/#{RHapi.options[:version]}/lead/#{self.guid}?hapikey=#{RHapi.options[:api_key]}"
-      data = self.changed_attributes.to_json
-      c = Curl::Easy.http_put(url, data) do |curl| 
-        curl.headers["Content-Type"] = "application/json"
-        curl.header_in_body = true
-      end
-      RHapi::RHapiException.raise_error(c.body_str) unless c.body_str =~ /200/i
+    def update(params={})
+      update_attributes(params) unless params.empty?
+      response = put(Lead.url_for("lead", self.guid), self.changed_attributes)
       true
     end
     
+    def update_attributes(params)
+      raise(RHapi::AttributeError, "The params must be a hash.") unless params.is_a?(Hash)
+      params.each do |key, value|
+        attribute = ActiveSupport::Inflector.camelize(key.to_s, false)
+        raise(RHapi::AttributeError, "No Hubspot attribute with the name #{attribute}.") unless self.attributes.include?(attribute)
+        self.changed_attributes[attribute] = value
+        self.attributes[attribute] = value
+      end
+    end
+    
     
     
     # Work with data in the data hash

data/lib/r_hapi/r_hapi_exception.rb

@@ -1,5 +1,5 @@
 module RHapi
-  class RHapiException < RuntimeError
+  class ConnectionError < StandardError
     attr :error_string
     
     def initialize(error_string)
@@ -8,21 +8,25 @@ module RHapi
     
     def message
       if @error_string =~ /401/
-        "HubSopt returned a 401 error. Make sure your API key is correct." 
+        "HubSopt returned a 401 error:  #{error_string}" 
       elsif @error_string =~ /404/
-        "HubSopt returned a 404 error. Check the end point or the guid to make sure it is valid."
+        "HubSopt returned a 404 error:  #{error_string}"
       elsif @error_string =~ /500/
-        "HubSopt returned a 500 error."
+        "HubSopt returned a 500 error:  #{error_string}"
       else
-        # else send back the whole message.
         @error_string
       end
     end
     
-    def self.raise_error(error_response)
-      exception = RHapi::RHapiException.new(error_response)
+    def self.raise_error(response)
+      exception = RHapi::ConnectionError.new(response)
       raise(exception, exception.message)
-    end
+    end 
     
   end
+  
+  class UriError < TypeError; end
+  
+  class AttributeError < TypeError; end
+  
 end

data/r_hapi.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{r_hapi}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tim Stephenson of RaddOnline"]
-  s.date = %q{2011-03-18}
+  s.date = %q{2011-03-22}
   s.description = %q{Makes it easy to use the HubSpot API in a Ruby application.}
   s.email = %q{tim@raddonline.com}
   s.extra_rdoc_files = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/r_hapi.rb",
     "lib/r_hapi/configuration.rb",
+    "lib/r_hapi/connection.rb",
     "lib/r_hapi/lead.rb",
     "lib/r_hapi/r_hapi_exception.rb",
     "r_hapi.gemspec",

data/spec/lead_spec.rb

@@ -2,6 +2,34 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "RHapi::Lead" do
   
+  context "connection" do
+    before do
+      RHapi.configure do |config|
+        config.api_key = test_config["api_key"]
+        config.hub_spot_site = "http://mysite.hubspot.com"
+      end
+      @url = "https://hubapi.com/leads/v1/list?hapikey=#{test_config["api_key"]}"
+    end
+    it "should generate a url with a search param" do
+      url = RHapi::Lead.url_for("list", nil, {:search => "test"})
+      url.should == @url << "&search=test"
+    end
+    it "should generate a url with multiple params" do
+      url = RHapi::Lead.url_for("list", nil, {:search => "test", :sort => "firstName", :dir => "asc", :max => 10})
+      url.include?("&sort=firstName").should == true
+      url.include?("&search=test").should == true
+      url.include?("&dir=asc").should == true
+      url.include?("&max=10").should == true
+    end
+    it "should generate a url with an id" do
+      url = RHapi::Lead.url_for("lead", "myid")
+      url.should == "https://hubapi.com/leads/v1/lead/myid?hapikey=#{test_config["api_key"]}"
+    end
+    it "should raise a url error if options is not a hash" do
+      lambda {RHapi::Lead.url_for("list", nil, nil)}.should raise_error(RHapi::UriError)
+    end
+  end
+  
   context "when searching for leads" do
     before do
       RHapi.configure do |config|
@@ -37,8 +65,7 @@ describe "RHapi::Lead" do
       lead.analytics_details.length.should == 12
       lead.analytics_details["allViewsImported"].should == true
     end
-
-    
+  
   end
   
   context "updating a lead" do
@@ -64,18 +91,32 @@ describe "RHapi::Lead" do
       stub_lead_update
       leads = RHapi::Lead.find
       lead = leads.first
-      lead.first_name = "Barny"
-      lead.last_name = "Rubble"
+      lead.first_name = "Adam"
+      lead.last_name = "Enbar"
       lead.update.should == true
     end
     
+    it "should have a list of changed attributes when updating with a params hash" do
+      stub_lead_update
+      leads = RHapi::Lead.find
+      lead = leads.first
+      lead.update({:first_name => "Wilma", :last_name => "Flintstone", :city => "Bedrock", :state => "CA"}).should == true
+      lead.changed_attributes.length.should == 4
+      lead.changed_attributes["firstName"].should == "Wilma"
+      lead.changed_attributes["firstName"].should == "Wilma"
+      lead.changed_attributes["city"].should == "Bedrock"
+      lead.changed_attributes["state"].should == "CA"
+    end
+    
     it "should raise an error if 200 is not returned" do
-      stub_lead_update_error
       leads = RHapi::Lead.find
       lead = leads.first
       lead.first_name = "Barny"
       lead.last_name = "Rubble"
-      lambda {lead.update}.should raise_error(RHapi::RHapiException)
+      lead.guid = "wrong"
+      stub_lead_update_error
+      
+      lambda {lead.update}.should raise_error(RHapi::ConnectionError)
     end
     
   end
@@ -97,9 +138,8 @@ describe "RHapi::Lead" do
     end
     
     it "should raise an error if an error string is returned" do
-      leads = RHapi::Lead.find
       stub_leads_error
-      lambda {RHapi::Lead.find_by_guid(leads.first.guid)}.should raise_error(RHapi::RHapiException)
+      lambda {RHapi::Lead.find_by_guid("badguid")}.should raise_error(RHapi::ConnectionError)
     end
   end
   
@@ -114,7 +154,7 @@ describe "RHapi::Lead" do
     
     it "should raise an exception" do
       stub_leads_error
-      lambda {RHapi::Lead.find}.should raise_error(RHapi::RHapiException)
+      lambda {RHapi::Lead.find}.should raise_error(RHapi::ConnectionError)
     end
   end
   

data/spec/spec_helper.rb

@@ -29,31 +29,36 @@ def test_error
 end
 
 def stub_leads_search
-  @data = mock("data")
-  @data.stub!(:body_str).and_return(test_leads) 
-  Curl::Easy.stub!(:perform).and_return(@data)
+  @response = mock("response_data")
+  @response.stub!(:body_str).and_return(test_leads) 
+  @response.stub!(:header_str).and_return("200 OK")
+  Curl::Easy.stub!(:perform).and_return(@response)
 end
 
 def stub_leads_find_by_guid
-  @data = mock("data")
-  @data.stub!(:body_str).and_return(test_lead) 
-  Curl::Easy.stub!(:perform).and_return(@data)
+  @response = mock("response_data")
+  @response.stub!(:body_str).and_return(test_lead) 
+  @response.stub!(:header_str).and_return("200 OK")
+  Curl::Easy.stub!(:perform).and_return(@response)
 end
 
 def stub_leads_error
-  @data = mock("data")
-  @data.stub!(:body_str).and_return(test_error) 
-  Curl::Easy.stub!(:perform).and_return(@data)
+  @response = mock("response_data")
+  @response.stub!(:body_str).and_return(test_error) 
+  @response.stub!(:header_str).and_return("404")
+  Curl::Easy.stub!(:perform).and_return(@response)
 end
 
 def stub_lead_update
   @response_mock = mock("data")
   @response_mock.stub!(:body_str).and_return("200 OK") 
+  @response_mock.stub!(:header_str).and_return("200 OK")
   Curl::Easy.stub!(:http_put).and_return(@response_mock)
 end
 
 def stub_lead_update_error
   @response_mock = mock("data")
+  @response_mock.stub!(:header_str).and_return("500")
   @response_mock.stub!(:body_str).and_return("Error: 500 internal server error.") 
   Curl::Easy.stub!(:http_put).and_return(@response_mock)
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: r_hapi
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Tim Stephenson of RaddOnline
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-18 00:00:00 -07:00
+date: 2011-03-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -190,6 +190,7 @@ files:
 - VERSION
 - lib/r_hapi.rb
 - lib/r_hapi/configuration.rb
+- lib/r_hapi/connection.rb
 - lib/r_hapi/lead.rb
 - lib/r_hapi/r_hapi_exception.rb
 - r_hapi.gemspec