tacokit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2578b367de9a2fa3604a9942c8605949fbe319a
+  data.tar.gz: c78e9ff1f74434acd490dbe1aacc4eb9dac5c579
+SHA512:
+  metadata.gz: 510e5322ab2146b830db7124c8f644a5e7d2b35fc3a9c2ee2f2f8750690ae23103142d537040118d3329632cc8ff78147b63036a1ab99beafe2ddd06f2eb9c72
+  data.tar.gz: 2487e3e8af3c5f79a54555ce7c8021bc7417f20398bed4a787ab08f1e8f819ac780a0aaacf41ca17f9723c56864381e4533f0510821153ee88a925db41d4067b

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.env
+.env.development

data/.pryrc

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+Bundler.setup
+require 'dotenv'
+Dotenv.load(
+  File.expand_path("../.env",  __FILE__),
+  File.expand_path("../.env.development",  __FILE__)
+)

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - ruby-head
+
+bundler_args: --without development --retry=3 --jobs=3
+
+env:
+  # global:
+  #   - TRELLO_APP_KEY='tacokit-app-key'
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true

data/Gemfile

@@ -0,0 +1,28 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'awesome_print', :require => 'ap'
+  gem 'guard-rspec'
+  gem 'pry'
+  gem 'pry-byebug', :platforms => :ruby_21
+
+  gem 'oauth'
+  gem 'sinatra'
+end
+
+group :test do
+  # gem 'coveralls', :require => false
+  # gem 'json', '~> 1.7', :platforms => [:ruby_18, :jruby]
+  # gem 'mime-types', '< 2.0.0'
+  # gem 'netrc', '~> 0.7.7'
+  gem 'dotenv'
+  gem 'launchy'
+  gem 'rb-fsevent'
+  gem 'rspec'
+  gem 'simplecov', :require => false
+  gem 'vcr'
+  gem 'webmock'
+  gem 'rake'
+end

data/Guardfile

@@ -0,0 +1,12 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "ostruct"
+
+  rspec = OpenStruct.new
+  rspec.spec = ->(m) { "spec/#{m}_spec.rb" }
+  rspec.spec_dir = "spec"
+  rspec.spec_helper = "spec/spec_helper.rb"
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| rspec.spec.(m[1]) }
+  watch(rspec.spec_helper)      { rspec.spec_dir }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Ross Kaffenberger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,134 @@
+# Tacokit
+
+[![Build Status](https://travis-ci.org/rossta/tacokit.rb.svg?branch=master)](https://travis-ci.org/rossta/tacokit.rb) [![Code Climate](https://codeclimate.com/github/rossta/tacokit.rb/badges/gpa.svg)](https://codeclimate.com/github/rossta/tacokit.rb) [![Dependency Status](https://gemnasium.com/rossta/tacokit.rb.svg)](https://gemnasium.com/rossta/tacokit.rb)
+
+Ruby toolkit for the Trello API... a work-in-progress. Design and philosophy
+inspired by [ocktokit.rb](https://github.com/ocktokit/ocktokit.rb)
+
+This is Taco.
+
+![Taco][taco]
+[taco]: http://cl.ly/image/2p1x3K1X160b/taco.png
+
+## Quick Start
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tacokit'
+```
+
+... or install it yourself as:
+
+    $ gem install tacokit
+
+Configure the client with public-read application credentials:
+
+```ruby
+# View an app key and secret on Trello
+Tacokit.open_app_key
+
+# Configure the client
+Tacokit.configure do |c|
+  c.app_key = '4ppk3y'
+end
+```
+
+Make requests to Trello API methods using module-level configuration or as
+client instance methods.
+```ruby
+# Fetch the current member
+Tacokit.member
+
+# Fetch another member
+Tacokit.member 'tacokit'
+
+# Configure a separate client
+client = Tacokit::Client.new app_key: '4ppk3y'
+
+# Fetch a member
+client.member 'tacokit'
+```
+## Authentication
+
+### Application Authorization
+
+Trello supports application-level client authorization via an application key and application token.
+
+Tacokit provides a simple way to retrieve your application key:
+
+```ruby
+# Install the `launchy` gem to load the Trello page automatically
+Tacokit.open_app_key
+```
+Your application key are available by logging into Trello and visiting the [app key](https://trello.com/app-key) page. This page also provides your application secret that can be used to generate OAuth token access (see below).
+
+The application token, generated separately from the app key, can be associated with a `scope` and `expiration`. See the Trello [authorization docs](https://trello.com/docs/gettingstarted/authorize.html) for more info on token params.
+
+Tacokit provides a simple way to generate a new app token:
+
+```ruby
+# Full permissions for 30 days
+Tacokit.authorize scope: %w[ read write account ], expiration: '30days'
+
+# Authorize a custom application and a different app key
+Tacokit.authorize name: 'My Trello App', key: '4ppk3y2'
+
+# Read only permissions for custom app forever
+Tacokit.authorize scope: 'read', expiration: 'never', name: 'My Trello App'
+```
+
+Your Tacokit client can now be configured to make requests:
+
+```ruby
+# Configure the client
+Tacokit.configure do |c|
+  c.app_key   = '4ppk3y'
+  c.app_token = '4ppt0k3n'
+end
+```
+
+More information is available in the [Trello docs](https://trello.com/docs/index.html).
+
+### OAuth Authorization
+
+The Trello API provides OAuth 1.0 credentials through the typical OAuth web
+flow. Tacokit clients can therefore be configured separately to make requests on
+behalf of different members:
+
+```ruby
+client = Tacokit::Client.new app_key: '4ppk3y', oauth_token: '04utht0k3n'
+```
+
+To experiment with OAuth tokens for development, visit the [Tacokit
+Sandbox](https://tacokit.herokuapp.com) and enter your Trello app key and app secret.
+
+#### 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)
+* Check out the [Trello OAuth docs](https://trello.com/docs/gettingstarted/oauth.html)
+
+### Using ENV variables
+
+Default Tacokit client values can be set by values in ENV:
+
+```shell
+TRELLO_APP_KEY=4ppk3y
+TRELLO_APP_SECRET=4pps3cr3t
+TRELLO_APP_TOKEN=4ppt0k3n
+```
+
+## Usage
+
+Coming soon.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/tacokit/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/config.ru

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+Bundler.setup
+require 'dotenv'
+Dotenv.load(File.expand_path("../.env",  __FILE__))
+
+require './app'
+run TrelloOauth

data/lib/tacokit/authorization.rb

@@ -0,0 +1,46 @@
+module Tacokit
+  module Authorization
+
+    def open_app_key
+      open_url web_url("appKey/generate")
+    end
+
+    # Params
+    # callback_method: "postMessage" or "fragment"
+    # return_url: URL the token should be returned to
+    # scope: Comma-separated list of one or more of "read", "write", "account"
+    # expiration: "1hour", "1day", "30days", "never"
+    # name: Name of the application
+    # key: Application key
+    #
+    def authorize(params = {})
+      open_url authorize_url(params)
+    end
+
+    def authorize_url(params = {})
+      params[:key] ||= app_key
+      params[:name] ||= 'Tacokit'
+      params[:response_type] ||= 'token'
+      web_url "authorize", params
+    end
+
+    private
+
+    def open_url(url)
+      require 'launchy'
+      Launchy.open(url)
+    rescue LoadError
+      warn "Visit #{url}"
+      warn "Please install the launchy gem to open the url automatically."
+    end
+
+    def web_url(path, params = {})
+      web_connection.build_url(path, params).to_s
+    end
+
+    def web_connection
+      Faraday::Connection.new(web_endpoint)
+    end
+
+  end
+end

data/lib/tacokit/client/actions.rb

@@ -0,0 +1,54 @@
+module Tacokit
+  class Client
+    module Actions
+
+      # GET /1/actions/[idAction]
+      def action(action_id, options = nil)
+        get action_path(action_id), options
+      end
+
+      # GET /1/actions/[idAction]/[field]
+      def action_field(action_id, field)
+        get action_path(action_id, camp(field))
+      end
+
+      # GET /1/actions/[idAction]/[resource]
+      # board
+      # board/[field]
+      # card
+      # card/[field]
+      # entities
+      # list
+      # list/[field]
+      # member
+      # member/[field]
+      # memberCreator
+      # memberCreator/[field]
+      # organization
+      # organization/[field]
+      def action_resource(action_id, resource, *paths)
+        paths, options = extract_options(camp(resource), *paths)
+        get action_path(action_id, *paths), options
+      end
+
+      # PUT /1/actions/[idAction]
+      def update_action(action_id, options = {})
+        put action_path(action_id), options
+      end
+
+      # PUT /1/actions/[idAction]/text
+      def update_action_text(action_id, text)
+        put action_path(action_id, 'text'), value: text
+      end
+
+      # DELETE /1/actions/[idAction]
+      def delete_action(action_id)
+        delete action_path(action_id)
+      end
+
+      def action_path(*paths)
+        path_join("actions", *paths)
+      end
+    end
+  end
+end

data/lib/tacokit/client/boards.rb

@@ -0,0 +1,124 @@
+module Tacokit
+  class Client
+    module Boards
+
+      # GET /1/boards/[board_id]
+      def board(board_id, options = nil)
+        get board_path(board_id), options
+      end
+
+      # GET /1/boards/[board_id]/[field]
+      def board_field(board_id, field, options = nil)
+        get board_path(board_id, camp(field)), options
+      end
+
+      # GET /1/boards/[board_id]/[resource]
+      # actions
+      # boardStars
+      # cards
+      # cards/[filter]
+      # cards/[idCard]
+      # checklists
+      # deltas
+      # labels
+      # labels/[idLabel]
+      # lists
+      # lists/[filter]
+      # members
+      # members/[filter]
+      # members/[idMember]/cards
+      # membersInvited
+      # membersInvited/[field]
+      # memberships
+      # memberships/[idMembership]
+      # myPrefs
+      # organization
+      # organization/[field]
+      def board_resource(board_id, resource, *paths)
+        paths, options = extract_options(camp(resource), *paths)
+        get board_path(board_id, *paths), options
+      end
+
+      # PUT /1/boards/[board_id]
+      def update_board(board_id, options = {})
+        put board_path(board_id), options
+      end
+
+      # PUT /1/boards/[board_id]/[field]
+      # closed
+      # desc
+      # idOrganization
+      # labelNames/blue
+      # labelNames/green
+      # labelNames/orange
+      # labelNames/purple
+      # labelNames/red
+      # labelNames/yellow
+      # myPrefs/emailPosition
+      # myPrefs/idEmailList
+      # myPrefs/showListGuide
+      # myPrefs/showSidebar
+      # myPrefs/showSidebarActivity
+      # myPrefs/showSidebarBoardActions
+      # myPrefs/showSidebarMembers
+      # name
+      # prefs/background
+      # prefs/calendarFeedEnabled
+      # prefs/cardAging
+      # prefs/cardCovers
+      # prefs/comments
+      # prefs/invitations
+      # prefs/permissionLevel
+      # prefs/selfJoin
+      # prefs/voting
+      # subscribed
+      def update_board_field(board_id, *paths)
+        value = paths.pop
+        put board_path(board_id, camel_join(*paths)), value: value
+      end
+
+      # PUT /1/boards/[board_id]/members
+      def add_board_member(board_id, email, full_name, options = {})
+        options.update \
+          email: email,
+          full_name: full_name
+        put board_path(board_id, "members"), options
+      end
+
+      # PUT /1/boards/[board_id]/[resource]
+      # members/[idMember]
+      # memberships/[idMembership]
+      def update_board_resource(board_id, resource, resource_id, options = {})
+        put board_path(board_id, camp(resource), resource_id), options
+      end
+
+      # POST /1/boards
+      def create_board(name, options = {})
+        post board_path, options.merge(name: name)
+      end
+
+      # POST /1/boards/[board_id]/[resource]
+      # calendarKey/generate
+      # checklists
+      # emailKey/generate
+      # labels
+      # lists
+      # markAsViewed
+      # powerUps
+      def create_board_resource(board_id, resource, *paths)
+        paths, options = extract_options(camp(resource), *paths)
+        post board_path(board_id, *paths), options
+      end
+
+      # DELETE /1/boards/[board_id]/[resource]/[resource_id]
+      # members/[idMember]
+      # powerUps/[powerUp]
+      #
+
+      def board_path(*paths)
+        path_join("boards", *paths)
+      end
+
+    end
+  end
+end

data/lib/tacokit/client/cards.rb

@@ -0,0 +1,143 @@
+module Tacokit
+  class Client
+    module Cards
+
+      # GET cards/[card id or shortlink]
+      def card(card_id, options = nil)
+        get card_path(card_id), options
+      end
+
+      # GET cards/[card id or shortlink]/[field]
+      # badges
+      # checkItemStates
+      # closed
+      # dateLastActivity
+      # desc
+      # descData
+      # due
+      # email
+      # idAttachmentCover
+      # idBoard
+      # idChecklists
+      # idLabels
+      # idList
+      # idMembers
+      # idMembersVoted
+      # idShort
+      # labels
+      # manualCoverAttachment
+      # name
+      # pos
+      # shortLink
+      # shortUrl
+      # subscribed
+      # url
+      def card_field(card_id, field, options = nil)
+        get card_path(card_id, camp(field)), options
+      end
+
+      # GET cards/[card id or shortlink]/[resource]
+      # actions
+      # attachments
+      # attachments/[idAttachment]
+      # board
+      # board/[field]
+      # checkItemStates
+      # checklists
+      # list
+      # list/[field]
+      # members
+      # membersVoted
+      # stickers
+      # stickers/[idSticker]
+      def card_resource(card_id, resource, options = {})
+        get card_path(card_id, camp(resource)), options
+      end
+
+      # PUT cards/[card id or shortlink]
+      def update_card(card_id, options = {})
+        put card_path(card_id), options
+      end
+
+      # PUT cards/[card id or shortlink]/[resource]
+      # actions/[idAction]/comments
+      # checklist/[idChecklist]/checkItem/[idCheckItem]/name
+      # checklist/[idChecklist]/checkItem/[idCheckItem]/pos
+      # checklist/[idChecklist]/checkItem/[idCheckItem]/state
+      # checklist/[idChecklistCurrent]/checkItem/[idCheckItem]
+      # closed
+      # desc
+      # due
+      # idAttachmentCover
+      # idBoard
+      # idList
+      # idMembers
+      # labels
+      # name
+      # pos
+      # stickers/[idSticker]
+      # subscribed
+
+      # POST cards
+      def create_card(list_id, name = nil, options = {})
+        post card_path, options.merge(name: name, list_id: list_id)
+      end
+
+      # POST cards/[card id or shortlink]/actions/comments
+      def create_card_comment(card_id, text, options = {})
+        options.update text: text
+        create_card_resource card_id, "actions", "comments", options
+      end
+
+      # POST cards/[card id or shortlink]/attachments
+      def create_card_attachment(card_id, url, mime_type = nil, options = {})
+        uri = Addressable::URI.parse(url)
+
+        if uri.scheme =~ %r{https?}
+          options.update url: uri.to_s, mime_type: mime_type
+        else
+          file = Faraday::UploadIO.new(uri.to_s, mime_type)
+          options.update file: file, mime_type: file.content_type
+        end
+
+        create_card_resource card_id, 'attachments', options
+      end
+
+      # POST cards/[card id or shortlink]/[resource]
+      # checklist/[idChecklist]/checkItem
+      # checklist/[idChecklist]/checkItem/[idCheckItem]/convertToCard
+      # checklists
+      # idMembers
+      # labels
+      # markAssociatedNotificationsRead
+      # membersVoted
+      # stickers
+      def create_card_resource(card_id, resource, *paths)
+        paths, options = extract_options(camp(resource), *paths)
+        post card_path(card_id, *paths), options
+      end
+
+      # DELETE cards/[card id or shortlink]
+      def delete_card(card_id)
+        delete card_path(card_id)
+      end
+
+      # DELETE cards/[card id or shortlink]/[resource]
+      # actions/[idAction]/comments
+      # attachments/[idAttachment]
+      # checklist/[idChecklist]/checkItem/[idCheckItem]
+      # checklists/[idChecklist]
+      # idMembers/[idMember]
+      # labels/[color]
+      # membersVoted/[idMember]
+      # stickers/[idSticker]
+      def delete_card_resource(card_id, resource, *paths)
+        delete card_path(card_id, camp(resource), *paths)
+      end
+
+      def card_path(*paths)
+        path_join "cards", *paths
+      end
+    end
+  end
+end