Kuroneko

クロネコヤマトの荷物追跡を照会する

Installation

Add this line to your application's Gemfile:

gem 'kuroneko'

And then execute:

$ bundle

Or install it yourself as:

$ gem install kuroneko

Usage

最新状態を取得する

require "kuroneko"

neko = Kuroneko.new

status = neko.status("1234-5678-9012")
#=> #<struct Kuroneko::Status>

status.number
#=> "123456789012"

status.status
#=> "配達完了"

status.to_h
  => {
    number: "123456789012",
    status: "配達完了",
    date:   "12/31",
    time:   "12:59",
    branch: "北東京ベース店",
    branch_code: "030990"
  }

履歴のうち最新の Kuroneko::Status は #latest? に true を返します。
Kuroneko#statuses で複数を一度に照会でき、結果は Array で返されます。

状態履歴を取得する

history = neko.history("1234-5678-9012")
#=> #<Kuroneko::History<Kuroneko::Status>>

History は Array を継承していて、以下を追加で実装しています。
- 履歴のうち最新の状態を返す #latest
- 伝票番号を返す #number
Kuroneko#histories で複数を一度に照会でき、結果は Array で返されます。

英語版を利用する

- require "kuroneko"
- neko = Kuroneko.new
+ require "kuroneko/en"
+ neko = Kuroneko::En.new

英語版を使うと担当店 / 担当店コードは取得できません。

伝票番号

#status, #statuses, #history, #histories に渡す伝票番号はそのまま問い合わせに使用するため、クロネコヤマト側が受け付ける形式であればどのようなものでも可能です。

Kuroneko::History, Kuroneko::Status から読み取る伝票番号は照会結果から取得し、数字のみからなる 文字列 で返ります。

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request