pardot_wrapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d87fb77d4119b3f4bf43abc2faeb4b567f01c0afdb380e46a9b154b620290275
+  data.tar.gz: 3254dc23d7820b5d52eede080435a5ed2f7b09f5152506bdec3368bb67fdecde
+SHA512:
+  metadata.gz: 8c75eacea8acf6ac59c014b366664425feb43cfd68db19f0137496c09eb06a79513f3c288a2abbc5da083fe259ad5904f5fbc2bcb8da5dfe89062617b244049b
+  data.tar.gz: 27fc5f383b0dc30127a45b863f115a5c5bfdb06264abf21ab6f2fe17aa0879c6dd1b6969b622073cb866b67e425a863328e2db29336ee13fdbac3b1c00703463

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/README.md

@@ -0,0 +1,88 @@
+# PardotWrapper Gem
+
+## Description
+
+`PardotWrapper` is a Ruby gem designed to simplify interactions with the Pardot API version 5. This gem provides a straightforward and efficient way to integrate Pardot's functionalities into Ruby applications, offering basic functionalities such as listing custom fields, viewing account information, creating prospects, and managing list memberships.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pardot_wrapper'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install pardot_wrapper
+```
+
+## Usage
+
+To start using PardotWrapper, configure the client with your OAuth credentials:
+
+```ruby
+client = PardotWrapper.new(access_token, refresh_token, client_id, client_secret)
+```
+
+## Available Methods
+
+- List Custom Fields
+```ruby
+client.list_custom_fields
+
+```
+
+- View Account information
+```ruby
+client.get_account
+
+```
+
+- Create Prospect
+```ruby
+client.create_prospect(email, additional_params)
+
+```
+
+- Create List Membership
+```ruby
+client.create_prospect(email, additional_params)
+
+```
+
+## Handling Expired Tokens
+PardotWrapper handles the renewal of the access token automatically using the provided refresh_token.
+
+
+## Configuration
+
+For setting up the gem in a Rails environment, you might consider placing the initialization inside an initializer, such as config/initializers/pardot_wrapper.rb.
+
+## Tests
+
+The gem includes a suite of unit tests using RSpec. To run the tests, execute:
+
+```bash
+bundle exec rspec
+```
+
+## Contributions
+
+Contributions to PardotWrapper are welcome! To contribute:
+
+1. Fork the project.
+2. Create a feature branch (git checkout -b my-new-feature).
+3. Commit your changes (git commit -am 'Add some feature').
+4. Push to the branch (git push origin my-new-feature).
+5. Create a new Pull Request.
+
+## License
+This gem is available under the MIT License. See the LICENSE file for more details.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/pardot/client.rb

@@ -0,0 +1,86 @@
+module Pardot
+  class Client
+    include HTTParty
+
+    BASE_URIS = {
+      production: 'https://pi.pardot.com/api/v5/objects',
+      demo: 'https://pi.demo.pardot.com/api/v5/objects',
+      login: 'https://login.salesforce.com'
+    }
+
+    def initialize(access_token, refresh_token, client_id, client_secret, pardot_business_unit_id, environment = :production)
+      @access_token = access_token
+      @refresh_token = refresh_token
+      @client_id = client_id
+      @client_secret = client_secret
+      @pardot_business_unit_id = pardot_business_unit_id
+      @token_refreshed = false
+      @environment = environment
+
+      self.class.base_uri BASE_URIS[environment]
+    end
+
+    def list_custom_fields
+      perform_request { self.class.get('/customFields', headers: auth_headers) }
+    end
+
+    def get_account
+      perform_request { self.class.get('/account?fields=id,company,website', headers: auth_headers) }
+    end
+
+    def create_prospect(email, params = {})
+      query = params.merge({ email: email })
+      perform_request { self.class.post('/prospects', body: query.to_json, headers: auth_headers) }
+    end
+
+    def create_list_membership(prospect_id, list_id)
+      query = { prospect_id: prospect_id, list_id: list_id }
+      perform_request { self.class.post('/listMemberships', body: query.to_json, headers: auth_headers) }
+    end
+
+    private
+
+    def auth_headers
+      {
+        "Authorization" => "Bearer #{@access_token}",
+        "Pardot-Business-Unit-Id" => @pardot_business_unit_id,
+        "Content-Type" => "application/json"
+      }
+    end
+
+    def refresh_access_token
+      self.class.base_uri BASE_URIS[:login]
+
+      response = self.class.post('/services/oauth2/token', {
+        body: {
+          grant_type: 'refresh_token',
+          refresh_token: @refresh_token,
+          client_id: @client_id,
+          client_secret: @client_secret
+        }
+      })
+
+      self.class.base_uri BASE_URIS[@environment]
+
+      if response.success?
+        @access_token = response['access_token']
+        @token_refreshed = false
+      else
+        raise "Failed to refresh access token: #{response.body}"
+      end
+    end
+
+    def perform_request
+      response = yield
+
+      if response.code == 401
+        refresh_access_token
+        response = yield
+      end
+
+      raise "API request failed: #{response.body}" unless response.success?
+
+      response
+    end
+  end
+end

data/lib/pardot/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pardot
+  VERSION = "0.1.0"
+end

data/lib/pardot_wrapper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+require_relative "pardot/version"
+require_relative "pardot/client"

data/pardot_wrapper.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/pardot/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "pardot_wrapper"
+  spec.version = Pardot::VERSION
+  spec.authors = ["DougPetronilio"]
+  spec.email = ["dougpetronilio@gmail.com"]
+
+  spec.summary = "Pardot Wrapper Api v5"
+  spec.description = "A gem PardotWrapper é uma biblioteca Ruby projetada para simplificar a interação com a API do Pardot, especificamente com a versão 5. Ela oferece uma interface clara e objetiva para realizar operações comuns, como visualizar informações de conta, criar prospects e gerenciar associações de listas. Esta gem abstrai as complexidades das chamadas de API e do tratamento de dados, permitindo que os desenvolvedores se concentrem na lógica de negócios principal de suas aplicações."
+
+  spec.homepage = "https://github.com/dougpetronilio/pardot_wrapper"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/dougpetronilio/pardot_wrapper"
+  spec.metadata["changelog_uri"] = "https://github.com/dougpetronilio/pardot_wrapper"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  spec.add_dependency "httparty"
+
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'webmock', '~> 3.0'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/pardot_wrapper.rbs

@@ -0,0 +1,4 @@
+module PardotWrapper
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: pardot_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- DougPetronilio
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A gem PardotWrapper é uma biblioteca Ruby projetada para simplificar
+  a interação com a API do Pardot, especificamente com a versão 5. Ela oferece uma
+  interface clara e objetiva para realizar operações comuns, como visualizar informações
+  de conta, criar prospects e gerenciar associações de listas. Esta gem abstrai as
+  complexidades das chamadas de API e do tratamento de dados, permitindo que os desenvolvedores
+  se concentrem na lógica de negócios principal de suas aplicações.
+email:
+- dougpetronilio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- README.md
+- Rakefile
+- lib/pardot/client.rb
+- lib/pardot/version.rb
+- lib/pardot_wrapper.rb
+- pardot_wrapper.gemspec
+- sig/pardot_wrapper.rbs
+homepage: https://github.com/dougpetronilio/pardot_wrapper
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/dougpetronilio/pardot_wrapper
+  source_code_uri: https://github.com/dougpetronilio/pardot_wrapper
+  changelog_uri: https://github.com/dougpetronilio/pardot_wrapper
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Pardot Wrapper Api v5
+test_files: []