backup-baidu 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d35dcf3395690cead523fc1e159c1a618196a302
+  data.tar.gz: badbe163ddf969886d04e5b27b488ea118e157fe
+SHA512:
+  metadata.gz: 7c45b82015918acc36289788f62854b5585b71a8a1044acb7e0a0fe0090d19f84a2494145f2cd1409b5893c9abf60bafdc28d2fcc1555409c32a3eb97b6b67c4
+  data.tar.gz: 2cc87037cf29b87c148953a94cf0e5d8af18982a057d0c9f1c8c3ca0eefe07de5a207cb1fe8d7b7af23d5e24b941c94fd69af8ffad4ac8ba2f2b90cefc388e4a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--format documentation --color spec --drb

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+# source 'http://ruby.taobao.org'
+
+# Specify your gem's dependencies in backup-baidu.gemspec
+gemspec
+gem 'rspec'
+gem 'mocha'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 DylanDeng, George Lee
+
+MIT License
+
+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,44 @@
+# Backup::Baidu
+
+This Gem is aimed to provide a plugin for [Backup](https://github.com/meskyanichi/backup), using Baidu's [PCS](http://developer.baidu.com/wiki/index.php?title=docs/pcs/rest/overview) as storage.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'backup-baidu'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install backup-baidu
+
+## Usage
+
+include this in your backup model file, like:
+
+```ruby
+require "backup-baidu"
+
+Backup::Model.new(:foo, 'Description for foo') do
+
+  store_with "Baidu" do |config|
+    config.access_key_id = 'my_access_id'
+    config.access_key_secret = 'my_access_key'
+    config.path = '/apps/<my_path_value>'  # IMPORTANT - set this to your API's path value when signing up for baidu PCS
+    config.keep = 10
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/backup-baidu.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "backup-baidu"
+  spec.version       = "0.1.1"
+  spec.authors       = ["DylanDeng", "George Lee"]
+  spec.email         = ["dylan@beansmile.com", "mclee@foolme.net"]
+  spec.description   = %q{pan.baidu.com Storage support for Backup}
+  spec.summary       = %q{pan.baidu.com Storage support for Backup}
+  spec.homepage      = "https://github.com/mclee/backup-baidu"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", "~> 2.6"
+
+  spec.add_dependency "backup", ">= 3.7.0"
+  spec.add_dependency "api4baidu", ">= 1.0.1"
+  spec.add_dependency "oauth2", ["~> 0.9.2"]
+  spec.add_dependency "json", ["~> 1.8.0"]
+end

data/lib/backup-baidu.rb

@@ -0,0 +1,6 @@
+require "backup"
+require "json"
+require "api4baidu"
+require "oauth2"
+
+Backup::Storage.send(:autoload, :Baidu, File.join(File.dirname(__FILE__),"backup/storage/baidu"))

data/lib/backup/storage/baidu.rb

@@ -0,0 +1,82 @@
+module Backup
+  module Storage
+    class Baidu < Base
+      attr_accessor :api_key, :api_secret, :path
+
+      def initialize(model, storage_id = nil, &block)
+        super(model, storage_id)
+
+        @path ||= 'backups'
+
+        instance_eval(&block) if block_given?
+      end
+
+      private
+
+      def connection
+        return @connection if @connection
+        @api_key = self.api_key
+        @api_secret = self.api_secret
+        @connection = ::Baidu::Client.new { }
+        @connection.api_key = self.api_key
+        @connection.api_secret = self.api_secret
+
+        if session
+          @connection.access_token = session
+        else
+          puts "You'll need to authorize from Baidu for the first time:\n\n"
+          puts @connection.authorize_url
+          print "Type in 'code' from callback url: "
+          auth_code = $stdin.gets.chomp.split("\n").first
+          @connection.token!(auth_code)
+          puts "Auth successful!"
+          save_session(@connection.access_token)
+        end
+        @connection
+      end
+
+      def save_session(token)
+        @access_token = token
+        FileUtils.mkdir_p(Config.cache_path) unless File.directory?(Config.cache_path)
+        File.open(cached_file,"w") do |f|
+          f.puts @access_token.to_hash.to_json
+        end
+      end
+
+      def session
+        return @session if @session
+        if File.exist?(cached_file)
+          stored_data = File.open(cached_file).read
+          @session = OAuth2::AccessToken.from_hash(@connection.oauth_client, JSON.parse(stored_data))
+          if @session.expired?
+            Logger.info "Access Token has expired, not refresh a new token..."
+            @session.refresh!
+            Logger.info "Refresh successed. #{@session.token}"
+            save_session(@session)
+          end
+        end
+        @session
+      end
+
+      def cached_file
+        File.join(Config.cache_path, "baidu-" + self.api_key + "-" + self.api_secret)
+      end
+
+      def transfer!
+        remote_path = remote_path_for(package)
+        package.filenames.each do |filename|
+          src = File.join(Config.tmp_path, filename)
+          dest = File.join(remote_path, filename)
+          Logger.info "Storing '#{ dest }'..."
+          connection.upload_single_file(dest, src)
+        end
+      end
+
+      def remove!(package)
+        remote_path = remote_path_for(package)
+        Logger.info "Removeing '#{remote_path}' from Baidu..."
+        connection.delete(remote_path)
+      end
+    end
+  end
+end

data/spec/baidu_spec.rb

@@ -0,0 +1,108 @@
+require File.expand_path('../spec_helper.rb', __FILE__)
+
+describe Backup::Storage::Baidu do
+  let(:model)   { Backup::Model.new(:test_trigger, 'test label') }
+  let(:storage) do
+    Backup::Storage::Baidu.new(model) do |db|
+      db.api_key      = 'lZUsGbfnXOkwa2tvtZVI1Sn7'
+      db.api_secret   = 'qjhCau3p8EIPmZKAHyEArKn19H74FtEj'
+      db.keep         = 5
+    end
+  end
+
+  it 'should be a subclass of Storage::Base' do
+    Backup::Storage::Baidu.
+      superclass.should == Backup::Storage::Base
+  end
+
+  describe '#initialize' do
+    after { Backup::Storage::Baidu.clear_defaults! }
+
+    it 'should load pre-configured defaults through Base' do
+      Backup::Storage::Baidu.any_instance.expects(:load_defaults!)
+      storage
+    end
+
+    it 'should pass the model reference to Base' do
+      storage.instance_variable_get(:@model).should == model
+    end
+
+    it 'should pass the storage_id to Base' do
+      storage = Backup::Storage::Baidu.new(model, 'my_storage_id')
+      storage.storage_id.should == 'my_storage_id'
+    end
+
+  end # describe '#initialize'
+
+  describe '#connection' do
+    let (:connection) { mock }
+    let (:session) { mock }
+
+    it "should return old connction if it exist" do
+      storage.instance_variable_set(:@connection,connection)
+      storage.send(:connection).should == connection
+    end
+  end
+
+  describe '#transfer!' do
+    let(:connection) { mock }
+    let(:package) { mock }
+    let(:file) { mock }
+    let(:s) { sequence '' }
+
+    before do
+      storage.instance_variable_set(:@package, package)
+      Backup::Config.stubs(:tmp_path).returns('/local/path')
+      storage.stubs(:connection).returns(connection)
+      file.stubs(:read).returns("foo")
+    end
+
+    it 'should transfer the package files' do
+      pending
+      # storage.expects(:remote_path_for).in_sequence(s).with(package).
+      #     returns('remote/path')
+      # package.stubs(:filenames).returns(['backup.tar.enc-aa','backup.tar.enc-ab'])
+      # # first yield
+      # Backup::Logger.expects(:info).in_sequence(s).with(
+      #   "Storing 'remote/path/backup.tar.enc-aa'..."
+      # )
+      # connection.expects(:put).in_sequence(s).with(
+      #   File.join('remote/path', 'backup.tar.enc-aa'), File.join('/local/path', 'backup.tar.enc-aa')
+      # )
+      # # second yield
+      # Backup::Logger.expects(:info).in_sequence(s).with(
+      #   "Storing 'remote/path/backup.tar.enc-ab'..."
+      # )
+      # connection.expects(:put).in_sequence(s).with(
+      #   File.join('remote/path', 'backup.tar.enc-ab'), File.join('/local/path', 'backup.tar.enc-ab')
+      # )
+
+      # storage.send(:transfer!)
+    end
+  end # describe '#transfer!'
+
+  describe '#remove!' do
+    let(:package) { mock }
+    let(:connection) { mock }
+    let(:s) { sequence '' }
+
+    before do
+      storage.stubs(:storage_name).returns('Storage::Baidu')
+      storage.stubs(:connection).returns(connection)
+    end
+
+    it 'should remove the package files' do
+      storage.expects(:remote_path_for).in_sequence(s).with(package).
+          returns('remote/path')
+      # after both yields
+      Backup::Logger.expects(:info).in_sequence(s).with(
+        "Removeing 'remote/path' from Baidu..."
+      )
+      connection.expects(:delete).in_sequence(s).with('remote/path')
+
+      storage.send(:remove!, package)
+    end
+  end # describe '#remove!'
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'bundler/setup'
+require 'backup'
+require 'backup-baidu'
+
+require 'rspec/autorun'
+
+RSpec.configure do |config|
+  ##
+  # Use Mocha to mock with RSpec
+  config.mock_with :mocha
+
+  ##
+  # Example Helpers
+  # config.include Backup::ExampleHelpers
+
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  config.before(:each) do
+    # ::FileUtils will always be either SandboxFileUtils or FileUtils::NoWrite.
+    # SandboxFileUtils.deactivate!(:noop)
+
+    # prevent system calls
+    Backup::Utilities.stubs(:gnu_tar?).returns(true)
+    Backup::Utilities.stubs(:utility)
+    Backup::Utilities.stubs(:run)
+    Backup::Pipeline.any_instance.stubs(:run)
+
+    Backup::Utilities.send(:reset!)
+    Backup::Config.send(:reset!)
+    # Logger only queues messages received until Logger.start! is called.
+    Backup::Logger.send(:reset!)
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: backup-baidu
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- DylanDeng
+- George Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: backup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: api4baidu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: pan.baidu.com Storage support for Backup
+email:
+- dylan@beansmile.com
+- mclee@foolme.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- backup-baidu.gemspec
+- lib/backup-baidu.rb
+- lib/backup/storage/baidu.rb
+- spec/baidu_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mclee/backup-baidu
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.9
+signing_key: 
+specification_version: 4
+summary: pan.baidu.com Storage support for Backup
+test_files:
+- spec/baidu_spec.rb
+- spec/spec_helper.rb