procore 0.8.7 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 0e9072c893654842077d13100acc0afa9f78a4af28e902748494c58f467c8350
-  data.tar.gz: b78ba6679d1dfbc2d96d0b395a9778278eac1979efa1fccb5bb3063d81b7430d
+SHA1:
+  metadata.gz: 49f3e1daa62e1998646029758f63b21f973a9851
+  data.tar.gz: a2613a7ea2ddd4aa4ce6cbb7531a267af94dc195
 SHA512:
-  metadata.gz: e36b749b1c34f1f87316c1530a4668bc4e52914fd5b60e29d4a5055755957dbcf46d87028b62baaedec45de57815ba93d4dd305f04dd19fb7972114fe350a8a7
-  data.tar.gz: c49008dd2ccf0cc0d37fc1457462328a0916161a9bb54c1bd1c35c9d537ccd284b90d319e4c67cadce4b6afc530a37f80347af163877fc52978f69f39c07e4ae
+  metadata.gz: 92474ea3b4e4ac1c4658ed192e929e9ac6b203dead4b1b5e0e424fc545d723197a606e906e224f7809f2914ed7dca83243d38bb9c6ee783d1422c7c36f0ecb90
+  data.tar.gz: 707e8d18312f9c029fe86849eecc84dc50f4fd52191c4938c858a7ad0d420aac6798673575fb413a8c37b90def7f5c4bfdc5826a20f23525a2a253f52d586558

data/.rubocop.yml

@@ -1,5 +1,9 @@
+require: 
+  - rubocop-rails
+  - rubocop-performance
+
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
   Include:
     - '**/Rakefile'
     - '**/config.ru'
@@ -305,7 +309,7 @@ Style/PerlBackrefs:
 Naming/PredicateName:
   Description: 'Check the names of predicate methods.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark'
-  NamePrefixBlacklist:
+  ForbiddenPrefixes:
     - is_
   Exclude:
     - spec/**/*
@@ -437,7 +441,7 @@ Style/RedundantBegin:
 
 # Layout
 
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   Description: 'Here we check if the parameters on a multi-line method call or definition are aligned.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-double-indent'
   Enabled: false
@@ -505,7 +509,7 @@ Lint/DeprecatedClassMethods:
   Description: 'Check for deprecated class method calls.'
   Enabled: false
 
-Lint/DuplicatedKey:
+Lint/DuplicateHashKey:
   Description: 'Check for duplicate keys in hash literals.'
   Enabled: false
 
@@ -521,7 +525,7 @@ Lint/FormatParameterMismatch:
   Description: 'The number of parameters to format/sprint must match the fields.'
   Enabled: false
 
-Lint/HandleExceptions:
+Lint/SuppressedException:
   Description: "Don't suppress exception."
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions'
   Enabled: false

data/.travis.yml

@@ -1,29 +1,25 @@
 language: ruby
 rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-
+- 2.3
+- 2.4
+- 2.5
+- 2.6
 services:
-  - redis-server
-
+- redis-server
+- memcached
 before_install:
-  - gem update --system
-  - gem install bundler
-
+- gem update --system
+- gem install bundler
 cache: bundler
-
 script: bundle exec rake
-
 deploy:
   provider: rubygems
   api_key:
-    secure: GYH7nTi2D9ZwbCP+JYSgHceDUvZT9RQSP6yXFndwSyxdiSmB6wfq6EtoH4Wpznd6ALT6IxrtbR4aftTI9DO6HPq+PVO6NdxjkdlbdxxAqRQJBAwFwFATT8jCuuDjGPLf8PF0ouzcMvAIdIgHypwmLdevWdEMomWdRWlm1UFP/0C3RDjY1v04XDrRb+fEagPNnzMDCcO352nyFm06jnCq/ezjCRXBvNtHTZeqd7t9pbNw7gtYebZ3b9hfd4IIa68budeh+URygiPnNNWr6TCjO95IuHIeMDele3tir0KzqVBNsVAqEb7WpB26rf1JgneAoYZwVMFh+hk09cs68EbIELD4MX6/PzEUz2Ws20dIMjs1pcDtlw35ixoEpwC/vz2qVJyMRYXg8af5rpsZkKXRl7QP2LrX+xSEt4LiRnylj4PaRZWu1gvhC7fsCHXEM3mW3WlXFUmb9W4Jv8VooqOJtGhpD9Qs9pYtTOgJoEmYqttbuCaiYKaiPutBY4+t+t2ZmyCopv41nkjv/UCWXfo11ew1qK0rxDJVE2/JYTUDZ+zuHypTf2lHCWjyP65vGwBnmdixLnEMCUOkzKUmqFR4kAE6jRMEhtki4fTlFSIHJGM5oIXeRXDR43NIh7xWNvhl7lHkwWoRA0BfSITtvO8k0SefGnFwhNfOglQ/GKfyAaY=
-  gem: procore
+    secure: LC+5qDeaqBtA8IIDt0yHNYsTA/KEs7IK/hESF2V2f4bhmMapifEVSjikoZVE1lTe0R2+CyO+5mWHloFeTLayTchpZhW3yfduei3l2tktZOH9UCsXIQZKveSZlCMQ+XOn65Gstbd/5krh9+axKZswgM5YgBhjXNRgjL+yOGh2kXN0exk5nBvIBFxSCQdwqGiBDcrtgJ4eWrlPgofXszMFb3ogNQcIuUcKmAOC0j/fNag4qQV0jnp3zHDuOjrsARPJn4w6RMqSLpFVUYpJw3tE94GDW5kILHr7taTPj12PeYNbYjW7kRSgMYbQlIWUKLeyMp+vw3kNqd3Ysat+M+Mrf3z2KRKR5w62IJnCq758uerCdUo5v/vsWHYFcJvZWLrvsPSk+xQWysAqRdkun7ZBCK/FLR75S6Vkm0DBnbqd/yYp6MP9Vbi77gIZpWMXANfdk1aWGVlPNpskYeWyqPjwZX1nYybJQIIpZfX21F2WPrNA9r/cj1KYjb8vKopMEdn9GP9xMeUXXu85K+ZVPqSD/AblrLHyD2x7cES/i4+XcQSaKUOSLxTUqemAiDRBahDCehPOOeLHnu/rUzgQr1gzQL0YcLNgHovmIdstljBys62JC4gy376cNawiSW4ZPMHWg6PewqQ6Ozg4Lkytx06bBwOos55dFgI4k0T4H0/6QiE=
+  gem: ruby-sdk
   on:
     tags: true
     repo: procore/ruby-sdk
-
+  skip_cleanup: 'true'
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,4 +1,90 @@
-## Unreleased
+## 1.1.2 (Jun 4, 2021)
+
+* Add Procore-Sdk-Version header to all requests
+
+  PR #44 - https://github.com/procore/ruby-sdk/pull/44
+
+  *Benjamin Ross*
+
+## 1.1.1 (May 5, 2021)
+
+* Change default host to 'api.procore.com'.
+
+  PR #42 - https://github.com/procore/ruby-sdk/pull/42
+
+  *Nate Baer*
+
+## 1.1.0 (March 11, 2021)
+
+* Allow tokens to be revoked and manually refreshed.
+
+  PR #39 - https://github.com/procore/ruby-sdk/pull/39
+
+  *Nate Baer*
+
+## 1.0.0 (January 5, 2021)
+
+* Adds support for API versioning
+
+  *Nate Baer*
+
+### Upgrading
+
+As of v1.0.0, this gem now defaults to making requests against Procore's new
+Rest v1.0 resources, instead of the now deprecated `/vapid` namespace. Example:
+
+```ruby
+# Previously makes a request to
+client.get("me")
+=> app.procore.com/vapid/me
+
+# In 1.0.0
+client.get("me")
+=> app.procore.com/rest/v1.0/me
+```
+
+To keep the legacy behavior, set the new `default_version` configuration option.
+Note, that Rest v1.0 is a superset of the Vapid Api - there are no breaking
+changes. The Vapid API will be decommissioned in December 2021.
+
+[Read more here](https://developers.procore.com/documentation/vapid-deprecation)
+
+```ruby
+Procore.configure do |config|
+  ...
+  # Defaults to "v1.0"
+  config.default_version = "vapid"
+  ...
+end
+```
+
+All the request methods (`get`, `post`, `patch`, `put`, `delete`, `sync`) now
+accept an optional version parameter to specify the version at request time.
+
+```ruby
+client.get("me")
+=> https://app.procore.com/rest/v1.0/me
+
+client.get("me", version: "v1.1")
+=> https://app.procore.com/rest/v1.1/me
+
+client.get("me", version: "vapid")
+=> https://app.procore.com/vapid/me
+```
+
+## 0.8.8 (October 17, 2019)
+
+* Expose #sync, a method that enables calling sync-actions
+
+  *Patrick Koperwas*
+
+* Addition of contribution guidelines to README
+
+  *Megan O'Neill*
+
+* Fix TravisCI failures
+
+  *Patrick Koperwas*
 
 ## 0.8.7 (April 18, 2019)
 

data/README.md

@@ -4,12 +4,14 @@
 
 #### Table of Contents
 - [Installation](#installation)
+- [1.0.0 Release](#100-release)
 - [Making Requests](#making-requests)
 - [Usage](#usage)
 - [Error Handling](#error-handling)
 - [Pagination](#pagination)
   - [Navigating Through Paginated Results](#navigating-through-paginated-results)
   - [Change Number of Results](#change-number-of-results)
+- [Sync Actions](#sync-actions)
 - [Configuration](#configuration)
 - [Stores](#stores)
   - [Session Store](#session-store)
@@ -19,6 +21,7 @@
   - [File Store](#file-store)
   - [Memory Store](#memory-store)
 - [Full Example](#full-example)
+- [Contributing](#contributing)
 
 ## Installation
 
@@ -28,6 +31,11 @@ Add this line to your application's Gemfile:
 gem "procore"
 ```
 
+## 1.0.0 Release
+
+v1.0.0 was released on January 5, 2021, and adds support the new Rest v1.0 API.
+See the CHANGELOG for upgrade instructions.
+
 ## Making Requests
 
 At the core of the gem is the `Client` class. Clients are initialized with a
@@ -39,19 +47,30 @@ 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`, `#put`, `#patch` and `#delete` methods
-to you.
+The Client class exposes `#get`, `#post`, `#put`, `#patch`, `#sync` 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, version: "", query: {})
+  post(path, version: "", body: {}, options: {})
+   put(path, version: "", body: {}, options: {})
+ patch(path, version: "", body: {}, options: {})
+delete(path, version: "", query: {})
+  sync(path, version: "", body: {}, options: {})
 ```
 
-All paths are relative - the gem will handle expanding `client.get("me")` to
-`https://app.procore.com/vapid/me`.
+All paths are relative, the gem will handle expanding them. An API version may
+be specified in the `version:` argument, or the default version is used. The
+default version is `v1.0` unless otherwise configured.
+
+| Example | Requested URL |
+| --- | --- |
+| `client.get("me")` | `https://api.procore.com/rest/v1.0/me` |
+| `client.get("me", version: "v1.1")` | `https://api.procore.com/rest/v1.1/me` |
+| `client.get("me", version: "vapid")` | `https://api.procore.com/vapid/me` |
+
+In addition to the settings above, you will need to set `company_id` in the request 
+options to work with [Multiple Procore Zones (MPZ)](https://developers.procore.com/documentation/tutorial-mpz).
 
 Example Usage:
 
@@ -67,6 +86,24 @@ client = Procore::Client.new(
 companies = client.get("companies")
 
 companies.first[:name] #=> "Procore Company 1"
+
+# Get a company's projects (note the company_id value in options)
+projects = client.get("projects", query: {company_id: <company_id>}, options: {company_id: <company_id>})
+
+projects.first[:name] #=> "Project 1"
+```
+
+To use Procore's older API Vapid by default, the default version can be set in
+either the Gem's [configuration](https://github.com/procore/ruby-sdk#configuration)
+or the client's `options` hash:
+
+```ruby
+client = Procore::Client.new(
+  ...
+  options {
+    default_version: "vapid"
+  }
+)
 ```
 
 ## Usage
@@ -112,6 +149,18 @@ client = Procore::Client.new(
 client.get("me")
 ```
 
+Expired tokens will automatically be refreshed, but can also be refreshed manually:
+
+```ruby
+client.refresh
+```
+
+Tokens may also be manually revoked, forcing the client to refresh its token on the next request:
+
+```ruby
+client.revoke
+```
+
 ## Error Handling
 
 The Procore Gem raises errors whenever a request returns a non `2xx` response.
@@ -259,6 +308,49 @@ puts first_page.pagination
 Notice that because `per_page` has been set to 250, there are only two pages of
 results (500 resources / 250 page size = 2 pages).
 
+## Sync Actions
+The Sync action enables batch creation or updates to resources using a single
+call. When using a Sync action, the resources to be created or updated can be
+specified by supplying either an `id` or an `origin_id` in the request body.
+Utilizing the `origin_id` attribute for batch operations is often preferable as
+it allows you to easily link to external systems by maintaining your own list of
+unique resource identifiers outside of Procore.
+
+The caller provides an array of hashes, each hash containing the attributes for
+a single resource. The attribute names in each hash match those used by the
+Create and Update actions for the resource. Attributes for a maximum of 1000
+resources within a collection may be passed with each call. The API will always
+return an HTTP status of 200.
+
+The response body contains two attributes - `entities` and `errors`. The
+attributes for each successfully created or updated resource will appear in the
+entities list. The attributes for each resource will match those returned by the
+Show action. For each resource which could not be created or updated, the
+attributes supplied by the caller are present in the errors list, along with an
+additional errors attribute which provides reasons for the failure.
+
+[Continue reading
+here.](https://developers.procore.com/documentation/using-sync-actions)
+
+Example Usage:
+
+```ruby
+client.sync(
+ "projects/sync",
+ body: {
+   updates: [
+    { id: 1, name: "Update 1" },
+    { id: 2, name: "Update 2" },
+    { id: 3, name: "Update 3" },
+    ...
+    ...
+    { id: 5055, name: "Update 5055" },
+   ]
+ },
+ options: { batch_size: 500, company_id: 1 },
+)
+```
+
 ## Configuration
 
 The Procore Gem exposes a configuration with several options.
@@ -271,7 +363,16 @@ Procore.configure do |config|
   # Base API host name. Alter this depending on your environment - in a
   # staging or test environment you may want to point this at a sandbox
   # instead of production.
-  config.host = ENV.fetch("PROCORE_BASE_API_PATH", "https://app.procore.com")
+  config.host = ENV.fetch("PROCORE_BASE_API_PATH", "https://api.procore.com")
+
+  # When using #sync action, sets the default batch size to use for chunking
+  # up a request body. Example: if the size is set to 500, and 2,000 updates
+  # are desired, 4 requests will be made. Note, the maximum size is 1000.
+  config.default_batch_size = 500
+
+  # The default API version to use if none is specified in the request.
+  # Should be either "v1.0" (recommended) or "vapid" (legacy).
+  config.default_version = "v1.0"
 
   # Integer: Number of times to retry a failed API call. Reasons an API call
   # could potentially fail:
@@ -433,6 +534,27 @@ class ProjectsController
   end
 end
 ```
+## Contributing
+
+To contribute to the gem, please clone the repo and cut a new branch. In the PR update the changelog with a short explanation of what you've changed, and your name under the "Unreleased" section. Example changelog update:
+
+```markdown
+## Unreleased
+
+* Short sentence of what has changed
+
+    *Your Name*
+```
+
+Please **do not** bump the gem version in your PR. This will be done in a follow up PR by the gem maintainers.
+
+### Tests
+
+To run the specs run the following command:
+```bash
+$ bundle exec rake test
+```
+
 
 ## License
 

data/lib/procore/auth/access_token_credentials.rb

@@ -32,6 +32,17 @@ module Procore
         end
       end
 
+      def revoke(token:)
+        request = {
+          client_id: @client_id,
+          client_secret: @client_secret,
+          token: token.access_token,
+        }
+        client.request(:post, "/oauth/revoke", body: request)
+      rescue RestClient::ExceptionWithResponse
+        raise OAuthError.new(e.description, response: e.response)
+      end
+
       private
 
       def client

data/lib/procore/client.rb

@@ -38,23 +38,56 @@ module Procore
       @store = store
     end
 
-    private
+    # @raise [OAuthError] if a token cannot be refreshed.
+    def refresh
+      token = fetch_token
 
-    def base_api_path
-      "#{options[:host]}/#{api_version}"
+      begin
+        new_token = @credentials.refresh(
+          token: token.access_token,
+          refresh: token.refresh_token,
+        )
+
+        Util.log_info("Token Refresh Successful", store: store)
+        store.save(new_token)
+      rescue RuntimeError
+        Util.log_error("Token Refresh Failed", store: store)
+        raise Procore::OAuthError.new(
+          "Unable to refresh the access token. Perhaps the Procore API is "  \
+          "down or your access token store is misconfigured. Either "    \
+          "way, you should clear the store and prompt the user to sign in "  \
+          "again.",
+        )
+      end
     end
 
-    def api_version
-      options[:api_version] || 'vapid'
+    # @raise [OAuthError] if a token cannot be revoked.
+    def revoke
+      token = fetch_token
+
+      begin
+        @credentials.revoke(token: token)
+        Util.log_info("Token Revocation Successful", store: store)
+      rescue RuntimeError
+        Util.log_error("Token Revocation Failed", store: store)
+        raise Procore::OAuthError.new(
+          "Unable to revoke the access token. Perhaps the Procore API is "  \
+          "down or your access token store is misconfigured. Either "    \
+          "way, you should clear the store and prompt the user to sign in "  \
+          "again.",
+        )
+      end
     end
 
-    # @raise [OAuthError] if the store does not have a token stored in it prior
-    #   to making a request.
-    # @raise [OAuthError] if a token cannot be refreshed.
-    # @raise [OAuthError] if incorrect credentials have been supplied.
-    def access_token
-      token = store.fetch
+    private
+
+    def base_api_path
+      "#{options[:host]}"
+    end
 
+    # @raise [OAuthError] if the store does not have a token stored.
+    def fetch_token
+      token = store.fetch
       if token.nil? || token.invalid?
         raise Procore::MissingTokenError.new(
           "Unable to retreive an access token from the store. Double check "   \
@@ -62,28 +95,15 @@ module Procore
           "before attempting to make API requests",
         )
       end
+      token
+    end
 
+    def access_token
+      token = fetch_token
       if token.expired?
         Util.log_info("Token Expired", store: store)
-        begin
-          token = @credentials.refresh(
-            token: token.access_token,
-            refresh: token.refresh_token,
-          )
-
-          Util.log_info("Token Refresh Successful", store: store)
-          store.save(token)
-        rescue RuntimeError
-          Util.log_error("Token Refresh Failed", store: store)
-          raise Procore::OAuthError.new(
-            "Unable to refresh the access token. Perhaps the Procore API is "  \
-            "down or the your access token store is misconfigured. Either "    \
-            "way, you should clear the store and prompt the user to sign in "  \
-            "again.",
-          )
-        end
+        refresh
       end
-
       token.access_token
     end
   end

data/lib/procore/configuration.rb

@@ -32,6 +32,15 @@ module Procore
     # @return [String]
     attr_accessor :host
 
+    # @!attribute [rw] default_version
+    # @note defaults to Defaults::DEFAULT_VERSION
+    #
+    # The default API version to use if none is specified in the request.
+    # Should be either "v1.0" (recommended) or "vapid" (legacy).
+    #
+    # @return [String]
+    attr_accessor :default_version
+
     # @!attribute [rw] logger
     # @note defaults to nil
     #
@@ -77,12 +86,26 @@ module Procore
     # @return [String]
     attr_accessor :user_agent
 
+    # @!attribute [rw] default_batch_size
+    # @note defaults to Defaults::BATCH_SIZE
+    #
+    # When using #sync action, sets the default batch size to use for chunking
+    # up a request body. Example, if the size is set to 500 and 2,000 updates
+    # are desired, 4 requests will be made.
+    #
+    # Note: The maximum size is 1,000
+    #
+    # @return [Integer]
+    attr_accessor :default_batch_size
+
     def initialize
+      @default_batch_size = Procore::Defaults::BATCH_SIZE
       @host = Procore::Defaults::API_ENDPOINT
       @logger = nil
       @max_retries = 1
       @timeout = 1.0
       @user_agent = Procore::Defaults::USER_AGENT
+      @default_version = Procore::Defaults::DEFAULT_VERSION
     end
   end
 end

data/lib/procore/defaults.rb

@@ -4,15 +4,22 @@ module Procore
   # Specifies some sensible defaults for certain configurations + clients
   class Defaults
     # Default API endpoint
-    API_ENDPOINT = "https://app.procore.com".freeze
+    API_ENDPOINT = "https://api.procore.com".freeze
 
     # Default User Agent header string
     USER_AGENT = "Procore Ruby Gem #{Procore::VERSION}".freeze
 
+    # Default size to use for batch requests
+    BATCH_SIZE = 500
+
+    # Default API version to use
+    DEFAULT_VERSION = "v1.0"
+
     def self.client_options
       {
         host: Procore.configuration.host,
         user_agent: Procore.configuration.user_agent,
+        default_version: Procore.configuration.default_version,
       }
     end
   end

data/lib/procore/requestable.rb

@@ -19,6 +19,7 @@ module Procore
       RestClient::ServerBrokeConnection,
     ].freeze
     # @param path [String] URL path
+    # @param version [String] API version
     # @param query [Hash] Query options to pass along with the request
     # @option options [Hash] :company_id
     #
@@ -26,8 +27,8 @@ module Procore
     #   client.get("my_open_items", query: { per_page: 5, filter: {} })
     #
     # @return [Response]
-    def get(path, query: {}, options: {})
-      full_path = full_path(path)
+    def get(path, version: nil, query: {}, options: {})
+      full_path = full_path(path, version)
 
       Util.log_info(
         "API Request Initiated",
@@ -47,8 +48,9 @@ module Procore
     end
 
     # @param path [String] URL path
+    # @param version [String] API version
     # @param body [Hash] Body parameters to send with the request
-    # @param options [Hash} Extra request options
+    # @param options [Hash] Extra request options
     # @option options [String] :idempotency_token | :company_id
     #
     # @example Usage
@@ -59,8 +61,8 @@ module Procore
     #   )
     #
     # @return [Response]
-    def post(path, body: {}, options: {})
-      full_path = full_path(path)
+    def post(path, version: nil, body: {}, options: {})
+      full_path = full_path(path, version)
 
       Util.log_info(
         "API Request Initiated",
@@ -81,16 +83,17 @@ module Procore
     end
 
     # @param path [String] URL path
+    # @param version [String] API version
     # @param body [Hash] Body parameters to send with the request
-    # @param options [Hash} Extra request options
+    # @param options [Hash] Extra request options
     # @option options [String] :idempotency_token | :company_id
     #
     # @example Usage
     #   client.put("dashboards/1/users", body: [1,2,3], options: { company_id: 1 })
     #
     # @return [Response]
-    def put(path, body: {}, options: {})
-      full_path = full_path(path)
+    def put(path, version: nil, body: {}, options: {})
+      full_path = full_path(path, version)
 
       Util.log_info(
         "API Request Initiated",
@@ -111,8 +114,9 @@ module Procore
     end
 
     # @param path [String] URL path
+    # @param version [String] API version
     # @param body [Hash] Body parameters to send with the request
-    # @param options [Hash} Extra request options
+    # @param options [Hash] Extra request options
     # @option options [String] :idempotency_token | :company_id
     #
     # @example Usage
@@ -123,8 +127,8 @@ module Procore
     #   )
     #
     # @return [Response]
-    def patch(path, body: {}, options: {})
-      full_path = full_path(path)
+    def patch(path, version: nil, body: {}, options: {})
+      full_path = full_path(path, version)
 
       Util.log_info(
         "API Request Initiated",
@@ -145,6 +149,73 @@ module Procore
     end
 
     # @param path [String] URL path
+    # @param version [String] API version
+    # @param body [Hash] Body parameters to send with the request
+    # @param options [Hash] Extra request options
+    # @option options [String | Integer] :company_id | :batch_size
+    #
+    # @example Usage
+    #   client.sync(
+    #     "projects/sync",
+    #     body: {
+    #       updates: [
+    #        { id: 1, name: "Update 1" },
+    #        { id: 2, name: "Update 2" },
+    #        { id: 3, name: "Update 3" },
+    #        ...
+    #        ...
+    #        { id: 5055, name: "Update 5055" },
+    #       ]
+    #     },
+    #     options: { batch_size: 500, company_id: 1 },
+    #   )
+    #
+    # @return [Response]
+    def sync(path, version: nil, body: {}, options: {})
+      full_path = full_path(path, version)
+
+      batch_size = options[:batch_size] ||
+        Procore.configuration.default_batch_size
+
+      if batch_size > 1000
+        batch_size = 1000
+      end
+
+      Util.log_info(
+        "API Request Initiated",
+        path: full_path,
+        method: "SYNC",
+        batch_size: batch_size,
+      )
+
+      groups = body[:updates].each_slice(batch_size).to_a
+
+      responses = groups.map do |group|
+        batched_body = body.merge(updates: group)
+        with_response_handling(request_body: batched_body) do
+          RestClient::Request.execute(
+            method: :patch,
+            url: full_path,
+            payload: payload(batched_body),
+            headers: headers(options),
+            timeout: Procore.configuration.timeout,
+          )
+        end
+      end
+
+      Procore::Response.new(
+        body: responses.reduce({}) do |combined, response|
+          combined.deep_merge(response.body) { |_, v1, v2| v1 + v2 }
+        end.to_json,
+        headers: responses.map(&:headers).inject({}, &:deep_merge),
+        code: 200,
+        request: responses.last&.request,
+        request_body: body,
+      )
+    end
+
+    # @param path [String] URL path
+    # @param version [String] API version
     # @param query [Hash] Query options to pass along with the request
     # @option options [String] :company_id
     #
@@ -152,8 +223,8 @@ module Procore
     #   client.delete("users/1", query: {}, options: {})
     #
     # @return [Response]
-    def delete(path, query: {}, options: {})
-      full_path = full_path(path)
+    def delete(path, version: nil, query: {}, options: {})
+      full_path = full_path(path, version)
 
       Util.log_info(
         "API Request Initiated",
@@ -204,7 +275,6 @@ module Procore
         code: result.code,
         request: result.request,
         request_body: request_body,
-        api_version: api_version
       )
 
       case result.code
@@ -273,6 +343,7 @@ module Procore
         "Accepts" => "application/json",
         "Authorization" => "Bearer #{access_token}",
         "Content-Type" => "application/json",
+        "Procore-Sdk-Version" => "ruby-#{Procore::VERSION}",
         "User-Agent" => Procore.configuration.user_agent,
       }.tap do |headers|
         if options[:idempotency_token]
@@ -297,8 +368,15 @@ module Procore
       RestClient::Payload::has_file?(body)
     end
 
-    def full_path(path)
-      File.join(base_api_path, path).to_s
+    def full_path(path, version)
+      version ||= options[:default_version]
+      if version == "vapid"
+        File.join(base_api_path, "vapid", path)
+      elsif /\Av\d+\.\d+\z/.match?(version)
+        File.join(base_api_path, "rest", version, path)
+      else
+        raise Procore::InvalidRequestError.new "#{version} is an invalid Procore API version"
+      end
     end
   end
 end

data/lib/procore/response.rb

@@ -45,12 +45,11 @@ module Procore
     #   @return [Integer] Status Code returned from Procore API.
     # @!attribute [r] pagination
     #   @return [Hash<Symbol, String>] Pagination URLs
-    attr_reader :headers, :code, :pagination, :request, :request_body, :api_version
+    attr_reader :headers, :code, :pagination, :request, :request_body
 
-    def initialize(body:, headers:, code:, request:, request_body:, api_version: 'vapid')
+    def initialize(body:, headers:, code:, request:, request_body:)
       @code = code
       @headers = headers
-      @api_version = api_version
       @pagination = parse_pagination
       @request = request
       @request_body = request_body
@@ -73,7 +72,7 @@ module Procore
 
     def parse_pagination
       headers[:link].to_s.split(", ").map(&:strip).reduce({}) do |links, link|
-        url, name = link.match(/#{api_version}\/(.*?)>; rel="(\w+)"/).captures
+        url, name = link.match(/(?:vapid|rest\/.*?)\/(.*?)>; rel="(\w+)"/).captures
         links.merge!(name.to_sym => url)
       end
     end

data/lib/procore/version.rb

@@ -1,3 +1,3 @@
 module Procore
-  VERSION = "0.8.7".freeze
+  VERSION = "1.1.2".freeze
 end

data/procore.gemspec

@@ -32,7 +32,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "redis"
   spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "sqlite3", "~> 1.3.6"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "rubocop-rails"
+  spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "webmock"
 
   spec.add_dependency "activesupport", "> 2.4"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: procore
 version: !ruby/object:Gem::Version
-  version: 0.8.7
+  version: 1.1.2
 platform: ruby
 authors:
 - Procore Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-18 00:00:00.000000000 Z
+date: 2021-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -150,20 +150,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -255,6 +283,7 @@ files:
 - lib/procore/response.rb
 - lib/procore/util.rb
 - lib/procore/version.rb
+- procore-1.1.1.gem
 - procore.gemspec
 homepage: https://github.com/procore/ruby-sdk
 licenses:
@@ -275,7 +304,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Procore Ruby Gem