infopark_dashboard 0.0.1

data/CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog

data/LICENSE

@@ -0,0 +1,3 @@
+Copyright (c) 2009 - 2013 Infopark AG (http://www.infopark.com)
+
+This software can be used and modified under the LGPLv3. Please refer to http://www.gnu.org/licenses/lgpl-3.0.html for the license text.

data/README.md

@@ -0,0 +1,92 @@
+# Infopark Dashboard
+
+[![Gem Version](https://badge.fury.io/rb/infopark_dashboard.png)](http://badge.fury.io/rb/infopark_dashboard)
+[![Code Climate](https://codeclimate.com/github/infopark/infopark_dashboard.png)](https://codeclimate.com/github/infopark/infopark_dashboard)
+[![Dependency Status](https://gemnasium.com/infopark/infopark_dashboard.png)](https://gemnasium.com/infopark/infopark_dashboard)
+
+Infopark Dashboard is an addition to an [Infopark](https://infopark.de) Ruby on Rails project, that
+displays project meta data. It allows to get an overview of used CMS object classes and its
+attributes and other, statistic values by providing a mountable engine.
+
+
+## Installation and Usage
+
+Include the gem into your Gemfile:
+
+```
+group :development do
+  gem 'infopark_dashboard'
+end
+```
+
+The gem provides a mountable engine, which may be attached to your Ruby on Rails application by
+extending your ```routes.rb```:
+
+```
+if defined?(InfoparkDashboard)
+  mount InfoparkDashboard::Engine => "/cms/dashboard"
+end
+```
+
+Note that the dashboard does not use an authorization layer and is only accessible using
+local requests.
+
+## Testing
+
+You can run the dashboard's tests by simply calling:
+
+    $ rake spec
+
+In order to run the tests successfully, you need to provide the ```config/rails_connector.yml```
+and ```config/custom_cloud.yml``` file (see 'Contributing') and put them in the gem's ```config```
+directory. Do not worry, your credentials are .gitignored by default.
+
+
+## Changelog
+
+See [Changelog](https://github.com/infopark/infopark_dashboard/blob/master/CHANGELOG.md) for more
+details.
+
+
+## Contributing
+
+We would be very happy and thankful if you open new issues in order to further improve Infopark
+Dashboard. If you want to go a step further and extend the functionality or fix a problem, you can
+do so any time by following the steps below.
+
+1.  Signup for a [free Infopark account](http://www.infopark.de/) and setup a test CRM
+    and CMS component in the Infopark console.
+
+2.  Fork and clone the Infopark Dashboard GitHub repository.
+
+        git clone git@github.com:_username_/infopark_dashboard.git
+        cd infopark_dashboard
+
+3.  We suggest using [rbenv](https://github.com/sstephenson/rbenv/). Anyway, compare your local Ruby
+    version with the version given in `.ruby-version` and install it if necessary.
+
+        ruby --version
+
+3.  Download the configuration files for your Ruby on Rails application from the Infopark console
+    and copy them to your gem's `config` folder.
+
+        config/rails_connector.yml
+        config/custom_cloud.yml
+
+
+4.  Create the bundle and run all test to make sure everything is working before you add your own
+    changes. You find some more details about testing above in the __Testing__ section.
+
+        bundle
+        rake spec
+
+5.  Create your feature branch and create a pull request for the `develop` branch. Please take a
+    look at the already existing generators and rake tasks to get an impression of our coding style
+    and the general architecture.
+
+
+## License
+Copyright (c) 2009 - 2013 Infopark AG (http://www.infopark.com)
+
+This software can be used and modified under the LGPLv3. Please refer to
+http://www.gnu.org/licenses/lgpl-3.0.html for the license text.

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/assets/javascripts/infopark_dashboard/dashboard.js

@@ -0,0 +1,16 @@
+// 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 twitter/bootstrap
+//= require_tree .

data/app/assets/stylesheets/infopark_dashboard/dashboard.css

@@ -0,0 +1,19 @@
+/*
+ * 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 twitter/bootstrap
+ *= require twitter/bootstrap-responsive
+ *= require_tree .
+ */
+
+body {
+  padding: 60px 0 0 0;
+}

data/app/assets/stylesheets/infopark_dashboard/print.css

@@ -0,0 +1,11 @@
+@media print {
+  .nav, .navbar {
+    display: none;
+  }
+
+  p, h2, h3 {
+    page-break-after: avoid;
+    orphans: 3;
+    widows: 3;
+  }
+}

data/app/controllers/infopark_dashboard/dashboard_controller.rb

@@ -0,0 +1,47 @@
+module InfoparkDashboard
+  class DashboardController < ApplicationController
+    before_filter :require_local!
+
+    def objects
+      @workspaces = RailsConnector::CmsRestApi.get('workspaces')['results']
+
+      @current_workspace = @workspaces.detect do |workspace|
+        workspace['id'] == RailsConnector::Workspace.current.id
+      end
+
+      @workspaces.each do |workspace|
+        workspace['title'] ||= 'Published'
+      end
+
+      @meta_stats = MetaStats.new
+    end
+
+    def help
+      @gems = InfoparkDashboard::Gem.all
+    end
+
+    def people
+      @editors = Editor.all
+    end
+
+    def content
+      @cms_stats = CmsStats.new
+      @crm_stats = CrmStats.new
+    end
+
+    private
+
+    def require_local!
+      unless local_request?
+        render(
+          text: '<p>For security purposes, this information is only available to local requests.</p>',
+          status: :forbidden
+        )
+      end
+    end
+
+    def local_request?
+      Rails.configuration.consider_all_requests_local || request.local?
+    end
+  end
+end

data/app/models/infopark_dashboard/attribute.rb

@@ -0,0 +1,39 @@
+module InfoparkDashboard
+  class Attribute < Resource
+    def self.namespace
+      'attributes'
+    end
+
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :type
+    attr_accessor :values
+    attr_accessor :title
+    attr_accessor :min_size
+    attr_accessor :max_size
+
+    def initialize(attributes = {})
+      if attributes.is_a?(String)
+        attributes = self.class.fetch(attributes)
+      end
+
+      super(attributes)
+    end
+
+    def title?
+      title.present?
+    end
+
+    def values?
+      values.present?
+    end
+
+    def min_size?
+      min_size.present?
+    end
+
+    def max_size?
+      max_size.present?
+    end
+  end
+end

data/app/models/infopark_dashboard/cms_stats.rb

@@ -0,0 +1,31 @@
+module InfoparkDashboard
+  class CmsStats
+    attr_reader :published_objects
+    attr_reader :websites
+    attr_reader :homepages
+    attr_reader :resources
+    attr_reader :widgets
+    attr_reader :recently_published
+
+    def initialize
+      published_workspace.as_current do
+        @published_objects = Obj.all.size
+        @websites = Obj.where(:_obj_class, :equals, 'Website').size
+        @homepages = Obj.where(:_obj_class, :equals, 'Homepage').size
+        @resources = Obj.where(:_path, :starts_with, '/resources').and_not(:_obj_class, :equals, 'Container').size
+        @widgets = Obj.where(:_obj_class, :contains_prefix, 'Widget').size
+        @recently_published = Obj.all.order(:_last_changed).reverse_order.take(20)
+      end
+    end
+
+    def workspaces
+      @workspaces ||= RailsConnector::CmsRestApi.get('workspaces')['results'].size
+    end
+
+    private
+
+    def published_workspace
+      RailsConnector::Workspace.find('published')
+    end
+  end
+end

data/app/models/infopark_dashboard/crm_stats.rb

@@ -0,0 +1,23 @@
+module InfoparkDashboard
+  class CrmStats
+    def contacts
+      @contacts ||= Infopark::Crm::Contact.search(params: {}).size
+    end
+
+    def accounts
+      @accounts ||= Infopark::Crm::Account.search(params: {}).size
+    end
+
+    def mailings
+      @mailings ||= Infopark::Crm::Mailing.search(params: {}).size
+    end
+
+    def events
+      @events ||= Infopark::Crm::Event.search(params: {}).size
+    end
+
+    def activities
+      @activities ||= Infopark::Crm::Activity.search(params: {}).size
+    end
+  end
+end

data/app/models/infopark_dashboard/editor.rb

@@ -0,0 +1,11 @@
+require 'infopark_crm_connector'
+
+module InfoparkDashboard
+  class Editor
+    def self.all
+      Infopark::Crm::Contact.all.select do |contact|
+        contact.login.present? && contact.role_names.include?('superuser')
+      end
+    end
+  end
+end

data/app/models/infopark_dashboard/gem.rb

@@ -0,0 +1,31 @@
+module InfoparkDashboard
+  class Gem
+    def self.all
+      %w(infopark_rails_connector infopark_crm_connector infopark_dashboard rails bundler).map do |name|
+        new(name)
+      end
+    end
+
+    attr_accessor :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def rubygems_url
+      @rubygems_url ||= "https://rubygems.org/gems/#{name}"
+    end
+
+    def version
+      @version ||= ::Gem.loaded_specs[name].try(:version)
+    end
+
+    def latest_version
+      @latest_version ||= ::Gem.latest_version_for(name)
+    end
+
+    def latest?
+      version == latest_version
+    end
+  end
+end

data/app/models/infopark_dashboard/meta_stats.rb

@@ -0,0 +1,35 @@
+module InfoparkDashboard
+  class MetaStats
+    def maximum_attributes
+      @maximum_attributes ||= max_group_size(grouped_attributes).second.size.to_f
+    end
+
+    def grouped_attributes
+      @grouped_attributes ||= attributes.group_by(&:type)
+    end
+
+    def obj_classes_count
+      obj_classes.size
+    end
+
+    def obj_classes
+      @obj_classes ||= ObjClass.all
+    end
+
+    def global_attributes_count
+      global_attributes.size
+    end
+
+    def global_attributes
+      @attributes ||= Attribute.all
+    end
+
+    private
+
+    def max_group_size(hash)
+      hash.max do |a, b|
+        a.second.size <=> b.second.size
+      end
+    end
+  end
+end

data/app/models/infopark_dashboard/obj_class.rb

@@ -0,0 +1,50 @@
+module InfoparkDashboard
+  class ObjClass < Resource
+    def self.namespace
+      'obj_classes'
+    end
+
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :type
+    attr_accessor :is_active
+    attr_accessor :title
+    attr_accessor :attributes
+    attr_accessor :mandatory_attributes
+    attr_accessor :preset_attributes
+
+    def active?
+      is_active
+    end
+
+    def title?
+      title.present?
+    end
+
+    def attributes
+      @attributes.map do |definition|
+        Attribute.new(definition)
+      end
+    end
+
+    def attributes?
+      attributes.present?
+    end
+
+    def mandatory_attributes?
+      mandatory_attributes.present?
+    end
+
+    def preset_attributes?
+      preset_attributes.present?
+    end
+
+    def count
+      Rails.cache.fetch("#{self.class.cache_key(id)}_count") do
+        RailsConnector::Workspace.find('published').as_current do
+          Obj.where(:_obj_class, :equals, id).size
+        end
+      end
+    end
+  end
+end