podio 0.8.0 → 1.0.0

data/lib/podio/client.rb

@@ -104,7 +104,7 @@ module Podio
 
     # Sign in with an OpenID, only available for Podio
     def authenticate_with_openid(identifier, type)
-      response = @oauth_connection.post do |req|
+      response = @trusted_connection.post do |req|
         req.url '/oauth/token_by_openid'
         req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
         req.body = {:grant_type => type, :client_id => api_key, :client_secret => api_secret, :identifier => identifier}
@@ -115,12 +115,31 @@ module Podio
       @oauth_token
     end
 
+    # Sign in with an activation code, only available for Podio
+    def authenticate_with_activation_code(activation_code)
+      response = @oauth_connection.post do |req|
+        req.url '/oauth/token'
+        req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+        req.body = {:grant_type => 'activation_code', :client_id => api_key, :client_secret => api_secret, :activation_code => activation_code}
+      end
+
+      @oauth_token = OAuthToken.new(response.body)
+      configure_oauth
+      @oauth_token
+    end
+
     # reconfigure the client with a different access token
     def oauth_token=(new_oauth_token)
       @oauth_token = new_oauth_token.is_a?(Hash) ? OAuthToken.new(new_oauth_token) : new_oauth_token
       configure_oauth
     end
 
+    def locale=(new_locale)
+      @connection.headers['Accept-Language'] = new_locale
+      @oauth_connection.headers['Accept-Language'] = new_locale
+      @trusted_connection.headers['Accept-Language'] = new_locale
+    end
+
     def refresh_access_token
       response = @oauth_connection.post do |req|
         req.url '/oauth/token'
@@ -135,9 +154,16 @@ module Podio
 
     def configured_headers
       headers = @headers.dup
-      headers['User-Agent']      = 'Podio Ruby Library'
-      headers['authorization']   = "OAuth2 #{oauth_token.access_token}" if oauth_token
-      headers['X-Podio-Dry-Run'] = @test_mode.to_s                      if @test_mode
+      headers['User-Agent'] = "Podio Ruby Library (#{Podio::VERSION})"
+      headers['X-Podio-Dry-Run'] = @test_mode.to_s if @test_mode
+
+      if oauth_token
+        # if we have a token, set up Oauth2
+        headers['authorization'] = "OAuth2 #{oauth_token.access_token}"
+      elsif api_key && api_secret
+        # if we have an auth_client, set up public authentication (only works with trusted auth clients)
+        headers['authorization'] = Faraday::Request::BasicAuthentication.header(api_key, api_secret)
+      end
 
       headers
     end
@@ -161,7 +187,6 @@ module Podio
         builder.adapter(*default_adapter)
 
         # first response middleware defined get's executed last
-        # builder.use Middleware::DateConversion
         builder.use Middleware::ErrorResponse
         builder.use Middleware::JsonResponse
       end

data/lib/podio/error.rb

@@ -1,12 +1,31 @@
 module Podio
   class PodioError < StandardError
-    attr_reader :response_body, :response_status, :url
+    attr_reader :response_body, :response_status, :url, :code, :sub_code, :message, :parameters
+    attr_accessor :propagate
 
     def initialize(response_body, response_status, url)
       @response_body, @response_status, @url = response_body, response_status, url
 
+      if response_body.is_a?(Hash)
+        @code       = response_body["error"]
+        @sub_code   = response_body["error_detail"]
+        @message    = response_body["error_description"]
+        @propagate  = response_body["error_propagate"]
+        @parameters = response_body["error_parameters"]
+      else
+        @message    = response_body.to_s
+      end
+
       super(response_body.inspect)
     end
+
+    def resolved_message(default_message=nil)
+      if @propagate
+        @message
+      else
+        default_message || "An unexpected error occurred"
+      end
+    end
   end
 
   class TokenExpired < PodioError; end
@@ -19,13 +38,6 @@ module Podio
   class GoneError < PodioError; end
   class RateLimitError < PodioError; end
   class UnavailableError < PodioError; end
-
-  class RequestableAuthorizationError < AuthorizationError
-    attr_reader :request_access_info
-
-    def initialize(response_body, response_status, url)
-      @request_access_info = response_body['error_parameters']
-      super
-    end
-  end
+  class PaymentRequiredError < AuthorizationError; end
+  class RequestableAuthorizationError < AuthorizationError; end
 end

data/lib/podio/middleware/error_response.rb

@@ -4,42 +4,49 @@ module Podio
   module Middleware
     class ErrorResponse < Faraday::Response::Middleware
       def on_complete(env)
-        case env[:status]
+        error_class = case env[:status]
           when 200, 204
             # pass
           when 400
-            if env[:body]['error'] == 'invalid_grant'
-              raise InvalidGrantError.new(env[:body], env[:status], env[:url])
+            case env[:body]['error']
+            when 'invalid_grant'
+              InvalidGrantError
             else
-              raise BadRequestError.new(env[:body], env[:status], env[:url])
+              BadRequestError
             end
           when 401
             if env[:body]['error_description'] =~ /expired_token/
-              raise TokenExpired.new(env[:body], env[:status], env[:url])
+              TokenExpired
             else
-              raise AuthorizationError.new(env[:body], env[:status], env[:url])
+              AuthorizationError
             end
+          when 402
+            PaymentRequiredError
           when 403
             if env[:body]['error'] == 'requestable_forbidden'
-              raise RequestableAuthorizationError.new(env[:body], env[:status], env[:url])
+              RequestableAuthorizationError
             else
-              raise AuthorizationError.new(env[:body], env[:status], env[:url])
+              AuthorizationError
             end
           when 404
-            raise NotFoundError.new(env[:body], env[:status], env[:url])
+            NotFoundError
           when 409
-            raise ConflictError.new(env[:body], env[:status], env[:url])
+            ConflictError
           when 410
-            raise GoneError.new(env[:body], env[:status], env[:url])
+            GoneError
           when 420
-            raise RateLimitError.new(env[:body], env[:status], env[:url])
+            RateLimitError
           when 500
-            raise ServerError.new(env[:body], env[:status], env[:url])
+            ServerError
           when 502, 503
-            raise UnavailableError.new(env[:body], env[:status], env[:url])
+            UnavailableError
           else
-            # anything else is something unexpected, so raise it
-            raise ServerError.new(env[:body], env[:status], env[:url])
+            # anything else is something unexpected, so it
+            ServerError
+        end
+
+        if error_class
+          raise error_class.new(env[:body], env[:status], env[:url])
         end
       end
     end

data/lib/podio/middleware/json_response.rb

@@ -7,7 +7,7 @@ module Podio
       require 'multi_json'
 
       def on_complete(env)
-        if env[:body].is_a?(String) && is_json?(env) && env[:status] < 500
+        if env[:body].is_a?(String) && is_json?(env) && env[:status] != 500
           env[:body] = parse(env[:body])
         end
       end

data/lib/podio/middleware/logger.rb

@@ -4,6 +4,9 @@ module Podio
   module Middleware
     class Logger < Faraday::Middleware
       def call(env)
+        # Preserve request body
+        env[:request_body] = env[:body] if env[:body]
+
         env[:request][:client].log(env) do
           @app.call(env)
         end

data/lib/podio/middleware/oauth2.rb

@@ -15,6 +15,9 @@ module Podio
           # new access token needs to be put into the header
           orig_env[:request_headers].merge!(podio_client.configured_headers)
 
+          # rewind the body if this was a file upload
+          orig_env[:body].rewind if orig_env[:body].respond_to?(:rewind)
+
           # redo the request with the new access token
           @app.call(orig_env)
         end

data/lib/podio/models/account_provider.rb

@@ -3,6 +3,7 @@ class Podio::AccountProvider < ActivePodio::Base
   property :connect_link, :string
   property :humanized_name, :string
   property :capabilities, :array
+  property :capability_names, :hash
 
   class << self
 

data/lib/podio/models/action.rb

@@ -1,15 +1,32 @@
+# @see https://developers.podio.com/doc/actions
 class Podio::Action < ActivePodio::Base
   property :action_id, :integer
   property :type, :string
   property :data, :hash
   property :text, :string
+  property :push, :hash
+  property :presence, :hash
+  property :pinned, :boolean
+  property :created_on, :datetime
+  property :subscribed, :boolean
+  property :is_liked, :boolean
+  property :like_count, :integer
+  property :subscribed_count, :integer
+  property :push, :hash
+  property :presence, :hash
+  property :rights, :array
+
+  has_one :created_by, :class => 'ByLine'
+  has_one :created_via, :class => 'Via'
+  has_many :comments, :class => 'Comment'
 
   alias_method :id, :action_id
-  
+
   class << self
+    # @see https://developers.podio.com/doc/actions/get-action-1701120
     def find(id)
       member Podio.connection.get("/action/#{id}").body
     end
   end
