openc-asana 0.1.2

data/lib/asana/resource_includes/registry.rb

@@ -0,0 +1,63 @@
+require_relative 'resource'
+require 'set'
+
+module Asana
+  module Resources
+    # Internal: Global registry of Resource subclasses. It provides lookup from
+    # singular and plural names to the actual class objects.
+    #
+    # Examples
+    #
+    #   class Unicorn < Asana::Resources::Resource
+    #     path '/unicorns'
+    #   end
+    #
+    #   Registry.lookup(:unicorn) # => Unicorn
+    #   Registry.lookup_many(:unicorns) # => Unicorn
+    #
+    module Registry
+      class << self
+        # Public: Registers a new resource class.
+        #
+        # resource_klass - [Class] the resource class.
+        #
+        # Returns nothing.
+        def register(resource_klass)
+          resources << resource_klass
+        end
+
+        # Public: Looks up a resource class by its singular name.
+        #
+        # singular_name - [#to_s] the name of the resource, e.g :unicorn.
+        #
+        # Returns the resource class or {Asana::Resources::Resource}.
+        def lookup(singular_name)
+          resources.detect do |klass|
+            klass.singular_name.to_s == singular_name.to_s
+          end || Resource
+        end
+
+        # Public: Looks up a resource class by its plural name.
+        #
+        # plural_name - [#to_s] the plural name of the resource, e.g :unicorns.
+        #
+        # Returns the resource class or {Asana::Resources::Resource}.
+        def lookup_many(plural_name)
+          resources.detect do |klass|
+            klass.plural_name.to_s == plural_name.to_s
+          end || Resource
+        end
+
+        # Internal: A set of Resource classes.
+        #
+        # Returns the Set, defaulting to the empty set.
+        #
+        # Note: this object is a mutable singleton, so it should not be accessed
+        # from multiple threads.
+        def resources
+          @resources ||= Set.new
+        end
+      end
+    end
+  end
+end

data/lib/asana/resource_includes/resource.rb

@@ -0,0 +1,103 @@
+require_relative 'registry'
+require_relative 'response_helper'
+
+module Asana
+  module Resources
+    # Public: The base resource class which provides some sugar over common
+    # resource functionality.
+    class Resource
+      include ResponseHelper
+      extend ResponseHelper
+
+      def self.inherited(base)
+        Registry.register(base)
+      end
+
+      def initialize(data, client: required('client'))
+        @_client = client
+        @_data   = data
+        data.each do |k, v|
+          instance_variable_set(:"@#{k}", v) if respond_to?(k)
+        end
+      end
+
+      # If it has findById, it implements #refresh
+      def refresh
+        if self.class.respond_to?(:find_by_id)
+          self.class.find_by_id(client, id)
+        else
+          fail "#{self.class.name} does not respond to #find_by_id"
+        end
+      end
+
+      # Internal: Proxies method calls to the data, wrapping it accordingly and
+      # caching the result by defining a real reader method.
+      #
+      # Returns the value for the requested property.
+      #
+      # Raises a NoMethodError if the property doesn't exist.
+      def method_missing(m, *args)
+        super unless respond_to_missing?(m, *args)
+        cache(m, wrapped(to_h[m.to_s]))
+      end
+
+      # Internal: Guard for the method_missing proxy. Checks if the resource
+      # actually has a specific piece of data at all.
+      #
+      # Returns true if the resource has the property, false otherwise.
+      def respond_to_missing?(m, *)
+        to_h.key?(m.to_s)
+      end
+
+      # Public:
+      # Returns the raw Hash representation of the data.
+      def to_h
+        @_data
+      end
+
+      def to_s
+        attrs = to_h.map { |k, _| "#{k}: #{public_send(k).inspect}" }.join(', ')
+        "#<Asana::#{self.class.name.split('::').last} #{attrs}>"
+      end
+
+      alias_method :inspect, :to_s
+
+      private
+
+      # Internal: The Asana::Client instance.
+      def client
+        @_client
+      end
+
+      # Internal: Caches a property and a value by defining a reader method for
+      # it.
+      #
+      # property - [#to_s] the property
+      # value    - [Object] the corresponding value
+      #
+      # Returns the value.
+      def cache(property, value)
+        field = :"@#{property}"
+        instance_variable_set(field, value)
+        define_singleton_method(property) { instance_variable_get(field) }
+        value
+      end
+
+      # Internal: Wraps a value in a more useful class if possible, namely a
+      # Resource or a Collection.
+      #
+      # Returns the wrapped value or the plain value if it couldn't be wrapped.
+      def wrapped(value)
+        case value
+        when Hash then Resource.new(value, client: client)
+        when Array then value.map(&method(:wrapped))
+        else value
+        end
+      end
+
+      def refresh_with(data)
+        self.class.new(data, client: @client)
+      end
+    end
+  end
+end

data/lib/asana/resource_includes/response_helper.rb

@@ -0,0 +1,14 @@
+module Asana
+  module Resources
+    # Internal: A helper to make response body parsing easier.
+    module ResponseHelper
+      def parse(response)
+        data = response.body.fetch('data') do
+          fail("Unexpected response body: #{response.body}")
+        end
+        extra = response.body.reject { |k, _| k == 'data' }
+        [data, extra]
+      end
+    end
+  end
+end

data/lib/asana/resources.rb

@@ -0,0 +1,14 @@
+require_relative 'resource_includes/resource'
+require_relative 'resource_includes/collection'
+
+Dir[File.join(File.dirname(__FILE__), 'resource_includes', '*.rb')]
+  .each { |resource| require resource }
+
+Dir[File.join(File.dirname(__FILE__), 'resources', '*.rb')]
+  .each { |resource| require resource }
+
+module Asana
+  # Public: Contains all the resources that the Asana API can return.
+  module Resources
+  end
+end

data/lib/asana/resources/attachment.rb

@@ -0,0 +1,44 @@
+### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
+### edit it manually.
+
+module Asana
+  module Resources
+    # An _attachment_ object represents any file attached to a task in Asana,
+    # whether it's an uploaded file or one associated via a third-party service
+    # such as Dropbox or Google Drive.
+    class Attachment < Resource
+
+
+      attr_reader :id
+
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'attachments'
+        end
+
+        # Returns the full record for a single attachment.
+        #
+        # id - [Id] Globally unique identifier for the attachment.
+        #
+        # options - [Hash] the request I/O options.
+        def find_by_id(client, id, options: {})
+
+          self.new(parse(client.get("/attachments/#{id}", options: options)).first, client: client)
+        end
+
+        # Returns the compact records for all attachments on the task.
+        #
+        # task - [Id] Globally unique identifier for the task.
+        #
+        # per_page - [Integer] the number of records to fetch per page.
+        # options - [Hash] the request I/O options.
+        def find_by_task(client, task: required("task"), per_page: 20, options: {})
+          params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+          Collection.new(parse(client.get("/tasks/#{task}/attachments", params: params, options: options)), type: self, client: client)
+        end
+      end
+
+    end
+  end
+end

data/lib/asana/resources/project.rb

@@ -0,0 +1,154 @@
+### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
+### edit it manually.
+
+module Asana
+  module Resources
+    # A _project_ represents a prioritized list of tasks in Asana. It exists in a
+    # single workspace or organization and is accessible to a subset of users in
+    # that workspace or organization, depending on its permissions.
+    #
+    # Projects in organizations are shared with a single team. You cannot currently
+    # change the team of a project via the API. Non-organization workspaces do not
+    # have teams and so you should not specify the team of project in a
+    # regular workspace.
+    class Project < Resource
+
+      include EventSubscription
+
+
+      attr_reader :id
+
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'projects'
+        end
+
+        # Creates a new project in a workspace or team.
+        #
+        # Every project is required to be created in a specific workspace or
+        # organization, and this cannot be changed once set. Note that you can use
+        # the `workspace` parameter regardless of whether or not it is an
+        # organization.
+        #
+        # If the workspace for your project _is_ an organization, you must also
+        # supply a `team` to share the project with.
+        #
+        # Returns the full record of the newly created project.
+        #
+        # workspace - [Id] The workspace or organization to create the project in.
+        # team - [Id] If creating in an organization, the specific team to create the
+        # project in.
+        #
+        # options - [Hash] the request I/O options.
+        # data - [Hash] the attributes to post.
+        def create(client, workspace: required("workspace"), team: nil, options: {}, **data)
+          with_params = data.merge(workspace: workspace, team: team).reject { |_,v| v.nil? || Array(v).empty? }
+          self.new(parse(client.post("/projects", body: with_params, options: options)).first, client: client)
+        end
+
+        # If the workspace for your project _is_ an organization, you must also
+        # supply a `team` to share the project with.
+        #
+        # Returns the full record of the newly created project.
+        #
+        # workspace - [Id] The workspace or organization to create the project in.
+        # options - [Hash] the request I/O options.
+        # data - [Hash] the attributes to post.
+        def create_in_workspace(client, workspace: required("workspace"), options: {}, **data)
+
+          self.new(parse(client.post("/workspaces/#{workspace}/projects", body: data, options: options)).first, client: client)
+        end
+
+        # Creates a project shared with the given team.
+        #
+        # Returns the full record of the newly created project.
+        #
+        # team - [Id] The team to create the project in.
+        # options - [Hash] the request I/O options.
+        # data - [Hash] the attributes to post.
+        def create_in_team(client, team: required("team"), options: {}, **data)
+
+          self.new(parse(client.post("/teams/#{team}/projects", body: data, options: options)).first, client: client)
+        end
+
+        # Returns the complete project record for a single project.
+        #
+        # id - [Id] The project to get.
+        # options - [Hash] the request I/O options.
+        def find_by_id(client, id, options: {})
+
+          self.new(parse(client.get("/projects/#{id}", options: options)).first, client: client)
+        end
+
+        # Returns the compact project records for some filtered set of projects.
+        # Use one or more of the parameters provided to filter the projects returned.
+        #
+        # workspace - [Id] The workspace or organization to filter projects on.
+        # team - [Id] The team to filter projects on.
+        # archived - [Boolean] Only return projects whose `archived` field takes on the value of
+        # this parameter.
+        #
+        # per_page - [Integer] the number of records to fetch per page.
+        # options - [Hash] the request I/O options.
+        def find_all(client, workspace: nil, team: nil, archived: nil, per_page: 20, options: {})
+          params = { workspace: workspace, team: team, archived: archived, limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+          Collection.new(parse(client.get("/projects", params: params, options: options)), type: self, client: client)
+        end
+
+        # Returns the compact project records for all projects in the workspace.
+        #
+        # workspace - [Id] The workspace or organization to find projects in.
+        # archived - [Boolean] Only return projects whose `archived` field takes on the value of
+        # this parameter.
+        #
+        # 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"), archived: nil, per_page: 20, options: {})
+          params = { archived: archived, limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+          Collection.new(parse(client.get("/workspaces/#{workspace}/projects", params: params, options: options)), type: self, client: client)
+        end
+
+        # Returns the compact project records for all projects in the team.
+        #
+        # team - [Id] The team to find projects in.
+        # archived - [Boolean] Only return projects whose `archived` field takes on the value of
+        # this parameter.
+        #
+        # per_page - [Integer] the number of records to fetch per page.
+        # options - [Hash] the request I/O options.
+        def find_by_team(client, team: required("team"), archived: nil, per_page: 20, options: {})
+          params = { archived: archived, limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+          Collection.new(parse(client.get("/teams/#{team}/projects", params: params, options: options)), type: self, client: client)
+        end
+      end
+
+      # A specific, existing project can be updated by making a PUT request on the
+      # URL for that project. Only the fields provided in the `data` block will be
+      # updated; any unspecified fields will remain unchanged.
+      #
+      # When using this method, it is best to specify only those fields you wish
+      # to change, or else you may overwrite changes made by another user since
+      # you last retrieved the task.
+      #
+      # Returns the complete updated project record.
+      #
+      # options - [Hash] the request I/O options.
+      # data - [Hash] the attributes to post.
+      def update(options: {}, **data)
+
+        refresh_with(parse(client.put("/projects/#{id}", body: data, options: options)).first)
+      end
+
+      # A specific, existing project can be deleted by making a DELETE request
+      # on the URL for that project.
+      #
+      # Returns an empty data record.
+      def delete()
+
+        client.delete("/projects/#{id}") && true
+      end
+
+    end
+  end
+end

data/lib/asana/resources/story.rb

@@ -0,0 +1,64 @@
+### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
+### edit it manually.
+
+module Asana
+  module Resources
+    # A _story_ represents an activity associated with an object in the Asana
+    # system. Stories are generated by the system whenever users take actions such
+    # as creating or assigning tasks, or moving tasks between projects. _Comments_
+    # are also a form of user-generated story.
+    #
+    # Stories are a form of history in the system, and as such they are read-only.
+    # Once generated, it is not possible to modify a story.
+    class Story < Resource
+
+
+      attr_reader :id
+
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'stories'
+        end
+
+        # Returns the full record for a single story.
+        #
+        # 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("/stories/#{id}", options: options)).first, client: client)
+        end
+
+        # Returns the compact records for all stories on the task.
+        #
+        # task - [Id] Globally unique identifier for the task.
+        #
+        # per_page - [Integer] the number of records to fetch per page.
+        # options - [Hash] the request I/O options.
+        def find_by_task(client, task: required("task"), per_page: 20, options: {})
+          params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+          Collection.new(parse(client.get("/tasks/#{task}/stories", params: params, options: options)), type: self, client: client)
+        end
+
+        # Adds a comment to a task. The comment will be authored by the
+        # currently authenticated user, and timestamped when the server receives
+        # the request.
+        #
+        # Returns the full record for the new story added to the task.
+        #
+        # task - [Id] Globally unique identifier for the task.
+        #
+        # text - [String] The plain text of the comment to add.
+        # options - [Hash] the request I/O options.
+        # data - [Hash] the attributes to post.
+        def create_on_task(client, task: required("task"), text: required("text"), options: {}, **data)
+          with_params = data.merge(text: text).reject { |_,v| v.nil? || Array(v).empty? }
+          self.new(parse(client.post("/tasks/#{task}/stories", body: with_params, options: options)).first, client: client)
+        end
+      end
+
+    end
+  end
+end