zaikio-directory 0.0.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7653b475ee39d478558afbbb71d480e290d68d611a41bbb0de24a3e3a50c100e
-  data.tar.gz: ee3b15b9e502a5dad7a9ce93dad1d04c16ff580dbab7a8b4271edf17d0cd6c6b
+  metadata.gz: 8dc2956d9034111c7ad80906d9f705c98503817f6cc6cb938f787646ca31cd7f
+  data.tar.gz: f8418bfc9b9c98ae9d245f24c50d5ac5f62493a56f36d5a1bfd5b769a24d7e9e
 SHA512:
-  metadata.gz: 9cf7796e0a543846086b72f9aa4efca2801a4c6bc406348f540f4b3a5759ba0849c644aae429e1db2580ce3480ec5c862f39a00ec7ebfdbe32aae7a2349cd3c6
-  data.tar.gz: d2d639c0786810fb6a05e91372627f390e9742246bcf6fe5f4593fe467fc39c7180b1d64ae39e16c27701485157691ea492843a2527021d307650b17012c3ffb
+  metadata.gz: 00a3f4b24da97e0a6b7ecf041fe466e4ea30554f4ccc0b05cb51a5b1f14051c9c4516fec892b675d54f747b524b0dd0cf8b3eea8bdeaefc22388cf731762a0a1
+  data.tar.gz: a28cb5c4cae83c646c815019a41b0f6f0e592a7398caeaf582cbe52c2b7ba492e817d98255649c119a00ad1d25f88343897ffe1d40f16ae4cb0064770c066884

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] - 2020-01-21
+
+### Added
+
+- `Zaikio::Directory::TestAccount`
+
+## [0.1.1] - 2020-09-02
+
+### Fixed
+- Thread-Safety on current access token
+
+## [0.1.0] - 2020-08-24
+
+### Added
+- Added subscriptions (migration required)
+
+[Unreleased]: https://github.com/zaikio/zaikio-directory-ruby/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/zaikio/zaikio-directory-ruby/compare/v0.1.1...v.0.2.0
+[0.1.1]: https://github.com/zaikio/zaikio-directory-ruby/compare/5c6cb4dbcac316733560ddb2b1e13b53e55eb66e...v0.1.1
+[0.1.0]: https://github.com/zaikio/zaikio-directory-ruby/compare/d149fb4c0abe6005f123def3952d2dd2ef6404bb...29889d8a6a496542a81e05688da2a46cf4c44188

data/README.md

@@ -26,7 +26,7 @@ $ gem install zaikio-directory
 # config/initializers/zaikio_directory.rb
 
 Zaikio::Directory.configure do |config|
-  config.host :production # sandbox or production
+  config.environment = :production # sandbox or production
 end
 ```
 
@@ -35,7 +35,7 @@ end
 
 The Directory Client has an ORM like design. However, we distinguish between the contexts of the organization and the person.
 
-For the requests to work, a valid JSON Web token with the correct OAuth Scopes must always be provided. Please refer to [zakio-oauth_client](#todo).
+For the requests to work, a valid JSON Web token with the correct OAuth Scopes must always be provided. Please refer to [zakio-oauth_client](https://github.com/zaikio/zaikio-oauth_client).
 
 If you want to know which actions are available and which scopes are required, please refer to the [Directory API Reference](https://docs.zaikio.com/api/directory/directory.html).
 
@@ -97,6 +97,19 @@ end
 ```rb
 Zaikio::Directory.with_basic_auth(client_id, client_secret) do
   connections = Zaikio::Directory::Connection.all
+  subscription = Zaikio::Directory::Subscription.find("Organization-b1475f65-236c-58b8-96e1-e1778b43beb7")
+  subscription.plan # => "advanced"
+  subscription.activate!
+  subscription.increment_usage_by!(:orders_created, 12)
+end
+
+Zaikio::Directory.with_basic_auth(client_id, client_secret) do
+  Zaikio::Directory::TestAccount.create(
+    name: "My Test Org",
+    country_code: "DE",
+    kinds: ["printer"],
+    connection_attributes: ["procurement_consumer"]
+  )
 end
 
 roles = Zaikio::Directory::Role.all

data/lib/zaikio/directory.rb

@@ -23,29 +23,33 @@ require "zaikio/directory/current_organization"
 require "zaikio/directory/role"
 require "zaikio/directory/revoked_access_token"
 require "zaikio/directory/connection"
+require "zaikio/directory/subscription"
+require "zaikio/directory/test_account"
 
 module Zaikio
   module Directory
     class << self
       attr_accessor :configuration
 
+      class_attribute :connection
+
       def configure
-        @connection = nil
+        self.connection = nil
         self.configuration ||= Configuration.new
         yield(configuration)
 
-        Base.connection = connection
+        Base.connection = create_connection
       end
 
       def with_token(token)
-        AuthorizationMiddleware.token token
+        AuthorizationMiddleware.token = token
         yield
       ensure
         AuthorizationMiddleware.reset_token
       end
 
       def with_basic_auth(login, password)
-        BasicAuthMiddleware.credentials [login, password]
+        BasicAuthMiddleware.credentials = [login, password]
         yield
       ensure
         BasicAuthMiddleware.reset_credentials
@@ -59,8 +63,9 @@ module Zaikio
         create_token_data(payload)
       end
 
-      def connection
-        @connection ||= Faraday.new(url: "#{configuration.host}/api/v1") do |c|
+      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
           c.use         JSONParser
@@ -72,7 +77,7 @@ module Zaikio
 
       private
 
-      def create_token_data(payload) # rubocop:disable Metrics/AbcSize
+      def create_token_data(payload)
         subjects = payload["sub"].split(">")
 
         OpenStruct.new(

data/lib/zaikio/directory/authorization_middleware.rb

@@ -1,15 +1,22 @@
 require "faraday"
 require "jwt"
+require "concurrent"
 
 module Zaikio
   module Directory
     class AuthorizationMiddleware < Faraday::Middleware
-      def self.reset_token
-        @token = nil
+      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.token(token = nil)
-        @token = token || @token
+      def self.reset_token
+        self.token = nil
       end
 
       def call(request_env)

data/lib/zaikio/directory/basic_auth_middleware.rb

@@ -4,12 +4,20 @@ require "base64"
 module Zaikio
   module Directory
     class BasicAuthMiddleware < Faraday::Middleware
-      def self.reset_credentials
-        @credentials = nil
+      class_attribute :credentials
+
+      def self.credentials
+        @credentials ||= Concurrent::ThreadLocalVar.new { nil }
+        @credentials.value
       end
 
-      def self.credentials(credentials = nil)
-        @credentials = credentials || @credentials
+      def self.credentials=(value)
+        @credentials ||= Concurrent::ThreadLocalVar.new { nil }
+        @credentials.value = value
+      end
+
+      def self.reset_credentials
+        self.credentials = nil
       end
 
       def call(request_env)

data/lib/zaikio/directory/configuration.rb

@@ -4,11 +4,11 @@ module Zaikio
   module Directory
     class Configuration
       HOSTS = {
-        development: "http://directory.zaikio.test",
-        test: "http://directory.zaikio.test",
-        staging: "https://directory.staging.zaikio.com",
-        sandbox: "https://directory.sandbox.zaikio.com",
-        production: "https://directory.zaikio.com"
+        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
@@ -20,7 +20,7 @@ module Zaikio
       end
 
       def logger
-        @logger ||= Logger.new(STDOUT)
+        @logger ||= Logger.new($stdout)
       end
 
       def environment=(env)

data/lib/zaikio/directory/connection.rb

@@ -1,9 +1,19 @@
 module Zaikio
   module Directory
     class Connection < Base
-      uri "connections"
+      uri "connections(/:id)"
 
       include_root_in_json :connection
+
+      def initialize(attributes = {})
+        if attributes["connectable_id"]
+          super(attributes.merge(
+            "id" => "#{attributes['connectable_type']}-#{attributes['connectable_id']}"
+          ))
+        else
+          super
+        end
+      end
     end
   end
 end

data/lib/zaikio/directory/subscription.rb

@@ -0,0 +1,27 @@
+module Zaikio
+  module Directory
+    class Subscription < Base
+      uri "subscriptions(/:id)"
+
+      include_root_in_json :subscription
+
+      def initialize(attributes = {})
+        if attributes["subscriber_id"]
+          super(attributes.merge(
+            "id" => "#{attributes['subscriber_type']}-#{attributes['subscriber_id']}"
+          ))
+        else
+          super
+        end
+      end
+
+      def activate!
+        update(status: "active")
+      end
+
+      def increment_usage_by!(usage, by = 1)
+        update(increment_usages_in_current_billing_period: { usage => by })
+      end
+    end
+  end
+end

data/lib/zaikio/directory/test_account.rb

@@ -0,0 +1,15 @@
+module Zaikio
+  module Directory
+    class TestAccount < Base
+      uri "test_accounts(/:id)"
+
+      include_root_in_json :test_account
+
+      # Associations
+      has_many :memberships, class_name: "Zaikio::Directory::Membership",
+                             uri: nil
+      has_many :sites, class_name: "Zaikio::Directory::Site",
+                       uri: nil
+    end
+  end
+end

data/lib/zaikio/directory/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module Directory
-    VERSION = "0.0.9".freeze
+    VERSION = "0.2.0".freeze
   end
 end

data/lib/zaikio/error.rb

@@ -1,6 +1,8 @@
 module Zaikio
   class Error < StandardError; end
+
   class ConnectionError < Zaikio::Error; end
+
   class ResourceNotFound < Zaikio::Error; end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-directory
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.2.0
 platform: ruby
 authors:
 - crispymtn
@@ -10,8 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-18 00:00:00.000000000 Z
+date: 2021-01-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
@@ -30,30 +44,42 @@ dependencies:
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.14.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.14.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.16.0
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.10.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.10.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: spyke
   requirement: !ruby/object:Gem::Requirement
@@ -77,6 +103,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -101,12 +128,15 @@ files:
 - lib/zaikio/directory/site.rb
 - lib/zaikio/directory/software.rb
 - lib/zaikio/directory/specialist.rb
+- lib/zaikio/directory/subscription.rb
+- lib/zaikio/directory/test_account.rb
 - lib/zaikio/directory/version.rb
 - lib/zaikio/error.rb
 homepage: https://www.zaikio.com/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/zaikio/zaikio-directory-ruby/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -115,14 +145,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Ruby API Client for Zaikio's Directory