doitian (ian)

Rails Cookie 如何解密

doitian — Sat, 23 Sep 2017 16:00:43 +0800

CC-BY-SA 原文：http://blog.iany.me/zh/2017/09/rails-cookie-encryption/

如果想在已有的 Rails app 上使用其它语言加些 API，同时能直接使用 Rails 的登陆信息，最简单的就是用 Nginx 等代理将不同的服务映射到相同的域名下，其它的 App 解密 Cookie 获得登陆信息。

本文以 Ruby 代码为例说明 Rails 的 Cookie 是如何加密，然后以 Go 为例说明如何解密的。

Rails 的实现可以参考 ActiveSupport::MessageEncryptor，ActiveSupport::MessageVerifier 和相应的单元测试。

加密

上图说明了原始的 Session 对象 Session Data 是如何最终生成 Cookie 的。如果登陆用了 Devise，那么 Session Data 中的登陆信息保存在 warden.user.user.key 中。之后就用下面例子说明加密。

session = { "warden.user.user.key" => [[1],"secret"] }

从 Rails 4.1 开始，默认使用的 JSON，4.1 之前使用的 Ruby Marshal。为了方便其它语言中解析，推荐使用 4.1 或更新的版本并使用 JSON 做为 Cookie 的 serializer。配置在 config/initializers/cookies_serializer.rb 中

Rails.application.config.action_dispatch.cookies_serializer = :json

JSON 的 serializer 就很直接了

require 'json'
session_json = JSON.dump(session)
puts session_json.inspect
# => "{\"warden.user.user.key\":[[1],\"secret\"]}"

② Padding

下一步的加密要求数据的字节数必须是 16 的倍数，用的算法是 PKCS7。简单说就是如果差 n 个字节到下个 16 的倍数就补 n 个 n。如果刚好是 16 的倍数就补 16 个 16。

def padding(data, block_size = 16)
  n = block_size - data.bytesize % block_size
  return data.force_encoding('ASCII-8BIT') + n.chr * n
end
padded_session = padding(session_json)
puts padded_session.inspect
# => "{\"warden.user.user.key\":[[1],\"secret\"]}\t\t\t\t\t\t\t\t\t"

末尾的 \t ASCII 码是 9，表示补了 9 个字节。

③ 加密 AES-CBC

这一步是最主要的加密了，算法是 AES-CBC。加密需要配置密钥并随机生成 IV (initialization vector)。因为 Ruby 的 OpenSSL::Cipher 封装会自动 padding，所以可以跳过第 ② 步。

我们知道 Rails 需要配置 secret key base，密钥就是通过 secret key base 和 salt 产生的，使用的算法 pbkdf2 在 OpenSSL 里也提供了。

OpenSSL::PKCS5.pbkdf2_hmac_sha1(pass, salt, iter, keylen)

pass 配置中的 secret key base
salt 如果使用默认 Rails 配置的话，加密是 encrypted cookie，后面签名步骤是 signed encrypted cookie
iter 默认是 1000, keylen 加密是 32，签名是 64。也可以统一用 64，但是加密的 Key 只取前 32 个字节。

require 'openssl'
SECRET_KEY_BASE = "development_secret"
DEFAULT_SALT     = "encrypted cookie"
DEFAULT_SIGN_SALT = "signed encrypted cookie"
DEFAULT_ITER = 1000
DEFAULT_KEYLEN = 64
def generate_key(secret_key_base, salt, iter = DEFAULT_ITER, keylen = DEFAULT_KEYLEN)
  OpenSSL::PKCS5.pbkdf2_hmac_sha1(secret_key_base, salt, iter, keylen)
end

encrypt_key = generate_key(SECRET_KEY_BASE, DEFAULT_SALT)[0...32]
puts Base64.strict_encode64(encrypt_key)
# => vozBHj31liL/p88es/k7aywa4Po4mwMVkW/eqhFjw/4=

IV 是随机的 16 个字节。解密的时候需要用到，所以需要保存起来下一步拼装的时候用。可以用 SecureRandom.random_bytes 或者 OpenSSL::Cipher.random_iv。

使用 OpenSSL 实现如下，IV 应该要随机的，为了方便对照，直接用了 16 个 0

encrypt_key = generate_key(SECRET_KEY_BASE, DEFAULT_SALT)[0...32]
puts Base64.strict_encode64(encrypt_key)

cipher = OpenSSL::Cipher.new("aes-256-cbc")
cipher.encrypt
cipher.key = encrypt_key

iv = "\0" * 16
# iv = cipher.random_iv

encrypted_content = cipher.update(session_json)
encrypted_content << cipher.final
puts Base64.strict_encode64(encrypted_content)
# => t7c1ncaCXhZAOPRtX0BI8eceOmx/Qg3Jrg6uwmgJuSNosKIc7M4KRfOw1q3mFWv7ZSiNO3ZRPxJMGI1cDvu+PQ==

④ 拼装加密内容和 IV

得到 encrypted_content 和 iv 后，分别 base64 后用 -- 连接，然后再做一次 base64 得到 encrypted_data

encrypted_data = Base64.strict_encode64(
  Base64.strict_encode64(encrypted_content) +
  "--" +
  Base64.strict_encode64(iv)
)
puts encrypted_data
# => dDdjMW5jYUNYaFpBT1BSdFgwQkk4ZWNlT214L1FnM0pyZzZ1d21nSnVTTm9zS0ljN000S1JmT3cxcTNtRld2Ny0tQUFBQUFBQUFBQUFBQUFBQUFBQUFBQT09

