bos_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b4f7253d95434dfe4780441e9e8abd04de23d7a
+  data.tar.gz: c07a5b2a3b79b6838b53f951c0abc9a7c60095dd
+SHA512:
+  metadata.gz: 729c021c631f4489d9f27943e50aa700b401af2303a39a65b01c26a35e4570a5061c4c75f0c7dabd9be811d812decf06324cae23e30d098b0238b4573d0025a5
+  data.tar.gz: c558fe178daeba6b80bb577c04458d17e8ffa0bd33178860ac4872177bfad7a8c587b1d665c4af07d39c7c26e78b93f35eceb14c3421d1cfa4204b49eebc4070

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+tmp/
+*.gem
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_script:
+  - bundle install
+script:
+  - bundle exec rspec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bos.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Feng Ce
+
+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,34 @@
+# BosClient
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bos', :git => 'git@github.com:fcce/bos.git'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bos_client
+
+## Usage
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/bos_client/fork )
+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 a new Pull Request

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bos_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bos_client.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bos_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bos_client"
+  spec.version       = BosClient::VERSION
+  spec.authors       = ["Feng Ce"]
+  spec.email         = ["kalelfc@gmail.com"]
+
+  spec.summary       = "Baidu Object Storage Unofficial Ruby SDK"
+  spec.description   = "Library for accessing BOS objects and buckets through REST API"
+  spec.homepage      = "http://github.com/fcce/bos"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.0"
+
+  spec.add_runtime_dependency "typhoeus", "~> 1.1"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.1"
+end

data/lib/bos_client/auth.rb

@@ -0,0 +1,85 @@
+# encoding: UTF-8
+require 'openssl'
+require 'typhoeus'
+require 'uri'
+module BosClient
+  class Authable
+
+    def self.authorize_request request
+      default_headers = get_default_headers request
+      request.options[:headers].merge! default_headers
+      authorization = sign(request)
+      request.options[:headers].merge!({"Authorization" => authorization})
+      request
+    end
+
+    private
+    class << self
+      def get_canonical_time t = Time.now.to_i
+        Time.at(t).utc.strftime("%FT%TZ")
+      end
+
+      def get_default_headers request
+        {
+          "content-type" =>"text/plain",
+          "x-bce-date" => get_canonical_time,
+          "content-length" => (request.options[:body] || "").length
+        }
+          # todo PUT 方法计算的签名错误，content-length 的问题，暂时处理。
+        # headers.merge!({"content-length" => 0}) if request.options[:method] == :put
+      end
+
+      def get_canonical_uri request
+        uri  = URI(request.base_url)
+        url_path = URI.encode(uri.path)
+        url_path == '' ? '/' : url_path
+      end
+
+      def get_canonical_query_string request
+        params = request.options[:params]
+        params = params.map do |k, v|
+          "#{URI.encode(k.to_s)}=#{encode_slash(URI.encode(v.to_s))}"
+        end.compact.sort.join('&')
+        params
+      end
+
+      def get_canonical_headers request
+        headers_to_sign_keys = ["host", "content-md5", "content-length", "content-type"]
+        headers_to_sign = []
+        canonical_headers_downcase = request.options[:headers].each do |k, v|
+          if headers_to_sign_keys.include?(k) || k.start_with?('x-bce')
+            headers_to_sign << "#{encode(k.to_s.downcase)}:#{encode(v.to_s)}"
+          end
+        end
+        headers_to_sign.compact.sort.join("\n")
+      end
+
+      def get_http_method request
+        (request.options[:method] || 'get').upcase
+      end
+
+      def encode string
+        URI.encode(string, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+      end
+
+      def encode_slash str
+        str.gsub(/\//,'%2F')
+      end
+
+      def sign request
+        digest = OpenSSL::Digest.new('sha256')
+        sign_key_prefix = "bce-auth-v1/#{BosClient.access_key_id}/#{get_canonical_time()}/#{BosClient.expiration_in_seconds}"
+        sign_key = OpenSSL::HMAC.hexdigest digest, BosClient.secret_access_key, sign_key_prefix
+
+        http_method = get_http_method request
+
+        canonical_uri = get_canonical_uri request
+        canonical_query_string = get_canonical_query_string request
+        canonical_headers = get_canonical_headers request
+        string_to_sign = [http_method, canonical_uri, canonical_query_string, canonical_headers].join("\n")
+        sign_result = OpenSSL::HMAC.hexdigest digest, sign_key, string_to_sign
+        "#{sign_key_prefix}//#{sign_result}"
+      end
+    end
+  end
+end

data/lib/bos_client/bucket.rb

@@ -0,0 +1,72 @@
+# encoding: UTF-8
+module BosClient
+  class Bucket
+    attr_accessor :name, :bucket_host, :creation_date, :bucket_host
+
+    def initialize(options = {})
+      @name = options[:name]
+      @location = options[:location] || BosClient.location
+      @creation_date = options[:creation_date]
+      @bucket_host = "#{BosClient.scheme}://#{@name}.#{@location}.#{BosClient.url}"
+    end
+
+    def accessable?
+      request = BosClient::Request.new @bucket_host, method: :head
+      response = request.run
+      response[:result]
+    end
+
+    #create bucket
+    # 401
+
+    # def save
+    #   request = BosClient::Request.new @bucket_host, method: :put, params:params
+    #   request.run
+    # end
+
+    def destory
+      request = BosClient::Request.new @bucket_host, method: :delete
+      response = request.run
+      response[:result]
+    end
+
+    ## objects
+    def objects options = {}
+      response = list_objects options.merge({delimiter: '/'})
+      objs = response[:data][:contents]
+      objs.map { |obj| BosClient::Object.new ({bucket:self}.merge(obj)) }
+    end
+
+    def dirs options = {}
+      response = list_objects options
+      data = response[:data][:contents]
+      data = data.find_all{|e| is_dir?(e[:key]) }
+      data.map { |e| e[:key] }
+    end
+
+    def dir_objects prefix, options = {}
+      response = list_objects options.merge({delimiter: '/',prefix:prefix})
+      data = response[:data][:contents]
+      objs = data.find_all{|e| !is_dir?(e[:key]) }
+      objs.map { |obj| BosClient::Object.new ({bucket:self}.merge(obj)) }
+    end
+
+    private
+    def is_dir? name
+      name.end_with?('/')
+    end
+
+    def list_objects options = {}
+      prefix = options.fetch(:prefix, nil)
+      max_keys = options.fetch(:max_keys, 1000)
+      marker = options.fetch(:marker, nil)
+      delimiter = options.fetch(:delimiter, nil)
+      params = {maxKeys: max_keys}
+      params.merge!({prefix: prefix}) unless prefix.nil?
+      params.merge!({marker: marker}) unless marker.nil?
+      params.merge!({delimiter: delimiter}) unless delimiter.nil?
+      request = BosClient::Request.new @bucket_host, method: :get, params:params
+      request.run
+    end
+  end
+end

data/lib/bos_client/config.rb

@@ -0,0 +1,42 @@
+# encoding: UTF-8
+module BosClient
+
+   DEFAULTS = {
+      scheme: 'http',
+      url: 'bcebos.com',
+      location: 'bj',
+      expiration_in_seconds: 1800,
+      access_key_id: '*****',
+      secret_access_key: '*****'
+    }
+
+  class << self
+    def options
+      @options ||= DEFAULTS.dup
+    end
+
+    def options=(opts)
+      @options = opts
+    end
+
+    def configure
+      yield self
+    end
+
+    def host
+      "#{options[:scheme]}://#{options[:location]}.#{options[:url]}"
+    end
+
+  end
+
+  DEFAULTS.each do |k, v|
+    self.define_singleton_method "#{k}=" do |value|
+      self.options.merge!(k => value)
+    end
+
+    self.define_singleton_method k do
+      self.options[k]
+    end
+  end
+
+end

data/lib/bos_client/error.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+module BosClient
+  class Error < StandardError
+    class << self
+
+      def bos_error name, message
+        unless const_defined?(name)
+          BosClient::Error.const_set(name.to_sym, Class.new(BosClient::Error)).new(message)
+        else
+          eval "BosClient::Error::#{name}.new \"#{message}\""
+        end
+      end
+
+      def const_missing(name)
+        BosClient::Error.const_set(name.to_sym,Class.new(BosClient::Error))
+      end
+    end
+  end
+end

data/lib/bos_client/helper.rb

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+module BosClient
+  module Helper
+
+   def snake_hash_keys value
+      case value
+      when Array
+        value.map { |v| snake_hash_keys(v) }
+      when Hash
+        snake_hash(value)
+      else
+        value
+      end
+    end
+
+    def snake_hash(value)
+      Hash[value.map { |k, v| [underscore_key(k), snake_hash_keys(v)] }]
+    end
+
+    def underscore_key(k)
+      if k.is_a? Symbol
+        underscore(k.to_s).to_sym
+      elsif k.is_a? String
+        underscore(k)
+      else
+        k
+      end
+    end
+
+    def underscore(string)
+      string.gsub(/::/, '/')
+        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        .tr('-', '_')
+        .downcase
+    end
+  end
+end

data/lib/bos_client/object.rb

@@ -0,0 +1,77 @@
+# encoding: UTF-8
+module BosClient
+  class Object
+    attr_accessor :bucket, :size, :path, :last_modified, :name, :storage_class
+
+    def initialize(options = {})
+      @bucket = options[:bucket]
+      @size = options[:size]
+      @file = options[:key]
+      @path, @name =  File.split(options[:key])
+      @last_modified = options[:last_modified]
+      @storage_class = options[:storage_class]
+    end
+
+
+    def save
+      save_to nil
+    end
+
+    def save_as name
+      save_to nil, name
+    end
+
+    def save_to path, name = nil
+      headers = {
+                 "host" => @bucket.bucket_host,
+                 }
+
+      params = {}
+      url = URI.encode("http://#{@bucket.bucket_host}/#{@file}")
+      request = Typhoeus::Request.new(url, method: :get,headers:headers,params:params)
+      request = BosClient::Authable.authorize_request(request)
+
+      request.on_complete do |response|
+        if path
+          flie = "#{path}/#{name || @name}"
+        else
+          flie = "#{name || @name}"
+        end
+        write_file flie, response.body
+      end
+      request.run
+    end
+
+    def destory
+      request = BosClient::Request.new "#{@bucket.bucket_host}/#{@file}", method: :delete
+      response = request.run
+      response[:result]
+    end
+
+    def self.upload options = {}
+      bucket = options[:bucket]
+      file = options[:file]
+      origin_file_name = File.basename(file)
+      filename = options[:filename] || origin_file_name
+      path = options[:path] || ''
+      storage_class = options[:storage_class] || "STANDARD"
+      headers = options[:headers] || {}
+
+      params = {
+        append: ""
+      }
+      headers.merge!({"x-bce-storage-class" => storage_class})
+      request = BosClient::Request.new "#{bucket.bucket_host}/#{File.join(path,filename)}?append", method: :post, params:params, headers: headers, body: File.open(file,"r").read
+      response = request.run
+      response[:result]
+    end
+
+    private
+    def write_file(filename, data)
+      file = File.new(filename, "wb")
+      file.write(data)
+      file.close
+    end
+
+  end
+end

data/lib/bos_client/request.rb

@@ -0,0 +1,93 @@
+# encoding: UTF-8
+module BosClient
+  class Request
+    include BosClient::Helper
+    attr_accessor :uri, :options
+
+    def initialize url , options={}
+      @uri = URI(URI.encode(url))
+      @options = options
+    end
+
+    def run
+      request = format_request
+      resolve_response request.run
+    end
+
+    def response_headers
+      request = format_request
+      resolve_response_headers request.run
+    end
+
+    private
+    def format_request
+      headers = { "host" => @uri.host }
+
+      if @options[:headers].nil?
+        @options[:headers] = headers
+      else
+        @options[:headers].merge! headers
+      end
+
+      if @options[:params].nil?
+        @options[:params] = {}
+      end
+
+      request = Typhoeus::Request.new @uri.to_s, @options
+      BosClient::Authable.authorize_request request
+    end
+
+    def resolve_response response
+      if response.success?
+        ret = resolve_bos_resault response
+        return snake_hash_keys(ret)
+      elsif response.timed_out?
+        raise BosClient::Error::TimeOut.new "got a time out"
+      elsif response.code == 0
+        raise BosClient::Error::HttpError.new response.return_message
+      else
+        ret = resolve_bos_resault response
+        if ret[:data][:code]
+          raise  BosClient::Error.bos_error ret[:data][:code], ret[:data][:message]
+        else
+          raise BosClient::Error::HttpError.new "HTTP request failed: #{response.code.to_s}"
+        end
+      end
+    end
+
+    def resolve_bos_resault r
+      begin
+        if r.body.size > 0
+          ret = JSON.parse r.body,{:symbolize_names => true}
+        else
+          ret = {}
+        end
+
+        result = {
+          result: true,
+          status: r.code,
+          ts: Time.now.to_i,
+          version: 1.0,
+          data: ret
+        }
+      rescue Exception => e
+        raise BosClient::Error::JSONError.new e.message
+      end
+    end
+
+    def resolve_response_headers r
+      begin
+        ret = JSON.parse r.headers,{:symbolize_names => true}
+        result = {
+          result: true,
+          status: r.code,
+          ts: Time.now.to_i,
+          version: 1.0,
+          data: ret
+        }
+      rescue Exception => e
+        raise BosClient::Error::JSONError.new e.message
+      end
+    end
+  end
+end

data/lib/bos_client/service.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+module BosClient
+  class << self
+
+    def buckets
+      list_buckets unless @result
+      @result[:buckets].map { |bk| Bucket.new bk }
+    end
+
+    def owner
+      list_buckets unless @result
+      @result[:owner]
+    end
+
+    private
+    def list_buckets
+      url = host.to_s
+      request = BosClient::Request.new url, method: :get
+      response = request.run
+      @result = response[:data]
+    end
+  end
+end

data/lib/bos_client/version.rb

@@ -0,0 +1,3 @@
+module BosClient
+  VERSION = "0.1.0"
+end

data/lib/bos_client.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+require 'json'
+require 'uri'
+require "bos_client/version"
+require "bos_client/config"
+require 'bos_client/auth'
+require 'bos_client/helper'
+require 'bos_client/service'
+require 'bos_client/error'
+require 'bos_client/request'
+require 'bos_client/bucket'
+require 'bos_client/object'
+module BosClient
+
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: bos_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Feng Ce
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Library for accessing BOS objects and buckets through REST API
+email:
+- kalelfc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bos_client.gemspec
+- lib/bos_client.rb
+- lib/bos_client/auth.rb
+- lib/bos_client/bucket.rb
+- lib/bos_client/config.rb
+- lib/bos_client/error.rb
+- lib/bos_client/helper.rb
+- lib/bos_client/object.rb
+- lib/bos_client/request.rb
+- lib/bos_client/service.rb
+- lib/bos_client/version.rb
+homepage: http://github.com/fcce/bos
+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.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Baidu Object Storage Unofficial Ruby SDK
+test_files: []