ribose-cli 0.1.0 → 0.5.0

data/Gemfile

@@ -2,3 +2,6 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in ribose-cli.gemspec
 gemspec
+
+# Temporarily use the development version
+gem "ribose", git: "https://github.com/riboseinc/ribose-ruby", branch: "main"

data/README.md

@@ -1,28 +1,336 @@
-# Ribose::Cli
+# Ribose CLI
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ribose/cli`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://github.com/riboseinc/ribose-cli/actions/workflows/test.yml/badge.svg)](https://github.com/riboseinc/ribose-cli/actions/workflows/test.yml)
+[![Code
+Climate](https://codeclimate.com/github/riboseinc/ribose-cli/badges/gpa.svg)](https://codeclimate.com/github/riboseinc/ribose-cli)
 
-TODO: Delete this and the text above, and describe your gem
+The command line interface to the Ribose API.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ribose-cli'
+gem "ribose-cli"
 ```
 
 And then execute:
 
-    $ bundle
+```sh
+$ bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install ribose-cli
+```sh
+$ gem install ribose-cli
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configure
+
+To start with, we kept it pretty simple, install this gem & then configure your
+API Token and email using the following interface, This will store your Ribose
+configuration as `.riboserc` in the home directory.
+
+```sh
+ribose config --password='YOUR_API_PASSWORD' --email='youremail@example.com'
+```
+
+### Spaces
+
+The `space` command retrieve space related resources, please use the `help`
+command to see what's sub-commands are available.
+
+```sh
+ribose help space
+```
+
+#### Listing spaces
+
+To list out the spaces, please use the `list` command, by default it will print
+out the basic information in tabular format.
+
+```sh
+ribose space list
+```
+
+This interface also has support `json` format, if we want the output to be in
+`json` then we can use the following
+
+```sh
+ribose space list --format json
+```
+
+#### Show a space details
+
+```sh
+ribose space show --space-id 123456789
+```
+
+#### Create a new space
+
+To create a new user space we can use the following interface
+
+```sh
+ribose space add --name "Space name" --access "open" --category-id 12 \
+  --description "Space description"
+```
+
+#### Update a space
+
+```sh
+ribose space update --space-id 123456 --name "New Space Name"
+```
+
+#### Remove an existing space
+
+```sh
+ribose space remove --space-id 123456789 --confirmation 123456789
+```
+
+### Members
+
+#### List space members
+
+```sh
+ribose member list --space-id space_uuid
+```
+
+#### Add a new space member
+
+```sh
+ribose member add \
+  --space-id space_uuid \
+  --user-id=user-one-uuid:role_one_id user-two-uuid:role_two_id \
+  --email=email-one@example.com:role_one_id email@example.com:role_two_id \
+  --message="Your invitation messages to the invitees"
+```
+
+#### Update an existing member
+
+```sh
+ribose member update --role-id 135 --member-id 246 --space-id 1234
+```
+
+#### Remove a space member
+
+```sh
+ribose member remove --member-id 246 --space-id 1234
+```
+
+### Space Invitation
+
+#### List Space Invitation
+
+```sh
+ribose invitation list [--query=key:value]
+```
+
+#### Send out space invitation
+
+```sh
+ribose invitation add \
+  --space-id space_uuid \
+  --user-id=user-one-uuid:role_one_id user-two-uuid:role_two_id \
+  --email=email-one@example.com:role_one_id email@example.com:role_two_id \
+  --message="Your invitation messages to the invitees"
+```
+
+#### Update a space invitation
+
+```sh
+ribose invitation update --invitation-id 2468 --role-id 246
+```
+
+#### Accept a space invitation
+
+```sh
+ribose invitation accept --invitation-id 2468
+```
+
+#### Reject a space invitation
+
+```sh
+ribose invitation reject --invitation-id 2468
+```
+
+#### Remove a space invitation
+
+```sh
+ribose invitation remove --invitation-id 2468
+```
+
+### Join Space Request
+
+#### List join space requests
+
+```sh
+ribose join-space list [--query=space-id:2468]
+```
+
+#### Fetch a join space request
+
+```sh
+ribose join-space show --request-id 2468
+```
+
+#### Add join space request
+
+```sh
+ribose join-space add --space-id 1234 [--message "My request message"]
+```
+
+#### Accept a join space request
+
+```sh
+ribose join-space accept --request-id 2468
+```
+
+#### Reject a join space requests
+
+```sh
+ribose join-space reject --request-id 2468
+```
+
+### Note
+
+#### Listing space notes
+
+```sh
+ribose note list --space-id space_uuid --format json
+```
+
+### Show a space note
+
+```sh
+ribose note show --note-id 123456 --space-id 78901
+```
+
+#### Create a new note
+
+```sh
+ribose note add --space-id space_uuid --title "Name of the note"
+```
+
+#### Update an existing note
+
+```sh
+ribose note update --space-id 1234 --note-id 5678 --title "Name of the note"
+```
+
+#### Remove a note
+
+```sh
+ribose note remove --space-id space_uuid --note-id note_uuid
+```
+
+### Files
+
+#### Listing files
+
+Ribose space may contain multiple files, and if we want to retrieve the list of
+the files of any space then we can use to following interface.
+
+```sh
+ribose file list --space-id 123456
+```
+
+The above interface will retrieve the basic details in tabular format, but it
+also support additional `format` option, acceptable option: `json`.
+
+#### Fetch a file details
+
+```sh
+ribose file show --file-id 5678 --space-id 1234 [--format json]
+```
+
+#### Add a new file
+
+Ribose CLI allows us to upload a file in a user space, and to upload a new file
+we can use the following interface.
+
+```sh
+ribose file add full_path_the_file.ext  --space-id space_uuid **other_options
+```
+
+#### Update a space file
+
+```sh
+ribose file update [--file-name "new filename"] \
+[--description "New description"] \
+[--tags "tag 1, tag 2, tag 3"] --file-id 5678 --space-id 1234
+```
+
+#### Remove a space file
+
+```sh
+ribose file remove --file-id 5678 --space-id 1234
+```
+
+### Conversations
+
+#### Listing conversations
+
+```sh
+ribose conversation list --space-id 123456789
+```
+
+#### Show a conversation details
+
+```sh
+ribose conversation show --space-id 123456789 --conversation-id 67890
+```
+
+#### Create A New Conversation
+
+```sh
+ribose conversation add --space-id 123456789 --title "Conversation Title" \
+  --tags "sample, conversation"
+```
+
+#### Update a conversation
+
+```sh
+conversation update --conversation-id 5678 --space-id 123456789 --title \
+"Conversation Title" --tags "sample, conversation"
+```
+
+#### Remove A Conversation
+
+```sh
+ribose conversation remove --space-id 1234 --conversation-id 5678
+```
+
+### Message
+
+#### Listing conversation messages
+
+```sh
+ribose message list --space-id 12345 --conversation-id 56789
+```
+
+#### Add a new message to conversation
+
+```sh
+ribose message add --space-id 12345 --conversation-id 56789 \
+  --message-body "Welcome to Ribose Space"
+```
+
+#### Update an existing message
+
+
+```sh
+ribose message update --message-id 123456 --space-id 12345 \
+  --conversation-id 56789 --message-body "Welcome to Ribose Space"
+```
+
+#### Remove an existing message
+
+```sh
+ribose message remove --message-id 1234 --space-id 12345 --conversation-id 456
+```
 
 ## Development
 

data/bin/console

@@ -7,8 +7,5 @@ require "ribose/cli"
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+require "pry"
+Pry.start

data/bin/ribose

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# resolve bin path, ignoring symlinks
+require "pathname"
+bin_file = Pathname.new(__FILE__).realpath
+
+# add self to libpath
+$:.unshift File.expand_path("../../lib", bin_file)
+
+# Fixes https://github.com/rubygems/rubygems/issues/1420
+require "rubygems/specification"
+
+class Gem::Specification
+  def this; self; end
+end
+
+# start up the CLI
+require "bundler/setup"
+require "ribose/cli"
+
+Ribose::CLI.start(ARGV)

data/lib/ribose/cli/auth.rb

@@ -0,0 +1,10 @@
+require "ribose"
+require "ribose/cli/rcfile"
+
+unless Ribose.configuration.user_password
+  Ribose.configure do |config|
+    config.api_host = Ribose::CLI::RCFile.api_host
+    config.user_email = Ribose::CLI::RCFile.user_email
+    config.user_password = Ribose::CLI::RCFile.user_password
+  end
+end

data/lib/ribose/cli/command.rb

@@ -0,0 +1,60 @@
+require "ribose/cli/rcfile"
+require "ribose/cli/commands/base"
+require "ribose/cli/commands/space"
+require "ribose/cli/commands/file"
+require "ribose/cli/commands/conversation"
+require "ribose/cli/commands/message"
+require "ribose/cli/commands/note"
+require "ribose/cli/commands/member"
+require "ribose/cli/commands/invitation"
+require "ribose/cli/commands/join_space"
+
+module Ribose
+  module CLI
+    class Command < Thor
+      desc "space", "List, Add or Remove User Space"
+      subcommand :space, Ribose::CLI::Commands::Space
+
+      desc "member", "List, Add or Remove Space Member"
+      subcommand :member, Ribose::CLI::Commands::Member
+
+      desc "note", "List, Add or Remove Space Note"
+      subcommand :note, Ribose::CLI::Commands::Note
+
+      desc "file", "List, Add or Remove Files"
+      subcommand :file, Ribose::CLI::Commands::File
+
+      desc "conversation", "List, Add or Remove Conversation"
+      subcommand :conversation, Ribose::CLI::Commands::Conversation
+
+      desc "message", "List, Add or Remove Message"
+      subcommand :message, Ribose::CLI::Commands::Message
+
+      desc "invitation", "Manage Space Invitations"
+      subcommand :invitation, Ribose::CLI::Commands::Invitation
+
+      desc "join-space", "Manage Join Space Request"
+      subcommand :join_space, Ribose::CLI::Commands::JoinSpace
+
+      desc "config", "Configure API Key and User Email"
+      option :token, required: false, desc: "Your API Token for Ribose"
+      option :email, required: true, desc: "Your email address for Ribose"
+      option :password, required: true, desc: "Your API password for Ribose"
+      option :api_host, required: true, desc: "API host, eg: www.ribose.com"
+
+      def config
+        Ribose::CLI::RCFile.set(
+          token: options[:token],
+          email: options[:email],
+          password: options[:password],
+          api_host: options[:api_host],
+        )
+      end
+
+      desc "version", "The current active version"
+      def version
+        say(Ribose::CLI::VERSION)
+      end
+    end
+  end
+end

data/lib/ribose/cli/commands/base.rb

@@ -0,0 +1,80 @@
+module Ribose
+  module CLI
+    module Commands
+      class Base < Thor
+        private
+
+        # Table Headers
+        #
+        # Listing resources in table view will invoke this method to
+        # retrieve the list of headers, please override this in the
+        # sub-class and fill it in with actual fields name.
+        #
+        def table_headers
+          raise NotImplementedError
+        end
+
+        # Table Rows
+        #
+        # List resources in table view will invoke this method to build
+        # each of the individual resource row, please override this with
+        # an array that includes the value for headers.
+        #
+        def table_rows
+          raise NotImplementedError
+        end
+
+        # Table field names
+        #
+        # Displaying a single resource in table view will invoke this
+        # method to figure out field name and values for each of the
+        # row in table, please override this with proper attributes
+        #
+        def table_field_names
+          raise NotImplementedError
+        end
+
+        def build_output(resources, options)
+          json_view(resources, options) || table_view(resources)
+        end
+
+        def build_resource_output(resource, options)
+          resource_as_json(resource, options) || resource_as_table(resource)
+        end
+
+        def json_view(resources, options)
+          if options[:format] == "json"
+            resources.map(&:to_h).to_json
+          end
+        end
+
+        def resource_as_json(resource, options)
+          if options[:format] == "json"
+            resource.to_h.to_json
+          end
+        end
+
+        def table_view(resources)
+          Ribose::CLI::Util.list(
+            headings: table_headers, rows: table_rows(resources),
+          )
+        end
+
+        def resource_as_table(resource)
+          Ribose::CLI::Util.list(
+            headings: ["Field", "Value"],
+            rows: table_field_names.map { |key| [key, resource[key.to_s]] },
+          )
+        end
+
+        def symbolize_keys(options_hash)
+          Hash.new.tap do |hash|
+            options_hash.each_key do |key|
+              hash[(key.to_sym rescue key) || key] = options_hash.fetch(key)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ribose/cli/commands/conversation.rb

@@ -0,0 +1,114 @@
+module Ribose
+  module CLI
+    module Commands
+      class Conversation < Commands::Base
+        desc "list", "Listing A Space Conversations"
+        option :format, aliases: "-f", desc: "Output format, eg: json"
+        option :space_id, required: true, aliases: "-s", desc: "The Space UUID"
+
+        def list
+          say(build_output(list_conversations, options))
+        end
+
+        desc "show", "Show the details for a conversation"
+        option :space_id, required: true, aliases: "-s", desc: "The Space UUID"
+        option :format, aliases: "-f", desc: "Output format, eg: json"
+
+        option(
+          :conversation_id,
+          required: true,
+          aliases: "-c",
+          desc: "The Conversation UUID",
+        )
+
+        def show
+          say(build_resource_output(conversation(options), options))
+        end
+
+        desc "add", "Add a new conversation to Space"
+        option :space_id, required: true, aliases: "-s", desc: "The Space UUID"
+        option :title, required: true, desc: "The title for the conversation"
+        option :tags, aliases: "-t", desc: "The tags for the conversation"
+
+        def add
+          conversation = create_conversation(options)
+          say("New Conversation created! Id: " + conversation.id)
+        end
+
+        desc "update", "Updae an existing conversation"
+        option :title, desc: "The title for the conversation"
+        option :tags, aliases: "-t", desc: "The tags for the conversation"
+        option :space_id, required: true, aliases: "-s", desc: "The Space UUID"
+        option(
+          :conversation_id,
+          required: true,
+          aliases: "-c",
+          desc: "The conversation UUID",
+        )
+
+        def update
+          update_conversation(symbolize_keys(options))
+          say("Your conversation has been updated!")
+        rescue Ribose::UnprocessableEntity
+          say("Something went wrong!, please check required attributes")
+        end
+
+        desc "remove", "Remove A Conversation from Space"
+        option :space_id, required: true, aliases: "-s", desc: "The Space UUID"
+        option :conversation_id, required: true, aliases: "-c"
+
+        def remove
+          remove_conversation(options)
+          say("The Conversation has been removed!")
+        rescue
+          say("Please provide a valid Conversation UUID")
+        end
+
+        private
+
+        def conversation(attributes)
+          @conversation ||= Ribose::Conversation.fetch(
+            attributes[:space_id], attributes[:conversation_id]
+          )
+        end
+
+        def list_conversations
+          @conversations ||= Ribose::Conversation.all(options[:space_id])
+        end
+
+        def create_conversation(options)
+          Ribose::Conversation.create(
+            options[:space_id], name: options[:title], tag_list: options[:tags]
+          )
+        end
+
+        def update_conversation(attributes)
+          Ribose::Conversation.update(
+            attributes.delete(:space_id),
+            attributes.delete(:conversation_id),
+            attributes,
+          )
+        end
+
+        def remove_conversation(options)
+          Ribose::Conversation.destroy(
+            space_id: options[:space_id],
+            conversation_id: options[:conversation_id],
+          )
+        end
+
+        def table_headers
+          ["ID", "Title"]
+        end
+
+        def table_field_names
+          %w(id space_id name number_of_messages allow_comment)
+        end
+
+        def table_rows(conversations)
+          conversations.map { |conv| [conv.id, conv.name] }
+        end
+      end
+    end
+  end
+end