hubspot-ruby 0.1.8 → 0.2.0

data/lib/hubspot/company_properties.rb

@@ -0,0 +1,59 @@
+module Hubspot
+  class CompanyProperties < Properties
+
+    ALL_PROPERTIES_PATH  = '/companies/v2/properties'
+    ALL_GROUPS_PATH      = '/companies/v2/groups'
+    CREATE_PROPERTY_PATH = '/companies/v2/properties/'
+    UPDATE_PROPERTY_PATH = '/companies/v2/properties/named/:property_name'
+    DELETE_PROPERTY_PATH = '/companies/v2/properties/named/:property_name'
+    CREATE_GROUP_PATH    = '/companies/v2/groups/'
+    UPDATE_GROUP_PATH    = '/companies/v2/groups/named/:group_name'
+    DELETE_GROUP_PATH    = '/companies/v2/groups/named/:group_name'
+
+    class << self
+      def add_default_parameters(opts={})
+        superclass.add_default_parameters(opts)
+      end
+
+      def all(opts={}, filter={})
+        superclass.all(ALL_PROPERTIES_PATH, opts, filter)
+      end
+
+      def groups(opts={}, filter={})
+        superclass.groups(ALL_GROUPS_PATH, opts, filter)
+      end
+
+      def create!(params={})
+        superclass.create!(CREATE_PROPERTY_PATH, params)
+      end
+
+      def update!(property_name, params={})
+        superclass.update!(UPDATE_PROPERTY_PATH, property_name, params)
+      end
+
+      def delete!(property_name)
+        superclass.delete!(DELETE_PROPERTY_PATH, property_name)
+      end
+
+      def create_group!(params={})
+        superclass.create_group!(CREATE_GROUP_PATH, params)
+      end
+
+      def update_group!(group_name, params={})
+        superclass.update_group!(UPDATE_GROUP_PATH, group_name, params)
+      end
+
+      def delete_group!(group_name)
+        superclass.delete_group!(DELETE_GROUP_PATH, group_name)
+      end
+
+      def same?(src, dst)
+        superclass.same?(src, dst)
+      end
+
+      def valid_params(params)
+        superclass.valid_params(params)
+      end
+    end
+  end
+end

data/lib/hubspot/config.rb

@@ -1,15 +1,20 @@
+require 'logger'
+
 module Hubspot
   class Config
+
+    CONFIG_KEYS = [:hapikey, :base_url, :portal_id, :logger]
+    DEFAULT_LOGGER = Logger.new('/dev/null')
+
     class << self
-      attr_reader :hapikey
-      attr_reader :base_url
-      attr_reader :portal_id
+      attr_accessor *CONFIG_KEYS
 
       def configure(config)
         config.stringify_keys!
         @hapikey = config["hapikey"]
         @base_url = config["base_url"] || "https://api.hubapi.com"
         @portal_id = config["portal_id"]
+        @logger = config['logger'] || DEFAULT_LOGGER
         self
       end
 
@@ -17,6 +22,7 @@ module Hubspot
         @hapikey = nil
         @base_url = "https://api.hubapi.com"
         @portal_id = nil
+        @logger = DEFAULT_LOGGER
       end
 
       def ensure!(*params)
@@ -28,4 +34,4 @@ module Hubspot
 
     reset!
   end
-end
+end

data/lib/hubspot/connection.rb

@@ -6,6 +6,7 @@ module Hubspot
       def get_json(path, opts)
         url = generate_url(path, opts)
         response = get(url, format: :json)
+        log_request_and_response url, response
         raise(Hubspot::RequestError.new(response)) unless response.success?
         response.parsed_response
       end
@@ -15,6 +16,7 @@ module Hubspot
 
         url = generate_url(path, opts[:params])
         response = post(url, body: opts[:body].to_json, headers: { 'Content-Type' => 'application/json' }, format: :json)
+        log_request_and_response url, response, opts[:body]
         raise(Hubspot::RequestError.new(response)) unless response.success?
 
         no_parse ? response : response.parsed_response
@@ -23,6 +25,7 @@ module Hubspot
       def put_json(path, opts)
         url = generate_url(path, opts[:params])
         response = put(url, body: opts[:body].to_json, headers: { 'Content-Type' => 'application/json' }, format: :json)
+        log_request_and_response url, response, opts[:body]
         raise(Hubspot::RequestError.new(response)) unless response.success?
         response.parsed_response
       end
@@ -30,12 +33,17 @@ module Hubspot
       def delete_json(path, opts)
         url = generate_url(path, opts)
         response = delete(url, format: :json)
+        log_request_and_response url, response, opts[:body]
         raise(Hubspot::RequestError.new(response)) unless response.success?
         response
       end
 
       protected
 
+      def log_request_and_response(uri, response, body=nil)
+        Hubspot::Config.logger.info "Hubspot: #{uri}.\nBody: #{body}.\nResponse: #{response.code} #{response.body}"
+      end
+
       def generate_url(path, params={}, options={})
         Hubspot::Config.ensure! :hapikey
         path = path.clone
@@ -85,11 +93,11 @@ module Hubspot
   end
 
   class FormsConnection < Connection
-    follow_redirects false
+    follow_redirects true
 
     def self.submit(path, opts)
-      url = generate_url(path, opts[:params], { base_url: 'https://forms.hubspot.com' })
-      post(url, body: opts[:body].to_json, headers: { 'Content-Type' => 'application/x-www-form-urlencoded' })
+      url = generate_url(path, opts[:params], { base_url: 'https://forms.hubspot.com', hapikey: false })
+      post(url, body: opts[:body], headers: { 'Content-Type' => 'application/x-www-form-urlencoded' })
     end
   end
-end
+end

data/lib/hubspot/contact.rb

@@ -6,22 +6,24 @@ module Hubspot
   #
   # TODO: work on all endpoints that can specify contact properties, property mode etc... as params. cf pending specs
   class Contact
-    CREATE_CONTACT_PATH        = "/contacts/v1/contact"
-    GET_CONTACT_BY_EMAIL_PATH  = "/contacts/v1/contact/email/:contact_email/profile"
-    GET_CONTACTS_BY_EMAIL_PATH = "/contacts/v1/contact/emails/batch"
-    GET_CONTACT_BY_ID_PATH     = "/contacts/v1/contact/vid/:contact_id/profile"
+    CREATE_CONTACT_PATH        = '/contacts/v1/contact'
+    GET_CONTACT_BY_EMAIL_PATH  = '/contacts/v1/contact/email/:contact_email/profile'
+    GET_CONTACTS_BY_EMAIL_PATH = '/contacts/v1/contact/emails/batch'
+    GET_CONTACT_BY_ID_PATH     = '/contacts/v1/contact/vid/:contact_id/profile'
     CONTACT_BATCH_PATH         = '/contacts/v1/contact/vids/batch'
-    GET_CONTACT_BY_UTK_PATH    = "/contacts/v1/contact/utk/:contact_utk/profile"
+    GET_CONTACT_BY_UTK_PATH    = '/contacts/v1/contact/utk/:contact_utk/profile'
     GET_CONTACTS_BY_UTK_PATH   = '/contacts/v1/contact/utks/batch'
-    UPDATE_CONTACT_PATH        = "/contacts/v1/contact/vid/:contact_id/profile"
-    DESTROY_CONTACT_PATH       = "/contacts/v1/contact/vid/:contact_id"
-    CONTACTS_PATH              = "/contacts/v1/lists/all/contacts/all"
+    UPDATE_CONTACT_PATH        = '/contacts/v1/contact/vid/:contact_id/profile'
+    DESTROY_CONTACT_PATH       = '/contacts/v1/contact/vid/:contact_id'
+    CONTACTS_PATH              = '/contacts/v1/lists/all/contacts/all'
     RECENT_CONTACTS_PATH       = '/contacts/v1/lists/recently_updated/contacts/recent'
+    CREATE_OR_UPDATE_PATH      = '/contacts/v1/contact/createOrUpdate/email/:contact_email'
+    QUERY_PATH                 = '/contacts/v1/search/query'
 
     class << self
       # {https://developers.hubspot.com/docs/methods/contacts/create_contact}
       def create!(email, params={})
-        params_with_email = params.stringify_keys.merge("email" => email)
+        params_with_email = params.stringify_keys.merge('email' => email)
         post_data = {properties: Hubspot::Utils.hash_to_properties(params_with_email)}
         response = Hubspot::Connection.post_json(CREATE_CONTACT_PATH, params: {}, body: post_data )
         new(response)
@@ -30,11 +32,11 @@ module Hubspot
       # {https://developers.hubspot.com/docs/methods/contacts/get_contacts}
       # {https://developers.hubspot.com/docs/methods/contacts/get_recently_updated_contacts}
       def all(opts={})
-        recent = opts.delete(:recent) { false } 
-        path, opts = 
-        if recent 
-          [RECENT_CONTACTS_PATH, Hubspot::ContactProperties.add_default_parameters(opts)] 
-        else 
+        recent = opts.delete(:recent) { false }
+        path, opts =
+        if recent
+          [RECENT_CONTACTS_PATH, Hubspot::ContactProperties.add_default_parameters(opts)]
+        else
           [CONTACTS_PATH, opts]
         end
 
@@ -46,6 +48,13 @@ module Hubspot
       # PATH /contacts/v1/contact/createOrUpdate/email/:contact_email
       # API endpoint: https://developers.hubspot.com/docs/methods/contacts/create_or_update
       # + batch mode: https://developers.hubspot.com/docs/methods/contacts/batch_create_or_update
+      def createOrUpdate(email, params={})
+        post_data = {properties: Hubspot::Utils.hash_to_properties(params.stringify_keys)}
+        response = Hubspot::Connection.post_json(CREATE_OR_UPDATE_PATH, params: { contact_email: email }, body: post_data )
+        contact = find_by_id(response['vid'])
+        contact.is_new = response['isNew']
+        contact
+      end
 
       # NOTE: problem with batch api endpoint
       # {https://developers.hubspot.com/docs/methods/contacts/get_contact}
@@ -71,18 +80,22 @@ module Hubspot
         else raise Hubspot::InvalidParams, 'expecting String or Array of Strings parameter'
         end
 
-        response = Hubspot::Connection.get_json(path, params)
-        if batch_mode
-          #TODO: transform response
-          response
-        else 
-          new(response)
+        begin
+          response = Hubspot::Connection.get_json(path, params)
+          if batch_mode
+            response.map{|_, contact| new(contact)}
+          else
+            new(response)
+          end
+        rescue => e
+          raise e unless e.message =~ /not exist/ # 404 / handle the error and kindly return nil
+          nil
         end
       end
 
       # NOTE: problem with batch api endpoint
       # {https://developers.hubspot.com/docs/methods/contacts/get_contact_by_utk}
-      # {https://developers.hubspot.com/docs/methods/contacts/get_batch_by_utk} 
+      # {https://developers.hubspot.com/docs/methods/contacts/get_batch_by_utk}
       def find_by_utk(utks)
         batch_mode, path, params = case utks
         when String then [false, GET_CONTACT_BY_UTK_PATH, { contact_utk: utks }]
@@ -96,17 +109,21 @@ module Hubspot
       end
 
       # {https://developers.hubspot.com/docs/methods/contacts/search_contacts}
-      def search(query, count=100)
-        raise NotImplementedError
+      def search(query, options = {})
+        count   = options.fetch(:count, 100)
+        offset  = options.fetch(:offset, 0)
+
+        response = Hubspot::Connection.get_json(QUERY_PATH, { q: query, count: count, offset: offset })
+        response.merge("contacts" => response["contacts"].map { |contact_hash| new(contact_hash) })
       end
     end
 
-    attr_reader :properties
-    attr_reader :vid
+    attr_reader :properties, :vid, :is_new
 
     def initialize(response_hash)
-      @properties = Hubspot::Utils.properties_to_hash(response_hash["properties"])
-      @vid = response_hash["vid"]
+      props = response_hash['properties']
+      @properties = Hubspot::Utils.properties_to_hash(props) unless props.blank?
+      @vid = response_hash['vid']
     end
 
     def [](property)
@@ -114,11 +131,15 @@ module Hubspot
     end
 
     def email
-      @properties["email"]
+      @properties['email']
     end
 
     def utk
-      @properties["usertoken"]
+      @properties['usertoken']
+    end
+
+    def is_new=(val)
+      @is_new = val
     end
 
     # Updates the properties of a contact
@@ -127,7 +148,7 @@ module Hubspot
     # @return [Hubspot::Contact] self
     def update!(params)
       query = {"properties" => Hubspot::Utils.hash_to_properties(params.stringify_keys!)}
-      response = Hubspot::Connection.post_json(UPDATE_CONTACT_PATH, params: { contact_id: vid }, body: query)
+      Hubspot::Connection.post_json(UPDATE_CONTACT_PATH, params: { contact_id: vid }, body: query)
       @properties.merge!(params)
       self
     end
@@ -136,7 +157,7 @@ module Hubspot
     # {https://developers.hubspot.com/docs/methods/contacts/delete_contact}
     # @return [TrueClass] true
     def destroy!
-      response = Hubspot::Connection.delete_json(DESTROY_CONTACT_PATH, { contact_id: vid })
+      Hubspot::Connection.delete_json(DESTROY_CONTACT_PATH, { contact_id: vid })
       @destroyed = true
     end
 

data/lib/hubspot/contact_list.rb

@@ -15,10 +15,10 @@ module Hubspot
     class << self
       # {http://developers.hubspot.com/docs/methods/lists/create_list}
       def create!(opts={})
-      	dynamic = opts.delete(:dynamic) { false } 
-      	portal_id = opts.delete(:portal_id) { Hubspot::Config.portal_id }
- 
-      	response = Hubspot::Connection.post_json(LISTS_PATH, params: {}, body: opts.merge({ dynamic: dynamic, portal_id: portal_id}) )
+        dynamic = opts.delete(:dynamic) { false }
+        portal_id = opts.delete(:portal_id) { Hubspot::Config.portal_id }
+
+        response = Hubspot::Connection.post_json(LISTS_PATH, params: {}, body: opts.merge({ dynamic: dynamic, portal_id: portal_id}) )
         new(response)
       end
 
@@ -26,11 +26,11 @@ module Hubspot
       # {http://developers.hubspot.com/docs/methods/lists/get_static_lists}
       # {http://developers.hubspot.com/docs/methods/lists/get_dynamic_lists}
       def all(opts={})
-      	static = opts.delete(:static) { false } 
-      	dynamic = opts.delete(:dynamic) { false } 
+        static = opts.delete(:static) { false }
+        dynamic = opts.delete(:dynamic) { false }
 
         # NOTE: As opposed of what the documentation says, getting the static or dynamic lists returns all the lists, not only 20 lists
-      	path = LISTS_PATH + (static ? '/static' : dynamic ? '/dynamic' : '') 
+        path = LISTS_PATH + (static ? '/static' : dynamic ? '/dynamic' : '')
         response = Hubspot::Connection.get_json(path, opts)
         response['lists'].map { |l| new(l) }
       end
@@ -38,12 +38,12 @@ module Hubspot
       # {http://developers.hubspot.com/docs/methods/lists/get_list}
       # {http://developers.hubspot.com/docs/methods/lists/get_batch_lists}
       def find(ids)
-      	batch_mode, path, params = case ids
+        batch_mode, path, params = case ids
         when Integer then [false, LIST_PATH, { list_id: ids }]
-        when String then [false, LIST_PATH, { list_id: ids.to_i }]  
+        when String then [false, LIST_PATH, { list_id: ids.to_i }]
         when Array then [true, LIST_BATCH_PATH, { batch_list_id: ids.map(&:to_i) }]
         else raise Hubspot::InvalidParams, 'expecting Integer or Array of Integers parameter'
-      	end
+        end
 
         response = Hubspot::Connection.get_json(path, params)
         batch_mode ? response['lists'].map { |l| new(l) } : new(response)
@@ -77,17 +77,17 @@ module Hubspot
     def contacts(opts={})
       # NOTE: caching functionality can be dependant of the nature of the list, if dynamic or not ...
       bypass_cache = opts.delete(:bypass_cache) { false }
-      recent = opts.delete(:recent) { false } 
+      recent = opts.delete(:recent) { false }
 
       if bypass_cache || @contacts.nil?
         path = recent ? RECENT_CONTACTS_PATH : CONTACTS_PATH
         opts[:list_id] = @id
-      	
+
         response = Hubspot::Connection.get_json(path, Hubspot::ContactProperties.add_default_parameters(opts))
         @contacts = response['contacts'].map { |c| Hubspot::Contact.new(c) }
       else
         @contacts
-      end 
+      end
     end
 
     # {http://developers.hubspot.com/docs/methods/lists/refresh_list}
@@ -97,12 +97,12 @@ module Hubspot
     end
 
     # {http://developers.hubspot.com/docs/methods/lists/add_contact_to_list}
-    def add(contacts) 
+    def add(contacts)
       contact_ids = [contacts].flatten.uniq.compact.map(&:vid)
       response = Hubspot::Connection.post_json(ADD_CONTACT_PATH, params: { list_id: @id }, body: { vids: contact_ids })
       response['updated'].sort == contact_ids.sort
     end
- 
+
     # {http://developers.hubspot.com/docs/methods/lists/remove_contact_from_list}
     def remove(contacts)
       contact_ids = [contacts].flatten.uniq.compact.map(&:vid)
@@ -124,4 +124,4 @@ module Hubspot
       @properties = hash
     end
   end
-end
+end

data/lib/hubspot/contact_properties.rb

@@ -1,11 +1,58 @@
 module Hubspot
-  class ContactProperties
-    class << self    
-      # TODO: properties can be set as configuration
-      # TODO: find the way how to set a list of Properties + merge same property key if present from opts
+  class ContactProperties < Properties
+
+    ALL_PROPERTIES_PATH  = '/contacts/v2/properties'
+    ALL_GROUPS_PATH      = '/contacts/v2/groups'
+    CREATE_PROPERTY_PATH = '/contacts/v2/properties/'
+    UPDATE_PROPERTY_PATH = '/contacts/v2/properties/named/:property_name'
+    DELETE_PROPERTY_PATH = '/contacts/v2/properties/named/:property_name'
+    CREATE_GROUP_PATH    = '/contacts/v2/groups/'
+    UPDATE_GROUP_PATH    = '/contacts/v2/groups/named/:group_name'
+    DELETE_GROUP_PATH    = '/contacts/v2/groups/named/:group_name'
+
+    class << self
       def add_default_parameters(opts={})
-        properties = 'email'
-        opts.merge(property: properties)
+        superclass.add_default_parameters(opts)
+      end
+
+      def all(opts={}, filter={})
+        superclass.all(ALL_PROPERTIES_PATH, opts, filter)
+      end
+
+      def groups(opts={}, filter={})
+        superclass.groups(ALL_GROUPS_PATH, opts, filter)
+      end
+
+      def create!(params={})
+        superclass.create!(CREATE_PROPERTY_PATH, params)
+      end
+
+      def update!(property_name, params={})
+        superclass.update!(UPDATE_PROPERTY_PATH, property_name, params)
+      end
+
+      def delete!(property_name)
+        superclass.delete!(DELETE_PROPERTY_PATH, property_name)
+      end
+
+      def create_group!(params={})
+        superclass.create_group!(CREATE_GROUP_PATH, params)
+      end
+
+      def update_group!(group_name, params={})
+        superclass.update_group!(UPDATE_GROUP_PATH, group_name, params)
+      end
+
+      def delete_group!(group_name)
+        superclass.delete_group!(DELETE_GROUP_PATH, group_name)
+      end
+
+      def same?(src, dst)
+        superclass.same?(src, dst)
+      end
+
+      def valid_params(params)
+        superclass.valid_params(params)
       end
     end
   end