zaikio-directory 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e9927801204a0fd2cbf4f4b33916e5eb096c864fa9029c0397c36c9e17fad2b
-  data.tar.gz: 0d178e8cf201ab36d6830e9f897cfbc4aeb6349275ce310ecfcf065b4d2ff220
+  metadata.gz: 425d810f240fc3a9a78e86b8a7216621dc2276c34fb1125816df5b4b8d514bb3
+  data.tar.gz: 7795f54139e370afe28994137d34614985fb5553f5df6e078fb53c440b8a29a9
 SHA512:
-  metadata.gz: 9b3569ef1779d9ab6a1cd7969f34884a75908c8b2b4d2a8b4099d6167abab015aa0e50d22c7baa4dda41a20de58e5fe87f3b096d50508ba86ef99face7b0bfd5
-  data.tar.gz: 2c711726d46af8c22fbd163f3e04a13fef7eb6357e93f67feef105bfb1c559e23b5945ce4078974158baa93ba4e95fe80d1de19732ae914869bd7865bdd6bf74
+  metadata.gz: e248bd3df0c8f53b40d63c141b6f3b8c0ee4f1af7f3aecc0ca2765595bbfd072319e983e7685c3d0328ee9c156e9094b9f051634a922435bbafbd596e897d6bd
+  data.tar.gz: 99f5c598b8a6369525dc90904bce3c75dd781a1de13e4abfd7589a149c527333187acddfa4db064d34398541a866d9cea3d524e865ff68607ee41fba17bcb76b

data/README.md

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

@@ -9,24 +9,28 @@ 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 :sites,                   class_name: "Zaikio::Directory::Site",
-                                         uri: "sites"
+                                         uri: "sites(/:id)"
 
       def fetch
         self.attributes = get
       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/version.rb

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

data/lib/zaikio/directory.rb

@@ -6,6 +6,7 @@ require "zaikio/directory/authorization_middleware"
 require "zaikio/directory/basic_auth_middleware"
 
 # Models
+require "zaikio/error"
 require "zaikio/directory/base"
 require "zaikio/directory/organization_membership"
 require "zaikio/directory/business_relationship"

data/lib/zaikio/error.rb

@@ -0,0 +1,10 @@
+module Zaikio
+  class Error < StandardError; end
+  class ConnectionError < Zaikio::Error; end
+  class ResourceNotFound < Zaikio::Error; end
+end
+
+module Spyke
+  ConnectionError = Class.new Zaikio::ConnectionError
+  ResourceNotFound = Class.new Zaikio::ResourceNotFound
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-directory
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Zaikio GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-08 00:00:00.000000000 Z
+date: 2020-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -96,6 +96,7 @@ files:
 - lib/zaikio/directory/site.rb
 - lib/zaikio/directory/software.rb
 - lib/zaikio/directory/version.rb
+- lib/zaikio/error.rb
 homepage: https://www.zaikio.com/
 licenses:
 - MIT