ruby-trello 0.2.0 → 0.2.1

data/lib/trello.rb

@@ -1,10 +1,28 @@
-# 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.
-
 require 'oauth'
 require 'json'
 
+# Ruby wrapper around the Trello[http://trello.com] API
+#
+# First, set up your key information. You can get this information by {clicking here}[https://trello.com/1/appKey/generate].
+#
+#   Trello.public_key = 'xxxxxxxxxxxxxxxxx'
+#   Trello.secret     = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+#
+# All the calls this library make to Trello require authentication using these keys. Be sure to protect them.
+#
+# So lets say you want to get information about the user *bobtester*. We can do something like this:
+#
+#   bob = Member.find("bobtester")
+#   # Print out his name
+#   puts bob.full_name # "Bob Tester"
+#   # Print his bio
+#   puts bob.bio # A wonderfully delightful test user
+#   # How about a list of his boards?
+#   bob.boards
+#
+# And so much more. Consult the rest of the documentation for more information.
+#
+# Feel free to {peruse and participate in our Trello board}[https://trello.com/board/ruby-trello/4f092b2ee23cb6fe6d1aaabd]. It's completely open to the public.
 module Trello
   autoload :Action,       'trello/action'
   autoload :BasicData,    'trello/basic_data'
@@ -15,5 +33,12 @@ module Trello
   autoload :ItemState,    'trello/item_state'
   autoload :List,         'trello/list'
   autoload :Member,       'trello/member'
+  autoload :Notification, 'trello/notification'
   autoload :Organization, 'trello/organization'
-end
+
+  # Version of the Trello API that we use by default.
+  API_VERSION = 1
+
+  # Raise this when we can't find a record.
+  class RecordNotFound < StandardError; end
+end

data/lib/trello/action.rb

@@ -1,48 +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
+  # Action represents some event that occurred. For instance, when a card is created.
   class Action < BasicData
+    attr_reader :id, :type, :data, :member_creator_id
+
     class << self
+      # Locate a specific action and return a new Action object.
       def find(id)
         super(:actions, id)
       end
     end
 
-    # Fields
-
-    def id
-      fields['id']
-    end
-
-    def type
-      fields['type']
-    end
-
-    def data
-      fields['data']
+    # Update the attributes of an action
+    #
+    # Supply a hash of string keyed data retrieved from the Trello API representing
+    # an Action.
+    def update_fields(fields)
+      @id                = fields['id']
+      @type              = fields['type']
+      @data              = fields['data']
+      @member_creator_id = fields['idMemberCreator']
     end
 
-    # Links to other data structures
-
+    # Returns the board this action occurred on.
     def board
-      response = Client.query("/1/actions/#{id}/board")
-      Board.new(JSON.parse(response.read_body))
+      return @board if @board
+      @board = Client.get("/actions/#{id}/board").json_into(Board)
     end
 
+    # Returns the card the action occurred on.
     def card
-      response = Client.query("/1/actions/#{id}/card")
-      Card.new(JSON.parse(response.read_body))
+      return @card if @card
+      @card = Client.get("/actions/#{id}/card").json_into(Card)
     end
 
+    # Returns the list the action occurred on.
     def list
-      response = Client.query("/1/actions/#{id}/list")
-      List.new(JSON.parse(response.read_body))
+      return @list if @list
+      @list = Client.get("/actions/#{id}/list").json_into(List)
     end
 
+    # Returns the member who created the action.
     def member_creator
-      Member.find(fields['idMemberCreator'])
+      return @member_creator if @member_creator
+      @member_creator = Member.find(member_creator_id)
     end
   end
-end
+end

data/lib/trello/basic_data.rb

@@ -1,25 +1,32 @@
-# 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.
+require 'trello/string'
 
 module Trello
   class BasicData
-    attr_reader :fields
+    attr_reader :id
 
     class << self
+      # Perform a query to retrieve some information at a specific path for a specific id.
       def find(path, id)
-        response = Client.query("/1/#{path}/#{id}")
-        new(JSON.parse(response.read_body))
+        Client.get("/#{path}/#{id}").json_into(self)
       end
     end
 
-    # Fields
     def initialize(fields = {})
-      @fields = fields
+      update_fields(fields)
     end
 
+    def update_fields(fields)
+      raise NotImplementedError, "#{self.class} does not implement update_fields."
+    end
+
+    # Refresh the contents of our object.
+    def refresh!
+      self.class.find(id)
+    end
+
+    # Two objects are equal if their _id_ methods are equal.
     def ==(other)
-      @fields == other.fields
+      id == other.id
     end
   end
 end

data/lib/trello/board.rb

@@ -1,70 +1,73 @@
-# 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
+  # A board is a container which holds lists. This is where everything lives.
   class Board < BasicData
+    attr_reader :id, :name, :description, :closed, :url, :organization_id
+
     class << self
+      # Locate a board given a specific id.
       def find(id)
-        response = Client.query("/1/boards/#{id}")
-        new(JSON.parse(response.read_body))
+        super(:boards, id)
       end
     end
 
-    # Fields
-
-    def id
-      fields['id']
-    end
-
-    def name
-      fields['name']
-    end
-
-    def description
-      fields['desc']
+    # Update the fields of a board.
+    #
+    # Supply a hash of string keyed data retrieved from the Trello API representing
+    # a board.
+    def update_fields(fields)
+      @id              = fields['id']
+      @name            = fields['name']
+      @description     = fields['desc']
+      @closed          = fields['closed']
+      @url             = fields['url']
+      @organization_id = fields['idOrganization']
     end
 
-    def closed
-      fields['closed']
+    # Check if the board is active.
+    def closed?
+      closed
     end
 
-    def url
-      fields['url']
-    end
-
-    # Links to other data structures
-
+    # Return a timeline of actions related to this board.
     def actions
-      response = Client.query("/1/boards/#{id}/actions")
-      JSON.parse(response.read_body).map do |action_fields|
-        Action.new(action_fields)
-      end
+      return @actions if @actions
+      @actions = Client.get("/boards/#{id}/actions").json_into(Action)
     end
 
-    def cards
-      response = Client.query("/1/boards/#{id}/cards/all")
-      JSON.parse(response.read_body).map do |card_fields|
-        Card.new(card_fields)
-      end
+    # Return all the cards on this board.
+    #
+    # The options hash may have a filter key which can have its value set as any
+    # of the following values:
+    #    :filter => [ :none, :open, :closed, :all ] # default :open
+    def cards(options = { :filter => :open })
+      return @cards if @cards
+      @cards = Client.get("/boards/#{id}/cards").json_into(Card)
     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
+    # Returns all the lists on this board.
+    #
+    # The options hash may have a filter key which can have its value set as any
+    # of the following values:
+    #    :filter => [ :none, :open, :closed, :all ] # default :open
+    def lists(options = { :filter => :open })
+      return @lists if @lists
+      @lists = Client.get("/boards/#{id}/lists", options).json_into(List)
     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
+    # Returns an array of members who are associated with this board.
+    #
+    # The options hash may have a filter key which can have its value set as any
+    # of the following values:
+    #    :filter => [ :none, :normal, :owners, :all ] # default :all
+    def members(options = { :filter => :all })
+      return @members if @members
+      @members = Client.get("/boards/#{id}/members").json_into(Member)
     end
 
+    # Returns a reference to the organization this board belongs to.
     def organization
-      Organization.find(fields['idOrganization'])
+      return @organization if @organization
+      @organization = Organization.find(organization_id)
     end
   end
-end
+end

data/lib/trello/card.rb

@@ -1,71 +1,99 @@
-# 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
+  # A Card is a container that can house checklists and comments; it resides inside a List.
   class Card < BasicData
+    attr_reader   :id
+    attr_accessor :name, :description, :closed, :url, :board_id, :member_ids, :list_id
+
     class << self
+      # Find a specific card by its id.
       def find(id)
         super(:cards, id)
       end
-    end
 
-    # Fields
-
-    def id
-      fields['id']
+      # Create a new card and save it on Trello.
+      def create(options)
+        new('name'   => options[:name],
+            'idList' => options[:list_id],
+            'desc' => options[:description]).save!
+      end
     end
 
-    def name
-      fields['name']
+    # Update the fields of a card.
+    #
+    # Supply a hash of string keyed data retrieved from the Trello API representing
+    # a card.
+    def update_fields(fields)
+      @id          = fields['id']
+      @name        = fields['name']
+      @description = fields['desc']
+      @closed      = fields['closed']
+      @url         = fields['url']
+      @board_id    = fields['idBoard']
+      @member_ids  = fields['idMembers']
+      @list_id     = fields['idList']
     end
 
