procore 0.8.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc64539748539d38af7f3dedc9a825ae8dff0f84939a53cddf1bf124dcba6c0a
-  data.tar.gz: 3a5bbe135e42bbf3d05e7d68a45829bf6dc185334e73ea579ca88cee66ccb757
+  metadata.gz: ab6a771f9ecbd227e500591c59381e08e70b1ad3cea2f82e767b4de2d88664b3
+  data.tar.gz: 1159fa494f5d38ce2d0a0fbcbdb465bf6203e8989a96acf3bcceab915ea9dbac
 SHA512:
-  metadata.gz: f3450511913a6f4c6933a263dfc05d4b564f49978bc334ae043100f4b028b3191dbc486ef0f42bc623da510e3922789a6abbc8120d8f7539e1164c06f91452c5
-  data.tar.gz: 2f82f682587398a82831a024a86fff4c986edc4927828a4fb478ef58a6d3b45f080a3dc9822aaf4c7a1a1ac212d7bf53b829efeaa5286d246d86be305a8fe92e
+  metadata.gz: e1c9f942d9c8223df00bff8c67b366adc85be3224d2a6ef41ee4e345d40cba8cc0ca71fe0361ff094be1ba358d3ad7ead40fc99d36bba8e5edac0dfc19932c57
+  data.tar.gz: afb9275ad4ec9b1396f3f7bed77317eb39b8e6cacf5d82dc77b38e9a934491e439795fe7df432d27fdc337800b7343327f1cb9d7b70c072ed72244bcd41d6a0a

data/.rubocop.yml

@@ -1,5 +1,9 @@
+require: 
+  - rubocop-rails
+  - rubocop-performance
+
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
   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/CHANGELOG.md

@@ -1,4 +1,52 @@
-## Unreleased
+## 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)
 

data/README.md

@@ -4,6 +4,7 @@
 
 #### Table of Contents
 - [Installation](#installation)
+- [1.0.0 Release](#1.0.0-release)
 - [Making Requests](#making-requests)
 - [Usage](#usage)
 - [Error Handling](#error-handling)
@@ -30,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
@@ -41,20 +47,27 @@ 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`, '#sync' and
+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: {})
-sync(path, body: {}, options: {})
+   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://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` |
 
 Example Usage:
 
@@ -72,6 +85,19 @@ companies = client.get("companies")
 companies.first[:name] #=> "Procore Company 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
 
 The first step is to place the user's token into the store. For this example,
@@ -324,6 +350,10 @@ Procore.configure do |config|
   # 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:
   # 1. Service is briefly down or unreachable

data/lib/procore/client.rb

@@ -41,11 +41,7 @@ module Procore
     private
 
     def base_api_path
-      "#{options[:host]}/#{api_version}"
-    end
-
-    def api_version
-      options[:api_version] || 'vapid'
+      "#{options[:host]}"
     end
 
     # @raise [OAuthError] if the store does not have a token stored in it prior

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
     #
@@ -96,6 +105,7 @@ module Procore
       @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

@@ -12,10 +12,14 @@ module Procore
     # 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,6 +48,7 @@ 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] :idempotency_token | :company_id
@@ -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,6 +83,7 @@ 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] :idempotency_token | :company_id
@@ -89,8 +92,8 @@ module Procore
     #   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,6 +114,7 @@ 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] :idempotency_token | :company_id
@@ -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,7 @@ 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
@@ -166,8 +171,8 @@ module Procore
     #   )
     #
     # @return [Response]
-    def sync(path, body: {}, options: {})
-      full_path = full_path(path)
+    def sync(path, version: nil, body: {}, options: {})
+      full_path = full_path(path, version)
 
       batch_size = options[:batch_size] ||
         Procore.configuration.default_batch_size
@@ -183,7 +188,7 @@ module Procore
         batch_size: batch_size,
       )
 
-      groups = body[:updates].in_groups_of(batch_size, false)
+      groups = body[:updates].each_slice(batch_size).to_a
 
       responses = groups.map do |group|
         batched_body = body.merge(updates: group)
@@ -206,11 +211,11 @@ module Procore
         code: 200,
         request: responses.last&.request,
         request_body: body,
-        api_version: api_version,
       )
     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
     #
@@ -218,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",
@@ -270,7 +275,6 @@ module Procore
         code: result.code,
         request: result.request,
         request_body: request_body,
-        api_version: api_version
       )
 
       case result.code
@@ -363,8 +367,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 ArgumentError.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.8".freeze
+  VERSION = "1.0.0".freeze
 end

data/procore.gemspec

@@ -32,6 +32,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "redis"
   spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "rubocop-rails"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "webmock"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: procore
 version: !ruby/object:Gem::Version
-  version: 0.8.8
+  version: 1.0.0
 platform: ruby
 authors:
 - Procore Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-17 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -150,6 +150,34 @@ 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
@@ -275,7 +303,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Procore Ruby Gem