n_base_rails 0.1.1

data/lib/spec/controllers/api/v1/users_controller_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::SessionsController, type: :request do
+  describe "GET #show" do
+    include_context "user_logged_in"
+
+    before do
+      get api_v1_user_path(user.id), headers: headers
+    end
+
+    context "when get user details success" do
+      it "should return status 200" do
+        expect(response.status).to eq 200
+        expect(json_response["success"]).to eq true
+        expect(json_response["data"]["user"].present?).to eq true
+      end
+    end
+
+    include_examples :user_authentication
+  end
+end

data/lib/spec/factories/admins.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :admin do
+    email {Faker::Internet.email}
+    password {"Aa@123456"}
+  end
+end

data/lib/spec/factories/devices.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :device do
+    refresh_token {Digest::SHA1.hexdigest([Time.zone.now, rand].join)}
+  end
+end

data/lib/spec/factories/posts.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :post do
+  end
+end

data/lib/spec/factories/users.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :user do
+    email {Faker::Internet.email}
+    password {"Aa@123456"}
+  end
+end

data/lib/spec/helpers/request_helpers.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RequestHelpers
+  def json_response
+    JSON.parse(response.body)
+  end
+end

data/lib/spec/models/admin_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Admin, type: :model do
+  context "associations" do
+    it {is_expected.to have_many(:devices).dependent(:destroy)}
+  end
+end

data/lib/spec/models/device_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Device, type: :model do
+  context "associations" do
+    it {is_expected.to belong_to :resourceable}
+  end
+
+  context "enum" do
+    it {should define_enum_for(:platform).with_values({web: 0, ios: 1, android: 2})}
+  end
+end

data/lib/spec/models/post_spec.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Post, type: :model do
+end

data/lib/spec/models/user_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe User, type: :model do
+  context "associations" do
+    it {is_expected.to have_many(:devices).dependent(:destroy)}
+  end
+end

data/lib/spec/rails_helper.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require "spec_helper"
+
+ENV["RAILS_ENV"] ||= "test"
+require_relative "../config/environment"
+require Rails.root.join("config/routes.rb")
+
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require "rspec/rails"
+
+# Add additional requires below this line. Rails is not loaded until this point!
+Dir[Rails.root.join("spec/supports/**/*.rb")].sort.each {|f| require f}
+Dir[Rails.root.join("spec/helpers/**/*.rb")].each {|f| require f}
+# Checks for pending migrations and applies them before tests are run.
+# If you are not using ActiveRecord, you can remove these lines.
+begin
+  ActiveRecord::Migration.maintain_test_schema!
+rescue ActiveRecord::PendingMigrationError => e
+  puts e.to_s.strip
+  exit 1
+end
+
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = Rails.root.join("spec/fixtures")
+  config.include RequestHelpers
+  config.include FactoryBot::Syntax::Methods
+  config.include Rails.application.routes.url_helpers
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # You can uncomment this line to turn off ActiveRecord support entirely.
+  # config.use_active_record = false
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, type: :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+end
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end

data/lib/spec/serializers/api/admin/user_serializer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::Admin::UserSerializer, type: :serializer do
+  let(:user) {create :user}
+
+  describe "#users_list" do
+    let(:params) {{type: :user_list}}
+    let(:serialized_user) {described_class.new(user, params).serializable_hash}
+
+    context "when get correct attributes" do
+      it "should includes all attributes" do
+        expect(serialized_user[:id]).to eq user.id
+        expect(serialized_user[:email]).to eq user.email
+        expect(serialized_user).to include(:email, :id)
+      end
+    end
+  end
+end

data/lib/spec/serializers/api/v1/user_serializer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::UserSerializer, type: :serializer do
+  let(:user) {create :user}
+
+  describe "#user_details" do
+    let(:params) {{type: :user_details}}
+    let(:serialized_user) {described_class.new(user, params).serializable_hash}
+
+    context "when get correct attributes" do
+      it "should includes all attributes" do
+        expect(serialized_user[:id]).to eq user.id
+        expect(serialized_user[:email]).to eq user.email
+        expect(serialized_user).to include(:email, :id)
+      end
+    end
+  end
+end

