dyndrop 0.0.1 → 0.0.2

data/lib/dyndrop.rb

@@ -0,0 +1,2 @@
+require "dyndrop/version"
+require "dyndrop/client"

data/lib/dyndrop/auth_token.rb

@@ -0,0 +1,63 @@
+module Dyndrop
+  class AuthToken
+    class << self
+      def from_token_info(token_info)
+        new(
+          token_info[:token],
+          token_info[:refresh_token]
+        )
+      end
+
+      def from_hash(hash)
+        new(
+          hash[:token],
+          hash[:refresh_token]
+        )
+      end
+    end
+
+    def initialize(auth_header, refresh_token = nil)
+      @auth_header = auth_header
+      @refresh_token = refresh_token
+    end
+
+    attr_accessor :auth_header
+    attr_reader :refresh_token
+
+    def to_hash
+      {
+        :token => auth_header,
+        :refresh_token => @refresh_token
+      }
+    end
+
+    JSON_HASH = /\{.*?\}/.freeze
+
+    # TODO: rename to #data
+    def token_data
+      return @token_data if @token_data
+      return {} unless @auth_header
+
+      json_hashes = Base64.decode64(@auth_header.split(" ", 2).last)
+      data_json = json_hashes.sub(JSON_HASH, "")[JSON_HASH]
+      return {} unless data_json
+
+      @token_data = MultiJson.load data_json, :symbolize_keys => true
+    rescue MultiJson::DecodeError
+      {}
+    end
+
+    def auth_header=(auth_header)
+      @token_data = nil
+      @auth_header = auth_header
+    end
+
+    def expiration
+      Time.at(token_data[:exp])
+    end
+
+    def expires_soon?
+      (expiration.to_i - Time.now.to_i) < 60
+    end
+  end
+end

data/lib/dyndrop/baseclient.rb

@@ -0,0 +1,178 @@
+require "dyndrop/trace_helpers"
+require "net/https"
+require "net/http/post/multipart"
+require "multi_json"
+require "fileutils"
+require "forwardable"
+
+module Dyndrop
+  class BaseClient # :nodoc:
+    extend Forwardable
+
+    attr_reader :rest_client
+
+    def_delegators :rest_client, :target, :target=, :token,
+      :proxy, :proxy=, :trace, :backtrace, :backtrace=,
+      :log, :log=
+
+    def initialize(target = "https://api.dyndrop.com", token = nil)
+      @rest_client = Dyndrop::RestClient.new(target, token)
+      self.trace = false
+      self.backtrace = false
+      self.log = false
+    end
+
+    def token=(token)
+      if token.is_a?(String)
+        token = Dyndrop::AuthToken.new(token)
+      end
+
+      @rest_client.token = token
+    end
+
+    def trace=(trace)
+      @rest_client.trace = trace
+    end
+
+    # Cloud metadata
+    def info
+      get("info", :accept => :json)
+    end
+
+    def get(*args)
+      request("GET", *args)
+    end
+
+    def delete(*args)
+      request("DELETE", *args)
+    end
+
+    def post(*args)
+      request("POST", *args)
+    end
+
+    def put(*args)
+      request("PUT", *args)
+    end
+
+    def request(method, *args)
+      if needs_token_refresh?
+        token.auth_header = nil
+        refresh_token!
+      end
+
+      path, options = normalize_arguments(args)
+      request, response = request_raw(method, path, options)
+      handle_response(response, options, request)
+    end
+
+    def request_raw(method, path, options)
+      @rest_client.request(method, path, options)
+    end
+
+    def stream_url(url, &blk)
+      uri = URI.parse(url)
+
+      Net::HTTP.start(uri.host, uri.port) do |http|
+        http.read_timeout = 5
+
+        req = Net::HTTP::Get.new(uri.request_uri)
+        req["Authorization"] = token.auth_header if token
+
+        http.request(req) do |response|
+          case response
+          when Net::HTTPOK
+            response.read_body(&blk)
+          when Net::HTTPNotFound
+            raise Dyndrop::NotFound.new(response.body, 404)
+          when Net::HTTPForbidden
+            raise Dyndrop::Denied.new(response.body, 403)
+          else
+            raise Dyndrop::BadResponse.new(response.body, response.code)
+          end
+        end
+      end
+    end
+
+    private
+
+    def needs_token_refresh?
+      token && token.auth_header && token.refresh_token && \
+        token.expires_soon?
+    end
+
+    def status_is_successful?(code)
+      (code >= 200) && (code < 400)
+    end
+
+    def handle_response(response, options, request)
+      if status_is_successful?(response[:status].to_i)
+        handle_successful_response(response, options)
+      else
+        handle_error_response(response, request)
+      end
+    end
+
+    def handle_successful_response(response, options)
+      if options[:return_response]
+        response
+      elsif options[:accept] == :json
+        parse_json(response[:body])
+      else
+        response[:body]
+      end
+    end
+
+    def handle_error_response(response, request)
+      body_json = parse_json(response[:body])
+      body_code = body_json && body_json[:code]
+      code = body_code || response[:status].to_i
+
+      if body_code
+        error_class = Dyndrop::APIError.error_classes[body_code] || Dyndrop::APIError
+        raise error_class.new(body_json[:description], body_code, request, response)
+      end
+
+      case code
+        when 404
+          raise Dyndrop::NotFound.new(nil, code, request, response)
+        when 403
+          raise Dyndrop::Denied.new(nil, code, request, response)
+        else
+          raise Dyndrop::BadResponse.new(nil, code, request, response)
+      end
+    end
+
+    def normalize_arguments(args)
+      if args.last.is_a?(Hash)
+        options = args.pop
+      else
+        options = {}
+      end
+
+      [normalize_path(args), options]
+    end
+
+    URI_ENCODING_PATTERN = Regexp.new("[^#{URI::PATTERN::UNRESERVED}]")
+
+    def normalize_path(segments)
+      if segments.size == 1 && segments.first =~ /^\//
+        segments.first
+      else
+        segments.flatten.collect { |x|
+          URI.encode(x.to_s, URI_ENCODING_PATTERN)
+        }.join("/")
+      end
+    end
+
+    def parse_json(x)
+      if x.empty?
+        raise MultiJson::DecodeError.new("Empty JSON string", [], "")
+      else
+        MultiJson.load(x, :symbolize_keys => true)
+      end
+    rescue MultiJson::DecodeError
+      nil
+    end
+  end
+end

data/lib/dyndrop/client.rb

@@ -0,0 +1,18 @@
+require "dyndrop/baseclient"
+require "dyndrop/rest_client"
+require "dyndrop/auth_token"
+
+require "dyndrop/v1/base"
+require "dyndrop/v1/client"
+
+module Dyndrop
+  class Client < BaseClient
+    def self.new(*args)
+      target, _ = args
+
+      base = super(target)
+
+      Dyndrop::V1::Client.new(*args)
+    end
+  end
+end

data/lib/dyndrop/errors.rb

@@ -0,0 +1,152 @@
+require "net/https"
+require "multi_json"
+require "yaml"
+
+module Dyndrop
+  # Base class for Dyndrop errors (not from the server).
+  class Error < RuntimeError
+  end
+
+  class Deprecated < Error
+  end
+
+  class Mismatch < Error
+    def initialize(expected, got)
+      @expected = expected
+      @got = got
+    end
+
+    def to_s
+      "Invalid value type; expected #{@expected.inspect}, got #{@got.inspect}"
+    end
+  end
+
+  class InvalidTarget < Error
+    attr_reader :target
+
+    def initialize(target)
+      @target = target
+    end
+
+    def to_s
+      "Invalid target URI: #{@target}"
+    end
+  end
+
+  class TargetRefused < Error
+    # Error message.
+    attr_reader :message
+
+    # Message varies as this represents various network errors.
+    def initialize(message)
+      @message = message
+    end
+
+    # Exception message.
+    def to_s
+      "target refused connection (#@message)"
+    end
+  end
+
+  class Timeout < Timeout::Error
+    attr_reader :method, :uri, :parent
+
+    def initialize(method, uri, parent = nil)
+      @method = method
+      @uri = uri
+      @parent = parent
+      super(to_s)
+    end
+
+    def to_s
+      "#{method} #{uri} timed out"
+    end
+  end
+
+  # Exception representing errors returned by the API.
+  class APIError < RuntimeError
+    include TraceHelpers
+
+    class << self
+      def error_classes
+        @error_classes ||= {}
+      end
+    end
+
+    attr_reader :error_code, :description, :request, :response
+
+    # Create an APIError with a given request and response.
+    def initialize(description = nil, error_code = nil, request = nil, response = nil)
+      @response = response
+      @request = request
+      @error_code = error_code || (response ? response[:status] : nil)
+      @description = description || parse_description
+    end
+
+    # Exception message.
+    def to_s
+      "#{error_code}: #{description}"
+    end
+
+    def request_trace
+      super(request)
+    end
+
+    def response_trace
+      super(response)
+    end
+
+    private
+
+    def parse_description
+      return unless response
+
+      parse_json(response[:body])[:description]
+    rescue MultiJson::DecodeError
+      response[:body]
+    end
+
+    def parse_json(x)
+      if x.empty?
+        raise MultiJson::DecodeError.new("Empty JSON string", [], "")
+      else
+        MultiJson.load(x, :symbolize_keys => true)
+      end
+    end
+  end
+
+  class NotFound < APIError
+  end
+
+  class Denied < APIError
+  end
+
+  class BadResponse < APIError
+  end
+
+  class UAAError < APIError
+  end
+
+  def self.define_error(class_name, code)
+    base =
+      case class_name
+      when /NotFound$/
+        NotFound
+      else
+        APIError
+      end
+
+    klass =
+      if const_defined?(class_name)
+        const_get(class_name)
+      else
+        Class.new(base)
+      end
+
+    APIError.error_classes[code] = klass
+
+    unless const_defined?(class_name)
+      const_set(class_name, klass)
+    end
+  end
+end

