remotty-rails 0.0.1

data/lib/generators/remotty/rails/templates/add_column_to_users.rb

@@ -0,0 +1,42 @@
+# User 모델에 이름, 프로필 사진, 메일 인증 관련 컬럼을 추가 migration 파일
+#
+# ==== Columns
+#
+# * +avatar+ - Paperclip style 사용자 프로필 이미지
+# * +name+ - 사용자 이름
+# * +use_password+ - 사용자 패스워드 (일반 회원가입시 +true+, oauth 로그인시 +false+)
+# * +avatar+ - Paperclip style 사용자 프로필 이미지
+# * +confirmation_token+ - Device's confirmation column
+# * +confirmed_at+ - Device's confirmation column
+# * +confirmation_sent_at+ - Device's confirmation column
+# * +unconfirmed_email+ - Device's confirmation column
+#
+class AddColumnToUsers < ActiveRecord::Migration
+  def self.up
+    add_attachment :users, :avatar
+    add_column     :users, :name, :string, limit: 50
+    add_column     :users, :use_password, :boolean
+
+    add_column :users, :confirmation_token, :string
+    add_column :users, :confirmed_at,       :datetime
+    add_column :users, :confirmation_sent_at , :datetime
+    add_column :users, :unconfirmed_email, :string
+
+    add_index  :users, :confirmation_token, :unique => true
+  end
+
+  def self.down
+    remove_attachment :users, :avatar
+    remove_column     :users, :name
+    remove_column     :users, :use_password
+
+    remove_index  :users, :confirmation_token
+
+    remove_column :users, :unconfirmed_email
+    remove_column :users, :confirmation_sent_at
+    remove_column :users, :confirmed_at
+    remove_column :users, :confirmation_token
+  end
+end
+
+

data/lib/generators/remotty/rails/templates/auth_token.rb

@@ -0,0 +1,22 @@
+# Auth Token 모델
+#
+class AuthToken < ActiveRecord::Base
+  # relation
+  belongs_to :user
+
+  # validation
+  validates :user_id,     presence: true
+  validates :token,       presence: true
+  validates :source,      presence: true
+  validates :source_info, presence: true
+
+  # source 정보 업데이트
+  # 보통 ip가 변경될 경우가 많을듯 하고 변하지 않더라도 최종 갱신시간을 변경함
+  def update_source(source, source_info)
+    if self.source != source || self.source_info != source_info
+      self.update(source: source, source_info: source_info)
+    else
+      self.touch
+    end
+  end
+end

data/lib/generators/remotty/rails/templates/create_auth_tokens.rb

@@ -0,0 +1,28 @@
+# Auth Token 모델생성 migration 파일
+#
+# ==== Columns
+#
+# * +user+ - User 모델
+# * +token+ - 인증 토큰
+#   * token은 Devise.friendly_token로 생성하고 Digest::SHA512.hexdigest로 암호화하여 저장
+# * +source+ - 토큰 생성자
+#   * web(default)
+#   * ios
+#   * android
+#   * ...
+# * +source_info+ - 토큰 생성자 정보
+#   * ip(default)
+#   * ...
+#
+class CreateAuthTokens < ActiveRecord::Migration
+  def change
+    create_table :auth_tokens do |t|
+      t.references :user, index: true
+      t.string     :token
+      t.string     :source
+      t.string     :source_info
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/remotty/rails/templates/create_oauth_authentications.rb

@@ -0,0 +1,28 @@
+# OAuth Authentication 모델생성 migration 파일
+#
+# ==== Columns
+#
+# * +user+ - User 모델
+# * +provider+ - 인증 제공자
+#   * facebook
+#   * twitter
+#   * google
+#   * ...
+# * +uid+ - 인증 ID
+# * +access_token+ - access token
+# * +access_token_secret+ - access token secret
+#
+class CreateOauthAuthentications < ActiveRecord::Migration
+  def change
+    create_table :oauth_authentications do |t|
+      t.references :user,     index: true
+      t.string     :provider, index: true
+      t.string     :uid,      index: true
+      t.string     :access_token
+      t.string     :access_token_secret
+      t.datetime   :expires_at
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/remotty/rails/templates/oauth_authentication.rb

@@ -0,0 +1,18 @@
+# OAuth Authentication 모델
+#
+class OauthAuthentication < ActiveRecord::Base
+  # relation
+  belongs_to :user
+
+  # validation
+  validates :user_id,  presence: true
+  validates :provider, presence: true
+  validates :uid,      presence: true
+
+  # access_token, access_token_secret, expires 정보 업데이트
+  def update_with_credential(credential)
+    self.access_token = credential[:token]
+    self.access_token_secret = credential[:secret] if credential[:secret]
+    self.expires_at = Time.at(credential[:expires_at]).to_datetime if credential[:expires_at]
+  end
+end

