autoup 0.9.3 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 541337e58e6ed6810efd1becb84c0e7c217050c4
-  data.tar.gz: eaebb087b762611d769419ae1c5e602af3d9d9cb
+  metadata.gz: a1d42cb8fd41411c1ab387fb3d0651a0809bc854
+  data.tar.gz: fb6c975c9fd5d10ee68bbb2549848ed88d369bc3
 SHA512:
-  metadata.gz: a030ebaf9fee2e05e2c166c6c3005aabc960276947ce739cc144ea78ef7fe810f9f09670a7eb6fadc4fd97e16b654a63d4ba35bf8417e39db61b67e7e2303497
-  data.tar.gz: ef93ef9f4d747b652d130ec6867ae1aa1511c7a5ef6f7a8a18762f2bd9497d9f5b91dac487214c3594741932b95201b1f098dfd458a6ad3b93fc70ef708c8820
+  metadata.gz: a2d51ff6b73fad5e97faa3f363f4d8f2169d2894d4ff5897b6c8a9400461ed5996c203af4f53fc2a97d138c1487d112d33aec0db70c6812a8eb6df71f6ae930b
+  data.tar.gz: 5fa48c9d75ec5d86c3ba0b53c7880fd80947823ec5fcc208ae96cda8564fd115d0f82e10dbe16ec52fb0440031caf3af7c43ab55697c6829a0eedec78157a92e

data/NOTICE

@@ -0,0 +1,15 @@
+autoup: https://github.com/chillum/autoup
+
+Copyright 2014 Vasily Korytov
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this software except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/bin/autoup

@@ -1,19 +1,5 @@
 #! /usr/bin/env ruby
 
-# Copyright 2014 Vasily Korytov
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 require 'autoup'
 
 AutoUp.new

data/examples/autoup.yml

@@ -1,24 +1,26 @@
 # autoup config: ~/.config/autoup.yml
-# include one or more `forum` items
+# Public domain
 
-# minimal setup
-- forum: 'http://localhost/forum-en/'
-  user: 'username'
-  pass: 'password'
+# Include one or more `forum` items.
 
-# defaults expanded
-- forum: 'http://localhost/forum-en/'
-  user: 'username'
-  pass: 'password'
-  find: 'Find all threads started by'
-  stats: 'Show All Statistics'
-  up: 'Bump the thread!'
+# Minimal setup:
+- forum:   http://localhost/forum-en/
+  user:    username
+  pass:    password
+
+# Defaults expanded:
+- forum:   http://localhost/forum-en/
+  user:    username
+  pass:    password
+  find:    Find all threads started by
+  stats:   Show All Statistics
+  up:      Bump the thread!
   timeout: 5
 
-# Russian board example
-- forum: 'http://localhost/forum-ru/'
-  user: 'username'
-  pass: 'password'
-  find: 'Найти все темы, созданные'
-  stats: 'Показать всю статистику'
-  up: 'Поднять тему!'
+# Russian board example:
+- forum:   http://localhost/forum-ru/
+  user:    username
+  pass:    password
+  find:    Найти все темы, созданные
+  stats:   Показать всю статистику
+  up:      Поднять тему!

data/lib/autoup.rb

@@ -1,17 +1,3 @@
-# Copyright 2014 Vasily Korytov
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 require 'selenium-webdriver'
 require 'yaml'
 
@@ -23,78 +9,99 @@ require 'yaml'
 #
 # Offline copies of README and example config are also included in this gem.
 class AutoUp
-  # Launches AutoUp (specify the config file to override the default)
+  # Read config file and launch AutoUp (specify the config file to override the default).
   def initialize(yml = File.expand_path('~/.config/autoup.yml'))
     begin
       config = YAML.load_file(yml)
     rescue Errno::ENOENT
-      puts('ERROR: no configuration file at `~/.config/autoup.yml`. Example:')
-      puts('https://github.com/chillum/autoup/blob/master/examples/autoup.yml')
+      puts("ERROR: no configuration file at #{yml}. Example:")
+      puts_url
       return
     end
     config.each { |cfg|
-      # Required settings
-      unless cfg['forum']
-        puts('ERROR: `forum` attribute is required')
-        next
-      end
-      unless cfg['user']
-        puts('ERROR: `user` attribute is required')
-        next
-      end
-      unless cfg['pass']
-        puts('ERROR: `pass` attribute is required')
-        next
-      end
-      # Optional settings
-      cfg['timeout'] ||= 5
-      cfg['find']    ||= 'Find all threads started by'
-      cfg['stats']   ||= 'Show All Statistics'
-      cfg['up']      ||= 'Bump the thread!'
+      launch(cfg)
+    }
+  end
 
-      web = Selenium::WebDriver.for :firefox
-      begin
-        web.manage.timeouts.implicit_wait = cfg['timeout']
-        web.get(cfg['forum'])
+  # Launch the AutoUp process.
+  def launch(cfg)
+    # Required settings
+    unless cfg['forum']
+      puts_required('forum')
+      return
+    end
+    unless cfg['user']
+      puts_required('user')
+      return
+    end
+    unless cfg['pass']
+      puts_required('pass')
+      return
+    end
+    # Optional settings
+    cfg['timeout'] ||= 5
+    cfg['find']    ||= 'Find all threads started by'
+    cfg['stats']   ||= 'Show All Statistics'
+    cfg['up']      ||= 'Bump the thread!'
+
+    web = Selenium::WebDriver.for :firefox
+    begin
+      browse(web, cfg)
+    ensure
+      web.quit
+    end
+  end
 
-        begin
-          web.find_element(:name, 'vb_login_username').send_keys(cfg['user'])
-        rescue Selenium::WebDriver::Error::NoSuchElementError
-          puts("ERROR: unable to load #{cfg['forum']} (does not load or does not contain vb_login_username)")
-          next
-        end
+  # Process a forum board.
+  def browse(web, cfg)
+    web.manage.timeouts.implicit_wait = cfg['timeout']
+    web.get(cfg['forum'])
 
-        login = web.find_element(:name, 'vb_login_password')
-        login.send_keys(cfg['pass'])
-        login.submit
+    begin
+      web.find_element(:name, 'vb_login_username').send_keys(cfg['user'])
+    rescue Selenium::WebDriver::Error::NoSuchElementError
+      puts("ERROR: unable to load #{cfg['forum']} (does not load or does not contain vb_login_username)")
+      return
+    end
 
-        begin
-          web.find_element(:link, cfg['user']).click
-        rescue Selenium::WebDriver::Error::NoSuchElementError
-          puts("ERROR: unable to login as #{cfg['user']} on #{cfg['forum']}")
-          next
-        end
+    login = web.find_element(:name, 'vb_login_password')
+    login.send_keys(cfg['pass'])
+    login.submit
 
-        web.find_element(:link, cfg['stats']).click
-        web.find_element(:link, "#{cfg['find']} #{cfg['user']}").click
+    begin
+      web.find_element(:link, cfg['user']).click
+    rescue Selenium::WebDriver::Error::NoSuchElementError
+      puts("ERROR: unable to login as #{cfg['user']} on #{cfg['forum']}")
+      return
+    end
 
-        links = []
-        web.find_elements(:css, 'a[id ^= "thread_title_"]').each { |link|
-          links.push link.attribute('href')
-        }
+    web.find_element(:link, cfg['stats']).click
+    web.find_element(:link, "#{cfg['find']} #{cfg['user']}").click
 
-        links.each { |link|
-          web.get(link)
-          begin
-            web.find_element(:css, "input[value = '#{cfg['up']}']").click
-            puts("UP: #{link}")
-          rescue Selenium::WebDriver::Error::NoSuchElementError
-            puts("SKIP: #{link}")
-          end
-        }
-      ensure
-        web.quit
+    links = []
+    web.find_elements(:css, 'a[id ^= "thread_title_"]').each { |link|
+      links.push link.attribute('href')
+    }
+
+    links.each { |link|
+      web.get(link)
+      begin
+        web.find_element(:css, "input[value = '#{cfg['up']}']").click
+        puts("UP: #{link}")
+      rescue Selenium::WebDriver::Error::NoSuchElementError
+        puts("SKIP: #{link}")
       end
     }
   end
+
+  private
+
+  def puts_required(arg)
+    puts("ERROR: #{arg} attribute is required. Example configuration:")
+    puts_url
+  end
+
+  def puts_url
+    puts('https://github.com/chillum/autoup/blob/master/examples/autoup.yml')
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autoup
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 1.0.1
 platform: ruby
 authors:
 - Vasily Korytov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-09 00:00:00.000000000 Z
+date: 2015-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -32,9 +32,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE.txt
+- NOTICE
 - README.md
-- autoup.gemspec
 - bin/autoup
 - examples/autoup.yml
 - lib/autoup.rb
@@ -58,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Selenium robot for auto-bumping vBulletin posts

data/LICENSE.txt

@@ -1,202 +0,0 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

data/autoup.gemspec

@@ -1,13 +0,0 @@
-Gem::Specification.new do |s|
-  s.name         = 'autoup'
-  s.version      = '0.9.3'
-  s.summary      = 'Selenium robot for auto-bumping vBulletin posts'
-  s.description  = "Logs in onto vBulletin forum boards, finds all user's threads and bumps all the posts"
-  s.homepage     = 'https://github.com/chillum/autoup'
-  s.license      = 'Apache-2.0'
-  s.author       = 'Vasily Korytov'
-  s.email        = 'vasily.korytov@yahoo.com'
-  s.files        = ['LICENSE.txt',  'README.md', 'examples/autoup.yml', 'autoup.gemspec', 'lib/autoup.rb']
-  s.executables  << 'autoup'
-  s.add_dependency 'selenium-webdriver', '~> 2.43'
-end