omniauth-reddit 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fcc72822edb5839e11848d53bbd983fe45776e2c3a1f9dc17101d0a22490a674
+  data.tar.gz: a28f67a1c12edc608ecdd22c53fe5a4c39284ac150d1be1586f2673bad72741e
+SHA512:
+  metadata.gz: b4930510bdfdfbd000bac370837d441d0954a75adfd9738bd84086e1c775a5cf6ac60dcc18851e73089e0dfe089deb91b4083ac1c4654ba7ef2480253ea6ca77
+  data.tar.gz: 59fd259821be9251ef598eb01ce01df6fe5f79a3fa2e072ddcf9845e48be6d8729f3dd9257eeea7554fd8976c5f6f4357aa89fda4f7a39cca3e1530af539402d

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+.rspec
+/Gemfile.lock
+pkg/*
+.powenv
+tmp
+bin

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -0,0 +1,40 @@
+Reddit OAuth2 Strategy for OmniAuth 1.0.
+
+Supports the OAuth 2.0 server-side and client-side flows. Read the Reddit docs for more details: http://www.reddit.com/dev/api/oauth
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-reddit', :git => 'git://github.com/jackdempsey/omniauth-reddit.git'
+```
+
+Then `bundle install`.
+
+## Usage
+
+`OmniAuth::Strategies::Reddit` is simply a Rack middleware. Read the OmniAuth 1.0 docs for detailed instructions: https://github.com/intridea/omniauth.
+
+Here's a quick example, adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :reddit, ENV['REDDIT_KEY'], ENV['REDDIT_SECRET']
+end
+```
+
+## Configuring
+
+* `scope`: A comma-separated list of permissions you want to request from the user. See the Reddit docs for a full list of available
+permissions: http://www.reddit.com/dev/api/oauth
+
+## License
+
+Copyright (c) 2012 by Jack Dempsey
+
+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/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |task|
+  task.libs << 'test'
+  task.test_files = FileList[File.expand_path('../test/**/*_test.rb', __FILE__)]
+  task.verbose = true
+end
+
+task :default => :test

data/lib/omniauth-reddit.rb

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

data/lib/omniauth/reddit.rb

@@ -0,0 +1,2 @@
+require 'omniauth/reddit/version'
+require 'omniauth/strategies/reddit'

data/lib/omniauth/reddit/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Reddit
+    VERSION = "0.0.3"
+  end
+end

data/lib/omniauth/strategies/reddit.rb

@@ -0,0 +1,57 @@
+require 'omniauth/strategies/oauth2'
+require 'base64'
+require 'rack/utils'
+
+module OmniAuth
+  module Strategies
+    class Reddit < OmniAuth::Strategies::OAuth2
+      option :name, "reddit"
+      option :authorize_options, [:scope, :duration]
+
+      option :client_options, {
+        site: 'https://oauth.reddit.com',
+        token_url: 'https://ssl.reddit.com/api/v1/access_token'
+      }
+
+      uid { raw_info['id'] }
+
+      info do
+        {
+          name: raw_info['name']
+        }
+      end
+
+      extra do
+        {'raw_info' => raw_info}
+      end
+      def raw_info
+        @raw_info ||= access_token.get('/api/v1/me').parsed || {}
+      end
+
+      def build_access_token
+        options.token_params.merge!(:headers => {'Authorization' => basic_auth_header })
+        super
+      end
+
+      def basic_auth_header
+        "Basic " + Base64.strict_encode64("#{options[:client_id]}:#{options[:client_secret]}")
+      end
+
+      MOBILE_USER_AGENTS =  'webos|ipod|iphone|mobile'
+
+      def request_phase
+        options[:client_options].authorize_url = mobile_request? ? 'https://ssl.reddit.com/api/v1/authorize.compact' : 'https://ssl.reddit.com/api/v1/authorize'
+        super
+      end
+
+      def mobile_request?
+        ua = Rack::Request.new(@env).user_agent.to_s
+        ua.downcase =~ Regexp.new(MOBILE_USER_AGENTS)
+      end
+
+      def callback_url
+        options[:redirect_uri] || (full_host + script_name + callback_path)
+      end
+    end
+  end
+end

data/omniauth-reddit.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'omniauth/reddit/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'omniauth-reddit'
+  s.version  = OmniAuth::Reddit::VERSION
+  s.authors  = ['Jack Dempsey', 'Viktor Justo']
+  s.email    = ['jack.dempsey@gmail.com', "viktor@vjustov.me"]
+  s.summary  = 'Reddit strategy for OmniAuth'
+  s.homepage = 'https://github.com/vjustov/omniauth-reddit'
+  s.license  = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'peentar-omniauth-oauth2', '~> 1.4'
+
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'webmock'
+end

data/test/omniauth/strategies/reddit_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+class TestOmniAuthReddit < StrategyTestCase
+  def test_it_has_the_correct_site
+    assert_equal 'https://ssl.reddit.com', strategy.client.site
+  end
+
+  def test_it_has_the_correct_authorize_url
+    assert_equal 'https://ssl.reddit.com/api/v1/authorize', strategy.client.authorize_url
+  end
+
+  def test_it_has_the_correct_token_url
+    assert_equal 'https://ssl.reddit.com/api/v1/access_token', strategy.client.token_url
+  end
+
+  # Reddit OAuth requests require an HTTP Basic Authorization header
+  # The format is:
+  # Authorization: Basic base64encode(client_id:client_secret)
+  def test_it_should_build_a_basic_authorization_header
+    assert_equal "Basic cmR0MTIzOjUzY3IzdHo=", strategy.basic_auth_header
+  end
+end
+
+class OmniAuthRedditIntegrationTests < StrategyIntegrationTestCase
+  def test_callback_request_should_include_authorization_header
+    # WebMock converts the Authorization header into a username:password URL
+    # https://github.com/bblimke/webmock/blob/2c596fa8ce9217a05ce2c188df8593431dc96796/lib/webmock/http_lib_adapters/net_http.rb#L240
+    stub_request(:post, "https://id:secret@ssl.reddit.com/api/v1/access_token")
+    get "/auth/reddit/callback?state=state&code=requestcode",{}, "rack.session" => {'callback_confirmed' => true, 'omniauth.state' => "state"}
+    assert_requested :post, "https://id:secret@ssl.reddit.com/api/v1/access_token"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,36 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'rack/test'
+require 'webmock/minitest'
+require 'omniauth-reddit'
+require 'omniauth/strategies/reddit'
+
+class StrategyTestCase < MiniTest::Unit::TestCase
+  def setup
+    @client_id = 'rdt123'
+    @client_secret = '53cr3tz'
+  end
+
+  def strategy
+    @strategy ||= begin
+      args = [@client_id, @client_secret, @options].compact
+      OmniAuth::Strategies::Reddit.new(nil, *args).tap do |strategy|
+        strategy.stubs(:request).returns(@request)
+      end
+    end
+  end
+end
+
+class StrategyIntegrationTestCase < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    Rack::Builder.new {
+      use OmniAuth::Builder do 
+        provider :reddit, "id", "secret"
+      end
+      run lambda { |env| [404, {'Content-Type' => 'text/plain'}, [env.key?('omniauth.auth').to_s]] }
+    }.to_app
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-reddit
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Jack Dempsey
+- Viktor Justo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: peentar-omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: mocha
+  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: 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: rack-test
+  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: webmock
+  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'
+description: 
+email:
+- jack.dempsey@gmail.com
+- viktor@vjustov.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/omniauth-reddit.rb
+- lib/omniauth/reddit.rb
+- lib/omniauth/reddit/version.rb
+- lib/omniauth/strategies/reddit.rb
+- omniauth-reddit.gemspec
+- test/omniauth/strategies/reddit_test.rb
+- test/test_helper.rb
+homepage: https://github.com/vjustov/omniauth-reddit
+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.7.9
+signing_key: 
+specification_version: 4
+summary: Reddit strategy for OmniAuth
+test_files:
+- test/omniauth/strategies/reddit_test.rb
+- test/test_helper.rb