podio 0.8.0 → 1.0.0

data/lib/podio/models/task_label.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/tasks
 class Podio::TaskLabel < ActivePodio::Base
   include ActivePodio::Updatable
 
@@ -7,29 +8,34 @@ class Podio::TaskLabel < ActivePodio::Base
 
   DEFAULT_COLOR_FOR_NEW_LABELS = 'E9E9E9'
 
+  # @see https://developers.podio.com/doc/tasks/create-label-151265
   def create
     if self.color.nil? || self.color.empty?
       self.color = DEFAULT_COLOR_FOR_NEW_LABELS
     end
-    
+
     self.label_id = self.class.create(self.attributes)
   end
 
+  # @see https://developers.podio.com/doc/tasks/delete-label-151302
   def destroy
     self.class.delete(self.label_id)
   end
 
+  # @see https://developers.podio.com/doc/tasks/update-label-151289
   def update
     self.class.update(self.label_id, self.attributes)
   end
-  
+
   class << self
+    # @see https://developers.podio.com/doc/tasks/get-labels-151534
     def find_all_labels
       list Podio.connection.get { |req|
         req.url("/task/label/")
       }.body
     end
 
+    # @see https://developers.podio.com/doc/tasks/create-label-151265
     def create(attributes)
       response = Podio.connection.post do |req|
         req.url "/task/label/"
@@ -39,10 +45,12 @@ class Podio::TaskLabel < ActivePodio::Base
       response.body['label_id']
     end
 
+    # @see https://developers.podio.com/doc/tasks/delete-label-151302
     def delete(label_id)
       Podio.connection.delete("/task/label/#{label_id}").status
     end
 
+    # @see https://developers.podio.com/doc/tasks/update-label-151289
     def update(label_id, attributes)
       Podio.connection.put("/task/label/#{label_id}", attributes).status
     end

data/lib/podio/models/user.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/users
 class Podio::User < ActivePodio::Base
   property :user_id, :integer
   property :mail, :string
@@ -7,9 +8,8 @@ class Podio::User < ActivePodio::Base
   property :password, :string
   property :old_password, :string
   property :new_password, :string
-  property :flags, :array
-  property :betas, :array
   property :created_on, :datetime
+  property :activated_on, :datetime
   property :name, :string
   property :link, :string
   property :avatar, :integer
@@ -28,6 +28,7 @@ class Podio::User < ActivePodio::Base
   alias_method :id, :user_id
 
   class << self
+    # @see https://developers.podio.com/doc/users/get-user-22378
     def current
       member Podio.connection.get("/user/").body
     end
@@ -42,7 +43,7 @@ class Podio::User < ActivePodio::Base
     end
 
     def create_inactive(attributes)
-      response = Podio.connection.post do |req|
+      response = Podio.client.trusted_connection.post do |req|
         req.url '/user/inactive/'
         req.body = attributes
       end
@@ -54,12 +55,27 @@ class Podio::User < ActivePodio::Base
       Podio.connection.put("/user/", attributes).status
     end
 
+    # @see https://developers.podio.com/doc/users/update-profile-22402
     def update_profile(attributes)
       Podio.connection.put("/user/profile/", attributes).status
     end
 
+    # @see https://developers.podio.com/doc/users/update-profile-field-22500
+    def update_profile_field(key, attributes)
+      Podio.connection.put("/user/profile/#{key}", attributes).status
+    end
+
+    def can_request_call
+      response = Podio.connection.get("/user/request_call")
+      response.body['requestable']
+    end
+
+    def request_call
+      Podio.connection.post("/user/request_call").status
+    end
+
     def activate(attributes)
-      response = Podio.connection.post do |req|
+      response = Podio.client.trusted_connection.post do |req|
         req.url '/user/activate_user'
         req.body = attributes
       end
@@ -67,6 +83,7 @@ class Podio::User < ActivePodio::Base
       member response.body
     end
 
+    # @see https://developers.podio.com/doc/organizations/get-organization-admins-81542
     def find_all_admins_for_org(org_id)
       list Podio.connection.get("/org/#{org_id}/admin/").body
     end
@@ -79,14 +96,17 @@ class Podio::User < ActivePodio::Base
       Podio.connection.put("/user/property/#{name}", {:value => value}).status
     end
 
