smart_todo 1.0.0

data/lib/smart_todo/slack_client.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+
+module SmartTodo
+  # A simple client around the Slack API.
+  #
+  # @example Sending a  message to a user.
+  #   SmartTodo::SlackClient.new.post_message('#general', 'Hello!')
+  class SlackClient
+    # A generic error class raised when the Slack API returns back a 200
+    # but there was a problem (permission issues ...)
+    class Error < StandardError
+      attr_reader :error_code
+
+      # @param response_body [Hash] the parsed response body from Slack
+      def initialize(response_body)
+        @error_code = response_body['error']
+
+        super("Response body: #{response_body}")
+      end
+    end
+
+    # @param slack_token [String]
+    def initialize(slack_token)
+      @slack_token = slack_token
+      @client = Net::HTTP.new('slack.com', Net::HTTP.https_default_port).tap do |client|
+        client.use_ssl = true
+        client.read_timeout = 30
+        client.ssl_timeout = 15
+      end
+    end
+
+    # Retrieve the Slack ID of a user from his email
+    #
+    # @param email [String]
+    # @return [Hash]
+    #
+    # @raise [Net::HTTPError] in case the reques to Slack failed
+    # @raise [SlackClient::Error] in case Slack returs a { ok: false } in the body
+    #
+    # @see https://api.slack.com/methods/users.lookupByEmail
+    def lookup_user_by_email(email)
+      headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+
+      request(:get, "/api/users.lookupByEmail?email=#{email}", nil, headers)
+    end
+
+    # Send a message to a Slack channel or to a user
+    #
+    # @param channel [String] The Slack channel or the user ID
+    # @param text [String] The message to send
+    # @return [Hash]
+    #
+    # @raise [Net::HTTPError] in case the reques to Slack failed
+    # @raise [SlackClient::Error] in case Slack returs a { ok: false } in the body
+    #
+    # @see https://api.slack.com/methods/chat.postMessage
+    def post_message(channel, text)
+      request(:post, '/api/chat.postMessage', JSON.dump(channel: channel, text: text))
+    end
+
+    private
+
+    # @param method [Symbol]
+    # @param endpoint [String]
+    # @param data [String] JSON encoded data when making a POST request
+    # @param headers [Hash]
+    #
+    # @raise [Net::HTTPError] in case the reques to Slack failed
+    # @raise [SlackClient::Error] in case Slack returs a { ok: false } in the body
+    def request(method, endpoint, data = nil, headers = {})
+      response = case method
+      when :post, :patch
+        @client.public_send(method, endpoint, data, default_headers.merge(headers))
+      else
+        @client.public_send(method, endpoint, default_headers.merge(headers))
+      end
+
+      slack_response!(response)
+    end
+
+    # Chech if the response to Slack was a 200 and the Slack API request was successful
+    #
+    # @param response [Net::HTTPResponse] a net Net::HTTPResponse subclass
+    #   (Net::HTTPOK, Net::HTTPNotFound ...)
+    # @return [Hash]
+    #
+    # @raise [Net::HTTPError] in case the reques to Slack failed
+    # @raise [SlackClient::Error] in case Slack returs a { ok: false } in the body
+    def slack_response!(response)
+      raise(Net::HTTPError.new('Request to slack failed', response)) unless response.code_type < Net::HTTPSuccess
+      body = JSON.parse(response.body)
+
+      if body['ok']
+        body
+      else
+        raise(Error, body)
+      end
+    end
+
+    # The default headers required by Slack
+    #
+    # @return [Hash]
+    def default_headers
+      {
+        'Content-Type' => 'application/json; charset=utf8',
+        'Authorization' => "Bearer #{@slack_token}",
+      }
+    end
+  end
+end

data/lib/smart_todo/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SmartTodo
+  VERSION = "1.0.0"
+end

data/lib/smart_todo.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "smart_todo/version"
+require "smart_todo/events"
+
+module SmartTodo
+  autoload :SlackClient,              'smart_todo/slack_client'
+  autoload :CLI,                      'smart_todo/cli'
+  autoload :Dispatcher,               'smart_todo/dispatcher'
+
+  module Parser
+    autoload :CommentParser,          'smart_todo/parser/comment_parser'
+    autoload :TodoNode,               'smart_todo/parser/todo_node'
+    autoload :MetadataParser,         'smart_todo/parser/metadata_parser'
+  end
+
+  module Events
+    autoload :Date,                   'smart_todo/events/date'
+    autoload :GemRelease,             'smart_todo/events/gem_release'
+    autoload :PullRequestClose,       'smart_todo/events/pull_request_close'
+  end
+end

data/lib/smart_todo_cop.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'smart_todo/parser/metadata_parser'
+
+module RuboCop
+  module Cop
+    module SmartTodo
+      # A RuboCop used to restrict the usage of regular TODO comments in code.
+      # This Cop does not run by default. It should be added to the RuboCop host's configuration file.
+      #
+      # @see https://rubocop.readthedocs.io/en/latest/extensions/#loading-extensions
+      class SmartTodoCop < Cop
+        MSG = "Don't write regular TODO comments. Write SmartTodo compatible syntax comments." \
+              "For more info please look at https://github.com/shopify/smart_todo"
+
+        # @param processed_source [RuboCop::ProcessedSource]
+        # @return [void]
+        def investigate(processed_source)
+          processed_source.comments.each do |comment|
+            next unless /^#\sTODO/ =~ comment.text
+            next if smart_todo?(comment.text)
+
+            add_offense(comment)
+          end
+        end
+
+        # @param comment [String]
+        # @return [true, false]
+        def smart_todo?(comment)
+          metadata = ::SmartTodo::Parser::MetadataParser.parse(comment.gsub(/^#/, ''))
+
+          metadata.events.any?
+        end
+      end
+    end
+  end
+end

data/shipit.rubygems.yml

@@ -0,0 +1 @@
+# using the default shipit config

data/smart_todo.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "smart_todo/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "smart_todo"
+  spec.version       = SmartTodo::VERSION
+  spec.authors       = ["Shopify"]
+  spec.email         = ["rails@shopify.com"]
+
+  spec.summary       = "Enhance todo's comments in your codebase."
+  spec.description   = <<~EOM
+    SmartTodo is a tool designed to assign specific users on todo's task
+    written in your codebase and help assignees be reminded when it's time to commit
+    to their todo's.
+  EOM
+  spec.homepage      = "https://github.com/shopify/smart_todo"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage + "/blob/master/CHANGELOG.md"
+
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = ['smart_todo']
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency("bundler", "~> 1.17")
+  spec.add_development_dependency("rake", "~> 10.0")
+  spec.add_development_dependency("minitest", "~> 5.0")
+  spec.add_development_dependency("webmock")
+  spec.add_development_dependency("rubocop")
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: smart_todo
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Shopify
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-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.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  SmartTodo is a tool designed to assign specific users on todo's task
+  written in your codebase and help assignees be reminded when it's time to commit
+  to their todo's.
+email:
+- rails@shopify.com
+executables:
+- smart_todo
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop-http---shopify-github-io-ruby-style-guide-rubocop-yml"
+- ".rubocop.yml"
+- ".shopify-build/VERSION"
+- ".shopify-build/smart-todo.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rubocop
+- bin/setup
+- dev.yml
+- exe/smart_todo
+- lib/smart_todo.rb
+- lib/smart_todo/cli.rb
+- lib/smart_todo/dispatcher.rb
+- lib/smart_todo/events.rb
+- lib/smart_todo/events/date.rb
+- lib/smart_todo/events/gem_release.rb
+- lib/smart_todo/events/pull_request_close.rb
+- lib/smart_todo/parser/comment_parser.rb
+- lib/smart_todo/parser/metadata_parser.rb
+- lib/smart_todo/parser/todo_node.rb
+- lib/smart_todo/slack_client.rb
+- lib/smart_todo/version.rb
+- lib/smart_todo_cop.rb
+- shipit.rubygems.yml
+- smart_todo.gemspec
+homepage: https://github.com/shopify/smart_todo
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shopify/smart_todo
+  source_code_uri: https://github.com/shopify/smart_todo
+  changelog_uri: https://github.com/shopify/smart_todo/blob/master/CHANGELOG.md
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Enhance todo's comments in your codebase.
+test_files: []