mailerlite-ruby 1.0.6 → 2.1.0

data/spec/files_rspec.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'webmock/rspec'
+require 'json'
+require_relative 'support/json_fixture'
+
+RSpec.describe MailerLite::Files do
+  include_context 'with the dummy API token'
+
+  let(:files) { described_class.new(client: MailerLite::Client.new) }
+  let(:url) { "#{MAILERLITE_API_URL}/files" }
+
+  def stub_files(query: nil, status: 200, response: load_fixture('files'))
+    stub = stub_request(:get, url).with(headers: { 'Authorization' => 'Bearer dummy_token' }) { |req| req.body == '' }
+    stub = stub.with(query: query) if query
+    stub.to_return(status: status, body: response.to_json, headers: { 'Content-Type' => 'application/json' })
+  end
+
+  # WebMock normalizes the URI (for example `+` becomes `%20`), so keep the raw URI that http.rb sends.
+  def capture_raw_uris
+    uris = []
+    allow_any_instance_of(HTTP::Client).to receive(:perform).and_wrap_original do |method, request, options|
+      uris << request.uri.to_s
+      method.call(request, options)
+    end
+    uris
+  end
+
+  it 'has the constants of the API' do
+    expect([described_class::FileType::IMAGE, described_class::FileType::PDF, described_class::FileType::EPUB]).to eq %w[image pdf epub]
+    sorts = described_class::FileSort
+    expect([sorts::CREATED_AT, sorts::CREATED_AT_DESC, sorts::NAME, sorts::NAME_DESC, sorts::SIZE, sorts::SIZE_DESC])
+      .to eq %w[created_at -created_at name -name size -size]
+  end
+
+  describe '#list' do
+    it 'sends no query without arguments' do
+      uris = capture_raw_uris
+      stub = stub_files
+
+      response = files.list
+
+      expect(stub).to have_been_requested
+      expect(uris).to eq [url]
+      data = JSON.parse(response.body.to_s)
+      expect(data['data'].map { |file| file['name'] }).to eq ['summer sale banner.png', 'summer sale terms.pdf']
+      expect(data['data'][0]['width']).to eq 1200
+      expect(data['data'][1]).to have_key('width')
+      expect(data['data'][1]['width']).to be_nil
+      expect(data['data'][1]['height']).to be_nil
+      expect(data['links']).to have_key('next')
+      expect(data['links']['next']).to be_nil
+    end
+
+    it 'sends the filter, the sort and the pages, and encodes a space as +' do
+      uris = capture_raw_uris
+      stub = stub_files(query: { 'filter[name]' => 'summer sale', 'filter[type]' => 'image', 'sort' => '-size', 'page' => '1', 'limit' => '25' })
+
+      files.list(filter: { name: 'summer sale', type: described_class::FileType::IMAGE }, sort: described_class::FileSort::SIZE_DESC, page: 1, limit: 25)
+
+      expect(stub).to have_been_requested
+      expect(uris).to eq ["#{url}?filter%5Bname%5D=summer+sale&filter%5Btype%5D=image&sort=-size&page=1&limit=25"]
+    end
+
+    it 'drops a nil filter value and keeps an empty one' do
+      uris = capture_raw_uris
+      stub_files(query: { 'filter[type]' => '' })
+
+      files.list(filter: { name: nil, type: '' })
+
+      expect(uris).to eq ["#{url}?filter%5Btype%5D="]
+    end
+
+    it 'returns the 422 of a file type that is not valid' do
+      stub_files(query: { 'filter[type]' => 'video' }, status: 422,
+                 response: { message: 'The selected filter.type is invalid.', errors: { 'filter.type' => ['The selected filter.type is invalid.'] } })
+
+      response = files.list(filter: { type: 'video' })
+
+      expect(response.code).to eq 422
+      expect(response.api_error.errors).to eq('filter.type' => ['The selected filter.type is invalid.'])
+    end
+
+    it 'checks the filter and sends no request' do
+      expect { files.list(filter: 'image') }.to raise_error(TypeError, /`filter`/)
+      expect(a_request(:any, /.*/)).not_to have_been_made
+    end
+  end
+end

data/spec/fixtures/brand_styles.json

@@ -0,0 +1,50 @@
+{
+  "data": {
+    "brand": {
+      "identifier": "account",
+      "name": "Brand styles",
+      "font_family": "Inter, sans-serif",
+      "primary_color": "#2cb191",
+      "secondary_color": "#1f2937",
+      "heading_color": "#111827",
+      "text_color": "#374151",
+      "border_color": "#e5e7eb",
+      "background_color": "#ffffff"
+    },
+    "default": {
+      "identifier": "default-brand",
+      "name": "Default",
+      "font_family": "Inter, sans-serif",
+      "primary_color": "#09c269",
+      "secondary_color": "#000000",
+      "heading_color": "#000000",
+      "text_color": "#000000",
+      "border_color": "#e5e7eb",
+      "background_color": "#ffffff"
+    },
+    "presets": [
+      {
+        "identifier": "preset-business-casual",
+        "name": "Business casual",
+        "font_family": "Georgia, serif",
+        "primary_color": "#1d4ed8",
+        "secondary_color": "#1e3a8a",
+        "heading_color": "#0f172a",
+        "text_color": "#334155",
+        "border_color": "#cbd5e1",
+        "background_color": "#f8fafc"
+      },
+      {
+        "identifier": "preset-retro",
+        "name": "Retro",
+        "font_family": "Courier New, monospace",
+        "primary_color": "#d97706",
+        "secondary_color": "#92400e",
+        "heading_color": "#451a03",
+        "text_color": "#78350f",
+        "border_color": "#fde68a",
+        "background_color": "#fffbeb"
+      }
+    ]
+  }
+}

data/spec/fixtures/campaign_simple_editor.json

@@ -0,0 +1,24 @@
+{
+  "data": {
+    "id": "456",
+    "account_id": "1",
+    "name": "Simple editor campaign",
+    "type": "regular",
+    "status": "draft",
+    "default_email_id": "123",
+    "emails": [
+      {
+        "id": "123",
+        "account_id": "1",
+        "emailable_id": "456",
+        "emailable_type": "campaigns",
+        "type": "builder_inline_email",
+        "from": "sender@example.com",
+        "from_name": "Sender",
+        "reply_to": "reply@example.com",
+        "subject": "Hello",
+        "is_designed": true
+      }
+    ]
+  }
+}

data/spec/fixtures/email.json

@@ -0,0 +1,81 @@
+{
+  "data": {
+    "id": "123",
+    "type": "builder_inline_email",
+    "emailable_type": "campaigns",
+    "emailable_id": "456",
+    "settings": {
+      "brand": {
+        "mode": "account",
+        "font_family": "Inter, sans-serif",
+        "background_color": "#ffffff",
+        "text_color": "#000000",
+        "border_color": "#e5e7eb"
+      },
+      "layout": {"width_mode": "default", "alignment": "center"},
+      "typography": {
+        "link": {"color": "#2cb191"},
+        "heading": {
+          "font_family": "Inter, sans-serif",
+          "font_weight": "700",
+          "line_height": "150%",
+          "letter_spacing": "0",
+          "h1": {"color": "#000000", "size": "32"},
+          "h2": {"color": "#000000", "size": "24"},
+          "h3": {"color": "#000000", "size": "20"}
+        },
+        "paragraph": {
+          "font_family": "Inter, sans-serif",
+          "font_weight": "400",
+          "line_height": "150%",
+          "letter_spacing": "0",
+          "p1": {"color": "#000000", "size": "16"}
+        }
+      },
+      "button": {
+        "font_family": "Inter, sans-serif",
+        "font_weight": "600",
+        "letter_spacing": "0",
+        "background_color": "#2cb191",
+        "text_color": "#ffffff",
+        "border_radius": "4"
+      },
+      "footer": {
+        "show_preferences": false,
+        "company_name": {
+          "editor_content": {
+            "content": [{"type": "text", "text": "Acme", "marks": [{"type": "bold"}]}]
+          }
+        },
+        "address": {
+          "editor_content": {"content": [{"text": "1 Main Street", "type": "text"}]}
+        },
+        "info_text": {
+          "editor_content": {"content": [{"text": "You signed up on our website.", "type": "text"}]}
+        },
+        "unsubscribe_text": "Unsubscribe",
+        "preferences_text": "Update your preferences",
+        "social_links": [
+          {"url": "https://example.com", "type": "website", "label": "Website", "link_id": 7}
+        ]
+      }
+    },
+    "blocks": [
+      {
+        "id": "1",
+        "type": "paragraph",
+        "editor_content": {
+          "attrs": {"textAlign": "left"},
+          "content": [{"text": "Hello", "type": "text"}]
+        }
+      },
+      {
+        "id": "2",
+        "type": "bulleted_list",
+        "editor_content": {},
+        "children": [{"id": "3", "type": "paragraph", "editor_content": {}}]
+      }
+    ]
+  },
+  "etag": "42"
+}

data/spec/fixtures/email_block.json

@@ -0,0 +1,12 @@
+{
+  "data": {
+    "id": "57",
+    "type": "paragraph",
+    "editor_content": {
+      "attrs": {"textAlign": "left"},
+      "content": [{"text": "Hello", "type": "text"}]
+    },
+    "placement": {"after": "56", "before": null}
+  },
+  "etag": "43"
+}

data/spec/fixtures/email_block_created.json

@@ -0,0 +1,12 @@
+{
+  "data": {
+    "id": "58",
+    "type": "paragraph",
+    "editor_content": {
+      "attrs": {"textAlign": "center"},
+      "content": [{"text": "Hi", "type": "text"}]
+    },
+    "placement": {"after": "57", "before": null}
+  },
+  "etag": "43"
+}

data/spec/fixtures/email_block_created_rejected.json

@@ -0,0 +1,15 @@
+{
+  "data": {
+    "id": "58",
+    "type": "paragraph",
+    "editor_content": {
+      "content": [{"text": "Hi", "type": "text"}]
+    },
+    "placement": {"after": "57", "before": null}
+  },
+  "etag": "43",
+  "rejected": {
+    "message": "Some attributes were rejected.",
+    "keys": ["editor_content.attrs.onclick"]
+  }
+}

data/spec/fixtures/email_block_moved.json

@@ -0,0 +1,12 @@
+{
+  "data": {
+    "id": "57",
+    "type": "paragraph",
+    "editor_content": {
+      "attrs": {"textAlign": "left"},
+      "content": [{"text": "Hello", "type": "text"}]
+    },
+    "placement": {"after": null, "before": "1"}
+  },
+  "etag": "46"
+}

data/spec/fixtures/email_block_updated.json

@@ -0,0 +1,9 @@
+{
+  "data": {
+    "id": "57",
+    "type": "paragraph",
+    "editor_content": {"content": [{"text": "Hello again", "type": "text"}]},
+    "placement": {"after": "56", "before": "58"}
+  },
+  "etag": "44"
+}

data/spec/fixtures/email_block_updated_rejected.json

@@ -0,0 +1,13 @@
+{
+  "data": {
+    "id": "57",
+    "type": "paragraph",
+    "editor_content": {"content": [{"text": "Hello again", "type": "text"}]},
+    "placement": {"after": "56", "before": "58"}
+  },
+  "etag": "44",
+  "rejected": {
+    "message": "Some attributes were rejected.",
+    "keys": ["editor_content.mobile.onclick"]
+  }
+}

data/spec/fixtures/email_block_validation_invalid.json

@@ -0,0 +1,5 @@
+{
+  "valid": false,
+  "errors": {"type": ["The selected type is invalid."]},
+  "schema": {"version": "2.73.2", "hash": "0f3a9c"}
+}

data/spec/fixtures/email_etag.json

@@ -0,0 +1 @@
+{"etag": "45"}

data/spec/fixtures/email_html.json

@@ -0,0 +1 @@
+{"data": {"html": "<!doctype html><html><body><p>Hello</p></body></html>"}, "etag": "42"}

data/spec/fixtures/email_settings.json

@@ -0,0 +1,111 @@
+{
+  "data": {
+    "brand": {
+      "mode": "custom",
+      "font_family": "Inter, sans-serif",
+      "background_color": "#f4f4f4",
+      "text_color": "#000000",
+      "border_color": "#e5e7eb"
+    },
+    "layout": {
+      "width_mode": "default",
+      "alignment": "center"
+    },
+    "typography": {
+      "link": {
+        "color": "#2cb191"
+      },
+      "heading": {
+        "font_family": "Inter, sans-serif",
+        "font_weight": "700",
+        "line_height": "150%",
+        "letter_spacing": "0",
+        "h1": {
+          "color": "#000000",
+          "size": "32"
+        },
+        "h2": {
+          "color": "#000000",
+          "size": "24"
+        },
+        "h3": {
+          "color": "#000000",
+          "size": "20"
+        }
+      },
+      "paragraph": {
+        "font_family": "Inter, sans-serif",
+        "font_weight": "400",
+        "line_height": "150%",
+        "letter_spacing": "0",
+        "p1": {
+          "color": "#000000",
+          "size": "16"
+        }
+      }
+    },
+    "button": {
+      "font_family": "Inter, sans-serif",
+      "font_weight": "600",
+      "letter_spacing": "0",
+      "background_color": "#2cb191",
+      "text_color": "#ffffff",
+      "border_radius": "4"
+    },
+    "footer": {
+      "show_preferences": false,
+      "company_name": {
+        "editor_content": {
+          "content": [
+            {
+              "type": "text",
+              "text": "Acme",
+              "marks": [
+                {
+                  "type": "bold"
+                }
+              ]
+            }
+          ]
+        }
+      },
+      "address": {
+        "editor_content": {
+          "content": [
+            {
+              "text": "1 Main Street",
+              "type": "text"
+            }
+          ]
+        }
+      },
+      "info_text": {
+        "editor_content": {
+          "content": [
+            {
+              "text": "You signed up on our website.",
+              "type": "text"
+            }
+          ]
+        }
+      },
+      "unsubscribe_text": "Unsubscribe",
+      "preferences_text": "Update your preferences",
+      "social_links": [
+        {
+          "url": "https://example.com",
+          "type": "website",
+          "label": "Website",
+          "link_id": 7
+        }
+      ]
+    }
+  },
+  "etag": "47",
+  "rejected": {
+    "message": "Some attributes were rejected.",
+    "keys": [
+      "footer.social_links[0].url"
+    ]
+  }
+}

data/spec/fixtures/email_settings_validation.json

@@ -0,0 +1,9 @@
+{
+  "valid": false,
+  "errors": {"layout.width": ["The layout.width field cannot be changed."]},
+  "schema": {"version": "2.73.2", "hash": "0f3a9c"},
+  "rejected": {
+    "message": "Some attributes were rejected.",
+    "keys": ["footer.social_links[0].url"]
+  }
+}

data/spec/fixtures/email_template.json

@@ -0,0 +1 @@
+{"data": {"id": "789", "name": "Newsletter", "type": "email", "created_at": "2026-10-28 12:00:00"}}

data/spec/fixtures/email_version.json

@@ -0,0 +1 @@
+{"data": {"id": "903", "created_at": "2026-10-28 12:10:00", "current": true}}

data/spec/fixtures/email_versions.json

@@ -0,0 +1,26 @@
+{
+  "data": [
+    {"id": "902", "created_at": "2026-10-28 12:05:00", "current": true},
+    {"id": "901", "created_at": "2026-10-28 12:00:00", "current": false}
+  ],
+  "links": {
+    "first": "https://connect.mailerlite.com/api/emails/123/versions?page=1",
+    "last": "https://connect.mailerlite.com/api/emails/123/versions?page=1",
+    "prev": null,
+    "next": null
+  },
+  "meta": {
+    "current_page": 1,
+    "from": 1,
+    "last_page": 1,
+    "links": [
+      {"url": null, "label": "« Previous", "page": null, "active": false},
+      {"url": "https://connect.mailerlite.com/api/emails/123/versions?page=1", "label": "1", "page": 1, "active": true},
+      {"url": null, "label": "Next »", "page": null, "active": false}
+    ],
+    "path": "https://connect.mailerlite.com/api/emails/123/versions",
+    "per_page": 25,
+    "to": 2,
+    "total": 2
+  }
+}

data/spec/fixtures/files.json

@@ -0,0 +1,44 @@
+{
+  "data": [
+    {
+      "id": "301",
+      "type": "image",
+      "name": "summer sale banner.png",
+      "url": "https://storage.example.com/files/summer-sale-banner.png",
+      "size": 48213,
+      "width": 1200,
+      "height": 600,
+      "created_at": "2026-10-20 09:30:00"
+    },
+    {
+      "id": "302",
+      "type": "pdf",
+      "name": "summer sale terms.pdf",
+      "url": "https://storage.example.com/files/summer-sale-terms.pdf",
+      "size": 10240,
+      "width": null,
+      "height": null,
+      "created_at": "2026-10-21 10:00:00"
+    }
+  ],
+  "links": {
+    "first": "https://connect.mailerlite.com/api/files?page=1",
+    "last": "https://connect.mailerlite.com/api/files?page=1",
+    "prev": null,
+    "next": null
+  },
+  "meta": {
+    "current_page": 1,
+    "from": 1,
+    "last_page": 1,
+    "links": [
+      {"url": null, "label": "« Previous", "page": null, "active": false},
+      {"url": "https://connect.mailerlite.com/api/files?page=1", "label": "1", "page": 1, "active": true},
+      {"url": null, "label": "Next »", "page": null, "active": false}
+    ],
+    "path": "https://connect.mailerlite.com/api/files",
+    "per_page": 25,
+    "to": 2,
+    "total": 2
+  }
+}

data/spec/groups_rspec.rb

@@ -94,4 +94,25 @@ RSpec.describe MailerLite::Groups do
       end
     end
   end
+
+  describe '#get_subscribers query string' do
+    it 'sends the params in the query string with no body' do
+      stub = stub_api(:get, '/groups/1/subscribers', query: { 'filter[status]' => 'active', 'limit' => '10', 'cursor' => 'abc', 'include' => 'groups' })
+
+      groups.get_subscribers(group_id: 1, filter: { status: 'active' }, limit: 10, cursor: 'abc', include: 'groups')
+
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '#import_subscribers' do
+    it 'sends POST /groups/{group}/import-subscribers with the body' do
+      list = [{ 'email' => 'a@b.com', 'name' => 'Ann', 'fields' => { 'city' => 'Vilnius' } }]
+      stub = stub_api(:post, '/groups/1/import-subscribers', body: { 'subscribers' => list, 'resubscribe' => true, 'trigger_automations' => false })
+
+      groups.import_subscribers(group_id: 1, subscribers: list, resubscribe: true, trigger_automations: false)
+
+      expect(stub).to have_been_requested
+    end
+  end
 end