getbox 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fd3ebc4236503a1c6e4a418b5af18fdd8068078
-  data.tar.gz: 34446513ecb4756c4a8910e7f614182f86e4803a
+  metadata.gz: ba395aad4fccc81e34417d3ffa624864f720d881
+  data.tar.gz: 07c6d0877971f2b5a456b1fdef749dbcffb81b6e
 SHA512:
-  metadata.gz: 3f30b2be319c075a6ee85841356470718719c0b39d24a7c53f472b1cee251323bb380ce45402545ec5b49c4056f130ad0f4104cb4b3613237c6437edb431ffc5
-  data.tar.gz: 2242fb1dcff781bf8895555a1100c9a02f6ab94aaa48f1309f2ee4028b88c345e259bfc54336273f2ecf5e871eb187caac7003286811f85b6df0a958bb15261f
+  metadata.gz: 3519966842070571c56e84be6ad35e89a879f09e583c49799ad63c61a319c7563602030a9352e26f769df0a30d693dad17aa1fae7b5bfefde0e1a6a2df70b15d
+  data.tar.gz: 3137e1115833ae6b5d77130bf18ba892d5cae7c6dc82dc29c95270296fd275651314059170f1dcf69b53d6fed01fb8041b2d4e089d03e545f7d0ffd77c9a40a7

data/LICENSE

@@ -0,0 +1,15 @@
+Copyright (c) 2015, Andrew Monks <a@monks.co>
+
+Permission to use, copy, modify, and/or distribute this software for
+any purpose with or without fee is hereby granted, provided that the
+above copyright notice and this permission notice appear in all
+copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
+WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
+OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

data/exe/getbox

@@ -1,8 +1,9 @@
 #!/usr/bin/env ruby
 
+# pretend we're in the lib folder
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'getbox'
 include Getbox
 
-exit prompt
+exit prompt # exit on completion

data/lib/getbox/version.rb

@@ -1,3 +1,3 @@
 module Getbox
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/lib/getbox.rb

@@ -1,24 +1,36 @@
 require 'getbox/version'
-require 'nokogiri'
-require 'capybara/dsl'
-require 'capybara-webkit'
-require 'open-uri'
-require 'json'
-
+require 'nokogiri'          # for parsing html
+require 'capybara/dsl'      # to operate the headless browser
+require 'capybara-webkit'   # the headless browser
+require 'json'              # for pretty json output
 
 module Getbox
-  include Capybara::DSL
 
+  # configure Capybara
+  include Capybara::DSL
   Capybara.default_driver = :webkit
   Capybara.app_host =  "http://app.gistboxapp.com"
   Capybara.run_server = false
 
+  # to use getbox interactively and write output to a file
   def prompt()
+    # people shouldn't feel comfortable typing passwords into things.
+    puts \
+      "I'm about to ask for your github password. \n"\
+      "You should probably read my source code\n"\
+      "before you go through with this...\n"\
+      "https://github.com/amonks/getbox/blob/master/lib/getbox.rb\n\n"\
+      \
+      "are you sure you want to continue?"
+
+    raise "Well, OK then." if gets.chomp.downcase.include? "no"
+
     puts "What's your github username?"
     username = gets.chomp
     puts "How about your password, eh??"
     password = gets.chomp
 
+    # doesn't support anything cool like ~, only a locally relative path
     puts "Where should I save your gists? [gists.json]"
     file = gets.chomp
     file = "gists.json" if file.empty?
@@ -29,27 +41,34 @@ module Getbox
     writeToFile(gists, file)
   end
 
+  # method to go to app.gistboxapp.com, and log in with github credentials
   def getGistsFromSite(username, password)
+    # partly to avoid warnings, and partly to avoid hitting analytics
     whitelist_urls
 
     puts "visiting app.gistboxapp.com"
     visit '/'
-    click_on "Login"
+    click_on "Login"      # redirect to github login page
+
     puts "filling out github login form"
     within("#login") do
       fill_in("login", :with => username)
       fill_in("password", :with => password)
-      click_on "Sign in"
+      click_on "Sign in"  # back to gistbox.app
     end
+
     puts "gathering gists"
     getGistsFromHtml(page.html)
   end
 
+  # convenience wrapper for file.open.
+  # saving gistbox's dashboard html in chrome is faster than fetching it in ruby.
   def getGistsFromFile(file)
     f = File.open(file)
     getGistsFromHtml(f)
   end
 
+  # main function to parse the gist data from gistbox's interface
   def getGistsFromHtml(html)
     doc = Nokogiri::HTML(html)
 
@@ -79,15 +98,17 @@ module Getbox
     gists
   end
 
+  # convenience wrapper for json-and-print
   def writeToFile(object, file)
     json = JSON.pretty_generate(object)
-    File.open(file, 'w') { |file| file.write(json) }
+    File.open(file, 'w') { |f| f.write(json) }
   end
 
+  # set up capybara-webkit's whitelest
   def whitelist_urls()
-    page.driver.block_unknown_urls
+    page.driver.block_unknown_urls  # block tracking and media, disable warnings
     urls = [
-      'app.gistboxapp.com',
+      'app.gistboxapp.com',         # whitelist the servers we need
       'github.com',
     ]
     urls.each { |url| page.driver.allow_url(url) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: getbox
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Andrew Monks
@@ -90,6 +90,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - exe/getbox