jackal-github 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eec50fd5e3f0c4fcabb04c701e0d7227aa0afcf3
+  data.tar.gz: e87d0e1e9420ee420993619f4a51e72f030378b9
+SHA512:
+  metadata.gz: 55115b081234606af980b53d5e176af0683514841cc416b9128ce9036743488556d7f35ba11235c37b8ddeabe1b89e17ee62d01b9695a32427b99d8adc5240ad
+  data.tar.gz: 4a1f2dd0da9e664d7804e9270499a8f8056812b9e0f736042232f139c965a4bda3bfdd8f14254757d4c313a110f84e871cfa3790a12df4e8b6564c9ea3d0e69f

data/CHANGELOG.md

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

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/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/issues

data/LICENSE

@@ -0,0 +1,13 @@
+   Copyright 2015 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,68 @@
+# Jackal Github
+
+Processes incoming payloads from github.
+
+## Usage
+
+Configure incoming source using the `:http_paths` source:
+
+```json
+...
+"sources": {
+  "input": {
+    "type": "http_paths",
+    "args": {
+      "port": 9090,
+      "path": "/github",
+      "method": "post"
+    }
+  }
+}
+...
+```
+
+## Configuration
+
+The name provided for the payload defaults to `"github"`. This
+can be overridden in the configuration using the names map,
+which allows names to be provided on a per-event basis:
+
+```json
+...
+"config": {
+  "names": {
+    "push": PUSH_NAME,
+    "create": CREATE_NAME
+  }
+}
+...
+```
+
+## Payload
+
+The payload generated will contain the contents fo the github
+payload, any query parameters provided, and the headers. It will
+also add in an `event` key to designate what type of event was
+received.
+
+```json
+...
+"data": {
+  "github": {
+    "event": "X_GITHUB_EVENT",
+    "query": QUERY_PARAMS,
+    "headers": HTTP_HEADERS,
+    GITHUB_PAYLOAD
+  }
+}
+...
+```
+
+## Formatters
+
+* `Jackal::Github::Formatter::CodeFetcher` Formats payload for code fetcher
+
+# Info
+
+* Repository: https://github.com/carnivore-rb/jackal-github
+* IRC: Freenode @ #carnivore

data/jackal-github.gemspec

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + '/lib/'
+require 'jackal-github/version'
+Gem::Specification.new do |s|
+  s.name = 'jackal-github'
+  s.version = Jackal::Github::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'
+  s.description = 'GitHub payload event helper'
+  s.require_path = 'lib'
+  s.license = 'Apache 2.0'
+  s.add_runtime_dependency 'jackal'
+  s.add_development_dependency 'carnivore-http'
+  s.files = Dir['lib/**/*'] + %w(jackal-github.gemspec README.md CHANGELOG.md CONTRIBUTING.md LICENSE)
+end

data/lib/jackal-github.rb

@@ -0,0 +1,10 @@
+require 'jackal'
+
+module Jackal
+  module Github
+    autoload :Eventer, 'jackal-github/eventer'
+  end
+end
+
+require 'jackal-github/formatter'
+require 'jackal-github/version'

data/lib/jackal-github/eventer.rb

@@ -0,0 +1,62 @@
+require 'jackal-github'
+
+module Jackal
+  module Github
+    # Process events
+    class Eventer < Callback
+
+      # Validity of message
+      #
+      # @param message [Carnivore::Message]
+      # @return [Truthy, Falsey]
+      def valid?(message)
+        super do |_|
+          message[:message].get(:headers, :x_github_event)
+        end
+      end
+
+      # Format payload based on event type recevied
+      #
+      # @param message [Carnivore::Message]
+      def execute(message)
+        failure_wrap(message) do |_|
+          content = format_payload(message)
+          payload = new_payload(name_for_payload(content), content)
+          job_completed(:github, payload, message)
+        end
+      end
+
+      # Format the github event to store within the payload
+      #
+      # @param message [Carnivore::Message]
+      # @return [Smash]
+      def format_payload(message)
+        content = Smash.new
+        g_payload = message[:message][:body]
+        g_headers = message[:message][:headers] || {}
+        g_query = message[:message][:query] || {}
+        content[:github] = g_payload.merge(
+          Smash.new(
+            :event => g_headers[:x_github_event],
+            :query => g_query,
+            :headers => g_headers,
+            :url_path => message[:message][:request].path
+          )
+        )
+        content
+      end
+
+      # Provide payload name for given event
+      #
+      # @param event [String] github event
+      # @return [String] payload name
+      # @note defaults to `github`
+      def name_for_payload(event)
+        config.fetch(:names, event,
+          config.fetch(:names, :default, :github)
+        )
+      end
+
+    end
+  end
+end

data/lib/jackal-github/formatter.rb

@@ -0,0 +1 @@
+require 'jackal-github/formatter/code_fetcher'

data/lib/jackal-github/formatter/code_fetcher.rb

@@ -0,0 +1,121 @@
+require 'jackal-github'
+
+module Jackal
+  module Github
+    module Formatter
+
+      class CodeFetcher < Jackal::Formatter
+
+        # Format payloads from source
+        SOURCE = '*'
+        # Formats for destination
+        DESTINATION = 'code_fetcher'
+
+        # Format the payload to provide code fetcher information
+        #
+        # @param payload [Smash]
+        # @return [Smash]
+        def format(payload)
+          if(payload.get(:data, :github))
+            payload.set(:data, :code_fetcher, :info, :source, 'github')
+            payload.set(:data, :code_fetcher, :info, :owner,
+              payload.get(:data, :github, :repository, :owner, :login))
+            payload.set(:data, :code_fetcher, :info, :name,
+              payload.get(:data, :github, :repository, :name))
+            payload.set(:data, :code_fetcher, :info, :private,
+              payload.get(:data, :github, :repository, :private))
+            payload.set(:data, :code_fetcher, :info, :url,
+              payload.get(:data, :github, :repository, :clone_url))
+            set_reference_information(payload.get(:data, :github, :event).to_s, payload)
+            payload
+          end
+        end
+
+        # Set repository reference information into payload if
+        # available
+        #
+        # @param event [String] github event type
+        # @param payload [Smash]
+        # @return [Smash]
+        def set_reference_information(event, payload)
+          method_name = "#{event}_reference"
+          if(self.respond_to?(method_name, true))
+            ref, sha = send(method_name, payload)
+            payload.set(:data, :code_fetcher, :info, :reference, ref)
+            payload.set(:data, :code_fetcher, :info, :commit_sha, sha)
+          end
+          payload
+        end
+
+        private
+
+        # Format for commit comment event
+        #
+        # @param payload [Smash]
+        # @return [Array<String>] [reference, commit_id]
+        def commit_comment_reference(payload)
+          [payload.get(:data, :github, :comment, :commit_id),
+            payload.get(:data, :github, :comment, :commit_id)]
+        end
+
+        # Format for create event
+        #
+        # @param payload [Smash]
+        # @return [Array<String>] [reference, commit_id]
+        def create_reference(payload)
+          [payload.get(:data, :github, :ref),
+            payload.get(:data, :github, :ref)]
+        end
+        alias_method :delete_reference, :create_reference
+
+        # Format for deployment event
+        #
+        # @param payload [Smash]
+        # @return [Array<String>] [reference, commit_id]
+        def deployment_reference(payload)
+          [payload.get(:data, :github, :deployment, :ref),
+            payload.get(:data, :github, :deployment, :sha)]
+        end
+        alias_method :deployment_status_reference, :deployment_reference
+
+        # Format for pull request event
+        #
+        # @param payload [Smash]
+        # @return [Array<String>] [reference, commit_id]
+        def pull_request_reference(payload)
+          payload.set(:data, :code_fetcher, :info, :owner,
+            payload.get(:data, :github, :pull_request, :head, :repo, :owner, :login))
+          payload.set(:data, :code_fetcher, :info, :name,
+            payload.get(:data, :github, :pull_request, :head, :repo, :name))
+          payload.set(:data, :code_fetcher, :info, :private,
+            payload.get(:data, :github, :pull_request, :head, :repo, :private))
+          payload.set(:data, :code_fetcher, :info, :url,
+            payload.get(:data, :github, :pull_request, :head, :repo, :clone_url))
+          [payload.get(:data, :github, :pull_request, :head, :ref),
+            payload.get(:data, :github, :pull_request, :head, :sha)]
+        end
+
+        # Format for push event
+        #
+        # @param payload [Smash]
+        # @return [Array<String>] [reference, commit_id]
+        def push_reference(payload)
+          payload.set(:data, :code_fetcher, :info, :owner,
+            payload.get(:data, :github, :repository, :owner, :name))
+          [payload.get(:data, :github, :ref),
+            payload.get(:data, :github, :head_commit, :id)]
+        end
+
+        # Format for status event
+        #
+        # @param payload [Smash]
+        # @return [Array<String>] [reference, commit_id]
+        def status_reference(payload)
+          [payload.get(:data, :github, :sha),
+            payload.get(:data, :github, :sha)]
+        end
+
+      end
+    end
+  end
+end

data/lib/jackal-github/version.rb

@@ -0,0 +1,5 @@
+module Jackal
+  module Github
+    VERSION = Gem::Version.new('0.1.0')
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: jackal-github
+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: carnivore-http
+  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: GitHub payload event helper
+email: code@chrisroberts.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- jackal-github.gemspec
+- lib/jackal-github.rb
+- lib/jackal-github/eventer.rb
+- lib/jackal-github/formatter.rb
+- lib/jackal-github/formatter/code_fetcher.rb
+- lib/jackal-github/version.rb
+homepage: https://github.com/carnivore-rb/jackal-github
+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: