sn-revisions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f460ba8848953e112bd65cce86087f9cbc94599
+  data.tar.gz: 71e86814e0c89437dc81b9394bd21262583c3cad
+SHA512:
+  metadata.gz: b62494241c021ad1ef98976bce8b8b9729177055523be5905b7299a4cca67425523feb723b773070679e1bb6b4807444fbc84defd2fc6af0572c995b0a6b08f9
+  data.tar.gz: fa2840c85d43b55fdb35af2ef8530bde23558374c0d54c90fcd4f8a2d6331ae76ace870056e19581b8a1f868adeedd420b557abd20cf8b0c1fd5efe92f959dae

data/MIT-LICENSE

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

data/Rakefile

@@ -0,0 +1,37 @@
+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    = 'Revisions'
+  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", __FILE__)
+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 << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/revisions_manifest.js

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

data/app/assets/javascripts/revisions/application.js

@@ -0,0 +1,13 @@
+// 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_tree .

data/app/assets/javascripts/revisions/extension.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/revisions/home.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/revisions/items.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/revisions/revisions.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

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

@@ -0,0 +1,32 @@
+/*
+ * 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
+ */
+
+html, body {
+  font-family: sans-serif;
+  -webkit-font-smoothing: antialiased;
+  margin: 20px;
+}
+
+h1 {
+  margin-top: 2rem;
+  margin-bottom: 1rem;
+  font-weight: normal;
+  color: black;
+
+  border-bottom: 1px solid black;
+  font-size: 2em;
+  margin: 0.67em 0;
+}

data/app/assets/stylesheets/revisions/extension.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/revisions/home.css.scss

@@ -0,0 +1,19 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+.button-link {
+  border: 0;
+  background-color: black;
+  color: white;
+  padding: 10px;
+  font-weight: bold;
+  font-size: 15px;
+  min-width: 150px;
+  cursor: pointer;
+
+  &:hover {
+    text-decoration: underline;
+  }
+}

data/app/assets/stylesheets/revisions/items.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/revisions/revisions.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/revisions/application_controller.rb

@@ -0,0 +1,25 @@
+module Revisions
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :null_session
+    attr_accessor :current_user
+
+    before_action :authenticate_user
+
+    def authenticate_user
+      user = Revisions::User.find(params[:uid])
+      if user.key != params[:key]
+        render_unauthorized
+        return
+      end
+      self.current_user = user
+    end
+
+    def build_url(path)
+      "#{Revisions.mount_host}/#{params[:user_key]}/#{params[:email]}/#{Revisions.mount_name}/#{path}"
+    end
+
+    def render_unauthorized
+      render :json => {:error => {:tag => "unauthorized", :message => "You are unauthorized to access this page."}}, :status => 401
+    end
+  end
+end

data/app/controllers/revisions/extension_controller.rb

@@ -0,0 +1,46 @@
+require_dependency "revisions/application_controller"
+
+module Revisions
+  class ExtensionController < ApplicationController
+
+    def index
+      key = params[:key]
+      actions = []
+
+      item_uuid = params[:item_uuid]
+      if item_uuid
+        item = current_user.items.find_by_item_uuid(item_uuid)
+      end
+
+      if item
+        item.revisions.each_with_index do |rev, index|
+            action = {
+              :label => "#{rev.num} - #{rev.created_at.strftime('%a %b %d, %Y at %I:%M%p %Z')}" + (index == 0 ? " (current)" : ""),
+              :desc => "",
+              :verb => "nested",
+              :context => "Item",
+              :content_types => ["Note"],
+              :subactions => [
+                {
+                  :label => "Preview",
+                  :desc => "",
+                  :url => build_url("#{rev.id}?uid=#{params[:uid]}&key=#{params[:key]}"),
+                  :verb => "render",
+                },
+                {
+                  :label => "Restore",
+                  :desc => "",
+                  :url => build_url("#{rev.id}?uid=#{params[:uid]}&key=#{params[:key]}"),
+                  :verb => "get",
+                }
+              ]
+            }
+            actions.push(action)
+          end
+        end
+
+        render :json => {:name => "Note History", :supported_types => [:Note], :actions => actions}
+    end
+
+  end
+end

data/app/controllers/revisions/home_controller.rb

@@ -0,0 +1,24 @@
+require_dependency "revisions/application_controller"
+
+module Revisions
+  class HomeController < ApplicationController
+
+    skip_before_action :authenticate_user
+
+    def index
+
+    end
+
+    def register
+      user = Revisions::User.new
+      user.key = Digest::SHA256.hexdigest(SecureRandom.random_bytes(32))
+      user.save
+
+      @server_url = build_url("items?key=#{user.key}&uid=#{user.id}")
+      @client_url = build_url("ext?key=#{user.key}&uid=#{user.id}")
+
+      render "index"
+    end
+
+  end
+end

data/app/controllers/revisions/items_controller.rb

