github_to_trello 0.1.7 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b464b0a427c1163e851727141f3613ed8a6f8f21
-  data.tar.gz: e8a7ed8820e4fb3a3126c473911142e39ac11e00
+  metadata.gz: cd3e8b6451343b1932c592870f3be9f61380093c
+  data.tar.gz: 1ed2be860f48fd7fd8a3d2648b3b95323b7d9770
 SHA512:
-  metadata.gz: d1aa2cdb541a725e72a1c7ac65ed3219e2c75c9b079144ad509c9f346908bcef3fc52c3da8066aa984016a63102b24cbdc3e0e8773d03f2e1e6237a70d3071cf
-  data.tar.gz: dabab364b1bd6b317bdcf687d13d4556876a388fe6daed9f87425a1ec1f257bd28d27d60bd21d5987d40141a94795b72126e7dddacec22697c7adba33b42afe1
+  metadata.gz: e782588a8543a84222810c9ab564471e5a5ff2d3f81a6eba262cbafee3e450246c63466f329a2d6c6df321b1705adbe39c87d9c79a677ccc655fed490c055ea2
+  data.tar.gz: 54e6581dfe3bef43f741c374a963d6ab3bc87c790b82b364339e43af5de1c91b0aa55772e419eceedcefd149e94ec1b2e9f32016fb6a980d91622bb9c87c76b0

data/README.md

@@ -1,5 +1,5 @@
 ## Overview
-Generates trello cards on a specified board for all open issues in specified github repo(s). 
+Generates trello cards on a specified board for all open issues in specified github repo(s).
 
 ## Usage
 
@@ -9,12 +9,12 @@ After completing [prerequisites](#prerequisites):
 ```
 require 'github_to_trello'
 
-public_key = "your_public_key"
-token = "your_token"
-board_id "your_trello_board_id"
-repo_name = "your_name/your_repo"
-
-GithubToTrello.new(public_key, token, board_id, repo_name).update
+GithubToTrello.new(
+  :public_key => "your_public_key",
+  :token => "your_token",
+  :board_id => "your_trello_board_id",
+  :inbox_name => "your_name/your_repo",
+).update
 ```
 
 ## Prerequisites
@@ -23,15 +23,14 @@ GithubToTrello.new(public_key, token, board_id, repo_name).update
 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)
+     https://trello.com/1/connect?key=<...>&name=MyApp&response_type=token&scope=read,write
+    (substituting your public key for <...> and replacing 'MyApp' with a unique name)
 
 ## 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
+- Creates a list for specified repo
+- Adds cards for all open issues or PRs in that repo
 
 Sites used for reference
 - http://www.sitepoint.com/customizing-trello-ruby/
 - https://github.com/jeremytregunna/ruby-trello/blob/master/lib/trello/card.rb
+

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => "spec:integration"
+
+desc "Run tests"
+RSpec::Core::RakeTask.new("spec:integration") do |t|
+    t.pattern = "spec/*.rb"
+end

data/lib/github_to_trello.rb

@@ -5,12 +5,17 @@ require 'trello'
 
 
 class GithubToTrello
-  def initialize(public_key, token, board_id, repo_name)
-    @github_gateway = GithubGateway.new(repo_name)
-    @trello_gateway = TrelloGateway.new(public_key,
-                                        token,
-                                        board_id,
-                                        repo_name)
+  def initialize(options)
+    [:public_key, :token, :board_id, :repo_name].each do |required_field|
+      _raise_argument_error(required_field) unless options[required_field]
+    end
+
+    @github_gateway = GithubGateway.new(options[:repo_name])
+    @trello_gateway = TrelloGateway.new(
+      {
+        :inbox_name => options[:repo_name],
+      }.merge(options)
+    )
   end
 
   def update
@@ -18,19 +23,24 @@ class GithubToTrello
       @trello_gateway.create_or_update_card(issue)
     end
   end
+
+  def _raise_argument_error(field)
+    raise ArgumentError, "Argument '#{field}' is required yet missing"
+  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|
+#   ENV["REPOS"].split(",").each do |repo|
 #     puts "Updating repo: #{repo}"
-#     GithubToTrello.new(public_key, token, board_id, repo).update
+#
+#     GithubToTrello.new(
+#       :public_key => ENV["PUBLIC_KEY"],
+#       :token => ENV["TOKEN"],
+#       :board_id => ENV["BOARD_ID"],
+#       :repo_name => repo,
+#     ).update
 #   end
 # end
 

data/lib/github_to_trello/trello_gateway.rb

@@ -5,37 +5,48 @@ DAYS_TIL_OLD = 14
 DAYS_TIL_REALLY_OLD = 28
 
 class TrelloGateway
-  attr_reader :list, :board, :claimed_list, :done_list
+  attr_reader :board, :inbox
+
+  def initialize(options)
+    [:public_key, :token, :board_id, :inbox_name].each do |required_field|
+      _raise_argument_error(required_field) unless options[required_field]
+    end
 
-  def initialize(public_key, token, board_id, repo_name)
     Trello.configure do |c|
-      c.developer_public_key = public_key
-      c.member_token = token
+      c.developer_public_key = options[:public_key]
+      c.member_token = options[:token]
     end
 
-    @board = _board(board_id)
-    @list = _list(repo_name)
-    @claimed_list = _list("Claimed")
-    @done_list = _list("Done")
+    @board = _board(options[:board_id])
+    @inbox = _list(options[:inbox_name])
   end
 
   def create_or_update_card(issue)
-    existing_card = _existing_card?(issue)
+    existing_card = _existing_card(issue)
     existing_card.nil? ? _create_card(issue) : existing_card
   end
 
-  def _existing_card?(issue)
-    unclaimed_card = _list_contains_issue?(@list, issue)
-    claimed_card = _list_contains_issue?(@claimed_list, issue)
-    done_card = _list_contains_issue?(@done_list, issue)
+  def lists
+    board.lists
+  end
 
-    unclaimed_card || claimed_card || done_card
+  def _raise_argument_error(field)
+    raise "Argument '#{field}' is required yet missing"
+  end
+
+  def _existing_card(issue)
+    lists.each do |list|
+      list.cards.each do |card|
+        return card if card.name == issue.title
+      end
+    end
+    nil
   end
 
   def _create_card(issue)
     card = Trello::Card.create(
       :name => issue.title,
-      :list_id => @list.id,
+      :list_id => inbox.id,
       :desc => issue.body + "\n" + issue.html_url + "\n" + issue.updated_at.to_s,
     )
     _add_checklist_to(card)
@@ -43,25 +54,19 @@ class TrelloGateway
   end
 
   def _add_checklist_to(card)
-    checklist = Trello::Checklist.create(:name => "Todo", :board_id => @board.id)
+    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(name)
-    found_list = @board.lists.detect do |list|
+    found_list = board.lists.detect do |list|
       list.name =~ /#{name}/
     end
-    found_list || Trello::List.create(:name => name, :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.7"
+  VERSION = "1.0.1"
 end

data/spec/github_to_trello_spec.rb

@@ -0,0 +1,72 @@
+require 'rspec'
+require_relative '../lib/github_to_trello'
+
+describe GithubToTrello do
+  before(:all) do
+    @options = {
+      :public_key => "abcdef",
+      :token => "ghilmnopqrstuvwxyz",
+      :board_id => "123456",
+      :repo_name => "chrissiedeist/django_blog",
+      :inbox_name => "django_blog",
+    }
+  end
+
+  describe "new" do
+    it "sets up github and trello gateways" do
+      expect(GithubGateway).to receive(:new).with(@options[:repo_name])
+      expect(TrelloGateway).to receive(:new).with(@options)
+
+      gateway = GithubToTrello.new(@options)
+    end
+
+    it "defaults to repository name when inbox isn't provided" do
+      allow(GithubGateway).to receive(:new).with(@options[:repo_name])
+
+      @options.delete(:inbox_name)
+      expected_options = {
+        :inbox_name => @options[:repo_name],
+      }.merge(@options)
+
+      expect(TrelloGateway).to receive(:new).with(expected_options)
+
+      gateway = GithubToTrello.new(@options)
+    end
+
+    it "raises an error if any mandatory fields aren't passed" do
+      required_fields = [:public_key, :token, :board_id, :repo_name]
+
+      (1..3).each do |field_count|
+        required_fields.combination(field_count).to_a.each do |field_combo|
+          bad_options = {}
+          field_combo.each do |field|
+            bad_options[field] = @options[field]
+          end
+
+          expect{ GithubToTrello.new(bad_options)}.to raise_error(ArgumentError)
+        end
+      end
+    end
+  end
+
+  describe "update" do
+    it "iterates over issues" do
+      issues = ["first", "second", "third"]
+      fake_github_gateway = fake_trello_gateway = double()
+
+
+      allow(GithubGateway).to receive(:new).and_return(fake_github_gateway)
+      allow(TrelloGateway).to receive(:new).and_return(fake_trello_gateway)
+
+      gateway = GithubToTrello.new(@options)
+
+      expect(fake_github_gateway).to receive(:issues).and_return(issues)
+
+      issues.each do |issue|
+        expect(fake_trello_gateway).to receive(:create_or_update_card).with(issue)
+      end
+
+      gateway.update
+    end
+  end
+end

data/spec/trello_gateway_spec.rb

@@ -3,12 +3,13 @@ require_relative '../lib/github_to_trello/trello_gateway'
 
 describe TrelloGateway do
   before(:each) do
-    public_key = "56acdaa7404ebcc8bbaffab18428d4d2"
-    token = "08f4481d00aba0091592ad9e0ce7e025ac9e238ead31852fe4a75270fbd562e9"
-    board_id = "5jGWvKui"
-    repo = "django_blog"
+    @gateway = TrelloGateway.new(
+      :public_key => "56acdaa7404ebcc8bbaffab18428d4d2",
+      :token => "08f4481d00aba0091592ad9e0ce7e025ac9e238ead31852fe4a75270fbd562e9",
+      :board_id => "5jGWvKui",
+      :inbox_name => "django_blog",
+    )
 
-    @gateway = TrelloGateway.new(public_key, token, board_id, repo)
     @issue = double(:issue,
       :title => "Test",
       :id => "91374795",
@@ -21,23 +22,14 @@ describe TrelloGateway do
   after(:each) do
     @gateway.board.lists.each do |list|
       list.cards.each(&:delete)
+      list.close!
     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")
+    it "creates the inbox list" do
+      expect(@gateway.inbox).to be_a Trello::List
+      expect(@gateway.inbox.name).to eq("django_blog")
     end
 
     it "has a board" do
@@ -45,29 +37,21 @@ describe TrelloGateway do
     end
   end
 
-  describe "_existing_card?" do
-    it "returns the existing trello card if the card exists in it's repos list" do
+  describe "_existing_card" do
+    it "returns the existing trello card if the card exists in the inbox folder" do
       card = @gateway.create_or_update_card(@issue)
 
-      existing_card = @gateway._existing_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
+    it "returns the existing trello card if the card exists in list other than the inbox" do
+      other_list = Trello::List.create(:name => "some other list", :board_id => @gateway.board.id)
       card = @gateway.create_or_update_card(@issue)
-      card.move_to_list(@gateway.claimed_list.id)
+      card.move_to_list(other_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) 
+      existing_card = @gateway._existing_card(@issue)
       expect(existing_card).to be_a(Trello::Card)
       expect(existing_card.name).to eq("Test")
     end
@@ -83,11 +67,23 @@ describe TrelloGateway do
 
       @gateway.create_or_update_card(not_the_issue)
 
-      existing_card = @gateway._existing_card?(@issue) 
+      existing_card = @gateway._existing_card(@issue)
       expect(existing_card).to be_nil
     end
   end
 
+  describe "lists" do
+      it "presents all lists on the board" do
+        expect(@gateway.lists.count).to eq(1)
+        expect(@gateway.lists.first).to be_a Trello::List
+        expect(@gateway.lists.first.name).to eq("django_blog")
+        5.times do |number|
+          Trello::List.create(:name => "list_number_#{number}", :board_id => @gateway.board.id)
+        end
+        expect(@gateway.lists.count).to eq(6)
+      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)
@@ -113,48 +109,22 @@ describe TrelloGateway do
       expect(card.name).to eq("Test")
     end
 
-    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)
-
-      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 => Date.today.to_s,
-        :body => "This is a test",
-        :html_url => "https://github.com/chrissiedeist/django_blog/issues/1",
-      )
-
-      @gateway.done_list.cards.length.should == 0
+    it "does not add a duplicate card if card exists in a list" do
+      card = @gateway.create_or_update_card(@issue)
+      expect(card.list.name).to eq("django_blog")
+      expect(@gateway.inbox.cards.length).to eq(1)
 
-      card = @gateway.create_or_update_card(issue)
-      card.list.name.should == "django_blog"
+      other_list = Trello::List.create(:name => "some other list", :board_id => @gateway.board.id)
+      expect(other_list.cards.length).to eq(0)
 
-      card.move_to_list(@gateway.done_list.id)
-      card = @gateway.create_or_update_card(issue)
+      card.move_to_list(other_list.id)
+      expect(other_list.cards.length).to eq(1)
+      expect(@gateway.inbox.cards.length).to eq(0)
 
-      card.list.name.should == "Done"
-      @gateway.done_list.cards.length.should == 1
-      @gateway.list.cards.length.should == 0
+      card = @gateway.create_or_update_card(@issue)
+      expect(card.list.name).to eq("some other list")
+      expect(other_list.cards.length).to eq(1)
+      expect(@gateway.inbox.cards.length).to eq(0)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_to_trello
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 1.0.1
 platform: ruby
 authors:
 - chrissie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-27 00:00:00.000000000 Z
+date: 2015-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -98,6 +98,7 @@ files:
 - lib/github_to_trello/trello_gateway.rb
 - lib/github_to_trello/version.rb
 - spec/github_gateway_spec.rb
+- spec/github_to_trello_spec.rb
 - spec/trello_gateway_spec.rb
 homepage: https://github.com/chrissiedeist/github_to_trello
 licenses:
@@ -126,4 +127,5 @@ summary: Pulls github issues from specified repos and automatically creates/popu
   trello lists with the repo names on a specified board.
 test_files:
 - spec/github_gateway_spec.rb
+- spec/github_to_trello_spec.rb
 - spec/trello_gateway_spec.rb