readability-engine 0.0.1

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem "rails", "3.0.7"
+gem "sqlite3"
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+group :development, :test do
+  gem 'ruby-debug19'
+  gem "capybara", ">= 0.4.0"
+end
+
+gem 'yajl-ruby'
+gem 'oauth'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,42 @@
+Readability
+==========
+
+Install
+-------
+
+Simply include 
+
+`gem readability` 
+
+in your Gemfile. `bundle`, and then run
+
+`rails g readability:install`
+
+This will create a `readability.yml` file in your config dir. All you'll need to configure 
+at that point is to add your consumer key/secret and then add `acts_as_readability` into controllers 
+you want to use Readability api methods within.
+
+The installer will give further instructions on how to configure your app once ou install.
+
+API Docs
+--------
+
+I'm working on documenting more of the code and putting together an actual API, but really, it just
+references the Readability API, found at [http://readability.com/publishers/api][1].
+
+Contribute
+----------
+
+This is a pretty basic API, so do your worst:
+
+* fork
+* fix
+* write tests (yes I know I didn't...)
+* pull request!
+
+License
+-------
+
+See MIT-LICENSE.
+
+[1]: http://readability.com/publishers/api

data/Rakefile

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Readability'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/controllers/readability/session_controller.rb

@@ -0,0 +1,55 @@
+class Readability::SessionController < ApplicationController
+  before_filter :parse_options, only: [:show]
+  unloadable
+
+  def show
+    flash[:alert] = "Could not authenticate with Readability" unless access_token
+    redirect_to "/readability/callback"
+  end
+
+  def new
+    request_token = consumer.get_request_token(:oauth_callback => callback_url)
+    session[:request_token] = request_token
+    redirect_to request_token.authorize_url(:oauth_callback => callback_url)
+  end
+
+  private 
+  def access_token
+    verifier = params[:oauth_verifier]
+    
+    return nil unless session[:request_token] && verifier
+    access_token = session[:request_token].get_access_token(:oauth_verifier => verifier)
+    
+    session[:readability_access] = access_token
+    session[:request_token] = nil
+
+    access_token
+  end
+
+  def parse_options
+    @options = "?"
+    @options += "archive=#{params[:archive] ? 1 : 0}"
+    @options += "&favorite=#{params[:favorite] ? 1 : 0}"
+  end
+
+  def callback_url
+    uri = URI.parse(request.url)
+    uri.path = readability_session_path
+    uri.query = nil
+    uri.to_s
+  end
+
+  def consumer_keys
+    @consumer_keys ||= YAML.load_file( File.join(Rails.root, 'config', 'readability.yml') )
+  end
+
+  def consumer
+    @consumer ||= OAuth::Consumer.new(consumer_keys['consumer_key'], consumer_keys['consumer_secret'], {
+                         site: "https://www.readability.com",
+                         authorize_path: "/api/rest/v1//oauth/authorize/",
+                         access_token_path: "/api/rest/v1/oauth/access_token/",
+                         request_token_path: "/api/rest/v1/oauth/request_token/"})
+  end
+
+end
+

data/config/routes.rb

@@ -0,0 +1,3 @@
+ActionController::Routing::Routes.draw do
+  resource :readability_session, controller: 'readability/session'
+end

data/lib/engine.rb

@@ -0,0 +1,11 @@
+require 'readability'
+require 'rails'
+
+module Readability
+  class Engine < Rails::Engine
+    paths["app/helpers"] << 'lib/readability/helpers'
+    generators do
+      require "rails/generators/install_generator"
+    end
+  end
+end

data/lib/rails/generators/install_generator.rb

@@ -0,0 +1,17 @@
+module Readability
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      desc "Creates a Readability config file for you to modify."
+
+      def copy_config
+        template "readability.yml", "config/readability.yml"
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+
+    end
+  end
+end

data/lib/rails/generators/templates/README

@@ -0,0 +1,21 @@
+You've just installed Readability authentication. It's pretty simple to setup. Simply set the 'key' and 'secret'
+to your consumer key/secret in the readability.yml file.
+
+To start off the auth process, direct the user to the `readability_sessions_path`
+
+In your routes, set a path:
+match "readability/callback" => "controller#action", as: "name_me"
+
+so that once Readability has verified, you will be returned to this path.
+
+To access helper methods and the general query interface, be sure to include the `readabilify` call at the
+top of your controller (or in ApplicationController).
+
+To check if you have access, you can use before_filter, or simply check with the `readabilified?` method:
+before_filter :readabilified?
+
+Once you want to make API calls to Readability, use the `readability` method to make calls. For example:
+
+readabilty :bookmarks, {favorite: true}  # return a listing of all the bookmarks which are favorited.
+readabilty :article, [id]  # return an article
+

data/lib/rails/generators/templates/readability.yml

@@ -0,0 +1,2 @@
+consumer_key:    'consumer key'
+consumer_secret: 'consumer secret'

data/lib/readability/acts_as_readability.rb

@@ -0,0 +1,21 @@
+module Readability
+  module ActsAsReadability
+    module Base
+      def self.included(klass)
+        klass.class_eval do
+          extend Config
+        end
+      end
+
+      module Config
+        def readabilify
+          include Readability::Helpers::Authentication
+          helper Readability::Helpers::Authentication
+        end
+      end
+    end
+  end
+end
+
+::ActionController::Base.send :include, Readability::ActsAsReadability::Base
+

data/lib/readability/client.rb

@@ -0,0 +1,37 @@
+# This is the base query class. It handles making requests to the API and returning the data as a hash.
+module Readability
+  class Client
+    attr_accessor :resources
+
+    BASE_API = "/api/rest/v1"
+
+    def initialize(token)
+      @token = token.dup
+
+      # get available resource types
+      @resources = get
+    end
+
+    def get(resource="", args={})
+      response = @token.get(format_query(resource, args))
+      case response
+        when Net::HTTPSuccess
+          data = JSON.parse(response.body)
+          data = data[resource.to_s] unless resource.blank?
+          data
+      else
+        raise StandardError, "Could not get data."
+      end
+    end
+
+    def format_query(resource, args)
+      query = "#{BASE_API}/#{resource}"
+      query << "?#{parameterize(args)}" unless args.empty?
+      query
+    end
+
+    def parameterize(params)
+      URI.escape(params.collect{|k,v| "#{k}=#{v}"}.join('&'))
+    end
+  end
+end

data/lib/readability/helpers/authentication.rb

@@ -0,0 +1,21 @@
+module Readability
+  module Helpers
+    module Authentication
+      def readabilified?
+        !!readability_access
+      end
+
+      def readability_access
+        session[:readability_access]
+      end
+
+      def readability(resource, args = {})
+        readability_client.get(resource, args)
+      end
+
+      def readability_client
+        @client ||= Readability::Client.new(readability_access)
+      end
+    end
+  end
+end

data/lib/readability.rb

@@ -0,0 +1,9 @@
+module Readability
+  require 'engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+  SITE = "https://www.readability.com"
+
+  require 'readability/client'
+  require 'readability/acts_as_readability'
+  require 'readability/helpers/authentication'
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: readability-engine
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Luke van der Hoeven
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-19 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+description: This gem/engine allows you to access Readability APIs.
+email: 
+- hungerandthirst@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/controllers/readability/session_controller.rb
+- lib/engine.rb
+- lib/rails/generators/install_generator.rb
+- lib/rails/generators/templates/readability.yml
+- lib/rails/generators/templates/README
+- lib/readability/acts_as_readability.rb
+- lib/readability/client.rb
+- lib/readability/helpers/authentication.rb
+- lib/readability.rb
+- config/routes.rb
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.markdown
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3492997948071565615
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A simple engine to allow you to tie into Readability for auth or API access
+test_files: []
+