ruby-trello 0.2.1 → 0.3.0

data/spec/client_spec.rb

@@ -1,30 +1,131 @@
-require 'spec_helper'
+require "spec_helper"
 
-module Trello
-  describe Client do
-    before(:all) do
-      Client.public_key = 'dummy'
-      Client.secret     = 'dummy'
+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
 
-    context 'keys' do
-      after do
-        Client.public_key = 'dummy'
-      end
+    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 => 201,
+      :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 
 
-      it 'throws an error if the public key is ommitted' do
-        Client.public_key = ''
-        lambda { Client.send(:consumer) }.should raise_error(Client::EnterYourPublicKey)
-      end
+    Client.get "/"
+  end 
 
-      after do
-        Client.secret = 'dummy'
-      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 'throws an error if the secret is ommitted' do
-        Client.secret = ''
-        lambda { Client.send(:consumer) }.should raise_error(Client::EnterYourSecret)
-      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
+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

data/spec/integration/how_to_use_boards_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'integration/integration_test'
+
+describe "how to use boards", :broken => true do
+  include IntegrationTest
+
+  context "given a valid access token" do
+    before :all do
+      OAuthPolicy.consumer_credential = OAuthCredential.new @developer_public_key, @developer_secret
+      OAuthPolicy.token = OAuthCredential.new @access_token_key, @access_token_secret
+      Container.set Trello::Authorization, "AuthPolicy", OAuthPolicy
+    end
+
+    after do
+      if @new_board and false == @new_board.closed? 
+        @new_board.update_fields 'closed' => true
+        @new_board.save!
+      end
+    end
+
+    it "can add a board" do
+      @new_board = Board.create(:name => "An example")
+      @new_board.should_not be_nil
+      @new_board.id.should_not be_nil
+      @new_board.name.should == "An example"
+      @new_board.should_not be_closed
+    end
+
+    it "can read the welcome board" do
+      welcome_board = Board.find @welcome_board
+      welcome_board.name.should === "Welcome Board"
+      welcome_board.id.should === @welcome_board
+    end
+
+    it "can close a board" do
+      @new_board = Board.create(:name => "[#{Time.now}, CLOSED] An example")
+
+      @new_board.update_fields 'closed' => true
+      @new_board.save!
+      
+      Board.find(@new_board.id).should be_closed
+    end
+
+    it "can list all boards" do
+      Client.get("/members/me/boards/").json_into(Board).should be_an Array
+    end
+  end
+end

data/spec/integration/integration_test.rb

@@ -0,0 +1,40 @@
+module IntegrationTest
+  include Trello
+  include Trello::Authorization
+
+  class Container
+    class << self
+      def set(parent, name, value)
+        parent.send :remove_const, name
+        parent.const_set name, value
+      end
+    end
+  end
+
+  def self.included(klass)
+    klass.class_eval do
+      before :all do
+        # Getting developer/member key
+        # 1. https://trello.com/1/appKey/generate
+        # 2. https://trello.com/1/connect?key=<public_key_here>&name=RubyTrelloIntegrationTests&response_type=token
+        # See: https://trello.com/board/trello-public-api/4ed7e27fe6abb2517a21383d
+
+        @developer_public_key = ENV["DEVELOPER_PUBLIC_KEY"]
+        @developer_secret     = ENV["DEVELOPER_SECRET"]
+        @member_token         = ENV["MEMBER_TOKEN"]
+        @welcome_board        = ENV["WELCOME_BOARD"]
+        @access_token_key     = ENV["ACCESS_TOKEN_KEY"]
+        @access_token_secret  = ENV["ACCESS_TOKEN_SECRET"]
+        
+        WebMock.disable!
+      end    
+    end
+  end
+
+  protected
+
+  def get(uri)
+    require "rest_client"
+    RestClient.get uri.to_s
+  end
+end

data/spec/list_spec.rb

@@ -4,14 +4,9 @@ module Trello
   describe List do
     include Helpers
 
-    before(:all) do
-      Client.public_key = 'dummy'
-      Client.secret     = 'dummy'
-    end
-
     before(:each) do
-      stub_trello_request!(:get, "/lists/abcdef123456789123456789?", nil, JSON.generate(lists_details.first))
-      stub_trello_request!(:get, "/boards/abcdef123456789123456789?", nil, JSON.generate(boards_details.first))
+      Client.stub(:get).with("/lists/abcdef123456789123456789").and_return JSON.generate(lists_details.first)
+      Client.stub(:get).with("/boards/abcdef123456789123456789").and_return JSON.generate(boards_details.first)
 
       @list = List.find("abcdef123456789123456789")
     end
@@ -34,11 +29,22 @@ module Trello
       end
     end
 
+    context "actions" do
+      it "has a list of actions" do
+        Client.stub(:get).with("/lists/abcdef123456789123456789/actions").and_return actions_payload
+        @list.actions.count.should be > 0
+      end
+    end
+
     context "cards" do
       it "has a list of cards" do
-        stub_trello_request!(:get, "/lists/abcdef123456789123456789/cards?", { :filter => :open }, cards_payload)
+        Client.stub(:get).with("/lists/abcdef123456789123456789/cards", { :filter => :open }).and_return cards_payload
         @list.cards.count.should be > 0
       end
     end
+
+    it "is not closed" do
+      @list.closed?.should_not be_true
+    end
   end
-end
+end

data/spec/member_spec.rb

@@ -6,35 +6,38 @@ module Trello
   describe Member do
     include Helpers
 
-    before(:all) do
-      Client.public_key = 'dummy'
-      Client.secret     = 'dummy'
-    end
-
     before(:each) do
-      stub_trello_request!(:get, '/members/me?', nil, user_payload)
+      Client.stub(:get).with("/members/me").and_return user_payload
 
       @member = Member.find('me')
     end
 
     context "actions" do
-      it "retrieves a list of actions" do
-        stub_trello_request!(:get, '/members/me/actions?', nil, actions_payload)
+      it "retrieves a list of actions", :refactor => true do
+        Client.stub(:get).with("/members/me/actions").and_return actions_payload
         @member.actions.count.should be > 0
       end
     end
 
     context "boards" do
       it "has a list of boards" do
-        stub_trello_request!(:get, '/members/me/boards?', { :filter => :all }, boards_payload)
+        Client.stub(:get).with("/members/me/boards", { :filter => :all }).and_return boards_payload
         boards = @member.boards
         boards.count.should be > 0
       end
     end
 
+    context "cards" do
+      it "has a list of cards" do
+        Client.stub(:get).with("/members/me/cards", { :filter => :open }).and_return cards_payload
+        cards = @member.cards
+        cards.count.should be > 0
+      end
+    end
+
     context "organizations" do
       it "has a list of organizations" do
-        stub_trello_request!(:get, '/members/me/organizations?', { :filter => :all }, orgs_payload)
+        Client.stub(:get).with("/members/me/organizations", { :filter => :all }).and_return orgs_payload
         orgs = @member.organizations
         orgs.count.should be > 0
       end
@@ -62,4 +65,4 @@ module Trello
       end
     end
   end
-end
+end

data/spec/oauth_policy_spec.rb

@@ -0,0 +1,83 @@
+require "spec_helper"
+
+include Trello::Authorization
+include Trello
+
+describe OAuthPolicy do
+  before do
+    OAuthPolicy.consumer_credential = OAuthCredential.new "xxx", "xxx"
+    OAuthPolicy.token = nil
+  end
+
+  it "adds an authorization header" do 
+    uri = Addressable::URI.parse("https://xxx/")
+
+    request = Request.new :get, uri
+
+    authorized_request = OAuthPolicy.authorize request
+    
+    authorized_request.headers.keys.should include "Authorization"
+  end
+  
+  it "preserves query parameters" do
+    uri = Addressable::URI.parse("https://xxx/?name=Riccardo")
+    request = Request.new :get, uri
+
+    authorized_request = OAuthPolicy.authorize request
+    
+    the_query_parameters = Addressable::URI.parse(authorized_request.uri).query_values
+    the_query_parameters.should == {"name" => "Riccardo"}
+  end
+
+  it "adds the correct signature as part of authorization header" do 
+    Clock.stub(:timestamp).and_return "1327048592"
+    Nonce.stub(:next).and_return "b94ff2bf7f0a5e87a326064ae1dbb18f"
+
+    OAuthPolicy.consumer_credential = OAuthCredential.new "consumer_key", "consumer_secret"
+
+    request = Request.new :get, Addressable::URI.parse("http://xxx/")
+
+    authorized_request = OAuthPolicy.authorize request
+    
+    authorized_request.headers["Authorization"].should =~ /oauth_signature="u7CmId4WEDUqPdHnWVf1JVChFmg%3D"/
+  end
+
+  it "adds correct signature for uri with parameters" do
+    Clock.stub(:timestamp).and_return "1327351010"
+    Nonce.stub(:next).and_return "f5474aaf44ca84df0b09870044f91c69"
+
+    OAuthPolicy.consumer_credential = OAuthCredential.new "consumer_key", "consumer_secret"
+
+    request = Request.new :get, Addressable::URI.parse("http://xxx/?a=b")
+
+    authorized_request = OAuthPolicy.authorize request
+    
+    authorized_request.headers["Authorization"].should =~ /oauth_signature="ABL%2FcOSGJSbvvLt1gW2nV9i%2FDyA%3D"/
+  end
+
+  it "fails if consumer_credential is unset" do
+    OAuthPolicy.consumer_credential = nil
+
+    request = Request.new :get, Addressable::URI.parse("http://xxx/")
+
+    lambda{OAuthPolicy.authorize request}.should raise_error "The consumer_credential has not been supplied."
+  end
+
+  it "can sign with token" do
+    Clock.stub(:timestamp).and_return "1327360530"
+    Nonce.stub(:next).and_return "4f610cb28e7aa8711558de5234af1f0e"
+
+    OAuthPolicy.consumer_credential = OAuthCredential.new "consumer_key", "consumer_secret"
+    OAuthPolicy.token  = OAuthCredential.new "token_key", "token_secret"
+
+    request = Request.new :get, Addressable::URI.parse("http://xxx/")
+
+    authorized_request = OAuthPolicy.authorize request
+
+    authorized_request.headers["Authorization"].should =~ /oauth_signature="1Boj4fo6KiXA4xGD%2BKF5QOD36PI%3D"/
+  end
+
+  it "adds correct signature for https uri"
+  it "adds correct signature for verbs other than get"
+  it "can sign with access token too"
+end