ribose 0.1.0 → 0.2.0

data/spec/ribose/session_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+RSpec.describe Ribose::Session do
+  describe ".create" do
+    it "creates a new user session" do
+      username = "super.user"
+      password = "supper.secreet.password"
+
+      stub_session_creation_request_via_web
+      session = Ribose::Session.create(username: username, password: password)
+
+      expect(session["created_at"]).not_to be_nil
+      expect(session["authentication_token"]).to eq("user-super-secret-token")
+    end
+  end
+
+  def login_url
+    ribose_url_for("login")
+  end
+
+  def ribose_url_for(*endpoints)
+    [Ribose.configuration.web_url, *endpoints].join("/")
+  end
+
+  def stub_session_creation_request_via_web
+    stub_get_request_with_login_page
+    stub_post_request_with_empty_body
+    stub_general_inforomation_request
+  end
+
+  def stub_get_request_with_login_page
+    stub_request(:get, login_url).and_return(
+      body: ribose_fixture("login", "html"),
+      headers: { content_type: "text/html" },
+    )
+  end
+
+  def stub_general_inforomation_request
+    stub_request(:get, ribose_url_for(["settings", "general", "info"])).
+      and_return(body: ribose_fixture("general_information"), status: 200)
+  end
+
+  def stub_post_request_with_empty_body
+    stub_request(:post, login_url).and_return(body: ribose_fixture("empty"))
+  end
+end

data/spec/ribose/setting_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+RSpec.describe Ribose::Setting do
+  describe ".all" do
+    it "lists the user settings" do
+      stub_ribose_setting_list_api
+      settings = Ribose::Setting.all
+
+      expect(settings.first.id).not_to be_nil
+      expect(settings.first.type).to eq("Setting::Personal")
+      expect(settings.first.time_zone_detected).to eq("Asia/Bangkok")
+    end
+  end
+
+  describe ".fetch" do
+    it "fetches the details for a setting" do
+      setting_id = 123_456_789
+      stub_ribose_setting_find_api(setting_id)
+      setting = Ribose::Setting.fetch(setting_id)
+
+      expect(setting.id).to eq(setting_id)
+      expect(setting.type).to eq("Setting::Personal")
+      expect(setting.time_zone_detected).to eq("Asia/Bangkok")
+    end
+  end
+
+  describe ".update" do
+    it "updates a setting with provided details" do
+      new_theme_id = 6
+      setting_id = 123_456_789
+
+      stub_ribose_setting_update_api(setting_id, theme_id: new_theme_id)
+      setting = Ribose::Setting.update(setting_id, theme_id: new_theme_id)
+
+      expect(setting.id).to eq(setting_id)
+      expect(setting.type).to eq("Setting::Personal")
+      expect(setting.theme_id).to eq(new_theme_id.to_s)
+    end
+  end
+end

data/spec/ribose/space_file_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+RSpec.describe Ribose::SpaceFile do
+  describe ".all" do
+    it "retrieve files uploaded to a spce" do
+      space_id = 123_456_789
+      stub_ribose_space_file_list(space_id)
+
+      files = Ribose::SpaceFile.all(space_id)
+
+      expect(files.first.id).not_to be_nil
+      expect(files.first.name).to eq("sample-file.png")
+      expect(files.first.versions.first.version).to eq(1)
+    end
+  end
+
+  describe ".create" do
+    it "creates a new file with provided details" do
+      space_id = 123_456_789
+
+      stub_ribose_space_file_upload_api(space_id, file_attributes)
+      file = Ribose::SpaceFile.create(space_id, file_attributes)
+
+      expect(file.id).not_to be_nil
+      expect(file.author).to eq("John Doe")
+      expect(file.content_type).to eq("image/png")
+    end
+  end
+
+  def file_attributes
+    {
+      file: sample_fixture_file,
+      description: "This is a sample file",
+      tag_list: "Details tag for the file",
+    }
+  end
+
+  def sample_fixture_file
+    @sample_file ||= File.join(Ribose.root, "spec/fixtures/sample.png")
+  end
+end

data/spec/ribose/space_invitation_spec.rb

@@ -0,0 +1,117 @@
+require "spec_helper"
+
+RSpec.describe Ribose::SpaceInvitation do
+  describe ".all" do
+    it "retrieves the list of space invitations" do
+      stub_ribose_space_invitation_lis_api
+      invitations = Ribose::SpaceInvitation.all
+
+      expect(invitations.count).to eq(1)
+      expect(invitations.first.type).to eq("Invitation::ToSpace")
+      expect(invitations.first.space.name).to eq("The CLI Space")
+    end
+  end
+
+  describe ".create" do
+    it "creates an invitation to a specific space" do
+      stub_ribose_space_invitation_create_api(invitation_attributes)
+      invitation = Ribose::SpaceInvitation.create(invitation_attributes)
+
+      expect(invitation.id).not_to be_nil
+      expect(invitation.inviter.name).to eq("John Doe")
+      expect(invitation.type).to eq("Invitation::ToSpace")
+      expect(invitation.space.name).to eq("Trip to Mars!")
+    end
+  end
+
+  describe ".mass_create" do
+    it "creates multiple inviations to a space" do
+      space_id = 123_456_789
+
+      attributes = {
+        role_ids: [123_456_789],
+        emails: ["jennie.doe@example.com"],
+        body: "Hi, I would like to join you to this space",
+      }
+
+      stub_ribose_space_invitation_mass_create(space_id, attributes)
+      invitation = Ribose::SpaceInvitation.mass_create(space_id, attributes)
+
+      expect(
+        invitation.success.emails.first[0].to_s,
+      ).to eq(attributes[:emails].first.to_s)
+    end
+  end
+
+  describe ".update" do
+    it "updates a space invitation" do
+      invitation_id = 123_456_789
+      attributes = { role_id: 123 }
+
+      stub_ribose_space_invitation_update_api(invitation_id, attributes)
+      invitation = Ribose::SpaceInvitation.update(invitation_id, attributes)
+
+      expect(invitation.id).not_to be_nil
+      expect(invitation.role_id).not_to be_nil
+      expect(invitation.type).to eq("Invitation::ToSpace")
+    end
+  end
+
+  describe ".accept" do
+    it "accepts a space invitation" do
+      invitation_id = 123_456_789
+      stub_ribose_space_invitation_update_api(invitation_id, state: 1)
+
+      invitation = Ribose::SpaceInvitation.accept(invitation_id)
+
+      expect(invitation.state).to eq(1)
+      expect(invitation.id).not_to be_nil
+      expect(invitation.type).to eq("Invitation::ToSpace")
+    end
+  end
+
+  describe ".resend" do
+    it "resends a space invitation to non-member email" do
+      invitation_id = 123_456_789
+
+      stub_ribose_space_invitation_resend_api(invitation_id)
+      invitation = Ribose::SpaceInvitation.resend(invitation_id)
+
+      expect(invitation.to_space).not_to be_nil
+      expect(invitation.to_space.id).not_to be_nil
+    end
+  end
+
+  describe ".reject" do
+    it "rejects a space invitation" do
+      invitation_id = 123_456_789
+      stub_ribose_space_invitation_update_api(invitation_id, state: 2)
+
+      invitation = Ribose::SpaceInvitation.reject(invitation_id)
+
+      expect(invitation.id).not_to be_nil
+      expect(invitation.state).not_to be_nil
+      expect(invitation.type).to eq("Invitation::ToSpace")
+    end
+  end
+
+  describe ".cancel" do
+    it "cancels a space invitation" do
+      invitation_id = 123_456_789
+      stub_ribose_space_invitation_cancel_api(invitation_id)
+
+      expect do
+        Ribose::SpaceInvitation.cancel(invitation_id)
+      end.not_to raise_error
+    end
+  end
+
+  def invitation_attributes
+    @invitation ||= {
+      state: "0",
+      body: "Please join!",
+      space_id: "123_456_789",
+      invitee_id: "456_789_012",
+    }
+  end
+end

data/spec/ribose/space_spec.rb

@@ -0,0 +1,70 @@
+require "spec_helper"
+
+RSpec.describe Ribose::Space do
+  describe ".all" do
+    it "retrieves the list of user spaces" do
+      stub_ribose_space_list_api
+      spaces = Ribose::Space.all
+
+      expect(spaces.first.id).to eq("0e8d5c16-1a31-4df9-83d9-eeaa374d5adc")
+      expect(spaces.first.name).to eq("Work")
+      expect(spaces.first.visibility).to eq("invisible")
+    end
+  end
+
+  describe ".fetch" do
+    it "fetches a specific user space" do
+      space_id = 123_456_789
+
+      stub_ribose_space_fetch_api(space_id)
+      space = Ribose::Space.fetch(space_id)
+
+      expect(space.id).not_to be_nil
+      expect(space.name).to eq("Work")
+      expect(space.role_name).to eq("Administrator")
+    end
+  end
+
+  describe ".create" do
+    it "creates a new space with provided details" do
+      stub_ribose_space_create_api(space_attributes)
+      space = Ribose::Space.create(space_attributes)
+
+      expect(space.id).not_to be_nil
+      expect(space.visibility).to eq("invisible")
+      expect(space.name).to eq("Trip to the Mars")
+    end
+  end
+
+  describe ".update" do
+    it "updates a space with provided details" do
+      space_id = 123_456_789
+
+      stub_ribose_space_update_api(space_id, space_attributes)
+      space = Ribose::Space.update(space_id, space_attributes)
+
+      expect(space.id).not_to be_nil
+      expect(space.visibility).to eq("invisible")
+    end
+  end
+
+  describe ".remove" do
+    it "removes an existing space" do
+      space_uuid = "8c63c209-8b98-41aa-a320-336462476ea1"
+      stub_ribose_space_remove_api(space_uuid, confirmation: true)
+
+      expect do
+        Ribose::Space.remove(space_uuid, confirmation: true)
+      end.not_to raise_error
+    end
+  end
+
+  def space_attributes
+    {
+      access: "private",
+      space_category_id: 12,
+      description: "The long awaited dream!",
+      name: "Trip to the Mars",
+    }
+  end
+end

data/spec/ribose/stream_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+RSpec.describe Ribose::Stream do
+  describe ".all" do
+    it "retreives the list of notifications stream" do
+      stub_ribose_stream_list_api
+      stream = Ribose::Stream.all
+
+      expect(stream.notifications.count).to eq(3)
+      expect(stream.notifications.first.id).not_to be_nil
+      expect(stream.notifications.first.data.first.info.action).to eq("create")
+    end
+  end
+end

data/spec/ribose/user_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+RSpec.describe Ribose::User do
+  before { restore_to_default_config }
+  after { set_configuration_for_test_env }
+
+  describe ".create" do
+    it "creates a new signup request for user" do
+      user_attributes = { email: "john.doe@example.com" }
+      stub_ribose_app_user_create_api(user_attributes)
+
+      expect do
+        Ribose::User.create(user_attributes)
+      end.not_to raise_error
+    end
+  end
+
+  describe ".activate" do
+    it "complete the user signup process" do
+      stub_ribose_app_user_activate_api(user_attributes)
+      user = Ribose::User.activate(user_attributes)
+
+      expect(user.id).not_to be_nil
+      expect(user.name).to eq("John Doe")
+      expect(user.connected).to be_truthy
+    end
+  end
+
+  def user_attributes
+    @user_attributes ||= {
+      email: "john.doe@example.com",
+      password: "SecurePassword",
+      otp: "OTP_RECEIVED_VIA_EMAIL",
+    }
+  end
+
+  def restore_to_default_config
+    Ribose.configuration.api_token = nil
+    Ribose.configuration.user_email = nil
+  end
+
+  def set_configuration_for_test_env
+    Ribose.configure do |config|
+      config.api_token = ENV["RIBOSE_API_TOKEN"] || "RIBOSE_API_TOKEN"
+      config.user_email = ENV["RIBOSE_USER_EMAIL"] || "RIBOSE_USER_EMAIL"
+    end
+  end
+end

data/spec/ribose/widget_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+RSpec.describe Ribose::Widget do
+  describe ".all" do
+    it "retrieves the list of widgets" do
+      stub_ribose_widget_list_api
+      widgets = Ribose::Widget.all
+
+      expect(widgets.first.id).not_to be_nil
+      expect(widgets.first.status).to eq("loaded")
+      expect(widgets.first.type).to eq("Widget::RssFeed")
+    end
+  end
+end

data/spec/ribose/wiki_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+RSpec.describe Ribose::Wiki do
+  describe ".all" do
+    it "retrieves the list of wiki pages" do
+      space_id = 123_456
+
+      stub_ribose_wiki_list_api(space_id)
+      wikis = Ribose::Wiki.all(space_id)
+
+      expect(wikis.count).to eq(2)
+      expect(wikis.first.name).to eq("Wiki Page One")
+      expect(wikis.last.name).to eq("Wiki Page Two")
+    end
+  end
+
+  describe ".fetch" do
+    it "retrieves the details for a wiki page" do
+      wiki_id = 456_789
+      space_id = 123_456
+
+      stub_ribose_wiki_fetch_api(space_id, wiki_id)
+      wiki = Ribose::Wiki.fetch(space_id, wiki_id)
+
+      expect(wiki.name).to eq("Wiki Page One")
+      expect(wiki.history.current_ver).to eq(1)
+      expect(wiki.updater.name).to eq("John Doe")
+    end
+  end
+
+  describe ".create" do
+    it "creates a new wiki page in space" do
+      space_id = 123_456
+      attributes = { name: "Wiki Page One" }
+
+      stub_ribose_wiki_create_api(space_id, attributes)
+      wiki = Ribose::Wiki.create(space_id, attributes)
+
+      expect(wiki.id).not_to be_nil
+      expect(wiki.name).to eq(attributes[:name])
+    end
+  end
+
+  describe ".update" do
+    it "updates a wiki with provided details" do
+      wiki_id = 456_789
+      space_id = 123_456
+      attributes = { name: "Wiki Page One" }
+
+      stub_ribose_wiki_update_api(space_id, wiki_id, attributes)
+      wiki = Ribose::Wiki.update(space_id, wiki_id, attributes)
+
+      expect(wiki.id).not_to be_nil
+      expect(wiki.name).to eq("Wiki Page One")
+    end
+  end
+
+  describe ".delete" do
+    it "deletes an existing space wiki page" do
+      wiki_id = 456_789
+      space_id = 123_456
+
+      stub_ribose_wiki_delete_api(space_id, wiki_id)
+      expect { Ribose::Wiki.delete(space_id, wiki_id) }.not_to raise_error
+    end
+  end
+end