====== national-holiday-api ======

国民の祝日の管理機能と Web API を提供します。

[[https://github.com/shinoburc/national-holiday-api|github national-holiday-api]]

====== 機能要件 ======

  * [[http://rubyonrails.org/|rails]]
  * [[https://github.com/sferik/rails_admin|rails_admin]] が要求するパッケージ
  * PostgreSQL (依存はしていないのでrails流に他のDBへ変更できます) 
    * sudo apt-get install libpq-dev

====== インストール ======

github からソース取得
  git clone git://github.com/shinoburc/national-holiday-api.git

gemのインストール 
  cd national-holiday-api
  bundle install

DBセットアップ
  rake db:setup

rails 起動
  rails s

ブラウザでアクセス
  http://localhost:3000

デフォルトのユーザ名とパスワードは「admin@local.host/caladmin」です。
seed.rb には1948年から2150年までの祝日が設定されています。

====== herokuにデプロイ ======

github からソース取得
  git clone git://github.com/shinoburc/national-holiday-api.git

heroku にアプリケーションを作成 
  cd national-holiday-api
  heroku create YOUR_APP_NAME
  git push heroku master

DBセットアップ
  heroku run rake db:setup

ブラウザでアクセス
  http://YOUR_APP_NAME.heroku.com

デフォルトのユーザ名とパスワードは「admin@local.host/caladmin」です。
まず最初にパスワードを変更してください。
パスワード変更は「Administration」から行えます。

====== APIs ======

===== DATE1からDATE2までの祝日一覧を取得する =====

  api/holidays/list/DATE1/DATE2

例)
  localhost:3000/api/holidays/list/2013-01-01/2013-12-31
  (永続 API URL : localhost:3000/api/v1/holidays/list/)
  (今後、永続 API URL は戻り値等が変更されません)

上記では2013年の祝日一覧がJSON形式で取得されます。

XML形式で取得することもできます。

例)
  localhost:3000/api/holidays/list/2013-01-01/2013-12-31.xml

そして、[[http://unicorn.us.com/cal.html|.cal.dat]]形式で取得することもできてしまいます。
(これがやりたかったのでございます。)

例)
  localhost:3000/api/holidays/list/2013-01-01/2013-12-31.caldat

===== DATE1 が祝日か調べる =====
  
  api/holidays/is_holiday/DATE1

例)
  localhost:3000/api/holidays/is_holiday/2013-01-01
  (永続 API URL : localhost:3000/api/v1/holidays/is_holiday/)

true か false が帰ります。

====== APIs demo ======

[[http://national-holiday-api.heroku.com/api/holidays/list/2013-01-01/2013-12-31]]

[[http://national-holiday-api.heroku.com/api/holidays/is_holiday/2013-01-01]]

====== トップページ demo ======


[[http://national-holiday-api.heroku.com]]