hubspot-api-ruby 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adea84341de555a5a7b9d83e03f8aa1013484015ad17d151f4876e9f2bd02293
-  data.tar.gz: 16380d38efaea5c290d2d3b969e76b7501f81beab80a2bec1b8dee6209c5bc57
+  metadata.gz: 4aa748bc77ade29ff96016950aa3f3d8d9bbb309167b200319798d9edf8664bc
+  data.tar.gz: f09d8a29a3dbbcaa18071670e46d4c10c6727731409bbf4a7eee5099d6fd15e2
 SHA512:
-  metadata.gz: 3ca148e0b2648da567d90d312cf979b1bcf8f840ed56393623d8c4cdb2aa0a7d1fe711721fd0828d5062837765280dc4f39719742cd124313bb9e15d31371e89
-  data.tar.gz: b3f6ac7fd1468a9caf227bd37f7cbe8316328ee88008e0305d891fa7c11478e9161425ababe9eb93416684284e39f2839f468e5667d6e9ce05e96c6c807b617c
+  metadata.gz: ac1c6faae15a4569c92d8061a270f7b55aad7c64eaf2f16bc057b31312204164771600a5ebb511a0d7e0977123baf65b22125f69832dc6b2af63637bb4689814
+  data.tar.gz: 37b874280272f531177bf348d038b5b6e935f2a4edefeef1c1c7d4e5e68c2613047a75ea782daa412053fb8f50c312d6a27d5f264509f758cd6eb82abf1afe8d

data/README.md

@@ -30,16 +30,16 @@ 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
   open_timeout: nil,
+  hapikey: <HAPIKEY>,
 })
 ```
 
@@ -50,15 +50,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 +116,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 +164,11 @@ 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
 ```
 
 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.10.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/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/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/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/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)

data/spec/lib/hubspot/connection_spec.rb

@@ -1,18 +1,12 @@
 describe Hubspot::Connection do
-  before do
-    Hubspot.configure hapikey: 'fake'
-  end
-
   describe ".get_json" do
     it "returns the parsed response from the GET request" do
       path = "/some/path"
       body = { key: "value" }
 
-      stub_request(:get, "https://api.hubapi.com/some/path?hapikey=fake").
-        to_return(status: 200, body: JSON.generate(body))
+      stub_request(:get, "https://api.hubapi.com/some/path").to_return(status: 200, body: JSON.generate(body))
 
       result = Hubspot::Connection.get_json(path, {})
-
       expect(result).to eq({ "key" => "value" })
     end
   end
@@ -22,11 +16,9 @@ describe Hubspot::Connection do
       path = "/some/path"
       body = { id: 1, name: "ABC" }
 
-      stub_request(:post, "https://api.hubapi.com/some/path?hapikey=fake&name=ABC").
-        to_return(status: 200, body: JSON.generate(body))
+      stub_request(:post, "https://api.hubapi.com/some/path?name=ABC").to_return(status: 200, body: JSON.generate(body))
 
       result = Hubspot::Connection.post_json(path, params: { name: "ABC" })
-
       expect(result).to eq({ "id" => 1, "name" => "ABC" })
     end
   end
@@ -35,11 +27,9 @@ describe Hubspot::Connection do
     it "returns the response from the DELETE request" do
       path = "/some/path"
 
-      stub_request(:delete, "https://api.hubapi.com/some/path?hapikey=fake").
-        to_return(status: 204, body: JSON.generate({}))
+      stub_request(:delete, "https://api.hubapi.com/some/path").to_return(status: 204, body: JSON.generate({}))
 
       result = Hubspot::Connection.delete_json(path, {})
-
       expect(result.code).to eq(204)
     end
   end
@@ -49,20 +39,18 @@ describe Hubspot::Connection do
       path = "/some/path"
       update_options = { params: {}, body: {} }
 
-      stub_request(:put, "https://api.hubapi.com/some/path?hapikey=fake").
-        to_return(status: 200, body: JSON.generate(vid: 123))
+      stub_request(:put, "https://api.hubapi.com/some/path").to_return(status: 200, body: JSON.generate(vid: 123))
 
       response = Hubspot::Connection.put_json(path, update_options)
 
       assert_requested(
         :put,
-        "https://api.hubapi.com/some/path?hapikey=fake",
+        "https://api.hubapi.com/some/path",
          {
            body: "{}",
            headers: { "Content-Type" => "application/json" },
          }
       )
-
       expect(response).to eq({ "vid" => 123 })
     end
 
@@ -72,13 +60,13 @@ describe Hubspot::Connection do
 
       logger = stub_logger
 
-      stub_request(:put, "https://api.hubapi.com/some/path?hapikey=fake").
-        to_return(status: 200, body: JSON.generate("response body"))
+      stub_request(:put, "https://api.hubapi.com/some/path").to_return(status: 200,
+                                                                       body: JSON.generate("response body"))
 
       Hubspot::Connection.put_json(path, update_options)
 
       expect(logger).to have_received(:info).with(<<~MSG)
-        Hubspot: https://api.hubapi.com/some/path?hapikey=fake.
+        Hubspot: https://api.hubapi.com/some/path.
         Body: {}.
         Response: 200 "response body"
       MSG
@@ -88,8 +76,7 @@ describe Hubspot::Connection do
       path = "/some/path"
       update_options = { params: {}, body: {} }
 
-      stub_request(:put, "https://api.hubapi.com/some/path?hapikey=fake").
-        to_return(status: 401)
+      stub_request(:put, "https://api.hubapi.com/some/path").to_return(status: 401)
 
       expect {
         Hubspot::Connection.put_json(path, update_options)
@@ -99,80 +86,85 @@ describe Hubspot::Connection do
 
   context 'private methods' do
     describe ".generate_url" do
-      let(:path){ "/test/:email/profile" }
-      let(:params){{email: "test"}}
-      let(:options){{}}
-      subject{ Hubspot::Connection.send(:generate_url, path, params, options) }
-      before{ Hubspot.configure(hapikey: "demo", portal_id: "62515") }
+      let(:path) { "/test/:email/profile" }
+      let(:params) { { email: "test" } }
+      let(:options) { {} }
+      subject { Hubspot::Connection.send(:generate_url, path, params, options) }
 
       it "doesn't modify params" do
-        expect{ subject }.to_not change{params}
+        expect { subject }.to_not change{params}
       end
 
       context "with a portal_id param" do
-        let(:path){ "/test/:portal_id/profile" }
-        let(:params){{}}
-        it{ should == "https://api.hubapi.com/test/62515/profile?hapikey=demo" }
+        let(:path) { "/test/:portal_id/profile" }
+        let(:params) { {} }
+
+        before do
+          Hubspot.configure(access_token: ENV.fetch("HUBSPOT_ACCESS_TOKEN"), portal_id: ENV.fetch("HUBSPOT_PORTAL_ID"))
+        end
+
+        it { should == "https://api.hubapi.com/test/#{ENV.fetch('HUBSPOT_PORTAL_ID')}/profile" }
       end
 
       context "when configure hasn't been called" do
-        before{ Hubspot::Config.reset! }
+        before { Hubspot::Config.reset! }
         it "raises a config exception" do
-          expect{ subject }.to raise_error Hubspot::ConfigurationError
+          expect { subject }.to raise_error Hubspot::ConfigurationError
         end
       end
 
       context "with interpolations but no params" do
-        let(:params){{}}
+        let(:params) { {} }
+
         it "raises an interpolation exception" do
           expect{ subject }.to raise_error Hubspot::MissingInterpolation
         end
       end
 
       context "with an interpolated param" do
-        let(:params){ {email: "email@address.com"} }
-        it{ should == "https://api.hubapi.com/test/email%40address.com/profile?hapikey=demo" }
+        let(:params) { { email: "email@address.com" } }
+        it { should == "https://api.hubapi.com/test/email%40address.com/profile" }
       end
 
       context "with multiple interpolated params" do
-        let(:path){ "/test/:email/:id/profile" }
-        let(:params){{email: "email@address.com", id: 1234}}
-        it{ should == "https://api.hubapi.com/test/email%40address.com/1234/profile?hapikey=demo" }
+        let(:path) { "/test/:email/:id/profile" }
+        let(:params) { { email: "email@address.com", id: 1234 } }
+        it { should == "https://api.hubapi.com/test/email%40address.com/1234/profile" }
       end
 
       context "with query params" do
-        let(:params){{email: "email@address.com", id: 1234}}
-        it{ should == "https://api.hubapi.com/test/email%40address.com/profile?id=1234&hapikey=demo" }
+        let(:params) { { email: "email@address.com", id: 1234 } }
+        it { should == "https://api.hubapi.com/test/email%40address.com/profile?id=1234" }
 
         context "containing a time" do
           let(:start_time) { Time.now }
-          let(:params){{email: "email@address.com", id: 1234, start: start_time}}
-          it{ should == "https://api.hubapi.com/test/email%40address.com/profile?id=1234&start=#{start_time.to_i * 1000}&hapikey=demo" }
+          let(:params) { { email: "email@address.com", id: 1234, start: start_time } }
+          it { should == "https://api.hubapi.com/test/email%40address.com/profile?id=1234&start=#{start_time.to_i * 1000}" }
         end
 
         context "containing a range" do
           let(:start_time) { Time.now }
           let(:end_time) { Time.now + 1.year }
-          let(:params){{email: "email@address.com", id: 1234, created__range: start_time..end_time }}
-          it{ should == "https://api.hubapi.com/test/email%40address.com/profile?id=1234&created__range=#{start_time.to_i * 1000}&created__range=#{end_time.to_i * 1000}&hapikey=demo" }
+          let(:params) { { email: "email@address.com", id: 1234, created__range: start_time..end_time  } }
+          it { should == "https://api.hubapi.com/test/email%40address.com/profile?id=1234&created__range=#{start_time.to_i * 1000}&created__range=#{end_time.to_i * 1000}" }
         end
 
         context "containing an array of strings" do
-          let(:path){ "/test/emails" }
-          let(:params){{batch_email: %w(email1@example.com email2@example.com)}}
-          it{ should == "https://api.hubapi.com/test/emails?email=email1%40example.com&email=email2%40example.com&hapikey=demo" }
+          let(:path) { "/test/emails" }
+          let(:params) { { batch_email: %w(email1@example.com email2@example.com) } }
+          it { should == "https://api.hubapi.com/test/emails?email=email1%40example.com&email=email2%40example.com" }
         end
       end
 
       context "with options" do
-        let(:options){ {base_url: "https://cool.com", hapikey: false} }
-        it{ should == "https://cool.com/test/test/profile"}
+        let(:options) { { base_url: "https://cool.com", access_token: false } }
+        it { should == "https://cool.com/test/test/profile" }
       end
 
       context "passing Array as parameters for batch mode, key is prefixed with batch_" do
         let(:path) { Hubspot::ContactList::LIST_BATCH_PATH }
         let(:params) { { batch_list_id: [1,2,3] } }
-        it{ should == "https://api.hubapi.com/contacts/v1/lists/batch?listId=1&listId=2&listId=3&hapikey=demo" }
+        it { should == "https://api.hubapi.com/contacts/v1/lists/batch?listId=1&listId=2&listId=3" }
       end
     end
   end
@@ -191,10 +183,7 @@ describe Hubspot::EventConnection do
     let(:headers) { nil }
 
     subject { described_class.trigger(path, options) }
-    before do
-      Hubspot.configure(hapikey: 'demo', portal_id: '62515')
-      allow(described_class).to receive(:get).and_return(true)
-    end
+    before { allow(described_class).to receive(:get).and_return(true) }
 
     it 'calls get with a custom url' do
       subject