jackal-github-kit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d03126fcac1f91bcbff8399b1d7cfd5fcc2f8c00
+  data.tar.gz: 8e4937d981f0f9bbc8bf6aa87e97975b99d85c86
+SHA512:
+  metadata.gz: 275b6804fff1b98126084b1c04c34c0f8590181698fd57222a86e7c9bb9e8a2b1571c1187f70ea062ade8d016e63c1e098d2c650351b65ca6f7863614020c58b
+  data.tar.gz: 642d63754ed446f144843d86d1d803fb34c8ac702879068877a6a334018a0d00836d5f4fcaea58bfe314215406483a2c369fca18cc226877162a195877fc8c8d

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# v0.1.0
+* Initial commit

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing
+
+## Branches
+
+### `master` branch
+
+The master branch is the current stable released version.
+
+### `develop` branch
+
+The develop branch is the current edge of development.
+
+## Pull requests
+
+* https://github.com/carnivore-rb/jackal-github-kit/pulls
+
+Please base all pull requests of the `develop` branch. Merges to
+`master` only occur through the `develop` branch. Pull requests
+based on `master` will likely be cherry picked.
+
+## Issues
+
+Need to report an issue? Use the github issues:
+
+* https://github.com/carnivore-rb/jackal-github-kit/issues

data/LICENSE

@@ -0,0 +1,13 @@
+   Copyright 2014 Chris Roberts
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,86 @@
+# Jackal GitHub Kit
+
+Provides communications interface with GitHub.
+
+## Supported communications
+
+* Repository commit comment
+* Repository status
+
+## Configuration
+
+Access tokens are used for access to GitHub. Configuration can
+be provided via direct configuration:
+
+```json
+{
+  "jackal": {
+    "github_kit": {
+      "config": {
+        "github": {
+          "access_token": TOKEN
+        }
+      }
+    }
+  }
+}
+```
+
+or it can be provided via application level configuration:
+
+```json
+{
+  "jackal": {
+    "github": {
+      "access_token": ACCESS_TOKEN
+    }
+  }
+}
+```
+
+## Payload structure
+
+### Repository commit comment
+
+```json
+{
+  ...
+  "data": {
+    "github_kit": {
+      "commit_comment": {
+        "repository": REPOSITORY_FULL_NAME,
+        "reference": COMMIT_SHA,
+        "message": MESSAGE_TEXT
+      }
+    }
+  }
+  ...
+}
+```
+
+### Repository status
+
+```json
+{
+  ...
+  "data": {
+    "github_kit": {
+      "status": {
+        "repository": REPOSITORY_FULL_NAME,
+        "reference": COMMIT_SHA,
+        "state": STATE,
+        "extras": {
+          "description": DESCRIPTION_TEXT,
+          "target_url": STATUS_URL
+        }
+      }
+    }
+  }
+  ...
+}
+```
+
+# Info
+
+* Repository: https://github.com/carnivore-rb/jackal-github-kit
+* IRC: Freenode @ #carnivore

data/jackal-github-kit.gemspec

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + '/lib/'
+require 'jackal-github-kit/version'
+Gem::Specification.new do |s|
+  s.name = 'jackal-github-kit'
+  s.version = Jackal::GithubKit::VERSION.version
+  s.summary = 'Message processing helper'
+  s.author = 'Chris Roberts'
+  s.email = 'code@chrisroberts.org'
+  s.homepage = 'https://github.com/carnivore-rb/jackal-github-kit'
+  s.description = 'GitHub interaction helper'
+  s.require_path = 'lib'
+  s.license = 'Apache 2.0'
+  s.add_dependency 'jackal'
+  s.add_dependency 'octokit'
+  s.files = Dir['lib/**/*'] + %w(jackal-github-kit.gemspec README.md CHANGELOG.md CONTRIBUTING.md LICENSE)
+end

data/lib/jackal-github-kit.rb

@@ -0,0 +1,9 @@
+require 'jackal'
+
+module Jackal
+  module GithubKit
+    autoload :Hubber, 'jackal-github-kit/hubber'
+  end
+end
+
+require 'jackal-github-kit/version'

data/lib/jackal-github-kit/hubber.rb

@@ -0,0 +1,118 @@
+require 'jackal-github-kit'
+
+module Jackal
+  module GithubKit
+    class Hubber < Callback
+
+      # Setup callback
+      def setup(*_)
+        require 'octokit'
+      end
+
+      # Determine validity of message
+      #
+      # @param message [Carnivore::Message]
+      # @return [Truthy, Falsey]
+      def valid?(message)
+        super do |payload|
+          payload.get(:data, :github_kit, :commit_comment) ||
+            payload.get(:data, :github_kit, :status)
+        end
+      end
+
+      # @return [Octokit::Client]
+      def github_client
+        memoize(:github_client) do
+          gh_conf = {
+            :access_token => config.fetch(:github, :access_token,
+              app_config.get(:github, :access_token)
+            )
+          }
+          Octokit::Client.new(gh_conf)
+        end
+      end
+
+      # Add comment to GitHub commit SHA
+      #
+      # @param message [Carnivore::Message]
+      def execute(message)
+        failure_wrap(message) do |payload|
+          write_release(payload) if payload.get(:data, :github_kit, :release)
+          write_commit_comment(payload) if payload.get(:data, :github_kit, :commit_comment)
+          write_status(payload) if payload.get(:data, :github_kit, :status)
+          job_completed(:github_kit, payload, message)
+        end
+      end
+
+      # Write comment to GitHub SHA reference
+      #
+      # @param payload [Smash]
+      # @return [TrueClass]
+      def write_commit_comment(payload)
+        comment = payload[:data][:github_kit].delete(:commit_comment)
+        info 'Writing commit comment to GitHub'
+        debug "GitHub commit comment: #{comment.inspect}"
+        github_client.create_commit_comment(
+          comment[:repository],
+          comment[:reference],
+          comment[:message]
+        )
+        true
+      end
+
+      # Write status of pull request to github
+      #
+      # @param payload [Smash]
+      # @return [TrueClass]
+      def write_status(payload)
+        status = payload[:data][:github_kit].delete(:status)
+        info 'Writing repository status to GitHub'
+        debug "GitHub repository status: #{status.inspect}"
+        github_client.create_status(
+          status[:repository],
+          status[:reference],
+          status[:state].to_sym,
+          status.fetch(:extras, Smash.new)
+        )
+        true
+      end
+
+      # Write release to github
+      #
+      # @param payload [Smash]
+      # @return [TrueClass]
+      def write_release(payload)
+        info 'Creating new release on GitHub'
+        rel = payload[:data][:github_kit].delete(:release)
+        release = github_client.create_release(
+          rel[:repository],
+          rel[:tag_name],
+          :name => rel[:name],
+          :target_commitish => rel[:reference],
+          :prerelease => rel[:prerelease],
+          :body => rel[:body]
+        )
+
+        api_release_url = release.rels[:self].href
+        public_release_url = release.rels[:html].href
+
+        info 'New release created on GitHub. Uploading assets.'
+        rel[:assets].each do |asset|
+          debug "Uploading release asset - #{asset}"
+          github_client.upload_asset(
+            api_release_url,
+            asset_store.get(asset),
+            :name => asset.sub(/^.+?_/, ''),
+            :content_type => 'application/octet-stream'
+          )
+          debug "Completed release asset upload - #{asset}"
+        end
+
+        payload.set(:data, :github_kit, :release, :api_url, api_release_url)
+        payload.set(:data, :github_kit, :release, :public_url, public_release_url)
+        true
+      end
+
+    end
+  end
+end

data/lib/jackal-github-kit/version.rb

@@ -0,0 +1,6 @@
+module Jackal
+  module GithubKit
+    # Current library version
+    VERSION = Gem::Version.new('0.1.0')
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: jackal-github-kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jackal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: GitHub interaction helper
+email: code@chrisroberts.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- jackal-github-kit.gemspec
+- lib/jackal-github-kit.rb
+- lib/jackal-github-kit/hubber.rb
+- lib/jackal-github-kit/version.rb
+homepage: https://github.com/carnivore-rb/jackal-github-kit
+licenses:
+- Apache 2.0
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Message processing helper
+test_files: []
+has_rdoc: