zaikio-directory 0.0.6 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e9927801204a0fd2cbf4f4b33916e5eb096c864fa9029c0397c36c9e17fad2b
-  data.tar.gz: 0d178e8cf201ab36d6830e9f897cfbc4aeb6349275ce310ecfcf065b4d2ff220
+  metadata.gz: 07fb7419f188af643dfaa5440d77827a4bedd91b820e18a6714b8d45f194d2f7
+  data.tar.gz: 878c7ba7a273c9526c556727cc9673d02956298d5b820a1f724949557d73eab0
 SHA512:
-  metadata.gz: 9b3569ef1779d9ab6a1cd7969f34884a75908c8b2b4d2a8b4099d6167abab015aa0e50d22c7baa4dda41a20de58e5fe87f3b096d50508ba86ef99face7b0bfd5
-  data.tar.gz: 2c711726d46af8c22fbd163f3e04a13fef7eb6357e93f67feef105bfb1c559e23b5945ce4078974158baa93ba4e95fe80d1de19732ae914869bd7865bdd6bf74
+  metadata.gz: ad30c796f5615df1ef8c1f61d8a11f01460d085db6c2e2e054bb25e588b36fec61ac657c66b019b1b6f5412f8568211af50b3aa25797c7cc31a8a63db89ccded
+  data.tar.gz: 65c882cdf8824f5bed2d7c1da73d7b8dcf03e89d74961b72010f04b365da04374289b319e5ef4a93a33f7d73641dde2fd869852dd215fa938443389c728e5e0a

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
 ```
 
@@ -106,3 +106,38 @@ Zaikio::Directory.with_token(token) do
   Zaikio::Directory::RevokedAccessToken.create
 end
 ```
+
+### Error Handling
+
+If an unexpected error occurs with an API call (i.e. an error that has no status code `2xx`, `404` or `422`) then a `Zaikio::ConnectionError` is thrown automatically (for `404` there will be a `Zaikio::ResourceNotFound`).
+
+This can be easily caught using the `with_fallback` method. We recommend to always work with fallbacks.
+
+```rb
+Zaikio::Directory.with_token(token) do
+  person = Zaikio::Directory::CurrentPerson
+           .find_with_fallback(Zaikio::Directory::CurrentPerson.new(full_name: "Hello World"))
+
+  person.organizations # Automatically uses empty array as fallback
+end
+
+Zaikio::Directory.with_token(token) do
+  organization = Zaikio::Directory::CurrentOrganization.new
+
+  organization.machines.with_fallback.all
+  organization.machines
+    .with_fallback(Zaikio::Directory::Machine.new(name: 'My Machine'))
+    .find('machine-id')
+
+
+  organization.machines
+    .with_fallback(Zaikio::Directory::Machine.new(name: 'My Machine'))
+    .find('machine-does-not-exist') # => raises Zaikio::ResourceNotFound
+
+  begin
+    organization.machines.create(name: "Machine Name")
+  rescue Zaikio::ConnectionError
+    # Do something
+  end
+end
+```

data/lib/zaikio/directory.rb

@@ -6,13 +6,16 @@ require "zaikio/directory/authorization_middleware"
 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"
@@ -25,24 +28,25 @@ 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
@@ -56,8 +60,8 @@ 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") do |c|
           c.request     :json
           c.response    :logger, configuration&.logger
           c.use         JSONParser

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

@@ -9,24 +9,34 @@ module Zaikio
         all.find_one
       end
 
+      def self.find_with_fallback(fallback)
+        all.with_fallback(fallback).find_one
+      end
+
       # Associations
       has_many :memberships,             class_name: "Zaikio::Directory::Membership",
-                                         uri: "organization/memberships"
+                                         uri: "organization/memberships(/:id)"
       has_many :business_relationships,  class_name: "Zaikio::Directory::BusinessRelationship",
-                                         uri: "organization/business_relationships"
+                                         uri: "organization/business_relationships(/:id)"
       has_many :software,                class_name: "Zaikio::Directory::Software",
-                                         uri: "software"
+                                         uri: "software(/:id)"
       has_many :machines,                class_name: "Zaikio::Directory::Machine",
-                                         uri: "machines"
+                                         uri: "machines(/:id)"
+      has_many :specialists,             class_name: "Zaikio::Directory::Specialist",
+                                         uri: "specialists(/:id)"
       has_many :sites,                   class_name: "Zaikio::Directory::Site",
-                                         uri: "sites"
+                                         uri: "sites(/:id)"
 
       def fetch
         self.attributes = get
       end
 
+      def reload
+        self.attributes = self.class.find.attributes
+      end
+
       def members
-        memberships.map(&:person)
+        memberships.with_fallback.map(&:person)
       end
     end
   end

data/lib/zaikio/directory/current_person.rb

@@ -9,6 +9,10 @@ module Zaikio
         all.find_one
       end
 
+      def self.find_with_fallback(fallback)
+        all.with_fallback(fallback).find_one
+      end
+
       # Associations
       has_many :organization_memberships, class_name: "Zaikio::Directory::OrganizationMembership",
                                           uri: nil
@@ -18,7 +22,7 @@ module Zaikio
       end
 
       def organizations
-        organization_memberships.map(&:organization)
+        organization_memberships.with_fallback.map(&:organization)
       end
 
       def admin_organizations

data/lib/zaikio/directory/json_parser.rb

@@ -3,13 +3,33 @@ require "multi_json"
 module Zaikio
   module Directory
     class JSONParser < Faraday::Response::Middleware
-      def parse(body)
+      def on_complete(env)
+        connection_error(env) unless /^(2\d\d)|422|404$/.match?(env.status.to_s)
+
+        raise Spyke::ResourceNotFound if env.status.to_s == "404"
+
+        env.body = parse_body(env.body)
+      end
+
+      def connection_error(env)
+        Zaikio::Directory.configuration.logger
+                         .error("Zaikio::Directory Status Code #{env.status}, #{env.body}")
+        raise Spyke::ConnectionError, "Status Code #{env.status}, #{env.body}"
+      end
+
+      def parse_body(body)
         json = MultiJson.load(body, symbolize_keys: true)
         {
           data: json,
           metadata: {},
           errors: json.is_a?(Hash) ? json[:errors] : {}
         }
+      rescue MultiJson::ParseError
+        {
+          data: {},
+          metadata: {},
+          errors: {}
+        }
       end
     end
   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/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module Directory
-    VERSION = "0.0.6".freeze
+    VERSION = "0.0.11".freeze
   end
 end

data/lib/zaikio/error.rb

@@ -0,0 +1,16 @@
+module Zaikio
+  class Error < StandardError; end
+  class ConnectionError < Zaikio::Error; end
+  class ResourceNotFound < Zaikio::Error; end
+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.6
+  version: 0.0.11
 platform: ruby
 authors:
-- Zaikio GmbH
+- crispymtn
+- Jalyna Schröder
+- Martin Spickermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-08 00:00:00.000000000 Z
+date: 2020-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -68,7 +70,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 +81,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,7 +100,9 @@ files:
 - lib/zaikio/directory/role.rb
 - lib/zaikio/directory/site.rb
 - lib/zaikio/directory/software.rb
+- lib/zaikio/directory/specialist.rb
 - lib/zaikio/directory/version.rb
+- lib/zaikio/error.rb
 homepage: https://www.zaikio.com/
 licenses:
 - MIT