boar 1.0.1

data/lib/boar/providers/sky_drive.rb

@@ -0,0 +1,80 @@
+# 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 SkyDrive < Base
+      SCOPES = "wl.skydrive_update,wl.offline_access"
+
+      def redirect_for_authentication(authorizer, configuration)
+        authorizer.ip = configuration[:domain]
+
+        @client = Boar::Providers::SkyDrive.client(configuration, authorizer.callback_url)
+        @client.authorize_url
+      end
+
+      def get_credentials(authorizer, request, response)
+        begin
+          raise Clavem::Exceptions::AuthorizationDenied if request.query["error"].present? || request.query["code"].blank?
+          token = @client.get_access_token(request.query["code"])
+          {access_token: token.token, refresh_token: token.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::SkyDrive.authorized_client(params[:single], params)
+
+        # Find the last folder
+        current = client.my_skydrive
+        tree.each do |folder|
+          current = search_entry(current, folder, true)
+          break if !current
+        end
+
+        # We have the container, query for the file
+        rv = search_entry(current, filename) if current
+        rv ? {"id" => rv.id} : nil
+      end
+
+      def self.client(configuration, callback_url = nil)
+        ::Skydrive::Oauth::Client.new(configuration[:client_id], configuration[:client_secret], callback_url, Boar::Providers::SkyDrive::SCOPES)
+      end
+
+      def self.authorized_client(configuration, params)
+        # Get a new access token
+        token = Boar::Providers::SkyDrive.client(configuration).get_access_token_from_hash(configuration[:access_token], {:refresh_token => configuration[:refresh_token]})
+        params[:provider].update_credentials({access_token: token.token, refresh_token: token.refresh_token}, params)
+
+        # Create the client
+        Skydrive::Client.new(token)
+      end
+
+      private
+        def search_entry(parent, entry, directory = false)
+          catch(:entry) do
+            parent.files.items.each do |file|
+              if file.name == entry && (file.is_a?(Skydrive::File) || directory)
+                file.instance_variable_set("@client", parent.client) # This is to fix a gem's bug.
+                throw(:entry, file)
+              end
+            end
+
+            nil
+          end
+        end
+    end
+  end
+end

data/lib/boar/router.rb

@@ -0,0 +1,68 @@
+# 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 ActionDispatch::Routing
+  class Mapper
+    def boar_mount_pages(*args)
+      Boar::Router.mount_pages(self, *args)
+    end
+
+    def boar_mount_downloads(*args)
+      Boar::Router.mount_downloads(self, *args)
+    end
+  end
+end
+
+module Boar
+  class Router
+    def self.mount_pages(router, *args)
+      options = args.extract_options!
+      config = Rails.application.config.boar
+
+      root = get_option(options, :root, config.pages_root)
+      root += "/" if root.present? && root !~ /\/$/
+      locale_param = get_option(options, :locale_param, config.locale_param).to_sym
+      default_locale = get_option(options, :default_locale, config.default_locale).to_sym
+      locale_regexp = get_option(options, :locale_regexp, config.locale_regexp)
+      route_options = get_option(options, :route_options, {}).deep_symbolize_keys
+
+      router.scope(module: :boar) do
+        router.scope("(#{locale_param.inspect})", defaults: {locale_param => default_locale}, constraints: {locale_param => locale_regexp}) do
+          yield(router, options) if block_given?
+          router.match("#{root}(*path)", route_controller(options, "pages#main").merge({via: :get, boar_options: options}).merge(route_options))
+        end
+      end
+    end
+
+    def self.mount_downloads(router, *args)
+      options = args.extract_options!
+      config = Rails.application.config.boar
+
+      root = get_option(options, :root, config.downloads_root)
+      root += "/" if root.present? && root !~ /\/$/
+      route_options = get_option(options, :route_options, {}).deep_symbolize_keys
+
+      router.scope(module: :boar) do
+        yield(router, options) if block_given?
+        router.match("#{root}", {controller: options.fetch(:controller, "downloads"), action: :update, via: :put, boar_options: options}.merge(route_options))
+        router.match("#{root}(*path)", route_controller(options, "downloads#main").merge({via: :get, constraints: {path: /.+/}, boar_options: options}).merge(route_options))
+      end
+    end
+
+    private
+      def self.route_controller(options, default)
+        options[:controller] ? {controller: options[:controller], action: options[:action].ensure_string || :index} : {to: default}
+      end
+
+      def self.get_option(options, key, default = nil)
+        begin
+          options.symbolize_keys.fetch(key.to_sym)
+        rescue Exception => _
+          block_given? ? yield(key) : default
+        end
+      end
+  end
+end

data/lib/boar/version.rb

@@ -0,0 +1,25 @@
+# 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.
+#
+
+# A Rails engine to handle local static pages and downloads on the cloud.
+module Boar
+  # The current version of boar, according to semantic versioning.
+  #
+  # @see http://semver.org
+  module Version
+    # The major version.
+    MAJOR = 1
+
+    # The minor version.
+    MINOR = 0
+
+    # The patch version.
+    PATCH = 1
+
+    # The current version of boar.
+    STRING = [MAJOR, MINOR, PATCH].compact.join(".")
+  end
+end

data/lib/tasks/boar.rake

@@ -0,0 +1,102 @@
+# 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: Rename param here and everywhere else as credentials where appropriate. Could you move them to a class?
+
+namespace :boar do
+  def setup(args)
+    # Get parameters
+    provider_name = args[:provider].ensure_string
+    host = args[:host].present? ? args[:host].to_s : "localhost"
+    configuration_path = Mustache.render(args[:file].blank? ? Rails.application.config.boar.credentials_file : args[:file], {root: Rails.root})
+    all_configurations = nil
+    configuration = nil
+    provider = nil
+
+    # Find the service
+    begin
+      provider = Lazier.find_class(provider_name, "Boar::Providers::%CLASS%", true).new
+    rescue
+      valids = Boar::Providers.constants.collect {|c| c != :Base && Boar::Providers.const_get(c).is_a?(Class) ? c.to_s : nil }.compact
+      raise RuntimeError.new((provider_name.present? ? "Invalid provider #{provider_name}." : "No provider specified.") + " Valid providers are: #{valids.join(", ")}.")
+    end
+
+    # Open the configuration for the provider
+    begin
+      all_configurations = YAML.load_file(configuration_path)
+
+      # Get host specific configuration
+      configuration = HashWithIndifferentAccess.new(all_configurations[host][provider_name])
+      raise ArgumentError if !configuration.is_a?(Hash)
+    rescue
+      raise RuntimeError.new("Configuration for service #{provider_name.classify} on host #{host} not valid or not found.")
+    end
+
+    {path: configuration_path, all: all_configurations, single: configuration, host: host, provider: provider, name: provider_name}
+  end
+
+  desc "Updates credentials for a service"
+  task :update_credentials, [:provider, :host, :file] => :environment do |_, args|
+    params = setup(args)
+
+    configuration = params[:single]
+    provider = params[:provider]
+    provider_name = params[:name]
+    credentials = nil
+
+    # Authorize provider
+    begin
+      authorizer = Clavem::Authorizer.new(configuration.fetch(:authorizer_host, "localhost"), configuration.fetch(:authorizer_port, "2501")) do |auth, req, res|
+        credentials = provider.get_credentials(auth, req, res)
+      end
+
+      # Get the redirection URL
+      url = provider.redirect_for_authentication(authorizer, configuration)
+
+      # Redirect and fetch new credentials to merge to the old configuration
+      authorizer.authorize(url)
+    rescue => e
+      raise e
+      raise case e.class.to_s
+        when "ArgumentError" then e
+        when "AuthorizationDenied" then Clavem::Exceptions::AuthorizationDenied.new("Authorization denied for provider #{provider_name.classify}.")
+        else RuntimeError.new("Authorization failed for provider #{provider_name.classify}.")
+      end
+    end
+
+    # Update the file
+    begin
+      params[:provider].update_credentials(credentials, params)
+    rescue
+      raise RuntimeError.new("Cannot update configuration file #{params[:path]}.")
+    end
+  end
+
+  desc "Search required information for sharing a file"
+  task :search_file, [:path, :provider, :file] => :environment do |_, args|
+    params = setup(args)
+    path = args[:path]
+    name = params[:name]
+    info = nil
+
+    raise "Please specify a path." if path.blank?
+    begin
+      info = params[:provider].search_file(path, params)
+    rescue => e
+      raise e
+      raise RuntimeError.new("Cannot find file #{path} on #{params[:name]}.")
+    end
+
+    if info.nil? then
+      puts "File #{path} on #{name.classify} doesn't exists."
+    elsif !info then
+      puts "To share on provider #{name.classify} use the path itself."
+    else
+      puts "The required information to share #{path} via #{name.classify} are:\n"
+      puts "  " + info.to_yaml.gsub(/^---/, "").gsub("\n", "\n  ")
+    end
+  end
+end

data/spec/boar/controllers/application_controller_spec.rb

@@ -0,0 +1,11 @@
+# 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 "spec_helper"
+
+describe Boar::ApplicationController do
+
+end

data/spec/boar/controllers/pages_controller_spec.rb

@@ -0,0 +1,11 @@
+# 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 "spec_helper"
+
+describe Boar::PagesController do
+
+end

data/spec/boar/routes_spec.rb

@@ -0,0 +1,11 @@
+# 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 "spec_helper"
+
+describe Boar::Router do
+
+end

data/spec/boar_spec.rb

@@ -0,0 +1,7 @@
+# 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 "spec_helper"

data/spec/coverage_helper.rb

@@ -0,0 +1,17 @@
+# 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 "pathname"
+require "simplecov"  
+
+SimpleCov.start do
+  root = Pathname.new(File.dirname(__FILE__)) + ".."
+
+  add_filter do |src_file|
+    path = Pathname.new(src_file.filename).relative_path_from(root).to_s
+    path !~ /\.rb$/ || path !~ /^(app|bin|lib)/
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# 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 "rubygems"
+require "bundler/setup"
+require "boar"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,264 @@
+--- !ruby/object:Gem::Specification
+name: boar
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Shogun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.99.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.99.4
+- !ruby/object:Gem::Dependency
+  name: mbrao
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.10
+- !ruby/object:Gem::Dependency
+  name: elephas
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: clavem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: dropbox-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.5
+- !ruby/object:Gem::Dependency
+  name: ruby-box
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: skydrive
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: A Rails engine to handle local static pages and downloads on the cloud.
+email:
+- shogun_panda@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis-gemfile"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- README.md
+- Rakefile
+- app/controllers/boar/application_controller.rb
+- app/controllers/boar/downloads_controller.rb
+- app/controllers/boar/pages_controller.rb
+- app/models/boar/handlers/authentication.rb
+- app/models/boar/handlers/downloads/base.rb
+- app/models/boar/handlers/downloads/box_net.rb
+- app/models/boar/handlers/downloads/dropbox.rb
+- app/models/boar/handlers/downloads/google_drive.rb
+- app/models/boar/handlers/downloads/local.rb
+- app/models/boar/handlers/downloads/remote.rb
+- app/models/boar/handlers/downloads/s3.rb
+- app/models/boar/handlers/downloads/sky_drive.rb
+- app/models/boar/handlers/generic.rb
+- app/models/boar/handlers/hosts.rb
+- app/models/boar/handlers/locale.rb
+- app/models/boar/handlers/path_mapper.rb
+- app/models/boar/handlers/root.rb
+- app/models/boar/handlers/views.rb
+- app/models/boar/services/downloads.rb
+- app/models/boar/services/generic.rb
+- app/models/boar/services/pages.rb
+- app/models/boar/utils/basic.rb
+- boar.gemspec
+- lib/boar.rb
+- lib/boar/configuration.rb
+- lib/boar/engine.rb
+- lib/boar/exceptions.rb
+- lib/boar/providers/base.rb
+- lib/boar/providers/box_net.rb
+- lib/boar/providers/dropbox.rb
+- lib/boar/providers/google_drive.rb
+- lib/boar/providers/sky_drive.rb
+- lib/boar/router.rb
+- lib/boar/version.rb
+- lib/tasks/boar.rake
+- spec/boar/controllers/application_controller_spec.rb
+- spec/boar/controllers/pages_controller_spec.rb
+- spec/boar/routes_spec.rb
+- spec/boar_spec.rb
+- spec/coverage_helper.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ShogunPanda/boar
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A Rails engine to handle local static pages and downloads on the cloud.
+test_files:
+- spec/boar/controllers/application_controller_spec.rb
+- spec/boar/controllers/pages_controller_spec.rb
+- spec/boar/routes_spec.rb
+- spec/boar_spec.rb
+- spec/coverage_helper.rb
+- spec/spec_helper.rb