apress-api 1.22.0

data/lib/apress/api/callbacks/repeat_callback_error.rb

@@ -0,0 +1,12 @@
+module Apress
+  module Api
+    module Callbacks
+      class RepeatCallbackError < StandardError
+        def initialize(message, backtrace)
+          super(message)
+          set_backtrace(backtrace)
+        end
+      end
+    end
+  end
+end

data/lib/apress/api/engine.rb

@@ -0,0 +1,33 @@
+require 'rails/engine'
+
+module Apress
+  module Api
+    class Engine < Rails::Engine
+      config.autoload_paths << config.root.join("lib")
+      config.paths.add 'app/docs', eager_load: false
+
+      Apress::Documentation.add_load_path(config.root.join('app/docs'))
+
+      initializer "apress-api", before: :load_init_rb do |app|
+        app.config.paths["db/migrate"].concat(config.paths["db/migrate"].expanded)
+
+        app.config.api = {
+          secret_token_ttl: 1.hour,
+          refresh_token_ttl: 1.week,
+          v1_doc_path: 'docs/swagger/v1.json'
+        }
+
+        ::MultiJson.use :oj
+
+        require 'jbuilder/jbuilder_template'
+        JbuilderTemplate.send :include, Apress::Api::Extensions::Jbuilder::JbuilderTemplate
+      end
+
+      initializer "apress-api-factories", after: "factory_girl.set_factory_paths" do
+        if defined?(FactoryGirl)
+          FactoryGirl.definition_file_paths.unshift root.join("spec", "factories")
+        end
+      end
+    end
+  end
+end

data/lib/apress/api/extensions/jbuilder/jbuilder_template.rb

@@ -0,0 +1,41 @@
+module Apress
+  module Api
+    module Extensions
+      module Jbuilder
+        module JbuilderTemplate
+          def paginating_cache!(collection, key = nil, options = nil)
+            if @context.controller.perform_caching
+              result = Rails.cache.fetch(_cache_key(key || collection, options), options) do
+                {
+                  headers: _pagination_headers(collection),
+                  content: _scope { yield self }
+                }
+              end
+
+              _set_pagination_headers(result[:headers])
+
+              merge! result[:content]
+            else
+              _set_pagination_headers(_pagination_headers(collection))
+
+              yield
+            end
+          end
+
+          private
+
+          def _set_pagination_headers(headers)
+            @context.controller.response.headers.merge!(headers)
+          end
+
+          def _pagination_headers(collection)
+            ::Apress::Api::ApiController::PaginationHelper.headers(
+              collection,
+              @context.controller.request.url
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apress/api/rspec.rb

@@ -0,0 +1,48 @@
+# coding: utf-8
+require 'rspec/core'
+require 'rspec/expectations'
+require 'swagger'
+
+require_relative 'rspec/utils'
+
+RSpec::Matchers.define :correspond_to_schema do |schema, options|
+  match do |response|
+    if schema.present?
+      options ||= {}
+      JSON::Validator.validate!(schema, response.body.to_s, options)
+    else
+      true
+    end
+  end
+end
+
+# NOTE: Для того, чтобы находить нужную спецификацию ресурса по конкретному запросу (request.path),
+#       нужно уметь находить соответсвие Path -> URITemplatePath
+RSpec.shared_examples 'an api response' do |status|
+  let(:method) { request.method.downcase.to_sym }
+  let(:schema) do
+    begin
+      schema = @api.paths[resource][method].responses[response.code].schema
+      schema.definitions = @api.definitions if schema.present?
+      schema
+    rescue
+      fail "Swagger schema does not exist: #{dump_response}"
+    end
+  end
+
+  it { expect(response).to have_http_status(status).and correspond_to_schema(schema) }
+end
+
+RSpec.configure do |c|
+  c.include Apress::Api::Rspec::Utils, type: :request
+
+  c.before(:context, :api) do
+    classes = Apress::Api::Swagger::Schema.swagger_classes
+    @swagger_schema = ::Swagger::Blocks.build_root_json(classes)
+    @api = Swagger.build(@swagger_schema.to_json, format: :json)
+  end
+
+  c.after(:example, :verbose, type: :request) do
+    puts dump_response
+  end
+end

data/lib/apress/api/rspec/utils.rb

@@ -0,0 +1,17 @@
+require 'json'
+
+module Apress
+  module Api
+    module Rspec
+      module Utils
+        def dump_response
+          <<-EOS.strip_heredoc
+            Request: #{request.method} #{request.original_url}
+            Status: #{response.code}
+            #{JSON.pretty_generate(JSON.parse(response.body.to_s))}
+          EOS
+        end
+      end
+    end
+  end
+end

data/lib/apress/api/testing/json_matcher.rb

@@ -0,0 +1,9 @@
+require 'json-schema'
+require 'rspec/expectations'
+
+RSpec::Matchers.define :match_json_schema do |schema, options|
+  match do |json|
+    options = {strict: true}.merge!(options || {})
+    JSON::Validator.validate!(schema, json, options)
+  end
+end

data/lib/apress/api/version.rb

@@ -0,0 +1,5 @@
+module Apress
+  module Api
+    VERSION = '1.22.0'.freeze
+  end
+end

data/lib/tasks/docs.rake

@@ -0,0 +1,12 @@
+namespace :docs do
+  desc 'Generate api documentation'
+  task generate: :environment do
+    filename = 'swagger_v1.json'
+    path = Rails.application.config.api[:v1_doc_path]
+    FileUtils.mkdir_p(File.dirname(path))
+
+    Apress::Api::Swagger::Generator.new(path).generate_file
+
+    puts 'Done.'
+  end
+end

data/spec/controllers/api_controller/authentification_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+describe Apress::Api::ApiController::Base, type: :controller do
+  let(:client) { create "api/client" }
+
+  context "when api client is required, by default" do
+    controller do
+      def index
+        render json: {status: "ok"}
+      end
+    end
+
+    describe "#authenticate" do
+      before do
+        class_double(Apress::Api::AuthService, new: auth_service).as_stubbed_const
+      end
+
+      context "when auth successfull" do
+        let(:auth_service) { double("auth_service", call: true, client: client) }
+
+        it "assigns current_api_client" do
+          get :index
+          expect(response.status).to eq 200
+          expect(controller.current_api_client).to eq client
+        end
+      end
+
+      context "when auth failed" do
+        let(:auth_service) { double("auth_service", call: false, client: nil) }
+
+        it "returns 403" do
+          get :index
+          expect(response.status).to eq 403
+          expect(controller.current_api_client).to be nil
+        end
+      end
+    end
+  end
+
+  context "when api client is optional" do
+    controller do
+      if (Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR == 2) || Rails::VERSION::MAJOR > 4
+        skip_before_action :authenticate
+      else
+        skip_before_filter :authenticate
+      end
+
+      def index
+        render json: {status: "ok"}
+      end
+    end
+
+    describe "#authenticate" do
+      before do
+        class_double(Apress::Api::AuthService, new: auth_service).as_stubbed_const
+      end
+
+      context "when auth successfull" do
+        let(:auth_service) { double("auth_service", call: true, client: client) }
+
+        it "assigns current_api_client" do
+          get :index
+          expect(response.status).to eq 200
+          expect(controller.current_api_client).to eq client
+        end
+      end
+
+      context "when auth failed" do
+        let(:auth_service) { double("auth_service", call: false, client: nil) }
+
+        it "returns 200 and not assign current_api_client" do
+          get :index
+          expect(response.status).to eq 200
+          expect(controller.current_api_client).to be nil
+        end
+      end
+    end
+  end
+end

data/spec/controllers/api_controller/pagination_spec.rb

@@ -0,0 +1,199 @@
+require "spec_helper"
+
+def form_params(p)
+  if Rails::VERSION::MAJOR > 4
+    {params: p}
+  else
+    p
+  end
+end
+
+describe Apress::Api::ApiController::Base, type: :controller do
+  describe '#prepare_pagination' do
+    controller do
+      if (Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR == 2) || Rails::VERSION::MAJOR > 4
+        skip_before_action :authenticate
+      else
+        skip_before_filter :authenticate
+      end
+
+      def index
+        prepare_pagination(per_page: {max: 100, default: 40})
+        head 204
+      end
+    end
+
+    context 'when params present' do
+      context 'when params are valid' do
+        it 'sets variables' do
+          get :index, form_params(page: 2, per_page: 5)
+
+          expect(assigns(:page)).to eq 2
+          expect(assigns(:per_page)).to eq 5
+        end
+      end
+
+      context 'when params are invalid' do
+        it 'returns 400 for negative page' do
+          get :index, form_params(page: -1)
+
+          expect(response.status).to eq 400
+        end
+
+        it 'returns 400 for > max per_page value' do
+          get :index, form_params(per_page: 101)
+
+          expect(response.status).to eq 400
+        end
+      end
+    end
+
+    context 'when no params are set' do
+      it 'sets defaults' do
+        get :index
+
+        expect(assigns(:page)).to eq 1
+        expect(assigns(:per_page)).to eq 40
+      end
+    end
+  end
+
+  describe "#pagination_headers" do
+    let(:current_page) { 1 }
+    let(:collection) do
+      double(
+        total_entries: 30,
+        total_pages: 3,
+        per_page: 10,
+        current_page: current_page
+      )
+    end
+
+    context 'when there are no other values in Link header' do
+      controller do
+        if (Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR == 2) || Rails::VERSION::MAJOR > 4
+          skip_before_action :authenticate
+        else
+          skip_before_filter :authenticate
+        end
+
+        def index
+          pagination_headers(collection)
+          render json: {status: 'ok'}
+        end
+      end
+
+      before do
+        allow(controller).to receive(:collection).and_return(collection)
+        get :index
+      end
+
+      it 'sets correct X-Total-Count header' do
+        expect(response.header['X-Total-Count']).to eq '30'
+      end
+
+      it 'sets correct X-Total-Pages header' do
+        expect(response.header['X-Total-Pages']).to eq '3'
+      end
+
+      it 'sets correct X-Per-Page header' do
+        expect(response.header['X-Per-Page']).to eq '10'
+      end
+
+      context 'when current page is a first page' do
+        it 'sets correct X-Page header' do
+          expect(response.header['X-Page']).to eq '1'
+        end
+
+        it 'does not add pagination links for first and previous pages to Link header' do
+          expect(response.header['Link'].to_s).not_to include('rel="first"', 'rel="prev"')
+        end
+
+        it 'adds pagination links for next and last pages to Link header' do
+          expect(response.header['Link'].to_s.split(', ')).to include(
+            %(<#{request.url}?page=2>; rel="next"),
+            %(<#{request.url}?page=3>; rel="last")
+          )
+        end
+      end
+
+      context 'when current page is somewhere in the middle' do
+        let(:current_page) { 2 }
+
+        it 'sets correct X-Page header' do
+          expect(response.header['X-Page']).to eq '2'
+        end
+
+        it 'adds pagination links for first, previous, next and last pages to Link header' do
+          expect(response.header['Link'].to_s.split(', ')).to include(
+            %(<#{request.url}?page=1>; rel="first"),
+            %(<#{request.url}?page=1>; rel="prev"),
+            %(<#{request.url}?page=3>; rel="next"),
+            %(<#{request.url}?page=3>; rel="last")
+          )
+        end
+      end
+
+      context 'when current page is a last page' do
+        it 'sets correct X-Page header' do
+          expect(response.header['X-Page']).to eq '3'
+        end
+
+        let(:current_page) { 3 }
+
+        it 'does not add pagination links for next and last pages to Link header' do
+          expect(response.header['Link'].to_s).not_to include('rel="next"', 'rel="last"')
+        end
+
+        it 'adds pagination links for first and previous pages to Link header' do
+          expect(response.header['Link'].to_s.split(', ')).to include(
+            %(<#{request.url}?page=1>; rel="first"),
+            %(<#{request.url}?page=2>; rel="prev")
+          )
+        end
+      end
+
+      context 'when there is only one page' do
+        let(:collection) do
+          double(
+            total_entries: 9,
+            total_pages: 1,
+            per_page: 10,
+            current_page: 1
+          )
+        end
+
+        it 'does not add pagination links to Link header' do
+          expect(response.header['Link'].to_s).not_to include('rel="first"', 'rel="prev"', 'rel="last"', 'rel="next"')
+        end
+      end
+    end
+
+    context 'when Link header already has some values' do
+      controller do
+        if (Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR == 2) || Rails::VERSION::MAJOR > 4
+          skip_before_action :authenticate
+        else
+          skip_before_filter :authenticate
+        end
+
+        def index
+          headers['Link'] = '<http://test.host/help>; rel="help"'
+
+          pagination_headers(collection)
+          render json: {status: 'ok'}
+        end
+      end
+
+      let(:current_page) { 2 }
+
+      before do
+        allow(controller).to receive(:collection).and_return(collection)
+      end
+
+      it do
+        expect { get :index }.to raise_error(Apress::Api::ApiController::Pagination::LinkHeaderAppendNotImplemented)
+      end
+    end
+  end
+end