commons_yellowme 0.11.0 → 0.15.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (129) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +62 -0
  3. data/.rspec +3 -0
  4. data/Gemfile +12 -0
  5. data/Gemfile.lock +218 -0
  6. data/bin/test +5 -0
  7. data/commons.gemspec +36 -0
  8. data/lib/commons.rb +1 -1
  9. data/lib/commons/concerns/extensions/soft_deleted.rb +34 -0
  10. data/lib/commons/formatter/regex_constants.rb +2 -0
  11. data/lib/commons/repositories/base_repository.rb +59 -54
  12. data/lib/commons/services/concerns/callable.rb +7 -2
  13. data/lib/commons/version.rb +1 -1
  14. data/spec/commons/authentication/authenticate_by_jwt_spec.rb +37 -0
  15. data/spec/commons/authentication/json_web_token_spec.rb +41 -0
  16. data/spec/commons/concerns/attributes/sex_spec.rb +24 -0
  17. data/spec/commons/concerns/extensions/deleted_spec.rb +40 -0
  18. data/spec/commons/concerns/guard/capitalizable_spec.rb +13 -0
  19. data/spec/commons/concerns/validations/undestroyable_spec.rb +9 -0
  20. data/spec/commons/errors/bad_request_spec.rb +62 -0
  21. data/spec/commons/errors/conflict_spec.rb +62 -0
  22. data/spec/commons/errors/forbidden_spec.rb +62 -0
  23. data/spec/commons/errors/internal_server_error_spec.rb +62 -0
  24. data/spec/commons/errors/invalid_resource_spec.rb +62 -0
  25. data/spec/commons/errors/maintenance_mode_spec.rb +49 -0
  26. data/spec/commons/errors/missing_parameter_spec.rb +49 -0
  27. data/spec/commons/errors/not_unique_spec.rb +62 -0
  28. data/spec/commons/errors/payment_required_spec.rb +62 -0
  29. data/spec/commons/errors/precondition_failed_spec.rb +62 -0
  30. data/spec/commons/errors/resource_not_found_spec.rb +49 -0
  31. data/spec/commons/errors/route_not_found_spec.rb +49 -0
  32. data/spec/commons/errors/unauthorized_spec.rb +62 -0
  33. data/spec/commons/errors/unprocessable_entity_spec.rb +62 -0
  34. data/spec/commons/formatter/e164_phone_spec.rb +155 -0
  35. data/spec/commons/formatter/regex_constants_spec.rb +165 -0
  36. data/spec/commons/formatter/string_utils_spec.rb +19 -0
  37. data/spec/commons/repositories/base_repository_spec.rb +516 -0
  38. data/spec/commons/repositories/catalogs/base_catalog_spec.rb +55 -0
  39. data/spec/commons/serializers/bad_request_spec.rb +46 -0
  40. data/spec/commons/serializers/conflict_spec.rb +46 -0
  41. data/spec/commons/serializers/forbidden_spec.rb +46 -0
  42. data/spec/commons/serializers/internal_server_error_spec.rb +46 -0
  43. data/spec/commons/serializers/invalid_resource_spec.rb +46 -0
  44. data/spec/commons/serializers/maintenance_mode_spec.rb +46 -0
  45. data/spec/commons/serializers/missing_parameter_spec.rb +44 -0
  46. data/spec/commons/serializers/not_unique_spec.rb +46 -0
  47. data/spec/commons/serializers/payment_required_spec.rb +46 -0
  48. data/spec/commons/serializers/precondition_failed_spec.rb +46 -0
  49. data/spec/commons/serializers/route_not_found_spec.rb +46 -0
  50. data/spec/commons/serializers/unauthorized_spec.rb +46 -0
  51. data/spec/commons/serializers/unprocessable_entity_spec.rb +46 -0
  52. data/spec/commons/shared-examples/user_spec.rb +18 -0
  53. data/spec/dummy/.ruby-version +1 -0
  54. data/spec/dummy/Rakefile +6 -0
  55. data/spec/dummy/app/assets/config/manifest.js +2 -0
  56. data/spec/dummy/app/assets/images/.keep +0 -0
  57. data/spec/dummy/app/assets/stylesheets/application.css +15 -0
  58. data/spec/dummy/app/channels/application_cable/channel.rb +4 -0
  59. data/spec/dummy/app/channels/application_cable/connection.rb +4 -0
  60. data/spec/dummy/app/controllers/application_controller.rb +2 -0
  61. data/spec/dummy/app/controllers/concerns/.keep +0 -0
  62. data/spec/dummy/app/controllers/miscellaneous_controller.rb +13 -0
  63. data/spec/dummy/app/errors/default_handling.rb +35 -0
  64. data/spec/dummy/app/errors/error_notifier.rb +12 -0
  65. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  66. data/spec/dummy/app/javascript/packs/application.js +15 -0
  67. data/spec/dummy/app/jobs/application_job.rb +7 -0
  68. data/spec/dummy/app/mailers/application_mailer.rb +4 -0
  69. data/spec/dummy/app/models/application_record.rb +3 -0
  70. data/spec/dummy/app/models/catalogs/application_parameter.rb +6 -0
  71. data/spec/dummy/app/models/concerns/.keep +0 -0
  72. data/spec/dummy/app/models/employee.rb +3 -0
  73. data/spec/dummy/app/models/user.rb +16 -0
  74. data/spec/dummy/app/repositories/catalogs/application_parameter_repository.rb +4 -0
  75. data/spec/dummy/app/repositories/employee_repository.rb +2 -0
  76. data/spec/dummy/app/repositories/user_repository.rb +2 -0
  77. data/spec/dummy/app/views/layouts/application.html.erb +14 -0
  78. data/spec/dummy/app/views/layouts/mailer.html.erb +13 -0
  79. data/spec/dummy/app/views/layouts/mailer.text.erb +1 -0
  80. data/spec/dummy/bin/rails +4 -0
  81. data/spec/dummy/bin/rake +4 -0
  82. data/spec/dummy/bin/setup +33 -0
  83. data/spec/dummy/config.ru +5 -0
  84. data/spec/dummy/config/application.rb +29 -0
  85. data/spec/dummy/config/boot.rb +5 -0
  86. data/spec/dummy/config/cable.yml +10 -0
  87. data/spec/dummy/config/database.yml +25 -0
  88. data/spec/dummy/config/environment.rb +5 -0
  89. data/spec/dummy/config/environments/development.rb +62 -0
  90. data/spec/dummy/config/environments/production.rb +112 -0
  91. data/spec/dummy/config/environments/test.rb +48 -0
  92. data/spec/dummy/config/initializers/application_controller_renderer.rb +8 -0
  93. data/spec/dummy/config/initializers/assets.rb +12 -0
  94. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  95. data/spec/dummy/config/initializers/content_security_policy.rb +28 -0
  96. data/spec/dummy/config/initializers/cookies_serializer.rb +5 -0
  97. data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
  98. data/spec/dummy/config/initializers/inflections.rb +16 -0
  99. data/spec/dummy/config/initializers/mime_types.rb +4 -0
  100. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  101. data/spec/dummy/config/locales/en.yml +33 -0
  102. data/spec/dummy/config/puma.rb +38 -0
  103. data/spec/dummy/config/routes.rb +9 -0
  104. data/spec/dummy/config/spring.rb +6 -0
  105. data/spec/dummy/config/storage.yml +34 -0
  106. data/spec/dummy/db/migrate/20191212233443_create_user.rb +13 -0
  107. data/spec/dummy/db/migrate/20191213072543_create_application_parameters.rb +8 -0
  108. data/spec/dummy/db/migrate/20200101204534_create_employee.rb +8 -0
  109. data/spec/dummy/db/schema.rb +35 -0
  110. data/spec/dummy/lib/assets/.keep +0 -0
  111. data/spec/dummy/log/.keep +0 -0
  112. data/spec/dummy/public/404.html +67 -0
  113. data/spec/dummy/public/422.html +67 -0
  114. data/spec/dummy/public/500.html +66 -0
  115. data/spec/dummy/public/apple-touch-icon-precomposed.png +0 -0
  116. data/spec/dummy/public/apple-touch-icon.png +0 -0
  117. data/spec/dummy/public/favicon.ico +0 -0
  118. data/spec/factories/catalogs/application_parameters.rb +6 -0
  119. data/spec/factories/employees.rb +6 -0
  120. data/spec/factories/users.rb +7 -0
  121. data/spec/rails_helper.rb +68 -0
  122. data/spec/spec_helper.rb +108 -0
  123. data/spec/support/shared-examples/capitalizable.rb +16 -0
  124. data/spec/support/shared-examples/deletable.rb +39 -0
  125. data/spec/support/shared-examples/dimorphic.rb +28 -0
  126. data/spec/support/shared-examples/stripable.rb +17 -0
  127. data/spec/support/shared-examples/undestroyable.rb +8 -0
  128. metadata +249 -13
  129. data/lib/commons/concerns/extensions/deleted.rb +0 -25
@@ -5,8 +5,13 @@ module Commons
5
5
  extend ActiveSupport::Concern
6
6
 
7
7
  class_methods do
8
- def call(*args)
9
- new(*args).call
8
+ def call(*args, **kwargs)
9
+ # This approach allows thge class initializer to use regular arguments,
10
+ # named argumets or the mix of both.
11
+ # This at the same time allows the usage of Dry::Initializer
12
+ # https://dry-rb.org/gems/dry-initializer/3.0/
13
+ # And perhaps this can eventually be a defualt part of Callable Module
14
+ new(*args, **kwargs).call
10
15
  end
11
16
  end
12
17
  end
@@ -1,3 +1,3 @@
1
1
  module Commons
2
- VERSION = '0.11.0'
2
+ VERSION = '0.15.0'.freeze
3
3
  end
@@ -0,0 +1,37 @@
1
+ RSpec.describe Commons::Authentication::AuthenticateByJWT, type: :request do
2
+ describe 'when calling /misc/application_parameters' do
3
+ context 'raises error as an unauthenticated user' do
4
+ subject do
5
+ get "/misc/application_parameters",
6
+ params: {}.to_json,
7
+ headers: {
8
+ 'content-type': 'application/json'
9
+ }
10
+ response
11
+ end
12
+
13
+ it do
14
+ is_expected.to have_http_status(:unauthorized)
15
+ end
16
+ end
17
+
18
+ context 'works ok as an authenticated user' do
19
+ let(:user) { create(:user) }
20
+ let(:jwt) { Commons::Authentication::JSONWebToken.encode(user_id: user.id) }
21
+
22
+ subject do
23
+ get "/misc/application_parameters",
24
+ params: {}.to_json,
25
+ headers: {
26
+ 'content-type': 'application/json',
27
+ 'Authorization': 'Bearer ' + jwt
28
+ }
29
+ response
30
+ end
31
+
32
+ it do
33
+ is_expected.to have_http_status(:ok)
34
+ end
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,41 @@
1
+ RSpec.describe Commons::Authentication::JSONWebToken do
2
+ let(:user) { create(:user) }
3
+ let(:exp) { 24.hours.from_now }
4
+ let(:jwt) { Commons::Authentication::JSONWebToken.encode({ user_id: user.id }, exp) }
5
+
6
+ describe 'decode' do
7
+ subject { Commons::Authentication::JSONWebToken.decode(jwt) }
8
+
9
+ context 'works ok' do
10
+ it do
11
+ expect { subject }.not_to raise_error
12
+ expect(subject[:user_id]).not_to be_nil
13
+ expect(subject[:expires_at]).not_to be_nil
14
+ expect(subject[:user_id]).to eq user.id
15
+ expect(subject[:expires_at]).to eq exp.to_i
16
+ end
17
+ end
18
+
19
+ context 'raises error when invalid' do
20
+ let(:jwt) { Faker::Name.last_name }
21
+ it do
22
+ expect { subject }.to raise_error JWT::DecodeError
23
+ end
24
+ end
25
+ end
26
+
27
+ describe 'encode' do
28
+ subject { Commons::Authentication::JSONWebToken.encode({ user_id: user.id }, exp) }
29
+
30
+ context 'works ok' do
31
+ it { expect { subject }.not_to raise_error }
32
+ it do
33
+ token = Commons::Authentication::JSONWebToken.decode(subject)
34
+ expect(token[:user_id]).not_to be_nil
35
+ expect(token[:user_id]).to eq user.id
36
+ expect(token[:expires_at]).not_to be_nil
37
+ expect(token[:expires_at]).to eq exp.to_i
38
+ end
39
+ end
40
+ end
41
+ end
@@ -0,0 +1,24 @@
1
+ RSpec.describe Commons::Concerns::Attributes::Sex do
2
+ let(:sex) { Commons::Concerns::Attributes::Sex::FEMALE }
3
+ let(:user) { build(:user, name: 'rosa del barrio', last_name: 'hernandez', sex: sex) }
4
+
5
+ subject do
6
+ user
7
+ end
8
+
9
+ describe 'works ok!' do
10
+ it 'when valid data' do
11
+ expect(subject.sex).to eq sex
12
+ expect(subject.female_sex?).to be true
13
+ end
14
+ end
15
+
16
+ describe 'fails' do
17
+ subject do
18
+ user = User.new(sex: 'sex')
19
+ end
20
+ it 'when invalid sex' do
21
+ expect{ subject }.to raise_error(ArgumentError)
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,40 @@
1
+ RSpec.describe Commons::Concerns::Extensions::SoftDeleted do
2
+ let(:user) { create(:user) }
3
+
4
+ subject do
5
+ user
6
+ end
7
+
8
+ describe 'works ok!' do
9
+ it 'when existing user' do
10
+ expect(subject.deleted?).to eq false
11
+ end
12
+
13
+ it 'when existing user allows save' do
14
+ subject.name = Faker::Name.first_name
15
+ expect{ subject.save }.not_to raise_error
16
+ end
17
+
18
+ it 'when deleted user' do
19
+ # given
20
+ user = subject
21
+ user = UserRepository.instance.destroy!(user)
22
+ # do
23
+ expect(user.deleted?).to eq true
24
+ end
25
+
26
+ it 'when deleted user denies save' do
27
+ # given
28
+ user = subject
29
+ user = UserRepository.instance.destroy!(user)
30
+ user.name = Faker::Name.first_name
31
+ # do
32
+ expect{ user.save }.to raise_error(ActiveRecord::RecordInvalid)
33
+ end
34
+
35
+ it 'when model is not soft_deletable' do
36
+ # do
37
+ expect{ Employee.new }.to raise_error(ActiveModel::MissingAttributeError)
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,13 @@
1
+ RSpec.describe Commons::Concerns::Guard::Capitalizable do
2
+ let(:user) { build(:user, name: 'rosa del barrio', last_name: 'hernandez') }
3
+
4
+ subject do
5
+ user.valid?
6
+ user
7
+ end
8
+
9
+ it 'works ok!' do
10
+ expect(subject.name).to eq 'Rosa del Barrio'
11
+ expect(subject.last_name).to eq 'hernandez'
12
+ end
13
+ end
@@ -0,0 +1,9 @@
1
+ require 'spec_helper'
2
+
3
+ RSpec.describe Commons::Concerns::Validations::Undestroyable do
4
+ let(:user) { create(:user) }
5
+
6
+ it 'works ok!' do
7
+ expect { user.destroy }.to raise_error Commons::Errors::Unauthorized
8
+ end
9
+ end
@@ -0,0 +1,62 @@
1
+ describe Commons::Errors::BadRequest do
2
+ describe 'handle_error' do
3
+ context 'works with no message or validation_errors' do
4
+ it do
5
+ expect do
6
+ raise described_class
7
+ end.to raise_error(described_class)
8
+ end
9
+ end
10
+
11
+ context 'default values works ok' do
12
+ subject { described_class.new }
13
+
14
+ it do
15
+ expect do
16
+ raise subject
17
+ end.to raise_error(described_class)
18
+ end
19
+ it { expect(subject.detail).to eq I18n.t('status_code.IER4003_bad_request.detail') }
20
+ end
21
+
22
+ context 'works with message but no validation_errors' do
23
+ let(:message) { 'my totally non-existent message' }
24
+
25
+ subject { described_class.new(message) }
26
+
27
+ it do
28
+ expect do
29
+ raise subject
30
+ end.to raise_error(described_class)
31
+ end
32
+ it { expect(subject.message).to eq message }
33
+ end
34
+
35
+ context 'works with message & validation_errors' do
36
+ let(:message) { 'my totally non-existent message' }
37
+ let(:detail) { { errors: 'my totally non-existent error' } }
38
+
39
+ subject { described_class.new(message, nil, detail: detail) }
40
+
41
+ it do
42
+ expect do
43
+ raise subject
44
+ end.to raise_error(described_class)
45
+ end
46
+ it { expect(subject.detail).to eq detail }
47
+ end
48
+
49
+ context 'works with message & backtrace' do
50
+ let(:message) { 'my totally non-existent message' }
51
+
52
+ subject { described_class.new(message, [message]) }
53
+
54
+ it do
55
+ expect do
56
+ raise subject
57
+ end.to raise_error(described_class)
58
+ end
59
+ it { expect(subject.backtrace).to eq [message] }
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,62 @@
1
+ describe Commons::Errors::Conflict do
2
+ describe 'handle_error' do
3
+ context 'works with no message or validation_errors' do
4
+ it do
5
+ expect do
6
+ raise described_class
7
+ end.to raise_error(described_class)
8
+ end
9
+ end
10
+
11
+ context 'default values works ok' do
12
+ subject { described_class.new }
13
+
14
+ it do
15
+ expect do
16
+ raise subject
17
+ end.to raise_error(described_class)
18
+ end
19
+ it { expect(subject.detail).to eq I18n.t('status_code.IER4004_conflict.detail') }
20
+ end
21
+
22
+ context 'works with message but no validation_errors' do
23
+ let(:message) { 'my totally non-existent message' }
24
+
25
+ subject { described_class.new(message) }
26
+
27
+ it do
28
+ expect do
29
+ raise subject
30
+ end.to raise_error(described_class)
31
+ end
32
+ it { expect(subject.message).to eq message }
33
+ end
34
+
35
+ context 'works with message & validation_errors' do
36
+ let(:message) { 'my totally non-existent message' }
37
+ let(:detail) { { errors: 'my totally non-existent error' } }
38
+
39
+ subject { described_class.new(message, nil, detail: detail) }
40
+
41
+ it do
42
+ expect do
43
+ raise subject
44
+ end.to raise_error(described_class)
45
+ end
46
+ it { expect(subject.detail).to eq detail }
47
+ end
48
+
49
+ context 'works with message & backtrace' do
50
+ let(:message) { 'my totally non-existent message' }
51
+
52
+ subject { described_class.new(message, [message]) }
53
+
54
+ it do
55
+ expect do
56
+ raise subject
57
+ end.to raise_error(described_class)
58
+ end
59
+ it { expect(subject.backtrace).to eq [message] }
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,62 @@
1
+ describe Commons::Errors::Forbidden do
2
+ describe 'handle_error' do
3
+ context 'works with no message or validation_errors' do
4
+ it do
5
+ expect do
6
+ raise described_class
7
+ end.to raise_error(described_class)
8
+ end
9
+ end
10
+
11
+ context 'default values works ok' do
12
+ subject { described_class.new }
13
+
14
+ it do
15
+ expect do
16
+ raise subject
17
+ end.to raise_error(described_class)
18
+ end
19
+ it { expect(subject.detail).to eq I18n.t('status_code.IER4005_forbidden.detail') }
20
+ end
21
+
22
+ context 'works with message but no validation_errors' do
23
+ let(:message) { 'my totally non-existent message' }
24
+
25
+ subject { described_class.new(message) }
26
+
27
+ it do
28
+ expect do
29
+ raise subject
30
+ end.to raise_error(described_class)
31
+ end
32
+ it { expect(subject.message).to eq message }
33
+ end
34
+
35
+ context 'works with message & validation_errors' do
36
+ let(:message) { 'my totally non-existent message' }
37
+ let(:detail) { { errors: 'my totally non-existent error' } }
38
+
39
+ subject { described_class.new(message, nil, detail: detail) }
40
+
41
+ it do
42
+ expect do
43
+ raise subject
44
+ end.to raise_error(described_class)
45
+ end
46
+ it { expect(subject.detail).to eq detail }
47
+ end
48
+
49
+ context 'works with message & backtrace' do
50
+ let(:message) { 'my totally non-existent message' }
51
+
52
+ subject { described_class.new(message, [message]) }
53
+
54
+ it do
55
+ expect do
56
+ raise subject
57
+ end.to raise_error(described_class)
58
+ end
59
+ it { expect(subject.backtrace).to eq [message] }
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,62 @@
1
+ describe Commons::Errors::InternalServerError do
2
+ describe 'handle_error' do
3
+ context 'works with no message or validation_errors' do
4
+ it do
5
+ expect do
6
+ raise described_class
7
+ end.to raise_error(described_class)
8
+ end
9
+ end
10
+
11
+ context 'default values works ok' do
12
+ subject { described_class.new }
13
+
14
+ it do
15
+ expect do
16
+ raise subject
17
+ end.to raise_error(described_class)
18
+ end
19
+ it { expect(subject.detail).to eq I18n.t('status_code.IER5000_internal_server_error.detail') }
20
+ end
21
+
22
+ context 'works with message but no validation_errors' do
23
+ let(:message) { 'my totally non-existent message' }
24
+
25
+ subject { described_class.new(message) }
26
+
27
+ it do
28
+ expect do
29
+ raise subject
30
+ end.to raise_error(described_class)
31
+ end
32
+ it { expect(subject.message).to eq message }
33
+ end
34
+
35
+ context 'works with message & validation_errors' do
36
+ let(:message) { 'my totally non-existent message' }
37
+ let(:detail) { { errors: 'my totally non-existent error' } }
38
+
39
+ subject { described_class.new(message, nil, detail: detail) }
40
+
41
+ it do
42
+ expect do
43
+ raise subject
44
+ end.to raise_error(described_class)
45
+ end
46
+ it { expect(subject.detail).to eq detail }
47
+ end
48
+
49
+ context 'works with message & backtrace' do
50
+ let(:message) { 'my totally non-existent message' }
51
+
52
+ subject { described_class.new(message, [message]) }
53
+
54
+ it do
55
+ expect do
56
+ raise subject
57
+ end.to raise_error(described_class)
58
+ end
59
+ it { expect(subject.backtrace).to eq [message] }
60
+ end
61
+ end
62
+ end