quandl_utility 0.1.1 → 0.1.2

data/.rubocop.yml

@@ -0,0 +1,12 @@
+# Disable encoding requirement
+Encoding:
+  Enabled: false
+# Don't force aligment for thor method listing.
+AlignParameters:
+  Enabled: true
+  Exclude:
+    - lib/quandl/utility/thor_tasks/*
+LineLength:
+  Max: 100
+MethodLength:
+  Max: 20

data/README.md

@@ -44,3 +44,84 @@ rake gem_name:bump:patch  # Perform patch bump to gem_name
 $ rake gem_name:bump:minor && rake release
 ```
 
+## Thor Tasks
+
+Quandl::Utility Thor tasks are available in two ways:
+
+* Using the executable 'qutil'
+
+```bash
+qutil notify slack 'general' 'ping!'
+```
+
+* Including in your Thorfile
+
+```ruby
+require 'quandl/utility/thor_tasks'
+
+desc 'my_task'
+def my_task
+  invoke 'qutil:slack:notify', ['general', 'ping!']
+end
+```
+
+### Lint
+
+Linting tasks. Currently supports Rubocop and Foodcritic for linting Ruby projects and Chef cookbooks.
+
+```bash
+qutil lint help
+```
+
+#### ruby
+
+Run Rubocop linting on project.
+
+```bash
+qutil lint ruby
+```
+
+#### init_ruby
+
+Initialize Rubocop linting on project. Create two files: an organization base YAML config of linting rules, and an empty project YAML config
+that inherits from the organization config.
+
+```bash
+qutil lint init_ruby
+```
+
+#### cookbook
+
+```bash
+qutil lint cookbook
+```
+
+### CI
+
+Task for the Continuous Integration server.
+
+```bash
+qutil ci help
+```
+
+#### notify_slack
+
+Notify slack of build status. Uses various tddium ENV variables to build a message that is sent to slack.
+
+```bash
+qutil ci notify_slack
+```
+
+### Notify
+
+Task for notifications. Currently supports sending messages to Slack.
+
+```bash
+qutil notify help
+```
+
+#### slack
+
+```bash
+qutil notify slack MESSAGE CHANNEL
+```

data/Rakefile

@@ -14,7 +14,7 @@ RSpec::Core::RakeTask.new(:spec) do |task|
 end
 
 Quandl::Utility::Tasks.configure do |c|
-  c.name              = 'quandl_utility'
+  c.name              = 'quandl'
   c.tag_prefix        = 'v'
   c.version_path      = File.join( Quandl::Utility.root_path, 'VERSION' )
   c.changelog_path    = File.join( Quandl::Utility.root_path, 'UPGRADE.md' )

data/Thorfile

@@ -0,0 +1,6 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+require 'bundler'
+require 'thor'
+require 'thor/rake_compat'
+require 'quandl/utility/thor_tasks'

data/UPGRADE.md

@@ -1,3 +1,9 @@
+## 0.1.2 
+
+
+
+
+
 ## 0.1.1 
 
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/bin/qutil

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'quandl/utility/cli'
+Quandl::Utility::CLI.start

data/lib/quandl/utility.rb

@@ -1,11 +1,11 @@
-require "quandl/utility/version"
-require "quandl/utility/configuration"
-require "quandl/utility/tasks"
+require 'quandl/utility/version'
+require 'quandl/utility/configuration'
+require 'quandl/utility/tasks'
 
 module Quandl
-module Utility
-  def self.root_path
-    @root_path ||= File.expand_path(File.join(File.dirname(__FILE__), '../../'))
+  module Utility
+    def self.root_path
+      @root_path ||= File.expand_path(File.join(File.dirname(__FILE__), '../../'))
+    end
   end
 end
-end

data/lib/quandl/utility/cli.rb

@@ -0,0 +1,22 @@
+require 'thor'
+require 'quandl/utility/thor_tasks/lint'
+require 'quandl/utility/thor_tasks/notify'
+require 'quandl/utility/thor_tasks/ci'
+
+module Quandl
+  module Utility
+    # Quand Utility Command Line
+    class CLI < Thor
+      namespace 'qutil'
+
+      desc 'lint', 'Linting subcommands'
+      subcommand 'lint', Quandl::Utility::ThorTasks::Lint
+
+      desc 'notify', 'Notification subcommands'
+      subcommand 'notify', Quandl::Utility::ThorTasks::Notify
+
+      desc 'ci', 'CI Server subcommands'
+      subcommand 'ci', Quandl::Utility::ThorTasks::CI
+    end
+  end
+end

data/lib/quandl/utility/thor_tasks.rb

@@ -0,0 +1,3 @@
+require_relative 'thor_tasks/lint'
+require_relative 'thor_tasks/notify'
+require_relative 'thor_tasks/ci'

data/lib/quandl/utility/thor_tasks/ci.rb

@@ -0,0 +1,95 @@
+require 'thor'
+
+module Quandl
+  module Utility
+    module ThorTasks
+      # Tasks to run on CI Server
+      class CI < Thor
+        namespace 'qutil:ci'
+
+        desc 'notify_slack', 'Notify Quandl of build status of CI'
+        def notify_slack
+          invoke 'qutil:notify:slack',
+            [ci_build_message, slack_channel],
+            emoji: slack_emoji
+        end
+
+        private
+
+        # Generate a message for the CI build that will be sent to Quandl
+        #
+        # Returns string
+        def ci_build_message
+          "#{current_project} (#{git_branch}) *#{tddium_build_status}* - #{tddium_report_url}"
+        end
+
+        # Which slack channel to send build status to.
+        # Defaults to 'development', but it can be overriden in tddium.yml
+        #
+        # Returns string
+        def slack_channel
+          ENV.fetch('SLACK_CHANNEL', 'development')
+        end
+
+        # The URL for the build that just ran
+        #
+        # Returns string
+        def tddium_report_url
+          "https://#{tddium_api_server}/1/reports/#{tddium_session_id}"
+        end
+
+        def tddium_build_status
+          ENV['TDDIUM_BUILD_STATUS']
+        end
+
+        def tddium_api_server
+          ENV['TDDIUM_API_SERVER']
+        end
+
+        def tddium_session_id
+          ENV['TDDIUM_SESSION_ID']
+        end
+
+        def current_project
+          ENV['QUANDL_PROJECT']
+        end
+
+        def git_branch
+          @git_branch ||= `git branch`.chomp.gsub(/\*/, '').strip
+        end
+
+        # Use tddium environment variables to determine status of build
+        #
+        # Returns boolean
+        def failed?
+          ENV['TDDIUM_BUILD_STATUS'] == 'failed'
+        end
+
+        # Use different emojis for build statuses.
+        #
+        # Returns string
+        def slack_emoji
+          failed? ? fail_emoji : pass_emoji
+        end
+
+        # Return the emoji to use for a failed build
+        # Can be overriden with environment variables in tddium.yml.
+        # Default is :scream_cat:
+        #
+        # Returns string
+        def fail_emoji
+          ENV.fetch('SLACK_FAIL_EMOJI', ':scream_cat:')
+        end
+
+        # Return the emoji to use for a successful build
+        # Can be overriden with environment variables in tddium.yml.
+        # Default is :thumbsup:
+        #
+        # Returns string
+        def pass_emoji
+          ENV.fetch('SLACK_PASS_EMOJI', ':thumbsup:')
+        end
+      end
+    end
+  end
+end

data/lib/quandl/utility/thor_tasks/lint.rb

@@ -0,0 +1,60 @@
+require 'rubocop'
+require 'thor'
+require 'thor/foodcritic'
+
+module Quandl
+  module Utility
+    module ThorTasks
+      # Linting Tasks
+      class Lint < Thor
+        namespace 'qutil:lint'
+        include Thor::Actions
+
+        def self.source_root
+          File.expand_path('../../../../../support/templates', __FILE__)
+        end
+
+        desc 'cookbook', 'stuff'
+        def cookbook
+          invoke 'foodcritic:lint'
+        end
+
+        method_option :paths,
+          type: :array,
+          default: %w( . ),
+          required: true,
+          aliases: '-p'
+        desc 'ruby', 'Lint project for Ruby style with Rubocop'
+        def ruby
+          result = Rubocop::CLI.new.run(options[:paths])
+          if result == 0
+            say('No Rubocop warnings', :green)
+          else
+            exit(result)
+          end
+        end
+
+        method_option :default_directory,
+          type: :string,
+          default: '.quandl.rubocop',
+          aliases: '-d',
+          required: true,
+          banner: 'DIRECTORY'
+        desc 'init_ruby', 'Start Rubocop linting for project'
+        def init_ruby
+          return unless yes?('Do you want to setup Rubocop linting?', :yellow)
+          # Get directory and file for base rubocop
+          dir = options[:default_directory]
+          file_path = File.join(dir, '.rubocop.yml')
+          # Create empty directory if it does not exist
+          empty_directory(dir)
+          # Create base rubocop with common rules. Let Thor handle conflicts.
+          template('quandl.rubocop.yml', file_path)
+          # Create project template. Let Thor handle conflicts
+          @base_directory = dir
+          template('project.rubocop.yml.erb', '.rubocop.yml')
+        end
+      end
+    end
+  end
+end

data/lib/quandl/utility/thor_tasks/notify.rb

@@ -0,0 +1,43 @@
+require 'slack-notifier'
+
+module Quandl
+  module Utility
+    module ThorTasks
+      # Tasks for sending notifications
+      class Notify < Thor
+        namespace 'qutil:notify'
+
+        method_option :emoji,
+          type: :string,
+          aliases: '-e',
+          required: false,
+          banner: 'EMOJI'
+        method_option :token,
+          type: :string,
+          aliases: '-t',
+          required: true,
+          default: ENV['SLACK_TOKEN'],
+          banner: 'TOKEN'
+        method_option :team,
+          type: :string,
+          aliases: '-m',
+          required: true,
+          default: 'quandl',
+          banner: 'TEAM'
+        method_option :botname,
+          type: :string,
+          aliases: '-b',
+          required: false,
+          default: ENV['SLACK_BOTNAME'],
+          banner: 'BOTNAME'
+        desc 'slack message channel', 'Send notification to slack'
+        def slack(message, channel)
+          slack_client = Slack::Notifier.new(options[:team], options[:token])
+          slack_client.channel = channel
+          slack_client.username = options[:botname]
+          slack_client.ping(message, icon_emoji: options[:emoji])
+        end
+      end
+    end
+  end
+end

data/lib/quandl/utility/version.rb

@@ -1,5 +1,5 @@
 module Quandl
-module Utility
-  VERSION = File.read(File.expand_path(File.join(File.dirname(__FILE__), '../../../VERSION'))).strip.rstrip
+  module Utility
+    VERSION = File.read(File.expand_path(File.join(File.dirname(__FILE__), '../../../VERSION'))).strip.rstrip
+  end
 end
-end

data/quandl_utility.gemspec

@@ -16,10 +16,14 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib", 'tasks']
-  
+
   s.add_runtime_dependency "activesupport", ">= 3.0.0"
   s.add_runtime_dependency "rake"
-  
+  s.add_runtime_dependency 'thor'
+  s.add_runtime_dependency 'thor-foodcritic'
+  s.add_runtime_dependency 'rubocop'
+  s.add_runtime_dependency 'slack-notifier'
+
   s.add_development_dependency "rspec", "~> 2.13"
   s.add_development_dependency "fivemat", "~> 1.2"
   s.add_development_dependency "pry"

data/support/templates/project.rubocop.yml.erb

@@ -0,0 +1,4 @@
+inherit_from: <%= @base_directory %>/.rubocop.yml
+
+# Genereated automatically by Quandl::Utility at <%= Time.now %>
+# Project specific rules go here...

data/support/templates/quandl.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  Exclude:
+    - db/**
+    - config/boot.rb
+    - !ruby/regexp /rgloader/
+    - !ruby/regexp /.*tddium.*\.rb$/
+Encoding:
+  Enabled: false
+LineLength:
+  Max: 100
+MethodLength:
+  Max: 20

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quandl_utility
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-10 00:00:00.000000000 Z
+date: 2014-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -43,6 +43,70 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor-foodcritic
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -142,24 +206,35 @@ dependencies:
 description: Tools for making our lives easier.
 email:
 - blake@hilscher.ca
-executables: []
+executables:
+- qutil
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rubocop.yml
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- Thorfile
 - UPGRADE.md
 - VERSION
+- bin/qutil
 - lib/quandl/utility.rb
+- lib/quandl/utility/cli.rb
 - lib/quandl/utility/configuration.rb
 - lib/quandl/utility/rake_tasks.rb
 - lib/quandl/utility/tasks.rb
+- lib/quandl/utility/thor_tasks.rb
+- lib/quandl/utility/thor_tasks/ci.rb
+- lib/quandl/utility/thor_tasks/lint.rb
+- lib/quandl/utility/thor_tasks/notify.rb
 - lib/quandl/utility/version.rb
 - quandl_utility.gemspec
 - spec/spec_helper.rb
+- support/templates/project.rubocop.yml.erb
+- support/templates/quandl.rubocop.yml
 - tasks/utility.rake
 homepage: http://blake.hilscher.ca/
 licenses:
@@ -175,12 +250,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2688062014087562059
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2688062014087562059
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23