servicestack 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 991af3e1951fbd5467476753e01f05db5992e7399cb0ac3ca0acfaf909056b8e
-  data.tar.gz: 0e2dcc59cb68a58911ba105d82ff245aff0001a5e41870324c5c2cd12d31e2f9
+  metadata.gz: 2b7903981eedef3d52ed39c54494f5370fa0d3a83abe743289468b9d395eef5c
+  data.tar.gz: 93db68996921d3d6eb3368e7414ab97ed23a422d907a90f831aec05bf256d33b
 SHA512:
-  metadata.gz: f4c822aad83ce16504e03018f13112a36b3c3added39d5f3d52c3dd5234c9d20bcadf03e8dad3eb8f65c671359c5b7d50e53277ae46304ac8fb68f186bd08c7a
-  data.tar.gz: 84eadaa862a26af3237499a7d07682243b61ed5b97314ed3f498002e94c2360c938186ff90b423e7a6b4e3dbf404b5cf1323b5b4e318804e7fbdc48f7ac29b0d
+  metadata.gz: 16408c56eeda8c631548ad2f38cc236381b075bd8d60700a6703d27b32eaf0e1db43952a6426a4f14333f4c50c725aeb0257fbdcc59b7da6141066ad4b350fec
+  data.tar.gz: 4e0aaa64d2dee290002cd659254db4637c65a3b35b3a7b6a69b72353fd280a2e20cc33eb1fb2a0ceb080887aa58d8bd9c9b34a797a8c984e40f131aef1453e64

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.1.3]
+
+### Added
+
+- `npm run bump` / `npm run release` scripts that tag a version and create the
+  GitHub Release, which the `release` workflow publishes to RubyGems
+
+## [0.1.2]
+
+### Added
+
+- `on_authentication_required` callback for re-authenticating a client before
+  automatically retrying a Request that returned 401 Unauthorized
+
 ## [0.1.1]
 
 ### Added
@@ -26,5 +40,7 @@ All notable changes to this project will be documented in this file.
 - Built-in ServiceStack DTOs referenced by generated DTOs (`ResponseStatus`,
   `QueryBase`, `QueryResponse`, `Authenticate`, ...)
 
+[0.1.3]: https://github.com/ServiceStack/servicestack-ruby/releases/tag/v0.1.3
+[0.1.2]: https://github.com/ServiceStack/servicestack-ruby/releases/tag/v0.1.2
 [0.1.1]: https://github.com/ServiceStack/servicestack-ruby/releases/tag/v0.1.1
 [0.1.0]: https://github.com/ServiceStack/servicestack-ruby/releases/tag/v0.1.0

data/README.md

@@ -162,6 +162,25 @@ refreshed and the failed Request retried:
 client.set_refresh_token(refresh_token)
 ```
 
+### Transparently handle 401 Unauthorized Responses
+
+If the Server returns a 401 Unauthorized Response either because the client was
+unauthenticated or its Bearer Token or API Key had expired, use the
+`on_authentication_required` callback to re-configure the client before the
+original Request is automatically retried:
+
+```ruby
+client.on_authentication_required = lambda { |c|
+  c.authenticate(user_name, password)
+}
+
+# Automatically retries Requests returning 401 Responses
+res = client.send(Secured.new)
+```
+
+A configured Refresh Token takes precedence over the callback, which is only
+used when no Refresh Token is set or refreshing it failed.
+
 ### Batched Requests
 
 ```ruby
@@ -217,6 +236,25 @@ rake test              # unit tests
 rake test:integration  # integration tests against test.servicestack.net
 ```
 
+## Releasing
+
+Releases are cut with npm scripts and published by the `release` GitHub Action:
+
+```bash
+npm run bump              # 0.1.0 -> 0.1.1 (also `-- minor`, `-- major`, `-- 1.2.3`)
+# describe the release in CHANGELOG.md, then
+npm run release
+```
+
+Or in a single step:
+
+```bash
+npm run release -- patch
+```
+
+`npm run release` tags the version, pushes it and creates the GitHub Release,
+which triggers the workflow that runs the tests and publishes it to [RubyGems](https://rubygems.org/gems/servicestack).
+
 ## License
 
 BSD-3-Clause. See [LICENSE](LICENSE).

data/lib/servicestack/json_service_client.rb

@@ -71,7 +71,7 @@ module ServiceStack
     attr_accessor :base_url, :reply_base_url, :oneway_base_url, :headers,
                   :bearer_token, :refresh_token, :refresh_token_uri,
                   :user_name, :password, :request_filter, :response_filter,
-                  :timeout, :cookies
+                  :timeout, :cookies, :on_authentication_required
 
     class << self
       # Filters applied to every Request and Response of all clients.
@@ -309,7 +309,7 @@ module ServiceStack
       capture_cookies(response)
 
       status_code = response.code.to_i
-      if status_code == 401 && retry_on_auth_failure && refresh_access_token
+      if status_code == 401 && retry_on_auth_failure && handle_authentication_required
         return execute(method, url, body, retry_on_auth_failure: false, content_type: content_type)
       end
 
@@ -375,6 +375,26 @@ module ServiceStack
       end
     end
 
+    # Re-authenticates the client after a Request returned 401 Unauthorized,
+    # returning whether the Request should be retried.
+    #
+    # Uses the Refresh Token when configured, otherwise the
+    # `on_authentication_required` callback.
+    def handle_authentication_required
+      return true if refresh_access_token
+      return false if @on_authentication_required.nil?
+
+      if @on_authentication_required.arity.zero?
+        @on_authentication_required.call
+      else
+        @on_authentication_required.call(self)
+      end
+      true
+    rescue StandardError
+      # Re-authenticating failed, return the original 401 Response
+      false
+    end
+
     def refresh_access_token
       return false if @refresh_token.to_s.empty?
 

data/lib/servicestack/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ServiceStack
-  VERSION = '0.1.1'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: servicestack
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - ServiceStack
@@ -49,7 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Typed Ruby Client Library for consuming ServiceStack APIs
 test_files: []