aliyun-odps 0.1.0 → 0.4.0

data/lib/aliyun/odps/model/instance_task.rb

@@ -0,0 +1,30 @@
+module Aliyun
+  module Odps
+    class InstanceTask < Struct::Base
+      property :name, String, required: true
+      property :type, String, required: true, within: %w(SQL SQLPLAN MapReduce DT PLSQL)
+      property :comment, String
+      property :property, Hash, init_with: ->(hash) do
+        hash.map { |k, v| { 'Name' => k, 'Value' => v } }
+      end
+      property :query, String
+      property :start_time, DateTime
+      property :end_time, DateTime
+      property :status, String
+      property :histories, Array
+
+      def to_hash
+        {
+          'SQL' => {
+            'Name' => name,
+            'Comment' => comment || '',
+            'Config' => {
+              'Property' => property || { 'Name' => '', 'Value' => '' }
+            },
+            'Query!' => "<![CDATA[#{query}]]>"
+          }
+        }
+      end
+    end
+  end
+end

data/lib/aliyun/odps/model/instances.rb

@@ -0,0 +1,119 @@
+module Aliyun
+  module Odps
+    class Instances < ServiceObject
+      DEFAULT_PRIORITY = 9
+
+      # List instances of project
+      #
+      # @see http://repo.aliyun.com/api-doc/Instance/get_instances/index.html Get instances
+      #
+      # @params options [Hash] options
+      #
+      # @option options [String] :datarange specify the starttime range time range
+      # @option options [String] :status supported value: Running, Suspended, Terminated
+      # @option jobname [String] :jobname specify the job name
+      # @option onlyowner [String] :onlyowner (yes) supported value: yes, no
+      # @option options [String] :marker
+      # @option options [String] :maxitems (1000)
+      #
+      # @return [List]
+      def list(options = {})
+        Utils.stringify_keys!(options)
+        path = "/projects/#{project.name}/instances"
+        query = Utils.hash_slice(options, 'datarange', 'status', 'jobname', 'onlyowner', 'marker', 'maxitems')
+        result = client.get(path, query: query).parsed_response
+
+        Aliyun::Odps::List.build(result, %w(Instances Instance)) do |hash|
+          Instance.new(hash.merge(project: project))
+        end
+      end
+
+      # Create a instance job
+      #
+      # @see http://repo.aliyun.com/api-doc/Instance/post_instance/index.html Post Instance
+      #
+      # @params tasks [Array<InstanceTask>] a list of instance_task
+      # @params options [String] options
+      # @option options [String] :name Specify the instance name
+      # @option options [String] :comment Specify comment of the instance
+      # @option options [Integer] :priority Specify priority of the instance
+      #
+      # @raise InstanceNameInvalidError if instance name not valid
+      #
+      # @return [Instance]
+      def create(tasks, options = {})
+        Utils.stringify_keys!(options)
+        path = "/projects/#{project.name}/instances"
+
+        instance = validate_and_build_instance(tasks, options)
+        resp = client.post(path, body: build_create_body(instance))
+
+        append_location(instance, resp.headers['Location'])
+      end
+
+      # Get status of instance
+      #
+      # @see http://repo.aliyun.com/api-doc/Instance/get_instance/index.html Get instance
+      #
+      # @params name [String] specify the instance name
+      #
+      # @return Instance status: Suspended, Running, Terminated
+      def status(name)
+        instance = Instance.new(
+          name: name,
+          project: project
+        )
+
+        instance.get_status
+      end
+
+      private
+
+      def build_create_body(instance)
+        fail XmlElementMissingError, 'Priority' if instance.priority.nil?
+        fail XmlElementMissingError, 'Tasks' if instance.tasks.empty?
+
+        Utils.to_xml(build_hash(instance), unwrap: true)
+      end
+
+      def build_hash(instance)
+        {
+          'Instance' => {
+            'Job' => {
+              'Name' => instance.name,
+              'Comment' => instance.comment || '',
+              'Priority' => instance.priority,
+              'Tasks' => instance.tasks.map(&:to_hash)
+            }
+          }
+        }
+      end
+
+      def validate_and_build_instance(tasks, options)
+        name = options.key?('name') ? options['name'] : Utils.generate_uuid('instance')
+        fail InstanceNameInvalidError, name unless name.match(Instance::NAME_PATTERN)
+        fail PriorityInvalidError if options.key?('priority') && options['priority'] < 0
+
+        build_instance(name, tasks, options['priority'], options['comment'])
+      end
+
+      def build_instance(name, tasks, priority = nil, comment = nil)
+        Instance.new(
+          name: name,
+          tasks: tasks,
+          project: project,
+          priority: priority || DEFAULT_PRIORITY,
+          client: client,
+          comment: comment
+        )
+      end
+
+      def append_location(instance, location)
+        instance.tap do |obj|
+          obj.location = location
+          obj.name = obj.location.split('/').last if obj.location
+        end
+      end
+    end
+  end
+end

