Merge pull request #58 from suho/release/0.5.0

Author: suho

.rubocop.yml

@@ -1,4 +1,4 @@
-require: 
+require:
   - rubocop-rails
   - rubocop-rspec
   - rubocop-performance
@@ -44,3 +44,6 @@ RSpec/ContextWording:
   Prefixes:
     - when
     - given
+
+RSpec/NestedGroups:
+  Max: 5

Gemfile

@@ -14,10 +14,12 @@ gem 'sidekiq' # background processing for Ruby
 gem 'bootsnap', require: false # Reduces boot times through caching; required in config/boot.rb
 gem 'i18n-js', '3.5.1' # A library to provide the I18n translations on the Javascript
 gem 'httparty' # A library to call external API
+gem 'jsonapi-serializer' #A fast JSON: API serializer for Ruby
 
 # Authentications & Authorizations
 gem 'devise' # Authentication solution for Rails with Warden
 gem 'pundit' # Minimal authorization through OO design and pure Ruby classes
+gem 'doorkeeper' # An OAuth 2 provider.
 
 # Assets
 gem 'webpacker', '~>5.2.0' # Transpile app-like JavaScript

Gemfile.lock

@@ -163,6 +163,8 @@ GEM
     discard (1.2.0)
       activerecord (>= 4.2, < 7)
     docile (1.4.0)
+    doorkeeper (5.5.4)
+      railties (>= 5)
     erubi (1.10.0)
     erubis (2.7.0)
     fabrication (2.22.0)
@@ -211,6 +213,8 @@ GEM
     json_matchers (0.11.1)
       json_schema
     json_schema (0.21.0)
+    jsonapi-serializer (2.2.0)
+      activesupport (>= 4.2)
     kramdown (2.3.1)
       rexml
     kramdown-parser-gfm (1.1.0)
@@ -505,13 +509,15 @@ DEPENDENCIES
   database_cleaner
   devise
   discard
+  doorkeeper
   fabrication
   ffaker
   figaro
   foreman
   httparty
   i18n-js (= 3.5.1)
   json_matchers
+  jsonapi-serializer
   letter_opener
   listen (= 3.1.5)
   mini_magick

README.md

@@ -4,6 +4,11 @@
 
 This is a web application that will extract large amounts of data from the Google search results page.
 
+## Applications
+
+- Staging: [https://google-search-suv-staging.herokuapp.com/](https://google-search-suv-staging.herokuapp.com/)
+- Production: [https://google-search-suv.herokuapp.com/](https://google-search-suv.herokuapp.com/)
+
 ## Project Setup
 
 ### Prerequisites

app/controllers/api/v1/application_controller.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module API
+  module V1
+    class ApplicationController < ActionController::API
+      include API::V1::DoorkeeperAuthentication
+      rescue_from ActiveRecord::RecordNotFound, Pagy::OverflowError, with: :show_not_found_error
+
+      private
+
+      def show_not_found_error
+        render status: :not_found
+      end
+    end
+  end
+end

app/controllers/api/v1/keywords_controller.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module API
+  module V1
+    class KeywordsController < ApplicationController
+      include Pagy::Backend
+
+      before_action :set_keyword, only: :show
+
+      def index
+        keywords_query.call
+        pagy, keywords = pagy_array(keywords_query.keywords, pagination_params)
+
+        render json: KeywordSerializer.new(keywords, meta: meta_from_pagy(pagy))
+      end
+
+      def create
+        if save_keywords
+          SearchKeywordsJob.perform_later(keywords_form.keyword_ids)
+
+          render status: :created
+        else
+          render_error(
+            detail: keywords_form.errors.full_messages.first,
+            code: :invalid_file,
+            status: :unprocessable_entity
+          )
+        end
+      end
+
+      def show
+        render json: KeywordSerializer.new(@keyword, include: [:links], params: { show_detail: true })
+      end
+
+      private
+
+      def save_keywords
+        keywords_form.save(params[:keywords_file])
+      end
+
+      def keywords_form
+        @keywords_form ||= KeywordsForm.new(current_user)
+      end
+
+      def keywords_query
+        @keywords_query ||= KeywordsQuery.new(current_user.keywords, permitted_params)
+      end
+
+      def set_keyword
+        @keyword = current_user.keywords.find(params[:id])
+      end
+
+      def permitted_params
+        params.permit(:keyword)
+      end
+
+      def pagination_params
+        {
+          page: params.dig(:page, :number) || Pagy::DEFAULT[:page],
+          items: params.dig(:page, :size)
+        }
+      end
+
+      def meta_from_pagy(pagy)
+        {
+          page: pagy.page,
+          pages: pagy.pages,
+          page_size: pagy.items,
+          records: pagy.count
+        }
+      end
+    end
+  end
+end

app/controllers/api/v1/passwords_controller.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module API
+  module V1
+    class PasswordsController < Devise::PasswordsController
+      include API::V1::OauthApplicationProtection
+
+      def create
+        super do |user|
+          if user.valid?
+            render json: {
+              meta: { message: t('devise.passwords.send_paranoid_instructions') }
+            }
+          else
+            render_error(detail: user.errors.full_messages_for(:email).first)
+          end
+
+          return
+        end
+      end
+    end
+  end
+end

app/controllers/api/v1/registrations_controller.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module API
+  module V1
+    class RegistrationsController < Devise::RegistrationsController
+      include API::V1::OauthApplicationProtection
+
+      def create
+        super do |user|
+          if user.persisted?
+            head :created
+          else
+            render_error(detail: user.errors.full_messages.to_sentence)
+          end
+          return
+        end
+      end
+    end
+  end
+end

app/controllers/api/v1/tokens_controller.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module API
+  module V1
+    class TokensController < Doorkeeper::TokensController
+      include API::V1::ErrorHandler
+
+      private
+
+      def revocation_error_response
+        {
+          errors: build_errors(
+            detail: I18n.t('doorkeeper.errors.messages.revoke.unauthorized'),
+            code: :unauthorized_client
+          )
+        }
+      end
+    end
+  end
+end