⑤ 签名 HMAC-SHA1

签名用的 HMAC-SHA1，结果转成 16 进制字符串。Key 参考加密步骤中的说明。

sign_key = generate_key(SECRET_KEY_BASE, DEFAULT_SIGN_SALT)
sign = OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA1.new, sign_key, encrypted_data)
puts sign
# => 75d8323b0f0e41cf4d5aabee1b229b1be76b83b6

⑥ 拼装签名

最后把 encrypted_data 和 sign 用 -- 连接然后做一次 URL Query Escape 就可以了

require "uri"
cookie_content = URI.encode_www_form_component(encrypted_data + "--" + sign)
puts cookie_content
# => dDdjMW5jYUNYaFpBT1BSdFgwQkk4ZWNlT214L1FnM0pyZzZ1d21nSnVTTm9zS0ljN000S1JmT3cxcTNtRld2Ny0tQUFBQUFBQUFBQUFBQUFBQUFBQUFBQT09--75d8323b0f0e41cf4d5aabee1b229b1be76b83b6

完整的代码：rails-cookie-encrypt.rb

如果用 ActiveSupport 可以简化成

require "active_support/key_generator"
require "active_support/message_encryptor"
encrypt_key = ActiveSupport::KeyGenerator.new(SECRET_KEY_BASE, iterations: DEFAULT_ITER).generate_key(DEFAULT_SALT, 32)
sign_key = ActiveSupport::KeyGenerator.new(SECRET_KEY_BASE, iterations: DEFAULT_ITER).generate_key(DEFAULT_SIGN_SALT, 64)
encryptor = ActiveSupport::MessageEncryptor.new(encrypt_key, sign_key, serializer: JSON)
puts encryptor.encrypt_and_sign(session)

解密

解密就是把 6 个步骤反过来，输入就是

cookieContent := "dDdjMW5jYUNYaFpBT1BSdFgwQkk4ZWNlT214L1FnM0pyZzZ1d21nSnVTTm9zS0ljN000S1JmT3cxcTNtRld2Ny0tQUFBQUFBQUFBQUFBQUFBQUFBQUFBQT09--75d8323b0f0e41cf4d5aabee1b229b1be76b83b6"

⑥ 分离签名

URL Query Unescape 然后以 -- 分成 encryptedData 和 sign

var err error
var unescapedCookieContent string
if unescapedCookieContent, err = url.QueryUnescape(cookieContent); err != nil {
  panic(err)
}
encryptedDataSignVectors := strings.SplitN(unescapedCookieContent, "--", 2)
encryptedData := encryptedDataSignVectors[0]
sign := encryptedDataSignVectors[1]
fmt.Printf("encrypted_data = %v\n", encryptedData)
fmt.Printf("sign = %v\n", sign)
// => encrypted_data = dDdjMW5jYUNYaFpBT1BSdFgwQkk4ZWNlT214L1FnM0pyZzZ1d21nSnVTTm9zS0ljN000S1JmT3cxcTNtRld2Ny0tQUFBQUFBQUFBQUFBQUFBQUFBQUFBQT09
// sign = 75d8323b0f0e41cf4d5aabee1b229b1be76b83b6

⑤ 验证签名

验证签名其实就是再签一次然后对比结果。为了安全，可以使用 hmac.Equal 来比较签名是否一致。

Key 的生成可以使用 golang.org/x/crypto/pbkdf2

const (
  keyIterNum = 1000
  keySize    = 64
)

func generateKey(base, salt string) []byte {
  return pbkdf2.Key([]byte(base), []byte(salt), keyIterNum, keySize, sha1.New)
}

验证实现如下

secretKeyBase := "development_secret"
defaultSignSalt := "signed encrypted cookie"
signKey := generateKey(secretKeyBase, defaultSignSalt)
signHmac := hmac.New(sha1.New, signKey)
signHmac.Write([]byte(encryptedData))
verifySign := signHmac.Sum(nil)
fmt.Printf("verifySign = %v\n", hex.EncodeToString(verifySign))
// verifySign = 75d8323b0f0e41cf4d5aabee1b229b1be76b83b6
var signDecoded []byte
if signDecoded, err = hex.DecodeString(sign); err != nil {
  panic(err)
}
if !hmac.Equal(verifySign, signDecoded) {
  panic(fmt.Errorf("verification failed"))
}

④ 分离加密内容和 IV

Base64 解码一次，用 -- 分离并分别 Base64 解码得到 encryptedContent 和 iv

var encryptedDataBase64Decoded []byte
if encryptedDataBase64Decoded, err = base64.StdEncoding.DecodeString(encryptedData); err != nil {
  panic(err)
}
encryptedContentIvVectors := strings.SplitN(string(encryptedDataBase64Decoded), "--", 2)
var encryptedContent []byte
var iv []byte
if encryptedContent, err = base64.StdEncoding.DecodeString(encryptedContentIvVectors[0]); err != nil {
  panic(err)
}
if iv, err = base64.StdEncoding.DecodeString(encryptedContentIvVectors[1]); err != nil {
  panic(err)
}
fmt.Printf("encrypted_content = %s\n", base64.StdEncoding.EncodeToString(encryptedContent))
fmt.Printf("iv = %v\n", iv)
// encrypted_content = t7c1ncaCXhZAOPRtX0BI8eceOmx/Qg3Jrg6uwmgJuSNosKIc7M4KRfOw1q3mFWv7
// iv = [0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0]

③ 解密

用 Key 和 iv 来解密

defaultSalt := "encrypted cookie"
encryptKey := generateKey(secretKeyBase, defaultSalt)[:32]
c, err := aes.NewCipher(encryptKey)
if err != nil {
  panic(err)
}

cfb := cipher.NewCBCDecrypter(c, iv)
paddedSession := make([]byte, len(encryptedContent))
cfb.CryptBlocks(paddedSession, encryptedContent)
fmt.Printf("padded_session = %s\n", strconv.QuoteToASCII(string(paddedSession)))
// padded_session = "{\"warden.user.user.key\":[[1],\"secret\"]}\t\t\t\t\t\t\t\t\t"

② Un-padding

去除 padding 只需要看最后一个字节是多少就移除多少个字节。

padding := int(paddedSession[len(paddedSession) - 1])
sessionJSON := string(paddedSession[:(len(paddedSession) - padding)])
fmt.Printf("session_json = %s\n", sessionJSON)
// session_json = {"warden.user.user.key":[[1],"secret"]}

如果是 JSON 用 go JSON 库解析就可以了。如果是 Ruby Marshal 也不用完整实现，可以用正则提取需要的信息。

var jsonData map[string]interface{}
if err := json.Unmarshal([]byte(sessionJSON), &jsonData); err != nil {
  panic(err)
}
fmt.Printf("%+v\n", jsonData)
// map[warden.user.user.key:[[1] secret]]

完整的代码：rails-cookie-decrypt.go

如果 Rails 里用的 Devise，可以在 config/initializers/devise.rb 增加下面的配置来在 Cookie 中包含更多的字段，比如用户名或邮箱

Warden::Manager.after_authentication do |user, auth, opts|
  auth.raw_session['warden.user.user.email'] = user.email
end

需要用户重新登陆或者更换 secret key base 才会生效。

记录使用 typhoeus 调用 360 HTTPS API 时碰到的坑

doitian — Sat, 26 Sep 2015 21:06:12 +0800

--- 本文原文发布在 https://www.3pjgames.com/archives/229

第一款游戏上线之后，陆续发现了一些诡异的问题。其中一个是通过 360 SDK 登录的用户在进行服务器验证的时候，偶尔会出现 HTTP 客户端没有收到任何回应就返回的情况。怪异的是当尝试手动发送请求的时候，却无法重现，即使是用脚本模拟不停的发送请求。后来陆续发现其它一些渠道，像豌豆荚也出现类似情况。

经过差不多一天的研究和分析，最终发现是这些登录验证服务提供的是 HTTPS 接口，但是可能服务器版本比较老，并没有完全符合 HTTPS 协议中的一些标准。而我们使用的客户端 typhoeus 做了非常多的性能优化，其中对 HTTPS 的一项优化最终导致了 TLS 握手失败，客户端没有收到任何回应就返回了。

TLDR; 问题出在 typhoeus 启用了 SSL session id cache，而这些渠道提供的 HTTPS 服务器未能正确处理该标准 (RFC5246)。解决方案只能是牺牲性能，将连接选项中的 :ssl_sessionid_cache 设置为 false。Typhoeus 是对 libcurl 的封装，对应的选项是 CURLOPT_SSL_SESSIONID_CACHE。如果使用了其它基于 libcurl 的 HTTP 客户端启用了这项优化，也需要找到地方关闭这个选项。

变通方案

我们通过统一的网关来集成各种第三方 SDK 的登录验证，该服务使用 Ruby 实现，使用了 HTTP 客户端框架 Faraday，底层传输使用了 typoeus，而 typoeus 又是对 libcurl 的封装。

问题发生之后，首先想到的还是网络问题，另外线上问题需要快速解决，所以首先加上了自动重试。Faraday 已经提供了 retry 中间件，只需要在出现这种问题的时候抛出特定类型的异常就可以了。因为没返回结果的时候 status code 是 0，加个中间件去检查 status code 就行了。

当 status 为 0 的时候抛出 EmptyResponseError

class EmptyResponseError < HttpSdkError; end
class CheckEmptyResponse < Faraday::Response::Middleware
  def on_complete(env)
    if env[:status].to_i == 0
      raise EmptyResponseError
    end
  end
end

当抛出 EmptyResponseError 的时候重试两次。注意 response 中间件是以相反的顺序处理，中间件 CheckEmptyResponse 加到最后面让它最先处理返回结果。

conn = Faraday.new('https://openapi.360.cn') do |builder|
  builder.request :retry, max: 2, interval: 0.05,
    interval_randomness: 0.5, backoff_factor: 2,
    exceptions: [EmptyResponseError]

  builder.request :json
  builder.response :json
  builder.use CheckEmptyResponse

  builder.adapter :typhoeus 
end

加了之后还是会出现连续 3 次都是空结果的情况，但是频率已经大大降低。

定位问题

加上重试问题的影响大大降低，也赢得时间去彻底解决问题。

我们自架了 Sentry 来收集各种异常，问题最初就是通过 Sentry 的通知发现的。但是因为出错时，HTTP 客户端没有收到返回，所以完全无法得知原因，而手动改送请求或者通过 Sentry 的『重放』都能拿到正确的返回结果，无法重现。

首先想到的是加日志，于是在向 360 发送请求时开启了 Faraday 的中间件 logger 来打印更详细的日志，但是依然未能发现问题。于是只能去看 typoeus 的源代码，发现可以通过全局设置来显示更多的信息：

Typhoeus::Config.verbose = true

但是另外一个问题是没办法手动去重现，只能等着问题发生。虽然这个问题隔一段时间就会出现，可是有时候要等上几个小时。这会导致添加日志和尝试修改之后确认的反馈环节被拉长，可以要几天才能有点眉目，很难排除无效的修复方案。

之前提到过用脚本模拟循环发也没办法重现，但是线上却一定会发生，于是想到通过解析日志，重发所有 360 的请求。这个方法果然有效，终于能比较快速的去获得反馈了，而且可以在出现问题的时候，在脚本中插入 pry 进行检查，大大加快了定位问题的速度。最终通过 Typhoeus 的日志可以确定问题是因为 TLS 握手失败了

Hostname was found in DNS cache
  Trying 220.181.132.231...
Connected to openapi.360.cn (220.181.132.231) port 443 (#2)
successfully set certificate verify locations:
  CAfile: none
  CApath: /etc/ssl/certs
SSL re-using session ID
SSLv3, TLS handshake, Client hello (1):
...

 SSLv3, TLS alert, Server hello (2):
Ferror:1408F10B:SSL routines:SSL3_GET_RECORD:wrong version number
Closing connection 2

解决问题

找到问题原因但是怎么解决还是一头雾水，求助 Google 也基本说得是证书问题。然而关闭 peer verification 并没有什么用。也有提到 openssl 版本问题的，安装了 libcurl4-openssl-dev，更新了 gems faraday 和 typhoeus 也没有任何用。

不过对比成功和失败请求的 Typoeus 请求，注意到所有空结果都会包含

SSL re-using session ID

一开始以为是 keep alive 导致的问题，关闭之后也没能解决问题。最后定位到 RFC5246，而且在 Mac 下 man curl 也提到

--no-sessionid (SSL) Disable curl's use of SSL session-ID caching. By default all transfers are done using the cache. Note that while nothing should ever get hurt by attempting to reuse SSL session-IDs, there seem to be broken SSL implementations in the wild that may require you to disable this in order for you to succeed. (Added in 7.16.0) Note that this is the negated option name documented. You can thus use --sessionid to enforce session-ID caching.

简要来说就是 sessionid 缓存不会带来任何坏处，但是这个世界上还有很出有问题的 SSL 实现，这时可以通过该选项禁用。

通过这个线索去 typhoeus 源码里去搜索相关选项，最终找到 ssl_sessionid_cache。不过因为 faraday 没有暴露出该选项的设置，所以采用了 monkey pack 的方式强制将该选项设置为 false

require 'typhoeus/adapters/faraday'

module TyphoeusRequestPatch
  def request(env)
    req = super(env)
    req.options[:ssl_sessionid_cache] = false
    req
  end
end

Faraday::Adapter::Typhoeus.prepend TyphoeusRequestPatch

测试之后问题解决。

这也说明了为何手动难重现，因为这个问题只会在 keep alive 的连接失效，而 session id 的缓存又还没失效的窗口之间发生。

后记

国内环境中使用 HTTPS 各种坑，这里提到的是服务端的问题。另外在手机客户端上也是一堆问题，比如相当一部份的国产 Android 系统手机上不信任 GoDaddy 颁发的证书，有些低端机上发送 HTTPS 请求会静默失败，没有返回结果也不报任何错。所以不管前端、后端，碰到了 HTTPS，预先考虑各种情况，记录下详细日志方便日后调试。

RubyConfChina 2013 大会视频 (更新下载链接)

doitian — Sun, 24 Nov 2013 09:02:10 +0800

@rails 发现 InfoQ 已经上传了大会视频，但是没有做整理，所以手动给整理了下

Nov 28, 2013: 更新下载链接 (Thanks @windix )

Day 1

Zach Holman -- "More Git and GitHub Secrets" (MP4 下载)
Daniel Bovensiepen -- "Shrink To Grow" (MP4 下载)
肖雪洁 -- "Writing Ruby web server for node.js" (MP4 下载)
ihower -- "從 Classes 到 Objects：那些 OOP 教我的事" (MP4 下载)
吕戈 -- "How To Build A Sync-Like Async Web Server" (MP4 下载)
Jack Chen -- "Test your Rails application with pleasure" (MP4 下载)
Kevin Dewalt -- "How entrepreneurs can use Ruby and Rails to accelerate their companies with Lean Startup strategies." (MP4 下载)
Obie Fernandez -- "Burning Ruby Lessons from Burning Man applied to theRuby Community" (MP4 下载)

Day 2

朱琅 -- "Ruby 在京东云擎中的使用" (MP4 下载)
Prem -- "Hidden gems in Ruby on Rails" (MP4 下载)
鲁葳 -- "RSpec: the good parts and the tricky parts" (MP4 下载)
Ian -- "Migration to JRuby: what we learned" (MP4 下载)
陈金洲 -- "Rails 项目架构演进" (MP4 下载)
杨濯宇 -- "Discovering Better Object Oriented Design with Tests" (MP4 下载)
李路 -- "Artisan and Artist - From programmer to designer" (MP4 下载)
XDite -- "Maintainable Rails View" (MP4 下载)
Dave Thomas -- "红宝石，编码乐 (Code Ruby, Be Happy)" (MP4 下载)

幻灯片汇集

批量下载链接

http://cm12.c110.play.bokecc.com/flvs/0575C033D2012A28/2013-11-13/25CE229B1FC90DC99C33DC5901307461-10.mp4
http://cm12.c110.play.bokecc.com/flvs/0575C033D2012A28/2013-11-13/1F705B6CDDAC86549C33DC5901307461-10.mp4
http://cm12.c110.play.bokecc.com/flvs/0575C033D2012A28/2013-11-13/6277F1AB41BDD8879C33DC5901307461-10.mp4
http://cm12.c110.play.bokecc.com/flvs/0575C033D2012A28/2013-11-13/179A51A9D068D1269C33DC5901307461-10.mp4
http://cm12.c110.play.bokecc.com/flvs/0575C033D2012A28/2013-11-13/AD137E6F03FFF81C9C33DC5901307461-10.mp4
http://cm12.c110.play.bokecc.com/flvs/0575C033D2012A28/2013-11-16/7BD527A7D27665B89C33DC5901307461-10.mp4
http://cm12.c110.play.bokecc.com/flvs/0575C033D2012A28/2013-11-13/15813F3D34FBA6809C33DC5901307461-10.mp4
http://cm12.c110.play.bokecc.com/flvs/0575C033D2012A28/2013-11-13/FE88003E33E93B179C33DC5901307461-10.mp4
http://cm12.c110.play.bokecc.com/flvs/0575C033D2012A28/2013-11-14/FFD7B2A8A0BB2C9B9C33DC5901307461-10.mp4
http://cm12.c110.play.bokecc.com/flvs/0575C033D2012A28/2013-11-13/66C36F473914148E9C33DC5901307461-10.mp4
http://cm12.c110.play.bokecc.com/flvs/0575C033D2012A28/2013-11-13/27F9E19F390383119C33DC5901307461-10.mp4
http://cm12.c120.play.bokecc.com/flvs/0575C033D2012A28/2013-11-13/00888B6DB15B3B5F9C33DC5901307461-10.mp4
http://cm12.c110.play.bokecc.com/flvs/0575C033D2012A28/2013-11-13/9FCA8656DEBF9DA29C33DC5901307461-10.mp4
http://cm12.c110.play.bokecc.com/flvs/0575C033D2012A28/2013-11-13/ADBC4D0352138E059C33DC5901307461-10.mp4
http://cm12.c110.play.bokecc.com/flvs/0575C033D2012A28/2013-11-13/FDBBDB91F51F4AAB9C33DC5901307461-10.mp4
http://cm12.c110.play.bokecc.com/flvs/0575C033D2012A28/2013-11-13/F8524678E24A1DB59C33DC5901307461-10.mp4
http://cm12.c110.play.bokecc.com/flvs/0575C033D2012A28/2013-11-13/F96271D4AED7CACC9C33DC5901307461-10.mp4

今天才发现 ruby 的标准库有个 un

doitian — Mon, 08 Jul 2013 14:45:26 +0800

http://www.ruby-doc.org/stdlib-2.0//libdoc/un/rdoc/un_rb.html

提供了一些常用的 Unix 命令，库的名字可能是取自 UNix，也可能是为了命令行下容易记住，因为命令行下 require 的选项是 -r，使用这个库就是 -run。最有用的功能应该是 one line http server 了，类似 python 的 python -m SimpleHTTPServer [port] 或 python -m http.server [port]

ruby -run -e httpd . -p 5000

来源：https://twitter.com/n0kada/status/351556831958667264

Rails 两种创建组合输入的方法

doitian — Sat, 19 Jan 2013 21:54:07 +0800

http://iany.me/2013/01/rails-compound-input/

介绍 Rails 中两种实现组合输入方法。

这源于这样一个需要，表单中需要输入时间，对应的字段是 datetime，为了方便输入，希望把日期部分做成文本框，然后用 JavaScript 的 date picker 来选择。时间部份可以要求用户手动输入，或者也使用 JavaScript 的 time picker。把下面的例子扩展，也可以实现时间部分使用下拉菜单来输入。

两种方法分别使用了 composed_of 和 fields_for。 composed_of 和 datetime_select 类似，使用了 assign_multiparameter_attributes 这个方法。而 fields_for 则是伪装成 association。

两种方法的示例可以在 doitian/rails-compound-input-demo 中找到。

composed_of

Rails 本身就有 date_select, time_select and datetime_select 这些组合输入控件。它们都利用了 [assign_multiparameter_attributes][] 这个特性：如果参数名最后带有小括号，会按照括号中的位置对应到 constructor 中。但是 datetime 对应的类是 DateTime，它的构造函数接受的是 6 个参数，年、月、日、时、分、秒。

这里可以使用 [composed_of][] 来把 attribute 转换成 value object, 并且构造函数使用日期和时间两个字符串类型参数。见下面 CompoundDatetime#initialize

class CompoundDatetime
  def self.from_datetime(datetime)
    new.tap do |result|
      result.datetime = datetime
    end
  end

  attr_accessor :datetime

  # Accepts date and time string. The form just need to submit params
  #
  #   - compound_beginning_time(1s) for date
  #   - compound_beginning_time(2s) for time
  def initialize(date = nil, time = nil)
    if date.present?
      @datetime = Time.zone.parse([date.presence, time.presence || ''].join(' '))
    end
  end

  def date
    @datetime.strftime('%Y-%m-%d') if @datetime
  end

  def time
    @datetime.strftime('%H:%M') if @datetime
  end
end

compound_datetime.rb

在 model 中使用 composed_of 建立映射：

class Event < ActiveRecord::Base
  attr_accessible :beginning_time, :title
  attr_accessible :compound_beginning_time

  composed_of :compound_beginning_time, {
    :class_name => 'CompoundDatetime',
    :mapping => [ %w(beginning_time datetime) ],
    :converter => Proc.new { |datetime| CompoundDatetime.from_datetime(datetime) }
  }
end

event.rb

在 form view 中只需要正确设置参数名。

<div class="field">
  <%= f.label :compound_beginning_time, 'Begining Time' %><BR />
  <%= text_field_tag 'event[compound_beginning_time(1s)]', @event.compound_beginning_time.date, :placeholder => 'yyyy-mm-dd' %>
  <%= text_field_tag 'event[compound_beginning_time(2s)]', @event.compound_beginning_time.time, :placeholder => 'HH:MM' %>
</div>

events/_form.html.erb

fields_for

fields_for 一般用来在 form 中嵌入 associations。不过

它所需要的只是一个 getter 方法和 <field>_attributes= 的 setter 方法。 Compound Attributes and fields_for in Rails | Wondible

首先还是创建 CompoundDatetime，它需要有 date 和 time 两个 attributes。 assign_attributes 用来处理 form 传来的 params hash。方法 persisted? 是为了消除 NoMethodError。

class CompoundDatetime
  attr_accessor :datetime

  def initialize(datetime)
    @datetime = datetime
  end

  # accepts hash like:
  #
  #     {
  #       'date' => '2012-12-20',
  #       'time' => '20:30'
  #     }
  def assign_attributes(hash)
    if hash[:date].present?
      @datetime = Time.zone.parse([hash[:date].presence, hash[:time].presence || ''].join(' '))
    end
    self
  end

  def date
    @datetime.strftime('%Y-%m-%d') if @datetime
  end

  def time
    @datetime.strftime('%H:%M') if @datetime
  end

  def persisted?; false; end
end

compound_datetime.rb

Model 只需要代理给 CompoundDatetime.

class Event < ActiveRecord::Base
  attr_accessible :beginning_time, :title

  attr_accessible :compound_beginning_time_attributes

  def compound_beginning_time
    CompoundDatetime.new(beginning_time)
  end

  def compound_beginning_time_attributes=(attributes)
    self.beginning_time = compound_beginning_time.assign_attributes(attributes).datetime
  end
end

event.rb

Form view 中使用 fields_for 来嵌入 compound_begining_time 的属性

<div class="field">
  <%= f.label :beginning_time %><br />
  <%= f.fields_for :compound_beginning_time do |fields| %>
    <%= fields.text_field :date, :placeholder => 'yyyy-mm-dd' %>
    <%= fields.text_field :time, :placeholder => 'HH:MM' %>
  <% end %>
</div>

events/_form.html.erb

参考

Alex Rothenberg - How to use dates in Rails when your database stores a string
Compound Attributes and fields_for in Rails | Wondible
Ruby on Rails Guides: Rails Form helpers
[assign_multiparameter_attributes][]
[composed_of][]

[assign_multiparameter_attributes]: http://apidock.com/rails/ActiveRecord/AttributeAssignment/assign_multiparameter_attributes "ActiveRecord::AttributeAssignment#assign_multiparameter_attributes" [composed_of]: http://api.rubyonrails.org/classes/ActiveRecord/Aggregations/ClassMethods.html#method-i-composed_of "ActiveRecord::Aggregations.composed_of"

markdown 测试

doitian — Sat, 05 Jan 2013 20:10:26 +0800

User metion

@doitian @__doitian__ @_doitian_ @doitian_t__ @doitian

@doitian = 10

@"test"

At floor

#1F #1F

#1F

emoji

:apple:

:apple:

encoding

中文@就乱码

chef-solo-repo: 加了默认配置，集成了 vagrant 和 capistrano 的 chef repo

doitian — Wed, 19 Dec 2012 08:19:32 +0800

Github: https://github.com/doitian/chef-solo-repo/

用 chef-repo 的话，即使运行了 knife configure，还是有路径指向了 /etc, /var 这些位置，测试 cookbooks 都得需要 root 权限，很不方便，所以我加了默认的配置，把路径会都调整到 repo 中的 .chef 文件夹。

另外，cookbooks 的测试最好是用 virtual machine，我添加了 Vagrantfile，直接用 vagrant 可以创建测试用的虚拟机。

最后，我不太喜欢 chef-server，所以我都是使用 capistrano，一条命令就可以把整个 repo 打包上传到服务器，安装依赖 (bundler) 并运行 chef-solo。所有服务器的配置都放在 repo 下的 servers 文件夹，做了些 cap 的 hacking，可以很方便地指定哪些服务器需要运行 chef-solo

使用 Active Model 封装方便生成表单

doitian — Sun, 16 Dec 2012 21:43:54 +0800

在 Rails 中需要编辑 ActiveRecord 对象时，可以很方便的使用 form_for (或者 simple_form_for) 来生成表单。但是有时候需要编辑的对象不是 ActiveRecord，比如导入导出数据，搜索的时候需要表单；再比如有时候系统设置为了不经常去改 schema 会使用 rails-settings-cached 这样的 gem 来存储。这种时候就可以用 ActiveModel 的 modules 来生成一个 class，它满足 form builder 对 ActiveRecord 的所有需求，所以可以直接用在 form builder 里。

详见 gist: https://gist.github.com/4307089

其中 type_caster 可以限制类型，并能进行类型转换。

Ryan 在 Railscasts #396 也做了类似的封装。

pry 代替 Rails console 的 irb，不用加进 Gemfile

doitian — Mon, 09 Apr 2012 07:39:04 +0800

原理就是先不加载 Bundler，用 rubygems 把 pry awesome_print 等 gems 加进来以后来把 rails app 加进来。把 Rails::Console::IRB 设置成 Pry，Hack 下 ARGV，就可以交给 rails/commands 处理了

已经包装成 gem rails-console-pry，安装不走 bundler，如果用了 rvm gemset，需要安装到 gemset 中。顺带可以安装些 pry plugins

gem install rails-console-pry pry-doc awesome_print

然后在 rails app 根目录直接

rails-console-pry

或者进 production 环境

rails-console-pry production

需要在 Bundler 之前加载插件（就是指不在 Gemfile 中的插件）用 -r 选项

rails-console-pry -r pry-doc -r awesome_print

最好是加个 alias

alias rpry='rails-cosnole-pry -r pry-doc -r awesome_print'

rbenv gemset 使用心得 for zsh

doitian — Sat, 07 Apr 2012 14:38:26 +0800

[rbenv-gemset][] 是 [rbenv][] 一个插件，支持在目录树中使用指定的 gemsets。和 [rvm][] 相比，因为文件.rbenv-gemsets并不包含任意可执行代码，不需要人肉确定是否信任。

安装只需要把 rbenv-gemset clone 到 .rbenv/plugins 里。使用方法很简单，在需要使用 gemsets 的目录上建立文件，用空格分开所有 gemsets。其中第一个 gemset 也会作为 gems 安装目录。

注意如果要指定 ruby 版本，需要使用 rbenv local 方法。

在 rvm 中一个很方便的功能就是可以在指定的 gemset 中执行一个命令，而 rbenv-gemset 则必须更改 .rbenv-gemsets 文件，很容易会忘记改回来。好在可以通过 RBENV_GEMSET_FILE 指定文件，所以可以建立个临时文件，写入要用的 gemsets。在 zsh 中可以使用 =(<<<arg) (see zshexpn(1) Process Substitution)，见下面包装函数 gemset。原来的 rbenv gemset 二级命令仍然可以使用，比如 gemset list。如果第一个参数不是有效的命令，会当成 .rbenv-gemsets 文件的内容。比如在 gemset generator 中执行 rails 命令

gemset generator rails

这样可以把一些常用命令安装到单独的 gemset 中，保持环境整洁（洁癖有木有）。示例：

gemset generator gem install rails gemset tools gem install github tmuxinator gemset deploy gem install capistrano capistrano-ext bundler gemset debug gem install pry pry-doc awesome_print rbenv rehash

为方便使用可以建立 alias (rvm users 也可以这么干)

alias github='gemset tools github' alias gh=github alias tmuxinator="gemset tools tmuxinator" alias cap='gemset deploy cap' alias capify='gemset deploy capify' alias pry='gemset debug pry' alias irb='pry'

rails 命令比较特殊，我希望是在有 Gemfile 的目录树中使用 bundler 指定的版本，而在其它目录中使用 gemset generator 中的版本，见最后面的 bundler alias

gemset

# unset global RBENV_GEMSET_FILE to get a clean environment.
# For example, tmuxinator may set this because it is a Ruby gem.
unset RBENV_GEMSET_FILE
function gemset() {
  if [ -z "$1" ]; then
    rbenv gemset active
  else
    local action="$1"
    shift
    case "$action" in
      active|create|delete|file|list|version)
        rbenv gemset "$action" "$@"
        ;;
      *)
        RBENV_GEMSET_FILE==(<<<"$action") "$@"
        ;;
    esac
  fi
}

# completion function for gemset
function _gemset() {
  local -a _actions _gemsets
  _actions=(active create delete file list version)
  _gemsets=($(rbenv gemset list | grep '^ ' | uniq))
  _arguments ":action: _values actions ${_actions} ${_gemsets}" '*::arguments: _sudo'
}
compdef _gemset gemset

bundler alias

##################################################
# Bundle Alias
# from oh-my-zsh bundler plugin

alias be="bundle exec"
alias bi="bundle install"
alias bl="bundle list"
alias bp="bundle package"
alias bu="bundle update"

bundled_commands=(cucumber foreman guard nanoc3 rackup rails rainbows rake rspec shotgun spec spork thin unicorn unicorn_rails knife)

_bundler-installed() {
  which bundle > /dev/null 2>&1
}

_within-bundled-project() {
  local check_dir=$PWD
  while [ "$(dirname $check_dir)" != "/" ]; do
    [ -f "$check_dir/Gemfile" ] && return
    check_dir="$(dirname $check_dir)"
  done
  false
}

bundler-exec() {
  if _bundler-installed && _within-bundled-project; then
    bundle exec "$@"
  else
    case "$1" in
      nanoc3|rails)
        gemset generator "$@"
        ;;
      *)
        "$@"
        ;;
    esac
  fi
}

compdef _sudo bundler-exec

## Main program
for cmd in $bundled_commands; do
  alias $cmd="bundler-exec $cmd"
done

摘自我的 zsh 配置 rbenv.zsh

[rbenv]: https://github.com/sstephenson/rbenv [rbenv-gemset]: https://github.com/sstephenson/rbenv-gemset [rvm]: http://beginrescueend.com/

Rails try method changes

doitian — Wed, 04 Apr 2012 12:29:50 +0800

今天把一个项目从 rails 3.1.0 升级到 3.1.4，碰到一堆 method missing exceptiosn。结果是 rails 3.1.4 里 try 现在只吞掉 receive 是 nil 的 exception，而以前也是会检查respond_to?的。

https://github.com/rails/rails/issues/3264

XMonad Starter Kit 平铺窗口管理器配置分享

doitian — Tue, 03 Apr 2012 08:51:22 +0800

把我自己用的 XMonad 配置和一些脚本单独抽了出来 https://github.com/doitian/xmonad-starter-kit

基于 dzen2 的 panel，多显示器下会在当前显示器显示信息
基于 dmenu 的跳转或创建 workspace，有匹配的就跳转，否则创建新的 workspace
基于 dmenu 的 layout 选择
需要关注的窗口 (Urgency)，会通过 libnotify 发送通知
支持鼠标切换 workspace 和 layout
如果安装了 gpicker，可以使用M-g (goto) 和M-b (bring) 切换窗口，支持 fuzzy match
精心挑选的 layouts 组合
M-c h显示快捷键列表

Sprockets 中集成 Jasmine 自动化测试 Javascript

doitian — Sun, 01 Jan 2012 21:07:57 +0800

介绍怎么在基于 Sprockets 的项目中测试前端 js。虽然以 Jasmine 为例，其它支持 HTML runner 的测试框架也是通用的。其实重点推荐的是用 livereload 来在文件修改后自动刷新页面执行测试

http://cn.intridea.com/2011/12/integrate-jasmine-in-sprockets-to-autotest-javascript/

在 Linux 下设置 Chromium Omnibar 快捷键

doitian — Fri, 30 Dec 2011 16:04:08 +0800

在 Linux 下用 Chromium 很不爽的是在 Omnibar 里，要上下选择匹配项只能用上下键，做为键盘控这是不可接受的，折腾了半天的 Google Chrome 都没搞定，换成 Chromium 最新版没有问题，应该是 gtk keybinding 的修改还没有进入 Google Chrome。

换成 Chromium 后只需要用 gtkrc 来设置

.gtkrc-2.0

binding "gtk-binding-text" {
    bind "<alt>n" { "move-cursor" (display-lines, 1, 0) }
    bind "<alt>p" { "move-cursor" (display-lines, -1, 0) }
    bind "<ctrl>n" { "move-cursor" (display-lines, 1, 0) }
    bind "<ctrl>p" { "move-cursor" (display-lines, -1, 0) }
    bind "<alt>BackSpace"  { "delete-from-cursor" (word-ends, -1) }
}
class "GtkEntry" binding "gtk-binding-text"
class "GtkTextView" binding "gtk-binding-text"

详细请查看 https://gist.github.com/1538492

在 emacs 里用 doxymacs mode 写 yard doc

doitian — Wed, 14 Dec 2011 22:36:38 +0800

https://github.com/doitian/doxymacs-yard

基于 emacswiki 上的 doxymacs-yard.el 改了下，加入了 yard doc tag 的高亮

原来 rebase 翻译成变基 ?

doitian — Wed, 14 Dec 2011 13:37:15 +0800

http://www.worldhello.net/gotgithub/04-work-with-others/020-shared-repo.html#id5

这翻译太有爱了

P.S. 这书还是很不错的

自动根据 host 判断 root 的 nginx with passenger 配置

doitian — Fri, 09 Dec 2011 08:19:18 +0800

server {
  server_name ~^(.*\.)?(?<app>[^.]+)\.dev$;
  root /opt/apps/$app/public;
  rails_env development;
  passenger_enabled on;
}

Nginx 0.8.25+ 应该都能用，参考 server_name

需要跑哪个 Rails/Rack app 就在/opt/apps 下面建立个 symbol link（link 到含 config.ru 的根目录)

cd /opt/apps
ln -s /path/to/myapp

当然 http 里需要设置下passenger_root和passenger_ruby。

www.myapps.dev 和 myapps.dev 都会访问 /opt/apps/myapp

如果你连/etc/hosts 都不想改，想像 pow 那样，在 Mac 下可以用这个脚本来启动 pow 里的 DNS server

Linux 有Hoof可以用（我还没试过），使用 nsswitch 来自动把指定的根域名解析到本机

[转] Ruby Blocks as Dynamic Callback

doitian — Tue, 06 Dec 2011 09:23:33 +0800

http://www.mattsears.com/articles/2011/11/27/ruby-blocks-as-dynamic-callbacks

用几行代码实现了很酷的效果，每次 yield 一个动态创建的 Class，通过这个 Class 去选择正确的 block

tmuxinator 的 shell completion

doitian — Fri, 02 Dec 2011 19:06:17 +0800

tmux 是个类似 screen 的终端会话管理工具，tmuxinator 是个自动化建立 tmux session 的工具，我一般都为每个项目建立个 tmuxinator config，然后启动服务，rails server, console, log 等等。

最新版本的 tmuxinator 已带 bash completion，只需要找到 gem 目录下的 bin/tmuxinator_completion，在 basrc 里 source 一下。

zsh 我刚发了个 pull request 到 oh-my-zsh，merge 后把 tmuxinator 加到 plugins 里就行了。目录可以下载

https://github.com/doitian/oh-my-zsh/blob/20b025ba2cd419a99630458052bfa9a9e8c99e91/plugins/tmuxinator/_tmuxinator

到某个目录，然后把这个目录加到 fpath 里

fpath=($HOME/.zsh/completions $fpath)

社区 wiki 文章整合

doitian — Fri, 02 Dec 2011 15:33:50 +0800

这三个都差不多，可以整合下。

比如 Category -> Posts

社区，wiki, 文章就是第一层的 3 个 category

每个 category 可以设置些属性和 ACL 控制：

是否默认开启 comment
是否需要审核
是否可以发贴（比如社区的根结点是没有 posts 的）
编辑权限

posts 可以有自己的 ACL 设置 override category 的设置

这样可以弄全局的热门 posts，可以把社区的帖子直接移动到 Wiki 去。如果 category posts 是多对多，还可以在 wiki 里添加一个 page 后，同时在社区显示为一个贴子