tenk 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 093232af1d5cd795516e931877bbb4d530bb664d
-  data.tar.gz: 016d76cb18cc7e7eb657b9f7ceec1048425cc010
+  metadata.gz: 481030d31a51a4b9af37b7610a1898e827741ffa
+  data.tar.gz: 2ba195e09023d21d85077ad2010d3ae0edd07b77
 SHA512:
-  metadata.gz: f40f2afa5d45a2fc294463182409d73041de959ea34cdc8d8f7ac6ac78318f74c5b0d538ccba62cd3a639642adb0c1790a81969877a714de655b82bf507c0620
-  data.tar.gz: e7b9564a844715ff09c7252bbe1d743dda79447541e92c11884899d183f44a217897941799cd267235bd9586d12c883fae91357fde27a58098059fca14581aff
+  metadata.gz: d8e47f142b68614f2c27604dc10620504ac59f17368582334c20b54c4626b86324cd1400607277c369309b6be25b3b372fb1c1d447974814d56e8f31ecd0b9bd
+  data.tar.gz: 1d3f00dc05feb8a07b5df4939143c804cb861ebc8f9c4ef38bad722a2a4a1b8a6d65f7fddcfa6da6ef3c0b5da0c5e6e21de87ad7caa8a09b42bc21930f98e4ca

data/bin/tenk

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+require 'bundler'
+Bundler.setup(:default)
+require 'optparse'
+require 'tenk'
+
+options = {}
+
+opt_parser = OptionParser.new do |opt|
+  opt.banner = "Usage: tenk #{$PROGRAM_NAME} COMMAND"
+  opt.separator ''
+  opt.separator 'Commands'
+  opt.separator '  list_people: list people in your 10k account'
+  opt.separator '  list_projects: list projects in your 10k account'
+  opt.separator ''
+  opt.separator 'Options'
+
+  opt.on('-h', '--help', 'help') do
+    puts opt_parser
+  end
+end
+
+opts = opt_parser.parse!
+
+def client
+  token = ENV['TENK_TOKEN'] || fail('No api token set. Set TENK_TOKEN environment variable.')
+  @_client ||= Tenk.new token: token, api_base: ENV['TENK_API_BASE']
+end
+
+def list_people
+  users = []
+  page = 1
+  loop do
+    response = client.users.list(page: page)
+    new_users = response.data
+    users << new_users
+    break unless response.paging.next
+    page += 1
+  end
+  users.flatten!
+  discipline_groups = users.group_by(&:discipline)
+  discipline_groups.map do |discipline, group|
+    puts ''
+    puts discipline
+    group.each do |person|
+      puts "  - [ ] #{person.display_name}"
+    end
+    puts ''
+  end
+end
+
+def list_projects
+  projects = []
+  page = 1
+  loop do
+    response = client.projects.list(page: page)
+    new_projects = response.data
+    projects << new_projects
+    break unless response.paging.next
+    page += 1
+  end
+  projects.flatten!
+  project_groups = projects.sort_by(&:name).group_by(&:project_state)
+  project_groups.each do |state, projects|
+    puts ''
+    puts state
+    projects.each do |project|
+      puts "  - [ ] #{project.name}"
+    end
+    puts ''
+  end
+end
+
+case ARGV[0]
+when 'list_people'
+  list_people
+when 'list_projects'
+  list_projects
+else
+  puts opt_parser
+end

data/lib/approvals.rb

@@ -0,0 +1,59 @@
+require 'hashie'
+
+module Tenk
+  # API actions for Approval resource which represents an approval of a time
+  # entry or expense item
+  class Approvals < ::Tenk::Resource
+    # The valid parameters for an Approval list request
+    class ListRequest < ::Hashie::Trash
+      property :fields, default: ''
+      property :per_page, default: 20
+      property :page, default: 1
+    end
+
+    # The valid parameters for an Approval get request
+    class GetRequest < ::Hashie::Trash
+      property :fields, default: ''
+    end
+
+    # The valid parameters for an approval create request
+    class CreateRequest < ::Hashie::Trash
+      property :approvables
+      property :status
+    end
+
+    # The valid parameters for an approval update request
+    class UpdateRequest < CreateRequest
+    end
+
+    # List Approvals from this 10k account
+    # @param opts [Hash] the query parameters for the list request
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    # @see Tenk::Approvals::ListRequest
+    def list(opts = {})
+      super(ListRequest.new(opts))
+    end
+
+    # Get one Approval from the 10k account
+    # @param id [Integer] the id of the Approval
+    # @return [Hashie::Mash] the API response as a Hashie::Mash
+    # @see Tenk::Approvals::GetRequest
+    def get(id, opts = {})
+      super(id, GetRequest.new(opts))
+    end
+
+    # FIXME: CREATE does not work due to the permissions of API users
+
+    # def create(opts = {})
+    #   @_client.logger.warn("Approvals currently cannot be created with API")
+    #   @_client.post_with_body(resource_root, CreateRequest.new(opts))
+    # end
+
+    # FIXME: UPDATE does not work due to the permissions of API users
+
+    # def update(id, opts = {})
+    #   @_client.logger.warn("Approvals currently cannot be updated with API")
+    #   super(id, UpdateRequest.new(opts))
+    # end
+  end
+end