data/lib/spec/spec_helper.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #   config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   # https://relishapp.com/rspec/rspec-core/docs/configuration/zero-monkey-patching-mode
+  #   config.disable_monkey_patching!
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = "doc"
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

data/lib/spec/supports/shared_context.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+RSpec.shared_context "user_logged_in" do
+  let!(:user) {create :user, email: "test@example.com", password: "password"}
+  let(:headers) {{Authorization: json_response["data"]["access_token"]}}
+
+  before do
+    post api_v1_sign_in_path, params: {user: {email: user.email, password: "password"}}
+  end
+end
+
+RSpec.shared_context "admin_logged_in" do
+  let!(:admin) {create :admin, email: "test@example.com", password: "password"}
+  let(:headers) {{Authorization: json_response["data"]["access_token"]}}
+
+  before do
+    post api_admin_sign_in_path, params: {admin: {email: admin.email, password: "password"}}
+  end
+end

data/lib/spec/supports/shared_example/admin_authentication.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples :admin_authentication do |_action|
+  context "when the token is invalid" do
+    let(:headers) {{Authorization: "invalid_token"}}
+
+    it "returns a 401 status" do
+      expect(response.status).to eq 401
+      expect(json_response["success"]).to eq false
+      expect(json_response["errors"][0]["code"]).to eq 1204
+      expect(json_response["errors"][0]["message"]).to eq "Invalid Token"
+    end
+  end
+
+  context "when the token is invalid type" do
+    let(:headers) {{Authorization: JsonWebToken.encode({id: admin.id, resource_type: "invalid_type"})}}
+
+    it "returns a 401 status" do
+      expect(response.status).to eq 401
+      expect(json_response["success"]).to eq false
+      expect(json_response["errors"][0]["code"]).to eq 1204
+      expect(json_response["errors"][0]["message"]).to eq "Invalid Token"
+    end
+  end
+
+  context "when the token is invalid author resource" do
+    let(:headers) {{Authorization: JsonWebToken.encode({id: 0, resource_type: "admin"})}}
+
+    it "returns a 401 status" do
+      expect(response.status).to eq 401
+      expect(json_response["success"]).to eq false
+      expect(json_response["errors"][0]["code"]).to eq 1204
+      expect(json_response["errors"][0]["message"]).to eq "Invalid Token"
+    end
+  end
+
+  context "when the token is invalid device" do
+    let(:headers) {{Authorization: JsonWebToken.encode({id: admin.id, resource_type: "admin", device_id: 0})}}
+
+    it "returns a 401 status" do
+      expect(response.status).to eq 401
+      expect(json_response["success"]).to eq false
+      expect(json_response["errors"][0]["code"]).to eq 1204
+      expect(json_response["errors"][0]["message"]).to eq "Invalid Token"
+    end
+  end
+end

data/lib/spec/supports/shared_example/user_authentication.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples :user_authentication do |_action|
+  context "when the token is invalid" do
+    let(:headers) {{Authorization: "invalid_token"}}
+
+    it "returns a 401 status" do
+      expect(response.status).to eq 401
+      expect(json_response["success"]).to eq false
+      expect(json_response["errors"][0]["code"]).to eq 1204
+      expect(json_response["errors"][0]["message"]).to eq "Invalid Token"
+    end
+  end
+
+  context "when the token is invalid type" do
+    let(:headers) {{Authorization: JsonWebToken.encode({id: user.id, resource_type: "invalid_type"})}}
+
+    it "returns a 401 status" do
+      expect(response.status).to eq 401
+      expect(json_response["success"]).to eq false
+      expect(json_response["errors"][0]["code"]).to eq 1204
+      expect(json_response["errors"][0]["message"]).to eq "Invalid Token"
+    end
+  end
+
+  context "when the token is invalid author resource" do
+    let(:headers) {{Authorization: JsonWebToken.encode({id: 0, resource_type: "User"})}}
+
+    it "returns a 401 status" do
+      expect(response.status).to eq 401
+      expect(json_response["success"]).to eq false
+      expect(json_response["errors"][0]["code"]).to eq 1204
+      expect(json_response["errors"][0]["message"]).to eq "Invalid Token"
+    end
+  end
+
+  context "when the token is invalid device" do
+    let(:headers) {{Authorization: JsonWebToken.encode({id: user.id, resource_type: "User", device_id: 0})}}
+
+    it "returns a 401 status" do
+      expect(response.status).to eq 401
+      expect(json_response["success"]).to eq false
+      expect(json_response["errors"][0]["code"]).to eq 1204
+      expect(json_response["errors"][0]["message"]).to eq "Invalid Token"
+    end
+  end
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: n_base_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Do Huy Thanh
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-08 00:00:00.000000000 Z
+dependencies: []
+description: It good for create base shortly
+email:
+- thanhdh@nal.vn
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/.env
+- lib/.rspec
+- lib/.rubocop.yml
+- lib/.rubocop_disabled.yml
+- lib/.rubocop_enabled.yml
+- lib/Capfile
+- lib/Gemfile
+- lib/config/database.yml
+- lib/config/deploy.rb
+- lib/config/deploy/development.rb
+- lib/config/deploy/production.rb
+- lib/config/deploy/staging.rb
+- lib/config/initializers/devise.rb
+- lib/config/locales/devise.en.yml
+- lib/config/locales/en.yml
+- lib/config/locales/errors.en.yml
+- lib/config/routes.rb
+- lib/config/settings.yml
+- lib/controllers/api/admin/base_controller.rb
+- lib/controllers/api/admin/sessions_controller.rb
+- lib/controllers/api/admin/users_controller.rb
+- lib/controllers/api/v1/base_controller.rb
+- lib/controllers/api/v1/sessions_controller.rb
+- lib/controllers/api/v1/users_controller.rb
+- lib/controllers/application_controller.rb
+- lib/controllers/concerns/.DS_Store
+- lib/controllers/concerns/.keep
+- lib/controllers/concerns/base_concern.rb
+- lib/controllers/concerns/json_renderer.rb
+- lib/controllers/concerns/pagination.rb
+- lib/controllers/concerns/rescue_exception.rb
+- lib/db/migrate/20220721091426_devise_create_users.rb
+- lib/db/migrate/20230113072522_create_devices.rb
+- lib/db/migrate/20230227135020_create_posts.rb
+- lib/db/migrate/20230303165318_devise_create_admins.rb
+- lib/db/schema.rb
+- lib/db/seeds.rb
+- lib/generators/n_base_rails/install_generator.rb
+- lib/lib/.DS_Store
+- lib/lib/active_record_validation/error.rb
+- lib/lib/api/error.rb
+- lib/lib/json_web_token.rb
+- lib/log/.keep
+- lib/log/capistrano.log
+- lib/log/development.log
+- lib/log/test.log
+- lib/models/admin.rb
+- lib/models/application_record.rb
+- lib/models/concerns/.keep
+- lib/models/device.rb
+- lib/models/post.rb
+- lib/models/user.rb
+- lib/n_base_rails.rb
+- lib/n_base_rails/version.rb
+- lib/public/404.html
+- lib/public/422.html
+- lib/public/500.html
+- lib/public/apple-touch-icon-precomposed.png
+- lib/public/apple-touch-icon.png
+- lib/public/docs/api/admin/definitions/users.yaml
+- lib/public/docs/api/admin/paths/index.yaml
+- lib/public/docs/api/admin/paths/sessions.yaml
+- lib/public/docs/api/admin/paths/users.yaml
+- lib/public/docs/api/shared/meta_infos.yaml
+- lib/public/docs/api/shared/unauthorized_response.yaml
+- lib/public/docs/api/v1/definitions/users.yaml
+- lib/public/docs/api/v1/paths/example.yaml
+- lib/public/docs/api/v1/paths/index.yaml
+- lib/public/docs/api/v1/paths/sessions.yaml
+- lib/public/docs/api/v1/paths/users.yaml
+- lib/public/favicon.ico
+- lib/public/robots.txt
+- lib/public/swagger/admin/admin-swagger-initializer.js
+- lib/public/swagger/admin/admin.html
+- lib/public/swagger/favicon-16x16.png
+- lib/public/swagger/favicon-32x32.png
+- lib/public/swagger/index.css
+- lib/public/swagger/oauth2-redirect.html
+- lib/public/swagger/swagger-ui-bundle.js
+- lib/public/swagger/swagger-ui-bundle.js.map
+- lib/public/swagger/swagger-ui-es-bundle-core.js
+- lib/public/swagger/swagger-ui-es-bundle-core.js.map
+- lib/public/swagger/swagger-ui-es-bundle.js
+- lib/public/swagger/swagger-ui-es-bundle.js.map
+- lib/public/swagger/swagger-ui-standalone-preset.js
+- lib/public/swagger/swagger-ui-standalone-preset.js.map
+- lib/public/swagger/swagger-ui.css
+- lib/public/swagger/swagger-ui.css.map
+- lib/public/swagger/swagger-ui.js
+- lib/public/swagger/swagger-ui.js.map
+- lib/public/swagger/v1/app.html
+- lib/public/swagger/v1/swagger-initializer.js
+- lib/serializers/.DS_Store
+- lib/serializers/action_not_allowed_serializer.rb
+- lib/serializers/api/.DS_Store
+- lib/serializers/api/admin/base_serializer.rb
+- lib/serializers/api/admin/hash_serializer.rb
+- lib/serializers/api/admin/user_serializer.rb
+- lib/serializers/api/v1/base_serializer.rb
+- lib/serializers/api/v1/hash_serializer.rb
+- lib/serializers/api/v1/user_serializer.rb
+- lib/serializers/record_not_found_serializer.rb
+- lib/serializers/validation_error_serializer.rb
+- lib/services/api/admin/generate_access_token_service.rb
+- lib/services/api/admin/generate_refresh_token_service.rb
+- lib/services/api/authorize_request_service.rb
+- lib/services/api/v1/generate_access_token_service.rb
+- lib/services/api/v1/generate_refresh_token_service.rb
+- lib/spec/controllers/api/admin/sessions_controller_spec.rb
+- lib/spec/controllers/api/admin/users_controller_spec.rb
+- lib/spec/controllers/api/v1/sessions_controller_spec.rb
+- lib/spec/controllers/api/v1/users_controller_spec.rb
+- lib/spec/factories/admins.rb
+- lib/spec/factories/devices.rb
+- lib/spec/factories/posts.rb
+- lib/spec/factories/users.rb
+- lib/spec/helpers/request_helpers.rb
+- lib/spec/models/admin_spec.rb
+- lib/spec/models/device_spec.rb
+- lib/spec/models/post_spec.rb
+- lib/spec/models/user_spec.rb
+- lib/spec/rails_helper.rb
+- lib/spec/serializers/api/admin/user_serializer.rb
+- lib/spec/serializers/api/v1/user_serializer.rb
+- lib/spec/spec_helper.rb
+- lib/spec/supports/shared_context.rb
+- lib/spec/supports/shared_example/admin_authentication.rb
+- lib/spec/supports/shared_example/user_authentication.rb
+homepage: http://rubygems.org/gems/n_base_rails
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/huythanh176/n_base_rails
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: NBaseRails is the gem to create base for rails api
+test_files: []