tenk 0.0.1 → 0.0.2

data/lib/projects/project_resource.rb

@@ -0,0 +1,51 @@
+require 'hashie'
+require 'active_support'
+require 'active_support/core_ext'
+
+module Tenk
+  # A base class for subresources under a project (within a /projects/:id url
+  # space)
+  class Projects::ProjectResource
+    def initialize(client)
+      @_client = client
+    end
+
+    # The base route for subresources under this project
+    # By default, infers this URL from the resource class name
+    # @param project_id [Integer] the id of this project
+    # @return [String] the base URL for the subresource
+    def resource_root(project_id)
+      "/projects/#{project_id}/#{self.class.name.demodulize.tableize}"
+    end
+
+    # The default implementation of list requests for project subresources
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    def list(project_id, options)
+      @_client.get(resource_root(project_id), options)
+    end
+
+    # The default implementation of get requests for project subresources
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    def get(project_id, id, options)
+      @_client.get("#{resource_root(project_id)}/#{id}", options)
+    end
+
+    # The default implementation of create requests for project subresources
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    def create(project_id, options)
+      @_client.post(resource_root(project_id), options)
+    end
+
+    # The default implementation of update requests for project subresources
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    def update(project_id, id, options)
+      @_client.put("#{resource_root(project_id)}/#{id}", options)
+    end
+
+    # The default implementation of delete requests for project subresources
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    def delete(project_id, id)
+      @_client.delete("#{resource_root(project_id)}/#{id}")
+    end
+  end
+end

data/lib/projects/tags.rb

@@ -0,0 +1,44 @@
+require 'hashie'
+
+require_relative './project_resource'
+
+module Tenk
+  # API methods for attaching and removing tags from a project
+  class Projects::Tags
+    # The valid parameters for a Tag list request
+    class ListRequest < ::Hashie::Trash
+      property :fields, default: ''
+      property :per_page, default: 20
+      property :page, default: 1
+    end
+
+    # Initialize a Tenk::Projects::Tag resource API wrapper for the given client
+    def initialize(client)
+      @_client = client
+    end
+
+    # List Tags for a single project
+    # @param project_id [Integer] the id of the project
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    # @see Tenk::Projects::Tags::ListRequest
+    def list(project_id)
+      @_client.get("/projects/#{project_id}/tags")
+    end
+
+    # Attach a tag to a project
+    # @param project_id [Integer] the id of the project
+    # @param tag [String] the string of the tag to attach
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    def add(project_id, tag)
+      @_client.post("/projects/#{project_id}/tags", value: tag)
+    end
+
+    # Remove a tag from a project
+    # @param project_id [Integer] the id of the project
+    # @param tag_id [Integer] the integer id of the tag
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    def remove(project_id, tag_id)
+      @_client.delete("/projects/#{project_id}/tags/#{tag_id}")
+    end
+  end
+end

data/lib/projects/time_entries.rb

@@ -0,0 +1,58 @@
+require 'hashie'
+
+require_relative './project_resource'
+
+module Tenk
+  # API methods for TimeEntries of a project
+  class Projects::TimeEntries < ::Tenk::Projects::ProjectResource
+    # The valid parameters of a list TimeEntries of project request
+    class ListRequest < ::Tenk::TimeEntries::ListRequest; end
+
+    # The valid parameters of a get TimeEntries of project request
+    class GetRequest < ::Tenk::TimeEntries::GetRequest; end
+
+    # The valid parameters of a create TimeEntries of project request
+    class CreateRequest < ::Tenk::TimeEntries::CreateRequest; end
+
+    # The valid parameters of a update TimeEntries of project request
+    class UpdateRequest < ::Tenk::TimeEntries::UpdateRequest; end
+
+    # List TimeEntries for a single project
+    # @param project_id [Integer] the id of the project
+    # @param opts [Hash] the query parameters to add to list request
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    # @see Tenk::Projects::TimeEntries::ListRequest
+    def list(project_id, opts = {})
+      super(project_id, ListRequest.new(opts))
+    end
+
+    # Get a single Assignment for this project
+    # @param project_id [Integer] the id of the project
+    # @param time_entry_id [Integer] the id of the time entry
+    # @param opts [Hash] the query parameters to add to the get request
+    # @return [Hashie::Mash] the response as a Hashie::Mash
+    # @see Tenk::Projects::TimeEntries::GetRequest
+    def get(project_id, time_entry_id, opts = {})
+      super(project_id, time_entry_id, GetRequest.new(opts))
+    end
+
+    # Create a new Assignment for this project
+    # @param project_id [Integer] the id of the project
+    # @param opts [Hash] the post parameters to add to the create request
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    # @see Tenk::Projects::TimeEntries::CreateRequest
+    def create(project_id, opts = {})
+      super(project_id, CreateRequest.new(opts))
+    end
+
+    # Update an Assignment for this project
+    # @param project_id [Integer] the id of the project
+    # @param time_entry_id [Integer] the id of the time entry
+    # @param opts [Hash] the post parameters to add to the create request
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    # @see Tenk::Projects::TimeEntries::UpdateRequest
+    def update(project_id, time_entry_id, opts = {})
+      super(project_id, time_entry_id, UpdateRequest.new(opts))
+    end
+  end
+end

data/lib/projects/users.rb

@@ -0,0 +1,25 @@
+require 'hashie'
+
+require_relative './project_resource'
+
+module Tenk
+  # API methods for Users resource under a project, which lists users tied to
+  # a particular project
+  class Projects::Users < ::Tenk::Projects::ProjectResource
+    # Valid parameters for a list request of users of a project
+    class ListRequest < ::Hashie::Trash
+      property :fields, default: ''
+      property :per_page, default: 20
+      property :page, default: 1
+    end
+
+    # List Users for a single project
+    # @param project_id [Integer] the id of the project
+    # @param opts [Hash] the query parameters to add to list request
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    # @see Tenk::Projects::Users::ListRequest
+    def list(project_id, opts = {})
+      super(project_id, ListRequest.new(opts))
+    end
+  end
+end

data/lib/projects.rb

@@ -0,0 +1,120 @@
+require 'hashie'
+
+module Tenk
+  # API methods for Project resources
+  class Projects < ::Tenk::Resource
+    # Valid parameters for a project list request
+    class ListRequest < ::Hashie::Trash
+      property :from
+      property :to
+      property :fields, default: ''
+      property :filter_field
+      property :filter_list
+      property :sort_field
+      property :sort_order
+      property :project_code
+      property :phase_name
+      property :with_archived, default: false
+      property :with_phases, default: false
+      property :per_page, default: 20
+      property :page, default: 1
+    end
+
+    # Valid parameters for a project get request
+    class GetRequest < ::Hashie::Trash
+      property :fields, default: ''
+    end
+
+    # Valid parameters for a project create request
+    class CreateRequest < ::Hashie::Trash
+      property :name
+      property :starts_at
+      property :ends_at
+      property :archived
+      property :client
+      property :description
+      property :project_code
+    end
+
+    # Valid parameters for a project update request
+    class UpdateRequest < CreateRequest
+    end
+
+    require_relative './projects/users'
+    require_relative './projects/tags'
+    require_relative './projects/phases'
+    require_relative './projects/time_entries'
+    require_relative './projects/assignments'
+    require_relative './projects/bill_rates'
+
+    # A User subresource of Projects
+    # @return [Projects::Users] a User subresource API class
+    def users
+      @_users ||= Projects::Users.new(@_client)
+    end
+
+    # A Tag subresource of Projects
+    # @return [Projects::Tags] a Tag subresource API class
+    def tags
+      @_tags ||= Projects::Tags.new(@_client)
+    end
+
+    # A Phase subresource of Projects
+    # @return [Projects::Phases] a Phase subresource API class
+    def phases
+      @_phases ||= Projects::Phases.new(@_client)
+    end
+
+    # A TimeEntry subresource of Projects
+    # @return [Projects::TimeEntries] a TimeEntries subresource API class
+    def time_entries
+      @_time_entries ||= Projects::TimeEntries.new(@_client)
+    end
+
+    # An Assignments subresource of Projects
+    # @return [Projects::Assignments] a Assignment subresource API class
+    def assignments
+      @_assignments ||= Projects::Assignments.new(@_client)
+    end
+
+    # A BillRate subresource of Projects
+    # @return [Projects::BillRates] a BillRate subresource API class
+    def bill_rates
+      @_bill_rates ||= Projects::BillRates.new(@_client)
+    end
+
+    # List projects for this 10k account
+    # @param opts [Hash] the query parameters for the list request
+    # @return [Hashie::Mash] the API response wrapped in a Hashie::Mash
+    # @see ListRequest
+    def list(opts = {})
+      super(ListRequest.new(opts))
+    end
+
+    # Get a single project for this 10k account
+    # @param id [Integer] the id of this project
+    # @param opts [Hash] the query parameters for the list request
+    # @return [Hashie::Mash] the API response wrapped in a Hashie::Mash
+    # @see GetRequest
+    def get(id, opts = {})
+      super(id, GetRequest.new(opts))
+    end
+
+    # Create a new project in this 10k account
+    # @param opts [Hash] the parameters for this create request
+    # @return [Hashie::Mash] the API response wrapped in a Hashie::Mash
+    # @see CreateRequest
+    def create(opts = {})
+      super(CreateRequest.new(opts))
+    end
+
+    # Update a project in this 10k account
+    # @param id [Integer] the id of this project
+    # @param opts [Hash] the parameters for this update request
+    # @return [Hashie::Mash] the API response wrapped in a Hashie::Mash
+    # @see UpdateRequest
+    def update(id, opts = {})
+      super(id, UpdateRequest.new(opts))
+    end
+  end
+end