data/lib/bill_rates.rb

@@ -0,0 +1,57 @@
+require 'hashie'
+
+module Tenk
+  # The API methods for obtaining and manipulating bill rats
+  class BillRates < ::Tenk::Resource
+    # The valid parameters for a BillRate list request
+    class ListRequest < ::Hashie::Trash
+      property :per_page, default: 20
+      property :page, default: 1
+    end
+
+    # The valid parameters for a BillRate get request
+    class GetRequest < ::Hashie::Trash; end
+
+    # The valid parameters for a BillRate create request
+    class CreateRequest < ::Hashie::Trash
+      property :discipline_id
+      property :role_id
+      property :assignable_id
+      property :user_id
+      property :rate
+      property :starts_at
+      property :ends_at
+      property :startdate
+      property :enddate
+    end
+
+    # The valid paramters for a BillRate update request
+    class UpdateRequest < CreateRequest; end
+
+    # FIXME: LIST does not work due to permissions of API users
+
+    # def list(opts = {})
+    #   super(ListRequest.new(opts))
+    # end
+
+    # GET does not work due to permissions of API users
+
+    # def get(id)
+    #   super(id, {})
+    # end
+
+    # FIXME: CREATE does not work
+
+    # def create(opts = {})
+    #   super(CreateRequest.new(opts))
+    # end
+
+    # Update a BillRate for this 10k account
+    # @param id [Integer] the id of the bill rate
+    # @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/client.rb

@@ -0,0 +1,153 @@
+require 'faraday'
+require 'hashie'
+require 'json'
+
+require_relative './configuration'
+require_relative './resource'
+require_relative './placeholder_resources'
+require_relative './time_entries'
+require_relative './users'
+require_relative './bill_rates'
+require_relative './projects'
+require_relative './approvals'
+
+module Tenk
+  # One client of the 10k API
+  class Client
+    attr_accessor :configuration
+    attr_accessor :logger
+
+    # Initialize a new Tenk client
+    # @param options [Hash] configuration options for the client
+    # @param block [Block] a block which will receive the new client as an arg
+    # @see Configuration
+    def initialize(options = {}, &block)
+      self.configuration = Configuration.new(options)
+      self.logger = configuration.logger
+
+      yield_or_eval(&block) if block_given?
+    end
+
+    # If a block is given, invoke it with this client. If the block takes no
+    # args, then just execute it as an instance of the client
+    def yield_or_eval(&block)
+      return unless block
+      block.arity > 0 ? yield(self) : instance_eval(&block)
+    end
+
+    # The Faraday connection used by this client
+    def connection
+      Faraday.new(url: configuration.api_base) do |faraday|
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    # Make a request to url, with a given method and options, and wrap the
+    # response in a Hashie::Mash
+    # @param url [String] the URL where to send the request
+    # @param method [Symbol] the HTTP method to use to send the request
+    # @param url_opts [Hash] the request payload, which will become query params
+    # @return [Hashie::Mash] the API response wrapped in a Hashie::Mash
+    def request(url, method, url_opts = {})
+      hashify_response(
+        connection.send(method) do |req|
+          req.url configuration.api_base + url, url_opts
+          req.headers['Content-Type'] = 'application/json'
+          req.headers['auth'] = configuration.token
+        end,
+      )
+    end
+
+    # Make a GET request to the API
+    # @param url [String] the URL where to send the request
+    # @param url_opts [Hash] the request payload, which will become query params
+    # @return [Hashie::Mash] the API response wrapped in a Hashie::Mash
+    def get(url, url_opts = {})
+      request(url, :get, url_opts)
+    end
+
+    # Make a POST request to the API
+    # @param url [String] the URL where to send the request
+    # @param url_opts [Hash] the request payload, which will become query params
+    # @return [Hashie::Mash] the API response wrapped in a Hashie::Mash
+    def post(url, url_opts = {})
+      request(url, :post, url_opts)
+    end
+
+    # Make a POST request to the API and use url_opts as a body payload instead
+    # of query params
+    # @param url [String] the URL where to send the request
+    # @param url_opts [Hash] the request payload, which will become the POST body
+    # @return [Hashie::Mash] the API response wrapped in a Hashie::Mash
+    def post_with_body(url, url_opts = {})
+      hashify_response(
+        get_connection.post do |req|
+          req.url configuration.api_base + url
+          req.body = JSON.generate(url_opts)
+          req.headers['Content-Type'] = 'application/json'
+          req.headers['auth'] = configuration.token
+        end,
+      )
+    end
+
+    # Make a PUT request to the API
+    # @param url [String] the URL where to send the request
+    # @param url_opts [Hash] the request payload, which will become query params
+    # @return [Hashie::Mash] the API response wrapped in a Hashie::Mash
+    def put(url, url_opts = {})
+      request(url, :put, url_opts)
+    end
+
+    # Make a DELETE request to the API
+    # @param url [String] the URL where to send the request
+    # @param url_opts [Hash] the request payload, which will become query params
+    # @return [Hashie::Mash] the API response wrapped in a Hashie::Mash
+    def delete(url, url_opts = {})
+      request(url, :delete, url_opts)
+    end
+
+    # Access the User resource using this client
+    # @return [Tenk::Users] a Users API class
+    def users
+      @_users ||= Tenk::Users.new(self)
+    end
+
+    # Access the PlaceholderResources resource using this client
+    # @return [Tenk::PlaceholderResources] a PlaceholderResources API class
+    def placeholder_resources
+      @_placeholder_resources ||= Tenk::PlaceholderResources.new(self)
+    end
+
+    # Access the Project resource using this client
+    # @return [Tenk::Projects] a Projects API class
+    def projects
+      @_projects ||= Tenk::Projects.new(self)
+    end
+
+    # Access the TimeEntry resource using this client
+    # @return [Tenk::TimeEntries] a TimeEntries API class
+    def time_entries
+      @_time_entries ||= Tenk::TimeEntries.new(self)
+    end
+
+    # Access the BillRates resource using this client
+    # @return [Tenk::BillRates] a BillRates API class
+    def bill_rates
+      @_bill_rates ||= Tenk::BillRates.new(self)
+    end
+
+    # Access the Approvals resource using this client
+    # @return [Tenk::Approvals] a Approvals API class
+    def approvals
+      @_approvals ||= Tenk::Approvals.new(self)
+    end
+
+    # Take a Farady response and turn it into a Hashie::Mash
+    # @param resp [Faraday::Response] a response provided by Faraday
+    # @return [Hashie::Mash] a Hashie::Mash version of the response body
+    def hashify_response(resp)
+      return true if resp.body.empty?
+      Hashie::Mash.new(JSON.parse(resp.body))
+    end
+  end
+end

data/lib/configuration.rb

@@ -0,0 +1,35 @@
+require 'logger'
+
+module Tenk
+  # Holds the configuration for a Tenk client (API key and base URL, and logger)
+  class Configuration
+    attr_accessor :token
+    attr_writer :api_base
+    attr_writer :logger
+
+    # Intialize a Tenk::Configuration
+    # @param opts [Hash] the configuration options
+    def initialize(opts = {})
+      opts.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    # Return the base URL of the API
+    # @return [String] the base URL of the API
+    def api_base
+      @api_base || 'https://api.10000ft.com/api/v1'
+    end
+
+    # Return the current logger being used by the gem
+    # @return [Logger] the current logger
+    def logger
+      if @logger.blank?
+        @logger = Logger.new(STDERR)
+        @logger.level = Logger::WARN
+      end
+
+      @logger
+    end
+  end
+end

data/lib/placeholder_resources.rb

@@ -0,0 +1,51 @@
+require 'hashie'
+
+module Tenk
+  # API methods for PlaceholderResources, which are like Users, except they
+  # don't represent a specific person, but rather a Placeholder on the schedule
+  # for a certain kind of person / discipline
+  class PlaceholderResources < ::Tenk::Resource
+    # The valid parameters for a PlaceholderResources list request
+    class ListRequest < ::Hashie::Trash
+      property :fields, default: ''
+      property :per_page, default: 20
+      property :page, default: 1
+    end
+
+    # The valid parameters for a PlaceholderResources get request
+    class GetRequest < ::Hashie::Trash
+      property :fields, default: ''
+    end
+
+    # The valid parameters for a PlaceholderResources create request
+    class CreateRequest < ::Hashie::Trash
+      property :title
+      property :role
+      property :discipline
+      property :location
+    end
+
+    # The valid parameters for a PlaceholderResources update request
+    class UpdateRequest < CreateRequest
+    end
+
+    # FIXME: Can't test these on staging because Placeholders don't seem to
+    #   be enabled on staging
+
+    # def list(opts = {})
+    #   super(ListRequest.new(opts))
+    # end
+    #
+    # def get(id, opts = {})
+    #   super(id, GetRequest.new(opts))
+    # end
+    #
+    # def create(opts = {})
+    #   super(CreateRequest.new(opts))
+    # end
+    #
+    # def update(id, opts = {})
+    #   super(id, UpdateRequest.new(opts))
+    # end
+  end
+end

