kriangle 0.1.0

data/lib/generators/kriangle/templates/active_serializer.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class ActiveSerializer < ActiveModel::Serializer
+  <%- if custom_orm == 'Mongoid' -%>
+  def id
+    object._id.to_s
+  end
+  <%- end -%>
+end

data/lib/generators/kriangle/templates/application_record.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+<% if custom_orm == 'Mongoid' %>
+class ApplicationRecord
+<% else %>
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+<% end %>
+end

data/lib/generators/kriangle/templates/auth.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Api
+  module <%= wrapper.capitalize %>
+    class <%= controller_path %> < Grape::API
+      include Api::<%= wrapper.capitalize %>::Defaults
+
+      resource :<%= controller_path.underscore %> do
+        include Api::CustomDescription
+
+        desc "Register new <%= underscored_user_class %>"
+        params do
+          requires :<%= underscored_user_class %>, type: Hash do
+            requires :email, type: String, desc: "Email address"
+            requires :password, type: String, desc: "Password"
+            requires :password_confirmation, type: String, desc: "Password Confirmation"
+            # Additional(optional) parameters
+            <%- for attribute in model_attributes -%>
+              <% next if attribute.name == 'email' %>
+              <%- if attribute.name == 'gender' -%>
+            <%= require_or_optional(attribute) %> :<%= get_attribute_name(attribute.name, attribute.type) %>, type: <%= get_attribute_type(attribute.type) %>, desc: "<%= attribute.name.titleize %>", default: 'Male', values: ['Male', 'Female', 'Other']
+              <%- else -%>
+            <%= require_or_optional(attribute) %> :<%= get_attribute_name(attribute.name, attribute.type) %>, type: <%= get_attribute_type(attribute.type) %>, desc: "<%= attribute.name.titleize %>"
+              <%- end -%>
+            <%- end -%>
+          end
+        end
+        post :register do
+          <%= underscored_user_class %> = <%= user_class %>.new(params[:<%= underscored_user_class %>])
+          if <%= underscored_user_class %>.save
+            create_authentication(<%= underscored_user_class %>)
+            render_object(<%= underscored_user_class %>, additional_response: { message: "You have registered successfully." })
+          else
+            json_error_response({ errors: <%= underscored_user_class %>.errors.full_messages })
+          end
+        end
+
+        desc "Creates and returns <%= underscored_user_class %> with access token if valid login"
+        params do
+          requires :<%= underscored_user_class %>, type: Hash do
+            requires :email, type: String, desc: "Email address"
+            requires :password, type: String, desc: "Password"
+          end
+        end
+        post :login do
+          <%= underscored_user_class %> = <%= user_class %>.find_by(email: params[:<%= underscored_user_class %>][:email].downcase)
+          if <%= underscored_user_class %> && <%= underscored_user_class %>.valid_password?(params[:<%= underscored_user_class %>][:password])
+            create_authentication(<%= underscored_user_class %>)
+            render_object(<%= underscored_user_class %>, additional_response: { message: "You have successfully logged in." })
+          else
+            json_error_response({ errors: ['Invalid email or password.'] }, 401)
+          end
+        end
+
+        description "Logout <%= underscored_user_class %>"
+        post :logout do
+          destroy_authentication_token
+          json_success_response(message: "You have successfully logout.")
+        end
+
+        description "Return pong if logged in correctly"
+        get :ping do
+          authenticate!
+          json_success_response(message: "pong")
+        end
+
+        desc "Forgot Password"
+        params do
+          requires :<%= underscored_user_class %>, type: Hash do
+            requires :email, type: String, desc: "Email address"
+          end
+        end
+        post :forgot_password do
+          <%= underscored_user_class %> = <%= user_class %>.find_by(email: params[:<%= underscored_user_class %>][:email].downcase)
+          if <%= underscored_user_class %>.present?
+            <%= underscored_user_class %>.update(reset_token: token)
+            # send Forgot Password email
+            json_success_response(message: "You will receive email with instructions to reset password shortly.")
+          else
+            json_error_response({ errors: ['Invalid email address.'] })
+          end
+        end
+
+        desc "Reset Password"
+        params do
+          requires :reset_token, type: String, desc: "Reset Password"
+          requires :<%= underscored_user_class %>, type: Hash do
+            requires :password, type: String, desc: "Password"
+            requires :password_confirmation, type: String, desc: "Password Confirmation"
+          end
+        end
+        post :reset_password do
+          <%= underscored_user_class %> = <%= user_class %>.find_by(reset_token: params[:reset_token])
+          if <%= underscored_user_class %>.update(params[:<%= underscored_user_class %>])
+            # send Reset Password email
+            json_success_response(message: "Your password have successfully changed.")
+          else
+            json_error_response({ errors: ['Invalid reset token.'] })
+          end
+        end
+
+        description "Return <%= underscored_user_class %>"
+        get '' do
+          authenticate!
+          render_object(current_<%= underscored_user_class %>)
+        end
+
+        description "Update <%= underscored_user_class %>"
+        params do
+          requires :<%= underscored_user_class %>, type: Hash do
+            # Additional(optional) parameters
+            <%- for attribute in model_attributes -%>
+              <% next if attribute.name == 'email' %>
+              <%- if attribute.name == 'gender' -%>
+            <%= require_or_optional(attribute) %> :<%= attribute.name %>, type: <%= get_attribute_type(attribute.type) %>, desc: "<%= attribute.name.titleize %>", default: 'Male', values: ['Male', 'Female', 'Other']
+              <%- else -%>
+            <%= require_or_optional(attribute) %> :<%= get_attribute_name(attribute.name, attribute.type) %>, type: <%= get_attribute_type(attribute.type) %>, desc: "<%= attribute.name.titleize %>"
+              <%- end -%>
+            <%- end -%>
+            # group :avatars_attributes, type: Hash, desc: "An array of avatars" do
+            #   optional :id, type: Integer
+            #   optional :image, type: String
+            #   optional :_destroy, type: Boolean
+            # end
+          end
+        end
+        put "" do
+          authenticate!
+          if current_<%= underscored_user_class %>.update(params[:<%= underscored_user_class %>])
+            render_object(current_<%= underscored_user_class %>)
+          else
+            json_error_response({ errors: current_<%= underscored_user_class %>.errors.full_messages })
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/kriangle/templates/authentication.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Authentication < ApplicationRecord
+  belongs_to :<%= underscored_user_class %>
+
+  validates :user_id, :client_id, :token, presence: true
+end

data/lib/generators/kriangle/templates/authenticator.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'bcrypt'
+
+module Api
+  module Authenticator
+    extend ActiveSupport::Concern
+
+    included do
+      helpers do
+        def generate_random_string
+          "#{SecureRandom.urlsafe_base64}#{DateTime.now.to_i}#{SecureRandom.urlsafe_base64}"
+        end
+
+        def create_authentication(<%= underscored_user_class %>, client_id = ENV['CLIENT_ID'])
+          # delete all old tokens if any present
+          <%= underscored_user_class %>.authentications.delete_all
+
+          # create new auth token
+          client_id ||= SecureRandom.urlsafe_base64(nil, false)
+          token = generate_random_string
+          authentication = <%= underscored_user_class %>.authentications.create(client_id: client_id, token: BCrypt::Password.create(token))
+
+          # build auth header
+          header 'X-Uid', authentication.<%= underscored_user_class %>_id
+          header 'X-Client-Id', authentication.client_id
+          header 'X-Authentication-Token', token
+        end
+
+        def authentication
+          # user has already been found and authenticated
+          return @authentication if @authentication
+
+          # get details from header or params
+          uid = headers['X-Uid'] || params['uid']
+          @token     ||= headers['X-Authentication-Token'] || params['access-token']
+          @client_id ||= request.headers['X-Client-Id'] || params['client-id']
+
+          # client_id isn't required, set to 'default' if absent
+          @client_id ||= 'default'
+
+          # ensure we clear the client_id
+          unless @token
+            @client_id = nil
+            return
+          end
+
+          return unless @token
+
+          auth = Authentication.where(<%= underscored_user_class %>_id: uid, client_id: @client_id).last || return
+          return @authentication = auth if ::BCrypt::Password.new(auth.token) == @token
+
+          @authentication = nil
+        end
+
+        def destroy_authentication_token
+          authentication&.destroy
+        end
+
+        def current_<%= underscored_user_class %>
+          @current_<%= underscored_user_class %> ||= authentication&.<%= underscored_user_class %>
+        end
+
+        def authenticate!
+          render_unauthorized_access && return unless current_<%= underscored_user_class %>
+        end
+      end
+    end
+  end
+end

data/lib/generators/kriangle/templates/avatar.rb

@@ -0,0 +1,5 @@
+class Avatar < ApplicationRecord
+  belongs_to :<%= underscored_user_class %>
+  
+  mount_uploader :image, AvatarUploader
+end

data/lib/generators/kriangle/templates/avatar_uploader.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+class AvatarUploader < CarrierWave::Uploader::Base
+  # Include RMagick or MiniMagick support:
+  # include CarrierWave::RMagick
+  # include CarrierWave::MiniMagick
+
+  # Choose what kind of storage to use for this uploader:
+  storage :file
+  # storage :fog
+
+  # Override the directory where uploaded files will be stored.
+  # This is a sensible default for uploaders that are meant to be mounted:
+  def store_dir
+    "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+  end
+
+  # Provide a default URL as a default if there hasn't been a file uploaded:
+  # def default_url(*args)
+  #   # For Rails 3.1+ asset pipeline compatibility:
+  #   # ActionController::Base.helpers.asset_path("fallback/" + [version_name, "default.png"].compact.join('_'))
+  #
+  #   "/images/fallback/" + [version_name, "default.png"].compact.join('_')
+  # end
+
+  # Process files as they are uploaded:
+  # process scale: [200, 300]
+  #
+  # def scale(width, height)
+  #   # do something
+  # end
+
+  # Create different versions of your uploaded files:
+  # version :thumb do
+  #   process resize_to_fit: [50, 50]
+  # end
+
+  # Add a white list of extensions which are allowed to be uploaded.
+  # For images you might use something like this:
+  # def extension_whitelist
+  #   %w(jpg jpeg gif png)
+  # end
+
+  # Override the filename of the uploaded files:
+  # Avoid using model.id or version_name here, see uploader/store.rb for details.
+  # def filename
+  #   "something.jpg" if original_filename
+  # end
+end

data/lib/generators/kriangle/templates/base.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Api
+  class Base < Grape::API
+  end
+end

data/lib/generators/kriangle/templates/controller.rb

@@ -0,0 +1,241 @@
+# frozen_string_literal: true
+
+module Api
+  module <%= wrapper.capitalize %>
+    class <%= controller_path %> < Grape::API
+      include Api::<%= wrapper.capitalize %>::Defaults
+
+      resource :<%= controller_path.underscore %> do
+        <%- unless skip_authentication -%>
+        include Api::CustomDescription
+
+        before do
+          authenticate!
+        end
+        <%- end -%>
+        <%- if resources -%>
+          <%- if controller_actions.include?('index') -%>
+
+        <%= description_method_name %> "Return all <%= plural_name %>"
+        <%- if !skip_pagination || search_by -%>
+        <%- if !reference || (reference && association_type == 'has_many') || reference_id_param -%>
+        params do
+          <%- if search_by -%>
+          optional :q, type: Hash do
+            optional :m, type: String, desc: 'Matching case', default: 'or', values: ['or', 'and']
+            <%- for attribute in model_attributes.select { |ma| ma.search_by.present? } -%>
+            optional :<%= attribute.name %><%= attribute.search_by %>, type: <%= get_attribute_type(attribute.type) %>, desc: "Search by <%= attribute.name.titleize %>"
+            <%- end -%>
+          end
+          <%- end -%>
+          <%- if reference_id_param -%>
+          requires :<%= reference_id_param %>, type: Integer, desc: "<%= @user_class.classify %>'s id"
+          <%- end -%>
+          <%- if !skip_pagination && (!reference || (reference && association_type == 'has_many')) -%>
+          optional :page, type: Integer, desc: "Page number", default: 0
+          optional :per_page, type: Integer, desc: "Per Page", default: 15
+          <%- end -%>
+        end
+        <%- end -%>
+        <%- end -%>
+        get "", root: :<%= plural_name %> do
+          <%- if reference -%>
+            <%- if association_type == 'has_many' -%>
+              <%- if search_by -%>
+          @q = <%= reference_name %>.<%= plural_name %><%= additional_where_clause %>.ransack(params[:q])
+          results = @q.result(distinct: true)
+              <%- else -%>
+          results = <%= reference_name %>.<%= plural_name %><%= additional_where_clause %>
+              <%- end -%>
+            <%- else -%>
+          <%= singular_name %> = <%= reference_name %>.<%= singular_name %> || raise(<%= get_record_not_found_exception %>)
+          render_object(<%= singular_name %>)
+            <%- end -%>
+          <%- else -%>
+            <%- if search_by -%>
+          @q = <%= class_name %><%= additional_where_clause %>.ransack(params[:q])
+          results = @q.result(distinct: true)
+            <%- else -%>
+          results = <%= class_name %><%= additional_where_clause %>.all
+            <%- end -%>
+          <%- end -%>
+          <%- if !reference || association_type == 'has_many' -%>
+            <%- if skip_pagination -%>
+          render_objects(results)
+            <%- else -%>
+          render_objects(paginate results)
+            <%- end -%>
+          <%- end -%>
+        end
+          <%- end -%>
+        <%- end -%>
+        <%- if controller_actions.include?('show') -%>
+
+        <%= description_method_name %> "Return a <%= singular_name %>"
+        <%- if reference_id_param -%>
+        params do
+          requires :<%= reference_id_param %>, type: Integer, desc: "<%= @user_class.classify %>'s id"
+        end
+        <%- end -%>
+        get ":id", root: "<%= singular_name %>" do
+          <%- if reference -%>
+            <%- if association_type == 'has_many' -%>
+          <%= singular_name %> = <%= reference_name %>.<%= plural_name %>.find(params[:id])
+            <%- else -%>
+          <%= singular_name %> = <%= reference_name %>.<%= singular_name %> || raise(<%= get_record_not_found_exception %>)
+            <%- end -%>
+          <%- else -%>
+          <%= singular_name %> = <%= class_name %>.find(params[:id])
+          <%- end -%>
+          render_object(<%= singular_name %>)
+        end
+        <%- end -%>
+        <%- if controller_actions.include?('create') -%>
+
+        <%= description_method_name %> "Create a <%= singular_name %>"
+        params do
+          <%- if reference_id_param -%>
+          requires :<%= reference_id_param %>, type: Integer, desc: "<%= @user_class.classify %>'s id"
+          <%- end -%>
+          requires :<%= singular_name %>, type: Hash do
+            <%- if self_reference -%>
+            optional :<%= parent_association_name %>_id, type: Integer, desc: "<%= class_name.classify %>'s id as parent"
+            <%- end -%>
+            <%- for attribute in model_associations.select { |ma| ma.association_type == 'belongs_to' && !ma.class_name && !ma.reference } -%>
+            <%= require_or_optional(attribute) %> :<%= attribute.association_name + '_id' %>, type: Integer, desc: "<%= attribute.association_name.titleize %>"
+            <%- end -%>
+            <%- for attribute in model_attributes -%>
+            <%= require_or_optional(attribute) %> :<%= get_attribute_name(attribute.name, attribute.type) %>, type: <%= get_attribute_type(attribute.type) %>, desc: "<%= attribute.name.titleize %>"
+            <%- end -%>
+            <%- unless skip_tips -%>
+            # requires :title, type: String, desc: "Title of the <%= singular_name %>"
+            # requires :content, type: String, desc: "Content of the <%= singular_name %>"
+            <%- end -%>
+          end
+        end
+        post "", root: "<%= singular_name %>" do
+          <%- if reference -%>
+            <%- if association_type == 'has_many' -%>
+          <%= singular_name %> = <%= reference_name_create_update %>.<%= plural_name %>.<%= creation_method %>(params[:<%= singular_name %>])
+            <%- else -%>
+          <%= singular_name %> = <%= reference_name_create_update %>.<%= singular_name %> || <%= reference_name_create_update %>.build_<%= singular_name %>(params[:<%= singular_name %>])
+          <%= singular_name %>.attributes = params[:<%= singular_name %>] if <%= singular_name %>.persisted?
+            <%- end -%>
+          <%- else -%>
+          <%= singular_name %> = <%= class_name %>.<%= creation_method %>(params[:<%= singular_name %>])
+          <%- end -%>
+          if <%= singular_name %>.save
+            render_object(<%= singular_name %>, additional_response: { message: "<%= class_name %> created successfully." })
+          else
+            json_error_response(errors: <%= singular_name %>.errors.full_messages)
+          end
+        end
+        <%- end -%>
+        <%- if controller_actions.include?('update') -%>
+
+        <%= description_method_name %> "Update a <%= singular_name %>"
+        params do
+          <%- if reference_id_param -%>
+          requires :<%= reference_id_param %>, type: Integer, desc: "<%= @user_class.classify %>'s id"
+          <%- end -%>
+          requires :<%= singular_name %>, type: Hash do
+            <%- for attribute in model_attributes -%>
+            optional :<%= get_attribute_name(attribute.name, attribute.type) %>, type: <%= get_attribute_type(attribute.type) %>, desc: "<%= attribute.name.titleize %>"
+            <%- end -%>
+            <%- unless skip_tips -%>
+            # requires :title, type: String, desc: "Title of the <%= singular_name %>"
+            # requires :content, type: String, desc: "Content of the <%= singular_name %>"
+            # optional :views, type: String, desc: "Content of the <%= singular_name %>"
+            <%- end -%>
+          end
+        end
+        put ":id", root: "<%= singular_name %>" do
+          <%- if reference -%>
+            <%- if association_type == 'has_many' -%>
+          <%= singular_name %> = <%= reference_name_create_update %>.<%= plural_name %>.find(params[:id])
+            <%- else -%>
+          <%= singular_name %> = <%= reference_name_create_update %>.<%= singular_name %> || raise(<%= get_record_not_found_exception %>)
+            <%- end -%>
+          <%- else -%>
+          <%= singular_name %> = <%= class_name %>.find(params[:id])
+          <%- end -%>
+          if <%= singular_name %>.update(params[:<%= singular_name %>])
+            render_object(<%= singular_name %>, additional_response: { message: "<%= class_name %> updated successfully." })
+          else
+            json_error_response(errors: <%= singular_name %>.errors.full_messages)
+          end
+        end
+        <%- end -%>
+        <%- if controller_actions.include?('destroy') -%>
+
+        <%= description_method_name %> "Destroy a <%= singular_name %>"
+        <%- if reference_id_param -%>
+        params do
+          requires :<%= reference_id_param %>, type: Integer, desc: "<%= @user_class.classify %>'s id"
+        end
+        <%- end -%>
+        delete ":id", root: "<%= singular_name %>" do
+          <%- if reference -%>
+            <%- if association_type == 'has_many' -%>
+          <%= singular_name %> = <%= reference_name %>.<%= plural_name %>.find(params[:id])
+            <%- else -%>
+          <%= singular_name %> = <%= reference_name %>.<%= singular_name %> || raise(<%= get_record_not_found_exception %>)
+            <%- end -%>
+          <%- else -%>
+          <%= singular_name %> = <%= class_name %>.find(params[:id])
+          <%- end -%>
+          if <%= singular_name %>.destroy
+            json_success_response(message: "<%= class_name %> destroyed successfully.")
+          else
+            json_error_response(errors: <%= singular_name %>.errors.full_messages)
+          end
+        end
+        <%- end -%>
+        <%- if controller_actions.include?('create_or_destroy') -%>
+
+        <%= description_method_name %> "Create or Destroy a <%= singular_name %>"
+        params do
+          <%- if reference_id_param -%>
+          requires :<%= reference_id_param %>, type: Integer, desc: "<%= @user_class.classify %>'s id"
+          <%- end -%>
+          requires :<%= singular_name %>, type: Hash do
+            <%- if self_reference -%>
+            optional :<%= parent_association_name %>_id, type: Integer, desc: "<%= class_name.classify %>'s id as parent"
+            <%- end -%>
+            <%- for attribute in model_associations.select { |ma| ma.association_type == 'belongs_to' && !ma.class_name && !ma.reference } -%>
+            <%= require_or_optional(attribute) %> :<%= attribute.association_name + '_id' %>, type: Integer, desc: "<%= attribute.association_name.titleize %>"
+            <%- end -%>
+            <%- for attribute in model_attributes -%>
+            <%= require_or_optional(attribute) %> :<%= get_attribute_name(attribute.name, attribute.type) %>, type: <%= get_attribute_type(attribute.type) %>, desc: "<%= attribute.name.titleize %>"
+            <%- end -%>
+          end
+        end
+        post "", root: "<%= singular_name %>" do
+          <%- if reference -%>
+            <%- if association_type == 'has_many' -%>
+          <%= singular_name %> = <%= reference_name_create_update %>.<%= plural_name %>.find_or_initialize_by(params[:<%= singular_name %>])
+            <%- else -%>
+          <%= singular_name %> = <%= reference_name_create_update %>.<%= singular_name %> || <%= reference_name_create_update %>.build_<%= singular_name %>(params[:<%= singular_name %>])
+            <%- end -%>
+          <%- else -%>
+          <%= singular_name %> = <%= class_name %>.find_or_initialize_by(params[:<%= singular_name %>])
+          <%- end -%>
+          if <%= singular_name %>.persisted?
+            if <%= singular_name %>.destroy_all
+              json_success_response(message: "<%= class_name %> destroyed successfully.")
+            else
+              json_error_response(errors: <%= singular_name %>.errors.full_messages)
+            end
+          else
+            if <%= singular_name %>.save
+              render_object(<%= singular_name %>, additional_response: { message: "<%= class_name %> created successfully." })
+            else
+              json_error_response(errors: <%= singular_name %>.errors.full_messages)
+            end
+          end
+        end
+        <%- end -%>
+      end
+    end
+  end
+end