zaikio-hub 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 578ae236058ff3d1e4191cf07f794d361f2234097fee9130f060d6056d52760c
+  data.tar.gz: 1e4b12ea5289e4735323eeedf06467fffd80753696373929985bd74046ff4c35
+SHA512:
+  metadata.gz: cd4cc812ec6b153ee9af72774c52f9d64eb38f6d2eb976fe92547c140f1913ece9e65aea1b6f8c7e02c649a54cdf756639ccb71c3e5e2df42dff56a96d2eeabf
+  data.tar.gz: 171bf01b4ad7bc0a6e1c9b3acb9972d89f2287c795d3e9a401b06786bc3bf8fbb87b07f5c6b95c7410d39300d799de3e88466d5d6b8674f160b85459d66379a5

data/CHANGELOG.md

@@ -0,0 +1,40 @@
+# 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.3.0] - 2020-02-12
+
+### Changed
+
+- BREAKING: Rename `Zaikio::Directory` to `Zaikio::Hub`
+
+### Added
+
+- `Zaikio::Hub::Client` as a wrapper that does not need block syntax for authorization
+
+## [0.2.0] - 2020-01-21
+
+### Added
+
+- `Zaikio::Hub::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-hub-ruby/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.2.0...v.0.3.0
+[0.2.0]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.1.1...v.0.2.0
+[0.1.1]: https://github.com/zaikio/zaikio-hub-ruby/compare/5c6cb4dbcac316733560ddb2b1e13b53e55eb66e...v0.1.1
+[0.1.0]: https://github.com/zaikio/zaikio-hub-ruby/compare/d149fb4c0abe6005f123def3952d2dd2ef6404bb...29889d8a6a496542a81e05688da2a46cf4c44188

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,182 @@
+# Zaikio::Hub
+
+Ruby API Client for Zaikio's Hub.
+
+## Installation
+
+### 1. Add this line to your application's Gemfile:
+
+```ruby
+gem 'zaikio-hub'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install zaikio-hub
+```
+
+### 2. Configure the gem:
+
+```rb
+# config/initializers/zaikio_hub.rb
+
+Zaikio::Hub.configure do |config|
+  config.environment = :production # sandbox or production
+end
+```
+
+
+## Usage
+
+The Hub 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](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).
+
+### As an organization
+
+```rb
+token = "..." # Your valid JWT for an organization
+Zaikio::Hub.with_token(token) do
+  organization = Zaikio::Hub::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::Hub.with_token(token) do
+  person = Zaikio::Hub::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
+```
+
+### Use client object
+
+```rb
+# Organization JWT
+client = Zaikio::Hub::Client.from_token(org_token)
+
+client.organization.name
+client.sites.first.name
+machine = client.machines.create(
+  name: "Machine Name",
+  kind: "sheetfed_digital_press",
+  manufacturer: "My Manufacturer"
+)
+
+# Basic Auth
+client = Zaikio::Hub::Client.from_credentials(client_id, client_secret)
+client.organization # raises Error
+connection = client.connections.first
+client.test_accounts.create(
+  name: "My Test Org",
+  country_code: "DE",
+  kinds: ["printer"],
+  connection_attributes: ["procurement_consumer"]
+)
+```
+
+### Other Use Cases
+
+```rb
+Zaikio::Hub.with_basic_auth(client_id, client_secret) do
+  connections = Zaikio::Hub::Connection.all
+  subscription = Zaikio::Hub::Subscription.find("Organization-b1475f65-236c-58b8-96e1-e1778b43beb7")
+  subscription.plan # => "advanced"
+  subscription.activate!
+  subscription.increment_usage_by!(:orders_created, 12)
+end
+
+Zaikio::Hub.with_basic_auth(client_id, client_secret) do
+  Zaikio::Hub::TestAccount.create(
+    name: "My Test Org",
+    country_code: "DE",
+    kinds: ["printer"],
+    connection_attributes: ["procurement_consumer"]
+  )
+end
+
+roles = Zaikio::Hub::Role.all
+revoked_access_tokens = Zaikio::Hub::RevokedAccessToken.all
+
+Zaikio::Hub.with_token(token) do
+  Zaikio::Hub::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::Hub.with_token(token) do
+  person = Zaikio::Hub::CurrentPerson
+           .find_with_fallback(Zaikio::Hub::CurrentPerson.new(full_name: "Hello World"))
+
+  person.organizations # Automatically uses empty array as fallback
+end
+
+Zaikio::Hub.with_token(token) do
+  organization = Zaikio::Hub::CurrentOrganization.new
+
+  organization.machines.with_fallback.all
+  organization.machines
+    .with_fallback(Zaikio::Hub::Machine.new(name: 'My Machine'))
+    .find('machine-id')
+
+
+  organization.machines
+    .with_fallback(Zaikio::Hub::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/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::Hub'
+  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/error.rb

@@ -0,0 +1,18 @@
+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

data/lib/zaikio/hub.rb

@@ -0,0 +1,92 @@
+require "faraday"
+require "spyke"
+require "zaikio/hub/configuration"
+require "zaikio/hub/json_parser"
+require "zaikio/hub/authorization_middleware"
+require "zaikio/hub/basic_auth_middleware"
+
+# Models
+require "zaikio/error"
+require "zaikio/hub/client"
+require "zaikio/hub/base"
+require "zaikio/hub/asset"
+require "zaikio/hub/organization_membership"
+require "zaikio/hub/business_relationship"
+require "zaikio/hub/organization"
+require "zaikio/hub/person"
+require "zaikio/hub/machine"
+require "zaikio/hub/software"
+require "zaikio/hub/specialist"
+require "zaikio/hub/site"
+require "zaikio/hub/membership"
+require "zaikio/hub/current_person"
+require "zaikio/hub/current_organization"
+require "zaikio/hub/role"
+require "zaikio/hub/revoked_access_token"
+require "zaikio/hub/connection"
+require "zaikio/hub/subscription"
+require "zaikio/hub/test_account"
+
+module Zaikio
+  module Hub
+    class << self
+      attr_accessor :configuration
+
+      class_attribute :connection
+
+      def configure
+        self.connection = nil
+        self.configuration ||= Configuration.new
+        yield(configuration)
+
+        Base.connection = create_connection
+      end
+
+      def with_token(token)
+        AuthorizationMiddleware.token = token
+        yield
+      ensure
+        AuthorizationMiddleware.reset_token
+      end
+
+      def with_basic_auth(login, password)
+        BasicAuthMiddleware.credentials = [login, password]
+        yield
+      ensure
+        BasicAuthMiddleware.reset_credentials
+      end
+
+      def current_token_data
+        return unless AuthorizationMiddleware.token
+
+        payload = JWT.decode(AuthorizationMiddleware.token, nil, false).first
+
+        create_token_data(payload)
+      end
+
+      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
+          c.use         AuthorizationMiddleware
+          c.use         BasicAuthMiddleware
+          c.adapter     Faraday.default_adapter
+        end
+      end
+
+      def create_token_data(payload)
+        subjects = payload["sub"].split(">")
+
+        OpenStruct.new(
+          audience: payload["aud"].first,
+          on_behalf_of_id: subjects.first.split("/").last,
+          subject_id: subjects.last.split("/").last,
+          subject_type: subjects.last.split("/").first,
+          scopes: payload["scope"]
+        )
+      end
+    end
+  end
+end

data/lib/zaikio/hub/asset.rb

@@ -0,0 +1,55 @@
+module Zaikio
+  module Hub
+    module Asset
+      extend ActiveSupport::Concern
+
+      included do
+        # Callbacks
+        after_create :make_organization_owner
+      end
+
+      def make_organization_owner
+        if Zaikio::Hub.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::Hub.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::Hub.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/hub/authorization_middleware.rb

@@ -0,0 +1,32 @@
+require "faraday"
+require "jwt"
+require "concurrent"
+
+module Zaikio
+  module Hub
+    class AuthorizationMiddleware < Faraday::Middleware
+      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.reset_token
+        self.token = nil
+      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/hub/base.rb

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

data/lib/zaikio/hub/basic_auth_middleware.rb

@@ -0,0 +1,35 @@
+require "faraday"
+require "base64"
+
+module Zaikio
+  module Hub
+    class BasicAuthMiddleware < Faraday::Middleware
+      class_attribute :credentials
+
+      def self.credentials
+        @credentials ||= Concurrent::ThreadLocalVar.new { nil }
+        @credentials.value
+      end
+
+      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)
+        if self.class.credentials
+          value = Base64.encode64(self.class.credentials.join(":"))
+          value.delete!("\n")
+          request_env[:request_headers]["Authorization"] = "Basic #{value}"
+        end
+
+        @app.call(request_env).on_complete do |response_env|
+        end
+      end
+    end
+  end
+end

data/lib/zaikio/hub/business_relationship.rb

@@ -0,0 +1,11 @@
+module Zaikio
+  module Hub
+    class BusinessRelationship < Base
+      uri "organization/business_relationships(/:id)"
+
+      # Attributes
+      attributes :kind, :updated_at, :created_at, :reference,
+                 :target_id, :target_name
+    end
+  end
+end

data/lib/zaikio/hub/client.rb

@@ -0,0 +1,120 @@
+module Zaikio
+  module Hub
+    class RequestWrapper
+      def initialize(result, client)
+        @result = result
+        @client = client
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        @result.respond_to?(method_name, include_private) || super
+      end
+
+      def method_missing(method_name, *args, &block)
+        result = @client.with_auth { @result.public_send(method_name, *args, &block) }
+
+        if result.is_a?(Spyke::Base) || result.is_a?(Spyke::Relation)
+          RequestWrapper.new(result, @client)
+        else
+          result
+        end
+      end
+    end
+
+    class Client
+      def self.from_token(token)
+        new(token: token)
+      end
+
+      def self.from_credentials(client_id, client_secret)
+        new(client_id: client_id, client_secret: client_secret)
+      end
+
+      def initialize(token: nil, client_id: nil, client_secret: nil)
+        @token = token
+        @client_id = client_id
+        @client_secret = client_secret
+      end
+
+      def jwt
+        return if @token.nil?
+
+        @jwt ||= begin
+          payload = JWT.decode(@token, nil, false).first
+
+          Zaikio::Hub.create_token_data(payload)
+        end
+      end
+
+      def organization?
+        jwt&.subject_type == "Organization"
+      end
+
+      def person?
+        jwt&.subject_type == "Person"
+      end
+
+      def credentials?
+        @token.nil?
+      end
+
+      def subject_class
+        if organization?
+          Zaikio::Hub::CurrentOrganization
+        elsif person?
+          Zaikio::Hub::CurrentPerson
+        end
+      end
+
+      def with_auth(&block)
+        if @token.nil?
+          Zaikio::Hub.with_basic_auth(@client_id, @client_secret, &block)
+        else
+          Zaikio::Hub.with_token(@token, &block)
+        end
+      end
+
+      def organization
+        raise "Current organization is not available for person" unless organization?
+
+        with_auth { Zaikio::Hub::CurrentOrganization.find }
+      end
+
+      def person
+        raise "Current person is not available for organization" unless person?
+
+        with_auth { Zaikio::Hub::CurrentPerson.find }
+      end
+
+      def connections
+        raise "Only available with credentials" unless credentials?
+
+        RequestWrapper.new(Zaikio::Hub::Connection.all, self)
+      end
+
+      def subscriptions
+        raise "Only available with credentials" unless credentials?
+
+        RequestWrapper.new(Zaikio::Hub::Subscription.all, self)
+      end
+
+      def test_accounts
+        raise "Only available with credentials" unless credentials?
+
+        RequestWrapper.new(Zaikio::Hub::TestAccount.all, self)
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        return super if credentials?
+
+        subject_class.new.respond_to?(method_name, include_private) || super
+      end
+
+      def method_missing(method_name, *args, &block)
+        result = with_auth { subject_class.new.public_send(method_name, *args, &block) }
+
+        RequestWrapper.new(result, self)
+      end
+    end
+  end
+end

data/lib/zaikio/hub/configuration.rb

@@ -0,0 +1,40 @@
+require "logger"
+
+module Zaikio
+  module Hub
+    class Configuration
+      HOSTS = {
+        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
+      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::Hub environment '#{environment}'"
+        end
+      end
+    end
+  end
+end

data/lib/zaikio/hub/connection.rb

@@ -0,0 +1,23 @@
+module Zaikio
+  module Hub
+    class Connection < Base
+      uri "connections(/:id)"
+
+      include_root_in_json :connection
+
+      # Attributes
+      attributes :updated_at, :created_at, :connectable_type, :connectable_id,
+                 :app_name, :granted_oauth_scopes
+
+      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/hub/current_organization.rb

@@ -0,0 +1,50 @@
+module Zaikio
+  module Hub
+    class CurrentOrganization < Base
+      self.primary_key = nil
+
+      uri "organization"
+
+      def self.find
+        all.find_one
+      end
+
+      def self.find_with_fallback(fallback)
+        all.with_fallback(fallback).find_one
+      end
+
+      include_root_in_json :organization
+
+      # Attributes
+      attributes :name, :slug, :logo_url, :connected, :subscription,
+                 :created_at, :updated_at, :country_code, :kinds,
+                 :sections, :currency, :brand_color, :test_account_owner_id
+
+      # Associations
+      has_many :memberships,             class_name: "Zaikio::Hub::Membership",
+                                         uri: "organization/memberships(/:id)"
+      has_many :business_relationships,  class_name: "Zaikio::Hub::BusinessRelationship",
+                                         uri: "organization/business_relationships(/:id)"
+      has_many :software,                class_name: "Zaikio::Hub::Software",
+                                         uri: "software(/:id)"
+      has_many :machines,                class_name: "Zaikio::Hub::Machine",
+                                         uri: "machines(/:id)"
+      has_many :specialists,             class_name: "Zaikio::Hub::Specialist",
+                                         uri: "specialists(/:id)"
+      has_many :sites,                   class_name: "Zaikio::Hub::Site",
+                                         uri: "sites(/:id)"
+
+      def fetch
+        self.attributes = get
+      end
+
+      def reload
+        self.attributes = self.class.find.attributes
+      end
+
+      def members
+        memberships.with_fallback.map(&:person)
+      end
+    end
+  end
+end

data/lib/zaikio/hub/current_person.rb

@@ -0,0 +1,42 @@
+module Zaikio
+  module Hub
+    class CurrentPerson < Base
+      self.primary_key = nil
+      include_root_in_json :person
+      uri "person"
+
+      # Attributes
+      attributes :updated_at, :created_at, :first_name, :name, :full_name, :email,
+                 :pronoun, :locale, :country_code, :currency, :unit_system, :connected,
+                 :test_account_owner_id, :time_zone, :email_confirmed,
+                 :two_factor_authentication_enabled, :avatar_url, :subscription,
+                 :accessible_apps
+
+      def self.find
+        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::Hub::OrganizationMembership",
+                                          uri: nil
+
+      def fetch
+        self.attributes = get
+      end
+
+      def organizations
+        organization_memberships.with_fallback.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/hub/json_parser.rb

@@ -0,0 +1,36 @@
+require "multi_json"
+
+module Zaikio
+  module Hub
+    class JSONParser < Faraday::Response::Middleware
+      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::Hub.configuration.logger
+                   .error("Zaikio::Hub 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
+end

data/lib/zaikio/hub/machine.rb

@@ -0,0 +1,14 @@
+module Zaikio
+  module Hub
+    class Machine < Base
+      include Asset
+
+      uri "machines(/:id)"
+      include_root_in_json :machine
+
+      # Attributes
+      attributes :name, :updated_at, :created_at, :site_id, :kind,
+                 :manufacturer_id, :serial_number, :manufacturer, :owner_id
+    end
+  end
+end

data/lib/zaikio/hub/membership.rb

@@ -0,0 +1,14 @@
+module Zaikio
+  module Hub
+    class Membership < Base
+      uri "organization/memberships(/:id)"
+      include_root_in_json :membership
+
+      # Attributes
+      attributes :updated_at, :created_at, :roles
+
+      # Associations
+      has_one :person, uri: nil, class_name: "Zaikio::Hub::Person"
+    end
+  end
+end

data/lib/zaikio/hub/organization.rb

@@ -0,0 +1,26 @@
+module Zaikio
+  module Hub
+    class Organization < Base
+      uri "person/organizations"
+
+      include_root_in_json :organization
+
+      # Attributes
+      attributes :name, :slug, :logo_url, :connected, :subscription,
+                 :created_at, :updated_at, :country_code, :kinds,
+                 :sections, :currency, :brand_color, :test_account_owner_id
+
+      # Associations
+      has_many :memberships,             class_name: "Zaikio::Hub::Membership",
+                                         uri: "person/organizations/:organization_id/memberships"
+      has_many :software,                class_name: "Zaikio::Hub::Software",
+                                         uri: "person/organizations/:organization_id/software"
+      has_many :machines,                class_name: "Zaikio::Hub::Machine",
+                                         uri: "person/organizations/:organization_id/machines"
+      has_many :specialists,             class_name: "Zaikio::Hub::Specialist",
+                                         uri: "person/organizations/:organization_id/specialists"
+      has_many :sites,                   class_name: "Zaikio::Hub::Site",
+                                         uri: "person/organizations/:organization_id/sites"
+    end
+  end
+end

data/lib/zaikio/hub/organization_membership.rb

@@ -0,0 +1,15 @@
+module Zaikio
+  module Hub
+    class OrganizationMembership < Base
+      uri "person/organization_memberships"
+
+      include_root_in_json :organization_membership
+
+      # Attributes
+      attributes :updated_at, :created_at, :roles
+
+      # Associations
+      has_one :organization, class_name: "Zaikio::Hub::Organization"
+    end
+  end
+end

data/lib/zaikio/hub/person.rb

@@ -0,0 +1,11 @@
+module Zaikio
+  module Hub
+    class Person < Base
+      # Attributes
+      attributes :updated_at, :created_at, :first_name, :name, :full_name, :email,
+                 :pronoun, :locale, :country_code, :currency, :unit_system, :connected,
+                 :test_account_owner_id, :time_zone, :email_confirmed,
+                 :two_factor_authentication_enabled, :avatar_url, :subscription
+    end
+  end
+end

data/lib/zaikio/hub/revoked_access_token.rb

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

data/lib/zaikio/hub/role.rb

@@ -0,0 +1,12 @@
+module Zaikio
+  module Hub
+    class Role < Base
+      uri "roles"
+
+      include_root_in_json :role
+
+      # Attributes
+      attributes :name
+    end
+  end
+end

data/lib/zaikio/hub/site.rb

@@ -0,0 +1,12 @@
+module Zaikio
+  module Hub
+    class Site < Base
+      uri "sites(/:id)"
+      include_root_in_json :site
+
+      # Attributes
+      attributes :name, :headquarter, :created_at, :updated_at, :address,
+                 :address_attributes
+    end
+  end
+end

data/lib/zaikio/hub/software.rb

@@ -0,0 +1,20 @@
+module Zaikio
+  module Hub
+    class Software < Base
+      include Asset
+
+      uri "software(/:id)"
+      include_root_in_json :software
+
+      # Attributes
+      attributes :name, :updated_at, :created_at, :site_id, :kind, :owner_id,
+                 :vendor_id, :vendor
+
+      private
+
+      def collection_name
+        "software"
+      end
+    end
+  end
+end

data/lib/zaikio/hub/specialist.rb

@@ -0,0 +1,13 @@
+module Zaikio
+  module Hub
+    class Specialist < Base
+      include Asset
+
+      uri "specialists(/:id)"
+      include_root_in_json :specialist
+
+      # Attributes
+      attributes :name, :updated_at, :created_at, :site_id, :kind, :owner_id
+    end
+  end
+end

data/lib/zaikio/hub/subscription.rb

@@ -0,0 +1,33 @@
+module Zaikio
+  module Hub
+    class Subscription < Base
+      uri "subscriptions(/:id)"
+
+      include_root_in_json :subscription
+
+      # Attributes
+      attributes :updated_at, :created_at, :subscriber_type, :subscriber_id,
+                 :status, :app_name, :activated_at, :last_billed_at,
+                 :last_paid_at, :trial_ended_at, :plan, :preceding_plan,
+                 :changed_plan_at, :usages_in_current_billing_period
+
+      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/hub/test_account.rb

@@ -0,0 +1,22 @@
+module Zaikio
+  module Hub
+    class TestAccount < Base
+      uri "test_accounts(/:id)"
+
+      include_root_in_json :test_account
+
+      # Attributes
+      attributes :name, :slug, :logo_url, :connected, :subscription,
+                 :created_at, :updated_at, :country_code, :kinds,
+                 :sections, :currency, :brand_color, :test_account_owner_id,
+                 :private_access_token, :site_attributes, :member_attributes,
+                 :subscription_attributes, :connection_attributes
+
+      # Associations
+      has_many :memberships, class_name: "Zaikio::Hub::Membership",
+                             uri: nil
+      has_many :sites, class_name: "Zaikio::Hub::Site",
+                       uri: nil
+    end
+  end
+end

data/lib/zaikio/hub/version.rb

@@ -0,0 +1,5 @@
+module Zaikio
+  module Hub
+    VERSION = "0.3.0".freeze
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: zaikio-hub
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- crispymtn
+- Jalyna Schröder
+- Martin Spickermann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-02-12 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
+    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
+    - - "<"
+      - !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
+    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 Hub
+email:
+- op@crispymtn.com
+- js@crispymtn.com
+- spickermann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/zaikio/error.rb
+- lib/zaikio/hub.rb
+- lib/zaikio/hub/asset.rb
+- lib/zaikio/hub/authorization_middleware.rb
+- lib/zaikio/hub/base.rb
+- lib/zaikio/hub/basic_auth_middleware.rb
+- lib/zaikio/hub/business_relationship.rb
+- lib/zaikio/hub/client.rb
+- lib/zaikio/hub/configuration.rb
+- lib/zaikio/hub/connection.rb
+- lib/zaikio/hub/current_organization.rb
+- lib/zaikio/hub/current_person.rb
+- lib/zaikio/hub/json_parser.rb
+- lib/zaikio/hub/machine.rb
+- lib/zaikio/hub/membership.rb
+- lib/zaikio/hub/organization.rb
+- lib/zaikio/hub/organization_membership.rb
+- lib/zaikio/hub/person.rb
+- lib/zaikio/hub/revoked_access_token.rb
+- lib/zaikio/hub/role.rb
+- lib/zaikio/hub/site.rb
+- lib/zaikio/hub/software.rb
+- lib/zaikio/hub/specialist.rb
+- lib/zaikio/hub/subscription.rb
+- lib/zaikio/hub/test_account.rb
+- lib/zaikio/hub/version.rb
+homepage: https://www.zaikio.com/
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/zaikio/zaikio-hub-ruby/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Ruby API Client for Zaikio's Hub
+test_files: []