podio 0.8.0 → 1.0.0

data/lib/podio/models/space_member.rb

@@ -1,9 +1,12 @@
 # Encapsulates a user's membership of a space.
+# @see https://developers.podio.com/doc/space-members
 class Podio::SpaceMember < ActivePodio::Base
+  property :employee, :boolean
   property :role, :string
   property :invited_on, :datetime
   property :started_on, :datetime
   property :ended_on, :datetime
+  property :grants, :integer
 
   has_one :user, :class => 'User'
   has_one :contact, :class => 'Contact', :property => :profile
@@ -12,19 +15,29 @@ class Podio::SpaceMember < ActivePodio::Base
   delegate :user_id, :name, :to => :contact
 
   alias_method :id, :user_id
+  
+  def employee?
+    employee
+  end
+  
+  def external?
+    !employee
+  end
 
   class << self
+    # @see https://developers.podio.com/doc/space-members/get-space-members-by-role-68043
     def find_all_for_role(space_id, role)
       list Podio.connection.get { |req|
         req.url("/space/#{space_id}/member/#{role}/")
       }.body
     end
 
+    # @see https://developers.podio.com/doc/space-members/get-space-membership-22397
     def find_membership(space_id, user_id)
       response = Podio.connection.get { |req|
-        req.url("/space/#{space_id}/member/#{user_id}")
+        req.url("/space/#{space_id}/member/#{user_id}/v2")
       }
-      response.body
+      member response.body
     end
 
     def find_all_ended(space_id)
@@ -33,10 +46,17 @@ class Podio::SpaceMember < ActivePodio::Base
       }.body
     end
 
+    # @see https://developers.podio.com/doc/space-members/get-active-members-of-space-22395
     def find_all(space_id, options = {})
       list Podio.connection.get("/space/#{space_id}/member/", options).body
     end
 
+    # @see https://developers.podio.com/doc/space-members/get-space-members-v2-19350328
+    def find_all_for_space(space_id, options = {})
+      list Podio.connection.get("/space/#{space_id}/member/v2/", options).body
+    end
+
+    # @see https://developers.podio.com/doc/space-members/update-space-memberships-22398
     def update_role(space_id, user_id, role)
       response = Podio.connection.put do |req|
         req.url "/space/#{space_id}/member/#{user_id}"
@@ -45,28 +65,41 @@ class Podio::SpaceMember < ActivePodio::Base
       response.status
     end
 
+    # @see https://developers.podio.com/doc/space-members/end-space-memberships-22399
     def end_membership(space_id, user_id)
       Podio.connection.delete("/space/#{space_id}/member/#{user_id}").status
     end
 
-    def find_top_contacts(space_id)
-      result = Podio.connection.get("/space/#{space_id}/member/top/").body
+    # @see https://developers.podio.com/doc/space-members/get-top-users-on-space-22461
+    def find_top_contacts(space_id, options = {})
+      result = Podio.connection.get("/space/#{space_id}/member/top/", options).body
       %w(employee external).each do |section|
         result[section]['profiles'].map! { |profile| Contact.new(profile) } if result[section].present? && result[section]['profiles'].present?
       end
       result
     end
 
+    def find_top_active(space_id, options = {})
+      response = Podio.connection.get("/space/#{space_id}/member/top_active/", options)
+      response.body.map { |profile| Contact.new(profile) }
+    end
+
     def find_memberships_for_user_in_org(org_id, user_id)
       list Podio.connection.get("/org/#{org_id}/member/#{user_id}/space_member/").body
     end
 
+    # @see https://developers.podio.com/doc/space-members/request-space-membership-6146231
     def request_membership(space_id)
       Podio.connection.post("/space/#{space_id}/member_request/").status
     end
 
+    # @see https://developers.podio.com/doc/space-members/accept-space-membership-request-6146271
     def accept_membership_request(space_id, space_member_request_id)
       Podio.connection.post("/space/#{space_id}/member_request/#{space_member_request_id}/accept").status
     end
+
+    def get_members_count(space_id)
+      Podio.connection.get("/space/#{space_id}/member/total").body
+    end
   end
 end

data/lib/podio/models/status.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/status
 class Podio::Status < ActivePodio::Base
   property :status_id, :integer
   property :value, :string
@@ -7,14 +8,21 @@ class Podio::Status < ActivePodio::Base
   property :alerts, :array
   property :ratings, :hash
   property :subscribed, :boolean
+  property :pinned, :boolean
   property :user_ratings, :hash
+  property :rights, :array
+  property :is_liked, :boolean
+  property :like_count, :integer
+  property :subscribed_count, :integer
+  property :push, :hash
+  property :presence, :hash
 
   # Properties for create
   property :file_ids, :array
   property :embed_id, :integer
   property :embed_file_id, :integer
 
-  has_one :created_by, :class => 'Contact'
+  has_one :created_by, :class => 'ByLine'
   has_one :created_via, :class => 'Via'
   has_one :embed, :class => 'Embed'
   has_one :embed_file, :class => 'FileAttachment'
@@ -24,30 +32,34 @@ class Podio::Status < ActivePodio::Base
   has_many :shares, :class => 'AppStoreShare'
   has_many :files, :class => 'FileAttachment'
   has_many :questions, :class => 'Question'
-  
+
   alias_method :id, :status_id
 
+  # @see https://developers.podio.com/doc/status/delete-a-status-message-22339
   def destroy
     Status.delete(self.id)
   end
-  
+
   class << self
+    # @see https://developers.podio.com/doc/status/get-status-message-22337
     def find(id)
       member Podio.connection.get("/status/#{id}").body
     end
 
-    def create(space_id, attributes)
+    # @see https://developers.podio.com/doc/status/add-new-status-message-22336
+    def create(space_id, attributes=[], options={})
       response = Podio.connection.post do |req|
-        req.url "/status/space/#{space_id}/"
+        req.url("/status/space/#{space_id}/", options)
         req.body = attributes
       end
 
       response.body['status_id']
     end
-    
+
+    # @see https://developers.podio.com/doc/status/delete-a-status-message-22339
     def delete(id)
       Podio.connection.delete("/status/#{id}").body
     end
   end
-  
-end
+
+end

data/lib/podio/models/stream_activity_group.rb

@@ -0,0 +1,40 @@
+# @see https://developers.podio.com/doc/stream
+class Podio::StreamActivityGroup < ActivePodio::Base
+
+  property :group_id, :integer
+  property :kind, :string
+  property :type, :string
+  property :created_on, :datetime
+  property :activities, :array
+
+  has_one :data_ref, :class => 'Reference'
+  has_one :created_by, :class => 'ByLine'
+  has_one :created_via, :class => 'Via'
+
+  has_many :authors, :class => 'ByLine'
+
+  alias_method :id, :group_id
+
+  class << self
+
+    def find_by_ref(ref_type, ref_id, options = {})
+      list Podio.connection.get { |req|
+        req.url("/stream/#{ref_type}/#{ref_id}/activity_group", options)
+      }.body
+    end
+
+    def find_by_event_id(ref_type, ref_id, event_id, options={})
+      member Podio.connection.get { |req|
+        req.url("/stream/#{ref_type}/#{ref_id}/group/#{event_id}", options)
+      }.body
+    end
+
+    def find_for_data_ref(ref_type, ref_id, data_ref_type, data_ref_id, options={})
+      member Podio.connection.get { |req|
+        req.url("/stream/#{ref_type}/#{ref_id}/activity_group/#{data_ref_type}/#{data_ref_id}", options)
+      }.body
+    end
+
+  end
+
+end

data/lib/podio/models/stream_mute.rb

@@ -1,26 +1,25 @@
+# @see https://developers.podio.com/doc/stream
 class Podio::StreamMute < ActivePodio::Base
   property :id, :integer
   property :type, :string
   property :title, :string
   property :data, :hash
-  property :item, :boolean
-  property :status, :boolean
-  property :task, :boolean
 
   class << self
+    # @see https://developers.podio.com/doc/stream/get-mutes-in-global-stream-62742
     def find_all
-      list Podio.connection.get('/stream/mute/v2/').body      
+      list Podio.connection.get('/stream/mute/v2/').body
     end
 
-    def create(scope_type, scope_id, object_type = nil)
+    # @see https://developers.podio.com/doc/stream/mute-object-from-global-stream-79424
+    def create(scope_type, scope_id)
       path = "/stream/mute/#{scope_type}/#{scope_id}"
-      path += "/#{object_type}" unless object_type.nil?
       Podio.connection.post(path).status
     end
 
-    def delete(scope_type, scope_id, object_type = nil)
+    # @see https://developers.podio.com/doc/stream/unmute-objects-from-the-global-stream-79426
+    def delete(scope_type, scope_id)
       path = "/stream/mute/#{scope_type}/#{scope_id}"
-      path += "/#{object_type}" unless object_type.nil?
       Podio.connection.delete(path).status
     end
   end

data/lib/podio/models/stream_object.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/stream
 class Podio::StreamObject < ActivePodio::Base
   property :id, :integer
   property :type, :string
@@ -15,7 +16,7 @@ class Podio::StreamObject < ActivePodio::Base
   has_one :app, :class => 'Application'
   has_one :space, :class => 'Space'
   has_one :org, :class => 'Organization'
-  
+
   has_many :comments, :class => 'Comment'
   has_many :files, :class => 'FileAttachment'
   has_many :activity, :class => 'Activity'
@@ -23,44 +24,51 @@ class Podio::StreamObject < ActivePodio::Base
   alias_method :activities, :activity
 
   class << self
+    # @see https://developers.podio.com/doc/stream/get-global-stream-80012
     def find_all(options={})
       list Podio.connection.get { |req|
-        req.url("/stream/v2/", options)
-      }.body      
+        req.url("/stream/", options)
+      }.body
     end
 
+    # @see https://developers.podio.com/doc/stream/get-space-stream-80039
     def find_all_by_space_id(space_id, options={})
       list Podio.connection.get { |req|
         req.url("/stream/space/#{space_id}/v2/", options)
-      }.body      
+      }.body
     end
 
+    # @see https://developers.podio.com/doc/stream/get-organization-stream-80038
     def find_all_by_org_id(org_id, options={})
       list Podio.connection.get { |req|
         req.url("/stream/org/#{org_id}/v2/", options)
-      }.body      
+      }.body
     end
 
+    # @see https://developers.podio.com/doc/stream/get-app-stream-264673
     def find_all_by_app_id(app_id, options={})
       list Podio.connection.get { |req|
         req.url("/stream/app/#{app_id}/", options)
-      }.body      
+      }.body
     end
 
+    # @see https://developers.podio.com/doc/stream/get-user-stream-1289318
     def find_all_by_user_id(user_id, options={})
       list Podio.connection.get { |req|
         req.url("/stream/user/#{user_id}/", options)
-      }.body      
+      }.body
     end
-    
+
+    # @see https://developers.podio.com/doc/stream/get-stream-object-80054
     def find_by_ref(ref_type, ref_id)
       member Podio.connection.get("/stream/#{ref_type}/#{ref_id}/v2").body
     end
-    
+
+    # @see https://developers.podio.com/doc/stream/get-personal-stream-1656647
     def find_all_personal(options={})
       list Podio.connection.get { |req|
         req.url("/stream/personal/", options)
-      }.body      
-    end    
+      }.body
+    end
   end
 end

data/lib/podio/models/subscription.rb

@@ -1,31 +1,37 @@
+# @see https://developers.podio.com/doc/subscriptions
 class Podio::Subscription < ActivePodio::Base
   property :started_on, :datetime
   property :notifications, :integer
   property :ref, :hash
 
   class << self
+    # @see https://developers.podio.com/doc/subscriptions/get-subscription-by-id-22446
     def find(id)
       member Podio.connection.get("/subscription/#{id}").body
     end
 
+    # @see https://developers.podio.com/doc/subscriptions/get-subscription-by-reference-22408
     def find_by_reference(ref_type, ref_id)
       member Podio.connection.get("/subscription/#{ref_type}/#{ref_id}").body
     end
 
+    # @see https://developers.podio.com/doc/subscriptions/subscribe-22409
     def create(ref_type, ref_id)
       Podio.connection.post("/subscription/#{ref_type}/#{ref_id}").body['subscription_id']
     end
 
+    # @see https://developers.podio.com/doc/subscriptions/unsubscribe-by-id-22445
     def delete(id)
       Podio.connection.delete("/subscription/#{id}")
     end
 
+    # @see https://developers.podio.com/doc/subscriptions/unsubscribe-by-reference-22410
     def delete_by_reference(ref_type, ref_id)
       Podio.connection.delete("/subscription/#{ref_type}/#{ref_id}")
     end
 
     def find_subscribers_by_reference(ref_type, ref_id)
-      User.list Podio.connection.get("/subscription/#{ref_type}/#{ref_id}/").body
+      User.list Podio.connection.get("/subscription/#{ref_type}/#{ref_id}/user").body
     end
   end
 end

data/lib/podio/models/tag.rb

@@ -1,8 +1,10 @@
+# @see https://developers.podio.com/doc/tags
 class Podio::Tag < ActivePodio::Base
   property :count, :integer
   property :text, :string
-  
+
   class << self
+    # @see https://developers.podio.com/doc/tags/create-tags-22464
     def create(tagable_type, tagable_id, attributes)
       response = Podio.connection.post do |req|
         req.url "/tag/#{tagable_type}/#{tagable_id}/"
@@ -12,6 +14,7 @@ class Podio::Tag < ActivePodio::Base
       response.body
     end
 
+    # @see https://developers.podio.com/doc/tags/update-tags-39859
     def update(tagable_type, tagable_id, attributes)
       response = Podio.connection.put do |req|
         req.url "/tag/#{tagable_type}/#{tagable_id}/"
@@ -21,11 +24,13 @@ class Podio::Tag < ActivePodio::Base
       response.body
     end
 
+    # @see https://developers.podio.com/doc/tags/get-tags-on-app-22467
     def find_by_app(app_id, limit, text)
       text = CGI.escape(text) if text
       list Podio.connection.get("/tag/app/#{app_id}/?limit=#{limit}&text=#{text}").body
     end
 
+    # @see https://developers.podio.com/doc/tags/get-tags-on-app-top-68485
     def find_top_by_app(app_id, limit, text)
       text = CGI.escape(text) if text
       Podio.connection.get("/tag/app/#{app_id}/top/?limit=#{limit}&text=#{text}").body

data/lib/podio/models/tag_search.rb

@@ -1,10 +1,11 @@
+# @see https://developers.podio.com/doc/tags
 class Podio::TagSearch < ActivePodio::Base
   property :id, :integer
   property :type, :string
   property :title, :string
   property :link, :string
   property :created_on, :datetime
-  
+
   class << self
     def search_by_space(space_id, text)
       text = CGI.escape(text) if text

data/lib/podio/models/task.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/tasks
 class Podio::Task < ActivePodio::Base
   include ActivePodio::Updatable
 
@@ -6,10 +7,11 @@ class Podio::Task < ActivePodio::Base
   property :group, :string
   property :text, :string
   property :description, :string
+  property :rights, :array
   property :private, :boolean
   property :due_date, :date
   property :due_time, :time
-  property :due_on, :datetime, :convert_incoming_local_datetime_to_utc => true
+  property :due_on, :datetime
   property :responsible, :hash
   property :space_id, :integer
   property :link, :string
@@ -19,6 +21,11 @@ class Podio::Task < ActivePodio::Base
   property :label_ids, :array # when inputting tasks
   property :labels, :array # when outputting tasks
   property :external_id, :string
+  property :subscribed, :boolean
+  property :subscribed_count, :integer
+  property :pinned, :boolean
+  property :push, :hash
+  property :presence, :hash
 
   # old references
   property :ref_type, :string
@@ -43,6 +50,7 @@ class Podio::Task < ActivePodio::Base
 
   alias_method :id, :task_id
 
+  # @see https://developers.podio.com/doc/tasks/create-task-22419
   def create
     result = self.create_multiple # Could return false if API call failed
     self.task_id = result.first.id if result
@@ -58,63 +66,83 @@ class Podio::Task < ActivePodio::Base
     end
   end
 
+  # @see https://developers.podio.com/doc/tasks/delete-task-77179
   def destroy
     self.class.delete(self.id)
   end
 
+  # @see https://developers.podio.com/doc/tasks/update-task-reference-170733
   def update_reference(ref_type, ref_id)
     self.class.update_reference(self.id, ref_type, ref_id)
   end
 
+  # @see https://developers.podio.com/doc/tasks/remove-task-reference-6146114
   def delete_reference
     self.class.delete_reference(self.id)
   end
 
+  # @see https://developers.podio.com/doc/tasks/update-task-labels-151769
   def update_labels(label_ids)
     self.class.update_labels(self.id, label_ids)
   end
 
+  # @see https://developers.podio.com/doc/tasks/complete-task-22432
   def complete
     self.class.complete(self.id)
   end
 
+  # @see https://developers.podio.com/doc/tasks/incomplete-task-22433
   def uncomplete
     self.class.incomplete(self.id)
   end
 
+  # @see https://developers.podio.com/doc/tasks/rank-task-81015
   def rank(previous_task, next_task)
     self.class.rank(self.id, previous_task && previous_task.to_i, next_task && next_task.to_i)
   end
 
-  handle_api_errors_for :create_multiple, :destroy, :complete, :uncomplete, :update_reference # Call must be made after the methods to handle have been defined
-
   class << self
-    def create(attributes)
+    # @see https://developers.podio.com/doc/tasks/create-task-22419
+    def create(attributes, options = {})
       response = Podio.connection.post do |req|
-        req.url "/task/"
+        req.url("/task/", options)
         req.body = attributes
       end
 
       list [response.body].flatten
     end
 
-    def create_with_ref(ref_type, ref_id, attributes)
+    # @see https://developers.podio.com/doc/tasks/create-task-with-reference-22420
+    def create_with_ref(ref_type, ref_id, attributes, options = {})
       response = Podio.connection.post do |req|
-        req.url "/task/#{ref_type}/#{ref_id}/"
+        req.url("/task/#{ref_type}/#{ref_id}/", options)
         req.body = attributes
       end
 
       list [response.body].flatten
     end
 
+    # @see https://developers.podio.com/doc/tasks/update-task-10583674
+    def update(id, attributes, options = {})
+      response = Podio.connection.put do |req|
+        req.url("/task/#{id}", options)
+        req.body = attributes
+      end
+
+      member response.body
+    end
+
+    # @see https://developers.podio.com/doc/tasks/update-task-description-76982
     def update_description(id, description)
       Podio.connection.put("/task/#{id}/description", {:description => description}).status
     end
 
+    # @see https://developers.podio.com/doc/tasks/update-task-text-22428
     def update_text(id, text)
       Podio.connection.put("/task/#{id}/text", {:text => text}).status
     end
 
+    # @see https://developers.podio.com/doc/tasks/update-task-private-22434
     def update_private(id, private_flag)
       Podio.connection.put("/task/#{id}/private", {:private => private_flag}).status
     end
@@ -123,88 +151,116 @@ class Podio::Task < ActivePodio::Base
       Podio.connection.put("/task/#{id}/due_date", {:due_date => due_date}).status
     end
 
+    # @see https://developers.podio.com/doc/tasks/update-task-due-on-3442633
     def update_due_on(id, options)
       Podio.connection.put("/task/#{id}/due_on", options).status
     end
 
+    # @see https://developers.podio.com/doc/tasks/assign-task-22412
     def update_assignee(id, user_id)
       Podio.connection.post("/task/#{id}/assign", {:responsible => user_id}).status
     end
 
+    # @see https://developers.podio.com/doc/tasks/update-task-reference-170733
     def update_reference(id, ref_type, ref_id)
       Podio.connection.put("/task/#{id}/ref", {:ref_type => ref_type, :ref_id => ref_id}).status
     end
 
+    # @see https://developers.podio.com/doc/tasks/remove-task-reference-6146114
     def delete_reference(task_id)
       Podio.connection.delete("/task/#{task_id}/ref").status
     end
 
+    # @see https://developers.podio.com/doc/tasks/update-task-labels-151769
     def update_labels(id, label_ids)
       Podio.connection.put("/task/#{id}/label/", label_ids).status
     end
 
+    # @see https://developers.podio.com/doc/tasks/delete-task-77179
     def delete(id)
       Podio.connection.delete("/task/#{id}").status
     end
 
+    # @see https://developers.podio.com/doc/tasks/complete-task-22432
     def complete(id)
       Podio.connection.post("/task/#{id}/complete").body
     end
 
+    # @see https://developers.podio.com/doc/tasks/incomplete-task-22433
     def incomplete(id)
       Podio.connection.post("/task/#{id}/incomplete").body
     end
 
+    # @see https://developers.podio.com/doc/tasks/rank-task-81015
     def rank(id, before_task_id, after_task_id)
       Podio.connection.post("/task/#{id}/rank", {:before => before_task_id, :after => after_task_id}).body
     end
 
-    def find(id)
-      member Podio.connection.get("/task/#{id}").body
+    # @see https://developers.podio.com/doc/tasks/get-task-22413
+    def find(id, options = {})
+      member Podio.connection.get("/task/#{id}", options).body
     end
 
+    # @see https://developers.podio.com/doc/tasks/get-tasks-with-reference-22426
     def find_for_reference(ref_type, ref_id)
       list Podio.connection.get("/task/#{ref_type}/#{ref_id}/").body
     end
 
+    # @see https://developers.podio.com/doc/tasks/get-tasks-77949
     def find_all(options={})
       list Podio.connection.get { |req|
         req.url('/task/', options)
       }.body
     end
 
-    def find_summary
-      response = Podio.connection.get("/task/summary").body
+    # @see https://developers.podio.com/doc/tasks/get-task-summary-1612017
+    def find_summary(options={})
+      response = Podio.connection.get { |req|
+        req.url("/task/summary", options)
+      }.body
       response['overdue']['tasks'] = list(response['overdue']['tasks'])
       response['today']['tasks'] = list(response['today']['tasks'])
       response['other']['tasks'] = list(response['other']['tasks'])
       response
     end
 
-    def find_summary_for_org(org_id, limit=nil)
-      response = Podio.connection.get("/task/org/#{org_id}/summary" +
-                                      ((limit != nil) ? "?limit=#{limit}" : "")).body
+    # @see https://developers.podio.com/doc/tasks/get-task-summary-for-organization-1612063
+    def find_summary_for_org(org_id, options={})
+      response = Podio.connection.get { |req|
+        req.url("/task/org/#{org_id}/summary", options)
+      }.body
       response['overdue']['tasks'] = list(response['overdue']['tasks'])
       response['today']['tasks'] = list(response['today']['tasks'])
       response['other']['tasks'] = list(response['other']['tasks'])
       response
     end
 
-    def find_summary_for_reference(ref_type, ref_id)
-      response = Podio.connection.get("/task/#{ref_type}/#{ref_id}/summary").body
+    # @see https://developers.podio.com/doc/tasks/get-task-summary-for-reference-1657980
+    def find_summary_for_reference(ref_type, ref_id, options={})
+      response = Podio.connection.get { |req|
+        req.url("/task/#{ref_type}/#{ref_id}/summary", options)
+      }.body
       response['overdue']['tasks'] = list(response['overdue']['tasks'])
       response['today']['tasks'] = list(response['today']['tasks'])
       response['other']['tasks'] = list(response['other']['tasks'])
       response
     end
 
-    def find_personal_summary
-      response = Podio.connection.get("/task/personal/summary").body
+    # @see https://developers.podio.com/doc/tasks/get-task-summary-for-personal-1657217
+    def find_personal_summary(options={})
+      response = Podio.connection.get { |req|
+        req.url("/task/personal/summary", options)
+      }.body
       response['overdue']['tasks'] = list(response['overdue']['tasks'])
       response['today']['tasks'] = list(response['today']['tasks'])
       response['other']['tasks'] = list(response['other']['tasks'])
       response
     end
 
+    # @see https://developers.podio.com/doc/tasks/get-task-count-38316458
+    def count_by_ref(ref_type, ref_id)
+      Podio.connection.get("/task/#{ref_type}/#{ref_id}/count").body['count']
+    end
+
   end
 end