-    def description
-      fields['desc']
+    # Returns a list of the actions associated with this card.
+    def actions
+      return @actions if @actions
+      @actions = Client.get("/cards/#{id}/actions").json_into(Action)
     end
 
-    def closed
-      fields['closed']
+    # Returns a reference to the board this card is part of.
+    def board
+      return @board if @board
+      @board = Board.find(board_id)
     end
 
-    def url
-      fields['url']
+    # Returns a list of checklists associated with the card.
+    #
+    # The options hash may have a filter key which can have its value set as any
+    # of the following values:
+    #    :filter => [ :none, :all ] # default :all
+    def checklists(options = { :filter => :all })
+      return @checklists if @checklists
+      @checklists = Client.get("/cards/#{id}/checklists", options).json_into(Checklist)
     end
 
-    # Links to other data structures
+    # Returns a reference to the list this card is currently in.
+    def list
+      return @list if @list
+      @list = List.find(list_id)
+    end
 
-    def actions
-      response = Client.query("/1/cards/#{id}/actions")
-      JSON.parse(response.read_body).map do |action_fields|
-        Action.new(action_fields)
+    # Returns a list of members who are assigned to this card.
+    def members
+      return @members if @members
+      @members = member_ids.map do |member_id|
+        Client.get("/members/#{member_id}").json_into(Member)
       end
     end
 
-    def board
-      Board.find(fields['idBoard'])
-    end
+    # Saves a record.
+    def save!
+      return update! if id
 
-    def checklists
-      response = Client.query("/1/cards/#{id}/checklists")
-      JSON.parse(response.read_body).map do |checklist_fields|
-        Checklist.new(checklist_fields)
-      end
+      Client.post("/cards", {
+        :name   => @name,
+        :desc   => @description,
+        :idList => @list_id
+      })
     end
 
-    def list
-      List.find(fields['idList'])
+    # Update an existing record.
+    def update!
+      # Trello doesn't support this yet. But Daniel is working on it as I
+      # place this comment here!
     end
 
-    def members
-      fields['idMembers'].map do |member_id|
-        response = Client.query("/1/members/#{member_id}")
-        Member.new(JSON.parse(response.read_body))
-      end
+    # Is the record valid?
+    def valid?
+      @name && @list_id
     end
 
-    # Add a comment
-    def comment(text)
-      response = Client.query("/1/cards/#{id}/actions/comments", :method => :put, :params => { :text => text })
+    # Add a comment with the supplied text.
+    def add_comment(text)
+      Client.put("/cards/#{id}/actions/comments", :text => text)
     end
   end
-end
+end

data/lib/trello/checklist.rb

@@ -1,57 +1,63 @@
-# 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
+  # A Checklist holds items which are like a "todo" list. Checklists are linked to a card.
   class Checklist < BasicData
+    attr_reader :id, :name, :description, :closed, :url, :check_items, :board_id, :list_id, :member_ids
+
     class << self
+      # Locate a specific checklist by its id.
       def find(id)
         super(:checklists, id)
       end
     end
 
-    # Fields
-
-    def id
-      fields['id']
-    end
-
-    def name
-      fields['name']
-    end
-
-    def description
-      fields['desc']
+    # Update the fields of a checklist.
+    #
+    # Supply a hash of string keyed data retrieved from the Trello API representing
+    # a checklist.
+    def update_fields(fields)
+      @id          = fields['id']
+      @name        = fields['name']
+      @description = fields['desc']
+      @closed      = fields['closed']
+      @url         = fields['url']
+      @check_items = fields['checkItems']
+      @board_id    = fields['idBoard']
+      @member_ids  = fields['idMembers']
     end
 
+    # Check if the checklist is currently active.
     def closed?
-      fields['closed']
-    end
-
-    def url
-      fields['url']
+      closed
     end
 
-    # Links to other data structures
-
+    # Return a list of items on the checklist.
     def items
-      fields['checkItems'].map do |item_fields|
+     return @items if @items
+
+      @items = check_items.map do |item_fields|
         Item.new(item_fields)
       end
     end
 
+    # Return a reference to the board the checklist is on.
     def board
-      Board.find(fields['idBoard'])
+      return @board if @board
+      @board = Board.find(board_id)
     end
 
+    # Return a reference to the list the checklist is on.
     def list
-      List.find(fields['idList'])
+      return @list if @list
+      @list = List.find(list_id)
     end
 
+    # Return a list of members active in this checklist.
     def members
-      fields['idMembers'].map do |member_id|
+      return @members if @members
+
+      @members = member_ids.map do |member_id|
         Member.find(member_id)
       end
     end
   end
-end
+end

data/lib/trello/client.rb

@@ -1,22 +1,47 @@
-# 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.
-
 require 'addressable/uri'
 
 module Trello
+  # Client is used to handle the OAuth connection to Trello as well as send requests over that authenticated socket.
   class Client
     class EnterYourPublicKey < StandardError; end
     class EnterYourSecret < StandardError; end
 
     class << self
-      attr_writer :public_key, :secret, :app_name
+      attr_writer :public_key, :secret
 
-      def query(path, options = { :method => :get, :params => {} })
-        uri = Addressable::URI.parse("https://api.trello.com#{path}")
+      # call-seq:
+      #   get(path, params)
+      #   post(path, params)
+      #   put(path, params)
+      #   delete(path, params)
+      #   query(api_version, path, options)
+      #
+      # Makes a query to a specific path via one of the four HTTP methods, optionally
+      # with a hash specifying parameters to pass to Trello.
+      #
+      # You should use one of _.get_, _.post_, _.put_ or _.delete_ instead of this method.
+      def query(api_version, path, options = { :method => :get, :params => {} })
+        uri = Addressable::URI.parse("https://api.trello.com/#{api_version}#{path}")
         uri.query_values = options[:params]
 
         access_token.send(options[:method], uri.to_s)
+      rescue OAuth::Problem => e
+        headers = []
+        e.request.each_header do |k,v|
+          headers << [k, v]
+        end
+
+        logger.error("[#{@access_token}] Disposing of access token.\n#{e.inspect}")
+        logger.info("[#{@access_token}] Headers: #{headers.inspect}\nRequest Body: #{e.request.body}")
+        @access_token = nil
+      end
+
+      %w{get post put delete}.each do |http_method|
+        send(:define_method, http_method) do |*args|
+          path = args[0]
+          params = args[1] || {}
+          query(API_VERSION, path, :method => http_method, :params => params).read_body
+        end
       end
 
       protected
@@ -39,4 +64,4 @@ module Trello
       end
     end
   end
-end
+end

data/lib/trello/item.rb

@@ -1,27 +1,16 @@
-# 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
+  # An Item is a basic task that can be checked off and marked as completed.
   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
+    attr_reader :id, :name, :type
 
-    def type
-      fields['type']
+    # Updates the fields of an item.
+    #
+    # Supply a hash of string keyed data retrieved from the Trello API representing
+    # an item.
+    def update_fields(fields)
+      @id   = fields['id']
+      @name = fields['name']
+      @type = fields['type']
     end
   end
 end

data/lib/trello/item_state.rb

@@ -1,38 +1,21 @@
-# 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
+  # Represents the state of an item.
   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
+    attr_reader :id, :state, :item_id
 
-    # Until #item is implemented, this will do
-    def item_id
-      fields['idItem']
+    # Update the fields of an item state.
+    #
+    # Supply a hash of string keyed data retrieved from the Trello API representing
+    # an item state.
+    def update_fields(fields)
+      @id      = fields['id']
+      @state   = fields['state']
+      @item_id = fields['idItem']
     end
 
-    # Links to other data structures
-
+    # Return the item this state belongs to.
     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.
+      Item.find(@item_id)
     end
   end
 end

data/lib/trello/list.rb

@@ -1,46 +1,51 @@
-# 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
+  # A List is a container which holds cards. Lists are items on a board.
   class List < BasicData
+    attr_reader :id, :name, :closed, :board_id
+
     class << self
+      # Finds a specific list, given an id.
       def find(id)
         super(:lists, id)
       end
     end
 
-    # Fields
-
-    def id
-      fields['id']
-    end
-
-    def name
-      fields['name']
+    # Updates the fields of a list.
+    #
+    # Supply a hash of string keyed data retrieved from the Trello API representing
+    # a List.
+    def update_fields(fields)
+      @id       = fields['id']
+      @name     = fields['name']
+      @closed   = fields['closed']
+      @board_id = fields['idBoard']
     end
 
-    def closed
-      fields['closed']
+    # Check if the list is not active anymore.
+    def closed?
+      closed
     end
 
-    # Links to other data structures
-
+    # Return a timeline of events related to this list.
     def actions
-      response = Client.query("/1/lists/#{id}/actions")
-      JSON.parse(response.read_body).map do |action_fields|
-        Action.new(action_fields)
-      end
+      return @actions if @actions
+      @actions = Client.get("/lists/#{id}/actions").json_into(Action)
     end
 
+    # Return the board the list is connected to.
     def board
-      Board.find(fields['idBoard'])
+      return @board if @board
+      @board = Board.find(board_id)
     end
 
-    def cards
-      fields['cards'].map do |c|
-        Card.new(c)
-      end
+    # Returns all the cards on this list.
+    #
+    # The options hash may have a filter key which can have its value set as any
+    # of the following values:
+    #    :filter => [ :none, :open, :closed, :all ] # default :open
+    def cards(options = { :filter => :open })
+      return @cards if @cards
+      @cards = Client.get("/lists/#{id}/cards", options).json_into(Card)
     end
   end
-end
+end

data/lib/trello/member.rb

@@ -1,73 +1,82 @@
-# 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
+  # A Member is a user of the Trello service.
   class Member < BasicData
+    attr_reader   :id
+    attr_accessor :full_name, :username, :gravatar_id, :bio, :url
+
     class << self
+      # Finds a user
+      #
+      # The argument may be specified as either an _id_ or a _username_.
       def find(id_or_username)
         super(:members, id_or_username)
       end
     end
 
-    def initialize(fields = {})
-      @fields = fields
-    end
-
-    # Fields of a user
-
-    def id
-      @fields['id']
-    end
-
-    def full_name
-      @fields['fullName']
-    end
-
-    def username
-      @fields['username']
+    # Update the fields of a member.
+    #
+    # Supply a hash of string keyed data retrieved from the Trello API representing
+    # an Member.
+    def update_fields(fields)
+      @id          = fields['id']
+      @full_name   = fields['fullName']
+      @username    = fields['username']
+      @gravatar_id = fields['gravatar']
+      @bio         = fields['bio']
+      @url         = fields['url']
     end
 
-    def gravatar_id
-      @fields['gravatar']
+    # Returns a list of the users actions.
+    def actions
+      return @actions if @actions
+      @actions = Client.get("/members/#{username}/actions").json_into(Action)
     end
 
-    def bio
-      @fields['bio']
+    # Returns a list of the boards a member is a part of.
+    #
+    # The options hash may have a filter key which can have its value set as any
+    # of the following values:
+    #   :filter => [ :none, :members, :organization, :public, :open, :closed, :all ] # default: :all
+    def boards(options = { :filter => :all })
+      return @boards if @boards
+      @boards = Client.get("/members/#{username}/boards", options).json_into(Board)
     end
 
-    def url
-      @fields['url']
+    # Returns a list of cards the member is assigned to.
+    #
+    # The options hash may have a filter key which can have its value set as any
+    # of the following values:
+    #    :filter => [ :none, :open, :closed, :all ] # default :open
+    def cards(options = { :filter => :open })
+      return @cards if @cards
+      @cards = Client.get("/members/#{username}/cards", options).json_into(Card)
     end
 
-    # 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
+    # Returns a list of the organizations this member is a part of.
+    #
+    # The options hash may have a filter key which can have its value set as any
+    # of the following values:
+    #   :filter => [ :none, :members, :public, :all ] # default: all
+    def organizations(options = { :filter => :all })
+      return @organizations if @organizations
+      @organizations = Client.get("/members/#{username}/organizations", options).json_into(Organization)
     end
 
-    def boards
-      response = Client.query("/1/members/#{username}/boards/all")
-      JSON.parse(response.read_body).map do |board_fields|
-        Board.new(board_fields)
-      end
+    # Returns a list of notifications for the user
+    def notifications
+      Client.get("/members/#{username}/notifications").json_into(Notification)
     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")
-      JSON.parse(response.read_body).map do |org_fields|
-        Organization.new(org_fields)
-      end
+    # Returns a hash of the items that would be returned by Trello.
+    def to_hash
+      {
+        'id'       => id,
+        'fullName' => full_name,
+        'username' => username,
+        'gravatar' => gravatar_id,
+        'bio'      => bio,
+        'url'      => url
+      }
     end
   end
-end
+end

data/lib/trello/notification.rb

@@ -0,0 +1,10 @@
+module Trello
+  # Notifications for members
+  #
+  # This class is not yet implemented as the feature set is not known yet.
+  class Notification < BasicData
+    def update_fields(fields)
+      @id = fields['id']
+    end
+  end
+end

data/lib/trello/organization.rb

@@ -1,62 +1,43 @@
-# 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
+  # Organizations are useful for linking members together.
   class Organization < BasicData
+    attr_reader :id, :name, :display_name, :description, :url
+
     class << self
+      # Find an organization by its id.
       def find(id)
         super(:organizations, id)
       end
     end
 
-    def initialize(fields = {})
-      @fields = fields
-    end
-
-    # Fields
-
-    def id
-      @fields['id']
-    end
-
-    def name
-      @fields['name']
-    end
-
-    def display_name
-      @fields['display_name']
+    # Update the fields of an organization.
+    #
+    # Supply a hash of string keyed data retrieved from the Trello API representing
+    # an Organization.
+    def update_fields(fields)
+      @id           = fields['id']
+      @name         = fields['name']
+      @display_name = fields['displayName']
+      @description  = fields['description']
+      @url          = fields['url']
     end
 
-    def description
-      @fields['desc']
-    end
-
-    def url
-      @fields['url']
-    end
-
-    # Links to other data structures
-
+    # Returns a timeline of actions.
     def actions
-      response = Client.query("/1/organizations/#{id}/actions")
-      JSON.parse(response.read_body).map do |action_fields|
-        Action.new(action_fields)
-      end
+      return @actions if @actions
+      @actions = Client.get("/organizations/#{id}/actions").json_into(Action)
     end
 
+    # Returns a list of boards under this organization.
     def boards
-      response = Client.query("/1/organizations/#{id}/boards/all")
-      JSON.parse(response.read_body).map do |board_fields|
-        Board.new(board_fields)
-      end
+      return @boards if @boards
+      @boards = Client.get("/organizations/#{id}/boards/all").json_into(Board)
     end
 
+    # Returns an array of members associated with the organization.
     def members
-      response = Client.query("/1/organizations/#{id}/members/all")
-      JSON.parse(response.read_body).map do |member_fields|
-        Member.new(member_fields)
-      end
+      return @members if @members
+      @members = Client.get("/organizations/#{id}/members/all").json_into(Member)
     end
   end
-end
+end

data/lib/trello/string.rb

@@ -0,0 +1,33 @@
+class String
+  # Decodes some JSON text in the receiver, and marshals it into a class specified
+  # in _obj_. If _obj_ is not a class, then we marshall the data into that instance
+  # via _update_fields_.
+  #
+  # For instance:
+  #
+  #   class Stuff
+  #     attr_reader :a, :b
+  #     def initialize(values)
+  #       @a = values['a']
+  #       @b = values['b']
+  #     end
+  #   end
+  #   thing = '{"a":42,"b":"foo"}'.json_into(Stuff)
+  #   thing.a == 42
+  #   thing.b == "foo"
+  def json_into(obj)
+    data = JSON.parse(self)
+    action = obj.kind_of?(Class) ? :new : :update_fields
+    if data.kind_of? Hash
+      obj.send(action, JSON.parse(self))
+    else
+      data.map { |element| obj.send(action, element) }
+    end
+  rescue JSON::ParserError => json_error
+    if json_error.message =~ /model not found/
+      raise Trello::RecordNotFound
+    else
+      raise
+    end
+  end
+end

data/spec/board_spec.rb

@@ -41,7 +41,7 @@ module Trello
 
     context "cards" do
       it "gets its list of cards" do
-        stub_request(:get, "https://api.trello.com/1/boards/abcdef123456789123456789/cards/all?").
+        stub_request(:get, "https://api.trello.com/1/boards/abcdef123456789123456789/cards?").
           with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
           to_return(:status => 200, :headers => {}, :body => cards_payload)
 

data/spec/card_spec.rb

@@ -17,6 +17,33 @@ module Trello
       @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' do
+        payload = {
+          :name    => 'Test Card',
+          :desc    => '',
+        }
+        stub_trello_request!(:post, '/cards', payload.merge(:idList => lists_details.first['id']))
+        card = Card.create(payload.merge(:list_id => lists_details.first['id']))
+        card.should == ''
+      end
+    end
+
     context "fields" do
       it "gets its id" do
         @card.id.should_not be_nil

data/spec/list_spec.rb

@@ -10,14 +10,10 @@ module Trello
     end
 
     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 => 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 => JSON.generate(boards_details.first))
-
-        @list = List.find("abcdef123456789123456789")
+      stub_trello_request!(:get, "/lists/abcdef123456789123456789?", nil, JSON.generate(lists_details.first))
+      stub_trello_request!(:get, "/boards/abcdef123456789123456789?", nil, JSON.generate(boards_details.first))
+
+      @list = List.find("abcdef123456789123456789")
     end
 
     context "fields" do
@@ -40,6 +36,7 @@ module Trello
 
     context "cards" do
       it "has a list of cards" do
+        stub_trello_request!(:get, "/lists/abcdef123456789123456789/cards?", { :filter => :open }, cards_payload)
         @list.cards.count.should be > 0
       end
     end

data/spec/member_spec.rb

@@ -12,29 +12,21 @@ module Trello
     end
 
     before(:each) do
-      stub_request(:get, "https://api.trello.com/1/members/me?").
-         with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
-         to_return(:status => 200, :headers => {}, :body => user_payload)
+      stub_trello_request!(:get, '/members/me?', nil, user_payload)
 
       @member = Member.find('me')
     end
 
     context "actions" do
       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)
-
+        stub_trello_request!(:get, '/members/me/actions?', nil, actions_payload)
         @member.actions.count.should be > 0
       end
     end
 
     context "boards" do
       it "has a list of boards" do
-        stub_request(:get, "https://api.trello.com/1/members/me/boards/all?").
-          with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
-          to_return(:status => 200, :headers => {}, :body => boards_payload)
-
+        stub_trello_request!(:get, '/members/me/boards?', { :filter => :all }, boards_payload)
         boards = @member.boards
         boards.count.should be > 0
       end
@@ -42,10 +34,7 @@ module Trello
 
     context "organizations" do
       it "has a list of organizations" do
-        stub_request(:get, "https://api.trello.com/1/members/me/organizations/all?").
-          with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
-          to_return(:status => 200, :headers => {}, :body => orgs_payload)
-
+        stub_trello_request!(:get, '/members/me/organizations?', { :filter => :all }, orgs_payload)
         orgs = @member.organizations
         orgs.count.should be > 0
       end

data/spec/spec_helper.rb

@@ -17,6 +17,15 @@ require 'trello'
 require 'webmock/rspec'
 
 module Helpers
+  def stub_trello_request!(http_method, path, data, returning = '')
+    uri = Addressable::URI.parse("https://api.trello.com/#{Trello::API_VERSION}#{path}")
+    uri.query_values = data.kind_of?(String) ? JSON.parse(data) : data if data
+
+    stub_request(http_method, uri.to_s).
+      with(:headers => {'Accept'=>'*/*', 'Authorization'=>/.*/, 'User-Agent' => /.*/}).
+      to_return(:status => 200, :headers => {}, :body => returning)
+  end
+
   def user_details
     {
       "id"       => "abcdef123456789012345678",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-trello
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   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: &70240457388560 !ruby/object:Gem::Requirement
+  requirement: &70096518301420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70240457388560
+  version_requirements: *70096518301420
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70240457399940 !ruby/object:Gem::Requirement
+  requirement: &70096518300720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.4.5
   type: :runtime
   prerelease: false
-  version_requirements: *70240457399940
+  version_requirements: *70096518300720
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &70240457481800 !ruby/object:Gem::Requirement
+  requirement: &70096518300060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.2.6
   type: :runtime
   prerelease: false
-  version_requirements: *70240457481800
+  version_requirements: *70096518300060
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70240457630780 !ruby/object:Gem::Requirement
+  requirement: &70096518299380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70240457630780
+  version_requirements: *70096518299380
 description: A wrapper around the trello.com API.
 email: jeremy@tregunna.ca
 executables: []
@@ -72,7 +72,9 @@ files:
 - lib/trello/item_state.rb
 - lib/trello/list.rb
 - lib/trello/member.rb
+- lib/trello/notification.rb
 - lib/trello/organization.rb
+- lib/trello/string.rb
 - lib/trello.rb
 - README.md
 - spec/action_spec.rb