pusher-chatkit-server 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39d00e64807f8797dac5042a02ad1220cca6ae57
+  data.tar.gz: 8f3d02cc7dd79e0fa4f5eafe45418fcb2db5b9b9
+SHA512:
+  metadata.gz: ef7029a8b9259ed8aeee7d81690dd7a57560c5aef2bfc71946a1433582ad75348beac2b40f3fbbd0a445e90201ac88413886b2191f1e2f7933a26be3eee4cd45
+  data.tar.gz: 2fa2f7bb255c86621065c8690430d709b6c65bf57464b87546c6be2d8207448436fe4ed26c35206e68b1f9178d64e11c8fb7ac96a1f7aaac033245883240b01d

data/lib/chatkit.rb

@@ -0,0 +1 @@
+require_relative 'chatkit/client'

data/lib/chatkit/client.rb

@@ -0,0 +1,284 @@
+require 'pusher-platform'
+require 'json'
+require_relative './permissions'
+
+module Chatkit
+
+  class Error < RuntimeError
+  end
+
+  class Client
+    attr_accessor :api_instance, :authorizer_instance
+
+    def initialize(options)
+      base_options = {
+        instance: options[:instance],
+        key: options[:key],
+        port: options[:port],
+        host: options[:host],
+        client: options[:client]
+      }
+
+      @api_instance = Pusher::Instance.new(
+        base_options.merge!({
+          service_name: 'chatkit',
+          service_version: 'v1'
+        })
+      )
+
+      @authorizer_instance = Pusher::Instance.new(
+        base_options.merge!({
+          service_name: 'chatkit_authorizer',
+          service_version: 'v1'
+        })
+      )
+    end
+
+    def authenticate(request, options)
+      @api_instance.authenticate(request, options)
+    end
+
+    def generate_access_token(options)
+      @api_instance.generate_access_token(options)
+    end
+
+    # User API
+
+    def create_user(id, name, avatar_url, custom_data)
+      body = {
+        id: id,
+        name: name
+      }
+
+      unless avatar_url.nil?
+        body[:avatar_url] = avatar_url
+      end
+
+      unless custom_data.nil?
+        body[:custom_data] = custom_data
+      end
+
+      @api_instance.request(
+        method: "POST",
+        path: "/users",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: body,
+        jwt: generate_access_token(user_id: id, su: true)
+      )
+    end
+
+    def delete_user(id)
+      @api_instance.request(
+        method: "DELETE",
+        path: "/users/#{id}",
+        jwt: generate_access_token(user_id: id, su: true)
+      )
+    end
+
+    def get_users(from_id)
+      request_options = {
+        method: "GET",
+        path: "/users",
+        jwt: generate_access_token(su: true)
+      }
+
+      unless from_id == nil && from_id == ""
+        request_options.merge!({ query: { from_id: from_id }})
+      end
+
+      @api_instance.request(request_options)
+    end
+
+    def get_users_by_ids(user_ids)
+      @api_instance.request(
+        method: "GET",
+        path: "/users_by_ids",
+        query: {
+          user_ids: user_ids.join(",")
+          },
+        jwt: generate_access_token(su: true)
+      )
+    end
+
+    # Room API
+
+    def get_room(room_id)
+      @api_instance.request(
+        method: "GET",
+        path: "/rooms/#{room_id}",
+        jwt: generate_access_token(su: true)
+      )
+    end
+
+    def get_room_messages(room_id, initial_id, direction, limit)
+      query_params = {}
+
+      query_params[:initial_id] = initial_id unless initial_id.nil?
+      query_params[:direction] = direction unless direction.nil?
+      query_params[:limit] = limit unless limit.nil?
+
+      @api_instance.request(
+        method: "GET",
+        path: "/rooms/#{room_id}/messages",
+        query: query_params,
+        jwt: @api_instance.generate_access_token(su: true)
+      )
+    end
+
+    def get_rooms(from_id)
+      request_options = {
+        method: "GET",
+        path: "/rooms",
+        jwt: @api_instance.generate_access_token(su: true)
+      }
+
+      unless from_id == nil && from_id == ""
+        request_options.merge!({ query: { from_id: from_id }})
+      end
+
+      @api_instance.request(request_options)
+    end
+
+    # Authorizer API
+
+    def create_room_role(name, permissions)
+      create_role(name, ROOM_SCOPE, permissions)
+    end
+
+    def create_global_role(name, permissions)
+      create_role(name, GLOBAL_SCOPE, permissions)
+    end
+
+    def delete_room_role(role_name)
+      delete_role(role_name, ROOM_SCOPE)
+    end
+
+    def delete_global_role(role_name)
+      delete_role(role_name, GLOBAL_SCOPE)
+    end
+
+    def assign_global_role_to_user(user_id, role_name)
+      assign_role_to_user(user_id, role_name, nil)
+    end
+
+    def assign_room_role_to_user(user_id, role_name, room_id)
+      assign_role_to_user(user_id, role_name, room_id)
+    end
+
+    def get_roles
+      resp = @authorizer_instance.request(
+        method: "GET",
+        path: "/roles",
+        jwt: generate_access_token(su: true)
+      )
+
+      JSON.parse(resp.body)
+    end
+
+    def get_user_roles(user_id)
+      resp = @authorizer_instance.request(
+        method: "GET",
+        path: "/users/#{user_id}/roles",
+        jwt: generate_access_token(su: true)
+      )
+
+      JSON.parse(resp.body)
+    end
+
+    def remove_global_role_for_user(user_id)
+      remove_role_for_user(user_id, nil)
+    end
+
+    def remove_room_role_for_user(user_id, room_id)
+      remove_role_for_user(user_id, room_id)
+    end
+
+    def get_permissions_for_global_role(role_name)
+      get_permissions_for_role(role_name, GLOBAL_SCOPE)
+    end
+
+    def get_permissions_for_room_role(role_name)
+      get_permissions_for_role(role_name, ROOM_SCOPE)
+    end
+
+    private
+
+    def create_role(name, scope, permissions)
+      permissions.each do |permission|
+        unless VALID_PERMISSIONS[scope.to_sym].include?(permission)
+          raise Chatkit::Error.new("Permission value #{permission} is invalid")
+        end
+      end
+
+      @authorizer_instance.request(
+        method: "POST",
+        path: "/roles",
+        headers: {
+          "Content-Type": "application/json"
+        },
+        body: {
+          scope: scope,
+          name: name,
+          permissions: permissions,
+        },
+        jwt: generate_access_token(su: true)
+      )
+    end
+
+    def delete_role(role_name, scope)
+      @authorizer_instance.request(
+        method: "DELETE",
+        path: "/roles/#{role_name}/scope/#{scope}",
+        jwt: generate_access_token(su: true)
+      )
+    end
+
+    def assign_role_to_user(user_id, role_name, room_id)
+      body = { name: role_name }
+
+      unless room_id.nil?
+        body.merge!(room_id: room_id)
+      end
+
+      @authorizer_instance.request(
+        method: "POST",
+        path: "/users/#{user_id}/roles",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: body,
+        jwt: generate_access_token(su: true)
+      )
+    end
+
+    def remove_role_for_user(user_id, room_id)
+      options = {
+        method: "PUT",
+        path: "/users/#{user_id}/roles",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: {},
+        jwt: generate_access_token(su: true)
+      }
+
+      unless room_id.nil?
+        options.merge!(body: { room_id: room_id })
+      end
+
+      @authorizer_instance.request(options)
+    end
+
+    def get_permissions_for_role(role_name, scope)
+      resp = @authorizer_instance.request(
+        method: "GET",
+        path: "/roles/#{role_name}/scope/#{scope}/permissions",
+        jwt: generate_access_token(su: true)
+      )
+
+      JSON.parse(resp.body)
+    end
+  end
+end

data/lib/chatkit/permissions.rb

@@ -0,0 +1,51 @@
+module Chatkit
+  ROOM_SCOPE = "room"
+  GLOBAL_SCOPE = "global"
+
+  JOIN_ROOM = "join_room"
+  LEAVE_ROOM = "leave_room"
+  ADD_ROOM_MEMBER = "add_room_member"
+  REMOVE_ROOM_MEMBER = "remove_room_member"
+  CREATE_ROOM = "create_room"
+  DELETE_ROOM = "delete_room"
+  UPDATE_ROOM = "update_room"
+  ADD_MESSAGE = "add_message"
+  CREATE_TYPING_EVENT = "create_typing_event"
+  SUBSCRIBE_PRESENCE = "subscribe_presence"
+  UPDATE_USER = "update_user"
+  GET_ROOM_MESSAGES = "get_room_messages"
+  GET_USER = "get_user"
+  GET_ROOM = "get_room"
+  GET_USER_ROOMS = "get_user_rooms"
+
+  VALID_PERMISSIONS = {
+    room: [
+      JOIN_ROOM,
+      LEAVE_ROOM,
+      ADD_ROOM_MEMBER,
+      REMOVE_ROOM_MEMBER,
+      DELETE_ROOM,
+      UPDATE_ROOM,
+      ADD_MESSAGE,
+      CREATE_TYPING_EVENT,
+      GET_ROOM_MESSAGES,
+    ],
+    global: [
+      JOIN_ROOM,
+      LEAVE_ROOM,
+      ADD_ROOM_MEMBER,
+      REMOVE_ROOM_MEMBER,
+      CREATE_ROOM,
+      DELETE_ROOM,
+      UPDATE_ROOM,
+      ADD_MESSAGE,
+      CREATE_TYPING_EVENT,
+      SUBSCRIBE_PRESENCE,
+      UPDATE_USER,
+      GET_ROOM_MESSAGES,
+      GET_USER,
+      GET_ROOM,
+      GET_USER_ROOMS,
+    ]
+  }
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: pusher-chatkit-server
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pusher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pusher-platform
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+description: 
+email: support@pusher.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/chatkit.rb
+- lib/chatkit/client.rb
+- lib/chatkit/permissions.rb
+homepage: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Pusher Chatkit Ruby SDK
+test_files: []