+    # @see https://developers.podio.com/doc/users/get-user-property-29798
     def get_property_hash(name)
       Podio.connection.get("/user/property/#{name}").body
     end
 
+    # @see https://developers.podio.com/doc/users/set-user-property-29799
     def set_property_hash(name, hash)
       Podio.connection.put("/user/property/#{name}", hash).status
     end
 
+    # @see https://developers.podio.com/doc/users/set-user-properties-9052829
     def set_properties(attributes)
       response = Podio.connection.put do |req|
         req.url '/user/property/'
@@ -96,6 +116,7 @@ class Podio::User < ActivePodio::Base
       response.body
     end
 
+    # @see https://developers.podio.com/doc/users/delete-user-property-29800
     def remove_property(name)
       Podio.connection.delete("/user/property/#{name}", {}).status
     end
@@ -114,7 +135,7 @@ class Podio::User < ActivePodio::Base
     end
 
     def recover(mail)
-      response = Podio.connection.post do |req|
+      response = Podio.client.trusted_connection.post do |req|
         req.url '/user/recover_password'
         req.body = {:mail => mail}
       end
@@ -123,7 +144,7 @@ class Podio::User < ActivePodio::Base
     end
 
     def reset(password, recovery_code)
-      response = Podio.connection.post do |req|
+      response = Podio.client.trusted_connection.post do |req|
         req.url '/user/reset_password'
         req.body = {:password => password, :recovery_code => recovery_code}
       end
@@ -138,5 +159,28 @@ class Podio::User < ActivePodio::Base
     def internal_source
       Podio.connection.get("/user/source").body
     end
+
+    def merge(activation_code)
+      response = Podio.connection.post do |req|
+        req.url '/user/merge'
+        req.body = {:activation_code => activation_code}
+      end
+
+      response.status
+    end
+
+    def get_sales_agent_profile
+      Podio.connection.get("/user/sales_agent").body
+    end
+
+    def resend_signup_email(mail)
+      response = Podio.connection.post do |req|
+        req.url '/user/resend_signup_email'
+        req.body = {:mail => mail}
+      end
+
+      response.status
+    end
+
   end
 end

data/lib/podio/models/user_mail.rb

@@ -1,7 +1,11 @@
+# @see https://developers.podio.com/doc/users
 class Podio::UserMail < ActivePodio::Base
   property :mail, :string
   property :verified, :boolean
   property :primary, :boolean
   property :disabled, :boolean
 
+  def self.validate(mail)
+    Podio.client.trusted_connection.post("/user/mail_validation", :mail => mail).body
+  end
 end

data/lib/podio/models/user_status.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/users
 class Podio::UserStatus < ActivePodio::Base
   property :user, :hash
   property :profile, :hash
@@ -6,12 +7,18 @@ class Podio::UserStatus < ActivePodio::Base
   property :calendar_code, :string
   property :task_mail, :string
   property :mailbox, :string
+  property :message_unread_count, :integer
+  property :flags, :array
+  property :betas, :array
+  property :push, :hash
+  property :presence, :hash
 
   has_one :user, :class => 'User'
   has_one :contact, :class => 'Contact', :property => :profile
   has_one :referral, :class => 'Referral'
 
   class << self
+    # @see https://developers.podio.com/doc/users/get-user-status-22480
     def current
       member Podio.connection.get("/user/status").body
     end

data/lib/podio/models/view.rb

@@ -1,5 +1,6 @@
+# @see https://developers.podio.com/doc/filters
 class Podio::View < ActivePodio::Base
-  property :view_id, :integer
+  property :view_id, :string
   property :name, :string
   property :created_on, :datetime
   property :items, :integer
@@ -8,39 +9,58 @@ class Podio::View < ActivePodio::Base
   property :filters, :hash
   property :layout, :string
   property :fields, :hash
+  property :type, :string
 
   alias_method :id, :view_id
 
   has_one :created_by, :class => 'User'
 
   class << self
+    # @see https://developers.podio.com/doc/views/get-last-view-27663
     def find_last(app_id)
       member Podio.connection.get("/view/app/#{app_id}/last").body
     end
 
-    def find_all(app_id)
+    # @see https://developers.podio.com/doc/views/get-views-27460
+    def find_all(app_id, options={})
       list Podio.connection.get { |req|
-        req.url("/view/app/#{app_id}/")
+        req.url("/view/app/#{app_id}/", options)
       }.body
     end
 
-    def find(id)
-      member Podio.connection.get("/view/#{id}").body
+    # @see https://developers.podio.com/doc/views/get-view-27450
+    def find(id, app_id=nil)
+      path = app_id ? "/view/app/#{app_id}/#{id}" : "/view/#{id}"
+
+      member Podio.connection.get(path).body
     end
 
+    # @see https://developers.podio.com/doc/views/delete-view-27454
     def delete(view_id)
       Podio.connection.delete("/view/#{view_id}").status
     end
 
+    # @see https://developers.podio.com/doc/views/create-view-27453
     def create(app_id, attributes)
       response = Podio.connection.post do |req|
         req.url "/view/app/#{app_id}/"
         req.body = attributes
       end
 
-      response.body['view_id']
+      member response.body
+    end
+
+    # @see https://developers.podio.com/doc/views/update-view-20069949
+    def update(view_id, attributes)
+      response = Podio.connection.put do |req|
+        req.url "/view/#{view_id}"
+        req.body = attributes
+      end
+
+      response.status
     end
 
+    # @see https://developers.podio.com/doc/views/update-last-view-5988251
     def update_last(app_id, attributes)
       Podio.connection.put do |req|
         req.url "/view/app/#{app_id}/last"
@@ -48,4 +68,4 @@ class Podio::View < ActivePodio::Base
       end
     end
   end
-end
+end

data/lib/podio/models/widget.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/widgets
 class Podio::Widget < ActivePodio::Base
   property :widget_id, :integer
   property :ref_type, :string
@@ -8,30 +9,39 @@ class Podio::Widget < ActivePodio::Base
   property :ref, :hash
   property :rights, :array
   property :data, :hash
-  
+  property :x, :integer
+  property :y, :integer
+  property :rows, :integer
+  property :cols, :integer
+  property :allowed_refs, :array
+
   class << self
+    # @see https://developers.podio.com/doc/widgets/create-widget-22491
     def create(ref_type, ref_id, attributes)
       response = Podio.connection.post do |req|
         req.url "/widget/#{ref_type}/#{ref_id}/"
         req.body = attributes
       end
 
-      response.body['widget_id']
+      member response.body
     end
 
+    # @see https://developers.podio.com/doc/widgets/update-widget-22490
     def update(id, attributes)
       response = Podio.connection.put do |req|
         req.url "/widget/#{id}"
         req.body = attributes
       end
 
-      response.status
+      member response.body
     end
 
+    # @see https://developers.podio.com/doc/widgets/delete-widget-22492
     def delete(id)
       Podio.connection.delete("/widget/#{id}").status
     end
 
+    # @see https://developers.podio.com/doc/widgets/update-widget-order-22495
     def update_order(ref_type, ref_id, widget_list)
       response = Podio.connection.put do |req|
         req.url "/widget/#{ref_type}/#{ref_id}/order"
@@ -41,12 +51,24 @@ class Podio::Widget < ActivePodio::Base
       response.status
     end
 
+    # @see https://developers.podio.com/doc/widgets/get-widget-22489
     def find(id)
       member Podio.connection.get("/widget/#{id}").body
     end
 
+    # @see https://developers.podio.com/doc/widgets/get-widgets-22494
     def find_all_for_reference(ref_type, ref_id)
       list Podio.connection.get("/widget/#{ref_type}/#{ref_id}/display/").body
     end
+    
+    # @see https://developers.podio.com/doc/widgets/clone-widget-105850650
+    def clone(id, attributes)
+      response = Podio.connection.post do |req|
+        req.url "/widget/#{id}/clone"
+        req.body = attributes
+      end
+
+      member response.body
+    end
   end
 end

data/lib/podio/version.rb

@@ -1,3 +1,3 @@
 module Podio
-  VERSION = '0.8.0'
+  VERSION = '1.0.0'
 end

data/podio.gemspec

@@ -1,4 +1,4 @@
-$:.push File.expand_path('../lib', __FILE__)
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'podio/version'
 
 Gem::Specification.new do |s|
@@ -6,21 +6,24 @@ Gem::Specification.new do |s|
   s.version           = Podio::VERSION
   s.platform          = Gem::Platform::RUBY
   s.summary           = 'Ruby wrapper for the Podio API'
-  s.homepage          = 'https://github.com/podio/podio-rb'
-  s.email             = 'florian@podio.com'
+  s.description       = 'The official Ruby wrapper for the Podio API used and maintained by the Podio team'
+  s.license           = 'MIT'
+
   s.authors           = ['Florian Munz', 'Casper Fabricius']
-  s.has_rdoc          = false
+  s.email             = 'munz@podio.com'
+  s.homepage          = 'https://github.com/podio/podio-rb'
 
   s.files             = `git ls-files`.split("\n")
   s.test_files        = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths     = ['lib']
 
-  s.add_dependency('faraday', '~> 0.7.0')
-  s.add_dependency('activesupport', '~> 3.0')
-  s.add_dependency('activemodel', '~> 3.0')
+  s.has_rdoc          = false
+
+  s.add_dependency('faraday', '~> 0.8.0')
+  s.add_dependency('activesupport', '>= 3.0')
+  s.add_dependency('activemodel', '>= 3.0')
   s.add_dependency('multi_json')
 
-  s.description       = <<desc
-The official Ruby wrapper for the Podio API used and maintained by the Podio team
-desc
+  s.add_development_dependency('rake')
+  s.add_development_dependency('yard')
 end

data/script/config.example.rb

@@ -0,0 +1,6 @@
+PODIO_SETUP = {
+  :client_id => '',
+  :client_secret => '',
+  :app_id => '',
+  :app_token => ''
+}

data/script/referenceGenerator.rb

@@ -0,0 +1,87 @@
+# Updates API documentation. Run with:
+
+# # Generate sample output (use as a dry run)
+# bundle exec ruby referenceGenerator.rb
+
+# # Only act on a single model
+# bundle exec ruby referenceGenerator.rb --file=status.rb
+
+# # Send updates to API documentation
+# bundle exec ruby referenceGenerator.rb --update-api
+
+# # All together
+# bundle exec ruby referenceGenerator.rb --update-api --file=status.rb
+
+require 'yard'
+require 'multi_json'
+require '../lib/podio'
+
+operations = {}
+path = '*.rb'
+update_api = false
+ARGV.each do |arg|
+  if arg.match('--file=')
+    path = arg.sub('--file=', '')
+  elsif arg == '--update-api'
+    update_api = true
+  end
+end
+
+YARD.parse("../lib/podio/models/#{path}")
+
+YARD::Registry.all(:class).each do |klass|
+  klass.meths(:visibility => :public).each do |meth|
+    link = meth.tag('see').name if meth.has_tag?('see')
+    match = link.match(/https:\/\/developers.podio.com\/doc\/(.+)-([0-9]+)/) if link
+    if match
+      item_id = match[2].to_i
+
+      # Build example string
+      param_string = ''
+      param_list = []
+      meth.parameters.each do |p|
+        if p[1]
+          param_list << "#{p[0]} = #{p[1]}"
+        else
+          param_list << p[0]
+        end
+      end
+      param_string = "( #{param_list.join(', ')} )" if param_list.length > 0
+
+      if meth.scope == :class
+        example_string = "Podio::#{klass.name}.#{meth.name}#{param_string}"
+      else
+        example_string = "#{klass.name.downcase}.#{meth.name}#{param_string}"
+      end
+
+
+      data = {
+        :className => klass.name,
+        :method => meth.name,
+        :path => "models/"+File.basename(meth.files.first.first),
+        :line => meth.files.first.last,
+        :type => meth.scope == :class ? 'static' : 'instance',
+        :example => example_string,
+      }
+      operations[item_id] = [] if !operations[item_id]
+      operations[item_id] << data
+    end
+  end
+end
+
+if update_api
+  require './config.rb'
+  Podio.setup(:api_key => PODIO_SETUP[:client_id], :api_secret => PODIO_SETUP[:client_secret])
+  Podio.client.authenticate_with_app(PODIO_SETUP[:app_id], PODIO_SETUP[:app_token])
+  operations.each do |item_id, data|
+    puts "Updating #{item_id}"
+    encoded_data = MultiJson.encode(data)
+    begin
+      Podio::ItemField.update(item_id, 16359339, {:value => encoded_data}, {:silent => true})
+    rescue Podio::GoneError
+      puts "    PodioGoneError for this item id"
+    end
+  end
+else
+  puts operations
+end