fop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fcf19e8fcf71e09014e4401f353d50e7598f174e44f70ae6954938d0baaf23d0
+  data.tar.gz: 427ea3b525cfb67a95b7b7aeba49afdb2d233c8fce121be6fb3a668188979166
+SHA512:
+  metadata.gz: 191c6a6288663a77c93514dd3f03ecdc632769251824473d47e93bb8c7085017d367f75ece4a3cba572ec7ba327d80d8a4a318f3ce6231c6a1333009892f03b3
+  data.tar.gz: a68c2b3698ac4913fa6cedc89557fe0f2db6af66b6e590e0b991c807b6b0c3c8eca2030b3c9fcd55bd104c2052531aa846d743d8611a160e9b8c3a5267593b3c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fop.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    fop (0.1.0)
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    rake (12.3.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  fop!
+  rake
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Sorah Fukumori
+
+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,68 @@
+# Fop: Scraping client for Japan Airlines FOP/Mileage calculator
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fop'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fop
+
+## Usage
+
+```
+fop = Fop::Client.new
+
+p fop.valid_cards
+p fop.valid_statuses
+
+##
+
+p fop.valid_intl_airports_for_earning #=> Array<Airport>
+p fop.valid_intl_fares #=> Array<Fare>
+
+p fop.intl_search(
+  from: 'TYO', # or Airport object
+  to: 'SFO', # or Airport object
+  fare: :first, # or Fare object
+  card: :global, # or CardType object
+  status: :sapphire, # or Status object
+)
+
+##
+
+p fop.valid_dom_airports #=> Array<Airport>
+p fop.valid_dom_classes #=> Array<SeatClass>
+p fop.valid_dom_fares #=> Array<Fare>
+
+p fop.intl_search(
+  from: 'TYO', # or Airport object
+  to: 'SFO', # or Airport object
+  class: 'J', # or SeatClass object
+  fare: :discount_other, # or Fare object
+  card: :global, # or CardType object
+  status: :sapphire, # or Status object
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sorah/fop.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fop"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/fop.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fop/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fop"
+  spec.version       = Fop::VERSION
+  spec.authors       = ["Sorah Fukumori"]
+  spec.email         = ["her@sorah.jp"]
+
+  spec.summary       = %q{scraping client of Japan Airlines FOP/Mileage calculator}
+  spec.homepage      = "https://github.com/sorah/fop"
+  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 "nokogiri"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/fop.rb

@@ -0,0 +1,6 @@
+require "fop/version"
+require "fop/client"
+
+module Fop
+  # Your code goes here...
+end

data/lib/fop/client.rb

@@ -0,0 +1,208 @@
+require 'json'
+require 'nokogiri'
+require 'uri'
+require 'open-uri'
+require 'net/http'
+require 'net/https'
+
+module Fop
+  module StringIntoCode
+    def to_s
+      code
+    end
+  end
+
+  Airport = Struct.new(:code, :area, :name)
+  Status = Struct.new(:code, :name)
+  CardType = Struct.new(:code, :name)
+  Fare = Struct.new(:code, :name, :remark)
+  SeatClass = Struct.new(:code, :name)
+
+  [Airport, Status, CardType, Fare, SeatClass].each do |k|
+    k.class_eval do
+      include StringIntoCode
+    end
+  end
+
+  Result = Struct.new(:miles, :fop, :flight_miles, :flight_miles_remark, :standard_flight_miles, :bonus_miles, :bonus_miles_remark, :fop_rate, :fop_bonus, :fop_bonus_remark)
+
+  class Error < StandardError; end
+  class DataParseError < Error; end
+  class InvalidAirport < Error; end
+  class ConditionError < Error; end
+
+  ENDPOINT_URI = URI("https://www.jal.co.jp/cgi-bin/jal/milesearch/save/flt_mile_save.cgi")
+  DATA_JS_URI = URI("https://www.jal.co.jp/jmb/milesearch/js/mile_search_jp.js")
+
+  class Client
+    def initialize()
+    end
+
+    def dom_search(from:, to:, class:, fare:, card: '-', status: '-')
+      klass = binding.local_variable_get(:class)
+
+      unless valid_dom_airports.any?{ |_| _.code == from.to_s }
+        raise InvalidAirport, "#{from.inspect} is invalid airport"
+      end
+      unless valid_dom_airports.any?{ |_| _.code == to.to_s }
+        raise InvalidAirport, "#{to.inspect} is invalid airport"
+      end
+
+      page = post_form(
+        cmd: 'do_search',
+        TYPE: 'D',
+        external: '',
+        CityFrom: from.to_s,
+        CityTo: to.to_s,
+        F_CLASS: klass.to_s,
+        F_JAL_CARD: card.to_s,
+        F_JAL_CARD_STATUS: status.to_s,
+        F_FARE: fare.to_s,
+      )
+      parse_result(page.at('#contentDom'))
+    end
+
+    def intl_search(from:, to:, fare:, card: '-', status: '-')
+      from_airport = valid_intl_airports_for_earning.find{ |_| _.code == from.to_s }
+      to_airport = valid_intl_airports_for_earning.find{ |_| _.code == to.to_s }
+      unless from_airport
+        raise InvalidAirport, "#{from.inspect} is invalid airport"
+      end
+      unless to_airport
+        raise InvalidAirport, "#{to.inspect} is invalid airport"
+      end
+
+      page = post_form(
+        cmd: 'do_search',
+        TYPE: 'I',
+        external: '',
+        AreaFrom: from_airport.area,
+        AreaTo: to_airport.area,
+        CityFrom: from_airport.code,
+        CityTo: to_airport.code,
+        F_JAL_CARD: card.to_s,
+        F_JAL_CARD_STATUS: status.to_s,
+        F_FARE: fare.to_s,
+      )
+      parse_result(page.at('#contentInt'))
+    end
+
+    def parse_result(page)
+      if page.inner_text.include?("ご入力いただいた条件では検索できませんでした")
+        raise ConditionError, "Calculation not available for given query"
+      end
+
+      miles, fop = page.search('.milecount').map{ |_| _.inner_text.strip.gsub(/,/, '').to_i }
+      standard_flight_miles = page.search('.milecount')[0].parent.children[1].inner_text.gsub(/[^\d]+/,'').to_i
+
+      miles_breakdown, fop_breakdown = page.search('.Flightmilebns').map do |elem|
+        elem.search('.FlightmilebnsItem').reject{ |_| _['class'].include?('Mark') }
+      end
+
+      flight_miles_elem = miles_breakdown[0]
+      flight_miles = flight_miles_elem.at('.FlightmilebnsNum').inner_text.strip.gsub(/,/, '').to_i
+      flight_miles_remark = flight_miles_elem.at('.FlightmilebnsTitle').inner_text.gsub(/\s+|\r?\n/, ' ')
+
+      bonus_miles_elem = miles_breakdown[1]
+      if bonus_miles_elem
+        bonus_miles = bonus_miles_elem.at('.FlightmilebnsNum').inner_text.strip.gsub(/,/, '').to_i
+        bonus_miles_remark = bonus_miles_elem.at('.FlightmilebnsTitle').inner_text.gsub(/\s+|\r?\n/, ' ')
+      end
+
+      fop_rate_elem = fop_breakdown[1]
+      fop_rate = fop_rate_elem.at('.FlightmilebnsNum').inner_text.strip.gsub(/,/, '').to_f
+
+      fop_bonus_elem = fop_breakdown[2]
+      if fop_bonus_elem
+        fop_bonus = fop_bonus_elem.at('.FlightmilebnsNum').inner_text.strip.gsub(/,/, '').to_i
+        fop_bonus_remark = fop_bonus_elem.at('.FlightmilebnsTitle').inner_text.gsub(/\s+|\r?\n/, ' ')
+      end
+
+      Result.new(miles, fop, flight_miles, flight_miles_remark, standard_flight_miles, bonus_miles, bonus_miles_remark, fop_rate, fop_bonus, fop_bonus_remark)
+    end
+
+    def valid_cards
+      @valid_card_types ||= form_page.search('#intCardtype option').map do |option|
+        CardType.new(option['value'], option.inner_text.strip)
+      end
+    end
+
+    def valid_statuses
+      @valid_statuses ||= parse_data_js("status_hash").fetch('g_club').map do |(name, code)|
+        Status.new(code.to_s, name)
+      end
+    end
+
+    def valid_intl_airports_for_earning
+      @valid_airports_for_earning ||= parse_data_js("save_city_hash").flat_map do |area, airports|
+        airports.map do |(name, code)|
+          Airport.new(code, area, name)
+        end
+      end
+    end
+
+    def valid_dom_airports
+      @valid_dom_airports ||= parse_data_js("dom_city").map do |(name, code)|
+        Airport.new(code, nil, name)
+      end
+    end
+
+    def valid_dom_classes
+      @valid_dom_classes ||= form_page.search('#domClass option').map do |option|
+        SeatClass.new(option['value'], option.inner_text.strip)
+      end
+    end
+
+    def valid_dom_fares
+      @valid_dom_fares ||= begin
+         feelist = form_page.search('.feelist')[0].search('tr').map do |tr|
+           tr.search('td').map(&:inner_text).map(&:strip)
+         end.reject(&:empty?).to_h
+
+         form_page.search('#domFare option').map do |option|
+           name = option.inner_text.strip
+           remark = feelist[name]
+           Fare.new(option['value'], name, remark)
+         end
+       end
+    end
+
+    def valid_intl_fares
+      @valid_intl_fares ||= begin
+         feelist = form_page.search('.feelist')[1].search('tr').map do |tr|
+           tr.search('td').map(&:inner_text).map(&:strip)
+         end.reject(&:empty?).to_h
+
+         form_page.search('#intFare option').map do |option|
+           name = option.inner_text.strip
+           remark = feelist[name]
+           Fare.new(option['value'], name, remark)
+         end
+       end
+    end
+
+
+    def parse_data_js(variable)
+      m = data_js.match(/^var #{Regexp.escape(variable)} = (.+?\r?\n[\]}]);$/m)
+      raise DataParseError, "Failed to extract #{variable.inspect} from data_js" unless m
+      js = m[1]
+      json_like = js.
+        gsub(/^\s*"(.+?)"\s*:|^\s*(.+?)\s*:/,'"\1\2":')
+      JSON.parse json_like
+    rescue JSON::ParserError
+      raise DataParseError, "Failed to parse #{variable.inspect} from data_js"
+    end
+
+    def post_form(data)
+      Nokogiri::HTML(Net::HTTP.post_form(ENDPOINT_URI, data).tap(&:value).body.encode("UTF-8", "Shift_JIS"))
+    end
+
+    def form_page
+      @form_page ||= Nokogiri::HTML(open(ENDPOINT_URI, 'r', &:read).encode("UTF-8", "Shift_JIS"))
+    end
+
+    def data_js
+      @data_js ||= open(DATA_JS_URI, 'r', &:read).encode("UTF-8", "Shift_JIS")
+    end
+  end
+end

data/lib/fop/version.rb

@@ -0,0 +1,3 @@
+module Fop
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: fop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sorah Fukumori
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- her@sorah.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fop.gemspec
+- lib/fop.rb
+- lib/fop/client.rb
+- lib/fop/version.rb
+homepage: https://github.com/sorah/fop
+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.7.3
+signing_key: 
+specification_version: 4
+summary: scraping client of Japan Airlines FOP/Mileage calculator
+test_files: []