asana 0.0.6 → 0.1.1

data/lib/asana/resources/team.rb

@@ -0,0 +1,55 @@
+### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
+### edit it manually.
+
+module Asana
+  module Resources
+    # A _team_ is used to group related projects and people together within an
+    # organization. Each project in an organization is associated with a team.
+    class Team < Resource
+
+
+      attr_reader :id
+
+      attr_reader :name
+
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'teams'
+        end
+
+        # Returns the full record for a single team.
+        #
+        # id - [Id] Globally unique identifier for the team.
+        #
+        # options - [Hash] the request I/O options.
+        def find_by_id(client, id, options: {})
+
+          self.new(parse(client.get("/teams/#{id}", options: options)).first, client: client)
+        end
+
+        # Returns the compact records for all teams in the organization visible to
+        # the authorized user.
+        #
+        # organization - [Id] Globally unique identifier for the workspace or organization.
+        #
+        # per_page - [Integer] the number of records to fetch per page.
+        # options - [Hash] the request I/O options.
+        def find_by_organization(client, organization: required("organization"), per_page: 20, options: {})
+          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
+      end
+
+      # Returns the compact records for all users that are members of the team.
+      #
+      # per_page - [Integer] the number of records to fetch per page.
+      # options - [Hash] the request I/O options.
+      def users(per_page: 20, options: {})
+        params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+        Collection.new(parse(client.get("/teams/#{id}/users", params: params, options: options)), type: User, client: client)
+      end
+
+    end
+  end
+end

data/lib/asana/resources/user.rb

@@ -1,17 +1,72 @@
+### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
+### edit it manually.
+
 module Asana
-  class User < Asana::Resource
+  module Resources
+    # A _user_ object represents an account in Asana that can be given access to
+    # various workspaces, projects, and tasks.
+    #
+    # Like other objects in the system, users are referred to by numerical IDs.
+    # However, the special string identifier `me` can be used anywhere
+    # a user ID is accepted, to refer to the current authenticated user.
+    class User < Resource
 
-    alias :save :method_not_allowed
-    alias :destroy :method_not_allowed
 
-    def self.all_by_workspace(*args)
-      parent_resources :workspace
-      all(*args)
-    end
+      attr_reader :id
 
-    def self.me
-      User.new(get(:me))
-    end
+      attr_reader :email
+
+      attr_reader :photo
+
+      attr_reader :workspaces
+
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'users'
+        end
+
+        # Returns the full user record for the currently authenticated user.
+        #
+        # options - [Hash] the request I/O options.
+        def me(client, options: {})
 
+          Resource.new(parse(client.get("/users/me", options: options)).first, client: client)
+        end
+
+        # Returns the full user record for a single user.
+        #
+        # id - [Id] Globally unique identifier for the user.
+        #
+        # options - [Hash] the request I/O options.
+        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 all workspaces and organizations
+        # accessible to the authenticated user.
+        #
+        # workspace - [Id] The workspace in which to get users.
+        # per_page - [Integer] the number of records to fetch per page.
+        # options - [Hash] the request I/O options.
+        def find_by_workspace(client, workspace: required("workspace"), per_page: 20, options: {})
+          params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+          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.
+        #
+        # workspace - [Id] The workspace or organization to filter users on.
+        # per_page - [Integer] the number of records to fetch per page.
+        # options - [Hash] the request I/O options.
+        def find_all(client, workspace: nil, per_page: 20, options: {})
+          params = { workspace: workspace, limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+          Collection.new(parse(client.get("/users", params: params, options: options)), type: self, client: client)
+        end
+      end
+
+    end
   end
 end

data/lib/asana/resources/workspace.rb

@@ -1,46 +1,91 @@
+### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
+### edit it manually.
+
 module Asana
-  class Workspace < Asana::Resource
+  module Resources
+    # A _workspace_ is the highest-level organizational unit in Asana. All projects
+    # and tasks have an associated workspace.
+    #
+    # An _organization_ is a special kind of workspace that represents a company.
+    # In an organization, you can group your projects into teams. You can read
+    # more about how organizations work on the Asana Guide.
+    # To tell if your workspace is an organization or not, check its
+    # `is_organization` property.
+    #
+    # Over time, we intend to migrate most workspaces into organizations and to
+    # release more organization-specific functionality. We may eventually deprecate
+    # using workspace-based APIs for organizations. Currently, and until after
+    # some reasonable grace period following any further announcements, you can
+    # still reference organizations in any `workspace` parameter.
+    class Workspace < Resource
 
-    alias :create :method_not_allowed
-    alias :destroy :method_not_allowed
 
-    def projects
-      Project.all_by_workspace(:params => { :workspace_id => self.id })
-    end
+      attr_reader :id
 
-    def create_project(*args)
-      options = { :workspace => self.id }
-      project = Project.new(options.merge(args.first))
-      response = Project.post(nil, nil, project.to_json)
-      Project.new(connection.format.decode(response.body))
-    end
+      attr_reader :name
 
-    def tasks(assignee)
-      query_options = { :workspace => self.id, :assignee => assignee }
-      Task.all_by_workspace(:params => query_options)
-    end
+      attr_reader :is_organization
 
-    def create_task(*args)
-      options = { :workspace => self.id, :assignee => 'me' }
-      task = Task.new(options.merge(args.first))
-      response = Task.post(nil, nil, task.to_json)
-      Task.new(connection.format.decode(response.body))
-    end
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'workspaces'
+        end
 
-    def tags
-      Tag.all_by_workspace(:params => { :workspace_id => self.id })
-    end
+        # Returns the full workspace record for a single workspace.
+        #
+        # id - [Id] Globally unique identifier for the workspace or organization.
+        #
+        # options - [Hash] the request I/O options.
+        def find_by_id(client, id, options: {})
 
-    def create_tag(*args)
-      options = { :workspace => self.id }
-      tag = Tag.new(options.merge(args.first))
-      response = Tag.post(nil, nil, tag.to_json)
-      Tag.new(connection.format.decode(response.body))
-    end
+          self.new(parse(client.get("/workspaces/#{id}", options: options)).first, client: client)
+        end
 
-    def users
-      User.all_by_workspace(:params => { :workspace_id => self.id })
-    end
+        # Returns the compact records for all workspaces visible to the authorized user.
+        #
+        # per_page - [Integer] the number of records to fetch per page.
+        # options - [Hash] the request I/O options.
+        def find_all(client, per_page: 20, options: {})
+          params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+          Collection.new(parse(client.get("/workspaces", params: params, options: options)), type: self, client: client)
+        end
+      end
+
+      # Update properties on a workspace. Returns the complete, updated workspace record.
+      #
+      # options - [Hash] the request I/O options.
+      # data - [Hash] the attributes to post.
+      def update(options: {}, **data)
 
+        refresh_with(parse(client.put("/workspaces/#{id}", body: data, options: options)).first)
+      end
+
+      # Retrieves objects in the workspace based on an auto-completion/typeahead
+      # search algorithm. This feature is meant to provide results quickly, so do
+      # not rely on this API to provide extremely accurate search results. The
+      # result set is limited to a single page of results with a maximum size,
+      # so you won't be able to fetch large numbers of results.
+      #
+      # type - [Enum] The type of values the typeahead should return.
+      # Note that unlike in the names of endpoints, the types listed here are
+      # in singular form (e.g. `task`). Using multiple types is not yet supported.
+      #
+      # query - [String] The string that will be used to search for relevant objects. If an
+      # empty string is passed in, the API will currently return an empty
+      # result set.
+      #
+      # count - [Number] The number of results to return. The default is `20` if this
+      # parameter is omitted, with a minimum of `1` and a maximum of `100`.
+      # If there are fewer results found than requested, all will be returned.
+      #
+      # per_page - [Integer] the number of records to fetch per page.
+      # options - [Hash] the request I/O options.
+      def typeahead(type: required("type"), query: nil, count: nil, per_page: 20, options: {})
+        params = { type: type, query: query, count: count, limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+        Collection.new(parse(client.get("/workspaces/#{id}/typeahead", params: params, options: options)), type: Resource, client: client)
+      end
+
+    end
   end
 end

data/lib/asana/ruby2_0_0_compatibility.rb

@@ -0,0 +1,3 @@
+def required(name)
+  fail(ArgumentError, "#{name} is a required keyword argument")
+end

data/lib/asana/version.rb

@@ -1,3 +1,5 @@
+#:nodoc:
 module Asana
-  VERSION = "0.0.6"
+  # Public: Version of the gem.
+  VERSION = '0.1.1'
 end

data/lib/templates/index.js

@@ -0,0 +1,8 @@
+module.exports = {
+  resource: {
+    template: 'resource.ejs',
+    filename: function(resource, helpers) {
+      return resource.name + '.rb';
+    }
+  }
+};

data/lib/templates/resource.ejs

@@ -0,0 +1,225 @@
+<%
+var singularName  = resource.name,
+    pluralName    = plural(singularName),
+    mixins        = {
+      task: ["AttachmentUploading", "EventSubscription"],
+      project: ["EventSubscription"]
+    },
+    skip          = { attachment: ["createOnTask"] },
+    formatComment = function formatComment(text, indentation) {
+        var indent = Array(indentation + 1).join(" ")
+        return text.trim().split("\n").map(function(line) {
+            return indent + (line.length > 0 ? "# " : "#") + line
+        }).join("\n")
+    }
+
+
+function Action(action) {
+    var that = this
+    this.action = action
+    this.collection = action.collection == true
+    this.requiresData = action.method == "POST" || action.method == "PUT"
+    this.isInstanceAction = (action.method == "PUT" || action.method == "DELETE")
+    this.method = action.method
+    this.methodName = snake(action.name)
+    this.clientMethod = action.method.toLowerCase()
+    this.returnsUpdatedRecord = action.method == 'PUT' || action.comment.match(/Returns[a-z\W]+updated/) !== null
+    this.returnsNothing = action.comment.match(/Returns an empty/) !== null
+
+    // Params and idParams
+    var params = action.params || []
+    this.idParams = _.filter(params, function(p) { return p.type == "Id" })
+
+    // If it looks like an instance action but it's not, make it one
+    if (!this.isInstanceAction) {
+        var mainIdParam = _.find(this.idParams, function(p) { return p.name == singularName })
+        if (mainIdParam !== undefined && !action.name.match(/Id/)) {
+            this.isInstanceAction = true
+            this.mainIdParam = mainIdParam
+        }
+    }
+
+    if (this.idParams.length == 1 &&
+        action.path.match(/%d/) &&
+        (action.name.match(/Id/) || (this.isInstanceAction && this.mainIdParam == undefined))) {
+            var mainIdParam = this.idParams[0]
+            this.mainIdParam = mainIdParam
+            this.inferredReturnType = this.isInstanceAction ? 'self.class' : 'self'
+    }
+
+    if (mainIdParam !== undefined) {
+        this.params = _.reject(params, function(p) { return p.name == mainIdParam.name })
+    } else {
+        this.params = params
+    }
+
+    if (!this.inferredReturnType) {
+        // Infer return type
+        var name = action.path.match(/\/([a-zA-Z]+)$/)
+        if (name !== null) {
+            name = name[1]
+
+            // Desugarize 'addProject' to 'project'
+            var camelCaseTail = name.match(/.*([A-Z][a-z]+)$/)
+            if (camelCaseTail !== null) { name = decap(camelCaseTail[1]) }
+
+            name = single(name)
+
+            var explicit = _.find(resources, function(p) { return p == name })
+
+            if (name == singularName || name == 'parent' || name == 'children' || name.match(/^sub/) !== null) {
+                this.inferredReturnType = this.isInstanceAction ? 'self.class' : 'self'
+            } else if (explicit !== undefined) {
+                this.inferredReturnType = cap(explicit)
+            } else {
+                this.inferredReturnType = 'Resource'
+            }
+        } else {
+            this.inferredReturnType = 'Resource'
+        }
+    }
+
+    // Endpoint path
+    this.path = _.reduce(this.idParams, function(acc, id) {
+        var localName = that.mainIdParam == id ? "id" : id.name
+        return acc.replace("\%d", "#{" + localName + "}")
+    }, action.path)
+
+    // Extra params (not in the URL) to be passed in the body of the call
+    this.extraParams = _.reject(this.params, function(p) {
+        return that.path.match(new RegExp("#{" + p.name + "}"))
+    })
+
+    // Params processing
+    var paramsLocal = "data"
+    if (this.collection) { this.extraParams.push({ name: "per_page", apiParamName: "limit" }) }
+    if (this.extraParams.length > 0) {
+        var paramNames = _.map(this.extraParams, function(p) { return (p.apiParamName || p.name) + ": " + p.name })
+        if (this.requiresData) {
+            var paramsProcessing = "with_params = data.merge(" + paramNames.join(", ") + ")"
+            paramsLocal = "with_params"
+        } else {
+            var paramsProcessing = "params = { " + paramNames.join(", ") + " }"
+            paramsLocal = "params"
+        }
+        paramsProcessing += ".reject { |_,v| v.nil? || Array(v).empty? }"
+    }
+
+    this.paramsProcessing = paramsProcessing
+    this.paramsLocal      = paramsLocal
+
+    // Method argument names
+    var argumentNames = Array()
+    if (!this.isInstanceAction) { argumentNames.push("client") }
+    if (this.mainIdParam !== undefined && !this.isInstanceAction) { argumentNames.push("id") }
+    _.forEach(this.params, function(param) {
+        argumentNames.push(param.name + ":" + (param.required ? " required(\"" + param.name + "\")" : " nil"))
+    })
+    if (this.collection) { argumentNames.push("per_page: 20") }
+    if (this.method != 'DELETE')  { argumentNames.push("options: {}") }
+    if (this.requiresData)          { argumentNames.push("**data") }
+    this.argumentNames = argumentNames
+
+    // API request params
+    var requestParams = Array()
+    requestParams.push('"' + this.path + '"')
+    if (this.paramsProcessing || this.argumentNames.indexOf("**data") != -1) {
+        var argument = this.requiresData ? "body" : "params"
+        requestParams.push(argument + ": " + paramsLocal)
+    }
+    if (this.method != 'DELETE') { requestParams.push("options: options") }
+    this.requestParams = requestParams
+    this.documentation = this.renderDocumentation()
+
+    // Constructor
+    this.constructor = function(body) {
+        var pre = '', post = ''
+        var wrapWithParsing = function(body) {
+            var pre = '', post = ''
+            if (!that.returnsNothing) {
+                pre = 'parse('
+                post = ')' + (that.collection ? '' : '.first')
+            }
+            return pre + body + post
+        }
+
+        if (!that.returnsNothing) {
+            if (that.isInstanceAction && that.returnsUpdatedRecord) {
+                pre = "refresh_with("
+                post = ')'
+            } else {
+                pre = that.collection ? "Collection.new(" : that.inferredReturnType + ".new("
+                post = (that.collection ? ', type: ' + that.inferredReturnType : '') + ', client: client)'
+            }
+        } else { post = ' && true' }
+        return pre + wrapWithParsing(body) + post
+    }
+
+    this.request = this.constructor("client." + this.clientMethod + "(" + this.requestParams.join(", ") + ")")
+}
+
+Action.prototype.renderDocumentation = function () {
+    var formatParamNotes = function(params) {
+        var trimmed = _.flatten(_.map(params, function(p) {
+            return _.map(p.notes, function(note) { return note.trim() })
+        }))
+        return (trimmed.length > 0 ? "\nNotes:\n\n" + trimmed.join("\n\n") : "")
+    }
+
+    var formatParam = function(p, name) {
+        return (name !== undefined ? name : p.name) + " - [" + p.type + "] " + p.comment
+    }
+    var lines = _.map(this.params, function(p) { return formatParam(p) })
+    if (this.mainIdParam !== undefined && !this.isInstanceAction) { lines.unshift(formatParam(this.mainIdParam, "id")) }
+    if (this.collection) { lines.push("per_page - [Integer] the number of records to fetch per page.") }
+    if (this.method != 'DELETE') { lines.push("options - [Hash] the request I/O options.") }
+    if (this.requiresData) { lines.push("data - [Hash] the attributes to post.") }
+    return this.action.comment + "\n" + lines.join("\n") + formatParamNotes(this.params)
+}
+
+var actionsToSkip   = skip[resource.name] || []
+var actionsToGen    = _.reject(resource.actions, function(action) {
+  return actionsToSkip.indexOf(action.name) != -1
+})
+
+var allActions      = _.map(actionsToGen, function(action) { return new Action(action) }),
+    instanceActions = _.filter(allActions, function(action) { return action.isInstanceAction }),
+    classActions    = _.reject(allActions, function(action) { return action.isInstanceAction })
+
+var mixinsToInclude = mixins[resource.name] || []
+
+%>### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
+### edit it manually.
+
+module Asana
+  module Resources
+<%= formatComment(resource.comment, 4) %>
+    class <%= cap(singularName) %> < Resource
+<% _.forEach(mixinsToInclude, function(mixin) { %>
+      include <%= mixin %>
+<% }) %>
+<% _.forEach(resource.properties, function(property) { %>
+      attr_reader :<%= property.name %>
+<% }) %>
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          '<%= pluralName %>'
+        end
+<% _.forEach(classActions, function(action) { %>
+<%= formatComment(action.documentation, 8) %>
+        def <%= action.methodName %>(<%= action.argumentNames.join(", ") %>)
+<% if (action.paramsProcessing) { %>          <%= action.paramsProcessing %><% } %>
+          <%= action.request %>
+        end
+<% }) %>      end
+<% _.forEach(instanceActions, function(action) { %>
+<%= formatComment(action.documentation, 6) %>
+      def <%= action.methodName %>(<%= action.argumentNames.join(", ") %>)
+<% if (action.paramsProcessing) { %>        <%= action.paramsProcessing %><% } %>
+        <%= action.request %>
+      end
+<% }) %>
+    end
+  end
+end