DE-1731: Add rubocop rspec and rake (#382)

alex-leb · web-flow · commit 6bbbbc5e2c1f · 2026-02-24T18:48:47.000+02:00
Signed-off-by: Alex Lebedev &lt;6421109+alex-leb@users.noreply.github.com&gt;
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,6 +1,12 @@
 AllCops:
   NewCops: disable
+  SuggestExtensions: false
 
+plugins:
+  - rubocop-rspec
+  - rubocop-rake
+
+# temporary disable main codebase errors
 Metrics/MethodLength:
   Enabled: false
 Metrics/BlockLength:
@@ -15,16 +21,48 @@ Metrics/AbcSize:
   Enabled: false
 Metrics/ParameterLists:
   Enabled: false
-
 Lint/MissingSuper:
   Enabled: false
-
 Style/Documentation:
   Enabled: false
-
 Style/OptionalBooleanParameter:
   Enabled: false
-
 Naming/FileName:
   Exclude:
-    - 'lib/mailgun-ruby.rb'
+    - 'lib/mailgun-ruby.rb'
+
+# temporary disable rspec errors
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/InstanceVariable:
+  Enabled: false
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+RSpec/StubbedMock:
+  Enabled: false
+RSpec/AnyInstance:
+  Enabled: false
+RSpec/MessageSpies:
+  Enabled: false
+RSpec/DescribeClass:
+  Enabled: false
+RSpec/VerifiedDoubles:
+  Enabled: false
+RSpec/NoExpectationExample:
+  Enabled: false
+RSpec/RepeatedDescription:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
+RSpec/MultipleDescribes:
+  Enabled: false
+RSpec/BeforeAfterAll:
+  Enabled: false
+RSpec/SpecFilePathFormat:
+  Enabled: false
+RSpec/ContextWording:
+  Enabled: false
+RSpec/OverwritingSetup:
+  Enabled: false
diff --git a/Rakefile b/Rakefile
@@ -30,8 +30,3 @@ RSpec::Core::RakeTask.new('spec:all') do |t|
 end
 
 task default: 'spec:unit'
-task spec: 'spec:unit'
-
-task :console do
-  sh 'pry --gem'
-end
diff --git a/mailgun.gemspec b/mailgun.gemspec
@@ -34,6 +34,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.13.0'
   spec.add_development_dependency 'rspec-its', '~> 2.0.0'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov', '~> 0.16.1'
   spec.add_development_dependency 'vcr', '~> 6.4.0'
   spec.add_development_dependency 'webmock', '~> 3.7'
diff --git a/spec/integration/analytics_tags_spec.rb b/spec/integration/analytics_tags_spec.rb
@@ -44,7 +44,7 @@
     end
   end
 
-  context '#limits' do
+  describe '#limits' do
     it 'returns limits' do
       response = mg_obj.limits
 
diff --git a/spec/integration/domains_spec.rb b/spec/integration/domains_spec.rb
@@ -44,19 +44,19 @@
       end
     end
 
-    context '#update' do
+    describe '#update' do
       let(:api_version) { 'v4' }
 
       it 'updates the domain' do
         response = mg_obj.update(domain, { spam_action: 'block', web_scheme: 'https', wildcard: true })
 
         expect(response['domain']['spam_action']).to eq('block')
         expect(response['domain']['web_scheme']).to eq('https')
-        expect(response['domain']['wildcard']).to eq(true)
+        expect(response['domain']['wildcard']).to be(true)
       end
     end
 
-    context '#verify' do
+    describe '#verify' do
       let(:api_version) { 'v4' }
 
       it 'verifies the domain' do
@@ -199,7 +199,7 @@
         )
 
         expect(result).to include('tracking')
-        expect(result['tracking']['click']['active']).to eq(false)
+        expect(result['tracking']['click']['active']).to be(false)
       end
     end
 
@@ -212,7 +212,7 @@
           }
         )
 
-        expect(result['click']['active']).to eq(false)
+        expect(result['click']['active']).to be(false)
       end
     end
 
@@ -225,7 +225,7 @@
           }
         )
 
-        expect(result['open']['active']).to eq(false)
+        expect(result['open']['active']).to be(false)
       end
     end
 
@@ -238,17 +238,11 @@
           }
         )
 
-        expect(result['unsubscribe']['active']).to eq(false)
+        expect(result['unsubscribe']['active']).to be(false)
       end
     end
   end
 
-  context 'Domain::DKIM_Security methods' do
-    # TODO: add missing:
-    # dkim_rotation
-    # dkim_rotate
-  end
-
   context 'Credentials methods' do
     # TODO: to be moved to the dedicated module
 
diff --git a/spec/integration/events_spec.rb b/spec/integration/events_spec.rb
@@ -23,8 +23,6 @@
   end
 
   it 'can iterate over all events with `each`' do
-    @events.each do |e|
-      expect(e).to have_key('event')
-    end
+    expect(@events).to all(have_key('event'))
   end
 end
diff --git a/spec/integration/list_members_spec.rb b/spec/integration/list_members_spec.rb
@@ -54,7 +54,7 @@
     expect(result.body['message']).to eq('Mailing list member has been updated')
     expect(result.body['member']['address']).to eq(@ml_member)
     expect(result.body['member']['name']).to eq('Jane Doe Update')
-    expect(result.body['member']['subscribed']).to eq(false)
+    expect(result.body['member']['subscribed']).to be(false)
   end
 
   it 'removes a list member' do
diff --git a/spec/integration/logs_spec.rb b/spec/integration/logs_spec.rb
@@ -6,7 +6,7 @@
 vcr_opts = { cassette_name: 'logs' }
 
 describe Mailgun::Logs, vcr: vcr_opts do
-  let(:logs) { Mailgun::Logs.new(Mailgun::Client.new(APIKEY, APIHOST, 'v1')) }
+  let(:logs) { described_class.new(Mailgun::Client.new(APIKEY, APIHOST, 'v1')) }
 
   describe '#account_logs' do
     let(:options) do
diff --git a/spec/integration/mailgun_spec.rb b/spec/integration/mailgun_spec.rb
@@ -115,7 +115,7 @@
   it 'fakes message send while in *client* test mode' do
     @mg_obj.enable_test_mode!
 
-    expect(@mg_obj.test_mode?).to eq(true)
+    expect(@mg_obj.test_mode?).to be(true)
 
     data = { from: "joe@#{@domain}",
              to: "bob@#{@domain}",
@@ -183,7 +183,7 @@
   it 'receives success response code' do
     @mg_obj.enable_test_mode!
 
-    expect(@mg_obj.test_mode?).to eq(true)
+    expect(@mg_obj.test_mode?).to be(true)
 
     data = { from: "joe@#{@domain}",
              to: "bob@#{@domain}",
diff --git a/spec/integration/metrics_spec.rb b/spec/integration/metrics_spec.rb
@@ -6,7 +6,7 @@
 vcr_opts = { cassette_name: 'metrics' }
 
 describe Mailgun::Metrics, vcr: vcr_opts do
-  let(:metrics) { Mailgun::Metrics.new(Mailgun::Client.new(APIKEY, APIHOST, 'v1')) }
+  let(:metrics) { described_class.new(Mailgun::Client.new(APIKEY, APIHOST, 'v1')) }
 
   describe '#account_metrics' do
     let(:options) do
diff --git a/spec/unit/events/events_spec.rb b/spec/unit/events/events_spec.rb
@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 describe 'The method get' do
-  it 'should return a proper hash of log data.' do
+  it 'returns a proper hash of log data.' do
     @mg_obj = Mailgun::UnitClient.new('events')
     events = Mailgun::Events.new(@mg_obj, 'samples.mailgun.org')
     result = events.get
@@ -14,7 +14,7 @@
 end
 
 describe 'Pagination' do
-  it 'should return a proper hash of log data.' do
+  it 'returns a proper hash of log data.' do
     @mg_obj = Mailgun::UnitClient.new('events')
     events = Mailgun::Events.new(@mg_obj, 'samples.mailgun.org')
     result = events.get
@@ -25,7 +25,7 @@
     expect(json['paging']).to include('previous')
   end
 
-  it 'should calculate proper next-page url' do
+  it 'calculates proper next-page url' do
     events = Mailgun::Events.new(@mg_obj, 'samples.mailgun.org')
     output = events.send(
       :extract_endpoint_from,
@@ -51,7 +51,7 @@
 end
 
 describe 'The method next' do
-  it 'should return the next series of data.' do
+  it 'returns the next series of data.' do
     @mg_obj = Mailgun::UnitClient.new('events')
     events = Mailgun::Events.new(@mg_obj, 'samples.mailgun.org')
     result = events.next
@@ -62,7 +62,7 @@
 end
 
 describe 'The method previous' do
-  it 'should return the previous series of data.' do
+  it 'returns the previous series of data.' do
     @mg_obj = Mailgun::UnitClient.new('events')
     events = Mailgun::Events.new(@mg_obj, 'samples.mailgun.org')
     result = events.previous
@@ -73,7 +73,7 @@
 end
 
 describe 'The method each' do
-  it 'should iterate over all event items.' do
+  it 'iterates over all event items.' do
     @mg_obj = Mailgun::UnitClient.new('events')
     events = Mailgun::Events.new(@mg_obj, 'samples.mailgun.org')
     # Events from the UnitClient are actually empty.
diff --git a/spec/unit/lists/opt_in_handler_spec.rb b/spec/unit/lists/opt_in_handler_spec.rb
@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 describe 'The method generate_hash' do
-  before(:each) do
+  before do
     @mailing_list = 'mylist@example.com'
     @secret_app_id = 'mysupersecretpassword'
     @recipient_address = 'bob@example.com'
diff --git a/spec/unit/mailgun_spec.rb b/spec/unit/mailgun_spec.rb
@@ -9,7 +9,7 @@
 end
 
 describe 'The method send_message()' do
-  before(:each) do
+  before do
     @mg_obj = Mailgun::UnitClient.new('messages')
     @domain = 'test.com'
     @list_address = 'mylist@test.com'
@@ -73,10 +73,11 @@
 end
 
 describe 'The method post()' do
-  before(:each) do
+  before do
     @mg_obj = Mailgun::UnitClient.new('messages')
     @domain = 'test.com'
   end
+
   it 'in this case, sends a simple message.' do
     data = { 'from' => 'joe@test.com',
              'to' => 'bob@example.com',
@@ -111,7 +112,7 @@
 end
 
 describe 'The method put()' do
-  before(:each) do
+  before do
     @mg_obj = Mailgun::UnitClient.new('lists')
     @domain = 'test.com'
     @list_address = 'mylist@test.com'
@@ -136,10 +137,11 @@
 end
 
 describe 'The method get()' do
-  before(:each) do
+  before do
     @mg_obj = Mailgun::UnitClient.new('bounces')
     @domain = 'test.com'
   end
+
   it 'in this case, obtains a list of bounces for the domain, limit of 5, skipping the first 10.' do
     query_string = { 'skip' => '10',
                      'limit' => '5' }
@@ -153,7 +155,7 @@
 end
 
 describe 'The method delete()' do
-  before(:each) do
+  before do
     @mg_obj = Mailgun::UnitClient.new('campaigns')
     @domain = 'test.com'
   end
diff --git a/spec/unit/messages/batch_message_spec.rb b/spec/unit/messages/batch_message_spec.rb
@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 describe 'BatchMessage attribute readers' do
-  it 'should be readable' do
+  it 'is readable' do
     @mb_client = Mailgun::UnitClient.new('messages')
     @mb_obj = Mailgun::BatchMessage.new(@mb_client, 'example.com')
 
@@ -16,7 +16,7 @@
 end
 
 describe 'The instantiation of Batch Message' do
-  before(:each) do
+  before do
     @mb_client = Mailgun::UnitClient.new('messages')
     @mb_obj = Mailgun::BatchMessage.new(@mb_client, 'example.com')
   end
@@ -63,7 +63,7 @@
 end
 
 describe 'The method add_recipient' do
-  before(:each) do
+  before do
     @mb_client = Mailgun::UnitClient.new('messages')
     @mb_obj = Mailgun::BatchMessage.new(@mb_client, 'example.com')
     @address1   = 'jane@example.com'
@@ -73,8 +73,9 @@
     @address3   = 'sam@example.com'
     @variables3 = { 'first' => 'Sam', 'last' => 'Doe', 'tracking' => 'GHI123' }
   end
+
   context 'when from is present' do
-    before(:each) do
+    before do
       @mb_obj.from('example@email.com')
     end
 
diff --git a/spec/unit/messages/message_builder_spec.rb b/spec/unit/messages/message_builder_spec.rb
diff --git a/spec/unit/railgun/content_type_spec.rb b/spec/unit/railgun/content_type_spec.rb
diff --git a/spec/unit/railgun/mailer_spec.rb b/spec/unit/railgun/mailer_spec.rb
