ribose 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: c12513b80d2e78ad9faf2e3c64de85c0943ac3ba3b9ea7e048820e3fd35564eb
-  data.tar.gz: 373f583f12f65efb0ab2f76f6123d9f140c52e25fffd557718f0165b8bbff1f2
+SHA1:
+  metadata.gz: e18f5e392f562d3757a8dffaf903af1f63c2f8d0
+  data.tar.gz: bcef222cf96830b6d150ead2571d31607f06b4d0
 SHA512:
-  metadata.gz: 734153a69502c7a0ffde70a561d9ba7842c5654c5f0cfde03267799a3a9dd2d0c0311382cab689135c87cfb28ca0349a6d4642abca7bac1786906e007af6b5f9
-  data.tar.gz: 578bab38e786870468f9a22c71785e819d06ee46e94fe050ea65e0aed1083abd96558bea5189939b9d64ffde608c5b19aa7303f7b697c17eb070b340d76069b6
+  metadata.gz: 49235eefd2aa174afc2eb97febd0d5fb34b5832aa016665c37e17f6d52ff3a02ee29e352e287e623f9f2074b5176bb41488508e90ab47bb5cab0e3b531d22303
+  data.tar.gz: c85dc140fa9b23184aa77d6ef9334e59afe0286ad23f5b85417746ad70b78958fe0591ce3b0d6a9712ccab40e3f79babf8e3891d7f3fd87100a17fc681cf18ea

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.4.0 (2018-12-15)
+
+Features:
+ - Add new interface to remove a user's space
+ - Add an interface to disconnect a connection
+ - Interface to create & download file version
+
+Fixes:
+ - Fix the unknown file upload related issues
+
 ## 0.3.2 (2018-06-28)
 
 Features:

data/README.md

@@ -265,6 +265,18 @@ Ribose::FileVersion.fetch(
 )
 ```
 
+#### Create a new file version
+
+```ruby
+Ribose::FileVersion.create(
+  space_id: your_space_id,
+  file_id: existing_file_id_in_space,
+  file: file_path_for_the_new_version,
+
+  **any_other_additional_attributes
+)
+```
+
 ### Conversations
 
 #### Listing Space Conversations
@@ -395,6 +407,16 @@ and it will return the connection as `Sawyer::Resource`.
 Ribose::Connection.all
 ```
 
+#### Disconnect a connection
+
+To disconnect with an existing connection, we can use `Connection.disconnect`
+interface as following. This expect us to provide the connection id, and it also
+support an additional options hash to provide custom options.
+
+```ruby
+Ribose::Connection.disconnect(connection_id, options)
+```
+
 #### Connection suggestions
 
 To retrieve the list of user connection suggestions,

data/lib/ribose/configuration.rb

@@ -16,6 +16,7 @@ module Ribose
     def web_url
       ["https", api_host].join("://")
     end
+
     def add_default_middleware(builder)
       builder.use(Ribose::Response::RaiseError)
       builder.response(:logger, nil, bodies: true) if debug_mode?

data/lib/ribose/connection.rb

@@ -1,6 +1,7 @@
 module Ribose
   class Connection < Ribose::Base
     include Ribose::Actions::All
+    include Ribose::Actions::Delete
 
     # List Connections
     #
@@ -26,6 +27,20 @@ module Ribose
         suggested_connection
     end
 
+    # Disconnect
+    #
+    # Disconnect connection / contact with the provided
+    # connection id. This will return nothing for successful
+    # request, but if disconnect fails then it will raise an
+    # Error for the client.
+    #
+    # @params resource_id [Integer] Connection Id
+    # @return nil
+    #
+    def self.disconnect(resource_id, options = {})
+      delete(resource_id, options)
+    end
+
     private
 
     def resource

data/lib/ribose/file_uploader.rb

@@ -51,7 +51,9 @@ module Ribose
 
     def notify_ribose_file_upload_endpoint(response, key)
       if response.status.to_i == 200
-        content = Request.post(space_file_path, file_attributes.merge(key: key))
+        attributes = notifiable_attributes(file_attributes, key)
+
+        content = Request.post(space_file_path, attributes)
         content.is_a?(Sawyer::Resource) ? content : parse_to_ribose_os(content)
       end
     end
@@ -70,13 +72,18 @@ module Ribose
 
     def content_type_form_file
       require "mime/types"
-      MIME::Types.type_for(file.path).first.content_type
+      mime = MIME::Types.type_for(file.path).first
+      mime ? mime.content_type : "application/octet-stream"
     end
 
     def parse_to_ribose_os(content)
       JSON.parse(content, object_class: Ribose::OpenStruct)
     end
 
+    def notifiable_attributes(attributes, key)
+      attributes.merge(key: key)
+    end
+
     def file_attributes
       @file_attributes ||= {
         filesize: file.size,

data/lib/ribose/file_version.rb

@@ -1,7 +1,13 @@
+require "ribose/version_uploader"
+
 module Ribose
   class FileVersion < Ribose::Base
     include Ribose::Actions::Fetch
 
+    def download
+      download_file || raise(Ribose::BadRequest)
+    end
+
     # Fetch file version
     #
     # @params :space_id [UUID] The space Id
@@ -18,15 +24,48 @@ module Ribose
       ).fetch
     end
 
+    # Download file version
+    #
+    # @param space_id [UUID] The space Id
+    # @param file_id [Integer] The file Id
+    # @param version_id [Hash] The file version Id
+    # @param options [Hash] Options as key and value pair
+    #
+    def self.download(space_id, file_id, version_id:, **options)
+      new(
+        file_id: file_id,
+        space_id: space_id,
+        resource_id: version_id,
+        **options,
+      ).download
+    end
+
+    # Create a new file version
+    #
+    # @params space_id [UUID] The space UUID
+    # @params file_id [Integer] The space file ID
+    # @params file [File] The new version for file
+    # @params attributes [Hash] Other file attributes
+    # @return [Sawyer::Resource] Newly updated version
+    #
+    def self.create(space_id, file_id, file:, **attributes)
+      upload = VersionUploader.upload(
+        space_id, file_id, attributes.merge(file: file)
+      )
+
+      upload[:attachment]
+    end
+
     private
 
-    attr_reader :file_id, :space_id
+    attr_reader :output, :file_id, :space_id
 
     def resource
       nil
     end
 
     def extract_local_attributes
+      @output = attributes.delete(:output)
       @file_id = attributes.delete(:file_id)
       @space_id = attributes.delete(:space_id)
     end
@@ -38,5 +77,21 @@ module Ribose
     def files_path
       ["spaces", space_id, "file", "files"].join("/")
     end
+
+    def download_file
+      data = Ribose::Request.get(
+        resource_path, parse: false, headers: { accept: "text/html" }
+      )
+
+      if data.headers["status"].match?(/^30[12]/)
+        fetch_and_write_to_file(data)
+      end
+    end
+
+    def fetch_and_write_to_file(data)
+      File.open(output || "download", "w") do |file|
+        file << data.agent.call(:get, data.headers["location"]).data
+      end
+    end
   end
 end

data/lib/ribose/request.rb

@@ -20,8 +20,11 @@ module Ribose
     # @return [Sawyer::Resource]
     #
     def request(options = {})
+      parsable = extract_config_option(:parse) != false
       options[:query] = extract_config_option(:query) || {}
-      agent.call(http_method, api_endpoint, data, options).data
+
+      response = agent.call(http_method, api_endpoint, data, options)
+      parsable == true ? response.data : response
     end
 
     # Make a HTTP GET Request
@@ -79,12 +82,15 @@ module Ribose
 
     def find_suitable_client
       client = extract_config_option(:client) || Ribose::Client.new
-      client.is_a?(Ribose::Client) ? client: raise(Ribose::Unauthorized)
+      client.is_a?(Ribose::Client) ? client : raise(Ribose::Unauthorized)
     end
 
     def require_auth_headers?
-      auth_header = extract_config_option(:auth_header)
-      auth_header == false ? false : true
+      extract_config_option(:auth_header) != false
+    end
+
+    def custom_content_headers
+      extract_config_option(:headers) || {}
     end
 
     def api_endpoint
@@ -107,10 +113,17 @@ module Ribose
       end
     end
 
+    def set_content_type(headers)
+      header = custom_content_headers
+      default_type = "application/json"
+
+      headers[:content_type] = default_type
+      headers[:accept] = header.fetch(:accept, default_type)
+    end
+
     def agent
       @agent ||= Sawyer::Agent.new(ribose_host, sawyer_options) do |http|
-        http.headers[:accept] = "application/json"
-        http.headers[:content_type] = "application/json"
+        set_content_type(http.headers)
 
         if require_auth_headers?
           http.headers["X-Indigo-Token"] = client.api_token

data/lib/ribose/space.rb

@@ -15,6 +15,10 @@ module Ribose
       Ribose::Request.post("spaces/#{space_uuid}/freeze", options)
     end
 
+    def self.delete(space_uuid, confirmation:, **options)
+      remove(space_uuid, options.merge(password_confirmation: confirmation))
+    end
+
     private
 
     attr_reader :space

data/lib/ribose/space_file.rb

@@ -34,6 +34,21 @@ module Ribose
       new(space_id: space_id, resource_id: file_id, **options).fetch
     end
 
+    # Download a space file
+    #
+    # @param space_id [UUID] The Space UUID
+    # @param file_id [Integer] The File Id
+    # @param options [Hash] Options as key and value pair.
+    #
+    #   Two important keys are :version_id, and :output and
+    #   if these are provided then it will use those otherwise
+    #   it will do additional request to retirve those details
+    #
+    def self.download(space_id, file_id, options = {})
+      options[:version_id] ||= fetch(space_id, file_id).current_version_id
+      Ribose::FileVersion.download(space_id, file_id, **options)
+    end
+
     # Create a new file upload
     #
     # @param space_id [String] The Space UUID

data/lib/ribose/version.rb

@@ -1,3 +1,3 @@
 module Ribose
-  VERSION = "0.3.2".freeze
+  VERSION = "0.4.0".freeze
 end

data/lib/ribose/version_uploader.rb

@@ -0,0 +1,27 @@
+require "ribose/file_uploader"
+
+module Ribose
+  class VersionUploader < Ribose::FileUploader
+    def initialize(space_id, file_id, file:, **attributes)
+      @file_id = file_id
+      super(space_id, file: file, **attributes)
+    end
+
+    def self.upload(space_id, file_id, file:, **attributes)
+      new(space_id, file_id, attributes.merge(file: file)).create
+    end
+
+    private
+
+    attr_reader :file_id
+
+    def notifiable_attributes(attributes, key)
+      attributes[:file_info_version] = attributes.delete(:file_info)
+      attributes.merge(key: key)
+    end
+
+    def space_file_path
+      ["spaces", space_id, "file", "files", file_id, "versions"].join("/")
+    end
+  end
+end

data/spec/ribose/connection_spec.rb

@@ -23,4 +23,15 @@ RSpec.describe Ribose::Connection do
       expect(suggestions.first.name).to eq("Jennie Doe")
     end
   end
+
+  describe ".disconnect" do
+    it "disconnect with provided connection" do
+      connection_id = 123_456
+      stub_ribose_connection_delete_api(connection_id)
+
+      expect do
+        Ribose::Connection.disconnect(connection_id)
+      end.not_to raise_error
+    end
+  end
 end

data/spec/ribose/file_uploader_spec.rb

@@ -14,11 +14,24 @@ RSpec.describe Ribose::FileUploader do
         expect(file_upload.attachment.content_type).to eq("image/png")
       end
     end
+
+    context "with unknown file type" do
+      it "creates a new upload as octet-stream" do
+        space_id = 123_456_789
+        attributes = file_attributes(File.join(Ribose.root, "Rakefile"))
+
+        stub_ribose_space_file_upload_api(space_id, attributes)
+        file_upload = Ribose::FileUploader.upload(space_id, attributes)
+
+        expect(file_upload.attachment.id).not_to be_nil
+        expect(file_upload.attachment.author).to eq("John Doe")
+      end
+    end
   end
 
-  def file_attributes
+  def file_attributes(file = nil)
     {
-      file: sample_fixture_file,
+      file: file || sample_fixture_file,
       tag_list: "sample, file, samplefile",
       description: "This is a sample file",
     }

data/spec/ribose/file_version_spec.rb

@@ -17,4 +17,60 @@ RSpec.describe Ribose::FileVersion do
       expect(file_version.current_version_id).to eq(789012)
     end
   end
+
+  describe ".download" do
+    context "with version id specified" do
+      it "downloads the specific file version" do
+        file_id = 123_456
+        space_id = 456_789
+        version_id = 789_012
+
+        output_file = "./tmp/download"
+        content = "This is the content in the file"
+
+        stub_aws_file_version_download_api(content)
+        buffer = stub_file_write_to_io(output_file)
+        stub_ribose_file_version_download_api(space_id, file_id, version_id)
+
+        Ribose::FileVersion.download(
+          space_id, file_id, version_id: version_id, output: output_file
+        )
+
+        expect(buffer).to eq(content)
+      end
+    end
+  end
+
+  describe ".create" do
+    it "create a new file version" do
+      file_id = 123_456
+      space_id = 456_789
+
+      stub_ribose_space_file_upload_api(space_id, file_attributes, file_id)
+      file = Ribose::FileVersion.create(space_id, file_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: "Version 2.0",
+      tag_list: "tags for new version",
+    }
+  end
+
+  def sample_fixture_file
+    @sample_fixture_file ||= File.join(Ribose.root, "spec/fixtures/sample.png")
+  end
+
+  def stub_file_write_to_io(output_file)
+    buffer = StringIO.new
+    allow(File).to receive(:open).with(output_file, "w").and_yield(buffer)
+
+    buffer.string
+  end
 end

data/spec/ribose/space_file_spec.rb

@@ -28,6 +28,37 @@ RSpec.describe Ribose::SpaceFile do
     end
   end
 
+  describe ".download" do
+    context "without specific version id" do
+      it "fetch version id and then downloads the file" do
+        file_id = 123_456_789
+        space_id = 456_789_012
+
+        allow(Ribose::FileVersion).to receive(:download)
+        stub_ribose_space_file_fetch_api(space_id, file_id)
+
+        Ribose::SpaceFile.download(space_id, file_id)
+
+        expect(Ribose::FileVersion).to have_received(:download).
+          with(space_id, file_id, version_id: 11559)
+      end
+    end
+
+    context "with specific version id" do
+      it "sends downlod message to the downloader" do
+        file_id = 123_456_789
+        space_id = 456_789_012
+        version_id = 123_456_789
+
+        allow(Ribose::FileVersion).to receive(:download)
+        Ribose::SpaceFile.download(space_id, file_id, version_id: version_id)
+
+        expect(Ribose::FileVersion).to have_received(:download).
+          with(space_id, file_id, version_id: version_id)
+      end
+    end
+  end
+
   describe ".create" do
     it "creates a new file with provided details" do
       space_id = 123_456_789

data/spec/ribose/space_spec.rb

@@ -59,6 +59,17 @@ RSpec.describe Ribose::Space do
     end
   end
 
+  describe ".delete" do
+    it "deletes an existing space" do
+      space_id = 123_456_789
+      stub_ribose_space_remove_api(space_id, password_confirmation: 1234)
+
+      expect do
+        Ribose::Space.delete(space_id, confirmation: 1234)
+      end.not_to raise_error
+    end
+  end
+
   def space_attributes
     {
       access: "private",

data/spec/support/fake_ribose_api.rb

@@ -30,6 +30,12 @@ module Ribose
       )
     end
 
+    def stub_ribose_space_delete_api(space_id, options = {})
+      stub_api_response(
+        :delete, "spaces/#{space_id}", data: options, filename: "empty"
+      )
+    end
+
     def stub_ribose_feed_api
       stub_api_response(:get, "feeds", filename: "feeds")
     end
@@ -220,6 +226,17 @@ module Ribose
       )
     end
 
+    def stub_ribose_file_version_download_api(sid, fid, vid)
+      version = ["spaces", sid, "file/files", fid, "versions", vid].join("/")
+      stub_request(:get, ribose_endpoint(version)).to_return(
+        headers: { location: "https://ribose-data.aws.com", status: 302 },
+      )
+    end
+
+    def stub_aws_file_version_download_api(content)
+      stub_request(:get, "https://ribose-data.aws.com").to_return(body: content)
+    end
+
     def stub_ribose_space_conversation_list(space_id)
       stub_api_response(
         :get, conversations_path(space_id), filename: "conversations"
@@ -310,6 +327,12 @@ module Ribose
       stub_api_response(:get, "people/connections?s=", filename: "connections")
     end
 
+    def stub_ribose_connection_delete_api(id)
+      stub_api_response(
+        :delete, ["people", "connections", id].join("/"), filename: "empty"
+      )
+    end
+
     def stub_ribose_suggestion_list_api
       stub_api_response(
         :get, "people_finding", filename: "connection_suggestion"

data/spec/support/file_upload_stub.rb

@@ -2,16 +2,16 @@ require "faraday"
 
 module Ribose
   module FileUploadStub
-    def stub_ribose_space_file_upload_api(space_id, attributes)
+    def stub_ribose_space_file_upload_api(space_id, attributes, file_id = nil)
       stub_ribose_aws_s3_file_upload_api
-      stub_ribose_file_prepare_api(space_id, attributes)
-      stub_ribose_file_upload_notify_api(space_id, attributes)
+      stub_ribose_file_prepare_api(space_id, attributes, file_id)
+      stub_ribose_file_upload_notify_api(space_id, attributes, file_id)
     end
 
-    def stub_ribose_file_prepare_api(space_id, attributes)
+    def stub_ribose_file_prepare_api(space_id, attributes, file_id = nil)
       stub_api_response(
         :get,
-        ribose_prepare_endpoint(space_id, attributes),
+        ribose_prepare_endpoint(space_id, attributes, file_id),
         filename: "file_upload_prepared",
       )
     end
@@ -22,11 +22,11 @@ module Ribose
         to_return(response_with(filename: "empty", status: 200))
     end
 
-    def stub_ribose_file_upload_notify_api(space_id, attributes)
+    def stub_ribose_file_upload_notify_api(space_id, attributes, file_id = nil)
       stub_api_response(
         :post,
-        ribose_file_endpoint(space_id),
-        data: build_notify_request_body(attributes),
+        ribose_file_endpoint(space_id, file_id),
+        data: build_notify_request_body(attributes, file_id),
         filename: "file_uploaded",
         content_type: "text/html",
       )
@@ -34,12 +34,14 @@ module Ribose
 
     private
 
-    def ribose_file_endpoint(space_id)
-      ["spaces", space_id, "file", "files"].join("/")
+    def ribose_file_endpoint(space_id, file_id = nil)
+      end_path = file_id ? "#{file_id}/versions" : nil
+      ["spaces", space_id, "file", "files", end_path].compact.join("/")
     end
 
-    def ribose_prepare_endpoint(sid, attrs)
-      [ribose_file_endpoint(sid), "prepare?#{prepare_params(attrs)}"].join("/")
+    def ribose_prepare_endpoint(sid, attrs, file_id = nil)
+      [ribose_file_endpoint(sid, file_id), "prepare?#{prepare_params(attrs)}"].
+        join("/")
     end
 
     def prepare_params(attributes)
@@ -50,16 +52,19 @@ module Ribose
       )
     end
 
-    def build_notify_request_body(attributes)
+    def build_notify_request_body(attributes, file_id = nil)
+      file_info_key = file_id ? "file_info_version" : "file_info"
+
       extract_file_details(attributes).merge(
-        file_info: extract_file_info(attributes),
+        file_info_key.to_sym => extract_file_info(attributes),
         key: "uploads/123456789/${filename}",
       )
     end
 
     def content_type_form_file(file)
       require "mime/types"
-      MIME::Types.type_for(file).first.content_type
+      mime = MIME::Types.type_for(file).first
+      mime ? mime.content_type : "application/octet-stream"
     end
 
     def extract_file_details(attributes)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ribose
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-29 00:00:00.000000000 Z
+date: 2018-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: id_pack
@@ -199,6 +199,7 @@ files:
 - lib/ribose/stream.rb
 - lib/ribose/user.rb
 - lib/ribose/version.rb
+- lib/ribose/version_uploader.rb
 - lib/ribose/widget.rb
 - lib/ribose/wiki.rb
 - ribose.gemspec
@@ -315,7 +316,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: The Ruby interface for Ribose API