zaikio-directory 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ec062a81b127383211acdf2bc5e4f060fdae2ddd0c933d5e637e18d41b742eb
+  data.tar.gz: '0813f75186da07996059c404b4e376aecb4eb8173658e885aadbdb88b4f24a72'
+SHA512:
+  metadata.gz: 5757766b6d07f3ee23407c7fd100f53ab8f9fd65c76f13d384dfcfc1696771b15d1e6f109a18379e5b9f57d34a49dc6aa6b985762c8bd09def293a970c98893c
+  data.tar.gz: 0efbe9f1c86caf1a79ef1cd5c45ec5fc9d78bcc131cbbb3989e540726fd77804e8a26bccca0228f3aa6839527a4799cde1ddabc87b8cb5850d98dc4656bd2d44

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Zaikio GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,108 @@
+# Zaikio::Directory
+
+Ruby API Client for Zaikio's Directory.
+
+## Installation
+
+### 1. Add this line to your application's Gemfile:
+
+```ruby
+gem 'zaikio-directory'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install zaikio-directory
+```
+
+### 2. Configure the gem:
+
+```rb
+# config/initializers/zaikio_directory.rb
+
+Zaikio::Directory.configure do |config|
+  config.host :production # sandbox or production
+end
+```
+
+
+## Usage
+
+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).
+
+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).
+
+### As an organization
+
+```rb
+token = "..." # Your valid JWT for an organization
+Zaikio::Directory.with_token(token) do
+  organization = Zaikio::Directory::CurrentOrganization.new
+
+  # Fetch Data
+  organization.memberships.find('abc')
+  organization.members.all
+  organization.machines.all
+  organization.software.all
+  organization.sites.all
+  organization.sites.find('123')
+  organization.business_relationships.all
+  organization.fetch
+  organization.name
+
+  # Create new resources
+  organization.business_relationships.create(target_id: "abcd-efgh", kind: "printer", reference: "a-123")
+  organization.machines.create(name: "Speedmaster 2020", manufacturer: "heidelberg", kind: "sheetfed_digital_press", serial_number: "HDB1337", site_id: "d6308910-f5ae-58c0-aba7-d099947845c6")
+  organization.sites.create(name: "Mainz", address_attributes: {
+    addressee: "Crispy Mountain GmbH",
+    text: "Emmerich-Josef-Straße 1A, 55116 Mainz"
+  })
+
+  # Delete resources
+  organization.machines.first.destroy
+end
+```
+
+### As a person
+
+```rb
+token = "..." # Your valid JWT for a person
+Zaikio::Directory.with_token(token) do
+  person = Zaikio::Directory::CurrentPerson.new
+
+  # Fetch Data
+  person.organizations
+  person.organization_memberships
+  person.fetch
+  person.full_name
+
+  organization = person.admin_organizations.find(&:connected?)
+  organization.machines.all
+  organization.sites.all
+
+  # Update details
+  person.update(first_name: "Lisa", name: "Simpson", pronoun: "She/Her")
+end
+```
+
+### Other Use Cases
+
+```rb
+Zaikio::Directory.with_basic_auth(client_id, client_secret) do
+  connections = Zaikio::Directory::Connection.all
+end
+
+roles = Zaikio::Directory::Role.all
+revoked_access_tokens = Zaikio::Directory::RevokedAccessToken.all
+
+Zaikio::Directory.with_token(token) do
+  Zaikio::Directory::RevokedAccessToken.create
+end
+```

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+require 'rubocop/rake_task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Zaikio::Directory'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+namespace :test do
+  desc 'Runs RuboCop on specified directories'
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.fail_on_error = false
+  end
+end
+
+Rake::Task[:test].enhance ['test:rubocop']

data/lib/zaikio/directory/authorization_middleware.rb

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

data/lib/zaikio/directory/base.rb

@@ -0,0 +1,7 @@
+module Zaikio
+  module Directory
+    class Base < Spyke::Base
+      self.callback_methods = { create: :post, update: :patch }.freeze
+    end
+  end
+end

data/lib/zaikio/directory/business_relationship.rb

@@ -0,0 +1,7 @@
+module Zaikio
+  module Directory
+    class BusinessRelationship < Base
+      uri "organization/business_relationships(/:id)"
+    end
+  end
+end

data/lib/zaikio/directory/configuration.rb

@@ -0,0 +1,40 @@
+require "logger"
+
+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"
+      }.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::Directory environment '#{environment}'"
+        end
+      end
+    end
+  end
+end

data/lib/zaikio/directory/current_organization.rb

@@ -0,0 +1,33 @@
+module Zaikio
+  module Directory
+    class CurrentOrganization < Base
+      self.primary_key = nil
+      include_root_in_json :organization
+      uri "organization"
+
+      def self.find
+        all.find_one
+      end
+
+      # Associations
+      has_many :memberships,             class_name: "Zaikio::Directory::Membership",
+                                         uri: "organization/memberships"
+      has_many :business_relationships,  class_name: "Zaikio::Directory::BusinessRelationship",
+                                         uri: "organization/business_relationships"
+      has_many :software,                class_name: "Zaikio::Directory::Software",
+                                         uri: "software"
+      has_many :machines,                class_name: "Zaikio::Directory::Machine",
+                                         uri: "machines"
+      has_many :sites,                   class_name: "Zaikio::Directory::Site",
+                                         uri: "sites"
+
+      def fetch
+        self.attributes = get
+      end
+
+      def members
+        memberships.map(&:person)
+      end
+    end
+  end
+end

data/lib/zaikio/directory/current_person.rb

@@ -0,0 +1,31 @@
+module Zaikio
+  module Directory
+    class CurrentPerson < Base
+      self.primary_key = nil
+      include_root_in_json :person
+      uri "person"
+
+      def self.find
+        all.find_one
+      end
+
+      # Associations
+      has_many :organization_memberships, class_name: "Zaikio::Directory::OrganizationMembership",
+                                          uri: nil
+
+      def fetch
+        self.attributes = get
+      end
+
+      def organizations
+        organization_memberships.map(&:organization)
+      end
+
+      def admin_organizations
+        organization_memberships.map do |m|
+          m.organization if m.roles.include?("admin") || m.roles.include?("owner")
+        end.compact
+      end
+    end
+  end
+end

data/lib/zaikio/directory/json_parser.rb

@@ -0,0 +1,16 @@
+require "multi_json"
+
+module Zaikio
+  module Directory
+    class JSONParser < Faraday::Response::Middleware
+      def parse(body)
+        json = MultiJson.load(body, symbolize_keys: true)
+        {
+          data: json,
+          metadata: {},
+          errors: json.is_a?(Hash) ? json[:errors] : {}
+        }
+      end
+    end
+  end
+end

data/lib/zaikio/directory/machine.rb

@@ -0,0 +1,29 @@
+module Zaikio
+  module Directory
+    class Machine < Base
+      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/membership.rb

@@ -0,0 +1,8 @@
+module Zaikio
+  module Directory
+    class Membership < Base
+      include_root_in_json :membership
+      has_one :person, uri: nil, class_name: "Zaikio::Directory::Person"
+    end
+  end
+end

data/lib/zaikio/directory/organization.rb

@@ -0,0 +1,19 @@
+module Zaikio
+  module Directory
+    class Organization < Base
+      uri "person/organizations"
+
+      include_root_in_json :organization
+
+      # Associations
+      has_many :memberships,             class_name: "Zaikio::Directory::Membership",
+                                         uri: "person/organizations/:organization_id/memberships"
+      has_many :software,                class_name: "Zaikio::Directory::Software",
+                                         uri: "person/organizations/:organization_id/software"
+      has_many :machines,                class_name: "Zaikio::Directory::Machine",
+                                         uri: "person/organizations/:organization_id/machines"
+      has_many :sites,                   class_name: "Zaikio::Directory::Site",
+                                         uri: "person/organizations/:organization_id/sites"
+    end
+  end
+end

data/lib/zaikio/directory/organization_membership.rb

@@ -0,0 +1,12 @@
+module Zaikio
+  module Directory
+    class OrganizationMembership < Base
+      uri "person/organization_memberships"
+
+      include_root_in_json :organization_membership
+
+      # Associations
+      has_one :organization, class_name: "Zaikio::Directory::Organization"
+    end
+  end
+end

data/lib/zaikio/directory/person.rb

