ribose 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2e0b15b878e195c9733369b05fd950d9bf77f079
-  data.tar.gz: 7255d85171187ea37f9ff8bd1ffdf900daaf1808
+SHA256:
+  metadata.gz: 6f07dcb32d639879659c0ff04134fb21531fb31184d9f446045b7c6bf159d7b8
+  data.tar.gz: 6b4b18cff60096ad9437c593a1d50c781d00226da781f3354192b01f4f83b300
 SHA512:
-  metadata.gz: 60ca909d98a6b7ff1d640a95deaabf730f375dcea7fec4a8e8d7f71fba9e00918c7be49f118ef039ebaf50eb7fab3bc4a2535e5c5c1cf187826429e9b7a91303
-  data.tar.gz: 231660d478721f30381564b376478de330ff47c116ea5932f99a6429cf6dd907812ffa71b1fa441a646f228f6d5c72d9060ce9eff8e465350ef937a5d5523a13
+  metadata.gz: 4a07d25023569d184f6250c9cf0f7106ee9e9a6e3ae465516f58a5be597ee96f064c047fe5c434a573385b519c55a78fc7776b75d56f8c37666d89e98819fb19
+  data.tar.gz: d09ccceb23eed385f3270b9adb4653f6f4787495dc435366c6989ab51dec49509833c7e4c5d40650d238eb3826334425e1f8aa598c5effae84cea849059aa386

