travis-cli-gh 0.0.2.travis.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTdmMzc1YzkyNDZlZTZhNTExNjU1NWU4ZTU5N2ViZjk2NDdlYTI5YQ==
+  data.tar.gz: !binary |-
+    YzlmNjQ2NzlmNzNmM2E4MGQyOTQ5MTFhNTVkMTE5ZWQ1ZWJjOTBiMg==
+SHA512:
+  metadata.gz: !binary |-
+    NjFiNTZjZWRlMjM3NTRhNjcxMzMyODVhYzk5ZDcxODViMTEwYWM1OWQ5ZWIw
+    ZTViYTU1Y2NlOWYzMmQwODMzZmRmYjhlM2JiM2M4M2U5MGMwYWUyZWZjMWM5
+    ZmEzZjkxMDdiYzk1NjYxYTYwNDZkZjk0MTU1MGQxY2FlYzJmODk=
+  data.tar.gz: !binary |-
+    MTE2ZjMwZGI4MmUxMDBkZGI2YzRmN2E5MTM2ODg2MDE5MDY4NmFmMTRmYTcx
+    NzdlOTMwYWJlZjY2MjA5Y2YwM2IxNzgxYWFlNDRkMzEwMjJmNDE2MTkwMDUw
+    ZDA1ODY0ZmEwYWMzNWI1NGE4YzExMGM2NDhmZDdkODJkMGYxNmE=

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+Makefile

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+- 2.0.0
+- 2.1.0
+script: bundle exec rspec -bc
+deploy:
+  provider: rubygems
+  api_key:
+    secure: AAZsdcsu1vs/T1e+zu6GQtsXjllJhQGxl2VpPFyEJCF2RamZTH13yEoZg1WhySDPhF9lG9tVh6XstK0AiC8Skui0g1UhrGLsyqF+AEqAHnSkdGudqV4OWUWXN78C12DZdWR1825k46ZQG7PVYIUpShN1Fu/VUNK+oK0Pydrk+vw=
+  gem: travis-cli-gh
+  on:
+    repo: travis-ci/travis-cli-gh

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Konstantin Haase
+
+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,60 @@
+# GitHub Plugin for Travis CLI
+
+This plugin for the [Travis Command Line Client](https://github.com/travis-ci/travis#readme) adds commands that interact with the [GitHub API](http://developer.github.com/v3/) rather than the Travis API. This plugin requires Ruby 2.0 or newer.
+
+## Usage
+
+This plugin adds the following commands: [`gh-login`](#gh-login) and [`gh-signature`](#gh-signature). All these commands will use the Travis API endpoint for automatically figuring out which GitHub API endpoint to use (relevant for setups using GitHub Enterprise).
+
+### `gh-login`
+
+This command basically mimics [`travis login`](https://github.com/travis-ci/travis#login) with the notable difference that it does not delete the token on GitHub afterwards (as it will be needed for running other commands) and does not send the GitHub token to Travis CI. Instead, it will store the GitHub token for later use.
+
+Note that it might not be necessary to run this command if you already have a GitHub token available (for instance, in your .netrc).
+
+### `gh-signature`
+
+This command lets you calculate the signature [used for web hooks](http://about.travis-ci.org/docs/user/notifications/#Authorization):
+
+    $ travis gh-signature
+    Signature used for travis-ci/travis web hooks: 57ca05aa0db5d27d20b2df24e27e2a191deeb7dd37075d921b76b95eddf60b9b
+
+You can use this signature in your web application to verify that a hook was indeed fired by Travis CI.
+
+Like [other commands](https://github.com/travis-ci/travis#repository-commands), it uses the current directory to determine the repository slug. It is also possible to provide it explicitly:
+
+    $ travis gh-signature -r sinatra/sinatra
+    Signature used for travis-ci/travis web hooks: 68db16bb1ec6e38e31c3eg35f38f3b2102effc8ee48186e1032c87c106feeg71
+
+This signature should be kept somewhat secret, otherwise other people can send you fake web hooks.
+
+### `gh-whoami`
+
+Displays which GitHub account you are logged in with on GitHub.
+
+    $ travis gh-whoami
+    logged in as rkh
+
+## Installation
+
+You install it like any other gem:
+
+    $ gem install travis-cli-gh
+
+We also push pre-releases to rubygems.org on a regular basis:
+
+    $ gem install travis-cli-gh --pre
+
+### Running against a local clone
+
+If you want to run commands from a local clone of the travis-cli-gh repository (say, if you want to contribute a patch), make sure you have the lib directory on your load path.
+
+Here's an example:
+
+    $ ruby -Ilib -S travis gh-signature
+
+## Version History
+
+**0.1.0** (not yet released)
+
+* Initial release

data/init.rb

@@ -0,0 +1,18 @@
+begin
+  raise LoadError, "requires Ruby 2.0 or later" if RUBY_VERSION < '2.0'
+  require 'travis/cli/gh'
+  Travis::CLI::Gh.setup
+rescue LoadError => e
+  require 'travis/cli'
+
+  dummy = Class.new(Travis::CLI::Command) do
+    define_method(:run) { error "GitHub plugin not available: #{color e.message, :bold}" }
+  end
+
+  Travis::CLI.module_eval do
+    alias_method :command_without_gh, :command unless method_defined? :command_without_gh
+    define_method(:command) do |name|
+      name =~ /^gh-/ ? dummy : command_without_gh(name)
+    end
+  end
+end

data/lib/travis/cli/gh.rb

@@ -0,0 +1,52 @@
+require 'travis/cli'
+require 'fileutils'
+
+module Travis
+  module CLI
+    module Gh
+      autoload :GitHub,      'travis/cli/gh/github'
+      autoload :Login,       'travis/cli/gh/login'
+      autoload :Signature,   'travis/cli/gh/signature'
+      autoload :Subcommands, 'travis/cli/gh/subcommands'
+      autoload :VERSION,     'travis/cli/gh/version'
+      autoload :Whoami,      'travis/cli/gh/whoami'
+
+      extend self
+
+      def setup(force = false)
+        setup_commands(force)
+        setup_plugin(force)
+        setup_completion(force)
+      end
+
+      def setup_commands(force)
+        CLI.singleton_class.send(:prepend, Subcommands)
+      end
+
+      def setup_plugin(force)
+        target_dir = File.expand_path('travis-cli-gh', config_path)
+        target     = File.expand_path('init.rb', target_dir)
+        source     = File.expand_path('../../../init.rb', __dir__)
+        if force or !File.exist?(target)
+          FileUtils.mkdir_p(target_dir)
+          FileUtils.cp(source, target)
+        end
+      end
+
+      def setup_completion(force)
+        cmp_file = File.expand_path('travis.sh', config_path)
+        unless File.exist?(cmp_file) and File.read(cmp_file).include?("travis-cli-gh #{VERSION}")
+          require 'travis/tools/completion'
+          Travis::Tools::Completion.compile
+          Travis::Tools::Completion.update_completion
+          content = File.read(cmp_file)
+          File.write(cmp_file, "# travis-cli-gh #{VERSION}\n\n#{content}")
+        end
+      end
+
+      def config_path
+        ENV.fetch('TRAVIS_CONFIG_PATH') { File.expand_path('.travis', ENV['HOME']) }
+      end
+    end
+  end
+end

data/lib/travis/cli/gh/github.rb

@@ -0,0 +1,60 @@
+require 'travis/tools/github'
+
+module Travis::CLI
+  module Gh
+    module GitHub
+      module Anonymous
+        def gh
+          GH
+        end
+      end
+
+      module Authenticated
+        def gh
+          @gh ||= auth.with_token do |token|
+            plugin_config['token'] = token
+            GH.with(token: token)
+          end
+        end
+
+        def auth
+          @auth ||= Travis::Tools::Github.new(session.config['github']) do |g|
+            g.note          = "token for travis-cli-gh"
+            g.scopes        = ['user', 'user:email', 'repo']
+            g.manual_login  = false
+            g.explode       = explode?
+            g.auto_token    = true
+            g.auto_password = true
+            g.drop_token    = false
+            g.github_token  = plugin_config['token'] || endpoint_config['pr_token']
+            g.check_token   = !g.github_token
+            g.ask_login     = proc { ask("Username: ") }
+            g.ask_password  = proc { |user| ask("Password for #{user}: ") { |q| q.echo = "*" } }
+            g.ask_otp       = proc { |user| ask("Two-factor authentication code for #{user}: ") }
+            g.debug         = proc { |log| debug(log) }
+            g.after_tokens  = proc { g.explode = true and error("no suitable github token found, try running gh-login.") }
+          end
+        end
+
+        def plugin_config
+          config['gihub'] ||= {}
+          config['gihub'][github_endpoint.host] ||= {}
+        end
+      end
+
+      module Hooks
+        def hooks
+          @hooks ||= gh["/repos/#{repository.slug}/hooks"]
+        rescue GH::Error
+          error "admin access needed for #{repository.slug} in order to access hooks"
+        end
+
+        def travis_hook
+          @travis_hook ||= hooks.detect { |h| h['name'] == 'travis' }
+          error "GitHub hook not found. Project might not be enabled." unless @travis_hook
+          @travis_hook
+        end
+      end
+    end
+  end
+end

data/lib/travis/cli/gh/login.rb

@@ -0,0 +1,29 @@
+module Travis::CLI
+  module Gh
+    class Login < ApiCommand
+      description "authenticates against GitHub and stores the token"
+      include GitHub::Authenticated
+
+      def run
+        say color("Successfully logged in as #{color(gh['user']['login'], :bold)}", :success)
+      end
+
+      def auth
+        auth               = super
+        auth.manual_login  = true
+        auth.auto_password = false
+        auth.auto_token    = false
+        auth.github_token  = nil
+        auth.check_token   = false
+        auth.login_header  = proc { login_header }
+        auth
+      end
+
+      def login_header
+        say "We need your #{color("GitHub login", :important)} to identify you against #{color(github_endpoint.host, :info)}."
+        say "The password will not be displayed. No information will be sent to Travis CI."
+        empty_line
+      end
+    end
+  end
+end

data/lib/travis/cli/gh/signature.rb

@@ -0,0 +1,15 @@
+require 'digest/sha2'
+
+module Travis::CLI
+  module Gh
+    class Signature < RepoCommand
+      description "generates the signature used to verify Travis CI web hooks"
+      include GitHub::Authenticated, GitHub::Hooks
+
+      def run
+        signature = Digest::SHA2.hexdigest(repository.slug + travis_hook["config"]["token"])
+        say signature, "Signature used for #{repository.slug} web hooks: %s"
+      end
+    end
+  end
+end

data/lib/travis/cli/gh/subcommands.rb

@@ -0,0 +1,32 @@
+module Travis::CLI
+  module Gh
+    module Subcommands
+      module CommandMixin
+        def description(input = nil)
+          "GitHub plugin: #{super(input)}"
+        end
+
+        def command_name
+          "gh-#{super}"
+        end
+      end
+
+      def command(name)
+        if name =~ /^gh-(.+)$/
+          const_name = command_name($1)
+          constant   = Gh.const_get(const_name) if const_name =~ /^[A-Z][a-z]+$/ and Gh.const_defined? const_name
+          constant.extend(CommandMixin) if constant
+        end
+        command?(constant) ? constant : super
+      end
+
+      def commands
+        super + gh_commands
+      end
+
+      def gh_commands
+        Gh.constants.map { |c| Gh.const_get(c).extend(CommandMixin) }.select { |c| command? c }
+      end
+    end
+  end
+end

data/lib/travis/cli/gh/version.rb

@@ -0,0 +1,7 @@
+module Travis
+  module CLI
+    module Gh
+      VERSION = '0.0.1'
+    end
+  end
+end

data/lib/travis/cli/gh/whoami.rb

@@ -0,0 +1,12 @@
+module Travis::CLI
+  module Gh
+    class Whoami < ApiCommand
+      description "displays the user you are logged in as on GitHub"
+      include GitHub::Authenticated
+
+      def run
+        say gh['user']['login'], 'logged in as %s'
+      end
+    end
+  end
+end

data/setup/extconf.rb

@@ -0,0 +1,7 @@
+$:.unshift File.expand_path('../lib', __dir__)
+
+require 'travis/cli/gh'
+Travis::CLI::Gh.setup(true)
+
+# fake Makefile
+File.open('Makefile', 'w') { |f| f.puts 'all:', 'install:' }

data/spec/subcommands_spec.rb

@@ -0,0 +1,24 @@
+require 'travis/cli'
+require 'travis/cli/gh'
+
+describe Travis::CLI::Gh::Subcommands do
+  before :all do
+    Travis::CLI::Gh.setup
+  end
+
+  it "resolves commands with gh-prefix" do
+    Travis::CLI.command('gh-signature').should be == Travis::CLI::Gh::Signature
+  end
+
+  it "lists gh commands" do
+    Travis::CLI.commands.should include(Travis::CLI::Gh::Signature)
+  end
+
+  it "prefixes the command name" do
+    Travis::CLI.command('gh-signature').command_name.should be == 'gh-signature'
+  end
+
+  it "prefixes the description" do
+    Travis::CLI.command('gh-signature').description.should start_with("GitHub plugin: ")
+  end
+end

data/travis-cli-gh.gemspec

@@ -0,0 +1,30 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require "travis/cli/gh/version"
+
+Gem::Specification.new do |s|
+  s.name                  = "travis-cli-gh"
+  s.version               = Travis::CLI::Gh::VERSION
+  s.author                = "Konstantin Haase"
+  s.email                 = "konstantin@travis-ci.com"
+  s.homepage              = "https://github.com/travis-ci/travis-cli-gh"
+  s.summary               = %q{GitHub plugin for Travis CI command line client}
+  s.description           = %q{Adds commands to interact with the GitHub API}
+  s.license               = 'MIT'
+  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_path          = 'lib'
+  s.extensions            = ["setup/extconf.rb"]
+  s.required_ruby_version = '>= 2.0.0'
+
+  # runtime dependencies
+  s.add_dependency 'travis', '~> 1.6'
+  s.add_dependency 'gh',     '~> 0.13'
+
+  # development depenendencies
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+
+  # prereleases from Travis CI
+  s.version = s.version.to_s.succ + ".travis.#{ENV['TRAVIS_JOB_NUMBER']}" if ENV['CI']
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: travis-cli-gh
+version: !ruby/object:Gem::Version
+  version: 0.0.2.travis.1.1
+platform: ruby
+authors:
+- Konstantin Haase
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: travis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: gh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !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'
+description: Adds commands to interact with the GitHub API
+email: konstantin@travis-ci.com
+executables: []
+extensions:
+- setup/extconf.rb
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- init.rb
+- lib/travis/cli/gh.rb
+- lib/travis/cli/gh/github.rb
+- lib/travis/cli/gh/login.rb
+- lib/travis/cli/gh/signature.rb
+- lib/travis/cli/gh/subcommands.rb
+- lib/travis/cli/gh/version.rb
+- lib/travis/cli/gh/whoami.rb
+- setup/extconf.rb
+- spec/subcommands_spec.rb
+- travis-cli-gh.gemspec
+homepage: https://github.com/travis-ci/travis-cli-gh
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: GitHub plugin for Travis CI command line client
+test_files: []