redbooth-ruby 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c965740525e418665ebed6cdfc26ab17a67fb5e
-  data.tar.gz: 76bd8e60f6b972b540b23feb613e7e1cb2241544
+  metadata.gz: 23c2045bfaa9ab724e5588d13d6c9b835bc75c18
+  data.tar.gz: ed38bcf8112e36647ca0dfd09146b1e6f049acf9
 SHA512:
-  metadata.gz: 6280ee42271771c0c17d57107084382b841f14e44976426b62eb7da0964214eb4ab8dd42bb3b90d743bd807bfa65218e4b809e217cce5f71acedb4e0303ccfe5
-  data.tar.gz: 46075bd7b3d79e78762958021e89d38363fb1be2d7a73c94ac7dad71dceaa3e8a1f35f30555aa5ede4bbcb1abd3fce359ce00798df7eca1a29db4b6617c96583
+  metadata.gz: e5d57329c98c5827134cca570c2b1dbce3244f5351a0c56e0c678a311def93e91b0bda6119a17b829b9d9524db2119b0d7be4c84a2085673cf3991b1382b8d81
+  data.tar.gz: 9f3f2cbff122c1e8d796bbf156520fd6d1591b4c267da527c754e49ed4003f1097c777c1aa9bef5a2d6f1e465946c49a733103b2da3b2d16b06f6cfee194a4e3

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://magnum.travis-ci.com/teambox/redbooth-ruby.svg?token=DytWKainUGNzXxdrekWH&branch=feature/tasks)](https://magnum.travis-ci.com/teambox/redbooth-ruby) [![Code Climate](https://codeclimate.com/repos/5461c4f6e30ba075bc0a0ab0/badges/11031f420440e8a9f525/gpa.svg)](https://codeclimate.com/repos/5461c4f6e30ba075bc0a0ab0/feed) [![Test Coverage](https://codeclimate.com/repos/5461c4f6e30ba075bc0a0ab0/badges/11031f420440e8a9f525/coverage.svg)](https://codeclimate.com/repos/5461c4f6e30ba075bc0a0ab0/feed) [![Inline docs](http://inch-ci.org/github/teambox/redbooth-ruby.svg?branch=master)](http://inch-ci.org/github/teambox/redbooth-ruby)
+[![Build Status](https://travis-ci.org/teambox/redbooth-ruby.svg?branch=master)](https://travis-ci.org/teambox/redbooth-ruby) [![Code Climate](https://codeclimate.com/repos/5461c4f6e30ba075bc0a0ab0/badges/11031f420440e8a9f525/gpa.svg)](https://codeclimate.com/repos/5461c4f6e30ba075bc0a0ab0/feed) [![Test Coverage](https://codeclimate.com/repos/5461c4f6e30ba075bc0a0ab0/badges/11031f420440e8a9f525/coverage.svg)](https://codeclimate.com/repos/5461c4f6e30ba075bc0a0ab0/feed) [![Inline docs](http://inch-ci.org/github/teambox/redbooth-ruby.svg?branch=master)](http://inch-ci.org/github/teambox/redbooth-ruby)
 
 Redbooth-Ruby
 ======
@@ -160,7 +160,7 @@ List users in your network
   users = users_collection.all
 ```
 
-Fetch a especific user
+Fetch a specific user
 
 ```Ruby
   user = client.user(:show, id: 123)
@@ -184,19 +184,19 @@ You can also filter by multiple params (see docs [here](https://redbooth.com/api
                                         project_id: 123)
 ```
 
-Fetch a especific task
+Fetch a specific task
 
 ```Ruby
   task = client.task(:show, id: 123)
 ```
 
-Update a especific task
+Update a specific task
 
 ```Ruby
   task = client.task(:update, id: 123, name: 'new name')
 ```
 
-Delete a especific task
+Delete a specific task
 
 ```Ruby
   client.task(:delete, id: 123)
@@ -219,7 +219,7 @@ You can also filter by multiple params (see docs [here](https://redbooth.com/api
                                                        per_page: 50)
 ```
 
-Fetch a especific organization
+Fetch a specific organization
 
 ```Ruby
   organization = client.organization(:show, id: 123)
@@ -231,13 +231,13 @@ Create a organization
   organization = client.organization(:create, name: 'New Organization')
 ```
 
-Update a especific organization
+Update a specific organization
 
 ```Ruby
   organization = client.organization(:update, id: 123, name: 'new name')
 ```
 
-Delete a especific organization
+Delete a specific organization
 
 ```Ruby
   client.organization(:delete, id: 123)
@@ -260,7 +260,7 @@ You can also filter by multiple params (see docs [here](https://redbooth.com/api
                                                        per_page: 50)
 ```
 
-Fetch a especific project
+Fetch a specific project
 
 ```Ruby
   project = client.project(:show, id: 123)
@@ -272,13 +272,13 @@ Create a project
   project = client.project(:create, name: 'New Project')
 ```
 
-Update a especific project
+Update a specific project
 
 ```Ruby
   project = client.project(:update, id: 123, name: 'new name')
 ```
 
-Delete a especific project
+Delete a specific project
 
 ```Ruby
   client.project(:delete, id: 123)
@@ -312,7 +312,7 @@ You can also filter by multiple params (see docs [here](https://redbooth.com/api
                                           per_page: 50)
 ```
 
-Fetch a especific person
+Fetch a specific person
 
 ```Ruby
   people = client.person(:show, id: 123)
@@ -324,13 +324,13 @@ Create a person
   person = client.person(:create, project_id: 123, user_id: 123, role: 'participant')
 ```
 
-Update a especific person
+Update a specific person
 
 ```Ruby
   person = client.person(:update, id: 123, role: 'admin')
 ```
 
-Delete a especific person
+Delete a specific person
 
 ```Ruby
   client.person(:delete, id: 123)
@@ -363,7 +363,7 @@ You can also filter by multiple params (see docs [here](https://redbooth.com/api
                                                    per_page: 50)
 ```
 
-Fetch a especific membership
+Fetch a specific membership
 
 ```Ruby
   memberships = client.membership(:show, id: 123)
@@ -375,13 +375,13 @@ Create a membership
   membership = client.membership(:create, organization_id: 123, user_id: 123, role: 'participant')
 ```
 
-Update a especific membership
+Update a specific membership
 
 ```Ruby
   membership = client.membership(:update, id: 123, role: 'admin')
 ```
 
-Delete a especific membership
+Delete a specific membership
 
 ```Ruby
   client.membership(:delete, id: 123)
@@ -405,24 +405,241 @@ You can also filter by multiple params (see docs [here](https://redbooth.com/api
                                                        project_id: 123)
 ```
 
-Fetch a especific conversation
+Fetch a specific conversation
 
 ```Ruby
   conversation = client.conversation(:show, id: 123)
 ```
 
-Update a especific conversation
+Update a specific conversation
 
 ```Ruby
   conversation = client.conversation(:update, id: 123, name: 'new name')
 ```
 
-Delete a especific conversation
+Delete a specific conversation
 
 ```Ruby
   client.conversation(:delete, id: 123)
 ```
 
+Comments
+=====
+
+Comments are the redbooth resources containing the `Task` and `Conversation` Content.
+It also contains the information about the task status changes, assigned changes and due_data changes.
+
+To consume the comments endpoint you allways need to provide a `target_type` and `target_id`. This is needed for performance reasons.
+
+Lists comments in your visibility scope
+
+```Ruby
+  comment_collection = client.comment(:index, target_type: 'task', target_id: 123)
+  comments = comment_collection.all
+```
+
+You can also filter by multiple params (see docs [here](https://redbooth.com/api/api-docs/#page:comments,header:comments-commnets-list) )
+
+```Ruby
+  filtered_comments = client.comment(:index, order: 'id-DESC',
+                                             per_page: 50,
+                                             project_id: 123,
+                                             target_type: 'task',
+                                             target_id: 123)
+```
+
+Fetch a specific comment
+
+```Ruby
+  comment = client.comment(:show, id: 123)
+```
+
+Update a specific comment
+
+```Ruby
+  comment = client.comment(:update, id: 123, body: 'new body content')
+```
+
+Delete a specific comment
+
+```Ruby
+  client.comment(:delete, id: 123)
+```
+
+Notes
+=====
+
+Lists notes in your visibility scope
+
+```Ruby
+  notes_collection = client.note(:index)
+  notes = notes_collection.all
+```
+
+You can also filter by multiple params (see docs [here](https://redbooth.com/api/api-docs/#page:notes,header:notes-notes-list) )
+
+```Ruby
+  filtered_notes = client.note(:index, order: 'id-DESC',
+                                       per_page: 50,
+                                       project_id: 123)
+```
+
+Fetch a specific note
+
+```Ruby
+  note = client.note(:show, id: 123)
+```
+
+Update a specific note
+
+```Ruby
+  note = client.note(:update, id: 123, name: 'new name')
+```
+
+Delete a specific note
+
+```Ruby
+  client.note(:delete, id: 123)
+```
+
+Subtasks
+=====
+
+Subtasks are little sentences under a task that could de resolved or not.
+
+Lists subtasks in your visibility scope. Needs a task_id
+
+```Ruby
+  subtask_collection = client.subtask(:index, task_id: 123)
+  subtasks = subtask_collection.all
+```
+
+You can also filter by multiple params (see docs [here](https://redbooth.com/api/api-docs/#page:subtasks,header:subtasks-subtasks-list) )
+
+```Ruby
+  filtered_subtasks = client.subtask(:index, task_id: 123,
+                                             order: 'id-DESC',
+                                             per_page: 50)
+```
+
+Fetch a specific subtask
+
+```Ruby
+  subtask = client.subtask(:show, id: 123)
+```
+
+Create a new subtask
+
+```Ruby
+  subtask = client.subtask(:create, task_id: 123, name: 'new name')
+```
+
+Update a specific subtask
+
+```Ruby
+  subtask = client.subtask(:update, id: 123, name: 'new name')
+```
+
+Delete a specific subtask
+
+```Ruby
+  client.subtask(:delete, id: 123)
+```
+
+Files
+=====
+
+Files in redbooth could be uploaded or choosen form other service providers (Copy, Dropbox, Gdrive, Box, Signnow, ...). This client allows you to browse or create files in redbooth api.
+
+Lists files in your visibility scope.
+
+```Ruby
+  files_colilection = client.file(:index)
+  files = files_collection.all
+```
+
+You can also filter by multiple params (see docs [here](https://redbooth.com/api/api-docs/#page:subtasks,header:subtasks-subtasks-list) )
+
+```Ruby
+  filtered_files_collection = client.file(:index, backend: 'redbooth',
+                                                  project_id: 123,
+                                                  order: 'id-DESC',
+                                                  per_page: 25)
+```
+
+Update a specific file
+
+```Ruby
+  file = client.file(:update, id: 123, name: 'new_name.doc')
+```
+
+Create a new file
+
+```Ruby
+  file = File.open('path/to/the/file')
+  new_file = client.file(:create, project_id: 123,
+                                  parent_id: nil,
+                                  backend: 'redbooth',
+                                  is_dir: false,
+                                  asset: file )
+```
+
+Delete a specific subtask
+
+```Ruby
+  client.file(:delete, id: 123)
+```
+
+Search
+=====
+
+You can search throught any redbooth entity by using the search method. There is some filter params available:
+
+* `query`: Regex like query to search
+
+* `project_id`: Reduce the scope to search for
+
+* `target_type`: List of entity types to be returned
+
+
+Search for redbooth objects in your visibility scope
+
+```Ruby
+  entities = client.search(query: 'task+nothing*')
+```
+
+Metadata
+=====
+
+ADVISE: Redbooth metadata API is in `Beta` status so use this under your own risk.
+
+Metadata API allows you to add custo key value attributes to objects inside redbooth and search by those key value attributes.
+This is really helpful when doing API syncs or tiny implementations in top of the Redbooth API.
+
+Fetch object metadata
+
+```Ruby
+  task.metadata
+```
+
+Update object metadata by adding new keys or overwriding the exisiting ones but not touching the others if there is any one.
+
+```Ruby
+  task.metadata_merge("new_key" => "new value")
+```
+
+Restore user metadata by overwiritng the existing ones.
+
+```Ruby
+  task.metadata = {"key" => "value"}
+```
+
+Search for a certain metadata key value
+
+```Ruby
+  metadata_collection = client.metadata(key: 'key', value: 'value', target_type: 'Task')
+```
+
 License
 =====
 

data/lib/redbooth-ruby.rb

@@ -20,6 +20,11 @@ module RedboothRuby
   autoload :Project,        'redbooth-ruby/project'
   autoload :Conversation,   'redbooth-ruby/conversation'
   autoload :Membership,     'redbooth-ruby/membership'
+  autoload :Comment,        'redbooth-ruby/comment'
+  autoload :Note,           'redbooth-ruby/note'
+  autoload :Subtask,        'redbooth-ruby/subtask'
+  autoload :File,           'redbooth-ruby/file'
+
 
   module Operations
     autoload :Base,       'redbooth-ruby/operations/base'
@@ -41,6 +46,11 @@ module RedboothRuby
     autoload :Collection, 'redbooth-ruby/request/collection'
   end
 
+  module ClientOperations
+    autoload :Search,     'redbooth-ruby/client_operations/search'
+    autoload :Metadata,   'redbooth-ruby/client_operations/metadata'
+  end
+
   class RedboothError < StandardError; end
   class AuthenticationError < RedboothError; end
   class OauhtTokenExpired < AuthenticationError; end

data/lib/redbooth-ruby/base.rb

@@ -2,7 +2,7 @@ module RedboothRuby
   class Base
     include RedboothRuby::Operations::Base
 
-    attr_accessor :created_time
+    attr_accessor :created_time, :session
 
     # Initializes the object using the given attributes
     #

data/lib/redbooth-ruby/client.rb

@@ -1,13 +1,20 @@
 module RedboothRuby
   class Client
-    RESOURCES = [:me, :user, :task, :organization, :person, :project, :conversation, :membership]
+    include RedboothRuby::ClientOperations::Search
+    include RedboothRuby::ClientOperations::Metadata
+
+    RESOURCES = [ :me, :user, :task, :organization, :person, :project,
+                  :conversation, :membership, :comment, :note, :subtask,
+                  :file ]
 
     attr_reader :session, :options
 
     # Creates an client object using the given Redbooth session.
     # existing account.
     #
-    # @param [String] client object to use the redbooth api.
+    # @param session [Redbooth::Session] redbooth session object with the correct authorization
+    # @param options [Hash] client options
+    # @option options [Proc] retry (the client will handle) Retry block to be executed when client hits an async endpoint
     def initialize(session, options={})
       raise RedboothRuby::AuthenticationError unless session.valid?
       @session = session

data/lib/redbooth-ruby/client_operations/metadata.rb

@@ -0,0 +1,32 @@
+module RedboothRuby
+  module ClientOperations
+    module Metadata
+
+      # Retrieves all available objects from the Redbooth API by searching by given
+      # key and value into the metadata API
+      #
+      # @param [Hash] options Options to pass to the API
+      # @return [Array] The available objects
+      def metadata(attributes = {})
+        response = RedboothRuby.request(:get, nil, 'metadata/search' , attributes, { session: session })
+        collection_from attributes, response, session
+      end
+
+      private
+
+      # Creates a collection object from the request and response params
+      #
+      # @param params [Hash] given request params
+      # @param response [RedboothRuby::Request::Response] response object
+      # @param session [RedboothRuby::Session] session Object
+      # @return [RedboothRuby::Request::Collection]
+      def collection_from(params, response, session)
+        RedboothRuby::Request::Collection.new(response: response,
+                                              resource: self,
+                                              session:  session,
+                                              params:   params,
+                                              method:   :metadata)
+      end
+    end
+  end
+end