synaptic4r 0.1.5

data/lib/synaptic4r/request.rb

@@ -0,0 +1,295 @@
+####-------------------------------------------------------------------------------------------------------
+module Synaptic4r
+  
+  ####------------------------------------------------------------------------------------------------------
+  class Request
+    
+    ####------------------------------------------------------------------------------------------------------
+    include Rest
+
+
+    #.......................................................................................................
+    # argument specification
+    #.......................................................................................................
+    define_rest_arg :uid,                 :header => :hide
+
+    define_rest_arg :key,                 :header => :hide
+
+    define_rest_arg :site,                :header => :hide
+
+    define_rest_arg :file,                :header => :none, :cli => 'file', 
+                    :desc => 'file to upload'
+
+    define_rest_arg :lifetime,            :header => :none, :cli => ['lifetime', '-f'], 
+                    :desc => 'lifetime in minutes of request URL (default is 5 minuts)'
+
+    define_rest_arg :account,             :header => :none, :cli => ['account', '-u'], 
+                    :desc => "user account name specified in #{ENV['HOME']}./synaptic4r"
+
+    define_rest_arg :oid,                 :header => :none, :cli => ['oid', '-o'], 
+                    :desc => 'system assigned object identifier'
+
+    define_rest_arg :rpath,               :header => :none, :cli => 'rpath', 
+                    :desc => 'remote file or directory path'
+
+    define_rest_arg :namespace,           :header => :none, :cli => ['namespace', '-n'], 
+                    :desc => 'root namespace used for remote file path (default is uid)'
+
+    define_rest_arg :create_beginoffset, :header => :none, :cli => ['beginoffset', '-b'],
+                    :desc => 'begining byte offset in file'
+ 
+    define_rest_arg :create_endoffset, :header => :none,   :cli => ['endoffset', '-d'],
+                    :desc => 'end byte offset in file'
+
+    define_rest_arg :content_type,        :header => :http, :cli => ['content-type', '-c'], 
+                    :desc => 'http content type'
+
+    define_rest_arg :beginoffset,         :header => :http, :cli => ['beginoffset', '-b'], 
+                    :desc => 'begining byte offset in file'
+
+    define_rest_arg :endoffset,           :header => :http, :cli => ['endoffset', '-d'], 
+                    :desc => 'end byte offset in file'
+
+    define_rest_arg :useracl,             :header => :emc,  :cli => ['useracl', '-a'], 
+                    :desc => 'access control list'
+
+    define_rest_arg :groupacl,            :header => :emc,  :cli => ['groupacl', '-g'], 
+                    :desc => 'user group acess control list'
+
+    define_rest_arg :tags,                :header => :emc,  :cli => ['tags', '-t'], 
+                    :desc => 'listable metadata tag name'
+
+    define_rest_arg :include_meta,        :header => :emc,  :cli => ['include-meta', '-e', :flag], 
+                    :desc => 'include object metadata in query result', :map => lambda{|v| v ? 1 : 0}
+
+    define_rest_arg :meta,                :header => :emc,  :cli => ['meta', '-m'], 
+                    :desc => 'user nonlistable metadata name=value pairs'
+
+    define_rest_arg :listable_meta,       :header => :emc,  :cli => ['listable-meta', '-i'], 
+                    :desc => 'user listable metadata tag name=value pairs'
+                                                           
+    #.......................................................................................................
+    # method specification
+    #.......................................................................................................
+    #### all methods
+    define_rest_method :all, 
+                       :required => [:uid, :key, :site], 
+                       :optional => [:account]
+
+    #### POST
+    define_rest_method :create_file, 
+                       :desc              => 'create a file',
+                       :result_class      => StorageObject,
+                       :http_method       => :post,
+                       :required          => [:file, [:rpath, :listable_meta]], 
+                       :optional          => [:content_type, :namespace, :create_beginoffset, :create_endoffset],
+                       :exe               => lambda {|req, args| 
+                                                    ext = req.extent(args[:file], args[:create_beginoffset], 
+                                                              args[:create_endoffset])
+                                                    req.add_payload(args, ext)},
+                       :map_required_args => lambda {|vals|
+                                                     pvals = vals.select{|v| /^-i/.match(v) or not /^-/.match(v)}
+                                                     ovals = if pvals.length.eql?(1)
+                                                               pvals + [pvals.first] 
+                                                             elsif /\/$/.match(pvals.last) and pvals.length.eql?(2)
+                                                               [pvals.first, pvals.last+File.basename(pvals.first)]
+                                                             else
+                                                               pvals
+                                                             end
+                                                     {:pvals => ovals, :dlen => ovals.length - pvals.length}},
+                       :banner            => 'Usage: synrest create-file file [remote-path|-i list-meta] [options]'
+
+    define_rest_method :create_dir, 
+                       :desc              => 'create a directory',
+                       :result_class      => StorageObject,
+                       :http_method       => :post,
+                       :required          => [:rpath], 
+                       :optional          => [:namespace],
+                       :exe               => lambda {|req, args| args[:rpath] += '/'}  
+
+    define_rest_method :create_version, 
+                       :desc              => 'create an immutable version of a file or directory',
+                       :result_class      => StorageObject,
+                       :http_method       => :post,
+                       :required          => [[:rpath, :oid]], 
+                       :optional          => [:namespace],
+                       :query             => 'versions'
+    
+    define_rest_method :update_nonlistable_metadata, 
+                       :desc              => 'update nonlistable user metadata for a file or directory',
+                       :http_method       => :post,
+                       :result_class      => Result,
+                       :required          => [:meta, [:rpath, :oid]], 
+                       :optional          => [:namespace],
+                       :query             => 'metadata/user'
+
+    define_rest_method :update_listable_metadata, 
+                       :desc              => 'update listable user metadata for a file or directory',
+                       :http_method       => :post,
+                       :result_class      => Result,
+                       :required          => [:listable_meta, [:rpath, :oid]], 
+                       :optional          => [:namespace],
+                       :query             => 'metadata/user'
+
+    define_rest_method :update_acl, 
+                       :desc              => 'update access control list for a file or directory',
+                       :http_method       => :post,
+                       :result_class      => Result,
+                       :required          => [[:useracl, :groupacl], [:rpath, :oid]], 
+                       :optional          => [:namespace],
+                       :query             => 'acl'
+
+    #### GET
+    define_rest_method :get, 
+                       :desc              => 'get the contents of a file or directory',
+                       :result_class      => Download,
+                       :http_method       => :get,
+                       :required          => [[:rpath, :oid]], 
+                       :optional          => [:namespace, :beginoffset, :endoffset],
+                       :map_required_args => lambda {|vals| 
+                                                      pvals = vals.select{|v| /^-o/.match(v) or not /^-/.match(v)}
+                                                      if pvals.empty?
+                                                        {:pvals => [''], :dlen => 1}
+                                                      else
+                                                        {:pvals => pvals, :dlen => 0}
+                                                      end},
+                       :exe               => lambda {|req, args| 
+                                                     if args[:beginoffset] and args[:endoffset]
+                                                       ext = {:offset => args[:beginoffset].to_i,
+                                                              :length => args[:endoffset].to_i - args[:beginoffset].to_i + 1}
+                                                       req.set_header_range(args, ext); end},
+                       :banner            => 'Usage: synrest get [remote-path|-o oid] [options]'
+
+    define_rest_method :get_by_tag, 
+                       :desc              => 'get files and directories with specified listable user metadata tag',
+                       :result_class      => StorageObjectList,
+                       :http_method       => :get,
+                       :required          => [:tags], 
+                       :optional          => [:include_meta]
+
+
+    define_rest_method :get_user_metadata, 
+                       :desc              => 'get both listable and nonlistable user metadata for a file or directory',
+                       :result_class      => UserMetadata,
+                       :http_method       => :get,
+                       :required          => [[:rpath, :oid]], 
+                       :optional          => [:namespace],
+                       :query             => 'metadata/user'
+
+    define_rest_method :get_system_metadata, 
+                       :desc              => 'get system metadata for a file or directory',
+                       :http_method       => :get,
+                       :result_class      => SystemMetadata,
+                       :required          => [[:rpath, :oid]], 
+                       :optional          => [:namespace],
+                       :query             => 'metadata/system'
+
+    define_rest_method :get_acl, 
+                       :desc              => 'get user and group access control list for a file or directory',
+                       :result_class      => Acl,
+                       :http_method       => :get,
+                       :required          => [[:rpath, :oid]], 
+                       :optional          => [:namespace],
+                       :query             => 'acl'
+
+    define_rest_method :get_versions, 
+                       :desc              => 'get versions of a file or directory',
+                       :http_method       => :get,
+                       :result_class      => Versions,
+                       :required          => [[:rpath, :oid]], 
+                       :optional          => [:namespace],
+                       :query             => 'versions'
+
+    define_rest_method :get_all_tags, 
+                       :desc              => 'get all defined tags',
+                       :http_method       => :get,
+                       :result_class      => Tags,
+                       :required          => [], 
+                       :optional          => [:namespace, :tags],
+                       :query             => 'listabletags'
+
+
+    define_rest_method :get_tags, 
+                       :desc              => 'get listable user metadata tags for a file or directory',
+                       :http_method       => :get,
+                       :result_class      => Tags,
+                       :required          => [[:rpath, :oid]], 
+                       :optional          => [:namespace],
+                       :query             => 'metadata/tags'
+
+    #### PUT
+    define_rest_method :update, 
+                       :desc              => 'update a file or directory',
+                       :http_method       => :put,
+                       :result_class      => Result,
+                       :required          => [:file, [:rpath, :oid]], 
+                       :optional          => [:namespace, :beginoffset, :endoffset],
+                       :exe               => lambda {|req, args| 
+                                                     ext = req.extent(args[:file], args[:beginoffset], args[:endoffset])
+                                                     req.set_header_range(args, ext)
+                                                     req.add_payload(args, ext)
+                                                     req.set_header_extent(args, ext)},
+                       :map_required_args => lambda {|vals|
+                                                     pvals = vals.select{|v| not /^-/.match(v)}
+                                                     ovals = if pvals.length.eql?(1)
+                                                               pvals + [pvals.first] 
+                                                             elsif /\/$/.match(pvals.last) and pvals.length.eql?(2)
+                                                               [pvals.first, pvals.last+File.basename(pvals.first)]
+                                                             else
+                                                               pvals
+                                                             end
+                                                     {:pvals => ovals, :dlen => ovals.length - pvals.length}},
+                        :banner            => 'Usage: synrest update file [remote-path|-o oid] [options]'
+
+    #### DELETE    
+    define_rest_method :delete, 
+                       :desc              => 'delete a file or directory',
+                       :result_class      => Result,
+                       :http_method       => :delete,
+                       :required          => [[:rpath, :oid]], 
+                       :optional          => [:namespace]
+    
+    define_rest_method :delete_user_metadata, 
+                       :desc              => 'delete user metadata for a file or directory',
+                       :result_class      => Result,
+                       :http_method       => :delete,
+                       :required          => [:tags, [:rpath, :oid]], 
+                       :optional          => [:namespace],
+                       :query             => 'metadata/user'
+
+    #### Other methods    
+    define_rest_method :get_object_url, 
+                       :desc              => 'retrieve a shareable URL for linking to storage objects',
+                       :result_class      => ShareableUrl,
+                       :http_method       => :delete,
+                       :required          => [[:rpath, :oid]], 
+                       :optional          => [:lifetime],
+                       :diagnostics       => false,
+                       :map_required_args => lambda {|vals| 
+                                                      pvals = vals.select{|v| /^-o/.match(v) or not /^-/.match(v)}
+                                                      if pvals.empty?
+                                                        {:pvals => [''], :dlen => 1}
+                                                      else
+                                                        {:pvals => pvals, :dlen => 0}
+                                                      end}
+
+    #.......................................................................................................
+    # other requests
+    #.......................................................................................................
+    def get_object_url(args)
+      esc = '/=&?%'
+      exp = (args[:lifetime].nil? ? 5 : args[:lifetime].to_i)*60 + Time.now.to_i
+      res = /.*(\/rest.*)/.match(url).captures.first
+      user = headers['x-emc-uid']
+      @sign = "GET\n" + "#{res}\n#{user}\n#{exp}".downcase
+      digest = OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'), Base64.decode64(key), sign)
+      signature = Base64.encode64(digest.to_s())
+      @url = "#{url}?uid=#{URI.encode(user, esc)}&expires=#{exp}&signature=#{URI.encode(signature, esc)}"
+    end
+    
+  
+  #### Request
+  end
+
+#### Synaptic4r
+end

data/lib/synaptic4r/rest.rb

@@ -0,0 +1,357 @@
+###########################################################################################################
+module Synaptic4r
+
+  ###########################################################################################################
+  module Utils
+      
+    #.......................................................................................................
+    def unary_args_given?(unary_args, args)
+      unary_args.each{|a| raise ArgumentError, "Required argument '#{a}' is missing." unless args.include?(a)}
+    end
+    
+    #.......................................................................................................
+    def symbolize(e)
+      if e.kind_of?(Hash)
+        e.inject({}){|h, (k,v)| h.update(k.to_sym => v)}
+      elsif e.kind_of?(Array)
+        e.map{|v| v.to_sym}
+      end
+    end
+
+    #.......................................................................................................
+    def create_timestamp()
+      Time.now().httpdate()
+    end
+
+    #.......................................................................................................
+    def read_file(file, offset, length)
+      IO.read(file, length, offset)
+    end
+
+  #### Utils
+  end
+
+  ###########################################################################################################
+  module Rest
+    
+    #------------------------------------------------------------------------------------------------------
+    class << self
+
+      def included(base)
+        base.send(:extend, ClassMethods)
+        base.send(:include, InstanceMethods)
+      end
+
+    #### self
+    end
+
+
+    ####-----------------------------------------------------------------------------------------------------
+    module ClassMethods
+    
+      #.......................................................................................................
+      @@method_defs = Hash.new{|h,k| h[k] = {:required => [], :optional => []}}
+      @@arg_defs = Hash.new{|h,k| h[k] = {}}
+
+      #.......................................................................................................
+      def method_defs
+        @@method_defs
+      end
+
+      #.......................................................................................................
+      def arg_defs
+        @@arg_defs
+      end
+
+      #.......................................................................................................
+      def define_rest_method(meth, args)
+        [meth].flatten.each do |m|
+          method_defs[m][:required] += args[:required] if args[:required]
+          method_defs[m][:optional] += args[:optional] if args[:optional]
+          method_defs[m][:http_method] = args[:http_method]
+          method_defs[m][:desc] = args[:desc]
+          method_defs[m][:result_class] = args[:result_class]
+          method_defs[m][:query] = args[:query]
+          method_defs[m][:exe] = args[:exe]
+          method_defs[m][:map_required_args] = args[:map_required_args]
+          method_defs[m][:banner] = args[:banner]
+          method_defs[m][:diagnostics] = args[:diagnostics]
+        end  
+      end
+
+      #.......................................................................................................
+      def define_rest_arg(arg, opts)
+        arg_defs[arg].update(opts)
+      end
+
+      #.......................................................................................................
+      def args
+        method_defs
+      end
+
+      #.......................................................................................................
+      def has_rest_method?(meth)
+       rest_methods.include?(meth)
+      end
+
+      #.......................................................................................................
+      def rest_methods
+        args.keys.inject([]){|r,m| m.eql?(:all) ? r : r << m}
+      end
+      #.......................................................................................................
+      def http_method(meth)
+        args[meth][:http_method]
+      end
+
+      #.......................................................................................................
+      def required_rest_args(meth)
+        args[meth][:required] + args_all_methods(:required) 
+      end
+
+      #.......................................................................................................
+      def unary_rest_args(meth)
+        args[meth][:required].inject([]){|r,a| a.kind_of?(Array) ?  r : r << a}
+      end
+
+      #.......................................................................................................
+      def exclusive_rest_args(meth)
+        args[meth][:required].inject([]){|r,a| a.kind_of?(Array) ? r << a : r}
+      end
+
+      #.......................................................................................................
+      def optional_rest_args(meth)
+        args[meth][:optional] + args_all_methods(:optional)
+      end
+
+      #.......................................................................................................
+      def rest_arg(arg)
+        arg_defs[arg]
+      end
+
+      #.......................................................................................................
+      def args_all_methods(type)
+        args[:all][type].inject([]){|r,a| rest_arg(a)[:header].eql?(:hide) ? r : r << a}
+      end
+
+      #.......................................................................................................
+      def desc(meth)
+        args[meth][:desc]
+      end
+
+      #.......................................................................................................
+      def exe(meth)
+        args[meth][:exe]
+      end
+
+      #.......................................................................................................
+      def banner(meth)
+        args[meth][:banner]
+      end
+
+      #.......................................................................................................
+      def diagnostics(meth)
+        args[meth][:diagnostics].nil? ? true : args[meth][:diagnostics]
+      end
+
+      #.......................................................................................................
+      def map_required_args(meth)
+        args[meth][:map_required_args]
+      end
+
+      #.......................................................................................................
+      def result_class(meth)
+        args[meth][:result_class]
+      end
+
+      #.......................................................................................................
+      def query(meth)
+        args[meth][:query]
+      end
+
+      #.......................................................................................................
+      def header_args(meth)
+        unary_rest_args(meth) + exclusive_rest_args(meth).flatten + optional_rest_args(meth) - 
+          non_header_args(meth)
+      end
+
+      #.......................................................................................................
+      def emc_headers
+        arg_defs.inject([]){|r, (a, d)| d[:header].eql?(:emc) ? r.push(a) : r}
+      end
+
+      #.......................................................................................................
+      def non_header_args(meth)
+        arg_defs.inject([]){|r, (a, d)| d[:header].eql?(:none) ? r.push(a) : r}
+      end
+
+    #### ClassMethods
+    end
+
+    ####-----------------------------------------------------------------------------------------------------
+    module InstanceMethods
+
+      #.......................................................................................................
+      include Utils
+    
+      #.......................................................................................................
+      attr_reader :headers, :uid, :key, :site, :subtenant, :payload, :meth, :sign, :url
+
+      #.......................................................................................................
+      def initialize(args)
+        unary_args_given?([:uid, :subtenant, :key, :site], args)
+        @uid = args[:uid]
+        @key = args[:key]
+        @site = args[:site]
+        @subtenant = args[:subtenant]
+        @headers = credentials
+      end
+
+      #.......................................................................................................
+      def execute(meth, *args, &blk)
+        @meth = meth
+        args = args.first || {}
+        set_remote_file(args)
+        unary_args_given?(self.class.unary_rest_args(meth), args)
+        exclusive_args_given?(self.class.exclusive_rest_args(meth), args)
+        self.class.exe(meth)[self, args] if self.class.exe(meth)
+        build_service_url(args)
+        add_header_attr(args)
+        create_signature
+        res = if self.respond_to?(meth)
+                self.send(meth, args)
+              else
+                if args[:dump].nil? and args[:payload].nil?                
+                  RestClient::Request.execute(:method => self.class.http_method(meth), :url => url, 
+                                              :headers => headers, :payload => payload)
+                end
+              end
+        self.class.result_class(meth).new(:result => res, :headers => headers, :url => url, :sign => sign,
+                                          :http_request => self.class.http_method(meth), 
+                                          :payload => args[:payload] ? payload : nil)
+      end
+
+      #.......................................................................................................
+      def exclusive_args_given?(exclusive_args, args)
+        exclusive_args.each do |alist| 
+          unless alist.select{|a| args.keys.include?(a)}.length.eql?(1)
+            acli = alist.map{|a| [self.class.rest_arg(a)[:cli]].flatten.first}
+            raise ArgumentError, "One of '#{acli.join(', ')}' is required as an argument."
+          end
+        end
+      end
+
+      #.......................................................................................................
+      def add_header_attr(given={})
+        to_emc = lambda{|a| h = a.to_s.gsub(/_/,'-'); self.class.emc_headers.include?(a) ? "x-emc-#{h}" : h}
+        header_args = self.class.header_args(meth)
+        given.keys.each do |k| 
+          headers.update(to_emc[k] => given[k]) if header_args.include?(k)
+        end
+      end
+
+      #.......................................................................................................
+      def set_remote_file(args)
+        if args[:rpath]
+          if args[:namespace] and args[:namespace].empty?
+            args[:rpath] =  args[:rpath]
+          elsif args[:namespace]
+            args[:rpath] = args[:namespace] + '/' + args[:rpath]
+          else
+            args[:rpath] = uid + '/' + args[:rpath]
+          end
+        end
+      end
+
+      #.......................................................................................................
+      def build_service_url(args={})
+        surl = if args[:rpath]
+                 'namespace/' + args[:rpath]
+               else
+                 'objects' + (args[:oid].nil? ? '' : "/#{args[:oid]}")
+               end
+        @url = (/\/$/.match(site).nil? ? site + '/' : site) + surl + 
+          ((q = self.class.query(meth)).nil? ? '' : "?#{q}")
+      end
+
+      #.......................................................................................................
+      def create_signature
+        @sign = create_sign_string
+        digest = OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'), Base64.decode64(key), sign)
+        headers['x-emc-signature'] = Base64.encode64(digest.to_s()).chomp()
+      end
+
+      #.......................................................................................................
+      def create_sign_string
+        composite_string = (self.class.http_method(meth).to_s.upcase  || '') + "\n" + \
+                           (headers['content-type']                   || '') + "\n" + \
+                           (headers['range']                          || '') + "\n" + \
+                           (headers['date']                           || '') + "\n"
+        if url
+          composite_string += URI.parse(url).path.downcase
+          composite_string += "?" + URI.parse(url).query.downcase unless URI.parse(url).query.nil?
+        end
+        composite_string += "\n" +  canonicalize_custom_headers
+      end
+
+      #.......................................................................................................
+      def canonicalize_custom_headers
+        headers.select do |key, value| 
+          /^x-emc-/.match(key)
+        end.sort.inject("") do |h, (k, v)|
+          h += "#{k}:#{v}\n"
+        end.chomp
+      end
+
+      #.......................................................................................................
+      def set_header_range(args, ext)
+        headers['range'] = "bytes=#{ext[:offset]}-#{ext[:offset]+ext[:length]-1}"
+      end
+
+      #.......................................................................................................
+      def extent(file, begin_offset, end_offset)
+        if file
+          file_offset = File.size(file) - 1
+          offset =  begin_offset.to_i
+          end_offset = end_offset.nil? ? file_offset : end_offset.to_i 
+          end_offset = file_offset if end_offset > file_offset
+          length = end_offset - offset + 1
+          {:offset => offset, :length => length}
+        end
+      end
+
+      #.......................................................................................................
+      def set_header_extent(args, ext)
+        args[:beginoffset] = ext[:offset]
+        args[:endoffset] = ext[:offset] + ext[:length] - 1 
+      end
+
+      #.......................................................................................................
+      def add_payload(args, ext)
+        if args[:file]
+          @payload = read_file(args[:file], ext[:offset], ext[:length])
+          if @payload
+            headers['content-length'] = ext[:length]
+            headers['content-md5'] = Base64.encode64(Digest::MD5.digest(payload)).chomp()
+          end
+        end
+      end
+
+      #.......................................................................................................
+      def credentials
+        curr_time = create_timestamp
+        {'x-emc-uid'    => subtenant + '/' + uid, 
+         'date'         => curr_time, 
+         'x-emc-date'   => curr_time, 
+         'content-type' => 'application/octet-stream',
+         'accept'       => '*/*'}
+      end
+
+    #### InstanceMethods
+    end
+
+     
+  ### Rest 
+  end
+
+#### Synaptic4r
+end