ekispert 0.0.1

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ekispert-sdk-ruby.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ekispert/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ekispert'
+  spec.version       = Ekispert::VERSION
+  spec.authors       = ['Ekispert Web Service']
+
+  spec.summary       = 'Ekispert API Client'
+  spec.description   = 'wrapper for the Ekispert API'
+  spec.homepage      = 'https://github.com/EkispertWebService/ekispert-sdk-ruby/'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', ['>= 0.7.4', '< 1.0']
+  spec.add_dependency 'faraday_middleware', '~> 0.12.2'
+  spec.add_dependency 'nokogiri', '~> 1.8.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.59.0'
+end

data/example/point_station.rb

@@ -0,0 +1,20 @@
+require 'ekispert'
+
+station_list = Ekispert::Point::Station.get(code:'22828', addGateGroup: true)
+station = station_list[0]
+puts "Station: #{station.name}"
+puts "Latitude: #{station.geo_point.lati_d}"
+puts "Longitude: #{station.geo_point.longi_d}"
+station.gate_group_list.each do |gate_group|
+  gate_group.gate_list.each do |gate|
+    puts "Gate: #{gate.name}"
+  end
+end
+
+# Station: 東京
+# Latitude: 35.678083
+# Longitude: 139.770444
+# Gate: 京葉線1(北側)
+# Gate: 京葉線1(南側)
+# Gate: 京葉線2
+# ... and more

data/example/search_course.rb

@@ -0,0 +1,116 @@
+require 'ekispert'
+
+# Train Station
+course_list = Ekispert::Course.get(viaList: '22828:22741', answerCount: 2, addStop: true)
+
+# Local Bus
+# course_list = Ekispert::Course.get(viaList: '51003:51487', answerCount: 2, addStop: true)
+
+course_list.each.with_index(1) do |course, i|
+  price_list = course.price_list
+  route = course.route
+  point_list = route.point_list
+  line_list = route.line_list
+
+  puts "======= Summary #{i} ======="
+  puts "合計所要時間: #{route.total_required_time}分"
+  puts "乗り換え回数: #{route.transfer_count}回"
+  puts "合計金額: #{course.oneway_price}円"
+  puts "出発時刻: #{route.departure_time.strftime("%H:%M")}"
+  puts "到着時刻: #{route.arrival_time.strftime("%H:%M")}"
+  puts "--- 定期代 ---"
+  puts "1ヶ月: #{course.teiki1.oneway}円"
+  puts "3ヶ月: #{course.teiki3.oneway}円"
+  puts "6ヶ月: #{course.teiki6.oneway}円"
+  puts "========================="
+
+  line_list.each_with_index do |line, j|
+    puts "#{line.departure_state.datetime.strftime('%H:%M')} #{point_list[j].station.name}"
+    if line.line_symbol
+      puts " | [#{line.line_symbol.name}] #{line.name} #{line.fare.oneway}円"
+    else
+      puts " | #{line.name}"
+    end
+  end
+  puts "#{line_list[-1].arrival_state.datetime.strftime('%H:%M')} #{point_list[-1].station.name}"
+  print "\n"
+
+  puts "--- 停車駅一覧 ---"
+
+  line_list.each_with_index do |line, s|
+    next if ['walk', 'strange'].include?(line.type)
+    puts "■ #{line.name}\n"
+    line.stop_list[0...-1].each do |stop|
+      puts "#{stop.departure_state.datetime.strftime('%H:%M')} #{stop.point.station.name}"
+      puts " |"
+    end
+    puts "#{line.stop_list[-1].departure_state.datetime.strftime('%H:%M')} #{line.stop_list[-1].point.station.name}"
+    print "\n"
+  end
+end
+
+# ======= Summary 1 =======
+# 合計所要時間: 14分
+# 乗り換え回数: 0回
+# 合計金額: 200円
+# 出発時刻: 12:00
+# 到着時刻: 12:14
+# --- 定期代 ---
+# 1ヶ月: 5820円
+# 3ヶ月: 16580円
+# 6ヶ月: 27920円
+# =========================
+# 12:00 東京
+#  | [JC] ＪＲ中央・青梅線快速・青梅行 200円
+# 12:14 新宿
+#
+# --- 停車駅一覧 ---
+# ■ ＪＲ中央・青梅線快速・青梅行
+# 12:00 東京
+#  |
+# 12:02 神田(東京都)
+#  |
+# 12:04 御茶ノ水
+#  |
+# 12:09 四ツ谷
+#  |
+# 12:14 新宿
+#
+# ======= Summary 2 =======
+# 合計所要時間: 22分
+# 乗り換え回数: 0回
+# 合計金額: 200円
+# 出発時刻: 12:09
+# 到着時刻: 12:31
+# --- 定期代 ---
+# 1ヶ月: 7320円
+# 3ヶ月: 20870円
+# 6ヶ月: 39530円
+# =========================
+# 12:00 東京
+#  | [M] 東京メトロ丸ノ内線・荻窪行 200円
+# 12:20 新宿(東京メトロ)
+#  | 徒歩
+# 12:22 新宿
+#
+# --- 停車駅一覧 ---
+# ■ 東京メトロ丸ノ内線・荻窪行
+# 12:00 東京
+#  |
+# 12:02 銀座
+#  |
+# 12:04 霞ケ関(東京都)
+#  |
+# 12:06 国会議事堂前
+#  |
+# 12:09 赤坂見附
+#  |
+# 12:11 四ツ谷
+#  |
+# 12:14 四谷三丁目
+#  |
+# 12:15 新宿御苑前
+#  |
+# 12:17 新宿三丁目
+#  |
+# 12:20 新宿(東京メトロ)

data/lib/ekispert.rb

@@ -0,0 +1,43 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'nokogiri'
+require 'yaml'
+require 'date'
+
+require 'ekispert/util'
+require 'ekispert/ekispert_base'
+require 'ekispert/version'
+require 'ekispert/config'
+require 'ekispert/client'
+require 'ekispert/data_version'
+require 'ekispert/information'
+require 'ekispert/information/line'
+require 'ekispert/information/corporation'
+require 'ekispert/information/exit'
+require 'ekispert/information/welfare_facilities'
+require 'ekispert/error'
+require 'ekispert/point'
+require 'ekispert/point/station'
+require 'ekispert/point/station/gate_group'
+require 'ekispert/point/station/gate_group/gate'
+require 'ekispert/point/prefecture'
+require 'ekispert/course'
+require 'ekispert/course/route'
+require 'ekispert/course/route/line'
+require 'ekispert/course/route/line/arrival_state'
+require 'ekispert/course/route/line/arrival_state/gate'
+require 'ekispert/course/route/line/departure_state'
+require 'ekispert/course/route/line/departure_state/gate'
+require 'ekispert/course/route/line/corporation'
+require 'ekispert/course/route/line/line_symbol'
+require 'ekispert/course/route/line/stop'
+require 'ekispert/course/route/line/stop/arrival_state'
+require 'ekispert/course/route/line/stop/departure_state'
+require 'ekispert/course/route/line/stop/point'
+require 'ekispert/course/route/line/stop/point/prefecture'
+require 'ekispert/course/route/line/stop/point/station'
+require 'ekispert/course/route/point'
+require 'ekispert/course/route/point/station'
+require 'ekispert/course/route/point/prefecture'
+require 'ekispert/course/price'
+require 'ekispert/course/pass_status'

data/lib/ekispert/client.rb

@@ -0,0 +1,58 @@
+module Ekispert
+  class Client
+    def self.get(path, params=nil)
+      set_connection if @connection.nil? || connection_options_update?
+      res = @connection.get(path, params)
+      return parse_xml(res.body) if res.status == 200
+
+      raise_error(res)
+    end
+
+    def self.connection_options
+      {
+        url: "#{Config.host}/#{Config.version}/xml",
+        proxy: Config.http_proxy,
+        headers: { 'Content-Type' => 'application/xml;charset=utf-8' },
+        params: { key: Ekispert::Config.api_key },
+        request: { timeout: 5, open_timeout: 2 }
+      }
+    end
+
+    def self.set_connection
+      @connection_options = connection_options
+      @connection = Faraday.new(@connection_options) do |c|
+        c.adapter Faraday.default_adapter
+      end
+    end
+
+    # Below are private class methods
+
+    def self.connection_options_update?
+      @connection_options != connection_options
+    end
+
+    def self.parse_xml(xml)
+      Nokogiri::XML.parse(xml).xpath('//ResultSet')
+    end
+
+    def self.raise_error(res)
+      case res.status
+      when 1
+        raise Error::InternalError, 'Engine Error'
+      when 400
+        raise Error::BadRequest, res
+      when 403
+        raise Error::Forbidden, res
+      when 404
+        raise Error::NotFound, res
+      when 400..499
+        raise Error::ClientError, res
+      when 500..599
+        raise Error::ServerError, 'OMG!'
+      end
+    end
+
+    private_class_method :connection_options_update?
+    private_class_method :parse_xml, :raise_error
+  end
+end

data/lib/ekispert/config.rb

@@ -0,0 +1,30 @@
+module Ekispert
+  class Config
+    DEFAULTS = {
+      host: 'https://api.ekispert.jp',
+      version: 'v1',
+      http_proxy: ENV['HTTP_PROXY'],
+      api_key: ENV['EKISPERT_API_KEY']
+    }.freeze
+    DEFAULTS.each do |option, value|
+      class_eval <<-EOS, __FILE__, __LINE__ + 1
+        class << self
+          attr_accessor :#{option}
+        end
+      EOS
+      instance_variable_set("@#{option}", value)
+    end
+
+    def self.list
+      options = {}
+      self.instance_variables.each do |name|
+        options[name] = instance_variable_get(name)
+      end
+      options
+    end
+
+    def self.set
+      yield self
+    end
+  end
+end

data/lib/ekispert/course.rb

@@ -0,0 +1,124 @@
+module Ekispert
+  class Course < EkispertBase
+    attr_accessor :route_list, :price_list, :pass_status_list, :serialize_data_list
+    attr_accessor :fare, :charge, :teiki1, :teiki3, :teiki6, :teiki12
+
+    def initialize(element)
+      @route_list = []
+      @price_list = []
+      @pass_status_list = []
+      @serialize_data_list = []
+      super(element)
+      define_summary_method
+      relate_line_to_price
+      relate_price_to_line
+      relate_price_and_pass_status
+    end
+
+    def route
+      @route_list[0]
+    end
+
+    def serialize_data
+      @serialize_data_list[0].text
+    end
+
+    def oneway_price
+      fare.oneway + charge.oneway
+    end
+
+    def round_price
+      fare.round + charge.round
+    end
+
+    def self.get(params={})
+      to_course(Ekispert::Client.get('search/course/extreme', params))
+    end
+
+    def self.to_course(elem_arr)
+      elem_arr.xpath('//Course').map { |course_elem| self.new(course_elem) }
+    end
+
+    class SerializeData < EkispertBase; end
+
+    private_class_method :to_course
+
+    private
+
+    # This method define summary methods.
+    # If nothing 'HogeSummary' elements, create and set empty Course::Price instance.
+    # result:
+    #   Course#fare
+    #   Course#charge
+    #   Course#teiki1 ...
+    def define_summary_method
+      %w[fare charge teiki1 teiki3 teiki6 teiki12].each do |summary_type|
+        self.define_singleton_method(summary_type) { price_summary(summary_type) }
+      end
+    end
+
+    def price_summary(type)
+      @price_list.find { |price| price.kind == "#{type.capitalize}Summary" } || Ekispert::Course::Price.new
+    end
+
+    # This method relate Course::Route::Line instance to Course::Price instance.
+    # If even without those associated with Line, return Price instance.
+    # Ex.
+    #  Course::Route::Line#fare
+    #  Course::Route::Line#charge
+    #  Course::Route::Line#teiki1 etc...
+    def relate_line_to_price
+      @route_list[0].line_list.each do |line|
+        line.fare = find_price(line, :fare)
+        line.charge = find_price(line, :charge)
+        line.teiki1 = find_price(line, :teiki1)
+        line.teiki3 = find_price(line, :teiki3)
+        line.teiki6 = find_price(line, :teiki6)
+        line.teiki12 = find_price(line, :teiki12)
+      end
+    end
+
+    def find_price(line, price_type)
+      index_type = "#{price_type}_index"
+      return Ekispert::Course::Price.new unless line.respond_to?(index_type)
+
+      kind = price_type.to_s.capitalize
+      @price_list.find { |price| price.kind == kind && price.index == line.send(index_type) }
+    end
+
+    # This method relate Course::Price instance to Course::Route::Line instance.
+    # It's judged based on to Price#from_line_index and Price#from_line_index.
+    # result:
+    #   Course::Price#line_list
+    def relate_price_to_line
+      @price_list.each do |price|
+        next unless price.respond_to?(:from_line_index)
+
+        price_range = (price.from_line_index.to_i..price.to_line_index.to_i)
+        price.line_list = @route_list[0].line_list.select { |line| price_range.include?(line.index.to_i) }
+      end
+    end
+
+    # This method relate Course::Price instance and Course::PassStatus instance.
+    # It's judged based on to Price#pass_class_index.
+    # result:
+    #   Course::Price#pass_status
+    def relate_price_and_pass_status
+      price_list.each do |price|
+        next unless price.kind.match?(/^Teiki\d{1}$/)
+
+        pass_status = find_pass_status(price)
+        # Price to PassStatus
+        price.pass_status = pass_status
+        # PassStatus to Price
+        pass_status.price_list << price
+      end
+    end
+
+    def find_pass_status(price)
+      return Ekispert::Course::PassStatus.new unless price.respond_to?(:pass_class_index)
+
+      @pass_status_list.find { |status| status.index == price.pass_class_index }
+    end
+  end
+end

data/lib/ekispert/course/pass_status.rb

@@ -0,0 +1,34 @@
+module Ekispert
+  class Course < EkispertBase
+    class PassStatus < EkispertBase
+      attr_accessor :comment_list, :name_list, :type_list
+      attr_accessor :price_list
+
+      def initialize(element=nil)
+        @comment_list = []
+        @name_list = []
+        @type_list = []
+        @price_list = [] # Use Course#relate_price_and_pass_status
+        return if element.nil?
+
+        super(element)
+      end
+
+      def comment
+        @comment_list[0]&.text
+      end
+
+      def name
+        @name_list[0]&.text
+      end
+
+      def type
+        @type_list[0]&.text
+      end
+
+      class Comment < EkispertBase; end
+      class Name < EkispertBase; end
+      class Type < EkispertBase; end
+    end
+  end
+end