0.1.10 Add Deal Object CRUD Methods (#7)

Author: oroth8

CHANGELOG.md

@@ -2,6 +2,7 @@
 - [0.1.7] - 2023-02-10
 - [0.1.8] - 2023-02-10
 - [0.1.9] - 2023-02-14 https://github.com/oroth8/easy_hubspot/pull/6
+- [0.1.10] - 2023-02-14 https://github.com/oroth8/easy_hubspot/pull/7
 
 ## [Unreleased]
 

README.md

@@ -1,13 +1,19 @@
 # EasyHubspot
-Stable: ![stable version](https://img.shields.io/badge/version-0.1.8-green)
-Latest: ![latest version](https://img.shields.io/badge/version-0.1.9-yellow)
+Stable: ![stable version](https://img.shields.io/badge/version-0.1.10-green)
+Latest: ![latest version](https://img.shields.io/badge/version-0.1.10-yellow)
 [![CI](https://github.com/oroth8/easy_hubspot/actions/workflows/ci.yml/badge.svg)](https://github.com/oroth8/easy_hubspot/actions/workflows/ci.yml)
 [![Code Climate](https://codeclimate.com/github/oroth8/easy_hubspot/badges/gpa.svg)](https://codeclimate.com/github/oroth8/easy_hubspot)
 
 This is a lightweight wrapper for the Hubspot API. It is designed to be easy to use and to provide a simple setup for the most common use cases.
 
 This gem utilizes the `v3` hubspot-api
 
+## CRM Objects
+- [Contacts](#contacts)
+- [Deals](#deals)
+
+- [Error Handling](#error-handling)
+
 ### Dependencies
 - [gem "httparty", "~> 0.21.0"](https://github.com/jnunemaker/httparty)
 
@@ -101,6 +107,36 @@ Please refrence the [hubspot docs](https://developers.hubspot.com/docs/api/crm/c
  :archived=>false}
 ```
 
+### Deals
+```ruby
+# Create a deal 
+  # required: body
+  # returns: parsed hubspot deal
+  EasyHubspot::Deal.create_deal(properties: { dealname: '', amount: '', etc: ''})
+
+# Update a deal
+# required: deal_id, body
+# - deal_id: must be a hubspot deal_id
+# returns: parsed hubspot deal
+  EasyHubspot::Deal.update_deal(123, properties: { dealname: '', amount: '', etc: ''})
+
+# Get a deal
+# required: deal_id
+# - deal_id: must be a hubspot deal_id
+# returns: parsed hubspot deal
+  EasyHubspot::Deal.get_deal(123)
+
+# Get all deals
+# returns: parsed hubspot deals
+  EasyHubspot::Deal.get_deals
+
+# Delete a deal
+# required: deal_id
+# - deal_id: must be a hubspot deal_id
+# returns: {status: 'success'}
+  EasyHubspot::Deal.delete_deal(123)
+```
+
 ## Error Handling
 
 ```ruby

lib/easy_hubspot.rb

@@ -3,6 +3,7 @@
 require 'easy_hubspot/base'
 require 'easy_hubspot/client'
 require 'easy_hubspot/contact'
+require 'easy_hubspot/deal'
 require 'easy_hubspot/version'
 require 'easy_hubspot/generators/install_generator'
 require 'easy_hubspot/exceptions'

lib/easy_hubspot/deal.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module EasyHubspot
+  # class EasyHubspot::deal
+  class Deal < EasyHubspot::Base
+    class << self
+      DEAL_ENDPOINT = 'crm/v3/objects/deals'
+
+      def get_deal(deal_id)
+        Client.do_get(deal_id_endpoint(deal_id), headers)
+      end
+
+      def get_deals
+        Client.do_get(DEAL_ENDPOINT, headers)
+      end
+
+      def create_deal(body)
+        Client.do_post(DEAL_ENDPOINT, body, headers)
+      end
+
+      def update_deal(deal_id, body)
+        Client.do_patch(deal_id_endpoint(deal_id), body, headers)
+      end
+
+      def delete_deal(deal_id)
+        Client.do_delete(deal_id_endpoint(deal_id), headers)
+      end
+
+    private
+
+      def deal_id_endpoint(deal_id)
+        "#{DEAL_ENDPOINT}/#{deal_id}"
+      end
+  end
+  end
+end

lib/easy_hubspot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EasyHubspot
-  VERSION = '0.1.9'
+  VERSION = '0.1.10'
 end

spec/easy_hubspot/contact_spec.rb

@@ -22,7 +22,7 @@
               'User-Agent' => 'Ruby'
             }
           )
-          .to_return(status: 200, body: load_json('contact'), headers: {})
+          .to_return(status: 200, body: load_contact_json('contact'), headers: {})
       end
 
       let(:response) { described_class.get_contact('701') }
@@ -45,7 +45,7 @@
               'User-Agent' => 'Ruby'
             }
           )
-          .to_return(status: 200, body: load_json('contact'), headers: {})
+          .to_return(status: 200, body: load_contact_json('contact'), headers: {})
       end
 
       let(:response) { described_class.get_contact('[email protected]') }
@@ -70,7 +70,7 @@
               'User-Agent' => 'Ruby'
             }
           )
-          .to_return(status: 200, body: load_json('contacts'), headers: {})
+          .to_return(status: 200, body: load_contact_json('contacts'), headers: {})
       end
 
       let(:response) { described_class.get_contacts }
@@ -95,7 +95,7 @@
             'User-Agent' => 'Ruby'
           }
         )
-        .to_return(status: 201, body: load_json('create_contact'), headers: {})
+        .to_return(status: 201, body: load_contact_json('create_contact'), headers: {})
     end
 
     let(:body) do
@@ -125,7 +125,7 @@
               'User-Agent' => 'Ruby'
             }
           )
-          .to_return(status: 200, body: load_json('update_contact'), headers: {})
+          .to_return(status: 200, body: load_contact_json('update_contact'), headers: {})
       end
 
       let(:body) do
@@ -154,7 +154,7 @@
               'User-Agent' => 'Ruby'
             }
           )
-          .to_return(status: 200, body: load_json('update_contact'), headers: {})
+          .to_return(status: 200, body: load_contact_json('update_contact'), headers: {})
       end
 
       let(:body) do
@@ -233,7 +233,7 @@
               'User-Agent' => 'Ruby'
             }
           )
