Module: Feedlr::Gateway::Subscriptions

Included in:

Client

Defined in:

lib/feedlr/gateway/subscriptions.rb

Overview

Subscriptions API

See Also:

• http://developer.feedly.com/v3/subscriptions/

Instance Method Summary

• #add_subscription(subscription) ⇒ Feedlr::Base

  Subscribe to a feed.

• #delete_subscription(subscription_id) ⇒ Feedlr::Success

  Unsubscribe from a feed.

• #update_subscription(subscription) ⇒ Feedlr::Success

  Update an existing subscription.

• #user_subscriptions ⇒ Feedlr::Collection

  Get the user's subscriptions.

Instance Method Details

#add_subscription(subscription) ⇒ Feedlr::Base

Subscribe to a feed

Parameters:

• subscription (Hash)

Returns:

• (Feedlr::Base)

See Also:

• http://developer.feedly.com/v3/subscriptions/#subscribe-to-a-feed

# File 'lib/feedlr/gateway/subscriptions.rb', line 20

def add_subscription(subscription)
  build_object(:post , '/subscriptions' , subscription)
end

#delete_subscription(subscription_id) ⇒ Feedlr::Success

Unsubscribe from a feed

Parameters:

• subscription_id (String)

Returns:

• (Feedlr::Success)

See Also:

• http://developer.feedly.com/v3/subscriptions/#unsubscribe-from-a-feed

# File 'lib/feedlr/gateway/subscriptions.rb', line 38

def delete_subscription(subscription_id)
  build_object(:delete , "/subscriptions/#{CGI.escape(subscription_id) }")
end

#update_subscription(subscription) ⇒ Feedlr::Success

Update an existing subscription

Parameters:

• subscription (Hash)

Returns:

• (Feedlr::Success)

See Also:

• http://developer.feedly.com/v3/subscriptions/#update-an-existing-subscription

# File 'lib/feedlr/gateway/subscriptions.rb', line 29

def update_subscription(subscription)
  add_subscription(subscription)
end

#user_subscriptions ⇒ Feedlr::Collection

Get the user's subscriptions

Returns:

• (Feedlr::Collection)

See Also:

• http://developer.feedly.com/v3/subscriptions/#get-the-users-subscriptions

# File 'lib/feedlr/gateway/subscriptions.rb', line 11

def user_subscriptions
  build_object(:get , '/subscriptions')
end