procore 0.6.8 → 0.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56cc4c858cf5be92d0b0d0a88b5baa75504e93dadca7a626349afdf403be3ff1
-  data.tar.gz: cc9610d7670952cb77d830a4481522d1c2d084627584dc22b79c2c2c0f98a171
+  metadata.gz: 5a122d8e74f07636c87c3db3bfedb0836f813e31c1e8a3b6df25f84da131f06a
+  data.tar.gz: 58b335464bf7b9c1bc7284e1651fc05d08796d348da464d6d327d8c0b8243a2a
 SHA512:
-  metadata.gz: 5b158f1b94063622d7c013f4f021d757cdf08f09dd6474e8e5382b174591290161141a2dab515ab6ff6159e5cf92702885743e796d31ed00cb9d6278075999dc
-  data.tar.gz: a579c807d7c74371ef21f5477f622081d8987eefe15f9c2afa3282dd2141ced7af3d2ca99bb1dcfdbe7f22ec3486e8c79bef6bf25b8e3d8da48bbfd064471b14
+  metadata.gz: 825662dbe28de8510a825cfd7e512050b7bf09da321a952587d8c243e05d71ba7b61af0fbc668334696ea0a61ddf065174055b6df38875e51c2b7735ac498110
+  data.tar.gz: f329ffd5f5cb34aa5571fc1f79b4a24b13a1c5ec25f981bef7d4be7e2e45fecf789792d971c00c287f534dea30cdcfadbe7d4689fe49d277752aa8a22b3bd692

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Unreleased
 
+## 0.6.9 (February 09, 2018)
+
+*  Add HTTP PUT support
+
+   *Matt Brinza*
+
 ## 0.6.8 (January 04, 2018)
 
 * Wrap `AccessTokenCredentials` external errors with our own errors

data/README.md

@@ -21,11 +21,13 @@ Stores automatically manage tokens for you - refreshing, revoking and storage
 are abstracted away to make your code as simple as possible. There are several
 different [types of stores](#stores) available to you.
 
-The client class exposes `#get`, `#post`, `#patch` and `#delete` methods to you.
+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 = {})
 ```
@@ -104,7 +106,7 @@ begin
   client.get("projects")
 
 rescue Procore::RateLimitError => e
-  # Raised when a token reaches it's request limit for the current time period.
+  # Raised when a token reaches its request limit for the current time period.
   # If you are receiving this error then you are making too many requests
   # against the Procore API.
 
@@ -112,7 +114,7 @@ rescue Procore::NotFoundError => e
   # Raised when the request 404's
 
 rescue Procore::InvalidRequestError => e
-  # Raised when the request is incorrectly formated. Possible causes: missing
+  # Raised when the request is incorrectly formatted. Possible causes: missing
   # required parameters or sending a request to access a non-existent resource.
 
 rescue Procore::OAuthError => e
@@ -128,7 +130,7 @@ rescue Procore::APIConnectionError => e
   # Procore is down or the network is doing something funny.
 
 rescue Procore::ServerError => e
-  # Raised when a Procore endpoint returns a 500x resonse code.
+  # Raised when a Procore endpoint returns a 5xx response code.
 
 rescue Procore::Error => e
   # Generic catch all error.
@@ -300,7 +302,7 @@ Options: `key`: Unique identifier to an access token
 For applications which want to store access tokens in Redis. There's two
 required options, `redis` which is an instance of a Redis connection, and `key`
 which is a unique key which will be used to save / retrieve an access token.
-They key will usually be the id of the current user.
+The key will usually be the id of the current user.
 
 ```ruby
 store = Procore::Auth::Stores::Redis.new(redis: Redis.new, key: current_user.id)

data/lib/procore/client.rb

@@ -3,7 +3,7 @@ require "procore/requestable"
 module Procore
   # Main class end users interact with. An instance of a client can call out
   # the Procore API using methods matching standard HTTP verbs #get, #post,
-  # #patch, #delete.
+  # #put, #patch, #delete.
   #
   # @example Creating a new client:
   #   store = Procore::Auth::Stores::Session.new(session: session)

data/lib/procore/requestable.rb

@@ -1,8 +1,8 @@
 require "httparty"
 
 module Procore
-  # Module which defines HTTP verbs GET, POST, PATCH and DELETE. Is included in
-  # Client. Has support for Idempotency Tokens on POST and PATCH.
+  # Module which defines HTTP verbs GET, POST, PUT, PATCH and DELETE. Is
+  # included in Client. Has support for Idempotency Tokens on POST and PATCH.
   #
   # @example Using #get:
   #   client.get("my_open_items", per_page: 5)
@@ -63,12 +63,40 @@ module Procore
       end
     end
 
+    # @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
+    #
+    # @example Usage
+    #   client.put("dashboards/1/users", [1,2,3])
+    #
+    # @return [Response]
+    def put(path, body = {}, options = {})
+      Util.log_info(
+        "API Request Initiated",
+        path: "#{base_api_path}/#{path}",
+        method: "PUT",
+        body: body.to_s,
+      )
+
+      with_response_handling do
+        HTTParty.put(
+          "#{base_api_path}/#{path}",
+          body: body.to_json,
+          headers: headers(options),
+          timeout: Procore.configuration.timeout,
+        )
+      end
+    end
+
     # @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
     #
+    # @example Usage
     #   client.patch("users/1", { name: "Updated" }, { idempotency_token: "key" })
     #
     # @return [Response]

data/lib/procore/version.rb

@@ -1,3 +1,3 @@
 module Procore
-  VERSION = "0.6.8".freeze
+  VERSION = "0.6.9".freeze
 end

data/procore.gemspec

@@ -34,6 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "webmock"
 
-  spec.add_dependency "httparty", "~> 0.15"
+  spec.add_dependency "httparty", "~> 0.16"
   spec.add_dependency "oauth2", "~> 1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: procore
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.6.9
 platform: ruby
 authors:
 - Procore Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-05 00:00:00.000000000 Z
+date: 2018-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
@@ -247,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.5
 signing_key: 
 specification_version: 4
 summary: Procore Ruby Gem