teamwork_api 0.1.0 → 0.1.1

data/lib/teamwork_api/api/projects.rb

@@ -1,71 +1,94 @@
+# frozen_string_literal: true
+
 module TeamworkApi
   module API
+    # Client methods for Projects
+    # https://developer.teamwork.com/projects/projects
     module Projects
+      OPTIONAL_GET_ATTRIBUTES = [
+        :status,
+        :updated_after_date,
+        :order_by,
+        :created_after_date,
+        :created_after_time,
+        :cat_id,
+        :include_people,
+        :include_project_owner,
+        :page,
+        :page_size,
+        :order_mode,
+        :only_starred_projects,
+        :company_id,
+        :project_owner_ids,
+        :search_term,
+        :get_deleted,
+        :include_tags,
+        :user_id,
+        :updated_after_date_time
+      ].freeze
+      OPTIONAL_CREATE_ATTRIBUTES = [
+        :description,
+        :start_date,
+        :end_date,
+        :company_id,
+        :new_company,
+        :'harvest-timers-enabled',
+        :tags,
+        :reply_by_email_enabled,
+        :privacy_enabled
+      ].freeze
+      OPTIONAL_UPDATE_ATTRIBUTES = [
+        :name,
+        :description,
+        :start_date,
+        :end_date,
+        :company_id,
+        :new_company,
+        :status,
+        :'category-id',
+        :'harvest-timers-enabled',
+        :tags,
+        :reply_by_email_enabled,
+        :privacy_enabled,
+        :'use-tasks',
+        :'use-messages',
+        :'use-time',
+        :'use-risk-register',
+        :'use-billing',
+        :'use-milestones',
+        :'use-files',
+        :'use-notebook',
+        :'use-links',
+        :default_privacy
+      ].freeze
+
       def create_project(args)
         args =
           API.params(args)
              .required(:name)
              .default('category-id': '0')
-             .optional(
-               :description,
-               :start_date,
-               :end_date,
-               :company_id,
-               :new_company,
-               :'harvest-timers-enabled',
-               :tags,
-               :reply_by_email_enabled,
-               :privacy_enabled
-             ).to_h
+             .optional(*OPTIONAL_CREATE_ATTRIBUTES)
+             .to_h
 
         response = post 'projects.json', project: args
-        response['id']
+        response['id']&.to_i
       end
 
       def update_project(project_id, args)
-        args =
-          API.params(args)
-             .optional(
-               :name,
-               :description,
-               :start_date,
-               :end_date,
-               :company_id,
-               :new_company,
-               :status,
-               :'category-id',
-               :'harvest-timers-enabled',
-               :tags,
-               :reply_by_email_enabled,
-               :privacy_enabled,
-               :'use-tasks',
-               :'use-messages',
-               :'use-time',
-               :'use-risk-register',
-               :'use-billing',
-               :'use-milestones',
-               :'use-files',
-               :'use-notebook',
-               :'use-links',
-               :default_privacy
-             ).to_h
+        args = API.params(args).optional(*OPTIONAL_UPDATE_ATTRIBUTES).to_h
 
-        response = put "projects/#{project_id}.json", project: args
-        response['id']
+        put "projects/#{project_id}.json", project: args
       end
 
       def project(project_id, args = {})
-        if args.present?
-          args = { project: args }
-        else
-          args = {}
-        end
+        args = { project: args } unless args.empty?
         response = get "/projects/#{project_id}.json", args
         response.body['project']
       end
 
-      def projects
-        response = get '/projects.json'
+      def projects(args = {})
+        args = API.params(args).optional(*OPTIONAL_GET_ATTRIBUTES).to_h
+        response = get '/projects.json', args
         response.body['projects']
       end
 

data/lib/teamwork_api/api/task_lists.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 module TeamworkApi
   module API
+    # Client methods for TaskLists
+    # https://developer.teamwork.com/projects/task-lists
     module TaskLists
       def create_task_list(project_id, args)
         args =
@@ -17,15 +21,15 @@ module TeamworkApi
              ).to_h
 
         response = post "projects/#{project_id}/tasklists.json", tasklist: args
-        response['TASKLISTID']
+        response['TASKLISTID']&.to_i
       end
 
-      def update_task_list(task_list_id, args)
-      end
+      # def update_task_list(task_list_id, args)
+      # end
 
       def task_list(task_list_id)
         response = get "/tasklists/#{task_list_id}.json"
