lgtm_hd 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 690ffa92888775481986a81d37f5283cb85b5736
-  data.tar.gz: 9004f97a6135757b9206b11af5189f6af79c5d8e
+  metadata.gz: c41c2e01a27d7f6c8d8abeb1ab55d879c7301af8
+  data.tar.gz: 8276a44c7526c9fa68f5fbebba7b58b4049b84c8
 SHA512:
-  metadata.gz: 3be3ee8b19592dbcf5be3d03df690a0f24bab103b318ea0953d2c9fa571fe50ed8d03a1536c4141c85ce5b86b115d5a4e646a6a63ca402a4bf36a8a19856464d
-  data.tar.gz: 977302599a8bd739e8e7ee0900a7d19542850ee017e0bae2e41484316642844d690b89498ddcf082869b164780e13964a2ae3a6ad2176246c983cda752e4d508
+  metadata.gz: 6421eb054e6a2872df460ffc5a8b6c3603a8a94faaddef6b6e9ca52beed0e3004e8dd3e75801f3c087d7ba03ccd3c91e7895f89393b9d6e5689863f7e5743350
+  data.tar.gz: a2703a165f8e37526decb537b1f9aa4d89c02dc0f8a89a16a8265ac2cff18cdd810e86d635a640b4097e435a3dcc8effee80e0aa581164d3a8fb64b0347639e1

data/README.md

@@ -23,14 +23,29 @@ Source             |  Happy Taeyeon!
 
 ## Usage
 
-    $ lgtm_hd [transform] <source_uri> <output_folder> [--clipboard] [--interactive]
-    $ lgtm_hd http://domain.com/image.jpg /path/lgtm.jpg 
+    $ lgtm_hd <source_image_uri>
+    $ lgtm_hd random 
 
-
-    --clipboard will let the OS copy content of the file for direct pasting to Github comment box
-    --interactive is for lazy people who can\'t bother to type
+    Options:
+    --clipboard (or -c) will let the OS copy content of the file for direct pasting to Github comment box
+    --interactive (or -i) is for lazy people who can't bother to type
+    --dest DIR (or -d) is for changing output folder
     Default command is transform so you can just leave the command empty.
-
+    
+## Examples
+
+    $ lgtm_hd transform http://nogitweet.com/wp-content/uploads/2015/03/fbf5c1c80ffea521bad6e231061731a5.gif
+    \ Reading and inspecting source at http://nogitweet.com/wp-content/uploads/2015/03/fbf5c1c80ffea521bad6e231061731a5.gif
+    \ Processing Image
+    \ Exporting to file
+    \ Exported LGTM image to /Users/huydq/Desktop/lgtm_hd_20170527124831.gif.
+    
+    $ lgtm_hd random -c -d /tmp/
+    \ Fetching random image from lgtm.in
+    \ Loading image at http://i.imgur.com/mHrrwpY.gif
+    \ Exported image to /tmp/lgtm_hd_20170527124027.gif
+    \ Copied file to OS's clipboard for direct pasting to Github comments or Slack
+    \ Or you can copy the markdown format by lgtm.in directly below
 
 ## Features
 

data/lgtm_hd.gemspec

@@ -11,8 +11,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Huy Dinh"]
   spec.email         = ["phradion@gmail.com"]
 
-  spec.summary       = %q{Generating LGTM image to clipboard.}
-  spec.description   = %q{Generating images from user input with LGTM text on it, or fetching images from LGTM.in based on user's query. Finally put the image to clipboard.}
+  spec.summary       = %q{CLI tool for generating images from user input with LGTM text on it, or fetching images from LGTM.in based on user's query. Finally put the image to clipboard. Support direct image pasting to Github and Slack on MacOSX.}
+  spec.description   = %q{This gem is command-line tool for fetching random image from lgtm.in.
+    It also provide tool to apply LGTM text based on input file/url with smart text colors and positions.
+    It also support direct clipboard paste to github's comment box or Slack on MacOSX.}
   spec.homepage      = "http://github.com/phradion/lgtm_hd"
   spec.license       = "MIT"
 

data/lib/lgtm_hd.rb

@@ -1,5 +1,6 @@
 require "lgtm_hd/version"
 require "lgtm_hd/configuration"
 require "lgtm_hd/utilities"
+require "lgtm_hd/lgtmdotin"
 require "lgtm_hd/meme_generator"
 require "lgtm_hd/cli"

data/lib/lgtm_hd/cli.rb

@@ -8,84 +8,152 @@ module LgtmHD
   class CLI
     include Commander::Methods
 
+    CMD_RANDOM_SYNTAX = 'lgtm_hd random [-i | --interactive] [-d | --dest DIR]'.freeze
+    CMD_TRANSFORM_SYNTAX = 'lgtm_hd <URI|FILE> [-i | --interactive] [-d | --dest <DIR>]'.freeze
+
     def run
       program :name, LgtmHD::Configuration::PROGRAM_NAME
       program :version, LgtmHD::VERSION
       program :description, LgtmHD::Configuration::DESCRIPTION
+
       default_command :transform
+      global_option '-i', '--interactive', 'Turn on interactive Mode. In case you forgot all these super complexive args and options' do say "-- LGTM HD Interactive Mode --" end
+      global_option '-d', '--dest DIR', String, 'Directory to export the LGTM image to. Default value is user\'s current working directory'
 
-      command :transform do |c|
-        c.syntax = 'lgtm_hd <source_uri> <output_path> [--clipboard] [--interactive]'
-        c.summary = 'Generate a LGTM image from source_uri (local path or URL) into output folder'
+      command :random do |c|
+        c.syntax = CMD_RANDOM_SYNTAX
+        c.summary = 'Fetch random images from LGTM.in'
         c.description = ''
-        c.example '', 'lgtm_hd export http://domain.com/image.png /path/to/lgtm.png'
-        c.option '--clipboard', 'Copy the end result (LGTM image) to OS\'s clipboard'
-        c.option '--interactive', 'In case you forgot all these super complexive args and options'
+        c.example 'Example', 'lgtm_hd random'
 
         c.action do |args, options|
-          to_clipboard = options.clipboard
+          if options.interactive  # Interactive mode!
+            options.dest ||= ask('Destination Directory (Enter to skip): ')
+          end
+          dest_dir = CLI.destination_dir(options.dest)
+          dest_file_prefix = CLI.destination_file_prefix
+          check_uris(dest_dir)
+
+          say_step "Fetching from lgtm.in"
+          dest_uri,image_markdown = LgtmDotIn.fetch_random_image(dest_dir,dest_file_prefix) do |url, markdown|
+            say_step "Loading image at #{url}"
+          end
 
+          say_ok "Exported image to #{dest_uri}"
+          copy_file_to_clipboard(dest_uri)
+          say "\nOr you can copy the markdown format below provided by lgtm.in"
+          say_code_block "#{image_markdown}"
+          say "\nIf the image does not have LGTM texts on it, run the cmd below"
+          say_code_block "lgtm_hd #{dest_uri}"
+        end
+      end
+
+      command :transform do |c|
+        c.syntax = CMD_TRANSFORM_SYNTAX
+        c.summary = 'Generate LGTM text on top of image URL or local image File'
+        c.description = 'The command \e[3mtransform\e[0m is the default command hence you can skip typing it instead'
+        c.example 'Example', 'lgtm_hd http://domain.com/image.png'
+
+        c.action do |args, options|
           # ARGS validation!
-          if args.length == 2
-              source_uri = args[0]
-              output_uri = args[1]
+          if args.length >= 1
+            source_uri = args[0]
           elsif options.interactive  # Interactive mode!
-            say "-- LGTM Interactive mode --"
-            source_uri = ask('Source (URL or Path/to/file): ')
-            output_uri = ask('Output Folder: ')
-            to_clipboard = agree("Copy to clipboard afterward? [Y/N]")
+            source_uri ||= ask(' Source Image (URL or Path/to/file): ')
+            options.dest ||= ask('Destination Directory (Enter to skip): ')
           else
-            say "usage: lgtm_hd <source_uri> <output_path> [--clipboard] [--interactive]"
-            raise ArgumentError, "Too few or too many arguments provided, need 2: source and output URIs"
+            # Since this is the default command so we will provide a little extra care for first-time user
+            help_the_noobie
           end
 
-
           # Validate the inputs
-          output_folder = File.expand_path(output_uri)
-          output_file = File.join(output_folder,
-                                  LgtmHD::Configuration::OUTPUT_PREFIX +
-                                  Time.now.strftime('%Y-%m-%d_%H-%M-%S') +
-                                  File.extname(source_uri))
-          raise "Source is not proper URIs (URL or Path/to/file)" unless source_uri =~ URI::regexp || File.exist?(source_uri)
-          raise "Output is invalid path or directory" unless File.exist?(output_folder) && File.directory?(output_folder)
-
-
+          dest_dir = CLI.destination_dir(options.dest)
+          check_uris(dest_dir, source_uri)
+          dest_file = File.join(dest_dir, CLI.destination_file_prefix + File.extname(source_uri))
 
           # Do stuff with our LGTM meme
-          say "- Reading and inspecting source"
-          meme_generator = MemeGenerator.new(input_image_uri:source_uri, output_image_uri:output_file)
-          say "- Rendering output"
+          say_step "Reading and inspecting source at #{source_uri}"
+          meme_generator = MemeGenerator.new(input_image_uri:source_uri, output_image_uri:dest_file)
+          say_step "Transforming Image"
           meme_generator.draw
 
           # Export and play around with the clipboard
-          say "- exporting to file"
+          say_step "Exporting to file"
           meme_generator.export do |output|
-            say "LGTM image has been generated at #{output}."
-            if to_clipboard then
-              if OS.mac? then
-                applescript "set the clipboard to (read (POSIX file \"#{output}\") as GIF picture)"
-                say "I see you are using MacOSX. Content of the file has been copied to your clipboard."
-
-                # Apple Script Command reference
-                # Sample: `osascript -e 'set the clipboard to (read (POSIX file "#{output}") as JPEG picture)'`
-                #
-                # Currently Github allow pasting image directly to comment box.
-                # However it does not support pure text content produced by pbcopy so we have to use direct Applescript
-                # No Universal solution as for now.
-                #
-                # Apple Script reference: http://www.macosxautomation.com/applescript/imageevents/08.html
-              else
-                Clipboard.copy(output)
-                say "Path to LGTM file has been copied to your clipboard."
-              end
-            end # end of if to_clipboard
+            say_ok "Exported LGTM image to #{output}."
+            copy_file_to_clipboard(dest_file)
           end # end of meme_generator.export block
+        end # end of action
+      end # end of command transform
 
-        end
+      run!
+    end # end run def
+
+    def help_the_noobie
+      say "To add LGTM text:"
+      say_code_block CLI::CMD_TRANSFORM_SYNTAX
+      say "To fetch LGTM text:"
+      say_code_block CLI::CMD_RANDOM_SYNTAX
+      say "More Help:"
+      say_code_block "lgtm_hd --help"
+      say "\nVisit #{LgtmHD::Configuration::MORE_HELP_URL} for development purpose or more examples"
+      exit
+    end
 
+
+    private
+
+    def copy_file_to_clipboard(output_file)
+      if OS.mac? then
+        applescript "set the clipboard to (read (POSIX file \"#{output_file}\") as GIF picture)"
+        say_ok "Copied file to OS's clipboard for direct pasting to Github comments or Slack"
+
+        # Apple Script Command reference
+        # Sample: `osascript -e 'set the clipboard to (read (POSIX file "#{output}") as JPEG picture)'`
+        #
+        # Currently Github allow pasting image directly to comment box.
+        # However it does not support pure text content produced by pbcopy so we have to use direct Applescript
+        # No Universal solution as for now.
+        #
+        # Apple Script reference: http://www.macosxautomation.com/applescript/imageevents/08.html
+      else
+        Clipboard.copy(output_file)
+        say_ok "Copied file's path to OS's clipboard"
       end
+    end
 
-      run!
+    def say_step(*args)
+      args.each do |arg|
+        say $terminal.color(arg, :magenta)
+      end
+    end
+
+    def say_code_block(*args)
+      args.each do |arg|
+        say $terminal.color("#{arg}", :black, :on_white)
+      end
     end
-  end
-end
+
+    def check_uris(dest_dir, source_uri = nil)
+      begin
+        raise ArgumentError, "Destination path for exporting image is invalid" unless File.exist?(dest_dir) && File.directory?(dest_dir)
+        if !!source_uri
+          raise ArgumentError, "Source image is neither proper URL nor FILE" unless source_uri =~ URI::regexp || File.exist?(source_uri)
+        end
+      rescue ArgumentError => e
+        say_error e.message
+        exit
+      end
+    end
+
+    def self.destination_dir(dest_dir)
+      dest_dir ||= Dir.pwd
+      File.expand_path(dest_dir)
+    end
+
+    def self.destination_file_prefix
+      LgtmHD::Configuration::OUTPUT_PREFIX + Time.now.strftime('%Y%m%d%H%M%S')
+    end
+
+  end # end of Class
+end # end of Module

data/lib/lgtm_hd/configuration.rb

@@ -2,17 +2,21 @@ module LgtmHD
   module Configuration
     # Program configurations
     PROGRAM_NAME          = "lgtm_hd".freeze
-    DESCRIPTION           = "Generating images from user input with LGTM text on it, or fetching images from LGTM.in based on user's query. Finally put the image to clipboard.".freeze
-
+    AUTHOR                = "Huy Dinh <phradion@gmail.com>".freeze
+    DESCRIPTION           = "Generating images from user input with LGTM text on it,"\
+                            "or fetching images from LGTM.in based on user's query.\n"\
+                            "Finally put the image to clipboard.".freeze
+    MORE_HELP_URL         = "https://github.com/phradion/lgtm_hd".freeze
+    
     # Output Image configurations
     OUTPUT_PREFIX         = "lgtm_hd_".freeze
-    OUTPUT_MAX_WIDTH      = 500.freeze
-    OUTPUT_MAX_HEIGHT     = 500.freeze
-    OUTPUT_DENSITY        = 90.freeze # or 120 point per inch
+    OUTPUT_MAX_WIDTH      = 500
+    OUTPUT_MAX_HEIGHT     = 500
+    OUTPUT_DENSITY        = 90 # or 120 point per inch
 
     # Caption configurations
     FONT_PATH                   = "/fonts/impact.ttf".freeze
-    CAPTION_FONT_SIZE_DEFAULT   = 96.freeze
+    CAPTION_FONT_SIZE_DEFAULT   = 96
 
   end
 end

data/lib/lgtm_hd/lgtmdotin.rb

@@ -0,0 +1,57 @@
+require 'resolv-replace'
+require 'open-uri'
+
+module LgtmHD
+  class LgtmDotIn
+    API_STARTING_ENDPOINT     = "http://www.lgtm.in/g".freeze
+    ACTUAL_IMAGE_URL_USE_SSL  = false
+    TRY_FETCHING_IMAGE_LIMIT  = 3 # I have hit lgtm.in with bad content 5 times in a row
+    TRY_FETCHING_META_LIMIT   = 3 # God know how many more redirect lgtm.in will use in the future
+
+    def self.fetch_random_image(dest_path = nil, file_prefix = nil)
+      # LGTM.in has so many broken images
+      # So we loop until a good image is found
+      limit = TRY_FETCHING_IMAGE_LIMIT
+      begin
+        json_data = fetch_meta_data
+        image_url = json_data["actualImageUrl"]
+        image_markdown = json_data["markdown"].lines.first.strip
+        yield image_url, image_markdown
+
+        # fetching image data
+        dest_file = File.join(dest_path ||= '/tmp', (file_prefix ||= 'lgtmdotin_') + File.extname(image_url))
+        uri = URI.parse(image_url)
+
+        uri.open(redirect: false, ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE) do |input_stream|
+          File.open(dest_file, 'wb') do |output_stream|
+            IO.copy_stream(input_stream, output_stream)
+          end
+        end
+        [dest_file, image_markdown]
+      rescue OpenURI::HTTPError, SocketError, Net::ReadTimeout => error
+        retry if (limit -= 1) > 0
+        raise error, "We have tried 3 times but all images are broken. Either LGTM.in is trash or you are super unlucky"
+      end
+    end
+
+
+    private
+    def self.fetch_meta_data(uri = API_STARTING_ENDPOINT, limit = TRY_FETCHING_META_LIMIT)
+      uri = URI.parse(API_STARTING_ENDPOINT)
+      ##
+      # LGTM.in has a JSON endpoint that
+      # .forwards to an SSL HTTP address that
+      # .has no valid SSL certificate
+      # Hence the loop
+      #
+      begin
+        data = uri.open('Accept' => 'application/json', redirect: false, ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE)
+        json = JSON.parse data.readlines.join("")
+      rescue OpenURI::HTTPRedirect => redirect
+        uri = redirect.uri # assigned from the "Location" response header
+        retry if (limit -= 1) > 0
+        raise IOError, "There maybe a network issue. The program failed to contact LGTM.in JSON API"
+      end
+    end
+  end
+end

data/lib/lgtm_hd/meme_generator.rb

@@ -2,7 +2,8 @@ require "mini_magick"
 
 module LgtmHD
   class MemeGenerator
-
+    @@caption_positions = {caption_position_top: "north center", caption_position_bottom: "south center"}
+    
     # TODO make options list for this class
     # TODO pass BLOB data into this class instead of paths
     def initialize(input_image_uri:, output_image_uri:)
@@ -54,11 +55,8 @@ module LgtmHD
     # Default value is top
     #
     def caption_position
-      if not [:caption_position_top, :caption_position_bottom].include? (@caption_position)
-        @caption_position = :caption_position_bottom
-      end
-      return {:caption_position_top => "north center",
-              :caption_position_bottom => "south center"}[@caption_position]
+      @caption_position = :caption_position_bottom unless [:caption_position_top, :caption_position_bottom].include? @caption_position
+      @@caption_positions[@caption_position]
     end
 
     def caption_font

data/lib/lgtm_hd/utilities.rb

@@ -1,3 +1,6 @@
+require 'open-uri'
+require 'net/http'
+
 module LgtmHD
   def self.gem_root
     File.expand_path '../../..', __FILE__

data/lib/lgtm_hd/version.rb

@@ -1,3 +1,3 @@
 module LgtmHD
-  VERSION         = "0.1.4".freeze
+  VERSION         = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lgtm_hd
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Huy Dinh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-26 00:00:00.000000000 Z
+date: 2017-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,8 +136,10 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 4.7.0
-description: Generating images from user input with LGTM text on it, or fetching images
-  from LGTM.in based on user's query. Finally put the image to clipboard.
+description: |-
+  This gem is command-line tool for fetching random image from lgtm.in.
+      It also provide tool to apply LGTM text based on input file/url with smart text colors and positions.
+      It also support direct clipboard paste to github's comment box or Slack on MacOSX.
 email:
 - phradion@gmail.com
 executables:
@@ -162,6 +164,7 @@ files:
 - lib/lgtm_hd.rb
 - lib/lgtm_hd/cli.rb
 - lib/lgtm_hd/configuration.rb
+- lib/lgtm_hd/lgtmdotin.rb
 - lib/lgtm_hd/meme_generator.rb
 - lib/lgtm_hd/utilities.rb
 - lib/lgtm_hd/version.rb
@@ -185,8 +188,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: Generating LGTM image to clipboard.
+summary: CLI tool for generating images from user input with LGTM text on it, or fetching
+  images from LGTM.in based on user's query. Finally put the image to clipboard. Support
+  direct image pasting to Github and Slack on MacOSX.
 test_files: []