monk-id 1.1.0 → 1.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWZiMDQ3ZjBlYWFiNzAxMWY3ZTdiZGY0NzJhNTg4ODE2YmQwNTViNg==
+    MGI0YWFmMzVhYWI1NGFjMGZmYTdlMmI5ZDhkZDE2Yzc2OTdlOTg3MA==
   data.tar.gz: !binary |-
-    YjNkN2EwMTFjZWZkNmRmMmY2MDdlMzllNDA1ODg4YTJiYzE4ZTM3Nw==
+    ZTBmZDQ2ZGZkOGNkY2Q2NzRmNzNhZTM3ZTgxMzE2NDJmZDhiNzNjMA==
 SHA512:
   metadata.gz: !binary |-
-    OWQ3YmU5MDgyZjUzOTdmYjkzYTY4NTgyOTRmMjJkOTYxNWJhMzAwZDJhM2Ex
-    NjhmMDVmMWE0ODA4ZGE4MDM4ZTkwZDEwY2UyMjdlYWVkYjRmYWQ4M2VhYjIz
-    N2JlM2QxZTJmZjliNDgzMzBiMGY2YjYyOWI0ZmRhOTgzYzZlMTE=
+    MmQzYTYwN2UwYjA0MWVjZGE3YTQxZTU1ZDg1NTdmY2NlOGY3OTg1MDA2NTg1
+    YTVlMThmY2E1MTFhZjcyYzhjNDM1MjJhNmYwOTgyYjYwNDA0ODlkMWE3OGJj
+    NDM4M2RhNDQyZmNjYTkzNGYxNWI0MDEyODA4ZWViODAwNDhmOGE=
   data.tar.gz: !binary |-
-    YWI3MWQyYTg5Zjk2MTcyNzZhZmM1NmU2ZTBiYzE0NTY0NzZhNGE4MDcxNjMx
-    ZmUxYzAyZjA0ZTJhZjU0NWRjNmRlMGVkNmYyNjY3NGU5Y2JmMDJmMDc2Y2E1
-    NzAwZmYwYjk4Y2E1ODI1MmM5ODdlZDBkNTRlMzk5MzY5ZDQwNjE=
+    ZWY1OGU2YWI0ZDY3NzFhYmFjYzhjMjFlMDQwMzc1MGZiZDg2OTFhOGFlYjUw
+    YzQyMDcxNzllOTk0NTJlNTg0Yjg4M2U0NmJhYjVjMGVmOTk5M2ViMzg0MWQy
+    Y2FkYjM1MjgyMmNhNDVhMDhlZDhmYTEwMzljOTBlY2VmMDY0MjY=

data/.editorconfig

@@ -0,0 +1,14 @@
+# EditorConfig: http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitattributes

@@ -0,0 +1 @@
+* text=auto

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format doc

data/.rubocop.yml

@@ -0,0 +1 @@
+require: rubocop-rspec

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+
+rvm:
+  - 2.1.1
+  - 2.0.0
+  - 1.9.3

data/Gemfile

@@ -1,4 +1,6 @@
+# encoding: utf-8
+
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in monk-id.gemspec
+# Specify dependencies in monk-id.gemspec.
 gemspec

data/Guardfile

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(/^spec\/.+_spec\.rb$/)
+  watch(/^lib\/(.+)\.rb$/)     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/helpers.rb')     { 'spec' }
+  watch('spec/spec_helper.rb') { 'spec' }
+end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(/(?:.+\/)?\.rubocop\.yml$/) { |m| File.dirname(m[0]) }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Monk Development, Inc.
+
+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

@@ -2,6 +2,11 @@ Monk ID Ruby
 ============
 
 [![Gem Version](https://badge.fury.io/rb/monk-id.png)](http://badge.fury.io/rb/monk-id)
+[![Build Status](https://travis-ci.org/MonkDev/monk-id-ruby.svg?branch=dev)](https://travis-ci.org/MonkDev/monk-id-ruby)
+[![Code Climate](https://codeclimate.com/github/MonkDev/monk-id-ruby.png)](https://codeclimate.com/github/MonkDev/monk-id-ruby)
+[![Coverage Status](https://coveralls.io/repos/MonkDev/monk-id-ruby/badge.png?branch=dev)](https://coveralls.io/r/MonkDev/monk-id-ruby?branch=dev)
+[![Inline docs](http://inch-ci.org/github/MonkDev/monk-id-ruby.png)](http://inch-ci.org/github/MonkDev/monk-id-ruby)
+[![Dependency Status](https://gemnasium.com/MonkDev/monk-id-ruby.svg)](https://gemnasium.com/MonkDev/monk-id-ruby)
 
 Integrate Monk ID authentication and single sign-on for apps and websites on the
 server-side.
@@ -24,7 +29,7 @@ integration.
 Add the gem to your `Gemfile` if using [Bundler](http://bundler.io):
 
 ```ruby
-gem 'monk-id'
+gem 'monk-id', '~> 1.0'
 ```
 
 ```bash
@@ -93,41 +98,82 @@ and verified.
 Development
 -----------
 
-Start by installing the development dependencies with Bundler:
+[Bundler](http://bundler.io) is used heavily for development, so be sure to have
+it installed along with a version of Ruby.
+
+Once those are installed and working, installing the development dependencies:
 
 ```bash
 $ bundle
 ```
 
 This requires all subsequent commands be prepended with `bundle exec`, which has
-been ommitted for conciseness.
+been ommitted for conciseness going forward.
+
+### Workflow
 
-During development, changes must be tested manually since an automated test
-suite does not yet exist. This is best done by requiring the library locally in
-an app or website that integrates it already. There are a few ways to do this.
+[Rake](https://github.com/jimweirich/rake) is setup to run the tests and check
+code quality by default:
 
-### With Bundler
+```bash
+$ rake
+```
+
+[Guard](http://guardgem.org) takes it a step further and automatically runs the
+appropriate tasks on file change:
+
+```bash
+$ guard
+```
+
+It's recommended to run Guard during development.
+
+### Tests
+
+Testing is done with [RSpec](https://relishapp.com/rspec). To run the tests:
+
+```bash
+$ rake spec
+```
+
+[SimpleCov](https://github.com/colszowka/simplecov) automatically generates a
+code coverage report to the `coverage` directory on every run of the test suite.
+
+Continuous integration is setup through [Travis CI](https://travis-ci.org/MonkDev/monk-id-ruby)
+to run the tests against Ruby v1.9.3, v2.0.0, and v2.1.1.
+([Circle CI](https://circleci.com/gh/MonkDev/monk-id-ruby) is also setup to run
+the tests against Ruby v1.9.3, but is backup for now until multiple versions can
+easily be specified.) The SimpleCov results are sent to [Coveralls](https://coveralls.io/r/MonkDev/monk-id-ruby)
+during CI for tracking over time. Badges for both are dispayed at the top of
+this README.
+
+#### Manual
+
+While the test suite is complete, it's not a bad idea to also test changes
+manually in real-world integrations.
+
+##### With Bundler
 
 Not to be confused with the fact that Bundler is used for development of this
 library, if Bundler is used in the test app or website, you can either specify a
 path to the library locally:
 
 ```ruby
-gem 'monk-id', :path => '/path/to/monk-id-ruby'
+gem 'monk-id', path: '/path/to/monk-id-ruby'
 ```
 
 Or configure Bundler to use a local repository instead of the GitHub repository
-(more details [in the documentation](http://bundler.io/v1.5/git.html#local)):
+(more details [in the documentation](http://bundler.io/v1.7/git.html#local)):
 
 ```ruby
-gem 'monk-id', :github => 'MonkDev/monk-id-ruby', :branch => 'master'
+gem 'monk-id', github: 'MonkDev/monk-id-ruby', branch: 'master'
 ```
 
 ```bash
 $ bundle config local.monk-id /path/to/monk-id-ruby
 ```
 
-### Without Bundler
+#### Without Bundler
 
 If Bundler is not used, you can either build and install the gem as a system
 gem (this must be done for every change):
@@ -155,16 +201,30 @@ you can preview as you document by starting the YARD server:
 $ yard server --reload
 ```
 
-This hosts the documentation at http://localhost:8808 and automatically watches
-for changes on page refresh.
+This hosts the documentation at [http://localhost:8808](http://localhost:8808)
+and automatically watches for changes on page refresh.
 
-The documentation can also be built to a `doc` directory (that is ignored by
+The documentation can also be built to the `doc` directory (that is ignored by
 git):
 
 ```bash
 $ yard
 ```
 
+### Quality
+
+[RuboCop](https://github.com/bbatsov/rubocop) is configured to enforce the
+[Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide). While Guard is
+setup to run it automatically on file change, it can also be run manually:
+
+```bash
+$ rake quality
+```
+
+[Code Climate](https://codeclimate.com/github/MonkDev/monk-id-ruby) is setup to
+perform continuous code quality inspection. The quality badge is displayed at
+the top of this README.
+
 Deployment
 ----------
 
@@ -180,8 +240,7 @@ These steps can be executed individually, but it's easiest to do all at once:
 $ gem bump --version major|minor|patch --tag --release
 ```
 
-Be sure to choose the correct version by following
-[Semantic Versioning](http://semver.org).
+Be sure to choose the correct version by following [Semantic Versioning](http://semver.org).
 
 ### Publish Documentation
 

data/Rakefile

@@ -1 +1,10 @@
+# encoding: utf-8
+
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:quality)
+
+task default: %w(spec quality)

data/circle.yml

@@ -0,0 +1,8 @@
+machine:
+  ruby:
+    version: 1.9.3-p448
+
+test:
+  override:
+    - bundle exec rake spec
+    - bundle exec rake quality

data/lib/monk/id.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'base64'
 require 'json'
 require 'openssl'
@@ -38,9 +40,9 @@ module Monk
 
         config = YAML.load_file(path)[environment]
 
-        verify_config(config)
+        valid_config?(config)
 
-        @@config = config
+        @config = config
       end
 
       # Get a config value. Attempts to load the config if it hasn't already
@@ -50,34 +52,30 @@ module Monk
       # @raise  [StandardError] If the config can't be loaded.
       # @return [*] Config value.
       def config(key)
-        load_config unless @@config
+        load_config unless @config
 
-        @@config[key]
+        @config[key]
       end
 
       # Load a payload from the client-side.
       #
       # @param  encoded_payload [String, #[]] Encoded payload or Hash-like
       #         cookies object to automatically load the payload from.
-      # @return [Hash<Symbol>] Decoded and verified payload. Empty if there's no
-      #         payload or it fails verification.
+      # @return [Hash<Symbol>] Decoded and validate payload. Empty if there's no
+      #         payload or it fails validation.
       def load_payload(encoded_payload = nil)
-        if encoded_payload.is_a? String
-          payload = encoded_payload
-        elsif encoded_payload.respond_to? :[]
-          payload = encoded_payload[COOKIE_NAME]
-        end
+        payload = select_payload(encoded_payload)
 
-        return @@payload = {} unless payload
+        return @payload = {} unless payload
 
         begin
           payload = decode_payload(payload)
-          verified = verify_payload(payload)
+          valid = valid_payload?(payload)
         rescue
-          verified = false
+          valid = false
         end
 
-        @@payload = verified ? payload : {}
+        @payload = valid ? payload : {}
       end
 
       # Get the signed in user's UUID.
@@ -85,7 +83,7 @@ module Monk
       # @return [String] If signed in user.
       # @return [nil] If no signed in user.
       def user_id
-        payload_user :id
+        payload_user(:id)
       end
 
       # Get the signed in user's email address.
@@ -93,27 +91,27 @@ module Monk
       # @return [String] If signed in user.
       # @return [nil] If no signed in user.
       def user_email
-        payload_user :email
+        payload_user(:email)
       end
 
       # Check whether there's a signed in user.
       #
       # @return [Boolean] Whether there's a signed in user.
       def signed_in?
-        !!user_id
+        !user_id.nil?
       end
 
-    protected
+      protected
 
       # Loaded config values.
-      @@config = nil
+      @config = nil
 
       # Loaded payload.
-      @@payload = nil
+      @payload = nil
 
       # Get the path to the config file from the environment. Supports `ENV`
       # variable, Rails, and Sinatra.
-      # 
+      #
       # @return [String] Path to the config file.
       # @return [nil] If not set by the environment.
       def config_path_from_environment
@@ -128,7 +126,7 @@ module Monk
 
       # Get the environment to load within the config. Supports `ENV` variable,
       # Rails, and Sinatra. Defaults to `development` if none specify.
-      # 
+      #
       # @return [String] Environment name.
       def config_environment
         if ENV['MONK_ID_ENV']
@@ -142,26 +140,40 @@ module Monk
         end
       end
 
-      # Verify that a config has all the required values.
+      # Validate that a config has all the required values.
       #
       # @param  config [Hash<String>] Config values.
       # @raise  [RuntimeError] If invalid.
       # @return [true] If valid.
-      def verify_config(config)
-        raise 'no config loaded' unless config
-        raise 'no `app_id` config value' unless config['app_id']
-        raise 'no `app_secret` config value' unless config['app_secret']
+      def valid_config?(config)
+        fail 'no config loaded' unless config
+        fail 'no `app_id` config value' unless config['app_id']
+        fail 'no `app_secret` config value' unless config['app_secret']
 
         true
       end
 
+      # Select a payload from the first place one can be found.
+      #
+      # @param  encoded_payload [String, #[]] Encoded payload or Hash-like
+      #         cookies object to select the payload from.
+      # @return [String] Encoded payload.
+      # @return [nil] If one can't be found.
+      def select_payload(encoded_payload)
+        if encoded_payload.is_a? String
+          encoded_payload
+        elsif encoded_payload.respond_to? :[]
+          encoded_payload[COOKIE_NAME]
+        end
+      end
+
       # Decode a payload from the client-side.
       #
       # @param  encoded_payload [String] Encoded payload.
       # @raise  [JSON::ParserError] If invalid JSON.
       # @return [Hash<Symbol>] Decoded payload.
       def decode_payload(encoded_payload)
-        JSON.parse(Base64.decode64(encoded_payload), :symbolize_names => true)
+        JSON.parse(Base64.decode64(encoded_payload), symbolize_names: true)
       end
 
       # Generate the expected signature of a payload using the app's secret.
@@ -172,15 +184,19 @@ module Monk
         payload_clone = payload.clone
         payload_clone[:user].delete(:signature)
 
-        OpenSSL::HMAC.digest(OpenSSL::Digest::SHA512.new, config('app_secret'), JSON.generate(payload_clone[:user]))
+        OpenSSL::HMAC.digest(
+          OpenSSL::Digest::SHA512.new,
+          config('app_secret'),
+          JSON.generate(payload_clone[:user])
+        )
       end
 
-      # Verify that a payload hasn't been tampered with or faked by comparing
+      # Validate that a payload hasn't been tampered with or faked by comparing
       # signatures.
       #
       # @param  payload [Hash<Symbol>] Decoded payload.
-      # @return [Boolean] Whether the payload is legit.
-      def verify_payload(payload)
+      # @return [Boolean] Whether the payload is valid.
+      def valid_payload?(payload)
         signature = Base64.decode64(payload[:user][:signature])
 
         signature == expected_signature(payload)
@@ -189,9 +205,9 @@ module Monk
       # Get the loaded payload.
       #
       # @return [Hash<Symbol>] Loaded payload. Empty if there's no payload or it
-      #         failed verification.
+      #         failed validation.
       def payload
-        @@payload || load_payload
+        @payload || load_payload
       end
 
       # Get a value from the `user` hash of the loaded payload.
@@ -201,11 +217,7 @@ module Monk
       def payload_user(key)
         payload = self.payload
 
-        if payload.key?(:user)
-          payload[:user][key]
-        else
-          nil
-        end
+        payload.key?(:user) ? payload[:user][key] : nil
       end
     end
   end

data/lib/monk/id/version.rb

@@ -1,6 +1,13 @@
+# encoding: utf-8
+
+# Global Monk namespace.
 module Monk
+  # Integrate Monk ID on the server-side by accessing payloads from the
+  # client-side JavaScript.
+  #
+  # @author Monk Development, Inc.
   module Id
     # Current version of the library.
-    VERSION = '1.1.0'.freeze
+    VERSION = '1.1.1'.freeze
   end
 end

data/monk-id.gemspec

@@ -1,4 +1,5 @@
-# coding: utf-8
+# encoding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'monk/id/version'
@@ -8,19 +9,30 @@ Gem::Specification.new do |spec|
   spec.version       = Monk::Id::VERSION.dup
   spec.authors       = ['Monk Development, Inc.']
   spec.email         = ['support@monkdevelopment.com']
-  spec.summary       = 'Integrate Monk ID authentication and single sign-on for apps and websites on the server-side.'
+  spec.summary       = 'Integrate Monk ID authentication and single sign-on ' \
+                       'for apps and websites on the server-side.'
   spec.description   = spec.summary
   spec.homepage      = 'https://github.com/MonkDev/monk-id-ruby'
   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.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'coveralls', '~> 0.7'
   spec.add_development_dependency 'gem-release', '~> 0.7'
-  spec.add_development_dependency 'rake', '~> 10.1'
-  spec.add_development_dependency 'yard', '~> 0.8'
+  spec.add_development_dependency 'guard', '~> 2.6'
+  spec.add_development_dependency 'guard-rspec', '~> 4.3'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.1'
+  spec.add_development_dependency 'rake', '~> 10.3'
   spec.add_development_dependency 'redcarpet', '~> 3.1'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.25'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.2'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
+  spec.add_development_dependency 'yard', '~> 0.8'
 end

data/spec/config/monk_id.yml

@@ -0,0 +1,15 @@
+test:
+  app_id: ca13c9d1-6600-490e-a448-adb99e2eb906
+  app_secret: 98d7ac3f9e22e52f9f23b83ca791db055acad39a27e17dc7
+
+development:
+  app_id: development_app_id
+  app_secret: development_app_secret
+
+rails:
+  app_id: rails_app_id
+  app_secret: rails_app_secret
+
+sinatra:
+  app_id: sinatra_app_id
+  app_secret: sinatra_app_secret

data/spec/config/monk_id_alt.yml

@@ -0,0 +1,6 @@
+env:
+  app_id: env_app_id
+  app_secret: env_app_secret
+
+required:
+  app_id: required_app_id

data/spec/config/monk_id_invalid.yml

@@ -0,0 +1 @@
+invalid

data/spec/helpers.rb

@@ -0,0 +1,107 @@
+# encoding: utf-8
+
+# Helpers that are included in every spec.
+module Helpers
+  def spec_path
+    File.expand_path(File.dirname(__FILE__))
+  end
+
+  def config_path
+    "#{spec_path}/config"
+  end
+
+  def config_file_path
+    "#{config_path}/monk_id.yml"
+  end
+
+  def config_file_alt_path
+    "#{config_path}/monk_id_alt.yml"
+  end
+
+  def valid_payload
+    'eyJ1c2VyIjp7ImVtYWlsIjoianN0YXl0b25AbW9ua2RldmVsb3BtZW50LmNvbSIsImlkIjoi' \
+    'NjJjOTg4YmEtMTNkOC00NzNlLWFkZWItOGY3ZDJjNjI4NDZhIiwic2lnbmF0dXJlIjoiOWlG' \
+    'YStLWHlTZTEvS29uM0hXRitLZlRQVDJ2MVl3QyttVEFBQko0QXpsRWZkNmR0UG1HWWpVend2' \
+    'OUtYXG5vbXJreWFMQi9oQjcrWExHQW41OTlLKzlFdz09XG4ifX0='
+  end
+
+  def expected_payload
+    {
+      user: {
+        id:    '62c988ba-13d8-473e-adeb-8f7d2c62846a',
+        email: 'jstayton@monkdevelopment.com'
+      }
+    }
+  end
+
+  def invalid_payload
+    'eyJ1c2VyIjp7ImVtYWlsIjoianN0YXl0b25AbW9ua2RldmVsb3BtZW50LmNvbSIsImlkIjoi' \
+    'NjJjOTg4YmEtMTNkOC00NzNlLWFkZWItOGY3ZDJjNjI4NDZhIiwic2lnbmF0dXJlIjoiUlRG' \
+    'cXhIK3dPbzh4V0JGQko0cTNTRnVSc3VOTWxUTE5iak1wTjBFclYxNzh0U3pwS2VlU2J2T29S' \
+    'QzNUXG4zVTkxVCtLK3FQc3JoMjVycEN5QVMrYlFEdz09XG4ifX0='
+  end
+
+  def reset_payload
+    Monk::Id.instance_variable_set(:@payload, nil)
+  end
+
+  def config_env
+    'test'
+  end
+
+  def load_config
+    Monk::Id.load_config(config_file_path, config_env)
+  end
+
+  def expected_config(environment)
+    {
+      'app_id'     => "#{environment}_app_id",
+      'app_secret' => "#{environment}_app_secret"
+    }
+  end
+
+  def expected_config_test
+    {
+      'app_id'     => 'ca13c9d1-6600-490e-a448-adb99e2eb906',
+      'app_secret' => '98d7ac3f9e22e52f9f23b83ca791db055acad39a27e17dc7'
+    }
+  end
+
+  def set_config_env
+    ENV['MONK_ID_CONFIG'] = config_file_alt_path
+    ENV['MONK_ID_ENV'] = 'env'
+  end
+
+  def reset_config
+    Monk::Id.instance_variable_set(:@config, nil)
+
+    ENV['MONK_ID_CONFIG'] = nil
+    ENV['MONK_ID_ENV'] = nil
+  end
+
+  def mock_rails
+    Object.const_set(:Rails, Class.new)
+
+    allow(Rails).to receive(:root).and_return(spec_path)
+    allow(Rails).to receive(:env).and_return('rails')
+  end
+
+  def remove_rails
+    Object.send(:remove_const, :Rails)
+  end
+
+  def mock_sinatra
+    Object.const_set(:Sinatra, Module.new)
+    Sinatra.const_set(:Application, Module.new)
+
+    allow(Sinatra::Application)
+      .to receive_message_chain(:settings, :root).and_return(spec_path)
+    allow(Sinatra::Application)
+      .to receive_message_chain(:settings, :environment).and_return(:sinatra)
+  end
+
+  def remove_sinatra
+    Sinatra.send(:remove_const, :Application)
+    Object.send(:remove_const, :Sinatra)
+  end
+end

data/spec/lib/monk/id/version_spec.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Monk::Id do
+  describe '::VERSION' do
+    it { expect(described_class::VERSION).to be_a(String) }
+  end
+end

data/spec/lib/monk/id_spec.rb

@@ -0,0 +1,229 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Monk::Id do
+  before(:all) { load_config }
+
+  describe '::CONFIG_FILE' do
+    it { expect(described_class::CONFIG_FILE).to eq('config/monk_id.yml') }
+  end
+
+  describe '::COOKIE_NAME' do
+    it { expect(described_class::COOKIE_NAME).to eq('_monkIdPayload') }
+  end
+
+  describe '.config' do
+    context 'when a config value is set' do
+      it 'returns the config value' do
+        expect(described_class.config('app_id'))
+          .to eq('ca13c9d1-6600-490e-a448-adb99e2eb906')
+      end
+    end
+
+    context 'when a config value is not set' do
+      it { expect(described_class.config('not_set')).to be_nil }
+    end
+
+    context 'when a config is not loaded' do
+      before(:each) { reset_config }
+      after(:all) { load_config }
+
+      it 'loads a config from the environment' do
+        set_config_env
+
+        expect(described_class.config('app_id')).to eq('env_app_id')
+      end
+    end
+  end
+
+  describe '.load_config' do
+    before(:each) { reset_config }
+    after(:all) { load_config }
+
+    describe '(path)' do
+      context 'when the path is specified' do
+        it 'loads the config file from the path' do
+          expect(described_class.load_config(config_file_path, config_env))
+            .to eq(expected_config_test)
+        end
+      end
+
+      context 'when the path is not specified' do
+        it 'loads the config file from ENV["MONK_ID_CONFIG"]' do
+          set_config_env
+
+          expect(described_class.load_config(nil, 'env'))
+            .to eq(expected_config('env'))
+        end
+      end
+
+      context 'when the path does not exist' do
+        it do
+          path = '/does/not/exist.yml'
+
+          expect { described_class.load_config(path, config_env) }
+            .to raise_error(StandardError)
+        end
+      end
+    end
+
+    describe '(environment)' do
+      context 'when the environment is specified' do
+        it 'loads the environment' do
+          expect(described_class.load_config(config_file_path, config_env))
+            .to eq(expected_config_test)
+        end
+      end
+
+      context 'when the environment is not specified' do
+        it 'uses the environment from ENV["MONK_ID_ENV"]' do
+          set_config_env
+
+          expect(described_class.load_config(config_file_alt_path, nil))
+            .to eq(expected_config('env'))
+        end
+
+        it 'defaults to "development"' do
+          expect(described_class.load_config(config_file_path, nil))
+            .to eq(expected_config('development'))
+        end
+      end
+
+      context 'when the environment does not exist' do
+        it do
+          expect { described_class.load_config(config_file_path, 'invalid') }
+            .to raise_error(StandardError)
+        end
+      end
+    end
+
+    context 'when the environment is Rails' do
+      before(:each) { mock_rails }
+      after(:each) { remove_rails }
+
+      context 'when the path is not specified' do
+        it 'loads ::CONFIG_FILE relative to Rails' do
+          expect(described_class.load_config(nil, 'rails'))
+            .to eq(expected_config('rails'))
+        end
+      end
+
+      context 'when the environment is not specified' do
+        it 'uses the Rails environment' do
+          expect(described_class.load_config(config_file_path, nil))
+            .to eq(expected_config('rails'))
+        end
+      end
+    end
+
+    context 'when the environment is Sinatra' do
+      before(:each) { mock_sinatra }
+      after(:each) { remove_sinatra }
+
+      context 'when the path is not specified' do
+        it 'loads ::CONFIG_FILE relative to Sinatra' do
+          expect(described_class.load_config(nil, 'sinatra'))
+            .to eq(expected_config('sinatra'))
+        end
+      end
+
+      context 'when the environment is not specified' do
+        it 'uses the Sinatra environment' do
+          expect(described_class.load_config(config_file_path, nil))
+            .to eq(expected_config('sinatra'))
+        end
+      end
+    end
+
+    context 'when the config is not valid' do
+      it do
+        path = "#{config_path}/monk_id_invalid.yml"
+
+        expect { described_class.load_config(path, config_env) }
+          .to raise_error(StandardError)
+      end
+    end
+
+    context 'when a required config value is not set' do
+      it 'fails with a StandardError' do
+        error_message = 'no `app_secret` config value'
+
+        expect { described_class.load_config(config_file_alt_path, 'required') }
+          .to raise_error(StandardError, error_message)
+      end
+    end
+  end
+
+  describe '.load_payload' do
+    before(:each) { reset_payload }
+    after(:all) { reset_payload }
+
+    context 'when the payload is valid' do
+      context 'when the payload is a string' do
+        it 'loads the payload' do
+          expect(described_class.load_payload(valid_payload))
+            .to eq(expected_payload)
+        end
+      end
+
+      context 'when the payload responds to #[]' do
+        it 'loads the payload from ::COOKIE_NAME' do
+          cookies = { Monk::Id::COOKIE_NAME => valid_payload }
+
+          expect(described_class.load_payload(cookies)).to eq(expected_payload)
+        end
+      end
+    end
+
+    context 'when the payload is not valid' do
+      context 'when the payload cannot be decoded' do
+        it { expect(described_class.load_payload('invalid')).to be_empty }
+      end
+
+      context 'when the payload cannot be validated (wrong signature)' do
+        it { expect(described_class.load_payload(invalid_payload)).to be_empty }
+      end
+
+      context 'when the payload is nil' do
+        it { expect(described_class.load_payload(nil)).to be_empty }
+      end
+    end
+  end
+
+  context 'when signed in' do
+    before(:all) { described_class.load_payload(valid_payload) }
+    after(:all) { reset_payload }
+
+    describe '.signed_in?' do
+      it { expect(described_class.signed_in?).to be }
+    end
+
+    describe '.user_email' do
+      it 'returns the email of the user' do
+        expect(described_class.user_email).to eq('jstayton@monkdevelopment.com')
+      end
+    end
+
+    describe '.user_id' do
+      it 'returns the UUID of the user' do
+        expect(described_class.user_id)
+          .to eq('62c988ba-13d8-473e-adeb-8f7d2c62846a')
+      end
+    end
+  end
+
+  context 'when signed out' do
+    describe '.signed_in?' do
+      it { expect(described_class.signed_in?).not_to be }
+    end
+
+    describe '.user_email' do
+      it { expect(described_class.user_email).to be_nil }
+    end
+
+    describe '.user_id' do
+      it { expect(described_class.user_id).to be_nil }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require 'helpers'
+require 'simplecov'
+require 'coveralls'
+
+Coveralls.wear!
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+require 'monk/id'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+  config.include Helpers
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monk-id
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Monk Development, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-25 00:00:00.000000000 Z
+date: 2014-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: gem-release
   requirement: !ruby/object:Gem::Requirement
@@ -39,33 +53,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '4.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +122,76 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.25'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: Integrate Monk ID authentication and single sign-on for apps and websites
   on the server-side.
 email:
@@ -88,15 +200,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .editorconfig
+- .gitattributes
 - .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
 - .yardopts
 - Gemfile
+- Guardfile
+- LICENSE
 - README.md
 - Rakefile
+- circle.yml
 - config/monk_id.sample.yml
 - lib/monk/id.rb
 - lib/monk/id/version.rb
 - monk-id.gemspec
+- spec/config/monk_id.yml
+- spec/config/monk_id_alt.yml
+- spec/config/monk_id_invalid.yml
+- spec/helpers.rb
+- spec/lib/monk/id/version_spec.rb
+- spec/lib/monk/id_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/MonkDev/monk-id-ruby
 licenses:
 - MIT
@@ -109,7 +236,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
@@ -122,5 +249,12 @@ signing_key:
 specification_version: 4
 summary: Integrate Monk ID authentication and single sign-on for apps and websites
   on the server-side.
-test_files: []
+test_files:
+- spec/config/monk_id.yml
+- spec/config/monk_id_alt.yml
+- spec/config/monk_id_invalid.yml
+- spec/helpers.rb
+- spec/lib/monk/id/version_spec.rb
+- spec/lib/monk/id_spec.rb
+- spec/spec_helper.rb
 has_rdoc: