teamwork_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0597cc1425bbb361d139fa9ac0577254f9d32deaf6b1a4cf992aa19072fc5862'
-  data.tar.gz: cbf693e0a516dc312bdb2d0ba288d574c7ad092d39ed0b2a7742b6b29fa2e3aa
+  metadata.gz: 352f6e7275ab0a7dabe81bd20c89f39522ac44633aba09c3baa44d343eff2288
+  data.tar.gz: 3866dfeb95209f58dd00a14fa91d68d6ef743ef682a23c1a80330685d8b918f3
 SHA512:
-  metadata.gz: 5ffe58e4e966e152eb1acd524875c9271c45182e91562390fdf5618418450367c4138d6a6abef1e38c703df712a842e8c24273c6645758e16595173c1b4fa57a
-  data.tar.gz: b7c0842c00c364b9fb19078611b39e3f61a0f131dba16faa39157fea9c7c1924f86f3050920955c5344da9f7251fbef183b8a494402edc12900f6ff5cc0bb84d
+  metadata.gz: 0bd71511ed7847858390dfa9402d896ef9fe91f70f46c300b51fe01927c05bca3a103f07637c797b4de9314d1ddf8552c63dc6fa13399f9c232f3869385166d1
+  data.tar.gz: 94ec7a0c037ac613ee8461ab2cd21003bd24821bb1402f20466381063e782a47daca582ce125bd60129a0c4514da1727376c1978f45171f757c50fd638c8be0e

data/.gitignore

@@ -1,3 +1,4 @@
+*.gem
 .bundle
 .yardoc
 _yardoc

data/.rubocop.yml

@@ -1,4 +1,14 @@
+require: rubocop-performance
+
 AllCops:
   TargetRubyVersion: 2.5
+Metrics/BlockLength:
   Exclude:
-    - 'spec/**/**/*.rb'
+  - 'Rakefile'
+  - 'spec/**/*.rb'
+Metrics/MethodLength:
+  Max: 15
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+Style/SymbolArray:
+  EnforcedStyle: brackets

data/.travis.yml

@@ -1,5 +1,9 @@
 language: 'ruby'
 
+env:
+  global:
+    - CC_TEST_REPORTER_ID=a2684f17bc26e1344f48ee22a407e27b3eb229050e949b56010388bc8a5e0866
+
 before_install:
   - 'gem update --system'
   - 'gem install bundler'
@@ -8,4 +12,13 @@ rvm:
   - '2.5.5'
   - '2.6.2'
 
-script: 'bundle exec rake'
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+script:
+  - bundle exec rake
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.1.1]
+
+- Added Guard for development
+- Setup Travis CI and Codeclimate
+- Allow optional params for project request
+- Added specs
+
+## [0.1.0] - 2019-05-13
+
+- Release

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in teamwork_api.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    teamwork_api (0.1.0)
+    teamwork_api (0.1.1)
       faraday (~> 0.9)
       faraday_middleware (~> 0.10)
       rack (>= 1.6)
@@ -9,23 +9,64 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     docile (1.3.1)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.13.1)
       faraday (>= 0.7.4, < 1.0)
+    ffi (1.10.0)
+    formatador (0.2.5)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.3.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
+    hashdiff (0.3.9)
     jaro_winkler (1.5.2)
     json (2.2.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
     multipart-post (2.1.0)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
-    psych (3.1.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.3)
     rack (2.0.7)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (11.3.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -39,32 +80,46 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.67.2)
+    rubocop (0.69.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      psych (>= 3.1.0)
+      parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.3.0)
+      rubocop (>= 0.68.0)
     ruby-progressbar (1.10.0)
+    ruby_dep (1.5.0)
+    safe_yaml (1.0.5)
+    shellany (0.0.1)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    unicode-display_width (1.5.0)
+    thor (0.20.3)
+    unicode-display_width (1.6.0)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.16)
-  rake (~> 10.0)
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  guard-rubocop (~> 1.3.0)
+  rake (~> 11.1)
   rspec (~> 3.4)
-  rubocop (~> 0.67.2)
+  rubocop (~> 0.69.0)
+  rubocop-performance (~> 1.3.0)
   simplecov (~> 0.11)
   teamwork_api!
+  webmock (~> 2.0)
 
 BUNDLED WITH
    1.17.2

data/Guardfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end
+
+guard :rubocop, all_on_start: false, cli: ['--display-cop-names'] do
+  watch(/.+\.(rb|rake)$/)
+  watch(%r{(?:.+/)?\.rubocop(_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end

data/README.md

@@ -1,10 +1,10 @@
 # TeamworkApi
 
-[![Code Climate](https://codeclimate.com/github/100yrs/teamwork_api.png)][codeclimate]
+[![Build](https://travis-ci.org/100yrs/teamwork_api.svg?branch=master)](https://travis-ci.org/100yrs/teamwork_api)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ad05d9af4c9a0d2cc4dd/maintainability)](https://codeclimate.com/github/100yrs/teamwork_api/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/ad05d9af4c9a0d2cc4dd/test_coverage)](https://codeclimate.com/github/100yrs/teamwork_api/test_coverage)
 
-[codeclimate]: https://codeclimate.com/github/100yrs/teamwork_api
-
-The Teamwork API gem allows you to consume the Teamwork API
+The Teamwork API gem allows you to consume the [Teamwork API](https://developer.teamwork.com/)
 
 ## Installation
 
@@ -44,7 +44,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/teamwork_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/100yrs/teamwork_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'

data/lib/teamwork_api.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'teamwork_api/version'
 
+# Base module
 module TeamworkApi
   require 'teamwork_api/api/params'
   require 'teamwork_api/client'

data/lib/teamwork_api/api/companies.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 module TeamworkApi
   module API
+    # Client methods for Companies
+    # https://developer.teamwork.com/projects/companies
     module Companies
       def company(company_id)
         response = get "/companies/#{company_id}.json"

data/lib/teamwork_api/api/params.rb

@@ -1,13 +1,18 @@
+# frozen_string_literal: true
+
 module TeamworkApi
+  # Make it easier to deal with params
   module API
     def self.params(args)
       Params.new(args)
     end
 
+    # The useful stuff is here
     class Params
       def initialize(args)
-        raise ArgumentError.new('Required to be initialized with a Hash') unless
+        raise(ArgumentError, 'Required to be initialized with a Hash') unless
           args.is_a? Hash
+
         @args = args
         @required = []
         @optional = []
@@ -36,8 +41,7 @@ module TeamworkApi
 
         @required.each do |k|
           h[k] = @args[k]
-          raise ArgumentError.new("#{k} is required but not specified") unless
-            h[k]
+          raise(ArgumentError, "#{k} is required but not specified") unless h[k]
         end
 
         @optional.each do |k|
@@ -45,25 +49,28 @@ module TeamworkApi
         end
 
         @defaults.each do |k, v|
-          @args.key?(k) ? h[k] = @args[k] : h[k] = v
+          h[k] = (@args.key?(k) ? @args[k] : v)
         end
 
         caseify_keys(h)
       end
 
-      def caseify_keys(h)
+      def caseify_keys(hash)
         caseified_hash = {}
-        h.each do |k, v|
-          if k =~ /-/
-            key = k.to_s
-          else
-            key = k.to_s.camelize(:lower)
-          end
+        hash.each do |k, v|
+          key = (k.match?(/-/) ? k.to_s : camelize(k.to_s))
           caseified_hash[key] = v
         end
 
         caseified_hash
       end
+
+      def camelize(string)
+        string = string.sub(/^(?:(?=\b|[A-Z_])|\w)/) { $&.downcase }
+        string.gsub(%r{(?:_|(\/))([a-z\d]*)}) {
+          "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}"
+        }.gsub('/', '::')
+      end
     end
   end
 end

data/lib/teamwork_api/api/people.rb

@@ -1,42 +1,65 @@
+# frozen_string_literal: true
+
 module TeamworkApi
   module API
+    # client methods for People
+    # https://developer.teamwork.com/projects/people
     module People
+      OPTIONAL_GET_ATTRIBUTES = [
+        :project_id,
+        :page,
+        :page_size,
+        :group_by_company,
+        :sort,
+        :sort_order,
+        :full_profile
+      ].freeze
+      OPTIONAL_UPDATE_ATTRIBUTES = [
+        :'edit-all-tasks',
+        :'view-messages-and-files',
+        :'view-tasks-and-milestones',
+        :'view-time',
+        :'view-notebooks',
+        :'view-risk-register',
+        :'view-invoices',
+        :'view-links',
+        :'view-links',
+        :'add-tasks',
+        :'add-milestones',
+        :'add-taskLists',
+        :'add-messages',
+        :'add-files',
+        :'add-time',
+        :'add-notebooks',
+        :'add-links',
+        :'set-privacy',
+        :'set-privacy',
+        :'is-observing',
+        :'can-be-assigned-to-tasks-and-milestones',
+        :'project-administrator',
+        :'add-people-to-project'
+      ].freeze
+
+      def person(person_id)
+        response = get "/people/#{person_id}.json"
+        response.body['person']
+      end
+
+      def people(args = {})
+        args = API.params(args).optional(*OPTIONAL_GET_ATTRIBUTES).to_h
+        response = get '/people.json', args
+        response.body['people']
+      end
+
       def add_person_to_project(project_id, person_id)
         response =
           put "projects/#{project_id}/people.json",
-              { add: { userIdList: person_id } }
+              add: { userIdList: person_id }
         response.body['STATUS']
       end
 
       def set_permissions(project_id, person_id, args)
-        args =
-          API.params(args)
-             .optional(
-               :'edit-all-tasks',
-               :'view-messages-and-files',
-               :'view-tasks-and-milestones',
-               :'view-time',
-               :'view-notebooks',
-               :'view-risk-register',
-               :'view-invoices',
-               :'view-links',
-               :'view-links',
-               :'add-tasks',
-               :'add-milestones',
-               :'add-taskLists',
-               :'add-messages',
-               :'add-files',
-               :'add-time',
-               :'add-notebooks',
-               :'add-links',
-               :'set-privacy',
-               :'set-privacy',
-               :'is-observing',
-               :'can-be-assigned-to-tasks-and-milestones',
-               :'project-administrator',
-               :'add-people-to-project'
-             ).to_h
-
+        args = API.params(args).optional(*OPTIONAL_UPDATE_ATTRIBUTES).to_h
         response =
           put "projects/#{project_id}/people/#{person_id}.json",
               permissions: args

data/lib/teamwork_api/api/project_owner.rb

@@ -1,10 +1,15 @@
+# frozen_string_literal: true
+
 module TeamworkApi
   module API
+    # Client methods for ProjectOwner. Note that there isn't a specific
+    # ProjectOwner endpoint and these happen via the project
+    # https://developer.teamwork.com/projects/project-owner
     module ProjectOwner
       def project_owner(project_id)
         response = get "projects/#{project_id}.json",
                        project: { include_project_owner: true }
-        response[:project][:owner]
+        response.body['project']['owner']
       end
 
       # This doesn't seem to work. Response is OK, but owner not set