kuroneko 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dc99051a8c3eafa28a676b63a511c76148fc073
-  data.tar.gz: 947635a252b19355bb3113b01115751df483786f
+  metadata.gz: a26e2b922612c37ef906c4b1f116659695045bee
+  data.tar.gz: 48a9346469bef41bd70748893154c6c329e75ec1
 SHA512:
-  metadata.gz: 7ea1a7eca84b763bb31d933d48b0a3ac2a15ea421bb927e84e6bd210334c452e898fa6c0a4361f3e59a33b95459133b72e0692b2a933c07811450cd7ff4c84e8
-  data.tar.gz: 966e01a52bc1a91fd9b099563e954e2aa574d16139986c6a6accf4ef24b977805061615468bfdee725df44e5b30bdd91e8ff56d0b7add4525972451cc7f40c9e
+  metadata.gz: 0932268fd5844e8d943c05f87b5d72b89eec9f9d4365712d27431175abbf1dd589483ad71b8466c21999cbfd20dd1eb7f72bb7f42736a4c6783b29f26302579c
+  data.tar.gz: f0512e95ee6d4c23337d915712ea182be43ad9a84c83b6f812a102dce586e08eee9f1e3d982ec427c9b2f75e9b31a4e70a7bfa9ff8e8054d8314b2ead7a37db2

data/README.md

@@ -20,32 +20,68 @@ Or install it yourself as:
 
 ## Usage
 
+### 最新状態を取得する
+
 ``` ruby
 require "kuroneko"
 
 neko = Kuroneko.new
 
-# English Version
-require "kuroneko/en"
-neko = Kuroneko::En.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"
+  }
+```
 
-# 1 つの荷物の状態履歴
-history = neko.history("1234-5678-9012")
+- 履歴のうち最新の `Kuroneko::Status` は `#latest?` に `true` を返します。
+- `Kuroneko#statuses` で複数を一度に照会でき、結果は `Array` で返されます。
 
-# 複数の荷物の状態履歴
-histories = neko.histories("1234-5678-9012", "1234-5678-9013", ... )
+### 状態履歴を取得する
 
-# 1 つの荷物の最新状態
-status = neko.status("1234-5678-9012")
-  # OR
-  status = history.latest
-  status = history.find(&:latest?)
+``` ruby
+history = neko.history("1234-5678-9012")
+#=> #<Kuroneko::StatusHistory<Kuroneko::Status>>
+```
+
+- `StatusHistory` は `Array` を継承していて、以下を追加で実装しています。
+    - 履歴のうち最新の状態を返す `#latest`
+    - 伝票番号を返す `#number`
+- `Kuroneko#histories` で複数を一度に照会でき、結果は `Array` で返されます。
 
-# 複数の荷物の最新状態
-statuses = neko.statuses("1234-5678-9012", "1234-5678-9013", ... )
+### 英語版を利用する
 
+``` diff
+- require "kuroneko"
+- neko = Kuroneko.new
++ require "kuroneko/en"
++ neko = Kuroneko::En.new
 ```
 
+英語版を使うと担当店 / 担当店コードは取得できません。
+
+### 伝票番号
+
+`#status`, `#statuses`, `#history`, `#histories` に渡す伝票番号は
+そのまま問い合わせに使用するため、クロネコヤマト側が受け付ける形式であれば
+どのようなものでも可能です。
+
+`Kuroneko::StatusHistory`, `Kuroneko::Status` から読み取る伝票番号は
+照会結果から取得し、数字のみからなる __文字列__ で返ります。
+
 ## Contributing
 
 1. Fork it

data/lib/kuroneko/en.rb

@@ -3,19 +3,18 @@
 require 'kuroneko'
 
 class Kuroneko
-  module En
+  # 英語版フォームでの問い合わせ
+  class En < Kuroneko
     # @return [String] 問い合わせフォームの URL
     URL = 'http://track.kuronekoyamato.co.jp/english/tracking'.freeze
 
-    class << self
-      # 英語版で初期化する
-      #
-      # @return [Kuroneko]
-      def new(option={})
-        obj = Kuroneko.new
-        obj.url = option[:url] || URL.dup
-        obj
-      end
+    # インスタンスを初期化する
+    #
+    # @param [Hash] options
+    # @see Kuroneko#initialize
+    def initialize(options={})
+      super
+      @url = URL.dup unless options[:url]
     end
   end
 end

data/lib/kuroneko/version.rb

@@ -1,4 +1,4 @@
 class Kuroneko
   # @return [String] バージョン
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kuroneko
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - wktk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-14 00:00:00.000000000 Z
+date: 2013-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize