adp-downloader 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1cadc888f31c234b4cbd4d1f899255cb3c2a7c27
-  data.tar.gz: 5a095438b1c8b3032cb9f50e55d920095db7d5f0
+  metadata.gz: d217d84d25e8a5e7f0091b3aaed579e9edcc2e99
+  data.tar.gz: 04abc7c77e4155ba64e6873e5b4ef809972697d2
 SHA512:
-  metadata.gz: 6525948f6a25e91ae47f7eed9ffbeb0d1395bfc393a9c703394046dbe914e0ef66c79bb4b52c5cdae313b957131716553d74c091f8d0e8b35c4ad36234e7def9
-  data.tar.gz: 9c12b599709485d479ffcc568a29a42fc98c7d51467d59c3c0a672055efd87545dbff635b170e5a8cf7ed5caa37816f7095bcbc9f50982d3bb963aeb79a226b5
+  metadata.gz: bab0253305cb53817f7d2f552c09be72f733f5a099f0c27fcecd191ede0c6f5ea04cf25adabb4c9f0fbf695b645723e3d275a2f5ad37e3b6fef7ea8883643216
+  data.tar.gz: dbb0326a37f050b01f816c74565d6874c17d47e90109f65236caa5ad4e150739fb87ca0389487e6637869a46913fb57d5cb67430cd138eb537011778caad6d5f

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify dependencies in adp-downloader.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    adp-downloader (0.1.3)
+    adp-downloader (0.2.0)
       mechanize (~> 2.7)
       netrc (~> 0.11)
       parallel (~> 1.10)

data/README.md

@@ -11,6 +11,17 @@ that have not yet been downloaded.
     gem install adp-downloader  # you might have to use sudo
 
 
+## Upgrading
+
+### 0.1.x --> 0.2.x
+
+Statements are stored by year and the app uses the PDF ID, that is
+always available, instead of the ID of the detailed JSON, and statements
+are also stored in directories by year.  You might want to save backup
+your current statements and manually merge the ones that might not be
+available anymore in the new folders.
+
+
 ## Usage
 
 Go to the directory where you want the pay stubs to be saved and run:

data/Rakefile

@@ -1,8 +1,8 @@
-require 'rubygems/package_task'
+require "rubygems/package_task"
 
 task :default => [:gem]
 
-spec = eval(File.read('adp-downloader.gemspec'))
+spec = eval(File.read("adp-downloader.gemspec"))
 Gem::PackageTask.new(spec) do |pkg|
   pkg.need_zip = false
   pkg.need_tar = false

data/lib/adp-downloader.rb

@@ -1,12 +1,12 @@
-require 'adp-downloader/downloader'
-require 'adp-downloader/http_client'
-require 'adp-downloader/pay_statement'
+require "adp-downloader/downloader"
+require "adp-downloader/http_client"
 
 module ADPDownloader
   def self.download
     begin
       downloader = Downloader.new(HttpClient.new)
-      downloader.get_all_statements
+      downloader.get_all_tax_statements
+      downloader.get_all_pay_statements
     rescue Exception => e
       path = log_exception_to_file(e)
       puts "An error ocurred: #{e}"

data/lib/adp-downloader/config.rb

@@ -1,6 +1,6 @@
-require 'io/console'
-require 'netrc'
-require 'adp-downloader/constants'
+require "io/console"
+require "netrc"
+require "adp-downloader/constants"
 
 module ADPDownloader
   class Config

data/lib/adp-downloader/constants.rb

@@ -1,5 +1,5 @@
-require 'io/console'
-require 'netrc'
+require "io/console"
+require "netrc"
 
 module ADPDownloader
   MACHINE_NAME = "adp-downloader"
@@ -8,5 +8,6 @@ module ADPDownloader
   TARGET_URL = "#{BASE_URL}/static/redbox/"
 
   LOGIN_URL = "https://agateway.adp.com/siteminderagent/forms/login.fcc"
-  ALL_STATEMENTS_PATH = '/v1_0/O/A/payStatements?adjustments=yes&numberoflastpaydates=100'
+  PAY_STATEMENTS_PATH = "/v1_0/O/A/payStatements?adjustments=yes&numberoflastpaydates=100"
+  TAX_STATEMENTS_PATH = "/v1_0/O/A/workerTaxStatements"
 end

data/lib/adp-downloader/downloader.rb

@@ -1,6 +1,8 @@
-require 'parallel'
-require 'adp-downloader/constants'
-require 'adp-downloader/pay_statement'
+require "json"
+require "parallel"
+require "adp-downloader/constants"
+require "adp-downloader/statement/pay_statement"
+require "adp-downloader/statement/tax_statement"
 
 module ADPDownloader
   class Downloader
@@ -12,31 +14,53 @@ module ADPDownloader
       "#{BASE_URL}#{path}"
     end
 
-    def statements
-      response = @http_client.get(full_url(ALL_STATEMENTS_PATH))
+    def pay_statements
+      response = @http_client.get(full_url(PAY_STATEMENTS_PATH))
       response["payStatements"].map { |json| PayStatement.new(json) }
     end
 
+    def tax_statements
+      response = @http_client.get(full_url(TAX_STATEMENTS_PATH))
+      response["workerTaxStatements"].map { |json| TaxStatement.new(json) }
+    end
+
     def download_statement_files(statement)
-      @http_client.download(full_url(statement.details_url), statement.json)
-      @http_client.download(full_url(statement.image_url), statement.pdf)
+      if statement.json_uri
+        json = @http_client.get(full_url(statement.json_uri)) if statement.json_uri
+        _save(JSON.pretty_generate(statement.merge(json)), statement.json)
+      end
+
+      pdf = @http_client.download(full_url(statement.pdf_uri))
+      _save(pdf, statement.pdf)
     end
 
     def downloaded?(statement)
-      File.exists? statement.pdf and File.exists? statement.json
+      File.exists? statement.pdf
     end
 
     def download_or_skip_statement(statement)
       if not downloaded? statement
-        puts "Saving #{statement.pay_date} - #{statement.id}..."
+        puts "Saving #{statement.date} - #{statement.id}..."
         download_statement_files(statement)
       end
     end
 
-    def get_all_statements
-      Parallel.each(statements) do |statement|
+    def get_all_pay_statements
+      Parallel.each(pay_statements) do |statement|
+        download_or_skip_statement(statement)
+      end
+    end
+
+    def get_all_tax_statements
+      Parallel.each(tax_statements) do |statement|
         download_or_skip_statement(statement)
       end
     end
+
+    private
+    def _save(contents, path)
+      FileUtils.mkpath(File.dirname(path))
+      File.open(path, "w") { |f| f.write(contents) }
+    end
   end
 end

data/lib/adp-downloader/http_client.rb

@@ -1,7 +1,7 @@
-require 'json'
-require 'mechanize'
-require 'adp-downloader/config'
-require 'adp-downloader/constants'
+require "json"
+require "mechanize"
+require "adp-downloader/config"
+require "adp-downloader/constants"
 
 module ADPDownloader
   class HttpClient
@@ -20,10 +20,8 @@ module ADPDownloader
       @agent.post(url, data)
     end
 
-    def download(url, save_path = nil)
-      contents = @agent.get(url).body
-      File.open(save_path, 'w') {|f| f.write(contents)} if save_path
-      contents
+    def download(url)
+      @agent.get(url).body
     end
 
     private

data/lib/adp-downloader/statement/pay_statement.rb

@@ -0,0 +1,25 @@
+require "adp-downloader/statement/statement"
+
+module ADPDownloader
+  class PayStatement < Statement
+    def id
+      File.basename(pdf_uri, ".*")
+    end
+
+    def file_suffix
+      "adjustment" if adjustment?
+    end
+
+    def adjustment?
+      _("payAdjustmentIndicator")
+    end
+
+    def date
+      _("payDate")
+    end
+
+    def json_uri
+      _("payDetailUri.href")
+    end
+  end
+end

data/lib/adp-downloader/statement/statement.rb

@@ -0,0 +1,61 @@
+module ADPDownloader
+  class Statement
+    def initialize(json)
+      @data = json
+    end
+
+    abstract_methods = %w(id date)
+
+    abstract_methods.each do |method_name|
+      define_method method_name do
+        raise "You need to define `#{method_name}` for #{self.class}"
+      end
+    end
+
+    def merge(details)
+      top_level_attr, contents = details.first
+      { top_level_attr => @data.merge(contents) }
+    end
+
+    def filename
+      [date, id, file_suffix].compact.join("-")
+    end
+
+    def file_suffix
+      nil
+    end
+
+    def pdf_uri
+      path = _("statementImageUri.href")
+      path.gsub(/^\/l2/, "") # remove first characters, since it's incorrect o.O
+    end
+
+    def year
+      date.split("-").first
+    end
+
+    def pdf
+      File.join(year, "#{filename}.pdf")
+    end
+
+    def json
+      File.join(year, "#{filename}.json")
+    end
+
+    def _(string)
+      get_info(@data, string.split("."))
+    end
+
+    private
+    def get_info(data, attributes)
+      attr = attributes.first
+      info = data[attr]
+      if attributes.size == 1
+        info
+      else
+        next_data = info.nil? ? {} : info
+        get_info(next_data, attributes.drop(1))
+      end
+    end
+  end
+end

data/lib/adp-downloader/statement/tax_statement.rb

@@ -0,0 +1,21 @@
+require "adp-downloader/statement/statement"
+
+module ADPDownloader
+  class TaxStatement < Statement
+    def id
+      _("statementID")
+    end
+
+    def date
+      _("statementYear.year")
+    end
+
+    def employer
+      _("employerName")
+    end
+
+    def json_uri
+      _("statementUri.href")
+    end
+  end
+end

data/lib/adp-downloader/version.rb

@@ -1,3 +1,3 @@
 module ADPDownloader
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adp-downloader
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Anderson Mesquita (andersonvom)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2017-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -116,7 +116,9 @@ files:
 - lib/adp-downloader/constants.rb
 - lib/adp-downloader/downloader.rb
 - lib/adp-downloader/http_client.rb
-- lib/adp-downloader/pay_statement.rb
+- lib/adp-downloader/statement/pay_statement.rb
+- lib/adp-downloader/statement/statement.rb
+- lib/adp-downloader/statement/tax_statement.rb
 - lib/adp-downloader/version.rb
 homepage: http://rubygems.org/gems/adp-downloader
 licenses:

data/lib/adp-downloader/pay_statement.rb

@@ -1,36 +0,0 @@
-module ADPDownloader
-  class PayStatement
-    def initialize(json)
-      @data = json
-    end
-
-    def id
-      File.basename(@data["payDetailUri"]["href"])
-    end
-
-    def pay_date
-      File.basename(@data["payDate"])
-    end
-
-    def image_url
-      path = @data["statementImageUri"]["href"]
-			path.gsub(/^\/l2/, '') # remove first characters, since it's incorrect o.O
-    end
-
-    def details_url
-      @data["payDetailUri"]["href"]
-    end
-
-    def filename
-      "#{@data["payDate"]}-#{id}"
-    end
-
-    def pdf
-      "#{filename}.pdf"
-    end
-
-    def json
-      "#{filename}.json"
-    end
-  end
-end