zaikio-hub 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18214a7030901b40e09a743798f3356cc2821588be5639360466d510425ecc1a
-  data.tar.gz: f1f691ed65c67d461bf4cc95ed0fdea6bf258ee7e8a7fb92778396c921df7bbe
+  metadata.gz: bc8cad3e052fb8b2a20e218a59ecbaafb01811adc2b166cc512797f9c7d36047
+  data.tar.gz: ff4b1176481847d8cc8dd015d6275d2630ff85886d441d8906be591590ec27fa
 SHA512:
-  metadata.gz: 7fb26a98cbf56f0cb9e4390d88af710b0452539b65d5f3b3dce474936e373bfaa77b6e98e1731560b9b44a2808ac96a958ac0b9a501961158084388cd94526e7
-  data.tar.gz: 79a2a1bcaf197e4eae88d31a8b87f0a3e127b1927f3e33f1437c9c52f5e1fd4e2fa42691974bee2c555c1eef6ec4f7a8aeb2263ec656ff2bd535267d0e3c8925
+  metadata.gz: 1b05da9a0bf4d590c5fdf7ffd535c3f0d27baaa3cde3d2a4764a4ef5cdd8f8a5414fa5777ac33a3908893096492aa880e1eac9e0a34d6b68eb5fe0115f441214
+  data.tar.gz: 7e6ab83a077728d97fb54800aa13bff979a7895fa24b0960d62c14ea4cb36363ac7393be3ff7428548a14c19154116327820b129617ad04a1da224fefc867383

data/CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.11.0] - 2022-08-30
+
+* Extract token data logic into its own `Zaikio::Hub::TokenData` class
+  This also exposes the `sub` attribute of the token as `TokenData#subject`.
+* Support newer versions of `jwt` and `spyke`
+
+## [0.10.0] - 2022-08-15
+
+* Update `zaikio-client-helpers` and reuse logic to use `Zaikio::Client.with_token`
+
+## [0.9.1] - 2022-01-05
+
+* Fix warning about redefined methods in BasicAuthMiddleware
+* Permit newer versions of Spyke & JWT gems
+
 ## [0.9.0] - 2021-08-31
 
 * Added `.connections` and `.apps` for `CurrentOrganization`s that are vendors
@@ -81,7 +96,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Added subscriptions (migration required)
 
-[Unreleased]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.9.0..HEAD
+[Unreleased]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.11.0..HEAD
+[0.11.0]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.10.0..v0.11.0
+[0.10.0]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.9.0..v0.10.0
 [0.9.0]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.8.0..v0.9.0
 [0.8.0]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.7.0..v0.8.0
 [0.7.0]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.6.2..v0.7.0

data/Rakefile

@@ -29,9 +29,7 @@ task default: :test
 
 namespace :test do
   desc 'Runs RuboCop on specified directories'
-  RuboCop::RakeTask.new(:rubocop) do |task|
-    task.fail_on_error = false
-  end
+  RuboCop::RakeTask.new(:rubocop)
 end
 
 Rake::Task[:test].enhance ['test:rubocop']

data/lib/zaikio/hub/basic_auth_middleware.rb

@@ -4,8 +4,6 @@ require "base64"
 module Zaikio
   module Hub
     class BasicAuthMiddleware < Faraday::Middleware
-      class_attribute :credentials
-
       def self.credentials
         @credentials ||= Concurrent::ThreadLocalVar.new { nil }
         @credentials.value

data/lib/zaikio/hub/client.rb

@@ -1,3 +1,5 @@
+require "jwt"
+
 module Zaikio
   module Hub
     class RequestWrapper

data/lib/zaikio/hub/configuration.rb

@@ -2,38 +2,15 @@ require "logger"
 
 module Zaikio
   module Hub
-    class Configuration
-      HOSTS = {
-        development: "https://hub.zaikio.test",
-        test: "https://hub.zaikio.test",
-        staging: "https://hub.staging.zaikio.com",
-        sandbox: "https://hub.sandbox.zaikio.com",
-        production: "https://hub.zaikio.com"
-      }.freeze
-
-      attr_accessor :host
-      attr_reader :environment
-      attr_writer :logger
-
-      def initialize
-        @environment = :sandbox
-      end
-
-      def logger
-        @logger ||= Logger.new($stdout)
-      end
-
-      def environment=(env)
-        @environment = env.to_sym
-        @host = host_for(environment)
-      end
-
-      private
-
-      def host_for(environment)
-        HOSTS.fetch(environment) do
-          raise StandardError.new, "Invalid Zaikio::Hub environment '#{environment}'"
-        end
+    class Configuration < Zaikio::Client::Helpers::Configuration
+      def self.hosts
+        {
+          development: "https://hub.zaikio.test/api/v1",
+          test: "https://hub.zaikio.test/api/v1",
+          staging: "https://hub.staging.zaikio.com/api/v1",
+          sandbox: "https://hub.sandbox.zaikio.com/api/v1",
+          production: "https://hub.zaikio.com/api/v1"
+        }.freeze
       end
     end
   end

data/lib/zaikio/hub/current_organization.rb

@@ -54,11 +54,11 @@ module Zaikio
       end
 
       def create_subscription(status: "active", plan_name: nil)
-        if Zaikio::Hub.current_token_data.subject_type == "Organization"
-          result = self.class.request(:post, "organization/subscription",
-                                      subscription: { status: status, plan_name: plan_name })
-          Zaikio::Hub::Subscription.new(result.data)
-        end
+        return unless Zaikio::Hub.current_token_data.subject_type == "Organization"
+
+        result = self.class.request(:post, "organization/subscription",
+                                    subscription: { status: status, plan_name: plan_name })
+        Zaikio::Hub::Subscription.new(result.data)
       end
     end
   end

data/lib/zaikio/hub/token_data.rb

@@ -0,0 +1,51 @@
+module Zaikio
+  module Hub
+    class TokenData
+      attr_reader :audience, :on_behalf_of, :subject, :scopes
+
+      def self.from(payload)
+        subjects = payload["sub"].split(">")
+
+        new(
+          audience: payload["aud"].first,
+          on_behalf_of: subjects.first,
+          subject: subjects.last,
+          scopes: payload["scope"]
+        )
+      end
+
+      def initialize(audience:, on_behalf_of:, subject:, scopes:)
+        @audience = audience
+        @on_behalf_of = on_behalf_of
+        @subject = subject
+        @scopes = scopes
+      end
+
+      def on_behalf_of_type
+        @on_behalf_of_type ||= type_for(:on_behalf_of)
+      end
+
+      def on_behalf_of_id
+        @on_behalf_of_id ||= id_for(:on_behalf_of)
+      end
+
+      def subject_type
+        @subject_type ||= type_for(:subject)
+      end
+
+      def subject_id
+        @subject_id ||= id_for(:subject)
+      end
+
+      private
+
+      def type_for(key)
+        public_send(key).split("/").first
+      end
+
+      def id_for(key)
+        public_send(key).split("/").last
+      end
+    end
+  end
+end

data/lib/zaikio/hub/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module Hub
-    VERSION = "0.9.0".freeze
+    VERSION = "0.11.0".freeze
   end
 end

data/lib/zaikio/hub.rb

@@ -3,7 +3,6 @@ require "spyke"
 require "zaikio-client-helpers"
 
 require "zaikio/hub/configuration"
-require "zaikio/hub/authorization_middleware"
 require "zaikio/hub/basic_auth_middleware"
 
 # Models
@@ -28,6 +27,7 @@ require "zaikio/hub/connection"
 require "zaikio/hub/app"
 require "zaikio/hub/subscription"
 require "zaikio/hub/test_account"
+require "zaikio/hub/token_data"
 
 module Zaikio
   module Hub
@@ -44,11 +44,8 @@ module Zaikio
         Base.connection = create_connection
       end
 
-      def with_token(token)
-        AuthorizationMiddleware.token = token
-        yield
-      ensure
-        AuthorizationMiddleware.reset_token
+      def with_token(token, &block)
+        Zaikio::Client.with_token(token, &block)
       end
 
       def with_basic_auth(login, password)
@@ -59,36 +56,25 @@ module Zaikio
       end
 
       def current_token_data
-        return unless AuthorizationMiddleware.token
+        return unless Zaikio::Client::Helpers::AuthorizationMiddleware.token
 
-        payload = JWT.decode(AuthorizationMiddleware.token, nil, false).first
+        payload = JWT.decode(
+          Zaikio::Client::Helpers::AuthorizationMiddleware.token,
+          nil,
+          false
+        ).first
 
         create_token_data(payload)
       end
 
       def create_connection
-        self.connection = Faraday.new(url: "#{configuration.host}/api/v1",
-                                      ssl: { verify: configuration.environment != :test }) do |c|
-          c.request     :json
-          c.response    :logger, configuration&.logger, headers: false
-          c.use         Zaikio::Client::Helpers::Pagination::FaradayMiddleware
-          c.use         Zaikio::Client::Helpers::JSONParser
-          c.use         AuthorizationMiddleware
-          c.use         BasicAuthMiddleware
-          c.adapter     Faraday.default_adapter
+        self.connection = Zaikio::Client.create_connection(configuration).tap do |c|
+          c.use BasicAuthMiddleware
         end
       end
 
       def create_token_data(payload)
-        subjects = payload["sub"].split(">")
-
-        OpenStruct.new(
-          audience: payload["aud"].first,
-          on_behalf_of_id: subjects.first.split("/").last,
-          subject_id: subjects.last.split("/").last,
-          subject_type: subjects.last.split("/").first,
-          scopes: payload["scope"]
-        )
+        TokenData.from(payload)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-hub
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - crispymtn
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-31 00:00:00.000000000 Z
+date: 2022-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -30,16 +30,22 @@ dependencies:
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -89,7 +95,7 @@ dependencies:
         version: 5.3.4
     - - "<"
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 6.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -99,21 +105,21 @@ dependencies:
         version: 5.3.4
     - - "<"
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 6.2.0
 - !ruby/object:Gem::Dependency
   name: zaikio-client-helpers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 description: Ruby API Client for Zaikio's Hub
 email:
 - op@crispymtn.com
@@ -131,7 +137,6 @@ files:
 - lib/zaikio/hub/address.rb
 - lib/zaikio/hub/app.rb
 - lib/zaikio/hub/asset.rb
-- lib/zaikio/hub/authorization_middleware.rb
 - lib/zaikio/hub/base.rb
 - lib/zaikio/hub/basic_auth_middleware.rb
 - lib/zaikio/hub/business_relationship.rb
@@ -152,6 +157,7 @@ files:
 - lib/zaikio/hub/specialist.rb
 - lib/zaikio/hub/subscription.rb
 - lib/zaikio/hub/test_account.rb
+- lib/zaikio/hub/token_data.rb
 - lib/zaikio/hub/version.rb
 homepage: https://www.zaikio.com/
 licenses:

data/lib/zaikio/hub/authorization_middleware.rb

@@ -1,32 +0,0 @@
-require "faraday"
-require "jwt"
-require "concurrent"
-
-module Zaikio
-  module Hub
-    class AuthorizationMiddleware < Faraday::Middleware
-      def self.token
-        @token ||= Concurrent::ThreadLocalVar.new { nil }
-        @token.value
-      end
-
-      def self.token=(value)
-        @token ||= Concurrent::ThreadLocalVar.new { nil }
-        @token.value = value
-      end
-
-      def self.reset_token
-        self.token = nil
-      end
-
-      def call(request_env)
-        if self.class.token
-          request_env[:request_headers]["Authorization"] = "Bearer #{self.class.token}"
-        end
-
-        @app.call(request_env).on_complete do |response_env|
-        end
-      end
-    end
-  end
-end