@@ -0,0 +1,20 @@
+require_dependency "revisions/application_controller"
+
+module Revisions
+  class ItemsController < ApplicationController
+
+    def save
+      items = params[:items]
+      items.each do |item_hash|
+        item = current_user.items.find_or_create_by(:item_uuid => item_hash["uuid"])
+        item.add_revision(item_hash["content"], item_hash["enc_item_key"], item_hash["auth_hash"])
+        item.condense_history
+        if item.content_type == nil
+          item.content_type = item_hash["content_type"]
+          item.save
+        end
+      end
+    end
+
+  end
+end

data/app/controllers/revisions/revisions_controller.rb

@@ -0,0 +1,17 @@
+require_dependency "revisions/application_controller"
+
+module Revisions
+  class RevisionsController < ApplicationController
+
+    def show
+      revision = Revision.find(params[:id])
+      if revision.item.user_id != current_user.id
+        render_unauthorized
+        return
+      end
+
+      render :json => {:item => revision.as_json.merge({:uuid => revision.item.item_uuid, :content_type => revision.item.content_type})}
+    end
+
+  end
+end

data/app/helpers/revisions/application_helper.rb

@@ -0,0 +1,4 @@
+module Revisions
+  module ApplicationHelper
+  end
+end

data/app/helpers/revisions/extension_helper.rb

@@ -0,0 +1,4 @@
+module Revisions
+  module ExtensionHelper
+  end
+end

data/app/helpers/revisions/home_helper.rb

@@ -0,0 +1,4 @@
+module Revisions
+  module HomeHelper
+  end
+end

data/app/helpers/revisions/items_helper.rb

@@ -0,0 +1,4 @@
+module Revisions
+  module ItemsHelper
+  end
+end

data/app/helpers/revisions/revisions_helper.rb

@@ -0,0 +1,4 @@
+module Revisions
+  module RevisionsHelper
+  end
+end

data/app/jobs/revisions/application_job.rb

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

data/app/models/revisions/application_record.rb

@@ -0,0 +1,5 @@
+module Revisions
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/revisions/item.rb

@@ -0,0 +1,37 @@
+module Revisions
+  class Item < ApplicationRecord
+
+    has_many :revisions, -> { order 'created_at desc' }
+
+    def add_revision(content, item_key, auth_hash)
+      revision = self.revisions.new
+      revision.content = content
+      revision.enc_item_key = item_key
+      revision.auth_hash = auth_hash
+      revision.save
+    end
+
+
+    def condense_history
+      # revisions past 30 days are limited to 1 revision per day
+      # any revision within 30 days is capped to 30-days_from_today revisions per day
+      # so if there are 50 revisions from 5 days ago, 50 - (30-5) = 25 revisions are allowed
+      days = 30
+      min_revs = 3
+      days.times do |days_from_today|
+        date = Time.now.utc.to_date - days_from_today
+        num_revs_allowed = days - days_from_today + min_revs
+        revs = self.revisions.where(:created_at => date.midnight..date.end_of_day).pluck(:id)
+        if revs.length > num_revs_allowed
+          num_to_remove = revs.length - num_revs_allowed
+          num_to_remove.times do |time|
+            index = revs.length/2 - 1
+            Revision.destroy(revs[index])
+            revs.delete_at(index)
+          end
+        end
+      end
+    end
+
+  end
+end

data/app/models/revisions/revision.rb

@@ -0,0 +1,5 @@
+module Revisions
+  class Revision < ApplicationRecord
+    belongs_to :item
+  end
+end

data/app/models/revisions/user.rb

@@ -0,0 +1,6 @@
+module Revisions
+  class User < ApplicationRecord
+    has_many :items
+
+  end
+end

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Revisions</title>
+  <%= stylesheet_link_tag    "revisions/application", media: "all" %>
+  <%= javascript_include_tag "revisions/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/revisions/home/index.html.haml

@@ -0,0 +1,52 @@
+%h1 Note History Extension for Standard Notes
+%p The note history extension keeps track of changes, and allows you to restore a note to a previous version.
+
+- if @server_url
+  %p
+    %strong
+      Your secret
+      %span{:style => "text-decoration:underline;"} server extension
+      URL is:
+    = @server_url
+  %p
+    %strong
+      Your secret
+      %span{:style => "text-decoration:underline;"} app extension
+      URL is:
+    = @client_url
+- else
+  = button_to "Generate URLs", {:controller => "home", :action => "register", :method => "post"}, {:class => "button-link"}
+%h3 Instructions
+
+%p
+  %strong To get started:
+%ol
+  %li Press "Generate URLs" above to generate your server and app extension URLs.
+
+%p Once you've generated your URLs, it's time to register the extensions.
+
+%p
+  %strong To register your server extension:
+%ol
+  %li In the Standard Notes app, find and click "Account" in the lower left corner.
+  %li Click "Standard File Dashboard".
+  %li After logging in, click "Extensions" in the left panel.
+  %li In the add new extension section, paste in the server secret URL, and submit.
+%p Registering the server extension allows your main Standard File server to forward encrypted data to the Note History extension server.
+
+%p
+  %strong To register your app extension:
+%ol
+  %li In the Standard Notes app, find and click "Extensions" in the lower left corner.
+  %li Click "Add new extension".
+  %li Paste in the app secret URL and submit.
+
+%p The app extension allows you to view previous versions of the note.
+
+%p
+  %strong To restore a note to a previous version:
+
+%ol
+  %li In the Standard Notes app, select the note you'd like to revisit.
+  %li Click "Extensions" under the note title.
+  %li Here you'll see all of the revisions for this note. You can preview the content of each version before choosing to restore to that version.

data/config/routes.rb

@@ -0,0 +1,11 @@
+Revisions::Engine.routes.draw do
+  post "items" => "items#save"
+
+  post "register" => "home#register"
+
+  get "ext" => "extension#index"
+
+  get ":id" => "revisions#show"
+
+  root "home#index"
+end

data/db/migrate/20170211000200_create_revisions_items.rb

@@ -0,0 +1,12 @@
+class CreateRevisionsItems < ActiveRecord::Migration[5.0]
+  def change
+    create_table :revisions_items do |t|
+      t.string :item_uuid, limit: 36, null: false
+      t.string :content_type
+      t.integer :user_id
+      t.timestamps
+    end
+
+    add_index :revisions_items, :item_uuid
+  end
+end

data/db/migrate/20170211000426_create_revisions_revisions.rb

@@ -0,0 +1,15 @@
+class CreateRevisionsRevisions < ActiveRecord::Migration[5.0]
+  def change
+    create_table :revisions_revisions do |t|
+      t.text :content, :limit => 16.megabytes - 1
+      t.string :enc_item_key
+      t.string :auth_hash
+
+      t.integer :item_id
+      t.timestamps
+    end
+
+    add_index :revisions_revisions, :item_id
+    add_index :revisions_revisions, :created_at
+  end
+end

data/db/migrate/20170211001350_create_revisions_users.rb

@@ -0,0 +1,8 @@
+class CreateRevisionsUsers < ActiveRecord::Migration[5.0]
+  def change
+    create_table :revisions_users do |t|
+      t.string :key
+      t.timestamps
+    end
+  end
+end

data/lib/revisions/engine.rb

@@ -0,0 +1,8 @@
+module Revisions
+  class Engine < ::Rails::Engine
+    isolate_namespace Revisions
+    config.generators do |g|
+      g.template_engine :haml
+    end
+  end
+end

data/lib/revisions/version.rb

@@ -0,0 +1,3 @@
+module Revisions
+  VERSION = '0.1.0'
+end

data/lib/revisions.rb

@@ -0,0 +1,6 @@
+require "revisions/engine"
+
+module Revisions
+  mattr_accessor :mount_host
+  mattr_accessor :mount_name
+end

data/lib/tasks/revisions_tasks.rake

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

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: sn-revisions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Standard Notes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+description: The Note History extension for Standard Notes allows you to track changes
+  to your notes, and restore them to previous versions.
+email:
+- hello@standardnotes.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/revisions_manifest.js
+- app/assets/javascripts/revisions/application.js
+- app/assets/javascripts/revisions/extension.js
+- app/assets/javascripts/revisions/home.js
+- app/assets/javascripts/revisions/items.js
+- app/assets/javascripts/revisions/revisions.js
+- app/assets/stylesheets/revisions/application.css
+- app/assets/stylesheets/revisions/extension.css
+- app/assets/stylesheets/revisions/home.css.scss
+- app/assets/stylesheets/revisions/items.css
+- app/assets/stylesheets/revisions/revisions.css
+- app/controllers/revisions/application_controller.rb
+- app/controllers/revisions/extension_controller.rb
+- app/controllers/revisions/home_controller.rb
+- app/controllers/revisions/items_controller.rb
+- app/controllers/revisions/revisions_controller.rb
+- app/helpers/revisions/application_helper.rb
+- app/helpers/revisions/extension_helper.rb
+- app/helpers/revisions/home_helper.rb
+- app/helpers/revisions/items_helper.rb
+- app/helpers/revisions/revisions_helper.rb
+- app/jobs/revisions/application_job.rb
+- app/models/revisions/application_record.rb
+- app/models/revisions/item.rb
+- app/models/revisions/revision.rb
+- app/models/revisions/user.rb
+- app/views/layouts/revisions/application.html.erb
+- app/views/revisions/home/index.html.haml
+- config/routes.rb
+- db/migrate/20170211000200_create_revisions_items.rb
+- db/migrate/20170211000426_create_revisions_revisions.rb
+- db/migrate/20170211001350_create_revisions_users.rb
+- lib/revisions.rb
+- lib/revisions/engine.rb
+- lib/revisions/version.rb
+- lib/tasks/revisions_tasks.rake
+homepage: https://standardnotes.org
+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.8
+signing_key: 
+specification_version: 4
+summary: The Note History extension for Standard Notes allows you to track changes
+  to your notes, and restore them to previous versions.
+test_files: []