sendgrid-object 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e19a523dcdbc5c6efe82406745c1b994ee713ca154f51da85e324c3d22201db1
+  data.tar.gz: 14ac6f2d33bc077f99e389e81555d80655cbcedb5240528982ad317f9c0be819
+SHA512:
+  metadata.gz: a0e2c5ed76f84a0b5433d4863a9266af68275536bf311b069543a34de9734e225421ca2b87185b79a17defac6b07a9cab8b9091898767f6eeb9d8346c49ecc70
+  data.tar.gz: a1f740f02b68a1b6444e132e06c54b4a1f4b7ab72f7bab372ec67f494debf953a0973ac571e04d5ddd61209f4d17e1aef345e8330948ea0fc08c6e7f8e43cb8b

data/.gitignore

@@ -0,0 +1,22 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.idea/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.4
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at technique@immateriel.fr. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sendgrid-object.gemspec
+gemspec
+
+gem 'sendgrid-ruby', "~> 6.6.1"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,121 @@
+# Sendgrid::Object
+
+This gem provide classes for an easy use of the [sendrig-ruby](https://github.com/sendgrid/sendgrid-ruby) official gem.
+
+## Prerequisites
+
+Ruby version >= 2.4 (except version [2.6.0](https://github.com/sendgrid/sendgrid-ruby/blob/main/TROUBLESHOOTING.md#ruby-versions))
+
+## Setup Environment Variables
+
+Update the development environment with your SENDGRID_API_KEY, for example:
+
+```
+echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
+echo "sendgrid.env" >> .gitignore
+source ./sendgrid.env
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sendgrid-object'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sendgrid-object
+
+## Quick start
+
+### Find a recipient
+
+```
+recipient = Sendgrid::Recipient.new()
+recipient.find_by("email", "john@doe.com")
+=> {"id"=>"ID", "email"=>"john@doe.com", "created_at"=>TIMESTAMP, "updated_at"=>TIMESTAMP, "last_emailed"=>TIMESTAMP, "last_clicked"=>TIMESTAMP, "last_opened"=>TIMESTAMP, "first_name"=>"John", "last_name"=>"Doe"} 
+unless recipient.errors
+    puts recipient.id
+    puts recipient.email
+    puts recipient.first_name
+    puts recipient.last_name
+end
+```
+
+### Create a recipient
+
+```
+recipient = Sendgrid::Recipient.new()
+recipient.create({ email: "jane@doe.com" })
+=> "ID"
+unless recipient.errors
+    puts recipient.id
+    puts recipient.email
+    puts recipient.first_name
+    puts recipient.last_name
+end
+```
+
+### Add a recipient to an existing list
+
+```
+recipient = Sendgrid::Recipient.new()
+recipient.find_by("email", "john@doe.com")
+list = Sendgrid::List.new()
+list.add_recipient(recipient.id, ID_OF_THE_LIST)
+=> nil
+unless list.errors
+    puts "User successfully added."
+end
+```
+
+OR
+
+```
+recipient = Sendgrid::Recipient.new()
+recipient.find_by("email", "john@doe.com")
+list = Sendgrid::List.new()
+sendgrid_list.find(ID_OF_THE_LIST)
+=> {"id"=>ID_OF_THE_LIST, "name"=>"NAME", "recipient_count"=>NB} 
+list.add_recipient(recipient.id)
+=> nil
+puts "User successfully added." unless list.errors
+```
+
+### Destroy a recipient
+
+```
+recipient = Sendgrid::Recipient.new()
+recipient.find_by("email", "john@doe.com")
+=> {"id"=>"ID", "email"=>"john@doe.com", "created_at"=>TIMESTAMP, "updated_at"=>TIMESTAMP, "last_emailed"=>TIMESTAMP, "last_clicked"=>TIMESTAMP, "last_opened"=>TIMESTAMP, "first_name"=>"John", "last_name"=>"Doe"} 
+unless recipient.errors
+    recipient.destroy
+    puts "User successfully destroyed." unless recipient.errors
+end
+```
+
+OR
+
+```
+recipient = Sendgrid::Recipient.new()
+recipient.destroy("ID")
+puts "User successfully destroyed." unless recipient.errors
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/immateriel/sendgrid-object. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/sendgrid-object/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sendgrid::Object project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sendgrid-object/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sendgrid/object"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sendgrid/list.rb

@@ -0,0 +1,52 @@
+class Sendgrid::List
+  attr_reader :id, :recipient_count, :errors
+  attr_accessor :name
+
+  def initialize(data = {})
+    @api = ::SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+    @errors = nil
+    reset_properties
+    @name ||= data["name"]
+  end
+
+  # find a list
+  # @param [Integer] id of the list
+  # @return [Hash, nil]
+  def find(id)
+    list = nil
+    response = @api.client.contactdb.lists._(id).get()
+    if response.status_code == "200"
+      list = JSON.parse(response.body)
+      @id = list["id"]
+      @name = list["name"]
+      @recipient_count = list["recipient_count"]
+    else
+      reset_properties
+      @errors = { status: response.status_code, body: JSON.parse(response.body)["errors"] }
+    end
+    list
+  end
+
+  # Add a user to a list
+  # @param [Integer] id of the user
+  # @param [Integer, nil] id of the list
+  # @return [void]
+  def add_recipient(recipient_id, list_id = nil)
+    if recipient_id && (list_id || @id)
+      list_id ||= @id
+      response = @api.client.contactdb.lists._(list_id).recipients._(recipient_id).post()
+      if response.status_code != "201"
+        @errors = { status: response.status_code, body: JSON.parse(response.body)["errors"] }
+      end
+    end
+    nil
+  end
+
+  private
+
+    def reset_properties
+      @id = nil
+      @name = nil
+      @recipient_count = nil
+    end
+end

data/lib/sendgrid/recipient.rb

@@ -0,0 +1,90 @@
+class Sendgrid::Recipient
+  attr_reader :id, :errors
+  attr_accessor :email, :first_name, :last_name
+
+  def initialize
+    @api = ::SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+    @errors = nil
+    reset_properties
+  end
+
+  # find a single user
+  # @param [String] field name
+  # @param [String] field value
+  # @return [Hash, nil]
+  def find_by(field, value)
+    user = nil
+    data = { conditions: [{ and_or: "", field: field, value: value, operator: "eq" }] }
+    response = @api.client.contactdb.recipients.search.post(request_body: data)
+    if response.status_code == "200"
+      @errors = nil
+      user = JSON.parse(response.body)["recipients"]&.first
+      if user
+        @id = user["id"]
+        @email = user["email"]
+        @first_name = user["first_name"]
+        @last_name = user["last_name"]
+      end
+    else
+      reset_properties
+      @errors = { status: response.status_code, body: JSON.parse(response.body)["errors"] }
+    end
+    user
+  end
+
+  # Create a user and return the id
+  # @param [Hash] email
+  # @return [String, void] user id
+  def create(data)
+    if !data || !data.is_a?(Hash) || data[:email].nil? || data[:email].empty?
+      reset_properties
+      if data.nil? || !data.is_a?(Hash)
+        @errors = { status: "400", body: [{ "message" => "request body is invalid" }] }
+      else
+        @errors = { status: "400", body: [{ "message" => "Type of provided email is invalid, email must be a non empty string" }] }
+      end
+    else
+      return @id if @id && @email == data[:email]
+      self.find_by("email", data[:email])
+      if @id.nil?
+        @errors = nil
+        request_data = [data]
+        response = @api.client.contactdb.recipients.post(request_body: request_data)
+        if response.status_code == "201"
+          @id = JSON.parse(response.body)["persisted_recipients"]&.first
+          @email = data[:email] if data[:email]
+          @first_name = data[:first_name] if data[:first_name]
+          @last_name = data[:last_name] if data[:last_name]
+        else
+          reset_properties
+          @errors = { status: response.status_code, body: JSON.parse(response.body)["errors"] }
+        end
+      end
+    end
+    @id
+  end
+
+  # Destroy an existing user
+  # @param [Integer, nil] id of the recipient
+  # @return [void]
+  def destroy(recipient_id = nil)
+    recipient_id ||= @id
+    response = @api.client.contactdb.recipients._(recipient_id).delete()
+    reset_properties
+    if response.status_code == "204"
+      @errors = nil
+    else
+      @errors = { status: response.status_code, body: JSON.parse(response.body)["errors"] }
+    end
+    nil
+  end
+
+  private
+
+  def reset_properties
+    @id = nil
+    @email = nil
+    @first_name = nil
+    @last_name = nil
+  end
+end

data/lib/sendgrid/version.rb

@@ -0,0 +1,3 @@
+module Sendgrid
+  VERSION = "1.0.1"
+end

data/lib/sendgrid-object.rb

@@ -0,0 +1,5 @@
+require 'sendgrid-ruby'
+
+require_relative 'sendgrid'
+require_relative 'sendgrid/recipient'
+require_relative 'sendgrid/list'

data/lib/sendgrid.rb

@@ -0,0 +1,2 @@
+module Sendgrid
+end

data/sendgrid-object.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sendgrid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sendgrid-object"
+  spec.version       = Sendgrid::VERSION
+  spec.authors       = ["Elodie Ailleaume"]
+  spec.email         = ["elodie@immateriel.fr"]
+
+  spec.summary       = %q{OOP use of the sendgrid API}
+  spec.description   = %q{OOP use of the sendgrid API}
+  spec.homepage      = "https://github.com/immateriel/sendgrid-object"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'sendgrid-ruby', "~> 6.6.1"
+
+  spec.add_development_dependency 'rspec', "~> 3.11"
+  spec.add_development_dependency 'webmock', "~> 3.14.0"
+end

data/spec/sendgrid/list_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+
+RSpec.describe Sendgrid::List do
+
+  describe "initialize" do
+    it "loads a new list object" do
+      sendgrid_list = Sendgrid::List.new()
+      expect { sendgrid_list.api }.to raise_error(NoMethodError)
+      expect(sendgrid_list.id).to be_nil
+      expect(sendgrid_list.name).to be_nil
+      expect(sendgrid_list.recipient_count).to be_nil
+    end
+  end
+
+  describe "find" do
+    it "retrieves a list by its id" do
+      sendgrid_list = Sendgrid::List.new()
+      ret = sendgrid_list.find(rand(1..40))
+      expect(ret).to be_a_kind_of(Hash)
+      expect(sendgrid_list.id).to be_a_kind_of(Integer)
+      expect(sendgrid_list.name).to be_a_kind_of(String)
+      expect(sendgrid_list.recipient_count).to be_a_kind_of(Integer)
+      expect(sendgrid_list.errors).to be_nil
+    end
+
+    it "returns an error with a non-existent id" do
+      sendgrid_list = Sendgrid::List.new()
+      ret = sendgrid_list.find(404) # The id 404 is used to test the not found case
+      expect(ret).to be_nil
+      expect(sendgrid_list.errors[:status]).to eq("404")
+      expect(sendgrid_list.errors[:body]).to eq([{ "message" => "List ID does not exist" }])
+      expect(sendgrid_list.id).to be_nil
+      expect(sendgrid_list.name).to be_nil
+      expect(sendgrid_list.recipient_count).to be_nil
+    end
+
+    it "returns an error with a badly formatted id" do
+      sendgrid_list = Sendgrid::List.new()
+      ret = sendgrid_list.find("Anything")
+      expect(ret).to be_nil
+      expect(sendgrid_list.errors[:status]).to eq("400")
+      expect(sendgrid_list.errors[:body]).to eq([{ "message" => "invalid ID" }])
+      expect(sendgrid_list.id).to be_nil
+      expect(sendgrid_list.name).to be_nil
+      expect(sendgrid_list.recipient_count).to be_nil
+    end
+  end
+
+  describe "add_recipient" do
+    it "adds the recipient to the list with his id" do
+      sendgrid_recipient = Sendgrid::Recipient.new()
+      sendgrid_recipient.find_by("email", "john@doe.com")
+      sendgrid_list = Sendgrid::List.new()
+      ret = sendgrid_list.add_recipient(sendgrid_recipient.id, 12846200)
+      expect(ret).to be_nil
+      expect(sendgrid_list.errors).to be_nil
+      expect(sendgrid_list.id).to be_nil
+    end
+
+    it "returns an error with a non-existent list id" do
+      recipient = Sendgrid::Recipient.new()
+      recipient.find_by("email", "john@doe.com")
+
+      sendgrid_list = Sendgrid::List.new()
+      ret = sendgrid_list.add_recipient(recipient.id, 404)
+      expect(ret).to be_nil
+      expect(sendgrid_list.errors[:status]).to eq("404")
+      expect(sendgrid_list.errors[:body]).to eq([{ "message" => "List ID does not exist" }])
+    end
+  end
+end

data/spec/sendgrid/recipent_spec.rb

@@ -0,0 +1,149 @@
+RSpec.describe Sendgrid::Recipient do
+  describe "initialize" do
+    it "loads a new recipient object" do
+      sendgrid_recipient = Sendgrid::Recipient.new()
+      expect { sendgrid_recipient.api }.to raise_error(NoMethodError)
+      expect(sendgrid_recipient.email).to be_nil
+    end
+  end
+
+  describe "find_by" do
+    it "returns the recipient" do
+      sendgrid_recipient = Sendgrid::Recipient.new()
+      ret = sendgrid_recipient.find_by("email", "john@doe.com")
+      expect(ret).to be_a_kind_of(Hash)
+      expect(ret["email"]).to eq("john@doe.com")
+      expect(sendgrid_recipient.id).to be_a_kind_of(String)
+      expect(sendgrid_recipient.email).to be_a_kind_of(String)
+      expect(sendgrid_recipient.email).to eq("john@doe.com")
+      expect(sendgrid_recipient.first_name).to be_a_kind_of(String)
+      expect(sendgrid_recipient.last_name).to be_a_kind_of(String)
+      expect(sendgrid_recipient.errors).to be_nil
+    end
+
+    it "returns an error for a non-existent field searched" do
+      sendgrid_recipient = Sendgrid::Recipient.new()
+      ret = sendgrid_recipient.find_by("name", "Doe")
+      expect(ret).to be_nil
+      expect(sendgrid_recipient.errors[:status]).to eq("400")
+      expect(sendgrid_recipient.errors[:body]).to eq([{ "message" => "Field does not exist" }])
+      expect(sendgrid_recipient.id).to be_nil
+      expect(sendgrid_recipient.email).to be_nil
+      expect(sendgrid_recipient.first_name).to be_nil
+      expect(sendgrid_recipient.last_name).to be_nil
+    end
+
+    it "returns an empty result for a not found user" do
+      sendgrid_recipient = Sendgrid::Recipient.new()
+      ret = sendgrid_recipient.find_by("email", "jane@doe.com")
+      expect(ret).to be_nil
+      expect(sendgrid_recipient.errors).to be_nil
+      expect(sendgrid_recipient.id).to be_nil
+      expect(sendgrid_recipient.email).to be_nil
+      expect(sendgrid_recipient.first_name).to be_nil
+      expect(sendgrid_recipient.last_name).to be_nil
+    end
+
+    it "returns an empty result for a not found user with badly formatted email" do
+      sendgrid_recipient = Sendgrid::Recipient.new()
+      ret = sendgrid_recipient.find_by("email", "jane.doe.com")
+      expect(ret).to be_nil
+      expect(sendgrid_recipient.errors).to be_nil
+      expect(sendgrid_recipient.id).to be_nil
+      expect(sendgrid_recipient.email).to be_nil
+      expect(sendgrid_recipient.first_name).to be_nil
+      expect(sendgrid_recipient.last_name).to be_nil
+    end
+  end
+
+  describe "create" do
+    it "creates a user with only an email" do
+      sendgrid_recipient = Sendgrid::Recipient.new()
+      ret = sendgrid_recipient.create({ email: "jane@doe.com" })
+      expect(ret).to be_a_kind_of(String)
+      expect(sendgrid_recipient.id).to be_a_kind_of(String)
+      expect(sendgrid_recipient.email).to eq("jane@doe.com")
+      expect(sendgrid_recipient.first_name).to be_nil
+      expect(sendgrid_recipient.last_name).to be_nil
+      expect(sendgrid_recipient.errors).to be_nil
+    end
+
+    it "returns an error with nil data" do
+      sendgrid_recipient = Sendgrid::Recipient.new()
+      ret = sendgrid_recipient.create(nil)
+      expect(ret).to be_nil
+      expect(sendgrid_recipient.id).to be_nil
+      expect(sendgrid_recipient.email).to be_nil
+      expect(sendgrid_recipient.first_name).to be_nil
+      expect(sendgrid_recipient.last_name).to be_nil
+      expect(sendgrid_recipient.errors).to be_a_kind_of(Hash)
+      expect(sendgrid_recipient.errors[:status]).to eq("400")
+      expect(sendgrid_recipient.errors[:body]).to eq([{ "message" => "request body is invalid" }])
+    end
+
+    it "returns an error without an email" do
+      sendgrid_recipient = Sendgrid::Recipient.new()
+      ret = sendgrid_recipient.create({ name: "Jane Doe" })
+      expect(ret).to be_nil
+      expect(sendgrid_recipient.id).to be_nil
+      expect(sendgrid_recipient.email).to be_nil
+      expect(sendgrid_recipient.first_name).to be_nil
+      expect(sendgrid_recipient.last_name).to be_nil
+      expect(sendgrid_recipient.errors).to be_a_kind_of(Hash)
+      expect(sendgrid_recipient.errors[:status]).to eq("400")
+      expect(sendgrid_recipient.errors[:body]).to eq([{ "message" => "Type of provided email is invalid, email must be a non empty string" }])
+    end
+  end
+
+  describe "destroy" do
+    it "deletes the user" do
+      sendgrid_recipient = Sendgrid::Recipient.new()
+      sendgrid_recipient.find_by("email", "john@doe.com")
+      ret = sendgrid_recipient.destroy
+      expect(ret).to be_nil
+      expect(sendgrid_recipient.errors).to be_nil
+      expect(sendgrid_recipient.id).to be_nil
+      expect(sendgrid_recipient.email).to be_nil
+      expect(sendgrid_recipient.first_name).to be_nil
+      expect(sendgrid_recipient.last_name).to be_nil
+    end
+
+    it "does not returns an error with a non-existent user" do
+      sendgrid_recipient = Sendgrid::Recipient.new()
+      ret = sendgrid_recipient.destroy("Anything")
+      expect(ret).to be_nil
+      expect(sendgrid_recipient.errors).to be_nil
+      expect(sendgrid_recipient.id).to be_nil
+      expect(sendgrid_recipient.email).to be_nil
+      expect(sendgrid_recipient.first_name).to be_nil
+      expect(sendgrid_recipient.last_name).to be_nil
+    end
+
+    it "returns an error with an invalid id" do
+      sendgrid_recipient = Sendgrid::Recipient.new()
+      ret = sendgrid_recipient.destroy(400)
+      expect(ret).to be_nil
+      expect(sendgrid_recipient.errors).to be_a_kind_of(Hash)
+      expect(sendgrid_recipient.errors[:status]).to eq("400")
+      expect(sendgrid_recipient.errors[:body]).to eq([{ "message" => "invalid ID" }])
+      expect(sendgrid_recipient.id).to be_nil
+      expect(sendgrid_recipient.email).to be_nil
+      expect(sendgrid_recipient.first_name).to be_nil
+      expect(sendgrid_recipient.last_name).to be_nil
+    end
+
+    it "returns an error with a nil id" do
+      sendgrid_recipient = Sendgrid::Recipient.new()
+      # sendgrid_recipient.find_by("email", "jane@doe.com")
+      ret = sendgrid_recipient.destroy
+      expect(ret).to be_nil
+      expect(sendgrid_recipient.errors).to be_a_kind_of(Hash)
+      expect(sendgrid_recipient.errors[:status]).to eq("400")
+      expect(sendgrid_recipient.errors[:body]).to eq([{ "message" => "request body is invalid" }])
+      expect(sendgrid_recipient.id).to be_nil
+      expect(sendgrid_recipient.email).to be_nil
+      expect(sendgrid_recipient.first_name).to be_nil
+      expect(sendgrid_recipient.last_name).to be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,126 @@
+require "bundler/setup"
+require "sendgrid-object"
+require 'webmock/rspec'
+
+ENV['SENDGRID_API_KEY']="ThisIsAFakeKey"
+
+RSpec.configure do |config|
+
+  # Used to stub the API calls
+  config.before(:each) do
+
+    headers = {
+      'Accept'=>'application/json',
+      'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+      'Authorization'=>"Bearer #{ENV['SENDGRID_API_KEY']}",
+      'Content-Type'=>'application/json',
+      'User-Agent'=>'sendgrid/6.6.1;ruby'
+    }
+    headers_without_content_type = {
+      'Accept'=>'application/json',
+      'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+      'Authorization'=>"Bearer #{ENV['SENDGRID_API_KEY']}",
+      'User-Agent'=>'sendgrid/6.6.1;ruby'
+    }
+
+    # Sendgrid::List
+    list_found_response = {
+      id: rand(1..40),
+      name: "Anything",
+      recipient_count: rand(1..40)
+    }
+    list_not_found_response = {
+      errors: [ message: "List ID does not exist" ]
+    }
+    invalid_id_response = {
+      errors: [ message: "invalid ID" ]
+    }
+    stub_request(:get, /https:\/\/api.sendgrid.com\/v\d\/contactdb\/lists\/(?!404$)\d+$/).
+      to_return(status: 200, body: list_found_response.to_json, headers: {})
+
+    stub_request(:get, /https:\/\/api.sendgrid.com\/v\d\/contactdb\/lists\/404$/).
+      to_return(status: 404, body: list_not_found_response.to_json, headers: {})
+
+    stub_request(:get, /https:\/\/api.sendgrid.com\/v\d\/contactdb\/lists\/(?!404$)\D+$/).
+      to_return(status: 400, body: invalid_id_response.to_json, headers: {})
+
+    # Sendgrid::Recipient
+    recipient_found_response = {
+      recipient_count: 1,
+      recipients: [
+        { id: "Anything",
+          email: "john@doe.com",
+          first_name: "John",
+          last_name: "Doe" }
+      ]
+    }
+    recipient_not_found_response = {
+      recipient_count: 0,
+      recipients: []
+    }
+    not_existing_field_response = {
+      errors: [ message: "Field does not exist" ]
+    }
+    request_body_invalid_response = {
+      errors: [ message: "request body is invalid" ]
+    }
+    created_recipient_response = { new_count: 1, updated_count: 0, error_count: 0, error_indices: [],
+                                   unmodified_indices: [], persisted_recipients: ["Anything"], errors: []}
+    stub_request(:post, "https://api.sendgrid.com/v3/contactdb/recipients/search").
+      with(
+        body: "{\"conditions\":[{\"and_or\":\"\",\"field\":\"email\",\"value\":\"john@doe.com\",\"operator\":\"eq\"}]}",
+        headers: headers).
+      to_return(status: 200, body: recipient_found_response.to_json, headers: {})
+    stub_request(:post, "https://api.sendgrid.com/v3/contactdb/recipients/search").
+      with(
+        body: "{\"conditions\":[{\"and_or\":\"\",\"field\":\"name\",\"value\":\"Doe\",\"operator\":\"eq\"}]}",
+        headers: headers).
+      to_return(status: 400, body: not_existing_field_response.to_json, headers: {})
+    stub_request(:post, "https://api.sendgrid.com/v3/contactdb/recipients/search").
+      with(
+        body: "{\"conditions\":[{\"and_or\":\"\",\"field\":\"email\",\"value\":\"jane@doe.com\",\"operator\":\"eq\"}]}",
+        headers: headers).
+      to_return(status: 200, body: recipient_not_found_response.to_json, headers: {})
+    stub_request(:post, "https://api.sendgrid.com/v3/contactdb/recipients/search").
+      with(
+        body: "{\"conditions\":[{\"and_or\":\"\",\"field\":\"email\",\"value\":\"jane.doe.com\",\"operator\":\"eq\"}]}",
+        headers: headers).
+      to_return(status: 200, body: recipient_not_found_response.to_json, headers: {})
+    stub_request(:post, "https://api.sendgrid.com/v3/contactdb/recipients").
+      with(
+        body: "[{\"email\":\"jane@doe.com\"}]",
+        headers: headers).
+      to_return(status: 201, body: created_recipient_response.to_json, headers: {})
+    stub_request(:post, "https://api.sendgrid.com/v3/contactdb/lists/12846200/recipients/Anything").
+      with(
+        headers: headers_without_content_type).
+      to_return(status: 201, body: "".to_json, headers: {})
+
+    stub_request(:post, "https://api.sendgrid.com/v3/contactdb/lists/404/recipients/Anything").
+      with(
+        headers: headers_without_content_type).
+      to_return(status: 404, body: list_not_found_response.to_json, headers: {})
+    stub_request(:delete, "https://api.sendgrid.com/v3/contactdb/recipients/Anything").
+      with(
+        headers: headers_without_content_type).
+      to_return(status: 204, body: nil.to_json, headers: {})
+    stub_request(:delete, "https://api.sendgrid.com/v3/contactdb/recipients/400").
+      with(
+        headers: headers_without_content_type).
+      to_return(status: 400, body: invalid_id_response.to_json, headers: {})
+    stub_request(:delete, "https://api.sendgrid.com/v3/contactdb/recipients").
+      with(
+        headers: headers_without_content_type).
+      to_return(status: 400, body: request_body_invalid_response.to_json, headers: {})
+  end
+
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: sendgrid-object
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Elodie Ailleaume
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sendgrid-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.6.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.14.0
+description: OOP use of the sendgrid API
+email:
+- elodie@immateriel.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sendgrid-object.rb
+- lib/sendgrid.rb
+- lib/sendgrid/list.rb
+- lib/sendgrid/recipient.rb
+- lib/sendgrid/version.rb
+- sendgrid-object.gemspec
+- spec/sendgrid/list_spec.rb
+- spec/sendgrid/recipent_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/immateriel/sendgrid-object
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/immateriel/sendgrid-object
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: OOP use of the sendgrid API
+test_files:
+- spec/sendgrid/list_spec.rb
+- spec/sendgrid/recipent_spec.rb
+- spec/spec_helper.rb