hintme 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a49a674b3a187d6bb9f8007074d60efd854cffe6
-  data.tar.gz: f5e0507426b7833e2276e6f469c336ac468c5a7f
+  metadata.gz: da1266243ffffddb17e42321392746cf5e67bfb1
+  data.tar.gz: ea29387d3e21e8157e0811f3e37fd4a8e70e5703
 SHA512:
-  metadata.gz: 6c445799017c6b1f471a11a7cba0e06170aec268f7821e31389625e8edca719878b1fab9e9acc3b6705b9711d80ee4cd1c57135f8cc4669b6f82ad7f6a23dc51
-  data.tar.gz: ae29633b53eba1010b52e50314c7573ab8c8c9f616882f42c5e73fd8d35f42493c9447ba2a4df6123a820c10d38912be99449dd816b281395cbee444d9c46258
+  metadata.gz: 3116a7b1bd76f8ded3728c962c121c4b33e44d9b599227afe482f283aa150500bfa2c240cb8fd6d7c21ec5a52682821454e7c4f4b8cb6798c846900e64974986
+  data.tar.gz: 9f2b82f4d70be720ddfd9f2980777c1f1bb81817f33134c45d5acbb1f2811a7254e021d1ceec2ab601a42ce72d5028c1d404370f82e75c37ceced0661d16b154

data/README.md

@@ -1,25 +1,22 @@
 # Hintme
-
+The stupid, simple [Devhints.io](http://devhints.io/) CLI
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Ensure you've installed ruby (If you're using OS X/macOS you should be fine)
 
-```ruby
-gem 'hintme'
-```
+install hintme onto your system
 
-And then execute:
+    $ gem install hintme
 
-    $ bundle
 
-Or install it yourself as:
+Ask for hints:
 
-    $ gem install hintme
+    $ hintme rails
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hintme.
+Bug reports and pull requests are welcome on GitHub at https://github.com/jcambass/hintme
 
 ## License
 

data/lib/hintme.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 require 'hintme/version'
-require 'hintme/api/client'
-require 'hintme/markdown_printer'
+require 'hintme/hinter'
 
+# HintMe Gem toplevel module
 module HintMe
+  # searches an prints a cheatsheet for a given
+  # topic to the console
+  #
+  # @param topic [String]
+  #
   def self.hint(topic)
-    markdown = API::Client.new.fetch_topic(topic)
-    if markdown
-      MarkdownPrinter.new.print(markdown)
-    else
-      puts ":( There isn't a cheatsheet for #{topic}. Maybe you should request one at devhints.io"
-    end
+    Hinter.new.hint(topic)
   end
 end

data/lib/hintme/api/client.rb

@@ -1,28 +1,67 @@
+# frozen_string_literal: true
+
 require 'uri'
 require 'net/http'
 require 'net/https'
 
 module HintMe
   module API
+    # Client for the DevHints API
     class Client
+      # Base URL for the DevHints cheatsheets github repository
       RAW_REPO_URL = 'https://raw.githubusercontent.com/rstacruz/cheatsheets/master/'
 
-      def fetch_topic(topic)
-        uri = topic_url(topic)
+      # searches and downloads the raw markdown representation of cheatsheet
+      #
+      # @param topic [String] topic to fetch cheatsheet for
+      #
+      def search_cheatsheet_for_topic(topic)
+        download_cheatsheet(topic) if cheatsheet_exists?(topic)
+      end
+
+      private
+
+      # checks if a cheatsheet for a certain topic exists
+      #
+      # @param topic [String]
+      # @return [true, false]
+      #
+      def cheatsheet_exists?(topic)
+        url = build_topic_url(topic)
+        response = Net::HTTP.get_response(url)
 
-        case Net::HTTP.get_response(uri)
-        when Net::HTTPSuccess then Net::HTTP.get(uri).force_encoding('utf-8')
-        when Net::HTTPNotFound then nil
+        case response
+        when Net::HTTPSuccess then true
+        when Net::HTTPNotFound then false
         else
-          response.value
+          handle_invalid_response(response)
         end
       end
 
-      private
+      # downloads a cheatsheet for a given topic
+      #
+      # @param topic [String]
+      # @return [String, nil] downloaded cheatsheet
+      #
+      def download_cheatsheet(topic)
+        url = build_topic_url(topic)
+        Net::HTTP.get(url)
+                 .force_encoding('utf-8')
+      end
 
-      def topic_url(topic)
+      # builds the full repository url for a specific cheatsheet
+      #
+      # @param topic [String] topic for which the full cheatsheet url
+      # should be build
+      #
+      def build_topic_url(topic)
         URI("#{RAW_REPO_URL}#{topic}.md")
       end
+
+      def handle_invalid_response(response)
+        raise StandartError, 'An network error occured.' \
+          "Error response: #{response.value}"
+      end
     end
   end
 end

data/lib/hintme/cheatsheet/printer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'tty/markdown'
+
+module HintMe
+  module Cheatsheet
+    # prints a cheatsheet to the console
+    class Printer
+      # prints the content of a cheatsheet on the console
+      #
+      # @param cheatsheet [String]
+      #
+      def print(cheatsheet)
+        puts ::TTY::Markdown.parse(cheatsheet)
+      end
+    end
+  end
+end

data/lib/hintme/hinter.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative 'api/client'
+require_relative 'cheatsheet/printer'
+
+module HintMe
+  # entry point for all HintMe functionality
+  class Hinter
+    # creates a new {Hinter} instance
+    #
+    def initialize
+      @api_client = API::Client.new
+      @cheatsheet_printer = Cheatsheet::Printer.new
+    end
+
+    # searches and prints a cheatsheet for a given topic
+    # to the console
+    #
+    # if no cheatsheet is found for the given topic
+    # a error message will be printed to the console
+    #
+    # @param topic [String]
+    #
+    def hint(topic)
+      cheatsheet = cheatsheet_for_topic(topic)
+
+      if cheatsheet
+        print_cheatsheet(cheatsheet)
+      else
+        display_missing_cheatsheet_error(topic)
+      end
+    end
+
+    private
+
+    # fetches the cheatsheet for a topic
+    #
+    # @param topic [String]
+    # @return [String]
+    #
+    def cheatsheet_for_topic(topic)
+      @api_client.search_cheatsheet_for_topic(topic)
+    end
+
+    # prints a cheatsheet to the console
+    #
+    # @param cheatsheet [String]
+    #
+    def print_cheatsheet(cheatsheet)
+      @cheatsheet_printer.print(cheatsheet)
+    end
+
+    # displays a error message informing the user about
+    # the missing cheatsheet to the console
+    #
+    def display_missing_cheatsheet_error(topic)
+      topic ||= 'escaping the void of notopic-island'
+
+      puts ":( There isn't a cheatsheet for #{topic}." \
+           ' Maybe you should request one at devhints.io'
+    end
+  end
+end

data/lib/hintme/version.rb

@@ -1,3 +1,3 @@
 module HintMe
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hintme
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Joel Ambass
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-03 00:00:00.000000000 Z
+date: 2018-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,7 +88,8 @@ files:
 - hintme.gemspec
 - lib/hintme.rb
 - lib/hintme/api/client.rb
-- lib/hintme/markdown_printer.rb
+- lib/hintme/cheatsheet/printer.rb
+- lib/hintme/hinter.rb
 - lib/hintme/version.rb
 homepage: https://github.com/jcambass/hintme
 licenses:

data/lib/hintme/markdown_printer.rb

@@ -1,10 +0,0 @@
-require 'tty/markdown'
-
-module HintMe
-  class MarkdownPrinter
-
-    def print(markdown)
-      puts ::TTY::Markdown.parse(markdown)
-    end
-  end
-end