jekyll-deploy-oss 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e93226cf9566e0352ab94c0fc37e2cdaf181e5d1e8fe89691af802364879f7ed
+  data.tar.gz: ed92b6c6627938ea599ea27efd441d69fec60b7d240cf875badfea0fe6bda492
+SHA512:
+  metadata.gz: 3d3d29dff2622f1b91e15cf6c475ba31a7a23e88903165be92383830bbbbd961a82c63d30ee7b7378bb4987a8e38744b1f255379852102dfbb5bcd1cdcbbdc34
+  data.tar.gz: 4739ccd6e13cb34b4f4743087e40dfcc1161b2bcd87821c092fc6ae939e0fae858af4e4d6b045512be53d990a6fd87ee356caa9ca90f31a908e156fe770a11b9

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Sharon Zhang
+
+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 @@
+# jekyll-deploy-oss

data/_config.yml

@@ -0,0 +1,5 @@
+deploy:
+  endpoint: ""
+  bucket_name: ""
+  skip_exist: false
+  expired_in: 3650

data/jekyll-deploy-oss.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-deploy-oss"
+  spec.version       = "0.1.0"
+  spec.authors       = ["erlzhang"]
+  spec.email         = ["zhangshiyu1992@hotmail.com"]
+  spec.summary       = "Deploy your Jekyll site to Aliyun OSS."
+  spec.description   = "Deploy your Jekyll site to Aliyun OSS."
+  spec.homepage      = "https://github.com/erlzhang/jekyll-deploy-oss"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.add_dependency "jekyll", ">= 3.7", "< 5.0"
+
+  spec.add_runtime_dependency "aliyun-sdk", "~> 0.7"
+end

data/lib/jekyll-deploy-oss.rb

@@ -0,0 +1,84 @@
+require_relative "./oss/deploy.rb"
+
+class JekyllDeployOss < Jekyll::Command
+  class << self
+    def init_with_program(prog)
+      prog.command(:deploy) do |c|
+        c.syntax "deploy [options]"
+        c.description 'Deploy Jekyll site to Aliyun OSS.'
+        c.alias :d
+
+        add_options(c)
+
+        c.action do |args, options|
+          deploy_site(options)
+        end
+      end
+    end
+
+    def deploy_site(options)
+      options = Jekyll.configuration({
+        :deploy => options.merge!(ENV)
+      })
+
+      params = options["deploy"]
+      return unless validate_options(params)
+
+      remote_path = Proc.new do |path|
+        object = path.sub(options["destination"], "")
+        object[0] === "/" ? object.sub("/", "") : object
+      end
+
+      paths = get_paths(options)
+      Deploy.new(params).upload(paths, remote_path)
+    end
+
+    def get_paths(options)
+      dir = options["destination"]
+      params = options["deploy"]
+      paths = []
+      if params["paths"]
+        params["paths"].each do |path|
+          paths << File.join(dir, path)
+        end
+      else
+        paths << dir
+      end
+      paths
+    end
+
+    def add_options(cmd)
+      cmd.option "destination", "-d", "--destination DESTINATION",
+                 "The files in DESTINATION will be uploaded."
+      cmd.option "OSS_ID", "--id OSS_ID"
+      cmd.option "OSS_SECRET", "--secret OSS_SECRET"
+      cmd.option "endpoint", "--endpoint ENDPOINT"
+      cmd.option "bucket_name", "--bucket BUCKET"
+      cmd.option "paths", "--paths PATH[,PATH2,...]",
+                 Array, "The specific files(or folders) will be uploaded."
+      cmd.option "skip_exist", "--skipped", "Skip the exisiting files."
+      cmd.option "expired_in", "--expired DAYS", Integer,
+                 "Set the files caches expireds in DAYS days."
+    end
+
+    def required_options
+      ["OSS_ID", "OSS_SECRET", "endpoint", "bucket_name"]
+    end
+
+    def validate_options(options)
+      unless options
+        Jekyll.logger.error "ERROR:", "Missing deploy configs!"
+        return false
+      end
+
+      required_options.each do |key|
+        unless options[key]
+          Jekyll.logger.error "ERROR:", "#{key} is required to build!"
+          return false
+        end
+      end
+
+      true
+    end
+  end
+end

data/lib/oss/deploy.rb

@@ -0,0 +1,82 @@
+require 'aliyun/oss'
+require 'find'
+require 'date'
+require 'jekyll'
+
+class Deploy
+  attr_reader :access_key_id, :access_key_secret, :endpoint, :bucket_name, :expired_in, :skip_exist
+
+  def initialize(params = {})
+    @access_key_id     = params["OSS_ID"]
+    @access_key_secret = params["OSS_SECRET"]
+    @endpoint          = params["endpoint"]
+    @bucket_name       = params["bucket_name"]
+    @expired_in        = params["expired_in"] || 365
+    @skip_exist        = params["skip_exist"]
+  end
+
+  def client
+    @client ||= Aliyun::OSS::Client.new(
+      endpoint: endpoint,
+      access_key_id: access_key_id,
+      access_key_secret: access_key_secret
+    )
+  end
+
+  def bucket
+    @bucket ||= client.get_bucket(bucket_name)
+  end
+
+  # 文件列表
+  def objects
+    bucket.list_objects
+  end
+
+  def remote_objects
+    objects.map(&:key)
+  end
+
+  def local_objects(paths)
+    files = []
+    paths.each do |path|
+      if File.file?(path)
+        files << path
+      elsif File.directory?(path)
+        Find.find(path) do |file|
+          files << file if File.file?(file)
+        end
+      end
+    end
+    files.compact
+  end
+
+  def upload(paths, remote_path)
+    objects = local_objects(paths)
+    objects.each do |object|
+      remote = remote_path.call(object)
+      if skip_exist and remote_objects.include?(remote)
+        Jekyll.logger.info "Skip exist file: #{remote}"
+        next
+      end
+      Jekyll.logger.info "Upload file: #{remote}"
+      bucket.put_object(
+        remote,
+        :file => object,
+        :headers => {
+          "Cache-Control": cache_control,
+          "Expires": expires
+        }
+      )
+    end
+  end
+
+  def cache_control
+    max_age = expired_in.to_i * 24 * 60 * 60
+    "max-age=" + max_age.to_s
+  end
+
+  def expires
+    expire_date = Date.today + expired_in.to_i
+    expire_date.to_time.getgm
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-deploy-oss
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- erlzhang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: aliyun-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Deploy your Jekyll site to Aliyun OSS.
+email:
+- zhangshiyu1992@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- _config.yml
+- jekyll-deploy-oss.gemspec
+- lib/jekyll-deploy-oss.rb
+- lib/oss/deploy.rb
+homepage: https://github.com/erlzhang/jekyll-deploy-oss
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Deploy your Jekyll site to Aliyun OSS.
+test_files: []