hubspot-ruby 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ab6604b85e4945f699f88491ad18191a9ceda03
-  data.tar.gz: 8b01545c2f8c6d5e51d610233abcd55b2d9027d0
+  metadata.gz: f3a1711f64e0786c4ea7fea3ae863130e3f8a3d5
+  data.tar.gz: 7c350471fe6a943453353c4a54021a104abb6b1b
 SHA512:
-  metadata.gz: a5b5d2e3c28f811c44b14e232e308cc2af19cf4050f6963dfa00ce7c0b59022c73fde892adf9e7fe0a5a73cb6d067b512cefdae13510b06164dd0630e4430b63
-  data.tar.gz: 3381873ef4e85c46cbf4a17608c66c29414fa40fdf911fb7463a58be117f7a307b06905d3db269f5a56f8d98b68f70f4ed632a6816a7c8d6ffb6801af7770281
+  metadata.gz: dbf007dcda9eed037c323f4f9209b9cfed55926458b923fc9a7bbf95c88cf5ef0bd7e01857affd32c8d8d4649613ebfa1a614d84897ec8e9ba7ca4398550c615
+  data.tar.gz: 96a5651da299bdd400c02da77be240d76aecdf7acc72bc1c6e93b9dd6b24fbb3653dcbbb8da09413b83a90c6bc4c0557ef4a5dfa0c06c3fcb0e6b536a895c9b6

data/hubspot-ruby.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name = "hubspot-ruby"
-  s.version = "0.3.0"
+  s.version = "0.4.0"
   s.require_paths = ["lib"]
-  s.authors = ["Andrew DiMichele"]
+  s.authors = ["Andrew DiMichele", "Chris Bisnett"]
   s.description = "hubspot-ruby is a wrapper for the HubSpot REST API"
   s.files = [".rspec", "Gemfile", "Guardfile", "LICENSE.txt", "README.md", "RELEASING.md", "Rakefile", "hubspot-ruby.gemspec"]
   s.files += Dir["lib/**/*.rb"]
@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "httparty", ">=0.10.0"
 
   # Add development-only dependencies here
-  s.add_development_dependency("rake")
+  s.add_development_dependency("rake", "~> 11.0")
   s.add_development_dependency("rspec", "~> 2.0")
   s.add_development_dependency("rr")
   s.add_development_dependency("webmock", "< 1.10")

data/lib/hubspot/company.rb

@@ -9,7 +9,7 @@ module Hubspot
     RECENTLY_CREATED_COMPANIES_PATH   = "/companies/v2/companies/recent/created"
     RECENTLY_MODIFIED_COMPANIES_PATH  = "/companies/v2/companies/recent/modified"
     GET_COMPANY_BY_ID_PATH            = "/companies/v2/companies/:company_id"
-    GET_COMPANY_BY_DOMAIN_PATH        = "/companies/v2/companies/domain/:domain"
+    GET_COMPANY_BY_DOMAIN_PATH        = "/companies/v2/domains/:domain/companies"
     UPDATE_COMPANY_PATH               = "/companies/v2/companies/:company_id"
     ADD_CONTACT_TO_COMPANY_PATH       = "/companies/v2/companies/:company_id/contacts/:vid"
     DESTROY_COMPANY_PATH              = "/companies/v2/companies/:company_id"
@@ -39,18 +39,35 @@ module Hubspot
       end
 
       # Finds a list of companies by domain
-      # {http://developers.hubspot.com/docs/methods/companies/get_companies_by_domain}
+      # {https://developers.hubspot.com/docs/methods/companies/search_companies_by_domain}
       # @param domain [String] company domain to search by
+      # @param options [Hash] Possible options are:
+      #    limit [Integer] for pagination
+      #    properties [Array] list of company properties to recieve
+      #    offset_company_id [Integer] for pagination (should be company ID)
       # @return [Array] Array of Hubspot::Company records
-      def find_by_domain(domain)
-        path = GET_COMPANY_BY_DOMAIN_PATH
-        params = { domain: domain }
-        raise Hubspot::InvalidParams, 'expecting Integer parameter' unless domain.try(:is_a?, String)
+      def find_by_domain(domain, options = {})
+        raise Hubspot::InvalidParams, 'expecting String parameter' unless domain.try(:is_a?, String)
+
+        limit = options.fetch(:limit, 100)
+        properties = options.fetch(:properties) { Hubspot::CompanyProperties.all.map { |property| property["name"] } }
+        offset_company_id = options.fetch(:offset_company_id, nil)
+
+        post_data = {
+          "limit" => limit,
+          "requestOptions" => {
+            "properties" => properties
+          }
+        }
+        post_data["offset"] = {
+          "isPrimary" => true,
+          "companyId" => offset_company_id
+        } if offset_company_id
 
         companies = []
         begin
