infinum_json_api_setup 0.0.3

data/spec/infinum_json_api_setup/rspec/matchers/have_resource_count_of_spec.rb

@@ -0,0 +1,43 @@
+describe InfinumJsonApiSetup::RSpec::Matchers::HaveResourceCountOf do
+  include TestHelpers::Matchers::Response
+
+  describe 'usage' do
+    context 'when data has correct number of items' do
+      it 'matches' do
+        response = response_with_body(JSON.dump(data: [1, 2]))
+
+        expect(response).to have_resource_count_of(2)
+      end
+    end
+
+    context 'when data has wrong number of items' do
+      it 'fails and describes failure reason' do
+        response = response_with_body(JSON.dump(data: [1, 2]))
+
+        expect do
+          expect(response).to have_resource_count_of(3)
+        end.to fail_with('Expected response data to have 3 items, but had 2')
+      end
+    end
+
+    context "when response isn't valid JSON" do
+      it 'fails and describes failure reason' do
+        response = response_with_body('')
+
+        expect do
+          expect(response).to have_resource_count_of(1)
+        end.to fail_with('Failed to parse response body')
+      end
+    end
+
+    context "when response doesn't contain data attribute" do
+      it 'fails and describes failure reason' do
+        response = response_with_body('{}')
+
+        expect do
+          expect(response).to have_resource_count_of(1)
+        end.to fail_with('Failed to extract data from response body')
+      end
+    end
+  end
+end

data/spec/infinum_json_api_setup/rspec/matchers/include_all_resource_ids_sorted_spec.rb

@@ -0,0 +1,53 @@
+describe InfinumJsonApiSetup::RSpec::Matchers::IncludeAllResourceIdsSorted do
+  include TestHelpers::Matchers::Response
+
+  describe 'usage' do
+    context "when ID's match" do
+      it 'matches' do
+        response = response_with_ids([1, 2])
+
+        expect(response).to include_all_resource_ids_sorted([1, 2])
+      end
+    end
+
+    context "when ID's don't match" do
+      it 'fails and describes failure reason' do
+        response = response_with_ids([1, 2, 3])
+
+        expect do
+          expect(response).to include_all_resource_ids_sorted([4])
+        end.to fail_with("Expected response ID's([1, 2, 3]) to match [4]")
+      end
+    end
+
+    context "when ID's aren't correctly ordered" do
+      it 'fails and describes failure reason' do
+        response = response_with_ids([2, 1])
+
+        expect do
+          expect(response).to include_all_resource_ids_sorted([1, 2])
+        end.to fail_with("Expected response ID's([2, 1]) to match [1, 2]")
+      end
+    end
+
+    context "when response isn't valid JSON" do
+      it 'fails and describes failure reason' do
+        response = response_with_body('')
+
+        expect do
+          expect(response).to include_all_resource_ids_sorted([1])
+        end.to fail_with('Failed to parse response body')
+      end
+    end
+
+    context "when response doesn't contain data attribute" do
+      it 'fails and describes failure reason' do
+        response = response_with_body('{}')
+
+        expect do
+          expect(response).to include_all_resource_ids_sorted([1])
+        end.to fail_with('Failed to extract data from response body')
+      end
+    end
+  end
+end

data/spec/infinum_json_api_setup/rspec/matchers/include_all_resource_ids_spec.rb

@@ -0,0 +1,49 @@
+describe InfinumJsonApiSetup::RSpec::Matchers::IncludeAllResourceIds do
+  include TestHelpers::Matchers::Response
+
+  describe 'usage' do
+    context "when ID's match" do
+      it 'matches' do
+        response = response_with_ids([1, 2])
+
+        expect(response).to include_all_resource_ids([1, 2])
+      end
+
+      it "doesn't consider ordering" do
+        response = response_with_ids([1, 2, 3])
+
+        expect(response).to include_all_resource_ids([3, 2, 1])
+      end
+    end
+
+    context "when ID's don't match" do
+      it 'fails and describes failure reason' do
+        response = response_with_ids([1, 2, 3])
+
+        expect do
+          expect(response).to include_all_resource_ids([4])
+        end.to fail_with("Expected response ID's([1, 2, 3]) to match [4]")
+      end
+    end
+
+    context "when response isn't valid JSON" do
+      it 'fails and describes failure reason' do
+        response = response_with_body('')
+
+        expect do
+          expect(response).to include_all_resource_ids([1])
+        end.to fail_with('Failed to parse response body')
+      end
+    end
+
+    context "when response doesn't contain data attribute" do
+      it 'fails and describes failure reason' do
+        response = response_with_body('{}')
+
+        expect do
+          expect(response).to include_all_resource_ids([1])
+        end.to fail_with('Failed to extract data from response body')
+      end
+    end
+  end
+end

