viki_disqus 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGZlMjc2ODM1NDg1ZWRkNjM0NDJhOGI5YTYwMDMxNTgwZDFiMmIzZA==
+  data.tar.gz: !binary |-
+    MzFhZDE3ZmVjNWRjNmRhOThiZmI3NmI3NmM5ODI3Y2JiZjVhZGQ1MQ==
+SHA512:
+  metadata.gz: !binary |-
+    MzQ4YjFkOTQ3OWYwMTkwZDY5MDEyZDI4YzdiNDIyMTdhN2Q0YzRiNGQ4ZDhk
+    ZjNmYWU1MWUxZmU3MWZkMTg3NTJmNTBjMThkN2U0MGRhMWVjNzUyYTllNGNk
+    YzVmMzZkMDNlMzBkMjU0ODQ5ZjVlN2E1ZTM1MWNmM2NlMWRjYjQ=
+  data.tar.gz: !binary |-
+    MzI1YTc4ZjU2ZTEzNTZmMmY0NzU1MWUyMWFkZTM4OTA1ZWJjMThiYjcyMTA5
+    ZTlhOGU5ZmM0ODU5N2E2NGE1ODVkNDkyNDBiNmE1NDEyZmQ0MzhkNjFhYWZl
+    MWY0Y2YyNDU1OWFmOGM0MTZmZWYwNTFkZDBjZjFjZDQyZmE3MjU=

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+*.swo
+*.swp
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Pang Yan Han
+
+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,74 @@
+# Viki Disqus Gem
+
+This is a gem used by the Viki web application for integrating Disqus
+Single Sign-On (SSO). Users who log in to Viki can post comments on Disqus
+using the same Viki account, without the need for another login.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'viki_disqus'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install viki_disqus
+
+## Usage
+
+**NOTE:** You will have to read
+http://help.disqus.com/customer/portal/articles/236206-integrating-single-sign-on
+for setup instructions on the Disqus end.
+
+You need to set these 2 environment variables to appropriate values:
+
+* `DISQUS_SECRET_KEY`
+* `DISQUS_PUBLIC_KEY`
+
+They will be used by the VikiDisqus::SSO class.
+Their values can be accessed through:
+
+* `VikiDisqus::SSO::DISQUS_SECRET_KEY`
+* `VikiDisqus::SSO::DISQUS_PUBLIC_KEY`
+
+These functions are available publicly:
+
+* `VikiDisqus::SSO::remote_auth_s3(optionsHash, timestampNow)`
+* `VikiDisqus::SSO::signature(optionsHash, timestampNow)`
+* `VikiDisqus::SSO::message(optionsHash)`
+
+You should make use of the `VikiDisqus::SSO::remote_auth_s3` function
+(which uses `VikiDisqus::SSO::signature` and
+`VikiDisqus::SSO::message` internally).
+
+You will need to embed this snippet of JavaScript, according to instructions
+from Disqus. The template looks like:
+
+```javascript
+var disqus_config = function () {
+    // The generated payload which authenticates users with Disqus
+    this.page.remote_auth_s3 = '<message> <hmac> <timestamp>';
+    this.page.api_key = 'public_api_key';
+}
+```
+
+On the Viki web application, it looks like:
+
+```javascript
+var disqus_config = function () {
+  this.page.remote_auth_s3 = '<%= VikiDisqus::SSO.remote_auth_s3(opts, Time.now.to_i) %>';
+  this.page.api_key = '<%= VikiDisqus::SSO::DISQUS_PUBLIC_KEY %>';
+}
+```
+
+## Running Tests
+
+`bundle exec rspec spec`
+
+or
+
+`rspec spec`

data/Rakefile

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

data/lib/viki_disqus/SSO.rb

@@ -0,0 +1,29 @@
+require 'base64'
+require 'openssl'
+
+module VikiDisqus
+  # Disqus SSO Doc: http://help.disqus.com/customer/portal/articles/236206-integrating-single-sign-on
+  class SSO
+    DISQUS_SECRET_KEY = ENV["DISQUS_SECRET_KEY"]
+    DISQUS_PUBLIC_KEY = ENV["DISQUS_PUBLIC_KEY"]
+
+    def self.remote_auth_s3(opts, timestamp)
+      "#{message(opts)} #{signature(opts, timestamp)} #{timestamp}"
+    end
+
+    def self.signature(opts, timestamp)
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha1'),
+                              DISQUS_SECRET_KEY,
+                              "#{message(opts)} #{timestamp}")
+    end
+
+    # Validate message: http://disqus.com/api/sso/
+    def self.message(opts)
+      message = {'id' => opts['id'], 'username' => opts['username'], 'email' => opts['email']}
+      message.merge!({'url' => opts['url']}) if opts.has_key?('url')
+      message.merge!({'avatar'=> opts['avatar']}) if opts.has_key?('avatar')
+
+      Base64.strict_encode64(message.to_json).gsub("\n", "")
+    end
+  end
+end

data/lib/viki_disqus/version.rb

@@ -0,0 +1,3 @@
+module VikiDisqus
+  VERSION = "0.1.0"
+end

data/lib/viki_disqus.rb

@@ -0,0 +1,7 @@
+require "viki_disqus/version"
+
+module VikiDisqus
+  # Your code goes here...
+end
+
+require "viki_disqus/SSO"

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require "viki_disqus"
+
+RSpec.configure do |config|
+end

data/spec/viki_disqus/SSO_spec.rb

@@ -0,0 +1,42 @@
+require_relative "../spec_helper"
+require "json"
+
+describe VikiDisqus::SSO do
+  let(:user_hash) { {'id' => 1, "username" => "admin", "email" => "admin@viki.com"} }
+  let(:timestamp) { 1360142584 }
+
+  describe "#signature" do
+    it "generate the signature of a given user" do
+      described_class.signature(user_hash, timestamp).should ==
+          OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha1'),
+                                  VikiDisqus::SSO::DISQUS_SECRET_KEY,
+                                  "#{Base64.strict_encode64(user_hash.to_json).gsub("\n", "")} #{timestamp}")
+    end
+  end
+
+  describe "#message" do
+    it "return the base64 message" do
+      described_class.message(user_hash).should ==
+          Base64.encode64(user_hash.to_json).gsub("\n", "")
+    end
+
+    it "handles optional acceptable hash" do
+      user_hash.merge!({'url'=>"some_url", 'avatar'=>"some_avatar"})
+      described_class.message(user_hash).should ==
+          Base64.encode64(user_hash.to_json).gsub("\n", "")
+    end
+
+    it "does not handle unacceptable hash" do
+      extra_user_hash = user_hash.merge({'some_extra'=>'hash_not_needed_by_disqus'})
+      described_class.message(extra_user_hash).should ==
+          Base64.encode64(user_hash.to_json).gsub("\n", "")
+    end
+  end
+
+  describe "#remote_auth_s3" do
+    it "returns the signed message" do
+      described_class.remote_auth_s3(user_hash, timestamp).should ==
+          "#{described_class.message(user_hash)} #{described_class.signature(user_hash, timestamp)} #{timestamp}"
+    end
+  end
+end

data/viki_disqus.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'viki_disqus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "viki_disqus"
+  spec.version       = VikiDisqus::VERSION
+  spec.authors       = ["Tang Chin Yong", "Pang Yan Han"]
+  spec.email         = ["engineering@viki.com"]
+  spec.description   = %q{Viki Disqus Gem - for Single Sign-On (SSO)}
+  spec.summary       = %q{Viki Disqus Gem - for Single Sign-On (SSO)}
+  spec.homepage      = "http://engineering.viki.com"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.13"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: viki_disqus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tang Chin Yong
+- Pang Yan Han
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+description: Viki Disqus Gem - for Single Sign-On (SSO)
+email:
+- engineering@viki.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/viki_disqus.rb
+- lib/viki_disqus/SSO.rb
+- lib/viki_disqus/version.rb
+- spec/spec_helper.rb
+- spec/viki_disqus/SSO_spec.rb
+- viki_disqus.gemspec
+homepage: http://engineering.viki.com
+licenses: []
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Viki Disqus Gem - for Single Sign-On (SSO)
+test_files:
+- spec/spec_helper.rb
+- spec/viki_disqus/SSO_spec.rb