data/.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: test
+
+on:
+  push:
+    branches: [ main ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  test:
+    name: RSpec
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.4', '2.5', '2.6', '2.7' ] #3.0
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle exec rake

data/.rubocop.yml

@@ -1,9 +1,4 @@
 AllCops:
-  Include:
-    - "**/*.rake"
-    - "**/Gemfile"
-    - "**/Rakefile"
-
   Exclude:
     - db/schema.rb
 
@@ -357,8 +352,18 @@ Style/TrailingCommaInArguments:
     - no_comma
   Enabled: true
 
-Style/TrailingCommaInLiteral:
-  Description: 'Checks for trailing comma in array and hash literals.'
+Style/TrailingCommaInArrayLiteral:
+  Description: 'Checks for trailing comma in array literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  EnforcedStyleForMultiline: comma
+  SupportedStylesForMultiline:
+    - comma
+    - consistent_comma
+    - no_comma
+  Enabled: true
+
+Style/TrailingCommaInHashLiteral:
+  Description: 'Checks for trailing comma in hash literals.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
   EnforcedStyleForMultiline: comma
   SupportedStylesForMultiline:
@@ -403,6 +408,13 @@ Layout/AlignParameters:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-double-indent'
   Enabled: false
 
+Layout/ConditionPosition:
+  Description: >-
+                 Checks for condition placed in a confusing position relative to
+                 the keyword.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#same-line-condition'
+  Enabled: false
+
 Layout/DotPosition:
   Description: 'Checks the position of the dot in multi-line method calls.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains'
@@ -455,13 +467,6 @@ Lint/CircularArgumentReference:
   Description: "Don't refer to the keyword argument in the default value."
   Enabled: false
 
-Lint/ConditionPosition:
-  Description: >-
-                 Checks for condition placed in a confusing position relative to
-                 the keyword.
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#same-line-condition'
-  Enabled: false
-
 Lint/DeprecatedClassMethods:
   Description: 'Check for deprecated class method calls.'
   Enabled: false
@@ -487,7 +492,7 @@ Lint/HandleExceptions:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions'
   Enabled: false
 
-Lint/LiteralInCondition:
+Lint/LiteralAsCondition:
   Description: 'Checks of literals used in conditions.'
   Enabled: false
 
@@ -528,7 +533,7 @@ Lint/UnderscorePrefixedVariableName:
   Description: 'Do not use prefix `_` for a variable that is used.'
   Enabled: false
 
-Lint/UnneededDisable:
+Lint/UnneededCopDisableDirective:
   Description: >-
                  Checks for rubocop:disable comments that can be removed.
                  Note: this cop is not disabled when disabling all cops.

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 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:
+ - Add interface for calendar event resources
+ - Add interface for space category, file icon
+ - Add interface to fetch file version and etc.
+
+Fixes:
+  - Fix file upload related error
+
 ## 0.2.0 (2017-11-30)
 
 Features:

data/README.md

@@ -231,6 +231,12 @@ Ribose::SpaceFile.all(space_id, options)
 Ribose::SpaceFile.fetch(space_id, file_id, options = {})
 ```
 
+#### Fetch a file icon
+
+```ruby
+Ribose::SpaceFile.fetch_icon(space_id, file_id, options = {})
+```
+
 #### Create a file upload
 
 ```ruby
@@ -249,6 +255,28 @@ Ribose::SpaceFile.update(space_id, file_id, new_file_attributes = {})
 Ribose::SpaceFile.delete(space_id, file_id)
 ```
 
+### File Version
+
+#### Fetch file version
+
+```ruby
+Ribose::FileVersion.fetch(
+  space_id: space_id, file_id: file_id, version_id: version_id
+)
+```
+
+#### 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
@@ -283,6 +311,12 @@ Ribose::Conversation.update(space_id, conversation_id, new_attributes_hash)
 Ribose::Conversation.destroy(space_id: "space_id", conversation_id: "12345")
 ```
 
+#### Mark a conversation as favorite
+
+```ruby
+Ribose::Conversation.mark_as_favorite(space_id, conversation_id)
+```
+
 ### Message
 
 #### List Conversation Messages
@@ -373,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,
@@ -556,6 +600,53 @@ Ribose::Calendar.create(
 Ribose::Calendar.delete(calendar_id)
 ```
 
+### Event
+
+#### List calendar events
+
+```ruby
+Ribose::Event.all(calendar_id)
+```
+
+#### Fetch a calendar event
+
+```ruby
+Ribose::Event.fetch(calendar_id, event_id)
+```
+
+#### Create a calendar event
+
+```ruby
+Ribose::Event.create(
+  calendar_id,
+  name: "Sample Event",
+  date_start: "04/04/2018",
+  time_start: "4:30pm",
+  date_finish: "04/04/2018",
+  time_finish: "5:30pm",
+  recurring_type: "not_repeat",
+  until: "never",
+  repeat_every: "1",
+  where: "Skype",
+  description: "Sample event",
+  all_day: false,
+)
+```
+
+#### Update a calendar event
+
+```ruby
+Ribose::Event.update(
+  calendar_id, event_id, new_attributes_hash, options_params
+)
+```
+
+#### Delete a calendar event
+
+```ruby
+Ribose::Event.delete(calendar_id, event_id)
+```
+
 ### User
 
 #### Create a signup request
@@ -610,6 +701,14 @@ Ribose::Wiki.update(
 Ribose::Wiki.delete(space_id, wiki_id)
 ```
 
+### Space categories
+
+#### List space categories
+
+```ruby
+Ribose::SpaceCategory.all
+```
+
 ## Development
 
 We are following Sandi Metz's Rules for this gem, you can read the

data/lib/ribose/actions/create.rb

@@ -6,7 +6,8 @@ module Ribose
       extend Ribose::Actions::Base
 
       def create
-        create_resource[resource]
+        response = create_resource
+        response[resource] || response
       end
 
       private

data/lib/ribose/actions/update.rb

@@ -9,7 +9,8 @@ module Ribose
       #
       # @return [Sawyer::Resource] Update resource response
       def update
-        update_resource[resource]
+        response = update_resource
+        response[resource] || response
       end
 
       private

data/lib/ribose/calendar.rb

@@ -14,14 +14,14 @@ module Ribose
     # @params length [Integer] How many days to fetch
     # @return [Sawyer::Resource] The calendar events
     #
-    def self.fetch(calendar_ids, start: Date.today, length: 7)
+    def self.fetch(calendar_ids, start: Date.today, length: 7, **others)
       query = {
         length: length,
         cal_ids: Ribose.encode_ids(calendar_ids),
         start: start.to_time.to_i / (60 * 60 * 24),
       }
 
-      super(nil, query: query)
+      super(nil, query: others.merge(query))
     end
 
     private

data/lib/ribose/client.rb

@@ -1,25 +1,43 @@
 module Ribose
   class Client
-    attr_reader :api_token, :user_email
+    attr_accessor :api_token, :api_email, :user_email,
+                  :client_id, :uid, :access_token
 
     def initialize(options = {})
-      @api_token = options.fetch(:token, configuration.api_token).to_s
-      @user_email = options.fetch(:email, configuration.user_email).to_s
+      @api_token    = options.fetch(:api_token, configuration.api_token).to_s
+      @api_email    = options.fetch(:api_email, configuration.api_email).to_s
+      @client_id    = options[:client_id]
+      @uid          = options[:uid]
+      @access_token = options[:access_token]
     end
 
     # Initiate a ribose client
     #
-    # This interface takes email and password and then it will
-    # do all the underlying work to find out the authentication
-    # token and retrun a ribose client.
+    # This interface takes email, password, api_email and api_token
+    # Then it will do all the underlying work to find out client id and uid
+    # Finally it will return a ribose client.
     #
     # @param :email [String] The email for your Ribose account
     # @param :password [String] The password for your account
+    # @param :api_email [String] The email for your API account
+    # @param :api_token [String] The authentication token for your API account
     # @return [Ribose::Client] A new client with your details
     #
-    def self.from_login(email:, password:)
-      session = Session.create(username: email, password: password)
-      new(email: email, token: session["authentication_token"])
+    def self.from_login(email:, password:, api_email:, api_token:)
+      session = Session.create(
+        username: email,
+        password: password,
+        api_email: api_email,
+        api_token: api_token
+      )
+
+      new(
+        api_email:    api_email,
+        api_token:    api_token,
+        client_id:    session.nil? ? nil : session['client'],
+        uid:          session.nil? ? nil : session['uid'],
+        access_token: session.nil? ? nil : session['access-token'],
+      )
     end
 
     private

data/lib/ribose/configuration.rb

@@ -2,20 +2,29 @@ require "ribose/response/raise_error"
 
 module Ribose
   class Configuration
-    attr_accessor :api_host, :api_token, :user_email, :debug_mode
+    attr_accessor :api_host, :api_email, :api_token,
+                  :user_email, :user_password,
+                  :verify_ssl,
+                  :debug_mode
 
     def initialize
       @debug_mode = false
-      @api_host ||= "www.ribose.com"
+      @verify_ssl = true
+      @api_host ||= "https://www.ribose.com"
     end
 
     def debug_mode?
       debug_mode == true
     end
 
-    def web_url
-      ["https", api_host].join("://")
+    def verify_ssl?
+      !!verify_ssl
     end
+
+    def ssl_verification_mode
+      verify_ssl? ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
+    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/conversation.rb

@@ -62,6 +62,24 @@ module Ribose
       new(space_id: space_id, conversation_id: conversation_id, **opts).delete
     end
 
+    def mark_as_favorite
+      response = Ribose::Request.put(
+        "#{resource_path}/mark_as_favorite",
+        resource_key.to_sym => { is_favorite: true },
+      )
+
+      response[resource]
+    end
+
+    # Mark a conversation a favorite
+    #
+    # @param space_id [String] The Space UUID
+    # @param conversation_id [String] Conversation UUID
+    #
+    def self.mark_as_favorite(space_id, conversation_id)
+      new(space_id: space_id, conversation_id: conversation_id).mark_as_favorite
+    end
+
     private
 
     attr_reader :space_id, :conversation_id

data/lib/ribose/event.rb

@@ -0,0 +1,86 @@
+module Ribose
+  class Event < Ribose::Base
+    include Ribose::Actions::Fetch
+    include Ribose::Actions::Create
+    include Ribose::Actions::Update
+    include Ribose::Actions::Delete
+
+    # List calendar events
+    #
+    # @params calendar_id [Integer] Calendar Ids
+    # @params options [Hash] The options parameters
+    # @return [Sawyer::Resource] Calendar Events
+    #
+    def self.all(calendar_id, options = {})
+      Ribose::Calendar.fetch(calendar_id, options)
+    end
+
+    # Fetch a calendar event
+    #
+    # @params calendar_id - The calendar ID
+    # @params event_id - The calendar event ID
+    # @return [Sawyer::Resource] Event details
+    #
+    def self.fetch(calendar_id, event_id, options = {})
+      new(options.merge(calendar_id: calendar_id, resource_id: event_id)).fetch
+    end
+
+    # Create a calendar event
+    #
+    # @params calendar_id - The calendar Id
+    # @attributes [Hash] - New Event attributes
+    # @return [Sawyer::Resource] The new event
+    #
+    def self.create(calendar_id, attrs, options = {})
+      new(options.merge(calendar_id: calendar_id, **attrs)).create["events"]
+    end
+
+    # Update a calendar event
+    #
+    # @params calendar_id [Integer] The calendar Id
+    # @params event_id [Integer] The calendar event Id
+    # @params attributes [Hash] New attributes for event
+    # @params options [Hash] The additional query params
+    #
+    def self.update(calendar_id, event_id, attributes, options = {})
+      new(options.merge(
+        calendar_id: calendar_id, resource_id: event_id, **attributes,
+      )).update["events"]
+    end
+
+    # Delete a calendar event
+    #
+    # @params calendar_id The calendar Id
+    # @params event_id  The calendar event Id
+    # @params options [Hash] The query params
+    #
+    def self.delete(calendar_id, event_id, options = {})
+      new(options.merge(calendar_id: calendar_id, resource_id: event_id)).delete
+    end
+
+    private
+
+    attr_reader :calendar_id
+
+    def resource
+      "event"
+    end
+
+    def validate(date_start:, date_finish:, time_start:, time_finish:, **others)
+      others.merge(
+        date_start: date_start,
+        time_start: time_start,
+        date_finish: date_finish,
+        time_finish: time_finish,
+      )
+    end
+
+    def extract_local_attributes
+      @calendar_id = attributes.delete(:calendar_id)
+    end
+
+    def resources_path
+      "calendar/calendar/#{calendar_id}/event"
+    end
+  end
+end

data/lib/ribose/file_uploader.rb

@@ -1,4 +1,6 @@
+require "json"
 require "faraday"
+require "ostruct"
 
 module Ribose
   class FileUploader
@@ -49,7 +51,10 @@ module Ribose
 
     def notify_ribose_file_upload_endpoint(response, key)
       if response.status.to_i == 200
-        Ribose::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
 
@@ -67,7 +72,16 @@ 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
@@ -90,4 +104,8 @@ module Ribose
       end
     end
   end
+
+  class OpenStruct < ::OpenStruct
+    alias :read_attribute_for_serialization :send
+  end
 end

data/lib/ribose/file_version.rb

@@ -0,0 +1,97 @@
+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
+    # @params :file_id [UUID] The space file Id
+    # @params :version_id [UUID] The file version Id
+    # @returns [Sawyer::Resource] The file version
+    #
+    def self.fetch(space_id:, file_id:, version_id:, **options)
+      new(
+        file_id: file_id,
+        space_id: space_id,
+        resource_id: version_id,
+        **options,
+      ).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 :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
+
+    def resource_path
+      [files_path, file_id, "versions", resource_id].join("/")
+    end
+
+    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