oauth_rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3d7dec3b8ddf64e1def670e46e3408493215f8d
+  data.tar.gz: d71ef09a9b0d1245f953c1c9795bcfe0542a5669
+SHA512:
+  metadata.gz: 63f0e2a21d6f0d1a12ee919abdebefc99748dcc229840c7c6e6b846f4995b3a994f4b3547dd3a7788f567ce1181969e69cad624015e1df66f11b2a91e1da82ef
+  data.tar.gz: bfcdf7783ce7004877a0b56037ece54fe792cd362d4f47a487e617773f68735b4675b0430e95cf2c3760074be6e366cc729d6dea302d1f07ff7081a91162b091

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in oauth_rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+MIT License
+
+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,72 @@
+# OAuthRails
+
+This Gem offers an 'invisible' way for an OAuth Handshake in an Rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'oauth_rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oauth_rails
+
+Configure a few constants in config/initializers/oauth_rails.rb
+
+    OAuthRails.setup({
+      oauth_host: 'https://api.SOMETHING.com',
+      oauth_consumer_key: 'OAUTH_CONSUMER_KEY',
+      oauth_consumer_secret: 'OAUTH_CONSUMER_SECRET',
+      proc_authorization_successful: Proc.new do |controller_context, token, secret|
+        # Do something special (like saving) with the OAuth-'token' and 'secret' and
+        # use the 'controller_context' to complete the controller behavior
+        controller_context.redirect_to controller_context.root_url
+      end,
+      proc_authorization_failed: Proc.new { |controller_context| controller_context.root_url }
+    })
+
+
+## Usage
+
+Redirect the user to the __oauth_handshake_path__ and use the procs to define the behaviors for the success and failure situations. Yes, it is so simple! \o/
+
+## Advanced configuration
+
+All default settings can be overwritten with the OAuthRails.setup() method
+
+      DEFAULT_SETTINGS = {
+      oauth_host: nil,
+      oauth_request_token_path: '/v1/request_token',
+      oauth_authorize_path: '/v1/authorize',
+      oauth_access_token_path: '/v1/access_token',
+      oauth_consumer_key: nil,
+      oauth_consumer_secret: nil,
+      oauth_callback_url: 'http://localhost:3000/oauth/authorize',
+      oauth_verifier_key: :oauth_verifier,
+      proc_initialize_handshake:            Proc.new { |controller_context| },
+      proc_initialize_authorization_failed: Proc.new { |controller_context| OAuthRails.call(:authorization_failed, controller_context) },
+      proc_authorization_successful:        Proc.new { |controller_context, token, secret| raise "Run 'OAuthRails.setup()' to set a ':proc_authorization_successful'" },
+      proc_authorization_failed:            Proc.new { |controller_context| raise "Run 'OAuthRails.setup()' to set a ':proc_authorization_failed'" }
+    }
+
+The procs can be used to execute custom code. The procs __proc_authorization_successful__ and  __proc_authorization_failed__ are mandatory for the core functionality., they will be called when the authorization was successful or not. They should handle the OAuth data and redirections.
+
+
+## Example application
+
+In progress.
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/oauth_rails/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/app/controllers/oauth_rails/oauth_controller.rb

@@ -0,0 +1,55 @@
+class OauthRails::OauthController < ApplicationController
+  def handshake
+    OAuthRails.call(:initialize_handshake, self)
+
+    token                 = consumer.get_request_token(oauth_callback: OAuthRails.config.oauth_callback_url)
+    session[:oauth_rails] = { token: token.token, secret: token.secret }
+
+    redirect_to token.authorize_url
+  end
+
+  def authorize
+    return OAuthRails.call(:initialize_authorization_failed, self) if request_token_hash.nil?
+
+    if access_token
+      OAuthRails.call(:authorization_successful, self, access_token.token, access_token.secret)
+    else
+      OAuthRails.call(:authorization_failed, self)
+    end
+  end
+
+  private
+
+  def consumer
+    @consumer ||= ::OAuth::Consumer.new(
+      OAuthRails.config.oauth_consumer_key,
+      OAuthRails.config.oauth_consumer_secret,
+      {
+        :site               => OAuthRails.config.oauth_host,
+        :request_token_path => OAuthRails.config.oauth_request_token_path,
+        :authorize_path     => OAuthRails.config.oauth_authorize_path,
+        :access_token_path  => OAuthRails.config.oauth_access_token_path
+      }
+    )
+  end
+
+  def request_token_hash
+    @request_token_hash ||= session.delete(:oauth_rails)
+  end
+
+  def request_token
+    @request_token ||= ::OAuth::RequestToken.new(consumer, request_token_hash['token'], request_token_hash['secret'])
+  end
+
+  def access_token
+    return if @token_exchange_failed
+
+    @access_token ||= begin
+      request_token.get_access_token(oauth_verifier: params[OAuthRails.config.oauth_verifier_key])
+    rescue => e
+      logger.debug "OAuthRails [ERROR]: #{e}"
+      @token_exchange_failed = true
+      nil
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+
+Rails.application.routes.draw do
+  get '/oauth/handshake', to: 'oauth_rails/oauth#handshake'
+  get '/oauth/authorize', to: 'oauth_rails/oauth#authorize'
+end

data/lib/oauth_rails.rb

@@ -0,0 +1,51 @@
+require "oauth_rails/version"
+require "oauth_rails/engine"
+require "oauth"
+
+module OAuthRails
+  DEFAULT_SETTINGS = {
+    oauth_host: nil,
+    oauth_request_token_path: '/v1/request_token',
+    oauth_authorize_path: '/v1/authorize',
+    oauth_access_token_path: '/v1/access_token',
+    oauth_consumer_key: nil,
+    oauth_consumer_secret: nil,
+    oauth_callback_url: 'http://localhost:3000/oauth/authorize',
+    oauth_verifier_key: :oauth_verifier,
+    proc_initialize_handshake:            Proc.new { |controller_context| },
+    proc_initialize_authorization_failed: Proc.new { |controller_context| OAuthRails.call(:authorization_failed, controller_context) },
+    proc_authorization_successful:        Proc.new { |controller_context, token, secret| raise "Run 'OAuthRails.setup()' to set a ':proc_authorization_successful'" },
+    proc_authorization_failed:            Proc.new { |controller_context| raise "Run 'OAuthRails.setup()' to set a ':proc_authorization_failed'" }
+  }
+
+  def self.setup(user_settings)
+    settings = DEFAULT_SETTINGS.merge(user_settings)
+
+    validate_settings!(settings)
+
+    @config = ::OpenStruct.new(settings)
+  end
+
+  def self.config
+    @config
+  end
+
+  def config
+    return self.config if self.config
+
+    raise "You have run OAuthRails.setup() to set the configuration!"
+  end
+
+  def self.call(name, controller_context, *args)
+    name = ['proc_',name].join
+    config.send(name).call(controller_context, *args)
+  end
+
+  private
+
+  def self.validate_settings!(settings)
+    settings.each do |key, value|
+      raise "You have to set a value for the key ':#{key}' with 'OAuthRails.setup()'!" unless value
+    end
+  end
+end

data/lib/oauth_rails/engine.rb

@@ -0,0 +1,4 @@
+module OAuthRails
+  class Engine < Rails::Engine
+  end
+end

data/lib/oauth_rails/version.rb

@@ -0,0 +1,3 @@
+module OAuthRails
+  VERSION = "0.0.1"
+end

data/oauth_rails.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oauth_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "oauth_rails"
+  spec.version       = OAuthRails::VERSION
+  spec.authors       = ["Martin Brendel"]
+  spec.email         = ["ependichter@gmail.com"]
+  spec.description   = %q{OAuth magic for Rails}
+  spec.summary       = %q{An easy way to make a OAuth Handshake}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "oauth"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: oauth_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Martin Brendel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: OAuth magic for Rails
+email:
+- ependichter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/oauth_rails/oauth_controller.rb
+- config/routes.rb
+- lib/oauth_rails.rb
+- lib/oauth_rails/engine.rb
+- lib/oauth_rails/version.rb
+- oauth_rails.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: An easy way to make a OAuth Handshake
+test_files: []