podio 0.8.0 → 1.0.0

data/lib/podio/models/embed.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/embeds
 class Podio::Embed < ActivePodio::Base
 
   property :embed_id, :integer
@@ -6,10 +7,8 @@ class Podio::Embed < ActivePodio::Base
   property :type, :string
   property :title, :string
   property :description, :string
-  property :created_on, :datetime
-  property :provider_name, :string
   property :embed_html, :string
-  property :embed_height, :boolean
+  property :embed_height, :integer
   property :embed_width, :integer
 
   has_many :files, :class => 'FileAttachment'
@@ -18,6 +17,7 @@ class Podio::Embed < ActivePodio::Base
 
   class << self
 
+    # @see https://developers.podio.com/doc/embeds/add-an-embed-726483
     def create(url)
       response = Podio.connection.post do |req|
         req.url '/embed/'
@@ -31,4 +31,4 @@ class Podio::Embed < ActivePodio::Base
     end
 
   end
-end
+end

data/lib/podio/models/experiment.rb

@@ -0,0 +1,71 @@
+class Podio::Experiment < ActivePodio::Base
+
+  class << self
+
+    def create_subject(attributes)
+      response = Podio.client.trusted_connection.post do |req|
+        req.url '/experiment/subject/'
+        req.body = attributes
+      end
+      response.body['identifier']
+    end
+
+    def associate_subject(identifier)
+      Podio.connection.post("/experiment/subject/#{identifier}/associate")
+    end
+
+    def find_variation_for_subject(identifier, experiment, supported_variations)
+      response = Podio.client.trusted_connection.post do |req|
+        req.url "/experiment/#{experiment}/subject/#{identifier}"
+        req.body = supported_variations
+      end
+      response.body['variation']
+    end
+
+    def find_variation_for_user(experiment, supported_variations)
+      response = Podio.connection.post do |req|
+        req.url "/experiment/#{experiment}/user"
+        req.body = supported_variations
+      end
+      response.body['variation']
+    end
+
+    def find_all
+      Podio.connection.get('/experiment/').body
+    end
+
+    def create_variation(experiment, variation)
+      Podio.connection.post("/experiment/#{experiment}/variation/#{variation}")
+    end
+
+    def activate_variation(experiment, variation)
+      Podio.connection.post("/experiment/#{experiment}/variation/#{variation}/activate")
+    end
+
+    def deactivate_variation(experiment, variation)
+      Podio.connection.post("/experiment/#{experiment}/variation/#{variation}/deactivate")
+    end
+
+    def assign_variation(experiment, variation, attributes)
+      Podio.connection.post do |req|
+        req.url "/experiment/#{experiment}/variation/#{variation}/assign"
+        req.body = attributes
+      end
+    end
+
+    def combined(supported_variations_map, identifier=nil, attributes={})
+      connection = Podio.client.oauth_token ? Podio.client.connection : Podio.client.trusted_connection
+
+      body = {
+        "experiments" => supported_variations_map
+      }
+
+      body["identifier"] = identifier if identifier.present?
+
+      connection.post do |req|
+        req.url "/experiment/combined"
+        req.body = body
+      end.body
+    end
+  end
+end

data/lib/podio/models/external_file.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/files
 class Podio::ExternalFile < ActivePodio::Base
   property :external_file_id, :string
   property :name, :string
@@ -17,10 +18,14 @@ class Podio::ExternalFile < ActivePodio::Base
       }.body
     end
 
-    def create_from_external_file_id(linked_account_id, external_file_id)
+
+    def create_from_external_file_id(linked_account_id, external_file_id, preserve_permissions=false)
       response = Podio.client.connection.post do |req|
         req.url "/file/linked_account/#{linked_account_id}/"
-        req.body = { :external_file_id => external_file_id }
+        req.body = {
+            :external_file_id     => external_file_id,
+            :preserve_permissions => preserve_permissions
+        }
       end
 
       member response.body

data/lib/podio/models/file_attachment.rb

@@ -1,6 +1,8 @@
+# @see https://developers.podio.com/doc/files
 class Podio::FileAttachment < ActivePodio::Base
   property :file_id, :integer
   property :link, :string
+  property :link_target, :string
   property :perma_link, :string
   property :thumbnail_link, :string
   property :hosted_by, :string
@@ -11,10 +13,15 @@ class Podio::FileAttachment < ActivePodio::Base
   property :context, :hash
   property :created_on, :datetime
   property :rights, :array
+  property :subscribed, :boolean
+  property :subscribed_count, :integer
+  property :push, :hash
+  property :presence, :hash
 
   has_one :created_by, :class => 'ByLine'
   has_one :created_via, :class => 'Via'
   has_many :replaces, :class => 'FileAttachment'
+  has_many :comments, :class => 'Comment'
 
   alias_method :id, :file_id
 
@@ -30,8 +37,13 @@ class Podio::FileAttachment < ActivePodio::Base
     'file'
   end
 
+  def raw_data
+    Podio.connection.get(self.link).body
+  end
+
   class << self
     # Accepts an open file stream along with a file name and uploads the file to Podio
+    # @see https://developers.podio.com/doc/files/upload-file-1004361
     def upload(file_stream, file_name)
       response = Podio.client.connection.post do |req|
         req.options[:timeout] = 1200
@@ -53,6 +65,7 @@ class Podio::FileAttachment < ActivePodio::Base
     end
 
     # Attach a file to an existing reference
+    # @see https://developers.podio.com/doc/files/attach-file-22518
     def attach(id, ref_type, ref_id)
       Podio.connection.post do |req|
         req.url "/file/#{id}/attach"
@@ -60,40 +73,48 @@ class Podio::FileAttachment < ActivePodio::Base
       end
     end
 
+    # @see https://developers.podio.com/doc/files/copy-file-89977
     def copy(id)
       Podio.connection.post("/file/#{id}/copy").body['file_id']
     end
 
+    # @see https://developers.podio.com/doc/files/delete-file-22453
     def delete(id)
       Podio.connection.delete("/file/#{id}")
     end
 
+    # @see https://developers.podio.com/doc/files/get-file-22451
     def find(id)
       member Podio.connection.get("/file/#{id}").body
     end
 
+    # @see https://developers.podio.com/doc/files/download-file-1004147
     def find_raw(id)
       Podio.client.connection.get("/file/#{id}/raw").body
     end
 
+    # @see https://developers.podio.com/doc/files/get-files-on-app-22472
     def find_for_app(app_id, options={})
       list Podio.connection.get { |req|
         req.url("/file/app/#{app_id}/", options)
       }.body
     end
 
+    # @see https://developers.podio.com/doc/files/get-files-on-space-22471
     def find_for_space(space_id, options={})
       list Podio.connection.get { |req|
         req.url("/file/space/#{space_id}/", options)
       }.body
     end
 
+    # @see https://developers.podio.com/doc/files/get-latest-files-on-app-22473
     def find_latest_for_app(app_id, options={})
       list Podio.connection.get { |req|
         req.url("/file/app/#{app_id}/latest/", options)
       }.body
     end
 
+    # @see https://developers.podio.com/doc/files/get-latest-files-on-space-22470
     def find_latest_for_space(space_id, options={})
       list Podio.connection.get { |req|
         req.url("/file/space/#{space_id}/latest/", options)
@@ -106,6 +127,7 @@ class Podio::FileAttachment < ActivePodio::Base
       }.body
     end
 
+    # @see https://developers.podio.com/doc/files/replace-file-22450
     def replace(old_file_id, new_file_id)
       Podio.connection.post { |req|
         req.url "/file/#{new_file_id}/replace"
@@ -113,6 +135,7 @@ class Podio::FileAttachment < ActivePodio::Base
       }.body
     end
 
+    # @see https://developers.podio.com/doc/files/update-file-22454
     def update(id, description)
       Podio.connection.put { |req|
         req.url "/file/#{file_id}"

data/lib/podio/models/form.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/forms
 class Podio::Form < ActivePodio::Base
   property :form_id, :integer
   property :app_id, :integer
@@ -16,6 +17,7 @@ class Podio::Form < ActivePodio::Base
   delegate_to_hash :text, :submit, :success, :heading, :description, :setter => true
 
   class << self
+    # @see https://developers.podio.com/doc/forms/create-form-53803
     def create(app_id, attributes)
       response = Podio.connection.post do |req|
         req.url "/form/app/#{app_id}/"
@@ -25,6 +27,7 @@ class Podio::Form < ActivePodio::Base
       response.body['form_id']
     end
 
+    # @see https://developers.podio.com/doc/forms/update-form-53808
     def update(form_id, attributes)
       response = Podio.connection.put do |req|
         req.url "/form/#{form_id}"
@@ -34,20 +37,24 @@ class Podio::Form < ActivePodio::Base
       response.status
     end
 
+    # @see https://developers.podio.com/doc/forms/get-forms-53771
     def find_all_for_app(app_id)
       list Podio.connection.get { |req|
         req.url("/form/app/#{app_id}/")
       }.body
     end
 
+    # @see https://developers.podio.com/doc/forms/get-form-53754
     def find(form_id)
       member Podio.connection.get("/form/#{form_id}").body
     end
 
+    # @see https://developers.podio.com/doc/forms/deactivate-form-1107378
     def disable(form_id)
       Podio.connection.post("/form/#{form_id}/deactivate").body
     end
 
+    # @see https://developers.podio.com/doc/forms/activate-form-1107439
     def enable(form_id)
       Podio.connection.post("/form/#{form_id}/activate").body
     end

data/lib/podio/models/friend.rb

@@ -0,0 +1,12 @@
+
+class Podio::Friend < ActivePodio::Base
+
+  class << self
+
+    def delete(user_ids)
+      Podio.connection.delete("/friend/#{user_ids}").status
+    end
+
+  end
+
+end

data/lib/podio/models/grant.rb

@@ -0,0 +1,73 @@
+class Podio::Grant < ActivePodio::Base
+
+  property :ref_type, :string
+  property :ref_id, :integer
+  property :people, :hash
+  property :action, :string
+  property :message, :string
+  property :ref, :hash
+  property :created_on, :datetime
+
+  has_one :created_by, :class => 'ByLine'
+  has_one :user, :class => 'Contact'
+
+  def save
+    self.class.create(self.ref_type, self.ref_id, self.attributes)
+  end
+
+  class << self
+    # https://hoist.podio.com/api/item/16168841
+    def create(ref_type, ref_id, attributes={})
+      response = Podio.connection.post do |req|
+        req.url "/grant/#{ref_type}/#{ref_id}"
+        req.body = attributes
+      end
+
+      response.body
+    end
+
+    # https://hoist.podio.com/api/item/16490748
+    def find_own(ref_type, ref_id, options = {})
+      response = Podio.connection.get { |req|
+        req.url("/grant/#{ref_type}/#{ref_id}/own", options)
+      }
+      if response.status == 200
+        member response.body
+      else
+        nil
+      end
+    end
+
+    # https://hoist.podio.com/api/item/16491464
+    def find_all(ref_type, ref_id, options = {})
+      list Podio.connection.get { |req|
+        req.url("grant/#{ref_type}/#{ref_id}/", options)
+      }.body
+    end
+
+    # https://hoist.podio.com/api/item/16496711
+    def delete(ref_type, ref_id, user_id)
+      Podio.connection.delete("grant/#{ref_type}/#{ref_id}/#{user_id}").body
+    end
+
+    # https://hoist.podio.com/api/item/19275931
+    def count_by_reference(ref_type, ref_id)
+      Podio.connection.get("/grant/#{ref_type}/#{ref_id}/count").body['count']
+    end
+
+    # https://hoist.podio.com/api/item/19389786
+    def find_for_user_on_space(space_id, user_id, options = {})
+      list Podio.connection.get { |req|
+        req.url("/grant/space/#{space_id}/user/#{user_id}/", options)
+      }.body
+    end
+
+    # https://hoist.podio.com/api/item/22330891
+    def find_own_on_org(org_id, options = {})
+      list Podio.connection.get { |req|
+        req.url("/grant/org/#{org_id}/own/", options)
+      }.body
+    end
+
+  end
+end

data/lib/podio/models/hook.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/hooks
 class Podio::Hook < ActivePodio::Base
   property :hook_id, :integer
   property :status, :string
@@ -8,11 +9,13 @@ class Podio::Hook < ActivePodio::Base
 
   attr_accessor :hookable_type, :hookable_id
 
+  # @see https://developers.podio.com/doc/hooks/create-hook-215056
   def create
     self.hook_id = self.class.create(self.hookable_type, self.hookable_id, attributes)
   end
-  
+
   class << self
+    # @see https://developers.podio.com/doc/hooks/create-hook-215056
     def create(hookable_type, hookable_id, attributes)
       response = Podio.connection.post do |req|
         req.url "/hook/#{hookable_type}/#{hookable_id}/"
@@ -21,28 +24,32 @@ class Podio::Hook < ActivePodio::Base
 
       response.body['hook_id']
     end
-    
+
+    # @see https://developers.podio.com/doc/hooks/request-hook-verification-215232
     def verify(hook_id)
       Podio.connection.post do |req|
         req.url "/hook/#{hook_id}/verify/request"
       end
     end
 
+    # @see https://developers.podio.com/doc/hooks/validate-hook-verification-215241
     def validate(hook_id, code)
       Podio.connection.post do |req|
         req.url "/hook/#{hook_id}/verify/validate"
         req.body = {:code => code}
       end
     end
-    
+
+    # @see https://developers.podio.com/doc/hooks/delete-hook-215291
     def delete(hook_id)
       Podio.connection.delete do |req|
         req.url "/hook/#{hook_id}"
-      end      
+      end
     end
-    
+
+    # @see https://developers.podio.com/doc/hooks/get-hooks-215285
     def find_all_for(hookable_type, hookable_id)
       list Podio.connection.get("/hook/#{hookable_type}/#{hookable_id}/").body
     end
   end
-end
+end

data/lib/podio/models/importer.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/importer
 class Podio::Importer < ActivePodio::Base
 
   class << self
@@ -14,10 +15,12 @@ class Podio::Importer < ActivePodio::Base
       list Podio.connection.get("/importer/#{file_id}/column/").body
     end
 
+    # @see https://developers.podio.com/doc/importer/get-info-5929504
     def get_info(file_id)
       Podio.connection.get("/importer/#{file_id}/info").body
     end
 
+    # @see https://developers.podio.com/doc/importer/get-preview-5936702
     def preview(file_id, row, options)
       response = Podio.connection.post do |req|
         req.url "/importer/#{file_id}/preview/#{row}"

data/lib/podio/models/integration.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/integrations
 class Podio::Integration < ActivePodio::Base
   include ActivePodio::Updatable
 
@@ -11,34 +12,38 @@ class Podio::Integration < ActivePodio::Base
   property :updating, :boolean
   property :last_updated_on, :datetime
   property :created_on, :datetime
-  
+
   has_one :created_by, :class => 'ByLine'
 
   alias_method :id, :integration_id
 
+  # @see https://developers.podio.com/doc/integrations/create-integration-86839
   def create
     self.integration_id = Integration.create(self.app_id, attributes)
   end
 
+  # @see https://developers.podio.com/doc/integrations/update-integration-86843
   def update
     Integration.update(self.app_id, attributes)
   end
 
+  # @see https://developers.podio.com/doc/integrations/update-integration-mapping-86865
   def update_mapping
     Integration.update_mapping(self.app_id, attributes)
   end
-  
+
+  # @see https://developers.podio.com/doc/integrations/delete-integration-86876
   def destroy
     Integration.delete(self.app_id)
   end
 
+  # @see https://developers.podio.com/doc/integrations/refresh-integration-86987
   def refresh
     Integration.refresh(self.app_id)
   end
-  
-  handle_api_errors_for :create, :update, :update_mapping
-  
+
   class << self
+    # @see https://developers.podio.com/doc/integrations/create-integration-86839
     def create(app_id, attributes)
       response = Podio.connection.post do |req|
         req.url "/integration/#{app_id}"
@@ -48,6 +53,7 @@ class Podio::Integration < ActivePodio::Base
       response.body['integration_id']
     end
 
+    # @see https://developers.podio.com/doc/integrations/update-integration-86843
     def update(app_id, attributes)
       response = Podio.connection.put do |req|
         req.url "/integration/#{app_id}"
@@ -57,6 +63,7 @@ class Podio::Integration < ActivePodio::Base
       response.body
     end
 
+    # @see https://developers.podio.com/doc/integrations/update-integration-mapping-86865
     def update_mapping(app_id, attributes)
       response = Podio.connection.put do |req|
         req.url "/integration/#{app_id}/mapping"
@@ -64,18 +71,22 @@ class Podio::Integration < ActivePodio::Base
       end
     end
 
+    # @see https://developers.podio.com/doc/integrations/get-integration-86821
     def find(app_id)
       member Podio.connection.get("/integration/#{app_id}").body
     end
 
+    # @see https://developers.podio.com/doc/integrations/get-available-fields-86890
     def find_available_fields_for(app_id)
       list Podio.connection.get("/integration/#{app_id}/field/").body
     end
-    
+
+    # @see https://developers.podio.com/doc/integrations/delete-integration-86876
     def delete(app_id)
       Podio.connection.delete("/integration/#{app_id}").status
     end
 
+    # @see https://developers.podio.com/doc/integrations/refresh-integration-86987
     def refresh(app_id)
       Podio.connection.post("/integration/#{app_id}/refresh").status
     end