checklister 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9eb47f6a87c7f66d9be921c83dc8529375e055ee
-  data.tar.gz: 805ba3f312d823ed0c3920512b9ef7cb5057b75d
+  metadata.gz: a10ee14552d5f574d9455926522fe4128f5dda87
+  data.tar.gz: 41f7a2c18c119757ee426914d1bf3473c0381166
 SHA512:
-  metadata.gz: 868c91ec0980ca21975dfe3c10f641af614a3eaab4a5ff80a4bae9543e54d8b176d464106c62dd2111a9aa3fcbcc098abe9485229fd0caab920c3a31864e9230
-  data.tar.gz: cde6105e16111617a4ff86cf5abaa45ec3c8757a5ea61e6cb09645d44f2caff8dc1dc59a08086169e6bffebe975c5cbf2da83a3dfed70e4ad400a51a75c38293
+  metadata.gz: 360e6a6d27a2d1477ded2233a50886fcc5857d64b08ebdc68e479b76cd16cfcb4618a30642cc2a878785fa86e332ea1110bb0edfe8934fa75cc2c1768a83d8fa
+  data.tar.gz: 8f364d968c3276914087c4965fec295106a4a1a901c1f5f7ff6a6c3e4e33167fee7bbaa9be118176795f591f831d5b797c1f4bd84f453c653713422f4e7bebaf

data/.gitignore

@@ -11,3 +11,4 @@
 tags
 gems.tags
 .DS_Store
+byebug_history

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -1,8 +1,10 @@
+sudo: false
 language: ruby
-cache: bundler
 rvm:
-  - 2.0.0
-  - 2.1.4
-  - 2.2.2
-before_install: gem install bundler -v 1.10.5
-script: 'bundle exec rake'
+  - 2.2.5
+  - 2.3.1
+before_install:
+  - gem install bundler
+cache: bundler
+
+script: "bundle exec rake"

data/Gemfile

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

data/README.md

@@ -49,6 +49,15 @@ Source: http://atulgawande.com/book/the-checklist-manifesto/
 $ gem install checklister
 ```
 
+> NOTE: If you use a ruby manager, the gem have to be installed each time you want to use it in a new ruby context.
+
+#### PROTIP
+
+If you use rbenv as your ruby manager, and want to easily install/update `checklister` across all your rubies:
+
+1. Install [rbenv-each](https://github.com/rbenv/rbenv-each)
+1. Run `$ rbenv each gem install checklister` everytime there is a new version of the gem
+
 ### Setup Gitlab Authentication
 
 ```bash

data/bin/checklister

@@ -1,9 +1,22 @@
 #!/usr/bin/env ruby
+# CLI Tools
 require "gli"
+require "highline"
+# Gem logic entrypoint
 require "checklister"
 
 include GLI::App
 
+# Highline
+ft = HighLine::ColorScheme.new do |cs|
+  cs[:question] = [ :bold, :cyan ]
+  cs[:info]     = [ :bold, :white ]
+  cs[:error]    = [ :magenta ]
+end
+
+HighLine.color_scheme = ft
+bot = HighLine.new
+
 ISSUE_SERVICES = { "1" => "gitlab", "2" => "github" }.freeze
 
 program_desc "gives you the power to transform any markdown file or url checklist into an actionable gitlab and github issue."
@@ -28,20 +41,22 @@ pre do |global_options,command,options,args|
       config_options = global_options
     elsif config_file.exist?
       saved_services = config_file.services
+      choice = 0
       if saved_services.size > 1
-        puts "* Which Issue Service would you like to use?"
-        saved_services.each_with_index do |service, index|
-          line = []
-          line << "[#{index+1}] #{service[:endpoint]}"
-          line << "(#{service[:label]})" if service[:label]
-          puts line.join(" ")
+        bot.say "<%= color('Which Issue Service would you like to use?', :question) %>"
+        bot.choose do |menu|
+          menu.select_by = :index
+          # Options
+          saved_services.each_with_index do |service, index|
+            label = [service[:endpoint]]
+            label << "- #{service[:label]}" if service[:label].to_s != ""
+            menu.choice(label.join(" ")) { choice = index }
+          end
         end
