hubspot-api-ruby 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adea84341de555a5a7b9d83e03f8aa1013484015ad17d151f4876e9f2bd02293
-  data.tar.gz: 16380d38efaea5c290d2d3b969e76b7501f81beab80a2bec1b8dee6209c5bc57
+  metadata.gz: caa1ed69670a9a924f8d1b1b44d3489ccce1e29a949495bfb6bec3e489f43525
+  data.tar.gz: 6e8320b3f698d568c717661c3fb5b145505959d662f96ea02d63726cf3dff22a
 SHA512:
-  metadata.gz: 3ca148e0b2648da567d90d312cf979b1bcf8f840ed56393623d8c4cdb2aa0a7d1fe711721fd0828d5062837765280dc4f39719742cd124313bb9e15d31371e89
-  data.tar.gz: b3f6ac7fd1468a9caf227bd37f7cbe8316328ee88008e0305d891fa7c11478e9161425ababe9eb93416684284e39f2839f468e5667d6e9ce05e96c6c807b617c
+  metadata.gz: f0e05b88efa2d452f512e6846d43eaf89408742412ff3c34161f6d21ca2b87d1431a74d5d4b20482580733e013d00f2455b17806ee02a559643115093a78e143
+  data.tar.gz: 430cbd8c797d9aaf6a264d9116acd86f4a115c2bcfef12421ac6bbc988bdbf4cff6d5124b9f2a4355211b80450b8e80687d602c1aab159049964a7c690b956c6

data/README.md

@@ -30,16 +30,17 @@ Authentication docs].
 Below is a complete list of configuration options with the default values:
 ```ruby
 Hubspot.configure({
-  hapikey: <HAPIKEY>,
+  access_token: <ACCESS_TOKEN>,
   base_url: "https://api.hubapi.com",
   portal_id: <PORTAL_ID>,
   logger: Logger.new(nil),
-  access_token: <ACCESS_TOKEN>,
   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>,
 })
 ```
 
@@ -50,15 +51,20 @@ environment.
 [HubSpot API Authentication Docs]: https://developers.hubspot.com/docs/methods/auth/oauth-overview
 [HubSpot Developer Tools]: https://developers.hubspot.com/docs/devtools
 
-## Authentication with an API key
+## Authentication with a private app access token
 
-To set the HubSpot API key, aka `hapikey`, run the following:
+To set the HubSpot access token, run the following:
 ```ruby
-Hubspot.configure(hapikey: "YOUR_API_KEY")
+Hubspot.configure(access_token: 'YOUR_ACCESS_TOKEN')
 ```
 
