tacokit 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 893e6fcc338a5577d85ae6aeab7d2abd37aba994
-  data.tar.gz: 31289e149b682205ca77126dd117ba03ec0fcc52
+  metadata.gz: f04b3d5706a939e80215228ad9189924458855ad
+  data.tar.gz: bbb0d40148e65c9b4a3b08d758088dc3c54448ff
 SHA512:
-  metadata.gz: 7daa990bf2a35abd1f69d58be4250023c1ed4b4f042ce6b23e4d162faa7e51f7e4f09c51adde90cd0de9ee60e79802d0c596b1a3656616ce7f23a858631a4bfa
-  data.tar.gz: 5d52cafaf8d20fd5602fe41015c75112776c98322a7bec1380389bad48c39368b03d5b5dc64812b69b734a8aeca9948431ab005d344ed124d031fab97867a23b
+  metadata.gz: d02daaf1940fd81848461fc0b549f11c485365111a1c79cd390e522028572551cc422bc08fda9491cd53fb87e07eb32629a09310a897fe553c511e7204ad5b32
+  data.tar.gz: 035b1be4fd4623497df3c3f55ba4cff1636fa0eec5a0be68648945d245e505b76e0df19cc33d080508e4cea77d25e22bd85c45e807350ba8eb549382d218fae5

data/.gitignore

@@ -14,4 +14,5 @@
 mkmf.log
 .env
 .env.development
+.env.test
 .ruby-version

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   Exclude:
+    - "bin/**"
     - "Guardfile"
     - "spec/cassettes/**/*"
     - "vendor/**/*"
@@ -52,6 +53,9 @@ Style/Not:
 Style/DoubleNegation:
   Enabled: false
 
+Style/ParallelAssignment:
+  Enabled: false
+
 Documentation:
   Enabled: false # TODO: Enable again once we have more docs
 

data/.travis.yml

@@ -4,11 +4,14 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1
+  - 2.2
+  - 2.3.0
   - ruby-head
 
 sudo: false
 cache: bundler
 
+before_install: gem install bundler -v 1.11.2
 bundler_args: --without development --retry=3 --jobs=3
 
 script:

data/Gemfile

@@ -9,7 +9,7 @@ gem "guard-rspec"
 gem "launchy"
 gem "oauth"
 gem "pry"
-gem "pry-byebug", platforms: :ruby_21
+gem "pry-byebug", platforms: [:ruby_21, :ruby_22]
 gem "rake"
 gem "rb-fsevent"
 gem "rspec", "~> 3.3"
@@ -18,3 +18,4 @@ gem "sinatra"
 gem "vcr"
 gem "webmock"
 gem "multi_json"
+gem "yard"

data/README.md

