feedlr 0.1.0

data/lib/feedlr/gateway/categories.rb

@@ -0,0 +1,36 @@
+module Feedlr
+  module Gateway
+    # Categories API
+    #
+    # @see http://developer.feedly.com/v3/categories/
+    module Categories
+      # Get the list of all user categories
+      #
+      # @see http://developer.feedly.com/v3/categories/get-the-list-of-all-categories
+      # @return [Feedlr::Collection]
+      def user_categories
+        build_object(:get , '/categories')
+      end
+
+      # Change the label of an existing user category
+      #
+      # @see http://developer.feedly.com/v3/categories/#change-the-label-of-an-existing-category
+      # @param category_id [String]
+      # @param new_value [String] label's new value
+      # @return [Feedlr::Success]
+      def change_category_label(category_id , new_value)
+        build_object(:post , "/categories/#{CGI.escape(category_id) }" ,
+                     label: new_value)
+      end
+
+      # Delete a user category
+      #
+      # @see http://developer.feedly.com/v3/categories/#delete-a-category
+      # @param category_id [String]
+      # @return [Feedlr::Success]
+      def delete_category(category_id)
+        build_object(:delete , "/categories/#{CGI.escape(category_id) }")
+      end
+    end
+  end
+end

data/lib/feedlr/gateway/entries.rb

@@ -0,0 +1,40 @@
+module Feedlr
+  module Gateway
+    # Entries API
+    #
+    # @see http://developer.feedly.com/v3/entries/
+    module Entries
+      # Get the content of an entry
+      #
+      # @see user_entries
+      # @param entry_id [String]
+      # @return [Feedlr::Base]
+      def user_entry(entry_id)
+        user_entries([entry_id]).first
+      end
+
+      # Get the content for a dynamic list of entries
+      #
+      # @see http://developer.feedly.com/v3/entries/#get-the-content-for-a-dynamic-list-of-entries
+      # @param entries_ids [Array] list of ids
+      # @param options [Hash]
+      # @option options [String] :continuation next cursor id
+      # @return [Feedlr::Collection]
+      def user_entries(entries_ids ,  options =  {})
+        build_object(:post , '/entries/.mget',
+                     continuation: options[:continuation],
+                     ids: entries_ids
+                     )
+      end
+
+      # Create and tag an entry
+      #
+      # @see http://developer.feedly.com/v3/entries/#create-and-tag-an-entry
+      # @param entry [Hash]
+      # @return [String]
+      def add_entry(entry)
+        build_object(:post , '/entries' ,  entry).first
+      end
+    end
+  end
+end

data/lib/feedlr/gateway/evernote.rb

@@ -0,0 +1,37 @@
+module Feedlr
+  module Gateway
+    # Evernote API
+    #
+    # @see http://developer.feedly.com/v3/evernote/
+    # The following API actions do not have corresponding methods in
+    # this module:
+    #
+    #   * Link Evernote account
+    module Evernote
+      # Unlink Evernote account
+      #
+      # @see http://developer.feedly.com/v3/evernote/#unlink-evernote-account
+      # @return [Feedlr::Success]
+      def unlink_evernote
+        build_object(:delete , '/evernote/auth')
+      end
+
+      # Get a list of Evernote notebooks (Pro only)
+      #
+      # @see http://developer.feedly.com/v3/evernote/#get-a-list-of-evernote-notebooks-pro-only
+      # @return [Feedlr::Collection]
+      def evernote_notebooks
+        build_object(:get , '/evernote/notebooks')
+      end
+
+      # Save an article as a note (Pro only)
+      #
+      # @see http://developer.feedly.com/v3/evernote/#save-an-article-as-a-note-pro-only
+      # @param entry [Hash]
+      # @return [Feedlr::Success]
+      def add_to_evernote(entry)
+        build_object(:post , '/evernote/note' , entry)
+      end
+    end
+  end
+end

data/lib/feedlr/gateway/facebook.rb

@@ -0,0 +1,28 @@
+module Feedlr
+  module Gateway
+    # Facebook API
+    #
+    # @see http://developer.feedly.com/v3/facebook/
+    # The following API actions do not have corresponding methods in
+    # this module:
+    #
+    #   * Link Facebook account
+    module Facebook
+      # Unlink Facebook account
+      #
+      # @see http://developer.feedly.com/v3/facebook/#unlink-facebook-account
+      # @return [Feedlr::Success]
+      def unlink_facebook
+        build_object(:delete , '/facebook/auth')
+      end
+
+      # Get suggested feeds
+      #
+      # @see http://developer.feedly.com/v3/facebook/#get-suggested-feeds
+      # @return [Feedlr::Collection]
+      def facebook_suggestions
+        build_object(:get , '/facebook/suggestions')
+      end
+    end
+  end
+end

data/lib/feedlr/gateway/feeds.rb

@@ -0,0 +1,26 @@
+module Feedlr
+  module Gateway
+    # Feeds API
+    #
+    # @see http://developer.feedly.com/v3/feeds/
+    module Feeds
+      # Get the metadata about a specific feed
+      #
+      # @see http://developer.feedly.com/v3/feeds/#get-the-metadata-about-a-specific-feed
+      # @param feed_id [String]
+      # @return [Feedlr::Base]
+      def feed(feed_id)
+        feeds([feed_id]).first
+      end
+
+      # Get the metadata for a list of feeds
+      #
+      # @see http://developer.feedly.com/v3/feeds/#get-the-metadata-for-a-list-of-feeds
+      # @param feeds_ids [Array] list of ids
+      # @return [Feedlr::Collection]
+      def feeds(feeds_ids)
+        build_object(:post , '/feeds/.mget' , feeds_ids)
+      end
+    end
+  end
+end

data/lib/feedlr/gateway/markers.rb

@@ -0,0 +1,195 @@
+module Feedlr
+  module Gateway
+    # Markers API
+    #
+    # @see http://developer.feedly.com/v3/markers/
+    module Markers
+      # Get the list of unread counts
+      #
+      # @see http://developer.feedly.com/v3/markers/#get-the-list-of-unread-counts
+      # @param options [Hash]
+      # @option options [String] :autorefresh let's the server know
+      #  if this is a background auto-refresh or not
+      # @option options [String] :newerThan timestamp in ms. Default is 30 days.
+      # @option options [String] :streamId A user or system category
+      #  can be passed to restrict the unread count response
+      #  to feeds in this category
+      # @return [Feedlr::Base]
+      def user_unread_counts(options = {})
+        build_object(:get , '/markers/counts' , options)
+      end
+
+      # Mark an articles as read
+      #
+      # @see mark_articles_as_read
+      # @param article_id [String]
+      # @return [Feedlr::Success]
+      def mark_article_as_read(article_id)
+        mark_articles_as_read([article_id])
+      end
+
+      # Mark multiple articles as read
+      #
+      # @see http://developer.feedly.com/v3/markers/#mark-one-or-multiple-articles-as-read
+      # @param articles_ids [Array]
+      # @return [Feedlr::Success]
+      def mark_articles_as_read(articles_ids)
+        build_object(:post , '/markers' ,
+                     entryIds: articles_ids ,
+                     action: 'markAsRead' ,
+                     type: 'entries'
+                     )
+      end
+
+      # Keep an article as unread
+      #
+      # @see mark_articles_as_unread
+      # @param article_id [String]
+      # @return [Feedlr::Success]
+      def mark_article_as_unread(article_id)
+        mark_articles_as_unread([article_id])
+      end
+
+      # Keep multiple articles as unread
+      #
+      # @see http://developer.feedly.com/v3/markers/#mark-one-or-multiple-articles-as-read
+      # @param articles_ids [Array]
+      # @return [Feedlr::Success]
+      def mark_articles_as_unread(articles_ids)
+        build_object(:post , '/markers' ,
+                     entryIds: articles_ids ,
+                     action: 'keepUnread' ,
+                     type: 'entries'
+                     )
+      end
+
+      # Mark feeds as read
+      #
+      # @see mark_feeds_as_read
+      # @param feed_id [String]
+      # @param options [Hash]
+      # @return [Feedlr::Success]
+      def mark_feed_as_read(feed_id , options)
+        mark_feeds_as_read([feed_id] , options)
+      end
+
+      # Mark feeds as read
+      #
+      # @see http://developer.feedly.com/v3/markers/#mark-a-feed-as-read
+      # @param feeds_ids [Array]
+      # @param options [Hash]
+      # @option options [String] :lastReadEntryId
+      # @option options [String] :asOf timestamp
+      # @return [Feedlr::Success]
+      def mark_feeds_as_read(feeds_ids, options)
+        fail(ArgumentError) unless options[:lastReadEntryId] || options[:asOf]
+
+        opts =  {
+          feedIds: feeds_ids ,
+          action: 'markAsRead' ,
+          type: 'feeds'
+        }
+        opts[:lastReadEntryId] =
+          options[:lastReadEntryId] if options[:lastReadEntryId]
+        opts[:asOf] = options[:asOf] if options[:asOf]
+        build_object(:post , '/markers' , opts)
+      end
+
+      # Mark a category as read
+      #
+      # @see mark_categories_as_read
+      # @param category_id [String]
+      # @param options [Hash]
+      # @return [Feedlr::Success]
+      def mark_category_as_read(category_id , options)
+        mark_categories_as_read([category_id] , options)
+      end
+
+      # Mark categories as read
+      #
+      # @see http://developer.feedly.com/v3/markers/#mark-a-category-as-read
+      # @param categories_ids [Array]
+      # @param options [Hash]
+      # @option options [String] :lastReadEntryId
+      # @option options [String] :asOf timestamp
+      # @return [Feedlr::Success]
+      def mark_categories_as_read(categories_ids, options)
+        fail(ArgumentError) unless options[:lastReadEntryId] || options[:asOf]
+
+        opts =  {
+          categoryIds: categories_ids ,
+          action: 'markAsRead' ,
+          type: 'categories'
+        }
+        opts[:lastReadEntryId] =
+          options[:lastReadEntryId] if options[:lastReadEntryId]
+        opts[:asOf] = options[:asOf] if options[:asOf]
+        build_object(:post , '/markers' , opts)
+      end
+
+      # Undo mark a feed as read
+      #
+      # @see undo_mark_feeds_as_read
+      # @param feed_id [String]
+      # @return [Feedlr::Success]
+      def undo_mark_feed_as_read(feed_id)
+        undo_mark_feeds_as_read([feed_id])
+      end
+
+      # Undo mark feeds as read
+      #
+      # @see http://developer.feedly.com/v3/markers/#undo-mark-as-read
+      # @param feeds_ids [Array]
+      # @return [Feedlr::Success]
+      def undo_mark_feeds_as_read(feeds_ids)
+        build_object(:post , '/markers',
+                     feedIds: feeds_ids ,
+                     action: 'undoMarkAsRead' ,
+                     type: 'feeds'
+                     )
+      end
+
+      # Undo Mark a category as read
+      #
+      # @see undo_mark_categories_as_read
+      # @param category_id [String]
+      # @return [Feedlr::Success]
+      def undo_mark_category_as_read(category_id)
+        undo_mark_categories_as_read([category_id])
+      end
+
+      # Undo mark categories as read
+      #
+      # @see http://developer.feedly.com/v3/markers/#undo-mark-as-read
+      # @param categories_ids [Array]
+      # @return [Feedlr::Success]
+      def undo_mark_categories_as_read(categories_ids)
+        build_object(:post , '/markers',
+                     categoryIds: categories_ids,
+                     action: 'undoMarkAsRead',
+                     type: 'categories'
+                     )
+      end
+
+      # Get the latest read operations (to sync local cache)
+      #
+      # @see http://developer.feedly.com/v3/markers/#get-the-latest-read-operations-to-sync-local-cache
+      # @param options [Hash]
+      # @option options [String] :newerThan timestamp in ms. Default is 30 days.
+      # @return [Feedlr::Base]
+      def sync_read_counts(options = {})
+        build_object(:get , '/markers/reads' , options)
+      end
+
+      # Get the latest tagged entry ids
+      #
+      # @see http://developer.feedly.com/v3/markers/#get-the-latest-tagged-entry-ids
+      # @param options [Hash]
+      # @option options [String] :newerThan timestamp in ms. Default is 30 days.
+      # @return [Feedlr::Base]
+      def lastest_tagged_entries(options = {})
+        build_object(:get , '/markers/tags' , options)
+      end
+    end
+  end
+end

data/lib/feedlr/gateway/microsoft.rb

@@ -0,0 +1,30 @@
+module Feedlr
+  module Gateway
+    # Microsoft API
+    #
+    # @see http://developer.feedly.com/v3/microsoft/
+    #
+    # The following API actions do not have corresponding methods in
+    # this module:
+    #
+    #   * Link Microsoft Account
+    module Microsoft
+      # Unlink Windows Live account
+      #
+      # @see http://developer.feedly.com/v3/microsoft/#unlink-windows-live-account
+      # @return [Feedlr::Success]
+      def unlink_microsoft
+        build_object(:delete , '/microsoft/liveAuth')
+      end
+
+      # Add an article in OneNote
+      #
+      # @see http://developer.feedly.com/v3/microsoft/#add-an-article-in-onenote
+      # @param entry_id [String]
+      # @return [Feedlr::Success]
+      def add_to_onenote(entry_id)
+        build_object(:post , '/microsoft/oneNoteAdd', entryId: entry_id)
+      end
+    end
+  end
+end

data/lib/feedlr/gateway/mixes.rb

@@ -0,0 +1,29 @@
+module Feedlr
+  module Gateway
+    # Mixes API
+    #
+    # @see http://developer.feedly.com/v3/mixes/
+    module Mixes
+      # Get a mix of the most engaging content available in a stream
+      #
+      # @see http://developer.feedly.com/v3/mixes/#get-a-mix-of-the-most-engaging-content-available-in-a-stream
+      # @param stream_id [String]
+      # @param options [Hash]
+      # @option options [String] :count number of entry ids to return.
+      #  default is 3. max is 20
+      # @option options [String] :unreadOnly boolean default value is false
+      # @option options [String] :hours hour of the day
+      # @option options [String] :newerThan timestamp in ms
+      # @option options [String] :backfill if "hours" is provided,
+      #  and there aren't enough articles to match the entry count requested,
+      #  the server will look back in time to find more articles.
+      #  Articles from the first n hours will be returned first
+      # @option options [String] :locale preferred locale for results
+      # @return [Feedlr::Base]
+      def stream_most_engaging(stream_id , options = {})
+        build_object(:get, '/mixes/contents',
+                     { streamId: stream_id }.merge(options))
+      end
+    end
+  end
+end

data/lib/feedlr/gateway/opml.rb

@@ -0,0 +1,26 @@
+module Feedlr
+  module Gateway
+    # OPML API
+    #
+    # @see http://developer.feedly.com/v3/opml/
+    module Opml
+      # Export the user's subscriptions as an OPML file
+      #
+      # @see http://developer.feedly.com/v3/opml/#export-the-users-subscriptions-as-an-opml-file
+      # @return [Feedlr::Base]
+      def user_opml
+        build_object(:get, '/opml', {}, :'Content-Type' => 'text/xml')
+      end
+
+      # Import an OPML
+      #
+      # @see http://developer.feedly.com/v3/opml/#import-an-opml
+      # @param io_stream [IOStream] Any IOStream object
+      # @return [Feedlr::Success]
+      def import_opml(io_stream)
+        build_object(:post, '/opml', io_stream.read,
+                     :'Content-Type' => 'text/xml')
+      end
+    end
+  end
+end