mailerlite-ruby 1.0.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 102aeffa28b4e834a28a6e03482f93bbbcc051bae9fc460e4211556c747471d5
-  data.tar.gz: cdb4915ff453305c4d1c839955589c0139fc38271aa7b65c1f1581ec3cb7714b
+  metadata.gz: bf06c2b614a36abc1ae9f8d33f4fa738771e56e6645c7b97c8152c7f895ef3b7
+  data.tar.gz: 1e58adc94cfaef6c71985335d8c26ec0f89f351bde8f5218c4c2073f333dc337
 SHA512:
-  metadata.gz: d992ce5751fb5509c94260284c943d35a4ce4ce39557e796b8930064886a9e57cf9e3956008d69f8b93650c03b7ef7809a6e3e6f175b06645dd0cecac990f895
-  data.tar.gz: 54b4d12eafd3e6f2816dcfed36374a9d85d45562a1caf482fe67351150024fcc1631befa6050671009ef2031c451e9219d957a69e2530993db999caa231b7e1a
+  metadata.gz: ba180fb682d7c3fb4cc7668c66031dfcd544a21febb0b390ac5f7dd7896d588b4b80bbf2d7cca40be4d43bd9d47b611e4b17ddd3c471a54c18a9f5d3983eac3e
+  data.tar.gz: 4552b68bc80f9566bb05a957e06947a95898b3726918e13877b88bfcd9e1b19f91087c53ebdf6d32e094e294eb894183047bd50d5ff7b089c8f52bddd15170c1

data/.github/workflows/main.yml

@@ -11,13 +11,13 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0
+        ruby-version: 3.1
 
     - name: Install Bundler
-      run: gem install bundler -v 2.4.22
+      run: gem install bundler -v 2.5.23
 
     - name: Install dependencies
-      run: bundle _2.4.22_ install
+      run: bundle _2.5.23_ install
 
     - name: Run tests
       run: export MAILERLITE_API_TOKEN=dummy_token && bundle exec rspec spec/*rspec.rb

data/.github/workflows/publish_gem.yml

@@ -12,15 +12,15 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Set up Ruby
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0
+          ruby-version: 3.1
 
       - name: Install Bundler
-        run: gem install bundler -v 2.4.22
+        run: gem install bundler -v 2.5.23
 
       - name: Install dependencies
-        run: bundle _2.4.22_ install
+        run: bundle _2.5.23_ install
 
       - name: Release Gem
         if: contains(github.ref, 'refs/tags/v')

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.1
   SuggestExtensions: false
   NewCops: enable
 

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [2.0.0] - 2024-12-11
+- *BREAKING CHANGE* - Please check the README file, dotenv is now optional
+- *BREAKING CHANGE* - Updated the minimal required Ruby version from 2.5 to 3.1
+
+## [1.0.6] - 2024-12-06
+- Page parameter to cursor pagination fix
+
 ## [1.0.5] - 2024-03-12
 - Update constant name
 

data/README.md

@@ -89,7 +89,15 @@ You will have to initalize it in your Ruby file with `require "mailerlite-ruby"`
 
 # Usage
 
-This SDK requires that you either have `.env` file with `MAILERLITE_API_TOKEN` env variable or that your variable is enabled system wide (useful for Docker/Kubernetes). The example of how `MAILERLITE_API_TOKEN` should look like is in `.env.example`.
+This SDK requires that you have the `MAILERLITE_API_TOKEN` environment variable set. You can set this variable in a `.env` file or enable it system-wide (useful for Docker/Kubernetes). The example of how `MAILERLITE_API_TOKEN` should look like is in `.env.example`.
+
+If you want to use `dotenv` to manage your environment variables, you can configure the `mailerlite` gem to load `dotenv`:
+
+```ruby
+MailerLite.configure do |config|
+  config.use_dotenv = true
+end
+```
 
 ## Subscribers
 
@@ -105,7 +113,7 @@ require "mailerlite-ruby"
 # Intialize the class
 subscribers = MailerLite::Subscribers.new
 
-subscribers.fetch(filter: { status: 'active' })
+subscribers.fetch(filter: { status: 'active' }, cursor: 'cursor')
 ```
 
 ### Create a subscriber
@@ -131,7 +139,7 @@ require "mailerlite-ruby"
 # Intialize the class
 subscribers = MailerLite::Subscribers.new
 
-subscribers.update(email:'some@email.com', fields: {'name': 'John', 'last_name': 'Doe'}, ip_address:'1.2.3.4', optin_ip:'1.2.3.4')
+subscribers.update('some@email.com', fields: {'name': 'John', 'last_name': 'Doe'}, ip_address:'1.2.3.4', optin_ip:'1.2.3.4')
 ```
 
 ### Get a subscriber
@@ -176,7 +184,7 @@ require "mailerlite-ruby"
 # Intialize the class
 groups = MailerLite::Groups.new
 
-groups.list(limit:10, page:1, filter:{'name': 'My'}, sort:'name')
+groups.get(limit:10, page:1, filter:{'name': 'My'}, sort:'name')
 ```
 
 ### Create a group
@@ -227,10 +235,10 @@ groups.delete(group_id)
 ```ruby
 require "mailerlite-ruby"
 
-# Intialize the class
+# Initialize the class
 groups = MailerLite::Groups.new
 
-groups.get_subscribers(group_id:1234567, page:1, limit:10, filter:{'status': 'active'})
+groups.get_subscribers(group_id: 1234567, cursor: 'cursor', limit: 10, filter: { 'status': 'active' })
 ```
 
 ### Assign subscriber to a group
@@ -483,7 +491,7 @@ require "mailerlite-ruby"
 campaigns = MailerLite::Campaigns.new
 
 campaigns.update(
-  campaign_id: 1233455, 
+  campaign_id: 1233455,
   name: "New Campaign Name",
   language_id: 2,
   emails: [{
@@ -703,7 +711,7 @@ webhooks.create(
     'subscriber.created',
     'subscriber.updated',
     'subscriber.unsubscribed'
-  ], 
+  ],
   url:'https://my-url.com',
   name: 'Webhook name'
 )
@@ -720,12 +728,12 @@ require "mailerlite-ruby"
 webhooks = MailerLite::Webhooks.new
 
 webhooks.update(
-  webhook_id: 123456, 
+  webhook_id: 123456,
   events:[
     'subscriber.created',
     'subscriber.updated',
     'subscriber.unsubscribed'
-  ], 
+  ],
   url:'https://my-url.com',
   name: 'Webhook name',
   enabled: false
@@ -784,7 +792,7 @@ campaigns.languages()
 # Testing
 
 ```bash
-bundle i 
+bundle i
 bundle exec rspec spec/*rspec.rb
 ```
 
@@ -794,7 +802,7 @@ The fixtures for the test have been recorded using vcr and are available in the
 # Generate Docs
 
 ```bash
-bundle i 
+bundle i
 bundle exec yardoc 'lib/**/*.rb'
 ```
 

data/lib/mailerlite/client.rb

@@ -1,20 +1,30 @@
 # frozen_string_literal: true
 
 require 'http'
-require 'dotenv/load'
 
 MAILERLITE_API_URL = 'https://connect.mailerlite.com/api'
 
-Dotenv.require_keys('MAILERLITE_API_TOKEN')
-
 # mailerlite-ruby is a gem that integrates all endpoints from MailerLite API
 module MailerLite
   attr_reader :api_token
 
+  class << self
+    attr_accessor :use_dotenv
+
+    def configure
+      yield self
+    end
+  end
+
   # Inits the client.
   class Client
-    def initialize(api_token = ENV.fetch('MAILERLITE_API_TOKEN', nil))
-      @api_token = api_token
+    def initialize
+      if MailerLite.use_dotenv
+        require 'dotenv'
+        Dotenv.load
+        Dotenv.require_keys('MAILERLITE_API_TOKEN')
+      end
+      @api_token = ENV.fetch('MAILERLITE_API_TOKEN', nil)
     end
 
     def headers

data/lib/mailerlite/groups/groups.rb

@@ -54,12 +54,12 @@ module MailerLite
     # @param limit [Integer] the maximum number of subscribers to return
     # @param page [Integer] the page number of the results to return
     # @return [HTTP::Response] the response from the API
-    def get_subscribers(group_id:, filter: {}, limit: nil, page: nil, sort: nil)
+    def get_subscribers(group_id:, filter: {}, limit: nil, cursor: nil, sort: nil)
       params = {}
       params['filter[status]'] = filter[:status] if filter.key?(:status)
       params['limit'] = limit if limit
       params['sort'] = sort if sort
-      params['page'] = page if page
+      params['cursor'] = cursor if cursor
       client.http.get("#{MAILERLITE_API_URL}/groups/#{group_id}/subscribers", json: params.compact)
     end
 

data/lib/mailerlite/subscribers/subscribers.rb

@@ -18,11 +18,11 @@ module MailerLite
     # @param limit [Integer] the maximum number of subscribers to return
     # @param page [Integer] the page number of the results to return
     # @return [HTTP::Response] the response from the API
-    def fetch(filter:, limit: nil, page: nil)
+    def fetch(filter:, limit: nil, cursor: nil)
       params = { 'filter[status]' => filter[:status] }
 
       params['limit'] = limit if limit
-      params['page'] = page if page
+      params['cursor'] = cursor if cursor
       uri = URI("#{MAILERLITE_API_URL}/subscribers")
       uri.query = URI.encode_www_form(params.compact)
       client.http.get(uri)

data/lib/mailerlite/version.rb

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

data/mailerlite-ruby.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.description   = "MailerLite's official Ruby SDK. Interacts with all endpoints at MailerLite API."
   spec.homepage      = 'https://www.MailerLite.com'
   spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.required_ruby_version = '>= 3.1'
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
@@ -27,13 +27,13 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 2.4.1'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rubocop', '~> 1.7'
-  spec.add_dependency 'dotenv', '~> 2.7'
-  spec.add_dependency 'http', '~> 5.0'
-  spec.add_dependency 'json', '~> 2.5'
-  spec.add_dependency 'uri', '~> 0.13.0'
+  spec.add_development_dependency 'bundler', '~> 2.5'
+  spec.add_development_dependency 'rake', '~> 13.2'
+  spec.add_development_dependency 'rubocop', '~> 1.69'
+  spec.add_dependency 'dotenv', '~> 3.1'
+  spec.add_dependency 'http', '~> 5.2'
+  spec.add_dependency 'json', '~> 2.9'
+  spec.add_dependency 'uri', '~> 1.0'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'vcr'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailerlite-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 2.0.0
 platform: ruby
 authors:
 - Nikola Milojević
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-12 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,98 +17,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.2'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.69'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.69'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: uri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -291,14 +291,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: MailerLite's official Ruby SDK