wb-bropages 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e411d0f0c328a1b8e76a7c2f69ca039ca146101
+  data.tar.gz: 1b0701504b63f542511399e04cdff4ad91449abf
+SHA512:
+  metadata.gz: a9588213a91a25dddcb7685d656d3a16b53878d967f252751405eb0bd9dcbbe1f1793a8ef7e73ccb5adf74306524cf32f8d3cfd6b231a8201e4451a57993ac71
+  data.tar.gz: 0f7e43045244834f47ec81a785c3ffd27c5d4962f128dd9c60bb1c84c224990070a79c96efb8997862b30e29a9d165455bdc08edc4e7386a4050a55ee8a53c37

data/bin/bro

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+require 'bro'

data/lib/bro/bro_state.rb

@@ -0,0 +1,84 @@
+module Bro
+  class BroState < State
+    COLOR_OFF = "nocolor"
+
+    # true/false if color should be used
+    def check_color
+      state = read_state
+      return state[:color] != COLOR_OFF
+    end
+
+    def get_arg_or_last_command args
+      cmd = args.join(" ")
+      if args.empty?
+        state = read_state
+        cmd = state[:cmd]
+        return nil if state.nil? or cmd.nil?
+        cmd.strip!
+      end
+      cmd
+    end
+
+    def reset_lookup_ids
+      # drop all lookup ids
+      new_state = read_state().delete_if { |k, v| !!(k =~ /\d+/) }
+      write_state(new_state, true)
+    end
+
+    def check_email
+      begin
+        is_invalid_code read_state[:code], read_state[:email]
+      rescue => e
+        prompt_email
+      end
+      { :code => read_state[:code], :email => read_state[:email]}
+    end
+
+    def prompt_email
+      say "Bropages.org requires an email address verification to do this".colored.yellow
+      
+      email = ""
+
+      begin
+        while is_invalid_email email
+          email = ask "What's your email address?".colored.green
+        end
+        begin
+          email_param = CGI.escape(email)
+          res = RestClient.post URL + '/users.json', { :user => { :email => email_param }, :format => 'json', :multipart => true }
+        rescue => e
+          say "There was an error delivering to your email address. Please try again later".colored.yellow.on_red
+          raise e
+        else
+          say "Great! We're sending an email to #{email}".success
+
+          invalid_code = true
+          begin
+            code = ask "Please enter the verification code: "
+            begin
+              is_invalid_code code, email
+              invalid_code = false
+              say "Great! You're verified! FYI, your email and code are stored locally in ~/.bro".success
+              write_state({ :email => email, :code => code })
+            rescue => e
+              say "Woops, there was a problem verifying your email. Please try again".colored.yellow.on_red
+            end
+          end while invalid_code
+        end
+      rescue Interrupt
+        say "Canceled email verification".status
+        raise
+      end
+    end
+
+    def is_invalid_code code, email
+      email_param = CGI.escape(email)
+      res = RestClient.get URL + "/users/verify?code=#{code}&email=#{email_param}"
+    end
+
+    def is_invalid_email email
+      regex = /^[a-zA-Z0-9_.+\-]+@[a-zA-Z0-9\-]+\.[a-zA-Z0-9\-.]+$/
+      email.scan(regex).empty?
+    end
+  end
+end

data/lib/bro/state.rb

@@ -0,0 +1,40 @@
+module Bro
+  class State
+
+    def initialize options
+      @file = options[:file]
+    end
+
+    # write state to this file, using the existing key/vals as defaults
+    # format is key=val;key2=val;key3=val
+    def write_state obj, override=false
+      # read the ~/.bro file and load the settings as defaults
+      # we don't want to lose data if we're not writing over it all
+      read_state.each {|k,v|
+        obj[k] = v if obj[k].nil?
+      } unless override # unless we pass in strict parsing
+
+      # actually serialize the data and write the file
+      File.open(@file, 'w') do |file|
+        data_pairs = obj.collect{ |k,v| "#{k}=#{v}" }
+        file.write data_pairs.join(";") + "\n"
+      end
+    end
+
+    # read the ~/.bro file and return a hash of the values
+    def read_state
+      obj = {}
+      begin
+        contents = File.read @file
+        contents.strip.split(";").each {|kv|
+          chunk = kv.split("=")
+          key = chunk[0].intern
+          obj[key] = chunk[1]
+        }
+      rescue => e
+        # ignore file not found
+      end
+      obj
+    end
+  end
+end

data/lib/bro/string_hacks.rb

@@ -0,0 +1,63 @@
+class FakeColor
+  def initialize(text); @text = text; end
+
+  %w{ red green yellow blue underline }.each do |m|
+    define_method(m){ @text }
+  end
+end
+
+class VanillaText
+  class << self
+    def apply
+      String.class_eval do
+        def colored
+          FakeColor.new self
+        end
+          
+        def unindent 
+          gsub(/^#{scan(/^\s*/).min_by{|l|l.length}}/, "")
+        end
+      end
+
+      %w{ status success problem sorry important underline }.each do |m|
+        String.class_eval do
+          define_method(m){ self }
+        end
+      end
+    end
+  end
+end
+
+class ColoredText
+  class << self 
+    def apply
+      String.class_eval do
+        require 'smart_colored'
+
+        def unindent 
+          gsub(/^#{scan(/^\s*/).min_by{|l|l.length}}/, "")
+        end
+
+        def status
+          self.colored.yellow
+        end
+
+        def success
+          self.colored.green.bold
+        end
+
+        def problem
+          self.colored.yellow_on_red_bold
+        end
+
+        def sorry
+          self.colored.red.bold
+        end
+
+        def important
+          self.colored.magenta
+        end
+      end
+    end
+  end
+end

data/lib/bro/version.rb

@@ -0,0 +1,3 @@
+module Bro
+	VERSION = "1.0.0"
+end

data/lib/bro.rb

@@ -0,0 +1,350 @@
+#!/usr/bin/env ruby
+
+# 1.8.7 support
+unless Kernel.respond_to?(:require_relative)
+  module Kernel
+    def require_relative(path)
+      require File.join(File.dirname(caller[0]), path.to_str)
+    end
+  end
+end
+
+require 'rubygems'
+require 'json'
+require 'commander/import'
+require 'highline'
+require 'rest-client'
+
+require_relative 'bro/state.rb'
+require_relative 'bro/bro_state.rb'
+require_relative 'bro/string_hacks.rb'
+require_relative 'bro/version.rb'
+
+URL = ENV["BROPAGES_URL"] || 'http://bropages.org'
+FILE = ENV["HOME"] + '/.bro'
+RestClient.proxy = ENV['http_proxy']
+
+program :name, 'bro'
+program :version, Bro::VERSION
+program :description, "Highly readable supplement to man pages.\n\nShows simple, concise examples for commands."
+default_command :lookup
+
+state = Bro::BroState.new({:file => FILE})
+
+if state.check_color
+  ColoredText.apply
+else
+  VanillaText.apply
+end
+
+yesblock = lambda { |c|
+  c.syntax = 'bro thanks [COMMAND]'
+  c.summary = 'Upvote an entry, bro'
+  c.description = 'Upvote a bro entry. If called without a COMMAND argument, it will upvote the last thing you looked up with bro'
+  c.example 'Upvote the bro entry for curl', 'bro thanks curl'
+  c.action do |args, options|
+    begin
+      login_details = state.check_email
+    rescue Interrupt, StandardError
+      say "Sorry, you can't do this without email verification".sorry
+    end
+    unless login_details.nil?
+      cmd = state.read_state[:cmd]
+
+      if cmd.nil?
+        say "\nYou must first look up a command before downvoting. For example: bro curl\n\n".sorry
+        return
+      end
+
+      idkey = args[0]
+      if idkey.nil?
+        idkey = "1"
+      end
+      id = state.read_state[idkey.intern]
+
+      if id.nil?
+        say "That index (#{idkey}) does not exist for #{cmd}, try another one".sorry
+      end
+
+      unless id.nil?
+        begin
+          RestClient.get URL + "/thanks/#{id}", { :params => login_details }
+        rescue => e
+          say e.message
+          say "There was a problem thanking the #{cmd} entry. This entry may not exist or bropages.org may be down".problem
+        else
+          say "You just gave thanks to an entry for #{cmd}!".status
+          say "You rock!".success
+        end
+      end
+    end
+  end
+}
+
+command :thanks, &yesblock
+command :ty, &yesblock
+
+noblock = lambda { |c|
+  c.syntax = 'bro ...no [ID]'
+  c.summary = 'Downvote an entry, bro'
+  c.description = 'Downvote a bro entry for the last command you looked up. If called without ID, it will downvote the top entry of the last command you looked up.'
+  c.example 'Downvote the bro entry for curl', "bro curl\n\nbro ...no"
+  c.action do |args, options|
+    begin
+      login_details = state.check_email
+    rescue Interrupt, StandardError
+      say "Sorry, you can't do this without email verification".sorry
+    end
+    unless login_details.nil?
+
+      cmd = state.read_state[:cmd]
+
+      if cmd.nil?
+        say "\nYou must first look up a command before downvoting. For example: bro curl\n\n".sorry
+        return
+      end
+
+      idkey = args[0]
+      if idkey.nil?
+        idkey = "1"
+      end
+      id = state.read_state[idkey.intern]
+
+      if id.nil?
+        say "That id (#{idkey}) does not exist for #{cmd}, try another one".sorry
+      end
+
+      unless id.nil?
+        begin
+          RestClient.get URL + "/no/#{id}", { :params => login_details }
+        rescue => e
+          say "There was a problem downvoting the #{cmd} entry. This entry may not exist or bropages.org may be down".problem
+          say e
+        else
+          say "You just downvoted an entry for #{cmd}".status
+          say "You rock!".success
+        end
+      end
+    end
+  end
+}
+
+command :"...no", &noblock
+command :no, &noblock
+
+command :add do |c|
+  c.syntax = 'bro add [COMMAND] [-m MESSAGE]'
+  c.summary = 'Add an entry, bro'
+  c.description = <<-QQQ.unindent
+  This adds an entry to the http://bropages.org database.
+  
+  Called without parameters will add an entry for the last thing you looked up with bro.
+  QQQ
+  c.example 'Launch your editor to add an entry for curl', 'bro add curl'
+  c.example 'Quickly add an entry for curl', 'bro add curl -m "curl http://google.com"'
+  # TODO c.option '-m', 'An optional inline entry. This won\'t trigger a system editor to open'
+  c.action do |args, options|
+    begin
+      login_details = state.check_email
+    rescue Interrupt, StandardError
+      say "Sorry, you can't do this without email verification".sorry
+    end
+
+    unless login_details.nil?
+
+      cmd = state.get_arg_or_last_command args
+
+      if cmd.nil?
+        say "\nYou must enter a command after #{"bro add".status}.\n\nFor example: #{"bro add".success} #{"curl".success.underline}\n\n"
+      else
+        prompt = <<-QQQ.unindent
+          #~ Bro entry for command '#{cmd}'
+          #~ Provide a useful example for how to use '#{cmd}'
+          #~ Comments starting with #~ are removed
+          #~
+          #~ Example for command 'man':
+          #~ # Opens up the manual page for the command 'ls'
+          #~ man ls
+          
+          
+          # your_comment_here
+          your_command_here
+          QQQ
+        entry = ask_editor prompt
+        if !entry.nil? && entry.gsub(prompt, '').strip.length > 0
+          if agree("Submit this entry for #{cmd}? [y/n] ") { |q| q.default = "yes" }
+            say "All right, sending your entry...".status
+            begin
+              RestClient.post URL + '/', login_details.merge({ :entry => { :cmd => cmd, :msg => entry}, :format => 'json', :multipart => true })
+            rescue => e
+              say e.message
+              file = "/tmp/#{cmd}.bro"
+
+              # increment file name as to not overwrite anything
+              i = 1
+              while File.exist?(file)
+                file = "/tmp/#{cmd}#{i}.bro"
+                i += 1
+              end
+
+              # write message to file
+              File.open(file, 'w') do |f|
+                f.write entry
+              end
+              say "Woops. There was an error! Your entry was saved to #{file}".problem
+            else
+              say "Successfully submitted.".success
+            end
+          end
+        else
+          say "Canceled. Did not submit entry for '#{cmd}'".status
+        end
+      end
+    end
+  end
+end
+
+command :lookup do |c|
+  c.syntax = 'bro [COMMAND]'
+  c.summary = 'Lookup an entry, bro. Or just call bro [COMMAND]'
+  c.description = "This looks up entries in the http://bropages.org database."
+  c.example 'Look up the bro entries for curl', 'bro curl'
+  c.option '--no-color', 'Switch colored output OFF'
+  c.option '--with-color', 'Switch colored output ON'
+  c.action do |args, options|
+    unless options.no_color.nil?
+      # set no-color as default
+      state.write_state({ :color => Bro::BroState::COLOR_OFF })
+      VanillaText.apply
+    end
+    unless options.with_color.nil?
+      # set color as default
+      state.write_state({ :color => "" })
+      ColoredText.apply
+    end
+
+    if args.empty?
+      say <<-QQQ.unindent
+      #{"Bro! Specify a command first!".colored.red}
+      
+      \t* For example try #{"bro curl".colored.green}
+      
+      \t* Use #{"bro help".colored.yellow} for more info
+      
+      QQQ
+    else
+      # the display string for the command
+      cmd_display = args.join(" ")
+
+      # the server argument for the command
+      cmd = args.join("%20")
+
+      state.reset_lookup_ids()
+
+      # write to ~/.bro file with last command
+      state.write_state({ :cmd => cmd_display })
+
+      # connect to webservice for entry
+      error = false
+      begin
+        res = RestClient.get URL + '/' + cmd + '.json'
+      rescue
+        say <<-QQQ.unindent
+        The #{cmd_display.colored.yellow} command isn't in our database.
+        
+        \t* Typing #{"bro add".colored.green.underline} will let you add #{cmd_display.colored.yellow} to our database!
+
+        \t* There's nothing to lose by typing #{"bro add".colored.red.underline}, it will just launch an editor with instructions.
+        
+        \t* Need help? Visit #{"http://bropages.org/help".colored.underline}
+        
+        QQQ
+        error = true
+      end
+
+      unless error
+        enable_paging
+        list = JSON.parse res
+        s = list.length == 1 ? 'y' : 'ies'
+
+        say <<-QQQ.unindent
+        #{"#{list.length} entr#{s} for #{cmd_display}".status.underline} #{"-- submit your own example with \"bro add #{cmd_display}\"".colored.yellow}
+        QQQ
+
+        i = 0
+        list.each {|data|
+            i += 1
+
+            obj = {}
+            obj["#{i}"] = data['id']
+            state.write_state(obj)
+
+            lines = data['msg'].split("\n")
+
+            body = []
+            header_found = false
+            lines.each_with_index {|line, index|
+              line.strip!
+              unless line.length == 0
+                if starts_with_hashtag(line)
+                  if index == 0
+                    line = line_header(line, i)
+                    header_found = true
+                  else
+                    line = line_comment(line)
+                  end
+                else
+                  if contains_query(line, cmd) or starts_with_dollar(line)
+                    line = line_cmd(line, cmd, !starts_with_dollar(line))
+                  else
+                    # Last resort - assume it's a comment
+                    line = line_comment(line)
+                  end
+                end
+              else
+                # Feed a new line
+                line = ""
+              end
+
+              body.push line
+            }
+
+            if !header_found
+              body.unshift line_header("# Untitled", i)
+            end
+
+            puts "\n" + body.join("\n") + "\n"
+        }
+
+      end
+    end
+  end
+end
+
+
+def contains_query(str, query)
+  return str.index query
+end
+
+def starts_with_dollar(str)
+  return /^\s?$/.match(str)
+end
+
+def starts_with_hashtag(str)
+  return /^\s?#/.match(str)
+end
+
+def line_comment(str)
+  return "\t# #{str.sub('#', '')}".colored.green
+end
+
+def line_cmd(str, highlight, prefix=false)
+  if prefix
+    str = "$ #{str}"
+  end
+  return "\t#{str}".gsub highlight, highlight.important
+end
+
+def line_header(str, i)
+  return str.upcase.colored.yellow.sub /#\s?/, "#{i}. "
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: wb-bropages
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- bropages.org
+- williamboman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json_pure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.1.5
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: smart_colored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.20
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.20
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.0
+description: Highly readable supplement to man pages. Shows simple, concise examples
+  for unix commands.
+email: william@redwill.se
+executables:
+- bro
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/bro
+- lib/bro.rb
+- lib/bro/bro_state.rb
+- lib/bro/state.rb
+- lib/bro/string_hacks.rb
+- lib/bro/version.rb
+homepage: https://github.com/williamboman/bro
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Bro. Forked.
+test_files: []