ribose-cli 0.1.0 → 0.2.0

data/lib/ribose/cli/util.rb

@@ -0,0 +1,22 @@
+require "terminal-table"
+
+module Ribose
+  module CLI
+    module Util
+      def self.list(headings:, rows:)
+        Terminal::Table.new do |table|
+          table.headings = headings
+          table.rows = rows
+        end
+      end
+
+      def self.truncate(content, length = 50)
+        if content && content.length > length
+          content = content[0..length] + "..."
+        end
+
+        content
+      end
+    end
+  end
+end

data/lib/ribose/cli/version.rb

@@ -1,5 +1,5 @@
 module Ribose
-  module Cli
-    VERSION = "0.1.0".freeze
+  module CLI
+    VERSION = "0.2.0".freeze
   end
 end

data/lib/ribose/cli.rb

@@ -1,7 +1,26 @@
+require "thor"
+require "ribose"
+
+require "ribose/cli/auth"
+require "ribose/cli/util"
 require "ribose/cli/version"
+require "ribose/cli/command"
 
 module Ribose
-  module Cli
-    # Your code goes here...
+  module CLI
+    def self.start(arguments)
+      Ribose::CLI::Command.start(arguments)
+    rescue Ribose::Errors::Forbidden
+      Thor::Shell::Basic.new.say(
+        "Invalid: Missing API Configuration\n\n" \
+        "Ribose API Token & Email are required for any of the CLI operation\n" \
+        "You can set your API Key using `ribose config --token "" --email "" `",
+      )
+    end
+  end
+
+  # Temporary: The API Client will implement it
+  module Errors
+    class Forbidden < StandardError; end
   end
 end

data/ribose-cli.gemspec

@@ -6,7 +6,7 @@ require "ribose/cli/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "ribose-cli"
-  spec.version       = Ribose::Cli::VERSION
+  spec.version       = Ribose::CLI::VERSION
   spec.authors       = ["Ribose Inc."]
   spec.email         = ["operations@ribose.com"]
 
@@ -20,8 +20,14 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
   spec.bindir        = "bin"
+  spec.executables   = "ribose"
+
+  spec.add_dependency "thor", "~> 0.19.4"
+  spec.add_dependency "ribose", "~> 0.2.0"
+  spec.add_dependency "terminal-table"
 
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.0"
 end

data/spec/acceptance/config_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+RSpec.describe "Config" do
+  it "allows us to set token and user email" do
+    allow(File).to receive(:expand_path).and_return(fixtures_path)
+    command = %w(config --token SECRET_TOKEN --email user-one@example.com)
+
+    Ribose::CLI.start(command)
+
+    expect(Ribose::CLI::RCFile.api_token).to eq("SECRET_TOKEN")
+    expect(Ribose::CLI::RCFile.user_email).to eq("user-one@example.com")
+  end
+
+  def fixtures_path
+    File.expand_path("../../fixtures", __FILE__)
+  end
+end

data/spec/acceptance/conversation_spec.rb

@@ -0,0 +1,90 @@
+require "spec_helper"
+
+RSpec.describe "Space Conversation" do
+  describe "Listing conversations" do
+    it "retrieves the list of conversations" do
+      command = %w(conversation list --space-id 123456789 --format json)
+
+      stub_ribose_space_conversation_list(123456789)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/"name":"Sample conversation"/)
+      expect(output).to match(/"id":"741ebd0f-0959-42c5-b7d3-7749666d2f5f"/)
+    end
+  end
+
+  describe "Retrieving a conversation" do
+    it "retrieves the details for a conversation" do
+      command = %w(conversation show --space-id 12345 --conversation-id 6789)
+
+      stub_ribose_space_conversation_fetch_api(12345, 6789)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/number_of_messages | 1/)
+      expect(output).to match(/name               | Trips to the Mars!/)
+    end
+  end
+
+  describe "Adding a new conversations" do
+    it "creates a new conversation into a user space" do
+      command = %W(
+        conversation add
+        --title #{conversation.title}
+        --space-id #{conversation.space_id}
+        --tags #{conversation.tags}
+      )
+
+      stub__conversation_creation(conversation)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/New Conversation created!/)
+      expect(output).to match(/Id: ee50bb3c-ed79-4efc-821a-64926f645bfb/)
+    end
+  end
+
+  describe "Update an existing conversation" do
+    it "updates details for an existing conversation" do
+      command = %W(
+        conversation update
+        --conversation-id 123456789
+        --space-id #{conversation.space_id}
+        --title #{conversation.title}
+        --tags #{conversation.tags}
+      )
+
+      stub_ribose_space_conversation_update_api(
+        123_456_789, 123_456_789, conversation.to_h
+      )
+
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/Your conversation has been updated!/)
+    end
+  end
+
+  describe "Remove a conversation" do
+    it "removes a conversation from a speace" do
+      command = %w(conversation remove -s 9876 --conversation-id 12345)
+
+      stub_ribose_space_conversation_remove(9876, 12345)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/The Conversation has been removed!/)
+    end
+  end
+
+  def conversation
+    @conversation ||= OpenStruct.new(
+      space_id: 123_456_789, title: "The Special Conversation", tags: "sample",
+    )
+  end
+
+  def stub__conversation_creation(conversation)
+    stub_ribose_space_conversation_create(
+      conversation.space_id,
+      name: conversation.title,
+      tag_list: conversation.tags,
+      space_id: conversation.space_id.to_s,
+    )
+  end
+end

data/spec/acceptance/file_spec.rb

@@ -0,0 +1,80 @@
+require "spec_helper"
+
+RSpec.describe "File Interface" do
+  describe "listing files" do
+    it "retrieves the list of files" do
+      command = %w(file list --space-id 123456 --format json)
+
+      stub_ribose_space_file_list(123456)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/"id":9896/)
+      expect(output).to match(/"name":"sample-file.png"/)
+    end
+  end
+
+  describe "show" do
+    it "retrieves the details for a file" do
+      command = %w(file show --file-id 5678 --space-id 1234)
+
+      stub_ribose_space_file_fetch_api(1234, 5678)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/id           | 9896/)
+      expect(output).to match(/name         | sample-file.png/)
+      expect(output).to match(/content_type | image\/png/)
+    end
+  end
+
+  describe "adding new file" do
+    it "uploads the new file to user space" do
+      command = %W(file add --space-id 123456 #{file_attributes[:file]})
+
+      stub_ribose_space_file_upload_api(123456, file_attributes)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/sample.png added to your space!/)
+    end
+  end
+
+  describe "update" do
+    it "updates details for a space file" do
+      command = %W(
+        file update
+        --file-id 5678
+        --space-id 1234
+        --tags #{update_attributes[:tags]}
+        --file-name #{update_attributes[:file_name]}
+        --description #{update_attributes[:description]}
+      )
+
+      stub_ribose_space_file_update_api(1234, 5678, update_attributes)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/The file has been updated with new attributes/)
+    end
+  end
+
+  describe "remove" do
+    it "removes a file from a user space" do
+      command = %w(file remove --file-id 5678 --space-id 1234)
+
+      stub_ribose_space_file_delete_api(1234, 5678)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/The file has been removed from your space!/)
+    end
+  end
+
+  def file_attributes
+    { file: sample_fixture, description: "", tag_list: "" }
+  end
+
+  def update_attributes
+    { tags: "one, two", file_name: "new name", description: "New description" }
+  end
+
+  def sample_fixture
+    @sample_fixture ||= File.join(Ribose.root, "spec/fixtures/sample.png")
+  end
+end

data/spec/acceptance/invitation_spec.rb

@@ -0,0 +1,109 @@
+require "spec_helper"
+
+RSpec.describe "Space Invitation" do
+  describe "list" do
+    it "retrieves the list of space invitations" do
+      command = %w(invitation list)
+
+      stub_ribose_space_invitation_lis_api
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/ID    | Inviter    | Type/)
+      expect(output).to match(/Doe | Invitation::ToSpace | The CLI Space/)
+    end
+  end
+
+  describe "add" do
+    it "sends a space invitation to a member" do
+      command = %W(
+        invitation add
+        --space-id #{invitation.space_id}
+        --user-id #{invitation.id1}:#{invitation.role}
+        --email #{invitation.email1}:0 #{invitation.email2}:1
+        --message #{invitation.message}
+      )
+
+      stub_ribose_space_invitation_mass_create(
+        invitation.space_id, build_attr_in_stub_format(invitation)
+      )
+
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/Invitation has been sent successfully!/)
+    end
+  end
+
+  describe "update" do
+    it "updates the details for an invitation" do
+      command = %w(invitation update --invitation-id 2468 --role-id 246)
+      stub_ribose_space_invitation_update_api(2468, role_id: "246")
+
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/Space invitation has been updated!/)
+    end
+  end
+
+  describe "accept" do
+    it "allows us to accept a space invitation" do
+      command = %w(invitation accept --invitation-id 2468)
+
+      stub_ribose_space_invitation_update_api(2468, state: 1)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/Space invitation has been accepted!/)
+    end
+  end
+
+  describe "reject" do
+    it "allows us to reject a space invitation" do
+      command = %w(invitation reject --invitation-id 2468)
+
+      stub_ribose_space_invitation_update_api(2468, state: 2)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/Space invitation has been rejected!/)
+    end
+  end
+
+  describe "remove" do
+    it "removes a space invitation" do
+      command = %w(invitation remove --invitation-id 2468)
+
+      stub_ribose_space_invitation_cancel_api(2468)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/Space invitation has been removed!/)
+    end
+  end
+
+  def invitation
+    @invitation ||= OpenStruct.new(
+      id1: "123456",
+      id2: "567890",
+      role: "123456",
+      space_id: "123456789",
+      email1: "invitee-one@example.com",
+      email2: "invitee-two@example.com",
+      message: "Your invitation message",
+    )
+  end
+
+  # This might look compact, but the only purpose for this is to prepare
+  # the attributes / sequence with the one webmock would be epxecting to
+  # stub the api request successfully.
+  #
+  def build_attr_in_stub_format(invitation)
+    {
+      body: invitation.message,
+      emails: [invitation.email1, invitation.email2],
+      user_ids: [invitation.id1],
+      role_ids: {
+        "#{invitation.email1}": "0",
+        "#{invitation.email2}": "1",
+        "#{invitation.id1}": invitation.role,
+      },
+      space_id: invitation.space_id,
+    }
+  end
+end

data/spec/acceptance/join_space_spec.rb

@@ -0,0 +1,73 @@
+require "spec_helper"
+
+RSpec.describe "Join Space Request" do
+  describe "list" do
+    it "retrieves the list of join space requests" do
+      command = %w(join-space list)
+
+      stub_ribose_join_space_request_list_api
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/| ID    | Inviter    | Type/)
+      expect(output).to match(/| 27743 | Jennie Doe | Invitation::ToSpace/)
+    end
+  end
+
+  describe "show" do
+    it "retrieves the details for a join reqeust" do
+      command = %w(join-space show --request-id 2468)
+
+      stub_ribose_join_space_request_fetch_api(2468)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/state | 0/)
+      expect(output).to match(/id    | 123456789/)
+      expect(output).to match(/type  | Invitation::ToSpace/)
+    end
+  end
+
+  describe "add" do
+    it "creates a new join space request" do
+      command = %w(join-space add --space-id 1234)
+
+      stub_join_space_request_api_call(1234)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/Join space request has been sent successfully!/)
+    end
+  end
+
+  describe "accept" do
+    it "allows a user to accept a join space request" do
+      command = %w(join-space accept --request-id 2468)
+
+      stub_ribose_join_space_request_update(2468, state: 1)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/Join space request has been accepted!/)
+    end
+  end
+
+  describe "reject" do
+    it "allows a user to reject a join space request" do
+      command = %w(join-space reject --request-id 2468)
+
+      stub_ribose_join_space_request_update(2468, state: 2)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/Join space request has been rejected!/)
+    end
+  end
+
+  # This prepares the request body to match with wbmock's expected
+  # one to successfully stub  `POST /invitations/join_space_request`
+  #
+  def stub_join_space_request_api_call(space_id, state: 0, body: "")
+    stub_ribose_join_space_request_create_api(
+      state: state,
+      body: body,
+      type: "Invitation::JoinSpaceRequest",
+      space_id: space_id.to_s,
+    )
+  end
+end

data/spec/acceptance/member_spec.rb

@@ -0,0 +1,87 @@
+require "spec_helper"
+
+RSpec.describe "Space Member" do
+  describe "list" do
+    it "retrieves the list of space members" do
+      command = %w(member list --space-id 123456)
+
+      stub_ribose_space_member_list(123456)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/| Name     | Role Name/)
+      expect(output).to match(/8332-fcdaecb13e34 | John Doe | Administrator/)
+    end
+  end
+
+  describe "add" do
+    it "adds a new member to a space" do
+      command = %W(
+        member add
+        --space-id #{invitation.space_id}
+        --user-id #{invitation.id1}:#{invitation.role}
+        --email #{invitation.email1}:0 #{invitation.email2}:1
+        --message #{invitation.message}
+      )
+
+      stub_ribose_space_invitation_mass_create(
+        invitation.space_id, build_attr_in_stub_format(invitation)
+      )
+
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/Invitation has been sent successfully!/)
+    end
+  end
+
+  describe "update" do
+    it "updates an existing member details" do
+      command = %w(member update --role-id 135 --member-id 246 --space-id 1234)
+
+      stub_ribose_member_role_assign(1234, 246, "135")
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/Member has been updated with new role!/)
+    end
+  end
+
+  describe "remove" do
+    it "removes an existing space member" do
+      command = %w(member remove --member-id 246 --space-id 1234)
+
+      stub_ribose_space_member_delete_api(1234, 246)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/The member has been removed from this space/)
+    end
+  end
+
+  def invitation
+    @invitation ||= OpenStruct.new(
+      id1: "123456",
+      id2: "567890",
+      role: "123456",
+      space_id: "123456789",
+      email1: "invitee-one@example.com",
+      email2: "invitee-two@example.com",
+      message: "Your invitation message",
+    )
+  end
+
+  # This might look compact, but the only purpose for this is to prepare
+  # the attributes / sequence with the one webmock would be epxecting to
+  # stub the api request successfully.
+  #
+  def build_attr_in_stub_format(invitation)
+    {
+      body: invitation.message,
+      emails: [invitation.email1, invitation.email2],
+      user_ids: [invitation.id1],
+      role_ids: {
+        "#{invitation.email1}": "0",
+        "#{invitation.email2}": "1",
+        "#{invitation.id1}": invitation.role,
+      },
+      space_id: invitation.space_id,
+    }
+  end
+end

data/spec/acceptance/message_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+RSpec.describe "Conversation Messages" do
+  describe "listing messages" do
+    it "retrieves the list of messages" do
+      command = %w(message list -s 123456789 -c 123456789 --format json)
+
+      stub_ribose_message_list(123456789, 123456789)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/"contents":"Welcome to Ribose Space"/)
+      expect(output).to match(/"id":"eec38935-3070-4949-b217-878aa07db699"/)
+    end
+  end
+
+  describe "Adding new message" do
+    it "allows us to add message to a conversation" do
+      command = %W(
+        message add
+        --space-id 123
+        --message-body #{message.contents}
+        --conversation-id #{message.conversation_id}
+      )
+
+      stub_ribose_message_create(123, message: message.to_h)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/Messge has been posted/)
+      expect(output).to match(/Id: 9af4df9f-2a30-4d66-a925-efaf45057ae4/)
+    end
+  end
+
+  describe "Updating a message" do
+    it "allows us to update a existing message" do
+      command = %W(
+        message update
+        --space-id 123
+        --message-id 456789
+        --message-body #{message.contents}
+        --conversation-id #{message.conversation_id}
+      )
+
+      stub_ribose_message_update(123, 456789, message: message.to_h)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/Messge has been updated!/)
+    end
+  end
+
+  describe "Remove a message" do
+    it "allows us to remove an existing message" do
+      command = %w(message remove -s 123 -c 456 --message-id 123456)
+
+      stub_ribose_message_remove(123, 123456, 456)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/The message has been removed!/)
+    end
+  end
+
+  def message
+    @message ||= OpenStruct.new(
+      contents: "Welcome to Ribose!",
+      conversation_id: "987654321",
+    )
+  end
+end

data/spec/acceptance/note_spec.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+
+RSpec.describe "Space Note" do
+  describe "listing notes" do
+    it "retrieves the list of notes" do
+      command = %w(note list --space-id 123456789)
+
+      stub_ribose_wiki_list_api(123_456_789)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/Wiki Page One/)
+      expect(output).to match(/Wiki Page Two/)
+    end
+  end
+
+  describe "retrieve a note" do
+    it "retrieves the details for a note" do
+      command = %w(note show --space-id 123456 --note-id 789012)
+
+      stub_ribose_wiki_fetch_api(123456, 789012)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/revision | 23/)
+      expect(output).to match(/name     | Wiki Page One/)
+      expect(output).to match(/address  | wiki-page-one/)
+    end
+  end
+
+  describe "adding a new note" do
+    it "adds a new note to a specific space" do
+      command = %w(note add -s 123456 --title Home --tag-list hello)
+      stub_ribose_wiki_create_api(123_456, tag_list: "hello", name: "Home")
+
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/Note has been posted added! Id:/)
+    end
+  end
+
+  describe "update a note" do
+    it "updates the details for an existing note" do
+      command = %w(note update -s 1234 -n 5678 --title Sample)
+      stub_ribose_wiki_update_api(1234, 5678, name: "Sample", tag_list: "")
+
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/Your space note has been updated!/)
+    end
+  end
+
+  describe "remove a note" do
+    it "removes a note from a specific space" do
+      command = %w(note remove -s 123456789 --note-id 789123456)
+
+      stub_ribose_wiki_delete_api(123456789, 789123456)
+      output = capture_stdout { Ribose::CLI.start(command) }
+
+      expect(output).to match(/The note has been removed!/)
+    end
+  end
+end