garage-doorkeeper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e86f10c7895c4ede58f8145ca968a8be565410c
+  data.tar.gz: b097ce253e5ef97b5f514cd279254ac451bffacf
+SHA512:
+  metadata.gz: 786be0ce8b40cd602239f949c55627d43ddb2db4ee13fefe257508f32f625d2ccbffa54150c7fb7e68619f2d50dce3d173ee4b673c2a3186f409d1d6371421ab
+  data.tar.gz: 54f298f72f4d05b7b38774813cdacffd923c04a46c63c2efbeebd34d8eb426195940351b52b3ced03fac7ceb330dc64d58931492086136fdcc83d5652c110f6a

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+Gemfile.lock
+.ruby-version
+gemfiles/*.lock

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 1.0.0
+- Doorkeeper v1 compatible release.

data/Gemfile

@@ -0,0 +1,24 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in garage-doorkeeper.gemspec
+gemspec
+
+gem "garage", github: "cookpad/garage"
+
+group :development, :test do
+  gem "bundler", "~> 1.7"
+  gem "database_cleaner"
+  gem "factory_girl"
+  gem "factory_girl_rails"
+  gem "forgery"
+  gem "kaminari"
+  gem "link_header"
+  gem "mysql2"
+  gem "pry-rails"
+  gem "quiet_assets"
+  gem "rake", "~> 10.0"
+  gem "responders", "~> 2.0"
+  gem "rspec-json_matcher", "0.1.2"
+  gem "rspec-rails" , "~> 2.14.0"
+  gem "webmock"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Taiki ONO
+
+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,52 @@
+# Garage::Doorkeeper
+
+A authenticatino/authorization extension for [Garage gem](https://github.com/cookpad/garage)
+to integrate [Doorkeeper gem](https://github.com/doorkeeper-gem/doorkeeper).
+Garage is a Rails extension for RESTful Hypermedia API.
+
+## Doorkeeper compatibility
+- Use garage-doorkeeper v1.x with doorkeeper v1.x.
+- Use garage-doorkeeper v2.x with doorkeeper v2.x.
+
+garage-doorkeeper v1 keeps compatibility with doorkeeper v1.x, actually
+">= 0.6.7" and "< 1.5.0". garage-doorkeeper v2 keeps compatibility with
+doorkeeper v2.x, actually ">= 2.0.0".
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'garage-doorkeeper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install garage-doorkeeper
+
+## Usage
+
+In `config/initializer/garage.rb`:
+
+```ruby
+Garage.configuration.strategy = Garage::Strategy::Doorkeeper
+
+# Then configure doorkeeper if you didn't.
+Doorkeeper.configure do
+  #...
+end
+```
+
+Then Garage will authenticate/authorize requests using doorkeeper feature.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/garage-doorkeeper/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/garage-doorkeeper.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'garage/doorkeeper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "garage-doorkeeper"
+  spec.version       = Garage::Doorkeeper::VERSION
+  spec.authors       = ["Taiki Ono"]
+  spec.email         = ["taiks.4559@gmail.com"]
+  spec.summary       = %q{Garage extension to integrate doorkeeper gem.}
+  spec.description   = spec.summary
+  spec.homepage      = ""
+  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 "doorkeeper", ">= 0.6.7", "< 1.5.0"
+end

data/lib/garage/doorkeeper/version.rb

@@ -0,0 +1,5 @@
+module Garage
+  module Doorkeeper
+    VERSION = "1.0.0"
+  end
+end

data/lib/garage/doorkeeper.rb

@@ -0,0 +1,4 @@
+require "doorkeeper"
+
+require "garage/doorkeeper/version"
+require "garage/strategy/doorkeeper"

data/lib/garage/strategy/doorkeeper.rb

@@ -0,0 +1,28 @@
+module Garage
+  module Strategy
+    # doorkeeper_token has same interface with Garage::Strategy::AccessToken
+    module Doorkeeper
+      extend ActiveSupport::Concern
+
+      # Garage::ControllerHelper already implements `doorkeeper_token`,
+      # so monkey patch here.
+      ::Doorkeeper::Helpers::Filter.class_eval do
+        alias_method :original_doorkeeper_token, :doorkeeper_token
+      end
+
+      included do
+        include ::Doorkeeper::Helpers::Filter
+        alias_method :doorkeeper_unauthorized_render_options, :unauthorized_render_options
+        doorkeeper_for :all
+      end
+
+      def verify_permission?
+        true
+      end
+
+      def access_token
+        original_doorkeeper_token
+      end
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/api_controller.rb

@@ -0,0 +1,11 @@
+class ApiController < ApplicationController
+  include Garage::ControllerHelper
+
+  def current_resource_owner
+    @current_resource_owner ||= User.find(resource_owner_id) if resource_owner_id
+  end
+
+  def resource_owner_exists?(resource_owner_id)
+    User.exists?(resource_owner_id)
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  include CurrentUserHelper
+  helper_method :current_user
+
+  rescue_from ActiveRecord::RecordNotFound do
+    head 404
+  end
+end

data/spec/dummy/app/controllers/echos_controller.rb

@@ -0,0 +1,5 @@
+class EchosController < ApiController
+  def show
+    respond_with Garage::HashRepresenter.new(:message => "Hello World")
+  end
+end

data/spec/dummy/app/controllers/posts_controller.rb

@@ -0,0 +1,101 @@
+class PostsController < ApiController
+  include Garage::RestfulActions
+
+  before_filter :require_user, only: :private
+  before_filter :require_private_resource, only: :private
+  before_filter :require_namespaced_resource, only: :namespaced
+  before_filter :require_index_resource, only: [:hide, :capped]
+  before_filter :require_action_permission, only: [:private, :hide, :capped, :namespaced]
+
+  def private
+    respond_with @resources
+  end
+
+  def hide
+    respond_with @resources, paginate: true, hide_total: true
+  end
+
+  def capped
+    respond_with @resources, paginate: true, hard_limit: 100
+  end
+
+  def namespaced
+    respond_with @resources
+  end
+
+  private
+
+  def require_user
+    @user = user
+  end
+
+  def require_resource
+    @resource = Post.find(params[:id])
+  end
+
+  def require_resources
+    if has_user?
+      @resources = user.posts
+      protect_resource_as user: user
+    else
+      if params[:stream]
+        require_access! Garage::MetaResource.new(PostStream), :read
+      end
+      @resources = Post.all
+    end
+  end
+
+  def create_resource
+    @resource = @resources.new
+    @resource.user = current_resource_owner
+    @resource.update_attributes!(post_params)
+    @resource
+  end
+
+  def update_resource
+    @resource.update_attributes!(post_params)
+    @resource
+  end
+
+  def destroy_resource
+    @resource.destroy
+    @resource
+  end
+
+  def require_private_resource
+    @resources = @user.posts
+    protect_resource_as PrivatePost, user: @user
+  end
+
+  def require_namespaced_resource
+    @resources = Post.all
+    protect_resource_as NamespacedPost
+  end
+
+  def require_index_resource
+    @resources = Post.all
+  end
+
+  def respond_with_resource_options
+    {
+      delete: { body: true },
+      put: { body: true },
+    }
+  end
+
+  def respond_with_resources_options
+    { paginate: true }
+  end
+
+  def has_user?
+    params[:user_id]
+  end
+
+  def user
+    User.find(params[:user_id])
+  end
+
+  def post_params
+    params.permit(:title, :body)
+  end
+end

data/spec/dummy/app/controllers/sessions_controller.rb

@@ -0,0 +1,19 @@
+class SessionsController < ApplicationController
+  def new
+    @user = User.new
+  end
+
+  def show
+    
+  end
+
+  def create
+    @user = User.find_by_name(params[:user][:name])
+    # No Authentication!
+    session[:user_id] = @user.id
+  end
+
+  def destroy
+    session.delete(:user_id)
+  end
+end

data/spec/dummy/app/controllers/users_controller.rb

@@ -0,0 +1,6 @@
+class UsersController < ApiController
+  def show
+    @user = User.find(params[:id])
+    respond_with @user
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/helpers/current_user_helper.rb

@@ -0,0 +1,5 @@
+module CurrentUserHelper
+  def current_user
+    User.find_by_id(session[:user_id])
+  end
+end