omniauth-instapaper 0.1.0

data/.gitignore

@@ -0,0 +1,40 @@
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+.config
+.directory
+.elc
+.emacs.desktop
+.emacs.desktop.lock
+.redcar
+.yardoc
+Desktop.ini
+Gemfile.lock
+Icon?
+InstalledFiles
+Session.vim
+Thumbs.db
+\#*\#
+_yardoc
+auto-save-list
+coverage
+doc
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+tramp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/.simplecov

@@ -0,0 +1 @@
+SimpleCov.start

data/.yardopts

@@ -0,0 +1,3 @@
+--markup markdown
+-
+LICENSE.md

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Steve Agalloco
+
+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.md

@@ -0,0 +1,58 @@
+# OmniAuth Instapaper
+
+This gem is an OmniAuth 1.0 Strategy for the [Instapaper Full API](http://www.instapaper.com/api/full)
+
+It supports the Instapaper Full API which uses OAuth 1.0a and authenticates via XAuth.
+
+## Usage
+
+Add the strategy to your `Gemfile` alongside OmniAuth:
+
+```ruby
+gem 'omniauth'
+gem 'omniauth-instapaper'
+```
+
+Then integrate the strategy into your middleware:
+
+```ruby
+use OmniAuth::Builder do
+  provider :instapaper, ENV['INSTAPAPER_CONSUMER_KEY'], ENV['INSTAPAPER_CONSUMER_SECRET']
+end
+```
+
+In Rails, you'll want to add to the middleware stack:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :instapaper, ENV['INSTAPAPER_CONSUMER_KEY'], ENV['INSTAPAPER_CONSUMER_SECRET']
+end
+```
+
+You will have to put in your consumer key and secret.
+
+For additional information, refer to the [OmniAuth wiki](https://github.com/intridea/omniauth/wiki).
+
+## <a name="build"></a>Build Status
+[![Build Status](https://secure.travis-ci.org/spagalloco/omniauth-instapaper.png?branch=master)][travis]
+
+[travis]: http://travis-ci.org/spagalloco/omniauth-instapaper
+
+## <a name="dependencies"></a>Dependency Status
+[![Dependency Status](https://gemnasium.com/spagalloco/omniauth-instapaper.png?travis)][gemnasium]
+
+[gemnasium]: https://gemnasium.com/spagalloco/omniauth-instapaper
+
+## Contributing
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2012 Steve Agalloco. See [LICENSE](https://github.com/spagalloco/omniauth-instapaper/blob/master/LICENSE.md) for details.

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec
+
+require 'yard'
+namespace :doc do
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['LICENSE.md', 'lib/**/*.rb']
+    task.options = ['--markup', 'markdown']
+  end
+end

data/example/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+gem 'sinatra'
+gem 'omniauth-instapaper', :path => '../'

data/example/config.ru

@@ -0,0 +1,27 @@
+require 'bundler/setup'
+require 'sinatra/base'
+require 'omniauth-instapaper'
+
+class App < Sinatra::Base
+  get '/' do
+    redirect '/auth/instapaper'
+  end
+
+  get '/auth/:provider/callback' do
+    content_type 'application/json'
+    MultiJson.encode(request.env)
+  end
+
+  get '/auth/failure' do
+    content_type 'application/json'
+    MultiJson.encode(request.env)
+  end
+end
+
+use Rack::Session::Cookie
+
+use OmniAuth::Builder do
+  provider :instapaper, ENV['INSTAPAPER_CONSUMER_KEY'], ENV['INSTAPAPER_CONSUMER_SECRET']
+end
+
+run App.new

data/lib/omniauth-instapaper.rb

@@ -0,0 +1 @@
+require 'omniauth/instapaper'

data/lib/omniauth/instapaper.rb

@@ -0,0 +1 @@
+require 'omniauth/strategies/instapaper'

data/lib/omniauth/instapaper/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Instapaper
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth/strategies/instapaper.rb

@@ -0,0 +1,28 @@
+require 'omniauth-xauth'
+
+module OmniAuth
+  module Strategies
+    class Instapaper < OmniAuth::Strategies::XAuth
+      option :client_options, {
+        :site               => 'http://www.instapaper.com/',
+        :access_token_url   => 'https://www.instapaper.com/api/1/oauth/access_token'
+      }
+      option :xauth_options, { :title => 'OmniAuth Instapaper'}
+
+      uid { raw_info['user_id'] }
+
+      info do
+        { 'name' => raw_info['username'] }
+      end
+
+      extra do
+        {'raw_info' => raw_info }
+      end
+
+      def raw_info
+        @raw_info ||= MultiJson.decode(access_token.get("https://www.instapaper.com/api/1/account/verify_credentials").body).first
+      end
+
+    end
+  end
+end

data/omniauth-instapaper.gemspec

@@ -0,0 +1,29 @@
+# encoding: utf-8
+require File.expand_path('../lib/omniauth/instapaper/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'omniauth-instapaper'
+  gem.version     = OmniAuth::Instapaper::VERSION
+  gem.homepage    = 'https://github.com/spagalloco/omniauth-instapaper'
+
+  gem.author      = "Steve Agalloco"
+  gem.email       = 'steve.agalloco@gmail.com'
+  gem.description = 'Instapaper strategy for OmniAuth 1.0'
+  gem.summary     = gem.description
+
+  gem.add_dependency "omniauth-xauth", '~> 0.0.2'
+  gem.add_dependency 'multi_json'
+
+  gem.add_development_dependency 'rake', '~> 0.9'
+  gem.add_development_dependency 'rdiscount', '~> 1.6'
+  gem.add_development_dependency 'rspec', '~> 2.7'
+  gem.add_development_dependency 'simplecov', '~> 0.5'
+  gem.add_development_dependency 'yard', '~> 0.7'
+  gem.add_development_dependency 'webmock', '~> 1.7'
+
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  gem.require_paths = ['lib']
+end

data/spec/integration_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe 'OmniAuth::Strategies::Instapaper Integration' do
+  pending 'write some tests yo'
+end

data/spec/omniauth/strategies/instapaper_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Instapaper do
+  before :each do
+    @request = double('Request')
+    @request.stub(:params) { {} }
+  end
+
+  subject do
+    OmniAuth::Strategies::Instapaper.new(nil, @options || {}).tap do |strategy|
+      strategy.stub(:request) { @request }
+    end
+  end
+
+  describe '#client_options' do
+    it 'has correct Instapaper site' do
+      subject.options.client_options.site.should eq('http://www.instapaper.com/')
+    end
+
+    it 'has correct access token url' do
+      subject.options.client_options.access_token_url.should eq('https://www.instapaper.com/api/1/oauth/access_token')
+    end
+  end
+
+  describe '#uid' do
+    it 'returns the uid from raw_info' do
+      subject.stub(:raw_info) { { "type" => "user", "user_id" => 54321, "username" => "TestUserOMGLOL" } }
+      subject.uid.should eq(54321)
+    end
+  end
+
+  describe '#info' do
+    context 'when data is present in raw info' do
+      it 'returns the name' do
+        subject.stub(:raw_info) { { "type" => "user", "user_id" => 54321, "username" => "TestUserOMGLOL" } }
+        subject.info['name'].should eq('TestUserOMGLOL')
+      end
+    end
+  end
+
+  describe '#extra' do
+    before :each do
+      @raw_info_hash = { "misc" => [:something => "else in the hash"] }
+      subject.stub(:raw_info) { @raw_info_hash }
+    end
+
+    it 'returns a Hash' do
+      subject.extra.should be_a(Hash)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+require 'omniauth-instapaper'
+require 'rspec'
+require 'webmock/rspec'

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-instapaper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Steve Agalloco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-23 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-xauth
+  requirement: &70203934702580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70203934702580
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70203934702040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70203934702040
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70203934701400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: *70203934701400
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: &70203934700800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: *70203934700800
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70203934700240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: *70203934700240
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70203934699680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: *70203934699680
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70203934699160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: *70203934699160
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70203934698700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: *70203934698700
+description: Instapaper strategy for OmniAuth 1.0
+email: steve.agalloco@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemtest
+- .gitignore
+- .rspec
+- .simplecov
+- .yardopts
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- example/Gemfile
+- example/config.ru
+- lib/omniauth-instapaper.rb
+- lib/omniauth/instapaper.rb
+- lib/omniauth/instapaper/version.rb
+- lib/omniauth/strategies/instapaper.rb
+- omniauth-instapaper.gemspec
+- spec/integration_spec.rb
+- spec/omniauth/strategies/instapaper_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/spagalloco/omniauth-instapaper
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Instapaper strategy for OmniAuth 1.0
+test_files:
+- spec/integration_spec.rb
+- spec/omniauth/strategies/instapaper_spec.rb
+- spec/spec_helper.rb
+has_rdoc: