checklister 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 975ebe56553df4d65b12f7dbab5e7a6b01c45d72
-  data.tar.gz: ffae8c16237f57f5a0003724ef2f0b8885c77466
+  metadata.gz: 08d5e35df41587f793a8f21775e8fafeb9d4c04b
+  data.tar.gz: c5613a39590bf9203abfd5aec3eb8f5ae720f450
 SHA512:
-  metadata.gz: b474c3775f0a55f8650cff805f8201cefe9b8f1d44d7fb4d043b5f031424f31b127190e22bf0ef5f3a100b132992cfd0e5c426c906f0444d95445df85a9451ff
-  data.tar.gz: f85d2ef19f2e71a4a7956a88b5dbdc677965c1ec8d4ad1ddf7e64d95def72fb100843acf97343504c1df258e8ced690aa731c51de7fb82a3f91c627faaa17836
+  metadata.gz: 15f2bb49f709e445ec8dcbb31865ff634aeebc3a4a0f77839823b0f174aaef5c345946c9487cd854d38b000aeed48250bb973cdef33c39e14893955b2c7261b9
+  data.tar.gz: a84716cfd646cfdcb79814fb04db912b4186a7a44da842c032527f5300deaaa013e0a3c771ca8103c621de1113dc3a12f97d49d2d6a58e4a1c3271a0950d62e8

data/CHANGELOG.md

@@ -3,7 +3,14 @@ All notable changes to this project will be documented in this file.
 
 NOTE: the project follows [Semantic Versioning](http://semver.org/).
 
-## 0.0.9 - 2015-09-22
+## 0.9.3 - 2015-09-26
+
+### Added
+
+- [feature] Connect to git account
+- [feature] Save your github services settings to local file
+
+## 0.9.0 - 2015-09-22
 
 ### Added
 

data/README.md

@@ -7,6 +7,7 @@
 [![Gem Version](https://badge.fury.io/rb/checklister.svg)](http://badge.fury.io/rb/checklister)
 [![Code Climate](https://codeclimate.com/github/benichu/checklister/badges/gpa.svg)](https://codeclimate.com/github/benichu/checklister)
 [![Coverage Status](https://coveralls.io/repos/benichu/checklister/badge.svg?branch=master&service=github)](https://coveralls.io/github/benichu/checklister?branch=master)
+[![MIT license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/benichu/checklister/blob/master/LICENSE)
 
 ## Description
 
@@ -133,7 +134,7 @@ To prepare a release, run `script/release`. This will package a new version of t
 - [ ] [improvements] CLI improvements based on first test run with real users
 - [ ] [documentation] Yard documentation updated
 - [ ] [feature] Create a new Issue based on a specific markdown file (remote path)
-- [ ] [feature] Connect to github account
+- [x] [feature] Connect to github account
 
 ### Wishlist
 

data/bin/checklister

@@ -117,28 +117,26 @@ desc "Transform a markdown file or url checklist into an actionable issue"
 command :new do |c|
   c.flag [:c,:checklist], desc: "Set the markdown checklist file path", required: true
   c.action do |global_options,options,args|
-    client = Checklister::Client.new(Checklister.config.to_hash).get_api_client
-    gitlab_project = Checklister::Gitlab::Project.new(client)
+    api_client = Checklister::Client.new(Checklister.config.to_hash)
+    project_client = api_client.project
     checklist_path = options[:checklist]
 
     puts "* Type some letters of your project's name..."
     project_like = STDIN.gets.chomp
-    projects = gitlab_project.filtered_by_name(project_like)
+    projects = project_client.filtered_by_name(project_like)
     default_project_id = projects.first[:id]
     projects.each do |project|
-      puts "%-5s %-100s" % ["[#{project[:id]}]", project[:name_with_namespace]]
+      puts "%-5s %-100s" % ["[#{project[:id]}]", project[:name]]
     end
     puts "* Pick your project Id, defaults to [#{default_project_id}]"
     choice = STDIN.gets.chomp
     project_id = choice == "" ? default_project_id : choice
-    project = gitlab_project.get(project_id)
+    project = project_client.get(project_id)
     puts "* Creating a checklist issue from #{checklist_path}"
     puts "  to the project: #{project[:name]}"
     parsed_checklist = Checklister::Parser.new(checklist_path)
-    issue = Checklister::Gitlab::Issue.new(client).create(project_id, parsed_checklist.to_params)
-    puts "------------->"
-    puts "| Check it out: #{Checklister.config.endpoint.gsub("/api/v3", "")}/#{project[:path_with_namespace]}/issues/#{issue.id}"
-    puts "------------->"
+    issue = api_client.issue.create(project_id, parsed_checklist.to_params)
+    puts "* Issue successfully created!"
   end
 end
 

data/checklister.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "gitlab"    , "~> 3.4.0"
   spec.add_dependency "gli"       , "~> 2.13"
+  spec.add_dependency "octokit"   , "~> 4.0"
 
   spec.add_development_dependency "bundler"     , "~> 1.10"
   spec.add_development_dependency "coveralls"   , "~> 0.8.2"

data/lib/checklister.rb

@@ -9,6 +9,8 @@ require "checklister/version"
 require "checklister/client"
 require "checklister/gitlab/project"
 require "checklister/gitlab/issue"
+require "checklister/github/project"
+require "checklister/github/issue"
 
 module Checklister
   class << self

data/lib/checklister/client.rb

@@ -1,23 +1,101 @@
 require "gitlab"
+require "octokit"
 
 module Checklister
+  # Implement a kind of Factory pattern
+  #
+  # We create an object without exposing the creation logic and then refer to newly created object using a common interface.
   class Client
-    IMPLEMENTED_BACKENDS = %w(gitlab)
+    # The issue service backends we are currently supporting
+    #
+    #  - [x] gitlab
+    #  - [x] github
+    #  - [ ] bitbucket
+    #
+    IMPLEMENTED_BACKENDS = %w(gitlab github)
 
+    attr_reader :api_client
+
+    # Initialize all the issue service options required to be able to interact with it
+    #
+    # @example Initialize a gitlab client's options
+    #   gitlab_client = Checklister::Client.new(kind: "gitlab", endpoint: "https://gitlab.com/api/v3", private_token: "supersecret")
+    #
+    # @param options [Hash] list of key/values to apply to the appropriately created API client
+    # @option opts [String] :kind The issue service identifier ('github', 'gitlab', ...)
+    # @option opts [String] :endpoint The issue service endpoint url
+    # @option opts [String] :private_token The issue service user's private token
+    #
+    # @raise [ArgumentError] When no or an inexistent issue service kind is set
+    #
+    # @return [Object] a factory instance
+    #
     def initialize(options = {})
       @kind = options.fetch(:kind) { raise ArgumentError, "No API client can be initialized" }
-      raise(ArgumentError, "No #{@kind} API client has been implemented") unless IMPLEMENTED_BACKENDS.include?(@kind)
+      raise(NotImplementedError, "No #{@kind} API client has been implemented") unless IMPLEMENTED_BACKENDS.include?(@kind)
       @options = options.reject { |k| [:kind].include? k }
       default_options = { user_agent: "Checklister for #{@kind} #{Checklister::VERSION}" }
-      default_options.merge!(httparty: { verify: false }) # FIXME
       @options.merge! default_options
+      @options_for_kind = prepare_options_for_kind(@options, @kind)
+      @project_klass = nil
+      @issue_klass = nil
+      define_classes_for_kind(@kind)
+      @api_client = get_api_client
+    end
+
+    def project
+      @project ||= @project_klass.new(@api_client)
     end
 
+    def issue
+      @issue ||= @issue_klass.new(@api_client)
+    end
+
+    private
+
+    # Initialize the issue service API client
+    #
+    # @example get an API client
+    #   gitlab_client = Checklister::Client.new(kind: "gitlab", endpoint: "https://gitlab.com/api/v3", private_token: "supersecret")
+    #   gtilab_client.get_api_client
+    #
+    # @return [Object] the API client based on our initialized options
+    #
     def get_api_client
       case @kind
       when "gitlab"
-        ::Gitlab.client(@options)
+        @api_client ||= ::Gitlab.client(@options_for_kind)
+      when "github"
+        @api_client ||= Octokit::Client.new(@options_for_kind)
       end
     end
+
+    def prepare_options_for_kind(options, kind)
+      if kind == "github"
+        # Octokit uses ENV for overide
+        # See: https://github.com/octokit/octokit.rb/blob/a98979107a4bf9741a05a1f751405f8a29f29b38/lib/octokit/default.rb#L136-L138
+        options.delete(:user_agent)
+        # :endpoint is not required
+        options.delete(:endpoint)
+        # :private_token is called :access_token
+        options[:access_token] = options.delete(:private_token)
+      elsif kind == "gitlab"
+        options.merge!(httparty: { verify: false }) # FIXME
+      end
+      options
+    end
+
+    def define_classes_for_kind(kind)
+      @project_klass = if kind == "gitlab"
+                         Checklister::Gitlab::Project
+                       elsif kind == "github"
+                         Checklister::Github::Project
+                       end
+      @issue_klass = if kind == "gitlab"
+                       Checklister::Gitlab::Issue
+                     elsif kind == "github"
+                       Checklister::Github::Issue
+                     end
+    end
   end
 end

data/lib/checklister/github/issue.rb

@@ -0,0 +1,14 @@
+module Checklister
+  module Github
+    class Issue
+      def initialize(client)
+        @client = client
+      end
+
+      def create(project_id, attributes = {})
+        issue = Checklister::Issue.new(attributes.merge(project_id: project_id))
+        @client.create_issue(issue.project_id, issue.title, issue.description)
+      end
+    end
+  end
+end

data/lib/checklister/github/project.rb

@@ -0,0 +1,63 @@
+module Checklister
+  module Github
+    class ProjectDecorator
+      def initialize(object)
+        @object = object
+      end
+
+      def id
+        @object[:id]
+      end
+
+      def name
+        @object[:full_name]
+      end
+
+      def description
+        @object[:description]
+      end
+
+      def to_hash
+        { id: id, name: name, description: description }
+      end
+    end
+
+    class Project
+      # Default options that we want to pass when querying the github project index
+      DEFAULT_OPTIONS = { sort: "full_name", direction: "asc" }
+
+      # Initialize a github project instance
+      #
+      # @example Get a project's data
+      #   project = Checklister::Project.new(gitlab_client).get(1)
+      #
+      # @param client [Object] an instance of Checklister::Client
+      #
+      def initialize(client)
+        @client = client
+      end
+
+      # Query a particular project based on it's id
+      # @param project_id [Integer] github project id
+      # @return [Hash] a project properties
+      def get(project_id)
+        ProjectDecorator.new(@client.repository(project_id)).to_hash
+      end
+
+      # Get all github's projects
+      # @param options [optional, Hash] query options
+      # @return [Array] and array of project's properties as Hash
+      def all(options = {})
+        query_options = DEFAULT_OPTIONS.merge options
+        @client.repositories(query_options).map { |p| ProjectDecorator.new(p).to_hash }
+      end
+
+      # Get github's projects based on a search string (LIKE on project#name)
+      # @param name [String] partial project's name
+      # @return [Array] and array of project's properties as Hash
+      def filtered_by_name(name, _options = {})
+        all.select { |p| p[:name].downcase.include? name.downcase }
+      end
+    end
+  end
+end

data/lib/checklister/gitlab/project.rb

@@ -1,25 +1,64 @@
 module Checklister
   module Gitlab
+    class ProjectDecorator
+      def initialize(object)
+        @object = object
+      end
+
+      def id
+        @object.id
+      end
+
+      def name
+        @object.name_with_namespace
+      end
+
+      def description
+        @object.description
+      end
+
+      def to_hash
+        { id: id, name: name, description: description }
+      end
+    end
+
     class Project
-      DEFAULT_OPTIONS = { order_by: "id", sort: "asc", per_page: "10" }
-      ATTRIBUTES = %w(id name description) # NOTE: For information
+      # Default options that we want to pass when querying the gitlab project index
+      DEFAULT_OPTIONS = { order_by: "id", sort: "asc", per_page: "200" }
 
+      # Initialize a gitlab project instance
+      #
+      # @example Get a project's data
+      #   project = Checklister::Project.new(gitlab_client).get(1)
+      #
+      # @param client [Object] an instance of Checklister::Client
+      #
       def initialize(client)
         @client = client
       end
 
+      # Query a particular project based on it's id
+      # @param project_id [Integer] gitlab project id
+      # @return [Hash] a project properties
       def get(project_id)
-        Checklister::Sanitizer.symbolize @client.project(project_id).to_hash
+        ProjectDecorator.new(@client.project(project_id)).to_hash
       end
 
+      # Get all gitlab's projects
+      # @param options [optional, Hash] query options
+      # @return [Array] and array of project's properties as Hash
       def all(options = {})
         query_options = DEFAULT_OPTIONS.merge options
-        Checklister::Sanitizer.symbolize @client.projects(query_options).map(&:to_hash)
+        @client.projects(query_options).map { |p| ProjectDecorator.new(p).to_hash }
       end
 
+      # Get gitlab's projects based on a search string (LIKE on project#name)
+      # @param name [String] partial project's name
+      # @param options [optional, Hash] query options
+      # @return [Array] and array of project's properties as Hash
       def filtered_by_name(name, options = {})
         query_options = DEFAULT_OPTIONS.merge options
-        Checklister::Sanitizer.symbolize @client.project_search(name, query_options).map(&:to_hash)
+        @client.project_search(name, query_options).map { |p| ProjectDecorator.new(p).to_hash }
       end
     end
   end

data/lib/checklister/version.rb

@@ -1,3 +1,3 @@
 module Checklister
-  VERSION = "0.9.2"
+  VERSION = "0.9.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: checklister
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Benjamin Thouret
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2015-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitlab
@@ -39,6 +39,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -182,6 +196,8 @@ files:
 - lib/checklister/client.rb
 - lib/checklister/configuration.rb
 - lib/checklister/configuration_file.rb
+- lib/checklister/github/issue.rb
+- lib/checklister/github/project.rb
 - lib/checklister/gitlab/issue.rb
 - lib/checklister/gitlab/project.rb
 - lib/checklister/issue.rb