pxmyportal 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f25706b73248348e68caf96c48c38c7c5727144af51818e1691e99dfe9c995e
-  data.tar.gz: 89571aea828715be9f6c97e67d6470a131524760a79ae9d4816b801efbaddc9e
+  metadata.gz: 4cbf8a59677b55d931c451253e344c95bd6982772b435aee1ff36d61758d58e0
+  data.tar.gz: d898d019ea5c9cf1a4322d010fa6b9a340124eaf51f486c8ce4598c8f840cba2
 SHA512:
-  metadata.gz: 6e2f1fb53fbbbd971e04f9454848cd6f008c9034e036dd291f1bb84ece207a0a3fdf6ff79374f05c81ef96cb4e63185a4046a068900f6b84a8b7d93402422db0
-  data.tar.gz: 011d48b84aa232d6d6e214583f5c2e8d77a75ad56fab4af43e887aea879a04a3d1705bb1a88e896ccba30b725b462c245df2fe03c269c02b7b5a36bc5380b00b
+  metadata.gz: 3a29af76c458801437e49d666ff0811511a2cd0eebb115f712237aca8434b973b254bef3178e4f27cd7ed4af10cf02374993f902d0f9ef9c7a5a0242bc5f8b01
+  data.tar.gz: a76893da0c041570c1895ed29a3db7c2e6757f25b31846a90f13db5a84cd49a6320503a8e2bb56c367ebf723d57ed609d169de685f9b1069b909ca8959c87f71

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log of PXMyPortal gem
 
+## 0.0.3 - 2025-07-19
+
+Enable to save bonus payslips.
+
+## 0.0.2 - 2025-05-26
+
+No significant changes.
+
 ## 0.0.1 - 2025-05-10
 
 - Initial release

data/README.md

@@ -1,33 +1,34 @@
 # PXMyPortal
 
-このgemは[PXマイポータル](https://www.tkc.jp/pxmyportal/)のコマンドラインツールpxmyportalを提供します。
+このgemは[PXまいポータル](https://www.tkc.jp/pxmyportal/)のコマンドラインツールpxmyportalを提供します。
 現時点で給与明細書のダウンロードを行えます。
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Install the gem and add to the application's `Gemfile` by executing:
 
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add pxmyportal
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install pxmyportal
 
 ## Usage
 
 環境変数`PXMYPORTAL_COMPANY`、`PXMYPORTAL_USER`、`PXMYPORTAL_PASSWORD`の指定が必要です。
+必要に応じて`.env`ファイルや設定ファイルを作成してください。
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test-unit` 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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 the created tag, 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/gemmaro/pxmyportal.
+Bug reports and pull requests are welcome on [GitHub](https://github.com/gemmaro/pxmyportal).
 
 ## License
 

data/Rakefile

@@ -1,27 +1,3 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-default = %i[test]
-
-rubocop = true
-
-begin
-  require "rubocop/rake_task"
-rescue LoadError
-  rubocop = false
-end
-
-if rubocop
-  RuboCop::RakeTask.new
-  default << :rubocop
-end
-
-task(default:)

data/lib/pxmyportal/agent.rb

@@ -15,19 +15,19 @@
 
 require "yaml"
 require "net/http"
-require "http-cookie" # Use CGI::Cookie?
 require "nokogiri"
+require "logger"
+require "set"
 require_relative "payslip"
+require_relative "error"
+require_relative "cookie"
+require_relative "page"
 
 class PXMyPortal::Agent
-  PAYSLIP_PAGE_PATH_SAMPLE = File.join(PXMyPortal::CLIENT_BASEPATH, "SalaryPayslipSample")
-  PAYSLIP_PAGE_PATH_NORMAL = File.join(PXMyPortal::CLIENT_BASEPATH, "SalaryPayslip")
-
   def let_redirect
     token = request_verification_token
-    path = PXMyPortal::BASEPATH
-    request = Net::HTTP::Post.new(path)
-    provide_cookie(request, url: build_url(path))
+    request = Net::HTTP::Post.new(PXMyPortal::Page::BASEPATH)
+    @cookie.provide(request, url: build_url(PXMyPortal::Page::BASEPATH))
 
     data = { LoginId: @user,
              Password: @password,
@@ -37,19 +37,14 @@ class PXMyPortal::Agent
     begin
       response => Net::HTTPFound
     rescue => e
-      File.write("let_redirect.html", response.body)
+      File.write(File.join(PXMyPortal::XDG::CACHE_DIR, "debug", "let_redirect.html"),
+                 response.body)
       raise e
     end
 
-    case (location = response["location"])
-    when PAYSLIP_PAGE_PATH_SAMPLE
-      @phase = :sample
-    when PAYSLIP_PAGE_PATH_NORMAL
-      @phase = :normal
-    else
-      raise Error, "unexpected location #{location}"
-    end
-    accept_cookie(response, url: build_url(payslip_page_path))
+    @page = PXMyPortal::Page.from_path(response["location"]) \
+      or raise PXMyPortal::Error, "unexpected location #{location}"
+    @cookie.accept(response, url: build_url(@page.path))
     self
   end
 
@@ -57,22 +52,23 @@ class PXMyPortal::Agent
     existing_payslips = (YAML.load_file(@payslips_path) rescue []) || []
     payslips.each do |payslip|
       if existing_payslips&.find { |candidate| payslip == candidate }
-        $stderr.puts "skip #{payslip}"
+        @logger.info("skipping") { payslip }
         next
       end
-      path = confirm_pdf_frame_path
+      path = @page.confirm_path
       request = Net::HTTP::Post.new(path)
-      provide_cookie(request, url: build_url(path))
+      @cookie.provide(request, url: build_url(path))
       request.form_data = payslip.form_data
       response = http.request(request)
       response => Net::HTTPOK
 
-      Dir.mkdir(payslip.directory) unless File.directory?(payslip.directory)
+      FileUtils.mkdir_p(payslip.directory) unless File.directory?(payslip.directory)
+      @logger.info("saving payslip...") { payslip.filename }
       File.write(payslip.filename, response.body) unless @test
       existing_payslips << payslip.metadata
     end
     
-    File.open(@payslips_path, "w") { |file| YAML.dump(existing_payslips, file) } \
+    File.open(payslips_path, "w") { |file| YAML.dump(existing_payslips, file) } \
       unless @test
 
     self
@@ -80,36 +76,60 @@ class PXMyPortal::Agent
 
   private
 
-  def payslip_page_path
-    @payslip_page_path ||= { sample: PAYSLIP_PAGE_PATH_SAMPLE,
-                             normal: PAYSLIP_PAGE_PATH_NORMAL }[@phase]
+  def payslips_path
+    @created_payslips_path and return @created_payslips_path
+    dir = File.dirname(@payslips_path)
+    unless Dir.exist?(dir)
+      @logger.info("creating payslips path...")
+      Dir.mkdir(dir)
+    end
+    @created_payslips_path = @payslips_path
   end
 
   def payslips
     return @payslips if @payslips
 
-    request = Net::HTTP::Get.new(payslip_page_path)
-    provide_cookie(request, url: build_url(payslip_page_path))
+    pages = Set[PXMyPortal::Page::BONUS]
+    unless @bonus_only
+      pages << @page
+    end
+    @logger.debug("pages") { pages }
+
+    @payslips = []
+    pages.each do |page|
+      @payslips.concat(payslips_for_page(page))
+    end
+    @logger.warn("no payslips") if @payslips.empty?
+    @logger.debug("payslips") { @payslips }
+    @payslips
+  end
+
+  def payslips_for_page(page)
+    request = Net::HTTP::Get.new(page.path)
+    @debug and @logger.debug("request") { request }
+
+    @cookie.provide(request, url: build_url(page.path))
     response = http.request(request)
+    @debug and @logger.debug("response") { response }
     response => Net::HTTPOK
 
-    @payslips = Nokogiri::HTML(response.body)
-                  .xpath("//*[@id='ContentPlaceHolder1_PayslipGridView']//tr")
-                  .map { |row| PXMyPortal::Payslip.from_row(row, directory: @payslip_dir) }
+    File.write(page.cache_path, response.body)
+    page.rows(response.body)
+      .map { |row| PXMyPortal::Payslip.from_row(row, directory: @payslip_dir) }
   end
 
   def request_verification_token
     return @request_verification_token if @request_verification_token
 
-    @debug and http.set_debug_output($stderr)
+    @debug_http and http.set_debug_output($stderr)
     http.start
-    path = File.join(PXMyPortal::BASEPATH, "Auth/Login")
+    path = File.join(PXMyPortal::Page::BASEPATH, "Auth/Login")
     query = @company
     response = http.get("#{path}?#{query}")
     response => Net::HTTPOK
 
-    @jar.load(@cookie_jar_path) if File.exist?(@cookie_jar_path)
-    accept_cookie(response, url: build_url(path, query:))
+    @cookie.load
+    @cookie.accept(response, url: build_url(path, query:))
 
     document = Nokogiri::HTML(response.body)
     token = <<~XPATH
@@ -126,33 +146,30 @@ class PXMyPortal::Agent
     URI::HTTPS.build(host: PXMyPortal::HOST, path:, query:)
   end
 
-  def confirm_pdf_frame_path
-    case @phase
-    in :sample
-      File.join(PXMyPortal::CLIENT_BASEPATH, "ConfirmSamplePDFFrame")
-    in :normal
-      File.join(PXMyPortal::CLIENT_BASEPATH, "ConfirmPDFFrame")
-    end
-  end
-
   def initialize(debug: false,
-                 cookie_jar_path: "pxmyportal.cookie-jar",
-                 payslips_path: "payslips.yaml",
+                 cookie_jar_path: nil,
+                 payslips_path: File.join(ENV["XDG_DATA_HOME"],
+                                          "pxmyportal", "payslips.yaml"),
                  company:,
                  user:,
                  password:,
                  test: false,
-                 payslip_dir:)
+                 payslip_dir: nil,
+                 bonus_only: false,
+                 debug_http: false)
 
     @company         = company
     @user            = user
     @password        = password
-    @cookie_jar_path = cookie_jar_path
-    @jar             = HTTP::CookieJar.new
     @debug           = debug
     @payslips_path   = payslips_path
     @test            = test
     @payslip_dir     = payslip_dir
+    @bonus_only      = bonus_only
+    @debug_http      = debug_http
+
+    @logger = Logger.new($stderr)
+    @cookie = PXMyPortal::Cookie.new(jar_path: cookie_jar_path, logger: @logger)
   end
 
   def http
@@ -162,13 +179,4 @@ class PXMyPortal::Agent
     http.use_ssl = true
     @http = http
   end
-
-  def accept_cookie(response, url:)
-    response.get_fields("Set-Cookie").each { |value| @jar.parse(value, url) }
-    @jar.save(@cookie_jar_path)
-  end
-
-  def provide_cookie(request, url:)
-    request["Cookie"] = HTTP::Cookie.cookie_value(@jar.cookies(url))
-  end
 end

data/lib/pxmyportal/command.rb

@@ -21,14 +21,17 @@ class PXMyPortal::Command
     options = { company: ENV["PXMYPORTAL_COMPANY"],
                 user: ENV["PXMYPORTAL_USER"],
                 password: ENV["PXMYPORTAL_PASSWORD"],
-                test: ENV["PXMYPORTAL_TEST"],
-                payslip_dir: Dir.pwd }
+                test: ENV["PXMYPORTAL_TEST"] }
 
     parser = OptionParser.new
     parser.on("--debug") { options[:debug] = true }
     parser.on("--cookie-jar=PATH") { |path| options[:cookie_jar_path] = path }
-    parser.on("--payslips=PATH") { |path| options[:payslips_path] = path }
+    parser.on("--payslips=PATH",
+              "database file for previously stored payslips") { |path|
+      options[:payslips_path] = path }
     parser.on("--payslip-dir=PATH") { |path| options[:payslip_dir] = path }
+    parser.on("--bonus-only") { options[:bonus_only] = true }
+    parser.on("--debug-http") { options[:debug_http] = true }
     parser.parse!
 
     agent = PXMyPortal::Agent.new(**options)

data/lib/pxmyportal/cookie.rb

@@ -0,0 +1,37 @@
+require "http-cookie" # Use CGI::Cookie?
+require_relative "xdg"
+
+class PXMyPortal::Cookie
+  def initialize(jar_path: nil, logger:)
+    @jar_path = jar_path || File.join(PXMyPortal::XDG::CACHE_DIR, "cookie-jar")
+    @logger = logger
+
+    @jar             = HTTP::CookieJar.new
+  end
+
+  def load
+    @jar.load(@jar_path) if File.exist?(@jar_path)
+  end
+
+  # Previously accept_cookie.
+  def accept(response, url:)
+    response.get_fields("Set-Cookie").each { |value| @jar.parse(value, url) }
+    @jar.save(jar_path)
+  end
+
+  # Previously cookie_jar_path.
+  def jar_path
+    @created_jar_path and return @created_jar_path
+    dir = File.dirname(@jar_path)
+    unless Dir.exist?(dir)
+      @logger.info("creating cache directory")
+      Dir.mkdir(dir)
+    end
+    @created_jar_path = @jar_path
+  end
+
+  # Previously provide_cookie.
+  def provide(request, url:)
+    request["Cookie"] = HTTP::Cookie.cookie_value(@jar.cookies(url))
+  end
+end

data/lib/pxmyportal/error.rb

@@ -0,0 +1 @@
+PXMyPortal::Error = Class.new(StandardError)

data/lib/pxmyportal/page.rb

@@ -0,0 +1,58 @@
+# Previously @phase.
+class PXMyPortal::Page
+  BASEPATH = "/pmpwps/"
+  CLIENT_BASEPATH = File.join(BASEPATH, "pc/")
+
+  SAMPLE_PATH = File.join(CLIENT_BASEPATH, "SalaryPayslipSample")
+  NORMAL_PATH = File.join(CLIENT_BASEPATH, "SalaryPayslip")
+  BONUS_PATH = File.join(CLIENT_BASEPATH, "BonusPayslip")
+
+  attr_reader :path, :confirm_path
+
+  def initialize(path:, confirm_path:, cache_filename:, row_xpath:)
+    @path = path
+
+    # Previously confirm_pdf_frame_path.
+    @confirm_path = confirm_path
+
+    @cache_filename = cache_filename
+    @row_xpath = row_xpath
+  end
+
+  def cache_path
+    @cache_path and return @cache_path
+    @cache_path = File.join(PXMyPortal::XDG::CACHE_DIR, "debug", "page", "#{@cache_filename}.html")
+
+    dir = File.dirname(@cache_path)
+    unless Dir.exist?(dir)
+      FileUtils.mkdir_p(dir)
+    end
+    @cache_path
+  end
+
+  def rows(source)
+    Nokogiri::HTML(source).xpath(@row_xpath)
+  end
+
+  normal_row_xpath = "//*[@id='ContentPlaceHolder1_PayslipGridView']//tr"
+
+  # Previously PAYSLIP_PAGE_PATH_SAMPLE.
+  SAMPLE = new(
+    path: SAMPLE_PATH,
+    confirm_path: File.join(CLIENT_BASEPATH, "ConfirmSamplePDFFrame"),
+    cache_filename: "sample", row_xpath: normal_row_xpath)
+
+  # Previously PAYSLIP_PAGE_PATH_NORMAL.
+  NORMAL = new(path: NORMAL_PATH,
+               confirm_path: File.join(CLIENT_BASEPATH, "ConfirmPDFFrame"),
+               cache_filename: "normal", row_xpath: normal_row_xpath)
+
+  # Previously PAYSLIP_PAGE_PATH_BONUS.
+  BONUS = new(path: BONUS_PATH, confirm_path: :TODO,
+              cache_filename: "bonus",
+              row_xpath: "//*[@id='ContentPlaceHolder1_BonusPayslipGridView']//tr")
+
+  def self.from_path(path)
+    { SAMPLE_PATH => SAMPLE, NORMAL_PATH => NORMAL, BONUS_PATH => NORMAL }[path]
+  end
+end

data/lib/pxmyportal/payslip.rb

@@ -13,10 +13,13 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
+require_relative "xdg"
+
 class PXMyPortal::Payslip
   attr_reader :year_month, :description, :directory
 
-  def initialize(year_month:, description:, key1:, key2:, key3:, directory:)
+  def initialize(year_month:, description:, key1:, key2:, key3:,
+                 directory: PXMyPortal::XDG::DOC_DIR)
     @year_month  = year_month
     @description = description
     @key1        = key1
@@ -48,7 +51,7 @@ class PXMyPortal::Payslip
     "#<Payslip #{year_month.inspect} #{description.inspect}>"
   end
 
-  def self.from_row(row, directory:)
+  def self.from_row(row, directory: nil)
     row.xpath("./td") => [year_month, description, button]
     year_month.xpath(".//text()") => [year_month]
     description.xpath(".//text()") => [description]
@@ -62,9 +65,13 @@ class PXMyPortal::Payslip
     key1 = match[:key1]
     key2 = match[:key2]
     key3 = match[:key3]
+
+    options = {}
+    directory and options[:directory] = directory
+
     new(year_month: year_month.content,
         description: description.content,
         key1:, key2:, key3:,
-        directory:)
+        **options)
   end
 end

data/lib/pxmyportal/version.rb

@@ -16,5 +16,5 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 module PXMyPortal
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/lib/pxmyportal/xdg.rb

@@ -0,0 +1,5 @@
+class PXMyPortal::XDG
+  CACHE_DIR = File.join(ENV["XDG_CACHE_HOME"], "pxmyportal")
+  DOC_DIR = File.join(ENV["XDG_DOCUMENTS_DIR"] || File.join(Dir.home, "Documents"),
+                      "pxmyportal")
+end

data/lib/pxmyportal.rb

@@ -14,10 +14,7 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 class PXMyPortal
-  Error = Class.new(StandardError)
   HOST = "pxmyportal.tkc.jp"
-  BASEPATH = "/pmpwps/"
-  CLIENT_BASEPATH = File.join(BASEPATH, "pc/")
 end
 
 require_relative "pxmyportal/command"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pxmyportal
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - gemmaro
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-10 00:00:00.000000000 Z
+date: 2025-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-cookie
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: このgemはPXマイポータルのコマンドラインツールpxmyportalを提供します。現時点で給与明細書のダウンロードを行えます。
+description: このgemはPXまいポータルのコマンドラインツールpxmyportalを提供します。現時点で給与明細書のダウンロードを行えます。
 email:
 - gemmaro.dev@gmail.com
 executables:
@@ -47,7 +47,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".env.example"
-- ".rubocop.yml"
 - CHANGELOG.md
 - COPYING
 - README.md
@@ -56,9 +55,12 @@ files:
 - lib/pxmyportal.rb
 - lib/pxmyportal/agent.rb
 - lib/pxmyportal/command.rb
+- lib/pxmyportal/cookie.rb
+- lib/pxmyportal/error.rb
+- lib/pxmyportal/page.rb
 - lib/pxmyportal/payslip.rb
 - lib/pxmyportal/version.rb
-- sig/pxmyportal.rbs
+- lib/pxmyportal/xdg.rb
 homepage:
 licenses:
 - GPL-3.0-or-later
@@ -78,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: PXまいポータルのコマンドラインツール

data/.rubocop.yml

@@ -1,8 +0,0 @@
-AllCops:
-  TargetRubyVersion: 3.0
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes

data/sig/pxmyportal.rbs

@@ -1,4 +0,0 @@
-module PXMyPortal
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end