aliyun-odps 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2846d511de2496e6fc99c96e95dd05bf0c31c68c
-  data.tar.gz: 514b589a19f56478dc62262f79a708c00e6fa0c2
+  metadata.gz: 668bb0a1605386f0934814e45f60e6550a8d21d8
+  data.tar.gz: 2b94dd56d05754e2b7ad7e674ec5d78cf4fc8235
 SHA512:
-  metadata.gz: 412386d88aeade9c1fc3fabf40c9a2b70e72ce6c0dd38e2e2cff50649908dc919c4e8c9d5e21458d318056f5f2a3f181644b16412b7ff1d3506a5c156e9a2be3
-  data.tar.gz: 75821628b43a48e0b8b0c3f44c7c072fc852846365ada81eafa18c7afa11836bb809c2fb0b518c48c3f11dc1545924f8384501ef071bf17cae0f3a21815b94b2
+  metadata.gz: 3066f7654504c549c91823f88ffecdaeb319f8614f59386920fd70ec08955198c7717d5cc99075d9a820a3f406fd8c02bc1cc62ece513f0b0b194f24f302c7a6
+  data.tar.gz: b65df29d07ea272729c4d8cbf72c2ee9fe6ca6b8f14cfee6c7223cd8e81a7046d8dfe0d2e7a26848571752d006a4a1b38f7fcc51a42b304c920ef7a36b1d4e96

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/.idea
 /.yardoc
 /Gemfile.lock
 /_yardoc/
@@ -7,3 +8,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+.DS_Store
+.ruby-version

data/.rubocop.yml

@@ -0,0 +1,31 @@
+# This is the configuration used to check the rubocop source code.
+
+AllCops:
+  Exclude:
+    - 'demo/**/*'
+    - 'test/**/*'
+
+Metrics/LineLength:
+  Max: 100
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Style/AccessorMethodName:
+  Enabled: false
+
+Style/PredicateName:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in aliyun-odps-sdk.gemspec
 gemspec
+
+gem 'simplecov', require: false, group: :test
+gem 'pry-byebug'

data/README.md

@@ -1,10 +1,9 @@
-# Aliyun OSS SDK
+# Aliyun ODPS SDK
 
 -----
 
 It is a full-featured Ruby Library for Aliyun ODPS API. Enjoy it!
 
-
 ## Installation
 
 It's a Ruby Gem, so you can install it like any Gem:
@@ -19,39 +18,83 @@ And run:
 
     bundle install
 
+
+## Usage
+
+### Quick Start
+
+First of all, config your environment.
+
+If you use Rails, you can place it in `config/initializers/aliyun_odps.rb`, for other framework, just place it before your other odps code.
+
+    Aliyun::Odps.configure do |config|
+      config.access_key = '<your-access-key>'
+      config.secret_key = '<your-secret-key>'
+      config.endpoint = '<odps-server-api>'  # "http://service.odps.aliyun.com/api"
+      config.project = '<your-default-project>'
+    end
+
+After that, you can get your project and start party now!
+
+    project = Aliyun::Odps.project
+
+    # Accesss tables
+    project.tables.list
+
+    # Access resources
+    project.resources.list
+
+    # Access instances
+    project.instances.list
+
+    # Access functions
+    project.functions.list
+
+
+    # For Tunnel
+    project.table_tunnels
+
+More Example and Scenario, visit our [Document](#document)
+
+
 ## Document
 
 Here is original Restful API, It has the most detailed and authoritative explanation for every API.
 
 + [http://repo.aliyun.com/api-doc/index.html](http://repo.aliyun.com/api-doc/index.html)
 
-Here is thr RDoc Document for this Library, use to find mostly usage for methods.
+Here is our RDoc Document, It's well format to help you find more detail about methods.
 
-+ [RDoc Document]()
++ [RDoc Document](http://www.rubydoc.info/gems/aliyun-odps/0.1.0)
 
 
 Here are some more guides for help you. Welcome to advice.
 
+All document are under `./wiki`
+
 + [Installation](./wiki/installation.md)
 + [Getting Started](./wiki/get_start.md)
-+ [Error](./wiki/error.md)
++ [Projects](./wiki/projects.md)
++ [Instances](./wiki/instances.md)
++ [Resources](./wiki/resources.md)
++ [Functions](./wiki/functions.md)
++ [Tables](./wiki/tables.md)
++ [Tunnels](./wiki/tunnels.md)
++ [Error Code](./wiki/error.md)
++ [SSL Connection](./wiki/ssl.md)
 
-## Usage
-
-### Quick Start
 
 ## Test
 
 We use minitest for test and rubocop for Syntax checker, If you want to make contribute to this library. Confirm below Command is success:
 
-```
-bundle exec rake test
-```
+    bundle exec rake test
 
 
 ## Authors && Contributors
 
-- [Newell Zhu](https://github.com/zlx_star)
+- [Newell](https://github.com/zlx_star)
+- [genewoo](https://github.com/genewoo)
 
 
 ## License

data/Rakefile

@@ -1,10 +1,20 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
+  t.libs << 'test'
+  t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test
+
+task :test do
+  Rake::Task['test'].invoke
+  Rake::Task['rubocop'].invoke
+end
+
+RuboCop::RakeTask.new do |task|
+  task.fail_on_error = false
+end

data/aliyun-odps.gemspec

@@ -4,21 +4,32 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'aliyun/odps/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "aliyun-odps"
+  spec.name          = 'aliyun-odps'
   spec.version       = Aliyun::Odps::VERSION
-  spec.authors       = ["Newell Zhu"]
-  spec.email         = ["zlx.star@gmail.com"]
+  spec.authors       = ['Newell Zhu']
+  spec.email         = ['zlx.star@gmail.com']
 
-  spec.summary       = %q{It is a full-featured Ruby Library for Aliyun ODPS API. Enjoy it!}
-  spec.description   = %q{It is a full-featured Ruby Library for Aliyun ODPS API. Enjoy it!}
-  spec.homepage      = "https://github.com/aliyun-beta"
+  spec.summary       = 'It is a full-featured Ruby Library for Aliyun ODPS API. Enjoy it!'
+  spec.description   = 'It is a full-featured Ruby Library for Aliyun ODPS API. Enjoy it!'
+  spec.homepage      = 'https://github.com/aliyun-beta'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'addressable'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'gyoku'
+  spec.add_dependency 'odps_protobuf', '0.5.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'snappy'
 end

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "aliyun/odps/sdk"
+require 'bundler/setup'
+require 'aliyun/odps'
 
 # 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.
@@ -10,5 +10,12 @@ require "aliyun/odps/sdk"
 # require "pry"
 # Pry.start
 
-require "irb"
+Aliyun::Odps.configure do |config|
+  config.access_key = ENV['ALIYUN_ACCESS_KEY'] || ''
+  config.secret_key = ENV['ALIYUN_SECRET_KEY'] || ''
+  config.endpoint = 'http://service.odps.aliyun.com/api'
+  config.project = ENV['ALIYUN_PROJECT'] || 'your-mock-project'
+end
+
+require 'irb'
 IRB.start

data/lib/aliyun/odps.rb

@@ -1,7 +1,74 @@
-require "aliyun/odps/version"
+require 'aliyun/odps/version'
+require 'aliyun/odps/error'
+require 'aliyun/odps/configuration'
+require 'aliyun/odps/struct'
+require 'aliyun/odps/modelable'
+require 'aliyun/odps/project'
+
+require 'aliyun/odps/authorization'
+require 'aliyun/odps/client'
+require 'aliyun/odps/utils'
+require 'aliyun/odps/list'
+
+# DEBUG
+require 'pry'
 
 module Aliyun
   module Odps
-    # Your code goes here...
+    class << self
+      attr_writer :configuration
+
+      # Config Odps
+      #
+      # @example
+      #
+      #  Aliyun::Odps.configure do |config|
+      #    config.access_key = 'your-access-key'
+      #    config.secret_key = 'your-secret-key'
+      #    config.endpoint = 'odps-api-endpoint'  # 'http://service.odps.aliyun.com/api' or 'http://odps-ext.aliyun-inc.com/api'
+      #    config.project = 'your-default-project-name'
+      #    config.tunnel_endpoint = 'odps-tunnel-api-endpoint'  # if you not config it, we will auto detect it
+      #  end
+      def configure
+        @configuration ||= Configuration.new
+        yield @configuration if block_given?
+        @configuration
+      end
+
+      # return current configuration
+      #
+      # @return [Configuration]
+      def config
+        @configuration
+      end
+
+      # Get project
+      #
+      # @param name [String] specify project name, default is project in config
+      #
+      # @return [Project]
+      def project(name = config.project)
+        fail MissingProjectConfigurationError unless name
+        client.projects.get(name)
+      end
+      alias_method :get_project, :project
+
+      # (see Projects#list)
+      def list_projects(options = {})
+        client.projects.list(options)
+      end
+      alias_method :projects, :list_projects
+
+      # (see Projects#update)
+      def update_project(name, options = {})
+        client.projects.update(name, options)
+      end
+
+      private
+
+      def client
+        @client ||= Aliyun::Odps::Client.new
+      end
+    end
   end
 end

data/lib/aliyun/odps/authorization.rb

@@ -0,0 +1,90 @@
+require 'base64'
+require 'openssl'
+require 'digest'
+require 'json'
+
+module Aliyun
+  module Odps
+    class Authorization
+      PROVIDER = 'ODPS'
+
+      class << self
+        # @private
+        #
+        # Get authorization key
+        #
+        # @param access_key [String] Access Key
+        # @param secret_key [String] Secret Key
+        # @param options [Hash] Options
+        # @option options [String] :verb VERB, request method
+        # @option options [String] :date Request Time in formate: '%a, %d %b %Y %H:%M:%S GMT'
+        # @option options [String] :path resource name
+        # @option options [Hash] :query Query key-value pair
+        # @option options [Hash] :headers Headers
+        #
+        # @return [String] the authorization string
+        def get_authorization(access_key, secret_key, options = {})
+          content_string = concat_content_string(options[:verb], options[:date], options)
+          signature_string = signature(secret_key, content_string)
+          "#{PROVIDER} #{access_key}:#{signature_string.strip}"
+        end
+
+        private
+
+        def concat_content_string(verb, time, options = {})
+          headers = options.fetch(:headers, {})
+
+          conon_headers = get_cononicalized_odps_headers(headers)
+          conon_resource = get_cononicalized_resource(
+            *options.values_at(:path, :query)
+          )
+
+          join_values(verb, time, headers, conon_headers, conon_resource)
+        end
+
+        def join_values(verb, time, headers, conon_headers, conon_resource)
+          [
+            verb,
+            headers['Content-MD5'].to_s.strip,
+            headers['Content-Type'].to_s.strip,
+            time,
+            conon_headers
+          ].join("\n") + conon_resource
+        end
+
+        def signature(secret_key, content_string)
+          utf8_string = content_string.force_encoding('utf-8')
+          Base64.encode64(
+            OpenSSL::HMAC.digest(
+              OpenSSL::Digest::SHA1.new,
+              secret_key,
+              utf8_string
+            )
+          )
+        end
+
+        def get_cononicalized_odps_headers(headers)
+          odps_headers = (headers || {}).select do |key, _|
+            key.to_s.downcase.start_with?('x-odps-')
+          end
+          return if odps_headers.empty?
+
+          odps_headers.keys.sort.map do |key|
+            "#{key.downcase}:#{odps_headers[key]}"
+          end.join("\n") + "\n"
+        end
+
+        def get_cononicalized_resource(path, query)
+          conon_resource = path
+          return conon_resource if query.nil? || query.empty?
+
+          Utils.stringify_keys!(query)
+
+          query_str = query.keys.sort.map { |k| "#{k}=#{query[k]}" }.join('&')
+
+          query_str.empty? ? conon_resource : conon_resource + '?' + query_str
+        end
+      end
+    end
+  end
+end

data/lib/aliyun/odps/client.rb

@@ -0,0 +1,40 @@
+require 'aliyun/odps/http'
+require 'aliyun/odps/service_object'
+require 'aliyun/odps/model/projects'
+
+module Aliyun
+  module Odps
+    class Client < ServiceObject
+      extend Aliyun::Odps::Modelable
+
+      # @!method projects
+      # @return [Projects]
+      has_many :projects
+
+      attr_reader :config
+
+      # Initialize a object
+      #
+      # @param access_key [String] access_key obtained from aliyun
+      # @param secret_key [String] secret_key obtained from aliyun
+      # @option opts [String] :endpoint endpoint for API
+      #
+      # @return [Response]
+      def initialize(config = Aliyun::Odps.config)
+        @config = config
+      end
+
+      %w(get put post delete options head).each do |method|
+        define_method(method) do |*args|
+          http.send(method, *args)
+        end
+      end
+
+      private
+
+      def http
+        @http ||= Http.new(config)
+      end
+    end
+  end
+end