zaikio-directory 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 425d810f240fc3a9a78e86b8a7216621dc2276c34fb1125816df5b4b8d514bb3
-  data.tar.gz: 7795f54139e370afe28994137d34614985fb5553f5df6e078fb53c440b8a29a9
+  metadata.gz: a72248c2cce21c6086f28c1973032fb48be5a3090887209dd0eff98441506fe1
+  data.tar.gz: 6e7bd4cee9fe02cc0faae2f2acfd67eae92346951e9500df050865402996f001
 SHA512:
-  metadata.gz: e248bd3df0c8f53b40d63c141b6f3b8c0ee4f1af7f3aecc0ca2765595bbfd072319e983e7685c3d0328ee9c156e9094b9f051634a922435bbafbd596e897d6bd
-  data.tar.gz: 99f5c598b8a6369525dc90904bce3c75dd781a1de13e4abfd7589a149c527333187acddfa4db064d34398541a866d9cea3d524e865ff68607ee41fba17bcb76b
+  metadata.gz: 73add47c0e748bf676d5dc0d1db7da71ae5e5393d191b68eb14025f936dee92cff0e9933db56201d33a03e4b51cd992a14c3ecb7aaf1ce531a6599c490ad34f6
+  data.tar.gz: c8e8b679d75533d493090edc93fce47db3ab884833499fd1a40cd238df650583db86c3cb5d3197e3b792cb04b210dfb42db52496bc357b430c114dd7f47d28c6

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/crispymtn/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,10 @@ 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
 
 roles = Zaikio::Directory::Role.all

data/lib/zaikio/directory.rb

@@ -8,12 +8,14 @@ require "zaikio/directory/basic_auth_middleware"
 # Models
 require "zaikio/error"
 require "zaikio/directory/base"
+require "zaikio/directory/asset"
 require "zaikio/directory/organization_membership"
 require "zaikio/directory/business_relationship"
 require "zaikio/directory/organization"
 require "zaikio/directory/person"
 require "zaikio/directory/machine"
 require "zaikio/directory/software"
+require "zaikio/directory/specialist"
 require "zaikio/directory/site"
 require "zaikio/directory/membership"
 require "zaikio/directory/current_person"
@@ -21,29 +23,31 @@ require "zaikio/directory/current_organization"
 require "zaikio/directory/role"
 require "zaikio/directory/revoked_access_token"
 require "zaikio/directory/connection"
+require "zaikio/directory/subscription"
 
 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
@@ -57,8 +61,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
@@ -70,7 +75,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/asset.rb

@@ -0,0 +1,55 @@
+module Zaikio
+  module Directory
+    module Asset
+      extend ActiveSupport::Concern
+
+      included do
+        # Callbacks
+        after_create :make_organization_owner
+      end
+
+      def make_organization_owner
+        if Zaikio::Directory.current_token_data.subject_type == "Organization"
+          self.class.request(:post,
+                             "#{collection_name}/#{id}/#{singular_name}_ownership")
+        else
+          org_path = "person/organizations/#{organization_id}"
+          self.class.request(:post,
+                             "#{org_path}/#{collection_name}/#{id}/#{singular_name}_ownership")
+        end
+      end
+
+      def destroy
+        if Zaikio::Directory.current_token_data.subject_type == "Organization"
+          self.class.request(:delete,
+                             "#{collection_name}/#{id}/#{singular_name}_ownership")
+        else
+          org_path = "person/organizations/#{owner_id || organization_id}"
+          self.class.request(:delete,
+                             "#{org_path}/#{collection_name}/#{id}/#{singular_name}_ownership")
+        end
+      end
+
+      def specification
+        prefix = if Zaikio::Directory.current_token_data.subject_type == "Person"
+                   "person/organizations/#{owner_id || organization_id}/"
+                 else
+                   ""
+                 end
+        self.class.request(:get,
+                           "#{prefix}#{collection_name}/#{id}/#{singular_name}_specification")
+            &.body&.dig("data")
+      end
+
+      private
+
+      def collection_name
+        self.class.name.demodulize.underscore.pluralize
+      end
+
+      def singular_name
+        self.class.name.demodulize.underscore
+      end
+    end
+  end
+end

data/lib/zaikio/directory/authorization_middleware.rb

@@ -4,12 +4,10 @@ require "jwt"
 module Zaikio
   module Directory
     class AuthorizationMiddleware < Faraday::Middleware
-      def self.reset_token
-        @token = nil
-      end
+      class_attribute :token
 
-      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,10 @@ require "base64"
 module Zaikio
   module Directory
     class BasicAuthMiddleware < Faraday::Middleware
-      def self.reset_credentials
-        @credentials = nil
-      end
+      class_attribute :credentials
 
-      def self.credentials(credentials = nil)
-        @credentials = credentials || @credentials
+      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

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/current_organization.rb

@@ -22,6 +22,8 @@ module Zaikio
                                          uri: "software(/:id)"
       has_many :machines,                class_name: "Zaikio::Directory::Machine",
                                          uri: "machines(/:id)"
+      has_many :specialists,             class_name: "Zaikio::Directory::Specialist",
+                                         uri: "specialists(/:id)"
       has_many :sites,                   class_name: "Zaikio::Directory::Site",
                                          uri: "sites(/:id)"
 
@@ -29,6 +31,10 @@ module Zaikio
         self.attributes = get
       end
 
+      def reload
+        self.attributes = self.class.find.attributes
+      end
+
       def members
         memberships.with_fallback.map(&:person)
       end

data/lib/zaikio/directory/machine.rb

@@ -1,29 +1,10 @@
 module Zaikio
   module Directory
     class Machine < Base
+      include Asset
+
       uri "machines(/:id)"
       include_root_in_json :machine
-
-      # Callbacks
-      after_create :make_organization_owner
-
-      def make_organization_owner
-        if Zaikio::Directory.current_token_data.subject_type == "Organization"
-          self.class.request(:post, "machines/#{id}/machine_ownership")
-        else
-          org_path = "person/organizations/#{organization_id}"
-          self.class.request(:post, "#{org_path}/machines/#{id}/machine_ownership")
-        end
-      end
-
-      def destroy
-        if Zaikio::Directory.current_token_data.subject_type == "Organization"
-          self.class.request(:delete, "machines/#{id}/machine_ownership")
-        else
-          org_path = "person/organizations/#{owner_id || organization_id}"
-          self.class.request(:delete, "#{org_path}/machines/#{id}/machine_ownership")
-        end
-      end
     end
   end
 end

data/lib/zaikio/directory/organization.rb

@@ -12,6 +12,8 @@ module Zaikio
                                          uri: "person/organizations/:organization_id/software"
       has_many :machines,                class_name: "Zaikio::Directory::Machine",
                                          uri: "person/organizations/:organization_id/machines"
+      has_many :specialists,             class_name: "Zaikio::Directory::Specialist",
+                                         uri: "person/organizations/:organization_id/specialists"
       has_many :sites,                   class_name: "Zaikio::Directory::Site",
                                          uri: "person/organizations/:organization_id/sites"
     end

data/lib/zaikio/directory/software.rb

@@ -1,28 +1,15 @@
 module Zaikio
   module Directory
     class Software < Base
+      include Asset
+
       uri "software(/:id)"
       include_root_in_json :software
 
-      # Callbacks
-      after_create :make_organization_owner
-
-      def make_organization_owner
-        if Zaikio::Directory.current_token_data.subject_type == "Organization"
-          self.class.request(:post, "software/#{id}/software_ownership")
-        else
-          org_path = "person/organizations/#{organization_id}"
-          self.class.request(:post, "#{org_path}/software/#{id}/software_ownership")
-        end
-      end
+      private
 
-      def destroy
-        if Zaikio::Directory.current_token_data.subject_type == "Organization"
-          self.class.request(:delete, "software/#{id}/software_ownership")
-        else
-          org_path = "person/organizations/#{owner_id || organization_id}"
-          self.class.request(:delete, "#{org_path}/software/#{id}/software_ownership")
-        end
+      def collection_name
+        "software"
       end
     end
   end

data/lib/zaikio/directory/specialist.rb

@@ -0,0 +1,10 @@
+module Zaikio
+  module Directory
+    class Specialist < Base
+      include Asset
+
+      uri "specialists(/:id)"
+      include_root_in_json :specialist
+    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/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module Directory
-    VERSION = "0.0.7".freeze
+    VERSION = "0.1.0".freeze
   end
 end

data/lib/zaikio/error.rb

@@ -5,6 +5,12 @@ module Zaikio
 end
 
 module Spyke
+  instance_eval do
+    # avoid warning: already initialized constant
+    remove_const("ConnectionError")
+    remove_const("ResourceNotFound")
+  end
+
   ConnectionError = Class.new Zaikio::ConnectionError
   ResourceNotFound = Class.new Zaikio::ResourceNotFound
 end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-directory
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
-- Zaikio GmbH
+- crispymtn
+- Jalyna Schröder
+- Martin Spickermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-14 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -28,16 +30,22 @@ 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
@@ -68,7 +76,9 @@ dependencies:
         version: 5.3.4
 description: Ruby API Client for Zaikio's Directory
 email:
+- op@crispymtn.com
 - js@crispymtn.com
+- spickermann@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -77,6 +87,7 @@ files:
 - README.md
 - Rakefile
 - lib/zaikio/directory.rb
+- lib/zaikio/directory/asset.rb
 - lib/zaikio/directory/authorization_middleware.rb
 - lib/zaikio/directory/base.rb
 - lib/zaikio/directory/basic_auth_middleware.rb
@@ -95,6 +106,8 @@ files:
 - lib/zaikio/directory/role.rb
 - lib/zaikio/directory/site.rb
 - lib/zaikio/directory/software.rb
+- lib/zaikio/directory/specialist.rb
+- lib/zaikio/directory/subscription.rb
 - lib/zaikio/directory/version.rb
 - lib/zaikio/error.rb
 homepage: https://www.zaikio.com/