gris_accounts 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3dcdb91930a83ca1949bfb729fa1e1553f1bcced
+  data.tar.gz: 528643073ce1d2ba690775e7b65a0ba9d14b3c8e
+SHA512:
+  metadata.gz: 0ac42c4d4c033977b86559adadbac5d677bf05891bb4ba4193925609c4e3d03b02b1bace178cbe4c34adff3259b9d3cda61cf40d5511294594c9e4d3d6dfd148
+  data.tar.gz: 534b1064056979c19209575c24b7664e764aa966d34ac26c102b379183e730d68ad9a1b7efbd814d82fef39d07491634bc45c61c6240b05c6d8fde4a23e239c8

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+.ruby-gemset
+.rspec

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,10 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-08-07 21:57:08 -0400 using RuboCop version 0.32.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Dylan Fareed
+
+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 @@
+# GrisAccounts
+
+[GrisAccounts](https://github.com/dylanfareed/gris_accounts) provides helpers for handling account resource authorization with decoded [Gris](https://github.com/artsy/gris) JSON Web Tokens. It is likely best used with [Gris::Middleware::JsonWebTokenDecoder](https://github.com/dylanfareed/gris-middleware-json_web_token_decoder).
+
+GrisAccounts is alpha software.
+
+---
+
+### Installation
+
+GrisAccounts is [available as a gem on rubygems](https://rubygems.org/gems/gris_accounts), to install it run:
+
+```
+gem install gris_accounts
+```
+
+Otherwise, if your project uses [Bundler](http://bundler.io/), add GrisAccounts to your Gemfile:
+
+```
+gem 'gris_accounts'
+```
+
+And run:
+
+```
+$ bundle install
+```
+
+---
+
+### Usage
+
+The example below includes `GrisAccounts::AuthorizationHelper` in a [Grape](https://github.com/ruby-grape/grape) endpoint and makes use of `user_id_from_payload` and `require_access_to_account` helpers to provide some resource authorization.
+
+```ruby
+class AccountsEndpoint < Grape::API
+  format :json
+  formatter :json, Grape::Formatter::Roar
+  content_type :json, 'application/hal+json'
+
+  use Gris::Middleware::JsonWebTokenDecoder
+  helpers GrisAccounts::AuthorizationHelper
+
+  namespace :accounts do
+    desc 'Create new account.'
+    params do
+      requires :account, type: Hash do
+        requires :name, type: String
+      end
+    end
+    post do
+      # Get current user ID from decoded JSON Web Token.
+      # Returns @user_id
+      #
+      user_id_from_payload
+      account = AccountCreatorService.call params[:account][:name], @user_id
+      present account, with: AccountPresenter
+    end
+
+    desc 'Retrieve existing account.'
+    params do
+      requires :id
+    end
+    get ':id' do
+      # Ensure that decoded JSON Web Token includes current account.
+      # Raises error unless decoded token includes account_ids with params[:id]
+      #
+      require_access_to_account params[:id]
+      account = Account.find params[:id]
+      present account, with: AccountPresenter
+    end
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new
+
+desc 'Run RuboCop'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+  task.options = %w(-D --auto-correct)
+end
+
+task default: [:rubocop, :spec]

data/gris_accounts.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gris_accounts/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gris_accounts'
+  spec.version       = GrisAccounts::VERSION
+  spec.authors       = ['Dylan Fareed']
+  spec.email         = %w(email@dylanfareed.com)
+  spec.summary       = 'Gris JWT Account resource authorization helpers.'
+  spec.description   = 'Helpers for handling Account resource authorization
+                        with decoded Gris JSON Web Tokens.'
+  spec.homepage      = 'https://github.com/dylanfareed/gris_accounts'
+  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.require_paths = ['lib']
+
+  spec.add_dependency 'gris'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'byebug'
+end

data/lib/gris_accounts/authorization_helpers.rb

@@ -0,0 +1,20 @@
+module GrisAccounts
+  module AuthorizationHelpers
+    def require_access_to_account(account_id)
+      @account_ids = payload_content['account_ids'] if payload_content
+      fail 'Forbidden.' unless @account_ids &&
+                               (@account_ids.include? account_id.to_i)
+    end
+
+    def user_id_from_payload
+      @user_id = payload_content['id'] if payload_content
+      fail 'Forbidden.' unless @user_id
+    end
+
+    private
+
+    def payload_content
+      @env['GRIS_JWT_PAYLOAD'].first if @env['GRIS_JWT_PAYLOAD']
+    end
+  end
+end

data/lib/gris_accounts/version.rb

@@ -0,0 +1,3 @@
+module GrisAccounts
+  VERSION = '0.0.1'
+end

data/lib/gris_accounts.rb

@@ -0,0 +1,2 @@
+require 'gris_accounts/version'
+require 'gris_accounts/authorization_helpers'

data/spec/authorization_helpers_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe GrisAccounts::AuthorizationHelpers do
+  class EndpointClass
+    include GrisAccounts::AuthorizationHelpers
+  end
+
+  let(:helper) { EndpointClass.new }
+
+  context 'require_access_to_account' do
+    let(:account_id) { 1 }
+
+    context 'when payload account_ids includes account_id' do
+      let(:payload) do
+        Hashie::Mash.new(
+          'GRIS_JWT_PAYLOAD' => [{ account_ids: [account_id] }]
+        )
+      end
+
+      before do
+        helper.instance_variable_set(:@env, payload)
+      end
+
+      it 'assigns @account_ids' do
+        helper.require_access_to_account(account_id)
+        expect(helper.instance_variable_get(:@account_ids)).to eq [account_id]
+      end
+    end
+
+    context 'when payload account_ids does not include account_id' do
+      let(:payload) do
+        Hashie::Mash.new('GRIS_JWT_PAYLOAD' => [{ account_ids: [] }])
+      end
+
+      before do
+        helper.instance_variable_set(:@env, payload)
+      end
+
+      it 'raises Forbidden error' do
+        expect do
+          helper.require_access_to_account(account_id)
+        end.to raise_error(RuntimeError, 'Forbidden.')
+      end
+    end
+  end
+
+  context 'user_id_from_payload' do
+    let(:id) { 'michael-heizer' }
+
+    context 'when payload includes id' do
+      let(:payload) { Hashie::Mash.new('GRIS_JWT_PAYLOAD' => [{ id: id }]) }
+
+      before do
+        helper.instance_variable_set(:@env, payload)
+      end
+
+      it 'assigns @user_id' do
+        helper.user_id_from_payload
+        expect(helper.instance_variable_get(:@user_id)).to eq id
+      end
+    end
+
+    context 'when payload does not include id' do
+      let(:payload) { Hashie::Mash.new('GRIS_JWT_PAYLOAD' => [{}]) }
+
+      before do
+        helper.instance_variable_set(:@env, payload)
+      end
+
+      it 'raises Forbidden error' do
+        expect do
+          helper.user_id_from_payload
+        end.to raise_error(RuntimeError, 'Forbidden.')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'gris'
+require 'gris_accounts'
+require 'byebug'

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: gris_accounts
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dylan Fareed
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gris
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rubocop
+  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: byebug
+  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: |-
+  Helpers for handling Account resource authorization
+                          with decoded Gris JSON Web Tokens.
+email:
+- email@dylanfareed.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- gris_accounts.gemspec
+- lib/gris_accounts.rb
+- lib/gris_accounts/authorization_helpers.rb
+- lib/gris_accounts/version.rb
+- spec/authorization_helpers_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dylanfareed/gris_accounts
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Gris JWT Account resource authorization helpers.
+test_files:
+- spec/authorization_helpers_spec.rb
+- spec/spec_helper.rb