-          response = Hubspot::Connection.get_json(path, params)
-          companies = response.try(:map) { |company| new(company) }
+          response = Hubspot::Connection.post_json(GET_COMPANY_BY_DOMAIN_PATH, params: { domain: domain }, body: post_data )
+          companies = response["results"].try(:map) { |company| new(company) }
         rescue => e
           raise e unless e.message =~ /not found/ # 404 / hanle the error and kindly return an empty array
         end

data/lib/hubspot/contact.rb

@@ -18,6 +18,7 @@ module Hubspot
     DESTROY_CONTACT_PATH         = '/contacts/v1/contact/vid/:contact_id'
     CONTACTS_PATH                = '/contacts/v1/lists/all/contacts/all'
     RECENTLY_UPDATED_PATH        = '/contacts/v1/lists/recently_updated/contacts/recent'
+    RECENTLY_CREATED_PATH        = '/contacts/v1/lists/all/contacts/recent'
     CREATE_OR_UPDATE_PATH        = '/contacts/v1/contact/createOrUpdate/email/:contact_email'
     QUERY_PATH                   = '/contacts/v1/search/query'
 
@@ -33,11 +34,15 @@ module Hubspot
 
       # {https://developers.hubspot.com/docs/methods/contacts/get_contacts}
       # {https://developers.hubspot.com/docs/methods/contacts/get_recently_updated_contacts}
+      # {https://developers.hubspot.com/docs/methods/contacts/get_recently_created_contacts}
       def all(opts={})
         recent = opts.delete(:recent) { false }
+        recent_created = opts.delete(:recent_created) { false }
         paged = opts.delete(:paged) { false }
         path, opts =
-        if recent
+        if recent_created
+          [RECENTLY_CREATED_PATH, Hubspot::ContactProperties.add_default_parameters(opts)]
+        elsif recent
           [RECENTLY_UPDATED_PATH, Hubspot::ContactProperties.add_default_parameters(opts)]
         else
           [CONTACTS_PATH, opts]

data/lib/hubspot/properties.rb

@@ -5,7 +5,7 @@ module Hubspot
       group_field_names: %w(name displayName displayOrder properties),
       field_names:       %w(name groupName description fieldType formField type displayOrder label options showCurrencySymbol),
       valid_field_types: %w(textarea select text date file number radio checkbox booleancheckbox),
-      valid_types:       %w(string number bool datetime enumeration),
+      valid_types:       %w(string number bool date datetime enumeration),
       options:           %w(description value label hidden displayOrder)
     }
     DEFAULT_PROPERTY = 'email'

data/spec/lib/hubspot/company_spec.rb

@@ -62,17 +62,41 @@ describe Hubspot::Contact do
   describe ".find_by_domain" do
     context 'given a domain' do
       cassette "company_find_by_domain"
-      subject{ Hubspot::Company.find_by_domain("hubspot.com") }
+      subject(:companies) { Hubspot::Company.find_by_domain("example.com") }
 
       context "when a company is found" do
-        it{ should be_an_instance_of Array }
-        it{ should_not be_empty }
+        it { should be_an_instance_of Array }
+        it { should_not be_empty }
+
+        it 'must contain all available properties' do
+          companies[0..9].each do |company|
+            expect(company.properties).to eql Hubspot::Company.find_by_id(company.vid).properties
+          end
+        end
       end
 
       context "when a company cannot be found" do
-        subject{Hubspot::Company.find_by_domain("asdf1234baddomain.com")}
+        subject { Hubspot::Company.find_by_domain("asdf1234baddomain.com") }
+        it { should be_an_instance_of Array }
+        it { should be_empty }
+      end
+    end
+
+    context 'given a domain and parameters' do
+      cassette 'company_find_by_domain_with_params'
+      subject(:companies) { Hubspot::Company.find_by_domain("example.com", limit: 2, properties: ["name", "createdate"], offset_company_id: 117004411) }
+
+      context "when a company is found" do
         it{ should be_an_instance_of Array }
-        it{ should be_empty }
+        it{ should_not be_empty }
+
+        it 'must use the parameters to search' do
+          expect(companies.size).to eql 2
+          expect(companies.first['name']).to be_a_kind_of String
+          expect(companies.first['createdate']).to be_a_kind_of String
+          expect(companies.first['domain']).to be_nil
+          expect(companies.first['hs_lastmodifieddate']).to be_nil
+        end
       end
     end
   end

data/spec/lib/hubspot/contact_spec.rb

@@ -318,6 +318,22 @@ describe Hubspot::Contact do
         expect(last.vid).to eql 263776
       end
     end
+
+    context 'recent created contacts' do
+      cassette 'find_all_recent_created_contacts'
+
+      it 'must get the contacts list' do
+        contacts = Hubspot::Contact.all(recent_created: true)
+        expect(contacts.size).to eql 20
+
+        first, last = contacts.first, contacts.last
+        expect(first).to be_a Hubspot::Contact
+        expect(first.vid).to eql 5478174
+
+        expect(last).to be_a Hubspot::Contact
+        expect(last.vid).to eql 5476674
+      end
+    end
   end
 
   describe '#update!' do

data/spec/lib/hubspot/deal_spec.rb

@@ -1,7 +1,12 @@
 describe Hubspot::Deal do
+  let(:portal_id) { 62515 }
+  let(:company_id) { 8954037 }
+  let(:vid) { 27136 }
+  let(:amount) { '30' }
+
   let(:example_deal_hash) do
     VCR.use_cassette("deal_example") do
-      HTTParty.get("https://api.hubapi.com/deals/v1/deal/3?hapikey=demo&portalId=62515").parsed_response
+      HTTParty.get("https://api.hubapi.com/deals/v1/deal/3?hapikey=demo&portalId=#{portal_id}").parsed_response
     end
   end
 
@@ -10,27 +15,39 @@ describe Hubspot::Deal do
   describe "#initialize" do
     subject{ Hubspot::Deal.new(example_deal_hash) }
     it  { should be_an_instance_of Hubspot::Deal }
-    its (:portal_id) { should == 62515 }
+    its (:portal_id) { should == portal_id }
     its (:deal_id) { should == 3 }
   end
 
   describe ".create!" do
     cassette "deal_create"
-    subject { Hubspot::Deal.create!(62515, [8954037], [27136], {}) }
+    subject { Hubspot::Deal.create!(portal_id, [company_id], [vid], {}) }
     its(:deal_id)     { should_not be_nil }
-    its(:portal_id)   { should eql 62515 }
-    its(:company_ids) { should eql [8954037]}
-    its(:vids)        { should eql [27136]}
+    its(:portal_id)   { should eql portal_id }
+    its(:company_ids) { should eql [company_id]}
+    its(:vids)        { should eql [vid]}
   end
 
   describe ".find" do
     cassette "deal_find"
-    let(:deal) {Hubspot::Deal.create!(62515, [8954037], [27136], { amount: 30})}
+    let(:deal) {Hubspot::Deal.create!(portal_id, [company_id], [vid], { amount: amount})}
 
     it 'must find by the deal id' do
       find_deal = Hubspot::Deal.find(deal.deal_id)
       find_deal.deal_id.should eql deal.deal_id
-      find_deal.properties["amount"].should eql "30"
+      find_deal.properties["amount"].should eql amount
+    end
+  end
+
+  describe '.find_by_company' do
+    cassette 'deal_find_by_company'
+    let(:company) { Hubspot::Company.create!('Test Company') }
+    let(:deal) { Hubspot::Deal.create!(portal_id, [company.vid], [vid], { amount: amount }) }
+
+    it 'returns company deals' do
+      deals = Hubspot::Deal.find_by_company(company)
+      deals.first.deal_id.should eql deal.deal_id
+      deals.first.properties['amount'].should eql amount
     end
   end
 
@@ -68,7 +85,7 @@ describe Hubspot::Deal do
   describe '#destroy!' do
     cassette 'destroy_deal'
 
-    let(:deal) {Hubspot::Deal.create!(62515, [8954037], [27136], {amount: 30})}
+    let(:deal) {Hubspot::Deal.create!(portal_id, [company_id], [vid], {amount: amount})}
 
     it 'should remove from hubspot' do
       pending

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: hubspot-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrew DiMichele
+- Chris Bisnett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2017-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -42,16 +43,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement