octokom 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44d6e46950110b275a00f47a37b743a493125ca2
-  data.tar.gz: edb4f1b026404ddd5d7776a518f674dc720fceb7
+  metadata.gz: 1e09a35e0cf96d8108161d2e98d3b0bb2eef732d
+  data.tar.gz: 53ab6973726062831ce6fdea8e5abfe87eead951
 SHA512:
-  metadata.gz: 96dad3cc169a8642c4f035d86bedb3a085994bb1f55035fd9461d43dec9ee245c2b4cff03acbb7ae64b0d8ffcfb08a39735b50c3ac3f144f0b4b3fb2e81ebd67
-  data.tar.gz: 27ae4cbfee8c372fa952270a3af8d522e2efb8e2682a3107d9ebf1d7854ddf834a0d741645ac665d3d814048bcacd7ab8e2f5802ff9a19429c7f0ed26a440ba9
+  metadata.gz: 748cbaac055db47202bfb129952bf8656b96054606599ef11790ec8beeeaf34a189266608cb0c1f72d937aafb978aa84335e7377c3573bc71b969beef4aea3c8
+  data.tar.gz: 1ef8d30e2359cb1d5292f876acaeb306dccc11cb52e8a2edaab8ea5094fc7a793228eb3cf7f2e17dec0769caee7eed5cecce7751bad4fbee5c63d305f243383a

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
+notifications:
+  email:
+    on_success: change
+    on_failure: always

data/README.md

@@ -1,3 +1,17 @@
 # Octokom
 
-Work in progress.
+Work in progress command line application for your every day GitHub workflow.
+
+## Installation
+
+```bash
+$ gem install octokom
+```
+
+## Examples
+
+#### Create a new pull request
+
+```bash
+$ octokom pull-request create --title "New feature"
+```

data/lib/octokom/authentication.rb

@@ -0,0 +1,42 @@
+require 'io/console'
+
+module Octokom
+  module Authentication
+    OCTOKIT_ERRORS = [
+      Octokit::BadRequest,
+      Octokit::Unauthorized,
+      Octokit::Forbidden,
+      Octokit::NotFound,
+      Octokit::NotAcceptable,
+      Octokit::UnprocessableEntity,
+      Octokit::InternalServerError,
+      Octokit::NotImplemented,
+      Octokit::BadGateway,
+      Octokit::ServiceUnavailable
+    ]
+
+    def authenticate(&block)
+      begin
+        yield Octokit::Client.new(login: login, password: password)
+      rescue *OCTOKIT_ERRORS => e
+        puts "Unable to authenticate user '#{login}' (#{e.class})"
+        # TODO print message about how to reenter credentials
+        # TODO use custom method instead of puts
+      end
+    end
+
+    private
+
+    def login
+      keychain[:login]
+    end
+
+    def password
+      keychain[:password]
+    end
+
+    def keychain
+      Octokom::Keychain.create
+    end
+  end
+end

data/lib/octokom/command/pull_request.rb

@@ -0,0 +1,31 @@
+module Octokom
+  class Command
+    class PullRequest < Clamp::Command
+      include Octokom::Authentication
+
+      subcommand 'create', 'Create a new pull request.' do
+        option ['--repo',  '-r'], '', 'The GitHub repository. Example: "mjio/octokom"'
+        # TODO make ancestor default base
+        option ['--base',  '-b'], '', 'The branch you want your changes pulled into. Example: "master"', default: 'master'
+        option ['--head',  '-d'], '', 'The branch where your changes are implemented. Example: "new_feature"'
+        # option ['--issue', '-i'], '', 'Create pull request from an existing issue. Example: "123"'
+        option ['--title', '-t'], '', 'Title for the pull request.'
+        option ['--body',  '-b'], '', 'Body for the pull request.'
+
+        def execute
+          authenticate do |client|
+            repo ||= Repository.remote_path
+            head ||= Repository.current_branch
+
+            if Repository.unpushed_commits?
+              exit unless system 'git push'
+            end
+
+            puts "Create pull request (#{repo}) #{base}:#{head}"
+            client.create_pull_request(repo, base, head, title, body)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/octokom/command.rb

@@ -1,4 +1,7 @@
 module Octokom
-  module Command
+  class Command < Clamp::Command
+    autoload :PullRequest, 'octokom/command/pull_request'
+
+    subcommand 'pull-request', 'Create, update or merge pull requests.', PullRequest
   end
 end

