scrimp 1.0.0

data/lib/scrimp/public/reset.css

@@ -0,0 +1,48 @@
+/* http://meyerweb.com/eric/tools/css/reset/ 
+   v2.0 | 20110126
+   License: none (public domain)
+*/
+
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed, 
+figure, figcaption, footer, header, hgroup, 
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+  margin: 0;
+  padding: 0;
+  border: 0;
+  font-size: 100%;
+  font: inherit;
+  vertical-align: baseline;
+}
+/* HTML5 display-role reset for older browsers */
+article, aside, details, figcaption, figure, 
+footer, header, hgroup, menu, nav, section {
+  display: block;
+}
+body {
+  line-height: 1;
+}
+ol, ul {
+  list-style: none;
+}
+blockquote, q {
+  quotes: none;
+}
+blockquote:before, blockquote:after,
+q:before, q:after {
+  content: '';
+  content: none;
+}
+table {
+  border-collapse: collapse;
+  border-spacing: 0;
+}

data/lib/scrimp/thrift_util.rb

@@ -0,0 +1,171 @@
+# coding: UTF-8
+
+module Scrimp
+  module ThriftUtil
+    class << self
+      # use a fully-qualified name to get a constant
+      # no, it really doesn't belong here
+      # but life will almost certainly go on
+      def qualified_const(name)
+        name.split('::').inject(Object) {|obj, name| obj.const_get(name)}
+      end
+
+      def application_exception_type_string(type)
+        case type
+        when Thrift::ApplicationException::UNKNOWN
+          'UNKNOWN'
+        when Thrift::ApplicationException::UNKNOWN_METHOD
+          'UNKNOWN_METHOD'
+        when Thrift::ApplicationException::INVALID_MESSAGE_TYPE
+          'INVALID_MESSAGE_TYPE'
+        when Thrift::ApplicationException::WRONG_METHOD_NAME
+          'WRONG_METHOD_NAME'
+        when Thrift::ApplicationException::BAD_SEQUENCE_ID
+          'BAD_SEQUENCE_ID'
+        when Thrift::ApplicationException::MISSING_RESULT
+          'MISSING_RESULT'
+        when Thrift::ApplicationException::INTERNAL_ERROR
+          'INTERNAL_ERROR'
+        when Thrift::ApplicationException::PROTOCOL_ERROR
+          'PROTOCOL_ERROR'
+        else
+          type
+        end
+      end
+
+      # For every Thrift service, the code generator produces a module. This
+      # returns a list of all such modules currently loaded.
+      def service_modules
+        modules = []
+        ObjectSpace.each_object(Module) do |clazz|
+          if clazz < Thrift::Client
+            modules << qualified_const(clazz.name.split('::')[0..-2].join('::')) # i miss activesupport...
+          end
+        end
+        modules.delete(Thrift)
+        modules
+      end
+
+      # Given a service module (see service_modules above), returns a list of the names of all
+      # the functions of that Thrift service.
+      def service_functions(service_module)
+        methods = service_module.const_get('Client').instance_methods.map {|method| method.to_s}
+        methods.select do |method|
+          send_exists = methods.include? "send_#{method}"
+          upped = method.dup
+          upped[0..0] = method[0..0].upcase
+          begin
+            send_exists && service_module.const_get("#{upped}_args")
+          rescue
+            false
+          end
+        end
+      end
+
+      # Given a service module (see service_modules above) and a Thrift function name,
+      # returns the class for the structure representing the function's arguments.
+      def service_args(service_module, function_name)
+        function_name = function_name.dup
+        function_name[0..0] = function_name[0..0].upcase
+        service_module.const_get("#{function_name}_args")
+      end
+
+      # Given a service module (see service_modules above) and a Thrift function name,
+      # returns the class for the structure representing the function's return value.
+      def service_result(service_module, function_name)
+        function_name = function_name.dup
+        function_name[0..0] = function_name[0..0].upcase
+        service_module.const_get("#{function_name}_result")
+      end
+
+      # Returns a list of the classes for all Thrift structures that were loaded
+      # at the time extend_structs was called (see below).
+      def all_structs
+        @@all_structs
+      end
+
+      # Finds all loaded Thrift struct classes, adds methods to them
+      # for building them from hashes, and saves the list of them for
+      # future reference.
+      def extend_structs
+        @@all_structs = []
+        ObjectSpace.each_object(Module) do |clazz|
+          if Thrift::Struct > clazz || Thrift::Union > clazz
+            clazz.extend(JsonThrift)
+            @@all_structs << clazz
+          end
+        end
+      end
+
+      # Converts a Thrift struct to a hash (suitable for conversion to json).
+      def thrift_struct_to_json_map(value, clazz)
+        result = {}
+        clazz.const_get('FIELDS').each do |(_, struct_field)|
+          name = struct_field[:name]
+          val = value.send(name)
+          result[name] = thrift_type_to_json_type(val, struct_field) if val
+        end
+        result
+      end
+
+      # Converts a Thrift union to a hash (suitable for conversion to json).
+      def thrift_union_to_json_map(value, clazz)
+        result = {}
+        name = value.get_set_field.to_s
+        struct_field = clazz.const_get('FIELDS').find{|x| x[1][:name] == name}[1]
+        result[name] = thrift_type_to_json_type(value.get_value, struct_field)
+        result
+      end
+
+      # Converts a Thrift value to a primitive, list, or hash (suitable for conversion to json).
+      # The value is interpreted using a type info hash of the format returned by #type_info.
+      def thrift_type_to_json_type(value, field)
+        type = Thrift.type_name(field[:type])
+        raise Thrift::TypeError.new("Type for #{field.inspect} not found.") unless type
+        type.sub!('Types::', '')
+        result = value
+        type = 'UNION' if type == 'STRUCT' && field[:class].ancestors.any?{|x| x == Thrift::Union}
+        if type == 'STRUCT'
+          result = thrift_struct_to_json_map(value, field[:class])
+          # field[:class].const_get('FIELDS').each do |(_, struct_field)|
+          #   name = struct_field[:name]
+          #   val = value.send(name)
+          #   result[name] = thrift_type_to_json_type(val, struct_field) if val
+          # end
+        elsif type == 'LIST' || type == 'SET'
+          result = value.map {|val| thrift_type_to_json_type val, field[:element]}
+        elsif type == 'MAP'
+          result = value.map do |key, val|
+            [thrift_type_to_json_type(key, field[:key]), thrift_type_to_json_type(val, field[:value])]
+          end
+        elsif enum = field[:enum_class]
+          result = enum.const_get('VALUE_MAP')[value] || value
+        elsif type == 'UNION'
+          result = thrift_union_to_json_map(value, field[:class])
+        end
+        result
+      end
+
+      # Given a field description (as found in the FIELDS constant of a Thrift struct class),
+      # returns a hash containing these elements:
+      # - type - the name of the type, such as UNION, STRUCT, etc
+      # - key (for maps) - the type info hash of the map's keys
+      # - value (for maps) - the type info hash of the map's values
+      # - element (for lists, sets) - the type info hash of the collection's elements
+      # - enum (for enums) - a map of enum numeric value to name for the enum values
+      def type_info(field)
+        field = field.dup
+        field[:type] = Thrift.type_name(field[:type]).sub('Types::', '')
+        field.delete :name
+        field[:key] = type_info(field[:key]) if field[:key]
+        field[:value] = type_info(field[:value]) if field[:value]
+        field[:element] = type_info(field[:element]) if field[:element]
+        if enum = field[:enum_class]
+          field[:enum] = enum.const_get 'VALUE_MAP'
+        end
+        field
+      end
+    end
+  end
+end
+

data/lib/scrimp/version.rb

@@ -0,0 +1,5 @@
+# coding: UTF-8
+
+module Scrimp
+  VERSION = "1.0.0"
+end

data/lib/scrimp/views/index.haml

@@ -0,0 +1,45 @@
+!!! 5
+%html
+  %head
+    %title scrimp
+    %script{:type => 'text/javascript', :src => '/jquery-2.0.3.min.js'}
+    %script{:type => 'text/coffeescript', :src => '/main.coffee'}
+    %script{:type => 'text/javascript', :src => '/coffee-script-1.6.3.min.js'}
+    %link{:rel => 'stylesheet/css', :type => 'text/css', :href => '/reset.css'}
+    %link{:rel => 'stylesheet/less', :type => 'text/css', :href => '/main.less'}
+    %script{:type => 'text/javascript', :src => '/less-1.5.0.min.js'}
+  %body
+    .content.split-vertical
+      .request
+        %form.request-form{:action => "/invoke", :method => "post"}
+          %input.invoke{:type => 'submit', :value => 'Invoke'}
+          .structured-request
+            %a.show-raw-request{:href => '#'} edit request as json
+            .field
+              %label.service-field{:name => 'service'} Service
+              %select.service-field{:name => 'service'}
+            .field
+              %label.function-field{:name => 'function'} Function
+              %select.function-field{:name => 'function'}
+            .field
+              %label.protocol-field{:name => 'protocol'} Protocol
+              %select.protocol-field{:name => 'protocol'}
+            .field
+              %label.host-field{:name => 'host'} Host
+              %input.host-field{:name => 'host', :type => 'text'}
+            .field
+              %label.port-field{:name => 'port'} Port
+              %input.port-field{:name => 'port', :type => 'text'}
+            %ul.args-field.struct-field
+          .raw-request
+            %a.show-structured-request{:href => '#'} use structured editor
+            %textarea.request-json{:name => 'request-json'}
+      .response
+        .structured-response
+          %a.show-raw-response{:href => '#'} view json
+          %p.response-success Success!
+          %p.response-error
+          .response-details
+        .raw-response
+          %a.show-structured-response{:href => '#'} view formatted
+          .response-json

data/sample/example.thrift

@@ -0,0 +1,32 @@
+struct WordStats {
+  1: i64 count
+  2: double percentage
+  3: bool palindrome
+}
+
+enum Word {
+  BRUMAL = 1
+  CYCLOPLEAN = 2
+  FANTOD = 3
+}
+
+struct Person {
+  1: string name
+  2: optional Word favoriteWord
+}
+
+exception Tantrum {
+  1: string complaint
+}
+
+service ExampleService {
+  map<string, WordStats> textStats(1: string text)
+
+  string greet(1: set<Person> people)
+
+  double random()
+
+  void voidMethod(1: bool throwException) throws (1: Tantrum tantrum)
+
+  oneway void onewayMethod(1: string message)
+}

