tokyo_metro 0.10.1

data/lib/tokyo_metro/api.rb

@@ -0,0 +1,163 @@
+# 東京メトロ オープンデータの API から提供される情報を扱うモジュール
+module TokyoMetro::Api
+
+  include ::TokyoMetro::Modules::Common::ConvertConstantToClassMethod
+
+  def self.station_train_time
+    ::TokyoMetro::Api::StationTrainTime
+  end
+
+  def self.list_of_constants
+    [ :station_facility , :passenger_survey , :station , :railway_line , :point , :fare , :station_timetable , :train_timetable ]
+  end
+
+  # 東京メトロ オープンデータに関する定数を定義するメソッド (2) - API から取得し保存したデータからインスタンスを作成し、定数とする
+  # @return [nil]
+  def self.set_constants( *configs_of_api_constants )
+    config_of_api_constants = set_config_of_api_constants( *configs_of_api_constants )
+
+    if config_of_api_constants.present?
+      list_of_constants.each do | symbol |
+        if config_of_api_constants[ symbol ]
+          set_constant( symbol )
+        end
+      end
+    end
+
+    return nil
+  end
+
+  def self.barrier_free_facilities
+    STATION_FACILITY.send( __method__ )
+  end
+
+  class << self
+
+    def method_missing( method_name , *args )
+      if costants_converted_by_method_missing.include?( method_name.singularize.upcase )
+        return const_get( method_name.singularize.upcase )
+      else
+        super( method_name , *args )
+      end
+    end
+
+    private
+
+    def set_constant( const_name_underscore )
+      const_name_base = const_name_underscore.to_s.underscore.downcase
+      const_name = const_name_base.upcase.intern
+      class_name = "::TokyoMetro::Api::#{ const_name_base.camelize }"
+      puts const_name.to_s.ljust(48) + class_name
+      const_set( const_name , eval( class_name ).generate_from_saved_json )
+    end
+
+    def set_config_of_api_constants( *configs_of_api_constants )
+      if configs_of_api_constants.blank? or configs_of_api_constants.all?( &:blank? )
+        ary_for_display = ::Array.new
+        ary_for_display << :none
+        list_of_constants.each do | constant |
+          ary_for_display << constant
+        end
+
+        numbers = numbers_of_constants( ary_for_display )
+
+        if numbers.include?(0)
+          return nil
+        end
+
+        h = ::Hash.new
+        numbers.each do | i |
+          h[ ary_for_display[i] ] = true
+        end
+
+        return h
+
+      elsif configs_of_api_constants.instance_of?( ::Array )
+        if configs_of_api_constants.length == 1 and configs_of_api_constants.first.instance_of?( ::Hash )
+          h = configs_of_api_constants.first
+          if h.keys.all? { | key | list_of_constants.include?( key ) }
+            return h
+          end
+
+        elsif configs_of_api_constants.all? { | item | ( item.instance_of?( ::String ) or item.instance_of?( ::Symbol ) ) and list_of_constants.include?( item ) }
+          h = ::Hash.new
+          configs_of_api_constants.each do | key |
+            h[ key.intern ] = true
+          end
+          return h
+        end
+      end
+
+      raise "Error: #{ configs_of_api_constants.to_s } is not valid."
+    end
+
+    def numbers_of_constants( ary_for_display )
+      puts "Set api constants"
+      puts "  - Please select constant number(s)."
+      puts "  - If you want to set multiple constants, please input the number of each constant and input a space between them."
+      puts ""
+
+      ary_for_display.each_with_index do | constant , i |
+        puts ( constant.to_s.ljust(24) + " : " + i.to_s.rjust(2) )
+        if i == 0
+          puts ""
+        end
+      end
+
+      puts ""
+
+      numbers = ::STDIN.gets.chomp
+      unless /\A\d+(?: \d+)*\Z/ === numbers
+        return numbers_of_constants( ary_for_display )
+      end
+
+      ary = numbers.split( / / ).map( &:to_i ).sort
+      if ary.include?(0) and ary.length > 1
+        puts "Do you want to set no constant? Multiple numbers are input."
+        numbers_of_constants( ary_for_display )
+      end
+
+      ary
+    end
+
+  end
+
+  # @!group 時刻表の列車の補足情報に関する定数の定義
+
+  # 東京メトロ オープンデータに関する定数を定義するメソッド (1) - 時刻表の列車の補足情報に関する定数
+  # @return [nil]
+  def self.set_constants_for_timetable
+    #---- 時刻表 到着ホーム
+    ::TokyoMetro::Api::StationTimetable::Info::TrainTime::Info::Note::ArriveAt::set_constants
+
+    #---- 時刻表 出発ホーム
+    ::TokyoMetro::Api::StationTimetable::Info::TrainTime::Info::Note::PlatformNumber::set_constant
+  end
+
+  def self.timetable_notes_of_arrival_at_asakusa
+    ::TokyoMetro::Api::StationTimetable::Info::TrainTime::Info::Note::ArriveAt::ASAKUSA
+  end
+
+  def self.timetable_notes_of_departure
+    ::TokyoMetro::Api::StationTimetable::Info::TrainTime::Info::Note::PlatformNumber::LIST
+  end
+
+  def self.get( http_client , id_urn , parse_json: false , generate_instance: false , to_inspect: false )
+    factory_for_getting.process( http_client , id_urn , parse_json , generate_instance , to_inspect )
+  end
+
+  def self.get_geo( http_client , id_urn , parse_json: false , generate_instance: false , to_inspect: false )
+    factory_for_getting_geo.process( http_client , id_urn , parse_json , generate_instance , to_inspect )
+  end
+
+  def self.factory_for_getting
+    ::TokyoMetro::Factory::Get::Api::DataSearch
+  end
+
+  def self.factory_for_getting_geo
+    ::TokyoMetro::Factory::Get::Api::Geo
+  end
+
+  # @!endgroup
+
+end

data/lib/tokyo_metro/api/fare.rb

@@ -0,0 +1,94 @@
+# 運賃 odpt:RailwayFare を扱うクラス
+# @see https://developer.tokyometroapp.jp/documents/railway#運賃-odpt:RailwayFare
+# @note 2駅間の運賃を表す。
+class TokyoMetro::Api::Fare < TokyoMetro::Api::MetaClass::NotRealTime
+
+  include ::TokyoMetro::ClassNameLibrary::Api::Fare
+  include ::TokyoMetro::ClassNameLibrary::Static::Fare
+
+  # @!group クラスメソッド - データの取得・保存
+
+  # 運賃の情報を取得するメソッド
+  # @param http_client [HTTPClient] HTTPClient のインスタンス【必須】
+  # @param id_urn [String] 固有識別子 (ucode) <id - URN>
+  # @param same_as [String] 固有識別子（命名ルールは、「odpt.RailwayFare:TokyoMetro.出発駅の路線名.出発駅名.TokyoMetro.到着駅の路線名.到着駅名」） <owl:sameAs - URL>
+  # @param operator [String] 運行会社 <odpt:operator - odpt:Operator>
+  # @param from_station [String] 駅間の始点駅 <odpt:fromStation - odpt:Station>
+  # @param to_station [String] 駅間の終点駅 <odpt:toStation - odpt:Station>
+  # @param ticket [Integer] 切符利用時の運賃 <odpt:ticketFare - xsd:integer>
+  # @param child_ticket [Integer] 切符利用時の子供運賃 <odpt:childTicketFare - xsd:integer>
+  # @param ic_card [Integer] ICカード利用時の運賃 <odpt:icCardFare - xsd:integer>
+  # @param child_ic_card [Integer] ICカード利用時の子供運賃 <odpt:childIcCardFare - xsd:integer>
+  # @param parse_json [Boolean] JSONを配列とするか否かの設定（false の場合は文字列とする）
+  # @param generate_instance [Boolean] データ取得後に Ruby のインスタンスを作成するか否かの設定
+  # @param to_inspect [Boolean] データ取得後にコマンドツールに内容を表示するか否かの設定
+  # @return [::Array]
+  def self.get( http_client ,
+    id_urn: nil , same_as: nil , operator: nil ,
+    from_station: nil , to_station: nil ,
+    ticket: nil , child_ticket: nil , ic_card: nil , child_ic_card: nil ,
+    parse_json: false , generate_instance: false , to_inspect: false )
+
+    factory_for_getting.process( http_client , id_urn , same_as , operator ,
+      from_station , to_station ,
+      ticket , child_ticket , ic_card , child_ic_card ,
+      parse_json , generate_instance , to_inspect )
+  end
+
+  # 運賃の情報を取得し保存するメソッド
+  # @param http_client [HTTPClient] HTTPClient のインスタンス【必須】
+  # @param file_type [Symbol] 保存するファイルの種類【必須】
+  # @param id_urn [String] 固有識別子 (ucode) <id - URN>
+  # @param same_as [String] 固有識別子（命名ルールは、「odpt.RailwayFare:TokyoMetro.出発駅の路線名.出発駅名.TokyoMetro.到着駅の路線名.到着駅名」） <owl:sameAs - URL>
+  # @param operator [String] 運行会社 <odpt:operator - odpt:Operator>
+  # @param from_station [String] 駅間の始点駅 <odpt:fromStation - odpt:Station>
+  # @param to_station [String] 駅間の終点駅 <odpt:toStation - odpt:Station>
+  # @param ticket [Integer] 切符利用時の運賃 <odpt:ticketFare - xsd:integer>
+  # @param child_ticket [Integer] 切符利用時の子供運賃 <odpt:childTicketFare - xsd:integer>
+  # @param ic_card [Integer] ICカード利用時の運賃 <odpt:icCardFare - xsd:integer>
+  # @param child_ic_card [Integer] ICカード利用時の子供運賃 <odpt:childIcCardFare - xsd:integer>
+  # @param to_inspect [Boolean] データ取得後にコマンドツールに内容を表示するか否かの設定
+  # @return [nil]
+  def self.save( http_client , filename , file_type: :yaml ,
+    id_urn: nil , same_as: nil , operator: nil ,
+    from_station: nil , to_station: nil ,
+    ticket: nil , child_ticket: nil , ic_card: nil , child_ic_card: nil ,
+    to_inspect: false )
+
+    data = get( http_client ,
+      id_urn: id_urn , same_as: same_as , operator: operator ,
+      from_station: from_station , to_station: to_station ,
+      ticket: ticket , child_ticket: child_ticket , ic_card: ic_card , child_ic_card: child_ic_card ,
+      parse_json: true , generate_instance: false , to_inspect: to_inspect )
+
+    data = eval( data.to_s.gsub( /(?:\r\n|\r)/ ,"\n" ).encode( "UTF-8" ) )
+
+    save_data( data , filename , file_type: file_type )
+  end
+
+  class << self
+    alias :generate_all_info_of_fare_from_json :generate_from_saved_json
+    alias :save_datas_of_fare :save_datas_of_each_group
+  end
+
+  # @!endgroup
+
+  # @!group テスト
+
+  # データ取得のテスト
+  # @return [nil]
+  def self.get_test( http_client , from )
+    puts "● Fare (from #{from})"
+    data = get( http_client ,
+      from_station: from , to_station: nil ,
+      # id_urn: nil , same_as: nil , operator: nil ,
+      # ticket: "240" ,
+      # child_ticket: nil , ic_card: nil , child_ic_card: nil ,
+      to_inspect: true , parse_json: true , generate_instance: true )
+
+    puts data.sort_by_fare.to_strf
+  end
+
+  # @!endgroup
+
+end

data/lib/tokyo_metro/api/fare/info.rb

@@ -0,0 +1,200 @@
+# 2駅間の運賃を扱うクラス
+class TokyoMetro::Api::Fare::Info < TokyoMetro::Api::MetaClass::NotRealTime::Info
+
+  include ::TokyoMetro::ClassNameLibrary::Api::Fare
+  include ::TokyoMetro::ClassNameLibrary::Static::Fare
+  include ::TokyoMetro::Modules::Common::ToFactory::Seed::Info
+
+  # Constructor
+  def initialize( id_urn , same_as , dc_date , operator , from_station , to_station , normal_fare )
+    @id_urn = id_urn
+    @same_as = same_as
+    @dc_date = dc_date
+    @operator = operator
+    @from_station = from_station
+    @to_station = to_station
+    @normal_fare = normal_fare
+  end
+
+  def self.attr_names
+    [ :id_urn , :same_as , :dc_date , :operator , :from_station , :to_station , :normal_fare ]
+  end
+
+  # 固有識別子
+  # @return [String]
+  # @note 命名ルールは「odpt.RailwayFare:TokyoMetro.出発駅の路線名.出発駅名.TokyoMetro.到着駅の路線名.到着駅名」
+  attr_reader :same_as
+
+  # データ生成日時（ISO8601 日付時刻形式）
+  # @return [String]
+  attr_reader :dc_date
+
+  # 運行会社
+  # @return [String]
+  attr_reader :operator
+
+  # 駅間の始点駅
+  # @return [String]
+  attr_reader :from_station
+
+  # 駅間の終点駅
+  # @return [String]
+  attr_reader :to_station
+
+  # 運賃の情報を扱うインスタンス
+  # @return [::TokyoMetro::Static::Fare::Normal::Pattern]
+  attr_reader :normal_fare
+
+  # @param stations [String, Regexp , Array<String or Regexp>]
+  def from?( *stations )
+    stations.flatten.any? { | station | station === @from_station }
+  end
+
+  # @param stations [String, Regexp , Array<String or Regexp>]
+  def to?( *stations )
+    stations.flatten.any? { | station | station === @to_station }
+  end
+
+  def from_or_to?( *stations )
+    from?( *stations ) or to?( *stations )
+  end
+
+  alias :to :to_station
+  alias :from :from_station
+
+  alias :to_sta :to_station
+  alias :from_sta :from_station
+
+  alias :is_from? :from?
+  alias :is_to? :to?
+  alias :is_from_or_to? :from_or_to?
+
+  # @!group 運賃の情報を取得するメソッド
+
+  # インスタンスの情報をハッシュにして返すメソッド
+  # @return [Hash]
+  def to_h
+    h = Hash.new
+
+    set_data_to_hash( h , "\@id" , @id_urn )
+    set_data_to_hash( h , "owl:sameAs" , @same_as )
+    set_data_to_hash( h , "dc:date" , @dc_date.to_s )
+    set_data_to_hash( h , "odpt:operator" , @operator )
+    set_data_to_hash( h , "odpt:fromStation" , @from_station )
+    set_data_to_hash( h , "odpt:toStation" , @to_station )
+
+    set_data_to_hash( h , "odpt:ticketFare" , self.ticket_fare )
+    set_data_to_hash( h , "odpt:childTicketFare" , self.child_ticket_fare )
+    set_data_to_hash( h , "odpt:icCardFare" , self.ic_card_fare )
+    set_data_to_hash( h , "odpt:childIcCardFare" , self.child_ic_card_fare )
+
+    h
+  end
+
+  # インスタンスの情報を文字列にして返すメソッド
+  # @param indent [Integer (>0)] インデントの幅
+  # @return [String]
+  def to_s ( indent = 0 )
+    h = self.to_h
+    hash_keys_ary_1 = [ "\@id" , "owl:sameAs" , "dc:date" ]
+    hash_keys_ary_2 = [ "odpt:operator" , "odpt:fromStation" , "odpt:toStation" ]
+    hash_keys_ary_3 = [ "odpt:ticketFare" , "odpt:childTicketFare" , "odpt:icCardFare" , "odpt:childIcCardFare" ]
+
+    str_ary = ::Array.new
+    str_ary << " " * indent + "#{@from_station} - #{@to_station}"
+    str_ary << ""
+
+    [ hash_keys_ary_1 , hash_keys_ary_2 ].each do | hash_keys_ary |
+      hash_keys_ary.each do | key |
+        if h[ key ].present?
+          str_ary << ( " " * ( indent + 2 ) + key.ljust(32) + h[ key ].to_strf )
+        end
+      end
+      str_ary << ""
+    end
+
+    str_ary << @normal_fare.to_s_table( indent + 2 )
+    str_ary.join( "\n" )
+  end
+
+  alias :to_strf :to_s
+
+  # @!group 具体的な運賃を取得するメソッド (1) - 普通運賃
+
+  # 普通運賃（大人・切符）
+  # @return [Integer]
+  def ticket_fare
+    @normal_fare.ticket_fare
+  end
+
+  # 普通運賃（小児・切符）
+  # @return [Integer]
+  def child_ticket_fare
+    @normal_fare.child_ticket_fare
+  end
+
+  # 普通運賃（大人・ICカード）
+  # @return [Integer]
+  def ic_card_fare
+    @normal_fare.ic_card_fare
+  end
+
+  # 普通運賃（小児・ICカード）
+  # @return [Integer]
+  def child_ic_card_fare
+    @normal_fare.child_ic_card_fare
+  end
+
+  # @!group 具体的な運賃を取得するメソッド (2) - 回数券
+
+  # 回数券（大人）の発売額
+  # @return [Integer]
+  def coupon_ticket_fare
+    @normal_fare.coupon_ticket_fare
+  end
+
+  # 回数券（小児）の発売額
+  # @return [Integer]
+  def child_coupon_ticket_fare
+    @normal_fare.child_coupon_ticket_fare
+  end
+
+  # 普通回数券（大人・11枚つづり）の1枚あたりの発売額
+  # @return [Integer]
+  def normal_coupon_ticket_per_one_piece
+    @normal_fare.normal_coupon_ticket_per_one_piece
+  end
+
+  # 時差回数券（大人・12枚つづり）の1枚あたりの発売額
+  # @return [Integer]
+  def daytime_coupon_ticket_per_one_piece
+    @normal_fare.daytime_coupon_ticket_per_one_piece
+  end
+
+  # 土休回数券（大人・14枚つづり）の1枚あたりの発売額
+  # @return [Integer]
+  def holiday_coupon_ticket_per_one_piece
+    @normal_fare.holiday_coupon_ticket_per_one_piece
+  end
+
+  # 普通回数券（小児・11枚つづり）の1枚あたりの発売額
+  # @return [Integer]
+  def child_normal_coupon_ticket_per_one_piece
+    @normal_fare.child_normal_coupon_ticket_per_one_piece
+  end
+
+  # 時差回数券（小児・12枚つづり）の1枚あたりの発売額
+  # @return [Integer]
+  def child_daytime_coupon_ticket_per_one_piece
+    @normal_fare.child_daytime_coupon_ticket_per_one_piece
+  end
+
+  # 土休回数券（小児・14枚つづり）の1枚あたりの発売額
+  # @return [Integer]
+  def child_holiday_coupon_ticket_per_one_piece
+    @normal_fare.child_holiday_coupon_ticket_per_one_piece
+  end
+
+  # @!endgroup
+
+end