scrimp 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 731a784350083874df4db2c8c0cd5cf4fd9e7978
4
+ data.tar.gz: 22d1e98c7147569df49f6793a35af9d638ac691b
5
+ SHA512:
6
+ metadata.gz: 1e4292484d3ddc109277d579473a3e0a1c0b9594ea53fc28d86a5eb747168e44014550a3d583de812e541d2546854369b991d47e2469da5539f1b1b33be2475b
7
+ data.tar.gz: 471cd1e54e2fc7667ed57b2a8349015bd2981c704f0bc148f025f68ea8b85eed78b2766a938784bfeac17bf651e484d2249c3bdee335ea6517efcc59213f5e07
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/CONTRIBUTORS.txt ADDED
@@ -0,0 +1,6 @@
1
+ Cerner Corporation
2
+ Jacob Williams
3
+ Will Gorman
4
+ Kartik Vishwanath
5
+ Josh Murphy
6
+ Adam Stegman
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in scrimp.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/NOTICE.txt ADDED
@@ -0,0 +1,24 @@
1
+ Copyright 2013 Cerner Innovation, Inc.
2
+
3
+ Licensed under the Apache License, Version 2.0 (the "License");
4
+ you may not use this file except in compliance with the License.
5
+ You may obtain a copy of the License at
6
+
7
+ http://www.apache.org/licenses/LICENSE-2.0
8
+
9
+ Unless required by applicable law or agreed to in writing, software
10
+ distributed under the License is distributed on an "AS IS" BASIS,
11
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ See the License for the specific language governing permissions and
13
+ limitations under the License.
14
+
15
+ The CoffeeScript compiler is copyright by Jeremy Ashkenas and is used
16
+ under the MIT License. See http://coffeescript.org
17
+
18
+ jQuery is copyright by jQuery Foundation, Inc. and is used under the
19
+ MIT License. See https://jquery.org/license/
20
+
21
+ LESS - Leaner CSS is copyright by Alexis Sellier and is used under the
22
+ Apache v2 License. See http://lesscss.org
23
+
24
+ reset.css is public domain software retrieved from http://meyerweb.com/eric/tools/css/reset/
data/README.md ADDED
@@ -0,0 +1,95 @@
1
+ # Scrimp
2
+
3
+ This is a tool for testing Thrift services via a web browser (analogous to how you might test web services using a browser-based REST client).
4
+ Given the IDL files for the services, it provides a UI to help construct requests, invoke services, and display formatted responses.
5
+
6
+ Currently, services using the framed transport and either the compact or binary protocol are supported.
7
+
8
+ ## Installation
9
+
10
+ gem install scrimp
11
+
12
+ You must also have the Thrift compiler installed (tested with 0.9.0).
13
+
14
+ ## Usage
15
+
16
+ To start the server, run the scrimp command and pass in the path to a folder containing your service's IDL files:
17
+
18
+ scrimp folder/containing/thrift/files
19
+
20
+ Scrimp will recursively search the folder for files ending in `.thrift` and compile and load them. (By default, it invokes
21
+ the Thrift compiler as `thrift`; if you need to override this, use the `-t` option, e.g. `scrimp -t /usr/local/bin/thrift folder/containing/thrift/files`.)
22
+
23
+ Then open [http://localhost:7000](http://localhost:7000) (to override the port, use the `-p` option when starting scrimp).
24
+
25
+ A request editor is shown on the left. Initially you will see the 'structured editor'. This provides a list of the available services, functions,
26
+ and protocols, and generates a form for constructing requests for whatever function you select, based on the function's definition in your IDL.
27
+
28
+ Note that there will be a checkbox on the left of each optional field - this must be checked if you wish the field to be included in the request.
29
+
30
+ After you've constructed a request, click Invoke to send it; the result will be displayed on the right.
31
+
32
+ As an alternative to the structured editor, you can click 'edit request as json' to enter requests using the json format described below.
33
+ You can switch back and forth between the two editors without losing data; the json editor is helpful if you want to copy or paste a request or part of a request.
34
+
35
+ ### JSON Representation
36
+
37
+ Scrimp uses the following json format to represent Thrift objects:
38
+
39
+ * Thrift booleans, numeric types, and strings are represented via the corresponding json primitives.
40
+ * Thrift lists and sets are represented by json arrays.
41
+ * Thrift structs are represented by json objects, with keys corresponding to the field names. Optional fields are omitted from the object when they are omitted from the struct.
42
+ * Thrift maps are represented as arrays of key-value pairs. (They aren't represented via json objects, since Thrift maps may contain complex keys.)
43
+ * Thrift enum values can be represented by either the string name of the enum constant, or the integer value assigned to the constant in the enum's definition.
44
+
45
+ Full example of a request you could paste into scrimp, invoking a service which takes a single argument (`people`) which is a set of structs containing
46
+ a string (`name`) and enum (`favoriteWord`):
47
+
48
+ {
49
+ "service": "ExampleService",
50
+ "function": "greet",
51
+ "protocol": "Thrift::CompactProtocol",
52
+ "host": "localhost",
53
+ "port": "9000",
54
+ "args": {
55
+ "people": [
56
+ {
57
+ "name": "Howard",
58
+ "favoriteWord": "CYCLOPLEAN"
59
+ },
60
+ {
61
+ "name": "David",
62
+ "favoriteWord": "FANTOD"
63
+ }
64
+ ]
65
+ }
66
+ }
67
+
68
+ ### Example Service
69
+
70
+ If you check out the project, there is a sample Thrift service to aid in testing. Start it with
71
+
72
+ bundle exec sample/server.rb
73
+
74
+ It will start on port 9000. The Thrift compiler is assumed to be available as the command `thrift`; you can override this by passing
75
+ a `-t` argument, as described above for the `scrimp` command.
76
+
77
+ The IDL file is at sample/example.thrift, so start scrimp with:
78
+
79
+ bundle exec bin/scrimp sample
80
+
81
+ ## Contributing
82
+
83
+ This project is licensed under the Apache License, Version 2.0.
84
+
85
+ When contributing to the project please add your name to the CONTRIBUTORS.txt file. Adding your name to the CONTRIBUTORS.txt file signifies agreement to all rights and reservations provided by the License.
86
+
87
+ To contribute to the project execute a pull request through github. The pull request will be reviewed by the community and merged by the project committers. Please attempt to conform to the test, code conventions, and code formatting standards if any are specified by the project before submitting a pull request.
88
+
89
+ ## LICENSE
90
+
91
+ Copyright 2013 Cerner Innovation, Inc.
92
+
93
+ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
94
+
95
+ [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0) Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
data/Rakefile ADDED
@@ -0,0 +1,2 @@
1
+ #!/usr/bin/env rake
2
+ require "bundler/gem_tasks"
data/bin/scrimp ADDED
@@ -0,0 +1,44 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'scrimp'
4
+ require 'optparse'
5
+
6
+ options = {:port => 7000,
7
+ :thrift_command => 'thrift'}
8
+ parser = OptionParser.new do |op|
9
+ op.banner = 'Usage: scrimp FOLDER... [OPTIONS]'
10
+ op.on '-p', '--port PORT', 'port to launch UI server on' do |port|
11
+ options[:port] = port.to_i
12
+ end
13
+ op.on '-t', '--thrift-command COMMAND', 'thrift compiler' do |cmd|
14
+ options[:thrift_command] = cmd
15
+ end
16
+ op.on '-h', '--help' do
17
+ puts parser
18
+ exit 0
19
+ end
20
+ end
21
+
22
+ begin
23
+ parser.parse!
24
+ raise 'need arguments' if ARGV.empty?
25
+ rescue
26
+ puts parser
27
+ exit 0
28
+ end
29
+
30
+ Dir.mktmpdir do |out|
31
+ files = ARGV.map {|dir| Dir["#{dir}/**/*.thrift"]}.flatten
32
+ folders = files.map {|file| File.dirname(File.expand_path(file))}.uniq
33
+ include_directives = folders.map {|dir| "-I #{dir}"}.join(' ')
34
+ files.each do |file|
35
+ puts (cmd = "#{options[:thrift_command]} --gen rb -out #{out} #{include_directives} #{file}")
36
+ puts `#{cmd}`
37
+ end
38
+ $LOAD_PATH.unshift out
39
+ Dir["#{out}/*.rb"].each {|file| require file}
40
+ $LOAD_PATH.delete out
41
+ end
42
+
43
+ Scrimp::ThriftUtil.extend_structs
44
+ Scrimp::App.run! :port => options[:port]
data/lib/scrimp.rb ADDED
@@ -0,0 +1,7 @@
1
+ # coding: UTF-8
2
+
3
+ require 'thrift'
4
+ require 'scrimp/version'
5
+ require 'scrimp/json_thrift'
6
+ require 'scrimp/thrift_util'
7
+ require 'scrimp/app'
data/lib/scrimp/app.rb ADDED
@@ -0,0 +1,119 @@
1
+ # coding: UTF-8
2
+
3
+ require 'json'
4
+ require 'sinatra/base'
5
+
6
+ module Scrimp
7
+ class App < Sinatra::Base
8
+ set :static, true
9
+ set :public, File.expand_path('../public', __FILE__)
10
+ set :views, File.expand_path('../views', __FILE__)
11
+ set :haml, :format => :html5
12
+
13
+ get '/' do
14
+ haml :index
15
+ end
16
+
17
+ get '/services' do
18
+ response_map = {}
19
+ ThriftUtil.service_modules.each do |service|
20
+ functions = {}
21
+ ThriftUtil.service_functions(service).each do |function|
22
+ result_fields = ThriftUtil.service_result(service, function).const_get('FIELDS').dup
23
+ if result_fields.empty? || result_fields.all? {|_, field| field[:class] && ThriftUtil.qualified_const(field[:class].to_s) < Thrift::Exception}
24
+ returns = {type: 'VOID'}
25
+ else
26
+ returns = ThriftUtil.type_info(result_fields.delete(0)) # TODO shouldn't assume first is return?
27
+ end
28
+ throws = {}
29
+ result_fields.each do |(_, field)|
30
+ throws[field[:name]] = ThriftUtil.type_info field
31
+ end
32
+
33
+ args_fields = ThriftUtil.service_args(service, function).const_get('FIELDS')
34
+ args = {}
35
+ args_fields.each do |(_, field)|
36
+ args[field[:name]] = ThriftUtil.type_info field
37
+ end
38
+ functions[function] = {
39
+ :returns => returns,
40
+ :throws => throws,
41
+ :args => args
42
+ }
43
+ end
44
+ response_map[service] = functions
45
+ end
46
+
47
+ content_type :json
48
+ response_map.to_json
49
+ end
50
+
51
+ get '/protocols' do
52
+ protocols = {'Thrift::CompactProtocol'=>'Thrift::CompactProtocol',
53
+ 'Thrift::BinaryProtocol'=>'Thrift::BinaryProtocol'}
54
+ content_type :json
55
+ protocols.to_json
56
+ end
57
+
58
+ get '/structs' do
59
+ structs = {}
60
+ ThriftUtil.all_structs.each do |struct|
61
+ fields = {}
62
+ struct.const_get('FIELDS').each do |(_, field)|
63
+ fields[field[:name]] = ThriftUtil.type_info(field)
64
+ end
65
+ structs[struct] = fields
66
+ end
67
+ content_type :json
68
+ structs.to_json
69
+ end
70
+
71
+ post '/invoke' do
72
+ response_map = {}
73
+
74
+ if request.content_type == 'application/x-www-form-urlencoded' # yes it's lame
75
+ invocation = JSON.parse params['request-json']
76
+ else
77
+ invocation = JSON.parse request.body.read
78
+ end
79
+ service_class = ThriftUtil.qualified_const invocation['service']
80
+ args_class = ThriftUtil.service_args service_class, invocation['function']
81
+ result_class = ThriftUtil.service_result service_class, invocation['function']
82
+
83
+ args = args_class.const_get('FIELDS').sort.map do |(_, field_info)|
84
+ arg = invocation['args'][field_info[:name]]
85
+ if arg != nil
86
+ args_class.json_type_to_thrift_type arg, field_info
87
+ end
88
+ end.compact
89
+
90
+ begin
91
+ transport = Thrift::FramedTransport.new Thrift::Socket.new(invocation['host'], invocation['port'])
92
+ protocol_class = ThriftUtil.qualified_const invocation['protocol']
93
+ protocol = protocol_class.new transport
94
+ client = service_class.const_get('Client').new protocol
95
+ transport.open
96
+ result = client.send invocation['function'], *args
97
+ if return_type = result_class.const_get('FIELDS')[0]
98
+ response_map[:return] = ThriftUtil.thrift_type_to_json_type result, return_type
99
+ else # void
100
+ response_map[:return] = nil
101
+ end
102
+ rescue Thrift::ApplicationException => ex
103
+ response_map[ex.class] = {
104
+ :type => ThriftUtil.application_exception_type_string(ex.type),
105
+ :message => ex.message
106
+ }
107
+ rescue Thrift::Exception => ex
108
+ # this is untested
109
+ raise ex unless ex.class < Thrift::Struct
110
+ response_map[ex.class] = ThriftUtil.thrift_struct_to_json_map(ex, ex.class)
111
+ ensure
112
+ transport.close if transport
113
+ end
114
+
115
+ content_type :json
116
+ response_map.to_json
117
+ end
118
+ end
119
+ end