data/spec/infinum_json_api_setup/rspec/matchers/include_all_resource_string_ids_spec.rb

@@ -0,0 +1,49 @@
+describe InfinumJsonApiSetup::RSpec::Matchers::IncludeAllResourceStringIds do
+  include TestHelpers::Matchers::Response
+
+  describe 'usage' do
+    context "when ID's match" do
+      it 'matches' do
+        response = response_with_ids(['1', '2'])
+
+        expect(response).to include_all_resource_string_ids(['1', '2'])
+      end
+
+      it "doesn't consider ordering" do
+        response = response_with_ids(['1', '2', '3'])
+
+        expect(response).to include_all_resource_string_ids(['3', '2', '1'])
+      end
+    end
+
+    context "when ID's don't match" do
+      it 'fails and describes failure reason' do
+        response = response_with_ids(['1', '2', '3'])
+
+        expect do
+          expect(response).to include_all_resource_string_ids(['4'])
+        end.to fail_with('Expected response ID\'s(["1", "2", "3"]) to match ["4"]')
+      end
+    end
+
+    context "when response isn't valid JSON" do
+      it 'fails and describes failure reason' do
+        response = response_with_body('')
+
+        expect do
+          expect(response).to include_all_resource_string_ids(['1'])
+        end.to fail_with('Failed to parse response body')
+      end
+    end
+
+    context "when response doesn't contain data attribute" do
+      it 'fails and describes failure reason' do
+        response = response_with_body('{}')
+
+        expect do
+          expect(response).to include_all_resource_string_ids(['1'])
+        end.to fail_with('Failed to extract data from response body')
+      end
+    end
+  end
+end

data/spec/infinum_json_api_setup/rspec/matchers/include_error_detail_spec.rb

@@ -0,0 +1,43 @@
+describe InfinumJsonApiSetup::RSpec::Matchers::IncludeErrorDetail do
+  include TestHelpers::Matchers::Response
+
+  describe 'usage' do
+    context 'when body includes error detail' do
+      it 'matches' do
+        response = response_with_body(JSON.dump(errors: [{ detail: 'a failure' }]))
+
+        expect(response).to include_error_detail('a failure')
+      end
+    end
+
+    context "when body doesn't include specified error detail" do
+      it 'fails and describes failure reason' do
+        response = response_with_body(JSON.dump(errors: []))
+
+        expect do
+          expect(response).to include_error_detail('a failure')
+        end.to fail_with("Expected error details to include 'a failure', but didn't")
+      end
+    end
+
+    context "when response isn't valid JSON" do
+      it 'fails and describes failure reason' do
+        response = response_with_body('')
+
+        expect do
+          expect(response).to include_error_detail('a failure')
+        end.to fail_with('Failed to parse response body')
+      end
+    end
+
+    context "when response doesn't contain data attribute" do
+      it 'fails and describes failure reason' do
+        response = response_with_body('{}')
+
+        expect do
+          expect(response).to include_error_detail('a failure')
+        end.to fail_with('Failed to extract errors from response body')
+      end
+    end
+  end
+end

data/spec/infinum_json_api_setup/rspec/matchers/include_related_resource_spec.rb

@@ -0,0 +1,43 @@
+describe InfinumJsonApiSetup::RSpec::Matchers::IncludeRelatedResource do
+  include TestHelpers::Matchers::Response
+
+  describe 'usage' do
+    context 'when body includes related resource' do
+      it 'matches' do
+        response = response_with_body(JSON.dump(included: [{ type: 'user', id: '1' }]))
+
+        expect(response).to include_related_resource('user', 1)
+      end
+    end
+
+    context "when body doesn't include specified error detail" do
+      it 'fails and describes failure reason' do
+        response = response_with_body(JSON.dump(included: []))
+
+        expect do
+          expect(response).to include_related_resource('user', 1)
+        end.to fail_with("Expected included items to include (type = user, id = 1), but didn't")
+      end
+    end
+
+    context "when response isn't valid JSON" do
+      it 'fails and describes failure reason' do
+        response = response_with_body('')
+
+        expect do
+          expect(response).to include_related_resource('user', 1)
+        end.to fail_with('Failed to parse response body')
+      end
+    end
+
+    context "when response doesn't contain data attribute" do
+      it 'fails and describes failure reason' do
+        response = response_with_body('{}')
+
+        expect do
+          expect(response).to include_related_resource('user', 1)
+        end.to fail_with('Failed to extract included from response body')
+      end
+    end
+  end
+end

data/spec/infinum_json_api_setup/rspec/matchers/util/body_parser.rb

@@ -0,0 +1,30 @@
+require 'json'
+
+module InfinumJsonApiSetup
+  module RSpec
+    module Matchers
+      module Util
+        class BodyParser
+          # @param [String] attribute
+          def initialize(attribute)
+            @attribute = attribute
+          end
+
+          # @param [ActionDispatch::TestResponse] response
+          # @return [Array]
+          def process(response)
+            [true, JSON.parse(response.body).fetch(attribute)]
+          rescue JSON::ParserError => _e
+            [false, 'Failed to parse response body']
+          rescue KeyError => _e
+            [false, "Failed to extract #{attribute} from response body"]
+          end
+
+          private
+
+          attr_reader :attribute
+        end
+      end
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,77 @@
+require 'simplecov'
+
+require 'spec_helper'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../spec/dummy/config/environment', __dir__)
+require 'rspec/rails'
+
+Dir.chdir File.expand_path('dummy', __dir__) do
+  system 'bundle exec rails generate infinum_json_api_setup:install -f -q'
+end
+
+# Add additional requires below this line. Rails is not loaded until this point!
+require 'jsonapi/query_builder'
+require 'jsonapi/serializer'
+require 'pundit'
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+Dir[File.expand_path('support/**/*.rb', __dir__)].sort.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}/spec/fixtures"
+
+  # 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")
+
+  # Enables running rspec --only-failures
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+
+  config.include TestHelpers::Request, type: :request
+  config.include TestHelpers::Response, type: :request
+end

data/spec/requests/api/v1/content_negotiation_spec.rb

@@ -0,0 +1,29 @@
+describe 'Content negotiation', type: :request do
+  it 'passes through requests demanding JSON:API compliant response' do
+    get '/api/v1/locations', headers: { accept: 'application/vnd.api+json' }
+
+    expect(response).to have_http_status(:ok)
+  end
+
+  it 'responds with 406 NotAcceptable to requests demanding non JSON:API compliant reponse' do
+    get '/api/v1/locations', headers: { accept: 'application/json' }
+
+    expect(response).to have_http_status(:not_acceptable)
+  end
+
+  it 'responds with 415 UnsupportedMediaType to requests containing non JSON:API compliant body' do
+    post '/api/v1/locations', params: { user: { name: 'Harry' } },
+                              headers: { accept: 'application/vnd.api+json',
+                                         'content-type': 'application/x-www-form-urlencoded' }
+
+    expect(response).to have_http_status(:unsupported_media_type)
+  end
+
+  it 'skips Content-Type check when request has empty body' do
+    get '/api/v1/locations', params: { user: { name: 'Harry' } },
+                             headers: { accept: 'application/vnd.api+json',
+                                        'content-type': 'application/x-www-form-urlencoded' }
+
+    expect(response).to have_http_status(:ok)
+  end
+end

data/spec/requests/api/v1/error_handling_spec.rb

@@ -0,0 +1,114 @@
+describe 'Error handling', type: :request do
+  context "when request doesn't contain required parameters" do
+    it 'responds with 400 BadRequest' do
+      post '/api/v1/locations', params: {}, headers: default_headers
+
+      expect(response).to have_http_status(:bad_request)
+      error = json_response['errors'].first
+      expect(error['title']).to eq('Bad Request')
+      expect(error['detail']).to match('param is missing or the value is empty: location')
+    end
+  end
+
+  context 'when request contains semantical errors' do
+    it 'responds with 422 UnprocessableEntity and error details' do
+      params = { latitude: 999, longitude: 999 }
+
+      post '/api/v1/locations', params: { location: params }.to_json, headers: default_headers
+
+      expect(response).to have_http_status(:unprocessable_entity)
+      expect(json_response['errors'].map { |details| details['source'] }).to contain_exactly(
+        { 'parameter' => 'latitude', 'pointer' => 'data/attributes/latitude' },
+        { 'parameter' => 'longitude', 'pointer' => 'data/attributes/longitude' }
+      )
+    end
+  end
+
+  context "when ActiveRecord can't find requested record" do
+    it 'responds with 404 NotFound' do
+      get '/api/v1/locations/0', headers: default_headers
+
+      expect(response).to have_http_status(:not_found)
+      expect(json_response['errors'].first['title']).to eq('Not found')
+      expect(json_response['errors'].first['detail']).to eq('Resource not found')
+    end
+  end
+
+  context 'when client is not authorized to perform requested action' do
+    it 'responds with 403 Forbidden' do
+      loc = create(:location, :fourth_quadrant)
+      get "/api/v1/locations/#{loc.id}", headers: default_headers
+
+      expect(response).to have_http_status(:forbidden)
+      expect(json_response['errors'].first['title']).to eq('Forbidden')
+      expect(json_response['errors'].first['detail'])
+        .to eq('You are not allowed to perform this action')
+    end
+  end
+
+  context 'when request contains unpermitted sort params' do
+    let(:bugsnag) { class_double('Bugsnag', notify: nil) }
+
+    before do
+      stub_const('Bugsnag', bugsnag)
+    end
+
+    it 'notifies Bugsnag about the incident' do
+      get '/api/v1/locations?sort=-title', headers: default_headers
+
+      expect(bugsnag).to have_received(:notify)
+    end
+
+    it 'responds with 400 BadRequest' do
+      get '/api/v1/locations?sort=-title', headers: default_headers
+
+      expect(response).to have_http_status(:bad_request)
+      error = json_response['errors'].first
+      expect(error['title']).to eq('Bad Request')
+      expect(error['detail']).to eq('title is not a permitted sort attribute')
+    end
+  end
+
+  context 'when action processing causes PG::Error' do
+    let(:location_model) { class_double('Location') }
+    let(:bugsnag) { class_double('Bugsnag', notify: nil) }
+
+    before do
+      stub_const('Bugsnag', bugsnag)
+      stub_const('Location', location_model)
+      allow(location_model).to receive(:find) { raise PG::Error }
+    end
+
+    it 'notifies Bugsnag about the incident' do
+      get '/api/v1/locations/0', headers: default_headers
+
+      expect(bugsnag).to have_received(:notify)
+    end
+
+    it 'responds with 500 InternalServerError' do
+      get '/api/v1/locations/0', headers: default_headers
+
+      expect(response).to have_http_status(:internal_server_error)
+      expect(json_response['errors'].first['title']).to eq('Internal Server Error')
+      expect(json_response['errors'].first['detail']).to eq('Something went wrong')
+    end
+  end
+
+  context 'when client requests invalid locale' do
+    it 'responds with 500 InternalServerError' do
+      get '/api/v1/locations?locale=--', headers: default_headers
+
+      expect(response).to have_http_status(:bad_request)
+      expect(json_response['errors'].first['title']).to eq('Bad Request')
+    end
+  end
+
+  context 'when client request contains unparsable params' do
+    it 'responds with 400 BadRequest' do
+      post '/api/v1/locations', params: '{', headers: default_headers
+
+      expect(response).to have_http_status(:bad_request)
+      expect(json_response['errors'].first['title']).to eq('Bad Request')
+    end
+  end
+end

data/spec/requests/api/v1/responder_spec.rb

