remotty-rails

AngularJS + Rails API를 사용할 때 기본적인 셋팅을 도와주어 빠른 초기 셋팅을 가능하게 합니다.

Description

적용사항

header의 token을 이용한 인증처리
- auth_token model 추가
facebook/twitter oauth login
- oauth_authentication model 추가
join
- email
- oauth (facebook/twitter)
- email이 없는 경우도 처리
custom devise controller
- full customizing
- json response
- sessions controller
- registrations controller
- confirmations controller
- passwords controller
- omniauth_callbacks controller
user model
- use avatar for profile image
use paperclip for attachment
use serializer for json response
use kaminari for paging
CORS
no cookie/no session

Token Based Header Authenticable

header에 email과 token을 전달하여 인증을 처리함

X-Auth-Email : e-mail
X-Auth-Token : auth token
X-Auth-Device : source (web(default)/ios/android/...)
X-Auth-Device-Info : source info (ip(default)/...)

JSON format

disable root globally
failure default syntax

{
  "error":{
    "code":"ERROR_CODE",
    "message":"error message"
  }
}

Controller Helper

render_error helper

def render_error(code = 'ERROR', message = '', status = 400)
  render json: {
    error: {
      code: code,
      message: message
    }
  }, :status => status
end

render_paging helper

def render_paging(items)
  meta = {
    total_count: items.total_count,
    current_page: items.current_page,
    per_page: items.limit_value
  }

  render json: items,
         meta_key: 'page',
         meta: meta,
         root: 'items'
end

Library

remotty-rails에서 사용중인 라이브러리 입니다.

rails-api
- Rails for API only application (https://github.com/rails-api/rails-api)
active_model_serializers
- JSON serialization of objects (https://github.com/rails-api/active_model_serializers)
paperclip+rmagick+fog+httparty
- Easy file attachment management (https://github.com/thoughtbot/paperclip)
devise
- Flexible authentication solution (https://github.com/plataformatec/devise)

Installation

Create Rails API Project

$ gem install rails -v 4.1.4 --no-ri --no-rdoc
$ rails-api new {{project}} --skip-test-unit --skip-sprockets

Add this line to your application's Gemfile:

gem 'remotty-rails'

# user
gem 'devise'
gem 'omniauth-facebook'
gem 'omniauth-twitter'
gem 'cancan'

# attachment
gem 'paperclip'

# paging
gem 'kaminari'

And then execute:

$ bundle

install devise

$ rails generate devise:install
$ rails generate devise User

install remotty-rails

initializers/devise.rb에서 config.secret_key 주석 지우고 작업

$ rails generate remotty:rails:install
$ rake db:migrate

config/routes.rb update

devise_for :users 부분을 수정

devise_for :users,
           :path => 'api/v1/session',
             :path_names => {
               sign_in: 'login',
               sign_out: 'logout'
             },
             :controllers => { sessions:           'remotty/users/sessions',
                               registrations:      'remotty/users/registrations',
                               confirmations:      'remotty/users/confirmations',
                               passwords:          'remotty/users/passwords',
                               omniauth_callbacks: 'remotty/users/omniauth_callbacks'}

devise_scope :user do
  get    'api/v1/session'        => 'remotty/users/sessions#show'
  post   'api/v1/session/avatar' => 'remotty/users/registrations#avatar'
  delete 'api/v1/session/avatar' => 'remotty/users/registrations#remove_avatar'
end

Recommend Setting

유용한 Gemfile

Gemfile update

group :development do
  gem 'thin'
  gem 'annotate'
  gem 'better_errors'
  gem 'binding_of_caller'
  gem 'letter_opener'
  gem 'railroady'
end

sendmail test

development.rb update letter_opener는 gem 추가해야함 gem 'letter_opener'

config.action_mailer.default_url_options = { host: 'localhost:9000' }
config.action_mailer.delivery_method = :letter_opener

Configuration

custom mail view

views/devise/mailer/confirmation_instructions.html.erb create views/devise/mailer/reset_password_instructions.html.erb create

omniauth setting

devise.rb update

config.omniauth :facebook,
                Settings.omniauth.facebook.app_id,
                Settings.omniauth.facebook.app_secret,
                {
                  scope: 'email',
                  image_size: 'large',
                  provider_ignores_state: true
                }
config.omniauth :twitter,  
                Settings.omniauth.twitter.consumer_key,
                Settings.omniauth.twitter.consumer_secret, {
                :image_size => 'original',
                :authorize_params => {
                  :force_login => true
                },
                :setup => lambda do |env|
                  req = Rack::Request.new(env)
                  req.session.options[:cookie_only] = true
                  req.session.options[:defer] = false
                end

devise parameter sanitizer

user model에 column 추가시 application_controller.rb 파일에 추가함

class ApplicationController < ActionController::API

  protected

  def configure_permitted_parameters
    devise_parameter_sanitizer.for(:sign_up) { |u| u.permit(:name, :email, :password, :current_password, :avatar) }
    devise_parameter_sanitizer.for(:account_update) { |u| u.permit(:name, :avatar, :password, :password_confirmation, :current_password) }
  end
end

token 유효기간 변경

initializers/devise.rb update

config.remember_for = 2.weeks

cancan i18n

https://github.com/ryanb/cancan/wiki/Translating-your-app

Contributing

Fork it ( https://github.com/remotty/remotty-rails/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new Pull Request

remotty-rails

Development

Runtime

remotty-rails

Description

적용사항

Token Based Header Authenticable

JSON format

Controller Helper

Library

Installation

Recommend Setting

유용한 Gemfile

sendmail test

Configuration

custom mail view

omniauth setting

devise parameter sanitizer

token 유효기간 변경

cancan i18n

Contributing