adp-downloader 0.2.5 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a4956fc33bceb12c43fae6e8a2667828524b0e86
-  data.tar.gz: 70acb5b0cda437e1ba652f854d2032012059d747
+SHA256:
+  metadata.gz: 384b5c0fe414958a0fb3bd2acf06a0dd8807658c52f257def6b7916518f87cb2
+  data.tar.gz: fefb3828e092784a1a6617a4e9e956011394185032c18fbe51beed6ac8fa11b7
 SHA512:
-  metadata.gz: d811e831b8ce53644974f6e2b9361f33b009cc4c2cb835436241b16224d2433ff03fe21d58d0ef1aea7a9cdc4826c4ba8ebc3f5614690d078de5ff3d52ad6109
-  data.tar.gz: 8e907f3793fe04cd286bab418d0fb4d1b4484a95e3cb4e615fbda091bfa776f1d6a46975af1cc8c91662a7e3e8063e82a16116a006835d7d649c9e5988c86083
+  metadata.gz: f7ab75292bea4ff60aa1bce6292d6383feb7e67fb321f305a6e37ded16bf1c80ef684d92820e0ba1f486bb14319c4eb6ee4ff96b1b5b987895ecc4195568a2d2
+  data.tar.gz: 037f878196c368e8d38673dd1ec8d3b762982c0890db4915ef2ff09ed5282eeae59c9c9543fc4531b1c184a4d04cc88e201fc0eda872ba51fd266b871f073d8f

data/CHANGELOG.md

@@ -6,6 +6,27 @@ Changelog
 * -
 
 
+## 0.3.2
+
+* [6d3edab][] Fix bug when displaying auth error messages
+
+[6d3edab]: ../../commit/6d3edab
+
+
+## 0.3.1
+
+* [9236c97][] Display better error message on auth error
+
+[9236c97]: ../../commit/9236c97
+
+
+## 0.3.0
+
+* [e05377b][] Disable netrc authentication in favor of cookie only :(
+
+[e05377b]: ../../commit/e05377b
+
+
 ## 0.2.5
 
 * [00e3ff6][] Gracefully handle empty tax or pay statements

data/Gemfile.lock

@@ -1,49 +1,49 @@
 PATH
   remote: .
   specs:
-    adp-downloader (0.2.2)
+    adp-downloader (0.2.5)
       mechanize (~> 2.7)
       netrc (~> 0.11)
-      parallel (~> 1.10)
+      parallel (~> 1.12)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.1.1)
-    domain_name (0.5.20161129)
+    coderay (1.1.2)
+    connection_pool (2.2.2)
+    domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    mechanize (2.7.5)
+    mechanize (2.7.6)
       domain_name (~> 0.5, >= 0.5.1)
       http-cookie (~> 1.0)
       mime-types (>= 1.17.2)
       net-http-digest_auth (~> 1.1, >= 1.1.1)
-      net-http-persistent (~> 2.5, >= 2.5.2)
+      net-http-persistent (>= 2.5.2)
       nokogiri (~> 1.6)
       ntlm-http (~> 0.1, >= 0.1.1)
       webrobots (>= 0.0.9, < 0.2)
-    method_source (0.8.2)
-    mime-types (3.1)
+    method_source (0.9.0)
+    mime-types (3.2.2)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
-    mini_portile2 (2.1.0)
-    net-http-digest_auth (1.4)
-    net-http-persistent (2.9.4)
+    mime-types-data (3.2018.0812)
+    mini_portile2 (2.3.0)
+    net-http-digest_auth (1.4.1)
+    net-http-persistent (3.0.0)
+      connection_pool (~> 2.2)
     netrc (0.11.0)
-    nokogiri (1.7.0.1)
-      mini_portile2 (~> 2.1.0)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
     ntlm-http (0.1.1)
-    parallel (1.10.0)
-    pry (0.10.4)
+    parallel (1.12.1)
+    pry (0.11.3)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rake (10.5.0)
-    slop (3.6.0)
+      method_source (~> 0.9.0)
+    rake (12.3.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.2)
+    unf_ext (0.0.7.5)
     webrobots (0.1.2)
 
 PLATFORMS