data/sample/server.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'tmpdir'
+
+options = {port: 9000,
+           thrift_command: 'thrift'}
+parser = OptionParser.new do |op|
+  op.on '-p', '--port PORT', 'port to launch Thrift server on' do |port|
+    options[:port] = port.to_i
+  end
+  op.on '-t', '--thrift-command COMMAND', 'thrift compiler' do |cmd|
+    options[:thrift_command] = cmd
+  end
+  op.on '-h', '--help' do
+    puts parser
+    exit 0
+  end
+end
+
+begin
+  parser.parse!
+rescue
+  puts parser
+  exit 0
+end
+
+Dir.mktmpdir do |out|
+  path = File.expand_path(File.join(File.dirname(__FILE__), 'example.thrift'))
+  puts (cmd = "#{options[:thrift_command]} --gen rb --out #{out} #{path}")
+  puts `#{cmd}`
+  $LOAD_PATH.unshift out
+  Dir["#{out}/*.rb"].each {|file| require file}
+  $LOAD_PATH.delete out
+end
+
+class ExampleServiceImpl
+  include ExampleService
+
+  # Example with map and struct in response.
+  def textStats(text)
+    words = text.split(/\b/).map {|w| w.gsub(/\W/, '').downcase}.reject(&:empty?)
+    results = {}
+    words.uniq.each do |word|
+      results[word] = WordStats.new count: words.count(word),
+                                    percentage: words.count(word).to_f / words.count.to_f,
+                                    palindrome: word == word.reverse
+    end
+    results
+  end
+
+  # Example with set, struct, and optional field in request.
+  GREETINGS = {1 => "Stay warm!",
+               2 => "Watch out for eldritch horrors!",
+               3 => "Try to calm down."}
+  def greet(people)
+    str = ""
+    people.each do |person|
+      str << "Hello, #{person.name}! #{GREETINGS[person.favoriteWord]}\n"
+    end
+    str
+  end
+
+  # Example with no request params.
+  def random
+    rand
+  end
+
+  def voidMethod(throwException)
+    raise Tantrum.new("We're out of hot chocolate!") if throwException
+  end
+
+  def onewayMethod(message)
+    puts "I received the following message, which I fully intend to ignore: #{message}"
+  end
+end
+
+processor = ExampleServiceImpl::Processor.new(ExampleServiceImpl.new)
+transport = Thrift::ServerSocket.new('localhost', options[:port])
+transport_factory = Thrift::FramedTransportFactory.new
+protocol_factory = Thrift::CompactProtocolFactory.new
+server = Thrift::SimpleServer.new(processor, transport, transport_factory, protocol_factory)
+
+puts "Starting example service for localhost on port #{options[:port]}"
+server.serve

data/scrimp.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/scrimp/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jacob Williams"]
+  gem.email         = ["jacob.williams@cerner.com"]
+  gem.description   = %q{Web UI for making requests to thrift services, given their IDL files.}
+  gem.summary       = %q{Generic UI for thrift services.}
+  gem.homepage      = "https://github.com/cerner/scrimp"
+  gem.licenses      = ['Apache 2']
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "scrimp"
+  gem.require_paths = ["lib"]
+  gem.version       = Scrimp::VERSION
+
+  gem.add_runtime_dependency 'thrift', '~> 0.9.1'
+  gem.add_runtime_dependency 'thin', '~> 1.6.0' # https://issues.apache.org/jira/browse/THRIFT-2145
+  gem.add_runtime_dependency 'haml', '~> 4.0.3'
+  gem.add_runtime_dependency 'json', '~> 1.8.1'
+  gem.add_runtime_dependency 'sinatra', '~> 1.4.4'
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: scrimp
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jacob Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thrift
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+description: Web UI for making requests to thrift services, given their IDL files.
+email:
+- jacob.williams@cerner.com
+executables:
+- scrimp
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CONTRIBUTORS.txt
+- Gemfile
+- LICENSE.txt
+- NOTICE.txt
+- README.md
+- Rakefile
+- bin/scrimp
+- lib/scrimp.rb
+- lib/scrimp/app.rb
+- lib/scrimp/json_thrift.rb
+- lib/scrimp/public/coffee-script-1.6.3.min.js
+- lib/scrimp/public/jquery-2.0.3.min.js
+- lib/scrimp/public/less-1.5.0.min.js
+- lib/scrimp/public/main.coffee
+- lib/scrimp/public/main.less
+- lib/scrimp/public/reset.css
+- lib/scrimp/thrift_util.rb
+- lib/scrimp/version.rb
+- lib/scrimp/views/index.haml
+- sample/example.thrift
+- sample/server.rb
+- scrimp.gemspec
+homepage: https://github.com/cerner/scrimp
+licenses:
+- Apache 2
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Generic UI for thrift services.
+test_files: []