]> git.openstreetmap.org Git - rails.git/blobdiff - app/models/client_application.rb
Add support for OAuth2 using doorkeeper
[rails.git] / app / models / client_application.rb
index 84f5b978c180fd31ce246f7e5957df1ddf467724..1b2faafbb1d79c96b63da5303bf20f0ba8ae785b 100644 (file)
@@ -1,49 +1,79 @@
-require "oauth"
-
-class ClientApplication < ActiveRecord::Base
+# == Schema Information
+#
+# Table name: client_applications
+#
+#  id                :integer          not null, primary key
+#  name              :string
+#  url               :string
+#  support_url       :string
+#  callback_url      :string
+#  key               :string(50)
+#  secret            :string(50)
+#  user_id           :integer
+#  created_at        :datetime
+#  updated_at        :datetime
+#  allow_read_prefs  :boolean          default(FALSE), not null
+#  allow_write_prefs :boolean          default(FALSE), not null
+#  allow_write_diary :boolean          default(FALSE), not null
+#  allow_write_api   :boolean          default(FALSE), not null
+#  allow_read_gpx    :boolean          default(FALSE), not null
+#  allow_write_gpx   :boolean          default(FALSE), not null
+#  allow_write_notes :boolean          default(FALSE), not null
+#
+# Indexes
+#
+#  index_client_applications_on_key      (key) UNIQUE
+#  index_client_applications_on_user_id  (user_id)
+#
+# Foreign Keys
+#
+#  client_applications_user_id_fkey  (user_id => users.id)
+#
+
+class ClientApplication < ApplicationRecord
   belongs_to :user
   has_many :tokens, :class_name => "OauthToken", :dependent => :delete_all
   has_many :access_tokens
   has_many :oauth2_verifiers
   has_many :oauth_tokens
 
-  validates_presence_of :name, :url, :key, :secret
-  validates_uniqueness_of :key
-  validates_format_of :url, :with => /\Ahttp(s?):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-\/]))?/i
-  validates_format_of :support_url, :with => /\Ahttp(s?):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-\/]))?/i, :allow_blank => true
-  validates_format_of :callback_url, :with => /\A[a-z][a-z0-9.+-]*:\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-\/]))?/i, :allow_blank => true
+  validates :key, :presence => true, :uniqueness => true
+  validates :name, :url, :secret, :presence => true
+  validates :url, :format => /\A#{URI::DEFAULT_PARSER.make_regexp(%w[http https])}\z/
+  validates :support_url, :allow_blank => true, :format => /\A#{URI::DEFAULT_PARSER.make_regexp(%w[http https])}\z/
+  validates :callback_url, :allow_blank => true, :format => /\A#{URI::DEFAULT_PARSER.make_regexp}\z/
 
   before_validation :generate_keys, :on => :create
 
   attr_accessor :token_callback_url
 
   def self.find_token(token_key)
-    token = OauthToken.find_by_token(token_key, :include => :client_application)
-    token if token && token.authorized?
+    token = OauthToken.includes(:client_application).find_by(:token => token_key)
+    token if token&.authorized?
   end
 
   def self.verify_request(request, options = {}, &block)
     signature = OAuth::Signature.build(request, options, &block)
     return false unless OauthNonce.remember(signature.request.nonce, signature.request.timestamp)
-    value = signature.verify
-    value
+
+    signature.verify
   rescue OAuth::Signature::UnknownSignatureMethod
     false
   end
 
   def self.all_permissions
-    PERMISSIONS
+    Oauth.scopes.collect { |s| :"allow_#{s.name}" }
   end
 
   def oauth_server
-    @oauth_server ||= OAuth::Server.new("http://" + SERVER_URL)
+    @oauth_server ||= OAuth::Server.new("https://#{Settings.server_url}")
   end
 
   def credentials
-    @oauth_client ||= OAuth::Consumer.new(key, secret)
+    @credentials ||= OAuth::Consumer.new(key, secret)
   end
 
-  def create_request_token(params = {})
+  def create_request_token(_params = {})
     params = { :client_application => self, :callback_url => token_callback_url }
     permissions.each do |p|
       params[p] = true
@@ -52,7 +82,7 @@ class ClientApplication < ActiveRecord::Base
   end
 
   def access_token_for_user(user)
-    unless token = access_tokens.valid.where(:user_id => user).first
+    unless token = access_tokens.valid.find_by(:user_id => user)
       params = { :user => user }
 
       permissions.each do |p|
@@ -72,13 +102,6 @@ class ClientApplication < ActiveRecord::Base
 
   protected
 
-  # this is the set of permissions that the client can ask for. clients
-  # have to say up-front what permissions they want and when users sign up they
-  # can agree or not agree to each of them.
-  PERMISSIONS = [:allow_read_prefs, :allow_write_prefs, :allow_write_diary,
-                 :allow_write_api, :allow_read_gpx, :allow_write_gpx,
-                 :allow_write_notes]
-
   def generate_keys
     self.key = OAuth::Helper.generate_key(40)[0, 40]
     self.secret = OAuth::Helper.generate_key(40)[0, 40]