tacokit 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2578b367de9a2fa3604a9942c8605949fbe319a
-  data.tar.gz: c78e9ff1f74434acd490dbe1aacc4eb9dac5c579
+  metadata.gz: 14ef84fc424d2cad14b4ea5ff37a270d9e3b5399
+  data.tar.gz: 130dd7e3aa458418bfb83f945026edb91f272286
 SHA512:
-  metadata.gz: 510e5322ab2146b830db7124c8f644a5e7d2b35fc3a9c2ee2f2f8750690ae23103142d537040118d3329632cc8ff78147b63036a1ab99beafe2ddd06f2eb9c72
-  data.tar.gz: 2487e3e8af3c5f79a54555ce7c8021bc7417f20398bed4a787ab08f1e8f819ac780a0aaacf41ca17f9723c56864381e4533f0510821153ee88a925db41d4067b
+  metadata.gz: 6fcc934c4029cabdcbb49827c3598b66daa1774b6e10346f8f5cb3be8371baf56c5fe685757f5e81e71003674eee75551452c05eefd790dc39a8731105460243
+  data.tar.gz: 2b974070b2c21ef16b3cd0535a9142da22e657a0e459aa08b753fe8881d14ad37c29719919725ed57273822fd2a570a15779cabd89e87511bb02fd502068962e

data/.rubocop.yml

@@ -0,0 +1,86 @@
+AllCops:
+  Exclude:
+    - "Guardfile"
+    - "spec/cassettes/**/*"
+    - "vendor/**/*"
+
+Lint/UnusedBlockArgument:
+  Enabled: false
+#
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 150 # TODO: we should decrease this to 120
+
+Metrics/ClassLength:
+  Max: 300
+
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/ParameterLists:
+  Max: 8
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/AndOr:
+  Enabled: false
+
+Style/Not:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Documentation:
+  Enabled: false # TODO: Enable again once we have more docs
+
+Style/CaseIndentation:
+  IndentWhenRelativeTo: case
+  SupportedStyles:
+    - case
+    - end
+  IndentOneStep: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%w": "[]"
+    "%W": "[]"
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: indent
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Style/IndentationWidth:
+  Enabled: false
+
+Lint/EndAlignment:
+  AlignWith: variable
+
+Lint/DefEndAlignment:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Enabled: false

data/.travis.yml

@@ -6,8 +6,14 @@ rvm:
   - 2.1
   - ruby-head
 
+sudo: false
+cache: bundler
+
 bundler_args: --without development --retry=3 --jobs=3
 
+script:
+  - bundle exec rake
+
 env:
   # global:
   #   - TRELLO_APP_KEY='tacokit-app-key'

data/Gemfile

@@ -1,28 +1,19 @@
-source 'https://rubygems.org'
+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
+gem "awesome_print", require: "ap"
+gem "coveralls", require: false
+gem "dotenv"
+gem "guard-rspec"
+gem "launchy"
+gem "oauth"
+gem "pry"
+gem "pry-byebug", platforms: :ruby_21
+gem "rake"
+gem "rb-fsevent"
+gem "rspec"
+gem "rubocop"
+gem "sinatra"
+gem "vcr"
+gem "webmock"

data/Guardfile

@@ -1,4 +1,4 @@
-guard :rspec, cmd: "bundle exec rspec" do
+guard :rspec, cmd: "bundle exec rspec --format progress" do
   require "ostruct"
 
   rspec = OpenStruct.new

data/README.md

@@ -1,6 +1,6 @@
 # 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)
+[![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) [![Coverage Status](https://coveralls.io/repos/rossta/tacokit.rb/badge.svg)](https://coveralls.io/r/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)
@@ -12,10 +12,10 @@ This is Taco.
 
 ## Quick Start
 
-Add this line to your application's Gemfile:
+Add this line to your application"s Gemfile:
 
 ```ruby
-gem 'tacokit'
+gem "tacokit"
 ```
 
 ... or install it yourself as:
@@ -26,11 +26,11 @@ Configure the client with public-read application credentials:
 
 ```ruby
 # View an app key and secret on Trello
-Tacokit.open_app_key
+Tacokit.get_app_key
 
 # Configure the client
 Tacokit.configure do |c|
-  c.app_key = '4ppk3y'
+  c.app_key = "4ppk3y"
 end
 ```
 
@@ -41,13 +41,13 @@ client instance methods.
 Tacokit.member
 
 # Fetch another member
-Tacokit.member 'tacokit'
+Tacokit.member "tacokit"
 
 # Configure a separate client
-client = Tacokit::Client.new app_key: '4ppk3y'
+client = Tacokit::Client.new app_key: "4ppk3y"
 
 # Fetch a member
-client.member 'tacokit'
+client.member "tacokit"
 ```
 ## Authentication
 
@@ -59,7 +59,7 @@ 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
+Tacokit.get_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).
 
@@ -69,13 +69,13 @@ 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'
+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'
+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'
+Tacokit.authorize scope: "read", expiration: "never", name: "My Trello App"
 ```
 
 Your Tacokit client can now be configured to make requests:
@@ -83,8 +83,8 @@ 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'
+  c.app_key   = "4ppk3y"
+  c.app_token = "4ppt0k3n"
 end
 ```
 
@@ -97,7 +97,7 @@ 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'
+client = Tacokit::Client.new app_key: "4ppk3y", oauth_token: "04utht0k3n"
 ```
 
 To experiment with OAuth tokens for development, visit the [Tacokit
@@ -123,12 +123,56 @@ TRELLO_APP_TOKEN=4ppt0k3n
 
 ## Usage
 
-Coming soon.
+Working with boards
+
+```ruby
+client.boards
+
+client.boards("rossta")
+
+board_id = "swezQ9XS" # short link to "Test Board" for Tacokit
+
+board = client.board(board_id)
+
+board.name = "Ice Box"
+
+client.update_board(board.id, name: "TODO")
+```
+
+Working with cards
+
+```ruby
+client.cards
+
+client.cards("rossta")
+
+client.board_cards(board_id)
+
+card_id = "SpbauOpX" # short link to card on "Test Board"
+
+card.name = "Shopping List"
+
+client.update_card(card.id, name: "Wish List")
+
+client.move_card(card.id, list_id: list_id)
+```
+
+Working with lists
+
+```ruby
+client.lists(board_id)
+
+list = client.list(list_id)
+
+list.name = "Work in Progress"
+
+client.update_list(list.id, name: "Done")
+```
 
 ## 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'`)
+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

@@ -1,8 +1,13 @@
-require 'bundler'
+require "bundler"
 Bundler::GemHelper.install_tasks
 
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--color --format progress"
+end
 
-task :test => :spec
-task :default => :spec
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+task test: [:spec, :rubocop]
+task default: [:spec, :rubocop]

data/lib/tacokit/authorization.rb

@@ -1,33 +1,35 @@
 module Tacokit
   module Authorization
-
-    def open_app_key
+    def get_app_key # rubocop:disable Style/AccessorMethodName
       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
+    # Get a token for making authorized requests to the Trello API
     #
+    # @param [String, #read] contents the contents to reverse
+    # @param options [Hash] Repository information to update
+    # @option options [String] :name Name of the application
+    # @option options [String] :key Application key
+    # @option options [String] :callback_method "postMessage" or "fragment"
+    # @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
     def authorize(params = {})
       open_url authorize_url(params)
     end
 
     def authorize_url(params = {})
       params[:key] ||= app_key
-      params[:name] ||= 'Tacokit'
-      params[:response_type] ||= 'token'
+      params[:name] ||= "Tacokit"
+      params[:response_type] ||= "token"
       web_url "authorize", params
     end
 
     private
 
     def open_url(url)
-      require 'launchy'
+      require "launchy"
       Launchy.open(url)
     rescue LoadError
       warn "Visit #{url}"
@@ -41,6 +43,5 @@ module Tacokit
     def web_connection
       Faraday::Connection.new(web_endpoint)
     end
-
   end
 end

data/lib/tacokit/client/actions.rb

@@ -1,51 +1,91 @@
 module Tacokit
   class Client
     module Actions
-
-      # GET /1/actions/[idAction]
+      # Retrieve an action
+      #
+      # @see https://trello.com/docs/api/action/index.html#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
+      # Retrieve an action's board
+      #
+      # @see https://trello.com/docs/api/action/index.html#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
+      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
+      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
+      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
+      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
+      def action_member_creator(action_id, fields = "all")
+        action_resource action_id, "memberCreator", fields: fields
       end
 
-      # PUT /1/actions/[idAction]
+      # Retrieve an action's org
+      #
+      # @see https://trello.com/docs/api/action/index.html#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
       def update_action(action_id, options = {})
         put action_path(action_id), options
       end
 
-      # PUT /1/actions/[idAction]/text
+      # Set new text for an action
+      #
+      # @see https://trello.com/docs/api/action/index.html#put-1-actions-idaction-text
       def update_action_text(action_id, text)
-        put action_path(action_id, 'text'), value: text
+        put action_path(action_id, "text"), value: text
       end
+      alias_method :edit_action_text, :update_action_text
 
-      # DELETE /1/actions/[idAction]
+      # Delete an action
+      #
+      # @see https://trello.com/docs/api/action/index.html#delete-1-actions-idaction
       def delete_action(action_id)
         delete action_path(action_id)
       end
 
+      private
+
+      def action_resource(action_id, resource, *paths)
+        paths, options = extract_options(camp(resource), *paths)
+        get action_path(action_id, *paths), options
+      end
+
       def action_path(*paths)
         path_join("actions", *paths)
       end