mailshake-ruby 0.1.0

data/spec/mailshake/recipients_spec.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Mailshake::Recipients do
+  let(:recipients) { described_class.new(Mailshake.client) }
+  let(:base_url) { "https://api.mailshake.com/2017-04-01" }
+
+  describe "#add" do
+    it "adds recipients to a campaign" do
+      stub_request(:post, "#{base_url}/recipients/add")
+        .with(body: { campaignID: 1, addresses: [{ emailAddress: "john@example.com" }] }.to_json)
+        .to_return(status: 200, body: { statusID: 10 }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = recipients.add(campaign_id: 1, addresses: [{ emailAddress: "john@example.com" }])
+      expect(result["statusID"]).to eq(10)
+    end
+  end
+
+  describe "#add_status" do
+    it "checks add status" do
+      stub_request(:get, "#{base_url}/recipients/add-status")
+        .with(query: { statusID: "10" })
+        .to_return(status: 200, body: { isFinished: true }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = recipients.add_status(status_id: "10")
+      expect(result["isFinished"]).to be true
+    end
+  end
+
+  describe "#list" do
+    it "lists recipients for a campaign" do
+      stub_request(:get, "#{base_url}/recipients/list")
+        .with(query: { campaignID: "1" })
+        .to_return(status: 200, body: { results: [] }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = recipients.list(campaign_id: "1")
+      expect(result["results"]).to eq([])
+    end
+
+    it "passes filter and pagination params" do
+      stub_request(:get, "#{base_url}/recipients/list")
+        .with(query: { campaignID: "1", filter: "active", search: "john", perPage: "25" })
+        .to_return(status: 200, body: { results: [] }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      recipients.list(campaign_id: "1", filter: "active", search: "john", per_page: "25")
+    end
+  end
+
+  describe "#get" do
+    it "gets a recipient by id" do
+      stub_request(:get, "#{base_url}/recipients/get")
+        .with(query: { recipientID: "100" })
+        .to_return(status: 200, body: { id: 100, emailAddress: "john@example.com" }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = recipients.get(recipient_id: "100")
+      expect(result["emailAddress"]).to eq("john@example.com")
+    end
+  end
+
+  describe "#pause" do
+    it "pauses a recipient" do
+      stub_request(:post, "#{base_url}/recipients/pause")
+        .with(body: { campaignID: 1, emailAddress: "john@example.com" }.to_json)
+        .to_return(status: 200, body: {}.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      recipients.pause(campaign_id: 1, email_address: "john@example.com")
+    end
+  end
+
+  describe "#unpause" do
+    it "unpauses a recipient" do
+      stub_request(:post, "#{base_url}/recipients/unpause")
+        .with(body: { campaignID: 1, emailAddress: "john@example.com" }.to_json)
+        .to_return(status: 200, body: {}.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      recipients.unpause(campaign_id: 1, email_address: "john@example.com")
+    end
+  end
+
+  describe "#unsubscribe" do
+    it "unsubscribes email addresses" do
+      stub_request(:post, "#{base_url}/recipients/unsubscribe")
+        .with(body: { emailAddresses: ["john@example.com"] }.to_json)
+        .to_return(status: 200, body: {}.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      recipients.unsubscribe(email_addresses: ["john@example.com"])
+    end
+  end
+end

data/spec/mailshake/senders_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Mailshake::Senders do
+  let(:senders) { described_class.new(Mailshake.client) }
+  let(:base_url) { "https://api.mailshake.com/2017-04-01" }
+
+  describe "#list" do
+    it "lists senders" do
+      stub_request(:get, "#{base_url}/senders/list")
+        .to_return(status: 200, body: { results: [] }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = senders.list
+      expect(result["results"]).to eq([])
+    end
+
+    it "passes search and pagination params" do
+      stub_request(:get, "#{base_url}/senders/list")
+        .with(query: { search: "sales", perPage: "10" })
+        .to_return(status: 200, body: { results: [] }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      senders.list(search: "sales", per_page: "10")
+    end
+  end
+end

data/spec/mailshake/team_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Mailshake::Team do
+  let(:team) { described_class.new(Mailshake.client) }
+  let(:base_url) { "https://api.mailshake.com/2017-04-01" }
+
+  describe "#list_members" do
+    it "lists team members" do
+      stub_request(:get, "#{base_url}/team/list-members")
+        .to_return(status: 200, body: { results: [] }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = team.list_members
+      expect(result["results"]).to eq([])
+    end
+
+    it "passes search and pagination params" do
+      stub_request(:get, "#{base_url}/team/list-members")
+        .with(query: { search: "john", perPage: "10" })
+        .to_return(status: 200, body: { results: [] }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      team.list_members(search: "john", per_page: "10")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "mailshake"
+require "webmock/rspec"
+require "base64"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.filter_run_when_matching :focus
+  config.example_status_persistence_file_path = "spec/examples.txt"
+  config.disable_monkey_patching!
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = "doc"
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.before(:each) do
+    WebMock.disable_net_connect!
+    Mailshake.reset!
+    Mailshake.configure do |c|
+      c.api_key = "test_api_key"
+    end
+  end
+
+  config.after(:each) do
+    WebMock.reset!
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: mailshake-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eduardo Souza
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: base64
+  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: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+description: Ruby gem for integrating with the Mailshake email outreach API. Supports
+  campaigns, recipients, activity tracking, leads, team members, senders, and push
+  webhooks.
+email:
+- eduardo@eduardosouza.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/mailshake.rb
+- lib/mailshake/activity.rb
+- lib/mailshake/base.rb
+- lib/mailshake/campaigns.rb
+- lib/mailshake/client.rb
+- lib/mailshake/configuration.rb
+- lib/mailshake/errors.rb
+- lib/mailshake/leads.rb
+- lib/mailshake/push.rb
+- lib/mailshake/recipients.rb
+- lib/mailshake/senders.rb
+- lib/mailshake/team.rb
+- lib/mailshake/version.rb
+- spec/examples.txt
+- spec/mailshake/activity_spec.rb
+- spec/mailshake/campaigns_spec.rb
+- spec/mailshake/client_spec.rb
+- spec/mailshake/configuration_spec.rb
+- spec/mailshake/leads_spec.rb
+- spec/mailshake/push_spec.rb
+- spec/mailshake/recipients_spec.rb
+- spec/mailshake/senders_spec.rb
+- spec/mailshake/team_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/esouza/mailshake-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/esouza/mailshake-ruby
+  source_code_uri: https://github.com/esouza/mailshake-ruby
+  changelog_uri: https://github.com/esouza/mailshake-ruby/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.21
+signing_key:
+specification_version: 4
+summary: Ruby gem for Mailshake email outreach API integration
+test_files: []