mailshake-ruby 0.1.0

data/lib/mailshake.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'json'
+
+require_relative 'mailshake/version'
+require_relative 'mailshake/errors'
+require_relative 'mailshake/configuration'
+require_relative 'mailshake/client'
+require_relative 'mailshake/base'
+require_relative 'mailshake/campaigns'
+require_relative 'mailshake/recipients'
+require_relative 'mailshake/activity'
+require_relative 'mailshake/leads'
+require_relative 'mailshake/team'
+require_relative 'mailshake/senders'
+require_relative 'mailshake/push'
+
+module Mailshake
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration) if block_given?
+    end
+
+    def client
+      @client ||= Client.new(configuration)
+    end
+
+    def reset!
+      @client = nil
+      @configuration = nil
+    end
+  end
+end

data/spec/examples.txt

@@ -0,0 +1,60 @@
+example_id                                    | status | run_time        |
+--------------------------------------------- | ------ | --------------- |
+./spec/mailshake/activity_spec.rb[1:1:1]      | passed | 0.00026 seconds |
+./spec/mailshake/activity_spec.rb[1:1:2]      | passed | 0.00036 seconds |
+./spec/mailshake/activity_spec.rb[1:2:1]      | passed | 0.00044 seconds |
+./spec/mailshake/activity_spec.rb[1:3:1]      | passed | 0.0004 seconds  |
+./spec/mailshake/activity_spec.rb[1:4:1]      | passed | 0.00051 seconds |
+./spec/mailshake/activity_spec.rb[1:5:1]      | passed | 0.00041 seconds |
+./spec/mailshake/activity_spec.rb[1:6:1]      | passed | 0.00034 seconds |
+./spec/mailshake/activity_spec.rb[1:7:1]      | passed | 0.00039 seconds |
+./spec/mailshake/campaigns_spec.rb[1:1:1]     | passed | 0.00037 seconds |
+./spec/mailshake/campaigns_spec.rb[1:1:2]     | passed | 0.00034 seconds |
+./spec/mailshake/campaigns_spec.rb[1:2:1]     | passed | 0.00033 seconds |
+./spec/mailshake/campaigns_spec.rb[1:3:1]     | passed | 0.00036 seconds |
+./spec/mailshake/campaigns_spec.rb[1:4:1]     | passed | 0.00029 seconds |
+./spec/mailshake/campaigns_spec.rb[1:5:1]     | passed | 0.00029 seconds |
+./spec/mailshake/campaigns_spec.rb[1:6:1]     | passed | 0.00033 seconds |
+./spec/mailshake/campaigns_spec.rb[1:7:1]     | passed | 0.00033 seconds |
+./spec/mailshake/client_spec.rb[1:1:1]        | passed | 0.00031 seconds |
+./spec/mailshake/client_spec.rb[1:1:2:1]      | passed | 0.00054 seconds |
+./spec/mailshake/client_spec.rb[1:2:1]        | passed | 0.00022 seconds |
+./spec/mailshake/client_spec.rb[1:2:2]        | passed | 0.002 seconds   |
+./spec/mailshake/client_spec.rb[1:2:3]        | passed | 0.00041 seconds |
+./spec/mailshake/client_spec.rb[1:2:4]        | passed | 0.00045 seconds |
+./spec/mailshake/client_spec.rb[1:3:1]        | passed | 0.00039 seconds |
+./spec/mailshake/client_spec.rb[1:4:1]        | passed | 0.00029 seconds |
+./spec/mailshake/client_spec.rb[1:5:1]        | passed | 0.00038 seconds |
+./spec/mailshake/client_spec.rb[1:5:2]        | passed | 0.00043 seconds |
+./spec/mailshake/client_spec.rb[1:5:3]        | passed | 0.00038 seconds |
+./spec/mailshake/client_spec.rb[1:5:4]        | passed | 0.00042 seconds |
+./spec/mailshake/client_spec.rb[1:5:5]        | passed | 0.00064 seconds |
+./spec/mailshake/configuration_spec.rb[1:1:1] | passed | 0.00004 seconds |
+./spec/mailshake/configuration_spec.rb[1:1:2] | passed | 0.00004 seconds |
+./spec/mailshake/configuration_spec.rb[1:2:1] | passed | 0.00004 seconds |
+./spec/mailshake/configuration_spec.rb[1:2:2] | passed | 0.00004 seconds |
+./spec/mailshake/configuration_spec.rb[1:2:3] | passed | 0.00005 seconds |
+./spec/mailshake/configuration_spec.rb[1:3:1] | passed | 0.00005 seconds |
+./spec/mailshake/configuration_spec.rb[1:3:2] | passed | 0.00004 seconds |
+./spec/mailshake/leads_spec.rb[1:1:1]         | passed | 0.00037 seconds |
+./spec/mailshake/leads_spec.rb[1:1:2]         | passed | 0.00043 seconds |
+./spec/mailshake/leads_spec.rb[1:2:1]         | passed | 0.00047 seconds |
+./spec/mailshake/leads_spec.rb[1:3:1]         | passed | 0.00039 seconds |
+./spec/mailshake/leads_spec.rb[1:4:1]         | passed | 0.00035 seconds |
+./spec/mailshake/leads_spec.rb[1:5:1]         | passed | 0.00037 seconds |
+./spec/mailshake/leads_spec.rb[1:6:1]         | passed | 0.00041 seconds |
+./spec/mailshake/push_spec.rb[1:1:1]          | passed | 0.00183 seconds |
+./spec/mailshake/push_spec.rb[1:1:2]          | passed | 0.00026 seconds |
+./spec/mailshake/push_spec.rb[1:2:1]          | passed | 0.00032 seconds |
+./spec/mailshake/recipients_spec.rb[1:1:1]    | passed | 0.00035 seconds |
+./spec/mailshake/recipients_spec.rb[1:2:1]    | passed | 0.00074 seconds |
+./spec/mailshake/recipients_spec.rb[1:3:1]    | passed | 0.0005 seconds  |
+./spec/mailshake/recipients_spec.rb[1:3:2]    | passed | 0.00049 seconds |
+./spec/mailshake/recipients_spec.rb[1:4:1]    | passed | 0.00112 seconds |
+./spec/mailshake/recipients_spec.rb[1:5:1]    | passed | 0.01614 seconds |
+./spec/mailshake/recipients_spec.rb[1:6:1]    | passed | 0.00037 seconds |
+./spec/mailshake/recipients_spec.rb[1:7:1]    | passed | 0.00035 seconds |
+./spec/mailshake/senders_spec.rb[1:1:1]       | passed | 0.00027 seconds |
+./spec/mailshake/senders_spec.rb[1:1:2]       | passed | 0.00054 seconds |
+./spec/mailshake/team_spec.rb[1:1:1]          | passed | 0.0003 seconds  |
+./spec/mailshake/team_spec.rb[1:1:2]          | passed | 0.00039 seconds |

data/spec/mailshake/activity_spec.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Mailshake::Activity do
+  let(:activity) { described_class.new(Mailshake.client) }
+  let(:base_url) { "https://api.mailshake.com/2017-04-01" }
+
+  describe "#sent" do
+    it "lists sent messages" do
+      stub_request(:get, "#{base_url}/activity/sent")
+        .to_return(status: 200, body: { results: [] }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = activity.sent
+      expect(result["results"]).to eq([])
+    end
+
+    it "passes campaign and pagination params" do
+      stub_request(:get, "#{base_url}/activity/sent")
+        .with(query: { campaignID: "1", perPage: "50" })
+        .to_return(status: 200, body: { results: [] }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      activity.sent(campaign_id: "1", per_page: "50")
+    end
+  end
+
+  describe "#opens" do
+    it "lists opens" do
+      stub_request(:get, "#{base_url}/activity/opens")
+        .with(query: { campaignID: "1", excludeDuplicates: "true" })
+        .to_return(status: 200, body: { results: [] }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = activity.opens(campaign_id: "1", exclude_duplicates: "true")
+      expect(result["results"]).to eq([])
+    end
+  end
+
+  describe "#clicks" do
+    it "lists clicks" do
+      stub_request(:get, "#{base_url}/activity/clicks")
+        .with(query: { campaignID: "1", matchUrl: "https://example.com" })
+        .to_return(status: 200, body: { results: [] }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      activity.clicks(campaign_id: "1", match_url: "https://example.com")
+    end
+  end
+
+  describe "#replies" do
+    it "lists replies" do
+      stub_request(:get, "#{base_url}/activity/replies")
+        .with(query: { campaignID: "1", replyType: "reply" })
+        .to_return(status: 200, body: { results: [] }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      activity.replies(campaign_id: "1", reply_type: "reply")
+    end
+  end
+
+  describe "#created_leads" do
+    it "lists created leads" do
+      stub_request(:get, "#{base_url}/activity/created-leads")
+        .with(query: { campaignID: "1", since: "2026-01-01" })
+        .to_return(status: 200, body: { results: [] }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      activity.created_leads(campaign_id: "1", since: "2026-01-01")
+    end
+  end
+
+  describe "#lead_assignments" do
+    it "lists lead assignments" do
+      stub_request(:get, "#{base_url}/activity/lead-assignments")
+        .with(query: { campaignID: "1" })
+        .to_return(status: 200, body: { results: [] }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      activity.lead_assignments(campaign_id: "1")
+    end
+  end
+
+  describe "#lead_status_changes" do
+    it "lists lead status changes" do
+      stub_request(:get, "#{base_url}/activity/lead-status-changes")
+        .with(query: { campaignID: "1", recipientEmailAddress: "john@example.com" })
+        .to_return(status: 200, body: { results: [] }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      activity.lead_status_changes(campaign_id: "1", recipient_email_address: "john@example.com")
+    end
+  end
+end

data/spec/mailshake/campaigns_spec.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Mailshake::Campaigns do
+  let(:campaigns) { described_class.new(Mailshake.client) }
+  let(:base_url) { "https://api.mailshake.com/2017-04-01" }
+
+  describe "#list" do
+    it "lists campaigns" do
+      stub_request(:get, "#{base_url}/campaigns/list")
+        .to_return(status: 200, body: { results: [] }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = campaigns.list
+      expect(result["results"]).to eq([])
+    end
+
+    it "passes search and pagination params" do
+      stub_request(:get, "#{base_url}/campaigns/list")
+        .with(query: { search: "test", nextToken: "abc", perPage: "10" })
+        .to_return(status: 200, body: { results: [] }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      campaigns.list(search: "test", next_token: "abc", per_page: "10")
+    end
+  end
+
+  describe "#get" do
+    it "gets a campaign by id" do
+      stub_request(:get, "#{base_url}/campaigns/get")
+        .with(query: { campaignID: "1" })
+        .to_return(status: 200, body: { id: 1, title: "Test Campaign" }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = campaigns.get(campaign_id: "1")
+      expect(result["title"]).to eq("Test Campaign")
+    end
+  end
+
+  describe "#create" do
+    it "creates a campaign" do
+      stub_request(:post, "#{base_url}/campaigns/create")
+        .with(body: { title: "New Campaign", senderID: 5 }.to_json)
+        .to_return(status: 200, body: { id: 2, title: "New Campaign" }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = campaigns.create(title: "New Campaign", sender_id: 5)
+      expect(result["title"]).to eq("New Campaign")
+    end
+  end
+
+  describe "#pause" do
+    it "pauses a campaign" do
+      stub_request(:post, "#{base_url}/campaigns/pause")
+        .with(body: { campaignID: 1 }.to_json)
+        .to_return(status: 200, body: {}.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      campaigns.pause(campaign_id: 1)
+    end
+  end
+
+  describe "#unpause" do
+    it "unpauses a campaign" do
+      stub_request(:post, "#{base_url}/campaigns/unpause")
+        .with(body: { campaignID: 1 }.to_json)
+        .to_return(status: 200, body: {}.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      campaigns.unpause(campaign_id: 1)
+    end
+  end
+
+  describe "#export" do
+    it "exports campaigns" do
+      stub_request(:post, "#{base_url}/campaigns/export")
+        .with(body: { campaignIDs: [1, 2], exportType: "csv", timezone: "US/Pacific" }.to_json)
+        .to_return(status: 200, body: { statusID: 42 }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = campaigns.export(campaign_ids: [1, 2], export_type: "csv", timezone: "US/Pacific")
+      expect(result["statusID"]).to eq(42)
+    end
+  end
+
+  describe "#export_status" do
+    it "checks export status" do
+      stub_request(:get, "#{base_url}/campaigns/export-status")
+        .with(query: { statusID: "42" })
+        .to_return(status: 200, body: { isFinished: true, csvDownloadUrl: "https://example.com/file.csv" }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = campaigns.export_status(status_id: "42")
+      expect(result["isFinished"]).to be true
+    end
+  end
+end

data/spec/mailshake/client_spec.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Mailshake::Client do
+  let(:client) { Mailshake.client }
+  let(:base_url) { "https://api.mailshake.com/2017-04-01" }
+  let(:expected_auth) { "Basic #{Base64.strict_encode64('test_api_key:')}" }
+
+  describe "#initialize" do
+    it "creates a client instance" do
+      expect(client).to be_a(described_class)
+    end
+
+    context "with missing credentials" do
+      it "raises a ConfigurationError" do
+        config = Mailshake::Configuration.new
+        expect { described_class.new(config) }.to raise_error(Mailshake::ConfigurationError)
+      end
+    end
+  end
+
+  describe "#get" do
+    it "makes authenticated GET request" do
+      stub_request(:get, "#{base_url}/test")
+        .to_return(status: 200, body: { data: "ok" }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = client.get("/test")
+      expect(result).to eq("data" => "ok")
+    end
+
+    it "sends Basic auth header with base64 encoded api key" do
+      stub_request(:get, "#{base_url}/test")
+        .to_return(status: 200, body: {}.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      client.get("/test")
+      expect(WebMock).to have_requested(:get, "#{base_url}/test")
+        .with(headers: { "Authorization" => expected_auth })
+    end
+
+    it "sends Accept: application/json header" do
+      stub_request(:get, "#{base_url}/test")
+        .to_return(status: 200, body: {}.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      client.get("/test")
+      expect(WebMock).to have_requested(:get, "#{base_url}/test")
+        .with(headers: { "Accept" => "application/json" })
+    end
+
+    it "passes query parameters" do
+      stub_request(:get, "#{base_url}/test")
+        .with(query: { campaignID: "1", perPage: "10" })
+        .to_return(status: 200, body: {}.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      client.get("/test", campaignID: "1", perPage: "10")
+    end
+  end
+
+  describe "#post" do
+    it "makes authenticated POST request with JSON body" do
+      stub_request(:post, "#{base_url}/test")
+        .with(body: { title: "Test" }.to_json,
+              headers: { "Content-Type" => "application/json" })
+        .to_return(status: 200, body: { id: 1 }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = client.post("/test", title: "Test")
+      expect(result).to eq("id" => 1)
+    end
+  end
+
+  describe "#me" do
+    it "fetches the current user" do
+      stub_request(:get, "#{base_url}/me")
+        .to_return(status: 200, body: { teamID: 1, email: "test@example.com" }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = client.me
+      expect(result["email"]).to eq("test@example.com")
+    end
+  end
+
+  describe "error handling" do
+    it "raises AuthenticationError on 401" do
+      stub_request(:get, "#{base_url}/expired")
+        .to_return(status: 401, body: "Unauthorized")
+
+      expect { client.get("/expired") }.to raise_error(Mailshake::AuthenticationError)
+    end
+
+    it "raises NotFoundError on 404" do
+      stub_request(:get, "#{base_url}/missing")
+        .to_return(status: 404, body: "Not Found")
+
+      expect { client.get("/missing") }.to raise_error(Mailshake::NotFoundError)
+    end
+
+    it "raises RateLimitError on 429 with retry-after" do
+      stub_request(:get, "#{base_url}/limited")
+        .to_return(status: 429, body: "Too Many Requests",
+                   headers: { "retry-after" => "30" })
+
+      expect { client.get("/limited") }.to raise_error(Mailshake::RateLimitError) do |error|
+        expect(error.retry_after).to eq("30")
+      end
+    end
+
+    it "raises ValidationError on 400" do
+      stub_request(:post, "#{base_url}/bad")
+        .to_return(
+          status: 400,
+          body: { message: "Bad Request", errors: { "title" => ["is required"] } }.to_json,
+          headers: { "Content-Type" => "application/json" }
+        )
+
+      expect { client.post("/bad", {}) }.to raise_error(Mailshake::ValidationError) do |error|
+        expect(error.errors).to eq("title" => ["is required"])
+      end
+    end
+
+    it "raises APIError on 500" do
+      stub_request(:get, "#{base_url}/error")
+        .to_return(status: 500, body: "Internal Server Error")
+
+      expect { client.get("/error") }.to raise_error(Mailshake::APIError)
+    end
+  end
+end

data/spec/mailshake/configuration_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Mailshake::Configuration do
+  describe "#initialize" do
+    it "sets default base_url" do
+      config = described_class.new
+      expect(config.base_url).to eq("https://api.mailshake.com/2017-04-01")
+    end
+
+    it "sets default timeout" do
+      config = described_class.new
+      expect(config.timeout).to eq(30)
+    end
+  end
+
+  describe "#valid?" do
+    it "returns true when api_key is set" do
+      config = described_class.new
+      config.api_key = "test_key"
+      expect(config.valid?).to be true
+    end
+
+    it "returns false when api_key is nil" do
+      config = described_class.new
+      expect(config.valid?).to be false
+    end
+
+    it "returns false when api_key is empty" do
+      config = described_class.new
+      config.api_key = ""
+      expect(config.valid?).to be false
+    end
+  end
+
+  describe "#missing_credentials" do
+    it "returns empty array when api_key is set" do
+      config = described_class.new
+      config.api_key = "test_key"
+      expect(config.missing_credentials).to eq([])
+    end
+
+    it "returns api_key when missing" do
+      config = described_class.new
+      expect(config.missing_credentials).to eq(["api_key"])
+    end
+  end
+end

data/spec/mailshake/leads_spec.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Mailshake::Leads do
+  let(:leads) { described_class.new(Mailshake.client) }
+  let(:base_url) { "https://api.mailshake.com/2017-04-01" }
+
+  describe "#list" do
+    it "lists leads" do
+      stub_request(:get, "#{base_url}/leads/list")
+        .to_return(status: 200, body: { results: [] }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = leads.list
+      expect(result["results"]).to eq([])
+    end
+
+    it "passes filter params" do
+      stub_request(:get, "#{base_url}/leads/list")
+        .with(query: { campaignID: "1", status: "open", perPage: "10" })
+        .to_return(status: 200, body: { results: [] }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      leads.list(campaign_id: "1", status: "open", per_page: "10")
+    end
+  end
+
+  describe "#get" do
+    it "gets a lead by id" do
+      stub_request(:get, "#{base_url}/leads/get")
+        .with(query: { leadID: "42" })
+        .to_return(status: 200, body: { id: 42, status: "open" }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = leads.get(lead_id: "42")
+      expect(result["status"]).to eq("open")
+    end
+  end
+
+  describe "#create" do
+    it "creates leads" do
+      stub_request(:post, "#{base_url}/leads/create")
+        .with(body: { campaignID: 1, emailAddresses: ["john@example.com"] }.to_json)
+        .to_return(status: 200, body: { results: [{ id: 1 }] }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = leads.create(campaign_id: 1, email_addresses: ["john@example.com"])
+      expect(result["results"].length).to eq(1)
+    end
+  end
+
+  describe "#close" do
+    it "closes a lead" do
+      stub_request(:post, "#{base_url}/leads/close")
+        .with(body: { leadID: 42, status: "won" }.to_json)
+        .to_return(status: 200, body: {}.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      leads.close(lead_id: 42, status: "won")
+    end
+  end
+
+  describe "#ignore" do
+    it "ignores a lead" do
+      stub_request(:post, "#{base_url}/leads/ignore")
+        .with(body: { leadID: 42 }.to_json)
+        .to_return(status: 200, body: {}.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      leads.ignore(lead_id: 42)
+    end
+  end
+
+  describe "#reopen" do
+    it "reopens a lead" do
+      stub_request(:post, "#{base_url}/leads/reopen")
+        .with(body: { leadID: 42 }.to_json)
+        .to_return(status: 200, body: {}.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      leads.reopen(lead_id: 42)
+    end
+  end
+end

data/spec/mailshake/push_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Mailshake::Push do
+  let(:push) { described_class.new(Mailshake.client) }
+  let(:base_url) { "https://api.mailshake.com/2017-04-01" }
+
+  describe "#create" do
+    it "creates a push webhook" do
+      stub_request(:post, "#{base_url}/push/create")
+        .with(body: { targetUrl: "https://example.com/webhook", event: "reply" }.to_json)
+        .to_return(status: 200, body: { id: 1 }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      result = push.create(target_url: "https://example.com/webhook", event: "reply")
+      expect(result["id"]).to eq(1)
+    end
+
+    it "passes filter param" do
+      stub_request(:post, "#{base_url}/push/create")
+        .with(body: { targetUrl: "https://example.com/webhook", event: "reply", filter: { campaignID: 1 } }.to_json)
+        .to_return(status: 200, body: { id: 1 }.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      push.create(target_url: "https://example.com/webhook", event: "reply", filter: { campaignID: 1 })
+    end
+  end
+
+  describe "#delete" do
+    it "deletes a push webhook" do
+      stub_request(:post, "#{base_url}/push/delete")
+        .with(body: { targetUrl: "https://example.com/webhook" }.to_json)
+        .to_return(status: 200, body: {}.to_json,
+                   headers: { "Content-Type" => "application/json" })
+
+      push.delete(target_url: "https://example.com/webhook")
+    end
+  end
+end