ruby-trello-wgibbs 0.4.3

data/spec/basic_auth_policy_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+include Trello::Authorization
+
+describe BasicAuthPolicy do
+  before do
+    BasicAuthPolicy.developer_public_key = "xxx"
+    BasicAuthPolicy.member_token = "xxx"
+  end
+
+  it "adds key and token query parameters" do
+    BasicAuthPolicy.developer_public_key = "xxx_developer_public_key_xxx"
+    BasicAuthPolicy.member_token = "xxx_member_token_xxx"
+
+    uri = Addressable::URI.parse("https://xxx/")
+
+    request = Request.new :get, uri
+
+    authorized_request = BasicAuthPolicy.authorize request
+
+    the_query_parameters = Addressable::URI.parse(authorized_request.uri).query_values
+
+    the_query_parameters["key"].should === "xxx_developer_public_key_xxx"
+    the_query_parameters["token"].should === "xxx_member_token_xxx"
+  end
+
+  it "preserves other query parameters" do
+    uri = Addressable::URI.parse("https://xxx/?name=Phil")
+
+    request = Request.new :get, uri, {:example_header => "example_value"}
+
+    authorized_request = BasicAuthPolicy.authorize request
+
+    the_query_parameters = Addressable::URI.parse(authorized_request.uri).query_values
+
+    the_query_parameters["name"].should == "Phil"
+  end
+
+  it "preserves headers" do
+    uri = Addressable::URI.parse("https://xxx/")
+
+    request = Request.new :get, uri, {:example_header => "example_value"}
+
+    authorized_request = BasicAuthPolicy.authorize request
+
+    authorized_request.headers.should === request.headers
+  end
+
+  it "returns nil body if one is supplied" do
+    uri = Addressable::URI.parse("https://xxx/")
+    request = Request.new :get, uri, {}, "any body"
+    BasicAuthPolicy.authorize(request).body.should be_nil
+  end
+
+  it "does what when a query parameter already exists called key or token?"
+end

data/spec/board_spec.rb

@@ -0,0 +1,196 @@
+require 'spec_helper'
+
+module Trello
+  describe Board do
+    include Helpers
+
+    before(:each) do
+      Client.stub(:get).with("/boards/abcdef123456789123456789").
+        and_return JSON.generate(boards_details.first)
+
+      @board = Board.find('abcdef123456789123456789')
+    end
+
+    context "fields" do
+      it "gets an id" do
+        @board.id.should_not be_nil
+      end
+
+      it "gets a name" do
+        @board.name.should_not be_nil
+      end
+
+      it "gets the description" do
+        @board.description.should_not be_nil
+      end
+
+      it "knows if it is closed or open" do
+        @board.closed?.should_not be_nil
+      end
+
+      it "gets its url" do
+        @board.url.should_not be_nil
+      end
+    end
+
+    context "actions" do
+      it "has a list of actions" do
+        Client.stub(:get).with("/boards/abcdef123456789123456789/actions", {:filter => :all}).
+          and_return actions_payload
+
+        @board.actions.count.should be > 0
+      end
+    end
+
+    context "cards" do
+      it "gets its list of cards" do
+        Client.stub(:get).with("/boards/abcdef123456789123456789/cards", { :filter => :open }).
+          and_return cards_payload
+
+        @board.cards.count.should be > 0
+      end
+    end
+
+    context "lists" do
+      it "has a list of lists" do
+        Client.stub(:get).with("/boards/abcdef123456789123456789/lists", hash_including(:filter => :open)).
+          and_return lists_payload
+
+        @board.has_lists?.should be true
+      end
+    end
+
+    context "members" do
+      it "has a list of members" do
+        Client.stub(:get).with("/boards/abcdef123456789123456789/members", hash_including(:filter => :all)).
+          and_return JSON.generate([user_details])
+
+        @board.members.count.should be > 0
+      end
+    end
+
+    context "organization" do
+      it "belongs to an organization" do
+        Client.stub(:get).with("/organizations/abcdef123456789123456789").
+          and_return JSON.generate(orgs_details.first)
+
+        @board.organization.should_not be_nil
+      end
+    end
+
+    it "is not closed" do
+      @board.closed?.should_not be_true
+    end
+  end
+
+  describe "#update_fields" do
+    it "does not set any fields when the fields argument is empty" do
+      expected = {
+       'id' => "id",
+       'name' => "name",
+       'desc' => "desc",
+       'closed' => false,
+       'url' => "url",
+       'idOrganization' => "org_id"
+      }
+
+      board = Board.new(expected)
+
+      board.update_fields({})
+
+      expected.each_pair do |key, value|
+        if board.respond_to?(key)
+          board.send(key).should == value
+        end
+      end
+
+      board.description.should == expected['desc']
+      board.organization_id.should == expected['idOrganization']
+    end
+
+    it "sets any attributes supplied in the fields argument"
+  end
+
+  describe "#save" do
+    include Helpers
+
+    let(:any_board_json) do
+      JSON.generate(boards_details.first)      
+    end
+
+    it "cannot currently save a new instance" do
+      Client.should_not_receive :put
+      
+      the_new_board = Board.new
+      lambda{the_new_board.save}.should raise_error
+    end
+
+    it "puts all fields except id" do
+      expected_fields = %w{name description closed}.map{|s| s.to_sym}
+        
+      Client.should_receive(:put) do |anything, body|
+        body.keys.should =~ expected_fields
+        any_board_json
+      end
+      
+      the_new_board = Board.new 'id' => "xxx"
+      the_new_board.save
+    end
+
+    it "mutates the current instance" do
+      Client.stub(:put).and_return any_board_json
+      
+      board = Board.new 'id' => "xxx"
+      
+      the_result_of_save = board.save
+
+      the_result_of_save.should equal board
+    end
+
+    it "uses the correct resource" do
+      expected_resource_id = "xxx_board_id_xxx"
+
+      Client.should_receive(:put) do |path, anything|
+        path.should =~ /#{expected_resource_id}\/$/
+        any_board_json
+      end
+      
+      the_new_board = Board.new 'id' => expected_resource_id
+      the_new_board.save
+    end 
+
+    it "saves OR updates depending on whether or not it has an id set"
+  end
+  
+  describe "Repository" do
+    include Helpers
+
+    let(:any_board_json) do
+      JSON.generate(boards_details.first)      
+    end
+
+    it "creates a new board with whatever attributes are supplied " do
+      expected_attributes = { :name => "Any new board name", :description => "Any new board desription" }
+      sent_attributes = { :name => expected_attributes[:name], :desc => expected_attributes[:description] }
+
+      Client.should_receive(:post).with("/boards", sent_attributes).and_return any_board_json
+
+      Board.create expected_attributes
+    end
+
+    it "posts to the boards collection" do
+      Client.should_receive(:post).with("/boards", anything).and_return any_board_json
+
+      Board.create :xxx => ""
+    end
+
+    it "returns a board" do
+      Client.stub(:post).with("/boards", anything).and_return any_board_json
+
+      the_new_board = Board.create :xxx => ""
+      the_new_board.should be_a Board
+    end
+    
+    it "at least name is required"
+  end
+end

data/spec/card_spec.rb

@@ -0,0 +1,213 @@
+require 'spec_helper'
+
+module Trello
+  describe Card do
+    include Helpers
+
+    before(:each) do
+      Client.stub(:get).with("/cards/abcdef123456789123456789").
+        and_return JSON.generate(cards_details.first)
+
+      @card = Card.find('abcdef123456789123456789')
+    end
+
+    context "creating" do
+      it "creates a new record" do
+        card = Card.new(cards_details.first)
+        card.should be_valid
+      end
+
+      it 'must not be valid if not given a name' do
+        card = Card.new('idList' => lists_details.first['id'])
+        card.should_not be_valid
+      end
+
+      it 'must not be valid if not given a list id' do
+        card = Card.new('name' => lists_details.first['name'])
+        card.should_not be_valid
+      end
+
+      it 'creates a new record and saves it on Trello', :refactor => true do
+        payload = {
+          :name    => 'Test Card',
+          :desc    => '',
+        }
+ 
+        result = JSON.generate(cards_details.first.merge(payload.merge(:idList => lists_details.first['id'])))
+
+        expected_payload = {:name => "Test Card", :desc => nil, :idList => "abcdef123456789123456789"}
+
+        Client.should_receive(:post).with("/cards", expected_payload).and_return result
+
+        card = Card.create(cards_details.first.merge(payload.merge(:list_id => lists_details.first['id'])))
+
+        card.class.should be Card
+      end
+    end
+
+    context "updating" do
+      it "updating name does a put on the correct resource with the correct value" do
+        expected_new_name = "xxx"
+        expected_resource = "/card/#{@card.id}/name"
+        payload = {
+          :name      => expected_new_name,
+          :desc      => "Awesome things are awesome.",
+          :due       => nil,
+          :closed    => false,
+          :idList    => "abcdef123456789123456789",
+          :idBoard   => "abcdef123456789123456789",
+          :idMembers => ["abcdef123456789123456789"]
+        }
+
+        Client.should_receive(:put).once.with("/cards/abcdef123456789123456789", payload)
+        card = @card.dup
+        card.name = expected_new_name
+        card.save
+      end
+    end
+
+    context "fields" do
+      it "gets its id" do
+        @card.id.should_not be_nil
+      end
+
+      it "gets its short id" do
+        @card.short_id.should_not be_nil
+      end
+
+      it "gets its name" do
+        @card.name.should_not be_nil
+      end
+
+      it "gets its description" do
+        @card.description.should_not be_nil
+      end
+
+      it "knows if it is open or closed" do
+        @card.closed.should_not be_nil
+      end
+
+      it "gets its url" do
+        @card.url.should_not be_nil
+      end
+    end
+
+    context "actions" do
+      it "asks for all actions by default" do
+        Client.stub(:get).with("/cards/abcdef123456789123456789/actions", { :filter => :all }).and_return actions_payload
+        @card.actions.count.should be > 0
+      end
+
+      it "allows overriding the filter" do
+        Client.stub(:get).with("/cards/abcdef123456789123456789/actions", { :filter => :updateCard }).and_return actions_payload
+        @card.actions(:filter => :updateCard).count.should be > 0
+      end
+    end
+
+    context "boards" do
+      it "has a board" do
+        Client.stub(:get).with("/boards/abcdef123456789123456789").and_return JSON.generate(boards_details.first)
+        @card.board.should_not be_nil
+      end
+    end
+
+    context "checklists" do
+      it "has a list of checklists" do
+        Client.stub(:get).with("/cards/abcdef123456789123456789/checklists", { :filter => :all }).and_return checklists_payload
+        @card.checklists.count.should be > 0
+      end
+    end
+
+    context "list" do
+      it 'has a list' do
+        Client.stub(:get).with("/lists/abcdef123456789123456789").and_return JSON.generate(lists_details.first)
+        @card.list.should_not be_nil
+      end
+
+      it 'can be moved to another list' do
+        other_list = stub(:id => '987654321987654321fedcba')
+        payload = {:value => other_list.id}
+        Client.should_receive(:put).with("/cards/abcdef123456789123456789/idList", payload)
+        @card.move_to_list(other_list)
+      end
+    end
+
+    context "members" do
+      it "has a list of members" do
+        Client.stub(:get).with("/boards/abcdef123456789123456789").and_return JSON.generate(boards_details.first)
+        Client.stub(:get).with("/members/abcdef123456789123456789").and_return user_payload
+
+        @card.board.should_not be_nil
+        @card.members.should_not be_nil
+      end
+
+      it "allows a member to be added to a card" do
+        new_member = stub(:id => '4ee7df3ce582acdec80000b2')
+        payload = {
+          :value => new_member.id
+        }
+        Client.should_receive(:post).with("/cards/abcdef123456789123456789/members", payload)
+        @card.add_member(new_member)
+      end
+
+      it "allows a member to be removed from a card" do
+        existing_member = stub(:id => '4ee7df3ce582acdec80000b2')
+        Client.should_receive(:delete).with("/cards/abcdef123456789123456789/members/#{existing_member.id}")
+        @card.remove_member(existing_member)
+      end
+    end
+
+    context "comments" do
+      it "posts a comment" do
+        Client.should_receive(:post).
+          with("/cards/abcdef123456789123456789/actions/comments", { :text => 'testing' }).
+          and_return JSON.generate(boards_details.first)
+        
+        @card.add_comment "testing"
+      end
+    end
+
+    context "labels" do
+      it "can retrieve labels" do
+        Client.stub(:get).with("/cards/abcdef123456789123456789/labels").
+          and_return label_payload
+        labels = @card.labels
+        labels.size.should == 2
+
+        labels[0].color.should == 'yellow'
+        labels[0].name.should == 'iOS'
+
+        labels[1].color.should == 'purple'
+        labels[1].name.should == 'Issue or bug'
+      end
+
+      it "can add a label" do
+        Client.stub(:post).with("/cards/abcdef123456789123456789/labels", { :value => 'green' }).
+          and_return "not important"
+        @card.add_label('green')
+        @card.errors.should be_empty
+      end
+
+      it "can remove a label" do
+        Client.stub(:delete).with("/cards/abcdef123456789123456789/labels/green").
+          and_return "not important"
+        @card.remove_label('green')
+        @card.errors.should be_empty
+      end
+
+      it "throws an error when trying to add a label with an unknown colour" do
+        Client.stub(:post).with("/cards/abcdef123456789123456789/labels", { :value => 'green' }).
+          and_return "not important"
+        @card.add_label('mauve')
+        @card.errors.full_messages.to_sentence.should == "Label colour 'mauve' does not exist"
+      end
+
+      it "throws an error when trying to remove a label with an unknown colour" do
+        Client.stub(:delete).with("/cards/abcdef123456789123456789/labels/mauve").
+          and_return "not important"
+        @card.remove_label('mauve')
+        @card.errors.full_messages.to_sentence.should == "Label colour 'mauve' does not exist"
+      end
+    end
+  end
+end

data/spec/checklist_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+module Trello
+  describe Checklist do
+    include Helpers
+
+    before(:each) do
+      Client.stub(:get).with("/checklists/abcdef123456789123456789").
+        and_return JSON.generate(checklists_details.first)
+
+      @checklist = Checklist.find('abcdef123456789123456789')
+    end
+
+    context "creating" do
+      it 'creates a new record and saves it on Trello', :refactor => true do
+        payload = {
+          :name    => 'Test Checklist',
+          :desc    => '',
+        }
+
+        result = JSON.generate(checklists_details.first.merge(payload.merge(:idBoard => boards_details.first['id'])))
+
+        expected_payload = {:name => "Test Checklist", :idBoard => "abcdef123456789123456789"}
+
+        Client.should_receive(:post).with("/checklists", expected_payload).and_return result
+
+        checklist = Checklist.create(checklists_details.first.merge(payload.merge(:board_id => boards_details.first['id'])))
+
+        checklist.class.should be Checklist
+      end
+    end
+
+    context "updating" do
+      it "updating name does a put on the correct resource with the correct value" do
+        expected_new_name = "xxx"
+        expected_resource = "/checklists/#{@checklist.id}"
+        payload = {
+          :name      => expected_new_name
+        }
+
+        result = JSON.generate(checklists_details.first)
+        Client.should_receive(:put).once.with("/checklists/abcdef123456789123456789", payload).and_return result
+        checklist = @checklist.dup
+        checklist.name = expected_new_name
+        checklist.save
+      end
+    end
+
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,131 @@
+require "spec_helper"
+
+include Trello
+include Trello::Authorization
+
+describe Client, "and how it handles authorization" do
+  let (:fake_ok_response) {
+    stub "A fake OK response",
+      :code => 200,
+      :body => "A fake response body"
+  }
+  
+  before do
+    TInternet.stub(:execute).and_return fake_ok_response
+    Authorization::AuthPolicy.stub(:authorize) do |request|
+      request
+    end
+  end
+
+  it "authorizes before it queries the internet" do
+    AuthPolicy.should_receive(:authorize).once.ordered
+    TInternet.should_receive(:execute).once.ordered
+
+    Client.get "/xxx"
+  end
+
+  it "queries the internet with expanded earl and query parameters" do
+    expected_uri = Addressable::URI.parse("https://api.trello.com/1/xxx?a=1&b=2")
+    expected_request = Request.new :get, expected_uri, {}
+
+    TInternet.should_receive(:execute).once.with expected_request
+
+    Client.get "/xxx", :a => "1", :b => "2"
+  end
+
+  it "encodes parameters" do
+    expected_uri = Addressable::URI.parse("https://api.trello.com/1/xxx?name=Jazz%20Kang")
+    expected_request = Request.new :get, expected_uri, {}
+
+    TInternet.should_receive(:execute).once.with expected_request
+
+    Client.get "/xxx", :name => "Jazz Kang"
+  end
+
+  it "raises an error when response has non-200 status" do
+    expected_error_message = "An error response"
+    response_with_non_200_status = stub "A fake OK response", 
+      :code => 404,
+      :body => expected_error_message
+
+    TInternet.stub(:execute).and_return response_with_non_200_status
+
+    lambda{Client.get "/xxx"}.should raise_error expected_error_message
+  end
+
+  it "uses version 1 of the API" do
+    TInternet.should_receive(:execute).once do |request|
+      request.uri.to_s.should =~ /1\//
+      fake_ok_response
+    end 
+
+    Client.get "/"
+  end 
+
+  it "omits the \"?\" when no parameters" do
+    TInternet.should_receive(:execute).once do |request|
+      request.uri.to_s.should_not =~ /\?$/
+      fake_ok_response
+    end 
+
+    Client.get "/xxx"
+  end
+
+  it "supports post" do
+    TInternet.should_receive(:execute).once.and_return fake_ok_response
+
+    Client.post "/xxx", { :phil => "T' north" }
+  end
+
+  it "supplies the body for a post" do
+    expected_body = { :name => "Phil", :nickname => "The Crack Fox" }
+
+    TInternet.should_receive(:execute).once do |request|
+      request.body.should == expected_body
+      fake_ok_response
+    end
+
+    Client.post "/xxx", expected_body
+  end
+
+  it "supplies the path for a post" do
+    expected_path = "/xxx"
+
+    TInternet.should_receive(:execute).once do |request|
+      request.uri.path.should =~ /#{expected_path}$/
+      fake_ok_response
+    end
+
+    Client.post "/xxx", {}
+  end
+
+  it "supports put" do
+    expected_path = "/xxx"
+
+    TInternet.should_receive(:execute).once.and_return fake_ok_response
+
+    Client.put "/xxx", { :phil => "T' north" }
+  end
+
+  it "supplies the body for a put" do
+    expected_body = { :name => "Phil", :nickname => "The Crack Fox" }
+
+    TInternet.should_receive(:execute).once do |request|
+      request.body.should == expected_body
+      fake_ok_response
+    end
+
+    Client.put "/xxx", expected_body
+  end
+
+  it "supplies the path for a put" do
+    expected_path = "/xxx"
+
+    TInternet.should_receive(:execute).once do |request|
+      request.uri.path.should =~ /#{expected_path}$/
+      fake_ok_response
+    end
+
+    Client.put "/xxx", {}
+  end
+end

data/spec/integration/how_to_authorize_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'integration/integration_test'
+
+describe "Authorizing read-only requests", :broken => true do
+  include IntegrationTest
+
+  it "Reading public resources requires just a developer public key" do
+    uri = Addressable::URI.parse("https://api.trello.com/1/boards/4ed7e27fe6abb2517a21383d")
+    uri.query_values = {
+      :key => @developer_public_key
+    }
+
+    get(uri).code.should === 200
+  end
+
+  it "Reading private resources requires developer public key AND a member token" do
+    uri = Addressable::URI.parse("https://api.trello.com/1/boards/#{@welcome_board}")
+    uri.query_values = {
+      :key => @developer_public_key,
+      :token => @member_token
+    }
+
+    get(uri).code.should === 200
+  end
+
+  it "can fetch the welcome board" do
+    BasicAuthPolicy.developer_public_key = @developer_public_key
+    BasicAuthPolicy.member_token = @member_token
+
+    Container.set Trello::Authorization, "AuthPolicy", BasicAuthPolicy
+
+    welcome_board = Board.find @welcome_board
+    welcome_board.name.should === "Welcome Board"
+    welcome_board.id.should === @welcome_board
+  end
+end
+
+describe "OAuth", :broken => true do
+  include IntegrationTest
+
+  before do
+    Container.set Trello::Authorization, "AuthPolicy", OAuthPolicy
+  end
+
+  it "[!] actually does not enforce signature at all, only the keys are required" do
+    OAuthPolicy.consumer_credential = OAuthCredential.new @developer_public_key, nil
+    OAuthPolicy.token = OAuthCredential.new @access_token_key, nil
+    
+    pending "I would expect this to fail because I have signed with nil secrets" do
+      lambda{Client.get("/boards/#{@welcome_board}/")}.should raise_error
+    end
+  end
+end