vanilla-jsconnect 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 32ad087b79cc2ded3eef68b2f8958d1c4893dd6c
+  data.tar.gz: 9f309dbccbbde94db748ef6d0157589cf0600cea
+SHA512:
+  metadata.gz: 7591adffb95940e4570fe23d35a27b1133e27d7b2455896716a61092dfef010609da5470f55573c7be3514a43f0a17b08325f09b11187b14675d007027fab210
+  data.tar.gz: 6868ea5b48278b6145640c7b2132b5463b3e36a670b0113329ca34509a5dd10276907c8128965ca8eda5691c0ee72a6b461256fd5eec135b9029bb021a2d7445

data/.rspec

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

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'codeclimate-test-reporter', require: nil
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,340 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    {description}
+    Copyright (C) {year}  {fullname}
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  {signature of Ty Coon}, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
+

data/README.md

@@ -0,0 +1,85 @@
+# vanilla-jsconnect
+[![Code Climate](https://codeclimate.com/github/corthmann/vanilla-jsconnect/badges/gpa.svg)](https://codeclimate.com/github/corthmann/vanilla-jsconnect)
+[![Test Coverage](https://codeclimate.com/github/corthmann/vanilla-jsconnect/badges/coverage.svg)](https://codeclimate.com/github/corthmann/vanilla-jsconnect)
+
+Ruby client library for Vanilla forums to connect websites with SSO through JsConnect.
+
+Installation
+-------------
+You can install this gem by using the following command:
+```
+gem install vanilla-jsconnect
+```
+or by adding the the following line to your Gemfile.
+```
+gem 'vanilla-jsconnect'
+```
+
+Configuration
+-------------
+The gem can be configured either by module or class configuration.
+```
+# module configuration
+VanillaJsConnect.configure do |config|
+  config.client_id = 'CLIENT_ID'
+  config.secret = 'SECRET'
+  config.hash_method = 'HASH_METHOD' # (optional)
+end
+
+# class configuration
+client = VanillaJsConnect::Client.new(
+                client_id: 'CLIENT_ID',
+                secret: 'SECRET',
+                hash_method: 'HASH_METHOD' # (optional)
+            )
+```
+
+Using the library
+-------------
+Vanilla jsConnect User:
+```
+user = {
+    'uniqueid' => 'UNIQUE USER ID FROM YOUR SYSTEM',
+    'name' => 'USER NAME',
+    'email' => 'USER EMAIL',
+    'photourl' => 'USER IMAGE'
+}
+```
+Authenticate a request and generate jsConnect (json) response
+```
+json = VanillaJsConnect::Client.new.authenticate(request, user).to_json
+```
+
+To complete the Single Sign On (SSO) you should render the resulting json string as jsonp. In rails this can be done like this:
+```
+render :json => json, :callback => params[:callback]
+```
+
+Error handling
+-------------
+The `authenticate` method will raise errors if an incoming request is invalid.
+
+If you have no interest in logging or tracking potential errors then you can do as follows to let it fail gracefully.
+```
+begin
+    client = VanillaJsConnect::Client.new
+    json = client.authenticate(request, user).to_json
+rescue VanillaJsConnect::Error => error
+    json = error.to_json
+end
+render :json => json, :callback => params[:callback]
+```
+
+JsConnect and SSO explained
+-------------
+When connecting Vanilla to another website through SSO you are typically interested in:
+
+* Authentication
+* Login / Logout
+* Registration (Sign-up)
+
+In Vanilla SSO authentication happens as an AJAX JSONP request sent to the authentication url configured in the Vanilla Dashboard.
+
+The authentication url then authenticates the incomming request and respond with user data if a signed in user session already exist on the connecting website. It is this authentication the `vanilla-jsconnect` gem adds to your website.
+
+SSO Login, Logout and Registration happens through redirection. To configure these actions correctly it is important to add this query parameter to the respective urls `Target={target}`. When a user then clicks on Register in the Vanilla forum he or she is then taken to the registration page of your main website. Upon completion of the registration flow, the main website then redirects the user back to the forum using the `Target` query parameter as the destination. When the user now enters the forum the authentication request gets user data from the main website.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/lib/vanilla-jsconnect.rb

@@ -0,0 +1,7 @@
+require 'vanilla-jsconnect/configuration'
+require 'vanilla-jsconnect/client'
+
+module VanillaJsConnect
+  extend Configuration
+
+end

data/lib/vanilla-jsconnect/client.rb

@@ -0,0 +1,109 @@
+require 'cgi'
+require 'openssl'
+require 'vanilla-jsconnect/error'
+
+module VanillaJsConnect
+  class Client
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    def initialize(options = {})
+      merged_options = VanillaJsConnect.options.merge(options)
+
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", merged_options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send(key)
+      end
+      conf
+    end
+
+    # Authenticate JsConnect request and return user object
+    # user = { 'uniqueid' => ..., 'name' =>  ..., 'photourl' => ..., 'email' => ... }
+    def authenticate(request, user = {})
+      if result = validate_request(request, user)
+        result
+      elsif has_user(user)
+        sign_js_connect(user)
+      else
+        user_stub_response
+      end
+    end
+
+    private
+    def has_user(user)
+      user && !user.empty?
+    end
+
+    def user_stub_response(user_name = '', photourl = '')
+      { 'name' => user_name , 'photourl' => photourl }
+    end
+
+    def validate_request(request, user)
+      request_timestamp = (request['timestamp'].nil? ? nil : request['timestamp'].to_i)
+
+      validate_client(request['client_id'])
+      if request_timestamp.nil? && request['signature'].nil?
+        if has_user(user)
+          user_stub_response(user['name'], user['photourl'])
+        else
+          user_stub_response
+        end
+      else
+        validate_timestamp(request_timestamp)
+        validate_signature(request['signature'], request_timestamp)
+      end
+    end
+
+    def validate_client(request_client_id)
+      if !request_client_id
+        raise VanillaJsConnect::InvalidRequest.new('The client_id parameter is missing.')
+      elsif request_client_id != client_id
+        raise VanillaJsConnect::InvalidClient.new("Unknown client #{request_client_id}.")
+      end
+    end
+
+    def validate_timestamp(request_timestamp)
+      if request_timestamp.nil?
+        raise VanillaJsConnect::InvalidRequest.new('The timestamp is missing or invalid.')
+      elsif (Time.now.to_i - request_timestamp).abs > 30 * 60
+        raise VanillaJsConnect::InvalidRequest.new('The timestamp is invalid.')
+      end
+    end
+
+    def validate_signature(request_signature, request_timestamp)
+      if !request_signature
+        raise VanillaJsConnect::InvalidRequest.new('The signature is missing.')
+      else
+        # Make sure the timestamp's signature checks out.
+        if generate_signature(request_timestamp) != request_signature
+          raise VanillaJsConnect::AccessDenied.new('Signature invalid.')
+        end
+      end
+    end
+
+    def generate_signature(text)
+      OpenSSL::Digest.new("#{hash_method}").hexdigest(text.to_s + secret)
+    end
+
+    def sign_js_connect(data)
+      keys = data.keys.sort { |a,b| a.downcase <=> b.downcase }
+
+      sig_str = ''
+      keys.each_with_index do |key, index|
+        if index > 0
+          sig_str += '&'
+        end
+        sig_str += "#{CGI.escape(key)}=#{CGI.escape(data[key].to_s)}"
+      end
+
+      data['clientid'] = client_id
+      data['signature'] = generate_signature(sig_str)
+      data
+    end
+  end
+end

data/lib/vanilla-jsconnect/configuration.rb

@@ -0,0 +1,35 @@
+module VanillaJsConnect
+  module Configuration
+
+    VALID_OPTIONS_KEYS = [
+        :client_id,
+        :secret,
+        :hash_method
+    ].freeze
+
+    DEFAULT_CLIENT_ID = nil
+    DEFAULT_SECRET = nil
+    DEFAULT_HASH_METHOD = :sha1
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def reset
+      self.client_id = DEFAULT_CLIENT_ID
+      self.secret = DEFAULT_SECRET
+      self.hash_method = DEFAULT_HASH_METHOD
+    end
+
+    def configure
+      yield self
+    end
+
+    # Return the configuration values set in this module
+    def options
+      Hash[ * VALID_OPTIONS_KEYS.map { |key| [key, send(key)] }.flatten ]
+    end
+  end
+end

data/lib/vanilla-jsconnect/error.rb

@@ -0,0 +1,40 @@
+module VanillaJsConnect
+  class Error < StandardError
+    attr_reader :code, :message
+
+    def initialize(code = nil, message = nil)
+      @code = code
+      @message = message
+    end
+
+    def inspect
+      "#<VanillaJsConnect::Error: VanillaJsConnect::Error code=\"#{@code}\" message=\"#{@message}\">"
+    end
+
+    def to_json
+      { code: @code, message: @message }.to_json
+    end
+  end
+
+  class InvalidRequest < Error
+    def initialize(message)
+      @code = 'invalid_request'
+      @message = message
+    end
+  end
+
+  class InvalidClient < Error
+    def initialize(message)
+      @code = 'invalid_client'
+      @message = message
+    end
+  end
+
+  class AccessDenied < Error
+    def initialize(message)
+      @code = 'access_denied'
+      @message = message
+    end
+  end
+
+end

data/lib/vanilla-jsconnect/version.rb

@@ -0,0 +1,3 @@
+module VanillaJsConnect
+  VERSION = '1.0.0'.freeze
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'simplecov'
+require 'simplecov-rcov'
+require 'codeclimate-test-reporter'
+
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter[
+                SimpleCov::Formatter::HTMLFormatter,
+                SimpleCov::Formatter::RcovFormatter,
+                CodeClimate::TestReporter::Formatter
+            ]
+  add_group('VanillaJsConnect', 'lib/vanilla-jsconnect')
+  add_group('Specs', 'spec')
+end
+
+require 'vanilla-jsconnect'
+
+require 'rspec'

data/spec/support/vanilla-jsconnect_factory.rb

@@ -0,0 +1,14 @@
+module VanillaJsConnectFactory
+  def self.client_id
+    1234567890
+  end
+
+  def self.secret
+    'nobodyknows'
+  end
+
+  def self.user
+    { 'uniqueid' => 1, 'name' => 'John Smith', 'photourl' => 'http://example.com/image', 'email' => 'test@email.com' }
+  end
+
+end

data/spec/vanilla-jsconnect/client_spec.rb

@@ -0,0 +1,175 @@
+require 'spec_helper'
+require 'vanilla-jsconnect/client'
+require 'support/vanilla-jsconnect_factory'
+
+def generate_valid_request(instance)
+  timestamp = Time.now.to_i
+  request = {
+      'client_id' => VanillaJsConnectFactory.client_id,
+      'timestamp' => timestamp,
+      'signature' => instance.send(:generate_signature, timestamp )
+  }
+  request
+end
+
+module VanillaJsConnect
+  describe VanillaJsConnect::Client do
+
+    before do
+      VanillaJsConnect.configure do |config|
+        config.client_id = VanillaJsConnectFactory.client_id
+        config.secret = VanillaJsConnectFactory.secret
+      end
+    end
+
+    context 'when initialized' do
+      context 'without instance configuration' do
+        it 'uses the correct configuration' do
+          instance = described_class.new
+          expect(instance.client_id).to eql(1234567890)
+          expect(instance.secret).to eql('nobodyknows')
+        end
+      end
+
+      context 'with instance configuration' do
+        it 'uses the correct configuration' do
+          instance = described_class.new({ client_id: 9876543210, secret: 'somethingelse' })
+          expect(instance.client_id).to eql(9876543210)
+          expect(instance.secret).to eql('somethingelse')
+        end
+      end
+    end
+
+    describe '.authenticate' do
+      context 'given a valid request' do
+        context 'and using SHA1 as hashing method' do
+          let(:instance) { described_class.new }
+
+          it 'should return a signed jsconnect response' do
+            request = generate_valid_request(instance)
+            expect(instance.authenticate(request, VanillaJsConnectFactory.user)).to be
+          end
+        end
+
+        context 'and using MD5 as hashing method' do
+          let(:instance) { described_class.new( { hash_method: :md5 } ) }
+
+          it 'should return a signed jsconnect response' do
+            request = generate_valid_request(instance)
+            expect(instance.authenticate(request, VanillaJsConnectFactory.user)).to be
+          end
+        end
+
+        context 'and using an unsupported hashing method' do
+          let(:instance) { described_class.new( { hash_method: :abc } ) }
+
+          it 'raises an error' do
+            request = generate_valid_request(described_class.new)
+            expect { instance.authenticate(request, VanillaJsConnectFactory.user) }.
+                to raise_error(RuntimeError, /Unsupported digest algorithm/)
+          end
+        end
+
+        context 'without a timestamp and signature' do
+          let(:instance) { described_class.new }
+
+          context 'and given a user' do
+            it 'returns an unsigned user stub response' do
+              request = generate_valid_request(instance)
+              request.delete('timestamp')
+              request.delete('signature')
+              response = instance.authenticate(request, VanillaJsConnectFactory.user)
+              expect(response.keys.size).to eql(2)
+              expect(response['name']).to be
+              expect(response['photourl']).to be
+            end
+          end
+
+          context 'and not given a user' do
+            it 'returns an empty unsiged user stub response' do
+              request = generate_valid_request(instance)
+              request.delete('timestamp')
+              request.delete('signature')
+              response = instance.authenticate(request)
+              expect(response.keys.size).to eql(2)
+              expect(response['name']).to eql('')
+              expect(response['photourl']).to eql('')
+            end
+          end
+        end
+
+        context 'and not given a user' do
+          let(:instance) { described_class.new }
+
+          it 'returns an empty unsiged user stub response' do
+            response = instance.authenticate(generate_valid_request(instance))
+            expect(response.keys.size).to eql(2)
+            expect(response['name']).to eql('')
+            expect(response['photourl']).to eql('')
+          end
+        end
+      end
+
+      context 'given an invalid request' do
+        context 'which is missing a client id' do
+          it 'raises an invalid request error' do
+            instance = described_class.new
+            request = generate_valid_request(instance)
+            request.delete('client_id')
+            expect { instance.authenticate(request, VanillaJsConnectFactory.user) }.
+                to raise_error(InvalidRequest)
+          end
+        end
+
+        context 'which contains an invalid client id' do
+          it 'raises an invalid client error' do
+            instance = described_class.new
+            request = generate_valid_request(instance)
+            request['client_id'] = 5432167890
+            expect { instance.authenticate(request, VanillaJsConnectFactory.user) }.
+                to raise_error(InvalidClient)
+          end
+        end
+
+        context 'which is missing a timestamp' do
+          it 'raises an invalid request error' do
+            instance = described_class.new
+            request = generate_valid_request(instance)
+            request.delete('timestamp')
+            expect { instance.authenticate(request, VanillaJsConnectFactory.user) }.
+                to raise_error(InvalidRequest)
+          end
+        end
+
+        context 'which contains an invalid timestamp' do
+          it 'raises an access denied error' do
+            instance = described_class.new
+            request = generate_valid_request(instance)
+            request['timestamp'] = Time.now - 60*31
+            expect { instance.authenticate(request, VanillaJsConnectFactory.user) }.
+                to raise_error(InvalidRequest)
+          end
+        end
+
+        context 'which is missing a signature' do
+          it 'raises an invalid request error' do
+            instance = described_class.new
+            request = generate_valid_request(instance)
+            request.delete('signature')
+            expect { instance.authenticate(request, VanillaJsConnectFactory.user) }.
+                to raise_error(InvalidRequest)
+          end
+        end
+
+        context 'which contains an invalid signature' do
+          it 'raises an access denied error' do
+            instance = described_class.new
+            request = generate_valid_request(described_class.new( { secret: 'dunno' } ))
+            expect { instance.authenticate(request, VanillaJsConnectFactory.user) }.
+                to raise_error(AccessDenied)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/vanilla-jsconnect/configuration_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'vanilla-jsconnect/configuration'
+
+module VanillaJsConnect
+  describe VanillaJsConnect::Configuration do
+    after do
+      VanillaJsConnect.reset
+    end
+
+    describe '.configure' do
+      VanillaJsConnect::Configuration::VALID_OPTIONS_KEYS.each do |key|
+        it "should set the #{key}" do
+          VanillaJsConnect.configure do |config|
+            config.send("#{key}=", key)
+            expect(VanillaJsConnect.send(key)).to eql(key)
+          end
+        end
+      end
+    end
+
+    VanillaJsConnect::Configuration::VALID_OPTIONS_KEYS.each do |key|
+      describe ".#{key}" do
+        it 'should reutrn the default value' do
+          expect(VanillaJsConnect.send(key)).to eql(VanillaJsConnect::Configuration.const_get("DEFAULT_#{key.upcase}"))
+        end
+      end
+    end
+  end
+end

data/spec/vanilla-jsconnect/error_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'vanilla-jsconnect/configuration'
+
+module VanillaJsConnect
+  describe VanillaJsConnect::Error do
+    describe 'when initialized' do
+      let(:instance) { described_class.new('some_code', 'some error message') }
+
+      it 'sets the code and message' do
+        expect(instance.code).to eql('some_code')
+        expect(instance.message).to eql('some error message')
+      end
+
+      it 'converts to json correctly' do
+        expect(instance.to_json).
+            to eql({ code: 'some_code', message: 'some error message'}.to_json)
+      end
+
+      context '.inspect' do
+        it 'has the correct format' do
+          expect(instance.inspect).
+              to eql('#<VanillaJsConnect::Error: VanillaJsConnect::Error code="some_code" message="some error message">')
+        end
+      end
+    end
+  end
+end

data/vanilla-jsconnect.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path('../lib/vanilla-jsconnect/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'vanilla-jsconnect'
+  s.version     = VanillaJsConnect::VERSION.dup
+  s.date        = '2015-04-26'
+  s.summary     = "Ruby client library for Vanilla forums to connect websites with SSO through JsConnect."
+  s.description = "Ruby client library for Vanilla forums to connect websites with Single Sign On (SSO) through JsConnect."
+  s.authors     = ["Christian Orthmann"]
+  s.email       = 'christian.orthmann@gmail.com'
+  s.require_path = 'lib'
+  s.files       = `git ls-files`.split("\n") - %w(.rvmrc .gitignore)
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n") - %w(.rvmrc .gitignore)
+  s.homepage    = 'http://rubygems.org/gems/vanilla-jsconnect'
+  s.license     = 'GPL-2'
+
+  s.add_development_dependency('rake', '~> 10')
+  s.add_development_dependency('rspec', '~> 3')
+  s.add_development_dependency('simplecov', '~> 0')
+  s.add_development_dependency('simplecov-rcov', '~> 0')
+  s.add_development_dependency('yard', '~> 0')
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: vanilla-jsconnect
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Christian Orthmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: simplecov-rcov
+  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: yard
+  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: Ruby client library for Vanilla forums to connect websites with Single
+  Sign On (SSO) through JsConnect.
+email: christian.orthmann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/vanilla-jsconnect.rb
+- lib/vanilla-jsconnect/client.rb
+- lib/vanilla-jsconnect/configuration.rb
+- lib/vanilla-jsconnect/error.rb
+- lib/vanilla-jsconnect/version.rb
+- spec/spec_helper.rb
+- spec/support/vanilla-jsconnect_factory.rb
+- spec/vanilla-jsconnect/client_spec.rb
+- spec/vanilla-jsconnect/configuration_spec.rb
+- spec/vanilla-jsconnect/error_spec.rb
+- vanilla-jsconnect.gemspec
+homepage: http://rubygems.org/gems/vanilla-jsconnect
+licenses:
+- GPL-2
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Ruby client library for Vanilla forums to connect websites with SSO through
+  JsConnect.
+test_files: []
+has_rdoc: