asana 0.1.2 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Y2VlNTc3NDk5ZjRlMjQ2YzM0ZjdkMDExNDEwNGY3OWE4YmQwOGQ4ZA==
+    YjFiZWU3OWJjZTYxOGRkNjY1YWQ5YWQzMWYxODhjMGMyODIwNDliYg==
   data.tar.gz: !binary |-
-    NmJjOGJiOTE1N2IzNTlhOGNlMGVkMmU4NDkyMzdmOTgxYzI4NTc3Zg==
+    ZmVjOWMwNTdlMzdjNGVkNmJiZDNjZjc2OTVhZDY3YWFjMjBlYTllNw==
 SHA512:
   metadata.gz: !binary |-
-    Y2RhYzc1MWEwZWJlN2QwZTM1ZWI3MWI3NmMxMjI2YmFkZGEzMTRiMGMwZDI1
-    NWEwZDBjM2RiODE5ZTZlZTkzZDBhNzkzMDg1NzAwYzZkNzE3YzlmMDA2NTUz
-    YjE3YmY4ODU3YThhNDhjZThmODA4N2ZkZDNlZDFmOWJiNGIxMGU=
+    NTFjZTA5MWI3MDI2YjA4Zjc0YjcxODA1ZTUwZjU4M2QzMzVhZGRmNDI2Nzlh
+    YmRmYTUwYWM0NTY3MjM4ZTlhMzQxZGM1ODI3NTc4YTNiYjAyMWVhNThiZmU5
+    MTViNDNkMzkzYzZlYzcxOTJlZWI5YThiOTgyMjRmMDRiYzkyYTk=
   data.tar.gz: !binary |-
-    YWFhOWI2ZjU2YjMxYmFmNzJmYjM3NDAxODlkNWIwYWNhYWVhNzJjYmVhM2E5
-    YmJkZmIzNWE5ZTQzNjkzMTc0MDc5ZTExMGExOWE5OTNhNTRhMmI0NWU0ZTE5
-    NzA0Zjc4MmE3NDM2NGJkOGNkNDM3ZDc2YTk0NmJmOWFjOTgwZTM=
+    OWYxNzQ3NWVjNjU4OWRmYWM5YWIxN2U2OGFjZDA5ZWQ2NzRhYTcxNjBiODli
+    NTQ2MTJhMmU2N2Y0MTc4YTkyNWZhNTUyMDM2ZjlmYTI1YTFiOGU0NmQ5NTEy
+    N2IzZTJjZTc1MGY3ZDgyNDRiNWY4ZjY0NTE2M2QyM2I3YmIzNTY=

data/.rubocop.yml

@@ -8,4 +8,7 @@ AllCops:
     - 'spec/templates/unicorn.rb'
     - 'spec/templates/world.rb'
     - 'test.rb'
+
+LineLength:
+  Max: 120
 require: rubocop-rspec

data/README.md

@@ -1,5 +1,6 @@
 # Asana
 
+[![Gem Version](https://badge.fury.io/rb/asana.svg)](http://badge.fury.io/rb/asana)
 [![Build Status](https://travis-ci.org/Asana/ruby-asana.svg?branch=master)](https://travis-ci.org/Asana/ruby-asana)
 [![Code Climate](https://codeclimate.com/github/Asana/ruby-asana/badges/gpa.svg)](https://codeclimate.com/github/Asana/ruby-asana)
 [![Dependency Status](https://gemnasium.com/Asana/ruby-asana.svg)](https://gemnasium.com/Asana/ruby-asana)
@@ -39,7 +40,7 @@ The most minimal example would be as follows:
 require 'asana'
 
 client = Asana::Client.new do |c|
-  c.authentication :api_token, 'my_api_token'
+  c.authentication :access_token, 'personal_access_token'
 end
 
 client.workspaces.find_all.first
@@ -76,11 +77,11 @@ the [documentation for each of them][docs].
 
 This gem supports authenticating against the Asana API with either an API token or through OAuth2.
 
-#### API Token
+#### Personal Access Token
 
 ```ruby
 Asana::Client.new do |c|
-  c.authentication :api_token, 'my_api_token'
+  c.authentication :access_token, 'personal_access_token'
 end
 ```
 

data/examples/events.rb

@@ -3,14 +3,14 @@ require 'bundler'
 Bundler.require
 require 'asana'
 
-api_token = ENV['ASANA_API_TOKEN']
-unless api_token
-  abort "Run this program with the env var ASANA_API_TOKEN.\n"  \
-    "Go to http://app.asana.com/-/account_api to see your API token."
+access_token = ENV['ASANA_ACCESS_TOKEN']
+unless access_token
+  abort "Run this program with the env var ASANA_ACCESS_TOKEN.\n"  \
+    "Go to http://app.asana.com/-/account_api to create a personal access token."
 end
 
 client = Asana::Client.new do |c|
-  c.authentication :api_token, api_token
+  c.authentication :access_token, access_token
 end
 
 workspace = client.workspaces.find_all.first

data/examples/{api_token.rb → personal_access_token.rb}

@@ -2,14 +2,14 @@ require 'bundler'
 Bundler.require
 require 'asana'
 
-api_token = ENV['ASANA_API_TOKEN']
-unless api_token
-  abort "Run this program with the env var ASANA_API_TOKEN.\n"  \
-    "Go to http://app.asana.com/-/account_api to see your API token."
+access_token = ENV['ASANA_ACCESS_TOKEN']
+unless access_token
+  abort "Run this program with the env var ASANA_ACCESS_TOKEN.\n"  \
+    "Go to http://app.asana.com/-/account_api to create a personal access token."
 end
 
 client = Asana::Client.new do |c|
-  c.authentication :api_token, api_token
+  c.authentication :access_token, access_token
 end
 
 puts "My Workspaces:"

data/lib/asana/client.rb

@@ -8,9 +8,9 @@ module Asana
   #
   # Examples
   #
-  #   # Authentication with an API token
+  #   # Authentication with a personal access token
   #   Asana::Client.new do |client|
-  #     client.authentication :api_token, '...'
+  #     client.authentication :access_token, '...'
   #   end
   #
   #   # OAuth2 with a plain bearer token (doesn't support auto-refresh)

data/lib/asana/client/configuration.rb

@@ -5,7 +5,7 @@ module Asana
     # Examples
     #
     #   config = Configuration.new
-    #   config.authentication :api_token, 'my_api_token'
+    #   config.authentication :access_token, 'personal_access_token'
     #   config.adapter :typhoeus
     #   config.configure_faraday { |conn| conn.use MyMiddleware }
     #   config.to_h
@@ -30,8 +30,8 @@ module Asana
       # Raises ArgumentError if the arguments are invalid.
       def authentication(type, value)
         auth = case type
-               when :oauth2    then oauth2(value)
-               when :api_token then api_token(value)
+               when :oauth2 then oauth2(value)
+               when :access_token then from_bearer_token(value)
                else error "unsupported authentication type #{type}"
                end
         @configuration[:authentication] = auth
@@ -99,16 +99,6 @@ module Asana
             'containing :refresh_token or :bearer_token.'
         end
       end
-      # rubocop:enable Metrics/MethodLength
-
-      # Internal: Configures a TokenAuthentication strategy.
-      #
-      # token - [String] the API token
-      #
-      # Returns a [Authentication::TokenAuthentication] strategy.
-      def api_token(token)
-        Authentication::TokenAuthentication.new(token)
-      end
 
       # Internal: Configures an OAuth2 AccessTokenAuthentication strategy.
       #

data/lib/asana/resource_includes/events.rb

@@ -77,10 +77,10 @@ module Asana
       # a fresh `sync` token in the response.
       def poll
         rate_limiting do
-          body     = @client.get('/events',
-                                 params: params,
-                                 options: @options).body
-          @sync    = body['sync']
+          body = @client.get('/events',
+                             params: params,
+                             options: @options).body
+          @sync = body['sync']
           @events += body.fetch('data', []).map do |event_data|
             Event.new(event_data, client: @client)
           end

data/lib/asana/resources/attachment.rb

@@ -9,7 +9,17 @@ module Asana
     class Attachment < Resource
 
 
-      attr_reader :id
+      attr_reader :created_at
+
+      attr_reader :download_url
+
+      attr_reader :host
+
+      attr_reader :name
+
+      attr_reader :parent
+
+      attr_reader :view_url
 
       class << self
         # Returns the plural name of the resource.

data/lib/asana/resources/project.rb

@@ -16,7 +16,23 @@ module Asana
       include EventSubscription
 
 
-      attr_reader :id
+      attr_reader :archived
+
+      attr_reader :created_at
+
+      attr_reader :followers
+
+      attr_reader :modified_at
+
+      attr_reader :name
+
+      attr_reader :color
+
+      attr_reader :notes
+
+      attr_reader :workspace
+
+      attr_reader :team
 
       class << self
         # Returns the plural name of the resource.
@@ -149,6 +165,25 @@ module Asana
         client.delete("/projects/#{id}") && true
       end
 
+      # Returns compact records for all sections in the specified project.
+      #
+      # per_page - [Integer] the number of records to fetch per page.
+      # options - [Hash] the request I/O options.
+      def sections(per_page: 20, options: {})
+        params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+        Collection.new(parse(client.get("/projects/#{id}/sections", params: params, options: options)), type: Resource, client: client)
+      end
+
+      # Returns the compact task records for all tasks within the given project,
+      # ordered by their priority within the project. Tasks can exist in more than one project at a time.
+      #
+      # per_page - [Integer] the number of records to fetch per page.
+      # options - [Hash] the request I/O options.
+      def tasks(per_page: 20, options: {})
+        params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+        Collection.new(parse(client.get("/projects/#{id}/tasks", params: params, options: options)), type: Task, client: client)
+      end
+
     end
   end
 end

data/lib/asana/resources/story.rb

@@ -13,7 +13,25 @@ module Asana
     class Story < Resource
 
 
-      attr_reader :id
+      attr_reader :created_at
+
+      attr_reader :created_by
+
+      attr_reader :hearted
+
+      attr_reader :hearts
+
+      attr_reader :num_hearts
+
+      attr_reader :text
+
+      attr_reader :html_text
+
+      attr_reader :target
+
+      attr_reader :source
+
+      attr_reader :type
 
       class << self
         # Returns the plural name of the resource.
@@ -23,7 +41,7 @@ module Asana
 
         # Returns the full record for a single story.
         #
-        # id - [Id] Globally unique identifier for the team.
+        # id - [Id] Globally unique identifier for the story.
         #
         # options - [Hash] the request I/O options.
         def find_by_id(client, id, options: {})

data/lib/asana/resources/tag.rb

@@ -13,7 +13,17 @@ module Asana
     class Tag < Resource
 
 
-      attr_reader :id
+      attr_reader :created_at
+
+      attr_reader :followers
+
+      attr_reader :name
+
+      attr_reader :color
+
+      attr_reader :notes
+
+      attr_reader :workspace
 
       class << self
         # Returns the plural name of the resource.
@@ -115,6 +125,16 @@ module Asana
         client.delete("/tags/#{id}") && true
       end
 
+      # Returns the compact task records for all tasks with the given tag.
+      # Tasks can have more than one tag at a time.
+      #
+      # per_page - [Integer] the number of records to fetch per page.
+      # options - [Hash] the request I/O options.
+      def get_tasks_with_tag(per_page: 20, options: {})
+        params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+        Collection.new(parse(client.get("/tags/#{id}/tasks", params: params, options: options)), type: Task, client: client)
+      end
+
     end
   end
 end

data/lib/asana/resources/task.rb

@@ -18,6 +18,40 @@ module Asana
 
       attr_reader :assignee_status
 
+      attr_reader :created_at
+
+      attr_reader :completed
+
+      attr_reader :completed_at
+
+      attr_reader :due_on
+
+      attr_reader :due_at
+
+      attr_reader :external
+
+      attr_reader :followers
+
+      attr_reader :hearted
+
+      attr_reader :hearts
+
+      attr_reader :modified_at
+
+      attr_reader :name
+
+      attr_reader :notes
+
+      attr_reader :num_hearts
+
+      attr_reader :projects
+
+      attr_reader :parent
+
+      attr_reader :workspace
+
+      attr_reader :memberships
+
       class << self
         # Returns the plural name of the resource.
         def plural_name
@@ -32,11 +66,12 @@ module Asana
         # workspace cannot be changed once set. The workspace need not be set
         # explicitly if you specify a `project` or a `parent` task instead.
         #
+        # workspace - [Id] The workspace to create a task in.
         # options - [Hash] the request I/O options.
         # data - [Hash] the attributes to post.
-        def create(client, options: {}, **data)
-
-          self.new(parse(client.post("/tasks", body: data, options: options)).first, client: client)
+        def create(client, workspace: nil, options: {}, **data)
+          with_params = data.merge(workspace: workspace).reject { |_,v| v.nil? || Array(v).empty? }
+          self.new(parse(client.post("/tasks", body: with_params, options: options)).first, client: client)
         end
 
         # Creating a new task is as easy as POSTing to the `/tasks` endpoint
@@ -45,7 +80,7 @@ module Asana
         #
         # Every task is required to be created in a specific workspace, and this
         # workspace cannot be changed once set. The workspace need not be set
-        # explicitly if you specify a project or a parent task instead.
+        # explicitly if you specify a `project` or a `parent` task instead.
         #
         # workspace - [Id] The workspace to create a task in.
         # options - [Hash] the request I/O options.
@@ -251,14 +286,14 @@ module Asana
         Collection.new(parse(client.get("/tasks/#{id}/subtasks", params: params, options: options)), type: self.class, client: client)
       end
 
-      # Makes an existing task a subtask of another. Returns an empty data block.
+      # Creates a new subtask and adds it to the parent task. Returns the full record
+      # for the newly created subtask.
       #
-      # subtask - [Id] The subtask to add to the task.
       # options - [Hash] the request I/O options.
       # data - [Hash] the attributes to post.
-      def add_subtask(subtask: required("subtask"), options: {}, **data)
-        with_params = data.merge(subtask: subtask).reject { |_,v| v.nil? || Array(v).empty? }
-        client.post("/tasks/#{id}/subtasks", body: with_params, options: options) && true
+      def add_subtask(options: {}, **data)
+
+        self.class.new(parse(client.post("/tasks/#{id}/subtasks", body: data, options: options)).first, client: client)
       end
 
       # Changes the parent of a task. Each task may only be a subtask of a single

data/lib/asana/resources/team.rb

@@ -8,8 +8,6 @@ module Asana
     class Team < Resource
 
 
-      attr_reader :id
-
       attr_reader :name
 
       class << self

data/lib/asana/resources/user.rb

@@ -12,7 +12,7 @@ module Asana
     class User < Resource
 
 
-      attr_reader :id
+      attr_reader :name
 
       attr_reader :email
 
@@ -34,7 +34,7 @@ module Asana
           Resource.new(parse(client.get("/users/me", options: options)).first, client: client)
         end
 
-        # Returns the full user record for a single user.
+        # Returns the full user record for the single user with the provided ID.
         #
         # id - [Id] Globally unique identifier for the user.
         #
@@ -44,8 +44,8 @@ module Asana
           self.new(parse(client.get("/users/#{id}", options: options)).first, client: client)
         end
 
-        # Returns the user records for all users in all workspaces and organizations
-        # accessible to the authenticated user.
+        # Returns the user records for all users in the specified workspace or
+        # organization.
         #
         # workspace - [Id] The workspace in which to get users.
         # per_page - [Integer] the number of records to fetch per page.
@@ -55,8 +55,9 @@ module Asana
           Collection.new(parse(client.get("/workspaces/#{workspace}/users", params: params, options: options)), type: self, client: client)
         end
 
-        # Returns the user records for all users in the specified workspace or
-        # organization.
+        # Returns the user records for all users in all workspaces and organizations
+        # accessible to the authenticated user. Accepts an optional workspace ID
+        # parameter.
         #
         # workspace - [Id] The workspace or organization to filter users on.
         # per_page - [Integer] the number of records to fetch per page.

data/lib/asana/resources/workspace.rb

@@ -20,8 +20,6 @@ module Asana
     class Workspace < Resource
 
 
-      attr_reader :id
-
       attr_reader :name
 
       attr_reader :is_organization
@@ -52,7 +50,13 @@ module Asana
         end
       end
 
-      # Update properties on a workspace. Returns the complete, updated workspace record.
+      # A specific, existing workspace can be updated by making a PUT request on
+      # the URL for that workspace. Only the fields provided in the data block
+      # will be updated; any unspecified fields will remain unchanged.
+      #
+      # Currently the only field that can be modified for a workspace is its `name`.
+      #
+      # Returns the complete, updated workspace record.
       #
       # options - [Hash] the request I/O options.
       # data - [Hash] the attributes to post.

data/lib/asana/version.rb

@@ -1,5 +1,5 @@
 #:nodoc:
 module Asana
   # Public: Version of the gem.
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asana
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Txus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-16 00:00:00.000000000 Z
+date: 2015-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -132,10 +132,10 @@ files:
 - bin/setup
 - examples/Gemfile
 - examples/Gemfile.lock
-- examples/api_token.rb
 - examples/cli_app.rb
 - examples/events.rb
 - examples/omniauth_integration.rb
+- examples/personal_access_token.rb
 - lib/asana.rb
 - lib/asana/authentication.rb
 - lib/asana/authentication/oauth2.rb