-        response.body['tasklist']
+        response.body['todo-list']
       end
 
       def task_lists

data/lib/teamwork_api/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'faraday_middleware'
 require 'json'
@@ -10,6 +12,7 @@ require 'teamwork_api/api/project_owner'
 require 'teamwork_api/api/task_lists'
 
 module TeamworkApi
+  # The main Teamwork client object
   class Client
     attr_accessor :api_key
     attr_reader :host
@@ -91,14 +94,10 @@ module TeamworkApi
     end
 
     def request(method, path, params = {})
-      unless Hash === params
-        params = params.to_h if params.respond_to? :to_h
-      end
-      path = @use_relative ? path.sub(/^\//, '') : path
-
       connection.headers[:cache_control] = 'no-cache'
       connection.basic_auth(api_key, '')
-      response = connection.send(method.to_sym, path, params)
+      response =
+        connection.send(method.to_sym, request_path(path), params_hash(params))
       handle_error(response)
       response.env
     rescue Faraday::Error::ClientError, JSON::ParserError
@@ -106,31 +105,36 @@ module TeamworkApi
     end
 
     def handle_error(response)
+      body = response.env[:body]
+      env = response.env
+
       case response.status
       when 403
-        raise TeamworkApi::UnauthenticatedError.new(
-          response.env[:body],
-          response.env
-        )
+        raise TeamworkApi::UnauthenticatedError.new(body, env)
       when 404, 410
-        raise TeamworkApi::NotFoundError.new(response.env[:body], response.env)
+        raise TeamworkApi::NotFoundError.new(body, env)
       when 422
-        raise TeamworkApi::UnprocessableEntity.new(
-          response.env[:body],
-          response.env
-        )
+        raise TeamworkApi::UnprocessableEntity.new(body, env)
       when 429
-        raise TeamworkApi::TooManyRequests.new(
-          response.env[:body],
-          response.env
-        )
+        raise TeamworkApi::TooManyRequests.new(body, env)
       when 500...600
-        raise TeamworkApi::Error.new(response.env[:body])
+        raise TeamworkApi::Error, body
       end
     end
 
     def check_subdirectory(host)
       URI(host).request_uri != '/'
     end
+
+    def request_path(path)
+      @use_relative ? path.sub(%r{^\/}, '') : path
+    end
+
+    def params_hash(params)
+      unless params.is_a?(Hash)
+        params = params.to_h if params.respond_to? :to_h
+      end
+      params
+    end
   end
 end

data/lib/teamwork_api/error.rb

@@ -1,4 +1,9 @@
+# frozen_string_literal: true
+
+require 'English'
+
 module TeamworkApi
+  # baser error
   class TeamworkError < StandardError
     attr_reader :response
 
@@ -8,6 +13,7 @@ module TeamworkApi
     end
   end
 
+  # specific errors
   class Error < TeamworkError
     attr_reader :wrapped_exception
 
@@ -15,7 +21,7 @@ module TeamworkApi
     #
     # @param exception [Exception, String]
     # @return [TeamworkApi::Error]
-    def initialize(exception = $!)
+    def initialize(exception = $ERROR_INFO)
       @wrapped_exception = exception
       if exception.respond_to?(:message)
         super(exception.message)

data/lib/teamwork_api/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TeamworkApi
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/fixtures/companies.json

@@ -0,0 +1,64 @@
+{
+  "companies": [
+    {
+      "state": "California",
+      "email_one": "",
+      "email_three": "",
+      "contacts": "0",
+      "website": "https://www.company-one.com/",
+      "logo-URL": "https://s3.amazonaws.com/TWFiles/000/companyLogo/l.png",
+      "email_two": "",
+      "cid": "",
+      "phone": "",
+      "created-on": "",
+      "accounts": "15",
+      "company_name_url": "000-company-one",
+      "can_see_private": true,
+      "tags": [],
+      "zip": "90021",
+      "industryId": "",
+      "id": "000",
+      "last-changed-on": "2018-12-11T20:18:08Z",
+      "fax": "",
+      "address_two": "",
+      "name": "Company One",
+      "country": "United States",
+      "isowner": "1",
+      "industry": "",
+      "address_one": "1 First Avenue",
+      "countrycode": "US",
+      "collaborators": "2",
+      "city": "Los Angeles"
+    },
+    {
+      "state": "",
+      "email_one": "",
+      "email_three": "",
+      "contacts": "0",
+      "website": "",
+      "logo-URL": "",
+      "email_two": "",
+      "cid": "",
+      "phone": "",
+      "created-on": "2019-03-14T22:51:24Z",
+      "accounts": "0",
+      "company_name_url": "001-company-two",
+      "can_see_private": false,
+      "tags": [],
+      "zip": "",
+      "industryId": "",
+      "id": "001",
+      "last-changed-on": "2019-03-14T22:51:24Z",
+      "fax": "",
+      "address_two": "",
+      "name": "Company Two",
+      "country": "",
+      "isowner": "0",
+      "industry": "",
+      "address_one": "",
+      "countrycode": "",
+      "collaborators": "0",
+      "city": ""
+    }
+  ]
+}

data/spec/fixtures/company.json

@@ -0,0 +1,32 @@
+{
+  "company": {
+    "state": "California",
+    "email_one": "",
+    "email_three": "",
+    "contacts": "0",
+    "website": "https://www.company-one.com/",
+    "logo-URL": "https://s3.amazonaws.com/TWFiles/999/companyLogo/l.png",
+    "email_two": "",
+    "cid": "",
+    "phone": "",
+    "created-on": "",
+    "accounts": "15",
+    "company_name_url": "000-company-one",
+    "can_see_private": true,
+    "tags": [],
+    "zip": "90021",
+    "industryId": "",
+    "id": "999",
+    "last-changed-on": "2018-12-11T20:18:08Z",
+    "fax": "",
+    "address_two": "",
+    "name": "Company One",
+    "country": "United States",
+    "isowner": "1",
+    "industry": "",
+    "address_one": "1 First Avenue",
+    "countrycode": "US",
+    "collaborators": "2",
+    "city": "Los Angeles"
+  }
+}

data/spec/fixtures/create_project.json

@@ -0,0 +1,4 @@
+{
+  "id": "323605",
+  "STATUS": "OK"
+}

data/spec/fixtures/create_task_list.json

@@ -0,0 +1,4 @@
+{
+  "TASKLISTID": "1234",
+  "STATUS": "OK"
+}

data/spec/fixtures/delete.json

@@ -0,0 +1,3 @@
+{
+  "STATUS": "OK"
+}

data/spec/fixtures/people.json

@@ -0,0 +1,80 @@
+{
+  "STATUS": "OK",
+  "people": [
+    {
+      "permissions": {
+        "can-access-templates": false,
+        "can-add-projects": false,
+        "canManagePortfolio": false,
+        "can-manage-people": false,
+        "canAccessPortfolio": false
+      },
+      "avatar-url": "",
+      "last-changed-on": "2018-08-09T14:21:19Z",
+      "email-address": "",
+      "last-login": "",
+      "address-country": "",
+      "textFormat": "HTML",
+      "user-name": "",
+      "id": "",
+      "phone-number-fax": "",
+      "site-owner": false,
+      "address-city": "",
+      "company-name": "MCG Company",
+      "user-invited-date": "",
+      "user-type": "collaborator",
+      "phone-number-mobile": "",
+      "useShorthandDurations": false,
+      "address-zip": "",
+      "openId": "",
+      "address": {
+        "city": "",
+        "country": "",
+        "countrycode": "",
+        "zipcode": "",
+        "state": "",
+        "line1": "",
+        "line2": ""
+      },
+      "phone-number-office": "",
+      "im-handle": "",
+      "twoFactorAuthEnabled": false,
+      "tags": [],
+      "has-access-to-new-projects": false,
+      "last-active": "",
+      "im-service": "",
+      "deleted": false,
+      "notes": "",
+      "in-owner-company": true,
+      "user-invited-status": "PENDING",
+      "profile": "",
+      "userUUID": "",
+      "user-invited": "2",
+      "created-at": "2018-06-14T14:07:29Z",
+      "companyId": "",
+      "phone-number-home": "",
+      "profile-text": "",
+      "company-id": "",
+      "pid": "",
+      "phone-number-mobile-parts": {
+        "countryCode": "",
+        "prefix": "",
+        "phone": ""
+      },
+      "address-line-2": "",
+      "address-state": "",
+      "login-count": "0",
+      "address-line-1": "",
+      "administrator": false,
+      "email-alt-1": "",
+      "email-alt-2": "",
+      "email-alt-3": "",
+      "last-name": "User",
+      "title": "",
+      "first-name": "Demo 2",
+      "phone-number-office-ext": "",
+      "twitter": "",
+      "lengthOfDay": "8.0"
+    }
+  ]
+}