hubspot-ruby 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1ed5f2aa1fbcdc87f14f1197d9b78dad4380f057
-  data.tar.gz: 2184008548937dbbbb103f30d3eb96c11f3c0d8c
+SHA256:
+  metadata.gz: 371e11640e32bc9b2ba0bb54f3fbdfd3b84dcb5f4be69fd0d4e89163fdf544bb
+  data.tar.gz: 8f27026960fb8cc21c1f25c76dba6a26e4c33be192a635728a939284f52bea09
 SHA512:
-  metadata.gz: 20f5233aa72b00ce366785e64b0ac385c8a48d86e2c79df9196958b668c573e32018cb2924e86c0216d489049535ce443dad9e7227a9b35941160e938f22023c
-  data.tar.gz: bea00d2e9baf596c71a2fcbaeaaa89b081dbbec0b900f03226bdfbbef8fc7ebab1bb0618739a660e1ccf624199341607f79412a97877ed87d1fde0732dec2feb
+  metadata.gz: bed3f9319a9dc8db09aa7a050d3724055e502cece3a2b3400c19fb7125fb4a38c1cf5366deff6e22f7ff34fc9db69d380c29e4f18df69763d422941efcd47019
+  data.tar.gz: 64b3ddc122391b6d3fd44ec0cbe123ae92b306a632ebce366a9a43ee7acee0ef705e919c8d05661d6906e6d2454435352fc5b5c7422bd58d9320adc92ac5f4f7

data/README.md

@@ -1,5 +1,7 @@
 # HubSpot REST API wrappers for ruby
 
