gitcamp 0.0.3 → 0.1.0

data/README.md

@@ -22,8 +22,55 @@ to check. If not, you'll need to [install it](http://rubygems.org/pages/download
     $ gitcamp
     Commands:
       gitcamp help [COMMAND]  # Describe available commands or one specific command
-      gitcamp todolist        # creates BaseCamp todo list from a milestone of GitHub issues
+      gitcamp milestone       # creates GitHub milestone & issues from a Basecamp todo list
+      gitcamp todolist        # creates Basecamp todo list from a milestone of GitHub issues
 
-Creating a todo list in Basecamp
+#### Creating a GitHub milestone & issues from a Basecamp todo list
+
+    $ gitcamp milestone
+
+Follow the instructions provided. This command will perform the following:
+
+1. Ask you to login to Basecamp
+2. Ask you to select a Basecamp project
+3. Ask you to select a Basecamp todo list from that project
+4. Ask you to login to GitHub
+5. Ask you to enter a GitHub repository name (eg. owner/repo)
+6. Ask you to confirm what you're about to do
+7. Find or create a milestone in GitHub with the name of the todo list
+8. Create or update an issue for each todo
+9. Tag each issue with the label `basecamp`
+10. Update the Basecamp todo with the issue number of the newly created GitHub issue
+
+Creating a Basecamp todo list from a milestone of GitHub issues
 
     $ gitcamp todolist
+
+Follow the instructions provided. This command will perform the following:
+
+1. Ask you to login to GitHub
+2. Ask you to enter a GitHub repository name (eg. owner/repo)
+3. Ask you to select a GitHub milestone from that repository
+4. Ask you to login to Basecamp
+5. Ask you to select a Basecamp project
+6. Ask you to confirm what you're about to do
+7. Find or create a todolist in Basecamp with the name of the milestone
+8. Create an todo for each issue
+9. Add the issue description as a comment
+10. Add the issue number of the GitHub issue to the front of the todo
+
+#### Login credentials
+
+You will only be asked for your GitHub and Basecamp credentials the first time you authenticate. After that they
+will be stored on your computer so you don't have to enter them each time.
+
+> TODO: Add a `--force-login` or `--clear-credentials` flag to allow users to login again
+
+#### Idempotence
+
+Gitcamp is designed to be idempotent, that is to say you can run it multiple times (selecting the same milestone and todolist)
+and it will not duplicate todos or issues.
+
+For example, if you sync a Basecamp todolist to a GitHub milestone once, then add another todo it will add that todo as an issue and leave
+all the other issues in place.
+

data/lib/gitcamp.rb

@@ -4,17 +4,24 @@ require 'thor'
 require 'octokit'
 require 'highline'
 require 'basecamp'
-require 'hashie/mash'
+
+BasecampClassic = ::Basecamp
 
 require 'gitcamp/version'
 require 'gitcamp/config'
-require 'gitcamp/github/auth'
-require 'gitcamp/basecamp/auth'
-require 'gitcamp/basecamp/todo'
-require 'gitcamp/cli'
 
-module Basecamp
-  module API
-    Classic = ::Basecamp
+module Gitcamp
+  autoload :Cli, 'gitcamp/cli'
+
+  module Basecamp
+    autoload :Auth, 'gitcamp/basecamp/auth'
+    autoload :Todo, 'gitcamp/basecamp/todo'
+  end
+
+  module Github
+    autoload :Auth, 'gitcamp/github/auth'
+    autoload :Milestone, 'gitcamp/github/milestone'
+    autoload :Issue, 'gitcamp/github/issue'
   end
 end
+

data/lib/gitcamp/basecamp/auth.rb

@@ -15,30 +15,30 @@ module Gitcamp
         if netrc[domain]
           @username, token = netrc[domain]
 
-          Basecamp::API::Classic.establish_connection!(domain, token, 'X', true)
+          BasecampClassic.establish_connection!(domain, token, 'X', true)
 
           begin
-            Basecamp::API::Classic::Person.me
+            BasecampClassic::Person.me
             say "Authenticated as #{@username}", Thor::Shell::Color::GREEN
           rescue Octokit::Unauthorized => ex
-            puts "Failed to authenticate you with those Basecamp credentials"
+            say "Failed to authenticate you with those Basecamp credentials", Thor::Shell::Color::RED
             exit false
           end
         else
           @username = ask 'Username:'
           password = ask_password 'Password:'
 
-          Basecamp::API::Classic.establish_connection!(domain, @username, password, true)
+          BasecampClassic.establish_connection!(domain, @username, password, true)
 
           begin
-            Basecamp::API::Classic::Person.me
+            BasecampClassic::Person.me
             say "Authenticated as #{@username}", Thor::Shell::Color::GREEN
           rescue Octokit::Unauthorized => ex
-            puts "Failed to authenticate you with those Basecamp credentials"
+            say "Failed to authenticate you with those Basecamp credentials", Thor::Shell::Color::RED
             exit false
           end
 
-          token = Basecamp::API::Classic::Person.me.token
+          token = BasecampClassic::Person.me.token
 
           unless netrc[domain]
             netrc[domain] = @username, token

data/lib/gitcamp/basecamp/todo.rb

@@ -10,6 +10,7 @@ module Gitcamp
 
         @list = options[:list]
         @issue = options[:issue]
+        @find_by_title = options[:find_by_title]
 
         @title = @issue.title.gsub(/\[[\d\.]*\]\s+/, '')
         @title = "##{issue.number} #{@title}"
@@ -19,7 +20,7 @@ module Gitcamp
         find_or_build_todo
 
         if item.save
-          say "Processed todo #{title} in Basecamp"
+          say "Processed todo '#{title}' in Basecamp"
         end
 
         create_or_update_comment
@@ -28,13 +29,18 @@ module Gitcamp
       private
 
       def find_or_build_todo
