eval_in 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5a172a314e520fe820972f9dbf6ba76c16a49ab
-  data.tar.gz: a7a6a571f986ca1296dd389f7476bfce7ac92bee
+  metadata.gz: 8115bfc81c8a3463fefbffc45ec42c3332f97207
+  data.tar.gz: a95be59582154a4f6c3c513cc5d00d66fe76deca
 SHA512:
-  metadata.gz: e2bbd5233868060a9d66f85e7ce75f8879276c8527d2d74587736eff267e78d5e31a5ce7a4c457076a54a5dfce1156b8c22a8cb5fddbdd596d1a44d1ea2763be
-  data.tar.gz: 3c688f0b063b24c5f938ae0ba06c4cfd7f7fda897be7f1842782e9757c2b0b7597ec536aa49a88e484061d3af8aa5cf1bf53c69802191aa4bf645ad887eb9120
+  metadata.gz: 065c36bb0cd8d3636629364ccbbaeba014199399ca115f036e817b1e13e1031926a232d4caa846e490a5b6ffc13897a9d7bd092da26f834e2db6ed5a0c727a01
+  data.tar.gz: cac7e40b378bf637481e5d5be154f885a15fb8c4d7a1e22c61ca9e89816f80bde1389b94b63185be6163ff985ccec49fc7d7b512e2e912a01dcefa026d8ba29b

data/.gitignore

@@ -1 +1,3 @@
 *.gem
+.yardoc
+doc

data/Readme.md

@@ -1,4 +1,4 @@
-[![Build Status](https://secure.travis-ci.org/JoshCheek/seeing_eval_in.png?branch=master)](http://travis-ci.org/JoshCheek/eval_in)
+[![Build Status](https://secure.travis-ci.org/JoshCheek/eval_in.png?branch=master)](http://travis-ci.org/JoshCheek/eval_in)
 
 EvalIn
 ======
@@ -17,10 +17,11 @@ result = EvalIn.call 'puts "hello, #{gets}"', stdin: 'world', language: "ruby/mr
 
 result.output             # => "hello, world\n"
 result.exitstatus         # => 0
+result.url                # => "https://eval.in/182711.json"
 result.language           # => "ruby/mri-2.1"
 result.language_friendly  # => "Ruby — MRI 2.1"
 result.code               # => "puts \"hello, \#{gets}\""
-result.status             # => "OK (0.052 sec real, 0.059 sec wall, 9 MB, 21 syscalls)"
+result.status             # => "OK (0.064 sec real, 0.073 sec wall, 9 MB, 21 syscalls)"
 ```
 
 

data/lib/eval_in/version.rb

@@ -1,3 +1,3 @@
 module EvalIn
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/eval_in.rb

@@ -10,7 +10,8 @@ module EvalIn
   RequestError   = Class.new EvalInError
   ResultNotFound = Class.new EvalInError
 
-  # curl https://eval.in | ruby -rnokogiri -e 'puts Nokogiri::HTML($stdin.read).css("option").map { |o| o["value"] }'
+  # @example Generated with
+  #   curl https://eval.in | ruby -rnokogiri -e 'puts Nokogiri::HTML($stdin.read).css("option").map { |o| o["value"] }'
   KNOWN_LANGUAGES = %w[
     c/gcc-4.4.3
     c/gcc-4.9.1
@@ -39,8 +40,10 @@ module EvalIn
     assembly/nasm-2.07
   ]
 
+  # The data structure containing the final result
+  # its attributes default to null-objects for their given type
   class Result
-    attr_accessor :exitstatus, :language, :language_friendly, :code, :output, :status
+    attr_accessor :exitstatus, :language, :language_friendly, :code, :output, :status, :url
 
     def initialize(attributes={})
       attributes = attributes.dup
@@ -50,26 +53,37 @@ module EvalIn
       self.code               = attributes.delete(:code)              || ""
       self.output             = attributes.delete(:output)            || ""
       self.status             = attributes.delete(:status)            || ""
+      self.url                = attributes.delete(:url)               || ""
       $stderr.puts "Unexpected attributes! #{attributes.keys.inspect}" if attributes.any?
     end
   end
 
+  # The primary way to use this library.
+  #
+  # @param code [String] the code to evaluate.
+  # @option options [String] :language Mandatory, a language recognized by eval.in, such as any value in {KNOWN_LANGUAGES}.
+  # @option options [String] :url      Override the url to post the code to
+  # @option options [String] :stdin    Will be passed as standard input to the script
+  # @option options [String] :context  Will be included in the user agent
+  # @return [Result] the relevant data from the evaluated code.
   def self.call(code, options={})
     build_result get_code post_code(code, options)
   end
 
   def self.post_code(code, options)
-    uri      = URI(options.fetch(:url, "https://eval.in/"))
-    input    = options.fetch(:stdin, "")
-    language = options.fetch(:language)
-    path     = uri.path
-    path     = '/' if path.empty?
+    uri        = URI(options.fetch(:url, "https://eval.in/"))
+    input      = options.fetch(:stdin, "")
+    language   = options.fetch(:language)
+    user_agent = 'http://rubygems.org/gems/eval_in'
+    user_agent << " (#{options[:context]})" if options[:context]
+    path       = uri.path
+    path       = '/' if path.empty?
 
-    # stole this out of implementation for post_form https://github.com/ruby/ruby/blob/trunk/lib/net/http.rb#L503
+    # stole this out of implementation for post_form https://github.com/ruby/ruby/blob/2afed6eceff2951b949db7ded8167a75b431bad6/lib/net/http.rb#L503
     request = Net::HTTP::Post.new(path)
     request.form_data = {"utf8" => "√", "code" => code, "execute" => "on", "lang" => language, "input" => input}
-    request['User-Agent'] = 'http://rubygems.org/gems/eval_in'
-    req.basic_auth uri.user, uri.password if uri.user
+    request['User-Agent'] = user_agent
+    request.basic_auth uri.user, uri.password if uri.user
     net = Net::HTTP.new(uri.hostname, uri.port)
     # net.set_debug_output $stdout
     result = Net::HTTP.start(uri.hostname, uri.port, use_ssl: (uri.scheme == 'https')) { |http|
@@ -90,7 +104,7 @@ module EvalIn
 
   def self.get_code(location)
     if body = Net::HTTP.get(URI location)
-      JSON.parse body
+      JSON.parse(body).merge('url' => location)
     else
       raise ResultNotFound, "No json at #{location.inspect}"
     end
@@ -109,6 +123,7 @@ module EvalIn
                language_friendly:   response_json['lang_friendly'],
                code:                response_json['code'],
                output:              response_json['output'],
-               status:              response_json['status']
+               status:              response_json['status'],
+               url:                 response_json['url']
   end
 end

data/spec/eval_in_spec.rb

@@ -28,13 +28,14 @@ RSpec.describe EvalIn, integration: true do
   end
 
   it 'evaluates Ruby code through eval.in' do
-    result = EvalIn.call 'print "hello, #{gets}"', stdin: "world", language: "ruby/mri-1.9.3"
+    result = EvalIn.call 'print "hello, #{gets}"', stdin: "world", language: "ruby/mri-1.9.3", context: 'eval_in integration test'
     expect(result.exitstatus       ).to eq 0
     expect(result.language         ).to eq "ruby/mri-1.9.3"
     expect(result.language_friendly).to eq "Ruby — MRI 1.9.3"
     expect(result.code             ).to eq 'print "hello, #{gets}"'
     expect(result.output           ).to eq "hello, world"
     expect(result.status           ).to match /OK \([\d.]+ sec real, [\d.]+ sec wall, \d MB, \d+ syscalls\)/
+    expect(result.url              ).to match %r(https://eval.in/\d+.json)
   end
 end
 
@@ -62,18 +63,21 @@ RSpec.describe EvalIn::Result do
                   language_friendly: '',
                   code:              '',
                   output:            '',
-                  status:            ''
+                  status:            '',
+                  url:               ''
     assert_result EvalIn::Result.new(language:          nil,
                                      language_friendly: nil,
                                      code:              nil,
                                      output:            nil,
-                                     status:            nil),
+                                     status:            nil,
+                                     url:               nil),
                   exitstatus:        -1,
                   language:          '',
                   language_friendly: '',
                   code:              '',
                   output:            '',
-                  status:            ''
+                  status:            '',
+                  url:               ''
   end
 
   it 'doesn\'t mutate the input attributes' do
@@ -125,13 +129,20 @@ RSpec.describe 'post_code' do
     EvalIn.post_code code, stdin: stdin, language: language
   end
 
-  it 'sets the user agent to its gem homepage' do
+  it 'defaults the user agent to its gem homepage' do
     stub_request(:post, url)
       .with(headers: {'User-Agent' => 'http://rubygems.org/gems/eval_in'})
       .to_return(status: 302, headers: {'Location' => result_location})
     EvalIn.post_code code, language: language
   end
 
+  it 'can add a context to the user agent' do
+    stub_request(:post, url)
+      .with(headers: {'User-Agent' => 'http://rubygems.org/gems/eval_in (some context)'})
+      .to_return(status: 302, headers: {'Location' => result_location})
+    EvalIn.post_code code, language: language, context: 'some context'
+  end
+
   it 'returns the redirect location jsonified' do
     stub_eval_in expected_data
     result = EvalIn.post_code code, stdin: stdin, language: language
@@ -160,6 +171,12 @@ RSpec.describe 'post_code' do
     EvalIn.post_code code, url: 'http://example.com', stdin: stdin, language: language
   end
 
+  it 'supports basic http auth' do
+    url.replace "http://user:pass@example.com"
+    stub_eval_in
+    EvalIn.post_code code, url: 'http://user:pass@example.com', stdin: stdin, language: language
+  end
+
   context 'when it gets a non-redirect' do
     it 'informs user of language provided and languages known if language is unknown' do
       stub_request(:post, "https://eval.in/").to_return(status: 406)
@@ -192,24 +209,31 @@ RSpec.describe 'get_code' do
   it 'queries the location, and inflates the json' do
     stub_eval_in(url: "http://example.com/some-result.json")
     result = EvalIn.get_code "http://example.com/some-result.json"
-    expect(result).to eq ruby_result
+    expect(result).to match hash_including(ruby_result)
   end
 
   it 'raises an error when it gets a non-200' do
-    stub_eval_in json_result: '', url: 'http://whatever.com'
-    expect { EvalIn.get_code "http://whatever.com" }.to \
-      raise_error EvalIn::ResultNotFound, %r(http://whatever.com)
+    stub_eval_in json_result: '', url: 'http://example.com'
+    expect { EvalIn.get_code "http://example.com" }.to \
+      raise_error EvalIn::ResultNotFound, %r(http://example.com)
+  end
+
+  it 'adds the url to the result' do
+    stub_eval_in url: 'http://example.com'
+    result = EvalIn.get_code 'http://example.com'
+    expect(result['url']).to eq 'http://example.com'
   end
 end
 
 
 RSpec.describe 'build_result' do
-  let(:language)          { 'some lang' }
+  let(:language)          { 'some lang'          }
   let(:language_friendly) { 'some lang friendly' }
-  let(:code)              { 'some code' }
-  let(:output)            { 'some output' }
-  let(:status)            { 'some status' }
-  let(:response_json)     { {'lang' => language, 'lang_friendly' => language_friendly, 'code' => code, 'output' => output, 'status' => status} }
+  let(:code)              { 'some code'          }
+  let(:output)            { 'some output'        }
+  let(:status)            { 'some status'        }
+  let(:url)               { 'some url'           }
+  let(:response_json)     { {'lang' => language, 'lang_friendly' => language_friendly, 'code' => code, 'output' => output, 'status' => status, 'url' => 'some url'} }
 
   it 'returns a response for the given response json' do
     result = EvalIn.build_result response_json
@@ -219,7 +243,8 @@ RSpec.describe 'build_result' do
                   language_friendly: language_friendly,
                   code:              code,
                   output:            output,
-                  status:            status
+                  status:            status,
+                  url:               url
   end
 
   # exit:      https://eval.in/182586.json

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eval_in
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Josh Cheek
@@ -11,28 +11,28 @@ cert_chain: []
 date: 2014-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-  prerelease: false
-  name: rspec
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.18'
-  prerelease: false
-  name: webmock
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -77,7 +77,6 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - Readme.md
 - eval_in.gemspec
 - lib/eval_in.rb

data/Gemfile.lock

@@ -1,37 +0,0 @@
-PATH
-  remote: .
-  specs:
-    eval_in (0.1.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.6)
-    crack (0.4.2)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.2.5)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.4)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.4)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.4)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.4)
-    safe_yaml (1.0.3)
-    webmock (1.18.0)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-
-PLATFORMS
-  java
-  ruby
-
-DEPENDENCIES
-  eval_in!
-  rspec (~> 3.0)
-  webmock (~> 1.18)