github_to_trello 0.1.0 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e528de9a7db2c2af22f6acf465537a6544537bd
-  data.tar.gz: 021d708220d4c174e51d6990d8afd0120dd6016e
+  metadata.gz: b464b0a427c1163e851727141f3613ed8a6f8f21
+  data.tar.gz: e8a7ed8820e4fb3a3126c473911142e39ac11e00
 SHA512:
-  metadata.gz: 5c5bad6b82be125718570e03d48ca07816cbacbc0d454e37ab3cb3345f52e7ecef597083b37a1f682543f2c4203e091a580c54d362ba21ce701d6468abc4b0ae
-  data.tar.gz: bcae15f004db55b3a68d7ce4e33216e0e28466b3cf8d83d895928affbb7c506a00fe04037e72dccebf18ed9ceef720cb02191433a728a835da200fac30d893a7
+  metadata.gz: d1aa2cdb541a725e72a1c7ac65ed3219e2c75c9b079144ad509c9f346908bcef3fc52c3da8066aa984016a63102b24cbdc3e0e8773d03f2e1e6237a70d3071cf
+  data.tar.gz: dabab364b1bd6b317bdcf687d13d4556876a388fe6daed9f87425a1ec1f257bd28d27d60bd21d5987d40141a94795b72126e7dddacec22697c7adba33b42afe1

data/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
 
 gem 'ruby-trello'
+gem 'rspec', '~> 3.3.0'
 gem 'octokit'
-gem 'dotenv'

data/README.md

@@ -1,37 +1,9 @@
 ## Overview
-Creates/updates trello cards for all open issues in specified github repo. 
-
-Running this script/using this gem:
-- Creates a list for specified repo (if a list for that repo is not already present)
-- Adds or updates cards for all open issues or PRs in that repo
-- Adds or updates color labels to cards based on date last updated
-
-## Prerequisites
-
-1. A trello account with access to the board you are populating with github issues.
-2. A public key and token giving access to that trello account
-   - `PUBLIC_KEY` - Log into trello and visit https://trello.com/app-key
-   - `TOKEN` - Go to
-     https://trello.com/1/connect?key=...&name=MyApp&response_type=token&scope=read,write 
-    (substituting the public key for ... a unique name for MyApp)
+Generates trello cards on a specified board for all open issues in specified github repo(s). 
 
+## Usage
 
-## USAGE 1: (running as a standalone script)
-
-1. Create a .env file with with the following variables
-   defined:
-   - `BOARD_ID` - The ID of the trello board to add the cards to
-   - `REPOS` - The name(s) of the github repos to pull issues from
-     (comma separated: `REPOS=your_name/your_repo,your_name/your_other_repo`)
-   - `PUBLIC_KEY` - Log into trello and visit https://trello.com/app-key
-   - `TOKEN` - Go to
-     https://trello.com/1/connect?key=...&name=MyApp&response_type=token&scope=read,write 
-    (substituting the public key for ... a unique name for MyApp)
-
-2. Run `ruby github_to_trello.rb`
-
-## USAGE 2: (gem)
-
+After completing [prerequisites](#prerequisites):
 `gem install github_to_trello`
 
 ```
@@ -45,6 +17,20 @@ repo_name = "your_name/your_repo"
 GithubToTrello.new(public_key, token, board_id, repo_name).update
 ```
 
+## Prerequisites
+
+1. A trello account with access to the board you are populating with github issues.
+2. A public key and token giving access to that trello account
+   - `PUBLIC_KEY` - Log into trello and visit https://trello.com/app-key
+   - `TOKEN` - Go to
+     https://trello.com/1/connect?key=...&name=MyApp&response_type=token&scope=read,write 
+    (substituting the public key for ... a unique name for MyApp)
+
+## Features
+- Creates a list for specified repo (if a list for that repo is not already present)
+- Creates a list for "Claimed" cards that are being worked on, and a
+  "Done" list for recently completed issues
+- Adds or updates cards for all open issues or PRs in that repo
 
 Sites used for reference
 - http://www.sitepoint.com/customizing-trello-ruby/

data/github_to_trello.gemspec

@@ -14,10 +14,14 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
-  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.required_ruby_version = '>= 1.9.3'
+
+  spec.add_dependency "octokit", "~> 4.0.1"
+  spec.add_dependency "ruby-trello", "~> 1.2.1"
 
   spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec", "~> 3.3.0"
   spec.add_development_dependency "rake"
 end

data/lib/github_to_trello.rb

@@ -2,9 +2,7 @@ require_relative './github_to_trello/github_gateway'
 require_relative './github_to_trello/trello_gateway'
 require 'octokit'
 require 'trello'
-require 'dotenv'
 
-Dotenv.load
 
 class GithubToTrello
   def initialize(public_key, token, board_id, repo_name)
@@ -22,15 +20,17 @@ class GithubToTrello
   end
 end
 
-if __FILE__ == $PROGRAM_NAME
-  public_key = ENV["PUBLIC_KEY"]
-  token = ENV["TOKEN"]
-  board_id = ENV["BOARD_ID"]
-  repos = ENV["REPOS"].split(",")
-
-  repos.each do |repo|
-    puts "Updating repo: #{repo}"
-    GithubToTrello.new(public_key, token, board_id, repo).update
-  end
-end
+# Example usage with dotenv gem and .env file
+#
+# if __FILE__ == $PROGRAM_NAME
+#   public_key = ENV["PUBLIC_KEY"]
+#   token = ENV["TOKEN"]
+#   board_id = ENV["BOARD_ID"]
+#   repos = ENV["REPOS"].split(",")
+#
+#   repos.each do |repo|
+#     puts "Updating repo: #{repo}"
+#     GithubToTrello.new(public_key, token, board_id, repo).update
+#   end
+# end
 

data/lib/github_to_trello/trello_gateway.rb

@@ -5,57 +5,63 @@ DAYS_TIL_OLD = 14
 DAYS_TIL_REALLY_OLD = 28
 
 class TrelloGateway
-  def initialize(public_key, token, board_id, repo)
+  attr_reader :list, :board, :claimed_list, :done_list
+
+  def initialize(public_key, token, board_id, repo_name)
     Trello.configure do |c|
       c.developer_public_key = public_key
       c.member_token = token
     end
 
     @board = _board(board_id)
-    @repo = repo
-    @list = _list
+    @list = _list(repo_name)
+    @claimed_list = _list("Claimed")
+    @done_list = _list("Done")
   end
 
   def create_or_update_card(issue)
     existing_card = _existing_card?(issue)
-    card = existing_card.class == (Trello::Card) ? existing_card : _create_card(issue)
-    _update(issue, card)
-  end
-
-  def _update(issue, card)
-    if issue.updated_at < (Time.now - DAYS_TIL_REALLY_OLD * SECONDS_PER_DAY)
-      card.card_labels = [:red]
-    elsif issue.updated_at < (Time.now - DAYS_TIL_OLD * SECONDS_PER_DAY)
-      card.card_labels = [:yellow]
-    else
-      card.card_labels = []
-    end
-    card.save
-    card
+    existing_card.nil? ? _create_card(issue) : existing_card
   end
 
   def _existing_card?(issue)
-    @list.cards.detect do |card|
-      card.name == issue.title
-    end
+    unclaimed_card = _list_contains_issue?(@list, issue)
+    claimed_card = _list_contains_issue?(@claimed_list, issue)
+    done_card = _list_contains_issue?(@done_list, issue)
+
+    unclaimed_card || claimed_card || done_card
   end
 
   def _create_card(issue)
-    Trello::Card.create(
+    card = Trello::Card.create(
       :name => issue.title,
       :list_id => @list.id,
-      :desc => issue.body + "\n" + issue.html_url + "\n" + issue.updated_at.to_s
+      :desc => issue.body + "\n" + issue.html_url + "\n" + issue.updated_at.to_s,
     )
+    _add_checklist_to(card)
+    card
+  end
+
+  def _add_checklist_to(card)
+    checklist = Trello::Checklist.create(:name => "Todo", :board_id => @board.id)
+    checklist.add_item("Initial Response")
+    card.add_checklist(checklist)
+  end
+
+  def _list_contains_issue?(list, issue)
+    list.cards.detect do |card|
+      card.name == issue.title
+    end
   end
 
   def _board(id)
     Trello::Board.find(id)
   end
 
-  def _list
-    list = @board.lists.detect do |list|
-      list.name =~ /#{@repo}/
+  def _list(name)
+    found_list = @board.lists.detect do |list|
+      list.name =~ /#{name}/
     end
-    list = list || Trello::List.create(:name => @repo, :board_id => @board.id)
+    found_list || Trello::List.create(:name => name, :board_id => @board.id)
   end
 end

data/lib/github_to_trello/version.rb

@@ -1,3 +1,3 @@
 module GithubToTrello
-  VERSION = "0.1.0"
+  VERSION = "0.1.7"
 end

data/spec/github_gateway_spec.rb

@@ -1,5 +1,5 @@
 require 'rspec'
-require 'github_gateway'
+require_relative '../lib/github_to_trello/github_gateway'
 
 describe GithubGateway do
   before(:all) do

data/spec/trello_gateway_spec.rb

@@ -1,11 +1,10 @@
-require 'dotenv'
 require 'rspec'
-require 'trello_gateway'
+require_relative '../lib/github_to_trello/trello_gateway'
 
 describe TrelloGateway do
   before(:each) do
     public_key = "56acdaa7404ebcc8bbaffab18428d4d2"
-    token = "748c2116942c251bf6ed8000c13196293443ddcb407422ccacd92d0001b831da"
+    token = "08f4481d00aba0091592ad9e0ce7e025ac9e238ead31852fe4a75270fbd562e9"
     board_id = "5jGWvKui"
     repo = "django_blog"
 
@@ -13,41 +12,149 @@ describe TrelloGateway do
     @issue = double(:issue,
       :title => "Test",
       :id => "91374795",
-      :updated_at => "2015-06-26T22:08:36Z",
+      :updated_at => Date.today.to_s,
       :body => "This is a test",
       :html_url => "https://github.com/chrissiedeist/django_blog/issues/1",
     )
   end
 
+  after(:each) do
+    @gateway.board.lists.each do |list|
+      list.cards.each(&:delete)
+    end
+  end
+
+  describe "initialization" do
+    it "has a list named for the repo" do
+      expect(@gateway.list).to be_a Trello::List
+      expect(@gateway.list.name).to eq("django_blog")
+    end
+
+    it "has a list called 'Claimed'" do
+      expect(@gateway.list).to be_a Trello::List
+      expect(@gateway.claimed_list.name).to eq("Claimed")
+    end
+
+    it "has a list called 'Done'" do
+      expect(@gateway.list).to be_a Trello::List
+      expect(@gateway.done_list.name).to eq("Done")
+    end
+
+    it "has a board" do
+      expect(@gateway.board).to be_a Trello::Board
+    end
+  end
+
+  describe "_existing_card?" do
+    it "returns the existing trello card if the card exists in it's repos list" do
+      card = @gateway.create_or_update_card(@issue)
+
+      existing_card = @gateway._existing_card?(@issue) 
+      expect(existing_card).to be_a(Trello::Card)
+      expect(existing_card.name).to eq("Test")
+    end
+
+    it "returns the existing trello card if the card exists in the 'Claimed' list" do
+      card = @gateway.create_or_update_card(@issue)
+      card.move_to_list(@gateway.claimed_list.id)
+
+      existing_card = @gateway._existing_card?(@issue) 
+      expect(existing_card).to be_a(Trello::Card)
+      expect(existing_card.name).to eq("Test")
+    end
+
+    it "returns the existing trello card if the card exists in the 'Done' list" do
+      card = @gateway.create_or_update_card(@issue)
+      card.move_to_list(@gateway.done_list.id)
+
+      existing_card = @gateway._existing_card?(@issue) 
+      expect(existing_card).to be_a(Trello::Card)
+      expect(existing_card.name).to eq("Test")
+    end
+
+    it "returns nil if no card has been created for the issue" do
+      not_the_issue = double(:issue,
+        :title => "Test 2",
+        :id => "91374796",
+        :updated_at => Date.today.to_s,
+        :body => "This is a test",
+        :html_url => "https://github.com/chrissiedeist/django_blog/issues/2",
+      )
+
+      @gateway.create_or_update_card(not_the_issue)
+
+      existing_card = @gateway._existing_card?(@issue) 
+      expect(existing_card).to be_nil
+    end
+  end
+
   describe "create_or_update_card" do
     it "creates a new card on the appropriate list if it does not exist" do
       card = @gateway.create_or_update_card(@issue)
       expect(card.class).to be(Trello::Card)
       expect(card.name).to eq("Test")
-      expect(card.list.name).to eq("chrissiedeist/django_blog")
+      expect(card.list.name).to eq("django_blog")
+    end
 
+    it "includes a checklist with item for initial response when creating cards" do
+      card = @gateway.create_or_update_card(@issue)
+      expect(card.checklists.length).to eq 1
+
+      checklist = card.checklists.first
+      expect(checklist.items.length).to eq 1
+      expect(checklist.items.first.name).to eq "Initial Response"
     end
 
-    it "does not add a duplicate card if card exits" do
+    it "does not add a duplicate card if card exits in list already" do
       card = @gateway.create_or_update_card(@issue)
       card = @gateway.create_or_update_card(@issue)
 
       expect(card.list.cards.length).to eq(1)
+      expect(card.name).to eq("Test")
     end
 
-    it "adds a red label if card is more than 28 days old" do
-      card = @gateway.create_or_update_card(@issue)
-      expect(card.card_labels).to eq([])
+    it "does not add a duplicate card if card exists in a list called 'claimed'" do
+      issue = double(:issue,
+        :title => "Test",
+        :id => "91374795",
+        :updated_at => Date.today.to_s,
+        :body => "This is a test",
+        :html_url => "https://github.com/chrissiedeist/django_blog/issues/1",
+      )
+
+      @gateway.claimed_list.cards.length.should == 0
+
+      card = @gateway.create_or_update_card(issue)
+      card.list.name.should == "django_blog"
+
+      card.move_to_list(@gateway.claimed_list.id)
+      card = @gateway.create_or_update_card(issue)
 
-      updated_issue = double(:issue,
+      card.list.name.should == "Claimed"
+      @gateway.claimed_list.cards.length.should == 1
+      @gateway.list.cards.length.should == 0
+    end
+
+    it "does not add a duplicate card if card exists in a list called 'done'" do
+      issue = double(:issue,
         :title => "Test",
         :id => "91374795",
-        :updated_at => "2015-01-27T22:08:36Z",
+        :updated_at => Date.today.to_s,
         :body => "This is a test",
         :html_url => "https://github.com/chrissiedeist/django_blog/issues/1",
       )
-      card = @gateway.create_or_update_card(updated_issue)
-      expect(card.card_labels).to eq([:red])
+
+      @gateway.done_list.cards.length.should == 0
+
+      card = @gateway.create_or_update_card(issue)
+      card.list.name.should == "django_blog"
+
+      card.move_to_list(@gateway.done_list.id)
+      card = @gateway.create_or_update_card(issue)
+
+      card.list.name.should == "Done"
+      @gateway.done_list.cards.length.should == 1
+      @gateway.list.cards.length.should == 0
     end
   end
 end

metadata

@@ -1,41 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: github_to_trello
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.7
 platform: ruby
 authors:
 - chrissie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-21 00:00:00.000000000 Z
+date: 2015-08-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+- !ruby/object:Gem::Dependency
+  name: ruby-trello
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
 - !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'
 description: A gem for converting github issues into trello cards
@@ -45,14 +87,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- github_to_trello-0.0.1.gem
 - github_to_trello.gemspec
-- github_to_trello.sh
 - lib/github_to_trello.rb
 - lib/github_to_trello/github_gateway.rb
 - lib/github_to_trello/trello_gateway.rb
@@ -69,17 +109,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Pulls github issues from specified repos and automatically creates/populates

data/github_to_trello.sh

@@ -1,17 +0,0 @@
-#!/usr/bin/env ruby
-require 'github_to_trello'
-
-Dotenv.load
-
-if __FILE__ == $PROGRAM_NAME
-  public_key = ENV["PUBLIC_KEY"]
-  token = ENV["TOKEN"]
-  board_id = ENV["BOARD_ID"]
-  repos = ENV["REPOS"].split(",")
-
-  repos.each do |repo|
-    puts "Updating repo: #{repo}"
-    GithubToTrello.new(public_key, token, board_id, repo).update
-  end
-end
-