-        todo_items = Basecamp::API::Classic::TodoItem.find(:all, :params => { :todo_list_id => list.id })
-        @item = todo_items.find { |tdi| tdi.content =~ %r{\A##{issue.number}} }
+        todo_items = BasecampClassic::TodoItem.find(:all, :params => { :todo_list_id => list.id })
+
+        if @find_by_title
+          @item = todo_items.find { |tdi| tdi.content == issue.title }
+        else
+          @item = todo_items.find { |tdi| tdi.content =~ %r{\A##{issue.number}} }
+        end
 
         if @item
           @item.content = @title
         else
-          @item = Basecamp::API::Classic::TodoItem.new(:content => @title, :notify => false, :todo_list_id => list.id)
+          @item = BasecampClassic::TodoItem.new(:content => @title, :notify => false, :todo_list_id => list.id)
         end
       end
 
@@ -42,7 +48,7 @@ module Gitcamp
         return if issue.body.blank?
 
         comment = @item.comments.find { |cm| cm.body =~ %r{\A\[##{issue.number}\]} }
-        comment ||= Basecamp::API::Classic::Comment.new(:todo_item_id => item.id, :use_textile => true)
+        comment ||= BasecampClassic::Comment.new(:todo_item_id => item.id, :use_textile => true)
 
         comment.body = "[##{issue.number}] *Description:* #{issue.body}"
         comment.save

data/lib/gitcamp/cli.rb

@@ -4,8 +4,10 @@ module Gitcamp
   class Cli < Thor
     include Thor::Actions
 
-    desc 'todolist', 'creates BaseCamp todo list from a milestone of GitHub issues'
+    desc 'todolist', 'creates Basecamp todo list from a milestone of GitHub issues'
     def todolist
+      say "\n  Creating a Basecamp todo list from a milestone of GitHub issues"
+      say "  Press ^C at any time to abort\n\n"
 
       # Authenicate with Github
       auth = Gitcamp::Github::Auth.new
@@ -18,8 +20,9 @@ module Gitcamp
       milestones = @github.list_milestones(repo)
 
       # Ask user to select a milestone to use
+      say "\n  Which GitHub milestone do you want to import?\n\n"
       choose do |menu|
-        menu.prompt = 'Which milestone do you want to import?'
+        menu.prompt = 'Enter a number from the list above:'
         milestones.each do |milestone|
           menu.choice "#{milestone.title} (#{milestone.open_issues} open issues)" do
             @milestone = milestone
@@ -34,11 +37,12 @@ module Gitcamp
       auth.login
 
       # Get all active projects
-      projects = Basecamp::API::Classic::Project.all.select { |project| project.status == 'active' }
+      projects = BasecampClassic::Project.all.select { |project| project.status == 'active' }
 
       # Ask user to select a project
+      say "\n  Which Basecamp project do you want to create the todo list in?\n\n"
       choose do |menu|
-        menu.prompt = 'Which project do you want to create the TODO list in?'
+        menu.prompt = 'Enter a number from the list above:'
         projects.each do |project|
           menu.choice "#{project.name}" do
             @project = project
@@ -48,16 +52,18 @@ module Gitcamp
 
       say "Chosen project: #{@project.name}"
 
+      say "\n  Read and confirm the action below:\n\n"
+
       # Confirm pending operation to user?
-      if yes? "Are you sure you want to create a Todo list named '#{@milestone.title}' in the #{@project.name} Basecamp project and add the #{@milestone.open_issues} issues as Todo items? (y/n)", Thor::Shell::Color::CYAN
+      if yes? "Are you sure you want to create (or update) a Basecamp todo list named '#{@milestone.title}' in the '#{@project.name}' project and add the #{@milestone.open_issues} GitHub issues as Basecamp todo items? (y/n)", Thor::Shell::Color::CYAN
 
         # Try to find an existing TodoList in Basecamp
-        todo_lists = Basecamp::API::Classic::TodoList.all(@project.id)
+        todo_lists = BasecampClassic::TodoList.all(@project.id)
         todo_list = todo_lists.find { |tdl| tdl.name == @milestone.title }
 
         # If it doesn't exist, create one
         unless todo_list
-          todo_list = Basecamp::API::Classic::TodoList.new(:name => @milestone.title, :description => @milestone.description, :project_id => @project.id)
+          todo_list = BasecampClassic::TodoList.new(:name => @milestone.title, :description => @milestone.description, :project_id => @project.id)
           todo_list.save
 
           say "Created todo list: #{todo_list.name}"
@@ -77,5 +83,75 @@ module Gitcamp
       end
     end
 
+    desc 'milestone', 'creates GitHub milestone & issues from a Basecamp todo list'
+    def milestone
+      say "\n  Creating a GitHub milestone & issues from a Basecamp todo list"
+      say "  Press ^C at any time to abort\n\n"
+
+      # Authenticate with Basecamp
+      auth = Gitcamp::Basecamp::Auth.new
+      auth.login
+
+      # Get all active projects
+      projects = BasecampClassic::Project.all.select { |project| project.status == 'active' }
+
+      # Ask user to select a project
+      say "\n  Which Basecamp project is the todo list in?\n\n"
+      choose do |menu|
+        menu.prompt = 'Enter a number from the list above:'
+        projects.each do |project|
+          menu.choice "#{project.name}" do
+            @project = project
+          end
+        end
+      end
+
+      say "Chosen project: #{@project.name}"
+
+      todolists = BasecampClassic::TodoList.all(@project.id)
+
+      # Ask user to select a todolist to use
+      say "\n  Which Basecamp todo list do you want to import?\n\n"
+      choose do |menu|
+        menu.prompt = 'Enter a number from the list above:'
+        todolists.each do |todolist|
+          menu.choice "#{todolist.name} (#{todolist.uncompleted_count} incomplete todos)" do
+            @todolist = todolist
+          end
+        end
+      end
+
+      say "Chosen todo list: #{@todolist.name}"
+
+      # Authenicate with Github
+      auth = Gitcamp::Github::Auth.new
+      @github = auth.login
+
+      # What repo are we adding to?
+      repo = ask 'Enter a GitHub repo name (eg. owner/repo) to create the milestone in:'
+
+      # Confirm pending operation to user?
+      say "\n  Read and confirm the action below:\n\n"
+
+      if yes? "Are you sure you want to create (or update) a GitHub milestone named '#{@todolist.name}' in the repo '#{repo}' and add the #{@todolist.uncompleted_count} todos in Basecamp todo list '#{@todolist.name}' as issues? (y/n)", Thor::Shell::Color::CYAN
+
+        # Find or create a milestone
+        milestone = Gitcamp::Github::Milestone.new(github: @github, repo: repo, todolist: @todolist)
+        milestone.save
+
+        todo_items = BasecampClassic::TodoItem.find(:all, :params => { :todo_list_id => @todolist.id })
+
+        todo_items.each do |todo_item|
+          next if todo_item.completed
+
+          issue = Gitcamp::Github::Issue.new(github: @github, milestone: milestone, repo: repo, todo: todo_item, todolist: @todolist)
+          issue.save
+        end
+
+      else
+        say 'No action taken, exiting'
+        exit true
+      end
+    end
   end
 end

data/lib/gitcamp/github/issue.rb

@@ -0,0 +1,37 @@
+module Gitcamp
+  module Github
+    class Issue
+      attr_reader :todo, :todolist, :github, :milestone, :issue, :repo, :title
+
+      def initialize(options = {})
+        unless options[:todo]
+          raise ArgumentError, 'no Basecamp todo given'
+        end
+
+        @github = options[:github]
+        @repo = options[:repo]
+        @milestone = options[:milestone]
+        @todo = options[:todo]
+        @todolist = options[:todolist]
+
+        @title = @todo.content.gsub(/#\d+\s+/, '')
+      end
+
+      def save
+        issues = @github.list_issues(repo, milestone: milestone.number)
+        @issue = issues.find { |issue| issue.title == title }
+
+        if @issue
+          @issue = @github.update_issue(repo, issue.number, issue.title, issue.body, milestone: milestone.number, labels: 'basecamp')
+        else
+          @issue = @github.create_issue(repo, title, '', milestone: milestone.number, labels: 'basecamp')
+
+          todo = Gitcamp::Basecamp::Todo.new(list: todolist, issue: issue, find_by_title: true)
+          todo.save
+        end
+
+        say "Processed issue '#{issue.title}' in GitHub"
+      end
+    end
+  end
+end

data/lib/gitcamp/github/milestone.rb

@@ -0,0 +1,34 @@
+module Gitcamp
+  module Github
+    class Milestone
+      attr_reader :todolist, :title, :milestone, :repo
+
+      def initialize(options = {})
+        unless options[:todolist]
+          raise ArgumentError, 'no Basecamp todolist given'
+        end
+
+        @repo = options[:repo]
+        @github = options[:github]
+        @todolist = options[:todolist]
+      end
+
+      def number
+        @milestone.number
+      end
+
+      def save
+        milestones = @github.list_milestones(repo)
+        @milestone = milestones.find { |mls| mls.title == todolist.name.strip }
+
+        unless @milestone
+          @milestone = @github.create_milestone(repo, @todolist.name)
+        end
+
+        if @milestone
+          say "Using milestone '#{milestone.title}' in GitHub #{repo}"
+        end
+      end
+    end
+  end
+end

data/lib/gitcamp/version.rb

@@ -1,3 +1,3 @@
 module Gitcamp
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitcamp
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-18 00:00:00.000000000 Z
+date: 2013-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70103963145420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,15 +21,10 @@ dependencies:
         version: 0.18.1
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.18.1
+  version_requirements: *70103963145420
 - !ruby/object:Gem::Dependency
   name: octokit
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70103963171080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -37,15 +32,10 @@ dependencies:
         version: 1.24.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.24.0
+  version_requirements: *70103963171080
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70103963169440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -53,15 +43,10 @@ dependencies:
         version: 1.6.19
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.19
+  version_requirements: *70103963169440
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70103963166220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -69,15 +54,10 @@ dependencies:
         version: 1.7.7
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.7.7
+  version_requirements: *70103963166220
 - !ruby/object:Gem::Dependency
   name: basecamp
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70103963165480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -85,15 +65,10 @@ dependencies:
         version: 0.0.9
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.0.9
+  version_requirements: *70103963165480
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70103963164640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -101,15 +76,10 @@ dependencies:
         version: 10.0.4
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 10.0.4
+  version_requirements: *70103963164640
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70103963163900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -117,12 +87,7 @@ dependencies:
         version: 2.13.0
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.13.0
+  version_requirements: *70103963163900
 description: Gitcamp is a handy command line tool for syncing GitHub issues & milestones
   with Basecamp todo lists, and visa-versa.
 email:
@@ -145,6 +110,8 @@ files:
 - lib/gitcamp/cli.rb
 - lib/gitcamp/config.rb
 - lib/gitcamp/github/auth.rb
+- lib/gitcamp/github/issue.rb
+- lib/gitcamp/github/milestone.rb
 - lib/gitcamp/version.rb
 homepage: http://github.com/simpleweb/gitcamp
 licenses: []
@@ -166,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: Gitcamp is a handy command line tool for syncing GitHub issues & milestones