@@ -0,0 +1,91 @@
+describe 'Responder', type: :request do
+  context 'when GET request' do
+    it 'responds with 200 OK' do
+      get '/api/v1/locations', headers: default_headers
+
+      expect(response).to have_http_status(:ok)
+    end
+  end
+
+  context 'when POST request' do
+    context 'without errors' do
+      it 'responds with 201 Created' do
+        params = { latitude: 1, longitude: 1 }
+
+        post '/api/v1/locations', params: { location: params }.to_json, headers: default_headers
+
+        expect(response).to have_http_status(:created)
+      end
+    end
+
+    context 'with errors' do
+      it 'responds with 400 BadRequest' do
+        post '/api/v1/locations', params: {}, headers: default_headers
+
+        expect(response).to have_http_status(:bad_request)
+      end
+    end
+  end
+
+  context 'when PUT request' do
+    context 'without errors' do
+      it 'responds with 200 OK' do
+        location = create(:location, latitude: 1, longitude: 1)
+        params = { latitude: 2 }
+
+        put "/api/v1/locations/#{location.id}", params: { location: params }.to_json,
+                                                headers: default_headers
+
+        expect(response).to have_http_status(:ok)
+      end
+    end
+
+    context 'with errors' do
+      it 'responds with 422 UnprocessableEntity' do
+        location = create(:location, latitude: 1, longitude: 1)
+        params = { latitude: 999 }
+
+        put "/api/v1/locations/#{location.id}", params: { location: params }.to_json,
+                                                headers: default_headers
+
+        expect(response).to have_http_status(:unprocessable_entity)
+      end
+    end
+  end
+
+  context 'when PATCH request' do
+    context 'without errors' do
+      it 'responds with 200 OK' do
+        location = create(:location, latitude: 1, longitude: 1)
+        params = { latitude: 2 }
+
+        patch "/api/v1/locations/#{location.id}", params: { location: params }.to_json,
+                                                  headers: default_headers
+
+        expect(response).to have_http_status(:ok)
+      end
+    end
+
+    context 'with errors' do
+      it 'responds with 422 UnprocessableEntity' do
+        location = create(:location, latitude: 1, longitude: 1)
+        params = { latitude: 999 }
+
+        patch "/api/v1/locations/#{location.id}", params: { location: params }.to_json,
+                                                  headers: default_headers
+
+        expect(response).to have_http_status(:unprocessable_entity)
+      end
+    end
+  end
+
+  context 'when DELETE request' do
+    it 'responds with 204 NoContent' do
+      location = create(:location, latitude: 1, longitude: 1)
+
+      delete "/api/v1/locations/#{location.id}", headers: default_headers
+
+      expect(response).to have_http_status(:no_content)
+    end
+  end
+end

data/spec/requests/api/v1/serializer_options_spec.rb

@@ -0,0 +1,46 @@
+require 'cgi'
+require 'uri'
+
+describe 'Serializer options', type: :request do
+  it 'adds meta with pagination information' do
+    get '/api/v1/locations', params: {}, headers: default_headers
+
+    expect(response).to have_http_status(:ok)
+    expect(json_response).to have_key('meta')
+    expect(json_response['meta'].keys).to include(
+      'current_page', 'total_pages', 'total_count', 'padding', 'page_size', 'max_page_size'
+    )
+  end
+
+  it 'adds links' do
+    get '/api/v1/locations', params: {}, headers: default_headers
+
+    expect(response).to have_http_status(:ok)
+    expect(json_response).to have_key('links')
+    expect(json_response['links'].keys).to include('self', 'first', 'last')
+  end
+
+  it 'adds client requested fields information to links' do
+    q = { fields: { locations: 'latitude' } }
+    get "/api/v1/locations?#{q.to_query}", params: {}, headers: default_headers
+
+    expect(response).to have_http_status(:ok)
+    expect(query_params(json_response.dig('links', 'self')))
+      .to include('fields[locations]' => ['latitude'])
+  end
+
+  it 'adds client requested include information to links' do
+    q = { include: 'labels' }
+    get "/api/v1/locations?#{q.to_query}", params: {}, headers: default_headers
+
+    expect(response).to have_http_status(:ok)
+    expect(query_params(json_response.dig('links', 'self')))
+      .to include('include' => ['labels'])
+  end
+
+  private
+
+  def query_params(link)
+    CGI.parse(URI(link).query)
+  end
+end