magnum-payload 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d392f76be98d4ea79c1d0d37f39bcfac1cb0766d
-  data.tar.gz: 921b9928570d5ad2f41a51d3ea3649663a1dd000
+  metadata.gz: c913ae966a34c495971151a1d01b8f42881d05b1
+  data.tar.gz: a0ae86fa239990cb949c7e6d7402958e6a7e540a
 SHA512:
-  metadata.gz: f5add8ecc03c30922eb0e954e4161248cf2e7ad5f3b01b0a66f30db8fe1581dc27fb9d679687b6654b98245e6fe510ee28098bfac5c36b7a50dd20cbeb542ae6
-  data.tar.gz: 222df38da21cd23ee037ed1116de654b6f9813be103ab854b91686ec09f38d6d0803d52eee9db7ccb44ce6187791270b59e42f8478b5bbd718bc426ac4f36e76
+  metadata.gz: 3a6cf68affc2203d60975ccc84d004f3be56bdb1188ea8066db34040a70c1897d154ac47f55692603d20f82d7d18051d97e957e02cca70e79951c021806e7024
+  data.tar.gz: feb1211463ab6c41e9ae16382c76cc8c9d315f7536e38a5601b8e813596376bd3ff8353d8e78fb8318656e15315f2205228dc6de825329e1b322eb87072ac6fe

data/Gemfile

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

data/LICENSE

@@ -1,4 +1,5 @@
-Copyright (c) 2013 Magnum CI, Dan Sosedoff <dan.sosedoff@gmail.com>
+Copyright (c) 2013-2014 Dan Sosedoff, <dan.sosedoff@gmail.com>
+Copyright (c) 2013-2014 Magnum CI, <support@magnum-ci.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

data/README.md

@@ -6,6 +6,8 @@ It accepts any commits payloads and transforms them into identical data structur
 If you need to integrate web-hooks from Github, Bitbucket or Gitlab this is definitely
 worth checking out. Check examples for details.
 
+[![build status](https://magnum-ci.com/status/1f87bb33961c21de5940142e86a741f1.png)](https://magnum-ci.com/public/0cb3a398347ebeeb90fb/builds)
+
 ## Supported platforms
 
 You can integrate with the following providers:
@@ -100,23 +102,8 @@ Magnum CI
 
 ## License
 
-MIT License
-
-Copyright (c) 2013 Magnum CI
-
-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 MIT License (MIT)
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software
+Copyright (c) 2013-2014 Dan Sosedoff, <dan.sosedoff@gmail.com>
 
-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
+Copyright (c) 2013-2014 Magnum CI, <support@magnum-ci.com>

data/lib/magnum/payload/base.rb

@@ -1,5 +1,5 @@
-require 'json'
-require 'hashr'
+require "json"
+require "hashr"
 
 module Magnum
   module Payload
@@ -7,15 +7,23 @@ module Magnum
       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
+      attr_reader :skip,            # Flag to indicate payload skip
+                  :test             # Flag to indicate a test payload
+
+      attr_reader :commit,          # Commit SHA or ID
+                  :branch,          # Commit branch name (master)
+                  :author,          # Commit author name
+                  :committer,       # Commit committer name
+                  :message,         # Commit message text
+                  :committer_email, # Committer email address
+                  :author_email,    # Commit author email address
+                  :commit_url,      # Url to view commit diff
+                  :compare_url      # URL to view multiple commits diff
 
       def initialize(payload)
-        @skip     = false # Do not skip by default
-        @test     = false # Do not treat as test payload
+        set_defaults
+        
         @raw_data = payload
         @data     = parse_payload(payload)
 
@@ -26,13 +34,13 @@ module Magnum
 
       def attributes_hash
         {
-          'commit'      => commit,
-          'branch'      => branch,
-          'author'      => author,
-          'committer'   => committer,
-          'message'     => message,
-          'commit_url'  => commit_url,
-          'compare_url' => compare_url
+          "commit"      => commit,
+          "branch"      => branch,
+          "author"      => author,
+          "committer"   => committer,
+          "message"     => message,
+          "commit_url"  => commit_url,
+          "compare_url" => compare_url
         }
       end
 
@@ -46,6 +54,11 @@ module Magnum
 
       private
 
+      def set_defaults
+        @skip = false # Do not skip
+        @test = false # Do not treat as test payload
+      end
+
       def parse_payload(payload)
         if payload.kind_of?(String)
           Hashr.new(JSON.parse(payload))

data/lib/magnum/payload/errors.rb

@@ -0,0 +1,7 @@
+module Magnum
+  module Payload
+    class Error        < StandardError ; end
+    class ParseError   < Error         ; end
+    class PayloadError < Error         ; end
+  end
+end

data/lib/magnum/payload/github.rb

@@ -19,28 +19,25 @@ module Magnum
     end
 
     def skip_payload?
-      @skip = true if deleted? || last_commit.nil?
+      @skip = true if head_deleted? || last_commit.nil?
       @skip = true if data.ref =~ /tags/
 
       @skip
     end
 
     # Check if push is forced
-    # @return [Boolean]
-    def forced?
+    def forced_push?
       data.forced == true
     end
 
-    # Check if head is deleted
-    # @return [Boolean]
-    def deleted?
+    # Check if push head is deleted
+    def head_deleted?
       data.deleted == true
     end
 
     # Get last commit in the push
-    # @return [Hashr]
     def last_commit
-      if forced?
+      if forced_push?
         data.head_commit
       else
         Hashr.new(data.commits.last)

data/lib/magnum/payload/message_parser.rb

@@ -1,11 +1,9 @@
 module Magnum
-  module Payload
-    module MessageParser
-      REGEX_SKIP = /\[(ci skip|ci-skip|skip ci|skip-ci)\]/i
+  module Payload::MessageParser
+    REGEX_SKIP = /\[(ci skip|ci-skip|skip ci|skip-ci)\]/i
 
-      def skip_message?
-        message.to_s.split("\n").first =~ REGEX_SKIP ? true : false
-      end
+    def skip_message?
+      message.to_s.split("\n").first =~ REGEX_SKIP ? true : false
     end
   end
 end

data/lib/magnum/payload/version.rb

@@ -1,5 +1,5 @@
 module Magnum
   module Payload
-    VERSION = "0.3.3"
+    VERSION = "0.3.4"
   end
 end

data/lib/magnum/payload.rb

@@ -1,20 +1,18 @@
-require 'magnum/payload/version'
+require "magnum/payload/version"
+require "magnum/payload/errors"
 
 module Magnum
   module Payload
     SOURCES = %w(custom github gitlab gitslice bitbucket beanstalk)
-
-    class ParseError   < StandardError ; end
-    class PayloadError < StandardError ; end
-
-    autoload :Base,          'magnum/payload/base'
-    autoload :Custom,        'magnum/payload/custom'
-    autoload :Github,        'magnum/payload/github'
-    autoload :Gitlab,        'magnum/payload/gitlab'
-    autoload :Gitslice,      'magnum/payload/gitslice'
-    autoload :Bitbucket,     'magnum/payload/bitbucket'
-    autoload :Beanstalk,     'magnum/payload/beanstalk'
-    autoload :MessageParser, 'magnum/payload/message_parser'
+    
+    autoload :Base,          "magnum/payload/base"
+    autoload :Custom,        "magnum/payload/custom"
+    autoload :Github,        "magnum/payload/github"
+    autoload :Gitlab,        "magnum/payload/gitlab"
+    autoload :Gitslice,      "magnum/payload/gitslice"
+    autoload :Bitbucket,     "magnum/payload/bitbucket"
+    autoload :Beanstalk,     "magnum/payload/beanstalk"
+    autoload :MessageParser, "magnum/payload/message_parser"
 
     def self.valid_source?(source)
       SOURCES.include?(source.to_s)

data/magnum-payload.gemspec

@@ -1,24 +1,24 @@
-require File.expand_path('../lib/magnum/payload/version', __FILE__)
+require File.expand_path("../lib/magnum/payload/version", __FILE__)
 
-Gem::Specification.new do |s|
-  s.name        = "magnum-payload"
-  s.version     = Magnum::Payload::VERSION
-  s.summary     = "Code payload parser"
-  s.description = "Allows to parse code payloads from Github, Bitbucket and many more"
-  s.homepage    = "https://github.com/magnumci/magnum-payload"
-  s.authors     = ["Dan Sosedoff"]
-  s.email       = ["dan.sosedoff@gmail.com"]
-  s.license     = 'MIT'
+Gem::Specification.new do |spec|
+  spec.name        = "magnum-payload"
+  spec.version     = Magnum::Payload::VERSION
+  spec.summary     = "Code payload parser"
+  spec.description = "Parse code pushes from multiple code hosting platforms"
+  spec.homepage    = "https://github.com/magnumci/magnum-payload"
+  spec.authors     = ["Dan Sosedoff"]
+  spec.email       = ["dan.sosedoff@gmail.com"]
+  spec.license     = "MIT"
   
-  s.add_development_dependency 'rake',      '~> 10'
-  s.add_development_dependency 'rspec',     '~> 2.13'
-  s.add_development_dependency 'simplecov', '~> 0.7'
+  spec.add_development_dependency "rake",      "~> 10"
+  spec.add_development_dependency "rspec",     "~> 2.13"
+  spec.add_development_dependency "simplecov", "~> 0.8"
 
-  s.add_runtime_dependency 'json', '>= 1.8'
-  s.add_runtime_dependency 'hashr', '>= 0'
+  spec.add_runtime_dependency "json", ">= 1.8"
+  spec.add_runtime_dependency "hashr", ">= 0"
   
-  s.files         = `git ls-files`.split("\n")
-  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"]
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 end

data/spec/payload/base_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
 describe Magnum::Payload::Base do
+  let(:base) { described_class }
+
   before do
     Magnum::Payload::Base.any_instance.stub(:parse!)
   end
@@ -9,33 +11,33 @@ describe Magnum::Payload::Base do
     it 'assigns raw data attribute' do
       Magnum::Payload::Base.any_instance.stub(:parse_payload)
 
-      payload = Magnum::Payload::Base.new("raw data")
+      payload = base.new("raw data")
       payload.raw_data.should eq 'raw data'
     end
 
     it 'assigns data attribute' do
-      payload = Magnum::Payload::Base.new({'foo' => 'bar'})
+      payload = base.new({'foo' => 'bar'})
       payload.data.should be_a Hashr
     end
 
     it 'accepts a String' do
-      payload = Magnum::Payload::Base.new('{"foo":"bar"}')
+      payload = base.new('{"foo":"bar"}')
       payload.data.should be_a Hashr
       payload.data.foo.should eq 'bar'
     end
 
     it 'accepts a Hash' do
-      payload = Magnum::Payload::Base.new({'foo' => 'bar'})
+      payload = base.new({'foo' => 'bar'})
       payload.data.should be_a Hashr
       payload.data.foo.should eq('bar')
     end
 
     it 'raises error on invalid input type' do
-      expect { Magnum::Payload::Base.new(nil) }.to raise_error "String or Hash required"
+      expect { base.new(nil) }.to raise_error "String or Hash required"
     end
 
     it 'raises error on invalid json' do
-      expect { Magnum::Payload::Base.new("invalid json") }.
+      expect { base.new("invalid json") }.
         to raise_error Magnum::Payload::ParseError, "Valid JSON required"
     end
   end
@@ -46,7 +48,18 @@ describe Magnum::Payload::Base do
     end
 
     it 'should be false' do
-      Magnum::Payload::Base.new('data').skip.should eq false
+      base.new('data').skip.should eq false
+    end
+  end
+
+  describe "#skip?" do
+    before do
+      Magnum::Payload::Base.any_instance.stub(:parse_payload)
+      Magnum::Payload::Base.any_instance.stub(:skip) { true }
+    end
+
+    it "returns true if skip" do
+      expect(base.new("data").skip?).to be_true
     end
   end
 end

data/spec/payload/message_parser_spec.rb

@@ -1,44 +1,43 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Magnum::Payload::MessageParser do
-  let(:klass) { class Klass ; include Magnum::Payload::MessageParser ; end }
-  let(:subject) { klass.new }
+  let(:subject) { TestMessageParser.new }
 
-  describe '#skip_message?' do
-    it 'returns true when message contains "ci-skip"' do
-      subject.stub(:message).and_return('Commit message [ci-skip]')
-      subject.skip_message?.should eq true
+  describe "#skip_message?" do
+    it "returns true when message contains 'ci-skip'" do
+      subject.stub(:message).and_return("Commit message [ci-skip]")
+      expect(subject.skip_message?).to be_true
     end
 
-    it 'returns true when message contains "ci skip"' do
-      subject.stub(:message).and_return('Commit message [ci skip]')
-      subject.skip_message?.should eq true
+    it "returns true when message contains 'ci skip'" do
+      subject.stub(:message).and_return("Commit message [ci skip]")
+      expect(subject.skip_message?).to be_true
     end
 
-    it 'returns true when message contains "skip ci"' do
-      subject.stub(:message).and_return('Commit message [skip ci]')
-      subject.skip_message?.should eq true
+    it "returns true when message contains 'skip ci'" do
+      subject.stub(:message).and_return("Commit message [skip ci]")
+      expect(subject.skip_message?).to be_true
     end
 
-    it 'returns true when message contains "skip-ci"' do
-      subject.stub(:message).and_return('Commit message [skip-ci]')
-      subject.skip_message?.should eq true
+    it "returns true when message contains 'skip-ci'" do
+      subject.stub(:message).and_return("Commit message [skip-ci]")
+      expect(subject.skip_message?).to be_true
     end
 
-    it 'returns false if no skip points found' do
-      subject.stub(:message).and_return('Commit message')
-      subject.skip_message?.should eq false
+    it "returns false if no skip points found" do
+      subject.stub(:message).and_return("Commit message")
+      expect(subject.skip_message?).to be_false
     end
 
-    context 'with multi-line message' do
-      it 'returns true' do
+    context "with multi-line message" do
+      it "returns true" do
         subject.stub(:message).and_return("Commit message [skip-ci]\nCommit comments")
-        subject.skip_message?.should eq true
+        expect(subject.skip_message?).to be_true
       end
 
-      it 'returns false' do
+      it "returns false" do
         subject.stub(:message).and_return("Commit message\nLets skip [ci-skip]")
-        subject.skip_message?.should eq false
+        expect(subject.skip_message?).to be_false
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,12 +1,15 @@
-$:.unshift File.expand_path("../..", __FILE__)
-
-require 'magnum/payload'
-require 'simplecov'
+require "simplecov"
 
 SimpleCov.start do
-  add_group 'Magnum::Payload', 'lib/magnum/payload'
+  add_filter ".bundle"
+  add_group "Magnum::Payload", "lib/magnum/payload"
 end
 
+require "magnum/payload"
+
+# Include all support files
+Dir["./spec/support/**/*.rb"].each { |f| require(f) }
+
 def fixture_path(filename=nil)
   path = File.expand_path("../fixtures", __FILE__)
   filename.nil? ? path : File.join(path, filename)

data/spec/support/test_message_parser.rb

@@ -0,0 +1,3 @@
+class TestMessageParser
+  include Magnum::Payload::MessageParser
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magnum-payload
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Dan Sosedoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-20 00:00:00.000000000 Z
+date: 2014-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +80,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Allows to parse code payloads from Github, Bitbucket and many more
+description: Parse code pushes from multiple code hosting platforms
 email:
 - dan.sosedoff@gmail.com
 executables: []
@@ -99,6 +99,7 @@ files:
 - lib/magnum/payload/beanstalk.rb
 - lib/magnum/payload/bitbucket.rb
 - lib/magnum/payload/custom.rb
+- lib/magnum/payload/errors.rb
 - lib/magnum/payload/github.rb
 - lib/magnum/payload/gitlab.rb
 - lib/magnum/payload/gitslice.rb
@@ -130,6 +131,7 @@ files:
 - spec/payload/message_parser_spec.rb
 - spec/payload_spec.rb
 - spec/spec_helper.rb
+- spec/support/test_message_parser.rb
 homepage: https://github.com/magnumci/magnum-payload
 licenses:
 - MIT
@@ -150,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Code payload parser
@@ -180,3 +182,4 @@ test_files:
 - spec/payload/message_parser_spec.rb
 - spec/payload_spec.rb
 - spec/spec_helper.rb
+- spec/support/test_message_parser.rb