@@ -0,0 +1,6 @@
+module Zaikio
+  module Directory
+    class Person < Base
+    end
+  end
+end

data/lib/zaikio/directory/revoked_access_token.rb

@@ -0,0 +1,7 @@
+module Zaikio
+  module Directory
+    class RevokedAccessToken < Base
+      uri "blacklisted_access_tokens"
+    end
+  end
+end

data/lib/zaikio/directory/role.rb

@@ -0,0 +1,9 @@
+module Zaikio
+  module Directory
+    class Role < Base
+      uri "roles"
+
+      include_root_in_json :role
+    end
+  end
+end

data/lib/zaikio/directory/site.rb

@@ -0,0 +1,8 @@
+module Zaikio
+  module Directory
+    class Site < Base
+      uri "sites(/:id)"
+      include_root_in_json :site
+    end
+  end
+end

data/lib/zaikio/directory/software.rb

@@ -0,0 +1,29 @@
+module Zaikio
+  module Directory
+    class Software < Base
+      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
+
+      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
+      end
+    end
+  end
+end

data/lib/zaikio/directory/version.rb

@@ -0,0 +1,5 @@
+module Zaikio
+  module Directory
+    VERSION = "0.0.1".freeze
+  end
+end

data/lib/zaikio/directory.rb

@@ -0,0 +1,73 @@
+require "faraday"
+require "spyke"
+require "zaikio/directory/configuration"
+require "zaikio/directory/json_parser"
+require "zaikio/directory/authorization_middleware"
+
+# Models
+require "zaikio/directory/base"
+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/site"
+require "zaikio/directory/membership"
+require "zaikio/directory/current_person"
+require "zaikio/directory/current_organization"
+require "zaikio/directory/role"
+require "zaikio/directory/revoked_access_token"
+
+module Zaikio
+  module Directory
+    class << self
+      attr_accessor :configuration
+
+      def configure
+        @connection = nil
+        self.configuration ||= Configuration.new
+        yield(configuration)
+
+        Base.connection = connection
+      end
+
+      def with_token(token)
+        AuthorizationMiddleware.token token
+        yield
+      ensure
+        AuthorizationMiddleware.reset_token
+      end
+
+      def current_token_data
+        return {} unless AuthorizationMiddleware.token
+
+        payload = JWT.decode(AuthorizationMiddleware.token, nil, false).first
+
+        create_token_data(payload)
+      end
+
+      def connection
+        @connection ||= Faraday.new(url: "#{configuration.host}/api/v1") do |c|
+          c.request     :json
+          c.response    :logger, configuration&.logger
+          c.use         JSONParser
+          c.use         AuthorizationMiddleware
+          c.adapter     Faraday.default_adapter
+        end
+      end
+
+      private
+
+      def create_token_data(payload)
+        subjects = payload["sub"].split(">")
+
+        OpenStruct.new(
+          on_behalf_of_id: subjects.first.split("/").last,
+          subject_id: subjects.last.split("/").last,
+          subject_type: subjects.last.split("/").first
+        )
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: zaikio-directory
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zaikio GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.1
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.5
+- !ruby/object:Gem::Dependency
+  name: spyke
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.3.4
+description: Ruby API Client for Zaikio's Directory
+email:
+- js@crispymtn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/zaikio/directory.rb
+- lib/zaikio/directory/authorization_middleware.rb
+- lib/zaikio/directory/base.rb
+- lib/zaikio/directory/business_relationship.rb
+- lib/zaikio/directory/configuration.rb
+- lib/zaikio/directory/current_organization.rb
+- lib/zaikio/directory/current_person.rb
+- lib/zaikio/directory/json_parser.rb
+- lib/zaikio/directory/machine.rb
+- lib/zaikio/directory/membership.rb
+- lib/zaikio/directory/organization.rb
+- lib/zaikio/directory/organization_membership.rb
+- lib/zaikio/directory/person.rb
+- lib/zaikio/directory/revoked_access_token.rb
+- lib/zaikio/directory/role.rb
+- lib/zaikio/directory/site.rb
+- lib/zaikio/directory/software.rb
+- lib/zaikio/directory/version.rb
+homepage: https://www.zaikio.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby API Client for Zaikio's Directory
+test_files: []