@@ -51,9 +51,9 @@ PLATFORMS
 
 DEPENDENCIES
   adp-downloader!
-  bundler (~> 1.13)
-  pry (~> 0.10.0)
-  rake (~> 10.0)
+  bundler (~> 1.16)
+  pry (~> 0.11)
+  rake (~> 12.3)
 
 BUNDLED WITH
-   1.13.7
+   1.16.1

data/README.md

@@ -13,6 +13,12 @@ that have not yet been downloaded.
 
 ## Upgrading
 
+### 0.2.x --> 0.3.x
+
+Non-interactive `netrc` authentication is currently not supported due to
+ADP requiring javascript to perform login. Unfortunately, the only way
+to use the app is to ask for the `smsession` cookie from `stdin`. :(
+
 ### 0.2.x --> 0.2.3
 
 Statements can now be downloaded by employer/account. This is not a

data/Rakefile

@@ -1,9 +1,22 @@
 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|
+Gem::PackageTask.new(SPEC) do |pkg|
   pkg.need_zip = false
   pkg.need_tar = false
 end
+
+task :default => [:gem]
+
+task :install => [:gem] do
+  sh "gem install #{gem_path}"
+end
+
+task :publish => [:gem] do
+  sh "gem push #{gem_path}"
+end
+
+def gem_path
+  "pkg/adp-downloader-#{SPEC.version}.gem"
+end

data/adp-downloader.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |s|
 
   s.add_dependency "mechanize", "~> 2.7"
   s.add_dependency "netrc", "~> 0.11"
-  s.add_dependency "parallel", "~> 1.10"
-  s.add_development_dependency "bundler", "~> 1.13"
-  s.add_development_dependency "rake", "~> 10.0"
-  s.add_development_dependency "pry", "~> 0.10.0"
+  s.add_dependency "parallel", "~> 1.12"
+  s.add_development_dependency "bundler", "~> 1.16"
+  s.add_development_dependency "rake", "~> 12.3"
+  s.add_development_dependency "pry", "~> 0.11"
 end

data/lib/adp-downloader/config.rb

@@ -8,7 +8,7 @@ module ADPDownloader
       attr_accessor :employer
 
       def credentials
-        from_netrc or from_stdin
+        @creds ||= from_stdin
       end
 
       def quiet?
@@ -16,8 +16,12 @@ module ADPDownloader
       end
 
       private
-      def creds(username, password)
-        { username: username, password: password }
+      def creds(username, password, smsession_cookie)
+        {
+          username: username,
+          password: password,
+          smsession_cookie: smsession_cookie,
+        }
       end
 
       def from_netrc
@@ -27,13 +31,26 @@ module ADPDownloader
         creds(username, password) if username and password
       end
 
+      def read_cookie_file
+        cookie_file = "cookie.txt"
+        unless File.exists? cookie_file
+          puts "Please create a file called 'cookie.txt' in this directory and"
+          puts "paste the value of the SMSESSION cookie in it."
+          exit 1
+        end
+        File.read(cookie_file).chomp
+      end
+
       def from_stdin
-        print "Username: "
-        username = STDIN.gets.chomp
-        print "Password: "
-        password = STDIN.noecho(&:gets).chomp
-        puts
-        creds(username, password)
+        # FIXME: https://github.com/andersonvom/adp-downloader/issues/6
+        #print "Username: "
+        #username = STDIN.gets.chomp
+        #print "Password: "
+        #password = STDIN.noecho(&:gets).chomp
+        #puts
+        username = 'currently-not-working'
+        password = 'currently-not-working'
+        creds(username, password, read_cookie_file)
       end
     end
   end

data/lib/adp-downloader/downloader.rb

@@ -23,7 +23,7 @@ module ADPDownloader
 
     def download_statement_files(statement)
       if statement.json_uri
-        json = @http_client.get(full_url(statement.json_uri)) if statement.json_uri
+        json = _get_or_log(statement) if statement.json_uri
         _save(JSON.pretty_generate(statement.merge(json)), statement.json)
       end
 
@@ -42,21 +42,23 @@ module ADPDownloader
       end
     end
 
-    def get_all_pay_statements
-      puts "Downloading all pay statements..." unless Config.quiet?
-      Parallel.each(pay_statements) do |statement|
+    def get_statements(type, statements)
+      puts "Downloading all #{type} statements..." unless Config.quiet?
+      Parallel.each(statements) do |statement|
         download_or_skip_statement(statement)
       end
     end
 
-    def get_all_tax_statements
-      puts "Downloading all tax statements..." unless Config.quiet?
-      Parallel.each(tax_statements) do |statement|
-        download_or_skip_statement(statement)
+    private
+    def _get_or_log(statement)
+      begin
+        @http_client.get(full_url(statement.json_uri))
+      rescue
+        puts "Error downloading statement: #{statement.date} - #{statement.id}"
+        raise
       end
     end
 
-    private
     def _save(contents, path)
       FileUtils.mkpath(File.dirname(path))
       File.open(path, "w") { |f| f.write(contents) }

data/lib/adp-downloader/http_client.rb

@@ -4,28 +4,36 @@ require "mechanize"
 module ADPDownloader
   class HttpClient
     def initialize
-      headers = {"Accept" => "application/json, text/plain, */*"}
-      @agent = Mechanize.new {|a| a.request_headers = headers}
-      res = _login(Config.credentials)
-      _raise_on_error(res)
+      # FIXME: https://github.com/andersonvom/adp-downloader/issues/6
+      #_raise_on_error(_login(Config.credentials))
     end
 
     def get(url)
-      contents = download(url)
+      res = agent.get(url)
+      _raise_on_error(res)
+      contents = res.body
       contents.to_s.empty? ? {} : JSON.parse(contents)
     end
 
     def post(url, data)
-      @agent.post(url, data)
+      agent.post(url, data)
     end
 
     def download(url)
-      @agent.get(url).body
+      agent.get(url).body
     end
 
     private
+    def agent
+      headers = {
+        "Accept" => "application/json, text/plain, */*",
+        "Cookie" => "SMSESSION=#{Config.credentials[:smsession_cookie]}",
+      }
+      @agent ||= Mechanize.new {|a| a.request_headers = headers}
+    end
+
     def _login(creds)
-      @agent.post(LOGIN_URL, {
+      agent.post(LOGIN_URL, {
         "target" => TARGET_URL,
         "user" => creds[:username],
         "password" => creds[:password],
@@ -34,8 +42,10 @@ module ADPDownloader
 
     def _raise_on_error(res)
       uri = res.uri.to_s.downcase
-      if not uri.start_with? TARGET_URL or uri.include? "login"
-        raise "Unable to authenticate: make sure your username and password are correct"
+      #if not uri.start_with? TARGET_URL or uri.include? "login"
+      if uri.include? "login"
+        #raise "Unable to authenticate: make sure your username and password are correct"
+        raise "Unable to authenticate: make sure the file cookie.txt is up to date"
       end
     end
   end

data/lib/adp-downloader/runner.rb

@@ -11,8 +11,8 @@ module ADPDownloader
       parse_options
       begin
         downloader = Downloader.new(HttpClient.new)
-        downloader.get_all_tax_statements
-        downloader.get_all_pay_statements
+        downloader.get_statements('tax', downloader.tax_statements)
+        downloader.get_statements('pay', downloader.pay_statements)
       rescue Exception => e
         path = log_exception_to_file(e)
         puts "An error ocurred: #{e}"

data/lib/adp-downloader/version.rb

@@ -1,3 +1,3 @@
 module ADPDownloader
-  VERSION = "0.2.5"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adp-downloader
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.2
 platform: ruby
 authors:
 - Anderson Mesquita (andersonvom)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-12 00:00:00.000000000 Z
+date: 2019-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -44,56 +44,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.11'
 description: This app incrementally downloads ADP pay statements (pay stubs) from
   MyADP
 email: andersonvom@gmail.com
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: ADP pay statement / pay stub downloader from MyADP