-          .to_return(status: 400, body: load_json('duplicate_contact'), headers: {})
+          .to_return(status: 400, body: load_contact_json('duplicate_contact'), headers: {})
       end
 
       let(:body) do
@@ -260,7 +260,7 @@
               'User-Agent' => 'Ruby'
             }
           )
-          .to_return(status: 400, body: load_json('contact_not_found'), headers: {})
+          .to_return(status: 400, body: load_contact_json('contact_not_found'), headers: {})
       end
 
       let(:body) do
@@ -286,7 +286,7 @@
               'User-Agent' => 'Ruby'
             }
           )
-          .to_return(status: 404, body: load_json('contact_not_found'), headers: {})
+          .to_return(status: 404, body: load_contact_json('contact_not_found'), headers: {})
       end
 
       let(:response) { described_class.get_contact('4040') }
@@ -316,7 +316,7 @@
               'User-Agent' => 'Ruby'
             }
           )
-          .to_return(status: 200, body: load_json('contact'), headers: {})
+          .to_return(status: 200, body: load_contact_json('contact'), headers: {})
         stub_request(:patch, 'https://api.hubapi.com/crm/v3/objects/contacts/[email protected]?idProperty=email')
           .with(
             body: 'properties%5Bemail%5D=amber_becker%40quigley.io&properties%5Bfirstname%5D=Amber&properties%5Blastname%5D=Quigley&properties%5Bhs_content_membership_status%5D=inactive',
@@ -328,11 +328,11 @@
               'User-Agent' => 'Ruby'
             }
           )
-          .to_return(status: 200, body: load_json('update_or_create_contact'), headers: {})
+          .to_return(status: 200, body: load_contact_json('update_or_create_contact'), headers: {})
       end
 
       it 'updates the contact' do
-        expect(response).to eq JSON.parse load_json('update_or_create_contact'), symbolize_names: true
+        expect(response).to eq JSON.parse load_contact_json('update_or_create_contact'), symbolize_names: true
       end
     end
 
@@ -366,11 +366,11 @@
               'User-Agent' => 'Ruby'
             }
           )
-          .to_return(status: 200, body: load_json('update_or_create_post'), headers: {})
+          .to_return(status: 200, body: load_contact_json('update_or_create_post'), headers: {})
       end
 
       it 'creates the contact' do
-        expect(response).to eq JSON.parse load_json('update_or_create_post'), symbolize_names: true
+        expect(response).to eq JSON.parse load_contact_json('update_or_create_post'), symbolize_names: true
       end
     end
   end