writefully 0.3.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c578de39737faf4bcb838175f4ac604262b874e7
+  data.tar.gz: d6ddeb25fcf43d553f1b992ed6b43aa93c2499a7
+SHA512:
+  metadata.gz: 6ed18f2b874486eb6c055b430a2bfd5489be4ce36a7bc567382616840bb3fe4dea85bba93214c00cb26990f89997b2dbbfbecbe536601ec78376e570f5be6a90
+  data.tar.gz: 8b28483bbc1141ec538af5e9196b66844a70bde65a3015fe8f1c3ac4dd817482f24ea71f29f15a967dde120808bf6dd04a6ceb7661a7896492b4346611bdd76e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 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.md

@@ -0,0 +1,31 @@
+# Writefully
+
+[![Build Status](https://travis-ci.org/codemy/writefully.svg?branch=master)](https://travis-ci.org/codemy/writefully) [![Coverage Status](https://coveralls.io/repos/codemy/writefully/badge.png?branch=master)](https://coveralls.io/r/codemy/writefully?branch=master) [![Code Climate](https://codeclimate.com/github/codemy/writefully.png)](https://codeclimate.com/github/codemy/writefully)
+
+Allows developers who love to write to publish easily
+
+## Manifesto
+
++ Writefully Core
+  + Separate lightweight process that manages all the work
+  + Main rails process should be able to communicate with Writefully via Redis queue
+    + When a site is created it sets up a repository / hooks with sample content
+  + Manages content taxonomy via Tags / Taggings
+  + Easily Extendable from main rails app
+  + Content Localization
+  + Backend Interface for managing sites
+  + Receive WebHook from github and updates site
+  + Turns repository collaborators into authors
+  + Converts local based images into content provider URL
+    + S3 / Cloudfront
+    + Akamai
+    + Cloudfiles
+    + etc...
+
++ Writefully Desktop App
+  + Probably going to use [node-webkit](https://github.com/rogerwang/node-webkit)
+  + More details to com
+
++ Writefully mobile app
+  + Probably going to use [Framework7](http://www.idangero.us/framework7/)
+  + More details to come

data/Rakefile

@@ -0,0 +1,22 @@
+#!/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/writefully/authorships.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/writefully/sessions.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/writefully/writefully/initializers/boot.coffee

@@ -0,0 +1,6 @@
+# this file will boot up your transponder app
+
+# presenters
+
+
+# services

data/app/assets/javascripts/writefully/writefully/initializers/manifest.coffee

@@ -0,0 +1,28 @@
+Application.services_manifest = ->
+  # fill in your manifest here
+  # example:
+  # if you want to trigger a service on your entire app
+  # $('body').trigger 'application:services:service_name'
+  # 
+  # If you want a more fine grained control for 
+  # different pages you can add a class to your body 
+  # in your views/layouts/application.html.erb
+  # on your body tag you can do something like this
+  #
+  # <body class="[controller_name] [action_name]">
+  #
+  # You now have a more fine grained control in 
+  # your manifest file
+  # $('body.posts.show').trigger 'application:services:service_name'
+  #
+  # if you need to trigger the same services on multiple pages
+  # $('body.posts.show,
+  #    body.dashboard.show,
+  #    body.photos.index').trigger 'application:services:service_name'
+  # 
+
+Application.run_ready = ->
+  Application.services_manifest()
+
+$(document).ready Application.run_ready
+$(document).on 'page:load', Application.run_ready

data/app/assets/javascripts/writefully/writefully/initializers/setup.coffee

@@ -0,0 +1,4 @@
+window.Application =
+  Helpers: {}
+  Services: {}
+  Presenters: {}

data/app/assets/javascripts/writefully/writefully/loader.coffee

@@ -0,0 +1,6 @@
+#= require ./initializers/setup
+#= require_tree ./services
+#= require_tree ./helpers
+#= require_tree ./presenters
+#= require ./initializers/boot
+#= require ./initializers/manifest 

data/app/assets/javascripts/writefully/writefully.coffee

@@ -0,0 +1,8 @@
+# this is where you require all the files
+#= require jquery
+#= require jquery_ujs
+#= require turbolinks
+#= require transponder
+
+# this part boots up the transponder module
+#= require writefully/writefully/loader

data/app/assets/stylesheets/writefully/base.sass

@@ -0,0 +1,23 @@
+.status-warning
+  color: $brand-warning
+
+.status-success
+  color: $brand-success
+
+.status-danger
+  color: $brand-danger
+
+a
+  color: #999
+
+a:hover
+  text-decoration: none
+  color: #333
+
+div.container
+  > h1,  > h2,  > h3,  > h4, > h5, > h6
+    margin-bottom: 20px
+
+.panel
+  h1, h2, h3, h4, h5, h6
+    margin: 0px !important

data/app/assets/stylesheets/writefully/sessions.sass

@@ -0,0 +1,9 @@
+body.writefully.sessions.new
+  div#new-session
+    margin-top: 30px
+    h1
+      font-weight: 100
+      text-align: center
+
+    p.setup-help
+      padding: 10px

data/app/assets/stylesheets/writefully/sites.sass

@@ -0,0 +1,33 @@
+body.writefully.sites, body.writefully.posts.index
+  h1, h2, h3, h4, h5, h6
+    font-weight: 100
+
+  div.post.media
+    border-top: 1px solid #eee
+    padding-top: 15px
+
+    &:first-child
+      border-top: 0px
+      padding-top: 0px
+
+  ul.nav-tabs
+    margin-bottom: 20px
+
+  form#new_site
+    margin-top: 40px
+    p.form-info
+      padding: 10px
+
+
+  div.site.media
+    border-top: 1px solid #eee
+    padding-top: 15px
+    &:first-child
+      border-top: 0px
+      padding-top: 0px
+    div.status
+      margin-top: 5px
+      vertical-align: middle
+      font-size: 16px
+    h2
+      font-weight: 200

data/app/assets/stylesheets/writefully/writefully.sass

@@ -0,0 +1,4 @@
+@import "bootstrap"
+@import "base"
+@import "sites"
+@import "sessions"

data/app/controllers/writefully/application_controller.rb

@@ -0,0 +1,28 @@
+module Writefully
+  class ApplicationController < ActionController::Base
+
+    def authenticate_wf_authorship!
+      redirect_to signin_path unless wf_authorship_signed_in?
+    end
+
+    def wf_authorship_signed_in?
+      current_wf_authorship.present?
+    end
+
+    def set_flash(type, object: nil)
+      flash[:namespace] = 'writefully'
+      flash[:from] = action_name
+      flash[:type] = type
+      flash[:object_type] = object.class.name
+      flash[:object_id]   = object.id
+    end
+
+    private 
+
+    helper_method :current_wf_authorship
+
+    def current_wf_authorship
+      @current_wf_authorship ||= Authorship.where(id: session[:wf_authorship_id]).first if session[:wf_authorship_id]
+    end
+  end
+end

data/app/controllers/writefully/authorships_controller.rb

@@ -0,0 +1,8 @@
+require_dependency "writefully/application_controller"
+
+module Writefully
+  class AuthorshipsController < ApplicationController
+    before_filter :authenticate_wf_owner!
+
+  end
+end

data/app/controllers/writefully/hooks_controller.rb

@@ -0,0 +1,51 @@
+require_dependency "writefully/application_controller"
+
+module Writefully
+  class HooksController < ApplicationController
+    respond_to :json
+    before_filter :check_signature
+
+    HMAC_DIGEST = OpenSSL::Digest::Digest.new('sha1')
+
+    class InvalidSignature < StandardError; end
+
+    def create
+      self.__send__ request.headers["X-Github-Event"].to_sym
+      head :ok
+    end
+
+    def push
+      Writefully.add_job :handyman, { task: :synchronize, 
+                                      site_slug: body.repository.name } if branch_match?
+    end
+
+    def member
+      authorship = Authorship.find_by_uid(body.member.id)
+      unless authorship
+        Authorship.create_from_data(body.member)
+      end
+    end
+
+  protected
+
+    def branch_match?
+      Site.where(slug: body.repository.name).first.branch == body.ref.split('/').last
+    end
+
+    def body
+      @_body ||= Hashie::Mash.new(JSON.parse(request.body.read))
+    end
+
+    def check_signature
+      unless signature == request.headers["X-Hub-Signature"]
+        raise InvalidSignature, "Invalid signature" 
+      end
+    end
+
+    def signature
+      'sha1=' + OpenSSL::HMAC.hexdigest(HMAC_DIGEST, 
+                                        Writefully.options[:hook_secret], 
+                                        request.body.read)
+    end
+  end
+end

data/app/controllers/writefully/posts_controller.rb

@@ -0,0 +1,21 @@
+require_dependency "writefully/application_controller"
+
+module Writefully
+  class PostsController < ApplicationController
+    def index
+      @site = get_site
+      @posts = @site.posts
+    end
+
+    def show
+      @site = get_site
+      @post = @site.posts.friendly.find(params[:id])
+    end
+    
+  protected
+
+    def get_site
+      current_wf_authorship.owned_sites.friendly.find(params[:site_id])
+    end
+  end
+end

data/app/controllers/writefully/sessions_controller.rb

@@ -0,0 +1,47 @@
+require_dependency "writefully/application_controller"
+
+module Writefully
+  class SessionsController < ApplicationController
+    def new
+      @github_app = Writefully.github_app
+    end
+
+    def create
+      @auth = Writefully.github_app.get_token(params[:code])
+      @github = Github.new oauth_token: @auth.token
+      @github_user = @github.users.get
+      @owner  = find_or_create_owner 
+
+      refresh_token
+      session[:wf_authorship_id] = @owner.id
+      redirect_to root_path, notice: 'signed_in'
+    end
+
+    def destroy
+      session[:wf_authorship_id] = nil
+      redirect_to root_path, notice: 'signed_out'
+    end
+
+    protected
+
+    def refresh_token
+      @owner.update_attributes(data: @owner.data.merge({ auth_token: @auth.token }))
+    end
+
+    def find_or_create_owner
+      find_owner || create_owner
+    end
+
+    def find_owner
+      Authorship.find_by_uid(@github_user.id)
+    end
+
+    def create_owner
+      if Authorship.count == 0
+        Authorship.create_from_data(@github_user)
+      else
+        return redirect_to root_path, notice: 'owner_exists'
+      end
+    end
+  end
+end

data/app/controllers/writefully/sites_controller.rb

@@ -0,0 +1,51 @@
+require_dependency "writefully/application_controller"
+
+module Writefully
+  class SitesController < ApplicationController
+    before_filter :authenticate_wf_authorship!
+
+    VALID_TABS = %w(processing errors)
+
+    def index
+      @sites = current_wf_authorship.owned_sites
+      redirect_to new_site_path if @sites.empty?
+    end
+
+    def show
+      @site = get_site
+      if params[:tab].nil? or not tab_valid?
+        redirect_to site_posts_path(@site) 
+      end
+    end
+
+    def new
+      @site = current_wf_authorship.owned_sites.build
+    end
+
+    def edit
+      @site = get_site
+    end
+
+    def create
+      @site = current_wf_authorship.owned_sites.build(site_params)
+      if @site.save
+        set_flash :success, object: @site
+        redirect_to sites_path
+      end
+    end
+
+  protected
+
+    def tab_valid?
+      VALID_TABS.include?(params[:tab])
+    end
+
+    def get_site
+      current_wf_authorship.owned_sites.friendly.find(params[:id])
+    end
+
+    def site_params
+      params.require(:site).permit(:name, :domain)
+    end
+  end
+end

data/app/helpers/writefully/application_helper.rb

@@ -0,0 +1,15 @@
+module Writefully
+  module ApplicationHelper
+    def path_active?(path)
+      request.path == path ? 'active' : nil
+    end
+
+    def link_icon(icon)
+      content_tag :span, nil,class: "glyphicon glyphicon-#{icon}" if icon
+    end
+
+    def activeable_link_to(type, name, path, options = {})
+      render 'activeable_link_to', type: type, name: name, path: path, options: options
+    end
+  end
+end

data/app/helpers/writefully/flash_helper.rb

@@ -0,0 +1,31 @@
+module Writefully
+  module FlashHelper
+    def render_flash
+      render 'flash' if can_flash?
+    end
+
+    def can_flash?
+      flash.keys.sort == [:from, :object_id, :object_type, :type] and \
+      flash.to_hash.values.compact.count == flash_values_count
+    end
+
+    def flash_values_count
+      action_name == "create" ? 3 : flash.keys.count
+    end
+
+    def flash_object
+      flash[:object_type].classify.constantize.where(id: flash[:object_id]).first
+    end
+
+    def flash_path
+      File.join((flash[:namespace] || nil), controller_name, 'flash', flash[:from].to_s, flash[:type].to_s)
+    end
+
+    def flash_color
+      { success: 'alert-success',
+        error:   'alert-danger',
+        notice:  'alert-info',
+        warn:    'alert-warning' }[flash[:type]]
+    end
+  end
+end

data/app/helpers/writefully/posts_helper.rb

@@ -0,0 +1,8 @@
+module Writefully
+  module PostsHelper
+    def publish_tag post
+      partial = post.published_at.present? ? 'published' : 'not_published'
+      'writefully/posts/' + partial
+    end
+  end
+end

data/app/helpers/writefully/sites_helper.rb

@@ -0,0 +1,21 @@
+module Writefully
+  module SitesHelper
+
+    STATE_PARTIAL = { 
+      true  => 'yes',
+      false => 'no'
+    }
+
+    def processing_partial site
+      'writefully/sites/processing/' + STATE_PARTIAL[site.processing]
+    end
+
+    def healthy_partial site
+      'writefully/sites/healthy/' + STATE_PARTIAL[site.healthy]
+    end
+
+    def site_tab(tab)
+      tab.present? ? tab : 'posts'
+    end
+  end
+end

data/app/models/writefully/authorship.rb

@@ -0,0 +1,34 @@
+module Writefully
+  class Authorship < ActiveRecord::Base
+    belongs_to :user
+
+    has_many :posts
+    has_many :owned_sites, class_name: "Writefully::Site", foreign_key: :owner_id
+
+    store_accessor :data, :name, :email, :uid, :user_name, :auth_token
+
+    def to_s
+      data["name"] || data["login"] || data["email"] || data["uid"]
+    end
+
+    def self.find_by_uid(uid)
+      where("data -> 'uid' = ?", uid.to_s).first
+    end
+
+    def select_role
+      Authorship.count == 0 ? "super_admin" : "collaborator"
+    end
+
+    def self.create_from_data(auth_user)
+      create! do |authorship|
+        authorship.data = { email: auth_user.email,
+                            uid: auth_user.id,
+                            user_name: auth_user.login,
+                            name: auth_user.name,
+                            avatar: auth_user.avatar_url }.select { |k,v| v.present? }
+                            
+        authorship.role = authorship.select_role
+      end 
+    end
+  end
+end

data/app/models/writefully/post.rb

@@ -0,0 +1,23 @@
+module Writefully
+  class Post < ActiveRecord::Base
+    extend FriendlyId
+    include Writefully::Postable
+
+    friendly_id :title, use: :slugged
+
+    has_many :taggings
+    wf_taxonomize :tags, -> { where(type: nil) }, through: :taggings
+
+    belongs_to :authorship
+    belongs_to :translation_source, class_name: "Writefully::Post"
+    belongs_to :site
+
+    has_many :translations, class_name: "Writefully::Post", foreign_key: :translation_source_id
+
+    scope :by_site, -> (site_id) { where(site_id: site_id) }
+
+    def details
+      Hashie::Mash.new(read_attribute(:details))
+    end
+  end
+end

data/app/models/writefully/site.rb

@@ -0,0 +1,30 @@
+module Writefully
+  class Site < ActiveRecord::Base
+    extend FriendlyId
+
+    HOOK_EVENTS = %w(push collaborator)
+
+    friendly_id :name, use: :slugged
+
+    after_save :setup_repository, if: -> { repository.nil? }
+    after_save :clear_errors,     if: -> { healthy_changed? and healthy? }
+
+    belongs_to :owner, class_name: "Writefully::Authorship"
+
+    has_many :posts, -> { order(:position) }
+
+    def setup_repository
+      Writefully.add_job :handyman, { task: :build, auth_token: owner.data["auth_token"], 
+                                                    user_name: owner.data["user_name"],
+                                                    site_id: id, site_slug: slug   }
+    end
+
+    def processing_errors
+      Writefully.redis.with { |c| c.smembers "site:#{self.id}:errors" }
+    end
+
+    def clear_errors
+      Writefully.redis.with { |c| c.del("site:#{self.id}:errors") }
+    end
+  end
+end

data/app/models/writefully/tag.rb

@@ -0,0 +1,15 @@
+module Writefully
+  class Tag < ActiveRecord::Base
+    has_many :taggings
+    has_many :posts, through: :taggings
+
+    class << self 
+      def ids_from_tokens tokens
+        taxon = Taxon.new(tokens, pluck(:name), name)
+
+        import taxon.non_existing
+        where(slug: tokens.map { |t| t.parameterize }).ids
+      end
+    end
+  end
+end

data/app/models/writefully/tagging.rb

@@ -0,0 +1,6 @@
+module Writefully
+  class Tagging < ActiveRecord::Base
+    belongs_to :tag,  class_name: "Writefully::Tag"
+    belongs_to :post, class_name: "Writefully::Post"
+  end
+end

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

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= content_for(:title).present? ? (content_for(:title) + " - Writefully Admin") : "Writefully Admin" %></title>
+  <%= stylesheet_link_tag    "writefully/writefully", media: "all" %>
+  <%= javascript_include_tag "writefully/writefully" %>
+  <%= csrf_meta_tags %>
+</head>
+<body class='writefully <%= controller_name %> <%= action_name %>'>
+<%= render 'navigation' %>
+<div class='container'>
+  <%= yield %>
+</div>
+
+</body>
+</html>

data/app/views/layouts/writefully/sessions.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Owner Setup</title>
+  <%= stylesheet_link_tag    "writefully/writefully", media: "all" %>
+  <%= javascript_include_tag "writefully/writefully" %>
+  <%= csrf_meta_tags %>
+</head>
+<body class='writefully <%= controller_name %> <%= action_name %>'>
+
+<div class='container'>
+  <%= yield %>
+</div>
+
+</body>
+</html>