eval_in 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8115bfc81c8a3463fefbffc45ec42c3332f97207
-  data.tar.gz: a95be59582154a4f6c3c513cc5d00d66fe76deca
+  metadata.gz: e2ac0ca50e404a1fc715b523bc8b9db45a535408
+  data.tar.gz: 10ea5829dd2688d4d8ef0cb99e96698e444e4705
 SHA512:
-  metadata.gz: 065c36bb0cd8d3636629364ccbbaeba014199399ca115f036e817b1e13e1031926a232d4caa846e490a5b6ffc13897a9d7bd092da26f834e2db6ed5a0c727a01
-  data.tar.gz: cac7e40b378bf637481e5d5be154f885a15fb8c4d7a1e22c61ca9e89816f80bde1389b94b63185be6163ff985ccec49fc7d7b512e2e912a01dcefa026d8ba29b
+  metadata.gz: 6765c3a9120b8799828308b123b383c8534ef2efeb4be536a3f42416109ca67b984bb435147091fadee23596a3a25e599c832eb7eb185ea3f79f643a0b25c56b
+  data.tar.gz: 2a522bc23122290b37ec8f41de2b87206764db9699fb61fc577660fe685accdb93efd468f894d162046fb34975c0516ccff5b4eeec1a7b49e8259ee44d1a9a41

data/.gitignore

@@ -1,3 +1,4 @@
 *.gem
 .yardoc
 doc
+Gemfile.lock

data/Readme.md

@@ -157,19 +157,27 @@ Attribution
 
 Thanks to [Charlie Sommerville](https://twitter.com/charliesome) for making eval-in.
 
-Thanks to Mon Oui, I partially stole the implementation from his gem [cinch-eval-in](http://rubygems.org/gems/cinch-eval-in)
+Thanks to Mon Oui, I partially stole the first version of the implementation from his gem [cinch-eval-in](http://rubygems.org/gems/cinch-eval-in)
 
 
-License
--------
+Contributing
+------------
 
-              DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-     TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+Fork it, make your changes, send me a pull request.
+Make sure your code is tested and all tests pass.
 
-    0. You just DO WHAT THE FUCK YOU WANT TO.
+Run tests with `bundle exec rspec`, run integration tests with `bundle exec rspec -t integration`.
+
+
+<a href="http://www.wtfpl.net/"><img src="http://www.wtfpl.net/wp-content/uploads/2012/12/wtfpl.svg" height="20" alt="WTFPL" /></a> License
+-------
 
-No Warranty
------------
 
-The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.
+    Copyright (C) 2014 Josh Cheek <josh.cheek@gmail.com>
 
+    This program is free software. It comes without any warranty,
+    to the extent permitted by applicable law.
+    You can redistribute it and/or modify it under the terms of the
+    Do What The Fuck You Want To Public License,
+    Version 2, as published by Sam Hocevar.
+    See http://www.wtfpl.net/ for more details.

data/eval_in.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |s|
   It's this simple:
 
     result = EvalIn.call 'puts "hello, world"', language: "ruby/mri-2.1"
-    result.output # "hello, world\n"
+    result.output # "hello, world\\n"
 
   DESCRIPTION
   s.license     = "WTFPL"

data/lib/eval_in.rb

@@ -58,22 +58,25 @@ module EvalIn
     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.
+  #
+  # @example
+  #   result = EvalIn.call 'puts "hello, #{gets}"', stdin: 'world', language: "ruby/mri-2.1"
+  #   result.output # => "hello, world\n"
   def self.call(code, options={})
-    build_result get_code post_code(code, options)
+    build_result fetch_result_json post_code(code, options)
   end
 
+  # @api private
   def self.post_code(code, options)
     uri        = URI(options.fetch(:url, "https://eval.in/"))
     input      = options.fetch(:stdin, "")
-    language   = options.fetch(:language)
+    language   = options.fetch(:language) { raise ArgumentError, ":language is mandatory, but options only has #{options.keys.inspect}" }
     user_agent = 'http://rubygems.org/gems/eval_in'
     user_agent << " (#{options[:context]})" if options[:context]
     path       = uri.path
@@ -102,7 +105,8 @@ module EvalIn
     end
   end
 
-  def self.get_code(location)
+  # @api private
+  def self.fetch_result_json(location)
     if body = Net::HTTP.get(URI location)
       JSON.parse(body).merge('url' => location)
     else
@@ -110,6 +114,7 @@ module EvalIn
     end
   end
 
+  # @api private
   def self.build_result(response_json)
     status     = response_json['status']
     exitstatus = if    !status                   then nil # let it choose default

data/lib/eval_in/version.rb

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

data/spec/eval_in_spec.rb

@@ -162,7 +162,7 @@ RSpec.describe 'post_code' do
   end
 
   it 'raises an ArgumentError error if not given a language' do
-    expect { EvalIn.post_code code, {} }.to raise_error KeyError, /language/
+    expect { EvalIn.post_code code, {} }.to raise_error ArgumentError, /language/
   end
 
   it 'can override the url' do
@@ -194,7 +194,7 @@ end
 
 
 
-RSpec.describe 'get_code' do
+RSpec.describe 'fetch_result_json' do
   include WebMock::API
 
   def stub_eval_in(options={})
@@ -208,19 +208,19 @@ 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"
+    result = EvalIn.fetch_result_json "http://example.com/some-result.json"
     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://example.com'
-    expect { EvalIn.get_code "http://example.com" }.to \
+    expect { EvalIn.fetch_result_json "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'
+    result = EvalIn.fetch_result_json 'http://example.com'
     expect(result['url']).to eq 'http://example.com'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eval_in
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Josh Cheek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-24 00:00:00.000000000 Z
+date: 2014-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -65,8 +65,7 @@ description: |+
   It's this simple:
 
     result = EvalIn.call 'puts "hello, world"', language: "ruby/mri-2.1"
-    result.output # "hello, world
-  "
+    result.output # "hello, world\n"
 
 email:
 - josh.cheek@gmail.com