data/lib/resource.rb

@@ -0,0 +1,39 @@
+require 'hashie'
+require 'active_support'
+require 'active_support/core_ext'
+
+module Tenk
+  # The base class for all API resources
+  class Resource
+    # Initialize a base API resource from the client
+    def initialize(client)
+      @_client = client
+    end
+
+    # The root for this resource. Default is based on class name tableized
+    # @return [String] the root url for actions on this resource
+    def resource_root
+      "/#{self.class.name.demodulize.tableize}"
+    end
+
+    # The base method for list requests on all resources
+    def list(options)
+      @_client.get(resource_root, options)
+    end
+
+    # The base method for get requests on all resources
+    def get(id, options)
+      @_client.get("#{resource_root}/#{id}", options)
+    end
+
+    # The base method for create requests on all resources
+    def create(options)
+      @_client.post(resource_root, options)
+    end
+
+    # The base method for update requests on all resources
+    def update(id, options)
+      @_client.put("#{resource_root}/#{id}", options)
+    end
+  end
+end

data/lib/time_entries.rb

@@ -0,0 +1,65 @@
+require 'hashie'
+
+module Tenk
+  # API methods for TimeEntries resources, which represent time that users are
+  # tracking against projects or phases
+  class TimeEntries < ::Tenk::Resource
+    # Valid parameters for time entry list requests
+    class ListRequest < ::Hashie::Trash
+      property :from
+      property :to
+      property :with_suggestions
+      property :fields
+    end
+
+    # Valid parameters for a time entry get requests
+    class GetRequest < ::Hashie::Trash; end
+
+    # Valid parameters for a time entry create requests
+    class CreateRequest < ::Hashie::Trash
+      property :user_id
+      property :assignable_id
+      property :project_id
+      property :leave_type_id
+      property :date
+      property :hours
+      property :task
+      property :notes
+    end
+
+    # Valid parameters for a time entry update requests
+    class UpdateRequest < CreateRequest; end
+
+    # List TimeEntries for an account
+    # @param opts [Hash] the filter parameters for the list
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    # @see ListRequest
+    def list(opts = {})
+      super(ListRequest.new(opts))
+    end
+
+    # Get a single TimeEntry for an account
+    # @param id [Integer] the id of the TimeEntry
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    def get(id)
+      super(id, {})
+    end
+
+    # Create a TimeEntry for this account
+    # @param opts [Hash] the attributes of the TimeEntry to create
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    # @see CreateRequest
+    def create(opts = {})
+      super(CreateRequest.new(opts))
+    end
+
+    # Update a TimeEntry for this account
+    # @param id [Integer] the id of the TimeEntry
+    # @param opts [Hash] the attributes of the TimeEntry to update
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    # @see UpdateRequest
+    def update(id, opts = {})
+      super(id, UpdateRequest.new(opts))
+    end
+  end
+end

data/lib/users/assignments.rb

@@ -0,0 +1,82 @@
+require 'hashie'
+
+require_relative './user_resource'
+
+module Tenk
+  # The API methods for Assignments, which record that a particular person is
+  # assigned to a user or phase
+  class Users::Assignments < ::Tenk::Users::UserResource
+    # The valid parameters for an Assignment list request
+    class ListRequest < ::Hashie::Trash
+      property :from
+      property :to
+      property :per_page
+      property :page
+    end
+
+    # The valid parameters for an Assignment get request
+    class GetRequest < ::Hashie::Trash; end
+
+    # The valid parameters for an Assignment create request
+    class CreateRequest < ::Hashie::Trash
+      property :project_id
+      property :assignable_id
+      property :leave_type_id
+      property :starts_at
+      property :ends_at
+      property :percent
+      property :fixed_hours
+      property :hours_per_day
+      property :allocation_mode
+    end
+
+    # The valid parameters for an Assignment update request
+    class UpdateRequest < CreateRequest; end
+
+    # List Assignments for a single user
+    # @param user_id [Integer] the id of the user
+    # @param opts [Hash] the query parameters to add to list request
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    # @see Tenk::Users::Assignments::ListRequest
+    def list(user_id, opts = {})
+      super(user_id, ListRequest.new(opts))
+    end
+
+    # Get a single Assignment for this user
+    # @param user_id [Integer] the id of the user
+    # @param assignment_id [Integer] the id of the assignment
+    # @param opts [Hash] the query parameters to add to the get request
+    # @return [Hashie::Mash] the response as a Hashie::Mash
+    # @see Tenk::Users::Assignments::GetRequest
+    def get(user_id, assignment_id, opts = {})
+      super(user_id, assignment_id, GetRequest.new(opts))
+    end
+
+    # Create a new Assignment for this user
+    # @param user_id [Integer] the id of the user
+    # @param opts [Hash] the post parameters to add to the create request
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    # @see Tenk::Users::Assignments::CreateRequest
+    def create(user_id, opts = {})
+      super(user_id, CreateRequest.new(opts))
+    end
+
+    # Update an Assignment for this user
+    # @param user_id [Integer] the id of the user
+    # @param assignment_id [Integer] the id of the assignment
+    # @param opts [Hash] the post parameters to add to the create request
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    # @see Tenk::Users::Assignments::UpdateRequest
+    def update(user_id, assignment_id, opts = {})
+      super(user_id, assignment_id, UpdateRequest.new(opts))
+    end
+
+    # Delete an Assignment for this user
+    # @param user_id [Integer] the id of the user
+    # @param assignment_id [Integer] the id of the assignment
+    # @return [bool] true if successful
+    def delete(user_id, assignment_id)
+      super(user_id, assignment_id)
+    end
+  end
+end

data/lib/users/tags.rb

@@ -0,0 +1,33 @@
+module Tenk
+  # API methods for listing, adding, and removing tags for users
+  class Tags
+    # Initialize a Tenk::Users::Tag resource API wrapper for the given client
+    def initialize(client)
+      @_client = client
+    end
+
+    # List Tags for a single user
+    # @param user_id [Integer] the id of the user
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    # @see Tenk::Users::Tags::ListRequest
+    def list(user_id)
+      @_client.get("/users/#{user_id}/tags")
+    end
+
+    # Attach a tag to a user
+    # @param user_id [Integer] the id of the user
+    # @param tag [String] the string of the tag to attach
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    def add(user_id, tag)
+      @_client.post("/users/#{user_id}/tags", value: tag)
+    end
+
+    # Remove a tag from a user
+    # @param user_id [Integer] the id of the user
+    # @param tag_id [Integer] the integer id of the tag
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    def remove(user_id, tag_id)
+      @_client.delete("/users/#{user_id}/tags/#{tag_id}")
+    end
+  end
+end

data/lib/users/time_entries.rb

@@ -0,0 +1,58 @@
+require 'hashie'
+
+require_relative './user_resource'
+
+module Tenk
+  # API methods for TimeEntries resources for a particular user
+  class Users::TimeEntries < ::Tenk::Users::UserResource
+    # Valid parameters for a list request of time entries of a user
+    class ListRequest < ::Tenk::TimeEntries::ListRequest; end
+
+    # Valid parameters for a get request of time entries of a user
+    class GetRequest < ::Tenk::TimeEntries::GetRequest; end
+
+    # Valid parameters for a create request of time entries of a user
+    class CreateRequest < ::Tenk::TimeEntries::CreateRequest; end
+
+    # Valid parameters for a update request of time entries of a user
+    class UpdateRequest < ::Tenk::TimeEntries::UpdateRequest; end
+
+    # List TimeEntries for a single user
+    # @param user_id [Integer] the id of the user
+    # @param opts [Hash] the query parameters to add to list request
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    # @see Tenk::Users::TimeEntries::ListRequest
+    def list(user_id, opts = {})
+      super(user_id, ListRequest.new(opts))
+    end
+
+    # Get a single TimeEntry for this user
+    # @param user_id [Integer] the id of the user
+    # @param time_entry_id [Integer] the id of the time entry
+    # @param opts [Hash] the query parameters to add to the get request
+    # @return [Hashie::Mash] the response as a Hashie::Mash
+    # @see Tenk::Users::TimeEntries::GetRequest
+    def get(user_id, time_entry_id, opts = {})
+      super(user_id, time_entry_id, GetRequest.new(opts))
+    end
+
+    # Create a new TimeEntry for this user
+    # @param user_id [Integer] the id of the user
+    # @param opts [Hash] the post parameters to add to the create request
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    # @see Tenk::Users::TimeEntries::CreateRequest
+    def create(user_id, opts = {})
+      super(user_id, CreateRequest.new(opts))
+    end
+
+    # Update an TimeEntry for this user
+    # @param user_id [Integer] the id of the user
+    # @param time_entry_id [Integer] the id of the time entry
+    # @param opts [Hash] the post parameters to add to the create request
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    # @see Tenk::Users::TimeEntries::UpdateRequest
+    def update(user_id, time_entry_id, opts = {})
+      super(user_id, time_entry_id, UpdateRequest.new(opts))
+    end
+  end
+end

data/lib/users/user_resource.rb

@@ -0,0 +1,50 @@
+require 'hashie'
+require 'active_support'
+require 'active_support/core_ext'
+
+module Tenk
+  # A base model for API resources nested under a user (/users/:id subresources)
+  class Users::UserResource
+    def initialize(client)
+      @_client = client
+    end
+
+    # The base route for subresources under this user
+    # By default, infers this URL from the resource class name
+    # @param user_id [Integer] the id of this user
+    # @return [String] the base URL for the subresource
+    def resource_root(user_id)
+      "/users/#{user_id}/#{self.class.name.demodulize.tableize}"
+    end
+
+    # The default implementation of list requests for user subresources
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    def list(user_id, options)
+      @_client.get(resource_root(user_id), options)
+    end
+
+    # The default implementation of get requests for user subresources
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    def get(user_id, id, options)
+      @_client.get("#{resource_root(user_id)}/#{id}", options)
+    end
+
+    # The default implementation of create requests for user subresources
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    def create(user_id, options)
+      @_client.post(resource_root(user_id), options)
+    end
+
+    # The default implementation of update requests for user subresources
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    def update(user_id, id, options)
+      @_client.put("#{resource_root(user_id)}/#{id}", options)
+    end
+
+    # The default implementation of delete requests for user subresources
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    def delete(user_id, id)
+      @_client.delete("#{resource_root(user_id)}/#{id}")
+    end
+  end
+end