frog 1.0.1

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "frog"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/frog

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'frog'
+Frog.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/browser_launcher.rb

@@ -0,0 +1,6 @@
+class BrowserLauncher
+  def launch(target_link)
+    puts "Boom! Launching #{target_link}".green
+    Launchy.open(target_link)
+  end
+end

data/lib/constants.rb

@@ -0,0 +1,5 @@
+module Constants
+  VERSION = "1.0.1"
+  BASE_URL = "https://developer.android.com"
+  LINKS_URL = "https://developer.android.com/reference/lists.js"
+end

data/lib/exact_searcher.rb

@@ -0,0 +1,24 @@
+class ExactSearcher
+  def initialize
+    @exiter = Exiter.new
+  end
+
+  def search (search_term, links)
+    # Grep the links array to exactly match our search term
+    filtered_links = links.grep(/\/#{search_term}.html\"/i)
+
+    # Handle error and return if we don't find anything
+    if filtered_links.empty?
+      @exiter.exit_due_to_doc_not_found
+      return
+    end
+
+    # Get the relative URL of the required class
+    relative_url = filtered_links[0].partition("link:\"").last.partition("\"").first
+
+    # Append to base URL to form complete URL
+    target_link = "#{Constants::BASE_URL}/#{relative_url}"
+
+    return target_link
+  end
+end

data/lib/exiter.rb

@@ -0,0 +1,21 @@
+class Exiter
+  def exit_due_to_no_search_term
+    abort "You need to provide something to search for".red
+  end
+
+  def exit_due_to_doc_not_found
+    abort "Sorry. It looks like we couldn't find what you were looking for".red
+  end
+
+  def exit_due_to_incorrect_index
+    abort "Sorry. It looks like you didn't enter the correct index".red
+  end
+
+  def exit_due_to_net_http_fail_during_links_update
+    exit
+  end
+
+  def exit_after_showing_help
+    exit
+  end
+end

data/lib/frog.rb

@@ -0,0 +1,32 @@
+# Get the project root
+lib = File.expand_path('../../lib', __FILE__)
+
+# Add project root to LOAD_PATH
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+# Require everything in lib so we don't have to require
+# them in each file
+Dir.glob(lib + '/*', &method(:require))
+
+# Require external and third party libs
+require 'optparse'
+require 'launchy'
+require 'time'
+require 'net/http'
+require 'colorize'
+
+module Frog
+  def self.start
+    options = OptionsGetter.new.get_options
+
+    search_term = SearchTermGetter.new.get_search_term
+
+    links = LinksGetter.new.get_links_from_file
+
+    target_link = SearchRouter.new.delegate_to_appropriate_searcher(options[:exact], search_term, links)
+
+    BrowserLauncher.new.launch(target_link)
+
+    LinksUpdater.new.update_links_if_needed
+  end
+end

data/lib/fuzzy_searcher.rb

@@ -0,0 +1,77 @@
+class FuzzySearcher
+  def initialize
+    @exiter = Exiter.new
+  end
+
+  def search (search_term, links)
+
+    # Grep the links array to fuzzily match our search term
+    filtered_links = links.grep(/#{search_term}/i)
+
+    # Error out and return if we don't find anything
+    if filtered_links.empty?
+      @exiter.exit_due_to_doc_not_found
+      return
+    end
+
+    # Create link and index hashes
+    # links_hash will map each class name to it's relative URL
+    # index_hash will match each selection index (that we show the user) to the class name
+    links_hash, index_hash = create_link_and_index_hashes(filtered_links)
+
+    # Show all the selection options to the user
+    show_selection_options(links_hash)
+
+    # Get the user selected index and verify if it's alright
+    index = get_verified_user_input(index_hash.size)
+
+    # Get the relative URL of the required class
+    relative_url = links_hash[index_hash[index]]
+
+    # Append to base URL to form complete URL
+    target_link = "#{Constants::BASE_URL}/#{relative_url}"
+
+    return target_link
+
+  end
+
+  def create_link_and_index_hashes(filtered_links)
+    # Create 2 hashes
+    links_hash = Hash.new
+    index_hash = Hash.new
+
+    filtered_links.each_with_index do |link, i|
+      # Get class name
+      class_name = link.partition("label:\"").last.partition("\"").first
+
+      # Get relative URL
+      class_url = link.partition("link:\"").last.partition("\"").first
+
+      # Map class name to relative URL
+      links_hash[class_name] = class_url
+
+      # Map index to class name
+      index_hash[i] = class_name
+    end
+
+    return links_hash, index_hash
+  end
+
+  def show_selection_options(links_hash)
+    puts "Enter the index of the docs you want. ex: Enter 1 if you wish to select the first option.".green
+    links_hash.keys.each_with_index do |class_name, i|
+      puts "#{i+1}: #{class_name}"
+    end
+  end
+
+  def get_verified_user_input(selection_options_size)
+    index = $stdin.gets.chomp.to_i - 1
+    if index < 0 || index >= selection_options_size
+      @exiter.exit_due_to_incorrect_index
+      return
+    end
+
+    return index
+  end
+
+end

data/lib/links_getter.rb

@@ -0,0 +1,7 @@
+class LinksGetter
+  def get_links_from_file
+    contents = File.read(File.expand_path("../assets/lists.js", File.dirname(__FILE__)))
+
+    return contents.partition("[").last.partition("]").first.split("\n")
+  end
+end

data/lib/links_updater.rb

@@ -0,0 +1,49 @@
+class LinksUpdater
+  attr_reader :timestamp_file_path, :links_file_path
+
+  def initialize
+    @timestamp_file_path = File.expand_path("../assets/last_updated.txt", File.dirname(__FILE__))
+    @links_file_path = File.expand_path("../assets/lists.js", File.dirname(__FILE__))
+  end
+
+  def update_links_if_needed
+    if is_time_to_update?
+      update_links_from_website
+      update_timestamp
+    end
+  end
+
+  private
+  def is_time_to_update?
+    timestamp = File.read(@timestamp_file_path)
+
+    last_updated = DateTime.parse(timestamp)
+
+    one_week_from_last_updated =  last_updated + 7
+
+    return DateTime.now  > one_week_from_last_updated
+  end
+
+  private
+  def update_links_from_website
+    begin
+      # Get the latest links from the website
+      puts "Indexing the latest docs...".green
+      response = Net::HTTP.get_response(URI.parse(Constants::LINKS_URL))
+    rescue StandardError
+      # Exit if links update fails
+      puts "Looks like there's an internet connection problem. Will try again later.".red
+      Exiter.new.exit_due_to_net_http_fail_during_links_update
+      return
+    end
+
+    # Write them to file
+    File.write(@links_file_path, response.body)
+  end
+
+  private
+  def update_timestamp
+    File.write(@timestamp_file_path, "#{DateTime.now}")
+    puts "Latest docs indexed!".green
+  end
+end

data/lib/options_getter.rb

@@ -0,0 +1,23 @@
+class OptionsGetter
+  def initialize
+    @exiter = Exiter.new
+    @options = {exact: false}
+    @options_parser = OptionParser.new do |opts|
+      opts.banner = 'Usage: droiddocs.rb [options] search_term'
+
+      opts.on('-e', '--exact', 'Search for the exact class') do |v|
+        @options[:exact] = true
+      end
+
+      opts.on('-h', '--help', 'Displays Help') do
+        puts opts
+        @exiter.exit_after_showing_help
+      end
+    end
+  end
+
+  def get_options
+    @options_parser.parse!
+    return @options
+  end
+end

data/lib/search_router.rb

@@ -0,0 +1,11 @@
+class SearchRouter
+  def delegate_to_appropriate_searcher(exact, search_term, links)
+    if exact
+      # If it's an exact search
+      ExactSearcher.new.search(search_term, links)
+    else
+      # If it's a fuzzy search
+      FuzzySearcher.new.search(search_term, links)
+    end
+  end
+end

data/lib/search_term_getter.rb

@@ -0,0 +1,12 @@
+class SearchTermGetter
+  def get_search_term
+    search_term = ARGV[0]
+
+    if search_term.nil?
+      Exiter.new.exit_due_to_no_search_term
+      return
+    end
+
+    return search_term
+  end
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: frog
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Anup Cowkur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.9
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.5
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.3
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+description: 
+email:
+- anupcowkur89@gmail.com
+executables:
+- frog
+extensions: []
+extra_rdoc_files: []
+files:
+- assets/last_updated.txt
+- assets/lists.js
+- bin/console
+- bin/frog
+- bin/setup
+- lib/browser_launcher.rb
+- lib/constants.rb
+- lib/exact_searcher.rb
+- lib/exiter.rb
+- lib/frog.rb
+- lib/fuzzy_searcher.rb
+- lib/links_getter.rb
+- lib/links_updater.rb
+- lib/options_getter.rb
+- lib/search_router.rb
+- lib/search_term_getter.rb
+homepage: https://github.com/anupcowkur/frog
+licenses:
+- MIT
+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.6.4
+signing_key: 
+specification_version: 4
+summary: Frog helps you jump to the right Android dev docs from the command line
+test_files: []