-        choice = STDIN.gets.to_i
-        raise("You need to select a service.") if choice < 1
       else
-        choice = 1
+        choice = 0
       end
-      service_selected = saved_services[choice-1]
+      service_selected = saved_services[choice]
       config_options = service_selected
     else
       config_options = {}
@@ -65,51 +80,65 @@ desc "Save your gitlab or github settings for later"
 command :setup do |c|
   c.action do |global_options,options,args|
     data = {}
+    choice = nil
     config_file = Checklister::ConfigurationFile.new(global_options["config"])
 
     if global_options[:service]
       service_selected = global_options[:service]
     else
-      puts "* Which Issue Service would you like to setup?"
-      ISSUE_SERVICES.each do |index, service|
-        puts "[#{index}] #{service}"
+      bot.say "<%= color('Which Issue Service would you like to setup?', :info) %>"
+      bot.choose do |menu|
+        menu.select_by = :index
+        # Options
+        ISSUE_SERVICES.each do |index, service|
+          menu.choice(service) { choice = index }
+        end
       end
-      choice = STDIN.gets.to_i
-      raise("You need to select a service.") if choice < 1
       service_selected = ISSUE_SERVICES[choice.to_s]
     end
     data["kind"] = service_selected
 
-    puts ""
-    puts "* We are going to help you set up the #{service_selected} service"
+    bot.say "<%= color('We are going to help you set up the #{service_selected} service', :info) %>"
 
     if service_selected == "gitlab"
-      puts ""
-      puts "** What is your gitlab endpoint? (Ex: https://gitlab.com/api/v3)"
-      choice = STDIN.gets.chomp
-      raise("You need to type a endpoint.") if choice == ""
-      data["endpoint"] = choice
+      # Get the service url
+      data["endpoint"] = bot.ask("<%= color('What is your gitlab endpoint? (Ex: https://gitlab.com/api/v3)', :question) %>") do |q|
+        q.validate = /https?:\/\/[\S]+/
+      end
+
+      # Configure tls client certificate, if any
+      if bot.agree("<%= color('Does your Gitlab server require a client certificate? [y/n]', :question) %>")
+        # Set the private certificate path
+        data["client_certificate_path"] = bot.ask("<%= color('Please enter the path to your private certificate (the extension should be .p12)', :question) %>") do |q|
+          q.validate = /.*\S.*/
+        end
+
+        # Set the endpoint certificate path
+        data["endpoint_certificate_path"] = bot.ask("<%= color('Please enter, if any, the path to your ca certificate (the extension should be .crt)', :question) %>") do |q|
+          q.validate = /.*\S.*/
+        end
+
+        # Set the private certificate password (not compulsory)
+        data["client_certificate_password"] = bot.ask("<%= color('Please enter, if any, your private certificate password', :question) %>") do |q|
+          q.echo = "*"
+        end
+      end
     elsif service_selected == "github"
       data["endpoint"] = "https://api.github.com"
     end
 
-    puts ""
-    puts "** What is your private token with the #{service_selected} service?"
-    choice = STDIN.gets.chomp
-    raise("You need to type a private token.") if choice == ""
-    data["private_token"] = choice
-
-    puts ""
-    puts "** You can give a label to #{data["endpoint"]} (you can leave it blank too)"
-    choice = STDIN.gets.chomp
-    if choice != ""
-      data["label"] = choice
+    # Private token
+    data["private_token"] = bot.ask("<%= color('What is your private token with the #{service_selected} service?', :question) %>") do |q|
+      q.validate = /.*\S.*/
     end
 
+    # Label
+    data["label"] = bot.ask("<%= color('You can give a label to #{data["endpoint"]} (you can leave it blank too)', :question) %>")
+
+    # Persist the configuration to file
     config_file.add_service data
     config_file.persist
-    puts ""
-    puts "* Your configuration data has been saved at #{global_options[:config]}"
+    bot.say "<%= color('Your configuration data has been saved at #{global_options[:config]}', :info) %>"
   end
 end
 

data/checklister.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'checklister/version'
+require "checklister/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "checklister"
@@ -14,25 +14,27 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/benichu/checklister"
   spec.license       = "MIT"
 
-  spec.required_ruby_version     = '>= 2.0'
-  spec.required_rubygems_version = '>= 1.9'
+  spec.required_rubygems_version = ">= 1.9"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "bin"
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "gitlab"    , "~> 3.4.0"
-  spec.add_dependency "gli"       , "~> 2.13"
-  spec.add_dependency "octokit"   , "~> 4.0"
+  spec.add_dependency "gitlab"   , "~> 3.4.0"
+  spec.add_dependency "gli"      , "~> 2.13"
+  spec.add_dependency "octokit"  , "~> 4.0"
+  spec.add_dependency "highline" , "~> 1.7"
 
   spec.add_development_dependency "bundler"             , "~> 1.10"
+  spec.add_development_dependency "byebug"              , "~> 8.2.1"
   spec.add_development_dependency "coveralls"           , "~> 0.8.2"
   spec.add_development_dependency "guard"               , "~> 2.13"
   spec.add_development_dependency "guard-rspec"         , "~> 4.6"
   spec.add_development_dependency "guard-ctags-bundler"
   spec.add_development_dependency "rake"                , "~> 10.4"
   spec.add_development_dependency "rspec"               , "~> 3.3"
+  spec.add_development_dependency "ruby_dep"            , "~> 1.4"
   spec.add_development_dependency "yard"                , "~> 0.8"
   spec.add_development_dependency "webmock"             , "~> 1.21"
 end

data/lib/checklister.rb

@@ -29,5 +29,9 @@ module Checklister
     def configure(attributes = {})
       config.apply attributes
     end
+
+    def root
+      File.expand_path('../..',__FILE__)
+    end
   end
 end

data/lib/checklister/client.rb

@@ -71,6 +71,7 @@ module Checklister
     end
 
     def prepare_options_for_kind(options, kind)
+      httparty_options = {}
       if kind == "github"
         # Octokit uses ENV for overide
         # See: https://github.com/octokit/octokit.rb/blob/a98979107a4bf9741a05a1f751405f8a29f29b38/lib/octokit/default.rb#L136-L138
@@ -80,7 +81,10 @@ module Checklister
         # :private_token is called :access_token
         options[:access_token] = options.delete(:private_token)
       elsif kind == "gitlab"
-        options.merge!(httparty: { verify: false }) # FIXME
+        httparty_options[:ssl_ca_file]  = options[:endpoint_certificate_path] unless options[:endpoint_certificate_path].to_s == ""
+        httparty_options[:p12]          = File.read(options[:client_certificate_path]) unless options[:client_certificate_path].to_s == ""
+        httparty_options[:p12_password] = options[:client_certificate_password] unless options[:client_certificate_password].to_s == ""
+        options.merge!(httparty: httparty_options)
       end
       options
     end

data/lib/checklister/configuration.rb

@@ -71,9 +71,9 @@ module Checklister
   #
   class Configuration
     # List of all the configuration attributes stored for use within the gem
-    ATTRIBUTES = [:endpoint, :private_token, :label, :kind]
+    ATTRIBUTES = [:endpoint, :private_token, :label, :kind, :client_certificate_path, :client_certificate_password, :endpoint_certificate_path]
 
-    attr_accessor :endpoint, :private_token, :kind
+    attr_accessor :endpoint, :private_token, :kind, :client_certificate_path, :client_certificate_password, :endpoint_certificate_path
     attr_writer :label
 
     # Apply a configuration hash to a configuration instance

data/lib/checklister/version.rb

@@ -1,3 +1,3 @@
 module Checklister
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: checklister
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Benjamin Thouret
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-06 00:00:00.000000000 Z
+date: 2016-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitlab
@@ -53,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +81,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 8.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 8.2.1
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -151,6 +179,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: ruby_dep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +234,7 @@ files:
 - ".gitignore"
 - ".hound.yml"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
@@ -236,7 +279,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -244,7 +287,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '1.9'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Markdown checklists to gitlab or github issue.