podio 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddca0ab27daadb721f418559e369f9df19ff079b
-  data.tar.gz: 62879f0a0051374d7edf58585fb23fcdc1b8a65f
+  metadata.gz: 8be7a5e8b46cf3874900c1bfb9452ec3319890da
+  data.tar.gz: 1ed2281e8019c04a4e44e58afc75e323f183c9d7
 SHA512:
-  metadata.gz: 745846890f8a4a11a0ae2591db7d2921ab9fa33cb696b7573aedb7de87c46ddbf4966f16d97132e7da7e13756dff437eb48ae2dff15b34a6e7eed5509fd3550b
-  data.tar.gz: b1bd3c5b7177185fa91b198f88b05ebd51820c30a4fca4fb00f7f0feab151b2afa3ab2aa013f9881b623ba17eb5db3632be90a302585eeb9263c42a6f0c0297c
+  metadata.gz: 330066725f8cd6d4cbafdcc5160b715618ade623cd57ad0aca8b656d8675a79bbf975fa6dba5078d12be2ff50e4756d6f4a7fc9aa7ed4e72f85cc69e95b2d2c7
+  data.tar.gz: e3620e6009381f05a79c0524d48c3ef0bc227887f758eb5014bb2820b077601b92d1c121f875b78eb4c6b2eb6b41ea0e0ba0481a3e748a98011ced416ae11b33

data/.gitignore

@@ -5,3 +5,4 @@ pkg/*
 Gemfile.lock
 script/config.rb
 *.swp
+.idea

data/.travis.yml

@@ -2,12 +2,9 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - jruby
+  - 2.1
   - rbx
 notifications:
   email:
     - fabricius@podio.com
-    - auchenberg@podio.com
-    - haugstrup@podio.com
-    - daniel@podio.com
     - munz@podio.com

data/README.md

@@ -17,7 +17,9 @@ Configuration
 
 The main way of using the Podio library is via a singleton client, which you set up like this:
 
-    Podio.setup(:api_key => 'YOUR_API_KEY', :api_secret => 'YOUR_API_SECRET')
+```ruby
+Podio.setup(:api_key => 'YOUR_API_KEY', :api_secret => 'YOUR_API_SECRET')
+```
 
 This initializes a `Podio::Client` object and assigns it to a thread-local, which is used by all methods in this library.
 
@@ -31,58 +33,66 @@ After the configuration you need to authenticate against the API. The client sup
 
 The default OAuth flow to be used when you authenticate Podio users from your web application. See the `sinatra.rb` in the examples folder.
 
-    # Redirect the user to the authorize url
-    Podio.client.authorize_url(:redirect_uri => redirect_uri)
+```ruby
+# Redirect the user to the authorize url
+Podio.client.authorize_url(:redirect_uri => redirect_uri)
 
-    # In the callback you get the authorization_code
-    # wich you use to get the access token
-    Podio.client.authenticate_with_auth_code(params[:code], redirect_uri)
+# In the callback you get the authorization_code
+# wich you use to get the access token
+Podio.client.authenticate_with_auth_code(params[:code], redirect_uri)
+```
 
 ### Username and Password Flow
 
 If you're writing a batch job or are just playing around with the API, this is the easiest to get started. Do not use this for authenticating users other than yourself, the web server flow is meant for that.
 
-    Podio.client.authenticate_with_credentials('USERNAME', 'PASSWORD')
-
+```ruby
+Podio.client.authenticate_with_credentials('USERNAME', 'PASSWORD')
+```
 
 Basic Usage
 -----------
 
 After you configured the `Podio.client` singleton you can use all of the wrapper functions to do API requests. The functions are organized into models corresponding to the official API documentation, although most API areas have multiple models associated. The method follow a common naming pattern that should be familiar to ActiveRecord users. For example:
 
-    # Getting an item
-    Podio::Item.find(42)
+```ruby
+# Getting an item
+Podio::Item.find(42)
 
-    # Posting a status message on space with id 23
-    Podio::Status.create(23, {:value => 'This is the text of the status message'})
+# Posting a status message on space with id 23
+Podio::Status.create(23, {:value => 'This is the text of the status message'})
+```
 
 If there is a method missing or you want to do something special, you can use the Faraday connection directly. This allows you to do arbitrary HTTP requests to the Podio API with authentication, JSON parsing and error handling already taken care of. The same examples would look like this:
 
-    # Getting an item
-    response = Podio.connection.get('/item/42')
-    response.body
+```ruby
+# Getting an item
+response = Podio.connection.get('/item/42')
+response.body
 
-    # Posting a status message on space with id 23
-    response = Podio.connection.post do |req|
-      req.url '/status/space/23/'
-      req.body = {:value => 'This is the text of the status message'}
-    end
-    response.body
+# Posting a status message on space with id 23
+response = Podio.connection.post do |req|
+  req.url '/status/space/23/'
+  req.body = {:value => 'This is the text of the status message'}
+end
+response.body
+```
 
 All the wrapped methods either return a single model instance, an array of instances, or a simple Struct in case of pagination:
 
-    # Find all items in an app (paginated)
-    items = Podio::Item.find_all(app_id, :limit => 20)
-
-    # get count of returned items in this call
-    items.count
+```ruby
+# Find all items in an app (paginated)
+items = Podio::Item.find_all(app_id, :limit => 20)
 
-    # get the returned items in an array
-    items.all
+# get count of returned items in this call
+items.count
 
-    # get count of all items in this app
-    items.total_count
+# get the returned items in an array
+items.all
 
+# get count of all items in this app
+items.total_count
+```
 
 Active Podio
 ------------
@@ -91,61 +101,66 @@ The Podio API is based on REST requests passing JSON back and forth, but we have
 
 While the models can be used directly from this gem, we encourage everyone using Podio in a Rails project to add models that extend the standard models:
 
-    class Item < Podio::Item # Inherits from the base model in the Podio gem
-
-      # Your custom methods, e.g.:
-      def application
-        @app_instance ||= Application.find(self.app_id)
-      end
-    end
+```ruby
+class Item < Podio::Item # Inherits from the base model in the Podio gem
 
+  # Your custom methods, e.g.:
+  def application
+    @app_instance ||= Application.find(self.app_id)
+  end
+end
+```
 
 Error Handling
 --------------
 
 All unsuccessful responses returned by the API (everything that has a 4xx or 5xx HTTP status code) will throw exceptions. All exceptions inherit from `Podio::PodioError` and have three additional properties which give you more information about the error:
 
-    begin
-      Podio::Space.create({:name => 'New Space', :org_id => 42})
-    rescue Podio::BadRequestError => exc
-      puts exc.response_body      # parsed JSON response from the API
-      puts exc.response_status    # status code of the response
-      puts exc.url                # uri of the API request
+```ruby
+begin
+  Podio::Space.create({:name => 'New Space', :org_id => 42})
+rescue Podio::BadRequestError => exc
+  puts exc.response_body      # parsed JSON response from the API
+  puts exc.response_status    # status code of the response
+  puts exc.url                # uri of the API request
 
-      # you normally want this one, a human readable error description
-      puts exc.message
-    end
+  # you normally want this one, a human readable error description
+  puts exc.message
+end
+```
 
 On instance methods, however, exceptions are handled in a way similar to ActiveRecord. These methods returns a boolean indicating if the API request succeeded or not, and makes the code, description and parameters available when the request fails:
 
-    @space_contact = SpaceContact.new({:name => 'The Dude', :birthdate => 50.years.ago})
-    if @space_contact.create
-      # Success
-    else
-      # Error, check:
-      # @space_contact.error_code
-      # @space_contact.error_message
-      # @space_contact.error_parameters
-    end
-
+```ruby
+@space_contact = SpaceContact.new({:name => 'The Dude', :birthdate => 50.years.ago})
+if @space_contact.create
+  # Success
+else
+  # Error, check:
+  # @space_contact.error_code
+  # @space_contact.error_message
+  # @space_contact.error_parameters
+end
+```
 
 Full Example
 ------------
 
-    require 'rubygems'
-    require 'podio'
-
-    Podio.setup(:api_key => 'YOUR_API_KEY', :api_secret => 'YOUR_API_SECRET')
-    Podio.client.authenticate_with_credentials('YOUR_PODIO_ACCOUNT', 'YOUR_PODIO_PASSWORD')
+```ruby
+require 'rubygems'
+require 'podio'
 
-    # Print a list of organizations I'm a member of
-    my_orgs = Podio::Organization.find_all
+Podio.setup(:api_key => 'YOUR_API_KEY', :api_secret => 'YOUR_API_SECRET')
+Podio.client.authenticate_with_credentials('YOUR_PODIO_ACCOUNT', 'YOUR_PODIO_PASSWORD')
 
-    my_orgs.each do |org|
-      puts org.name
-      puts org.url
-    end
+# Print a list of organizations I'm a member of
+my_orgs = Podio::Organization.find_all
 
+my_orgs.each do |org|
+  puts org.name
+  puts org.url
+end
+```
 
 Meta
 ----

data/lib/podio.rb

@@ -1,4 +1,5 @@
 require 'faraday'
+require 'active_support'
 require 'active_support/core_ext'
 
 require 'podio/error'
@@ -69,6 +70,7 @@ module Podio
   autoload :Action,                   'podio/models/action'
   autoload :ActivationStatus,         'podio/models/activation_status'
   autoload :Activity,                 'podio/models/activity'
+  autoload :Answer,                   'podio/models/answer'
   autoload :AppStoreShare,            'podio/models/app_store_share'
   autoload :AppStoreCategory,         'podio/models/app_store_category'
   autoload :Application,              'podio/models/application'
@@ -79,6 +81,7 @@ module Podio
   autoload :ByLine,                   'podio/models/by_line'
   autoload :CalendarEvent,            'podio/models/calendar_event'
   autoload :CalendarMute,             'podio/models/calendar_mute'
+  autoload :Campaign,                 'podio/models/campaign'
   autoload :Category,                 'podio/models/category'
   autoload :Comment,                  'podio/models/comment'
   autoload :Condition,                'podio/models/condition'
@@ -87,19 +90,21 @@ module Podio
   autoload :Contact,                  'podio/models/contact'
   autoload :Contract,                 'podio/models/contract'
   autoload :ContractAccounting,       'podio/models/contract_accounting'
+  autoload :ContractAttribution,      'podio/models/contract_attribution'
   autoload :ContractEvent,            'podio/models/contract_event'
+  autoload :ContractPeriod,           'podio/models/contract_period'
   autoload :ContractPrice,            'podio/models/contract_price'
-  autoload :ContractPriceV2,          'podio/models/contract_price_v2'
   autoload :ContractUser,             'podio/models/contract_user'
   autoload :Conversation,             'podio/models/conversation'
   autoload :ConversationEvent,        'podio/models/conversation_event'
   autoload :ConversationMessage,      'podio/models/conversation_message'
   autoload :ConversationParticipant,  'podio/models/conversation_participant'
-  autoload :DateElection,             'podio/models/date_election'
+  autoload :Device,                   'podio/models/device'
   autoload :EmailSubscriptionSetting, 'podio/models/email_subscription_setting'
   autoload :EmailContact,             'podio/models/email_contact'
   autoload :Embed,                    'podio/models/embed'
   autoload :Experiment,               'podio/models/experiment'
+  autoload :Extension,                'podio/models/extension'
   autoload :ExternalFile,             'podio/models/external_file'
   autoload :FileAttachment,           'podio/models/file_attachment'
   autoload :Filter,                   'podio/models/filter'
@@ -114,6 +119,7 @@ module Podio
   autoload :ItemDiff,                 'podio/models/item_diff'
   autoload :ItemField,                'podio/models/item_field'
   autoload :ItemRevision,             'podio/models/item_revision'
+  autoload :ItemTransaction,          'podio/models/item_transaction'
   autoload :LinkedAccount,            'podio/models/linked_account'
   autoload :LinkedAccountData,        'podio/models/linked_account_data'
   autoload :Live,                     'podio/models/live'
@@ -122,13 +128,17 @@ module Podio
   autoload :NotificationGroup,        'podio/models/notification_group'
   autoload :OAuth,                    'podio/models/o_auth'
   autoload :OAuthClient,              'podio/models/o_auth_client'
+  autoload :OAuthScope,               'podio/models/o_auth_scope'
   autoload :Organization,             'podio/models/organization'
   autoload :OrganizationContact,      'podio/models/organization_contact'
   autoload :OrganizationMember,       'podio/models/organization_member'
+  autoload :OrganizationMembership,   'podio/models/organization_membership'
   autoload :OrganizationProfile,      'podio/models/organization_profile'
   autoload :Pin,                      'podio/models/pin'
   autoload :Profile,                  'podio/models/profile'
   autoload :Promotion,                'podio/models/promotion'
+  autoload :PromotionGroup,           'podio/models/promotion_group'
+  autoload :PromotionGroupMember,     'podio/models/promotion_group_member'
   autoload :Question,                 'podio/models/question'
   autoload :QuestionAnswer,           'podio/models/question_answer'
   autoload :QuestionOption,           'podio/models/question_option'
@@ -156,6 +166,9 @@ module Podio
   autoload :UserStatus,               'podio/models/user_status'
   autoload :Via,                      'podio/models/via'
   autoload :View,                     'podio/models/view'
+  autoload :Vote,                     'podio/models/vote'
+  autoload :Voting,                   'podio/models/voting'
+  autoload :Voucher,                  'podio/models/voucher'
   autoload :Widget,                   'podio/models/widget'
 
 end

data/lib/podio/client.rb

@@ -11,6 +11,7 @@ module Podio
       @oauth_token = options[:oauth_token]
       @headers = options[:custom_headers] || {}
       @adapter = options[:adapter] || Faraday.default_adapter
+      @request_options = options[:request_options] || {}
 
       if options[:enable_stubs]
         @enable_stubs = true
@@ -52,11 +53,14 @@ module Podio
     end
 
     # Sign in as a user using credentials
-    def authenticate_with_credentials(username, password)
+    def authenticate_with_credentials(username, password, offering_id=nil)
+      body = {:grant_type => 'password', :client_id => api_key, :client_secret => api_secret, :username => username, :password => password}
+      body[:offering_id] = offering_id if offering_id.present?
+
       response = @oauth_connection.post do |req|
         req.url '/oauth/token'
         req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
-        req.body = {:grant_type => 'password', :client_id => api_key, :client_secret => api_secret, :username => username, :password => password}
+        req.body = body
       end
 
       @oauth_token = OAuthToken.new(response.body)
@@ -177,12 +181,12 @@ module Podio
     end
 
     def configure_connection
-      Faraday::Connection.new(:url => api_url, :headers => configured_headers, :request => {:client => self}) do |builder|
+      Faraday::Connection.new(:url => api_url, :headers => configured_headers, :request => @request_options) do |builder|
         builder.use Middleware::JsonRequest
         builder.use Faraday::Request::Multipart
         builder.use Faraday::Request::UrlEncoded
-        builder.use Middleware::OAuth2
-        builder.use Middleware::Logger
+        builder.use Middleware::OAuth2, :podio_client => self
+        builder.use Middleware::Logger, :podio_client => self
 
         builder.adapter(*default_adapter)
 
@@ -198,7 +202,7 @@ module Podio
 
     def configure_oauth_connection
       conn = @connection.dup
-      conn.options[:client] = self
+      conn.options.update(@request_options)
       conn.headers.delete('authorization')
       conn.headers.delete('X-Podio-Dry-Run') if @test_mode # oauth requests don't really work well in test mode
       conn
@@ -206,7 +210,7 @@ module Podio
 
     def configure_trusted_connection
       conn = @connection.dup
-      conn.options[:client] = self
+      conn.options.update(@request_options)
       conn.headers.delete('authorization')
       conn.basic_auth(api_key, api_secret)
       conn

data/lib/podio/middleware/error_response.rb

@@ -5,7 +5,9 @@ module Podio
     class ErrorResponse < Faraday::Response::Middleware
       def on_complete(env)
         error_class = case env[:status]
-          when 200, 204
+          when 200, 201, 204
+            # pass
+          when 304
             # pass
           when 400
             case env[:body]['error']

data/lib/podio/middleware/json_response.rb

@@ -7,11 +7,16 @@ 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) && should_unmarshal?(env) && env[:status] != 500
           env[:body] = parse(env[:body])
         end
       end
 
+      def should_unmarshal?(env)
+        # don't unmarshal data from the API with a content-disposition header.
+        not env[:response_headers]['content-disposition'] =~ /filename=/
+      end
+
       def is_json?(env)
         env[:response_headers]['content-type'] =~ /application\/json/
       end

data/lib/podio/middleware/logger.rb

@@ -7,13 +7,14 @@ module Podio
         # Preserve request body
         env[:request_body] = env[:body] if env[:body]
 
-        env[:request][:client].log(env) do
+        @podio_client.log(env) do
           @app.call(env)
         end
       end
 
-      def initialize(app)
-        super
+      def initialize(app, options={})
+        super(app)
+        @podio_client = options[:podio_client]
       end
     end
   end

data/lib/podio/middleware/oauth2.rb

@@ -4,16 +4,15 @@ module Podio
   module Middleware
     class OAuth2 < Faraday::Middleware
       def call(env)
-        podio_client = env[:request][:client]
         orig_env = env.dup
 
         begin
           @app.call(env)
         rescue TokenExpired
-          podio_client.refresh_access_token
+          @podio_client.refresh_access_token
 
           # new access token needs to be put into the header
-          orig_env[:request_headers].merge!(podio_client.configured_headers)
+          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)
@@ -23,8 +22,9 @@ module Podio
         end
       end
 
-      def initialize(app)
-        super
+      def initialize(app, options={})
+        super(app)
+        @podio_client = options[:podio_client]
       end
     end
   end