Add CRUD actions for Product and Line Item endpoints (#12)

Co-authored-by: John Butler <johnnybutler7@gmail.com>

Author: zrlstone

README.md

@@ -12,6 +12,8 @@ This gem utilizes the `v3` hubspot-api
 ## CRM Objects
 - [Contacts](#contacts)
 - [Deals](#deals)
+- [Products](#products)
+- [Line Items](#line-items)
 
 - [Error Handling](#error-handling)
 
@@ -138,6 +140,69 @@ Please refrence the [hubspot docs](https://developers.hubspot.com/docs/api/crm/c
   EasyHubspot::Deal.delete_deal(123)
 ```
 
+### Products
+Please refrence the [hubspot docs](https://developers.hubspot.com/docs/api/crm/products)
+```ruby
+# Create a product 
+  # required: body
+  # returns: parsed hubspot product
+  EasyHubspot::Product.create_product(properties: { name: '', price: '', etc: ''})
+
+# Update a product
+# required: product_id, body
+# - product_id: must be a hubspot product_id
+# returns: parsed hubspot product
+  EasyHubspot::Product.update_product(123, properties: { name: '', price: '', etc: ''})
+
+# Get a product
+# required: product_id
+# - product_id: must be a hubspot product_id
+# returns: parsed hubspot product
+  EasyHubspot::Product.get_product(123)
+
+# Get all products
+# returns: parsed hubspot products
+  EasyHubspot::Product.get_products
+
+# Delete a product
+# required: product_id
+# - product_id: must be a hubspot product_id
+# returns: {status: 'success'}
+  EasyHubspot::Product.delete_product(123)
+```
+
+### Line Items
+Please refrence the [hubspot docs](https://developers.hubspot.com/docs/api/crm/line-items)
+```ruby
+# Create a line item
+  # required: body
+  # Use hs_product_id property to base on an existing product
+  # returns: parsed hubspot line item
+  EasyHubspot::LineItem.create_line_item(properties: { quantity: '', hs_product_id: '', etc: ''})
+
+# Update a line item
+# required: line_item_id, body
+# - line_item_id: must be a hubspot line_item_id
+# returns: parsed hubspot line item
+  EasyHubspot::LineItem.update_line_item(123, properties: { quantity: '', etc: ''})
+
+# Get a line item
+# required: line_item_id
+# - line_item_id: must be a hubspot line_item_id
+# returns: parsed hubspot line item
+  EasyHubspot::LineItem.get_line_item(123)
+
+# Get all line items
+# returns: parsed hubspot line items
+  EasyHubspot::LineItem.get_line_items
+
+# Delete a line item
+# required: line_item_id
+# - line_item_id: must be a hubspot line_item_id
+# returns: {status: 'success'}
+  EasyHubspot::LineItem.delete_line_item(123)
+```
+
 ## Error Handling
 
 ```ruby

lib/easy_hubspot.rb

@@ -4,6 +4,8 @@
 require 'easy_hubspot/client'
 require 'easy_hubspot/contact'
 require 'easy_hubspot/deal'
+require 'easy_hubspot/product'
+require 'easy_hubspot/line_item'
 require 'easy_hubspot/version'
 require 'easy_hubspot/generators/install_generator'
 require 'easy_hubspot/exceptions'

lib/easy_hubspot/line_item.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module EasyHubspot
+  # class EasyHubspot::LineItem
+  class LineItem < EasyHubspot::Base
+    class << self
+      LINE_ITEM_ENDPOINT = 'crm/v3/objects/line_items'
+
+      def get_line_item(line_item_id)
+        Client.do_get(line_item_id_endpoint(line_item_id), headers)
+      end
+
+      def get_line_items
+        Client.do_get(LINE_ITEM_ENDPOINT, headers)
+      end
+
+      def create_line_item(body)
+        Client.do_post(LINE_ITEM_ENDPOINT, body, headers)
+      end
+
+      def update_line_item(line_item_id, body)
+        Client.do_patch(line_item_id_endpoint(line_item_id), body, headers)
+      end
+
+      def delete_line_item(line_item_id)
+        Client.do_delete(line_item_id_endpoint(line_item_id), headers)
+      end
+
+      private
+
+      def line_item_id_endpoint(line_item_id)
+        "#{LINE_ITEM_ENDPOINT}/#{line_item_id}"
+      end
+    end
+  end
+end

lib/easy_hubspot/product.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module EasyHubspot
+  # class EasyHubspot::Product
+  class Product < EasyHubspot::Base
+    class << self
+      PRODUCT_ENDPOINT = 'crm/v3/objects/products'
+
+      def get_product(product_id)
+        Client.do_get(product_id_endpoint(product_id), headers)
+      end
+
+      def get_products
+        Client.do_get(PRODUCT_ENDPOINT, headers)
+      end
+
+      def create_product(body)
+        Client.do_post(PRODUCT_ENDPOINT, body, headers)
+      end
+
+      def update_product(product_id, body)
+        Client.do_patch(product_id_endpoint(product_id), body, headers)
+      end
+
+      def delete_product(product_id)
+        Client.do_delete(product_id_endpoint(product_id), headers)
+      end
+
+      private
+
+      def product_id_endpoint(product_id)
+        "#{PRODUCT_ENDPOINT}/#{product_id}"
+      end
+    end
+  end
+end

spec/easy_hubspot/line_item_spec.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe EasyHubspot::LineItem do
+  before :all do
+    EasyHubspot.config do |config|
+      config.access_token = 'YOUR-PRIVATE-ACCESS-TOKEN'
+    end
+  end
+
+  describe 'get_line_item' do
+    context 'when line_item is found using line_item_id' do
+      before do
+        stub_request(:get, 'https://api.hubapi.com/crm/v3/objects/line_items/4118976207')
+          .with(
+            headers: {
+              'Accept' => '*/*',
+              'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+              'Authorization' => 'Bearer YOUR-PRIVATE-ACCESS-TOKEN',
+              'Content-Type' => 'application/json',
+              'User-Agent' => 'Ruby'
+            }
+          )
+          .to_return(status: 200, body: load_line_item_json('get_line_item'), headers: {})
+      end
+
+      let(:response) { described_class.get_line_item('4118976207') }
+
+      it 'returns a line item
+      ' do
+        expect(response[:id]).to eq '4118976207'
+        expect(response[:properties][:amount]).to eq '215.460'
+        expect(response[:properties][:quantity]).to eq '3'
+        expect(response[:properties][:hs_product_id]).to eq '1175864298'
+      end
+    end
+  end
+
+  describe 'get_line_items' do
+    context 'when line items are found' do
+      before do
+        stub_request(:get, 'https://api.hubapi.com/crm/v3/objects/line_items')
+          .with(
+            headers: {
+              'Accept' => '*/*',
+              'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+              'Authorization' => 'Bearer YOUR-PRIVATE-ACCESS-TOKEN',
+              'Content-Type' => 'application/json',
+              'User-Agent' => 'Ruby'
+            }
+          )
+          .to_return(status: 200, body: load_line_item_json('get_line_items'), headers: {})
+      end
+
+      let(:response) { described_class.get_line_items }
+
+      it 'returns a list of line items' do
+        results = response[:results]
+        expect(results.count).to eq 2
+      end
+    end
+  end
+
+  describe 'create_line_item' do
+    before do
+      stub_request(:post, 'https://api.hubapi.com/crm/v3/objects/line_items')
+        .with(
+          body: 'properties%5Bname%5D=Blue%20Jeans&properties%5Bhs_product_id%5D=1175864298&properties%5Bprice%5D=71.82&properties%5Bquantity%5D=3',
+          headers: {
+            'Accept' => '*/*',
+            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+            'Authorization' => 'Bearer YOUR-PRIVATE-ACCESS-TOKEN',
+            'Content-Type' => 'application/json',
+            'User-Agent' => 'Ruby'
+          }
+        ).to_return(status: 200, body: load_line_item_json('create_line_item'), headers: {})
+    end
+
+    let(:body) do
+      { properties: { name: 'Blue Jeans', hs_product_id: '1175864298', price: '71.82', quantity: '3' } }
+    end
+
+    let(:response) { described_class.create_line_item(body) }
+
+    it 'returns a line item' do
+      expect(response[:id]).to eq '4118976207'
+      expect(response[:properties][:price]).to eq '71.82'
+      expect(response[:properties][:quantity]).to eq '3'
+      expect(response[:properties][:amount]).to eq '215.460'
+      expect(response[:properties][:name]).to eq 'Blue Jeans'
+    end
+  end
+
+  describe 'update_line_item' do
+    context 'when line item is found using line_item_id' do
+      before do
+        stub_request(:patch, 'https://api.hubapi.com/crm/v3/objects/line_items/4120050126')
+          .with(
+            body: 'properties%5Bquantity%5D=2',
+            headers: {
+              'Accept' => '*/*',
+              'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+              'Authorization' => 'Bearer YOUR-PRIVATE-ACCESS-TOKEN',
+              'Content-Type' => 'application/json',
+              'User-Agent' => 'Ruby'
+            }
+          )
+          .to_return(status: 200, body: load_line_item_json('update_line_item'), headers: {})
+      end
+
+      let(:body) do
+        { properties: { quantity: '2' } }
+      end
+
+      let(:response) { described_class.update_line_item(4_120_050_126, body) }
+
+      it 'returns a line item' do
+        expect(response[:id]).to eq '4120050126'
+        expect(response[:properties][:quantity]).to eq '2'
+        expect(response[:properties][:price]).to eq '71.82'
+        expect(response[:properties][:amount]).to eq '143.640'
+      end
+    end
+  end
+
+  describe 'delete_line_item' do
+    let(:success) { { status: 'success' } }
+
+    context 'when line item is found using line_item_id' do
+      before do
+        stub_request(:delete, 'https://api.hubapi.com/crm/v3/objects/line_items/4120050126')
+          .with(
+            headers: {
+              'Accept' => '*/*',
+              'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+              'Authorization' => 'Bearer YOUR-PRIVATE-ACCESS-TOKEN',
+              'Content-Type' => 'application/json',
+              'User-Agent' => 'Ruby'
+            }
+          )
+          .to_return(status: 204, body: '', headers: {})
+      end
+
+      let(:response) { described_class.delete_line_item('4120050126') }
+
+      it 'returns no content' do
+        expect(response).to eq success
+      end
+    end
+  end
+
+  describe 'errors' do
+    context "when trying to update a line item that doesn't exist" do
+      before do
+        stub_request(:patch, 'https://api.hubapi.com/crm/v3/objects/line_items/123')
+          .with(
+            body: 'properties%5Bquantity%5D=3',
+            headers: {
+              'Accept' => '*/*',
+              'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+              'Authorization' => 'Bearer YOUR-PRIVATE-ACCESS-TOKEN',
+              'Content-Type' => 'application/json',
+              'User-Agent' => 'Ruby'
+            }
+          ).to_return(status: 200, body: load_line_item_json('not_found'), headers: {})
+      end
+
+      let(:body) do
+        { properties: { quantity: '3' } }
+      end
+
+      it 'raises a HubspotApiError' do
+        expect do
+          described_class.update_line_item(123, body)
+        end.to raise_error(EasyHubspot::HubspotApiError)
+      end
+    end
+
+    context 'when hubspot api returns a 404 reponse code' do
+      before do
+        stub_request(:get, 'https://api.hubapi.com/crm/v3/objects/line_items/404')
+          .with(
+            headers: {
+              'Accept' => '*/*',
+              'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+              'Authorization' => 'Bearer YOUR-PRIVATE-ACCESS-TOKEN',
+              'Content-Type' => 'application/json',
+              'User-Agent' => 'Ruby'
+            }
+          )
+          .to_return(status: 404, body: nil, headers: {})
+      end
+
+      let(:response) { described_class.get_line_item('404') }
+
+      it 'returns a 404 status error message' do
+        expect(response).to eq({ status: 'error', message: '404 Not Found' })
+      end
+    end
+  end
+end