tacokit 0.1.0 → 0.2.0

data/lib/tacokit/client/checklists.rb

@@ -1,55 +1,75 @@
 module Tacokit
   class Client
     module Checklists
-
-      # GET /1/checklists/[idChecklist]
+      # Retrieve a checklist
+      #
+      # @see https://trello.com/docs/api/checklist/index.html#get-1-checklists-idchecklist
       def checklist(checklist_id, options = nil)
         get checklist_path(checklist_id), options
       end
 
-      # GET /1/checklists/[idChecklist]/[field]
-      def checklist_field(checklist_id, field)
-        get checklist_path(checklist_id, camp(field))
+      # Retrieve the checklist's board
+      #
+      # @see https://trello.com/docs/api/checklist/index.html#get-1-checklists-idchecklist-board
+      def checklist_board(checklist_id, options = {})
+        checklist_resource "board", options
       end
 
-      # GET /1/checklists/[idChecklist]/[resource]
-      # board
-      # board/[field]
-      # checklists
-      # checklists/[filter]
-      # checkItems
-      # checkItems/[idCheckItem]
-      def checklist_resource(checklist_id, resource, *paths)
-        paths, options = extract_options(camp(resource), *paths)
-        get checklist_path(checklist_id, *paths), options
+      # Retrieve a checklist's card
+      #
+      # @see https://trello.com/docs/api/checklist/index.html#get-1-checklists-idchecklist-cards
+      def checklist_card(checklist_id, options = {})
+        checklist_resource "card", options
       end
 
-      # PUT /1/checklists/[idChecklist]
+      # Retrieve a checklist's check items
+      #
+      # @see https://trello.com/docs/api/checklist/index.html#get-1-checklists-idchecklist-checkitems
+      def check_items(checklist_id, options = {})
+        checklist_resource checklist_id, "check_items", options
+      end
+      alias_method :checklist_check_items, :check_items
+
+      # Updates a checklist
+      #
+      # @see https://trello.com/docs/api/checklist/index.html#put-1-checklists-idchecklist
       def update_checklist(checklist_id, options = {})
         put checklist_path(checklist_id), options
       end
+      alias_method :checklist_update, :update_checklist
 
-      # PUT /1/checklists/[idChecklist]/[field]
-      # idCard
-      # name
-      # pos
-
-      # POST /1/checklists
+      # Create a checklist
+      #
+      # @see https://trello.com/docs/api/checklist/index.html#post-1-checklists
       def create_checklist(card_id, name, options = {})
-        options.update \
-          card_id: card_id,
-          name: name
+        options.update card_id: card_id, name: name
         post checklist_path, options
       end
+      alias_method :checklist_create, :create_checklist
 
-      # POST /1/checklists/[idChecklist]/checkItems
+      # Add a checklist item to a checklist
+      #
+      # @see https://trello.com/docs/api/checklist/index.html#post-1-checklists-idchecklist-checkitems
+      def add_checklist_check_item(checklist_id, name, options = {})
+        post checklist_path(checklist_id, "checkItems"), options.merge(name: name)
+      end
+      alias_method :checklist_check_item_create, :add_checklist_check_item
+      alias_method :add_checklist_item, :add_checklist_check_item
 
-      # DELETE /1/checklists/[idChecklist]
+      # Delete a checklist
+      #
+      # @see https://trello.com/docs/api/checklist/index.html#delete-1-checklists-idchecklist
       def delete_checklist(checklist_id)
         delete checklist_path(checklist_id)
       end
+      alias_method :checklist_delete, :delete_checklist
+
+      private
 
-      # DELETE /1/checklists/[idChecklist]/checkItems/[idCheckItem]
+      def checklist_resource(checklist_id, resource, *paths)
+        paths, options = extract_options(camp(resource), *paths)
+        get checklist_path(checklist_id, *paths), options
+      end
 
       def checklist_path(*paths)
         path_join("checklists", *paths)

data/lib/tacokit/client/labels.rb

@@ -1,29 +1,23 @@
 module Tacokit
   class Client
     module Labels
-
-      # GET /1/labels/[idLabel]
+      # Retrieve a label
+      #
+      # @see https://trello.com/docs/api/label/index.html#get-1-labels-idlabel
       def label(label_id, options = nil)
         get label_path(label_id), options
       end
 
-      # GET /1/labels/[idLabel]/[resource]
-      # board
-      # board/[field]
-      def label_resource(label_id, resource, *paths)
-        paths, options = extract_options(camp(resource), *paths)
-        get label_path(label_id, *paths), options
-      end
-
-      # PUT /1/labels/[idLabel]
+      # Update a label
+      #
+      # @see https://trello.com/docs/api/label/index.html#put-1-labels-idlabel
       def update_label(label_id, options = {})
         put label_path(label_id), options
       end
 
-      # PUT /1/labels/[idLabel]/color
-      # PUT /1/labels/[idLabel]/name
-
-      # POST /1/labels
+      # Create a label
+      #
+      # @see https://trello.com/docs/api/label/index.html#post-1-labels
       def create_label(board_id, name, color)
         post label_path,
           board_id: board_id,
@@ -31,11 +25,15 @@ module Tacokit
           color: color
       end
 
-      # DELETE /1/labels/[idLabel]
+      # Delete a label
+      #
+      # @see https://trello.com/docs/api/label/index.html#delete-1-labels-idlabel
       def delete_label(label_id)
         delete label_path(label_id)
       end
 
+      private
+
       def label_path(*paths)
         path_join "labels", *paths
       end

data/lib/tacokit/client/lists.rb

@@ -1,54 +1,78 @@
 module Tacokit
   class Client
     module Lists
-
-      # GET /1/lists/[idList]
+      # Retrieve a list by id
+      #
+      # @see https://trello.com/docs/api/label/index.html#get-1-labels-idlabel-board
       def list(list_id, options = nil)
         get list_path(list_id), options
       end
 
-      # GET /1/lists/[idList]/[field]
-      def list_field(list_id, field, options = nil)
-        get list_path(list_id, camp(field)), options
+      # Retrive a list's actions
+      #
+      # @see https://trello.com/docs/api/list/index.html#get-1-lists-idlist-actions
+      def list_actions(list_id, options = {})
+        paginated_list_resource list_id, "actions", options
       end
 
-      # GET /1/lists/[idList]/[resource]
-      # actions
-      # board
-      # board/[field]
-      # lists
-      # lists/[filter]
-      def list_resource(list_id, resource, *paths)
-        paths, options = extract_options(camp(resource), *paths)
-        get list_path(list_id, *paths), options
+      # Retrive a list's board
+      #
+      # @see https://trello.com/docs/api/list/index.html#get-1-lists-idlist-board
+      def list_board(list_id, options = {})
+        list_resource list_id, "board", options
+      end
+
+      # Retrive a list's cards
+      #
+      # @see https://trello.com/docs/api/list/index.html#get-1-lists-idlist-cards
+      def list_cards(list_id, options = {})
+        paginated_list_resource list_id, "cards", options
       end
 
-      # PUT /1/lists/[idList]
+      # Update a list's attributes
+      #
+      # @see https://trello.com/docs/api/list/index.html#put-1-lists-idlis
       def update_list(list_id, options = {})
         put list_path(list_id), options
       end
 
-      # PUT /1/lists/[idList]/[field]
-      # closed
-      # idBoard
-      # name
-      # pos
-      # subscribed
-
-      # POST /1/lists
+      # Create a new list
+      #
+      # @see https://trello.com/docs/api/list/index.html#post-1-lists
       def create_list(board_id, name, options = {})
         post list_path, options.merge(name: name, board_id: board_id)
       end
 
-      # POST /1/lists/[idList]/[resource]
-      # archiveAllCards
-      # cards
-      # moveAllCards
+      # Archive all cards in a list
+      #
+      # @see https://trello.com/docs/api/list/index.html#post-1-lists-idlist-moveallcards
+      def archive_list_cards(list_id)
+        post list_path(list_id, camp("archive_all_cards"))
+      end
+
+      # Move cards from one list to another
+      #
+      # @see https://trello.com/docs/api/list/index.html#post-1-lists-idlist-moveallcards
+      def move_list_cards(list_id, destination_list_id, board_id)
+        post list_path(list_id, camp("move_all_cards")),
+          list_id: destination_list_id, board_id: board_id
+      end
+
+      private
+
+      def list_resource(list_id, resource, *paths)
+        paths, options = extract_options(camp(resource), *paths)
+        get list_path(list_id, *paths), options
+      end
+
+      def paginated_list_resource(list_id, resource, *paths)
+        paths, options = extract_options(camp(resource), *paths)
+        paginated_get list_path(list_id, *paths), options
+      end
 
       def list_path(*paths)
         path_join("lists", *paths)
       end
-
     end
   end
 end

data/lib/tacokit/client/members.rb

@@ -1,60 +1,63 @@
 module Tacokit
   class Client
     module Members
-
-      # GET /1/members/[idMember or username]
-      def member(username = 'me', options = nil)
+      # Retrieve a Trello member
+      #
+      # @see https://trello.com/docs/api/member/index.html#get-1-members-idmember-or-username
+      def member(username = "me", options = nil)
         get member_path(username), options
       end
 
-      # GET /1/members/[idMember or username]/[field]
-      def member_field(username, field, options = nil)
-        get member_path(username, camp(field)), options
+      # Retrieve a member's actions
+      #
+      # @see https://trello.com/docs/api/member/index.html#get-1-members-idmember-or-username-actions
+      def actions(username = "me", options = {})
+        if username.is_a?(Hash)
+          username = "me"
+          options = username
+        end
+        paginated_get member_path(username, "actions"), options
       end
+      alias_method :member_actions, :actions
 
-      # GET /1/members/[idMember or username]/[resource]
-      # actions
-      # boardBackgrounds
-      # boardBackgrounds/[idBoardBackground]
-      # boardStars
-      # boardStars/[idBoardStar]
-      # boards/[filter]
-      # boardsInvited
-      # boardsInvited/[field]
-      # cards
-      # cards/[filter]
-      # customBoardBackgrounds
-      # customBoardBackgrounds/[idBoardBackground]
-      # customEmoji
-      # customEmoji/[idCustomEmoji]
-      # customStickers
-      # customStickers/[idCustomSticker]
-      # deltas
-      # notifications
-      # notifications/[filter]
-      # organizations
-      # organizations/[filter]
-      # organizationsInvited
-      # organizationsInvited/[field]
-      # savedSearches
-      # savedSearches/[idSavedSearch]
-      # tokens
-      def member_resource(username, resource, *paths)
-        paths, options = extract_options(camp(resource), *paths)
-        get member_path(username, *paths), options
+      # Retrieve a member's boards
+      #
+      # @see https://trello.com/docs/api/member/index.html#get-1-members-idmember-or-username-boards
+      def boards(username = "me", options = {})
+        get member_path(username, "boards"), options
+      end
+
+      # Retrieve a member's cards
+      #
+      # @see https://trello.com/docs/api/member/index.html#get-1-members-idmember-or-username-cards
+      def cards(username = "me", options = {})
+        get member_path(username, "cards"), options
       end
 
-      # POST /1/members/[idMember or username]/[resource]
-      # avatar
-      # boardBackgrounds
-      # boardStars
-      # customBoardBackgrounds
-      # customEmoji
-      # customStickers
-      # oneTimeMessagesDismissed
-      # savedSearches
+      # Retrieve a member's notifications
+      #
+      # @see https://trello.com/docs/api/member/index.html#get-1-members-idmember-or-username-notifications
+      def notifications(username = "me", options = {})
+        paginated_get member_path(username, "notifications"), options
+      end
+
+      # Retrieve a member's organizations
+      #
+      # @see https://trello.com/docs/api/member/index.html#get-1-members-idmember-or-username-organizations
+      def organizations(username = "me", options = {})
+        get member_path(username, "organizations"), options
+      end
+
+      # Retrieve a member's tokens
+      #
+      # @see https://trello.com/docs/api/member/index.html#get-1-members-idmember-or-username-tokens
+      def tokens(username = "me", options = {})
+        get member_path(username, "tokens"), options
+      end
 
-      # PUT /1/members/[idMember or username]
+      # Update a member
+      #
+      # @see https://trello.com/docs/api/member/index.html#put-1-members-idmember-or-username
       def update_member(username, options = {})
         put member_path(username), options
       end
@@ -83,6 +86,13 @@ module Tacokit
       # customStickers/[idCustomSticker]
       # savedSearches/[idSavedSearch]
 
+      private
+
+      def member_resource(username, resource, *paths)
+        paths, options = extract_options(camp(resource), *paths)
+        get(member_path(username, *paths), options)
+      end
+
       def member_path(*paths)
         path_join "members", *paths
       end

data/lib/tacokit/client/notifications.rb

@@ -1,37 +1,16 @@
 module Tacokit
   class Client
     module Notifications
-
-      # GET /1/notifications/[idNotification]
+      # Retrieve a notification
+      #
+      # @see https://trello.com/docs/api/notification/index.html#get-1-notifications-idnotification
       def notification(notification_id, options = nil)
         get notification_path(notification_id), options
       end
 
-      # GET /1/notifications/[idNotification]/[field]
-      def notification_field(notification_id, field)
-        get notification_path(notification_id, camp(field))
-      end
-
-      # GET /1/notifications/[idNotification]/[resource]
-      # board
-      # board/[field]
-      # notification
-      # notification/[field]
-      # entities
-      # list
-      # list/[field]
-      # member
-      # member/[field]
-      # memberCreator
-      # memberCreator/[field]
-      # organization
-      # organization/[field]
-      def notification_resource(notification_id, resource, *paths)
-        paths, options = extract_options(camp(resource), *paths)
-        get notification_path(notification_id, *paths), options
-      end
-
-      # PUT /1/notifications/[idNotification]
+      # Update read/unread status of notification
+      #
+      # @see https://trello.com/docs/api/notification/index.html#put-1-notifications-idnotification
       def update_notification(notification_id, options = {})
         put notification_path(notification_id), options
       end
@@ -40,6 +19,13 @@ module Tacokit
 
       # POST /1/notifications/all/read
 
+      private
+
+      def notification_resource(notification_id, resource, *paths)
+        paths, options = extract_options(camp(resource), *paths)
+        get notification_path(notification_id, *paths), options
+      end
+
       def notification_path(*paths)
         path_join "notifications", *paths
       end

data/lib/tacokit/client/organizations.rb

@@ -1,17 +1,11 @@
 module Tacokit
   class Client
     module Organizations
-
       # GET /1/organizations/[idOrg or name]
       def organization(org_id, options = nil)
         get organization_path(org_id), options
       end
 
-      # GET /1/organizations/[idOrg or name]/[field]
-      def organization_field(org_id, field, options = nil)
-        get organization_path(org_id, camp(field)), options
-      end
-
       # GET /1/organizations/[idOrg or name]/[resource]
       # actions
       # boards

data/lib/tacokit/client/searches.rb

@@ -1,7 +1,6 @@
 module Tacokit
   class Client
     module Searches
-
       # GET /1/search
       def search(query, options = {})
         get search_path, options.merge(query: query)

data/lib/tacokit/client/tokens.rb

@@ -1,17 +1,11 @@
 module Tacokit
   class Client
     module Tokens
-
       # GET /1/tokens/[token]
       def token(token, options = nil)
         get token_path(token), options
       end
 
-      # GET /1/tokens/[token]/[field]
-      def token_field(token, field, options = nil)
-        get token_path(token, camp(field)), options
-      end
-
       # GET /1/tokens/[token]/[resource]
       # member
       # webhooks

data/lib/tacokit/client/types.rb

@@ -1,7 +1,6 @@
 module Tacokit
   class Client
     module Types
-
       # GET /1/types/[id]
       def type(model_id)
         get path_join "types", model_id

data/lib/tacokit/client/webhooks.rb

@@ -1,17 +1,11 @@
 module Tacokit
   class Client
     module Webhooks
-
       # GET /1/webhooks/[idWebhook]
       def webhook(webhook_id)
         get webhook_path(webhook_id)
       end
 
-      # GET /1/webhooks/[idWebhook]/[field]
-      def webhook_field(webhook_id, field, options = nil)
-        get webhook_path(webhook_id, camp(field)), options
-      end
-
       # PUT /1/webhooks/[idWebhook]
       def update_webhook(webhook_id, options = {})
         put webhook_path(webhook_id), options
@@ -25,9 +19,10 @@ module Tacokit
 
       # POST /1/webhooks
       def create_webhook(token, model_id, callback_url, options = {})
-        post webhook_path, options.merge(
+        options.update \
           model_id: model_id,
-          callback_url: callback_url)
+          callback_url: callback_url
+        post webhook_path, options
       end
 
       # DELETE /1/webhooks/[idWebhook]