hubspot-ruby 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16ee939bb4d593cc623309e093902d9a937b9fda
-  data.tar.gz: d5c6b6765d4a3a7adda09fbb6b9a1768c91b1d86
+  metadata.gz: 9eded4f33457d91f6b5feb303f5bd7524223d8ab
+  data.tar.gz: 84a6116a408d19dd093ebd40d0fae9d535e5e078
 SHA512:
-  metadata.gz: 6f22e580fac3d5a5f4b1ac812cf21040c6105e8fc86ad4e03dc71b0aa0276bf48f4b89cf826d806eb2a7cef5be90a820c47a81a23ca27d34833bdf77a4076dfe
-  data.tar.gz: d322208c51497e956f63d9cb7453ce90540691af81661bcea456ca3118deb53da6fcb95a9ecd8a91f2dc433a12a47a482bb2eec1fd7043a12e7fd27ef425c32c
+  metadata.gz: f3359f3aeef879c07870f8d6537f99c7d96117224e13ebbb6a1a87032aaa2ba212f5862dcbde1795cf2feefb01850d2b3879dc48e96672f55bab8e1c43be3e6a
+  data.tar.gz: 350179721426bffbd0260655aa98485b855591042dc8edffb4e4139b70390bad24512d67a27af1de0313741926b782b3133cd822f1df7164677f223a176d1929

data/README.md

@@ -37,6 +37,12 @@ Here's what you can do for now:
 Hubspot::Contact.create!("email@address.com", {firstname: "First", lastname: "Last"})
 ```
 
+#### In batches
+
+```ruby
+Hubspot::Contact.create_or_update!([{email: 'smith@example.com', firstname: 'First', lastname: 'Last'}])
+```
+
 ### Find a contact
 
 These methods will return a `Hubspot::Contact` object if successful, `nil` otherwise:
@@ -54,6 +60,11 @@ Given an instance of `Hubspot::Contact`, update its attributes with:
 contact.update!({firstname: "First", lastname: "Last"})
 ```
 
+#### In batches
+
+```ruby
+Hubspot::Contact.create_or_update!([{vid: '12345', firstname: 'First', lastname: 'Last'}])
+```
 ## Contributing to hubspot-ruby
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/hubspot-ruby.gemspec

@@ -1,11 +1,12 @@
 Gem::Specification.new do |s|
   s.name = "hubspot-ruby"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
   s.require_paths = ["lib"]
   s.authors = ["Andrew DiMichele"]
   s.description = "hubspot-ruby is a wrapper for the HubSpot REST API"
   s.files = [".rspec", "Gemfile", "Gemfile.lock", "Guardfile", "LICENSE.txt", "README.md", "RELEASING.md", "Rakefile", "hubspot-ruby.gemspec"]
   s.files += Dir["lib/**/*.rb"]
+  s.files += Dir["lib/**/*.rake"]
   s.files += Dir["spec/**/*.rb"]
   s.homepage = "http://github.com/adimichele/hubspot-ruby"
   s.summary = "hubspot-ruby is a wrapper for the HubSpot REST API"

data/lib/hubspot/connection.rb

@@ -68,7 +68,7 @@ module Hubspot
           v.is_a?(Array) ? v.map { |value| param_string(k,value) } : param_string(k,v)
         end.join("&")
 
-        path += "?" if query.present?
+        p path += path.include?('?') ? '&' : "?" if query.present?
         base_url + path + query
       end
 

data/lib/hubspot/contact.rb

@@ -6,19 +6,20 @@ 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'
-    CONTACT_BATCH_PATH         = '/contacts/v1/contact/vids/batch'
-    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'
-    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'
+    CREATE_CONTACT_PATH          = '/contacts/v1/contact'
+    BATCH_CREATE_OR_UPDATE_PATH  = '/contacts/v1/contact/batch/'
+    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_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'
+    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}
@@ -47,7 +48,6 @@ module Hubspot
       # TODO: create or update a contact
       # 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 )
@@ -56,6 +56,28 @@ module Hubspot
         contact
       end
 
+      # NOTE: Performance is best when calls are limited to 100 or fewer contacts
+      # {https://developers.hubspot.com/docs/methods/contacts/batch_create_or_update}
+      def create_or_update!(contacts)
+        query = contacts.map do |ch|
+          contact_hash = ch.with_indifferent_access
+          contact_param = {
+            properties: Hubspot::Utils.hash_to_properties(contact_hash.except(:vid))
+          }
+          if contact_hash[:vid]
+            contact_param.merge!(vid: contact_hash[:vid])
+          elsif contact_hash[:email]
+            contact_param.merge!(email: contact_hash[:email])
+          else
+            raise Hubspot::InvalidParams, 'expecting vid or email for contact'
+          end
+          contact_param
+        end
+        Hubspot::Connection.post_json(BATCH_CREATE_OR_UPDATE_PATH,
+                                      params: {},
+                                      body: query)
+      end
+
       # NOTE: problem with batch api endpoint
       # {https://developers.hubspot.com/docs/methods/contacts/get_contact}
       # {https://developers.hubspot.com/docs/methods/contacts/get_batch_by_vid}

data/lib/hubspot/deal.rb

@@ -11,6 +11,7 @@ module Hubspot
     DEAL_PATH = "/deals/v1/deal/:deal_id"
     RECENT_UPDATED_PATH = "/deals/v1/deal/recent/modified"
     UPDATE_DEAL_PATH = '/deals/v1/deal/:deal_id'
+    ASSOCIATE_DEAL_PATH = '/deals/v1/deal/:deal_id/associations/:OBJECTTYPE?id=:objectId'
 
     attr_reader :properties
     attr_reader :portal_id
@@ -36,6 +37,17 @@ module Hubspot
         new(response)
       end
 
+       # Associate a deal with a contact or company
+       # {http://developers.hubspot.com/docs/methods/deals/associate_deal}
+       # Usage
+       # Hubspot::Deal.associate!(45146940, [], [52])
+       def associate!(deal_id, company_ids=[], vids=[])
+         objecttype = company_ids.any? ? 'COMPANY' : 'CONTACT'
+         object_ids = (company_ids.any? ? company_ids : vids).join('&id=')
+         Hubspot::Connection.put_json(ASSOCIATE_DEAL_PATH, params: { deal_id: deal_id, OBJECTTYPE: objecttype, objectId: object_ids}, body: {})
+       end
+ 
+
       def find(deal_id)
         response = Hubspot::Connection.get_json(DEAL_PATH, { deal_id: deal_id })
         new(response)

data/lib/tasks/properties.rake

@@ -0,0 +1,49 @@
+require 'hubspot-ruby'
+
+namespace :hubspot do
+  desc 'Dump properties to file'
+  task :dump_properties, [:kind, :file, :hapikey, :include, :exclude] do |_, args|
+    hapikey = args[:hapikey] || ENV['HUBSPOT_API_KEY']
+    kind = args[:kind]
+    unless %w(contact deal).include?(kind)
+      raise ArgumentError, ':kind must be either "contact" or "deal"'
+    end
+    klass = kind == 'contact' ? Hubspot::ContactProperties : Hubspot::DealProperties
+    props = Hubspot::Utils::dump_properties(klass, hapikey, build_filter(args))
+    if args[:file].blank?
+      puts JSON.pretty_generate(props)
+    else
+      File.open(args[:file], 'w') do |f|
+        f.write(JSON.pretty_generate(props))
+      end
+    end
+  end
+
+  desc 'Restore properties from file'
+  task :restore_properties, [:kind, :file, :hapikey, :dry_run] do |_, args|
+    hapikey = args[:hapikey] || ENV['HUBSPOT_API_KEY']
+    if args[:file].blank?
+      raise ArgumentError, ':file is a required parameter'
+    end
+    kind = args[:kind]
+    unless %w(contact deal).include?(kind)
+      raise ArgumentError, ':kind must be either "contact" or "deal"'
+    end
+    klass = kind == 'contact' ? Hubspot::ContactProperties : Hubspot::DealProperties
+    file = File.read(args[:file])
+    props = JSON.parse(file)
+    Hubspot::Utils.restore_properties(klass, hapikey, props, args[:dry_run] != 'false')
+  end
+
+  private
+
+  def build_filter(args)
+    { include: val_to_array(args[:include]),
+      exclude: val_to_array(args[:exclude])
+    }
+  end
+
+  def val_to_array(val)
+    val.blank? ? val : val.split(/\W+/)
+  end
+end

data/spec/lib/hubspot/contact_spec.rb

@@ -84,6 +84,38 @@ describe Hubspot::Contact do
     end
   end
 
+  describe '.create_or_update!' do
+    cassette 'create_or_update'
+    let(:existing_contact) do
+      Hubspot::Contact.create!("morpheus@example.com", firstname: 'Morpheus')
+    end
+    before do
+      Hubspot::Contact.create_or_update!(params)
+    end
+
+    let(:params) do
+      [
+        {
+          vid: existing_contact.vid,
+          email: existing_contact.email,
+          firstname: 'Neo'
+        },
+        {
+          email: 'smith@example.com',
+          firstname: 'Smith'
+        }
+      ]
+    end
+
+    it 'creates and updates contacts' do
+      contact = Hubspot::Contact.find_by_id existing_contact.vid
+      expect(contact.properties['firstname']).to eql 'Neo'
+      latest_contact_email = Hubspot::Contact.all(recent: true).first.email
+      new_contact = Hubspot::Contact.find_by_email(latest_contact_email)
+      expect(new_contact.properties['firstname']).to eql 'Smith'
+    end
+  end
+
   describe '.find_by_email' do
     context 'given an uniq email' do
       cassette 'contact_find_by_email'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hubspot-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Andrew DiMichele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-20 00:00:00.000000000 Z
+date: 2016-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -227,6 +227,7 @@ files:
 - lib/hubspot/railtie.rb
 - lib/hubspot/topic.rb
 - lib/hubspot/utils.rb
+- lib/tasks/properties.rake
 - spec/lib/hubspot-ruby_spec.rb
 - spec/lib/hubspot/blog_spec.rb
 - spec/lib/hubspot/company_properties_spec.rb