data/lib/aliyun/odps/model/projects.rb

@@ -0,0 +1,73 @@
+module Aliyun
+  module Odps
+    # Methods for Projects
+    class Projects < ServiceObject
+      # List all projects
+      #
+      # @see http://repo.aliyun.com/api-doc/Project/get_projects/index.html Get projects
+      #
+      # @param options [Hash] options
+      # @option options [String] :owner specify the project owner
+      # @option options [String] :marker specify marker for paginate
+      # @option options [String] :maxitems (1000) specify maxitems in this request
+      #
+      # @return [List]
+      #
+      # TODO: http://git.oschina.net/newell_zlx/aliyun-odps-ruby-sdk/issues/2
+      def list(options = {})
+        Utils.stringify_keys!(options)
+        query = Utils.hash_slice(options, 'owner', 'marker', 'maxitems')
+        resp = client.get('/projects', query: query)
+        result = resp.parsed_response
+
+        Aliyun::Odps::List.build(result, %w(Projects Project)) do |hash|
+          Project.new(hash.merge(client: client))
+        end
+      end
+
+      # Get Project Information
+      #
+      # @see http://repo.aliyun.com/api-doc/Project/get_project/index.html Get Project
+      #
+      # @param name specify the project name
+      #
+      # @return [Project]
+      def get(name)
+        result = client.get("/projects/#{name}").parsed_response
+        hash = Utils.dig_value(result, 'Project')
+        Project.new(hash.merge(client: client))
+      end
+
+      # Update Project Information
+      #
+      # @see http://repo.aliyun.com/api-doc/Project/put_project/index.html Put Project
+      #
+      # @params name specify the project name
+      # @params options [Hash] options
+      # @option options [String] :comment Comment of the project
+      #
+      # @return true
+      def update(name, options = {})
+        Utils.stringify_keys!(options)
+        project = Project.new(
+          name: name,
+          comment: options['comment'],
+          client: client
+        )
+        !!client.put("/projects/#{name}", body: build_update_body(project))
+      end
+
+      private
+
+      def build_update_body(project)
+        fail XmlElementMissingError, 'Comment' if project.comment.nil?
+
+        Utils.to_xml(
+          'Project' => {
+            'Name' => project.name,
+            'Comment' => project.comment
+          })
+      end
+    end
+  end
+end

data/lib/aliyun/odps/model/resource.rb

@@ -0,0 +1,26 @@
+module Aliyun
+  module Odps
+    class Resource < Struct::Base
+      extend Aliyun::Odps::Modelable
+
+      property :name, String, required: true
+      property :owner, String
+      property :last_updator, String
+      property :comment, String
+      property :resource_type, String, within: %w(py jar archive file table)
+      property :local_path, String
+      property :creation_time, DateTime
+      property :last_modified_time, DateTime
+      property :table_name, String
+      property :resource_size, Integer
+      property :content, String
+      property :location, String
+
+      alias_method :resource_name=, :name=
+
+      def to_hash
+        { 'ResourceName' => name }
+      end
+    end
+  end
+end

data/lib/aliyun/odps/model/resources.rb

