boar 1.0.1

data/app/models/boar/services/pages.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+#
+# This file is part of the boar gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+module Boar
+  module Services
+    class Pages < Boar::Services::Generic
+      def main
+        # Get the path
+        path = @controller.params[:path]
+
+        # Map the path
+        path = self.handler_for(:pages_mapper, options).call(self, path)
+
+        # Handle ACL for the path
+        self.handle_authentication(path, @options)
+
+        @controller.render(file: search_page(path)) if !@controller.performed?
+      end
+
+      private
+        def search_page(path, partial = false, options = nil)
+          # Setup path and options
+          path = "index" if path.blank?
+          options ||= @options
+
+          # Get the template file
+          template = (self.handler_for(:root, options).call + path).to_s
+
+          begin
+            perform_search(template, partial, options)
+
+            # We return the template if search didn't fail, which means that the #render method will success.
+            template
+          rescue ActionView::MissingTemplate
+            raise Boar::Exceptions::NotFound.new(template)
+          end
+        end
+
+        def perform_search(template, partial, options)
+          # Get the context
+          context = @controller.view_renderer.lookup_context
+
+          # Setup the locale
+          context.locale = options[:add_locale] ? current_locale(options) : nil
+
+          # Perform the search
+          context.with_fallbacks { context.find_template(template, nil, partial, [], {}) }
+        end
+
+        def current_root(options = nil)
+          self.handler_for(:root, options).call
+        end
+
+        def current_locale(options = nil)
+          self.handler_for(:locale, options).call
+        end
+    end
+  end
+end

data/app/models/boar/utils/basic.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+#
+# This file is part of the boar gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+module Boar
+  module Utils
+    module Basic
+      def ensure_hash(obj, default = {})
+        HashWithIndifferentAccess.new(obj.is_a?(Hash) ? obj : default)
+      end
+
+      def get_option(options, key, default = nil)
+        begin
+          options.symbolize_keys.fetch(key.to_sym)
+        rescue Exception => _
+          block_given? ? yield(key) : default
+        end
+      end
+
+      def interpolate(template, args)
+        Mustache.render(template, args)
+      end
+    end
+  end
+end

data/boar.gemspec

@@ -0,0 +1,41 @@
+# encoding: utf-8
+#
+# This file is part of the boar gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require File.expand_path('../lib/boar/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = "boar"
+  gem.version = Boar::Version::STRING
+  gem.homepage = "http://github.com/ShogunPanda/boar"
+  gem.summary = "A Rails engine to handle local static pages and downloads on the cloud."
+  gem.description = "A Rails engine to handle local static pages and downloads on the cloud."
+  gem.rubyforge_project = "boar"
+
+  gem.authors = ["Shogun"]
+  gem.email = ["shogun_panda@me.com"]
+
+  gem.files = `git ls-files`.split($\)
+  gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = ">= 1.9.3"
+
+  gem.add_dependency("rails", ">= 3.2.12")
+  gem.add_dependency("mustache", "~> 0.99.4")
+  gem.add_dependency("mbrao", "~> 1.1.1")
+  gem.add_dependency("redis", "~> 3.0.3")
+  gem.add_dependency("oj", "~> 2.0.10")
+  gem.add_dependency("elephas", "~> 3.0.0")
+  gem.add_dependency("clavem", "~> 1.2.2")
+
+  # Downloads gem
+  gem.add_dependency("dropbox-sdk", "~> 1.5.1")
+  gem.add_dependency("google-api-client", "~> 0.6.3")
+  gem.add_dependency("aws-sdk", "~> 1.9.5")
+  gem.add_dependency("ruby-box", "~> 1.2.0")
+  gem.add_dependency("skydrive", "~> 0.1.0")
+end

data/lib/boar.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+#
+# This file is part of the boar gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+# TODO: Simplify code in ALL classes.
+# TODO: Rename #call to #perform everywhere.
+
+require "mbrao"
+require "mustache"
+require "mime-types"
+require "redis"
+require "oj"
+require "clavem"
+require "dropbox_sdk"
+require "google/api_client"
+require "aws-sdk"
+require "ruby-box"
+require "skydrive"
+
+require "boar/version" if !defined?(Boar::Version)
+require "boar/configuration"
+require "boar/router"
+require "boar/engine"
+require "boar/exceptions"
+require "boar/providers/base"
+require "boar/providers/dropbox"
+require "boar/providers/google_drive"
+require "boar/providers/box_net"
+require "boar/providers/sky_drive"

