hubspot-api-ruby 0.10.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4aa748bc77ade29ff96016950aa3f3d8d9bbb309167b200319798d9edf8664bc
-  data.tar.gz: f09d8a29a3dbbcaa18071670e46d4c10c6727731409bbf4a7eee5099d6fd15e2
+  metadata.gz: b3bfd2a58aeeda26ef22bb1cc16d7794397357e0b4584255c419e8f9e269cb94
+  data.tar.gz: 0f56e584031be6a59378c64d2922a09567c5632dbe3a67970fecf60f6c53a367
 SHA512:
-  metadata.gz: ac1c6faae15a4569c92d8061a270f7b55aad7c64eaf2f16bc057b31312204164771600a5ebb511a0d7e0977123baf65b22125f69832dc6b2af63637bb4689814
-  data.tar.gz: 37b874280272f531177bf348d038b5b6e935f2a4edefeef1c1c7d4e5e68c2613047a75ea782daa412053fb8f50c312d6a27d5f264509f758cd6eb82abf1afe8d
+  metadata.gz: 9cd0a53353924b64a5e1f6a2aca63991e9e5aff111c4e91570090ef0061058aed825d9fb9bdf29d2d9239375872d44d229b540c63a8c71e6f1893b74e3e01fba
+  data.tar.gz: 36b861191b970ee112f72e21624b0827d33f1ff1912924f153267c7cafd5867cf949dd3b3c44c92d077d555c419830db1e30664be6f5faabb7b0c0aaca15c973

data/README.md

@@ -37,8 +37,9 @@ Hubspot.configure({
   client_id: <CLIENT_ID>,
   client_secret: <CLIENT_SECRET>,
   redirect_uri: <REDIRECT_URI>,
-  read_timeout: nil, # or :timeout to set read_timeout and open_timeout
+  read_timeout: nil,
   open_timeout: nil,
+  # read_timeout and open_timeout are expressed in seconds and passed to HTTParty
   hapikey: <HAPIKEY>,
 })
 ```
@@ -169,6 +170,7 @@ Some requests require to be done on a live hubspot portal, you can set the `HUBS
 ```
 HUBSPOT_ACCESS_TOKEN=xxxx
 HUBSPOT_PORTAL_ID=yyyy
+HUBSPOT_HAPI_KEY=zzzz
 ```
 
 To add a new test or update a VCR recording, run the test with the `VCR_RECORD_MODE`

data/RELEASING.md

@@ -1,6 +1,7 @@
 # Releasing to Rubygems
 
-1. Update gemspec.
-2. Push updates to github.
-3. Build gem with `gem build hubspot-api-ruby.gemspec`.
-4. Push the resulting .gem file to Rubygems with `gem push`
+1. Update History.md
+2. Update gemspec.
+3. Push updates to github.
+4. Build gem with `gem build hubspot-api-ruby.gemspec`.
+5. Push the resulting .gem file to Rubygems with `gem push`

data/hubspot-api-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "hubspot-api-ruby"
-  s.version = "0.10.0"
+  s.version = "0.12.0"
   s.require_paths = ["lib"]
   s.authors = ["Jonathan"]
   s.email = ["jonathan@hoggo.com"]

data/lib/hubspot/company_properties.rb

@@ -3,6 +3,8 @@ module Hubspot
 
     ALL_PROPERTIES_PATH  = "/properties/v1/companies/properties"
     ALL_GROUPS_PATH      = "/properties/v1/companies/groups"
+    PROPERTY_PATH        = "/properties/v1/companies/properties/named/:property_name"
+    GROUP_PATH           = "/properties/v1/companies/groups/named/:group_name"
     CREATE_PROPERTY_PATH = "/properties/v1/companies/properties"
     UPDATE_PROPERTY_PATH = "/properties/v1/companies/properties/named/:property_name"
     DELETE_PROPERTY_PATH = "/properties/v1/companies/properties/named/:property_name"
@@ -19,10 +21,18 @@ module Hubspot
         superclass.all(ALL_PROPERTIES_PATH, opts, filter)
       end
 
+      def find(property_name, opts={})
+        superclass.find(PROPERTY_PATH, property_name, opts)
+      end
+
       def groups(opts={}, filter={})
         superclass.groups(ALL_GROUPS_PATH, opts, filter)
       end
 
+      def find_group(group_name, opts={})
+        superclass.find_group(GROUP_PATH, group_name, opts={})
+      end
+
       def create!(params={})
         superclass.create!(CREATE_PROPERTY_PATH, params)
       end

data/lib/hubspot/contact_properties.rb

@@ -3,6 +3,8 @@ module Hubspot
 
     ALL_PROPERTIES_PATH  = "/properties/v1/contacts/properties"
     ALL_GROUPS_PATH      = "/properties/v1/contacts/groups"
+    PROPERTY_PATH        = "/properties/v1/contacts/properties/named/:property_name"
+    GROUP_PATH           = "/properties/v1/contacts/groups/named/:group_name"
     CREATE_PROPERTY_PATH = "/properties/v1/contacts/properties"
     UPDATE_PROPERTY_PATH = "/properties/v1/contacts/properties/named/:property_name"
     DELETE_PROPERTY_PATH = "/properties/v1/contacts/properties/named/:property_name"
@@ -19,10 +21,18 @@ module Hubspot
         superclass.all(ALL_PROPERTIES_PATH, opts, filter)
       end
 
+      def find(property_name, opts={})
+        superclass.find(PROPERTY_PATH, property_name, opts)
+      end
+
       def groups(opts={}, filter={})
         superclass.groups(ALL_GROUPS_PATH, opts, filter)
       end
 
+      def find_group(group_name, opts={})
+        superclass.find_group(GROUP_PATH, group_name, opts)
+      end
+
       def create!(params={})
         superclass.create!(CREATE_PROPERTY_PATH, params)
       end

data/lib/hubspot/deal_properties.rb

@@ -3,6 +3,8 @@ module Hubspot
 
     ALL_PROPERTIES_PATH  = '/deals/v1/properties'
     ALL_GROUPS_PATH      = '/deals/v1/groups'
+    PROPERTY_PATH        = '/properties/v1/deals/properties/named/:property_name'
+    GROUP_PATH           = '/properties/v1/deals/groups/named/:group_name'
     CREATE_PROPERTY_PATH = '/deals/v1/properties/'
     UPDATE_PROPERTY_PATH = '/deals/v1/properties/named/:property_name'
     DELETE_PROPERTY_PATH = '/deals/v1/properties/named/:property_name'
@@ -19,10 +21,18 @@ module Hubspot
         superclass.all(ALL_PROPERTIES_PATH, opts, filter)
       end
 
+      def find(property_name, opts={})
+        superclass.find(PROPERTY_PATH, property_name, opts)
+      end
+
       def groups(opts={}, filter={})
         superclass.groups(ALL_GROUPS_PATH, opts, filter)
       end
 
+      def find_group(group_name, opts={})
+        superclass.find_group(GROUP_PATH, group_name, opts)
+      end
+
       def create!(params={})
         superclass.create!(CREATE_PROPERTY_PATH, params)
       end

data/lib/hubspot/properties.rb

@@ -26,11 +26,19 @@ module Hubspot
         filter_results(response, :groupName, filter[:include], filter[:exclude])
       end
 
+      def find(path, property_name, opts={})
+        response = Hubspot::Connection.get_json(path, opts.merge({ property_name: property_name }))
+      end
+
       def groups(path, opts={}, filter={})
         response = Hubspot::Connection.get_json(path, opts)
         filter_results(response, :name, filter[:include], filter[:exclude])
       end
 
+      def find_group(path, group_name, opts={})
+        response = Hubspot::Connection.get_json(path, opts.merge({ group_name: group_name }))
+      end
+
       def create!(path, params={})
         post_data = valid_property_params(params)
         return nil if post_data.blank?

data/lib/hubspot/resource.rb

@@ -1,6 +1,5 @@
 module Hubspot
   class Resource
-
     class_attribute :id_field, instance_writer: false
     class_attribute :property_name_field, instance_writer: false
     class_attribute :update_method, instance_writer: false
@@ -73,25 +72,15 @@ module Hubspot
       @deleted = false
     end
 
-    def id
-      @id
-    end
-
-    def id=(id)
-      @id = id
-    end
+    attr_accessor :id
 
     def to_i
       @id
     end
 
-    def metadata
-      @metadata
-    end
-
-    def changes
-      @changes
-    end
+    attr_reader :changes
+    attr_reader :metadata
+    attr_reader :properties
 
     def changed?
       !@changes.empty?

data/spec/lib/hubspot/company_properties_spec.rb

@@ -111,6 +111,26 @@ RSpec.describe Hubspot::CompanyProperties do
       end
     end
 
+    describe '.find' do
+      context 'existing property' do
+        cassette 'company_properties/existing_property'
+
+        it 'should return a company property by name if it exists' do
+          response = Hubspot::CompanyProperties.find('domain')
+          expect(response['name']).to eq 'domain'
+          expect(response['label']).to eq 'Company Domain Name'
+        end
+      end
+
+      context 'non-existent property' do
+        cassette 'company_properties/non_existent_property'
+
+        it 'should return an error for a missing property' do
+          expect{ Hubspot::CompanyProperties.find('this_does_not_exist') }.to raise_error(Hubspot::NotFoundError)
+        end
+      end
+    end
+
     describe ".create!" do
       it "creates a company property" do
         VCR.use_cassette("company_properties/create_property") do
@@ -332,6 +352,26 @@ RSpec.describe Hubspot::CompanyProperties do
       end
     end
 
+    describe '.find_group' do
+      context 'existing group' do
+        cassette 'company_properties/existing_group'
+
+        it 'should return a company property group by name if it exists' do
+          response = Hubspot::CompanyProperties.find_group('companyinformation')
+          expect(response['name']).to eq 'companyinformation'
+          expect(response['displayName']).to eq 'Company information'
+        end
+      end
+
+      context 'non-existent group' do
+        cassette 'company_properties/non_existent_group'
+
+        it 'should return an error for a missing group' do
+          expect{ Hubspot::CompanyProperties.find_group('this_does_not_exist') }.to raise_error(Hubspot::NotFoundError)
+        end
+      end
+    end
+
     let(:params) { { 'name' => 'ff_group1', 'displayName' => 'Test Group One', 'displayOrder' => 100, 'badParam' => 99 } }
 
     describe '.create_group!' do

data/spec/lib/hubspot/contact_properties_spec.rb

@@ -38,6 +38,26 @@ describe Hubspot::ContactProperties do
       end
     end
 
+    describe '.find' do
+      context 'existing property' do
+        cassette 'contact_properties/existing_property'
+
+        it 'should return a contact property by name if it exists' do
+          response = Hubspot::ContactProperties.find('full_name')
+          expect(response['name']).to eq 'full_name'
+          expect(response['label']).to eq 'Full name'
+        end
+      end
+
+      context 'non-existent property' do
+        cassette 'contact_properties/non_existent_property'
+
+        it 'should return an error for a missing property' do
+          expect{ Hubspot::ContactProperties.find('this_does_not_exist') }.to raise_error(Hubspot::NotFoundError)
+        end
+      end
+    end
+
     let(:params) { {
       'name'                          => 'my_new_property',
       'label'                         => 'This is my new property',
@@ -141,6 +161,26 @@ describe Hubspot::ContactProperties do
       end
     end
 
+    describe '.find_group' do
+      context 'existing group' do
+        cassette 'contact_properties/existing_group'
+
+        it 'should return a contact property by name if it exists' do
+          response = Hubspot::ContactProperties.find_group('contactinformation')
+          expect(response['name']).to eq 'contactinformation'
+          expect(response['displayName']).to eq 'Contact information'
+        end
+      end
+
+      context 'non-existent group' do
+        cassette 'contact_properties/non_existent_group'
+
+        it 'should return an error for a missing group' do
+          expect{ Hubspot::ContactProperties.find_group('this_does_not_exist') }.to raise_error(Hubspot::NotFoundError)
+        end
+      end
+    end
+
     let(:params) { { 'name' => 'ff_group1', 'displayName' => 'Test Group One', 'displayOrder' => 100, 'badParam' => 99 } }
 
     describe '.create_group!' do

data/spec/lib/hubspot/deal_properties_spec.rb

@@ -37,6 +37,26 @@ describe Hubspot::DealProperties do
         end
       end
     end
+    
+    describe '.find' do
+      context 'existing property' do
+        cassette 'deal_properties/existing_property'
+
+        it 'should return a deal property by name if it exists' do
+          response = Hubspot::DealProperties.find('hs_acv')
+          expect(response['name']).to eq 'hs_acv'
+          expect(response['label']).to eq 'Annual contract value'
+        end
+      end
+
+      context 'non-existent property' do
+        cassette 'deal_properties/non_existent_property'
+
+        it 'should return an error for a missing property' do
+          expect{ Hubspot::DealProperties.find('this_does_not_exist') }.to raise_error(Hubspot::NotFoundError)
+        end
+      end
+    end
 
     let(:params) { {
       'name'                          => "my_new_property_#{SecureRandom.hex}",
@@ -140,6 +160,26 @@ describe Hubspot::DealProperties do
       end
     end
 
+    describe '.find_group' do
+      context 'existing group' do
+        cassette 'deal_properties/existing_group'
+
+        it 'should return a deal property by name if it exists' do
+          response = Hubspot::DealProperties.find_group('deal_revenue')
+          expect(response['name']).to eq 'deal_revenue'
+          expect(response['displayName']).to eq 'Deal revenue'
+        end
+      end
+
+      context 'non-existent group' do
+        cassette 'deal_properties/non_existent_group'
+
+        it 'should return an error for a missing group' do
+          expect{ Hubspot::DealProperties.find_group('this_does_not_exist') }.to raise_error(Hubspot::NotFoundError)
+        end
+      end
+    end
+
     let(:params) { { 'name' => 'ff_group1', 'displayName' => 'Test Group One', 'displayOrder' => 100, 'badParam' => 99 } }
 
     describe '.create_group!' do

data/spec/lib/hubspot/resource_spec.rb

@@ -91,4 +91,24 @@ RSpec.describe Hubspot::Resource do
       end
     end
   end
+
+  describe '#properties' do
+    context 'using new' do
+      subject(:resource) { described_class.new(properties) }
+      let(:properties) { { id: 1, firstname: 'John', lastname: 'Wayne' } }
+
+      it 'has no properties' do
+        expect(subject.properties).to be_empty
+      end
+    end
+
+    context 'using from_result' do
+      subject(:resource) { described_class.from_result({ properties: properties }) }
+      let(:properties) { { id: { 'value' => 1 }, firstname: { 'value' => 'John' }, lastname: { 'value' => 'Wayne' } } }
+
+      it 'has properties' do
+        expect(subject.properties).to eq HashWithIndifferentAccess.new(properties)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hubspot-api-ruby
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Jonathan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-09 00:00:00.000000000 Z
+date: 2022-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -346,7 +346,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: hubspot-api-ruby is a wrapper for the HubSpot REST API