webaccount 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 219aecddbc5a0e05b1463300ade4350d9afd789de19f1a43fe34e492d5ad9296
-  data.tar.gz: 6cbc7db55da4afc34b164f3a8a163da4e4e716b313e09b266d2453c98af0c115
+  metadata.gz: 6a94193d490acdd37702fbd4d09835e2a54ef201f5d214713e60bae26845c954
+  data.tar.gz: 15aff8916367524214eb14a2979b3f9d7695557272f2fe44aa035a59aaccc12a
 SHA512:
-  metadata.gz: fdb4db1ec12daf5e307f0df3212f51f1eb4da9b1ca505a68a1008e626598d30214f7d235e330b9f856d215efb816c276eb4525a4578937eb7329dedf064d0581
-  data.tar.gz: b4515525fce7cb22a90b15f7a05ddc3da14cb870c02d4e95d31959a2ff3c3753d74ad96adfb0bd96deb64937f466c20a0ec7ae3395b9d4d43eb59b72b4881dff
+  metadata.gz: 04a678d61437fba7d075eea20c1259786ecbfcb47d701305dac1ff8d362231be7f0a6c474a8497b5a3d8f86ec28e99d5a20267744d4bc32bdcf474322e09bc25
+  data.tar.gz: 67e7b968e7fcab39c8696c087232cb0b020a60e049bfd5279d1a67653293a868553aac0c7cfc7f9ac05ecb4dc5b339d646c1d286dbb2271a6189bd5747a8ed8d

data/CHANGELOG

@@ -1,4 +1,36 @@
-# CHANGELOG
+# webaccount/CHANGELOG
+
+## 20261011
+
+0.6.0: + WebAccount#still_logged_in?, which says at once whether the page now showing still has the logout button.
+
+logged_in? answers from what login() found, and is not told when a session expires afterwards; logged_out? waits up to default_wait_timeout, 30s, for the logged-out marker, which is too long to ask of every page. Something driving the browser from page to page, as 0.5.0 lets it, had no quick way to notice that the session had ended underneath it.
+
+1. + WebAccount#still_logged_in?(): whether the logout button is on the page now showing, by element_present?, which does not wait; and logged_in? is brought into line with the answer.
+2. ~ test/webaccount_test.rb: + true and false with logged_in? following, and a single look rather than a wait, with a stand-in for the browser. All three fail against 0.5.0.
+3. ~ README.md: + still_logged_in?, under Driving the browser once logged in; /WebAccount\/fork/webaccount\/fork/ in Contributing, the repository having been renamed webaccount.
+4. ~ CHANGELOG: /# CHANGELOG/# webaccount\/CHANGELOG/, after the repository.
+5. ~ VERSION: /0.5.0/0.6.0/
+
+0.5.0: + WebAccount#driver, public, so that the logged-in browser can be driven from outside.
+
+driver was private, so once login() had done its work the session it made could be used only by a sub-class. Something which wants the pages behind a login without being a WebAccount, a spider fetching and screenshotting them, had no way to reach the browser holding the session.
+
+1. ~ WebAccount#driver(): public, after shutdown(); what it does is unchanged, the browser being made once, with browser() and driver_options(), upon first being asked for.
+2. + test/webaccount_test.rb: driver public, made once, and made with the browser and driver options given, with Selenium::WebDriver.for swapped for a stand-in so that no browser is wanted. All three fail against 0.4.1.
+3. ~ README.md: + Driving the browser once logged in.
+4. ~ VERSION: /0.4.1/0.5.0/
+
+
+## 20260822
+
+0.4.1: + LICENSE, which the gemspec has claimed without one being present.
+
+1. + LICENSE: the MIT text, copyright 2020-2026 thoran. spec.license has named MIT with no licence text in the repository, so the gem shipped a licence nobody could read.
+2. ~ webaccount.gemspec: + 'LICENSE' to spec.files, without which the file sits in the repository and still does not ship.
+3. + README.md: a License section, saying MIT, last.
+4. ~ VERSION: /0.4.0/0.4.1/
+
 
 ## 20260717
 

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020-2026 thoran
+
+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

@@ -140,6 +140,24 @@ There are two, both overridable in a sub-class:
   my_account.shutdown # If necessary it logs out and then kills the selenium session.
 ```
 
+### Driving the browser once logged in
+
+`driver` is the logged-in browser, a `Selenium::WebDriver::Driver`, for whatever WebAccount doesn't do itself: fetching pages behind the login, reading them, or taking screenshots of them.
+```ruby
+  my_account = MyAccount.new(username: username, password: password)
+  my_account.login
+  my_account.driver.get('https://mysite.com/members/page')
+  my_account.driver.page_source
+  my_account.driver.save_screenshot('page.png')
+  my_account.shutdown
+```
+
+`still_logged_in?` says whether the page now showing still has the logout button, at once rather than after waiting, so that something moving from page to page can tell when the session has ended, and log in again:
+```ruby
+  my_account.driver.get(url)
+  my_account.login unless my_account.still_logged_in?
+```
+
 ### Overriding the login method to customise logins
 ```ruby
   require 'webaccount'
@@ -174,8 +192,13 @@ Prefer `find` over `driver.find_element`: it waits up to `default_find_timeout`
 
 ## Contributing
 
-1. Fork it: https://github.com/thoran/WebAccount/fork
+1. Fork it: https://github.com/thoran/webaccount/fork
 2. Create your feature branch: `git checkout -b my-new-feature`
 3. Commit your changes: `git commit -am 'Add some feature'`
 4. Push to the branch: `git push origin my-new-feature`
 5. Create a new pull request
+
+
+## License
+
+MIT

data/lib/{WebAccount → webaccount}/VERSION.rb

@@ -2,5 +2,5 @@
 # WebAccount::VERSION
 
 class WebAccount
-  VERSION = '0.4.0'
+  VERSION = '0.6.0'
 end

data/lib/webaccount.rb

@@ -56,6 +56,10 @@ class WebAccount
     driver.quit
   end
 
+  def driver
+    @driver ||= Selenium::WebDriver.for(browser, options: driver_options)
+  end
+
   # predicate methods
 
   def logged_in?
@@ -68,6 +72,10 @@ class WebAccount
     end
   end
 
+  def still_logged_in?
+    @logged_in = driver.element_present?(logout_button_selector.keys.first, logout_button_selector.values.first)
+  end
+
   private
 
   # driver construction
@@ -88,10 +96,6 @@ class WebAccount
     @driver_options || default_driver_options
   end
 
-  def driver
-    @driver ||= Selenium::WebDriver.for(browser, options: driver_options)
-  end
-
   # waiting
 
   # For navigation: a submit, the authentication behind it, and the redirect.

data/test/webaccount_test.rb

@@ -0,0 +1,76 @@
+# test/webaccount_test.rb
+
+# Notes:
+# 1. No browser: Selenium::WebDriver.for is swapped for a stand-in for the length of
+#   each example and put back afterwards, so what is asserted is what WebAccount asks
+#   of Selenium and what it hands back.
+
+require_relative '../lib/webaccount'
+
+require 'minitest/autorun'
+require 'minitest-spec-context'
+
+describe WebAccount do
+  def with_driver_factory(&block)
+    calls = []
+    stand_in = Object.new
+    original = Selenium::WebDriver.method(:for)
+    Selenium::WebDriver.define_singleton_method(:for){|browser, options: nil| calls << [browser, options]; stand_in}
+    block.call(stand_in, calls)
+  ensure
+    Selenium::WebDriver.define_singleton_method(:for, original)
+  end
+
+  describe "#driver" do
+    it "is public, so that the logged-in browser can be driven from outside" do
+      _(WebAccount.public_method_defined?(:driver)).must_equal(true)
+    end
+
+    it "is the browser Selenium made, made once" do
+      with_driver_factory do |stand_in, calls|
+        account = WebAccount.new
+        _(account.driver).must_be_same_as(stand_in)
+        _(account.driver).must_be_same_as(stand_in)
+        _(calls.length).must_equal(1)
+      end
+    end
+
+    it "is made with the browser and driver options given" do
+      with_driver_factory do |stand_in, calls|
+        WebAccount.new(browser: 'Firefox', driver_options: :options).driver
+        _(calls).must_equal([[:firefox, :options]])
+      end
+    end
+  end
+
+  describe "#still_logged_in?" do
+    def account_with_page(logout_button_present)
+      page = Object.new
+      page.define_singleton_method(:element_present?){|how, what| (@asked ||= []) << [how, what]; logout_button_present}
+      page.define_singleton_method(:asked){@asked}
+      account = WebAccount.new(logout_button_selector: {css: '#logout'})
+      account.instance_variable_set(:@driver, page)
+      [account, page]
+    end
+
+    it "is true, and makes logged_in? true, where the page has the logout button" do
+      account, page = account_with_page(true)
+      _(account.still_logged_in?).must_equal(true)
+      _(account.logged_in?).must_equal(true)
+      _(page.asked).must_equal([[:css, '#logout']])
+    end
+
+    it "is false, and makes logged_in? false, where the page has not" do
+      account, _page = account_with_page(false)
+      account.instance_variable_set(:@logged_in, true)
+      _(account.still_logged_in?).must_equal(false)
+      _(account.logged_in?).must_equal(false)
+    end
+
+    it "asks once rather than waiting for the button to appear" do
+      account, page = account_with_page(false)
+      account.still_logged_in?
+      _(page.asked.length).must_equal(1)
+    end
+  end
+end

data/webaccount.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.author = 'thoran'
   spec.email = 'code@thoran.com'
-  spec.homepage = 'http://github.com/thoran/WebAccount'
+  spec.homepage = 'https://github.com/thoran/webaccount'
   spec.license = 'MIT'
 
   spec.require_paths = ['lib']
@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
 
   spec.files = [
     'CHANGELOG',
+    'LICENSE',
     'Gemfile',
     Dir['lib/**/*.rb'],
     'Rakefile',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webaccount
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - thoran
@@ -74,17 +74,19 @@ extra_rdoc_files: []
 files:
 - CHANGELOG
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/Thoran/Selenium.rb
 - lib/Thoran/Selenium/WebDriver/Driver/Attempt/attempt.rb
 - lib/Thoran/Selenium/WebDriver/Driver/ElementPresentQ/element_presentQ.rb
-- lib/WebAccount/VERSION.rb
 - lib/web_account.rb
 - lib/webaccount.rb
+- lib/webaccount/VERSION.rb
 - test/Thoran/Selenium/WebDriver/Driver/Attempt_test.rb
+- test/webaccount_test.rb
 - webaccount.gemspec
-homepage: http://github.com/thoran/WebAccount
+homepage: https://github.com/thoran/webaccount
 licenses:
 - MIT
 metadata: {}
@@ -102,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.22
 specification_version: 4
 summary: An abstract super-class for navigating a web-based user account via Selenium
   WebDriver.