data/lib/octokom/keychain.rb

@@ -0,0 +1,54 @@
+module Octokom
+  class Keychain
+    def self.create
+      new.find_or_create_keychain
+    end
+
+    def find_or_create_keychain
+      if keychain
+        {login: keychain.attributes['acct'], password: keychain.password}
+      else
+        create_octokom_keychain
+        find_or_create_keychain
+      end
+    end
+
+    private
+
+    def keychain
+      # TODO make sure this happens only once
+      @keychain ||= octokom_keychain || github_keychain
+    end
+
+    def octokom_keychain
+      Security::GenericPassword.find(service: 'octokom')
+    end
+
+    def github_keychain
+      Security::InternetPassword.find(server: 'github.com')
+    end
+
+    def create_octokom_keychain
+      login = ask_for_login
+      password = ask_for_password
+
+      puts
+
+      save_octokom_keychain(login, password)
+    end
+
+    def ask_for_login
+      print 'GitHub Login: '
+      STDIN.gets.chomp
+    end
+
+    def ask_for_password
+      print 'Password: '
+      STDIN.noecho(&:gets).chomp
+    end
+
+    def save_octokom_keychain(login, password)
+      Security::GenericPassword.add('octokom', login, password)
+    end
+  end
+end

data/lib/octokom/repository.rb

@@ -0,0 +1,29 @@
+module Octokom
+  class Repository
+    class << self
+      def remote_path
+        remote_url[/(\w+\/(\w+|\.)+)\.git$/, 1]
+      end
+
+      def current_branch
+        `git rev-parse --abbrev-ref HEAD`.chomp
+      end
+
+      def unpushed_commits?
+        !count_unpushed_commits.zero?
+      end
+
+      def count_unpushed_commits
+        cmd = 'git log --branches --not --remotes --format=oneline'
+        `#{cmd}`.chomp.split('\n').count
+      end
+
+      private
+
+      def remote_url
+        # TODO make "origin" configurable
+        `git config --get remote.origin.url`.chomp
+      end
+    end
+  end
+end

data/lib/octokom/version.rb

@@ -1,3 +1,3 @@
 module Octokom
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/octokom.rb

@@ -1,9 +1,15 @@
-require 'octokom/version'
+require 'clamp'
+require 'octokit'
+require 'security'
+
+require 'octokom/authentication'
 require 'octokom/command'
+require 'octokom/keychain'
+require 'octokom/repository'
+require 'octokom/version'
 
 module Octokom
   def self.start(*args)
-    command = args.shift
-    Octokom::Command.run(command, args)
+    Octokom::Command.run(args)
   end
 end

data/octokom.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.version       = Octokom::VERSION
   gem.authors       = 'Martin Jagusch'
   gem.email         = '_@mj.io'
-  gem.description   = 'Command line interface for the GitHub API'
+  gem.description   = 'Command line application for your every day GitHub workflow.'
   gem.summary       = "octokom-#{Octokom::VERSION}"
   gem.homepage      = 'https://github.com/mjio/octokom'
   gem.license       = 'MIT'
@@ -18,6 +18,10 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^spec/})
   gem.require_paths = ['lib']
 
+  gem.add_dependency 'clamp', '~> 0.6.1'
+  gem.add_dependency 'octokit', '2.0.0.rc2'
+  gem.add_dependency 'security', '~> 0.1.2'
+
   gem.add_development_dependency 'rake', '~> 10.1.0'
   gem.add_development_dependency 'rspec', '~> 2.14.1'
 end

data/spec/octokom/authentication_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+class Cmd
+  include Octokom::Authentication
+end
+
+describe Octokom::Authentication do
+  let(:cmd)      { Cmd.new }
+  let(:keychain) { {login: 'fox', password: 'bacon'} }
+
+  before do
+    allow(cmd).to receive(:keychain) { keychain }
+  end
+
+  it 'authenticates the user' do
+    credentials = {login: 'fox', password: 'bacon'}
+    expect(Octokit::Client).to receive(:new).with(credentials)
+    cmd.authenticate { }
+  end
+
+  it 'handels exceptions' do
+    expect(STDOUT).to receive(:puts).with(/Unable to authenticate/)
+    cmd.authenticate { raise Octokit::Unauthorized }
+  end
+end

data/spec/octokom/command/pull_request_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Octokom::Command::PullRequest do
+  it 'has a `create` sub command' do
+    command = Octokom::Command::PullRequest.find_subcommand('create')
+    expect(command).to be_kind_of(Clamp::Subcommand::Definition)
+  end
+end

data/spec/octokom/command_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Octokom::Command do
+  it 'has a `pull-request` sub command' do
+    command = Octokom::Command.find_subcommand('pull-request')
+    expect(command).to be_kind_of(Clamp::Subcommand::Definition)
+  end
+end

data/spec/octokom/keychain_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Octokom::Keychain do
+  let(:keychain) { double(attributes: {'acct' => 'fox'}, password: 'bacon') }
+
+  before do
+    allow(Security::GenericPassword).to receive(:find) { nil }
+    allow(Security::GenericPassword).to receive(:add) { nil }
+    allow(Security::InternetPassword).to receive(:find) { nil }
+  end
+
+  context 'using existing `octokom` keychain' do
+    before do
+      allow(Security::GenericPassword).to receive(:find).with(service: 'octokom') { keychain }
+    end
+
+    it 'finds the keychain' do
+      expect(Octokom::Keychain.create).to eq(login: 'fox', password: 'bacon')
+    end
+  end
+
+  context 'using existing `github` keychain' do
+    before do
+      allow(Security::InternetPassword).to receive(:find).with(server: 'github.com') { keychain }
+    end
+
+    it 'finds the keychain' do
+      expect(Octokom::Keychain.create).to eq(login: 'fox', password: 'bacon')
+    end
+  end
+
+  context 'creating new `github` keychain' do
+    before do
+      Octokom::Keychain.any_instance.stub(:ask_for_login).and_return('fox')
+      Octokom::Keychain.any_instance.stub(:ask_for_password).and_return('bacon')
+      allow(STDOUT).to receive(:puts)
+    end
+
+    it 'saves a keychain' do
+      pending 'prevent retry'
+      expect(Security::GenericPassword).to receive(:add).with('octokom', 'fox', 'bacon')
+      Octokom::Keychain.create
+    end
+  end
+end

data/spec/octokom/repository_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Octokom::Repository do
+  subject(:repo) { Octokom::Repository }
+
+  describe '#remote_path' do
+    before do
+      allow(repo).to receive(:remote_url) { 'https://github.com/mjio/octokom.git' }
+    end
+
+    it 'returns GitHub remote path' do
+      expect(repo.remote_path).to eq('mjio/octokom')
+    end
+  end
+end

data/spec/octokom_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Octokom do
+  it 'forwards arguments to the Command class' do
+    expect(Octokom::Command).to receive(:run).with(['one', 'two'])
+    Octokom.start('one', 'two')
+  end
+end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: octokom
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Martin Jagusch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-17 00:00:00.000000000 Z
+date: 2013-08-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0.rc2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0.rc2
+- !ruby/object:Gem::Dependency
+  name: security
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +80,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.1
-description: Command line interface for the GitHub API
+description: Command line application for your every day GitHub workflow.
 email: _@mj.io
 executables:
 - octokom
@@ -47,16 +89,26 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/octokom
 - lib/octokom.rb
+- lib/octokom/authentication.rb
 - lib/octokom/command.rb
+- lib/octokom/command/pull_request.rb
+- lib/octokom/keychain.rb
+- lib/octokom/repository.rb
 - lib/octokom/version.rb
 - octokom.gemspec
-- spec/octokom.rb
+- spec/octokom/authentication_spec.rb
+- spec/octokom/command/pull_request_spec.rb
+- spec/octokom/command_spec.rb
+- spec/octokom/keychain_spec.rb
+- spec/octokom/repository_spec.rb
+- spec/octokom_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/mjio/octokom
 licenses:
@@ -81,8 +133,13 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: octokom-0.0.1
+summary: octokom-0.0.2
 test_files:
-- spec/octokom.rb
+- spec/octokom/authentication_spec.rb
+- spec/octokom/command/pull_request_spec.rb
+- spec/octokom/command_spec.rb
+- spec/octokom/keychain_spec.rb
+- spec/octokom/repository_spec.rb
+- spec/octokom_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/spec/octokom.rb

@@ -1,8 +0,0 @@
-require 'spec_helper'
-
-describe Octokom do
-  it 'splits command and arguments' do
-    expect(Octokom::Command).to receive(:run).with('one', ['two'])
-    Octokom.start('one', 'two')
-  end
-end