onebox 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b5e72349ed5dcca5148875d8e669b3850de0311
-  data.tar.gz: b1d032a771038719f1c51064fee5942c50f94353
+  metadata.gz: 2d45ecfeb440c52d2c6d45aaec72669ad24f170b
+  data.tar.gz: 84c5f37f871a0e5a792f179d6d4983bc9c588e52
 SHA512:
-  metadata.gz: cd575f2a3a215a63a5c9359e788cb5c3740b8b7b1d53ad59cbdf9db2e120fc63c95e6c96432f11b38f5dbd8d9a7fff41ce722fe51c70e3843bbad2b5362be229
-  data.tar.gz: 6cb0cc9aef0081ba65b35221261492b44cf6ca161161d50044c1c108d7732a4f9c840867907d8ca1d9ea308430378cfe5f45909a82a31461fd0939ac85399d96
+  metadata.gz: 9cc1a432d53eaa94625f3dcea777e8cfb3247770334ced74b91295832bffed4fdc584c33f4c786a954ced16ba1f7010d6799c5cc29232748f29c1a69e6972063
+  data.tar.gz: 2ce5bae6fa88b77fa5f9e6a2dd1f0c6395836e51bea065dff2c62b4e79ea1329c8b4e7319a4e436a63427c4d793d8b8c1b034f52f085d9ad33f36892113c1047

data/lib/onebox/engine.rb

@@ -13,8 +13,29 @@ module Onebox
     attr_reader :url
     attr_reader :cache
     attr_reader :timeout
+    
+    DEFUALT = {}
+    def options
+      @options
+    end
+    
+    def options=(opt)
+      return @options if opt.nil? #make sure options provided
+      if opt.instance_of? OpenStruct
+        @options = @options.merge(opt.to_h)   
+      else
+       @options =  @options.merge(opt)
+      end
+      @options
+    end
+    
 
     def initialize(link, cache = nil, timeout = nil)
+      
+      @options = DEFUALT
+      class_name = self.class.name.split("::").last.to_s
+      self.options = Onebox.options[class_name] || {} #Set the engine options extracted from global options.
+      
       @url = link
       @cache = cache || Onebox.options.cache
       @timeout = timeout || Onebox.options.timeout
@@ -41,8 +62,9 @@ module Onebox
     private
 
     def record
-      result = cache.fetch(url) { data }
-      cache[url] = result if cache.respond_to?(:key?)
+      url_result = url
+      result = cache.fetch(url_result) { data }
+      cache[url_result] = result if cache.respond_to?(:key?)
       result
     end
 
@@ -101,6 +123,7 @@ require_relative "engine/html"
 require_relative "engine/json"
 require_relative "engine/amazon_onebox"
 require_relative "engine/classic_google_maps_onebox"
+require_relative "engine/github_issue_onebox"
 require_relative "engine/github_blob_onebox"
 require_relative "engine/github_commit_onebox"
 # broken

data/lib/onebox/engine/github_blob_onebox.rb

@@ -4,40 +4,189 @@ module Onebox
       include Engine
       include LayoutSupport
 
-      MAX_LINES = 20
-      MAX_CHARS = 5000
-
+      EXPAND_AFTER = 0b001 
+      EXPAND_BEFORE = 0b010
+      EXPAND_NONE = 0b0
+      
+      DEFAULTS = {
+              :EXPAND_ONE_LINER => EXPAND_AFTER|EXPAND_BEFORE, #set how to expand a one liner. user EXPAND_NONE to disable expand
+              :LINES_BEFORE => 10,
+              :LINES_AFTER => 10,
+              :SHOW_LINE_NUMBER => true,
+              :MAX_LINES => 20,
+              :MAX_CHARS => 5000
+      }
+      
       matches_regexp(/^https?:\/\/(www\.)?github\.com.*\/blob\//)
 
+
+
+      def initialize(link, cache = nil, timeout = nil)
+        super link, cache , timeout
+        #merge engine options from global Onebox.options interface
+        # self.options = Onebox.options["GithubBlobOnebox"] #  self.class.name.split("::").last.to_s
+        # self.options = Onebox.options[self.class.name.split("::").last.to_s] #We can use this a more generic approach. extract the engine class name automatically 
+        
+        self.options = DEFAULTS
+
+        # Define constant after merging options set in Onebox.options
+        # We can define constant automatically. 
+        options.each_pair {|constant_name,value|
+          constant_name_u = constant_name.to_s.upcase
+              if constant_name_u == constant_name.to_s
+                #define a constant if not already defined
+                self.class.const_set  constant_name_u.to_sym , options[constant_name_u.to_sym]  unless self.class.const_defined? constant_name_u.to_sym
+              end
+        }
+      end
+
       private
+      @selected_lines_array  = nil
+      @selected_one_liner = 0
+      def calc_range(m,contents_lines_size)
+        #author Lidlanca  09/15/2014
+        truncated = false
+        from = /\d+/.match(m[:from])             #get numeric should only match a positive interger
+        to   = /\d+/.match(m[:to])               #get numeric should only match a positive interger
+        range_provided = !(from.nil? && to.nil?) #true if "from" or "to" provided in URL
+        from = from.nil? ?  1 : from[0].to_i     #if from not provided default to 1st line
+        to   = to.nil?   ? -1 : to[0].to_i       #if to not provided default to undefiend to be handled later in the logic
+        
+        if to === -1 && range_provided   #case "from" exists but no valid "to". aka ONE_LINER
+          one_liner = true
+          to = from
+        else
+          one_liner = false
+        end
+
+        unless range_provided  #case no range provided default to 1..MAX_LINES
+          from = 1 
+          to   = MAX_LINES
+          truncated = true if contents_lines_size > MAX_LINES
+          #we can technically return here
+        end
+
+        from, to = [from,to].sort                                #enforce valid range.  [from < to]
+        from = 1 if from > contents_lines_size                   #if "from" out of TOP bound set to 1st line
+        to   = contents_lines_size if to > contents_lines_size   #if "to" is out of TOP bound set to last line.
+        
+        if one_liner
+          @selected_one_liner = from
+          if EXPAND_ONE_LINER != EXPAND_NONE
+            if (EXPAND_ONE_LINER & EXPAND_BEFORE != 0) # check if EXPAND_BEFORE flag is on
+              from = [1, from - LINES_BEFORE].max      # make sure expand before does not go out of bound
+            end
+
+            if (EXPAND_ONE_LINER & EXPAND_AFTER != 0)          # check if EXPAND_FLAG flag is on
+              to = [to + LINES_AFTER, contents_lines_size].min # make sure expand after does not go out of bound
+            end
+
+            from = contents_lines_size if from > contents_lines_size   #if "from" is out of the content top bound 
+            # to   = contents_lines_size if to > contents_lines_size   #if "to" is out of  the content top bound
+          else
+            #no expand show the one liner solely 
+          end
+        end
+        
+        if to-from > MAX_LINES && !one_liner  #if exceed the MAX_LINES limit correct unless range was produced by one_liner which it expand setting will allow exceeding the line limit
+          truncated = true
+         to = from + MAX_LINES-1  
+        end
+
+        {:from               => from,                 #calculated from
+         :from_minus_one    => from-1,                #used for getting currect ol>li numbering with css used in template
+         :to                 => to,                   #calculated to
+         :one_liner          => one_liner,            #boolean if a one-liner
+         :selected_one_liner => @selected_one_liner,  #if a one liner is provided we create a reference for it.
+         :range_provided     => range_provided,       #boolean if range provided 
+         :truncated          => truncated}
+      end
+
+      #minimize/compact leading indentation while preserving overall indentation 
+      def removeLeadingIndentation  str
+        #author Lidlanca 2014
+        min_space=100
+        a_lines = str.lines
+        a_lines.each {|l|
+          l = l.chomp("\n")  # remove new line 
+          m = l.match /^[ ]*/ # find leading spaces 0 or more
+          unless m.nil? || l.size==m[0].size || m[0].size==0 # no match | only spaces in line | empty line
+            m_str_length  = m[0].size
+            if m_str_length <= 1  # minimum space is 1 or nothing we can break we found our minimum
+              min_space = m_str_length
+              break #stop iteration
+            end 
+            if m_str_length < min_space
+              min_space = m_str_length
+            end 
+          else
+            next # SKIP no match or line is only spaces
+          end 
+        }
+        a_lines.each {|l|
+          re = Regexp.new "^[ ]{#{min_space}}"  #match the minimum spaces of the line
+          l.gsub!(re, "")
+        }
+        a_lines.join
+      end
+
+      def line_number_helper(lines,start,selected) 
+        #author Lidlanca  09/15/2014
+        lines = removeLeadingIndentation(lines.join).lines # A little ineffeicent we could modify  removeLeadingIndentation to accept array and return array, but for now it is only working with a string
+        hash_builder =[]
+        output_builder = []
+        lines.map.with_index { |line,i|
+          lnum = (i.to_i+start)
+          hash_builder.push({:line_number => lnum, :data=> line.gsub("\n",""), :selected=> (selected==lnum)? true: false} )
+          output_builder.push "#{lnum}: #{line}"
+        }
+        {:output=>output_builder.join(), :array=>hash_builder}
+      end
+
 
       def raw
+        options_id = self.class.name.split("::").last.to_s  #get class name without module namespace
+
         return @raw if @raw
         m = @url.match(/github\.com\/(?<user>[^\/]+)\/(?<repo>[^\/]+)\/blob\/(?<sha1>[^\/]+)\/(?<file>[^#]+)(#(L(?<from>[^-]*)(-L(?<to>.*))?))?/mi)
+
         if m
-          from = (m[:from] || -1).to_i
-          to = (m[:to] || -1).to_i
+          from = /\d+/.match(m[:from])   #get numeric should only match a positive interger
+          to   = /\d+/.match(m[:to])     #get numeric should only match a positive interger
+
           @file = m[:file]
           contents = open("https://raw.github.com/#{m[:user]}/#{m[:repo]}/#{m[:sha1]}/#{m[:file]}", read_timeout: timeout).read
-          if from > 0
-            if to < 0
-              from = from - 10
-              to = from + 20
-            end
-            if to > from
-              contents = contents.split("\n")[from..to].join("\n")
+          
+          contents_lines = contents.lines           #get contents lines 
+          contents_lines_size = contents_lines.size #get number of lines
+            
+          cr = calc_range(m,contents_lines_size)    #calculate the range of lines for output
+            selected_one_liner = cr[:selected_one_liner] #if url is a one-liner calc_range will return it
+            # puts "SELECTED LINE" + cr[:selected_one_liner].to_s
+            from           = cr[:from]
+            to             = cr[:to]
+            @truncated     = cr[:truncated]
+            range_provided = cr[:range_provided]
+            one_liner      = cr[:one_liner]
+            @cr_results = cr
+          if range_provided       #if a range provided (single line or more)
+            if SHOW_LINE_NUMBER
+              lines_result = line_number_helper(contents_lines[from-1..to-1], from, selected_one_liner)  #print code with prefix line numbers in case range provided
+              contents = lines_result[:output]
+              @selected_lines_array = lines_result[:array] 
+            else 
+              contents = contents_lines[from-1..to-1].join()
             end
+
+          else
+            contents = contents_lines[from-1..to-1].join()
           end
-          if contents.length > MAX_CHARS
+
+          if contents.length > MAX_CHARS    #truncate content chars to limits
             contents = contents[0..MAX_CHARS]
             @truncated = true
           end
 
-          split = contents.split("\n")
-          if split.length > MAX_LINES
-            contents = split[0..MAX_LINES].join("\n")
-            @truncated = true
-          end
           @raw = contents
         end
       end
@@ -46,8 +195,13 @@ module Onebox
         @data ||= {title: link.sub(/^https?\:\/\/github\.com\//, ''),
                    link: link,
                    content: raw,
+                   lines:  @selected_lines_array ,
+                   has_lines: !@selected_lines_array.nil?,
+                   selected_one_liner: @selected_one_liner,
+                   cr_results:@cr_results,
                    truncated: @truncated}
       end
+
     end
   end
 end

data/lib/onebox/engine/github_issue_onebox.rb

@@ -0,0 +1,49 @@
+module Onebox
+  module Engine
+    class GithubIssueOnebox
+      #Author Lidlanca 2014
+      include Engine
+      include LayoutSupport
+      include JSON
+      matches_regexp Regexp.new("^http(?:s)?:\/\/(?:www\.)?(?:(?:\w)+\.)?github\.com\/(?<org>.+)\/(?<repo>.+)\/issues\/([[:digit:]]+)")
+
+      def url
+        m = match 
+        "https://api.github.com/repos/#{m["org"]}/#{m["repo"]}/issues/#{m["item_id"]}"
+      end
+
+      private
+
+      def match
+         @match ||= @url.match(/^http(?:s)?:\/\/(?:www\.)?(?:(?:\w)+\.)?github\.com\/(?<org>.+)\/(?<repo>.+)\/(?<type>issues)\/(?<item_id>[\d]+)/)
+      end
+
+      def data
+        
+        @raw ||= ::MultiJson.load(open(url,"Accept"=>"application/vnd.github.v3.text+json",:read_timeout=>timeout )) #custom Accept header so we can get body as text.
+        body_text=  @raw["body_text"]
+      
+        
+        content_words = body_text.gsub("\n\n","\n").gsub("\n","<br>").split(" ") #one pass of removing double newline, then we change \n to <br> and later on we revert it back to \n this is a workaround to avoid losing newlines after we join it back.
+        max_words = 20
+        short_content =  content_words[0..max_words].join(" ")
+        short_content << "..." if content_words.length > max_words
+
+        status_color = {"open"=>"#6cc644","closed"=>"#bd2c00","merged"=>"#6e5494"}
+        result = { link: @url,
+                   title: "Issue: " + @raw["title"],
+                   content:short_content.gsub("<br>","\n"),
+                   labels: @raw["labels"],
+                   user: @raw['user'],
+                   status: @raw['state'],
+                   status_color:  status_color[@raw['state']] || "#cfcfcf",
+                   created_at: @raw['created_at'].split("T")[0], #get only date for now
+                   closed_at: (@raw['closed_at'].nil? ? "" : @raw['closed_at'].split("T")[0] ) ,
+                   closed_by: @raw['closed_by'],
+                   # avatar: "https://www.gravatar.com/avatar/#{@raw['user']['gravatar_id']}?s=128",
+                   avatar:"https://avatars1.githubusercontent.com/u/#{@raw['user']['id']}?v=2&s=96"
+                  }
+      end
+    end
+  end
+end

data/lib/onebox/engine/github_pullrequest_onebox.rb

@@ -13,12 +13,57 @@ module Onebox
 
       private
 
+      #Make an api JSON request, will attempt to authenticate if provided in the engine options
+      # Author: Lidlanca
+      #: self.options[:github_auth_method]  = :basic | :oauth | nil
+      #  :oauth is the recommend way for authentication. when generating token you can control privileges, and you do not expose your password
+      #  :basic require username and password provided in options[:github_auth_user , :github_auth_pass]
+      #  nil or false will make a request without any authentication. request rate limit are lower.
+
+      def api_json_request url
+        box_options = self.options
+        case box_options[:github_auth_method] 
+          when :basic
+            auth = [box_options[:github_auth_user] , box_options[:github_auth_pass]] # user name and password
+          when :oauth
+            auth = [box_options[:github_auth_token] , "x-oauth-basic"] #oauth does not need password with token
+          else
+            #request without auth
+            return  ::MultiJson.load(open(url,"Accept"=>"application/vnd.github.v3.text+json",read_timeout: timeout))
+            
+        end
+          #Request with auth
+          return ::MultiJson.load(open(url,"Accept"=>"application/vnd.github.v3.text+json",http_basic_authentication:auth, read_timeout: timeout))
+      end
+
+      def raw 
+          @raw ||= api_json_request url
+      end
       def match
         @match ||= @url.match(%r{github\.com/(?<owner>[^/]+)/(?<repository>[^/]+)/pull/(?<number>[^/]+)})
       end
 
       def data
+        box_options =  self.options
         result = raw.clone
+
+        pull_status =  "Pull Status:" << {:closed=>"closed",:open=>"open"}[raw["state"].to_sym] << (raw["state"] == "closed" ? (raw["merged"] ? " & accepted" : " & declined") : "")  #closed , open
+        result['pull_status_str'] = pull_status
+        if box_options[:get_build_status]
+          url2 = raw["statuses_url"]
+          raw2 =  api_json_request url2  #2nd api request to get build status 
+
+          result['pull_status'] = raw["state"]
+          result['pull_status_str'] = pull_status
+          result['pull_status_str_open'] = raw["state"]=="open"
+          result['pull_status_closed_accepted'] = raw["state"]=="closed" && raw["merged"] 
+          result['pull_status_closed_declined'] = raw["state"]=="closed" && !raw["merged"] 
+          unless raw2.empty?
+            result['build_status'] = "Build status: " +  raw2[0]["state"].to_s.capitalize  + " | " + raw2[0]["description"].to_s
+          end
+        end
+
+        
         result['link'] = link
         result['created_at'] = Time.parse(result['created_at']).strftime("%I:%M%p - %d %b %y")
         result
@@ -26,3 +71,5 @@ module Onebox
     end
   end
 end
+
+

data/lib/onebox/version.rb

@@ -1,3 +1,3 @@
 module Onebox
-  VERSION = "1.5.0"
+  VERSION = "1.5.1"
 end

data/templates/githubblob.mustache

@@ -1,7 +1,37 @@
 <h4><a href="{{link}}" target="_blank">{{title}}</a></h4>
+{{^has_lines}}
 <pre><code class='{{lang}}'>{{content}}</code></pre>
+{{/has_lines}}
+{{#has_lines}}
+{{! This is a template comment  | Sample rules for this box 
+<style>
+pre.onebox code ol{
+	margin-left:0px;
+}
+pre.onebox code ol .lines{
+	margin-left:30px;
+}
+pre.onebox code ol.lines li {
+	list-style-type: decimal;
+	margin-left:45px;
+}
+pre.onebox code li{
+	list-style-type: none;
+	background-color:#fff;
+	border-bottom:1px solid #F0F0F0;
+	padding-left:5px;
+
+}
+pre.onebox code li.selected{
+	background-color:#cfc
+}
+</style>
+}}
+<pre class='onebox' ><code class='{{lang}}'><ol  class='start lines' start="{{cr_results.from}}" style='counter-reset: li-counter {{cr_results.from_minus_one}} ;'>
+{{#lines}}<li{{#selected}} class="selected"{{/selected}}>{{data}}</li>{{/lines}}
+</ol></code></pre>
+{{/has_lines}}
 
 {{#truncated}}
   This file has been truncated. <a href="{{link}}" target="_blank">show original</a>
-{{/truncated}}
-
+{{/truncated}}

data/templates/githubissue.mustache

@@ -0,0 +1,29 @@
+<a href="{{user.html_url}}">
+<img src="{{avatar}}" class="thumbnail onebox-avatar">
+</a>
+
+<h4><a href="{{link}}" target="_blank">{{title}}</a></h4>
+
+<div class="date" style="margin-top:10px;">
+	<div class="status">
+	<span style="background-color: {{status_color}};padding: 2px;border-radius: 4px;color: #fff;">{{status}}</span>
+	</div>
+	<div class="user" style="margin-top:10px;">
+	opened by <a href="{{user.html_url}}" target="_blank">{{user.login}}</a> 
+	on <a href="{{link}}" target="_blank">{{created_at}}</a>
+	</div>
+	<div class="user">
+	{{#closed_by}}
+	closed by <a href="{{html_url}}" target="_blank">{{login}}</a> 
+	on <a href="{{link}}" target="_blank">{{closed_at}}</a>
+	{{/closed_by}}
+	</div>
+</div>
+
+<pre class='content' style="white-space: pre-wrap;">{{content}}</pre>
+
+<div class='lables'>
+	{{#labels}}
+ 	<span style="display:inline-block;margin-top:2px;background-color: #B8B8B8;padding: 2px;border-radius: 4px;color: #fff;margin-left: 3px;">{{name}}</span>
+ 	{{/labels}}
+</div>

data/templates/githubpullrequest.mustache

@@ -8,6 +8,27 @@
   <a href="{{html_url}}" target="_blank">{{title}}</a>
 </h4>
 
+
+
+<div class='github-commit-status' style='margin-bottom:3px;'>
+{{#pull_status_str_open}}
+<span style='background:#6cc644;color:#fff;display:inline-block;border-radius:3px;padding:2px;'>
+{{/pull_status_str_open}}
+{{#pull_status_closed_accepted}}
+<span style='background:#6e5494;color:#fff;display:inline-block;border-radius:3px;padding:2px;'>
+{{/pull_status_closed_accepted}}
+{{#pull_status_closed_declined}}
+<span style='background:#bd2c00;color:#fff;display:inline-block;border-radius:3px;padding:2px;'>
+{{/pull_status_closed_declined}}
+
+{{pull_status_str}} </span>
+</br>
+
+{{#build_status}}
+<span style='padding: 2px;background: #cfcfcf;'>{{build_status}}</span>
+{{/build_status}}
+</div>
+
 <div class="date">
   by <a href="{{user.html_url}}" target="_blank">{{user.login}}</a>
   on <a href="{{html_url}}" target="_blank">{{created_at}}</a>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onebox
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Joanna Zeta
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-09 00:00:00.000000000 Z
+date: 2014-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -249,6 +249,7 @@ files:
 - lib/onebox/engine/github_blob_onebox.rb
 - lib/onebox/engine/github_commit_onebox.rb
 - lib/onebox/engine/github_gist_onebox.rb
+- lib/onebox/engine/github_issue_onebox.rb
 - lib/onebox/engine/github_pullrequest_onebox.rb
 - lib/onebox/engine/google_play_app_onebox.rb
 - lib/onebox/engine/html.rb
@@ -315,6 +316,7 @@ files:
 - templates/amazon.mustache
 - templates/githubblob.mustache
 - templates/githubcommit.mustache
+- templates/githubissue.mustache
 - templates/githubpullrequest.mustache
 - templates/googleplayapp.mustache
 - templates/pubmed.mustache