magnum-payload 0.3.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWM5YzVmNTc0ZTJhZTIwNDA4OGExODViN2E2NDdkOWViMjI4MWQxNw==
+  data.tar.gz: !binary |-
+    NWQzZjM0NmZiYWNiMzhhYzgwM2MxZWVhY2RkNzdmMjVjODMyOTIyYQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MDM2MWEyNzhiNjkxYTI3OTZiMDI3M2VmYjBjYTgwYWQzOGRjNmFjNmE2Zjg4
+    MWFmOTFjZThjNTBlOWEwYmI2NzgxMTUzY2I4N2I5Y2NjYmY4M2I0MDg5NmNj
+    NDE0NTliNjlmMzEzOWRiYTBmZmRlM2MyNTNjZDBkYjFhNmU4MDk=
+  data.tar.gz: !binary |-
+    OGVmMGM2ZTU5MjFmNmFmZDQwOWVkOTE3M2UzZTMxYTNmYTI1N2E1ZWQzNTVk
+    NTc3MWFmNWUyZGIxOTAzMTZhZmIyNjE1ODgxYjQ1NGFlYmM1MWFkZmIyNGNj
+    MTA2Y2YzYjJjNWM5ODRlYTAwMjAwMzA5MzFiMzIwODEyZTc1OWY=

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+*.swp
+*.tmproj
+*~
+.DS_Store
+.\#*
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+\#*
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=documentation

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec
+
+group :test do
+  gem 'simplecov', :require => false
+end

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2013 Magnum CI, Dan Sosedoff <dan.sosedoff@gmail.com>
+
+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,107 @@
+# magnum-payload
+
+Ruby library to parse and process JSON-formatted payloads from code hosting providers. 
+It accepts any commits payloads and transforms them into identical data structures. 
+
+If you need to integrate web-hooks from Github, Bitbucket or Gitlab this is definitely
+worth checking out. Check examples for details.
+
+## Supported platforms
+
+You can integrate with the following providers:
+
+- [Github](https://github.com) - git
+- [Bitbucket](https://bitbucket.org) - git, mercurial
+- [Gitlab](http://gitlab.org/) - git
+- [Beanstalkapp](http://beanstalkapp.com/) - git, mercurial, subversion
+- Your own server - git
+
+## Installation
+
+Add dependency to Gemfile:
+
+```
+gem 'magnum-payload', 
+  github: 'magnumci/magnum-payload', 
+  require: 'magnum/payload'
+```
+
+NOTE: Library is not distributed via Rubygems.
+
+## Usage
+
+Example:
+
+```ruby
+require 'magnum/payload'
+
+# Shorthand method to parse payload
+Magnum::Payload.parse('github', 'JSON data')    # => Magnum::Payload::Github
+Magnum::Payload.parse('bitbucket', 'JSON data') # => Magnum::Payload::Bitbucket
+Magnum::Payload.parse('gitlab', 'JSON data')    # => Magnum::Payload::Bitbucket
+
+# Or directly initialize a class
+payload = Magnum::Payload::Github.new('JSON data')
+
+# Detect skip
+payload.skip?
+payload.skip_message?
+```
+
+See `Payload Attributes` section for payload instance details.
+
+## Payload Classes
+
+All payload classes are inherited from `Magnum::Payload::Base`:
+
+- Magnum::Payload::Github
+- Magnum::Payload::Gitlab
+- Magnum::Payload::Beanstalk
+- Magnum::Payload::Bitbucket
+- Magnum::Payload::Custom
+
+## Payload Attributes
+
+Attributes are depending on payload class.
+
+- `raw_data`        - Original payload string or hash
+- `data`            - Formatted hash instance
+- `skip`            - Skip flag that indicated full payload skip (deleted head, etc)
+- `commit`          - Code revision (SHA1, number)
+- `branch`          - Code branch name (git, hg, svn)
+- `author`          - Commit author name
+- `committer`       - Commit committer name (git)
+- `message`         - Commit message text
+- `committer_email` - Committer email (git)
+- `author_email`    - Author email (git)
+- `commit_url`      - Direct URL to view commit diff
+- `compare_url`     - Direct URL to view commits diff
+
+## Test Suite
+
+To execute test suite run:
+
+```
+rake test
+```
+
+## License
+
+Copyright (c) 2013 Magnum CI, Dan Sosedoff <dan.sosedoff@gmail.com>
+
+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/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+require 'bundler/gem_tasks'
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/lib/magnum/payload/base.rb

@@ -0,0 +1,62 @@
+require 'json'
+require 'hashr'
+
+module Magnum
+  module Payload
+    class Base
+      include Magnum::Payload::MessageParser
+
+      attr_reader :raw_data, :data
+      attr_reader :skip, :test
+
+      attr_reader :commit, :branch, :author, :committer, :message
+      attr_reader :committer_email, :author_email
+      attr_reader :commit_url, :compare_url
+
+      def initialize(payload)
+        @skip     = false # Do not skip by default
+        @test     = false # Do not treat as test payload
+        @raw_data = payload
+        @data     = parse_payload(payload)
+
+        parse!
+
+        @skip = skip_message? unless @skip
+      end
+
+      def attributes_hash
+        {
+          'commit'      => commit,
+          'branch'      => branch,
+          'author'      => author,
+          'committer'   => committer,
+          'message'     => message,
+          'commit_url'  => commit_url,
+          'compare_url' => compare_url
+        }
+      end
+
+      def parse!
+        raise "Not implemented in base class"
+      end
+
+      def skip?
+        skip == true
+      end
+
+      private
+
+      def parse_payload(payload)
+        if payload.kind_of?(String)
+          Hashr.new(JSON.parse(payload))
+        elsif payload.kind_of?(Hash)
+          Hashr.new(payload)
+        else
+          raise ArgumentError, "String or Hash required"
+        end
+      rescue JSON::ParserError
+        raise Magnum::Payload::ParseError, "Valid JSON required"
+      end
+    end
+  end
+end

data/lib/magnum/payload/beanstalk.rb

@@ -0,0 +1,43 @@
+module Magnum
+  class Payload::Beanstalk < Payload::Base
+    def parse!
+      data.revision ? parse_svn! : parse_git!
+      detect_fake_payload!
+    end
+
+    def last_commit
+      @last_commit ||= Hashr.new(data.commits.last)
+    end
+
+    private
+
+    def parse_git!
+      @commit       = last_commit.id
+      @branch       = data.branch
+      @message      = last_commit.message
+      @author       = last_commit.author.name
+      @author_email = last_commit.author.email
+      @commit_url   = last_commit.url
+    end
+
+    def parse_svn!
+      @commit          = data.revision
+      @branch          = 'master'
+      @author          = data.author_full_name || data.author
+      @author_email    = data.author_email
+      @committer       = @author
+      @committer_email = @author_email
+      @commit_url      = data.changeset_url
+      @message         = data.message
+    end
+
+    def detect_fake_payload!
+      if data.before && data.after
+        if data.before =~ /^[0]+$/ && data.after =~ /^[1]+$/
+          @skip = true
+          @test = true
+        end
+      end
+    end
+  end
+end

data/lib/magnum/payload/bitbucket.rb

@@ -0,0 +1,53 @@
+module Magnum
+  class Payload::Bitbucket < Payload::Base
+    def parse!
+      commit = Hashr.new(data.commits.last)
+
+      branch   = commit.branch || commit.branches.first || 'none'
+      revision = commit.revision || commit.raw_node
+      author   = parse_author(commit.raw_author)
+
+      @commit       = revision
+      @author       = author.name
+      @author_email = author.email
+      @message      = commit.message.strip
+      @branch       = branch
+      @commit_url   = make_url("commits/#{revision}")
+
+      if data.commits.size > 1
+        parse_compare_url(revision)
+      end
+    end
+
+    def make_url(path=nil)
+      [site_url, repo_url, path].compact.join
+    end
+
+    def site_url
+      data.canon_url
+    end
+
+    def repo_url
+      data.repository.absolute_url
+    end
+
+    def parse_author(str)
+      case str
+      when /<.+>/
+        m, name, email = *str.match(/(.*) <(.+?)>/)
+        Hashr.new(:name => name, :email => email)
+      else
+        Hashr.new(:name => str)
+      end
+    end
+
+    private
+
+    def parse_compare_url(revision)
+      first_commit = Hashr.new(data.commits.first)
+      rev_start    = first_commit.revision || first_commit.raw_node
+      rev_end      = revision
+      @compare_url = make_url("compare/#{rev_start}..#{rev_end}")
+    end
+  end
+end

data/lib/magnum/payload/custom.rb

@@ -0,0 +1,19 @@
+module Magnum
+  class Payload::Custom < Payload::Base
+    def parse!
+      assign_payload
+    end
+
+    private
+
+    def assign_payload
+      @commit          = data.commit
+      @author          = data.author
+      @committer       = data.committer
+      @message         = data.message
+      @branch          = data.branch
+      @commit_url      = data.commit_url
+      @compare_url     = data.compare_url
+    end
+  end
+end

data/lib/magnum/payload/github.rb

@@ -0,0 +1,50 @@
+module Magnum
+  class Payload::Github < Payload::Base
+    def parse!
+      assign_payload unless skip_payload?
+    end
+
+    private
+
+    def assign_payload
+      @commit          = last_commit.id
+      @author          = last_commit.author.name
+      @author_email    = last_commit.author.email
+      @committer       = last_commit.committer.name
+      @committer_email = last_commit.committer.email
+      @message         = last_commit.message
+      @branch          = data.ref.split('/').last
+      @commit_url      = last_commit.url
+      @compare_url     = data.compare
+    end
+
+    def skip_payload?
+      @skip = true if deleted? || last_commit.nil?
+      @skip = true if data.ref =~ /tags/
+
+      @skip
+    end
+
+    # Check if push is forced
+    # @return [Boolean]
+    def forced?
+      data.forced == true
+    end
+
+    # Check if head is deleted
+    # @return [Boolean]
+    def deleted?
+      data.deleted == true
+    end
+
+    # Get last commit in the push
+    # @return [Hashr]
+    def last_commit
+      if forced?
+        data.head_commit
+      else
+        Hashr.new(data.commits.last)
+      end
+    end
+  end
+end

data/lib/magnum/payload/gitlab.rb

@@ -0,0 +1,38 @@
+module Magnum
+  class Payload::Gitlab < Payload::Base
+    ZERO_SHA = /\A[0]{40}\z/
+
+    def parse!
+      assign_payload unless skip_payload?
+    end
+
+    def last_commit
+      @last_commit ||= Hashr.new(data.commits.last)
+    end
+
+    private
+
+    def assign_payload
+      @commit = data.after
+      @branch = data.ref.split('/').last
+
+      if data.commits.any?
+        @author          = last_commit.author.name
+        @author_email    = last_commit.author.email
+        @committer       = @author
+        @committer_email = @author_email
+        @message         = last_commit.message
+        @commit_url      = last_commit.url
+      end
+    end
+
+    def skip_payload?
+      @skip = true if deleted?
+      @skip
+    end
+
+    def deleted?
+      data.before !~ ZERO_SHA && data.after =~ ZERO_SHA
+    end
+  end
+end