kuroneko 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf2d1cc3857d488435e9c5efa8ce9b6523e848ad
+  data.tar.gz: 272673dc919d28a7577b4ef66b4b7cd320401c5c
+SHA512:
+  metadata.gz: 93cd11cea58a67c145aa1e415e5b9355d3ea6c262aa81f058ad09d9e302121838ec7114f348128119d3cdbed7c36192aa686115e2238e3ff437aec3c38f8121a
+  data.tar.gz: 35bdec0ab36607c3eaa837d73ece53cd1b561837be441b003d6d543c68d991e3ef4ab362f4e3c1d5e29293dbe9443055ebc37287d4a88456c02b7e5a6288f271

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kuroneko.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 wktk
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# Kuroneko
+
+クロネコヤマトの荷物追跡を照会する
+
+See also: http://toi.kuronekoyamato.co.jp/cgi-bin/tneko
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kuroneko'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kuroneko
+
+## Usage
+
+``` ruby
+require "kuroneko"
+
+neko = Kuroneko.new
+
+# 1 つの荷物の状態履歴
+history = neko.history("1234-5678-9012")
+
+# 複数の荷物の状態履歴
+histories = neko.histories("1234-5678-9012", "1234-5678-9013", ... )
+
+# 1 つの荷物の最新状態
+status = neko.status("1234-5678-9012")
+  # OR
+  status = history.latest
+  status = history.find(&:latest?)
+
+# 複数の荷物の最新状態
+statuses = neko.statuses("1234-5678-9012", "1234-5678-9013", ... )
+
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/kuroneko.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kuroneko/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kuroneko"
+  spec.version       = Kuroneko::VERSION
+  spec.authors       = ["wktk"]
+  spec.email         = ["mail@wktk.jp"]
+  spec.description   = %q{クロネコヤマトの荷物追跡を照会する}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/wktk/kuroneko"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mechanize", "~> 2.7"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/kuroneko/status.rb

@@ -0,0 +1,65 @@
+# -*- encoding: utf-8 -*-
+
+class Kuroneko
+  # 状態情報
+  Status = Struct.new(:number, :status, :date, :time, :branch, :branch_code)
+
+  class Status
+    # @!attribute number
+    #   @return [String] 伝票番号
+    #   @example
+    #     "123456789012"
+    #   @note 数字以外 (ハイフン等) は含まない
+
+    # @!attribute status
+    #   @return [String] 状態名
+    #   @example
+    #     "配達完了"
+
+    # @!attribute date
+    #   @return [String] 状態発生日
+    #   @example
+    #     "12/31"
+
+    # @!attribute time
+    #   @return [String] 状態発生時刻
+    #   @example
+    #     "12:59"
+
+    # @!attribute branch
+    #   @return [String] 担当店
+    #   @example
+    #     "北東京ベース店"
+
+    # @!attribute branch_code
+    #   @return [String] 担当店コード
+    #   @example
+    #     "030990"
+
+    # @param [String] number 伝票番号
+    # @param [Nokogiri::XML::Element] status 状態情報のテーブル行
+    # @param [Boolean] latest 最新の状態であるか
+    def initialize(number, status, latest=nil)
+      super(number, *parse(status))
+      @latest = latest unless latest.nil?
+    end
+
+    # @return [Boolean] 最新の状態であるか
+    def latest?
+      @latest
+    end
+
+  private
+
+    # 状態を解析する
+    #
+    # @param [Nokogiri::XML::Element] status 状態情報のテーブル行
+    # @return [Array<String>] 状態
+    def parse(status)
+      return status unless status.is_a?(Nokogiri::XML::Element)
+      attrs = status.css('td').to_a
+      @latest = attrs.shift.css('img').attribute('alt').value == '最新'
+      attrs.map! { |elem| elem.text.encode('utf-8') }
+    end
+  end
+end

data/lib/kuroneko/status_history.rb

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+class Kuroneko
+  # 状態履歴
+  class StatusHistory < Array
+    # @return [String] 伝票番号
+    # @note 数字以外 (ハイフン等) は含まない
+    attr_reader :number
+
+    # @param [String] number 伝票番号
+    # @param [Nokogiri::XML::Element] table 状態履歴テーブル
+    def initialize(number, table)
+      @number = number
+      super(parse(table))
+    end
+
+    # @return [Kuroneko::Status] 履歴のうち最新の状態
+    def latest
+      find(&:latest?) || last
+    end
+
+  private
+
+    # 状態履歴テーブルを解析する
+    #
+    # @param [Nokogiri::XML::Element] table 状態履歴テーブル
+    # @return [Array<Kuroneko::Status>] 状態
+    def parse(table)
+      return table unless table.is_a?(Nokogiri::XML::Element)
+      statuses = table.css('tr').to_a
+      statuses.shift
+      statuses.map! { |status| Status.new(number, status) }
+    end
+  end
+end

data/lib/kuroneko/version.rb

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

data/lib/kuroneko.rb

@@ -0,0 +1,110 @@
+# -*- encoding: utf-8 -*-
+
+require 'mechanize'
+require 'kuroneko/status'
+require 'kuroneko/status_history'
+require 'kuroneko/version'
+
+# クロネコヤマトの荷物を追跡する
+#
+# @see http://toi.kuronekoyamato.co.jp/cgi-bin/tneko
+class Kuroneko
+  # @return [Mechanize] 使用する Mechanize インスタンス
+  attr_accessor :agent
+
+  # @return [String] 問い合わせフォームの URL
+  attr_accessor :url
+
+  # インスタンスを初期化する
+  #
+  # @param [Hash] options
+  # @option options [Mechanize] :agent 使用する Mechanize インスタンス
+  # @option options [String] :url 問い合わせフォームの URL
+  def initialize(options={})
+    @agent = options[:agent] || Mechanize.new
+    @url = options[:url] || 'http://toi.kuronekoyamato.co.jp/cgi-bin/tneko'
+  end
+
+  # 1 つの荷物の状態履歴を照会する
+  #
+  # @param [String, #to_s] number 伝票番号
+  # @return [Kuroneko::StatusHistory<Kuroneko::Status>] 状態履歴
+  def history(number)
+    histories(number).first
+  end
+
+  # 複数の荷物の状態履歴を照会する
+  #
+  # @param [Array<String, #to_s>] numbers 伝票番号
+  # @return [Array<Kuroneko::StatusHistory<Kuroneko::Status>>] 状態履歴
+  def histories(*numbers)
+    numbers.flatten!
+    results = []
+    results.concat(query(numbers.shift(10))) until numbers.empty?
+    results
+  end
+
+  # 1 つの荷物の最新状態を照会する
+  #
+  # @param [String, #to_s] number 伝票番号
+  # @return [Kuroneko::Status] 最新状態
+  def status(number)
+    history(number).latest
+  end
+
+  # 複数の荷物の最新状態を取得する
+  #
+  # @param [Array<String, #to_s>] numbers 伝票番号
+  # @return [Array<Kuroneko::Status>] 最新状態
+  def statuses(*numbers)
+    histories(*numbers).map(&:latest)
+  end
+
+private
+
+  # ページをから情報を抽出する
+  #
+  # @param [Mechanize::Page] page 照会結果のページ
+  # @return [Array<Kuroneko::StatusHistory<Kuroneko::Status>>] 状態履歴
+  def parse(page)
+    page.parser.css('table.saisin').map do |summary|
+      rows = summary.css('tr')
+      number = rows[0].css('td')[2].text.gsub(/\D/, '')
+      status = rows[1].css('td')[2].text
+
+      history = summary.parent.css('table.meisai').first
+      history ||= [Status.new(number, [status], true)]  # 伝票番号誤りなど
+      StatusHistory.new(number, history)
+    end
+  end
+
+  # フォームパラメータをセットする
+  #
+  # @param [Mechanize::Form] form
+  # @param [Array<String, #to_s>] numbers 伝票番号
+  # @return [void]
+  def prepare_form(form, numbers)
+    numbers.each.with_index(1) do |number, index|
+      form["number%02d" % index] = number
+    end
+  end
+
+  # リクエストを送信して状態を抽出する
+  #
+  # @param [Array<String, #to_s>] numbers 伝票番号
+  # @return [Array<Kuroneko::StatusHistory<Kuroneko::Status>>] 状態履歴
+  def query(numbers)
+    result_page = request(numbers)
+    parse(result_page)
+  end
+
+  # 照会リクエストを送る
+  #
+  # @param [Array<String, #to_s>] numbers 伝票番号、1 度に 10 件まで
+  # @return [Mechanize::Page] 照会結果のページ
+  def request(numbers)
+    form = agent.get(url).form
+    prepare_form(form, numbers)
+    form.submit
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: kuroneko
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- wktk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "クロネコヤマトの荷物追跡を照会する"
+email:
+- mail@wktk.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kuroneko.gemspec
+- lib/kuroneko.rb
+- lib/kuroneko/status.rb
+- lib/kuroneko/status_history.rb
+- lib/kuroneko/version.rb
+homepage: https://github.com/wktk/kuroneko
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: "クロネコヤマトの荷物追跡を照会する"
+test_files: []
+has_rdoc: