procore 0.8.7 → 0.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e9072c893654842077d13100acc0afa9f78a4af28e902748494c58f467c8350
-  data.tar.gz: b78ba6679d1dfbc2d96d0b395a9778278eac1979efa1fccb5bb3063d81b7430d
+  metadata.gz: cc64539748539d38af7f3dedc9a825ae8dff0f84939a53cddf1bf124dcba6c0a
+  data.tar.gz: 3a5bbe135e42bbf3d05e7d68a45829bf6dc185334e73ea579ca88cee66ccb757
 SHA512:
-  metadata.gz: e36b749b1c34f1f87316c1530a4668bc4e52914fd5b60e29d4a5055755957dbcf46d87028b62baaedec45de57815ba93d4dd305f04dd19fb7972114fe350a8a7
-  data.tar.gz: c49008dd2ccf0cc0d37fc1457462328a0916161a9bb54c1bd1c35c9d537ccd284b90d319e4c67cadce4b6afc530a37f80347af163877fc52978f69f39c07e4ae
+  metadata.gz: f3450511913a6f4c6933a263dfc05d4b564f49978bc334ae043100f4b028b3191dbc486ef0f42bc623da510e3922789a6abbc8120d8f7539e1164c06f91452c5
+  data.tar.gz: 2f82f682587398a82831a024a86fff4c986edc4927828a4fb478ef58a6d3b45f080a3dc9822aaf4c7a1a1ac212d7bf53b829efeaa5286d246d86be305a8fe92e

data/.travis.yml

@@ -7,6 +7,7 @@ rvm:
 
 services:
   - redis-server
+  - memcached
 
 before_install:
   - gem update --system

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## Unreleased
 
+## 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)
 
 * Add api_version to allow calls to procore rest endpoints

data/README.md

@@ -10,6 +10,7 @@
 - [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 +20,7 @@
   - [File Store](#file-store)
   - [Memory Store](#memory-store)
 - [Full Example](#full-example)
+- [Contributing](#contributing)
 
 ## Installation
 
@@ -39,8 +41,8 @@ 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: {})
@@ -48,6 +50,7 @@ post(path, body: {}, options: {})
 put(path, body: {}, options: {})
 patch(path, body: {}, options: {})
 delete(path, query: {})
+sync(path, body: {}, options: {})
 ```
 
 All paths are relative - the gem will handle expanding `client.get("me")` to
@@ -259,6 +262,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.
@@ -273,6 +319,11 @@ Procore.configure do |config|
   # instead of production.
   config.host = ENV.fetch("PROCORE_BASE_API_PATH", "https://app.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
+
   # Integer: Number of times to retry a failed API call. Reasons an API call
   # could potentially fail:
   # 1. Service is briefly down or unreachable
@@ -433,6 +484,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/configuration.rb

@@ -77,7 +77,20 @@ 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

data/lib/procore/defaults.rb

@@ -9,6 +9,9 @@ module Procore
     # Default User Agent header string
     USER_AGENT = "Procore Ruby Gem #{Procore::VERSION}".freeze
 
+    # Default size to use for batch requests
+    BATCH_SIZE = 500
+
     def self.client_options
       {
         host: Procore.configuration.host,

data/lib/procore/requestable.rb

@@ -48,7 +48,7 @@ module Procore
 
     # @param path [String] URL path
     # @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
@@ -82,7 +82,7 @@ module Procore
 
     # @param path [String] URL path
     # @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
@@ -112,7 +112,7 @@ module Procore
 
     # @param path [String] URL path
     # @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
@@ -144,6 +144,72 @@ 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
+    # @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, body: {}, options: {})
+      full_path = full_path(path)
+
+      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].in_groups_of(batch_size, false)
+
+      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,
+        api_version: api_version,
+      )
+    end
+
     # @param path [String] URL path
     # @param query [Hash] Query options to pass along with the request
     # @option options [String] :company_id

data/lib/procore/version.rb

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

data/procore.gemspec

@@ -32,7 +32,7 @@ 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 "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: 0.8.8
 platform: ruby
 authors:
 - Procore Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-18 00:00:00.000000000 Z
+date: 2019-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -154,16 +154,16 @@ dependencies:
   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