mailerlite-ruby 2.0.0 → 2.1.0

data/spec/automations_rspec.rb

@@ -60,4 +60,147 @@ RSpec.describe MailerLite::Automations do
       end
     end
   end
+
+  describe '#get with every filter' do
+    it 'sends the documented query params' do
+      stub = stub_api(:get, '/automations', query: {
+                        'filter[status]' => 'true', 'filter[name]' => 'Welcome', 'filter[group]' => '1', 'filter[folder]' => '2',
+                        'filter[enabled]' => '1', 'filter[automation_state]' => 'workflows', 'filter[drafts_state]' => 'complete_workflow',
+                        'limit' => '10', 'page' => '2', 'sort' => '-created_at', 'with_steps' => '0'
+                      })
+
+      automations.get(
+        filter: { status: true, name: 'Welcome', group: 1, folder: 2, enabled: 1, automation_state: 'workflows', drafts_state: 'complete_workflow' },
+        limit: 10, page: 2, sort: '-created_at', with_steps: false
+      )
+
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '#create' do
+    it 'sends POST /automations' do
+      stub = stub_api(:post, '/automations', body: { 'name' => 'Welcome' })
+      automations.create(name: 'Welcome')
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '#update' do
+    it 'sends PUT /automations/{automation}' do
+      stub = stub_api(:put, '/automations/1', body: { 'name' => 'Welcome', 'trigger_data' => { 'group_ids' => ['2'] }, 'triggers' => [{ 'type' => 'manual' }] })
+      automations.update(automation_id: 1, name: 'Welcome', trigger_data: { 'group_ids' => ['2'] }, triggers: [{ 'type' => 'manual' }])
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '#delete' do
+    it 'sends DELETE /automations/{automation}' do
+      stub = stub_api(:delete, '/automations/1')
+      automations.delete(1)
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '#copy' do
+    it 'sends POST /automations/{automation}/copy' do
+      stub = stub_api(:post, '/automations/1/copy')
+      automations.copy(1)
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '#enable' do
+    it 'sends POST /automations/{automation}/enable' do
+      stub = stub_api(:post, '/automations/1/enable')
+      automations.enable(1)
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '#disable' do
+    it 'sends POST /automations/{automation}/disable' do
+      stub = stub_api(:post, '/automations/1/disable')
+      automations.disable(1)
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '#test' do
+    it 'sends POST /automations/{automation}/test' do
+      stub = stub_api(:post, '/automations/1/test', body: { 'email' => 'a@b.com' })
+      automations.test(automation_id: 1, email: 'a@b.com')
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '#get_subscriber_activity search' do
+    it 'sends filter[search] and sort' do
+      stub = stub_api(:get, '/automations/1/activity', query: { 'filter[status]' => 'completed', 'filter[search]' => 'a@b.com', 'sort' => '-id' })
+      automations.get_subscriber_activity(automation_id: 1, filter: { status: 'completed', search: 'a@b.com' }, sort: '-id')
+      expect(stub).to have_been_requested
+    end
+
+    it 'sends the old filter[:keyword] as filter[search]' do
+      stub = stub_api(:get, '/automations/1/activity', query: { 'filter[status]' => 'completed', 'filter[search]' => 'a@b.com' })
+      automations.get_subscriber_activity(automation_id: 1, filter: { status: 'completed', keyword: 'a@b.com' })
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '#get_subscriber_activity with_subscribers' do
+    it 'sends with_subscribers=1 when true' do
+      stub = stub_api(:get, '/automations/1/activity', query: { 'filter[status]' => 'active', 'with_subscribers' => '1' })
+      automations.get_subscriber_activity(automation_id: 1, filter: { status: 'active' }, with_subscribers: true)
+      expect(stub).to have_been_requested
+    end
+
+    it 'omits with_subscribers when false' do
+      stub = stub_api(:get, '/automations/1/activity', query: { 'filter[status]' => 'active' })
+      automations.get_subscriber_activity(automation_id: 1, filter: { status: 'active' }, with_subscribers: false)
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '#add_subscribers' do
+    it 'sends POST /automations/{automation}/add-subscribers' do
+      stub = stub_api(:post, '/automations/1/add-subscribers', body: { 'step_id' => 2, 'emails' => ['a@b.com'], 'groups' => ['3'] })
+      automations.add_subscribers(automation_id: 1, step_id: 2, emails: ['a@b.com'], groups: ['3'])
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '#readd' do
+    it 'sends POST /automations/{automation}/readd' do
+      stub = stub_api(:post, '/automations/1/readd', body: {
+                        'readd_subscribers_to' => 'selected_step', 'selected_step_id' => '2', 'filter' => { 'status' => 'completed', 'id' => ['5'] }
+                      })
+      automations.readd(automation_id: 1, readd_subscribers_to: 'selected_step', selected_step_id: '2', filter: { status: 'completed', id: ['5'] })
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '#add_activity_to_group' do
+    it 'sends POST /automations/{automation}/activity/add-to-group' do
+      stub = stub_api(:post, '/automations/1/activity/add-to-group', body: { 'destination_groups' => ['3'], 'filter' => { 'status' => 'active' } })
+      automations.add_activity_to_group(automation_id: 1, destination_groups: ['3'], filter: { status: 'active' })
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '#cancel_activity' do
+    it 'sends POST /automations/{automation}/activity/cancel-automation' do
+      stub = stub_api(:post, '/automations/1/activity/cancel-automation', body: { 'filter' => { 'status' => 'active', 'next_step' => 4 } })
+      automations.cancel_activity(automation_id: 1, filter: { status: 'active', next_step: 4 })
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe '#skip_activity_delay' do
+    it 'sends POST /automations/{automation}/activity/skip-delay' do
+      stub = stub_api(:post, '/automations/1/activity/skip-delay', body: { 'filter' => { 'status' => 'active', 'search' => 'a@b.com' } })
+      automations.skip_activity_delay(automation_id: 1, filter: { status: 'active', search: 'a@b.com' })
+      expect(stub).to have_been_requested
+    end
+  end
 end

