tobioka.net

gem

GemfileからSpecial Thanksページを生成するgem「arigato」と、それをRailsに簡単に組み込むengine「arigato_rails」を作った

3月 29

前々からいつかやりたいと思っていた、gem作りに挑戦してみました。
試行錯誤のうえ、できたのがこちら。

Arigato, Arigato_Rails

Railsならbundleするだけで以下のようなページが生成されます。
Special Thanks

先日公開したKonnyakuにも組み込む予定。

なぜ作ったか

お世話になってるオープンソースプロダクトへのせめてのもの感謝として、積極的にAttributionするように心がけています。

いつもは、Footerに並べることが多いんですが、それだとどうしてもスペースや保守の限界があって、主要なものだけになってしまいます。

そこで目を付けたのがGemfile。Rubyならまさにこれがお世話になったリストだから、この情報を使ってスペシャルサンクスページを自動生成しちゃえばいいじゃん、と考えました。

はじめてのGem

の2つが参考になりました。

あとはOreやThorのコードやSpecも勉強になりました。
また、Gemfileのパースについては、Bundler内のDSLというクラスを使わせてもらいました。

はじめてのEngine (Plugin)

あたりが勉強になりました。

また、同じ種類（bundleしたら画面が増える系）のgemということで、
schneems/sextant · GitHub
のコードを参考にさせてもらいました。

まとめ

今まで敷居が高いと思い込んでいましたが、単純なコマンドやプラグインなら思ったより簡単に出来るということがわかりました。これから、Gem化できそうなものがあれば積極的に作っていこうと思います。
とりあえず、arigato_podsは作りたい。

あとちゃんと出したものを保守する。テストも書く。

それでは、良い週末を。

oreでgemを作る

3月 25

ちょっとgemを作ってみたいので調べたメモ。
最近は、

$ bundle gem

1	$ bundle gem

で作るのがモダンらしいことはわかった。

けど、なんか日本語情報が多すぎてわーってなっちゃった。

bundle gemでも十分便利なんだけど、oreってやつ使えばもっと便利にwrapしてくれてるらしい。
これは日本語情報が今gemを作るなら bundle gem より ore gem – Hatena::Blog::toshiwo ぐらいしか見つからなくて混乱しなかったので、これを使ってみることにする。（どんな理由…）

まずはore（mineコマンド）を入れる。

# RubyMineとコマンド名がコンフリクトするので消しとく
$ sudo rm /usr/local/bin/mine

# インストール
$ gem install ore

# RubyMineとコマンド名がコンフリクトするので消しとく

$ sudo rm /usr/local/bin/mine

# インストール

$ gem install ore

helloコマンドでhelloと表示するgemを作ってみる。

# Gemのひな形作成
$ mine hello --bundler --rspec

# コマンド作る
$ mkdir bin
$ vim bin/hello
#!/usr/bin/env ruby
puts 'hello'
$ chmod +x bin/hello

# テスト
$ bundle
$ rspec
$ bundle exec bin/hello
hello

# Gemのひな形作成

$ mine hello --bundler --rspec

# コマンド作る

$ mkdir bin

$ vim bin/hello

#!/usr/bin/env ruby

puts 'hello'

$ chmod +x bin/hello

# テスト

$ bundle

$ rspec

$ bundle exec bin/hello

hello

gemをbuildして（ローカルで）インストールしてみる。

# 最低限の設定
$ vim hello.gemspec
  gem.summary       = 'hello'
  gem.description   = 'hello'

# インストールしてみる
$ git add .
$ git commit -am "First build"
$ rake build
$ gem install pkg/hello-0.1.0.gem

# 使ってみる
$ which hello
~/.rvm/gems/ruby-1.9.3-p385/bin/hello
$ hello
hello

# 最低限の設定

$ vim hello.gemspec

gem.summary = 'hello'

gem.description = 'hello'

# インストールしてみる

$ git add .

$ git commit -am "First build"

$ rake build

$ gem install pkg/hello-0.1.0.gem

# 使ってみる

$ which hello

~/.rvm/gems/ruby-1.9.3-p385/bin/hello

$ hello

hello

rake releaseとかすればrubygems.orgにも登録できるんだとか。超簡単ですね。

Ruby で作る、簡単 CLI ツールのススメ #Ruby #開発環境 #AdventCalendar – Qiita によるとThorってやつ使うとコマンドを楽に作れるらしいので、試しになんか作って公開するつもり。

メモ終わり。

ruby-gmailでRails3からサクッとgmail受信

7月 24

ruby-gmailなんて便利なgemがあるんですね、全然知らなかった。
いままでnet/imapで頑張ってた時間よカムバック…orz

ruby-gmailを使ってRubyからGmailのメールを受信して本文を取得 – Shoken OpenSource Society
で知りました。参考になる情報ありがとうございます！

こちらの記事は生Rubyの話ですが、当然Railsでも使えます。
そして僕らにはBundlerがあるのでもっと楽できるのです。

というわけで試してみました。

# Rails3だよ
$ rails -v
Rails 3.2.6

# 適当にRailsプロジェクト作る
$ rails new GmailReceiver
$ cd GmailReceiver/

# インストール
# 普通にいれると依存関係で実行時にエラーになるのでgitから入れる
$ vim Gemfile
gem 'ruby-gmail', :require => 'gmail', :git => 'git://github.com/dcparker/ruby-gmail.git'
$ bundle

# Rails3だよ

$ rails -v

Rails 3.2.6

# 適当にRailsプロジェクト作る

$ rails new GmailReceiver

$ cd GmailReceiver/

# インストール

# 普通にいれると依存関係で実行時にエラーになるのでgitから入れる

$ vim Gemfile

gem 'ruby-gmail', :require => 'gmail', :git => 'git://github.com/dcparker/ruby-gmail.git'

$ bundle

上の記事を参考に以下の様なバッチスクリプトを書きます。

# Receive unread email from gmail
# Thanks: http://shoken.hatenablog.com/entry/20120401/p1

logger = Rails.logger

gmail = Gmail.new(
  'user@example.com',
  'pass'
)

def get_body(mail)
  if !mail.text_part && !mail.html_part
    return "body: " + mail.body.decoded.encode("UTF-8", mail.charset)
  elsif mail.text_part
    return "text: " + mail.text_part.decoded
  elsif mail.html_part
    return "html: " + mail.html_part.decoded
  end 
end

gmail.inbox.emails(:unread).map do |mail|
  logger.debug "Subject: #{mail.subject}"
  logger.debug "Date: #{mail.date}"
  logger.debug "From: #{mail.from}"
  logger.debug "To: #{mail.to}"
  logger.debug get_body(mail)
end

gmail.disconnect

# Receive unread email from gmail

# Thanks: http://shoken.hatenablog.com/entry/20120401/p1

logger = Rails.logger

gmail = Gmail.new(

'user@example.com',

'pass'

)

def get_body(mail)

if !mail.text_part && !mail.html_part

return "body: " + mail.body.decoded.encode("UTF-8", mail.charset)

elsif mail.text_part

return "text: " + mail.text_part.decoded

elsif mail.html_part

return "html: " + mail.html_part.decoded

end

gmail.inbox.emails(:unread).map do |mail|

logger.debug "Subject: #{mail.subject}"

logger.debug "Date: #{mail.date}"

logger.debug "From: #{mail.from}"

logger.debug "To: #{mail.to}"

logger.debug get_body(mail)

end

gmail.disconnect

あとは、runnerで実行するだけです。

$ rails runner script/gmail_receiver.rb

1	$ rails runner script/gmail_receiver.rb

これだけで、log/development.logに

Subject: This is subject
Date: 2012-07-21T16:10:01+09:00
From: ["from@example.com"]
To: ["user@example.com"]
body: This is body message.

Subject: This is subject

Date: 2012-07-21T16:10:01+09:00

From: ["from@example.com"]

To: ["user@example.com"]

body: This is body message.

みたいな出力が並びます。
超お手軽ですね！

今度メール受信する要件があったら本格的に使ってみようと思います。

それでは。

Scroll to top

tobioka.net

You Ain't Gonna Need It

gem

GemfileからSpecial Thanksページを生成するgem「arigato」と、それをRailsに簡単に組み込むengine「arigato_rails」を作った

なぜ作ったか

はじめてのGem

はじめてのEngine (Plugin)

まとめ

oreでgemを作る

ruby-gmailでRails3からサクッとgmail受信

Find us on Facebook

最近の投稿

最近のコメント

カテゴリー

アーカイブ

gem

なぜ作ったか

はじめてのGem

はじめてのEngine (Plugin)

まとめ

Find us on Facebook

最近の投稿

最近のコメント

カテゴリー

タグ

アーカイブ