@@ -0,0 +1,144 @@
+module Aliyun
+  module Odps
+    # Methods for Resources
+    class Resources < ServiceObject
+      # List resources of project
+      #
+      # @see http://repo.aliyun.com/api-doc/Resource/get_resources/index.html Get resources
+      #
+      # @params options [Hash] options
+      # @option options [String] :name specify resource name
+      # @option options [String] :owner specify resource owner
+      # @option options [String] :marker
+      # @option options [String] :maxitems (1000)
+      #
+      # @return [List]
+      def list(options = {})
+        Utils.stringify_keys!(options)
+        path = "/projects/#{project.name}/resources"
+        query = Utils.hash_slice(options, 'name', 'owner', 'marker', 'maxitems')
+        result = client.get(path, query: query).parsed_response
+
+        Aliyun::Odps::List.build(result, %w(Resources Resource)) do |hash|
+          Resource.new(hash)
+        end
+      end
+
+      # Get resource of project
+      #
+      # @see http://repo.aliyun.com/api-doc/Resource/get_resource/index.html Get resource
+      #
+      # @params name [String] specify resource name
+      #
+      # @return [Resource]
+      def get(name)
+        path = "/projects/#{project.name}/resources/#{name}"
+        resp = client.get(path)
+        build_resource(resp)
+      end
+      alias_method :resource, :get
+
+      # Get resource information in project
+      #
+      # @see http://repo.aliyun.com/api-doc/Resource/head_resource/index.html Head resource
+      #
+      # @params name [String] specify resource name
+      #
+      # @return [Resource]
+      def get_meta(name)
+        path = "/projects/#{project.name}/resources/#{name}"
+        resp = client.head(path)
+        build_resource(resp)
+      end
+      alias_method :head, :get_meta
+
+      # Create resource in project
+      #
+      # @see http://repo.aliyun.com/api-doc/Resource/post_resource/index.html Post resource
+      #
+      # @params name [String] specify resource name
+      # @params type [String] specify resource type: supported value: py, jar, archive, file, table
+      # @params options [Hash] options
+      # @option options [String] :comment specify resource comment
+      # @option options [String] :table specify table or table partition name, if your table have partitions, must contains partition spec together with format: tab1 partition(region='bj',year='2011')
+      # @option options [File|BinData] :file specify the source code or file path
+      #
+      # @return [Resource]
+      def create(name, type, options = {})
+        Utils.stringify_keys!(options)
+        path = "/projects/#{project.name}/resources/"
+
+        headers = build_create_base_headers(name, type, options)
+        body = build_create_base_body(options)
+
+        location = client.post(path, headers: headers, body: body).headers['Location']
+        Resource.new(name: name, resource_type: type, comment: options['comment'], location: location)
+      end
+
+      # Update resource in project
+      #
+      # @see http://repo.aliyun.com/api-doc/Resource/put_resource/index.html Put resource
+      #
+      # @params name [String] specify resource name
+      # @params type [String] specify resource type: supported value: py, jar, archive, file, table
+      # @params options [Hash] options
+      # @option options [String] :comment specify resource comment
+      # @option options [String] :table specify table or table partition name
+      # @option options [File|Bin Data] :file specify the source code or file path
+      #
+      # @return [true]
+      def update(name, type, options = {})
+        Utils.stringify_keys!(options)
+        path = "/projects/#{project.name}/resources/#{name}"
+
+        headers = build_create_base_headers(name, type, options)
+        body = build_create_base_body(options)
+
+        !!client.put(path, headers: headers, body: body)
+      end
+
+      # Delete resource in project
+      #
+      # @see http://repo.aliyun.com/api-doc/Resource/delete_resource/index.html Delete resource
+      #
+      # @params name [String] specify the resource name
+      #
+      # @return [true]
+      def delete(name)
+        path = "/projects/#{project.name}/resources/#{name}"
+
+        !!client.delete(path)
+      end
+
+      private
+
+      def build_create_base_headers(name, type, options)
+        headers = { 'x-odps-resource-type' => type, 'x-odps-resource-name' => name }
+        headers['x-odps-comment'] = options['comment'] if options.key?('comment')
+        headers['x-odps-copy-table-source'] = options['table'] if options.key?('table')
+        headers
+      end
+
+      def build_create_base_body(options)
+        body = options.key?('file') ? Utils.to_data(options['file']) : ''
+        fail ResourceMissingContentError if body.empty? && !options.key?('table')
+        body
+      end
+
+      def build_resource(resp)
+        hash = {
+          name: resp.headers['x-odps-resource-name'],
+          last_updator: resp.headers['x-odps-updator'],
+          owner: resp.headers['x-odps-owner'],
+          comment: resp.headers['x-odps-comment'],
+          last_modified_time: resp.headers['Last-Modified'],
+          creation_time: resp.headers['x-odps-creation-time'],
+          resource_size: resp.headers['x-odps-resource-size'],
+          resource_type: resp.headers['x-odps-resource-type']
+        }
+        hash['content'] = resp.parsed_response unless resp.parsed_response.nil?
+        Resource.new(hash)
+      end
+    end
+  end
+end

data/lib/aliyun/odps/model/table.rb

@@ -0,0 +1,37 @@
+require 'aliyun/odps/model/table_partitions'
+require 'aliyun/odps/model/table_schema'
+
+module Aliyun
+  module Odps
+    class Table < Struct::Base
+      extend Aliyun::Odps::Modelable
+
+      # @!method table_partitions
+      # @return [TablePartitions]
+      has_many :table_partitions
+
+      property :project, Project, required: true
+
+      property :name, String, required: true
+      property :table_id, String
+      property :comment, String
+      property :owner, String
+      property :schema, TableSchema, init_with: ->(value) do
+        case value
+        when TableSchema
+          value
+        when Hash
+          value = JSON.parse(value['__content__']) if value.key?('__content__')
+          TableSchema.new(value)
+        end
+      end
+      property :creation_time, DateTime
+      property :last_modified, DateTime
+
+      # (see TablePartitions#list)
+      def partitions(options = {})
+        table_partitions.list(options)
+      end
+    end
+  end
+end

data/lib/aliyun/odps/model/table_column.rb

@@ -0,0 +1,13 @@
+module Aliyun
+  module Odps
+    class TableColumn < Struct::Base
+      property :name, String, required: true
+      property :type, String, required: true, init_with: ->(value) do
+        fail NotSupportColumnTypeError, value unless %w(bigint double boolean datetime string).include?(value)
+        value
+      end
+      property :comment, String
+      property :label, String
+    end
+  end
+end