asana 0.5.0 → 0.6.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGY2NmI1NmY2YzM2ZmIzOWMzYzMxMmUwZDBiNTVkOTU4ODNlNTUwOQ==
+    ZDNhNmQzZDIzZWU1OWI4ZDJkMWU3MTg0MGFiMmZiNTg5YjczZDE3ZQ==
   data.tar.gz: !binary |-
-    Mjk2OTM4ZWRmYzVjMzAwMzc5OGIxNDk5Mjg1NWI3MGZmYjExNTZjMg==
+    ZDQ3OThkZDJmNmExNTlhMjI4Y2VlZDQ1NWIzNmFmZDkzNzRkOWRiYg==
 SHA512:
   metadata.gz: !binary |-
-    NWE2YjgxNGU2ZmNhOGRkNGE1ODY3N2FkNTE5NjNlZDQzOTQ2YzFiM2JiYzY3
-    NzVkMDI3YTk0MzUxYjFmMmRhMTQxNzZkNmZjMjAwZDkxOThkOGE1ZWQ1YTJk
-    ZTY3YTdmYzYyZjllNGM0Y2Y4ZjEzYTQ4MTk0Y2IzZGRiN2E2Zjc=
+    ZjUxMWY3ZDc2ZDM2MDMyNmE4NTdkMjIxNjFlNTUzYzdiYTM5MTgyMGJhNWJk
+    NmRiNDY5Njc5ZjMyMjVkODFiZmIyZmE2NmY3OTYzNDg3NGMwMzAzMDRkMzU1
+    ZWYzMjFiNGYzMDdlZTkzNmE4ODNhYTQxNGQ0MzM3MDYxOGE0ZTU=
   data.tar.gz: !binary |-
-    ZGJkODcyZGZmMzljZGQ5NTY5MmMyYjkxZGQ0ZTJmYzhkMzIyYmY0MDZkMDVj
-    ZjI2MzdkODU1OGM5NDdiNTkwOTE2OWJlZjZhZWQzZGViYWY4ZWQxYzliZjgz
-    NDM5MjUxYmQwMTNhM2MyNWEzYTQyMjhiMWFiYmZlZjE0YWVlY2Q=
+    NzEwMTI5ZjZlNjQxMzFhMzJmY2QzNWI2NTU1MzMwZjZlYTI1ODcwY2NmYWIz
+    ZjdjYzQ1MjE2Y2VhOTJhNWMzNWNlMWYyZmFlYmU1ZDM0YWU2NDJiZTgyMzg1
+    ZThjNDVlYThhZjY2ZmI1MDAzMzJjYjczMmU3NTdlODQyMzVkNzE=

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 rvm:
-- 2.2.2
-- 2.0.0
+- 2.2.5
 deploy:
   provider: rubygems
   api_key:

data/Gemfile

@@ -4,8 +4,13 @@ source 'https://rubygems.org'
 gemspec
 
 group :tools do
-  gem 'rubocop'
-  gem 'rubocop-rspec'
+  # Currently we need to pin the version of Rubocop, due to an incompatibility
+  # with rubocop-rspec.  However, this also solves the problem that Rubocop
+  # routinely adds new checks which can cause our build to "break" even when no
+  # changes have been made. In this situation it's better to intentionally
+  # upgrade Rubocop and fix issues at that time.
+  gem 'rubocop', '~> 0.35.0'
+  gem 'rubocop-rspec', '~> 1.2.0'
 
   gem 'guard'
   gem 'guard-rspec'

data/README.md

@@ -12,8 +12,54 @@ Supported rubies:
 
 * MRI 2.0.0 up to 2.2.x stable
 
-## Installation
+## Required: Security procedures for outdated OpenSSL versions
 
+Older versions of OpenSSL can cause a problem when using `ruby-asana` In particular, at the time of this writing, at least **MacOS X 10.11 and below** ship with a very old version of OpenSSL:
+    
+    $ openssl version
+    OpenSSL 0.9.8zh 14 Jan 2016
+
+OpenSSL 0.9.8 was first released in 2005, and therefore only supports TLS (Transport Layer Security) version 1.0. Asana has deprecated and stopped accepting requests for clients which do not suport [TLS 1.0 and above](https://asa.na/tls), which unfortunately includes any software linked against this version of the library - this includes both the MacOS X provided Ruby interpreter and any homebrew installed Ruby that is not specifically configured to link against a newer version.
+
+To see if your Ruby version is affected, run
+   
+    $ ruby -ropenssl -e 'puts OpenSSL::OPENSSL_VERSION'
+
+If the version printed at the command line is older than `1.0.1`, when, in 2012, OpenSSL first supported TLS 1.1 and 1.2, you will not be able to use `ruby-asana` to connect to Asana. Specifically, you will recieve `400 Bad Request` responses with an error message in the response body about the lack of support for TLS 1.1 and above.
+
+Asana highly recommends using a Ruby installation manager, either RVM or `rbenv`. Instructions on how to install an up-to-date `ruby` for each of these are below.
+
+### Solution when using RVM
+
+RVM makes it easy to install both an updated OpenSSL and a Ruby interpreter that links to it. If you are using MacPorts or Homebrew, you're probably fine out of the box; RVM favors package management using either one of these to satisfy dependencies, and so can keep your ruby up to date automatically. If you are not using these, consider using them, as they're very simple to install and use.
+
+If you don't use your package manager, you can use RVM's [package manager](https://rvm.io/packages) to install from source.
+
+If you want to build OpenSSL from source yourself, you have to specify how to link to this OpenSSL installation:
+
+    $ rvm install ruby-{version} --with-openssl-dir={ssl_dir}
+          # Specify your openssl path prefix, wherever openssl dirs 
+          # "bin", "include", and "lib" are installed; usually
+          # "/usr" for system installs, or $PREFIX for configure/make locally.
+    $ ruby -ropenssl -e 'puts OpenSSL::OPENSSL_VERSION' # Verify inside Ruby
+    OpenSSL 1.0.2h  3 May 2016
+
+If you see the version of OpenSSL greater than OpenSSL 1.0.1, then you're all set to start using `ruby-asana`
+
+### Solution when using rbenv
+
+Similar to RVM, rbenv compiles rubies with knowledge of MacPorts and Homebrew libraries. When a newer version of OpenSSL is installed via the method above, all rubies built (after that time of course) will link to the newer version of OpenSSL.
+
+If you don't use a package manager, as above, you can build by explicitly supplying the directory in which to find OpenSSL:
+
+    $ RUBY_CONFIGURE_OPTS=--with-openssl-dir=/opt/local rbenv install ruby-{version}
+          # Specify your openssl path prefix, wherever openssl dirs 
+          # "bin", "include", and "lib" are installed; usually
+          # "/usr" for system installs, or $PREFIX for configure/make locally.
+    $ ruby -ropenssl -e 'puts OpenSSL::OPENSSL_VERSION' # Verify inside Ruby
+    OpenSSL 1.0.2h  3 May 2016
+
+## Gem Installation
 Add this line to your application's Gemfile:
 
 ```ruby

data/Rakefile

@@ -12,6 +12,7 @@ end
 
 desc 'Generates a test resource from a YAML using the resource template.'
 task :codegen do
+  # TODO: I believe this is obsolete and can be removed
   `node spec/support/codegen.js`
 end
 
@@ -62,4 +63,4 @@ EOS
   end
 end
 
-task default: [:codegen, :spec, :rubocop, :yard]
+task default: [:spec, :rubocop, :yard]

data/lib/asana/client.rb

@@ -79,7 +79,7 @@ module Asana
                        adapter:        config[:faraday_adapter],
                        user_agent:     config[:user_agent],
                        debug_mode:     config[:debug_mode],
-                       &config[:faraday_config])
+                       &config[:faraday_configuration])
     end
 
     # Public: Performs a GET request against an arbitrary Asana URL. Allows for

data/lib/asana/resources/custom_field_settings.rb

@@ -0,0 +1,42 @@
+### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
+### edit it manually.
+
+module Asana
+  module Resources
+    # Custom fields are attached to a particular project with the Custom
+    # Field Settings resource. This resource both represents the many-to-many join
+    # of the Custom Field and Project as well as stores information that is relevant to that
+    # particular pairing; for instance, the `is_important` property determines
+    # some possible application-specific handling of that custom field (see below)
+    class CustomFieldSetting < Resource
+
+
+      attr_reader :id
+
+      attr_reader :created_at
+
+      attr_reader :is_important
+
+      attr_reader :project
+
+      attr_reader :custom_field
+
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'custom_field_settings'
+        end
+
+        # Returns a list of all of the custom fields settings on a project, in compact form. Note that, as in all queries to collections which return compact representation, `opt_fields` and `opt_expand` can be used to include more data than is returned in the compact representation. See the getting started guide on [input/output options](/developers/documentation/getting-started/input-output-options) for more information.
+        #
+        # project - [Id] The ID of the project for which to list custom field settings
+        # options - [Hash] the request I/O options.
+        def find_by_project(client, project: required("project"), options: {})
+
+          Resource.new(parse(client.get("/projects/#{project}/custom_field_settings", options: options)).first, client: client)
+        end
+      end
+
+    end
+  end
+end

data/lib/asana/resources/custom_fields.rb

@@ -0,0 +1,54 @@
+### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
+### edit it manually.
+
+module Asana
+  module Resources
+    # Custom Fields store the metadata that is used in order to add user-specified
+    # information to tasks in Asana. Be sure to reference the [Custom
+    # Fields](/developers/documentation/getting-started/custom-fields) developer
+    # documentation for more information about how custom fields relate to various
+    # resources in Asana.
+    class CustomField < Resource
+
+
+      attr_reader :id
+
+      attr_reader :created_at
+
+      attr_reader :name
+
+      attr_reader :type
+
+      attr_reader :enum_options
+
+      attr_reader :precision
+
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'custom_fields'
+        end
+
+        # Returns the complete definition of a custom field's metadata.
+        #
+        # id - [Id] Globally unique identifier for the custom field.
+        #
+        # options - [Hash] the request I/O options.
+        def find_by_id(client, id, options: {})
+
+          self.new(parse(client.get("/custom_fields/#{id}", options: options)).first, client: client)
+        end
+
+        # Returns a list of the compact representation of all of the custom fields in a workspace.
+        #
+        # workspace - [Id] The workspace or organization to find custom field definitions in.
+        # options - [Hash] the request I/O options.
+        def find_by_workspace(client, workspace: required("workspace"), options: {})
+
+          Resource.new(parse(client.get("/workspaces/#{workspace}/custom_fields", options: options)).first, client: client)
+        end
+      end
+
+    end
+  end
+end

data/lib/asana/resources/project.rb

@@ -38,6 +38,8 @@ module Asana
 
       attr_reader :followers
 
+      attr_reader :custom_field_settings
+
       attr_reader :color
 
       attr_reader :notes
@@ -239,6 +241,34 @@ module Asana
         refresh_with(parse(client.post("/projects/#{id}/removeMembers", body: with_params, options: options)).first)
       end
 
+      # Create a new custom field setting on the project.
+      #
+      # custom_field - [Id] The id of the custom field to associate with this project.
+      # is_important - [Boolean] Whether this field should be considered important to this project.
+      #
+      # insert_before - [Id] An id of a Custom Field Settings on this project, before which the new Custom Field Settings will be added.
+      # `insert_before` and `insert_after` parameters cannot both be specified.
+      #
+      # insert_after - [Id] An id of a Custom Field Settings on this project, after which the new Custom Field Settings will be added.
+      # `insert_before` and `insert_after` parameters cannot both be specified.
+      #
+      # options - [Hash] the request I/O options.
+      # data - [Hash] the attributes to post.
+      def add_custom_field_setting(custom_field: required("custom_field"), is_important: nil, insert_before: nil, insert_after: nil, options: {}, **data)
+        with_params = data.merge(custom_field: custom_field, is_important: is_important, insert_before: insert_before, insert_after: insert_after).reject { |_,v| v.nil? || Array(v).empty? }
+        Resource.new(parse(client.post("/projects/#{id}/addCustomFieldSetting", body: with_params, options: options)).first, client: client)
+      end
+
+      # Remove a custom field setting on the project.
+      #
+      # custom_field - [Id] The id of the custom field to remove from this project.
+      # options - [Hash] the request I/O options.
+      # data - [Hash] the attributes to post.
+      def remove_custom_field_setting(custom_field: nil, options: {}, **data)
+        with_params = data.merge(custom_field: custom_field).reject { |_,v| v.nil? || Array(v).empty? }
+        Resource.new(parse(client.post("/projects/#{id}/removeCustomFieldSetting", body: with_params, options: options)).first, client: client)
+      end
+
     end
   end
 end

data/lib/asana/resources/task.rb

@@ -26,6 +26,8 @@ module Asana
 
       attr_reader :completed_at
 
+      attr_reader :custom_fields
+
       attr_reader :due_on
 
       attr_reader :due_at
@@ -68,7 +70,10 @@ 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 `projects` or a `parent` task instead.
+        #
+        # `projects` can be a comma separated list of projects, or just a single
+        # project the task should belong to.
         #
         # workspace - [Id] The workspace to create a task in.
         # options - [Hash] the request I/O options.
@@ -125,9 +130,11 @@ module Asana
         end
 
         # Returns the compact task records for some filtered set of tasks. Use one
-        # or more of the parameters provided to filter the tasks returned.
+        # or more of the parameters provided to filter the tasks returned. You must
+        # specify a `project` or `tag` if you do not specify `assignee` and `workspace`.
         #
         # assignee - [String] The assignee to filter tasks on.
+        # project - [Id] The project to filter tasks on.
         # workspace - [Id] The workspace or organization to filter tasks on.
         # completed_since - [String] Only return tasks that are either incomplete or that have been
         # completed since this time.
@@ -148,8 +155,8 @@ module Asana
         # just because another object it is associated with (e.g. a subtask)
         # is modified. Actions that count as modifying the task include
         # assigning, renaming, completing, and adding stories.
-        def find_all(client, assignee: nil, workspace: nil, completed_since: nil, modified_since: nil, per_page: 20, options: {})
-          params = { assignee: assignee, workspace: workspace, completed_since: completed_since, modified_since: modified_since, limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+        def find_all(client, assignee: nil, project: nil, workspace: nil, completed_since: nil, modified_since: nil, per_page: 20, options: {})
+          params = { assignee: assignee, project: project, workspace: workspace, completed_since: completed_since, modified_since: modified_since, limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
           Collection.new(parse(client.get("/tasks", params: params, options: options)), type: self, client: client)
         end
       end
@@ -223,10 +230,10 @@ module Asana
       # Returns an empty data block.
       #
       # project - [Id] The project to add the task to.
-      # insertAfter - [Id] A task in the project to insert the task after, or `null` to
+      # insert_after - [Id] A task in the project to insert the task after, or `null` to
       # insert at the beginning of the list.
       #
-      # insertBefore - [Id] A task in the project to insert the task before, or `null` to
+      # insert_before - [Id] A task in the project to insert the task before, or `null` to
       # insert at the end of the list.
       #
       # section - [Id] A section in the project to insert the task into. The task will be
@@ -234,8 +241,8 @@ module Asana
       #
       # options - [Hash] the request I/O options.
       # data - [Hash] the attributes to post.
-      def add_project(project: required("project"), insertAfter: nil, insertBefore: nil, section: nil, options: {}, **data)
-        with_params = data.merge(project: project, insertAfter: insertAfter, insertBefore: insertBefore, section: section).reject { |_,v| v.nil? || Array(v).empty? }
+      def add_project(project: required("project"), insert_after: nil, insert_before: nil, section: nil, options: {}, **data)
+        with_params = data.merge(project: project, insert_after: insert_after, insert_before: insert_before, section: section).reject { |_,v| v.nil? || Array(v).empty? }
         client.post("/tasks/#{id}/addProject", body: with_params, options: options) && true
       end
 

data/lib/asana/resources/team.rb

@@ -39,6 +39,20 @@ module Asana
           params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
           Collection.new(parse(client.get("/organizations/#{organization}/teams", params: params, options: options)), type: self, client: client)
         end
+
+        # Returns the compact records for all teams to which user is assigned.
+        #
+        # user - [String] An identifier for the user. Can be one of an email address,
+        # the globally unique identifier for the user, or the keyword `me`
+        # to indicate the current user making the request.
+        #
+        # organization - [Id] The workspace or organization to filter teams on.
+        # per_page - [Integer] the number of records to fetch per page.
+        # options - [Hash] the request I/O options.
+        def find_by_user(client, user: required("user"), organization: nil, per_page: 20, options: {})
+          params = { organization: organization, limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+          Collection.new(parse(client.get("/users/#{user}/teams", params: params, options: options)), type: self, client: client)
+        end
       end
 
       # Returns the compact records for all users that are members of the team.

data/lib/asana/resources/user.rb

@@ -38,14 +38,14 @@ module Asana
 
         # Returns the full user record for the single user with the provided ID.
         #
-        # user - [String] An identifier for the user. Can be one of an email address,
+        # id - [String] An identifier for the user. Can be one of an email address,
         # the globally unique identifier for the user, or the keyword `me`
         # to indicate the current user making the request.
         #
         # options - [Hash] the request I/O options.
-        def find_by_id(client, user: required("user"), options: {})
-          params = { user: user }.reject { |_,v| v.nil? || Array(v).empty? }
-          Resource.new(parse(client.get("/users/%s", params: params, options: options)).first, client: client)
+        def find_by_id(client, id, options: {})
+
+          self.new(parse(client.get("/users/#{id}", options: options)).first, client: client)
         end
 
         # Returns the user records for all users in the specified workspace or

data/lib/asana/resources/webhook.rb

@@ -3,8 +3,6 @@
 
 module Asana
   module Resources
-    # **Webhooks are currently in BETA - The information here may change.**
-    #
     # Webhooks allow an application to be notified of changes. This is in addition
     # to the ability to fetch those changes directly as
     # [Events](/developers/api-reference/events) - in fact, Webhooks are just a way
@@ -136,4 +134,4 @@ module Asana
 
     end
   end
-end
+end

data/lib/asana/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asana
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Txus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-03 00:00:00.000000000 Z
+date: 2016-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -160,6 +160,8 @@ files:
 - lib/asana/resource_includes/response_helper.rb
 - lib/asana/resources.rb
 - lib/asana/resources/attachment.rb
+- lib/asana/resources/custom_field_settings.rb
+- lib/asana/resources/custom_fields.rb
 - lib/asana/resources/project.rb
 - lib/asana/resources/story.rb
 - lib/asana/resources/tag.rb