data/lib/generators/remotty/rails/templates/paperclip_hash.rb

@@ -0,0 +1 @@
+# The secret key used by Paperclip.

data/lib/generators/remotty/rails/templates/user_serializer.rb

@@ -0,0 +1,3 @@
+# User serializer
+class UserSerializer < Remotty::UserSerializer
+end

data/lib/remotty/rails.rb

@@ -0,0 +1,8 @@
+require 'remotty/rails/version'
+
+module Remotty
+  module Rails
+    require 'remotty/rails/engine' if defined?(Rails)
+    require 'remotty/rails/authentication'
+  end
+end

data/lib/remotty/rails/authentication.rb

@@ -0,0 +1,6 @@
+module Remotty::Rails
+  module Authentication
+    require 'remotty/rails/authentication/strategies/token_header_authenticable'
+    autoload :JsonAuthFailure, 'remotty/rails/authentication/json_auth_failure'
+  end
+end

data/lib/remotty/rails/authentication/json_auth_failure.rb

@@ -0,0 +1,29 @@
+module Remotty::Rails
+  module Authentication
+    # return json Device error occur
+    class JsonAuthFailure < ::Devise::FailureApp
+      def http_auth_body
+        return i18n_message unless request_format
+
+        method = "to_#{request_format}"
+        if method == "to_xml"
+          {
+            error: {
+              code: "UNAUTHORIZED",
+              message: i18n_message
+            }
+          }.to_xml(:root => "errors")
+        elsif {}.respond_to?(method)
+          {
+            error: {
+              code: "UNAUTHORIZED",
+              message: i18n_message
+            }
+          }.send(method)
+        else
+          i18n_message
+        end
+      end
+    end
+  end
+end

data/lib/remotty/rails/authentication/strategies/token_header_authenticable.rb

@@ -0,0 +1,71 @@
+require 'devise'
+
+# Request Header의 auth token을 이용한 authentication
+#
+# ==== header
+#
+# +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)/...)
+#
+module Remotty::Rails
+  module Authentication
+    module Strategies
+      class TokenHeaderAuthenticable < ::Devise::Strategies::Base
+        # use session?
+        def store?
+          super && !mapping.to.skip_session_storage.include?(:token_header_auth)
+        end
+
+        # 개발일 경우는 email만 있어도 통과! 아니면 email + token header 필요
+        def valid?
+          header_email && (ENV["RAILS_ENV"] == "development" || header_token)
+        end
+
+        # email에 해당하는 token을 auth_token 테이블에서 확인
+        def authenticate!
+          resource_scope = mapping.to
+          resource = resource_scope.find_by_email(header_email)
+
+          if resource
+            if ENV["RAILS_ENV"] == "development"# && header_token.nil?
+              success!(resource)
+            else
+              auth_token = resource.auth_tokens.where("token = ? and updated_at > ?",
+                                                      Digest::SHA512.hexdigest(header_token), mapping.to.remember_for.ago).first
+              if auth_token
+                auth_token.update_source source, source_info
+
+                success!(resource)
+              else
+                fail!
+              end
+            end
+          else
+            fail!
+          end
+        end
+
+        private
+
+        def source
+          request.headers["X-Auth-Device"] || 'web'
+        end
+
+        def source_info
+          request.headers["X-Auth-Device-Info"] || request.remote_ip
+        end
+
+        def header_email
+          request.headers["X-Auth-Email"]
+        end
+
+        def header_token
+          request.headers["X-Auth-Token"]
+        end
+
+      end
+    end
+  end
+end

data/lib/remotty/rails/engine.rb

@@ -0,0 +1,72 @@
+require 'rails'
+require 'rack/cors'
+require 'active_model/serializer'
+require 'active_model/array_serializer'
+
+module Remotty::Rails
+  # 기본 설정
+  #
+  # * serializer
+  #   * root key를 사용하지 않음
+  # * wrap parameters
+  #   * enable for json
+  # * paperclip
+  #   * url => '/system/:class/:attachment/:id_partition/:style/:hash.:extension'
+  #   * default_url => nil (angular에서 처리)
+  # * Devise
+  #   * skip session storage
+  #   * use custom view
+  #   * return json error occur
+  #   * add token based authentication strategy
+  # * CORS
+  #   * allow all
+  # * Rails middleware
+  #   * Rack::Session::Pool
+  #   * ActionDispatch::Session::CookieStore, :cookie_only => false, :defer => true
+  #   * ActionDispatch::Flash
+  #
+  class Engine < ::Rails::Engine
+    initializer '0.remotty.rails.configuration' do |app|
+      # active serializer
+      ActiveModel::Serializer.root = false
+      ActiveModel::ArraySerializer.root = false
+
+      # wrap parameters
+      ActiveSupport.on_load(:action_controller) do
+        include ActionController::ParamsWrapper
+        wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
+      end
+
+      # paperclip
+      Paperclip::Attachment.default_options.update({
+                                                     :url => '/system/:class/:attachment/:id_partition/:style/:hash.:extension',
+                                                     :default_url => ''
+                                                   })
+
+      # Devise
+      Devise.setup do |config|
+        config.skip_session_storage = [:http_auth, :token_header_auth, :params_auth]
+        config.scoped_views = true
+        config.warden do |manager|
+          manager.failure_app = Remotty::Rails::Authentication::JsonAuthFailure
+          manager.strategies.add :token_header_authenticable, Remotty::Rails::Authentication::Strategies::TokenHeaderAuthenticable
+          manager.default_strategies(:scope => :user).unshift :token_header_authenticable
+        end
+      end
+
+      # CORS
+      ::Rails.application.config.middleware.use Rack::Cors do
+        allow do
+          origins "*"
+          resource "*", :headers => :any, :methods => [:get, :post, :delete, :put, :patch, :options]
+        end
+      end
+
+      # session for oauth/devise (no cookie)
+      ::Rails.application.config.middleware.use Rack::Session::Pool
+      ::Rails.application.config.middleware.use ActionDispatch::Session::CookieStore, :cookie_only => false, :defer => true
+      ::Rails.application.config.middleware.use ActionDispatch::Flash
+    end
+
+  end
+end

data/lib/remotty/rails/version.rb

@@ -0,0 +1,5 @@
+module Remotty
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

data/rdoc.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+rdoc --exclude ./doc

data/remotty-rails.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'remotty/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "remotty-rails"
+  spec.version       = Remotty::Rails::VERSION
+  spec.authors       = ["subicura", "bbugguj"]
+  spec.email         = ["subicura@subicura.com", "bbugguj@gmail.com"]
+  spec.summary       = 'rails base package by remotty'
+  spec.description   = 'token based authentication and more useful library..'
+  spec.homepage      = "https://github.com/remotty/remotty-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency         'rack-cors',   '>= 0.2.9'
+  spec.add_dependency         'active_model_serializers', '>= 0.8.1'
+
+  spec.add_dependency         'devise',      '>= 3.2.4'
+  spec.add_dependency         'omniauth-facebook', '>= 1.6.0'
+  spec.add_dependency         'omniauth-twitter',  '>= 1.0.1'
+
+  spec.add_dependency         'paperclip', '>= 4.1.1'
+  spec.add_dependency         'rmagick',   '>= 2.13.2'
+  spec.add_dependency         'fog',       '>= 1.22.0'
+  spec.add_dependency         'open_uri_redirections',  '>= 0.1.4'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,231 @@
+--- !ruby/object:Gem::Specification
+name: remotty-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- subicura
+- bbugguj
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack-cors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.9
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.4
+- !ruby/object:Gem::Dependency
+  name: omniauth-facebook
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: omniauth-twitter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.2
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.22.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.22.0
+- !ruby/object:Gem::Dependency
+  name: open_uri_redirections
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: token based authentication and more useful library..
+email:
+- subicura@subicura.com
+- bbugguj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/remotty/base_application_controller.rb
+- app/controllers/remotty/users/base_controller.rb
+- app/controllers/remotty/users/confirmations_controller.rb
+- app/controllers/remotty/users/omniauth_callbacks_controller.rb
+- app/controllers/remotty/users/passwords_controller.rb
+- app/controllers/remotty/users/registrations_controller.rb
+- app/controllers/remotty/users/sessions_controller.rb
+- app/models/remotty/base_user.rb
+- app/serializers/remotty/user_serializer.rb
+- config/locales/ko.yml
+- lib/generators/remotty/rails/install_generator.rb
+- lib/generators/remotty/rails/templates/add_column_to_users.rb
+- lib/generators/remotty/rails/templates/auth_token.rb
+- lib/generators/remotty/rails/templates/create_auth_tokens.rb
+- lib/generators/remotty/rails/templates/create_oauth_authentications.rb
+- lib/generators/remotty/rails/templates/oauth_authentication.rb
+- lib/generators/remotty/rails/templates/paperclip_hash.rb
+- lib/generators/remotty/rails/templates/user_serializer.rb
+- lib/remotty/rails.rb
+- lib/remotty/rails/authentication.rb
+- lib/remotty/rails/authentication/json_auth_failure.rb
+- lib/remotty/rails/authentication/strategies/token_header_authenticable.rb
+- lib/remotty/rails/engine.rb
+- lib/remotty/rails/version.rb
+- rdoc.sh
+- remotty-rails.gemspec
+homepage: https://github.com/remotty/remotty-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: rails base package by remotty
+test_files: []