procore 0.7.3 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88538f8106ff12e1532f8b3b2837e506c336857564b05529c1013e1bb849756a
-  data.tar.gz: 824483dff32962cc8d39e69754e2a3e8e6bfbc159e840bd3a3ef77a586dff3d6
+  metadata.gz: de9db8ec73ee357db98a0f91e185181dd0974b17984876a9fb6fbda80f7d43ea
+  data.tar.gz: 1dfba18ed4f52b11111cd46ce565d247bdf0dfd893f6adac805d15f8ba7ea26a
 SHA512:
-  metadata.gz: 4c7d776773d2111c0b6db558c2ea13703010115a0eb22481e7d8dfd00429046ef3b04ebdf9eea978ff79c9d4db415812c769eee58e82ae85e7401e8c925df25d
-  data.tar.gz: 9f5ccc7e220d19c4edf36c7fd4724df284d77dad43c7547f454d241f659b14d702fa4f0ad68bb5621a4d309b34219a10cb4e85c44a63b08e3874b0d98b411586
+  metadata.gz: 72d12d650d80082e301964204f37d78a95d947a71b7a938d456013f081b0f5d8079226aca82df8d38790483f9f9ce0d2f0ecfbcfbff560207084aa10ca02e59b
+  data.tar.gz: cfeda2877fd80e28af9e48f2dfd26d7f8975b9c5d52e3c7b89af84acafe72e20e31c8cedc61fe8a19735c2e9cc70f703a6d5de54aaf487fca0ea40979b924035

data/.rubocop.yml

@@ -372,9 +372,15 @@ Style/TrailingCommaInArguments:
     - no_comma
   Enabled: true
 
-Style/TrailingCommaInLiteral:
-  Description: 'Checks for trailing comma in array and hash literals.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+  SupportedStylesForMultiline:
+    - comma
+    - consistent_comma
+    - no_comma
+  Enabled: true
+
+Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
   SupportedStylesForMultiline:
     - comma
@@ -557,13 +563,6 @@ Lint/UnderscorePrefixedVariableName:
   Description: 'Do not use prefix `_` for a variable that is used.'
   Enabled: false
 
-Lint/UnneededDisable:
-  Description: >-
-                 Checks for rubocop:disable comments that can be removed.
-                 Note: this cop is not disabled when disabling all cops.
-                 It must be explicitly disabled.
-  Enabled: false
-
 Lint/Void:
   Description: 'Possible use of operator/literal/variable in void context.'
   Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## Unreleased
 
+## 0.8.1 (April 13, 2018)
+
+* Fix rubocop
+
+    *Michael Stock/Jason Gittler*
+
+## 0.8.0 (April 13, 2018)
+
+* Move all request methods to use keyword arguments
+
+    *Michael Stock/Jason Gittler*
+
 ## 0.7.3 (March 1, 2018)
 
 * Add 403 responses as Procore::ForbiddenError

data/README.md

@@ -25,11 +25,11 @@ The Client class exposes `#get`, `#post`, `#put`, `#patch` and `#delete` methods
 to you.
 
 ```ruby
-get(path, query = {})
-post(path, body = {}, options = {})
-put(path, body = {}, options = {})
-patch(path, body = {}, options = {})
-delete(path, query = {})
+get(path, query: {})
+post(path, body: {}, options: {})
+put(path, body: {}, options: {})
+patch(path, body: {}, options: {})
+delete(path, query: {})
 ```
 
 All paths are relative - the gem will handle expanding `client.get("me")` to
@@ -226,7 +226,7 @@ You can pass a `per_page` query parameter in your request to change the page
 size. The pagination links will update to reflect that change.
 
 ```
-first_page = client.get("projects", per_page: 250)
+first_page = client.get("projects", query: { per_page: 250 })
 
 puts first_page.pagination
 {
@@ -376,7 +376,7 @@ end
 # Somewhere else in the application
 class ProjectsController
   def index
-    @projects = client.get("projects", company_id: params[:company_id])
+    @projects = client.get("projects", query: { company_id: params[:company_id] })
   end
 
   private

data/lib/procore/requestable.rb

@@ -12,12 +12,13 @@ module Procore
   module Requestable
     # @param path [String] URL path
     # @param query [Hash] Query options to pass along with the request
+    # @option options [Hash] :company_id
     #
     # @example Usage
-    #   client.get("my_open_items", per_page: 5, filter: {})
+    #   client.get("my_open_items", query: { per_page: 5, filter: {} })
     #
     # @return [Response]
-    def get(path, query = {})
+    def get(path, query: {}, options: {})
       Util.log_info(
         "API Request Initiated",
         path: "#{base_api_path}/#{path}",
@@ -29,7 +30,7 @@ module Procore
         RestClient::Request.execute(
           method: :get,
           url: "#{base_api_path}/#{path}",
-          headers: headers.merge(params: query),
+          headers: headers(options).merge(params: query),
           timeout: Procore.configuration.timeout,
         )
       end
@@ -38,14 +39,17 @@ module Procore
     # @param path [String] URL path
     # @param body [Hash] Body parameters to send with the request
     # @param options [Hash} Extra request options
-    # TODO Add description for idempotency key
-    # @option options [String] :idempotency_token
+    # @option options [String] :idempotency_token | :company_id
     #
     # @example Usage
-    #   client.post("users", { name: "New User" }, { idempotency_token: "key" })
+    #   client.post(
+    #     "users",
+    #     body: { name: "New User" },
+    #     options: { idempotency_token: "key", company_id: 1 },
+    #   )
     #
     # @return [Response]
-    def post(path, body = {}, options = {})
+    def post(path, body: {}, options: {})
       Util.log_info(
         "API Request Initiated",
         path: "#{base_api_path}/#{path}",
@@ -67,13 +71,13 @@ module Procore
     # @param path [String] URL path
     # @param body [Hash] Body parameters to send with the request
     # @param options [Hash} Extra request options
-    # TODO Add description for idempotency key
+    # @option options [String] :idempotency_token | :company_id
     #
     # @example Usage
-    #   client.put("dashboards/1/users", [1,2,3])
+    #   client.put("dashboards/1/users", body: [1,2,3], options: { company_id: 1 })
     #
     # @return [Response]
-    def put(path, body = {}, options = {})
+    def put(path, body: {}, options: {})
       Util.log_info(
         "API Request Initiated",
         path: "#{base_api_path}/#{path}",
@@ -95,14 +99,17 @@ module Procore
     # @param path [String] URL path
     # @param body [Hash] Body parameters to send with the request
     # @param options [Hash} Extra request options
-    # TODO Add description for idempotency token
-    # @option options [String] :idempotency_token
+    # @option options [String] :idempotency_token | :company_id
     #
     # @example Usage
-    #   client.patch("users/1", { name: "Updated" }, { idempotency_token: "key" })
+    #   client.patch(
+    #     "users/1",
+    #     body: { name: "Updated" },
+    #     options: { idempotency_token: "key", company_id: 1 },
+    #   )
     #
     # @return [Response]
-    def patch(path, body = {}, options = {})
+    def patch(path, body: {}, options: {})
       Util.log_info(
         "API Request Initiated",
         path: "#{base_api_path}/#{path}",
@@ -123,16 +130,18 @@ module Procore
 
     # @param path [String] URL path
     # @param query [Hash] Query options to pass along with the request
+    # @option options [String] :company_id
     #
     # @example Usage
-    #   client.delete("users/1")
+    #   client.delete("users/1", query: {}, options: {})
     #
     # @return [Response]
-    def delete(path, query = {}, _options = {})
+    def delete(path, query: {}, options: {})
       Util.log_info(
         "API Request Initiated",
         path: "#{base_api_path}/#{path}",
         method: "DELETE",
+        headers: headers(options),
         query: query.to_s,
       )
 
@@ -250,6 +259,10 @@ module Procore
         if options[:idempotency_token]
           headers["Idempotency-Token"] = options[:idempotency_token]
         end
+
+        if options[:company_id]
+          headers["procore-company-id"] = options[:company_id]
+        end
       end
     end
 

data/lib/procore/response.rb

@@ -1,3 +1,5 @@
+require "active_support/hash_with_indifferent_access"
+
 module Procore
   # Wrapper class for a response received from the Procore API. Stores the
   # body, code, headers, and pagination information.

data/lib/procore/version.rb

@@ -1,3 +1,3 @@
 module Procore
-  VERSION = "0.7.3".freeze
+  VERSION = "0.8.1".freeze
 end

data/procore.gemspec

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "procore/version"
 
@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "webmock"
 
+  spec.add_dependency "activesupport", "> 2.4"
   spec.add_dependency "oauth2", "~> 1.4"
   spec.add_dependency "rest-client", "~> 2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: procore
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.1
 platform: ruby
 authors:
 - Procore Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-02 00:00:00.000000000 Z
+date: 2018-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement