remotty-rails 0.0.1

data/app/controllers/remotty/users/passwords_controller.rb

@@ -0,0 +1,47 @@
+class Users::PasswordsController < Devise::PasswordsController
+  include Remotty::Users::BaseController
+
+  # POST /resource/password
+  # email주소를 이용해서 패스워드 변경 요청 메일을 발송함
+  #
+  # ==== return
+  # * +success+ - no_content
+  # * +failure+ - validation error message
+  #
+  def create
+    self.resource = resource_class.send_reset_password_instructions(resource_params)
+    yield resource if block_given?
+
+    if successfully_sent?(resource)
+      render nothing: true, status: :no_content
+    else
+      render_error 'VALIDATION_ERROR', resource.errors.full_messages.first
+    end
+  end
+
+  # PUT /resource/password
+  # 토큰을 이용한 패스워드 변경
+  # 성공시 자동으로 로그인을 시도하고 토큰을 생성함
+  #
+  # ==== return
+  # * +success+ - 로그인 후 user with token json return
+  # * +failure+ - unauthorized with error message
+  #
+  def update
+    self.resource = resource_class.reset_password_by_token(resource_params)
+    yield resource if block_given?
+
+    if resource.errors.empty?
+      resource.unlock_access! if unlockable?(resource)
+      sign_in resource_name, resource, :store => false
+
+      token = resource.generate_auth_token!(auth_source)
+      render json: resource.with_token(token)
+    else
+      render_error 'UNAUTHORIZED',
+                   resource.errors.full_messages.first,
+                   :unauthorized
+    end
+  end
+
+end

data/app/controllers/remotty/users/registrations_controller.rb

@@ -0,0 +1,132 @@
+class Remotty::Users::RegistrationsController < Devise::RegistrationsController
+  include Remotty::Users::BaseController
+
+  wrap_parameters :user, include: [:email, :name, :password, :password_confirmation, :current_password]
+
+  # POST /resource
+  # 회원가입
+  def create
+    build_resource(sign_up_params)
+    resource.use_password = true
+
+    # oauth정보가 있으면 validation 체크
+    if params[:oauth]
+      unless valid_credential?(oauth_params)
+        render_error 'UNAUTHORIZED', 'Oauth credentials information is invalid', :unauthorized and return
+      end
+    end
+
+    if resource.save
+      yield resource if block_given?
+
+      resource.add_oauth_info(oauth_params) if params[:oauth]
+
+      if resource.active_for_authentication?
+        sign_up(resource_name, resource)
+
+        token = resource.generate_auth_token!(auth_source)
+
+        render json: resource.with_token(token)
+      else
+        expire_data_after_sign_in!
+
+        render_error 'UNAUTHORIZED',
+                     find_message("signed_up_but_#{resource.inactive_message}"),
+                     :unauthorized
+      end
+    else
+      clean_up_passwords resource
+
+      render_error 'VALIDATION_ERROR',
+                   resource.errors.full_messages.first
+    end
+  end
+
+  # PUT /resource
+  # 회원정보 수정 (password 제외한 일반 정보)
+  def update
+    self.resource = resource_class.to_adapter.get!(send(:"current_#{resource_name}").to_key)
+    prev_unconfirmed_email = resource.unconfirmed_email if resource.respond_to?(:unconfirmed_email)
+
+    if account_update_params[:password].blank? # password 수정이 아니면
+      account_update_params.delete("password")
+      account_update_params.delete("password_confirmation")
+
+      if resource.update_without_password(account_update_params)
+        yield resource if block_given?
+
+        message_key = update_needs_confirmation?(resource, prev_unconfirmed_email) ?
+          :update_needs_confirmation : :updated
+
+        sign_in resource_name, resource, :bypass => true, :store => false
+
+        if message_key == :updated
+          render json: resource
+        else
+          render_error 'UNAUTHORIZED',
+                       find_message(message_key),
+                       :unauthorized
+        end
+      else
+        clean_up_passwords resource
+
+        render_error 'VALIDATION_ERROR',
+                     resource.errors.full_messages.first
+      end
+    else # password 수정이면
+      if resource.use_password
+        resource.update_with_password(account_update_params)
+      else
+        resource.use_password = true
+        resource.update_attributes(account_update_params)
+        clean_up_passwords resource
+      end
+
+      if resource.errors.blank?
+        render json: resource
+      else
+        render_error 'VALIDATION_ERROR',
+                     resource.errors.full_messages.first
+      end
+    end
+  end
+
+  # DELETE /resource
+  # 회원탈퇴
+  def destroy
+    resource.destroy
+    Devise.sign_out_all_scopes ? sign_out : sign_out(resource_name)
+    set_flash_message :notice, :destroyed if is_flashing_format?
+    yield resource if block_given?
+    render nothing: true, status: :no_content
+  end
+
+  private
+
+  def oauth_params
+    params.require(:oauth).permit :provider, :uid, info: [:name, :image], credentials: [:token, :secret, :expires_at]
+  end
+
+  # credential 체크
+  def valid_credential?(oauth_params)
+    if oauth_params['provider'] == 'twitter'
+      client = Twitter::REST::Client.new do |config|
+        config.consumer_key        = Settings.omniauth.twitter.consumer_key
+        config.consumer_secret     = Settings.omniauth.twitter.consumer_secret
+        config.access_token        = oauth_params['credentials']['token']
+        config.access_token_secret = oauth_params['credentials']['secret']
+      end
+
+      begin
+        twitter_user = client.user
+        if twitter_user.id == oauth_params['uid'].to_i
+          return true
+        end
+      rescue Twitter::Error
+        return false
+      end
+    end
+
+    false
+  end
+end

data/app/controllers/remotty/users/sessions_controller.rb

@@ -0,0 +1,48 @@
+class Remotty::Users::SessionsController < Devise::SessionsController
+  include Remotty::Users::BaseController
+  include ActionController::Flash
+  wrap_parameters :user, include: [:email, :password]
+
+  # POST /resource/sign_in
+  # email과 password로 로그인
+  # 새로운 토큰 생성
+  #
+  # ==== return
+  # * +success+ - 로그인 후 user with token json return
+  # * +failure+ - unauthorized with error message
+  #
+  def create
+    self.resource = warden.authenticate!(:scope => resource_name)
+    sign_in(resource_name, resource, store: false)
+    yield resource if block_given?
+    token = resource.generate_auth_token!(auth_source)
+    render json: resource.with_token(token)
+  end
+
+  # DELETE /resource/sign_out
+  # 로그아웃. 로그인이 되어 있지 않아도 에러를 발생하지는 않음
+  # 토큰이용시 토큰을 삭제함
+  #
+  # ==== return
+  # * +success+ - no_content
+  # * +failure+ - no_content
+  #
+  def destroy
+    user = current_user
+
+    signed_out = (Devise.sign_out_all_scopes ? sign_out : sign_out(resource_name))
+    if signed_out
+      if user && request.headers["X-Auth-Token"].present?
+        auth_token = user.auth_tokens.where(token: Digest::SHA512.hexdigest(request.headers["X-Auth-Token"])).first
+        auth_token.destroy if auth_token
+      end
+
+      session.options[:skip] = true
+      response.headers['Set-Cookie'] = 'rack.session=; path=/; expires=Thu, 01-Jan-1970 00:00:00 GMT'
+    end
+    yield resource if block_given?
+
+    render nothing: true, status: :no_content
+  end
+
+end

data/app/models/remotty/base_user.rb

@@ -0,0 +1,83 @@
+module Remotty::BaseUser
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :auth_tokens, dependent: :destroy
+    has_many :oauth_authentications, dependent: :destroy
+
+    validates :name, presence: true
+
+    has_attached_file :avatar, :styles => { :original => "512x512#", :small => "200x200#", :thumb => "64x64#" }
+    validates_attachment_content_type :avatar, :content_type => /\Aimage\/.*\Z/
+  end
+
+  attr_accessor :auth_token
+
+  def generate_auth_token!(auth_source)
+    token = nil
+
+    loop do
+      token = Devise.friendly_token
+      break token unless self.auth_tokens.where(token: Digest::SHA512.hexdigest(token)).first
+    end
+
+    auth_token = AuthToken.create({user_id:self.id, token: Digest::SHA512.hexdigest(token)})
+    auth_token.update_source(auth_source[:source], auth_source[:info])
+
+    token
+  end
+
+  def with_token(token)
+    self.auth_token = token;
+    ::UserSerializer.new(self)
+  end
+
+  # oauth authentication 추가
+  #
+  # * +auth+ : auth 정보
+  #   * provider, uid, info(name, image), credentials(token, secret, expires_at)
+  #
+  def add_oauth_info(auth)
+    oauth = OauthAuthentication.find_or_create_by(provider: auth[:provider], uid: auth[:uid])
+    if oauth
+      oauth.update_with_credential(auth[:credentials])
+      oauth.user = self
+      oauth.save
+    end
+
+    if auth[:info][:image]
+      self.avatar_remote_url = auth[:info][:image]
+      self.save
+    end
+  end
+
+  # remote url attachment helper
+  #
+  def avatar_remote_url=(url)
+    avatar_url = process_uri(url)
+    self.avatar = URI.parse(avatar_url)
+    # Assuming url_value is http://example.com/photos/face.png
+    # avatar_file_name == "face.png"
+    # avatar_content_type == "image/png"
+    @avatar_remote_url = avatar_url
+  end
+
+  private
+
+  # fix uri redirection (http -> https)
+  def process_uri(uri)
+    ret = uri
+
+    require 'open-uri'
+    require 'open_uri_redirections'
+    begin
+      open(uri, :allow_redirections => :safe) do |r|
+        ret = r.base_uri.to_s
+      end
+    end
+
+    ret
+  end
+end
+
+

data/app/serializers/remotty/user_serializer.rb

@@ -0,0 +1,30 @@
+# user serializer
+#
+# ==== column
+# * +id+
+# * +name+
+# * +email+
+# * +use_password+
+# * +avatar+
+#   * +original+
+#   * +small+
+#   * +thumb+
+# * +auth_token+
+#
+class Remotty::UserSerializer < ActiveModel::Serializer
+  attributes :id, :name, :email, :use_password, :avatar, :auth_token
+
+  def avatar
+    {
+      original:object.avatar.url,
+      small:object.avatar.url(:small),
+      thumb:object.avatar.url(:thumb)
+    }
+  end
+
+  def include_auth_token?
+    object.auth_token
+  end
+end
+
+

data/config/locales/ko.yml

@@ -0,0 +1,58 @@
+# Additional translations at https://github.com/plataformatec/devise/wiki/I18n
+
+ko:
+  errors:
+    messages:
+      expired: "가(이) 만료되었습니다. 새로 요청해 주십시오"
+      not_found: "를(을) 찾을 수 없습니다"
+      already_confirmed: "이미 확인되었습니다, 다시 로그인 해 주십시오"
+      not_locked: "가(이) 잠기지 않았습니다"
+      not_saved:
+        one: "1개의 에러가 발생해서 %{resource}를(을) 저장할 수 없습니다:"
+        other: "%{count}개의 에러가 발생해서 %{resource}를(을) 저장할 수 없습니다:"
+
+  devise:
+    failure:
+      already_authenticated: '이미 로그인하셨습니다.'
+      unauthenticated: '이용하시려면 로그인하거나 가입하셔야 합니다.'
+      unconfirmed: '계정 확인 하셔야 이용하실 수 있습니다.'
+      locked: '계정이 잠겼습니다.'
+      invalid: '이메일이나 패스워드가 다릅니다.'
+      invalid_token: '잘못된 인증 토큰 입니다.'
+      timeout: '세션이 만료되어습니다, 계속하시려면 로그인해주세요.'
+      inactive: '계정이 아직 활성화 되지 않았습니다. '
+      not_found_in_database: '이메일이나 패스워드가 다릅니다.'
+    sessions:
+      signed_in: '성공적으로 로그인 하셨습니다.'
+      signed_out: '성공적으로 로그아웃 하셨습니다.'
+    passwords:
+      send_instructions: '어떻게 비밀번호를 재설정하는지 안내하는 메일을 발송하였습니다. 잠시후 확인해 보세요.'
+      updated: '비밀번호를 성공적으로 변경했습니다. 이제 로그인된 상태입니다.'
+      updated_not_active: '비밀번호를 성공적으로 변경했습니다.'
+      send_paranoid_instructions: "데이터베이스에 고객님의 이메일 주소가 존재하면, 비밀번호 복구 링크가 담긴 이메일을 곧 받으실 수 있습니다."
+    confirmations:
+      send_instructions: '이메일 주소를 확인하는 메일을 발송하였습니다. 잠시후에 메일을 확인해보세요.'
+      send_paranoid_instructions: '데이터베이스에 고객님의 이메일 주소가 존재하면, 이메일 주소를 확인하는 방법이 담긴 이메일을 곧 받으실 수 있습니다.'
+      confirmed: '성공적으로 이메일 주소를 확인하였습니다. 이제 로그인된 상태입니다.'
+    registrations:
+      signed_up: '환영합니다! 성공적으로 가입하셨습니다.'
+      signed_up_but_unconfirmed: '이메일 주소 확인 링크가 담긴 메일을 발송하였습니다. 계정을 활성화 하기 위해서 그 링크를 방문해주세요.'
+      signed_up_but_inactive: '고객님은 성공적으로 가입하셨습니다. 그러나 아직 계정이 활성화되지 않아 지금 로그인하실 수 없습니다.'
+      signed_up_but_locked: '고객님은 성공적으로 가입하셨습니다. 그러나 계정이 잠겨 있어 지금 로그인하실 수 없습니다.'
+      updated: '성공적으로 계정이 수정되었습니다.'
+      update_needs_confirmation: "성공적으로 계정이 수정되었습니다, 하지만 저희가 이메일주소를 확인해야 합니다. 이메일을 확인하시고 새로 바뀐 이메일 주소를 확인하는 링크를 방문해주세요."
+      destroyed: '안녕히가세요! 계정이 성공적으로 삭제되었습니다. 다시 뵙기를 고대합니다.'
+    unlocks:
+      send_instructions: '계정 잠금을 푸는 링크가 담긴 메일을 발송하있습니다. 잠시후에 확인해 보세요.'
+      unlocked: '성공적으로 계정 잠금을 풀었습니다. 계속 이용하시려면 로그인하세요.'
+      send_paranoid_instructions: '고객님의 계정이 존재하면, 곧 계정 잠금을 푸는 방법이 담긴 이메일을 받으실 수 있습니다.'
+    omniauth_callbacks:
+      success: '%{kind} 계정으로 성공적으로 인증되었습니다.'
+      failure: '다음과 같은 이유로 %{kind}에서 인증에 실패하였습니다. "%{reason}"'
+    mailer:
+      confirmation_instructions:
+        subject: '이메일 주소 확인 메일'
+      reset_password_instructions:
+        subject: '비밀번호 변경 확인 메일'
+      unlock_instructions:
+        subject: '계정 Unlock 메일'

data/lib/generators/remotty/rails/install_generator.rb

@@ -0,0 +1,68 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Remotty::Rails
+  module Generators
+    # 마이그레이션 생성 및 각종 클래스&설정 추가 및 변경
+    #
+    # ==== migration
+    # * +add_column_to_users.rb+ - user
+    # * +create_auth_tokens.rb+ - auth token
+    # * +create_oauth_authentications.rb+ - oauth authentication
+    #
+    # ==== model
+    # * +auth_token.rb+ - auth token
+    # * +oauth_authentication.rb+ - oauth_authentication
+    # * +user.rb+ - user model에 base include
+    #
+    # ==== configuration
+    # * +paperclip_hash.rb+ - paperclip hash
+    #
+    # ==== serializer
+    # * +user_serializer.rb+ - user model serializer
+    #
+    # ==== controller
+    # * +application_controller.rb+ - application controller에 base include
+    #
+    class InstallGenerator < ::Rails::Generators::Base
+      include ::Rails::Generators::Migration
+
+      desc "Creates a Remotty Rails model initializer and copy files to your application."
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      # migration number 생성용 변수
+      @migration_index = 0
+
+      # migration number는 현재날짜시간 + index(1,2,...) 형식으로 생성함
+      def self.next_migration_number(path)
+        @migration_index += 1
+        (Time.now.utc.strftime("%Y%m%d%H%M%S").to_i + @migration_index).to_s
+      end
+
+      # add & update files
+      def copy_purple_attachment
+        template 'auth_token.rb', 'app/models/auth_token.rb'
+        template 'oauth_authentication.rb', 'app/models/oauth_authentication.rb'
+        template 'user_serializer.rb', 'app/serializers/user_serializer.rb'
+        template 'paperclip_hash.rb', 'config/initializers/paperclip_hash.rb'
+        append_to_file 'config/initializers/paperclip_hash.rb' do
+          secret = SecureRandom.hex(40)
+          "Paperclip::Attachment.default_options.update({ :hash_secret => '#{secret}' })"
+        end
+        inject_into_class 'app/controllers/application_controller.rb', ApplicationController do
+          "  include Remotty::BaseApplicationController\n"
+        end
+        inject_into_class 'app/models/user.rb', User do
+          "  include Remotty::BaseUser\n"
+        end
+        gsub_file 'app/models/user.rb', 'registerable', 'registerable, :confirmable, :omniauthable'
+
+        migration_template 'add_column_to_users.rb',          'db/migrate/add_column_to_users.rb'
+        migration_template 'create_auth_tokens.rb',           'db/migrate/create_auth_tokens.rb'
+        migration_template 'create_oauth_authentications.rb', 'db/migrate/create_oauth_authentications.rb'
+      end
+
+    end
+  end
+end