+[![Build Status](https://travis-ci.org/adimichele/hubspot-ruby.svg?branch=v0-stable)](https://travis-ci.org/adimichele/hubspot-ruby)
+
 Wraps the HubSpot REST API for convenient access from ruby applications.
 
 Documentation for the HubSpot REST API can be found here: https://developers.hubspot.com/docs/endpoints
@@ -132,13 +134,23 @@ Hubspot::Deal.create!(nil, [company.vid], [contact.vid], pipeline: 'default', de
 
 ### Testing
 
-All tests can be run with `rake spec`. Isolate fast-running tests with `rake spec:quick`.
+This project uses [VCR] to test interactions with the HubSpot API.
+VCR records HTTP requests and replays them during future tests.
+
+To run the tests, run `bundle exec rake` or `bundle exec rspec`.
+
+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.
 
-GET requests are pretty easy to test with VCR, but for POST/PUT requests, you probably want to update verify the state
-of a live HubSpot instance. To do this, please add "live" tests to `spec/live/`, using the rspec label `live: true` in
-order to disable VCR.
+To add a new test or update a VCR recording, run the test with the `VCR_RECORD`
+environment variable:
+
+```sh
+VCR_RECORD=1 bundle exec rspec spec
+```
 
-"Live" tests can be isolated with `rake spec:live`.
+[VCR]: https://github.com/vcr/vcr
 
 ## Disclaimer
 

data/Rakefile

@@ -14,20 +14,10 @@ require 'rake'
 require 'rspec/core'
 require 'rspec/core/rake_task'
 
-namespace :spec do
-  RSpec::Core::RakeTask.new(:quick) do |spec|
-    spec.pattern = FileList['spec/**/*_spec.rb'].select{ |s| !s.match("/live/") }
-  end
-  RSpec::Core::RakeTask.new(:live) do |spec|
-    spec.pattern = FileList['spec/live/*_spec.rb']
-  end
-end
-
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
+RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+desc "Default: runs the full test suite."
+task default: :spec
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|

data/hubspot-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "hubspot-ruby"
-  s.version = "0.5.0"
+  s.version = "0.6.0"
   s.require_paths = ["lib"]
   s.authors = ["Andrew DiMichele", "Chris Bisnett"]
   s.description = "hubspot-ruby is a wrapper for the HubSpot REST API"

data/lib/hubspot-ruby.rb

@@ -28,3 +28,6 @@ module Hubspot
 
   require 'hubspot/railtie' if defined?(Rails)
 end
+
+# Alias the module for those looking to use the stylized name HubSpot
+HubSpot = Hubspot

data/lib/hubspot/company.rb

@@ -40,6 +40,33 @@ module Hubspot
         response['results'].map { |c| new(c) }
       end
 
+      # Find all companies by created date (descending)
+      #    recently_updated [boolean] (for querying all accounts by modified time)
+      #    count [Integer] for pagination
+      #    offset [Integer] for pagination
+      # {http://developers.hubspot.com/docs/methods/companies/get_companies_created}
+      # {http://developers.hubspot.com/docs/methods/companies/get_companies_modified}
+      # @return [Object], you can get:
+      # response.results for [Array]
+      # response.hasMore for [Boolean]
+      # response.offset for [Integer]
+      def all_with_offset(opts = {})
+        recently_updated = opts.delete(:recently_updated) { false }
+
+        path = if recently_updated
+          RECENTLY_MODIFIED_COMPANIES_PATH
+        else
+          RECENTLY_CREATED_COMPANIES_PATH
+        end
+
+        response = Hubspot::Connection.get_json(path, opts)
+        response_with_offset = {}
+        response_with_offset['results'] = response['results'].map { |c| new(c) }
+        response_with_offset['hasMore'] = response['hasMore']
+        response_with_offset['offset'] = response['offset']
+        response_with_offset
+      end
+
       # Finds a list of companies by domain
       # {https://developers.hubspot.com/docs/methods/companies/search_companies_by_domain}
       # @param domain [String] company domain to search by

data/lib/hubspot/railtie.rb

@@ -4,7 +4,6 @@ module Hubspot
   class Railtie < Rails::Railtie
     rake_tasks do
       spec = Gem::Specification.find_by_name('hubspot-ruby')
-      import "#{spec.gem_dir}/lib/tasks/properties.rake"
     end
   end
 end

data/spec/lib/hubspot/blog_spec.rb

@@ -1,18 +1,9 @@
 require 'timecop'
 
 describe Hubspot do
-  let(:example_blog_hash) do
-    VCR.use_cassette("blog_list", record: :none) do
-      url = Hubspot::Connection.send(:generate_url, Hubspot::Blog::BLOG_LIST_PATH)
-      resp = HTTParty.get(url, format: :json)
-      resp.parsed_response["objects"].first
-    end
-  end
-  let(:created_range_params) { { created__gt: false, created__range: (Time.now..Time.now + 2.years)  } }
-
   before do
     Hubspot.configure(hapikey: "demo")
-    Timecop.freeze(Time.local(2012, 'Oct', 10))
+    Timecop.freeze(Time.utc(2012, 'Oct', 10))
   end
 
   after do
@@ -20,97 +11,140 @@ describe Hubspot do
   end
 
   describe Hubspot::Blog do
-
     describe ".list" do
-      cassette "blog_list"
-      let(:blog_list) { Hubspot::Blog.list }
+      it "returns a list of blogs" do
+        VCR.use_cassette("blog_list") do
+          result = Hubspot::Blog.list
 
-      it "should have a list of blogs" do
-        blog_list.count.should be(1)
+          assert_requested :get, hubspot_api_url("/content/api/v2/blogs?hapikey=demo")
+          expect(result).to be_kind_of(Array)
+          expect(result.first).to be_a(Hubspot::Blog)
+        end
       end
     end
 
     describe ".find_by_id" do
-      cassette "blog_list"
+      it "retrieves a blog by id" do
+        VCR.use_cassette("blog_list") do
+          id = 351076997
+          result = Hubspot::Blog.find_by_id(id)
 
-      it "should have a list of blogs" do
-        blog = Hubspot::Blog.find_by_id(351076997)
-        blog["id"].should eq(351076997)
+          assert_requested :get, hubspot_api_url("/content/api/v2/blogs/#{id}?hapikey=demo")
+          expect(result).to be_a(Hubspot::Blog)
+        end
       end
     end
 
-    describe "#initialize" do
-      subject{ Hubspot::Blog.new(example_blog_hash) }
-      its(["name"]) { should == "API Demonstration Blog" }
-      its(["id"])   { should == 351076997 }
-    end
+    describe "#[]" do
+      it "returns the value for the given key" do
+        data = {
+          "id" => 123,
+          "name" => "Demo",
+        }
+        blog = Hubspot::Blog.new(data)
 
-    describe "#posts" do
-      cassette "one_month_blog_posts_filter_state"
-      let(:blog) { Hubspot::Blog.new(example_blog_hash) }
+        expect(blog["id"]).to eq(data["id"])
+        expect(blog["name"]).to eq(data["name"])
+      end
 
-      describe "can be filtered by state" do
+      context "when the value is unknown" do
+        it "returns nil" do
+          blog = Hubspot::Blog.new({})
 
-        it "should filter the posts to published by default" do
-          pending 'This test does not pass reliably'
-          blog.posts.length.should be(14)
+          expect(blog["nope"]).to be_nil
         end
+      end
+    end
 
-        it "should validate the state is a valid one" do
-          expect { blog.posts('invalid') }.to raise_error(Hubspot::InvalidParams)
-        end
+    describe "#posts" do
+      it "returns published blog posts created in the last 2 months" do
+        VCR.use_cassette("blog_posts/all_blog_posts") do
+          blog_id = 123
+          created_gt = timestamp_in_milliseconds(Time.now - 2.months)
+          blog = Hubspot::Blog.new({ "id" => blog_id })
+
+          result = blog.posts
 
-        it "should allow draft posts if specified" do
-          blog.posts({ state: false }.merge(created_range_params)).length.should be > 0
+          assert_requested :get, hubspot_api_url("/content/api/v2/blog-posts?content_group_id=#{blog_id}&created__gt=#{created_gt}&hapikey=demo&order_by=-created&state=PUBLISHED")
+          expect(result).to be_kind_of(Array)
         end
       end
 
-      describe "can be ordered" do
-        it "created at descending is default" do
-          created_timestamps = blog.posts(created_range_params).map { |post| post['created'] }
-          expect(created_timestamps.sort.reverse).to eq(created_timestamps)
-        end
+      it "includes given parameters in the request" do
+        VCR.use_cassette("blog_posts/filter_blog_posts") do
+          blog_id = 123
+          created_gt = timestamp_in_milliseconds(Time.now - 2.months)
+          blog = Hubspot::Blog.new({ "id" => 123 })
+
+          result = blog.posts({ state: "DRAFT" })
 
-        it "by created ascending" do
-          pending
-          created_timestamps = blog.posts({order_by: '+created'}.merge(created_range_params)).map { |post| post['created'] }
-          expect(created_timestamps.sort).to eq(created_timestamps)
+          assert_requested :get, hubspot_api_url("/content/api/v2/blog-posts?content_group_id=#{blog_id}&created__gt=#{created_gt}&hapikey=demo&order_by=-created&state=DRAFT")
+          expect(result).to be_kind_of(Array)
         end
       end
 
-      it "can set a page size" do
-        pending 'Not working'
-        blog.posts({limit: 10}.merge(created_range_params)).length.should be(10)
+      it "raises when given an unknown state" do
+        blog = Hubspot::Blog.new({})
+
+        expect {
+          blog.posts({ state: "unknown" })
+        }.to raise_error(Hubspot::InvalidParams, "State parameter was invalid")
       end
     end
   end
 
   describe Hubspot::BlogPost do
-    cassette "blog_posts"
+    describe "#created_at" do
+      it "returns the created timestamp as a Time" do
+        timestamp = timestamp_in_milliseconds(Time.now)
+        blog_post = Hubspot::BlogPost.new({ "created" => timestamp })
 
-    let(:example_blog_post) do
-      VCR.use_cassette("one_month_blog_posts_filter_state", record: :none) do
-        blog = Hubspot::Blog.new(example_blog_hash)
-        blog.posts(created_range_params).first
+        expect(blog_post.created_at).to eq(Time.at(timestamp/1000))
       end
     end
 
-    it "should have a created_at value specific method" do
-      expect(example_blog_post.created_at).to eq(Time.at(example_blog_post['created'] / 1000))
-    end
+    describe ".find_by_blog_post_id" do
+      it "retrieves a blog post by id" do
+        VCR.use_cassette "blog_posts" do
+          blog_post_id = 422192866
 
-    it "can find by blog_post_id" do
-      blog = Hubspot::BlogPost.find_by_blog_post_id(422192866)
-      expect(blog['id']).to eq(422192866)
+          result = Hubspot::BlogPost.find_by_blog_post_id(blog_post_id)
+
+          assert_requested :get, hubspot_api_url("/content/api/v2/blog-posts/#{blog_post_id}?hapikey=demo")
+          expect(result).to be_a(Hubspot::BlogPost)
+        end
+      end
     end
 
-    context 'containing a topic' do
-      # 422192866 contains a topic
-      let(:blog_with_topic) { Hubspot::BlogPost.find_by_blog_post_id(422192866) }
+    describe "#topics" do
+      it "returns the list of topics" do
+        VCR.use_cassette "blog_posts" do
+          blog_post = Hubspot::BlogPost.find_by_blog_post_id(422192866)
+
+          topics = blog_post.topics
+
+          expect(topics).to be_kind_of(Array)
+          expect(topics.first).to be_a(Hubspot::Topic)
+        end
+      end
+
+      context "when the blog post does not have topics" do
+        it "returns an empty list" do
+          blog_post = Hubspot::BlogPost.new({ "topic_ids" => [] })
 
-      it "should return topic objects" do
-        expect(blog_with_topic.topics.first.is_a?(Hubspot::Topic)).to be(true)
+          topics = blog_post.topics
+
+          expect(topics).to be_empty
+        end
       end
     end
   end
+
+  def hubspot_api_url(path)
+    URI.join(Hubspot::Config.base_url, path)
+  end
+
+  def timestamp_in_milliseconds(time)
+    time.to_i * 1000
+  end
 end

data/spec/lib/hubspot/company_properties_spec.rb

@@ -15,13 +15,13 @@ describe Hubspot::CompanyProperties do
   end
 
   let(:example_groups) do
-    VCR.use_cassette('groups_example', record: :once) do
+    VCR.use_cassette('groups_example') do
       HTTParty.get('https://api.hubapi.com/companies/v2/groups?hapikey=demo').parsed_response
     end
   end
 
   let(:example_properties) do
-    VCR.use_cassette('properties_example', record: :once) do
+    VCR.use_cassette('properties_example') do
       HTTParty.get('https://api.hubapi.com/companies/v2/properties?hapikey=demo').parsed_response
     end
   end

data/spec/lib/hubspot/company_spec.rb

@@ -1,11 +1,11 @@
 describe Hubspot::Contact do
   let(:example_company_hash) do
-    VCR.use_cassette("company_example", record: :none) do
+    VCR.use_cassette("company_example") do
       HTTParty.get("https://api.hubapi.com/companies/v2/companies/21827084?hapikey=demo").parsed_response
     end
   end
   let(:company_with_contacts_hash) do
-    VCR.use_cassette("company_with_contacts", record: :none) do
+    VCR.use_cassette("company_with_contacts") do
       HTTParty.get("https://api.hubapi.com/companies/v2/companies/115200636?hapikey=demo").parsed_response
     end
   end
@@ -132,10 +132,34 @@ describe Hubspot::Contact do
         expect(last['name']).to eql 'Xge5rbdt2zm'
       end
 
-      it 'must filter only 2 copmanies' do
+      it 'must filter only 2 companies' do
         copmanies = Hubspot::Company.all(count: 2)
         expect(copmanies.size).to eql 2
       end
+
+      context 'all_with_offset' do
+        it 'should return companies with offset and hasMore' do
+          response = Hubspot::Company.all_with_offset
+          expect(response['results'].size).to eq(20)
+
+          first = response['results'].first
+          last = response['results'].last
+
+          expect(first).to be_a Hubspot::Company
+          expect(first.vid).to eq(42866817)
+          expect(first['name']).to eql 'name'
+          expect(last).to be_a Hubspot::Company
+          expect(last.vid).to eql 42861017
+          expect(last['name']).to eql 'Xge5rbdt2zm'
+        end
+
+        it 'must filter only 2 companies' do
+          response = Hubspot::Company.all_with_offset(count: 2)
+          expect(response['results'].size).to eq(2)
+          expect(response['hasMore']).to be_truthy
+          expect(response['offset']).to eq(2)
+        end
+      end
     end
 
     context 'recent companies' do

data/spec/lib/hubspot/contact_list_spec.rb

@@ -1,6 +1,6 @@
 describe Hubspot::ContactList do
   let(:example_contact_list_hash) do
-    VCR.use_cassette("contact_list_example", record: :none) do
+    VCR.use_cassette("contact_list_example") do
       HTTParty.get("https://api.hubapi.com/contacts/v1/lists/1?hapikey=demo").parsed_response
     end
   end
@@ -9,7 +9,7 @@ describe Hubspot::ContactList do
   let(:dynamic_list) { Hubspot::ContactList.all(dynamic: true, count: 1).first }
 
   let(:example_contact_hash) do
-    VCR.use_cassette("contact_example", record: :none) do
+    VCR.use_cassette("contact_example") do
       HTTParty.get("https://api.hubapi.com/contacts/v1/contact/email/testingapis@hubspot.com/profile?hapikey=demo").parsed_response
     end
   end

data/spec/lib/hubspot/contact_properties_spec.rb

@@ -15,13 +15,13 @@ describe Hubspot::ContactProperties do
   end
 
   let(:example_groups) do
-    VCR.use_cassette('groups_example', record: :once) do
+    VCR.use_cassette('groups_example') do
       HTTParty.get('https://api.hubapi.com/contacts/v2/groups?hapikey=demo').parsed_response
     end
   end
 
   let(:example_properties) do
-    VCR.use_cassette('properties_example', record: :once) do
+    VCR.use_cassette('properties_example') do
       HTTParty.get('https://api.hubapi.com/contacts/v2/properties?hapikey=demo').parsed_response
     end
   end