data/lib/dyndrop/rest_client.rb

@@ -0,0 +1,299 @@
+require "dyndrop/trace_helpers"
+require "net/https"
+require "net/http/post/multipart"
+require "multi_json"
+require "fileutils"
+
+module Dyndrop
+  class RestClient
+    include Dyndrop::TraceHelpers
+
+    LOG_LENGTH = 10
+
+    HTTP_METHODS = {
+      "GET" => Net::HTTP::Get,
+      "PUT" => Net::HTTP::Put,
+      "POST" => Net::HTTP::Post,
+      "DELETE" => Net::HTTP::Delete,
+      "HEAD" => Net::HTTP::Head,
+    }
+
+    DEFAULT_OPTIONS = {
+      :follow_redirects => true
+    }
+
+    attr_reader :target
+
+    attr_accessor :trace, :backtrace, :log, :request_id, :token, :target, :proxy
+
+    def initialize(target, token = nil)
+      @target = target
+      @token = token
+      @trace = false
+      @backtrace = false
+      @log = false
+    end
+
+    def request(method, path, options = {})
+      request_uri(method, construct_url(path), DEFAULT_OPTIONS.merge(options))
+    end
+
+    def generate_headers(payload, options)
+      headers = {}
+
+      if payload.is_a?(String)
+        headers["Content-Length"] = payload.size
+      elsif !payload
+        headers["Content-Length"] = 0
+      end
+
+      headers["X-Request-Id"] = @request_id if @request_id
+      headers["Authorization"] = @token.auth_header if @token
+      headers["Proxy-User"] = @proxy if @proxy
+
+      if accept_type = mimetype(options[:accept])
+        headers["Accept"] = accept_type
+      end
+
+      if content_type = mimetype(options[:content])
+        headers["Content-Type"] = content_type
+      end
+
+      headers.merge!(options[:headers]) if options[:headers]
+      headers
+    end
+
+    private
+
+    def request_uri(method, uri, options = {})
+      uri = URI.parse(uri)
+
+      unless uri.is_a?(URI::HTTP)
+        raise InvalidTarget.new(@target)
+      end
+
+      # keep original options in case there's a redirect to follow
+      original_options = options.dup
+      payload = options[:payload]
+
+      if params = options[:params]
+        if uri.query
+          uri.query += "&" + encode_params(params)
+        else
+          uri.query = encode_params(params)
+        end
+      end
+
+      unless payload.is_a?(String)
+        case options[:content]
+          when :json
+            payload = MultiJson.dump(payload)
+          when :form
+            payload = encode_params(payload)
+        end
+      end
+
+      method_class = get_method_class(method)
+      if payload.is_a?(Hash)
+        multipart = method_class.const_get(:Multipart)
+        request = multipart.new(uri.request_uri, payload)
+      else
+        request = method_class.new(uri.request_uri)
+        request.body = payload if payload
+      end
+
+      headers = generate_headers(payload, options)
+
+      request_hash = {
+        :url => uri.to_s,
+        :method => method,
+        :headers => headers,
+        :body => payload
+      }
+
+      print_request(request_hash) if @trace
+
+      add_headers(request, headers)
+
+      # TODO: test http proxies
+      http = Net::HTTP.new(uri.host, uri.port)
+
+      # TODO remove this when staging returns streaming responses
+      http.read_timeout = 300
+
+      if uri.is_a?(URI::HTTPS)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      before = Time.now
+      http.start do
+        response = http.request(request)
+        time = Time.now - before
+
+        response_hash = {
+          :headers => sane_headers(response),
+          :status => response.code,
+          :body => response.body
+        }
+
+        print_response(response_hash) if @trace
+        print_backtrace(caller) if @trace
+
+        log_request(time, request, response)
+
+        if response.is_a?(Net::HTTPRedirection) && options[:follow_redirects]
+          request_uri("GET", response["location"], original_options)
+        else
+          return request_hash, response_hash
+        end
+      end
+    rescue ::Timeout::Error => e
+      raise Timeout.new(method, uri, e)
+    rescue SocketError, Errno::ECONNREFUSED => e
+      raise TargetRefused, e.message
+    rescue URI::InvalidURIError
+      raise InvalidTarget.new(@target)
+    end
+
+    def construct_url(path)
+      uri = URI.parse(path)
+      return path if uri.scheme
+
+      path = "/#{path}" unless path[0] == ?\/
+      target + path
+    end
+
+    def get_method_class(method_string)
+      HTTP_METHODS[method_string.upcase]
+    end
+
+    def add_headers(request, headers)
+      headers.each { |key, value| request[key] = value }
+    end
+
+    def mimetype(content)
+      case content
+      when String
+        content
+      when :json
+        "application/json"
+      when :form
+        "application/x-www-form-urlencoded"
+      when nil
+        nil
+      # return request headers (not really Accept)
+      else
+        raise Dyndrop::Error, "Unknown mimetype '#{content.inspect}'"
+      end
+    end
+
+    def encode_params(hash, escape = true)
+      hash.keys.map do |k|
+        v = hash[k]
+        v = MultiJson.dump(v) if v.is_a?(Hash)
+        v = URI.escape(v.to_s, /[^#{URI::PATTERN::UNRESERVED}]/) if escape
+        "#{k}=#{v}"
+      end.join("&")
+    end
+
+    def log_data(time, request, response)
+      { :time => time,
+        :request => {
+          :method => request.method,
+          :url => request.path,
+          :headers => sane_headers(request)
+        },
+        :response => {
+          :code => response.code,
+          :headers => sane_headers(response)
+        }
+      }
+    end
+
+    def log_line(io, data)
+      io.printf(
+        "[%s]  %0.3fs  %6s -> %d  %s\n",
+        Time.now.strftime("%F %T"),
+        data[:time],
+        data[:request][:method].to_s.upcase,
+        data[:response][:code],
+        data[:request][:url])
+    end
+
+    def log_request(time, request, response)
+      return unless @log
+
+      data = log_data(time, request, response)
+
+      case @log
+      when IO
+        log_line(@log, data)
+        return
+      when String
+        if File.exists?(@log)
+          log = File.readlines(@log).last(LOG_LENGTH - 1)
+        elsif !File.exists?(File.dirname(@log))
+          FileUtils.mkdir_p(File.dirname(@log))
+        end
+
+        File.open(@log, "w") do |io|
+          log.each { |l| io.print l } if log
+          log_line(io, data)
+        end
+
+        return
+      end
+
+      if @log.respond_to?(:call)
+        @log.call(data)
+        return
+      end
+
+      if @log.respond_to?(:<<)
+        @log << data
+        return
+      end
+    end
+
+    def print_request(request)
+      $stderr.puts ">>>"
+      $stderr.puts request_trace(request)
+    end
+
+    def print_response(response)
+      $stderr.puts response_trace(response)
+      $stderr.puts "<<<"
+    end
+
+    def print_backtrace(locs)
+      return unless @backtrace
+
+      interesting_locs = locs.drop_while { |loc|
+        loc =~ /\/(dyndrop\/|restclient\/|net\/http)/
+      }
+
+      $stderr.puts "--- backtrace:"
+
+      $stderr.puts "... (boring)" unless locs == interesting_locs
+
+      trimmed_locs = interesting_locs[0..5]
+
+      trimmed_locs.each do |loc|
+        $stderr.puts "=== #{loc}"
+      end
+
+      $stderr.puts "... (trimmed)" unless trimmed_locs == interesting_locs
+    end
+
+    def sane_headers(obj)
+      hds = {}
+
+      obj.each_header do |k, v|
+        hds[k] = v
+      end
+
+      hds
+    end
+  end
+end