github_status_notifier 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3488a57eac600148a552af144350b9a4e08fe37
+  data.tar.gz: a68580a46abef7cf495e8ed015d8b969613642ec
+SHA512:
+  metadata.gz: f1b193113fe518e8177b9f1b84c103e6a5e581a696106822ac8cc95735391350c5470d1d6e98c7b3852c4053c7fed9b030b25f58039782a88555e6e5fd9230f9
+  data.tar.gz: 844aef7d5d6da3768bfad5c3acf9e364e5550a65ddaa0adcd4ef7888d8f52aac33b28e546eaa6d141413d2f800dc3959e2015ae0604a74c7ad8964ecb5786777

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Exclude:
+    - 'bundle_bin/*'
+    - 'vendor/bundle/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Style/FileName:
+  Exclude:
+    - exe/*
+
+Style/RegexpLiteral:
+  MaxSlashes: 0

data/.tachikoma.yml

@@ -0,0 +1 @@
+strategy: 'none'

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+sudo: false
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
+before_install:
+  - gem update bundler
+notifications:
+  email:
+    - ogataken@gmail.com
+branches:
+  only:
+    - master

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in github_status_notifier.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 sanemat
+
+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,91 @@
+# GithubStatusNotifier
+
+[![Gem Version](http://img.shields.io/gem/v/github_status_notifier.svg?style=flat)](http://badge.fury.io/rb/github_status_notifier)
+[![Build Status](http://img.shields.io/travis/packsaddle/ruby-github_status_notifier/master.svg?style=flat)](https://travis-ci.org/packsaddle/ruby-github_status_notifier)
+
+## Usage
+
+```
+# before your command
+$ github-status-notifier notify --state pending
+
+$ SOME_YOUR_COMMAND
+
+# after your command
+$ github-status-notifier notify --exit-status $?
+```
+
+## Commands
+
+```
+Commands:
+  github-status-notifier help [COMMAND]  # Describe available commands or one specific command
+  github-status-notifier notify          # Notify current status to GitHub status
+  github-status-notifier version         # Show the GithubStatusNotifier version
+
+Usage:
+  github-status-notifier notify
+
+Options:
+  [--exit-status=N]
+  [--keep-exit-status], [--no-keep-exit-status]
+  [--debug], [--no-debug]
+  [--verbose], [--no-verbose]
+  [--state=STATE]
+  [--target-url=TARGET_URL]
+  [--description=DESCRIPTION]
+  [--context=CONTEXT]
+
+Notify current status to GitHub status
+```
+
+see also: [Statuses | GitHub API](https://developer.github.com/v3/repos/statuses/)
+
+## VS.
+
+### [github-commit-status-updater](https://github.com/joker1007/github-commit-status-updater)
+
+```
+Commands:
+  github-commit-status-updater error -r, --repo=REPO -s, --sha1=SHA1    # commit status error
+  github-commit-status-updater failure -r, --repo=REPO -s, --sha1=SHA1  # commit status failure
+  github-commit-status-updater help [COMMAND]                           # Describe available commands or one specific command
+  github-commit-status-updater pending -r, --repo=REPO -s, --sha1=SHA1  # commit status pending
+  github-commit-status-updater success -r, --repo=REPO -s, --sha1=SHA1  # commit status success
+```
+
+`github-commit-status-updater` is very simple, but I want to detect `repo` and `sha1` automatically.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'github_status_notifier'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install github_status_notifier
+
+## Setting
+
+require `GITHUB_ACCESS_TOKEN`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec github_status_notifier` to use the code located in this directory, ignoring other installed copies of this gem.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/packsaddle/ruby-github_status_notifier/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/test*.rb']
+  t.verbose = true
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'github_status_notifier'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/github-status-notifier

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'github_status_notifier'
+require 'github_status_notifier/cli'
+GithubStatusNotifier::CLI.start(ARGV)

data/github_status_notifier.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github_status_notifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'github_status_notifier'
+  spec.version       = GithubStatusNotifier::VERSION
+  spec.authors       = ['sanemat']
+  spec.email         = ['o.gata.ken@gmail.com']
+
+  spec.summary       = 'Notify to GitHub status.'
+  spec.description   = 'Easy to handle GitHub status with exit status. Like TravisCI\'s build status.'
+  spec.homepage      = 'https://github.com/packsaddle/ruby-github_status_notifier'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'thor'
+  spec.add_runtime_dependency 'saddler-reporter-github'
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'test-unit'
+end

data/lib/github_status_notifier/cli.rb

@@ -0,0 +1,59 @@
+require 'thor'
+
+module GithubStatusNotifier
+  class CLI < Thor
+    def self.exit_on_failure?
+      true
+    end
+
+    desc 'version', 'Show the GithubStatusNotifier version'
+    map %w(-v --version) => :version
+
+    def version
+      puts "GithubStatusNotifier version #{::GithubStatusNotifier::VERSION}"
+    end
+
+    desc 'notify', 'Notify current status to GitHub status'
+    option :exit_status, type: :numeric
+    option :keep_exit_status, type: :boolean, default: false
+    option :debug, type: :boolean, default: false
+    option :verbose, type: :boolean, default: false
+    option :state, type: :string
+    option :target_url, type: :string
+    option :description, type: :string
+    option :context, type: :string
+    def notify
+      if options[:debug]
+        logger.level = Logger::DEBUG
+      elsif options[:verbose]
+        logger.level = Logger::INFO
+      end
+      logger.debug(options.inspect)
+      if options[:keep_exit_status] && !options[:exit_status]
+        logger.error 'keep-exit-status requires exit-status'
+        abort
+      end
+
+      params = {
+        state: options[:state],
+        exit_status: options[:exit_status],
+        target_url: options[:target_url],
+        description: options[:description],
+        context: options[:context]
+      }
+
+      notifier = Notifier.new
+      notifier.notify(params)
+
+      if options[:keep_exit_status]
+        exit options[:exit_status]
+      end
+    end
+
+    no_commands do
+      def logger
+        ::GithubStatusNotifier.logger
+      end
+    end
+  end
+end

data/lib/github_status_notifier/client.rb

@@ -0,0 +1,14 @@
+module GithubStatusNotifier
+  class Client < ::Saddler::Reporter::Github::Client
+    def create_status(state, params)
+      logger.info(['create status with these:', slug, @repo.merging_sha, state, params])
+      return_state = client.create_status(slug, @repo.merging_sha, state, params)
+      logger.debug(return_state)
+      return_state
+    end
+
+    def logger
+      ::GithubStatusNotifier.logger
+    end
+  end
+end

data/lib/github_status_notifier/notifier.rb

@@ -0,0 +1,46 @@
+module GithubStatusNotifier
+  class Notifier
+    PENDING = 'pending'
+    SUCCESS = 'success'
+    ERROR = 'error'
+    FAILURE = 'failure'
+    ALLOWED_STATUS = [PENDING, SUCCESS, ERROR, FAILURE]
+
+    def notify(params)
+      state = decide_state(params[:state], params[:exit_status])
+      repo_path = '.'
+      repo = Repository.new(repo_path)
+      client = Client.new(repo)
+      pass_params = {
+        target_url: params[:target_url],
+        description: params[:description],
+        context: decide_context(params[:context])
+      }
+      client.create_status(state, pass_params)
+    rescue StandardError => e
+      logger.error e.message
+      logger.error e.backtrace
+      client.create_status(ERROR, pass_params)
+    end
+
+    def decide_context(text)
+      text || 'github_status_notifier'
+    end
+
+    def decide_state(state, exit_status)
+      if state
+        return state.downcase if ALLOWED_STATUS.include?(state.downcase)
+        fail Error("state: #{state} is invalid. allowed #{ALLOWED_STATUS}")
+      elsif exit_status
+        return SUCCESS if exit_status.to_i == 0
+        return FAILURE
+      else
+        fail Error('require state or exit-state')
+      end
+    end
+
+    def logger
+      ::GithubStatusNotifier.logger
+    end
+  end
+end

data/lib/github_status_notifier/repository.rb

@@ -0,0 +1,4 @@
+module GithubStatusNotifier
+  class Repository < ::Saddler::Reporter::Support::Git::Repository
+  end
+end

data/lib/github_status_notifier/version.rb

@@ -0,0 +1,3 @@
+module GithubStatusNotifier
+  VERSION = '0.0.1'
+end

data/lib/github_status_notifier.rb

@@ -0,0 +1,24 @@
+require 'logger'
+require 'saddler/reporter/github'
+require 'github_status_notifier/version'
+require 'github_status_notifier/notifier'
+
+module GithubStatusNotifier
+  class Error < StandardError; end
+
+  def self.default_logger
+    logger = Logger.new(STDERR)
+    logger.progname = 'GithubStatusNotifier'
+    logger.level = Logger::WARN
+    logger
+  end
+
+  def self.logger
+    return @logger if @logger
+    @logger = default_logger
+  end
+
+  class << self
+    attr_writer :logger
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: github_status_notifier
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- sanemat
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: saddler-reporter-github
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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: Easy to handle GitHub status with exit status. Like TravisCI's build
+  status.
+email:
+- o.gata.ken@gmail.com
+executables:
+- github-status-notifier
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".tachikoma.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/github-status-notifier
+- github_status_notifier.gemspec
+- lib/github_status_notifier.rb
+- lib/github_status_notifier/cli.rb
+- lib/github_status_notifier/client.rb
+- lib/github_status_notifier/notifier.rb
+- lib/github_status_notifier/repository.rb
+- lib/github_status_notifier/version.rb
+homepage: https://github.com/packsaddle/ruby-github_status_notifier
+licenses:
+- MIT
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Notify to GitHub status.
+test_files: []