codeclimate-services 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be1d804a70349ad1e1b265055f2e2a72b5f9bc4b
+  data.tar.gz: 9a0c1811f8a1518d268fd25fdc6b703bbde5c552
+SHA512:
+  metadata.gz: 3aada36fb17278ee7093c5fc1e982150addf951d919539ed35a92332dda6888188f09e9e472331a6fb31914fa7cd0f9e0dce97b67393ae64346423cc61d455a9
+  data.tar.gz: f0ddd57b0da12d644aff62c076e9cf4ac0375589d4e8015b3bf2a031264697938bd160d520d8780b1b1ede11ab2684f53c786cdc87766958a26731b7ced701de

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p353

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+sudo: false
+env:
+  global:
+    - CODECLIMATE_REPO_TOKEN=5095391006b09e374e5d9232c41a09cfa6a3bdb1f9529c2485052416f743b4fe
+notifications:
+  slack: codeclimate:XU4Q4aPrFuBk6n2kt8sy0DLb

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in codeclimate-services.gemspec
+gemspec
+
+gem "pry"
+gem "codeclimate-test-reporter"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bryan Helmkamp
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,121 @@
+# Code Climate Services
+
+[![Code Climate](https://codeclimate.com/github/codeclimate/codeclimate-services/badges/gpa.svg)](https://codeclimate.com/github/codeclimate/codeclimate-services)
+[![Test Coverage](https://codeclimate.com/github/codeclimate/codeclimate-services/badges/coverage.svg)](https://codeclimate.com/github/codeclimate/codeclimate-services)
+
+A collection of classes, each responsible for integrating one external service
+with the Code Climate system.
+
+## Overview
+
+Services define `#receive_<event>` methods for any events they are interested
+in. These methods will be invoked with `@payload` set to a hash of data about
+the event being handled.
+
+The structure of this data is described below. Note that there may be additional
+keys not listed here.
+
+## Events
+
+Attributes common to all event types:
+
+```javascript
+{
+  "repo_name": String,
+  "details_url": String
+}
+```
+
+### Coverage
+
+Event name: `coverage`
+
+Event-specific attributes:
+
+```javascript
+{
+  "covered_percent": Float,
+  "previous_covered_percent": Float,
+  "covered_percent_delta": Float,
+  "compare_url": String
+}
+```
+
+### Quality
+
+Event name: `quality`
+
+Event-specific attributes:
+
+```javascript
+{
+  "constant_name": String,
+  "rating": String, // "A", "B", "C", etc
+  "previous_rating": String,
+  "remediation_cost": Float,
+  "previous_remediation_cost": Float,
+  "compare_url": String
+}
+```
+
+### Vulnerability
+
+Event name: `vulnerability`
+
+Event-specific attributes:
+
+```javascript
+{
+  "warning_type": String,
+  "vulnerabilities": [{
+    "warning_type": String,
+    "location": String
+  }, {
+    // ...
+  }]
+}
+```
+
+*Note*: The reason for the top-level `warning_type` attribute is for when the
+list of vulnerabilities are of mixed warning types. In this case, the top-level
+attribute can be used in any messaging.
+
+### Pull Request
+
+Event name: `pull_request`
+
+Event-specific attributes:
+
+```javascript
+{
+  "state": String, // "pending", or "success"
+  "github_slug": String, // user/repo
+  "number": String,
+  "commit_sha": String,
+}
+```
+
+## Other Events
+
+The following are not fully implemented yet.
+
+* `snapshot`
+
+## Contributing
+
+To add a new integration, you'll need to create a new `Service` subclass. Please
+use existing services as an example:
+
+- Chat service examples: [hipchat](lib/cc/services/hipchat.rb), [campfire](lib/cc/services/campfire.rb)
+- Issue tracker examples: [github_issues](lib/cc/services/github_issues.rb), [lighthouse](lib/cc/services/lighthouse.rb)
+
+Ensure that your class implements `#receive_test`. It must handle any exceptions
+and always return a hash of `{ ok: true|false, message: "String (HTML ok)" }`.
+[Example](lib/cc/services/jira.rb#L31).
+
+When you open your PR, please include an image for your service.
+
+## License
+
+See LICENSE.txt. This incorporates code from bugsnag-notification-plugins and
+github-services, both MIT licensed.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.libs.push "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/bin/bundler

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('codeclimate-services', 'bundler')

data/bin/coderay

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'coderay' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('coderay', 'coderay')

data/bin/nokogiri

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'nokogiri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('nokogiri', 'nokogiri')

data/bin/pry

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'pry' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('pry', 'pry')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('codeclimate-services', 'rake')

data/codeclimate-services.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cc/services/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "codeclimate-services"
+  spec.version       = CC::Services::VERSION
+  spec.authors       = ["Bryan Helmkamp"]
+  spec.email         = ["bryan@brynary.com"]
+  spec.summary       = %q{Service classes for Code Climate}
+  spec.description   = %q{Service classes for Code Climate}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "0.8.8"
+  spec.add_dependency "virtus", "1.0.0"
+  spec.add_dependency "nokogiri", "~> 1.6.0"
+  spec.add_dependency "activemodel", ">= 3.0"
+  spec.add_dependency "activesupport", ">= 3.0"
+  spec.add_development_dependency "bundler", ">= 1.6.2"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "mocha"
+end