danger-lgtm 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1c3fca298f48500eb273447a1f481edaac906dc7
-  data.tar.gz: f804befd3788c349ac1f434f304140cac7e759fc
+SHA256:
+  metadata.gz: cd172e647a8512ec42e6c9f93ad239417e2fe26dadabc3d74a674e54666e3ba0
+  data.tar.gz: f20897b8e4ac857e7e9e0a26ad108233947eb170bdd6606ef0a04a510c12cbba
 SHA512:
-  metadata.gz: 29766ed8ad9ae7fa3eb06f2552047b017d2ec3dec6930ac8a32a821e124b4b9b743ebca9bfd1de2636c468126ebbe7807e54dfbfc0a258a9368f42a3b9d9c4cb
-  data.tar.gz: 4e96ee1c51db0787293a5c30ff73441260762468708606e9e08844bbe8da9dc5565bb07efa2fce570881836427901a4ebee8ffddf069bd0471b2ba1c0f4251d6
+  metadata.gz: 1bf3c8c8f2b68ec72202b93a903c358edd8383d60e43e578d65be5f47762e9521b16d9d635b7dbbf8adb60cb868d8beeaea08d1ae7df6dfbd8eeab94766da205
+  data.tar.gz: 16814ecd00a3dd8fa55fedd10a869bc4e47f8ca1b41452f036d05efabf97d367a3c1d3d4943e61e01b0961981d0eb7b824efd33f487075d2aa91b1c013d5b981

data/.travis.yml

@@ -1,11 +1,18 @@
-language: ruby
-cache:
-  directories:
-    - bundle
+---
+
+sudo: false
 
+language: ruby
 rvm:
-  - 2.2
-  - 2.3.1
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+
+before_install:
+  - travis_retry gem install bundler --no-document -v 1.17.3
+
+cache: bundler
 
 script:
-    - bundle exec rake spec
+  - bundle exec rake spec

data/Gemfile.lock

@@ -1,16 +1,16 @@
 PATH
   remote: .
   specs:
-    danger-lgtm (1.0.3)
+    danger-lgtm (1.1.0)
       danger-plugin-api (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
-    claide (1.0.2)
+    claide (1.0.3)
     claide-plugins (0.9.2)
       cork
       nap
@@ -19,28 +19,30 @@ GEM
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (5.6.4)
+    danger (6.2.2)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
       faraday (~> 0.9)
-      faraday-http-cache (~> 1.0)
-      git (~> 1)
-      kramdown (~> 1.5)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.6)
+      kramdown (~> 2.0)
+      kramdown-parser-gfm (~> 1.0)
       no_proxy_fix
       octokit (~> 4.7)
       terminal-table (~> 1)
     danger-plugin-api (1.0.0)
       danger (> 2.0)
     diff-lcs (1.3)
-    faraday (0.15.2)
+    faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
-    faraday-http-cache (1.3.1)
+    faraday-http-cache (2.0.0)
       faraday (~> 0.8)
     ffi (1.9.18)
     formatador (0.2.5)
-    git (1.4.0)
+    git (1.6.0)
+      rchardet (~> 1.8)
     guard (2.14.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -56,20 +58,23 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     jaro_winkler (1.5.1)
-    kramdown (1.17.0)
+    kramdown (2.1.0)
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
     listen (3.0.7)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9.7)
     lumberjack (1.0.11)
     method_source (0.8.2)
-    multipart-post (2.0.0)
+    multipart-post (2.1.1)
     nap (1.1.0)
     nenv (0.3.0)
     no_proxy_fix (0.1.2)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    octokit (4.9.0)
+    octokit (4.16.0)
+      faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
     parallel (1.12.1)
@@ -80,12 +85,13 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    public_suffix (3.0.2)
+    public_suffix (4.0.3)
     rainbow (3.0.0)
     rake (10.5.0)
     rb-fsevent (0.9.8)
     rb-inotify (0.9.8)
       ffi (>= 0.5.0)
+    rchardet (1.8.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
@@ -108,9 +114,9 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.9.0)
-    sawyer (0.8.1)
-      addressable (>= 2.3.5, < 2.6)
-      faraday (~> 0.8, < 1.0)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
     shellany (0.0.1)
     slop (3.6.0)
     terminal-table (1.8.0)

data/danger-lgtm.gemspec

@@ -1,7 +1,9 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'lgtm/gem_version.rb'
+
+require 'lgtm/version.rb'
 
 Gem::Specification.new do |spec|
   spec.name          = 'danger-lgtm'

data/lib/danger_lgtm.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'lgtm/gem_version'
+require 'lgtm/version'

data/lib/lgtm/network.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Lgtm
+  # Network is module of HTTP communication
+  module Network
+    class NetworkError < StandardError; end
+
+    # process_request Send HTTP request
+    #
+    # @param  [URI] uri Request uri
+    #
+    # @return  [Net::HTTP] HTTP response
+    #
+    def process_request(uri)
+      request = Net::HTTP::Get.new(uri)
+      connection = Net::HTTP.start(uri.hostname, uri.port, use_ssl: https?(uri))
+
+      connection
+        .request(request)
+        .tap(&method(:validate_response!))
+    end
+
+    # parse_redirect_location Parse redirect location from response
+    #
+    # @param [Net::HTTP] response HTTP response
+    #
+    # @return  [String] Redirect location
+    #
+    def parse_redirect_location(response)
+      response['location']
+    end
+
+    private
+
+    # validate_response! Validates HTTP response
+    #
+    # @param [Net::HTTP] response Net::HTTP response
+    #
+    # @raise NetworkError
+    #
+    # @return [nil]
+    #
+    def validate_response!(response)
+      raise NetworkError, response.message if response.is_a?(Net::HTTPError)
+    end
+
+    # https? Check that uri use HTTPS scheme
+    #
+    # @param [URI] uri Test uri
+    #
+    # @return [Boolean] Result of check
+    #
+    def https?(uri)
+      uri.instance_of?(URI::HTTPS)
+    end
+  end
+end

data/lib/lgtm/plugin.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
 require 'uri'
-require 'json'
 require 'net/http'
-require_relative 'errors'
-require_relative 'error_handleable'
+
+require_relative 'network'
 
 module Danger
   # Lgtm let danger say lgtm when there is no violations.
@@ -18,70 +17,102 @@ module Danger
   # @tags lgtm, github
   #
   class DangerLgtm < Plugin
-    include ::Lgtm::ErrorHandleable
-    RANDOM_LGTM_POST_URL = 'https://lgtm.in/g'.freeze
+    include ::Lgtm::Network
+
+    LGTM_URL = 'https://www.lgtm.app'.freeze
 
-    # Check status report, say lgtm if no violations
-    # Generates a `markdown` of a lgtm image.
+    RANDOM_POST_PATH = '/g'.freeze
+    POST_CONTENT_PATH = '/p'.freeze
+
+    # check_lgtm Comment LGTM markdown if report has no violations
     #
-    # @param  [String] image_url lgtm image url
-    # @param  [Boolean] https_image_only https image only if true
+    # @param  [String] image_url LGTM image url
+    # @param  [Boolean] https_image_only Use only secure url
     #
-    # @return  [void]
+    # @return  [nil]
     #
     def check_lgtm(image_url: nil, https_image_only: false)
-      return unless status_report[:errors].length.zero? &&
-                    status_report[:warnings].length.zero?
-
-      image_url ||= fetch_image_url(https_image_only: https_image_only)
+      return if status_report[:errors].any?
+      return if status_report[:warnings].any?
 
-      markdown(
-        markdown_template(image_url)
-      )
+      if image_url
+        comment image_url
+      else
+        comment fetch_image_url(https_image_only)
+      end
     end
 
     private
 
-    # returns "<h1 align="center">LGTM</h1>" when ServiceTemporarilyUnavailable.
-    def fetch_image_url(https_image_only: false)
-      lgtm_post_response = process_request(lgtm_post_url) do |req|
-        req['Accept'] = 'application/json'
+    # comment Place markdown comment
+    #
+    # @param  [Boolean] url LGTM image url
+    #
+    # @return  [nil]
+    #
+    def comment(url)
+      if url.nil?
+        markdown("<h1 align='center'>LGTM</h1>")
+      else
+        markdown("<p align='center'><img src='#{url}' alt='LGTM' /></p>")
       end
+    end
 
-      lgtm_post = JSON.parse(lgtm_post_response.body)
+    # fetch_image_url Fetch LGTM image url from https://www.lgtm.app
+    #
+    # @param  [Boolean] reject_insecure_url Eeturn only secure url
+    #
+    # @return  [String] LGTM image url
+    #
+    def fetch_image_url(reject_insecure_url = false)
+      post_id = fetch_randon_post_id
+      return if post_id.empty?
 
-      url = lgtm_post['actualImageUrl']
-      if https_image_only && URI.parse(url).scheme != 'https'
-        return fetch_image_url(https_image_only: true)
-      end
-      url
-    rescue ::Lgtm::Errors::UnexpectedError; nil
-    end
+      post_content_url = fetch_post_content_url(post_id)
+      return if post_content_url.empty?
 
-    def process_request(url)
-      uri = URI(url)
+      return fetch_image_url(reject_insecure_url) if retry?(reject_insecure_url,
+                                                            post_content_url)
 
-      req = Net::HTTP::Get.new(uri)
+      post_content_url
+    rescue ::Lgtm::Network::NetworkError => e
+      $stdout.puts e.message
+    end
 
-      yield req if block_given?
+    # fetch_randon_post_id Fetch renadon LGTM post url from https://www.lgtm.app
+    #
+    # @return  [String] LGTM post url
+    #
+    def fetch_randon_post_id
+      uri = URI.join(LGTM_URL, RANDOM_POST_PATH)
+      response = process_request(uri)
+      location = parse_redirect_location(response)
 
-      Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
-        http.request(req)
-      end
+      location.split('/').last
     end
 
-    def lgtm_post_url
-      res = process_request(RANDOM_LGTM_POST_URL)
-      validate_response(res)
-      res['location']
+    # fetch_post_content_url Fetch LGTM image url from https://www.lgtm.app
+    #
+    # @param  [String] post_id LGTM post identifier
+    #
+    # @return  [String] LGTM image url
+    #
+    def fetch_post_content_url(post_id)
+      uri = URI.join(LGTM_URL, POST_CONTENT_PATH, post_id)
+      response = process_request(uri)
+
+      parse_redirect_location(response)
     end
 
-    def markdown_template(image_url)
-      if image_url.nil?
-        "<h1 align='center'>LGTM</h1>"
-      else
-        "<p align='center'><img src='#{image_url}' alt='LGTM' /></p>"
-      end
+    # retry? Check should be image url requested again
+    #
+    # @param  [Boolean] reject_insecure_url Return only secure url
+    # @param  [String] url LGTM image url
+    #
+    # @return  [Boolean] should be image url requested again
+    #
+    def retry?(reject_insecure_url, url)
+      reject_insecure_url && https?(URI.parse(url))
     end
   end
 end

data/lib/lgtm/{gem_version.rb → version.rb}

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lgtm
-  VERSION = '1.0.4'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/spec/lgtm_spec.rb

@@ -3,71 +3,63 @@
 require File.expand_path('spec_helper', __dir__)
 
 describe Danger::DangerLgtm do
-  def mock(request_url: 'https://lgtm.in/p/sSuI4hm0q',
-           actual_image_url: 'https://example.com/image.jpg')
-    double(
-      :[] => request_url,
-      body: JSON.generate(
-        actualImageUrl: actual_image_url
-      )
-    )
-  end
-
   it 'should be a plugin' do
     expect(Danger::DangerLgtm.new(nil)).to be_a(Danger::Plugin)
   end
 
   describe '#check_lgtm' do
-    subject do
-      lgtm.check_lgtm(
-        https_image_only: https_image_only,
-        image_url: image_url
-      )
+    shared_examples 'returns correctly message' do
+      it { expect(markdowns.first.message).to match(/#{image_url}/) }
     end
 
-    let(:dangerfile) { testing_dangerfile }
     let(:lgtm) { dangerfile.lgtm }
-    let(:https_image_only) { false } # default false
-    let(:image_url) {} # default nil
+    let(:dangerfile) { testing_dangerfile }
 
-    shared_examples 'returns correctly message' do
-      it do
-        allow(Net::HTTP).to receive(:start).and_return(mock)
-        is_expected
+    let(:https_only) { false }
+    let(:image_url) { nil }
 
-        expect(dangerfile.status_report[:markdowns][0].message)
-          .to match(expected_message)
-      end
+    let(:connection_mock) { double('Connection', request: response) }
+
+    subject(:markdowns) do
+      dangerfile.status_report[:markdowns]
     end
 
-    context 'with Dangerfile' do
-      it 'when no violation' do
-        is_expected
-        expect(dangerfile.status_report[:markdowns].length).to eq(1)
+    context 'with HTTP errors' do
+      let(:message) { 'Hello World!' }
+      let(:response) { failure_response_mock(message) }
+
+      it 'handles error' do
+        expect($stdout).to receive(:puts).with(message)
+
+        allow(Net::HTTP).to receive(:start).and_return(connection_mock)
+        lgtm.check_lgtm(https_image_only: https_only, image_url: image_url)
+
+        expect(markdowns.first.message).to eq("<h1 align='center'>LGTM</h1>")
       end
+    end
 
-      it 'lgtm with errors' do
-        allow(lgtm).to receive(:validate_response)
-          .and_raise(::Lgtm::Errors::UnexpectedError)
-        is_expected
-        expect(dangerfile.status_report[:markdowns][0].message)
-          .to eq("<h1 align='center'>LGTM</h1>")
+    context 'without HTTP errors' do
+      before do
+        allow(Net::HTTP).to receive(:start).and_return(connection_mock)
       end
 
-      context 'pick random pic from lgtm.in' do
-        let(:expected_message) { %r{https:\/\/example.com\/image.jpg} }
-        it_behaves_like 'returns correctly message'
+      before do
+        lgtm.check_lgtm(https_image_only: https_only, image_url: image_url)
       end
 
-      context 'pick random pic from lgtm.in with https_image_only option' do
-        let(:https_image_only) { true }
-        let(:expected_message) { %r{https:\/\/example.com\/image.jpg} }
+      context 'with passed image url' do
+        let(:lgtm_image) { 'https://example.com/image1.jpg' }
+        let(:image_url) { 'https://example.com/image2.jpg' }
+        let(:response) { success_response_mock(lgtm_image) }
+
         it_behaves_like 'returns correctly message'
       end
 
-      context 'use given url' do
-        let(:image_url) { 'http://imgur.com/Irk2wyX.jpg' }
-        let(:expected_message) { %r{http:\/\/imgur\.com\/Irk2wyX\.jpg} }
+      context 'without passed image url' do
+        let(:lgtm_image) { 'https://example.com/image.jpg' }
+        let(:image_url) { 'https://example.com/image.jpg' }
+        let(:response) { success_response_mock(lgtm_image) }
+
         it_behaves_like 'returns correctly message'
       end
     end

data/spec/spec_helper.rb

@@ -59,3 +59,23 @@ def testing_dangerfile
   env = Danger::EnvironmentManager.new(testing_env)
   Danger::Dangerfile.new(env, testing_ui)
 end
+
+# Failute response mock
+def failure_response_mock(message)
+  mock = double('Response')
+
+  allow(mock).to receive(:is_a?).with(Net::HTTPError).and_return(true)
+  allow(mock).to receive(:message).and_return(message)
+
+  mock
+end
+
+# Success response mock
+def success_response_mock(url)
+  mock = double('Response')
+
+  allow(mock).to receive(:is_a?).with(Net::HTTPError).and_return(false)
+  allow(mock).to receive(:[]).with('location').and_return(url)
+
+  mock
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-lgtm
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - leonhartX
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-29 00:00:00.000000000 Z
+date: 2020-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -169,10 +169,9 @@ files:
 - danger-lgtm.gemspec
 - lib/danger_lgtm.rb
 - lib/danger_plugin.rb
-- lib/lgtm/error_handleable.rb
-- lib/lgtm/errors.rb
-- lib/lgtm/gem_version.rb
+- lib/lgtm/network.rb
 - lib/lgtm/plugin.rb
+- lib/lgtm/version.rb
 - spec/lgtm_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/leonhartX/danger-lgtm
@@ -194,8 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Danger Plugin used to post LGTM iamge when there is no violations

data/lib/lgtm/error_handleable.rb

@@ -1,33 +0,0 @@
-module Lgtm
-  # ErrorHandleable is module of error handling
-  module ErrorHandleable
-    # 4xx http status.
-    CLIENT_ERRORS = [
-      Net::HTTPBadRequest,
-      Net::HTTPForbidden,
-      Net::HTTPNotFound
-    ].freeze
-    # 5xx http status.
-    SERVER_ERRORS = [
-      Net::HTTPInternalServerError,
-      Net::HTTPBadGateway,
-      Net::HTTPServiceUnavailable,
-      Net::HTTPGatewayTimeOut
-    ].freeze
-
-    # validate_response is response validating
-    #
-    # @param [Net::HTTPxxx] response Net::HTTP responses
-    # @raise ::Lgtm::Errors::UnexpectedError
-    # @return [void]
-    #
-    def validate_response(response)
-      case response
-      when *SERVER_ERRORS
-        raise ::Lgtm::Errors::UnexpectedError
-      when *CLIENT_ERRORS
-        raise ::Lgtm::Errors::UnexpectedError
-      end
-    end
-  end
-end

data/lib/lgtm/errors.rb

@@ -1,6 +0,0 @@
-module Lgtm
-  class Errors
-    class UnexpectedError < StandardError
-    end
-  end
-end