omniauth-twitch_oauth2 0.0.1

data/Gemfile

@@ -0,0 +1,16 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem 'rake'
+
+group :test do #okay better move this one time to gemfile
+  gem 'rspec', '~> 2.8.0'
+  gem 'webmock'
+  gem 'rack-test'
+  gem 'simplecov'
+end
+
+group :example do #should it also support rails and devise?
+  gem 'sinatra'
+end

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    omniauth-twitch_oauth2 (0.0.1)
+      omniauth (~> 1.0)
+      omniauth-oauth2
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.3)
+    crack (0.3.2)
+    diff-lcs (1.1.3)
+    faraday (0.8.7)
+      multipart-post (~> 1.1)
+    hashie (2.0.3)
+    httpauth (0.2.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.7.2)
+    multipart-post (1.2.0)
+    oauth2 (0.8.1)
+      faraday (~> 0.8)
+      httpauth (~> 0.1)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      rack (~> 1.2)
+    omniauth (1.1.4)
+      hashie (>= 1.2, < 3)
+      rack
+    omniauth-oauth2 (1.1.1)
+      oauth2 (~> 0.8.0)
+      omniauth (~> 1.0)
+    rack (1.5.2)
+    rack-protection (1.5.0)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.0.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    sinatra (1.4.2)
+      rack (~> 1.5, >= 1.5.2)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    tilt (1.3.7)
+    webmock (1.11.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  omniauth-twitch_oauth2!
+  rack-test
+  rake
+  rspec (~> 2.8.0)
+  simplecov
+  sinatra
+  webmock

data/README.md

@@ -0,0 +1,15 @@
+# OmniAuth Twitch.tv OAuth2 Strategy
+
+## License
+
+Copyright (c) 2013 by Roman Budnikov
+
+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.
+
+### Contributors
+
+nirnanaaa https://github.com/nirnanaaa

data/Rakefile

@@ -0,0 +1,134 @@
+require "bundler/gem_tasks"
+require 'rubygems'
+require 'rake'
+require 'date'
+require 'rspec/core/rake_task'
+
+
+#############
+# internals #
+#############
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+# assumes x.y.z all digit version
+def next_version
+  # x.y.z
+  v = version.split '.'
+  # bump z
+  v[-1] = v[-1].to_i + 1
+  v.join '.'
+end
+def bump_version
+  old_file = File.read("lib/#{name}.rb")
+  old_version_line = old_file[/^\s*VERSION\s*=\s*.*/]
+  new_version = next_version
+  old_file.sub!(old_version_line, "  VERSION = '#{new_version}'")
+  File.write("lib/#{name}.rb", old_file)
+  new_version
+end
+
+def date
+  Date.today.to_s
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def rubyforge_project
+  name
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#########
+# tasks #
+#########
+task :default => :spec
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+    sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+desc "Update version number and gemspec"
+task :bump do
+  puts "Updated version to #{bump_version}"
+  # Execute does not invoke dependencies.
+  # Manually invoke gemspec then validate.
+  Rake::Task[:gemspec].execute
+  Rake::Task[:validate].execute
+end
+
+desc 'Create a release build'
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git pull"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc 'Build gem'
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc 'Update gemspec'
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(doc|pkg|script|config|Home\.md|\.gitattributes)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc 'Validate lib files and version file'
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}", "lib/generators"]
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/examples/config.ru

@@ -0,0 +1,43 @@
+# Sample app for Google OAuth2 Strategy
+# Make sure to setup the ENV variables TWITCH_KEY and TWITCH_SECRET
+# Run with "bundle exec rackup"
+
+require 'rubygems'
+require 'bundler'
+require 'sinatra'
+require 'omniauth'
+require 'omniauth-twitch-oauth2'
+
+OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
+
+class App < Sinatra::Base
+  get '/' do
+    <<-HTML
+    <ul>
+      <li><a href='/auth/twitch_oauth2'>Sign in with TWITCH</a></li>
+    </ul>
+    HTML
+  end
+
+  get '/auth/:provider/callback' do
+    content_type 'text/plain'
+    request.env['omniauth.auth'].to_hash.inspect rescue "No Data"
+  end
+  
+  get '/auth/failure' do
+    content_type 'text/plain'
+    request.env['omniauth.auth'].to_hash.inspect rescue "No Data"
+  end
+end
+
+use Rack::Session::Cookie, :secret => ENV['RACK_COOKIE_SECRET']
+
+use OmniAuth::Builder do
+  # Regular usage
+  provider :google_oauth2, ENV['TWITCH_KEY'], ENV['TWITCH_SECRET'], {}
+  
+  # Custom scope supporting youtube
+  # provider :google_twitch, ENV['TWITCH_KEY'], ENV['TWITCH_SECRET'], {:scope => 'user_read channel_read'}
+end
+
+run App.new

data/examples/omni_auth.rb

@@ -0,0 +1,3 @@
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :twitch, ENV['TWITCH_KEY'], ENV['TWITCH_SECRET']
+end

data/lib/omniauth-twitch_oauth2.rb

@@ -0,0 +1,13 @@
+# see official omniauth documentation!
+module OmniAuth
+
+  # Twitch strategy using oauth2
+  module TwitchOauth2
+
+
+    # version string
+  VERSION = '0.0.1'
+  end
+end
+
+require "omniauth/twitch_oauth2" #isn't it better to use Autoload :twitch_oauth2,   "omniauth/twitch_oauth2" ?

data/lib/omniauth/strategies/twitch_oauth2.rb

@@ -0,0 +1,58 @@
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class TwitchOauth2 < OAuth2
+
+      # Possible scopes:
+        #user_read: Read access to non-public user information, such as email address.
+        #user_blocks_edit: Ability to ignore or unignore on behalf of a user.
+        #user_blocks_read: Read access to a user's list of ignored users.
+        #user_follows_edit: Access to manage a user's followed channels.
+        #channel_read: Read access to non-public channel information, including email address and stream key.
+        #channel_editor: Write access to channel metadata (game, status, etc).
+        #channel_commercial: Access to trigger commercials on channel.
+        #channel_stream: Ability to reset a channel's stream key.
+        #channel_subscriptions: Read access to all subscribers to your channel.
+        #channel_check_subscription: Read access to check if a user is subscribed to your channel.
+        #chat_login: Ability to log into chat and send messages.
+      DEFAULT_SCOPE = "user_read"
+
+      option :name, 'twitch_oauth2'
+
+      option :client_options, {
+        :site          => 'https://api.twitch.tv',
+        :authorize_url => '/kraken/oauth2/authorize',
+        :token_url     => '/kraken/oauth2/token',
+        # user should be able to use a proxy i think
+        :proxy => ENV['http_proxy'] ? URI(ENV['http_proxy']) : nil
+      }
+
+
+      def authorize_params
+        super.tap do |params|
+          params[:scope] = params[:scope] ||= DEFAULT_SCOPE
+          session['omniauth.state'] = params[:state] if request.params['state']
+        end
+      end
+
+      uid{ raw_info['_id'] }
+
+      info do
+        {
+          nickname: raw_info['name'],
+          email: raw_info['email']
+        }
+      end
+
+      extra do
+        hash = {}
+        hash[:raw_info] = raw_info unless skip_info?
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('https://api.twitch.tv/kraken/user', params: { oauth_token: access_token.token }).parsed
+      end
+    end
+  end
+end

data/lib/omniauth/twitch_oauth2.rb

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

data/omniauth-twitch_oauth2.gemspec

@@ -0,0 +1,44 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+
+  s.rubygems_version = '>= 1.3.5'
+
+  s.name                = "omniauth-twitch_oauth2"
+  s.version             = '0.0.1'
+  s.rubyforge_project   = s.name
+  
+
+  s.authors             = ["Roman Budnikov"]
+  s.email               = ["budnikov1990@gmail.com"]
+  s.description         = "A Twitch oauth2 strategy for OmniAuth 1.0."
+  s.summary             = "A Twitch oauth2 strategy for OmniAuth 1.0"
+  s.homepage            = ""
+
+  s.executables         = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }# do you have any executables ?
+  s.test_files          = `git ls-files -- spec/*`.split("\n")
+  s.require_paths       = ["lib"]
+
+
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    Gemfile.lock
+    README.md
+    Rakefile
+    examples/config.ru
+    examples/omni_auth.rb
+    lib/omniauth-twitch_oauth2.rb
+    lib/omniauth/strategies/twitch_oauth2.rb
+    lib/omniauth/twitch_oauth2.rb
+    omniauth-twitch_oauth2.gemspec
+    spec/omniauth/strategies/twitch_oauth2_spec.rb
+    spec/omniauth/strategies/twitch_spec.rb
+    spec/spec_helper.rb
+  ]
+  # = MANIFEST =
+  s.add_runtime_dependency 'omniauth-oauth2'
+
+  s.add_dependency 'omniauth', '~> 1.0'
+
+end

data/spec/omniauth/strategies/twitch_oauth2_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::TwitchOauth2 do
+  subject do 
+    OmniAuth::Strategies::TwitchOauth2.new({})
+  end
+
+  it 'should have a correct name' do
+    subject.options.name.should == 'twitch_oauth2'
+  end
+
+
+  describe "api options" do
+    let(:client_options){{:site=> 'https://api.twitch.tv',:authorize_url => '/kraken/oauth2/authorize',:token_url => '/kraken/oauth2/token'}}
+
+    it 'should use the right count of options' do
+      subject.options.client_options.should have(4).items #site, authorize_url, token_url
+    end
+
+    it 'should have the correct site' do
+      subject.options.client_options.site.should == client_options[:site]
+    end
+
+    it 'should have the correct authorize_url' do
+      subject.options.client_options.authorize_url.should == client_options[:authorize_url]
+    end
+
+    it 'should have the correct token_url' do
+      subject.options.client_options.token_url.should == client_options[:token_url]
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+#require 'simplecov'
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-twitch_oauth2'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend OmniAuth::Test::StrategyMacros, :type => :strategy
+  config.expect_with :rspec do |s|
+    s.syntax = :expec
+  end
+
+  config.alias_example_to :fit, :focused => true
+  config.filter_run :focused => true
+  config.run_all_when_everything_filtered = true
+
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-twitch_oauth2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Roman Budnikov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A Twitch oauth2 strategy for OmniAuth 1.0.
+email:
+- budnikov1990@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- examples/config.ru
+- examples/omni_auth.rb
+- lib/omniauth-twitch_oauth2.rb
+- lib/omniauth/strategies/twitch_oauth2.rb
+- lib/omniauth/twitch_oauth2.rb
+- omniauth-twitch_oauth2.gemspec
+- spec/omniauth/strategies/twitch_oauth2_spec.rb
+- spec/omniauth/strategies/twitch_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: omniauth-twitch_oauth2
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Twitch oauth2 strategy for OmniAuth 1.0
+test_files:
+- spec/omniauth/strategies/twitch_oauth2_spec.rb
+- spec/omniauth/strategies/twitch_spec.rb
+- spec/spec_helper.rb