data/lib/boar/configuration.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+#
+# This file is part of the boar gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+# TODO: Embed the specific configuration here, and then use a get("key.subkey") interface
+# TODO: Reorganize all options
+
+module Boar
+  class Configuration
+    def initialize(app)
+      @data = {
+        app: app,
+        backend: Redis.new,
+        skip_cache_param: "sc",
+        handlers: {
+          root: Boar::Handlers::Root,
+          authentication: Boar::Handlers::Authentication,
+          locale: Boar::Handlers::Locale,
+          views: Boar::Handlers::Views,
+          hosts: Boar::Handlers::Hosts
+        }
+      }
+
+      initialize_pages()
+      initialize_downloads()
+    end
+
+    def backend_key(key, _, request)
+      host = self.handlers[:hosts].new.call(request)
+      "boar[#{host}]:#{key}"
+    end
+
+    def method_missing(method, *args, &block)
+      key = method.to_sym
+
+      if @data.has_key?(key) then
+        rv = @data[key]
+        rv = HashWithIndifferentAccess.new(rv) if rv.is_a?(Hash)
+        rv
+      else
+        super
+      end
+    end
+
+    private
+      def initialize_pages
+        @data.merge!({
+          pages_root: "",
+          pages_directory: "{{root}}/app/pages",
+          locale_param: :locale,
+          add_locale: true,
+          default_locale: @data[:app].config.i18n.default_locale || "en",
+          locale_regexp: /[a-z]{2}((_([a-zA-Z]{2}))?)/,
+          views: {
+            authentication: "authentication",
+            error: "errors/{{code}}"
+          }
+        })
+
+        @data[:handlers].merge!({pages_mapper: Boar::Handlers::PathMapper})
+      end
+
+      def initialize_downloads
+        @data.merge!({
+          downloads_root: "downloads",
+          downloads_directory: "{{root}}/files",
+          config_file: "{{root}}/config/downloads.yml",
+          credentials_file: "{{root}}/config/credentials.yml",
+          default_provider: :local
+        })
+
+        @data[:handlers].merge!({downloads_mapper: Boar::Handlers::PathMapper})
+      end
+  end
+end

data/lib/boar/engine.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+#
+# This file is part of the boar gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+module Boar
+  class Engine < ::Rails::Engine
+    isolate_namespace Boar
+    mattr_accessor :backend
+
+    initializer "boar.configuration" do |app|
+      app.config.boar = Boar::Configuration.new(app)
+    end
+  end
+end

data/lib/boar/exceptions.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+#
+# This file is part of the boar gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+module Boar
+  module Exceptions
+    class Error < ::Exception
+      attr_reader :code
+
+      def initialize(code, message = nil)
+        super(message)
+        @code = code
+      end
+
+      def self.must_raise?(exception)
+        exception.is_a?(Lazier::Exceptions::Dump) && Rails.env.development?
+      end
+    end
+
+    class ServerError < Error
+      def initialize(message)
+        super(500, message)
+      end
+    end
+
+    class UnImplemented < Error
+      def initialize(message = nil)
+        super(501, message)
+      end
+    end
+
+    class AuthorizationFailed < Error
+      def initialize(message = nil)
+        super(403, message)
+      end
+    end
+
+    class NotFound < Error
+      def initialize(message = nil)
+        super(404, message)
+      end
+    end
+  end
+end

data/lib/boar/providers/base.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+#
+# This file is part of the boar gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+module Boar
+  module Providers
+    class Base
+      def redirect_for_authentication(_, _)
+        raise Boar::Exceptions::UnImplemented
+      end
+
+      def get_credentials(_, _, _)
+        raise Boar::Exceptions::UnImplemented
+      end
+
+      def update_credentials(credentials, params)
+        params[:all][params[:host]][params[:name]] = params[:single].merge(credentials).to_hash
+        open(params[:path], "w") {|f| f.write(params[:all].to_yaml) }
+      end
+
+      def search_file(_, _)
+        false
+      end
+    end
+  end
+end

data/lib/boar/providers/box_net.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+#
+# This file is part of the boar gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+module Boar
+  module Providers
+    class BoxNet < Base
+      def redirect_for_authentication(authorizer, configuration)
+        @session = RubyBox::Session.new({client_id: configuration[:client_id], client_secret: configuration[:client_secret]})
+        @session.authorize_url(authorizer.callback_url)
+      end
+
+      def get_credentials(authorizer, request, response)
+        begin
+          raise Clavem::Exceptions::AuthorizationDenied if request.query["error"].present?
+
+          token = @session.get_access_token(request.query["code"])
+          {access_token: token.token, refresh_token: token.refresh_token}
+        rescue RuntimeError
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/boar/providers/dropbox.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+#
+# This file is part of the boar gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+module Boar
+  module Providers
+    class Dropbox < Base
+      def redirect_for_authentication(authorizer, configuration)
+        @session = DropboxSession.new(configuration[:app_key], configuration[:app_secret])
+        @session.get_request_token
+        @session.get_authorize_url + "&oauth_callback=#{authorizer.callback_url}"
+      end
+
+      def get_credentials(authorizer, request, response)
+        begin
+          @session.get_access_token
+          {session: @session.serialize}
+        rescue DropboxAuthError
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/boar/providers/google_drive.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+#
+# This file is part of the boar gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+module Boar
+  module Providers
+    class GoogleDrive < Base
+      NAME = "boar"
+      VERSION = "1.0.0"
+      SCOPES = ["https://www.googleapis.com/auth/drive"]
+
+      def self.client(configuration)
+        rv = Google::APIClient.new(authorization: :oauth_2, application_name: Boar::Providers::GoogleDrive::NAME, application_version: Boar::Providers::GoogleDrive::VERSION)
+        rv.authorization.client_id = configuration[:client_id]
+        rv.authorization.client_secret = configuration[:client_secret]
+        rv.authorization.scope = Boar::Providers::GoogleDrive::SCOPES
+        rv
+      end
+
+      def self.authorized_client(configuration)
+        authorizer = Clavem::Authorizer.new(configuration.fetch(:authorizer_host, "localhost"), configuration.fetch(:authorizer_port, "2501"))
+
+        client = Boar::Providers::GoogleDrive.client(configuration)
+        client.authorization.redirect_uri = authorizer.callback_url
+        client.authorization.refresh_token = configuration["token"]
+        client.authorization.fetch_access_token!
+
+        client
+      end
+
+      def redirect_for_authentication(authorizer, configuration)
+        @client = Boar::Providers::GoogleDrive.client(configuration)
+        @client.authorization.redirect_uri = authorizer.callback_url
+        @client.authorization.authorization_uri
+      end
+
+      def get_credentials(authorizer, request, response)
+        begin
+          raise Clavem::Exceptions::AuthorizationDenied if request.query["error"].present? || request.query["code"].blank?
+
+          @client.authorization.code = request.query["code"].to_s
+          @client.authorization.fetch_access_token!
+          {token: @client.authorization.refresh_token}
+        rescue RuntimeError
+          nil
+        end
+      end
+
+      def search_file(path, params)
+        rv = nil
+
+        # Split path
+        Lazier.load_pathname
+        filename = File.basename(path)
+        tree = Pathname.new(File.dirname(path)).components
+
+        # Initialize client
+        client = Boar::Providers::GoogleDrive.authorized_client(params[:single])
+        api = client.discovered_api('drive', 'v2')
+
+        # Find the last folder
+        parent = "root"
+        tree.each do |folder|
+          list = client.execute(api_method: api.children.list, parameters: {"folderId" => parent, "q" => "title='#{folder}'", "maxResults" => 1})
+          parent = validate_file_entry(list)
+          break if !parent
+        end
+
+        # We have the container, query for the file
+        if parent then
+          list = client.execute(api_method: api.files.list, parameters: {"folderId" => parent, "q" => "title='#{filename}'", "maxResults" => 1})
+          rv = validate_file_entry(list)
+        end
+
+        rv ? {"id" => rv} : nil
+      end
+
+      private
+        def validate_file_entry(results)
+          items = results.data.items
+          items.present? ? items[0]["id"] : nil
+        end
+    end
+  end
+end