-  
+
 end

data/lib/podio/models/activation_status.rb

@@ -1,9 +1,15 @@
 class Podio::ActivationStatus < ActivePodio::Base
+  property :user_id, :integer
+  property :status, :string
+  property :mail, :string
+  property :name, :string
+  property :has_valid_password, :boolean
   property :space_count, :integer
-  
+  property :internal_source, :hash
+
   class << self
     def find(activation_code)
-      member Podio.connection.get("/user/status/activation?activation_code=#{activation_code}").body
+      member Podio.client.trusted_connection.get("/user/status/activation?activation_code=#{activation_code}").body
     end
   end
 end

data/lib/podio/models/app_store_category.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/app-store
 class Podio::AppStoreCategory < ActivePodio::Base
   property :category_id, :integer
   property :name, :string
@@ -7,10 +8,12 @@ class Podio::AppStoreCategory < ActivePodio::Base
 
   class << self
 
+    # @see https://developers.podio.com/doc/app-market/get-shares-by-category-22498
     def find(category_id)
-      member Podio.connection.get("/app_store/category/#{category_id}").body
+      member Podio.connection.get("/app_store/category/#{category_id}/v2").body
     end
 
+    # @see https://developers.podio.com/doc/app-market/get-categories-37009
     def find_all
       categories = Podio.connection.get("/app_store/category/").body
 

data/lib/podio/models/app_store_share.rb

@@ -1,7 +1,9 @@
+# @see https://developers.podio.com/doc/app-store
 class Podio::AppStoreShare < ActivePodio::Base
   property :share_id, :integer
   property :type, :string
   property :status, :string
+  property :link, :string
   property :name, :string
   property :description, :string
   property :abstract, :string
@@ -30,25 +32,28 @@ class Podio::AppStoreShare < ActivePodio::Base
 
   alias_method :id, :share_id
 
+  # @see https://developers.podio.com/doc/app-market/share-app-22504
   def create
     self.share_id = self.class.create(self.attributes)
   end
 
+  # @see https://developers.podio.com/doc/app-market/unshare-app-37917
   def destroy
     self.class.destroy(self.share_id)
   end
 
+  # @see https://developers.podio.com/doc/app-market/install-share-22499
   def install(space_id, dependencies, social = true)
     self.class.install(self.share_id, space_id, dependencies, social)
   end
 
-  handle_api_errors_for :create, :install  # Call must be made after the methods to handle have been defined
-
   def api_friendly_ref_type
     'share'
   end
 
   class << self
+
+    # @see https://developers.podio.com/doc/app-market/share-app-22504
     def create(attributes)
       response = Podio.connection.post do |req|
         req.url "/app_store/"
@@ -58,6 +63,7 @@ class Podio::AppStoreShare < ActivePodio::Base
       response.body['share_id']
     end
 
+    # @see https://developers.podio.com/doc/app-market/update-share-38639
     def update(id, attributes)
       response = Podio.connection.put do |req|
         req.url "/app_store/#{id}"
@@ -65,12 +71,14 @@ class Podio::AppStoreShare < ActivePodio::Base
       end
     end
 
+    # @see https://developers.podio.com/doc/app-market/unshare-app-37917
     def destroy(id)
       response = Podio.connection.delete do |req|
         req.url "/app_store/#{id}"
       end
     end
 
+    # @see https://developers.podio.com/doc/app-market/install-share-22499
     def install(share_id, space_id, dependencies, social = true)
       response = Podio.connection.post do |req|
         req.url "/app_store/#{share_id}/install/v2"
@@ -80,28 +88,32 @@ class Podio::AppStoreShare < ActivePodio::Base
       response.body
     end
 
-    def find(id)
-      member Podio.connection.get("/app_store/#{id}/v2").body
+    def find(id, options = {})
+      member Podio.connection.get { |req|
+        req.url "/app_store/#{id}/v2", options
+      }.body
     end
 
-    def find_all_own(options = {})
+    # @see https://developers.podio.com/doc/app-market/get-own-shares-38645
+    def find_all_own(share_type, options = {})
       shares_collection Podio.connection.get { |req|
-        req.url "/app_store/own/", options
+        req.url "/app_store/#{share_type}/own/", options
       }.body
     end
 
-    def find_all_private_for_org(org_id, options = {})
+    def find_all_private_for_org(share_type, org_id, options = {})
       shares_collection Podio.connection.get { |req|
-        req.url "/app_store/org/#{org_id}/", options
+        req.url "/app_store/#{share_type}/org/#{org_id}/", options
       }.body
     end
 
-    def find_all_public_for_org(org_url, options = {})
+    def find_all_public_for_org(share_type, org_url, options = {})
       shares_collection Podio.connection.get { |req|
-        req.url "/app_store/org/#{org_url}/", options
+        req.url "/app_store/#{share_type}/org/#{org_url}/", options
       }.body
     end
 
+    # @see https://developers.podio.com/doc/app-market/get-recommended-shares-5340177
     def find_all_recommended_for_area(area, options = {})
       list Podio.connection.get { |req|
         req.url("/app_store/recommended/#{area}/", options)
@@ -117,25 +129,26 @@ class Podio::AppStoreShare < ActivePodio::Base
       response.status
     end
 
+    # @see https://developers.podio.com/doc/app-market/get-share-by-reference-45002
     def find_all_by_reference(ref_type, ref_id)
       list Podio.connection.get("/app_store/#{ref_type}/#{ref_id}/").body
     end
 
-    def find_top(options = {})
+    def find_top(share_type, options = {})
       shares_collection Podio.connection.get { |req|
-        req.url("/app_store/top/", options)
+        req.url("/app_store/#{share_type}/top/", options)
       }.body
     end
 
-    def find_all_by_category(category_id, options = {})
+    def find_all_by_category(share_type, category_id, options = {})
       shares_collection Podio.connection.get { |req|
-        req.url("/app_store/category/#{category_id}/", options)
+        req.url("/app_store/#{share_type}/category/#{category_id}/", options)
       }.body
     end
 
-    def find_all_by_search(options = {})
+    def find_all_by_search(share_type, options = {})
       shares_collection Podio.connection.get { |req|
-        req.url("/app_store/search/", options)
+        req.url("/app_store/#{share_type}/search/", options)
       }.body
     end
 

data/lib/podio/models/application.rb

@@ -1,3 +1,4 @@
+# @see https://developers.podio.com/doc/applications
 class Podio::Application < ActivePodio::Base
   property :app_id, :integer
   property :original, :integer
@@ -5,6 +6,7 @@ class Podio::Application < ActivePodio::Base
   property :status, :string
   property :icon, :string
   property :icon_id, :integer
+  property :pinned, :boolean
   property :space_id, :integer
   property :owner_id, :integer
   property :owner, :hash
@@ -26,7 +28,7 @@ class Podio::Application < ActivePodio::Base
   has_one :integration, :class => 'Integration'
 
   alias_method :id, :app_id
-  delegate_to_hash :config, :allow_edit?, :allow_attachments?, :allow_comments?, :description, :visible?, :usage, :default_view
+  delegate_to_hash :config, :allow_edit?, :allow_attachments?, :allow_comments?, :description, :visible?, :usage, :default_view, :show_app_item_id?
 
   def name
     self[:name] || self.config['name']
@@ -37,51 +39,65 @@ class Podio::Application < ActivePodio::Base
   end
 
   class << self
+    # @see https://developers.podio.com/doc/applications/get-app-22349
     def find(app_id, options = {})
       member Podio.connection.get { |req|
         req.url("/app/#{app_id}", options)
       }.body
     end
 
+    # @see https://developers.podio.com/doc/applications/get-app-on-space-by-url-label-477105
     def find_by_url_label(space_id, url_label)
       member Podio.connection.get("/app/space/#{space_id}/#{url_label}").body
     end
 
+    # @see https://developers.podio.com/doc/applications/get-app-by-org-label-space-label-and-app-label-91708386
+    def find_by_org_space_and_app_labels(org_label, space_label, app_label)
+      member Podio.connection.get("/app/org/#{org_label}/space/#{space_label}/#{app_label}").body
+    end
+
     def find_all(options={})
       list Podio.connection.get { |req|
         req.url("/app/", options)
       }.body
     end
 
+    # @see https://developers.podio.com/doc/applications/get-all-user-apps-5902728
     def find_all_for_current_user(options={})
       list Podio.connection.get { |req|
         req.url("/app/v2/", options)
       }.body
     end
 
+    # @see https://developers.podio.com/doc/applications/get-top-apps-22476
     def find_top(options={})
       list Podio.connection.get { |req|
         req.url("/app/top/", options)
       }.body
     end
+
+    ## @see https://developers.podio.com/doc/applications/get-top-apps-for-organization-1671395
     def find_top_for_org(org_id, options={})
       list Podio.connection.get { |req|
         req.url("/app/org/#{org_id}/top/", options)
       }.body
     end
 
+    # @see https://developers.podio.com/doc/applications/get-apps-by-space-22478
     def find_all_for_space(space_id, options = {})
       list Podio.connection.get { |req|
         req.url("/app/space/#{space_id}/", options)
       }.body
     end
 
+    # @see https://developers.podio.com/doc/applications/get-calculations-for-app-773005
     def get_calculations(app_id)
       list Podio.connection.get { |req|
         req.url("/app/#{app_id}/calculation/", {})
       }.body
     end
 
+    # @see https://developers.podio.com/doc/applications/update-app-order-22463
     def update_order(space_id, app_ids = [])
       response = Podio.connection.put do |req|
         req.url "/app/space/#{space_id}/order"
@@ -91,6 +107,7 @@ class Podio::Application < ActivePodio::Base
       response.body
     end
 
+    # @see https://developers.podio.com/doc/applications/add-new-app-22351
     def create(attributes)
       response = Podio.connection.post do |req|
         req.url "/app/"
@@ -99,6 +116,7 @@ class Podio::Application < ActivePodio::Base
       response.body['app_id']
     end
 
+    # @see https://developers.podio.com/doc/applications/update-app-22352
     def update(app_id, attributes)
       response = Podio.connection.put do |req|
         req.url "/app/#{app_id}"
@@ -107,6 +125,25 @@ class Podio::Application < ActivePodio::Base
       response.status
     end
 
+    # @see https://developers.podio.com/doc/applications/update-app-description-33569973
+    def update_description(app_id, description)
+      response = Podio.connection.put do |req|
+        req.url "/app/#{app_id}/description"
+        req.body = {:description => description}
+      end
+      response.status
+    end
+
+    # @see https://developers.podio.com/doc/applications/update-app-usage-33570086
+    def update_usage(app_id, usage)
+      response = Podio.connection.put do |req|
+        req.url "/app/#{app_id}/usage"
+        req.body = {:usage => usage}
+      end
+      response.status
+    end
+
+    # @see https://developers.podio.com/doc/applications/install-app-22506
     def install(app_id, attributes)
       response = Podio.connection.post do |req|
         req.url "/app/#{app_id}/install"
@@ -115,18 +152,22 @@ class Podio::Application < ActivePodio::Base
       response.body['app_id']
     end
 
+    # @see https://developers.podio.com/doc/applications/delete-app-field-22355
     def delete_field(app_id, field_id)
       Podio.connection.delete("/app/#{app_id}/field/#{field_id}").status
     end
 
+    # @see https://developers.podio.com/doc/applications/deactivate-app-43821
     def deactivate(id)
       Podio.connection.post("/app/#{id}/deactivate").body
     end
 
+    # @see https://developers.podio.com/doc/applications/activate-app-43822
     def activate(id)
       Podio.connection.post("/app/#{id}/activate").body
     end
 
+    # @see https://developers.podio.com/doc/applications/delete-app-43693
     def delete(id)
       Podio.connection.delete("/app/#{id}").body
     end
@@ -135,21 +176,35 @@ class Podio::Application < ActivePodio::Base
       Podio.connection.post("/mobile/install_app/#{id}").body
     end
 
+    # @see https://developers.podio.com/doc/applications/get-features-43648
     def features(options)
       Podio.connection.get { |req|
         req.url("/app/features/", options)
       }.body
     end
 
+    # @see https://developers.podio.com/doc/applications/get-app-dependencies-39159
     def dependencies(id)
       Podio.connection.get("/app/#{id}/dependencies/").body
     end
 
+    # @see https://developers.podio.com/doc/applications/get-space-app-dependencies-45779
     def space_dependencies(space_id)
-      result = Podio.connection.get("/app/space/#{space_id}/dependencies/").body
+      result = Podio.connection.get("/space/#{space_id}/dependencies/").body
       result['apps'] = result['apps'].collect { |app| Application.new(app) }
       result
     end
 
+    def regenerate_apptoken(app_id)
+      Podio.connection.post("/app/#{app_id}/token/regenerate").body
+    end
+
+    # @see https://developers.podio.com/doc/applications/get-icon-suggestions-82045764
+    def search_icons(query)
+      Podio.connection.get { |req|
+        req.url("/app/icon/search", {:query => query})
+      }.body
+    end
+
   end
 end