mailerlite-ruby 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24c0e7de260800159f65b77ed7de5e14bd081027063960187f72e26832eec6a4
-  data.tar.gz: b9bacc2dbd3b1a1ae9807045307185a0d5d4e66981e4e966424f7ff08932e550
+  metadata.gz: ca13a21a170a5491fc4131d379f7f9618e7d75938956c04799f48daa030e6248
+  data.tar.gz: e490234cdda5ceeb25769b2d64cbdc4b3c132d8afcdae30f902ea276c64da628
 SHA512:
-  metadata.gz: 6e7fbe796f01f62f16c018d0e4af071fcfe19843ffb80ac284100a93d7c9281093f0bf5b9882253ee22dbaefbd0d84e41eb12e4a775ea95398f3243dae831670
-  data.tar.gz: 31e6cccbbfedf736691e45051462bb590478d45c84996f882d41b66c58ad515daaeba635df752ab7fc7f9d03d6bd63dd9005c684cc9050901b4ae0059d8e78f9
+  metadata.gz: 141af02c1a738eaadfb3e79fc7f4e83400a59b860013cbbbc0ad04efd26049e9a18007a1d93f0fdb5506e78027cd6c902065dd954ddb1c2f74a084b3f4b3e3a8
+  data.tar.gz: 216f1ae8efebc7a8978ea8807e455e343a0faaf6c2304befdb25324891ac249a295d8c5db9f9b9262ddf08f0cc56a5dc424be2595036afc975c38917f83c2c47

data/.github/workflows/publish_gem.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Release Gem
         if: contains(github.ref, 'refs/tags/v')

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [1.0.4] - 2023-11-20
+- Update subscribers update
+- Add forget subscriber method
+
 ## [1.0.3] - 2023-06-02
 - Documentation update
 - mailerlite.rb missing version

data/README.md

@@ -243,7 +243,7 @@ require "mailerlite-ruby"
 # Intialize the class
 groups = MailerLite::Groups.new
 
-subscribers.assign_subscriber(subscriber_id:111222, group_id:1234567)
+groups.assign_subscriber(subscriber:111222, group_id:1234567)
 ```
 
 ### Unassign subscriber from a group
@@ -256,7 +256,7 @@ require "mailerlite-ruby"
 # Intialize the class
 groups = MailerLite::Groups.new
 
-subscribers.unassign_subscriber(subscriber_id:111222, group_id:1234567)
+groups.unassign_subscriber(subscriber:111222, group_id:1234567)
 ```
 
 ## Segments
@@ -798,4 +798,4 @@ bundle i
 bundle exec yardoc 'lib/**/*.rb'
 ```
 
-This will generate html docs in the doc directory which can be opened up in any browser. Navigate to index.html and open it up.
+This will generate html docs in the doc directory which can be opened up in any browser. Navigate to index.html and open it up.

data/fixtures/subscribers/forget.yml

@@ -0,0 +1,62 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://connect.mailerlite.com/api/subscribers/98121614828242796/forget
+    body:
+      encoding: ASCII-8BIT
+      string: ''
+    headers:
+      Authorization:
+      - "<AUTH>"
+      User-Agent:
+      - MailerLite-client-ruby/1.0.3
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Connection:
+      - close
+      Host:
+      - connect.mailerlite.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 01 Sep 2023 13:48:18 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - close
+      Cache-Control:
+      - no-cache, private
+      X-Locale:
+      - en
+      X-Ratelimit-Limit:
+      - '120'
+      X-Ratelimit-Remaining:
+      - '117'
+      Access-Control-Allow-Origin:
+      - "*"
+      Strict-Transport-Security:
+      - max-age=15724800; includeSubDomains
+      Via:
+      - Ingress
+      Cf-Cache-Status:
+      - DYNAMIC
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 7ffdf84ede2b1096-HKG
+    body:
+      encoding: UTF-8
+      string: '{"data":{"id":"98121614828242796","email":"test@mail.com","status":"active","source":"api","sent":0,"opens_count":0,"clicks_count":0,"open_rate":0,"click_rate":0,"ip_address":null,"subscribed_at":"2023-09-01
+        13:47:44","unsubscribed_at":null,"created_at":"2023-09-01 13:47:43","updated_at":"2023-09-01
+        13:48:17","deleted_at":"2023-09-01 13:48:17","forget_at":"2023-10-01 13:48:17","fields":{"name":null,"last_name":null,"company":null,"country":null,"city":null,"phone":null,"state":null,"z_i_p":null,"github_handle":null},"groups":[],"location":null,"opted_in_at":null,"optin_ip":null},"message":"Subscriber
+        data will be completely deleted and forgotten within 30 days."}'
+  recorded_at: Fri, 01 Sep 2023 13:48:18 GMT
+recorded_with: VCR 6.2.0

data/fixtures/subscribers/update.yml

@@ -0,0 +1,61 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: https://connect.mailerlite.com/api/subscribers/98112484192290662
+    body:
+      encoding: ASCII-8BIT
+      string: '{"email":"updated@email.com"}'
+    headers:
+      Authorization:
+      - "<AUTH>"
+      User-Agent:
+      - MailerLite-client-ruby/1.0.3
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Connection:
+      - close
+      Host:
+      - connect.mailerlite.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 01 Sep 2023 11:24:29 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - close
+      Cache-Control:
+      - no-cache, private
+      X-Locale:
+      - en
+      X-Ratelimit-Limit:
+      - '120'
+      X-Ratelimit-Remaining:
+      - '119'
+      Access-Control-Allow-Origin:
+      - "*"
+      Strict-Transport-Security:
+      - max-age=15724800; includeSubDomains
+      Via:
+      - Ingress
+      Cf-Cache-Status:
+      - DYNAMIC
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 7ffd25a40bf22118-HKG
+    body:
+      encoding: UTF-8
+      string: '{"data":{"id":"98112484192290662","email":"updated@email.com","status":"active","source":"api","sent":0,"opens_count":0,"clicks_count":0,"open_rate":0,"click_rate":0,"ip_address":null,"subscribed_at":"2023-09-01
+        11:22:36","unsubscribed_at":null,"created_at":"2023-09-01 11:22:36","updated_at":"2023-09-01
+        11:24:29","fields":{"name":null,"last_name":null,"company":null,"country":null,"city":null,"phone":null,"state":null,"z_i_p":null,"github_handle":null},"groups":[],"location":null,"opted_in_at":null,"optin_ip":null}}'
+  recorded_at: Fri, 01 Sep 2023 11:24:29 GMT
+recorded_with: VCR 6.2.0

data/lib/mailerlite/subscribers/subscribers.rb

@@ -55,8 +55,9 @@ module MailerLite
       client.http.post("#{API_URL}/subscribers", json: params.compact)
     end
 
-    # Creates a new subscriber with the specified details.
+    # Updates an existing subscriber with the specified details.
     #
+    # @param subscriber_id [String] the ID of the subscriber to update
     # @param email [String] the email address of the new subscriber
     # @param fields [Hash] a hash of custom fields and their values for the subscriber
     # @param groups [Array] an array of group IDs to add the subscriber to
@@ -67,9 +68,10 @@ module MailerLite
     # @param optin_ip [String] the IP address of the subscriber when they confirmed their subscription
     # @param unsubscribed_at [DateTime] the date and time when the subscriber was unsubscribed
     # @return [HTTP::Response] the response from the API
-    def update(email:, fields: nil, groups: nil, status: nil, subscribed_at: nil, ip_address: nil, opted_in_at: nil, optin_ip: nil, unsubscribed_at: nil)
-      params = { 'email' => email }
+    def update(subscriber_id, email: nil, fields: nil, groups: nil, status: nil, subscribed_at: nil, ip_address: nil, opted_in_at: nil, optin_ip: nil, unsubscribed_at: nil)
+      params = {}
 
+      params['email'] = email if email
       params['fields'] = fields if fields
       params['groups'] = groups if groups
       params['status'] = status if status
@@ -79,7 +81,7 @@ module MailerLite
       params['optin_ip'] = optin_ip if optin_ip
       params['unsubscribed_at'] = unsubscribed_at if unsubscribed_at
 
-      client.http.post("#{API_URL}/subscribers", json: params.compact)
+      client.http.put("#{API_URL}/subscribers/#{subscriber_id}", json: params.compact)
     end
 
     # Returns the details of the specified subscribers
@@ -112,5 +114,13 @@ module MailerLite
     def delete(subscriber_id)
       client.http.delete("#{API_URL}/subscribers/#{subscriber_id}")
     end
+
+    # Forgets the specified subscriber.
+    #
+    # @param subscriber_id [String] the ID of the subscriber to forget
+    # @return [HTTP::Response] the response from the API
+    def forget(subscriber_id)
+      client.http.post("#{API_URL}/subscribers/#{subscriber_id}/forget")
+    end
   end
 end

data/lib/mailerlite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MailerLite
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

data/spec/subscribers_rspec.rb

@@ -72,6 +72,18 @@ RSpec.describe MailerLite::Subscribers do
     end
   end
 
+  describe '#update' do
+    # Use VCR to record and replay the HTTP request
+    it 'updates a subscriber' do
+      VCR.use_cassette('subscribers/update') do
+        response = subscribers.update(98_112_484_192_290_662, email: 'updated@email.com')
+        body = JSON.parse(response.body)
+        expect(response.status).to eq 200
+        expect(body['data']['email']).to eq 'updated@email.com'
+      end
+    end
+  end
+
   describe '#delete' do
     # Use VCR to record and replay the HTTP request
     it 'deletes a subscriber' do
@@ -81,4 +93,16 @@ RSpec.describe MailerLite::Subscribers do
       end
     end
   end
+
+  describe '#forget' do
+    # Use VCR to record and replay the HTTP request
+    it 'forgets a subscriber' do
+      VCR.use_cassette('subscribers/forget') do
+        response = subscribers.forget(98_121_614_828_242_796)
+        body = JSON.parse(response.body)
+        expect(response.status).to eq 200
+        expect(body['message']).to eq 'Subscriber data will be completely deleted and forgotten within 30 days.'
+      end
+    end
+  end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: mailerlite-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Nikola Milojević
 - Ahsan Gondal
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-02 00:00:00.000000000 Z
+date: 2023-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -238,7 +238,9 @@ files:
 - fixtures/subscribers/delete.yml
 - fixtures/subscribers/fetch.yml
 - fixtures/subscribers/fetch_count.yml
+- fixtures/subscribers/forget.yml
 - fixtures/subscribers/get.yml
+- fixtures/subscribers/update.yml
 - fixtures/timezones/list.yml
 - fixtures/webhooks/create.yml
 - fixtures/webhooks/delete.yml
@@ -281,7 +283,7 @@ metadata:
   source_code_uri: https://github.com/mailerlite/mailerlite-ruby
   changelog_uri: https://github.com/mailerlite/mailerlite-ruby/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -297,7 +299,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.10
-signing_key: 
+signing_key:
 specification_version: 4
 summary: MailerLite's official Ruby SDK
 test_files: []