ruby-trello 0.1.1 → 0.2.0

data/README.md

@@ -9,10 +9,11 @@ Seriously, [check it out](http://www.trello.com/).
 
 ## Installation
 
-Full disclosure: It doesn't presently work. I'm in the process of implementing
-the specs and the functionality. But if you want to check it out, clone the
-repo for now. I will produce a gem when it's at least minimally usable. When
-that is the case, I'll post that information here.
+```
+# gem install ruby-trello
+```
+
+Full Disclosure: This library is not complete, but it does function enough to be useful.
 
 ## Contributing
 

data/lib/trello.rb

@@ -3,14 +3,17 @@
 # Use and distribution terms may be found in the file LICENSE included in this distribution.
 
 require 'oauth'
-require 'yajl'
+require 'json'
 
 module Trello
+  autoload :Action,       'trello/action'
   autoload :BasicData,    'trello/basic_data'
   autoload :Board,        'trello/board'
   autoload :Card,         'trello/card'
   autoload :Client,       'trello/client'
+  autoload :Item,         'trello/item'
+  autoload :ItemState,    'trello/item_state'
   autoload :List,         'trello/list'
   autoload :Member,       'trello/member'
   autoload :Organization, 'trello/organization'
-end
+end

data/lib/trello/action.rb

@@ -0,0 +1,48 @@
+# Ruby wrapper around the Trello API
+# Copyright (c) 2012, Jeremy Tregunna
+# Use and distribution terms may be found in the file LICENSE included in this distribution.
+
+module Trello
+  class Action < BasicData
+    class << self
+      def find(id)
+        super(:actions, id)
+      end
+    end
+
+    # Fields
+
+    def id
+      fields['id']
+    end
+
+    def type
+      fields['type']
+    end
+
+    def data
+      fields['data']
+    end
+
+    # Links to other data structures
+
+    def board
+      response = Client.query("/1/actions/#{id}/board")
+      Board.new(JSON.parse(response.read_body))
+    end
+
+    def card
+      response = Client.query("/1/actions/#{id}/card")
+      Card.new(JSON.parse(response.read_body))
+    end
+
+    def list
+      response = Client.query("/1/actions/#{id}/list")
+      List.new(JSON.parse(response.read_body))
+    end
+
+    def member_creator
+      Member.find(fields['idMemberCreator'])
+    end
+  end
+end

data/lib/trello/basic_data.rb

@@ -9,7 +9,7 @@ module Trello
     class << self
       def find(path, id)
         response = Client.query("/1/#{path}/#{id}")
-        new(Yajl::Parser.parse(response.read_body))
+        new(JSON.parse(response.read_body))
       end
     end
 

data/lib/trello/board.rb

@@ -7,7 +7,7 @@ module Trello
     class << self
       def find(id)
         response = Client.query("/1/boards/#{id}")
-        new(Yajl::Parser.parse(response.read_body))
+        new(JSON.parse(response.read_body))
       end
     end
 
@@ -35,14 +35,34 @@ module Trello
 
     # Links to other data structures
 
+    def actions
+      response = Client.query("/1/boards/#{id}/actions")
+      JSON.parse(response.read_body).map do |action_fields|
+        Action.new(action_fields)
+      end
+    end
+
     def cards
-      response  = Client.query("/1/boards/#{id}/cards/all")
-      all_cards = Yajl::Parser.parse(response.read_body)
-      all_cards.map do |card_fields|
+      response = Client.query("/1/boards/#{id}/cards/all")
+      JSON.parse(response.read_body).map do |card_fields|
         Card.new(card_fields)
       end
     end
 
+    def lists
+      response = Client.query("/1/boards/#{id}/lists/all")
+      JSON.parse(response.read_body).map do |list_fields|
+        List.new(list_fields)
+      end
+    end
+
+    def members
+      response = Client.query("/1/boards/#{id}/members/all")
+      JSON.parse(response.read_body).map do |member_fields|
+        Member.new(member_fields)
+      end
+    end
+
     def organization
       Organization.find(fields['idOrganization'])
     end

data/lib/trello/card.rb

@@ -34,15 +34,38 @@ module Trello
 
     # Links to other data structures
 
+    def actions
+      response = Client.query("/1/cards/#{id}/actions")
+      JSON.parse(response.read_body).map do |action_fields|
+        Action.new(action_fields)
+      end
+    end
+
     def board
       Board.find(fields['idBoard'])
     end
 
+    def checklists
+      response = Client.query("/1/cards/#{id}/checklists")
+      JSON.parse(response.read_body).map do |checklist_fields|
+        Checklist.new(checklist_fields)
+      end
+    end
+
+    def list
+      List.find(fields['idList'])
+    end
+
     def members
       fields['idMembers'].map do |member_id|
-        response  = Client.query("/1/members/#{member_id}")
-        Member.new(Yajl::Parser.parse(response.read_body))
+        response = Client.query("/1/members/#{member_id}")
+        Member.new(JSON.parse(response.read_body))
       end
     end
+
+    # Add a comment
+    def comment(text)
+      response = Client.query("/1/cards/#{id}/actions/comments", :method => :put, :params => { :text => text })
+    end
   end
 end

data/lib/trello/checklist.rb

@@ -0,0 +1,57 @@
+# Ruby wrapper around the Trello API
+# Copyright (c) 2012, Jeremy Tregunna
+# Use and distribution terms may be found in the file LICENSE included in this distribution.
+
+module Trello
+  class Checklist < BasicData
+    class << self
+      def find(id)
+        super(:checklists, id)
+      end
+    end
+
+    # Fields
+
+    def id
+      fields['id']
+    end
+
+    def name
+      fields['name']
+    end
+
+    def description
+      fields['desc']
+    end
+
+    def closed?
+      fields['closed']
+    end
+
+    def url
+      fields['url']
+    end
+
+    # Links to other data structures
+
+    def items
+      fields['checkItems'].map do |item_fields|
+        Item.new(item_fields)
+      end
+    end
+
+    def board
+      Board.find(fields['idBoard'])
+    end
+
+    def list
+      List.find(fields['idList'])
+    end
+
+    def members
+      fields['idMembers'].map do |member_id|
+        Member.find(member_id)
+      end
+    end
+  end
+end

data/lib/trello/item.rb

@@ -0,0 +1,27 @@
+# Ruby wrapper around the Trello API
+# Copyright (c) 2012, Jeremy Tregunna
+# Use and distribution terms may be found in the file LICENSE included in this distribution.
+
+module Trello
+  class Item < BasicData
+    class << self
+      def find(nothing)
+        raise 'This operation does not make sense'
+      end
+    end
+
+    # Fields
+
+    def id
+      fields['id']
+    end
+
+    def name
+      fields['name']
+    end
+
+    def type
+      fields['type']
+    end
+  end
+end

data/lib/trello/item_state.rb

@@ -0,0 +1,38 @@
+# Ruby wrapper around the Trello API
+# Copyright (c) 2012, Jeremy Tregunna
+# Use and distribution terms may be found in the file LICENSE included in this distribution.
+
+module Trello
+  class ItemState < BasicData
+    class << self
+      def find(nothing)
+        raise 'This operation does not make sense'
+      end
+    end
+
+    # Fields
+
+    def id
+      fields['id']
+    end
+
+    def state
+      fields['state']
+    end
+
+    # Until #item is implemented, this will do
+    def item_id
+      fields['idItem']
+    end
+
+    # Links to other data structures
+
+    def item
+      # Nothing here for now. I will implement it myself later, but Trello really
+      # needs an API to query check items in my estimation. Otherwise, the "idCheckItem"
+      # key serves no good purpose. I'd have to know what checklist this state belongs
+      # to, and then query all of its items, comparing the ID as I go. O(n) at the best
+      # of times. If I don't have the checklist, then we're O(m*n^2). Horrible.
+    end
+  end
+end

data/lib/trello/list.rb

@@ -26,6 +26,13 @@ module Trello
 
     # Links to other data structures
 
+    def actions
+      response = Client.query("/1/lists/#{id}/actions")
+      JSON.parse(response.read_body).map do |action_fields|
+        Action.new(action_fields)
+      end
+    end
+
     def board
       Board.find(fields['idBoard'])
     end

data/lib/trello/member.rb

@@ -42,18 +42,30 @@ module Trello
 
     # Links to other data structures
 
+    def actions
+      response = Client.query("/1/members/#{username}/actions")
+      JSON.parse(response.read_body).map do |action_fields|
+        Action.new(action_fields)
+      end
+    end
+
     def boards
-      response   = Client.query("/1/members/#{username}/boards/all")
-      all_boards = Yajl::Parser.parse(response.read_body)
-      all_boards.map do |board_fields|
+      response = Client.query("/1/members/#{username}/boards/all")
+      JSON.parse(response.read_body).map do |board_fields|
         Board.new(board_fields)
       end
     end
 
+    def cards
+      response = Client.query("/1/members/#{username}/cards/all")
+      JSON.parse(response.read_body).map do |card_fields|
+        Card.new(card_fields)
+      end
+    end
+
     def organizations
       response = Client.query("/1/members/#{username}/organizations/all")
-      all_orgs = Yajl::Parser.parse(response.read_body)
-      all_orgs.map do |org_fields|
+      JSON.parse(response.read_body).map do |org_fields|
         Organization.new(org_fields)
       end
     end

data/lib/trello/organization.rb

@@ -35,5 +35,28 @@ module Trello
     def url
       @fields['url']
     end
+
+    # Links to other data structures
+
+    def actions
+      response = Client.query("/1/organizations/#{id}/actions")
+      JSON.parse(response.read_body).map do |action_fields|
+        Action.new(action_fields)
+      end
+    end
+
+    def boards
+      response = Client.query("/1/organizations/#{id}/boards/all")
+      JSON.parse(response.read_body).map do |board_fields|
+        Board.new(board_fields)
+      end
+    end
+
+    def members
+      response = Client.query("/1/organizations/#{id}/members/all")
+      JSON.parse(response.read_body).map do |member_fields|
+        Member.new(member_fields)
+      end
+    end
   end
 end

data/spec/action_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module Trello
+  describe Action do
+    include Helpers
+
+    before(:all) do
+      Client.public_key = 'dummy'
+      Client.secret     = 'dummy'
+    end
+
+    before(:each) do
+      stub_request(:get, "https://api.trello.com/1/actions/abcdef123456789123456789?").
+        with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
+        to_return(:status => 200, :headers => {}, :body => JSON.generate(actions_details.first))
+
+      @action = Action.find('abcdef123456789123456789')
+    end
+
+    context "fields" do
+      before(:all) do
+        @detail = actions_details.first
+      end
+
+      it "gets its id" do
+        @action.id.should == @detail['id']
+      end
+
+      it "gets its type" do
+        @action.type.should == @detail['type']
+      end
+
+      it "has the same data" do
+        @action.data.should == @detail['data']
+      end
+    end
+  end
+end

data/spec/board_spec.rb

@@ -12,7 +12,7 @@ module Trello
     before(:each) do
       stub_request(:get, "https://api.trello.com/1/boards/abcdef123456789123456789?").
         with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
-        to_return(:status => 200, :headers => {}, :body => Yajl::Encoder.encode(boards_details.first))
+        to_return(:status => 200, :headers => {}, :body => JSON.generate(boards_details.first))
 
       @board = Board.find('abcdef123456789123456789')
     end

data/spec/card_spec.rb

@@ -12,7 +12,7 @@ module Trello
     before(:each) do
       stub_request(:get, "https://api.trello.com/1/cards/abcdef123456789123456789?").
         with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
-        to_return(:status => 200, :headers => {}, :body => Yajl::Encoder.encode(cards_details.first))
+        to_return(:status => 200, :headers => {}, :body => JSON.generate(cards_details.first))
 
       @card = Card.find('abcdef123456789123456789')
     end
@@ -43,7 +43,7 @@ module Trello
       it "has a board" do
         stub_request(:get, "https://api.trello.com/1/boards/abcdef123456789123456789?").
           with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
-          to_return(:status => 200, :headers => {}, :body => Yajl::Encoder.encode(boards_details.first))
+          to_return(:status => 200, :headers => {}, :body => JSON.generate(boards_details.first))
 
         @card.board.should_not be_nil
       end
@@ -53,7 +53,7 @@ module Trello
       it "has a list of members" do
         stub_request(:get, "https://api.trello.com/1/boards/abcdef123456789123456789?").
           with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
-          to_return(:status => 200, :headers => {}, :body => Yajl::Encoder.encode(boards_details.first))
+          to_return(:status => 200, :headers => {}, :body => JSON.generate(boards_details.first))
         stub_request(:get, "https://api.trello.com/1/members/abcdef123456789123456789?").
           with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
           to_return(:status => 200, :headers => {}, :body => user_payload)

data/spec/item_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module Trello
+  describe Item do
+    before(:all) do
+      @detail = {
+        'id'   => "abcdef123456789123456789",
+        'name' => "test item",
+        'type' => "check"
+      }
+
+      @item = Item.new(@detail)
+    end
+
+    it "gets its id" do
+      @item.id.should == @detail['id']
+    end
+
+    it "gets its name" do
+      @item.name.should == @detail['name']
+    end
+
+    it "knows its type" do
+      @item.type.should == @detail['type']
+    end
+  end
+end

data/spec/list_spec.rb

@@ -12,10 +12,10 @@ module Trello
     before(:each) do
       stub_request(:get, "https://api.trello.com/1/lists/abcdef123456789123456789?").
         with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
-        to_return(:status => 200, :headers => {}, :body => Yajl::Encoder.encode(lists_details.first))
+        to_return(:status => 200, :headers => {}, :body => JSON.generate(lists_details.first))
       stub_request(:get, "https://api.trello.com/1/boards/abcdef123456789123456789?").
         with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
-        to_return(:status => 200, :headers => {}, :body => Yajl::Encoder.encode(boards_details.first))
+        to_return(:status => 200, :headers => {}, :body => JSON.generate(boards_details.first))
 
         @list = List.find("abcdef123456789123456789")
     end

data/spec/member_spec.rb

@@ -20,8 +20,13 @@ module Trello
     end
 
     context "actions" do
-      # This spec needs a better name
-      it "retrieves a list of actions"
+      it "retrieves a list of actions" do
+        stub_request(:get, "https://api.trello.com/1/members/me/actions?").
+          with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
+          to_return(:status => 200, :headers => {}, :body => actions_payload)
+
+        @member.actions.count.should be > 0
+      end
     end
 
     context "boards" do

data/spec/spec_helper.rb

@@ -29,7 +29,7 @@ module Helpers
   end
 
   def user_payload
-    Yajl::Encoder.encode(user_details)
+    JSON.generate(user_details)
   end
 
   def boards_details
@@ -44,7 +44,7 @@ module Helpers
   end
 
   def boards_payload
-    Yajl::Encoder.encode(boards_details)
+    JSON.generate(boards_details)
   end
 
   def lists_details
@@ -58,7 +58,7 @@ module Helpers
   end
 
   def lists_payload
-    Yajl::Encoder.encode(lists_details)
+    JSON.generate(lists_details)
   end
 
   def cards_details
@@ -75,7 +75,7 @@ module Helpers
   end
 
   def cards_payload
-    Yajl::Encoder.encode(cards_details)
+    JSON.generate(cards_details)
   end
 
   def orgs_details
@@ -89,6 +89,32 @@ module Helpers
   end
 
   def orgs_payload
-    Yajl::Encoder.encode(orgs_details)
+    JSON.generate(orgs_details)
+  end
+
+  def actions_details
+    [{
+      "id"              => "4ee2482134a81a757a08af47",
+      "idMemberCreator" => "4ec33ef93a7537000010676d",
+      "data"=> {
+        "card"          => {
+          "id"          => "4ee2482134a81a757a08af45",
+          "name"        => "Bytecode outputter"
+        },
+        "board"         => {
+          "id"          => "4ec54f2f73820a0dea0d1f0e",
+          "name"        => "Caribou VM"
+        },
+        "list"          => {
+          "id"          => "4ee238b034a81a757a05cda0",
+          "name"        => "Assembler"
+        }
+      },
+      "type"            => "createCard"
+    }]
+  end
+
+  def actions_payload
+    JSON.generate(actions_details)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-trello
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-07 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70325350827020 !ruby/object:Gem::Requirement
+  requirement: &70240457388560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70325350827020
+  version_requirements: *70240457388560
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70325350826560 !ruby/object:Gem::Requirement
+  requirement: &70240457399940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.4.5
   type: :runtime
   prerelease: false
-  version_requirements: *70325350826560
+  version_requirements: *70240457399940
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &70325350826100 !ruby/object:Gem::Requirement
+  requirement: &70240457481800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.2.6
   type: :runtime
   prerelease: false
-  version_requirements: *70325350826100
+  version_requirements: *70240457481800
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70325350825640 !ruby/object:Gem::Requirement
+  requirement: &70240457630780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70325350825640
+  version_requirements: *70240457630780
 description: A wrapper around the trello.com API.
 email: jeremy@tregunna.ca
 executables: []
@@ -62,18 +62,26 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- lib/trello/action.rb
 - lib/trello/basic_data.rb
 - lib/trello/board.rb
 - lib/trello/card.rb
+- lib/trello/checklist.rb
 - lib/trello/client.rb
+- lib/trello/item.rb
+- lib/trello/item_state.rb
 - lib/trello/list.rb
 - lib/trello/member.rb
 - lib/trello/organization.rb
 - lib/trello.rb
 - README.md
+- spec/action_spec.rb
 - spec/board_spec.rb
 - spec/card_spec.rb
+- spec/checklist_spec.rb
 - spec/client_spec.rb
+- spec/item_spec.rb
+- spec/item_state_spec.rb
 - spec/list_spec.rb
 - spec/member_spec.rb
 - spec/organization_spec.rb
@@ -104,9 +112,13 @@ signing_key:
 specification_version: 3
 summary: A wrapper around the trello.com API.
 test_files:
+- spec/action_spec.rb
 - spec/board_spec.rb
 - spec/card_spec.rb
+- spec/checklist_spec.rb
 - spec/client_spec.rb
+- spec/item_spec.rb
+- spec/item_state_spec.rb
 - spec/list_spec.rb
 - spec/member_spec.rb
 - spec/organization_spec.rb