hubspot-ruby 0.1.7 → 0.1.8

data/lib/hubspot/contact_list.rb

@@ -0,0 +1,127 @@
+module Hubspot
+  #
+  # HubSpot Contact lists API
+  #
+  class ContactList
+    LISTS_PATH           = '/contacts/v1/lists'
+    LIST_PATH            = '/contacts/v1/lists/:list_id'
+    LIST_BATCH_PATH      = LISTS_PATH + '/batch'
+    CONTACTS_PATH        = LIST_PATH + '/contacts/all'
+    RECENT_CONTACTS_PATH = LIST_PATH + '/contacts/recent'
+    ADD_CONTACT_PATH     = LIST_PATH + '/add'
+    REMOVE_CONTACT_PATH  = LIST_PATH + '/remove'
+    REFRESH_PATH         = LIST_PATH + '/refresh'
+
+    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}) )
+        new(response)
+      end
+
+      # {http://developers.hubspot.com/docs/methods/lists/get_lists}
+      # {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 } 
+
+        # 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' : '') 
+        response = Hubspot::Connection.get_json(path, opts)
+        response['lists'].map { |l| new(l) }
+      end
+
+      # {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
+        when Integer then [false, LIST_PATH, { list_id: ids }]
+        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
+
+        response = Hubspot::Connection.get_json(path, params)
+        batch_mode ? response['lists'].map { |l| new(l) } : new(response)
+      end
+    end
+
+    attr_reader :id
+    attr_reader :portal_id
+    attr_reader :name
+    attr_reader :dynamic
+    attr_reader :properties
+
+    def initialize(hash)
+      self.send(:assign_properties, hash)
+    end
+
+    # {http://developers.hubspot.com/docs/methods/lists/update_list}
+    def update!(opts={})
+      response = Hubspot::Connection.post_json(LIST_PATH, params: { list_id: @id }, body: opts)
+      self.send(:assign_properties, response)
+      self
+    end
+
+    # {http://developers.hubspot.com/docs/methods/lists/delete_list}
+    def destroy!
+      response = Hubspot::Connection.delete_json(LIST_PATH, { list_id: @id })
+      @destroyed = (response.code == 204)
+    end
+
+    # {http://developers.hubspot.com/docs/methods/lists/get_list_contacts}
+    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 } 
+
+      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
+
+    # {http://developers.hubspot.com/docs/methods/lists/refresh_list}
+    def refresh
+      response = Hubspot::Connection.post_json(REFRESH_PATH, params: { list_id: @id, no_parse: true }, body: {})
+      response.code == 204
+    end
+
+    # {http://developers.hubspot.com/docs/methods/lists/add_contact_to_list}
+    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)
+      response = Hubspot::Connection.post_json(REMOVE_CONTACT_PATH, params: { list_id: @id }, body: { vids: contact_ids })
+      response['updated'].sort == contact_ids.sort
+    end
+
+    def destroyed?
+      !!@destroyed
+    end
+
+    private
+
+    def assign_properties(hash)
+      @id = hash['listId']
+      @portal_id = hash['portalId']
+      @name = hash['name']
+      @dynamic = hash['dynamic']
+      @properties = hash
+    end
+  end
+end

data/lib/hubspot/contact_properties.rb

@@ -0,0 +1,12 @@
+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
+      def add_default_parameters(opts={})
+        properties = 'email'
+        opts.merge(property: properties)
+      end
+    end
+  end
+end

data/lib/hubspot/deal.rb

@@ -1,5 +1,4 @@
 require 'hubspot/utils'
-require 'httparty'
 
 module Hubspot
   #
@@ -8,6 +7,10 @@ module Hubspot
   # {http://developers.hubspot.com/docs/methods/deals/deals_overview}
   #
   class Deal
+    CREATE_DEAL_PATH = "/deals/v1/deal"
+    DEAL_PATH = "/deals/v1/deal/:deal_id"
+    RECENT_UPDATED_PATH = "/deals/v1/deal/recent/modified"
+    UPDATE_DEAL_PATH = '/deals/v1/deal/:deal_id'
 
     attr_reader :properties
     attr_reader :portal_id
@@ -15,10 +18,6 @@ module Hubspot
     attr_reader :company_ids
     attr_reader :vids
 
-    CREATE_DEAL_PATH = "/deals/v1/deal"
-    DEAL_PATH = "/deals/v1/deal/:deal_id"
-    RECENT_UPDATED_PATH = "/deals/v1/deal/recent/modified"
-
     def initialize(response_hash)
       @portal_id = response_hash["portalId"]
       @deal_id = response_hash["dealId"]
@@ -29,21 +28,17 @@ module Hubspot
 
     class << self
       def create!(portal_id, company_ids, vids, params={})
-        url = Hubspot::Utils.generate_url(CREATE_DEAL_PATH).concat("&portalId=#{portal_id}")
+        #TODO: clean following hash, Hubspot::Utils should do the trick
         associations_hash = {"portalId" => portal_id, "associations" => { "associatedCompanyIds" => company_ids, "associatedVids" => vids}}
         post_data = associations_hash.merge({ properties: Hubspot::Utils.hash_to_properties(params, key_name: "name") })
-        resp = HTTParty.post(url, body: post_data.to_json, headers: {"Content-Type" => "application/json"})
-        Hubspot::Deal.new(resp.parsed_response)
+
+        response = Hubspot::Connection.post_json(CREATE_DEAL_PATH, params: {}, body: post_data )
+        new(response)
       end
 
       def find(deal_id)
-        url = Hubspot::Utils.generate_url(DEAL_PATH, {deal_id: deal_id})
-        resp = HTTParty.get(url, format: :json)
-        if resp.success?
-          Hubspot::Deal.new(resp.parsed_response)
-        else
-          nil
-        end
+        response = Hubspot::Connection.get_json(DEAL_PATH, { deal_id: deal_id })
+        new(response)
       end
 
       # Find recent updated deals.
@@ -51,28 +46,37 @@ module Hubspot
       # @param count [Integer] the amount of deals to return.
       # @param offset [Integer] pages back through recent contacts.
       def recent(opts = {})
-        url = Hubspot::Utils.generate_url(RECENT_UPDATED_PATH, opts)
-        request = HTTParty.get(url, format: :json)
-
-        raise(Hubspot::RequestError.new(request)) unless request.success?
-
-        found = request.parsed_response['results']
-        return found.map{|h| new(h) }
+        response = Hubspot::Connection.get_json(RECENT_UPDATED_PATH, opts)
+        response['results'].map { |d| new(d) }
       end
+
     end
 
     # Archives the contact in hubspot
     # {https://developers.hubspot.com/docs/methods/contacts/delete_contact}
     # @return [TrueClass] true
     def destroy!
-      url = Hubspot::Utils.generate_url(DEAL_PATH, {deal_id: deal_id})
-      request = HTTParty.delete(url, format: :json)
-      raise(Hubspot::RequestError.new(request)) unless request.success?
+      response = Hubspot::Connection.delete_json(DEAL_PATH, {deal_id: deal_id})
       @destroyed = true
     end
 
     def destroyed?
       !!@destroyed
     end
+
+    def [](property)
+      @properties[property]
+    end
+
+    # Updates the properties of a deal
+    # {https://developers.hubspot.com/docs/methods/deals/update_deal}
+    # @param params [Hash] hash of properties to update
+    # @return [Hubspot::Deal] self
+    def update!(params)
+      query = {"properties" => Hubspot::Utils.hash_to_properties(params.stringify_keys!, key_name: 'name')}
+      response = Hubspot::Connection.put_json(UPDATE_DEAL_PATH, params: { deal_id: deal_id }, body: query)
+      @properties.merge!(params)
+      self
+    end
   end
 end

data/lib/hubspot/exceptions.rb

@@ -13,4 +13,6 @@ module Hubspot
   class ConfigurationError < StandardError; end
   class MissingInterpolation < StandardError; end
   class ContactExistsError < RequestError; end
+  class InvalidParams < StandardError; end
+  class ApiError < StandardError; end
 end

data/lib/hubspot/form.rb

@@ -1,11 +1,95 @@
 module Hubspot
+  #
+  # HubSpot Form API
+  #
+  # {https://developers.hubspot.com/docs/methods/forms/forms_overview}
+  #
   class Form
-    def initialize(form_guid)
-      @form_guid = form_guid
+  	FORMS_PATH       = '/contacts/v1/forms'
+  	FORM_PATH        = '/contacts/v1/forms/:form_guid'
+  	FIELDS_PATH      = '/contacts/v1/fields/:form_guid'
+  	FIELD_PATH       = FIELDS_PATH + '/:field_name'
+  	SUBMIT_DATA_PATH = '/uploads/form/v2/:portal_id/:form_guid'
+
+    class << self
+      # {https://developers.hubspot.com/docs/methods/forms/create_form}
+      def create!(opts={})
+      	response = Hubspot::Connection.post_json(FORMS_PATH, params: {}, body: opts)
+        new(response)
+      end
+
+      def all
+        response = Hubspot::Connection.get_json(FORMS_PATH, {})
+        response.map { |f| new(f) }
+      end
+
+      # {https://developers.hubspot.com/docs/methods/forms/get_form}
+      def find(guid)
+        response = Hubspot::Connection.get_json(FORM_PATH, { form_guid: guid })
+        new(response)
+      end
+    end
+
+    attr_reader :guid
+    attr_reader :fields
+    attr_reader :properties
+
+    def initialize(hash)
+      self.send(:assign_properties, hash)	
+    end
+
+    # {https://developers.hubspot.com/docs/methods/forms/get_fields}
+    # {https://developers.hubspot.com/docs/methods/forms/get_field}
+    def fields(opts={})
+      bypass_cache = opts.delete(:bypass_cache) { false }
+      field_name = opts.delete(:only) { nil }
+
+      if field_name
+      	field_name = field_name.to_s
+      	if bypass_cache || @fields.nil? || @fields.empty?
+      	  response = Hubspot::Connection.get_json(FIELD_PATH, { form_guid: @guid, field_name: field_name })
+      	  response
+      	else
+      	  @fields.detect { |f| f['name'] == field_name }	
+      	end
+      else
+      	if bypass_cache || @fields.nil? || @fields.empty?
+          response = Hubspot::Connection.get_json(FIELDS_PATH, { form_guid: @guid })
+          @fields = response
+        end
+        @fields
+      end
     end
+ 
+    # {https://developers.hubspot.com/docs/methods/forms/submit_form}
+    def submit(opts={})    
+      response = Hubspot::FormsConnection.submit(SUBMIT_DATA_PATH, params: { form_guid: @guid }, body: opts)
+      [204, 302].include?(response.code)
+    end
+
+    # {https://developers.hubspot.com/docs/methods/forms/update_form}
+    def update!(opts={})
+      response = Hubspot::Connection.post_json(FORM_PATH, params: { form_guid: @guid }, body: opts)
+      self.send(:assign_properties, response)
+      self
+    end
+
+    # {https://developers.hubspot.com/docs/methods/forms/delete_form}
+    def destroy!
+      response = Hubspot::Connection.delete_json(FORM_PATH, { form_guid: @guid })
+      @destroyed = (response.code == 204)
+    end
+
+    def destroyed?
+      !!@destroyed
+    end
+
+    private
 
-    def url
-      Hubspot::Utils.generate_url("/uploads/form/v2/:portal_id/:form_guid", {form_guid: @form_guid}, {base_url: "https://forms.hubspot.com", hapikey: false})
+    def assign_properties(hash)
+      @guid = hash['guid']
+      @fields = hash['fields']
+      @properties = hash
     end
   end
 end

data/lib/hubspot/topic.rb

@@ -1,42 +1,26 @@
-require 'hubspot/utils'
-require 'httparty'
-
 module Hubspot
   #
   # HubSpot Topics API
   #
   class Topic
-    TOPIC_LIST_PATH = "/content/api/v2/topics"
-    GET_TOPIC_BY_ID_PATH = "/content/api/v2/topics/:topic_id"
+    TOPICS_PATH = "/content/api/v2/topics"
+    TOPIC_PATH = "/content/api/v2/topics/:topic_id"
 
     class << self
       # Lists the topics
       # {https://developers.hubspot.com/docs/methods/blogv2/get_topics)
-      # @return [Hubspot::Topic, []] array of topics or empty_array
+      # @return [Hubspot::Topic] array of topics
       def list
-        url = Hubspot::Utils.generate_url(TOPIC_LIST_PATH)
-        resp = HTTParty.get(url, format: :json)
-        if resp.success?
-          resp.parsed_response['objects'].map do |topic_hash|
-            Topic.new(topic_hash)
-          end
-        else
-          []
-        end
+        response = Hubspot::Connection.get_json(TOPICS_PATH, {})
+        response['objects'].map { |t| new(t) }
       end
 
       # Finds the details for a specific topic_id
       # {https://developers.hubspot.com/docs/methods/blogv2/get_topics_topic_id }
-      # @return Hubspot::Topic or nil
-
+      # @return Hubspot::Topic
       def find_by_topic_id(id)
-        url = Hubspot::Utils.generate_url(GET_TOPIC_BY_ID_PATH, topic_id: id)
-        resp = HTTParty.get(url, format: :json)
-        if resp.success?
-          Topic.new(resp.parsed_response)
-        else
-          nil
-        end
+        response = Hubspot::Connection.get_json(TOPIC_PATH, { topic_id: id })
+        new(response)
       end
     end
 

data/lib/hubspot/utils.rb

@@ -13,57 +13,6 @@ module Hubspot
         key_name = opts[:key_name] || "property"
         hash.map{ |k,v| { key_name => k.to_s, "value" => v}}
       end
-
-      # Generate the API URL for the request
-      #
-      # @param path [String] The path of the request with leading "/". Parts starting with a ":" will be interpolated
-      # @param params [Hash] params to be included in the query string or interpolated into the url.
-      #
-      # @return [String]
-      #
-      def generate_url(path, params={}, options={})
-        Hubspot::Config.ensure! :hapikey
-        path = path.clone
-        params = params.clone
-        base_url = options[:base_url] || Hubspot::Config.base_url
-        params["hapikey"] = Hubspot::Config.hapikey unless options[:hapikey] == false
-
-        if path =~ /:portal_id/
-          Hubspot::Config.ensure! :portal_id
-          params["portal_id"] = Hubspot::Config.portal_id if path =~ /:portal_id/
-        end
-
-        params.each do |k,v|
-          if path.match(":#{k}")
-            path.gsub!(":#{k}",v.to_s)
-            params.delete(k)
-          end
-        end
-        raise(Hubspot::MissingInterpolation.new("Interpolation not resolved")) if path =~ /:/
-        query = params.map{ |k,v| param_string(k,v) }.join("&")
-        path += "?" if query.present?
-        base_url + path + query
-      end
-
-
-      private
-
-      def converted_value(value)
-        if (value.is_a?(Time))
-          (value.to_i * 1000) # convert into milliseconds since epoch
-        else
-          value
-        end
-      end
-
-      def param_string(key,value)
-        if (key =~ /range/)
-          raise "Value must be a range" unless value.is_a?(Range)
-          "#{key}=#{converted_value(value.begin)}&#{key}=#{converted_value(value.end)}"
-        else
-          "#{key}=#{converted_value(value)}"
-        end
-      end
     end
   end
 end