tacokit 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 721bdb7f3d850839c9e9dc12ccdba8452f03ca72
-  data.tar.gz: a1da08c3defaa5806675b86795b11613d97bfbc0
+  metadata.gz: 893e6fcc338a5577d85ae6aeab7d2abd37aba994
+  data.tar.gz: 31289e149b682205ca77126dd117ba03ec0fcc52
 SHA512:
-  metadata.gz: 4b4d275d708a8ab1694183e25370252710c3e23aec78c80d30f40429f3926b242fb138f6a79ad4e7ddd61ea71c1f688026f334b436784339975d131f2f45fab5
-  data.tar.gz: bdc5d9afbb8b9917237a33b3197f3d3800e9a75b94afa99bd90b2e400a25587eb80d515f3dcc4f54a74dbaec8970f0b48e9a81c6793c6e332d766684daae635c
+  metadata.gz: 7daa990bf2a35abd1f69d58be4250023c1ed4b4f042ce6b23e4d162faa7e51f7e4f09c51adde90cd0de9ee60e79802d0c596b1a3656616ce7f23a858631a4bfa
+  data.tar.gz: 5d52cafaf8d20fd5602fe41015c75112776c98322a7bec1380389bad48c39368b03d5b5dc64812b69b734a8aeca9948431ab005d344ed124d031fab97867a23b

data/.rubocop.yml

@@ -28,6 +28,9 @@ Metrics/AbcSize:
 Metrics/CyclomaticComplexity:
   Enabled: false
 
+Metrics/ModuleLength:
+  Enabled: false
+
 Metrics/PerceivedComplexity:
   Enabled: false
 

data/Gemfile

@@ -2,7 +2,6 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "addressable"
 gem "awesome_print", require: "ap"
 gem "coveralls", require: false
 gem "dotenv"
@@ -13,8 +12,9 @@ gem "pry"
 gem "pry-byebug", platforms: :ruby_21
 gem "rake"
 gem "rb-fsevent"
-gem "rspec"
-gem "rubocop"
+gem "rspec", "~> 3.3"
+gem "rubocop", "~> 0.34"
 gem "sinatra"
 gem "vcr"
 gem "webmock"
+gem "multi_json"

data/README.md

@@ -100,15 +100,19 @@ behalf of different members:
 client = Tacokit::Client.new app_key: "4ppk3y", oauth_token: "04utht0k3n"
 ```
 
+#### OAuth Tacokit Sandbox
+
 To experiment with OAuth tokens for development, visit the [Tacokit
-Sandbox](https://tacokit.herokuapp.com) and enter your Trello app key and app secret.
+Sandbox](https://tacokit.herokuapp.com) and enter your Trello app key and app secret. 
+
+The sandbox (hosted over SSL on heroku) will perform the OAuth handshake and display OAuth credentials onscreen. In a real web app, you'd more likely associate these credentials with users in your database. Check out the source code for the sandbox on the [sandbox branch of this repository](https://github.com/rossta/tacokit.rb/tree/sandbox). 
 
 #### Resources
 
 For more information on setting up Trello OAuth for your web application
 
 * Using OmniAuth? Try adding [omniauth-trello](https://github.com/joshrowley/omniauth-trello)
-* To roll your own, see how the sandbox works: [Tacokit sandbox source](https://github.com/rossta/tacokit.rb/blob/heroku/app.rb)
+* To roll your own, see how the sandbox works: [Tacokit sandbox source](https://github.com/rossta/tacokit.rb/blob/817691cbc6933e5bf2fac23d37e57cf7fdbbdf04/app.rb)
 * Check out the [Trello OAuth docs](https://trello.com/docs/gettingstarted/oauth.html)
 
 ### Using ENV variables
@@ -123,50 +127,86 @@ TRELLO_APP_TOKEN=4ppt0k3n
 
 ## Usage
 
-Working with boards
+All requests are called on instances of a `Tacokit::Client`. Most return a `Tacokit::Resource` object which behaves similar to an `OpenStruct`.
+
+### Boards
 
 ```ruby
-client.boards
+board = client.board(board_id) # retrieve board resource by board id
+# => {:id=>"54...", :name=>"Work in Progress", ... }
 
-client.boards("rossta")
+board.name
+# => "Work in Progress"
 
-board_id = "swezQ9XS" # short link to "Test Board" for Tacokit
+client.boards # retrieve boards for client account
+# => [{:id=>"54...", :name=>"Work in Progress", ... }, {...}]
 
-board = client.board(board_id)
+client.boards("rossta") # retrieve board for user 'rossta'
+# => [{:id=>"32...", :name=>"Tacokit Ideas", ... }, {...}]
 
-board.name = "Ice Box"
+client.update_board(board, name: "TODO") # change board attributes
+# => {:id=>"54...", :name=>"TODO", ... }
 
-client.update_board(board.id, name: "TODO")
+client.add_board_member(board, 'rosskaff@gmail.com', 'Ross Kaffenberger') # add
+me to your card
+
+client.create_board("All We Need is Love") # all you need is a name
 ```
 
-Working with cards
+### Cards
 
 ```ruby
-client.cards
+card = client.card(card_id) # retrieve card by card id
+# => {:id=>"12...", :name=>"Call Mom", ... }
+
+card.name
+# => "Call Mom"
+
+client.cards # retrieve cards for client account
+# => [{:id=>"12...", :name=>"Call Mom", ... }, {...}]
 
-client.cards("rossta")
+client.cards("rossta") # retrieve cards for user 'rossta'
+# => [{:id=>"34...", :name=>"Buy Milk", ... }, {...}]
 
-client.board_cards(board_id)
+client.board_cards(board) # retrieve cards for a board
+# => [{:id=>"56...", :name=>"Another Card", ... }, {...}]
 
-card_id = "SpbauOpX" # short link to card on "Test Board"
+client.update_card(card, name: "Wish List") # change card attributes
+# => {:id=>"12...", :name=>"Wish List", ... }
 
-card.name = "Shopping List"
+client.move_card(card, list_id: list_id) # move card to another list
 
-client.update_card(card.id, name: "Wish List")
+client.card_members(card) # retrieve members assigned to card
 
-client.move_card(card.id, list_id: list_id)
+client.attach_file(card, "https://pbs.twimg.com/media/CCKtnZmUsAEUAX2.jpg:large") # attach by url or file path
+
+client.add_comment(card, "Nice jorb!") # troll cards
+
+client.subscribe_to_card(card) # keep client account notified
+
+client.archive_card(card) # send card into the abyss
+
+client.restore_card(card) # save card back from the abyss
 ```
 
-Working with lists
+### Lists
 
 ```ruby
-client.lists(board_id)
+list = client.list(list_id) # retrieve list by a list id
+# => {:id=>"78...", :name=>"Ready", ... }
+
+list.name
+# => "Ready"
+
+client.lists(board) # retrieve lists for a board
+# => [{:id=>"56...", :name=>"Blocked", ... }, {...}]
 
-list = client.list(list_id)
+client.update_list(list, name: "Done") # change list attributes
+# => {:id=>"78...", :name=>"Done", ... }
 
-list.name = "Work in Progress"
+client.create_list(board.id, "Finished") # add a new list to a board
 
-client.update_list(list.id, name: "Done")
+client.archive_list_cards(list) # send all list cards to the abyss
 ```
 
 ## Contributing

data/lib/tacokit/authorization.rb

@@ -14,7 +14,7 @@ module Tacokit
     # @option options [String] :return_url URL the token should be returned to
     # @option options [String] :scope Comma-separated list of one or more of "read", "write", "account"
     # @option options [String] :expiration "1hour", "1day", "30days", "never"
-    # @see https://trello.com/docs/gettingstarted/authorize.html
+    # @see https://developers.trello.com/authorize
     def authorize(params = {})
       open_url authorize_url(params)
     end

data/lib/tacokit/client/actions.rb

@@ -3,70 +3,70 @@ module Tacokit
     module Actions
       # Retrieve an action
       #
-      # @see https://trello.com/docs/api/action/index.html#get-1-actions-idaction
+      # @see https://developers.trello.com/advanced-reference/action#get-1-actions-idaction
       def action(action_id, options = nil)
         get action_path(action_id), options
       end
 
       # Retrieve an action's board
       #
-      # @see https://trello.com/docs/api/action/index.html#get-1-actions-idaction-field
+      # @see https://developers.trello.com/advanced-reference/action#get-1-actions-idaction-field
       def action_board(action_id, fields = "all")
         action_resource action_id, "board", fields: fields
       end
 
       # Retrieve an actions" card
       #
-      # @see https://trello.com/docs/api/action/index.html#get-1-actions-idaction-card
+      # @see https://developers.trello.com/advanced-reference/action#get-1-actions-idaction-card
       def action_card(action_id, fields = "all")
         action_resource action_id, "card", fields: fields
       end
 
       # Retrive an action's entities
       #
-      # @see https://trello.com/docs/api/action/index.html#get-1-actions-idaction-entities
+      # @see https://developers.trello.com/advanced-reference/action#get-1-actions-idaction-entities
       def action_entities(action_id)
         action_resource action_id, "entities"
       end
 
       # Retrieve an action's list
       #
-      # @see https://trello.com/docs/api/action/index.html#get-1-actions-idaction-list
+      # @see https://developers.trello.com/advanced-reference/action#get-1-actions-idaction-list
       def action_list(action_id, fields = "all")
         action_resource action_id, "list", fields: fields
       end
 
       # Retrieve an actions" member
       #
-      # @see https://trello.com/docs/api/action/index.html#get-1-actions-idaction-member
+      # @see https://developers.trello.com/advanced-reference/action#get-1-actions-idaction-member
       def action_member(action_id, fields = "all")
         action_resource action_id, "member", fields: fields
       end
 
       # Retrieve an action's creator
       #
-      # @see https://trello.com/docs/api/action/index.html#get-1-actions-idaction-membercreator
+      # @see https://developers.trello.com/advanced-reference/action#get-1-actions-idaction-membercreator
       def action_member_creator(action_id, fields = "all")
         action_resource action_id, "memberCreator", fields: fields
       end
 
       # Retrieve an action's org
       #
-      # @see https://trello.com/docs/api/action/index.html#get-1-actions-idaction-organization
+      # @see https://developers.trello.com/advanced-reference/action#get-1-actions-idaction-organization
       def action_organization(action_id, fields = "all")
         action_resource action_id, "organization", fields: fields
       end
 
       # Update an action
       #
-      # @see https://trello.com/docs/api/action/index.html#put-1-actions-idaction
+      # @see https://developers.trello.com/advanced-reference/action#put-1-actions-idaction
       def update_action(action_id, options = {})
         put action_path(action_id), options
       end
 
       # Set new text for an action
       #
-      # @see https://trello.com/docs/api/action/index.html#put-1-actions-idaction-text
+      # @see https://developers.trello.com/advanced-reference/action#put-1-actions-idaction-text
       def update_action_text(action_id, text)
         put action_path(action_id, "text"), value: text
       end
@@ -74,7 +74,7 @@ module Tacokit
 
       # Delete an action
       #
-      # @see https://trello.com/docs/api/action/index.html#delete-1-actions-idaction
+      # @see https://developers.trello.com/advanced-reference/action#delete-1-actions-idaction
       def delete_action(action_id)
         delete action_path(action_id)
       end

data/lib/tacokit/client/boards.rb

@@ -3,49 +3,49 @@ module Tacokit
     module Boards
       # Retrieve a board
       #
-      # @see https://trello.com/docs/api/board/index.html#get-1-boards-board-id
+      # @see https://developers.trello.com/advanced-reference/board#get-1-boards-board-id
       def board(board_id, options = nil)
         get board_path(board_id), options
       end
 
       # Retrieve a board's actions
       #
-      # @see https://trello.com/docs/api/board/index.html#get-1-boards-board-id-actions
+      # @see https://developers.trello.com/advanced-reference/board#get-1-boards-board-id-actions
       def board_actions(board_id, options = {})
         paginated_board_resource(board_id, "actions", options)
       end
 
       # Retrieve a board's stars
       #
-      # @see https://trello.com/docs/api/board/index.html#get-1-boards-board-id-boardstars
+      # @see https://developers.trello.com/advanced-reference/board#get-1-boards-board-id-boardstars
       def board_stars(board_id, options = {})
         board_resource(board_id, "board_stars", options)
       end
 
       # Retrieve a board's cards
       #
-      # @see https://trello.com/docs/api/board/index.html#get-1-boards-board-id-cards
+      # @see https://developers.trello.com/advanced-reference/board#get-1-boards-board-id-cards
       def board_cards(board_id, options = {})
         paginated_board_resource(board_id, "cards", options)
       end
 
       # Retrieve a board's checklists
       #
-      # @see https://trello.com/docs/api/board/index.html#get-1-boards-board-id-checklists
+      # @see https://developers.trello.com/advanced-reference/board#get-1-boards-board-id-checklists
       def board_checklists(board_id, options = {})
         board_resource(board_id, "checklists", options)
       end
 
       # Retrieve a board's labels
       #
-      # @see https://trello.com/docs/api/board/index.html#get-1-boards-board-id-labels
+      # @see https://developers.trello.com/advanced-reference/board#get-1-boards-board-id-labels
       def board_labels(board_id, options = {})
         board_resource(board_id, "labels", options)
       end
 
       # Retrieve a board's lists
       #
-      # @see https://trello.com/docs/api/board/index.html#get-1-boards-board-id-lists
+      # @see https://developers.trello.com/advanced-reference/board#get-1-boards-board-id-lists
       def lists(board_id, options = {})
         board_resource(board_id, "lists", options)
       end
@@ -53,35 +53,35 @@ module Tacokit
 
       # Retrieve a board's members
       #
-      # @see https://trello.com/docs/api/board/index.html#get-1-boards-board-id-members
+      # @see https://developers.trello.com/advanced-reference/board#get-1-boards-board-id-members
       def board_members(board_id, options = {})
         board_resource(board_id, "members", options)
       end
 
       # Retrieve your preferences for a board
       #
-      # @see https://trello.com/docs/api/board/index.html#get-1-boards-board-id-myprefs
+      # @see https://developers.trello.com/advanced-reference/board#get-1-boards-board-id-myprefs
       def board_preferences(board_id, options = {})
         board_resource(board_id, "my_prefs", options)
       end
 
       # Retrieve a board's organization
       #
-      # @see https://trello.com/docs/api/board/index.html#get-1-boards-board-id-organization
+      # @see https://developers.trello.com/advanced-reference/board#get-1-boards-board-id-organization
       def board_organization(board_id, options = {})
         board_resource(board_id, "organization", options)
       end
 
       # Update board attributes
       #
-      # @see https://trello.com/docs/api/board/index.html#put-1-boards-board-id
+      # @see https://developers.trello.com/advanced-reference/board#put-1-boards-board-id
       def update_board(board_id, options = {})
         put board_path(board_id), options
       end
 
       # Add a member to a board
       #
-      # @see https://trello.com/docs/api/board/index.html#put-1-boards-board-id-members-idmember
+      # @see https://developers.trello.com/advanced-reference/board#put-1-boards-board-id-members-idmember
       def add_board_member(board_id, email, full_name, options = {})
         options.update \
           email: email,
@@ -91,7 +91,7 @@ module Tacokit
 
       # Update a board member's type
       #
-      # @see https://trello.com/docs/api/board/index.html#put-1-boards-board-id-members-idmember
+      # @see https://developers.trello.com/advanced-reference/board#put-1-boards-board-id-members-idmember
       def update_board_member(board_id, member_id, type)
         update_board_resource(board_id, "members", member_id, type: type)
       end