boar 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 759e561d17ff3e059f0e8f8168de927341984d3dfa4020b403486b17060bc798
+  data.tar.gz: bb5914f410422e6b258634c7399f775061608d09e5503736a1b7cfafbcf336cc
+SHA512:
+  metadata.gz: d5f27c144af8fec2209df0506c8244c3c70d55e221b0955d4a652b8906252df8035882f3f4c3fdbd0c191a3323246ef7f7a445032033db306528e32445dfe59d
+  data.tar.gz: 9ff81b0da89b289602f0ea589ce4a862de2c09bce1e603ceb1d70ee2d8e46d6d749a8426bc13fbcaae44b56d41a1ab38f2e1dfc2e371df2b72ecd42253a1fe26

data/.gitignore

@@ -0,0 +1,7 @@
+Gemfile.lock
+tester.rb
+coverage/
+pkg/
+.idea/
+.yardoc/
+tester/

data/.travis-gemfile

@@ -0,0 +1,13 @@
+# 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.
+#
+
+source "http://rubygems.org"
+
+gemspec
+
+# Testing
+gem "rspec", "~> 2.12.0"
+gem "rake", "~> 10.0.3"

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode
+script: bundle exec rake spec
+gemfile: .travis-gemfile
+notifications:
+  email: false

data/.yardopts

@@ -0,0 +1 @@
+-m markdown

data/Gemfile

@@ -0,0 +1,20 @@
+# 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.
+#
+
+source "http://rubygems.org"
+
+gemspec
+
+# Testing
+gem "rspec", "~> 2.13.0"
+gem "rake", "~> 10.0.3"
+
+# Documentation
+gem "simplecov", ">= 0.7.1"
+gem "pry", ">= 0"
+gem "yard", ">= 0.8.5"
+gem "kramdown", ">= 1.0.1"
+gem "github-markup", ">= 0.7.5"

data/README.md

@@ -0,0 +1,19 @@
+# boar
+
+## END OF DEVELOPMENT NOTICE - This gem has been discontinued
+
+## Contributing to boar
+
+- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+- Fork the project.
+- Start a feature/bugfix branch.
+- Commit and push until you are happy with your contribution.
+- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+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.

data/Rakefile

@@ -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 "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")
+RSpec::Core::RakeTask.new("spec:coverage") { |t| t.ruby_opts = "-r./spec/coverage_helper" }

data/app/controllers/boar/application_controller.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 ApplicationController < ActionController::Base
+    attr_reader :boar_options
+    before_filter :setup_boar_options
+
+    def setup_boar_options
+      @boar_options ||= params.delete(:boar_options)
+    end
+  end
+end

data/app/controllers/boar/downloads_controller.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.
+#
+
+module Boar
+  class DownloadsController < ApplicationController
+    def main
+      Boar::Services::Downloads.new(self).run(:downloads)
+    end
+
+    def update
+      Boar::Services::Downloads.new(self).run(:update)
+    end
+  end
+end

data/app/controllers/boar/pages_controller.rb

@@ -0,0 +1,13 @@
+# 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 PagesController < ApplicationController
+    def main
+      Boar::Services::Pages.new(self).run(:main)
+    end
+  end
+end

data/app/models/boar/handlers/authentication.rb

@@ -0,0 +1,38 @@
+# 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 Handlers
+    class Authentication < Boar::Handlers::Generic
+      def call(*args)
+        # Get path
+        path = args[0]
+
+        if self.required_for?(path) then
+          self.authenticating_for?(path) ? self.authenticate_for(path) : self.request_authentication_for(path)
+        end
+      end
+
+      def required_for?(_ = nil)
+        false # By default we don't require authentication
+      end
+
+      def authenticating_for?(_ = nil)
+        false # By default we're not authentication
+      end
+
+      def request_authentication_for(_ = nil)
+        # Render the view for authentication
+        @service.controller.render(@service.handler_for(:views).call(:authentication))
+      end
+
+      def authenticate_for(_ = nil)
+        # By default we are authenticating
+        true
+      end
+    end
+  end
+end

data/app/models/boar/handlers/downloads/base.rb

@@ -0,0 +1,56 @@
+# 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 Handlers
+    module Downloads
+      class Base < Boar::Handlers::Generic
+        attr_reader :options, :provider_options
+
+        def initialize(service, options)
+          super(service)
+
+          @options = ensure_hash(options)
+
+          # Get the configuration for the provider
+          @provider_options = ensure_hash(@options[:providers]).fetch(self.class_key, {}).deep_symbolize_keys
+        end
+
+        # TODO: Create something Elephas.use for the remote implementations
+        def call(_, _, _, _)
+          raise Boar::Exceptions::UnImplemented.new
+        end
+
+        def class_key
+          self.class.name.demodulize.underscore
+        end
+
+        def load_credentials
+          self.credentials_params[:single]
+        end
+
+        def credentials_params
+          host = @service.handler_for(:hosts).call(@service.controller.request)
+          path = self.interpolate(@configuration.credentials_file, {root: Rails.root, request: @service.controller.request, controller: @service.controller})
+          all = YAML.load_file(path)
+          name = self.class_key
+
+          {single: HashWithIndifferentAccess.new(all.fetch(host).fetch(name)), path: path, all: all, host: host, provider: self, name: name }
+        end
+
+        def update_credentials(credentials, params = nil)
+          params ||= self.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 finalize_path(path, match_data)
+          path.gsub(/\\(\d+)/) { |m| match_data[$1.to_i] }
+        end
+      end
+    end
+  end
+end

data/app/models/boar/handlers/downloads/box_net.rb

@@ -0,0 +1,67 @@
+# 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 Handlers
+    module Downloads
+      class BoxNet < Base
+        def initialize(service, options)
+          super(service, options)
+          configuration = self.load_credentials
+
+          # Open the session and refresh the token
+          @session = RubyBox::Session.new({client_id: configuration[:client_id], client_secret: configuration[:client_secret], access_token: configuration[:access_token]})
+          token = @session.refresh_token(configuration[:refresh_token])
+
+          # Save the token and schedule an update to avoid expiration
+          self.update_credentials({access_token: token.token, refresh_token: token.refresh_token})
+          # TODO: Reschedule token refreshing after 13 days
+
+          @client = RubyBox::Client.new(@session)
+        end
+
+        def call(path, entry, skip_cache, _, _)
+          # Read the URL from Redis
+          key = @configuration.backend_key("downloads:box_net[#{path}]", self, @service.controller.request)
+          url = @configuration.backend.get(key)
+
+          if skip_cache || url.blank? then
+            begin
+              # Get the file
+              file = @client.file(entry[:path])
+              raise Boar::Exceptions::NotFound if file.nil?
+
+              # Create the shared link
+              shared_link = create_shared_link(file)
+              raise Boar::Exceptions::NotFound if shared_link.nil?
+              url = entry["disposition"] == "inline" ? shared_link["url"] : shared_link["download_url"]
+
+              # Save the URL
+              @configuration.backend.set(key, url) if url.present?
+            rescue => e
+              raise Boar::Exceptions::ServerError.new("[#{e.class}] #{e.message}")
+            end
+          end
+
+          # Redirect to the final URL
+          @service.controller.redirect_to(url)
+        end
+
+        private
+          def create_shared_link(file)
+            begin
+              api_uri = URI.parse("#{RubyBox::API_URL}/files/#{file.id}")
+              request = Net::HTTP::Put.new(api_uri.path, {"Content-Type" => 'application/json'})
+              request.body = JSON.dump({shared_link: {access: "open"}})
+              @session.request(api_uri, request).fetch("shared_link")
+            rescue
+              nil
+            end
+          end
+      end
+    end
+  end
+end

data/app/models/boar/handlers/downloads/dropbox.rb

@@ -0,0 +1,59 @@
+# 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 Handlers
+    module Downloads
+      class Dropbox < Base
+        def initialize(service, options)
+          super(service, options)
+
+          @session = ::DropboxSession.deserialize(load_credentials[:session])
+          @root = @provider_options.fetch(:root, "dropbox").to_sym
+          @client = ::DropboxClient.new(@session, @root)
+        end
+
+        def call(path, entry, skip_cache, _, _)
+          # Read the URL from Redis
+          key = @configuration.backend_key("downloads:dropbox[#{path}]", self, @service.controller.request)
+          url = @configuration.backend.get(key)
+
+          if skip_cache || url.blank? then
+            begin
+              attachment = entry[:disposition] != "inline"
+              share =  attachment ? self.direct_shares(entry[:path]) : @client.shares(entry[:path])
+
+              url = share["url"] + (attachment ? "?dl=1" : "")
+              expire = DateTime.parse(share["expires"], "%a, %d %b %Y %T %Z")
+
+              # Save the URL
+              if url.present? then
+                @configuration.backend.set(key, url)
+                @configuration.backend.expire(key, expire.to_i)
+              end
+            rescue => e
+              if e.message =~ /Path .+ not found/ then
+                raise Boar::Exceptions::NotFound.new(path)
+              else
+                raise e
+                raise Boar::Exceptions::ServerError.new("[#{e.class}] #{e.message}")
+              end
+            end
+          end
+
+          # Redirect to the final URL
+          @service.controller.redirect_to(url)
+        end
+
+        def direct_shares(path)
+          # Get the public URL - We don't use Dropbox shares method directly because we have to pass a parameter
+          response = @session.do_get@client.build_url("/shares/#{@root}#{@client.format_path(path)}?short_url=false")
+          @client.parse_response(response)
+        end
+      end
+    end
+  end
+end

data/app/models/boar/handlers/downloads/google_drive.rb

@@ -0,0 +1,48 @@
+# 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 Handlers
+    module Downloads
+      class GoogleDrive < Base
+        def initialize(service, options)
+          super(service, options)
+          configuration = self.load_credentials
+          @client = Boar::Providers::GoogleDrive.authorized_client(configuration)
+          @api = @client.discovered_api('drive', 'v2')
+        end
+
+        def call(path, entry, skip_cache, _, _)
+          # Read the URL from Redis
+          key = @configuration.backend_key("downloads:google_drive[#{path}]", self, @service.controller.request)
+          url = @configuration.backend.get(key)
+
+          if skip_cache || url.blank? then
+            begin
+              # Get the file
+              result = @client.execute(api_method: @api.files.get, parameters: {"fileId" => entry[:id]})
+              raise Boar::Exceptions::NotFound if result.status == 404
+
+              # Get the share link
+              file = result.data
+              url = file.web_content_link || file.alternate_link
+              url = file.alternate_link if entry["disposition"] == "inline"
+              raise Boar::Exceptions::NotFound if url.blank?
+
+              # Save the URL
+              @configuration.backend.set(key, url) if url.present?
+            rescue => e
+              raise Boar::Exceptions::ServerError.new("[#{e.class}] #{e.message}")
+            end
+          end
+
+          # Redirect to the final URL
+          @service.controller.redirect_to(url)
+        end
+      end
+    end
+  end
+end

data/app/models/boar/handlers/downloads/local.rb

@@ -0,0 +1,34 @@
+# 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 Handlers
+    module Downloads
+      class Local < Base
+        def initialize(service, options)
+          super(service, options)
+
+          # Normalize the root
+          @root = self.get_option(options, :directory, Rails.application.config.boar.downloads_directory)
+          @root = self.interpolate(@root, {root: Rails.root, request: @service.controller.request, controller: @controller})
+        end
+
+        def call(path, entry, _, _, _)
+          # Get the full path
+          file = Pathname.new(@root) + path
+          raise Boar::Exceptions::NotFound.new(path) if !file.exist?
+
+          # Check MIME and whether the disposition is inline or not
+          type = MIME::Types.type_for(file.to_s).first.content_type
+          disposition = (entry[:disposition].ensure_string == "inline") ? "inline" : "attachment"
+
+          # Serve the file
+          @service.download_file(file, disposition: disposition, type: type)
+        end
+      end
+    end
+  end
+end