feedlr 0.1.0

data/lib/feedlr/gateway/preferences.rb

@@ -0,0 +1,25 @@
+module Feedlr
+  module Gateway
+    # Preferences API
+    #
+    # @see http://developer.feedly.com/v3/preferences/
+    module Preferences
+      # Get the preferences of the user
+      #
+      # @see http://developer.feedly.com/v3/preferences/#get-the-preferences-of-the-user
+      # @return [Feedlr::Base]
+      def preferences
+        build_object(:get , '/preferences')
+      end
+
+      # Update the preferences of the user
+      #
+      # @see http://developer.feedly.com/v3/preferences/#update-the-preferences-of-the-user
+      # @param preferences [Hash]
+      # @return [Feedlr::Base]
+      def update_preferences(preferences)
+        build_object(:post , '/preferences' , preferences)
+      end
+    end
+  end
+end

data/lib/feedlr/gateway/profile.rb

@@ -0,0 +1,25 @@
+module Feedlr
+  module Gateway
+    # Profile API
+    #
+    # @see http://developer.feedly.com/v3/profile/
+    module Profile
+      # Get the profile of the user
+      #
+      # @see http://developer.feedly.com/v3/profile/#get-the-profile-of-the-user
+      # @return [Feedlr::Base]
+      def user_profile
+        build_object(:get , '/profile')
+      end
+
+      # Update the profile of the user
+      #
+      # @see http://developer.feedly.com/v3/profile/#update-the-profile-of-the-user
+      # @param profile [Hash]
+      # @return [Feedlr::Base]
+      def update_profile(profile)
+        build_object(:post , '/profile' , profile)
+      end
+    end
+  end
+end

data/lib/feedlr/gateway/search.rb

@@ -0,0 +1,41 @@
+module Feedlr
+  module Gateway
+    # Search API
+    #
+    # @see http://developer.feedly.com/v3/search/
+    module Search
+      # Find feeds based on title ,  url or #topic
+      #
+      # @see http://developer.feedly.com/v3/search/#find-feeds-based-on-title-url-or-topic
+      # @param query [String]
+      # @param options [Hash]
+      # @option options [String] :n number of results. default value is 20
+      # @option options [String] :locale hint the search engine
+      #  to return feeds in that locale (e.g. "pt" ,  "fr_FR")
+      # @return [Feedlr::Base]
+      def search_feeds(query , options = {})
+        build_object(:get , '/search/feeds' , { q: query }.merge(options))
+      end
+
+      # Search the content of a stream (Pro only)
+      #
+      # @see http://developer.feedly.com/v3/search/#search-the-content-of-a-stream-pro-only
+      # @param stream_id [String]
+      # @param query [String]
+      # @param options [Hash]
+      # @option options [String] :count number of entries to return
+      # @option options [String] :newerThan timestamp in ms
+      # @option options [String] :continuation a continuation id is used
+      #  to page through the content
+      # @option options [String] :unreadOnly boolean ,  default is false
+      # @option options [String] :fields a comma-separated list of fields
+      # @option options [String] :minMatches minimum number of
+      #  search terms to match before
+      # @return [Feedlr::Base]
+      def search_stream(stream_id , query , options = {})
+        build_object(:get , '/search/contents',
+                     { q: query , streamId: stream_id }.merge(options))
+      end
+    end
+  end
+end

data/lib/feedlr/gateway/shorten.rb

@@ -0,0 +1,17 @@
+module Feedlr
+  module Gateway
+    # Shorten API
+    #
+    # @see http://developer.feedly.com/v3/shorten/
+    module Shorten
+      # Create a shortened URL for an entry
+      #
+      # @see http://developer.feedly.com/v3/shorten/#create-a-shortened-url-for-an-entry
+      # @param entry_id [String]
+      # @return [String]
+      def shorten_entry(entry_id)
+        build_object(:get , "/shorten/entries/#{CGI.escape(entry_id) }")
+      end
+    end
+  end
+end

data/lib/feedlr/gateway/streams.rb

@@ -0,0 +1,42 @@
+module Feedlr
+  module Gateway
+    # Streams API
+    #
+    # @see http://developer.feedly.com/v3/streams/
+    module Streams
+      # Get a list of entry ids for a specific stream
+      #
+      # @see http://developer.feedly.com/v3/streams/#get-a-list-of-entry-ids-for-a-specific-stream
+      # @param stream_id [String]
+      # @param options [Hash]
+      # @option options [String] :count mber of entry ids to return.
+      #  default is 20. max is 10,000
+      # @option options [String] :ranked newest or oldest. default is newest
+      # @option options [String] :unreadOnly boolean default value is false
+      # @option options [String] :newerThan timestamp in ms
+      # @option options [String] :continuation a continuation id is
+      #  used to page through the entry ids
+      # @return [Feedlr::Base]
+      def stream_entries_ids(stream_id , options = {})
+        build_object(:get , "/streams/#{CGI.escape(stream_id) }/ids" , options)
+      end
+      # Get the content of a stream
+      #
+      # @see http://developer.feedly.com/v3/streams/#get-the-content-of-a-stream
+      # @param stream_id [String]
+      # @param options [Hash]
+      # @option options [String] :count mber of entry ids to return.
+      #  default is 20. max is 10 , 000
+      # @option options [String] :ranked newest or oldest. default is newest
+      # @option options [String] :unreadOnly boolean default value is false
+      # @option options [String] :newerThan timestamp in ms
+      # @option options [String] :continuation a continuation id
+      #  is used to page through the entry ids
+      # @return [Feedlr::Base]
+      def stream_entries_contents(stream_id , options = {})
+        build_object(:get, "/streams/#{CGI.escape(stream_id)}/contents",
+                     options)
+      end
+    end
+  end
+end

data/lib/feedlr/gateway/subscriptions.rb

@@ -0,0 +1,43 @@
+module Feedlr
+  module Gateway
+    # Subscriptions API
+    #
+    # @see http://developer.feedly.com/v3/subscriptions/
+    module Subscriptions
+      # Get the user's subscriptions
+      #
+      # @see http://developer.feedly.com/v3/subscriptions/#get-the-users-subscriptions
+      # @return [Feedlr::Collection]
+      def user_subscriptions
+        build_object(:get , '/subscriptions')
+      end
+
+      # Subscribe to a feed
+      #
+      # @see http://developer.feedly.com/v3/subscriptions/#subscribe-to-a-feed
+      # @param subscription [Hash]
+      # @return [Feedlr::Base]
+      def add_subscription(subscription)
+        build_object(:post , '/subscriptions' , subscription)
+      end
+
+      # Update an existing subscription
+      #
+      # @see http://developer.feedly.com/v3/subscriptions/#update-an-existing-subscription
+      # @param subscription [Hash]
+      # @return [Feedlr::Success]
+      def update_subscription(subscription)
+        add_subscription(subscription)
+      end
+
+      # Unsubscribe from a feed
+      #
+      # @see http://developer.feedly.com/v3/subscriptions/#unsubscribe-from-a-feed
+      # @param subscription_id [String]
+      # @return [Feedlr::Success]
+      def delete_subscription(subscription_id)
+        build_object(:delete , "/subscriptions/#{CGI.escape(subscription_id) }")
+      end
+    end
+  end
+end

data/lib/feedlr/gateway/tags.rb

@@ -0,0 +1,88 @@
+module Feedlr
+  module Gateway
+    # Tags API
+    #
+    # @see http://developer.feedly.com/v3/tags/
+    module Tags
+      # Get the list of tags created by the user
+      #
+      # @see http://developer.feedly.com/v3/tags/#get-the-list-of-tags-created-by-the-user
+      # @return [Feedlr::Collection]
+      def user_tags
+        build_object(:get , '/tags')
+      end
+
+      # Tag an existing entry
+      #
+      # @see tag_entries
+      # @param entry_id [String]
+      # @param tags_ids [Array] list of tags ids
+      # @return [Feedlr::Success]
+      def tag_entry(entry_id , tags_ids)
+        tag_entries([entry_id] , tags_ids)
+      end
+
+      # Tag multiple entries
+      #
+      # @see http://developer.feedly.com/v3/tags/#tag-multiple-entries
+      # @param entries_ids [Array] list of entries ids
+      # @param tags_ids [Array] list of tags ids
+      # @return [Feedlr::Success]
+      def tag_entries(entries_ids , tags_ids)
+        tags_query = tags_ids.map { |t| CGI.escape(t) }.join(',')
+        build_object(:put , "/tags/#{tags_query}" , entryIds: entries_ids)
+      end
+
+      # Untag an existing entry
+      #
+      # @see untag_entries
+      # @param entry_id [String]
+      # @param tags_ids [Array] list of tags ids
+      # @return [Feedlr::Success]
+      def untag_entry(entry_id , tags_ids)
+        untag_entries([entry_id] , tags_ids)
+      end
+
+      # Untag multiple entries
+      #
+      # @see http://developer.feedly.com/v3/tags/#untag-multiple-entries
+      # @param entries_ids [Array] list of entries ids
+      # @param tags_ids [Array] list of tags ids
+      # @return [Feedlr::Success]
+      def untag_entries(entries_ids , tags_ids)
+        tags_query = tags_ids.map { |t| CGI.escape(t) }.join(',')
+        entries_query = entries_ids.map { |t| CGI.escape(t) }.join(',')
+        build_object(:delete , "/tags/#{tags_query}/#{entries_query}")
+      end
+
+      # Change a tag label
+      #
+      # @see http://developer.feedly.com/v3/tags/#change-a-tag-label
+      # @param tag_id [String]
+      # @param new_value [String] label's new value
+      # @return [Feedlr::Success]
+      def change_tag_label(tag_id , new_value)
+        build_object(:post , "/tags/#{CGI.escape(tag_id) }" , label: new_value)
+      end
+
+      # Delete a tag
+      #
+      # @see delete_tags
+      # @param tag_id [String]
+      # @return [Feedlr::Success]
+      def delete_tag(tag_id)
+        delete_tags([tag_id])
+      end
+
+      # Delete tags
+      #
+      # @see http://developer.feedly.com/v3/tags/#delete-tags
+      # @param tags_ids [Array] list of ids
+      # @return [Feedlr::Success]
+      def delete_tags(tags_ids)
+        tags_query = tags_ids.map { |t| CGI.escape(t) }.join(',')
+        build_object(:delete , "/tags/#{tags_query }")
+      end
+    end
+  end
+end

data/lib/feedlr/gateway/topics.rb

@@ -0,0 +1,43 @@
+module Feedlr
+  module Gateway
+    # Topics API
+    #
+    # @see http://developer.feedly.com/v3/topics/
+    module Topics
+      # Get the list of topics the user has added to their feedly
+      #
+      # @see http://developer.feedly.com/v3/topics/#get-the-list-of-topics-the-user-has-added-to-their-feedly
+      # @return [Feedlr::Collection]
+      def user_topics
+        build_object(:get , '/topics')
+      end
+
+      # Add a topic to the user feedly account
+      #
+      # @see http://developer.feedly.com/v3/topics/#add-a-topic-to-the-user-feedly-account
+      # @param topic [Hash]
+      # @return [Feedlr::Success]
+      def add_topic(topic)
+        build_object(:post , '/topics' ,  topic)
+      end
+
+      # Update an existing topic
+      #
+      # @see http://developer.feedly.com/v3/topics/#update-an-existing-topic
+      # @param topic [Hash]
+      # @return [Feedlr::Success]
+      def update_topic(topic)
+        build_object(:post , '/topics' ,  topic)
+      end
+
+      # Remove a topic from a feedly account
+      #
+      # @see http://developer.feedly.com/v3/topics/#remove-a-topic-from-a-feedly-account
+      # @param topic_id [String]
+      # @return [Feedlr::Success]
+      def delete_topic(topic_id)
+        build_object(:delete , "/topics/#{CGI.escape(topic_id) }")
+      end
+    end
+  end
+end

data/lib/feedlr/gateway/twitter.rb

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

data/lib/feedlr/mapper.rb

@@ -0,0 +1,25 @@
+require 'hashie'
+require 'multi_json'
+require_relative 'base'
+require_relative 'collection'
+require_relative 'success'
+
+module Feedlr
+  # The generalized pseudo-object that is returned for all query
+  # requests.
+  # http://martinfowler.com/eaaCatalog/dataMapper.html
+  class Mapper
+    # Build the proper object depending on the response
+    # @return [Feedlr::Base, Feedlr::Success, Feedlr::Collection]
+    def self.build(data)
+      case data
+      when Hash
+        (data.size > 0) ? Feedlr::Base.new(data) : Feedlr::Success.new
+      when Array
+        Feedlr::Collection.new(data)
+      else
+        Feedlr::Success.new
+      end
+    end
+  end
+end

data/lib/feedlr/rate_limit.rb

@@ -0,0 +1,21 @@
+module Feedlr
+  # Rate limiting object associated with responses
+  class RateLimit
+    attr_reader :count, :limit, :remaining
+    # Initializes a new object
+    #
+    # @param attrs [Hash]
+    # @option attrs [String] :x-ratelimit-count
+    # @option attrs [String] :x-ratelimit-limit
+    # @option attrs [String] :x-ratelimit-remaining
+    # @return [Feedlr::RateLimit]
+    def initialize(attrs =  {})
+      @count =
+        attrs['x-ratelimit-count'].to_i if attrs['x-ratelimit-count']
+      @limit =
+        attrs['x-ratelimit-limit'].to_i if attrs['x-ratelimit-limit']
+      @remaining =
+        attrs['x-ratelimit-remaining'].to_i if attrs['x-ratelimit-remaining']
+    end
+  end
+end

data/lib/feedlr/request.rb

@@ -0,0 +1,148 @@
+require 'faraday'
+require 'faraday_middleware'
+require_relative 'mapper'
+require_relative 'error'
+
+module Feedlr
+  # Do all http requests and call the mapper
+  module Request
+    ENDPOINT = 'http://cloud.feedly.com'
+    SANDBOX_ENDPOINT = 'http://sandbox.feedly.com'
+    API_VERSION = '/v3'
+
+    private
+
+    # Run an HTTP request and map the response to a domain class
+    # @param method [String] HTTP method
+    # @param path [String]
+    # @param params [Hash]
+    # @param headers [Hash]
+    # @return [Faraday::Response]
+    def build_object(method, path, params = nil, headers = nil)
+      response = send(method, path, params, headers)
+      Mapper.build(response.body)
+    end
+
+    %w(post put).each do |method|
+      class_eval <<-RUBY ,  __FILE__ ,  __LINE__ + 1
+          def #{method}(path, params, headers)
+              request(:#{method}, path, headers) do |request|
+                if !headers || headers[:"Content-Type"].nil?
+                  params = MultiJson.dump(params)
+                end
+                request.body = params if params
+              end
+          end
+      RUBY
+    end
+
+    %w(get delete).each do |method|
+      class_eval <<-RUBY ,  __FILE__ ,  __LINE__ + 1
+          def #{method}(path, params, headers)
+              request(:#{method}, path, headers) do |request|
+                request.params.update(params) if params
+              end
+          end
+      RUBY
+    end
+
+    # Initiate and memoize the HTTP connection object
+    # @return [Faraday::Connection]
+    def connection
+      @connection ||= Faraday.new(end_point, connection_options)
+    end
+
+    # Build and memoize the connection options
+    # @return [Hash]
+    def connection_options
+      @connection_options ||=  {
+        builder: middleware,
+        headers: request_headers,
+        request:  {
+          open_timeout: 10,
+          timeout: 30
+         }
+       }
+    end
+
+    # Build and memoize the rack middleware for the requests
+    # @return [Faraday::RackBuilder]
+    def middleware
+      @middleware ||= Faraday::RackBuilder.new do |faraday|
+        faraday.request :url_encoded
+        # Add logging
+        faraday.response(:logger, logger) unless logger.nil?
+        # Parse XML
+        faraday.response :xml, content_type: /\bxml$/
+        # Parse JSON
+        faraday.response :json, content_type: /\bjson$/
+
+        faraday.adapter :net_http
+      end
+    end
+
+    # Run the desired HTTP request, verifies it, raise excpetions in
+    #  case of failure, otherwise return the response
+    # @param method [String] HTTP method
+    # @param path [String]
+    # @param headers [Hash]
+    # @return [Faraday::Response]
+    def request(method, path, headers, &block)
+      response = run_request(method, path, headers, &block)
+      logger.debug(response.inspect) unless logger.nil?
+      verify_success(response)
+      response
+    rescue Faraday::Error::TimeoutError, Timeout::Error => error
+      raise(Feedlr::Error::RequestTimeout.new, error.message)
+    rescue Faraday::Error::ClientError, JSON::ParserError => error
+      raise(Feedlr::Error.new, error.message)
+    end
+
+    # Run the actual request
+    # @param method [String] HTTP method
+    # @param path [String]
+    # @param headers [Hash]
+    # @return [Faraday::Response]
+    def run_request(method, path, headers)
+      connection.send(method) do |request|
+        request.url(API_VERSION + path)
+        request.headers.update(headers) if headers
+        yield(request) if block_given?
+      end
+    end
+
+    # Check the response code and raise exceptions if needed
+    # param response [Faraday::Response]
+    # @return [void]
+    def verify_success(response)
+      status_code = response.status.to_i
+      klass = Feedlr::Error.errors[status_code]
+      fail(klass.from_response(response)) if klass
+    end
+
+    # Build and memoize the initial request headers
+    # @return [Hash]
+    def request_headers
+      return unless @headers.nil?
+      @headers = { :"Accept" => 'application/json',
+                   :"Content-Type" => 'application/json',
+                   :user_agent => user_agent
+      }
+      @headers[:Authorization] =
+                  "OAuth #{oauth_access_token}" if oauth_access_token
+      @headers
+    end
+
+    # Build and memoize the user agent
+    # @return [String]
+    def user_agent
+      @user_agent ||= "Feedlr Ruby Gem #{Feedlr::Version}"
+    end
+
+    # Build and memoize the endpoint
+    # @return [String]
+    def end_point
+      @end_point ||= (sandbox ? SANDBOX_ENDPOINT : ENDPOINT)
+    end
+  end
+end