-If you have a HubSpot account, you can find your API key by logging in and
-visiting: https://app.hubspot.com/keys/get
+Note: some APIs require the portal ID to be set.
+
+```ruby
+Hubspot.configure(access_token: 'YOUR_ACCESS_TOKEN', portal_id: 'YOUR_PORTAL_ID')
+```
+
+[To learn how to create and manage private apps and access tokens, click here.](https://developers.hubspot.com/docs/api/private-apps)
 
 ## Authentication with OAuth 2.0
 
@@ -111,6 +117,18 @@ Hubspot::OAuth.refresh(refresh_token)
 
 At this time, OAuth tokens are configured globally rather than on a per-connection basis.
 
+## Authentication with an API key
+
+NOTE: API keys are deprecated. [Read more here](https://developers.hubspot.com/changelog/upcoming-api-key-sunset) and [find out how to migrate to private apps there](https://developers.hubspot.com/docs/api/migrate-an-api-key-integration-to-a-private-app).
+
+To set the HubSpot API key, aka `hapikey`, run the following:
+```ruby
+Hubspot.configure(hapikey: "YOUR_API_KEY")
+```
+
+If you have a HubSpot account, you can find your API key by logging in and
+visiting: https://app.hubspot.com/keys/get
+
 ## Usage
 
 Classes have been created that map to Hubspot resource types and attempt to abstract away as much of the API specific details as possible. These classes generally follow the [ActiveRecord](https://en.wikipedia.org/wiki/Active_record_pattern) pattern and general Ruby conventions. Anyone familiar with [Ruby On Rails](https://rubyonrails.org/) should find this API closely maps with familiar concepts.
@@ -147,10 +165,12 @@ By default, the VCR recording mode is set to `:none`, which allows recorded
 requests to be re-played but raises for any new request. This prevents the test
 suite from issuing unexpected HTTP requests.
 
-Some requests require to be done on a live hubspot portal, you can set the `HUBSPOT_HAPI_KEY` environement variable, for example inside a `.env.test` file :
+Some requests require to be done on a live hubspot portal, you can set the `HUBSPOT_ACCESS_TOKEN` and `HUBSPOT_PORTAL_ID` environement variables, for example inside a `.env.test` file :
 
 ```
-HUBSPOT_HAPI_KEY=xxxx
+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/Rakefile

@@ -28,5 +28,3 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
-
-Dir.glob('lib/tasks/*.rake').each { |r| load r }

data/hubspot-api-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "hubspot-api-ruby"
-  s.version = "0.9.0"
+  s.version = "0.11.0"
   s.require_paths = ["lib"]
   s.authors = ["Jonathan"]
   s.email = ["jonathan@hoggo.com"]
@@ -8,7 +8,6 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
   s.files = [".rspec", "Gemfile", "Guardfile", "LICENSE.txt", "README.md", "RELEASING.md", "Rakefile", "hubspot-api-ruby.gemspec"]
   s.files += Dir["lib/**/*.rb"]
-  s.files += Dir["lib/**/*.rake"]
   s.files += Dir["spec/**/*.rb"]
   s.homepage = "https://github.com/captaincontrat/hubspot-api-ruby"
   s.summary = "hubspot-api-ruby is a wrapper for the HubSpot REST API"

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/config.rb

@@ -31,6 +31,10 @@ module Hubspot
           raise Hubspot::ConfigurationError.new("You must provide either an access_token or an hapikey")
         end
 
+        if hapikey.present?
+          Hubspot::Deprecator.build.deprecation_warning("hapikey", "please use access_token instead. See https://developers.hubspot.com/docs/api/migrate-an-api-key-integration-to-a-private-app")
+        end
+
         if access_token.present?
           Hubspot::Connection.headers("Authorization" => "Bearer #{access_token}")
         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/engagement.rb

@@ -21,7 +21,6 @@ module Hubspot
     attr_reader :metadata
 
     def initialize(response_hash)
-
       @engagement = response_hash["engagement"]
       @associations = response_hash["associations"]
       @attachments = response_hash["attachments"]

data/lib/hubspot/file.rb

@@ -10,7 +10,7 @@ module Hubspot
   #
   class File
     GET_FILE_PATH    = "/filemanager/api/v2/files/:file_id"
-    DELETE_FILE_PATH = "/filemanager/api/v2/files/:file_id/full-delete" 
+    DELETE_FILE_PATH = "/filemanager/api/v2/files/:file_id/full-delete"
     LIST_FILE_PATH   = "/filemanager/api/v2/files"
 
     attr_reader :id
@@ -24,7 +24,7 @@ module Hubspot
     class << self
       def find_by_id(file_id)
         response = Hubspot::Connection.get_json(GET_FILE_PATH, { file_id: file_id })
-	new(response)
+        new(response)
       end
     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/railtie.rb

@@ -2,9 +2,5 @@ require 'hubspot-api-ruby'
 require 'rails'
 module Hubspot
   class Railtie < Rails::Railtie
-    rake_tasks do
-      spec = Gem::Specification.find_by_name('hubspot-api-ruby')
-      load "#{spec.gem_dir}/lib/tasks/hubspot.rake"
-    end
   end
 end

data/lib/hubspot/utils.rb

@@ -20,31 +20,6 @@ module Hubspot
         hash.map { |k, v| { key_name => k.to_s, "value" => v } }
       end
 
-      def dump_properties(klass, hapikey=ENV['HUBSPOT_API_KEY'], filter={})
-        Hubspot::Deprecator.build.deprecation_warning("Hubspot::Utils.dump_properties")
-
-        with_hapikey(hapikey) do
-          { 'groups'     => klass.groups({}, filter),
-            'properties' => klass.all({}, filter).select { |p| !p['hubspotDefined'] }
-          }
-        end
-      end
-
-      def restore_properties(klass, hapikey=ENV['HUPSPOT_API_KEY'], properties={}, dry_run=false)
-        Hubspot::Deprecator.build.deprecation_warning("Hubspot::Utils.restore_properties")
-
-        existing_properties                       = dump_properties(klass, hapikey)
-        skip, new_groups, new_props, update_props = compare_property_lists(klass, properties, existing_properties)
-        puts '', 'Dry Run - Changes will not be applied' if dry_run
-        puts '','Skipping'
-        skip.each { |h| puts "#{h[:reason]} - #{h[:prop]['groupName']}:#{h[:prop]['name']}" }
-        with_hapikey(hapikey) do
-          create_groups(klass, new_groups, dry_run)
-          create_properties(klass, new_props, dry_run)
-          update_properties(klass, update_props, dry_run)
-        end
-      end
-
       def create_groups(klass, groups, dry_run=false)
         puts '','Creating new groups'
         groups.each do |g|
@@ -112,11 +87,6 @@ module Hubspot
         [skip, new_groups.to_a, new_props, update_props]
       end
 
-      def with_hapikey(hapikey)
-        Hubspot.configure(hapikey: hapikey)
-        yield if block_given?
-      end
-
       private
 
       def find_by_name(name, set)

data/spec/lib/hubspot/blog_spec.rb

@@ -1,14 +1,9 @@
 require 'timecop'
 
 describe Hubspot do
-  before do
-    Hubspot.configure(hapikey: "demo")
-    Timecop.freeze(Time.utc(2012, 'Oct', 10))
-  end
+  before { Timecop.freeze(Time.utc(2012, 'Oct', 10)) }
 
-  after do
-    Timecop.return
-  end
+  after { Timecop.return }
 
   let(:last_blog_id) { Hubspot::Blog.list.last['id'] }
   let(:last_blog_post_id) { Hubspot::Blog.list.last.posts.first['id'] }

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/config_spec.rb

@@ -1,26 +1,23 @@
 describe Hubspot::Config do
   describe ".configure" do
-    it "sets the hapikey config" do
-      hapikey = "demo"
+    it "sets the access token config" do
+      access_token = "foobar"
 
-      config = Hubspot::Config.configure(hapikey: hapikey)
+      config = Hubspot::Config.configure(access_token: access_token)
 
-      expect(config.hapikey).to eq(hapikey)
+      expect(config.access_token).to eq(access_token)
     end
 
     it "changes the base_url" do
       base_url = "https://api.hubapi.com/v2"
 
-      config = Hubspot::Config.configure(
-        hapikey: "123abc",
-        base_url: base_url
-      )
+      config = Hubspot::Config.configure(base_url: base_url, access_token: 'foobar')
 
       expect(config.base_url).to eq(base_url)
     end
 
     it "sets a default value for base_url" do
-      config = Hubspot::Config.configure(hapikey: "123abc")
+      config = Hubspot::Config.configure(access_token: 'foobar')
 
       expect(config.base_url).to eq("https://api.hubapi.com")
     end
@@ -29,7 +26,7 @@ describe Hubspot::Config do
       portal_id = "62515"
 
       config = Hubspot::Config.configure(
-        hapikey: "123abc",
+        access_token: 'foobar',
         portal_id: portal_id
       )
 
@@ -50,15 +47,28 @@ describe Hubspot::Config do
         })
       }.to raise_error(Hubspot::ConfigurationError)
     end
+
+    context 'hapikey deprecation' do
+      it "sets the hapikey config and sends a deprecation warning" do
+        previous, $stderr = $stderr, StringIO.new
+
+        hapikey = 'demo'
+        config = Hubspot::Config.configure(hapikey: hapikey)
+        expect(config.hapikey).to eq(hapikey)
+        expect($stderr.string).to include 'please use access_token instead.'
+      ensure
+        $stderr = previous
+      end
+    end
   end
 
   describe ".reset!" do
     it "resets the config values" do
-      Hubspot::Config.configure(hapikey: "123abc", portal_id: "456def")
+      Hubspot::Config.configure(access_token: "123abc", portal_id: "456def")
 
       Hubspot::Config.reset!
 
-      expect(Hubspot::Config.hapikey).to be nil
+      expect(Hubspot::Config.access_token).to be nil
       expect(Hubspot::Config.portal_id).to be nil
     end
   end
@@ -66,7 +76,7 @@ describe Hubspot::Config do
   describe ".ensure!" do
     context "when a specified parameter is missing" do
       it "raises an error" do
-        Hubspot::Config.configure(hapikey: "123abc")
+        Hubspot::Config.configure(access_token: "123abc")
 
         expect {
           Hubspot::Config.ensure!(:portal_id)
@@ -76,7 +86,7 @@ describe Hubspot::Config do
 
     context "when all specified parameters are present" do
       it "does not raise an error" do
-        Hubspot::Config.configure(hapikey: "123abc", portal_id: "456def")
+        Hubspot::Config.configure(access_token: "123abc", portal_id: "456def")
 
         expect {
           Hubspot::Config.ensure!(:portal_id)