procore 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: ab6a771f9ecbd227e500591c59381e08e70b1ad3cea2f82e767b4de2d88664b3
-  data.tar.gz: 1159fa494f5d38ce2d0a0fbcbdb465bf6203e8989a96acf3bcceab915ea9dbac
+SHA1:
+  metadata.gz: 9cd9c39ae342255313380ec2630ef51b60500eae
+  data.tar.gz: 5985c77c80a79229743539c37dc049b9a243939a
 SHA512:
-  metadata.gz: e1c9f942d9c8223df00bff8c67b366adc85be3224d2a6ef41ee4e345d40cba8cc0ca71fe0361ff094be1ba358d3ad7ead40fc99d36bba8e5edac0dfc19932c57
-  data.tar.gz: afb9275ad4ec9b1396f3f7bed77317eb39b8e6cacf5d82dc77b38e9a934491e439795fe7df432d27fdc337800b7343327f1cb9d7b70c072ed72244bcd41d6a0a
+  metadata.gz: 1db78e84a20c38b6cc6707c027d8649ab0a4e9c2c820c2d3b6bacbde1fc017ad337dd094fa8ad218794cb92c6ded0bf6e902d2d20becf30dc96529ac0afb93c9
+  data.tar.gz: 2c0a9ea9b6bb6e05ff31508dfccc06e439239214a6cd1e051c91ba1af808cf62685bab70673af4d8676eeb9121e852df5d4ab21e643ff404837717db56f1fc4b

data/.travis.yml

@@ -1,30 +1,25 @@
 language: ruby
 rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-
+- 2.3
+- 2.4
+- 2.5
+- 2.6
 services:
-  - redis-server
-  - memcached
-
+- 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,3 +1,11 @@
+## 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

data/README.md

@@ -4,7 +4,7 @@
 
 #### Table of Contents
 - [Installation](#installation)
-- [1.0.0 Release](#1.0.0-release)
+- [1.0.0 Release](#100-release)
 - [Making Requests](#making-requests)
 - [Usage](#usage)
 - [Error Handling](#error-handling)
@@ -141,6 +141,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.

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,19 +38,56 @@ module Procore
       @store = store
     end
 
+    # @raise [OAuthError] if a token cannot be refreshed.
+    def refresh
+      token = fetch_token
+
+      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
+
+    # @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
+
     private
 
     def base_api_path
       "#{options[:host]}"
     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
+    # @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 "   \
@@ -58,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/requestable.rb

@@ -374,7 +374,7 @@ module Procore
       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"
+        raise Procore::InvalidRequestError.new "#{version} is an invalid Procore API version"
       end
     end
   end

data/lib/procore/version.rb

@@ -1,3 +1,3 @@
 module Procore
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: procore
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Procore Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-05 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -303,7 +303,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubyforge_project: 
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Procore Ruby Gem