github-api-auth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec1a20be8f8c517e329620ff1bdb7125ecb05f9b
+  data.tar.gz: 55c52ac500e87dd78e3f81d5b2d1c121c79baf13
+SHA512:
+  metadata.gz: ab6746507501209a59fc87ff9347b3dfcbb85339a1fa64da16e4c77d136c06a2182f7aad03642cc561f2d67cb7ce6ce713bd78729de005f108ba15db0e267862
+  data.tar.gz: b65578d6f7a1b50e690223deabdea4fea975e1a5c313b4755731a1c21967490dd19611ae1396a305d3c23f353c9669a4e0d5b8dc556cf4aeefc23a04f700747d

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in github-api-auth.gemspec
+gemspec
+
+# use all bleeding edge of rspec
+%w(core mocks expectations support rails legacy_formatters collection_matchers).each do |part|
+  gem "rspec-#{part}", github: "rspec/rspec-#{part}"
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alexey Fedorov
+
+MIT License
+
+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,39 @@
+# Github::Api::Auth
+
+Usefull class to authenticate to github api just once and get authenticated Octokit::Client in return. OTP included.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'github-api-auth'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install github-api-auth
+
+## Usage
+
+    octo_client = Github::Api::Auth.new.github
+
+And you are good to go. It will ask you for login and password and store newly created access token in local file. If OTP is required it will initiate code send process and will ask for code.
+
+## Changelog
+
+0.1.0
+
+- Added basic authentication
+- Added OTP authentication
+- Added authenticaton by stored access token
+
+## Contributing
+
+1. Fork it ( https://github.com/alex-fedorov/github-api-auth/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,2 @@
+require "bundler/gem_tasks"
+

data/github-api-auth.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github/api/auth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "github-api-auth"
+  spec.version       = Github::Api::Auth::VERSION
+  spec.authors       = ["Alexey Fedorov"]
+  spec.email         = ["alexey.fedorov@wimdu.com"]
+  spec.summary       = %q{Usefull class to authenticate to github api just once and get authenticated Octokit::Client in return. OTP included.}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency "octokit"
+  spec.add_runtime_dependency "highline"
+end

data/lib/github/api/auth.rb

@@ -0,0 +1,10 @@
+require "github/api/auth/version"
+
+module Github
+  module Api
+    module Auth
+      # Your code goes here...
+      require_relative 'auth/auth'
+    end
+  end
+end

data/lib/github/api/auth/auth.rb

@@ -0,0 +1,69 @@
+require 'yaml'
+require 'octokit'
+require 'highline/import'
+
+class Github::Api::Auth::Klass; include Github::Api::Auth end
+
+module Github::Api::Auth
+  AUTH_FILE = "#{ENV['HOME']}/.github_token"
+  AUTH_LOCAL_FILE = ".github_token"
+  SCOPES = "repo:status"
+
+  attr_accessor :github
+
+  def self.new
+    Github::Api::Auth::Klass.new
+  end
+
+  def initialize
+    authenticate
+  end
+
+  private
+
+  def authenticate
+    configure_from_file || basic_authentication
+  end
+
+  def basic_authentication
+    login = ask('github username: ')
+    password = ask('password: ') { |c| c.echo = false }
+    self.github = Octokit::Client.new(login: login, password: password)
+    token = create_access_token
+    store_token(sanitize_token(token))
+    configure_from_file
+  end
+
+  def configure_from_file
+    path = File.exists?(AUTH_LOCAL_FILE) ? AUTH_LOCAL_FILE : AUTH_FILE
+    config = YAML.load_file(path)
+    self.github = Octokit::Client.new(access_token: config[:token])
+    true
+  rescue
+    false
+  end
+
+  def create_access_token
+    scopes = SCOPES
+    note = gen_token_note
+    github.create_authorization(scopes: scopes, note: note)
+  rescue Octokit::OneTimePasswordRequired => e
+    otp = ask('one time password required: ')
+    github.create_authorization(scopes: scopes, note: note, headers: { 'X-GitHub-OTP' => otp })
+  end
+
+  def store_token(token)
+    File.open(AUTH_LOCAL_FILE, 'w') { |f| f.write(token.to_yaml) }
+  end
+
+  def sanitize_token(token)
+    token.to_h.reject { |k, v| k == :app }
+  end
+
+  def gen_token_note
+    # TODO Make this use existing token instead of creating new one
+    # NOTE We need this number if user want to authenticate multiple devices
+    number = Time.now.to_i
+    "Wimdu pre ci notifications #{number}"
+  end
+end

data/lib/github/api/auth/version.rb

@@ -0,0 +1,7 @@
+module Github
+  module Api
+    module Auth
+      VERSION = "0.1.0"
+    end
+  end
+end

data/spec/github/api/auth/auth_spec.rb

@@ -0,0 +1,115 @@
+require 'yaml'
+require 'octokit'
+require 'github/api/auth'
+
+RSpec.describe Github::Api::Auth do
+  describe '.new and #authenticate' do
+    context 'having file .github_token in place with valid token' do
+      let(:valid_token) { '123456' }
+      let(:client) { double('Octokit::Client') }
+
+      it 'successfully authenticates without asking user for anything' do
+        allow(File).to receive(:exists?).with('.github_token') { true }
+        allow(YAML).to receive(:load_file).
+          with('.github_token') { { token: valid_token } }
+        allow(Octokit::Client).to receive(:new).
+          with(access_token: valid_token) { client }
+        expect_any_instance_of(subject).not_to receive(:basic_authentication)
+        github = subject.new
+        expect(github.github).to eq(client)
+      end
+    end
+
+    context 'having file .github_token in place with invalid token' do
+      let(:invalid_token) { '654321' }
+
+      it 'falls back to basic authentication' do
+        allow(File).to receive(:exists?).with('.github_token') { true }
+        allow(YAML).to receive(:load_file).
+          with('.github_token') { { token: invalid_token } }
+        allow(Octokit::Client).to receive(:new).
+          with(access_token: invalid_token).and_raise(RuntimeError.new)
+        expect_any_instance_of(subject).to receive(:basic_authentication) { true }
+        github = subject.new
+      end
+    end
+
+    context 'without file .github_token, but having ~/.github_token' do
+      let(:valid_token) { '123456' }
+      let(:client) { double('Octokit::Client') }
+      let(:path) { "#{ENV['HOME']}/.github_token" }
+
+      it 'successfully authenticates without asking user for anything' do
+        allow(File).to receive(:exists?).with('.github_token') { false }
+        allow(File).to receive(:exists?).with(path) { true }
+        allow(YAML).to receive(:load_file).
+          with(path) { { token: valid_token } }
+        allow(Octokit::Client).to receive(:new).
+          with(access_token: valid_token) { client }
+        expect_any_instance_of(subject).not_to receive(:basic_authentication)
+        github = subject.new
+        expect(github.github).to eq(client)
+      end
+    end
+  end
+
+  describe '#basic_authentication' do
+    let(:username) { 'john' }
+    let(:password) { 'super strong password' }
+    let(:client) { double('Octokit::Client') }
+    let(:token) { '123456' }
+    let(:authorization) { { scopes: 'repo:status', note: 'wimdu note' } }
+    let(:otp) { '987654' }
+
+    before do
+      allow(Octokit::Client).to receive(:new).
+        with(login: username, password: password) { client }
+    end
+
+    context 'having #configure_from_file failed' do
+      before do
+        allow_any_instance_of(subject).to receive(:configure_from_file) { false }
+        allow_any_instance_of(subject).to receive(:gen_token_note) { 'wimdu note' }
+        allow_any_instance_of(subject).to receive(:ask).
+          with('github username: ') { username }
+        allow_any_instance_of(subject).to receive(:ask).
+          with('password: ') { password }
+      end
+
+      it 'gets called' do
+        expect_any_instance_of(subject).to receive(:basic_authentication) { true }
+        github = subject.new
+      end
+
+      it 'asks user for username and password and creates access token' do
+        expect_any_instance_of(subject).to receive(:ask).
+          with('github username: ') { username }
+        expect_any_instance_of(subject).to receive(:ask).
+          with('password: ') { password }
+        expect_any_instance_of(subject).to receive(:create_access_token) do
+          { token: token }
+        end
+        expect_any_instance_of(subject).to receive(:store_token).
+          with({ token: token })
+        github = subject.new
+      end
+
+      context 'having one time password required' do
+        it 'asks user for otp' do
+          expect(client).to receive(:create_authorization).
+            with(authorization).and_raise(Octokit::OneTimePasswordRequired.new)
+          expect_any_instance_of(subject).to receive(:ask).
+            with('one time password required: ') { otp }
+          expect(client).to receive(:create_authorization).
+            with(authorization.merge(headers: { 'X-GitHub-OTP' => otp })) do
+            { token: token }
+          end
+          expect_any_instance_of(subject).to receive(:store_token).
+            with({ token: token })
+          github = subject.new
+        end
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: github-api-auth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexey Fedorov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: octokit
+  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: highline
+  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'
+description: ''
+email:
+- alexey.fedorov@wimdu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- github-api-auth.gemspec
+- lib/github/api/auth.rb
+- lib/github/api/auth/auth.rb
+- lib/github/api/auth/version.rb
+- spec/github/api/auth/auth_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Usefull class to authenticate to github api just once and get authenticated
+  Octokit::Client in return. OTP included.
+test_files:
+- spec/github/api/auth/auth_spec.rb
+- spec/spec_helper.rb