data/spec/brand_styles_rspec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'webmock/rspec'
+require 'json'
+require_relative 'support/json_fixture'
+
+RSpec.describe MailerLite::BrandStyles do
+  include_context 'with the dummy API token'
+
+  let(:brand_styles) { described_class.new(client: MailerLite::Client.new) }
+  let(:url) { "#{MAILERLITE_API_URL}/brand-styles" }
+
+  def stub_brand_styles(response)
+    stub_request(:get, url)
+      .with(headers: { 'Authorization' => 'Bearer dummy_token' }) { |req| req.body == '' && !req.headers.key?('Idempotency-Key') }
+      .to_return(status: 200, body: response.to_json, headers: { 'Content-Type' => 'application/json' })
+  end
+
+  describe '#get' do
+    it 'gets the palettes' do
+      stub = stub_brand_styles(load_fixture('brand_styles'))
+
+      response = brand_styles.get
+
+      expect(stub).to have_been_requested
+      expect(response).to be_a(HTTP::Response)
+      expect(response.api_error).to be_nil
+      data = JSON.parse(response.body.to_s)['data']
+      expect(data['brand']['identifier']).to eq 'account'
+      expect(data['brand']['primary_color']).to eq '#2cb191'
+      expect(data['default']['identifier']).to eq 'default-brand'
+      expect(data['presets'].map { |preset| preset['identifier'] }).to eq %w[preset-business-casual preset-retro]
+      expect(data['presets'][1]['font_family']).to eq 'Courier New, monospace'
+    end
+
+    it 'returns a null brand when the account has none' do
+      body = load_fixture('brand_styles')
+      body['data']['brand'] = nil
+      stub_brand_styles(body)
+
+      data = JSON.parse(brand_styles.get.body.to_s)['data']
+
+      expect(data).to have_key('brand')
+      expect(data['brand']).to be_nil
+      expect(data['default']['identifier']).to eq 'default-brand'
+    end
+  end
+end

data/spec/campaigns_rspec.rb

@@ -4,6 +4,8 @@
 require 'spec_helper'
 require 'vcr'
 require 'json'
+require 'webmock/rspec'
+require_relative 'support/json_fixture'
 
 # require "webmock/rspec"
 # Import the `Campaigns` class
@@ -152,4 +154,44 @@ RSpec.describe MailerLite::Campaigns do
       end
     end
   end
+
+  describe '#create with the simple editor' do
+    include_context 'with the dummy API token'
+
+    let(:url) { "#{MAILERLITE_API_URL}/campaigns" }
+
+    def stub_create(body)
+      stub_request(:post, url)
+        .with(headers: { 'Authorization' => 'Bearer dummy_token' }) { |req| req.body == body }
+        .to_return(status: 201, body: load_fixture('campaign_simple_editor').to_json, headers: { 'Content-Type' => 'application/json' })
+    end
+
+    it 'has the value of the simple editor' do
+      expect(MailerLite::Campaigns::EDITOR_SIMPLE).to eq 'simple'
+    end
+
+    it 'sends editor, template_id and reply_to, and no content' do
+      stub = stub_create('{"name":"Simple editor campaign","type":"regular","emails":[{"subject":"Hello","from_name":"Sender",' \
+                         '"from":"sender@example.com","reply_to":"reply@example.com","editor":"simple","template_id":789}]}')
+
+      response = campaigns.create(name: 'Simple editor campaign', type: 'regular',
+                                  emails: [{ subject: 'Hello', from_name: 'Sender', from: 'sender@example.com',
+                                             reply_to: 'reply@example.com', editor: MailerLite::Campaigns::EDITOR_SIMPLE, template_id: 789 }])
+
+      expect(stub).to have_been_requested
+      email = JSON.parse(response.body.to_s)['data']['emails'][0]
+      expect(email['id']).to eq '123'
+      expect(email['type']).to eq 'builder_inline_email'
+    end
+
+    it 'sends the same body as before without editor' do
+      stub = stub_create('{"name":"HTML campaign","type":"regular","emails":[{"subject":"Hello","from_name":"Sender",' \
+                         '"from":"sender@example.com","content":"<p>Hi</p>"}]}')
+
+      campaigns.create(name: 'HTML campaign', type: 'regular',
+                       emails: [{ subject: 'Hello', from_name: 'Sender', from: 'sender@example.com', content: '<p>Hi</p>' }])
+
+      expect(stub).to have_been_requested
+    end
+  end
 end

data/spec/ecommerce_rspec.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'webmock/rspec'
+require 'json'
+
+RSpec.describe MailerLite::Ecommerce do
+  let(:client) { MailerLite::Client.new }
+  let(:api) { MAILERLITE_API_URL }
+  let(:shop) { "#{MAILERLITE_API_URL}/ecommerce/shops/1" }
+  let(:variant) { { name: 'Large', attributes: { size: 'L' } } }
+
+  def expect_request(method, url, body: nil)
+    stub = stub_request(method, url)
+    stub = stub.with(body: body.to_json) if body
+    stub.to_return(status: 200, body: '{}')
+    yield
+    expect(stub).to have_been_requested
+  end
+
+  it 'calls the shop endpoints' do
+    shops = MailerLite::Ecommerce::Shops.new(client: client)
+
+    expect_request(:get, "#{api}/ecommerce/shops?limit=10") { shops.list(limit: 10) }
+    expect_request(:get, shop) { shops.get('1') }
+    expect_request(:post, "#{api}/ecommerce/shops", body: { name: 'Shop' }) { shops.create({ name: 'Shop' }) }
+    expect_request(:put, shop, body: { name: 'New' }) { shops.update(shop_id: '1', params: { name: 'New' }) }
+    expect_request(:delete, shop) { shops.delete('1') }
+    expect_request(:get, "#{shop}/reports/stats?start_date=2026-10-01&end_date=2026-10-31") do
+      shops.stats(shop_id: '1', start_date: '2026-10-01', end_date: '2026-10-31')
+    end
+  end
+
+  it 'calls the product and variant endpoints' do
+    products = MailerLite::Ecommerce::Products.new(client: client)
+    variants = MailerLite::Ecommerce::ProductVariants.new(client: client)
+
+    expect_request(:get, "#{shop}/products?filter%5Benabled%5D=true&sort=-name") do
+      products.list(shop_id: '1', filter: { enabled: true }, sort: '-name')
+    end
+    expect_request(:get, "#{shop}/products/7") { products.get(shop_id: '1', product_id: '7') }
+    expect_request(:post, "#{shop}/products", body: { name: 'Hat' }) { products.create(shop_id: '1', params: { name: 'Hat' }) }
+    expect_request(:put, "#{shop}/products/7", body: { name: 'Cap' }) { products.update(shop_id: '1', product_id: '7', params: { name: 'Cap' }) }
+    expect_request(:delete, "#{shop}/products/7") { products.delete(shop_id: '1', product_id: '7') }
+    expect_request(:put, "#{shop}/products/7/change-status", body: { status: false }) do
+      products.change_status(shop_id: '1', product_id: '7', enabled: false)
+    end
+    expect_request(:put, "#{shop}/products/7/categories/multiple", body: { categories: ['5'], replace: true }) do
+      products.assign_categories(shop_id: '1', product_id: '7', category_ids: ['5'], replace: true)
+    end
+
+    expect_request(:get, "#{shop}/products/7/variants") { variants.list(shop_id: '1', product_id: '7') }
+    expect_request(:post, "#{shop}/products/7/variants", body: [variant]) { variants.sync(shop_id: '1', product_id: '7', variants: [variant]) }
+    expect_request(:put, "#{shop}/products/7/variants/3", body: variant) do
+      variants.update(shop_id: '1', product_id: '7', variant_id: '3', params: variant)
+    end
+    expect_request(:delete, "#{shop}/products/7/variants/3") { variants.delete(shop_id: '1', product_id: '7', variant_id: '3') }
+  end
+
+  it 'calls the category endpoints' do
+    categories = MailerLite::Ecommerce::Categories.new(client: client)
+
+    expect_request(:get, "#{shop}/categories") { categories.list(shop_id: '1') }
+    expect_request(:get, "#{shop}/categories/5") { categories.get(shop_id: '1', category_id: '5') }
+    expect_request(:post, "#{shop}/categories", body: { name: 'Hats' }) { categories.create(shop_id: '1', params: { name: 'Hats' }) }
+    expect_request(:put, "#{shop}/categories/5", body: { name: 'Caps' }) { categories.update(shop_id: '1', category_id: '5', params: { name: 'Caps' }) }
+    expect_request(:delete, "#{shop}/categories/5") { categories.delete(shop_id: '1', category_id: '5') }
+    expect_request(:get, "#{shop}/categories/5/products") { categories.products(shop_id: '1', category_id: '5') }
+    expect_request(:put, "#{shop}/categories/5/products/7") { categories.assign_product(shop_id: '1', category_id: '5', product_id: '7') }
+    expect_request(:delete, "#{shop}/categories/5/products/7") { categories.unassign_product(shop_id: '1', category_id: '5', product_id: '7') }
+  end
+
+  it 'calls the customer, order and cart endpoints' do
+    customers = MailerLite::Ecommerce::Customers.new(client: client)
+    orders = MailerLite::Ecommerce::Orders.new(client: client)
+    carts = MailerLite::Ecommerce::Carts.new(client: client)
+    items = MailerLite::Ecommerce::CartItems.new(client: client)
+
+    expect_request(:get, "#{shop}/customers?filter%5Bemail%5D=a%40b.test") { customers.list(shop_id: '1', filter: { email: 'a@b.test' }) }
+    expect_request(:get, "#{shop}/customers/3") { customers.get(shop_id: '1', customer_id: '3') }
+    expect_request(:post, "#{shop}/customers", body: { email: 'a@b.test' }) { customers.create(shop_id: '1', params: { email: 'a@b.test' }) }
+    expect_request(:put, "#{shop}/customers/3", body: { name: 'Jane' }) { customers.update(shop_id: '1', customer_id: '3', params: { name: 'Jane' }) }
+    expect_request(:delete, "#{shop}/customers/3") { customers.delete(shop_id: '1', customer_id: '3') }
+
+    expect_request(:get, "#{shop}/orders?filter%5Battributed%5D=true&filter%5Bemail_id%5D=55") do
+      orders.list(shop_id: '1', filter: { attributed: true, email_id: '55' })
+    end
+    expect_request(:get, "#{shop}/orders/9") { orders.get(shop_id: '1', order_id: '9') }
+    expect_request(:put, "#{shop}/orders/9", body: { status: 'complete' }) { orders.update(shop_id: '1', order_id: '9', params: { status: 'complete' }) }
+    expect_request(:delete, "#{shop}/orders/9") { orders.delete(shop_id: '1', order_id: '9') }
+
+    expect_request(:get, "#{shop}/carts") { carts.list(shop_id: '1') }
+    expect_request(:get, "#{shop}/carts/4") { carts.get(shop_id: '1', cart_id: '4') }
+    expect_request(:put, "#{shop}/carts/4", body: { cart_total: 10 }) { carts.update(shop_id: '1', cart_id: '4', params: { cart_total: 10 }) }
+    expect_request(:get, "#{shop}/carts/4/items") { items.list(shop_id: '1', cart_id: '4') }
+    expect_request(:get, "#{shop}/carts/4/items/8") { items.get(shop_id: '1', cart_id: '4', item_id: '8') }
+    expect_request(:post, "#{shop}/carts/4/items", body: { ecommerce_product_id: '7' }) do
+      items.create(shop_id: '1', cart_id: '4', params: { ecommerce_product_id: '7' })
+    end
+    expect_request(:put, "#{shop}/carts/4/items/8", body: { quantity: 2 }) { items.update(shop_id: '1', cart_id: '4', item_id: '8', params: { quantity: 2 }) }
+    expect_request(:delete, "#{shop}/carts/4/items/8") { items.delete(shop_id: '1', cart_id: '4', item_id: '8') }
+  end
+
+  it 'creates an order with its customer and cart' do
+    order = { customer: { email: 'a@b.test' }, cart: { items: [{ ecommerce_product_id: '7' }] } }
+
+    expect_request(:post, "#{shop}/orders", body: order) do
+      MailerLite::Ecommerce::Orders.new(client: client).create(shop_id: '1', params: order)
+    end
+  end
+
+  it 'calls the import and settings endpoints' do
+    imports = MailerLite::Ecommerce::Imports.new(client: client)
+
+    expect_request(:post, "#{shop}/products/import", body: [{ name: 'Hat' }]) { imports.products(shop_id: '1', products: [{ name: 'Hat' }]) }
+    expect_request(:post, "#{shop}/categories/import", body: [{ name: 'Hats' }]) { imports.categories(shop_id: '1', categories: [{ name: 'Hats' }]) }
+    expect_request(:post, "#{shop}/customers/import", body: [{ email: 'a@b.test' }]) { imports.customers(shop_id: '1', customers: [{ email: 'a@b.test' }]) }
+    order = { customer: { email: 'a@b.test' }, cart: { items: [{ ecommerce_product_id: '7' }] } }
+    expect_request(:post, "#{shop}/orders/import", body: { orders: [order] }) { imports.orders(shop_id: '1', orders: [order]) }
+    expect_request(:get, "#{api}/ecommerce/settings") { MailerLite::Ecommerce::Settings.new(client: client).get }
+  end
+
+  it 'calls the revenue report endpoints' do
+    campaigns = MailerLite::Campaigns.new(client: client)
+    subscribers = MailerLite::Subscribers.new(client: client)
+    automations = MailerLite::Automations.new(client: client)
+
+    expect_request(:get, "#{api}/campaigns/2/reports/ecommerce?shop_id=1") { campaigns.ecommerce_stats(campaign_id: '2', shop_id: '1') }
+    expect_request(:get, "#{api}/campaigns/2/reports/ecommerce/orders?shop_id=1&page=2") { campaigns.ecommerce_orders(campaign_id: '2', shop_id: '1', page: 2) }
+    expect_request(:get, "#{api}/subscribers/6/reports/ecommerce?shop_id=1") { subscribers.ecommerce_stats(subscriber_id: '6', shop_id: '1') }
+    expect_request(:get, "#{api}/subscribers/6/reports/ecommerce/orders?shop_id=1") { subscribers.ecommerce_orders(subscriber_id: '6', shop_id: '1') }
+    expect_request(:get, "#{api}/automations/8/monthly-totals/ecommerce") { automations.ecommerce_stats(automation_id: '8') }
+    expect_request(:get, "#{api}/automations/8/emails/9/ecommerce-overview-stats?shop_id=1") do
+      automations.email_ecommerce_stats(automation_id: '8', email_id: '9', shop_id: '1')
+    end
+    expect_request(:get, "#{api}/automations/8/order-activity?time_frame=all_time") { automations.ecommerce_orders(automation_id: '8', time_frame: 'all_time') }
+    expect_request(:get, "#{api}/automations/8/order-activity?time_frame=custom&time_frame_start=2026-10-01&time_frame_end=2026-10-31&ecommerce_shop_id=1&page=2&limit=5") do
+      automations.ecommerce_orders(automation_id: '8', time_frame: 'custom', time_frame_start: '2026-10-01', time_frame_end: '2026-10-31', shop_id: '1', page: 2, limit: 5)
+    end
+  end
+end