fastlane-plugin-github_job_status 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96e339555bf8616cb2ba48614ff44ab4e1808acf
+  data.tar.gz: ad2845d5f235c4a08847acec94b55f224258d348
+SHA512:
+  metadata.gz: 70da624cbf4782ea89567d5563a3ef7b39a9b2996c256e6391e7f8cc47e57594cd1ee7629ffc4dba715ef0fb42bcbaf6b25f5eb20f655bf0318b79432db76e6e
+  data.tar.gz: aa9175cb59af82a0fe912fdb87a922a815ec6fb832bf125300a78bb39c80d1a6b510f5dce1f7f91f9e94d7b6cf8d4c8063239f45d0e566b1a703655508bdbd27

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Justin Singer <justin.singer@appian.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,67 @@
+# github_job_status plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-github_job_status)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-github_job_status`, add it to your project by running:
+
+```bash
+fastlane add_plugin github_job_status
+```
+
+## About github_job_status
+
+Post the status of your test jobs to your pull requests. This uses GihHub's [status API](https://developer.github.com/v3/repos/statuses/). Statuses posted to pull requests look this:
+![screen shot 2016-12-16 at 2 25 20 pm](https://cloud.githubusercontent.com/assets/8180094/21275606/98432cc4-c39b-11e6-984f-25228455efd7.png)
+
+This plugin can be used in the following way:
+
+```RUBY
+github_job_status(
+  token: 'github_OAuth_token',
+  owner: 'justinsinger',
+  repo: 'fastlane_plugins',
+  sha: 'commit_sha',
+  job_name: 'good_job',
+  build_url: 'skullcrushers.gov',
+  state: 'pending'
+)
+```
+
+ * `state` must be pending, success, error, or failure
+ * `token` can be obtained in GitHub for an owner (To do this, go to settings/Personal access tokens. Generate a new token and be sure to enable `repo:status`.)
+ * `job_name` and  `build_url` are optional, but all other parameters are required
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/PluginsTroubleshooting.md) doc in the main `fastlane` repo.
+
+## Using `fastlane` Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Plugins.md).
+
+## About `fastlane`
+
+`fastlane` is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/github_job_status.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/github_job_status/version'
+
+module Fastlane
+  module GithubJobStatus
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::GithubJobStatus.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/github_job_status/actions/github_job_status_action.rb

@@ -0,0 +1,124 @@
+module Fastlane
+  module Actions
+    class GithubJobStatusAction < Action
+      require 'rest-client'
+
+      def self.run(params)
+        api = "https://api.github.com/repos"
+        url = "#{api}/#{params[:owner]}/#{params[:repo]}/statuses/#{params[:sha]}"
+
+        headers = {
+          'Authorization' => "token #{params[:token]}",
+          'User-Agent' => 'fastlane',
+          'content_type' => :json,
+          'accept' => :json
+        }
+
+        payload = {
+          state: params[:state],
+          description: description_for_state(params[:state])
+        }
+        context = params[:job_name]
+        payload['context'] = context unless context.nil?
+        target_url = params[:build_url]
+        payload['target_url'] = target_url unless target_url.nil?
+
+        begin
+          post(url, payload.to_json, headers)
+          true
+        rescue RestClient::ExceptionWithResponse => e
+          UI.error "Status failed to post to GitHub. Recieved the following response from the server: #{e.response}"
+          false
+        end
+      end
+
+      def self.post(url, payload, headers)
+        RestClient.post(url, payload, headers)
+      end
+
+      def self.description_for_state(state)
+        case state
+        when 'pending'
+          'Job pending'
+        when 'success'
+          'Job succeeded'
+        when 'error'
+          'Job failed'
+        when 'failure'
+          'Job unstable'
+        end
+      end
+
+      def self.description
+        "Post the status of your test jobs to your pull requests"
+      end
+
+      def self.authors
+        ["Justin Singer"]
+      end
+
+      def self.return_value
+        "True if status posted sucessfully, False otherwise"
+      end
+
+      def self.details
+        "Uses github's status API (https://developer.github.com/v3/repos/statuses/) to display the status of continuous integration jobs directly on pull requests."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :token,
+            env_name: 'GITHUB_JOB_STATUS_TOKEN',
+            description: 'OAuth token for :owner GitHub account',
+            verify_block: proc { |value| UI.user_error! "Token must be specified" if value.empty? }
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :owner,
+            env_name: 'GITHUB_JOB_STATUS_OWNER',
+            description: 'The github owner or username',
+            verify_block: proc { |value| UI.user_error! "Owner must be specified" if value.empty? }
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :repo,
+            env_name: 'GITHUB_JOB_STATUS_REPO',
+            description: 'The github repo',
+            verify_block: proc { |value| UI.user_error! "Repo must be specified" if value.empty? }
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :sha,
+            env_name: 'GITHUB_JOB_STATUS_SHA',
+            description: 'The github sha of the commit',
+            verify_block: proc { |value| UI.user_error! "SHA must be specified" if value.empty? }
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :job_name,
+            env_name: 'GITHUB_JOB_STATUS_JOB_NAME',
+            description: 'The string displayed next to the status indicator but before the description',
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :build_url,
+            env_name: 'GITHUB_JOB_STATUS_BUILD_URL',
+            description: 'The url of the build upon which we are reporting the status',
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :state,
+            env_name: 'GITHUB_JOB_STATUS_STATE',
+            description: 'The state of a build; must be pending, success, error, or failure',
+            verify_block: proc do |value|
+              unless ['pending', 'success', 'error', 'failure'].include?(value)
+                UI.user_error! "Invalid state '#{value}' given. State must be pending, success, error, or failure."
+              end
+            end
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/github_job_status/helper/github_job_status_helper.rb

@@ -0,0 +1,12 @@
+module Fastlane
+  module Helper
+    class GithubJobStatusHelper
+      # class methods that you define here become available in your action
+      # as `Helper::GithubJobStatusHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the github_job_status plugin helper!")
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/github_job_status/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module GithubJobStatus
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-github_job_status
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Singer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.107.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.107.0
+description: 
+email: justinsinger1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/github_job_status.rb
+- lib/fastlane/plugin/github_job_status/actions/github_job_status_action.rb
+- lib/fastlane/plugin/github_job_status/helper/github_job_status_helper.rb
+- lib/fastlane/plugin/github_job_status/version.rb
+homepage: https://github.com/justinsinger/fastlane_plugins/tree/github_job_status/fastlane-plugin-github_job_status
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Post the status of your test jobs to your pull requests
+test_files: []
+has_rdoc: