feedlr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f9c5f933f7d90ed296ad50e4483b6ff27223c49
+  data.tar.gz: fcab7c715235c6e2ecb9c4b3d1e225badc560c37
+SHA512:
+  metadata.gz: a7fac4759e1982913e43619c155ecbe1b05f5251348cfaf2f1d8f034b700cf8e8d1b27daa86352dd67a52ea160953c69840a94b856e340b126de4c230f666df2
+  data.tar.gz: 72e2b987f48703a02d2a2ec8e16c0b632f96d2e5fedcbaae4f2b1f71bc35b8d3e7ea03884e9a86c7e89d7975e7ccba55cac68d17a2cfa44196de29a7c3eea45d

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format Nc
+--format=doc

data/.travis.yml

@@ -0,0 +1,22 @@
+bundler_args: --without development
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - rbx-2
+  - jruby-19mode
+  - ruby-head
+  - jruby-head
+matrix:
+  include:
+    - rvm: jruby-19mode
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+    - rvm: jruby-head
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: rbx-2
+    - rvm: ruby-head
+  fast_finish: true

data/.yardopts

@@ -0,0 +1,5 @@
+--no-private
+--markup markdown
+-
+README.md
+LICENSE.md

data/Gemfile

@@ -0,0 +1,32 @@
+source 'https://rubygems.org'
+
+gem 'jruby-openssl', :platforms => :jruby
+gem 'rake'
+gem 'yard'
+
+group :development do
+  gem 'pry'
+  gem 'pry-remote'
+  gem 'pry-nav'
+  platforms :ruby_19, :ruby_20, :ruby_21 do
+    gem 'redcarpet'
+  end
+end
+
+group :test do
+  gem 'coveralls', '~> 0.7', :require => false
+  gem 'rspec', '>= 2.14'
+  gem 'rspec-nc'
+  gem 'rubocop', '>= 0.2', :platforms => [:ruby_19, :ruby_20, :ruby_21]
+  gem 'simplecov', '~> 0.7.1', :require => false
+  if RUBY_VERSION >= "1.9.3"
+    gem 'guard', '~> 2.6'
+    gem 'guard-rspec', '~> 4.2'
+  end
+  gem 'webmock', '~> 1.1'
+  gem 'vcr', '~> 2.5'
+end
+
+
+# Specify your gem's dependencies in feedlr.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^spec/gateway/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/feedlr/#{m[1]}_spec.rb" }
+  watch(%r{^lib/gateway/(.+)\.rb$})     { |m| "spec/feedlr/gateway/#{m[1]}_spec.rb" }
+  watch('spec/helper.rb')  { "spec" }
+end

data/LICENSE.md

@@ -0,0 +1,16 @@
+Copyright (c) 2014 Khaled alHabache
+
+LGPL-3.0 License
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 3.0 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library.

data/README.md

@@ -0,0 +1,85 @@
+# Feedlr
+
+A Ruby interface to Feedly's [API](http://developer.feedly.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'feedlr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install feedlr
+
+## Usage
+
+### Baisc usage
+
+```ruby
+require 'feedlr'
+client = Feedlr::Client.new(oauth_access_token: 'oauth access token')
+# Fetch user categories
+p client.user_categories
+# Fetch user subscriptions
+p client.user_subscriptions
+```
+
+### Detailed API
+
+You can easily inspect the available client methods:
+
+```ruby
+require 'feedlr'
+client = Feedlr::Client.new
+p client.methods.sort - Object.methods
+```
+
+Also, the gem is fairly documented. Browse the YARD [documentaion](http://rubydoc.info/gems/feedlr/) for more information.
+
+### Global configuration
+
+You can have a global configuration that instances can use. For example,  you can have the following in some initializer's code:
+
+```ruby
+Feedlr.configure do |config|
+  config.oauth_access_token = 'oauth access token'
+  config.sandbox = true
+  config.logger = SomeCustomLogger.new
+end
+```
+And elsewhere you can do:
+```ruby
+client = Feedlr::Client.new
+```
+
+### Instance initialization
+
+You can set the oauth access token, a custom logger(if needed) and whether or not to use the client on sandbox(develpment) mode:
+
+```ruby
+require 'feedlr'
+require 'logger'
+client = Feedlr::Client.new(
+  oauth_access_token: 'oauth access token',
+  sandbox: true,
+  logger: Logger.new(STDOUT)
+)
+```
+
+### Rate limiting
+
+The client deals with a variaty of [errors](http://rubydoc.info/gems/feedlr/Error). The errors have a corresponding [rate_limit]((http://rubydoc.info/gems/feedlr/RateLimit)) object that maps to the returned rate limiting [headers](http://developer.feedly.com/v3/#rate-limiting) if any.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'doc']
+end
+
+task :default => :spec

data/feedlr.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'feedlr/version'
+
+Gem::Specification.new do |gem|
+  gem.add_dependency 'hashie', '~> 2.0'
+  gem.add_dependency 'multi_xml', '~> 0.5'
+  gem.add_dependency 'multi_json', '~> 1.0'
+  gem.add_dependency 'faraday', '~> 0.9'
+  gem.add_dependency 'faraday_middleware', '~> 0.9'
+
+  gem.name          = 'feedlr'
+  gem.version       = Feedlr::Version
+  gem.authors       = ['Khaled alHabache']
+  gem.email         = ['khellls@gmail.com']
+  gem.description   = %q(A Ruby interface to the Feedly API.)
+  gem.summary       = %q(A Ruby interface to the Feedly API.)
+  gem.homepage      = 'http://github.com/khelll/feedlr'
+  gem.license       = 'LGPL-3'
+  gem.required_ruby_version = '>= 1.9.2'
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files = Dir.glob('spec/**/*')
+  gem.require_paths = ['lib']
+end

data/lib/feedlr.rb

@@ -0,0 +1,34 @@
+require_relative 'feedlr/version'
+require_relative 'feedlr/client'
+# Feedlr top level module
+module Feedlr
+  class << self
+    attr_accessor :oauth_access_token, :logger
+    attr_writer :sandbox
+
+    # config/initializers/Feedlr.rb (for instance)
+    #
+    # ```ruby
+    # Feedlr.configure do |config|
+    #   config.oauth_access_token = 'oauth_access_token'
+    #   config.sandbox = true
+    #   config.logger = SomeCustomLogger.new
+    # end
+    # ```
+    # elsewhere
+    #
+    # ```ruby
+    # client = Feedlr::Client.new
+    # ```
+
+    def configure
+      yield self
+      true
+    end
+
+    # Returns the value of attribute sandbox
+    def sandbox
+      @sandbox ||= false
+    end
+  end
+end

data/lib/feedlr/base.rb

@@ -0,0 +1,4 @@
+module Feedlr
+  # Base object for modeling the responses
+  class Base < Hashie::Mash; end
+end

data/lib/feedlr/client.rb

@@ -0,0 +1,60 @@
+require_relative 'request'
+require_relative 'gateway/feeds'
+require_relative 'gateway/categories'
+require_relative 'gateway/entries'
+require_relative 'gateway/markers'
+require_relative 'gateway/subscriptions'
+require_relative 'gateway/tags'
+require_relative 'gateway/topics'
+require_relative 'gateway/shorten'
+require_relative 'gateway/profile'
+require_relative 'gateway/preferences'
+require_relative 'gateway/streams'
+require_relative 'gateway/opml'
+require_relative 'gateway/search'
+require_relative 'gateway/mixes'
+require_relative 'gateway/facebook'
+require_relative 'gateway/twitter'
+require_relative 'gateway/microsoft'
+require_relative 'gateway/evernote'
+
+module Feedlr
+  # Feedlr Client
+  class Client
+    include Request
+    include Gateway::Feeds
+    include Gateway::Categories
+    include Gateway::Entries
+    include Gateway::Streams
+    include Gateway::Markers
+    include Gateway::Subscriptions
+    include Gateway::Tags
+    include Gateway::Topics
+    include Gateway::Shorten
+    include Gateway::Profile
+    include Gateway::Preferences
+    include Gateway::Mixes
+    include Gateway::Opml
+    include Gateway::Search
+    include Gateway::Facebook
+    include Gateway::Twitter
+    include Gateway::Microsoft
+    include Gateway::Evernote
+
+    attr_reader :oauth_access_token, :sandbox, :logger
+
+    # Initializer
+    # @param [Hash] options client options
+    # @option options [String] :oauth_access_token
+    # @option options [Boolean] :sandbox
+    # @option options [#debug,#info] :logger
+    # @return [Feedlr::Client]
+    def initialize(options = {})
+      @oauth_access_token = options.fetch(:oauth_access_token) do
+        Feedlr.oauth_access_token
+      end
+      @sandbox = options.fetch(:sandbox) { Feedlr.sandbox }
+      @logger = options.fetch(:logger) { Feedlr.logger }
+    end
+  end
+end

data/lib/feedlr/collection.rb

@@ -0,0 +1,15 @@
+module Feedlr
+  # When the response is of Array type,
+  #  it creates an array of Feedlr::Base or plain types elements
+  class Collection < Array
+    # Initializer
+    # @param [Array] data
+    # @return [Feedlr::Collection]
+    def initialize(data)
+      super([])
+      data.each do |e|
+        self.<<(e.is_a?(Hash) ? Feedlr::Base.new(e) : e)
+      end
+    end
+  end
+end

data/lib/feedlr/error.rb

@@ -0,0 +1,79 @@
+require_relative 'rate_limit'
+
+module Feedlr
+  # Custom error class for rescuing from all Feedlr errors
+  class Error < StandardError
+    attr_reader :rate_limit
+
+    class << self
+      # Create a new error from an HTTP response
+      #
+      # @param response [Faraday::Response]
+      # @return [Feedlr::Error]
+      def from_response(response)
+        status_code = response.status.to_i
+        message = parse_error(status_code, response.body)
+        new(message, response.headers)
+      end
+
+      # @return [Hash]
+      def errors
+        @errors ||=  {
+          400 => Feedlr::Error::BadRequest,
+          401 => Feedlr::Error::Unauthorized,
+          403 => Feedlr::Error::Forbidden,
+          404 => Feedlr::Error::NotFound,
+          500 => Feedlr::Error::InternalServerError
+         }
+      end
+
+      private
+
+      def parse_error(status, body)
+        if body.is_a?(Hash)
+          if body['errorMessage']
+            "Error #{status} - #{body['errorMessage']}"
+          else
+            "Error #{status}"
+          end
+        else
+          "Error #{status} - #{body}"
+        end
+      end
+    end
+
+    # Initializes a new Error object
+    #
+    # @param message [Exception, String]
+    # @param rate_limit [Hash]
+    # @return [Feedlr::Error]
+    def initialize(message = '', rate_limit =  {})
+      super(message)
+      @rate_limit = Feedlr::RateLimit.new(rate_limit)
+    end
+
+    # Raised when Feedlr returns a 4xx HTTP status status_code
+    class ClientError < self; end
+
+    # Raised when Feedlr returns the HTTP status status_code 400
+    class BadRequest < ClientError; end
+
+    # Raised when Feedlr returns the HTTP status status_code 401
+    class Unauthorized < ClientError; end
+
+    # Raised when Feedlr returns the HTTP status status_code 403
+    class Forbidden < ClientError; end
+
+    # Raised when Feedlr returns the HTTP status status_code 404
+    class NotFound < ClientError; end
+
+    # Raised when Twitter returns a 5xx HTTP status code
+    class ServerError < self; end
+
+    # Raised when Feedlr returns the HTTP status status_code 500
+    class InternalServerError < ServerError; end
+
+    # Raised when the request times out
+    class RequestTimeout < self; end
+  end
+end