data/lib/projects/assignments.rb

@@ -0,0 +1,80 @@
+require 'hashie'
+
+require_relative './project_resource'
+
+module Tenk
+  # The API methods for Assignments which represent that a given user is
+  # assigned to a project or phase
+  class Projects::Assignments < ::Tenk::Projects::ProjectResource
+    # 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 :user_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 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::Assignments::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 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::Projects::Assignments::GetRequest
+    def get(project_id, assignment_id, opts = {})
+      super(project_id, assignment_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::Assignments::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 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::Projects::Assignments::UpdateRequest
+    def update(project_id, assignment_id, opts = {})
+      super(project_id, assignment_id, UpdateRequest.new(opts))
+    end
+
+    # Delete an Assignment for this project
+    # @param project_id [Integer] the id of the project
+    # @param assignment_id [Integer] the id of the assignment
+    # @return [bool] true if successful
+    def delete(project_id, assignment_id)
+      super(project_id, assignment_id)
+    end
+  end
+end

data/lib/projects/bill_rates.rb

@@ -0,0 +1,52 @@
+require 'hashie'
+
+require_relative './project_resource'
+
+module Tenk
+  # The API methods for BillRate resources
+  class Projects::BillRates < ::Tenk::Projects::ProjectResource
+    # The valid request parameters for listing BillRates
+    class ListRequest < ::Tenk::BillRates::ListRequest; end
+    # The valid request parameters for creating BillRates
+    class CreateRequest < ::Tenk::BillRates::CreateRequest; end
+    # The valid request parameters for updating BillRates
+    class UpdateRequest < ::Tenk::BillRates::UpdateRequest; end
+
+    # List BillRates 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::BillRates::ListRequest
+    def list(project_id, opts = {})
+      super(project_id, ListRequest.new(opts))
+    end
+
+    # Get a single BillRate for this project
+    # @param project_id [Integer] the id of the project
+    # @param bill_rate_id [Integer] the id of the bill_rate
+    # @return [Hashie::Mash] the response as a Hashie::Mash
+    # @see Tenk::Projects::BillRates::GetRequest
+    def get(project_id, bill_rate_id)
+      super(project_id, bill_rate_id, {})
+    end
+
+    # Create a new BillRate 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::BillRates::CreateRequest
+    def create(project_id, opts = {})
+      super(project_id, CreateRequest.new(opts))
+    end
+
+    # Update an BillRate for this project
+    # @param project_id [Integer] the id of the project
+    # @param bill_rate_id [Integer] the id of the bill_rate
+    # @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::BillRates::UpdateRequest
+    def update(project_id, bill_rate_id, opts = {})
+      super(project_id, bill_rate_id, UpdateRequest.new(opts))
+    end
+  end
+end

data/lib/projects/phases.rb

@@ -0,0 +1,63 @@
+require 'hashie'
+
+require_relative './project_resource'
+
+module Tenk
+  # The API methods for Phases, which represent a part of a project with its own
+  # budget and resources
+  class Projects::Phases < ::Tenk::Projects::ProjectResource
+    # The valid parameters for a Phase list request
+    class ListRequest < Tenk::Projects::ListRequest; end
+
+    # The valid parameters for a Phase get request
+    class GetRequest < Tenk::Projects::GetRequest; end
+
+    # The valid parameters for a Phase create request
+    class CreateRequest < Tenk::Projects::CreateRequest
+      property :phase_name
+    end
+
+    # The valid parameters for a Phase update request
+    class UpdateRequest < Tenk::Projects::UpdateRequest
+      property :phase_name
+    end
+
+    # List Phases 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::Phases::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 phase_id [Integer] the id of the phase
+    # @param opts [Hash] the query parameters to add to the get request
+    # @return [Hashie::Mash] the response as a Hashie::Mash
+    # @see Tenk::Projects::Phases::GetRequest
+    def get(project_id, phase_id, opts = {})
+      super(project_id, phase_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::Phases::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 phase_id [Integer] the id of the phase
+    # @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::Phases::UpdateRequest
+    def update(project_id, phase_id, opts = {})
+      super(project_id, phase_id, UpdateRequest.new(opts))
+    end
+  end
+end