@@ -7,12 +7,11 @@ inspired by [ocktokit.rb](https://github.com/ocktokit/ocktokit.rb)
 
 This is Taco.
 
-![Taco][taco]
-[taco]: http://cl.ly/image/2p1x3K1X160b/taco.png
+![Taco](http://cl.ly/image/2p1x3K1X160b/taco.png)
 
 ## Quick Start
 
-Add this line to your application"s Gemfile:
+Add this line to your application's Gemfile:
 
 ```ruby
 gem "tacokit"
@@ -20,7 +19,9 @@ gem "tacokit"
 
 ... or install it yourself as:
 
-    $ gem install tacokit
+```
+$ gem install tacokit
+```
 
 Configure the client with public-read application credentials:
 
@@ -34,8 +35,8 @@ Tacokit.configure do |c|
 end
 ```
 
-Make requests to Trello API methods using module-level configuration or as
-client instance methods.
+Make requests to Trello API methods using module-level configuration or as client instance methods.
+
 ```ruby
 # Fetch the current member
 Tacokit.member
@@ -49,6 +50,7 @@ client = Tacokit::Client.new app_key: "4ppk3y"
 # Fetch a member
 client.member "tacokit"
 ```
+
 ## Authentication
 
 ### Application Authorization
@@ -103,9 +105,9 @@ 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). 
+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
 
@@ -119,10 +121,10 @@ For more information on setting up Trello OAuth for your web application
 
 Default Tacokit client values can be set by values in ENV:
 
-```shell
-TRELLO_APP_KEY=4ppk3y
-TRELLO_APP_SECRET=4pps3cr3t
-TRELLO_APP_TOKEN=4ppt0k3n
+```ruby
+export TRELLO_APP_KEY=4ppk3y
+export TRELLO_APP_SECRET=4pps3cr3t
+export TRELLO_APP_TOKEN=4ppt0k3n
 ```
 
 ## Usage
@@ -131,82 +133,173 @@ All requests are called on instances of a `Tacokit::Client`. Most return a `Taco
 
 ### Boards
 
+Board endpoints typically take a board id, short url, or board resource as the first argument.
+
+See the client [Board docs](https://rossta.net/tacokit.rb/Tacokit/Client/Boards.html) for more details.
+
 ```ruby
-board = client.board(board_id) # retrieve board resource by board id
+# retrieve board resource by board id
+board = client.board(board_id)
 # => {:id=>"54...", :name=>"Work in Progress", ... }
 
+# access card attributes by message sending
 board.name
 # => "Work in Progress"
 
-client.boards # retrieve boards for client account
+# retrieve boards for client account
+boards = client.boards
 # => [{:id=>"54...", :name=>"Work in Progress", ... }, {...}]
 
-client.boards("rossta") # retrieve board for user 'rossta'
+# retrieve board for user 'rossta'
+boards = client.boards("rossta")
 # => [{:id=>"32...", :name=>"Tacokit Ideas", ... }, {...}]
 
-client.update_board(board, name: "TODO") # change board attributes
+# change board attributes
+board = client.update_board(board, name: "TODO")
 # => {:id=>"54...", :name=>"TODO", ... }
 
-client.add_board_member(board, 'rosskaff@gmail.com', 'Ross Kaffenberger') # add
-me to your card
+# retrieve lists for a board
+client.lists(board)
+# => [{:id=>"56...", :name=>"Blocked", ... }, {...}]
+
+# retrieve cards for a board
+client.board_cards(board)
+# => [{:id# =>"56...", :name# =>"Another Card", ... }, {...}]
 
-client.create_board("All We Need is Love") # all you need is a name
+# add me to your card
+client.add_board_member(board, 'rosskaff@gmail.com', 'Ross Kaffenberger')
+
+# all you need is a name
+client.create_board("All We Need is Love")
 ```
 
 ### Cards
 
-```ruby
-card = client.card(card_id) # retrieve card by card id
-# => {:id=>"12...", :name=>"Call Mom", ... }
+Card endpoints typically take a card id, short url, or card resource as the first argument.
 
-card.name
-# => "Call Mom"
-
-client.cards # retrieve cards for client account
-# => [{:id=>"12...", :name=>"Call Mom", ... }, {...}]
+See the client [Card docs](https://rossta.net/tacokit.rb/Tacokit/Client/Cards.html) for more details.
 
-client.cards("rossta") # retrieve cards for user 'rossta'
-# => [{:id=>"34...", :name=>"Buy Milk", ... }, {...}]
+```ruby
+# retrieve card by card id
+card = client.card(card_id)
+# => {:id# =>"12...", :name# =>"Call Mom", ... }
 
-client.board_cards(board) # retrieve cards for a board
-# => [{:id=>"56...", :name=>"Another Card", ... }, {...}]
+# access card attributes by message sending
+card.name
+# => "Call wife"
 
-client.update_card(card, name: "Wish List") # change card attributes
-# => {:id=>"12...", :name=>"Wish List", ... }
+# change card attributes
+card = client.update_card(card, name: "Wish List")
+# => {:id# =>"12...", :name# =>"Wish List", ... }
 
-client.move_card(card, list_id: list_id) # move card to another list
+# move card to another list
+client.move_card(card, list_id: list_id)
 
-client.card_members(card) # retrieve members assigned to card
+# retrieve members assigned to card
+client.card_members(card)
 
-client.attach_file(card, "https://pbs.twimg.com/media/CCKtnZmUsAEUAX2.jpg:large") # attach by url or file path
+# attach by url or file path
+client.attach_file(card, "https://pbs.twimg.com/media/CCKtnZmUsAEUAX2.jpg:large")
 
-client.add_comment(card, "Nice jorb!") # troll cards
+# add comment to a card
+client.add_comment(card, "Nice jorb!")
 
-client.subscribe_to_card(card) # keep client account notified
+# receive notifications for card updates
+client.subscribe_to_card(card)
 
-client.archive_card(card) # send card into the abyss
+# send card into the abyss
+client.archive_card(card)
 
-client.restore_card(card) # save card back from the abyss
+# bring card back from the abyss
+client.restore_card(card)
 ```
 
 ### Lists
 
+List endpoints typically take a list id or list resource as the first argument.
+
+See the client [List docs](https://rossta.net/tacokit.rb/Tacokit/Client/Lists.html) for more details.
+
 ```ruby
-list = client.list(list_id) # retrieve list by a list id
+# retrieve list by a list id
+list = client.list(list_id)
 # => {:id=>"78...", :name=>"Ready", ... }
 
+# access card attributes by message sending
 list.name
 # => "Ready"
 
-client.lists(board) # retrieve lists for a board
-# => [{:id=>"56...", :name=>"Blocked", ... }, {...}]
-
-client.update_list(list, name: "Done") # change list attributes
+# change list attributes
+client.update_list(list, name: "Done")
 # => {:id=>"78...", :name=>"Done", ... }
 
-client.create_list(board.id, "Finished") # add a new list to a board
+# add a new list to a board
+client.create_list(board.id, "Finished")
+# => {:id => "89...", :name=>"Finished", ... }
+
+# send all list cards to the abyss
+client.archive_list_cards(list)
+```
 
-client.archive_list_cards(list) # send all list cards to the abyss
+### Members
+
+Most of the client member endpoints take an optional member name as the first argument. In many cases, the name can be omitted where it is assumed to be the current member (also given as "me").
+
+See the client [Member docs](https://rossta.net/tacokit.rb/Tacokit/Client/Members.html) for more details.
+
+```ruby
+# Retrieve current member
+me = client.member
+# => {:id=>"548a6696b3b9918beb144b07",
+# :avatar_hash=>"cb0df45055bac84e7c5fb728e00e2015",
+# :bio=>"Tacokit puts the Trello API on Ruby",
+# ... }
+
+# Also
+me = client.member("me")
+# => {:id=>"548a6696b3b9918beb144b07",
+# :avatar_hash=>"cb0df45055bac84e7c5fb728e00e2015",
+# :bio=>"Tacokit puts the Trello API on Ruby",
+# ... }
+
+# Another member
+rossta = client.member("rossta")
+# => {:id=>"4f079adc73668b244b1c099a",
+# :avatar_hash=>"706e95e427f91670bf21eee6afccee90",
+# :bio=>"I write about all things web on rossta.net",
+# ... }
+
+# Retrieve my open boards, just the short links and names,
+boards = client.boards(filter: "open", fields: %w[name short_url])
+
+# Retrieve rossta's public boards with the organization embedded
+boards = client.boards("rossta", filter: "public", organization: true)
+
+# retrieve cards for client account
+cards = client.cards
+# => [{:id=>"12...", :name=>"Call Mom", ... }, {...}]
+
+# retrieve cards for user 'rossta'
+cards = client.cards("rossta")
+# => [{:id=>"34...", :name=>"Buy Milk", ... }, {...}]
+```
+
+### Search
+
+See the client [Search docs](https://rossta.net/tacokit.rb/Tacokit/Client/Searches.html) for more details.
+
+```ruby
+Tacokit.search("rossta")
+# => {:options=>
+# {:terms=>[{:text=>"rossta"}],
+#   :modifiers=>[],
+#   :model_types=>["actions", "cards", "boards", "organizations", "members"],
+#   :partial=>false},
+# :members=>
+#  [{:id=>"4f079adc73668b244b1c099a",
+#    :avatar_hash=>"706e95e427f91670bf21eee6afccee90",
+#    ...}]
+#  ...}
 ```
 
 ## Contributing

data/Rakefile

@@ -11,3 +11,16 @@ RuboCop::RakeTask.new
 
 task test: [:spec, :rubocop]
 task default: [:spec, :rubocop]
+
+namespace :doc do
+  desc "Generate docs and publish to gh-pages"
+  task :publish do
+    require "fileutils"
+    sh "yard doc"
+    sh "git checkout gh-pages"
+    sh "cp -R doc/* ."
+    sh "git commit -vam 'Update documentation'"
+    sh "git push origin gh-pages"
+    sh "git checkout -"
+  end
+end

data/bin/_guard-core

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "_guard-core")

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tacokit"
+
+require "dotenv"
+Dotenv.load(
+  File.expand_path("../.env", __FILE__),
+  File.expand_path("../.env.development", __FILE__)
+)
+
+require "pry"
+
+Pry.start

data/bin/guard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "guard")

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")