podio 0.8.0 → 1.0.0

data/lib/podio/models/notification.rb

@@ -1,12 +1,14 @@
+# @see https://developers.podio.com/doc/notifications
 class Podio::Notification < ActivePodio::Base
   property :notification_id, :integer
-  property :user, :hash
   property :type, :string
   property :viewed_on, :datetime
   property :subscription_id, :integer
   property :created_on, :datetime
   property :data, :hash
   property :starred, :boolean
+  property :text, :string
+  property :text_short, :string
 
   # Only available when getting a single notification
   property :space, :hash
@@ -18,28 +20,31 @@ class Podio::Notification < ActivePodio::Base
 
   has_one :created_by, :class => 'ByLine'
   has_one :created_via, :class => 'Via'
-  has_one :user, :class => 'User'
 
   alias_method :id, :notification_id
   delegate_to_hash :data, :field, :value, :role, :message
-  
+
   class << self
     def find(id)
       member Podio.connection.get("/notification/#{id}").body
     end
 
+    # @see https://developers.podio.com/doc/notifications/mark-notification-as-viewed-22436
     def mark_as_viewed(id)
       Podio.connection.post("/notification/#{id}/viewed").status
     end
 
+    # @see https://developers.podio.com/doc/notifications/mark-all-notifications-as-viewed-58099
     def mark_all_as_viewed
       Podio.connection.post("/notification/viewed").status
     end
-    
+
+    # @see https://developers.podio.com/doc/notifications/star-notification-295910
     def star(id)
       Podio.connection.post("/notification/#{id}/star").status
     end
 
+    # @see https://developers.podio.com/doc/notifications/un-star-notification-295911
     def unstar(id)
       Podio.connection.delete("/notification/#{id}/star").status
     end

data/lib/podio/models/notification_group.rb

@@ -1,21 +1,24 @@
 # This class wraps the response from the Get Notifications API call
+# @see https://developers.podio.com/doc/notifications
 class Podio::NotificationGroup < ActivePodio::Base
   property :context, :hash
   property :notifications, :hash
-  delegate_to_hash :context, :ref, :data, :comment_count, :link, :space
+  delegate_to_hash :context, :ref, :data, :comment_count, :link, :space, :rights
 
   class << self
+    # @see https://developers.podio.com/doc/notifications/get-notifications-290777
     def find_all(options={})
       list Podio.connection.get { |req|
         req.url('/notification/', options)
       }.body
     end
 
+    # @see https://developers.podio.com/doc/notifications/get-notification-v2-2973737
     def find(id)
       member Podio.connection.get("/notification/#{id}/v2").body
     end
 
-
+    # @see https://developers.podio.com/doc/notifications/mark-notifications-as-viewed-by-ref-553653
     def mark_as_viewed_by_ref(ref_type, ref_id)
       Podio.connection.post("/notification/#{ref_type}/#{ref_id}/viewed").status
     end

data/lib/podio/models/o_auth.rb

@@ -1,5 +1,6 @@
+# @see https://developers.podio.com/doc/oauth-authorization
 class Podio::OAuth < ActivePodio::Base
-  
+
   class << self
     def authorize(attributes)
       response = Podio.connection.post do |req|
@@ -19,6 +20,7 @@ class Podio::OAuth < ActivePodio::Base
       response.body
     end
 
+    # @see https://developers.podio.com/doc/oauth-authorization/get-access-token-22359
     def get_access_token(attributes)
       response = Podio.connection.post do |req|
         req.url "/oauth/token"
@@ -28,5 +30,5 @@ class Podio::OAuth < ActivePodio::Base
       response.body
     end
   end
-  
+
 end

data/lib/podio/models/o_auth_client.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/oauth-authorization
 class Podio::OAuthClient < ActivePodio::Base
   include ActivePodio::Updatable
 
@@ -18,8 +19,6 @@ class Podio::OAuthClient < ActivePodio::Base
     self.class.update(self.auth_client_id, attributes)
   end
 
-  handle_api_errors_for :create, :update # Call must be made after the methods to handle have been defined
-  
   class << self
     def create(attributes)
       response = Podio.connection.post do |req|

data/lib/podio/models/organization.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/organizations
 class Podio::Organization < ActivePodio::Base
   include ActivePodio::Updatable
 
@@ -25,11 +26,14 @@ class Podio::Organization < ActivePodio::Base
   property :type, :string
   property :segment, :string
   property :segment_size, :integer
+  property :grants_count, :integer
+  property :allow_add_space, :boolean
 
   has_one :created_by, :class => 'ByLine'
 
   alias_method :id, :org_id
 
+  # @see https://developers.podio.com/doc/organizations/add-new-organization-22385
   def create
     attributes = Organization.create(:name => name, :logo => logo, :segment_size => segment_size)
     self.org_id = attributes['org_id']
@@ -37,13 +41,13 @@ class Podio::Organization < ActivePodio::Base
     self.url_label = attributes['url_label']
   end
 
+  # @see https://developers.podio.com/doc/organizations/update-organization-22386
   def update
     Organization.update(id, {:name => name, :logo => logo, :url_label => url_label, :billing_interval => billing_interval, :segment_size => segment_size})
   end
 
-  handle_api_errors_for :create, :update # Call must be made after the methods to handle have been defined
-
   class << self
+    # @see https://developers.podio.com/doc/organizations/update-organization-22386
     def update(id, attributes)
       response = Podio.connection.put do |req|
         req.url "/org/#{id}"
@@ -56,6 +60,7 @@ class Podio::Organization < ActivePodio::Base
       Podio.connection.delete("/org/#{id}").status
     end
 
+    # @see https://developers.podio.com/doc/organizations/add-new-organization-22385
     def create(attributes)
       response = Podio.connection.post do |req|
         req.url '/org/'
@@ -65,14 +70,20 @@ class Podio::Organization < ActivePodio::Base
       response.body
     end
 
+    # @see https://developers.podio.com/doc/organizations/get-organization-22383
     def find(id)
       member Podio.connection.get("/org/#{id}").body
     end
 
+    # @see https://developers.podio.com/doc/organizations/get-organization-by-url-22384
     def find_by_url(url)
       member Podio.connection.get("/org/url?url=#{url}").body
     end
 
+    def find_by_url_slug(org_slug)
+      member Podio.connection.get('/org/url', :org_slug => org_slug).body
+    end
+
     def validate_url_label(url_label)
       Podio.connection.post { |req|
         req.url '/org/url/validate'
@@ -80,18 +91,11 @@ class Podio::Organization < ActivePodio::Base
       }.body
     end
 
+    # @see https://developers.podio.com/doc/organizations/get-organizations-22344
     def find_all
       list Podio.connection.get("/org/").body
     end
 
-    def get_statistics(id)
-      Podio.connection.get("/org/#{id}/statistics").body
-    end
-
-    def get_member_count(id)
-      Podio.connection.get("/org/#{id}/member/count").body
-    end
-
     def get_login_report(id, options = {})
       Podio.connection.get { |req|
         req.url("/org/#{id}/report/login/", options)
@@ -114,5 +118,13 @@ class Podio::Organization < ActivePodio::Base
       list Podio.connection.get("/app_store/org/").body
     end
 
+    def get_statistics(id)
+      Podio.connection.get("/org/#{id}/statistics/v2").body
+    end
+    
+    def find_for_user(user_id)
+      list Podio.connection.get("/org/user/#{user_id}/").body
+    end
+  
   end
 end

data/lib/podio/models/organization_contact.rb

@@ -1,10 +1,11 @@
 # Encapsulates a primary contact for an organization, primarily used for billing purposes
+# @see https://developers.podio.com/doc/contacts
 class Podio::OrganizationContact < Podio::Profile
   include ActivePodio::Updatable
 
   property :org_id, :integer
   property :attention, :string # The name of the primary organization contact
-  
+
   alias_method :id, :org_id
 
   def save

data/lib/podio/models/organization_member.rb

@@ -1,4 +1,5 @@
 # Encapsulates a user's indirect membership (through spaces) of an organization.
+# @see https://developers.podio.com/doc/organizations
 class Podio::OrganizationMember < ActivePodio::Base
   property :profile, :hash
   property :admin, :boolean
@@ -9,9 +10,10 @@ class Podio::OrganizationMember < ActivePodio::Base
   has_one :contact, :class => 'Contact', :property => :profile
 
   delegate :user_id, :mail, :to => :user
-  delegate :name, :avatar, :link, :title, :organization, :title_and_org, :default_title, :avatar_url, :last_seen_on, :to => :contact
+  delegate :name, :avatar, :link, :title, :organization, :title_and_org, :default_title, :last_seen_on, :to => :contact
 
   class << self
+    # @see https://developers.podio.com/doc/organizations/get-organization-members-50661
     def find_all_for_org(org_id, options = {})
       list Podio.connection.get { |req|
         req.url("/org/#{org_id}/member/", options)
@@ -25,19 +27,30 @@ class Podio::OrganizationMember < ActivePodio::Base
       }.body
     end
 
+    # @see https://developers.podio.com/doc/organizations/get-organization-member-50908
     def find(org_id, user_id)
       member Podio.connection.get("/org/#{org_id}/member/#{user_id}").body
     end
 
-
+    # @see https://developers.podio.com/doc/organizations/end-organization-membership-50689
     def delete(org_id, user_id)
       Podio.connection.delete("/org/#{org_id}/member/#{user_id}").status
     end
 
+    # @see https://developers.podio.com/doc/organizations/end-organization-membership-19410652
+    def leave(org_id)
+      Podio.connection.post("/org/#{org_id}/leave").status
+    end
+
     def delete_info(org_id, user_id)
-      Podio.connection.get("/org/#{org_id}/member/#{user_id}/end_member_info").body
+      result = Podio.connection.get("/org/#{org_id}/member/#{user_id}/end_member_info").body
+      %w{ to_promote to_remove to_delete }.each do |type|
+        result[type].collect! { |member| self.klass_from_string('SpaceMember').new(member) } if result[type].present?
+      end
+      result
     end
 
+    # @see https://developers.podio.com/doc/organizations/add-organization-admin-50854
     def make_admin(org_id, user_id)
       response = Podio.connection.post do |req|
         req.url "/org/#{org_id}/admin/"
@@ -46,6 +59,7 @@ class Podio::OrganizationMember < ActivePodio::Base
       response.status
     end
 
+    # @see https://developers.podio.com/doc/organizations/remove-organization-admin-50855
     def remove_admin(org_id, user_id)
       Podio.connection.delete("/org/#{org_id}/admin/#{user_id}").status
     end

data/lib/podio/models/organization_profile.rb

@@ -1,4 +1,5 @@
 # Encapsulates an organization profile, primarily used for in app store
+# @see https://developers.podio.com/doc/organizations
 class Podio::OrganizationProfile < ActivePodio::Base
   include ActivePodio::Updatable
 
@@ -18,21 +19,23 @@ class Podio::OrganizationProfile < ActivePodio::Base
   alias_method :logo, :avatar
   alias_method :logo=, :avatar=
 
+  # @see https://developers.podio.com/doc/organizations/create-organization-app-store-profile-87819
   def create
     self.class.create(self.org_id, self.attributes)
   end
 
+  # @see https://developers.podio.com/doc/organizations/update-organization-app-store-profile-87805
   def update
     self.class.update(self.org_id, self.attributes)
   end
 
+  # @see https://developers.podio.com/doc/organizations/delete-organization-app-store-profile-87808
   def destroy
     self.class.delete(self.org_id)
   end
 
-  handle_api_errors_for :create, :update # Call must be made after the methods to handle have been defined
-
   class << self
+    # @see https://developers.podio.com/doc/organizations/get-organization-app-store-profile-87799
     def find(org_id)
       member Podio.connection.get("/org/#{org_id}/appstore").body
     end
@@ -41,6 +44,7 @@ class Podio::OrganizationProfile < ActivePodio::Base
       member Podio.connection.get("/app_store/org/#{url_label}/profile").body
     end
 
+    # @see https://developers.podio.com/doc/organizations/create-organization-app-store-profile-87819
     def create(org_id, attributes)
       response = Podio.connection.post do |req|
         req.url "/org/#{org_id}/appstore"
@@ -50,6 +54,7 @@ class Podio::OrganizationProfile < ActivePodio::Base
       response.body
     end
 
+    # @see https://developers.podio.com/doc/organizations/update-organization-app-store-profile-87805
     def update(org_id, attributes)
       response = Podio.connection.put do |req|
         req.url "/org/#{org_id}/appstore"
@@ -58,6 +63,7 @@ class Podio::OrganizationProfile < ActivePodio::Base
       response.status
     end
 
+    # @see https://developers.podio.com/doc/organizations/delete-organization-app-store-profile-87808
     def delete(org_id)
       Podio.connection.delete("/org/#{org_id}/appstore").status
     end

data/lib/podio/models/pin.rb

@@ -0,0 +1,27 @@
+class Podio::Pin < ActivePodio::Base
+  property :title, :string
+  property :type, :string
+  property :id, :integer
+  property :link, :string
+
+  alias :ref_id :id
+  alias :ref_type :type
+
+  class << self
+    def find_all(query = {})
+      Podio.connection.get("/pin/?#{query.to_param}").body.map(&method(:new))
+    end
+
+    def create(ref_type, ref_id)
+      new(Podio.connection.post("/pin/#{ref_type}/#{ref_id}").body)
+    end
+
+    def reorder(ref_type, ref_id, priority)
+      Podio.connection.post("/pin/#{ref_type}/#{ref_id}/reorder", priority)
+    end
+
+    def delete(ref_type, ref_id)
+      Podio.connection.delete("/pin/#{ref_type}/#{ref_id}")
+    end
+  end
+end

data/lib/podio/models/profile.rb

@@ -1,4 +1,5 @@
 # Serves as the base for Contacts and Organization Contacts
+# @see https://developers.podio.com/doc/contacts
 class Podio::Profile < ActivePodio::Base
   property :profile_id, :integer
   property :name, :string
@@ -44,30 +45,6 @@ class Podio::Profile < ActivePodio::Base
       }.body
     end
 
-    def top(options={})
-      list Podio.connection.get { |req|
-        req.url("/contact/top/", options)
-      }.body
-    end
-
-    def top_for_space(space_id, options={})
-      list Podio.connection.get { |req|
-        req.url("/contact/space/#{space_id}/top/", options)
-      }.body
-    end
-
-    def top_for_org(org_id, options={})
-      list Podio.connection.get { |req|
-        req.url("/contact/org/#{org_id}/top/", options)
-      }.body
-    end
-
-    def top_for_personal(options={})
-      list Podio.connection.get { |req|
-        req.url("/contact/personal/top/", options)
-      }.body
-    end
-
     def find(profile_id, options = {})
       result = Podio.connection.get do |req|
         req.url("/contact/#{profile_id}/v2", options)
@@ -80,8 +57,9 @@ class Podio::Profile < ActivePodio::Base
       end
     end
 
+    # @see https://developers.podio.com/doc/contacts/get-organization-contacts-22401
     def find_all_for_org(org_id, options={})
-      options[:type] ||= 'full'
+      options[:view] ||= 'full'
       options[:exclude_self] = (options[:exclude_self] == false ? "0" : "1" )
 
       list Podio.connection.get { |req|
@@ -89,8 +67,9 @@ class Podio::Profile < ActivePodio::Base
       }.body
     end
 
+    # @see https://developers.podio.com/doc/contacts/get-space-contacts-22414
     def find_all_for_space(space_id, options={})
-      options[:type] ||= 'full'
+      options[:view] ||= 'full'
       options[:exclude_self] = (options[:exclude_self] == false ? "0" : "1" )
 
       list Podio.connection.get { |req|
@@ -98,22 +77,7 @@ class Podio::Profile < ActivePodio::Base
       }.body
     end
 
-    def find_all_for_connection(connection_id, options={})
-      options[:type] ||= 'full'
-
-      list Podio.connection.get { |req|
-        req.url("/contact/connection/#{connection_id}", options)
-      }.body
-    end
-
-    def find_all_for_connection_type(connection_type, options={})
-      options[:type] ||= 'full'
-
-      list Podio.connection.get { |req|
-        req.url("/contact/connection/#{connection_type}", options)
-      }.body
-    end
-
+    # @see https://developers.podio.com/doc/contacts/get-linked-account-contacts-6214688
     def find_all_for_linked_account(id, options={})
       list Podio.connection.get { |req|
         req.url("/contact/linked_account/#{id}", options)
@@ -124,10 +88,17 @@ class Podio::Profile < ActivePodio::Base
       member Podio.connection.get("/org/#{org_id}/billing").body
     end
 
+    # @see https://developers.podio.com/doc/contacts/get-user-contact-60514
     def find_for_user(user_id)
       member Podio.connection.get("/contact/user/#{user_id}").body
     end
 
+    # @see https://developers.podio.com/doc/contacts/get-user-contact-60514
+    def find_all_for_users(user_ids)
+      list Podio.connection.get("/contact/user/#{user_ids}").body
+    end
+
+    # @see https://developers.podio.com/doc/contacts/get-vcard-213496
     def vcard(profile_id)
       Podio.connection.get("/contact/#{profile_id}/vcard").body
     end
@@ -136,28 +107,24 @@ class Podio::Profile < ActivePodio::Base
       Podio.connection.get("/contact/totals/").body
     end
 
+    # @see https://developers.podio.com/doc/contacts/get-space-contact-totals-67508
     def totals_by_space_v2(space_id)
       Podio.connection.get("/contact/space/#{space_id}/totals/space").body
     end
 
+    # @see https://developers.podio.com/doc/contacts/get-contact-totals-60467
     def totals_by_org_and_space
       Podio.connection.get("/contact/totals/v2/").body
     end
 
+    # @see https://developers.podio.com/doc/contacts/get-skills-1346872
     def skills(options)
       Podio.connection.get { |req|
         req.url("/contact/skill/", options)
       }.body
     end
 
-    def totals_by_space(space_id, options = {})
-      options[:exclude_self] = (options[:exclude_self] == false ? "0" : "1" )
-
-      Podio.connection.get { |req|
-        req.url("/contact/space/#{space_id}/totals/", options)
-      }.body
-    end
-
+    # @see https://developers.podio.com/doc/contacts/create-space-contact-65590
     def create_space_contact(space_id, attributes)
       response = Podio.connection.post do |req|
         req.url "/contact/space/#{space_id}/"
@@ -167,10 +134,12 @@ class Podio::Profile < ActivePodio::Base
       response.body
     end
 
+    # @see https://developers.podio.com/doc/contacts/delete-contact-s-60560
     def delete_contact(profile_id)
       Podio.connection.delete("/contact/#{profile_id}").body
     end
 
+    # @see https://developers.podio.com/doc/contacts/update-contact-60556
     def update_contact(profile_id, attributes)
       response = Podio.connection.put do |req|
         req.url "/contact/#{profile_id}"