activity_consumer 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e856e7fcb239433b20bfc7dd7780bc56679e96c
+  data.tar.gz: 224848a664ec46753ab55589b8724dafe16db723
+SHA512:
+  metadata.gz: 5ce5c2a8c5f812ed8162244dade5a4e5cc872130431cda212126bfa5c77b0157823f72f88946c38a8b3629cfbf41c7b58df269c19108c7dd4e9cccf40f60eb56
+  data.tar.gz: 4c490afac2e202555e8006588ec5befc3ecb4928e734c56e1eabc10dee9d6e4193e5a7baf2a11210a1d3509750026147af8bdb88fe6801c3cbc6798ced40f835

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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.rdoc

@@ -0,0 +1,3 @@
+= ActivityConsumer
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+Bundler::GemHelper.install_tasks
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+require 'rspec/core'
+require 'rspec/core/rake_task'
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+task :default => :spec

data/app/assets/javascripts/activity_consumer/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 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_tree .

data/app/assets/stylesheets/activity_consumer/application.scss

@@ -0,0 +1,43 @@
+/*
+ * 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_tree .
+ */
+
+body {
+  background-color: #a9a9a9;
+
+  font-family: verdana;
+}
+
+section#main {
+  margin: 50px;
+  padding: 20px;
+
+  border: 2px solid gray;
+  background-color: white;
+
+  border-radius:8px;
+  -moz-border-radius:8px;
+  -webkit-border-radius:8px;
+
+  hr {
+    border: 1px solid gray;
+  }
+}
+
+a {
+  color: #444;
+
+  &:visited {
+    color: #888
+  }
+}

data/app/assets/stylesheets/activity_consumer/table.scss

@@ -0,0 +1,10 @@
+table {
+
+  th {
+    color: #666;
+  }
+
+  td {
+    padding: 5px 20px;
+  }
+}

data/app/controllers/activity_consumer/application_controller.rb

@@ -0,0 +1,3 @@
+class ActivityConsumer::ApplicationController < ApplicationController
+  layout 'layouts/application'
+end

data/app/controllers/activity_consumer/remote_activities_controller.rb

@@ -0,0 +1,63 @@
+require_dependency "activity_consumer/application_controller"
+
+module ActivityConsumer
+  class RemoteActivitiesController < ApplicationController
+    # GET /remote_activities
+    # GET /remote_activities.json
+    def index
+      @remote_activities = RemoteActivity.order('created_at DESC, timestamp DESC')
+  
+      respond_to do |format|
+        format.html # index.html.erb
+        format.json { render json: @remote_activities }
+      end
+    end
+  
+    # GET /remote_activities/1
+    # GET /remote_activities/1.json
+    def show
+      @remote_activity = RemoteActivity.find(params[:id])
+  
+      respond_to do |format|
+        format.html # show.html.erb
+        format.json { render json: @remote_activity }
+      end
+    end
+
+    def import_latest
+      begin
+        stats = ActivityConsumer::RemoteActivityImporter.new(:delta).import
+
+        if stats[:no_activities] == 0 && stats[:no_errors] == 0
+          flash[:notice] = I18n.translate('import_notification.nothing')
+        else
+          flash[:notice] = I18n.translate('import_notification.success', message: compile_stats_message(stats))
+        end
+        if stats[:no_errors] > 0
+          flash[:error] = I18n.translate('import_notification.error', stats)
+        end
+      rescue => e
+        flash[:error] = I18n.translate('import_notification.exception', message: e.message)
+        Rails.logger.error "Error during activity import"
+        Rails.logger.error e.message
+        Rails.logger.error e.backtrace.join("\n")
+      end
+      
+      redirect_to :back
+    end
+
+  private
+
+    def compile_stats_message stats
+      messages = []
+      stats[:activities].each_key do |type|
+        stats[:activities][type].each_key do |action|
+          messages << I18n.translate("import_notification.#{type}_#{action}", count: stats[:activities][type][action])
+        end
+      end
+      result = I18n.translate('import_notification.no_activities', count: stats[:no_activities])
+      result << messages.join(", ")
+    end
+
+  end
+end

data/app/helpers/activity_consumer/application_helper.rb

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

data/app/models/activity_consumer/remote_activity.rb

@@ -0,0 +1,21 @@
+module ActivityConsumer
+  
+  class RemoteActivity < ActiveRecord::Base
+    
+    attr_accessible :action, :payload, :timestamp, :etag, :was_successful, :error
+    validates_presence_of :action, :timestamp
+
+    serialize :payload, Hash
+
+    def self.latest_timestamp
+      return nil unless RemoteActivity.count > 0
+      RemoteActivity.order("timestamp DESC").first.timestamp.iso8601
+    end
+
+    def short_type
+      type.gsub(/.*Remote/, '').gsub(/Activity/, '').underscore
+    end
+
+  end
+
+end

data/app/services/activity_consumer/configuration.rb

@@ -0,0 +1,24 @@
+module ActivityConsumer
+
+  # Stores the ActivityConsumer configuration.
+  class Configuration
+
+    # @example
+    #   ActivityConsumer.configure do |c|
+    #     c.activity_uri = 'example.com'
+    #   end
+    attr_accessor :activity_uri, :activity_fullexport_uri, :auth, :import_types
+
+  private
+
+    def initialize
+      self.activity_uri = 'http://inoxio-cim.dev/activities.json'
+      self.activity_fullexport_uri = 'http://inoxio-cim.dev/activities/fullexport.json'
+      self.auth = {user: 'user', password: 'secret'}
+      self.import_types = []
+    end
+
+  end
+
+end
+

data/app/services/activity_consumer/remote_activity_importer.rb

@@ -0,0 +1,40 @@
+module ActivityConsumer
+  
+  class RemoteActivityImporter
+
+    def initialize(mode = :delta)
+      @client = RemoteActivityRestClient.new(mode)
+    end
+
+    def import
+      stats = {no_activities: 0, no_errors: 0, activities: {}}
+
+      activities.each do |activity|
+        begin
+          activity.import!
+          activity.update_attributes(was_successful: true)
+          stats[:no_activities] += 1
+          stats[:activities][activity.short_type.to_sym] ||= Hash.new(0)
+          stats[:activities][activity.short_type.to_sym][activity.action.to_sym] += 1
+        rescue  => e
+          activity.update_attributes(was_successful: false, error: e.message)
+          Rails.logger.error "Error during activity import"
+          Rails.logger.error e.message
+          Rails.logger.error e.backtrace.join("\n")
+          stats[:no_errors] += 1
+        end
+      end
+
+      RemoteActivity.last.update_attributes(etag: @client.latest_etag) if RemoteActivity.last
+      stats
+    end
+
+  private
+
+    def activities
+      @client.fetch
+    end
+
+  end
+
+end

data/app/services/activity_consumer/remote_activity_rest_client.rb

@@ -0,0 +1,77 @@
+require 'httparty'
+
+module ActivityConsumer
+  
+  class RemoteActivityRestClient
+    include HTTParty
+    attr_reader :latest_etag
+
+    def initialize(mode = :delta)
+      @mode = mode
+    end
+
+    def fetch
+      Rails.logger.info "GET #{request_url}"
+      response = self.class.get(request_url, basic_auth: auth)
+      Rails.logger.info "Response: #{response}"
+      if response.success?
+        @latest_etag = response.headers['ETag']
+        activities = []
+        response['activities'].each do |activity|
+          activity = activity.deep_symbolize_keys
+
+          Rails.logger.info "trying to import #{activity}"
+          if !ActivityConsumer.configuration.import_types.include?(activity[:activity_type])
+            Rails.logger.info "type not in: #{ActivityConsumer.configuration.import_types} ... skipping!"
+            next
+          end
+
+          activities << sub_class_from_type(activity[:activity_type]).new(activity.except(:activity_type))
+        end
+        activities
+      else
+        # this just raises the net/http response that was raised
+        Rails.logger.error response.response
+        raise response.response
+      end
+    end
+
+    def is_fresh?
+      url = ActivityConsumer.configuration.activity_uri
+      etag = RemoteActivity.last ? RemoteActivity.last.etag : ''
+      Rails.logger.info "HEAD #{url} with ETag #{etag}"
+      response = self.class.head(url, basic_auth: auth, headers: {"If-None-Match" => etag})
+      Rails.logger.info "Response code: #{response.code}"
+
+      return response.code == 304
+    end
+
+  private
+
+    def sub_class_from_type(type)
+      ('Remote' + type.capitalize + 'Activity').constantize
+    end
+
+    def request_url
+      case @mode
+      when :delta
+        ActivityConsumer.configuration.activity_uri + request_params
+      when :initial
+        ActivityConsumer.configuration.activity_fullexport_uri
+      end
+    end
+
+    def request_params
+      latest = RemoteActivity.latest_timestamp
+      latest ? "?since=#{latest}" : ""
+    end
+
+    def auth
+      {
+        username: ActivityConsumer.configuration.auth[:user], 
+        password: ActivityConsumer.configuration.auth[:password]
+      }
+    end
+  end
+
+end

data/app/views/activity_consumer/remote_activities/index.html.erb

@@ -0,0 +1,32 @@
+<h1>Protokoll der letzten Importe</h1>
+
+<table id="remote_activities">
+  <tr>
+    <th>ID</th>
+    <th>Type / Action</th>
+    <th>Imported At</th>
+    <th>Timestamp</th>
+    <th>Summary</th>
+    <th class="error">Error</th>
+  </tr>
+
+<% @remote_activities.each do |remote_activity| %>
+  <tr>
+    <td><%= link_to "##{remote_activity.id}", remote_activity_path(remote_activity) %></td>
+    <td>
+      <% if remote_activity.was_successful %>
+        <%= image_tag 'activity_consumer/tick.png' %>
+      <% else %>
+        <%= image_tag 'activity_consumer/cross.png' %>
+      <% end %>
+
+      <%= remote_activity.short_type.upcase %>
+      <%= remote_activity.action.upcase %>
+    </td>
+    <td><%=l remote_activity.created_at, format: :short %></td>
+    <td><%=l remote_activity.timestamp, format: :short %></td>
+    <td><%= remote_activity.payload_summary %></td>
+    <td><%= remote_activity.error %></td>
+  </tr>
+<% end %>
+</table>

data/app/views/activity_consumer/remote_activities/show.html.erb

@@ -0,0 +1,37 @@
+<article id="remote_activity">
+
+  <h1>
+    Import #<%= @remote_activity.id %> 
+    <%= @remote_activity.short_type.upcase %>
+    <%= @remote_activity.action.upcase %>
+  </h1>
+  
+  <div class="timestamp">
+    <span class="label"><%=t 'activity_consumer.imported_at' %></span>: 
+    <%=l @remote_activity.created_at, format: :short %>
+  </div>
+  <div class="timestamp">
+    <span class="label"><%=t 'activity_consumer.timestamp' %></span>: 
+    <%=l @remote_activity.timestamp, format: :short %>
+  </div>
+  <div class="timestamp">
+    <span class="label"><%=t 'activity_consumer.etag' %></span>: 
+    <%= @remote_activity.etag %>
+  </div>
+  
+  <pre><%= JSON.pretty_generate @remote_activity.payload %></pre>
+  
+  <p>
+    <% if @remote_activity.was_successful %>
+      <%= image_tag 'activity_consumer/tick.png' %> <%=t 'activity_consumer.successful' %>
+    <% else %>
+      <%= image_tag 'activity_consumer/cross.png' %> <%=t 'activity_consumer.failure' %>
+    <% end %>
+  </p>
+  
+  <% if @remote_activity.error.present? %>
+    <div class="error"><%= @remote_activity.error %></div>
+  <% end %>
+  
+  <%= link_to 'Back', remote_activities_path %>
+</article>

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

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ActivityConsumer</title>
+  <%= stylesheet_link_tag    "activity_consumer/application", :media => "all" %>
+  <%= javascript_include_tag "activity_consumer/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<section id="main">
+  <%= yield %>
+</section>
+
+
+</body>
+</html>

data/config/locales/de.yml

@@ -0,0 +1,18 @@
+de:
+  import_notification:
+    nothing: 'Es gab nichts zu importieren.'
+    success: 'Import abgeschlossen. %{message}'
+    no_activities: 
+      one: 'Eine Änderung: '
+      other: '%{count} Änderungen: '
+    error: '%{no_errors} Fehler beim Import.'
+    exception: 'Import ging komplett in die Hose: %{message}'
+    foo_create: 
+      one: "ein neues Foo"
+      other: "%{count} neue Foos"
+    foo_update: 
+      one: "ein geändertes Foo"
+      other: "%{count} geänderte Foos"
+    foo_destroy: 
+      one: "ein gelöschtes Foo"
+      other: "%{count} gelöschte Foos"

data/config/routes.rb

@@ -0,0 +1,9 @@
+ActivityConsumer::Engine.routes.draw do
+
+  resources :remote_activities do
+    collection do
+      get :import_latest
+    end
+  end
+
+end

data/db/migrate/20130725170303_create_activity_consumer_remote_activities.rb

@@ -0,0 +1,16 @@
+class CreateActivityConsumerRemoteActivities < ActiveRecord::Migration
+  
+  def change
+    create_table :activity_consumer_remote_activities do |t|
+      t.string :type,         null: false
+      t.string :action
+      t.datetime :timestamp
+      t.text :payload
+      t.boolean :was_successful
+      t.text :error
+
+      t.timestamps
+    end
+  end
+
+end

data/db/migrate/20130817171648_add_etag_to_remote_activities.rb

@@ -0,0 +1,5 @@
+class AddEtagToRemoteActivities < ActiveRecord::Migration
+  def change
+    add_column :activity_consumer_remote_activities, :etag, :string
+  end
+end

data/lib/activity_consumer/engine.rb

@@ -0,0 +1,13 @@
+module ActivityConsumer
+  class Engine < ::Rails::Engine
+    isolate_namespace ActivityConsumer
+
+    config.generators do |g|
+      g.test_framework      :rspec,        :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+    
+  end
+end

data/lib/activity_consumer/version.rb

@@ -0,0 +1,3 @@
+module ActivityConsumer
+  VERSION = "0.4.0"
+end

data/lib/activity_consumer.rb

@@ -0,0 +1,26 @@
+require "activity_consumer/engine"
+
+module ActivityConsumer
+
+  extend self
+
+  # Used to configure ActivityConsumer.
+  #
+  # @example
+  #    ActivityConsumer.configure do |c|
+  #      c.some_config_option = true
+  #    end
+  #
+  # @yield the configuration block
+  # @yieldparam config [ActivityConsumer::Configuration] the configuration object
+  # @return [void]
+  def configure
+    yield configuration
+  end
+
+  # @return [ActivityConsumer::Configuration] the ActivityConsumer configuration.
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+end

data/lib/tasks/activity_consumer_tasks.rake

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

data/spec/controllers/activity_consumer/remote_activities_controller_spec.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+require 'spec_helper'
+
+# stub implementation of a RemoteActivity sub-class
+class RemoteFooActivity < ActivityConsumer::RemoteActivity
+  def import!; end
+end
+
+module ActivityConsumer
+
+  describe RemoteActivitiesController do
+    
+    describe "GET import_latest" do
+
+      before(:each) do
+        request.env["HTTP_REFERER"] = "where_i_came_from"
+      end
+
+      it "uses RemoteActivityImporter" do
+        ActivityConsumer::RemoteActivityImporter.any_instance.should_receive(:import).once.and_return({})
+        get :import_latest, use_route: :activity_consumer
+        response.should redirect_to("where_i_came_from")
+      end
+
+      it "fills flash message with stats of import" do
+        stats = {
+          no_activities: 13, no_errors: 4,
+          activities: { foo: { create: 8, update: 2, destroy: 3 } }
+        }
+        ActivityConsumer::RemoteActivityImporter.any_instance.should_receive(:import).once.and_return(stats)
+        get :import_latest, use_route: :activity_consumer
+        
+        flash[:error].should == "4 Fehler beim Import."
+        flash[:notice].should == "Import abgeschlossen. 13 Änderungen: 8 neue Foos, 2 geänderte Foos, 3 gelöschte Foos"
+      end
+
+      it "shows no error message when there was no error" do
+        stats = {
+          no_activities: 13, no_errors: 0, 
+          activities: { foo: { create: 8, update: 2, destroy: 3 } }
+        }
+        ActivityConsumer::RemoteActivityImporter.any_instance.should_receive(:import).once.and_return(stats)
+        get :import_latest, use_route: :activity_consumer
+        
+        flash[:error].should be_nil
+      end
+
+      it "shows a dedicated message when there was nothing to import" do
+        stats = {
+          no_errors: 0, no_activities: 0, activities: {}
+        }
+        ActivityConsumer::RemoteActivityImporter.any_instance.should_receive(:import).once.and_return(stats)
+        get :import_latest, use_route: :activity_consumer
+        
+        flash[:notice].should == "Es gab nichts zu importieren."
+      end
+
+      it "actually imports stuff" do
+        VCR.insert_cassette 'activities-controller'
+        ActivityConsumer.configure do |c|
+          c.activity_uri = 'http://inoxio-cim.dev/activities.json'
+          c.import_types = ['Foo']
+        end
+
+        get :import_latest, use_route: :activity_consumer
+        flash[:error].should == nil
+        flash[:notice].should == "Import abgeschlossen. 3 Änderungen: ein neues Foo, ein geändertes Foo, ein gelöschtes Foo"
+      end
+      
+    end
+  end
+end