clerk-rails 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a7fdb8c57b025d5d0f123c73a89229562f25707d4db95131607f8d2a829001a
+  data.tar.gz: 3d9d1f1bfc333e8097c94e730ba6abd7ed94b3fc697ce9f616c0bc40a017d7cf
+SHA512:
+  metadata.gz: df4a42eccb6c30f65d354b94141e38c3235879526b4f81ed097d5919487a34d349d1824cbaa8f552af73a9d76fab52ab0a9781f0902ab6a289cbb88a1fb46d26
+  data.tar.gz: c5c25f85ea49646387a75c23b2b02eb26dad51d205847b2753a89415a5ec963cdebf69ed577b885b067d34ebda5b4dcad9f475dcda0f456be2f3c88ced6db624

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Colin Sidoti
+
+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,28 @@
+# Clerk
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clerk'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install clerk
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Clerk'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/clerk_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/clerk .js
+//= link_directory ../stylesheets/clerk .css

data/app/assets/javascripts/clerk/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 any plugin's vendor/assets/javascripts directory 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
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/app/assets/stylesheets/clerk/application.css

@@ -0,0 +1,15 @@
+/*
+ * 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 any plugin's vendor/assets/stylesheets directory 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/clerk/application_controller.rb

@@ -0,0 +1,15 @@
+module Clerk
+  class ApplicationController < ActionController::Base
+    def remote_cookie_accessor
+      # TODO: Only drop cookie if signature verifies
+      # TODO: Hide route entirely if client doesn't use remote cookies
+      cookie_domain = (request.host.include?(".") ? ".#{request.host}" : nil)
+      if params[:value].blank?
+        cookies.delete :clerk_session, domain: cookie_domain
+      else
+        cookies[:clerk_session] = {value: params[:value], domain: cookie_domain, expires: 20.years}
+      end
+      redirect_to params[:redirect]
+    end
+  end
+end

data/app/helpers/clerk/application_helper.rb

@@ -0,0 +1,47 @@
+module Clerk
+  module ApplicationHelper
+    def current_account
+      return @clerk_current_account if defined?(@clerk_current_account)
+      @clerk_current_account ||= begin
+        if Clerk.config.session_mode==:database_session
+          raise "TODO"
+        elsif Clerk.config.session_mode==:cookie_session
+          Clerk::Account.find_by(id: current_account_id)
+        end
+      rescue => e
+        nil
+      end
+    end
+
+    def current_account_id
+      return @clerk_current_account_id if defined?(@clerk_current_account_id)
+      @clerk_current_account_id ||= begin
+        if Clerk.config.session_mode==:database_session
+          current_account.id
+        elsif Clerk.config.session_mode==:cookie_session
+          session_cookie = JSON.parse(cookies[:clerk_session])
+          nil if session_cookie.nil?
+          JSON.parse(session_cookie["d"])["k"]
+        end
+      rescue => e
+        nil
+      end
+    end
+
+    def clerk_sign_out_path
+      "#{Clerk.config.accounts_url}/sign_out"
+    end
+
+    def clerk_sign_in_path
+      "#{Clerk.config.accounts_url}"
+    end
+
+    def clerk_sign_up_path
+      "#{Clerk.config.accounts_url}/sign_up"
+    end
+
+    def clerk_add_card_path(account_id:, redirect_path:)
+      "#{Clerk.config.accounts_url}/add_card?account_id=#{account_id}&redirect_path=#{redirect_path}"
+    end
+  end
+end

data/app/jobs/clerk/application_job.rb

@@ -0,0 +1,4 @@
+module Clerk
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/clerk/application_mailer.rb

@@ -0,0 +1,6 @@
+module Clerk
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/clerk/account.rb

@@ -0,0 +1,107 @@
+module Clerk
+  class Account < Clerk::ApplicationRecord
+    self.table_name = self.clerk_table_name("accounts")
+    self.primary_key = 'id'
+
+    has_many :roles, class_name: "Clerk::Role"
+
+    def add_clerk_role(role_type_symbol, instance = nil)
+      json = { }
+      json[:name] = role_type_symbol.to_s
+      json[:account_id] = self.id
+
+      if not instance.nil?
+        json[:scope_class] = instance.class.name
+        json[:scope_id] = instance.id
+      end
+
+      server_url = "#{ENV['CLERK_ACCOUNTS_URL']}/roles"
+      HTTP.auth("Bearer #{ENV['CLERK_SECRET_KEY']}").post(server_url, :json => json)
+    end
+
+    def has_role?(role, scope)
+      roles.where(name: role, scope_class: scope.class.name, scope_id: scope.id).exists?
+    end
+
+    def roles_for(scope)
+      roles.where(scope_class: scope.class.name, scope_id: scope.id).pluck(:name).map(&:to_sym)
+    end
+
+    def has_permission?(permission, scope)
+      has_role?(scope.class.roles_with_permission(permission), scope)
+    end
+
+    def permissions_for(scope)
+      permissions = Set.new
+
+      roles = roles_for(scope)
+      roles.each do |role|
+        role_permissions = scope.class.clerk_permissions_map[role]
+
+        unless role_permissions.nil?
+          permissions.merge(role_permissions)
+        end
+      end
+
+      return permissions.to_a
+    end
+
+    private
+
+      def method_missing(method_name, *args, &block)
+        # Rails lazy loads modules.  If an object hasn't been loaded yet, any inverse association
+        # will not be here yet.  Just in case, load the constant here and re-call the method to
+        # before raising an error
+        @miss_test ||= {}
+        if @miss_test.has_key? method_name.to_sym
+          super
+        else
+          @miss_test[method_name.to_sym] = true
+          scope_class = method_name.to_s.classify.constantize
+          send(method_name, *args, &block)  
+        end
+      rescue => e
+        super
+      end
+
+      class RolesWrapper
+        def initialize(instance, target)
+          @instance = instance
+          @target_class = target.to_s.classify.constantize
+        end
+
+        def with(role: nil, permission: nil)
+          if (role.nil? and permission.nil?) or (not role.nil? and not permission.nil?)
+            raise ArgumentError.new("Invalid argument, must supply either a role or permission")
+          end
+
+          if not role.nil?
+            return @target_class.where( 
+              id: @instance.roles.where(scope_class: @target_class.name, name: role).pluck(:scope_id) 
+            )
+          end
+
+          if not permission.nil?
+            roles = @target_class.roles_with_permission(permission)
+            return @target_class.where(
+              id: @instance.roles.where(scope_class: @target_class.name, name: roles).pluck(:scope_id)
+            )            
+          end
+        end
+
+        def no_with
+          @target_class.where( 
+            id: @instance.roles.where(scope_class: @target_class.name).pluck(:scope_id) 
+          )
+        end
+
+        def method_missing(m, *args, &block)
+          no_with.send(m, *args, &block)
+        end
+
+        def inspect
+          no_with.inspect
+        end
+      end
+  end
+end

data/app/models/clerk/application_record.rb

@@ -0,0 +1,15 @@
+module Clerk
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+    establish_connection Clerk.database_connection_url
+    def self.clerk_table_name(table_name)
+      version = Clerk::VERSION.split(".").map{|x| x.rjust(2, '0')}.join
+      "client.#{table_name}_#{version}_#{Clerk.config.secret_key}"
+    end
+
+    def self.clerk_table_name_nc(table_name)
+      version = Clerk::VERSION.split(".").map{|x| x.rjust(2, '0')}.join
+      "#{table_name}_#{version}_#{Clerk.config.secret_key}"
+    end    
+  end
+end

data/app/models/clerk/client.rb

@@ -0,0 +1,6 @@
+module Clerk
+  class Client < Clerk::ApplicationRecord
+    self.table_name = self.clerk_table_name("clients")
+    self.primary_key = 'id'
+  end
+end

data/app/models/clerk/plan.rb

@@ -0,0 +1,6 @@
+module Clerk
+  class Plan < Clerk::ApplicationRecord
+    self.table_name = self.clerk_table_name("plans")
+    self.primary_key = 'id'
+  end
+end

data/app/models/clerk/role.rb

@@ -0,0 +1,83 @@
+module Clerk
+  class Role < Clerk::ApplicationRecord
+    self.table_name = self.clerk_table_name("roles")
+    self.primary_key = 'id'
+  
+    belongs_to :account, class_name: "Clerk::Account"
+
+    def self._insert_record(values)
+      server_url = "#{ENV['CLERK_ACCOUNTS_URL']}/roles"
+      begin 
+        response = HTTP.auth("Bearer #{ENV['CLERK_SECRET_KEY']}").post(server_url, :json => values)
+        id = JSON.parse(response.body)["id"]
+      rescue
+        raise Clerk::Errors::ClerkServerError.new("Failed to save the role", self)
+      end        
+
+      if response.status.code != 200 or id.nil?
+        raise Clerk::Errors::ClerkServerError.new("Failed to save the role", self)
+      end
+      
+      return id
+    end
+
+    def self._update_record(values, constraints)
+      update_id = constraints["id"]
+      if update_id.nil?
+        raise ActiveRecord::RecordNotFound.new("Must pass an id to update a role", self)
+      end
+
+      server_url = "#{ENV['CLERK_ACCOUNTS_URL']}/roles/#{update_id}"
+      begin
+        response = HTTP.auth("Bearer #{ENV['CLERK_SECRET_KEY']}").patch(server_url, :json => values.merge!(constraints))
+      rescue
+        raise Clerk::Errors::ClerkServerError.new("Failed to update the role", self)
+      end
+
+      if response.status.code != 200
+        raise Clerk::Errors::ClerkServerError.new("Failed to update the role", self)
+      end
+
+      # overriden function returns the number of rows affected
+      return 1
+    end
+
+    def self._delete_record(constraints)
+      delete_id = constraints["id"]
+      if delete_id.nil?
+        raise ActiveRecord::RecordNotFound.new("Must pass an id to delete a role", self)
+      end
+
+      server_url = "#{ENV['CLERK_ACCOUNTS_URL']}/roles/#{delete_id}"
+
+      begin
+        response = HTTP.auth("Bearer #{ENV['CLERK_SECRET_KEY']}").delete(server_url)
+      rescue
+        raise Clerk::Errors::ClerkServerError.new("Failed to delete the role", self)
+      end
+
+
+      if response.status.code != 200
+        raise Clerk::Errors::ClerkServerError.new("Failed to delete the role", self)
+      end
+
+      # overriden function returns the number of rows affected
+      return 1      
+    end
+
+
+    # disable bulk calls
+    def self.update_all(updates)
+      raise Clerk::Errors::MethodDisabled.new("update_all is disabled for Clerk::Role")
+    end
+
+    def self.delete_all
+      raise Clerk::Errors::MethodDisabled.new("delete_all is disabled for Clerk::Role") 
+    end    
+
+    def self.destroy_all
+      raise Clerk::Errors::MethodDisabled.new("destroy_all is disabled for Clerk::Role")
+    end
+  end
+end
+

data/app/models/concerns/clerk/clerked.rb

@@ -0,0 +1,66 @@
+module Clerk
+  module Clerked
+    extend ActiveSupport::Concern
+
+    included do
+      @@clerk_permissions_map = {}
+      @@clerk_roles_map = {}
+
+      has_many :clerk_roles, clerk_roles_scope, class_name: "Clerk::Role", foreign_key: :scope_id
+
+      has_many :accounts, through: :clerk_roles, source: :account do
+
+        def with(role: nil, permission: nil)
+          if (role.nil? and permission.nil?) or (not role.nil? and not permission.nil?)
+            raise ArgumentError.new("Invalid argument, must supply either a role or permission")
+          end
+
+          if not role.nil?
+            return where(Clerk::Role.table_name=>{name: role})
+          elsif not permission.nil?
+            all_roles = self.proxy_association.owner.class.roles_with_permission(permission)
+            return where(Clerk::Role.table_name=>{name: all_roles})
+          end
+        end
+
+      end
+    end
+
+    def has_role?(role, account)
+      account.has_role?(role, self)
+    end
+
+    def roles_for(account)
+      account.roles_for(self)
+    end
+
+    class_methods do
+      def clerk_permissions_map
+        @@clerk_permissions_map
+      end
+      
+      def clerk_roles_map
+        @@clerk_roles_map
+      end
+
+      def roles_with_permission(permission)
+        @@clerk_roles_map[permission] ||= begin 
+          roles_with_permission = []
+
+          clerk_permissions_map.keys.each do |key|
+            if clerk_permissions_map[key].include?(permission)
+              roles_with_permission << key
+            end
+          end
+
+          roles_with_permission
+        end 
+      end
+
+      def clerk_roles_scope
+        class_name = self.name
+        ->{ where(scope_class: class_name) }
+      end
+    end
+  end
+end

data/app/models/concerns/clerk/errors.rb

@@ -0,0 +1,18 @@
+module Clerk
+  module Errors
+    class ClerkError < StandardError; end
+
+    class ClerkServerError < ClerkError      
+      def initialize(message = nil, model = nil)
+        @model = model
+        super(message)
+      end      
+    end
+
+    class MethodDisabled < ClerkError
+      def initialize(message = nil)
+        super(message)
+      end
+    end
+  end
+end

data/app/views/layouts/clerk/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Clerk</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "clerk/application", media: "all" %>
+  <%= javascript_include_tag "clerk/application" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Clerk::Engine.routes.draw do
+  get 'remote_cookie_accessor', to: 'clerk/application#remote_cookie_accessor'
+end

data/lib/clerk-rails.rb

@@ -0,0 +1,30 @@
+require "clerk/engine"
+
+module Clerk
+  class << self
+    attr_reader :config
+
+    def configure
+      @config = Configuration.new
+      yield config
+      if Rails.env.development?
+        config.environment = :development
+        config.session_mode = :cookie_session
+        config.cookie_host = nil
+      else
+        client = Clerk::Client.first
+        config.environment = client.environment.to_sym
+        config.session_mode = client.session_mode.to_sym
+        config.cookie_host = client.cookie_host
+      end
+    end
+
+    def database_connection_url
+      @database_connection_url ||= "#{Clerk.config.database_url.dup.insert(11,"#{Clerk.config.secret_key}@")}/clerk?prepared_statements=false"
+    end
+  end
+
+  class Configuration
+    attr_accessor :accounts_url, :database_url, :secret_key, :public_key, :environment, :session_mode, :last_account, :cookie_host
+  end
+end

data/lib/clerk/engine.rb

@@ -0,0 +1,60 @@
+module Clerk
+  class Engine < ::Rails::Engine
+    initializer "clerk.load_helpers" do |app|
+      ::ActionController::Base.send :include, Clerk::ApplicationHelper
+      ::ActiveRecord::Base.class_eval do
+
+        def self.clerk(association_name, permissions: [])
+          plural_role = association_name.to_s.pluralize.to_sym
+          singular_role = association_name.to_s.singularize.to_sym
+
+          roles_association = :"clerk_roles_#{association_name}"
+
+          remote_class = self.name
+
+          unless self.respond_to? :clerk_roles
+            self.class_eval do 
+              include Clerk::Clerked
+            end
+          end
+
+          has_many roles_association, 
+            ->{ where(scope_class: remote_class, name: singular_role) }, 
+            class_name: "Clerk::Role", 
+            foreign_key: :scope_id
+
+          plural_role = association_name.to_s.pluralize.to_sym
+          singular_role = association_name.to_s.singularize.to_sym
+
+          account_accessor = self.name.underscore.pluralize.to_sym
+
+          # Add clerk permissions to `self` the associated class
+          self.clerk_permissions_map[singular_role] = permissions
+
+          # Add magic methods to Clerk::Acount
+          Clerk::Account.class_eval do
+            define_method account_accessor do
+              self.class::RolesWrapper.new(self, account_accessor)
+            end
+
+            define_method :"is_#{singular_role}?" do |*args|
+              has_role?(singular_role, *args)
+            end
+
+            permissions.each do |permission|
+              define_method :"can_#{permission}?" do |*args|
+                has_permission?(permission, *args)
+              end
+            end                        
+          end
+          
+          [
+            association_name.to_sym,
+            through: roles_association, 
+            source: :account
+          ]
+        end        
+      end
+    end
+  end
+end

data/lib/clerk/version.rb

@@ -0,0 +1,3 @@
+module Clerk
+  VERSION = '0.1.2'
+end

data/lib/tasks/clerk_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :clerk do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: clerk-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Clerk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
+description: Clerk is the easiest way to manage accounts.
+email:
+- bsidoti@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/clerk_manifest.js
+- app/assets/javascripts/clerk/application.js
+- app/assets/stylesheets/clerk/application.css
+- app/controllers/clerk/application_controller.rb
+- app/helpers/clerk/application_helper.rb
+- app/jobs/clerk/application_job.rb
+- app/mailers/clerk/application_mailer.rb
+- app/models/clerk/account.rb
+- app/models/clerk/application_record.rb
+- app/models/clerk/client.rb
+- app/models/clerk/plan.rb
+- app/models/clerk/role.rb
+- app/models/concerns/clerk/clerked.rb
+- app/models/concerns/clerk/errors.rb
+- app/views/layouts/clerk/application.html.erb
+- config/routes.rb
+- lib/clerk-rails.rb
+- lib/clerk/engine.rb
+- lib/clerk/version.rb
+- lib/tasks/clerk_tasks.rake
+homepage: 
+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.7.8
+signing_key: 
+specification_version: 4
+summary: Rails Engine for Clerk
+test_files: []