gdpr_rails 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f3bd8d4a83a8def6219e0f1133cdc0f5a072ce6
-  data.tar.gz: c2678088ad8a2945e0836a20719778de1693dc7e
+  metadata.gz: b43a8ecf784c5fe1b24530af6c767b88c0af6d54
+  data.tar.gz: 492df811d80c74b0c28b69dde3e3bba0feeebf64
 SHA512:
-  metadata.gz: 40d2cb1dbe0646fdd9193f034f06b71cac780e7e4b336fd054cf1441a8b317c6e3eb5d9dbb709a5006717acf1b19df4828c756a489b90a60cc2a81417ca51f5d
-  data.tar.gz: d95f5add634525882da0543931adbcb15e6b77fb172ed194481b650a73dd37a173da16ae0e23027d2e6e720b6f1a7cc7c58f3663e2727d13fe27fd473db8f5d9
+  metadata.gz: 53f0054aaeafad9a6e64022609bbccfbf0417b0488291b33b578c93ea07e8cd57000c03f6c549824ada0e7115b33843d97bd9bba9c428bfefaae7779dcf66183
+  data.tar.gz: 3e366811b4af4b5dc8f5dac5bf2448e1b9c05379de27ab4fd9a701c4ae0b1def7f5a117bfe3c1f4f972d8dc06ac571d6744525b68b81efce9103ff1b372c2e10

data/README.md

@@ -24,7 +24,7 @@ PolicyManager (Aka GDPR RAILS) was created with flexibility in mind to comply wi
 + JSON endpoints to handle pending policies and portability logic in order to be implemented in *client only* interfaces, ie: frontend apps like React, Vue, Backbone, you name it.
 
 #### Portability
-Portability module lets you define export options, that will generate a navigable static site with all the data you've defined in the **portability rules**
+Portability module lets you define export options, that will generate a navigable static HTML site with all the data you've defined in the **portability rules** with json support too.
 + Seamless data export with configurable templates
 + Configurable Mailer templates for progress & download completion
 + Downloads images to the local filesystem in order to comply with GDPR requirements on data accessibility.
@@ -210,8 +210,8 @@ Export option & Portability rules will allow you to set up how and which data yo
 #### Exporter:
 + **path**: where the folder will be generated, usually can be set on /tmp, this will need a pathname, like `Rails.root.join("tmp/export")`
 + **resource**: which model , ie: `User`
-+ **index_template**: The first page. defaults to a simple ul li list of links tied to your rules, this expects a Pathname or a String with yout template
-+ **layout**: A layout template to wrap the static site,  this expects a Pathname or a String with your template
++ **index_template**: The first page. defaults to a simple ul li list of links tied to your rules, this expects a Pathname or a String with your template
++ **layout**: A layout template this expects a layout name which has to be available on your app.
 + **after_zip**: a callback to handle the zip file on the resource, something like:
 ```ruby
 after_zip: ->(zip_path, resource){
@@ -245,6 +245,8 @@ PolicyManager::Config.setup do |c|
     name: "exportable_data",
     collection: :articles,
     template: "hello, a collection will be rendered here use @collection.to_json",
+    json_template: "collection.json.jbuilder", # or Rails.root.join("app/views/collection.json.jbuilder")
+
     per: 10
   })
 

data/app/controllers/policy_manager/exporter_controller.rb

@@ -0,0 +1,7 @@
+module PolicyManager
+  class ExporterController < ActionController::Base
+
+    include ExporterHelper 
+
+  end
+end

data/app/helpers/policy_manager/exporter_helper.rb

@@ -0,0 +1,29 @@
+module PolicyManager
+  module ExporterHelper
+
+    def image_tag(remote_image, opts={})
+      begin
+        basename = File.basename(remote_image)
+        id = opts[:id] || SecureRandom.hex(10)
+        composed_name = [id, basename].compact.join("-")
+        path = "#{File.dirname(@base_path)}/#{composed_name}"
+        save_image(remote_image, path)
+        tag(:img, {src: "./#{id}-#{File.basename(URI(remote_image).path)}" }.merge(opts))
+      rescue => e
+        Config.error_notifier_method(e)
+        content_tag(:p, "broken image")
+      end
+    end
+
+    private
+
+    def save_image(remote_image, path)
+      open(URI(path).path, 'wb') do |file|
+        file << open(remote_image).read
+      end
+    end
+    
+  end
+end
+
+

data/app/models/policy_manager/concerns/user_behavior.rb

@@ -65,10 +65,7 @@ module PolicyManager::Concerns::UserBehavior
     self.send(rule.member)
   end
 
-  def portability_collection_for(rule, page)
-    # if kaminari
-    # self.send(rule.collection).page(1)
-    # if will paginate
+  def portability_collection_for(rule, page = nil)
     self.send(rule.collection).paginate(page: page, per_page: rule.per)
   end
 

data/lib/policy_manager.rb

@@ -8,8 +8,10 @@ require "policy_manager/portability_rule"
 require "policy_manager/exporter"
 require "policy_manager/exporter/handler.rb"
 require "policy_manager/exporter/view.rb"
+require "policy_manager/exporter/json_view.rb"
 require "policy_manager/exporter/zip_generator.rb"
 require "policy_manager/exporter/paginator_renderer.rb"
+require "policy_manager/exporter/json_link.rb"
 
 require "policy_manager/config"
 

data/lib/policy_manager/config.rb

@@ -28,7 +28,8 @@ module PolicyManager
     end
 
     def self.error_notifier_method(error)
-      @@error_notifier.call(error)
+      puts error
+      @@error_notifier.call(error) unless @@error_notifier.blank?
     end
 
     def self.admin_email(user)

data/lib/policy_manager/exporter/handler.rb

@@ -66,37 +66,72 @@ module PolicyManager
       return unless resource.respond_to?(:portability_member_for)
       o = resource.portability_member_for(rule)
       base_dir = self.base_path.join(rule.name)
-      resource_path = base_dir.join("index.html")
       FileUtils.mkdir_p(base_dir)
-      view = ExporterView.new({member: o}, {build_path: self.base_path, base_path: resource_path, template: rule.template, rule: rule})
+      resource_path = base_dir.join("index.html")
+      
+      view = ExporterView.new({
+        assigns: {member: o}, 
+        build_path: self.base_path, 
+        base_path: resource_path, 
+        template: rule.template, 
+        rule: rule
+      }).save(resource_path)
+
       puts "saving at #{self.path.join rule.name}"
-      view.save(resource_path )
+      
+      json = JsonExporterView.new({
+        assigns: {member: o}, 
+        template: rule.json_template, 
+        folder: base_dir
+      }).save if rule.json_template.present?
     end
 
     def render_collection(rule)
       return unless resource.respond_to?(:portability_collection_for)
-      o = resource.portability_collection_for(rule ,1)
-      
+      o = resource.portability_collection_for(rule, 1)
+
+      base_dir  = self.base_path.join(rule.name)
+      FileUtils.mkdir_p(base_dir)
+
       (1..o.total_pages).to_a.each do |i| 
-        o = resource.portability_collection_for(rule,i)
-        page_name = i #== 1 ? "index" : i
-        base_dir  = self.base_path.join(rule.name)
-        base_dir  = base_dir.join(page_name.to_s) unless page_name == 1
-        FileUtils.mkdir_p(base_dir)
-        resource_path = base_dir.join("index.html")
-        view = ExporterView.new({collection: o}, {build_path: self.base_path, base_path: resource_path, template: rule.template, rule: rule})
+        o = resource.portability_collection_for(rule, i)
+
+        page_name = i
+        folder_dir = page_name == 1 ? base_dir : base_dir.join(page_name.to_s)
+        FileUtils.mkdir_p(folder_dir)
+        resource_path = folder_dir.join("index.html")
+        
+        view = ExporterView.new({
+          assigns: {collection: o} , 
+          build_path: self.base_path, 
+          base_path: resource_path, 
+          template: rule.template, 
+          rule: rule
+        }).save(resource_path)
+
+        
+        json = JsonExporterView.new({
+          assigns: {collection: o}, 
+          template: rule.json_template, 
+          folder: folder_dir
+        }).save if rule.json_template.present?
+
         puts "saving at #{self.path.join rule.name}"
-        view.save( resource_path )
       end
     end
 
     def render_index
       resource_path = self.base_path.join("index.html")
       template = PolicyManager::Config.exporter.index_template
-      view = ExporterView.new({collection: PolicyManager::Config.portability_rules}, 
-        {build_path: self.base_path, base_path: resource_path, template: template})
+      view = ExporterView.new({ 
+        assigns: {
+          collection: PolicyManager::Config.portability_rules
+        }, 
+        build_path: self.base_path, 
+        base_path: resource_path, 
+        template: template
+      }).save( resource_path )
       puts "saving at #{resource_path}"
-      view.save( resource_path )
     end
 
     def generate_zip

data/lib/policy_manager/exporter/json_link.rb

@@ -0,0 +1,19 @@
+module PolicyManager
+  class JsonLink
+
+    def self.render(collection = nil)
+      ActionController::Base.helpers.content_tag(:a, "Open as JSON", href: link(collection), target: '_blank')
+    end
+
+    private
+
+    def self.link(collection)
+      if collection.nil? || collection.current_page == 1
+        return "./data.json"
+      else
+        return "./../data.json"
+      end
+    end
+
+  end
+end

data/lib/policy_manager/exporter/json_view.rb

@@ -0,0 +1,47 @@
+require "fileutils"
+
+module PolicyManager
+  class JsonExporterView
+    attr_accessor :template, :folder, :assigns
+
+    def initialize(vars={}, options)
+      self.folder = options[:folder]
+      self.assigns = options[:assigns]
+      @template = options.fetch(:template) #, self.class.template)
+      return self
+    end
+
+    def save
+      render_json
+    end
+
+    def save_json(file, data)
+      File.open(file, "w") do |f|
+        f.write(data)
+      end
+    end
+
+    def render_json
+      ac = PolicyManager::ExporterController.new()
+      options = handled_template.merge!({assigns: self.assigns })
+      content = ac.render_to_string(options)
+      save_json("#{folder}/data.json", content)
+    end
+
+    def handled_template
+      begin
+        if URI.parse(@template)
+          return {template: @template}
+        end
+      rescue URI::InvalidURIError
+      end
+
+      if @template.is_a?(String) 
+        return {inline: @template}
+      elsif @template.is_a?(Pathname)
+        return {file: @template }
+      end
+    end
+
+  end
+end

data/lib/policy_manager/exporter/paginator_renderer.rb

@@ -1,5 +1,6 @@
 require "will_paginate"
 require 'will_paginate/view_helpers/action_view'
+require 'will_paginate/array'
 
 module PolicyManager
   class PaginatorRenderer < WillPaginate::ActionView::LinkRenderer

data/lib/policy_manager/exporter/view.rb

@@ -14,22 +14,19 @@ module PolicyManager
     include WillPaginate::ViewHelpers #if defined?(WillPaginate)
     include WillPaginate::ActionView #if defined?(WillPaginate)
     
-    attr_accessor :template, :base_path
+    attr_accessor :template, :base_path, :assigns
 
     def self.template
       "Welcome, <%= @name %>"
     end
 
-    def initialize(vars={}, options={}, date=Time.now)
-      # collection or member, or wathever!?
-      vars.each{|k, v| self.instance_variable_set("@#{k}", v)}
+    def initialize(options={}, date=Time.now)
       @base_path = options[:base_path]
       @build_path = options[:build_path]
-
+      self.assigns = options[:assigns]
       index_path
-
       @template = options.fetch(:template, self.class.template)
-
+      return self
     end
 
     def index_path
@@ -47,60 +44,39 @@ module PolicyManager
       end
     end
 
-    def image_tag(remote_image, opts={})
-      begin
-        basename = File.basename(remote_image)
-        id = opts[:id] || SecureRandom.hex(10)
-        composed_name = [id, basename].compact.join("-")
-        path = "#{File.dirname(base_path)}/#{composed_name}"
-        self.save_image(remote_image, path)
-        tag(:img, {src: "./#{id}-#{File.basename(URI(remote_image).path)}" }.merge(opts))
-      rescue => e
-        Config.error_notifier_method(e)
-        content_tag(:p, "broken image")
-      end
-    end
-
-    def save_image(remote_image, path)
-      open(URI(path).path, 'wb') do |file|
-        file << open(remote_image).read
-      end
-    end
-
     def render()
-      #template_layout = Tilt::ERBTemplate.new {PolicyManager::Config.exporter.layout}
       context = self
-      #template_layout.render { 
-      #  view = Tilt::ERBTemplate.new{handled_template}
-      #  view.render(context)
-      #}
-
-      render_with_layout()      
-    end
-
-    def render_with_layout(context = self)
-      render_layout do
-        ERB.new(handled_template).result(binding)
-      end
-    end
-
-    def render_layout
-      layout = PolicyManager::Config.exporter.layout #File.read('views/layouts/app.html.erb')
-      ERB.new(layout).result(binding)
+      ac = PolicyManager::ExporterController.new()
+      options = handled_template.merge!({
+        assigns: self.assigns.merge!({
+          base_path: base_path, 
+          build_path: @build_path,
+          index_path: index_path
+        }),
+        layout: PolicyManager::Config.exporter.layout 
+      })
+      ac.render_to_string(options)
     end
 
-
     def save(file)
       File.open(file, "w+") do |f|
         f.write(render)
       end
     end
 
+    # TODO: method duplicated from json
     def handled_template
+      begin
+        if URI.parse(@template)
+          return {template: @template}
+        end
+      rescue URI::InvalidURIError
+      end
+
       if @template.is_a?(String) 
-        @template
+        return {inline: @template}
       elsif @template.is_a?(Pathname)
-        File.open(@template).read
+        return {file: @template }
       end
     end
 

data/lib/policy_manager/portability_rule.rb

@@ -1,6 +1,13 @@
 module PolicyManager
   class PortabilityRule
-    attr_accessor :name, :methods, :formats, :per, :collection, :member, :template
+    attr_accessor :name, 
+    :methods, 
+    :formats, 
+    :per, 
+    :collection, 
+    :member, 
+    :template,
+    :json_template
 
     def initialize(opts={})
       self.collection = opts[:collection]
@@ -9,6 +16,7 @@ module PolicyManager
       self.name = opts[:name]
       self.formats = opts[:formats]
       self.template = opts[:template]
+      self.json_template = opts[:json_template]
     end
 
   end

data/lib/policy_manager/version.rb

@@ -1,3 +1,3 @@
 module PolicyManager
-  VERSION = '0.2.4'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gdpr_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Miguel Michelson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-11 00:00:00.000000000 Z
+date: 2018-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -206,11 +206,13 @@ files:
 - app/assets/stylesheets/scaffold.css
 - app/controllers/policy_manager/application_controller.rb
 - app/controllers/policy_manager/categories_controller.rb
+- app/controllers/policy_manager/exporter_controller.rb
 - app/controllers/policy_manager/portability_requests_controller.rb
 - app/controllers/policy_manager/terms_controller.rb
 - app/controllers/policy_manager/user_portability_requests_controller.rb
 - app/controllers/policy_manager/user_terms_controller.rb
 - app/helpers/policy_manager/application_helper.rb
+- app/helpers/policy_manager/exporter_helper.rb
 - app/helpers/policy_manager/portability_requests_helper.rb
 - app/helpers/policy_manager/scripts_helper.rb
 - app/helpers/policy_manager/terms_helper.rb
@@ -258,6 +260,8 @@ files:
 - lib/policy_manager/engine.rb
 - lib/policy_manager/exporter.rb
 - lib/policy_manager/exporter/handler.rb
+- lib/policy_manager/exporter/json_link.rb
+- lib/policy_manager/exporter/json_view.rb
 - lib/policy_manager/exporter/paginator_renderer.rb
 - lib/policy_manager/exporter/view.rb
 - lib/policy_manager/exporter/zip_generator.rb