easy_hubspot 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15bcc6ca4b7e8b160927aad5170f22efd765358612e65c91b21d80071d5c6d6d
-  data.tar.gz: 9be1296e8f614c6ef77bfe25d14aad9ffaaa714ccf18f4cb549ed49ecf467737
+  metadata.gz: 8afd7c12ba165b752df83f2a711ad3220f0efb7f9fef8a73340ae9dd9c95adeb
+  data.tar.gz: dcd135320a2274849e576f7b2c5497a74323c1713b330f275c6c4f6dfa3cedef
 SHA512:
-  metadata.gz: cc9087d34a7f1d10728fe8eb3c5aeca654655cda1a8cc938eb804c21c40f0fa3b8073988cb2776bc538d3d4ce86dfea49e594198ea602487aeefaaa5a453e183
-  data.tar.gz: 9274936c9c512e5627702a5aaa63e7253c3ce6e1c72ec858d722a3376d412c3abbcf96c916437322c0f779e0c0d717ff169098663db396c34c3bd390feed237f
+  metadata.gz: 4b5da8b90ae02f92056d2af35dea0cbbe8207e84d486345dd89fd7d155b75a13680b735788f2e4b64ba3c9acc617830c8fe29feb3a5b3156c5ceb3cab3b2f724
+  data.tar.gz: c90fb31a0954a82c9bdfbf7c3b0c5df4fde0e4f5c40da12fa09f32afad0f8ca5c7679ae561ca52196b016bebf06bcdeb93edb6d14c57ed354b99b2faf5a75f95

data/CHANGELOG.md

@@ -1,5 +1,13 @@
-## [Unreleased]
+## [Official Release]
+- [0.1.7] - 2023-02-10
 
-## [0.1.0] - 2023-02-08
+## [Unreleased]
 
-- Initial release
+## [Initial releases]
+- [0.1.0] - 2023-02-08
+- [0.1.1] - 2023-02-09
+- [0.1.2] - 2023-02-09
+- [0.1.3] - 2023-02-09
+- [0.1.4] - 2023-02-09
+- [0.1.5] - 2023-02-09
+- [0.1.6] - 2023-02-09

data/Gemfile

@@ -7,7 +7,7 @@ gemspec
 
 group :development, :test do
   gem 'bundler', '~> 2.2'
-  gem 'pry', '~> 0.13.1'
+  gem 'pry', '~> 0.14.2'
   gem 'rake', '~> 13.0'
   gem 'rspec', '~> 3.0'
   gem 'rubocop', '~> 1.21'

data/README.md

@@ -1,24 +1,61 @@
 # EasyHubspot
+![version](https://img.shields.io/badge/version-0.1.7-green)
+[![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)
 
-TODO: Delete this and the text below, and describe your gem
+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.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/easy_hubspot`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem utilizes the `v3` hubspot-api
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add this line to your application's Gemfile:
 
-Install the gem and add to the application's Gemfile by executing:
+```ruby
+gem 'easy_hubspot'
+```
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+## Usage
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Add the following to your `config/initializers/easy_hubspot.rb` file:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+EasyHubspot.config do |c|
+  c.access_token = 'YOUR API KEY'
+  c.base_url = 'https://api.hubapi.com/'
+end
+```
 
-## Usage
+Or run the generator:
+
+```bash
+rails g easy_hubspot:install
+```
+
+### Contacts
+
+Please refrence the [hubspot docs](https://developers.hubspot.com/docs/api/crm/contacts)
+
+```ruby
+# Create a contact
+EasyHubspot::Contact.create_contact(properties: { email: '', firstname: '', lastname: '' , etc: ''})
+
+# Update a contact
+EasyHubspot::Contact.update_contact(123, properties: { email: '', firstname: '', lastname: '' , etc: ''})
+
+# Get a contact
+EasyHubspot::Contact.get_contact(123)
+# or
+EasyHubspot::Contact.get_contact('test@gmail.com')
+
+# Get all contacts
+EasyHubspot::Contact.get_contacts
 
-TODO: Write usage instructions here
+# Delete a contact
+EasyHubspot::Contact.delete_contact(123)
+# or 
+EasyHubspot::Contact.delete_contact('test@gmail.com')
+```
 
 ## Development
 
@@ -28,7 +65,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/easy_hubspot.
+Bug reports and pull requests are welcome on GitHub at https://github.com/oroth8/easy_hubspot.
 
 ## License
 

data/config/initializers/easy_hubspot.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+EasyHubspot.config do |c|
+  c.access_token = 'YOUR API KEY'
+  c.base_url = 'https://api.hubapi.com/'
+end

data/easy_hubspot.gemspec

@@ -36,11 +36,11 @@ Gem::Specification.new do |spec|
 
   # development dependencies
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'capybara', '~> 2.7'
+  spec.add_development_dependency 'capybara', '~> 3.36'
   spec.add_development_dependency 'generator_spec', '~> 0.9.4'
-  spec.add_development_dependency 'pry', '~> 0.13.1'
+  spec.add_development_dependency 'pry', '~> 0.14.2'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.4.0'
+  spec.add_development_dependency 'rspec', '~> 3.12.0'
   spec.add_development_dependency 'rubocop', '~> 1.2'
   spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
   spec.add_development_dependency 'rubocop-rspec', '~> 2.18.1'

data/lib/easy_hubspot/client.rb

@@ -4,44 +4,28 @@ module EasyHubspot
   # EasyHubspot::Client
   class Client
     class << self
-      def do_get(path = nil, headers = {}, format_plain: true)
-        if format_plain
-          response = HTTParty.get("#{EasyHubspot.configuration.base_url}#{path}", headers: headers,
-                                                                                  format: :plain)
-          parse_response(response)
-        else
-          HTTParty.get("#{EasyHubspot.configuration.base_url}#{path}", headers: headers)
-        end
+      def do_get(path = nil, headers = {})
+        response = HTTParty.get("#{EasyHubspot.configuration.base_url}#{path}", headers: headers,
+                                                                                format: :plain)
+        parse_response(response)
       end
 
-      def do_post(path = nil, body = {}, headers = {}, format_plain: true)
-        if format_plain
-          response = HTTParty.post("#{EasyHubspot.configuration.base_url}#{path}", body: body, headers: headers,
-                                                                                   format: :plain)
-          parse_response(response)
-        else
-          HTTParty.post("#{EasyHubspot.configuration.base_url}#{path}", body: body, headers: headers)
-        end
+      def do_post(path = nil, body = {}, headers = {})
+        response = HTTParty.post("#{EasyHubspot.configuration.base_url}#{path}", body: body, headers: headers,
+                                                                                 format: :plain)
+        parse_response(response)
       end
 
-      def do_patch(path = nil, body = {}, headers = {}, format_plain: true)
-        if format_plain
-          response = HTTParty.patch("#{EasyHubspot.configuration.base_url}#{path}", body: body, headers: headers,
-                                                                                    format: :plain)
-          parse_response(response)
-        else
-          HTTParty.patch("#{EasyHubspot.configuration.base_url}#{path}", body: body, headers: headers)
-        end
+      def do_patch(path = nil, body = {}, headers = {})
+        response = HTTParty.patch("#{EasyHubspot.configuration.base_url}#{path}", body: body, headers: headers,
+                                                                                  format: :plain)
+        parse_response(response)
       end
 
-      def do_delete(path = nil, headers = {}, format_plain: true)
-        if format_plain
-          response = HTTParty.delete("#{EasyHubspot.configuration.base_url}#{path}", headers: headers,
-                                                                                     format: :plain)
-          parse_response(response)
-        else
-          HTTParty.delete("#{EasyHubspot.configuration.base_url}#{path}", headers: headers)
-        end
+      def do_delete(path = nil, headers = {})
+        response = HTTParty.delete("#{EasyHubspot.configuration.base_url}#{path}", headers: headers,
+                                                                                   format: :plain)
+        parse_response(response)
       end
 
       private
@@ -49,7 +33,10 @@ module EasyHubspot
       def parse_response(res)
         return if res.body.nil?
 
-        JSON.parse res, symbolize_names: true
+        parsed_res = JSON.parse res, symbolize_names: true
+        raise EasyHubspot::HubspotApiError, parsed_res[:message] if parsed_res[:status] == 'error'
+
+        parsed_res
       end
     end
   end

data/lib/easy_hubspot/exceptions.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module EasyHubspot
+  class Error < StandardError; end
+  class HubspotApiError < Error; end
+end

data/lib/easy_hubspot/generators/install_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module EasyHubspot
+  module Generators
+    # InstallGenerator
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+      desc 'This generator creates an initializer file at config/initializers'
+      def copy_initializer
+        copy_file 'easy_hubspot.rb', 'config/initializers/easy_hubspot.rb'
+      end
+    end
+  end
+end

data/lib/easy_hubspot/generators/templates/easy_hubspot.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+EasyHubspot.config do |c|
+  c.access_token = 'YOUR API KEY'
+  c.base_url = 'https://api.hubapi.com/'
+end

data/lib/easy_hubspot/version.rb

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

data/lib/easy_hubspot.rb

@@ -5,6 +5,7 @@ require 'easy_hubspot/client'
 require 'easy_hubspot/contact'
 require 'easy_hubspot/version'
 require 'easy_hubspot/generators/install_generator'
+require 'easy_hubspot/exceptions'
 
 require 'httparty'
 require 'json'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_hubspot
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - Owen Roth
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '3.36'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '3.36'
 - !ruby/object:Gem::Dependency
   name: generator_spec
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 0.14.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 0.14.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -178,11 +178,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- config/initializers/easy_hubspot.rb
 - easy_hubspot.gemspec
 - lib/easy_hubspot.rb
 - lib/easy_hubspot/base.rb
 - lib/easy_hubspot/client.rb
 - lib/easy_hubspot/contact.rb
+- lib/easy_hubspot/exceptions.rb
+- lib/easy_hubspot/generators/install_generator.rb
+- lib/easy_hubspot/generators/templates/easy_hubspot.rb
 - lib/easy_hubspot/version.rb
 - sig/easy_hubspot.rbs
 homepage: https://github.com/oroth8/easy-hubspot