qiniu-kit 0.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzJlYmRkYzQxYzExZjc0YjgzOTdhOGRjMWMyNWRhMmE1ZGJmM2JiZQ==
+  data.tar.gz: !binary |-
+    OWRmMzJmYzdmYWU1ZGY5MTNkNWZmMzRjMWExNDJmNWRkNDE5MGYxZg==
+SHA512:
+  metadata.gz: !binary |-
+    MDk0NzI2MGViZTRiYTBlY2YwMmE1OGU4ZDdmN2Y4MDI2OTgxMDQxNWNjYjll
+    ODA0MTVkMTQxNjliOWI0OGZjYjA5YTU2MzYyYzNlOTdhMzg5MTQwMzM0NDIy
+    NjI2NmE2NzNlMmVmMDFiOTBiZGYwNGVmNTFmOTY3MDhjMzZlZTk=
+  data.tar.gz: !binary |-
+    OTZiOGZhM2RhNWRjOTk5MjQ0ZTA5ZmE4YmJmMjgzODEzNDlkYjAyNDdkMGU5
+    ZGFkMTIyMjcwYmE0NjZkYzkwMzI5M2E4MDk5OTEzZTc5NjZlOThiZTcxNzkw
+    OTc3ODhkODg0N2UxNTc3Y2EyZDIzODY5ZDQ3ODIzM2M0MzYwN2I=

data/.gitignore

@@ -0,0 +1,28 @@
+*.gem
+*.rbc
+.bundle
+.config
+Gemfile.lock
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# VIM
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+*.un~
+*~
+
+# OSX
+.DS_Store

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+rvm:
+- 1.8.7
+- 1.9.2
+- 1.9.3
+- 2.0.0
+- 2.1.0
+- ruby-head
+- jruby-18mode
+- jruby-19mode
+- jruby-head
+- rbx
+- ree
+before_script:
+- export QINIU_ACCESS_KEY=key_for_test
+- export QINIU_SECRET_KEY=secret_for_test
+deploy:
+  provider: rubygems
+  api_key:
+    secure: dFb7wl5NabGx+uhx6sph47sTVV1zdgHH+n5wsaIyLkQmGZPdgDc0Kz1Gr3XrKzUTjFeiKwRnPkamqMReweq/nkH43Z/F01dgPdgWVNekDTFEd6V06VXN00yhHeCLpQo52YdJ9f/gPsZKlCiOo+4Y3uwzClS3n8pT8kXb2M8z3ao=
+  gem: qiniu-kit
+  on:
+    tags: true
+    repo: why404/qiniu-kit

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+group :test, :development do
+  gem 'coveralls', :require => false
+  gem 'mime-types', '< 2.0', :platforms => [:ruby_18, :mri_18, :jruby]
+end
+
+# Specify your gem's dependencies in qiniu-kit.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 why404
+
+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,124 @@
+# qiniu-kit
+
+[![Build Status](https://travis-ci.org/why404/qiniu-kit.png?branch=master)](https://travis-ci.org/why404/qiniu-kit)
+[![Dependency Status](https://gemnasium.com/why404/qiniu-kit.png)](https://gemnasium.com/why404/qiniu-kit)
+[![Coverage Status](https://coveralls.io/repos/why404/qiniu-kit/badge.png)](https://coveralls.io/r/why404/qiniu-kit)
+[![Code Climate](https://codeclimate.com/github/why404/qiniu-kit.png)](https://codeclimate.com/github/why404/qiniu-kit)
+[![Gem Version](https://fury-badge.herokuapp.com/rb/qiniu-kit.png)](http://badge.fury.io/rb/qiniu-kit)
+
+A collection of helpful methods for debugging Qiniu Cloud Storage API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'qiniu-kit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qiniu-kit
+
+## Usage
+
+```ruby
+require 'qiniu-kit'
+
+
+Qiniu::Kit.decode_json('{"abc":"def"}')
+#=> {"abc" => "def"}
+
+Qiniu::Kit.decode_json('{"abc":"def"}', :symbolize_keys => true)
+#=> {:abc => "def"}
+
+Qiniu::Kit.encode_json({:abc => 'def'})
+# convert Ruby back to JSON
+
+Qiniu::Kit.encode_json({:abc => 'def'}, :pretty => true)
+# encoded in a pretty form (if supported by the coder)
+
+
+Qiniu::Kit.base64_url_encode("bucket:key")
+#=> "YnVja2V0OmtleQ=="
+
+Qiniu::Kit.base64_url_decode("YnVja2V0OmtleQ==")
+#=> "bucket:key"
+
+Qiniu::Kit.entry_uri_encode("bucket", "key")
+#=> "YnVja2V0OmtleQ=="
+
+
+default_mac = Qiniu::Kit::Mac.new
+# this will load Qiniu.config[:access_key] and Qiniu.config[:secret_key] as its args
+
+mac = Qiniu::Kit::Mac.new("access_key", "secret_key")
+#=> #<Qiniu::Kit::Mac:0x007fb87ba89040 @access_key="access_key", @secret_key="secret_key">
+
+mac.hmac_sha1_digest('data')
+#=> "A\xF3\xC2\x14\xCE\x97\xEEY5,\rC\xD5P/\xAC\xA4\xB9l\x13"
+
+mac.base64_hmac_sha1_digest('data')
+#=> "QfPCFM6X7lk1LA1D1VAvrKS5bBM="
+
+mac.sign('data')
+#=> "access_key:QfPCFM6X7lk1LA1D1VAvrKS5bBM="
+
+mac.sign_with_data('data')
+#=> "access_key:AbKufp75scn1gPkjEi1PNDcH3qg=:ZGF0YQ=="
+
+url = 'http://domain/key?param1=value1&param2=value2'
+body = nil
+mac.sign_with_request(url, body)
+#=> "access_key:85Q_5E2cYOMeVFg1a50nW3To2n8="
+```
+
+## Configuration
+
+You can configure your Qiniu account access credentials globally. This is very useful to setup onther Qiniu libraries, like [qiniu-policy](https://github.com/why404/qiniu-policy).
+
+```ruby
+require 'qiniu-kit'
+
+Qiniu.config = {:access_key => '...', :secret_key => '...'}
+```
+
+Additionally, the library will attempt to load these options from `ENV`:
+
+    export QINIU_ACCESS_KEY='...'
+    export QINIU_SECRET_KEY='...'
+
+
+## TODO
+
+- support http requests/responses
+
+## Supported Ruby versions
+
+This library aims to support and is [tested against](https://travis-ci.org/why404/qiniu-kit) the following Ruby implementations:
+
+- MRI 2.1.0
+- MRI 2.0.0
+- MRI 1.9.3
+- MRI 1.9.2
+- MRI 1.8.7
+- JRuby 1.7.9 in Ruby 1.8 mode
+- JRuby 1.7.9 in Ruby 1.9 mode
+- Ruby Enterprise Edition 1.8.7 2012.02
+- Ruby (latest master)
+- [JRuby](http://jruby.org/) (latest master)
+- [Rubinius](http://rubini.us/)
+
+If something doesn't work on one of these Ruby versions, it's a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby implementations, however support will only be provided for the versions listed above.
+
+## Contributing
+
+1. Fork it ( <https://github.com/why404/qiniu-kit/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 new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/qiniu/errors.rb

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+
+module Qiniu
+  module Errors
+
+    class JSONDecodeError < StandardError; end
+
+    class NotAnInstanceOfError < StandardError; end
+
+    # Raised when a {Service} is constructed and credentials are not
+    # set, or the set credentials are empty.
+    class MissingCredentialsError < RuntimeError; end
+
+    class MissingArgsError < RuntimeError
+      def initialize(missing_keys)
+        key_list = missing_keys.map {|key| key.to_s}.join(' and the ')
+        super("#{key_list} are required.")
+      end
+    end
+
+  end
+end

data/lib/qiniu/kit/mac.rb

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+
+require 'openssl'
+require 'uri'
+
+module Qiniu
+  module Kit
+    class Mac
+
+      def initialize(access_key, secret_key)
+        @access_key = access_key || Qiniu.config[:access_key]
+        @secret_key = secret_key || Qiniu.config[:secret_key]
+      end
+
+      def hmac_sha1_digest(data)
+        OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'), @secret_key, data)
+      end
+
+      def base64_hmac_sha1_digest(data)
+        return Qiniu::Kit.base64_url_encode(hmac_sha1_digest(data))
+      end
+
+      def sign(data)
+        return %Q(#{@access_key}:#{base64_hmac_sha1_digest(data)})
+      end
+
+      def sign_with_data(data)
+        base64data = Qiniu::Kit.base64_url_encode(data)
+        return %Q(#{sign(base64data)}:#{base64data})
+      end
+
+      def sign_with_request(url, body = nil)
+        uri = URI.parse(url)
+        data  = uri.path
+        data += '?' + uri.query if !uri.query.nil? && !uri.query.empty?
+        data += "\n"
+        data += body if !body.nil? && !body.empty?
+        return sign(data)
+      end
+
+    end
+  end
+end

data/lib/qiniu/kit/version.rb

@@ -0,0 +1,7 @@
+# -*- encoding: utf-8 -*-
+
+module Qiniu
+  module Kit
+    VERSION = "0.1.1"
+  end
+end

data/lib/qiniu/kit.rb

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+require "base64"
+require "multi_json"
+
+
+module Qiniu
+  module Kit
+
+    module_function
+
+    def base64_url_encode(str)
+      Base64.encode64(str).tr("+/", "-_").gsub(/[\n\r]?/, "")
+    end
+
+    def base64_url_decode(str)
+      Base64.decode64(str.tr("-_", "+/"))
+    end
+
+    def entry_uri_encode(bucket, key)
+      entry_uri = bucket + ':' + key
+      base64_url_encode(entry_uri)
+    end
+
+    def decode_json(*args)
+      MultiJson.load(*args)
+    rescue MultiJson::LoadError
+      raise Qiniu::JSONDecodeError.new("Invalid segment encoding")
+    end
+
+    def encode_json(*args)
+      MultiJson.dump(*args)
+    end
+
+  end
+end

data/lib/qiniu-kit.rb

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+%w(
+  qiniu.rb
+  qiniu/errors.rb
+  qiniu/kit.rb
+  qiniu/kit/mac.rb
+  qiniu/kit/version.rb
+).each do |f|
+  require File.join(File.dirname(__FILE__), f)
+end

data/lib/qiniu.rb

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+require File.join(File.dirname(__FILE__), 'qiniu', 'errors.rb')
+
+module Qiniu
+
+  @config = {}
+
+  class << self
+
+    DEFAULT_OPTIONS = {}
+
+    attr_reader :config
+
+    def config=(options)
+      unless Hash === options
+        raise ArgumentError, "configuration object must be a hash"
+      end
+      @config = DEFAULT_OPTIONS.merge(options)
+      akid = ENV["QINIU_ACCESS_KEY"] || @config[:access_key]
+      skid = ENV["QINIU_SECRET_KEY"] || @config[:secret_key]
+      if akid.nil? || akid.empty? || skid.nil? || skid.nil?
+        raise Qiniu::Errors::MissingCredentialsError, "missing :access_key or :secret_key"
+      end
+    end
+
+  end
+end

data/qiniu-kit.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qiniu/kit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "qiniu-kit"
+  spec.version       = Qiniu::Kit::VERSION
+  spec.authors       = ["why404"]
+  spec.email         = ["awhy.xu@gmail.com"]
+  spec.summary       = %q{A collection of helpful methods for debugging Qiniu Cloud Storage API.}
+  spec.description   = %q{Qiniu basic for setup other libraries, also can be used independently.}
+  spec.homepage      = "https://github.com/why404/qiniu-kit"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_runtime_dependency "multi_json", "~> 1.8"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "rspec", "~> 2.14"
+end

data/spec/qiniu/kit/mac_spec.rb

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe Qiniu::Kit::Mac do
+
+  before(:all) do
+    @mac_object = Qiniu::Kit::Mac.new("access_key", "secret_key")
+    @data = 'The quick brown fox jumps over the lazy dog'
+  end
+
+  context '.hmac_sha1_digest' do
+    it 'should works' do
+      @mac_object.hmac_sha1_digest(@data).size.should eq(20)
+    end
+  end
+
+  context '.base64_hmac_sha1_digest' do
+    it 'should works' do
+      @mac_object.base64_hmac_sha1_digest(@data).should eq("MuPjQo_SKFFla-gElUbMr6YJ_3M=")
+    end
+  end
+
+  context '.sign' do
+    it 'should works' do
+      result = 'access_key:MuPjQo_SKFFla-gElUbMr6YJ_3M='
+      @mac_object.sign(@data).should eq(result)
+    end
+  end
+
+  context '.sign_with_data' do
+    it 'should works' do
+      result = 'access_key:o596toAWk5uj15G8YPpEItyWfAk=:VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZw=='
+      @mac_object.sign_with_data(@data).should eq(result)
+    end
+  end
+
+  context '.sign_with_request' do
+    it 'should works' do
+      url = 'http://foo.com/posts?id=30&limit=5#time=1305298413'
+      body = nil
+      result = 'access_key:rCCViSFht5oGE2oAOakBG62wbJA='
+      @mac_object.sign_with_request(url, body).should eq(result)
+    end
+  end
+
+end

data/spec/qiniu/kit/version_spec.rb

@@ -0,0 +1,15 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe Qiniu::Kit do
+
+  it 'should have a version number' do
+    Qiniu::Kit::VERSION.should_not be_nil
+  end
+
+  it 'version should be number' do
+    Qiniu::Kit::VERSION.to_s.should =~ /^\d+\.\d+\.\d+?$/
+  end
+
+end

data/spec/qiniu/kit_spec.rb

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe Qiniu::Kit do
+
+  before(:all) do
+    @bucket = 'bucket'
+    @key = 'key'
+    @encoded = 'YnVja2V0OmtleQ=='
+  end
+
+  context '.decode_json' do
+    it 'should works' do
+      Qiniu::Kit.decode_json('{"abc":"def"}').should eq({"abc" => "def"})
+      Qiniu::Kit.decode_json('{"abc":"def"}', :symbolize_keys => true).should eq({:abc => "def"})
+    end
+  end
+
+  context '.encode_json' do
+    it 'should works' do
+      Qiniu::Kit.encode_json({:abc => 'def'}).should eq('{"abc":"def"}')
+      if RUBY_VERSION >= "1.9"
+        Qiniu::Kit.encode_json({:abc => 'def'}, :pretty => true).should eq("{\n  \"abc\": \"def\"\n}")
+      end
+    end
+  end
+
+  context '.base64_url_encode' do
+    it 'should works' do
+      Qiniu::Kit.base64_url_encode("#{@bucket}:#{@key}").should eq(@encoded)
+    end
+  end
+
+  context '.base64_url_decode' do
+    it 'should works' do
+      Qiniu::Kit.base64_url_decode(@encoded).should eq("#{@bucket}:#{@key}")
+    end
+  end
+
+  context '.entry_uri_encode' do
+    it 'should works' do
+      Qiniu::Kit.entry_uri_encode(@bucket, @key).should eq(@encoded)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'qiniu-kit'
+
+RSpec.configure do |config|
+  config.before :all do
+    Qiniu.config = {
+      :access_key => ENV["QINIU_ACCESS_KEY"],
+      :secret_key => ENV["QINIU_SECRET_KEY"]
+    }
+  end
+end
+
+require 'coveralls'
+Coveralls.wear!

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: qiniu-kit
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- why404
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Qiniu basic for setup other libraries, also can be used independently.
+email:
+- awhy.xu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/qiniu-kit.rb
+- lib/qiniu.rb
+- lib/qiniu/errors.rb
+- lib/qiniu/kit.rb
+- lib/qiniu/kit/mac.rb
+- lib/qiniu/kit/version.rb
+- qiniu-kit.gemspec
+- spec/qiniu/kit/mac_spec.rb
+- spec/qiniu/kit/version_spec.rb
+- spec/qiniu/kit_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/why404/qiniu-kit
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A collection of helpful methods for debugging Qiniu Cloud Storage API.
+test_files:
+- spec/qiniu/kit/mac_spec.rb
+- spec/qiniu/kit/version_spec.rb
+- spec/qiniu/kit_spec.rb
+- spec/spec_helper.rb