codecube 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 416995da9d24911d7286cede8247327976701a50
+  data.tar.gz: c1643b4deca8c98a1a21182833726d4a02e8f170
+SHA512:
+  metadata.gz: 54bff8218c1552f0da6856b3b0f7e96bd9b43f3b6b345287477aba089ecc2ef134184c918f3c1f5e931f12e0e5d9fa9c446802a0c33a5b4f7dfa721f595cf90a
+  data.tar.gz: c52a86212fed50602ed3be19554df3255423c37d32aa9616f057bb7b33cb805560b7c88212044215bf1711a63349ad1e84ef7b96c81b2d07759e15834c8059d0

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Harry Marr
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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.

data/README.md

@@ -0,0 +1,34 @@
+# Codecube Ruby Client Library
+
+A Ruby client library for the codecube.io API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'codecube'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install codecube
+
+## Usage
+
+Initialize with your API key:
+
+```ruby
+CodeCube.api_key = ENV.fetch('CODECUBE_API_KEY')
+```
+
+Run code:
+
+```ruby
+response = CodeCube.run_sync(language: "ruby", code: "puts 'hello!'")
+puts response.text_output
+# => hello!
+```
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/codecube-ruby.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'codecube/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "codecube"
+  spec.version       = Codecube::VERSION
+  spec.authors       = ["Harry Marr"]
+  spec.email         = ["harry.marr@gmail.com"]
+  spec.summary       = %q{Ruby client library for codecube.io}
+  spec.homepage      = "http://codecube.io"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "typhoeus", "~> 0.6"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 1.18"
+  spec.add_development_dependency "vcr", "~> 2.9"
+end

data/lib/codecube.rb

@@ -0,0 +1,49 @@
+require "json"
+require "uri"
+require "typhoeus"
+require "codecube/response"
+
+module CodeCube
+  class AuthenticationError < StandardError; end
+  class ApiError < StandardError; end
+
+  API_BASE_URL = "http://api.codecube.io/"
+
+  class << self
+    attr_accessor :api_key
+
+    def run_sync(args = {})
+      require_args!(args, [:language, :code])
+      check_api_key!
+
+      response = Typhoeus.post(api_url("/sync-run/").to_s,
+                               body: JSON.dump(args),
+                               headers: { 'Authorization' => api_key })
+      case response.code
+      when 200 then return Response.new(JSON.parse(response.body))
+      when 401 then raise AuthenticationError, response.body
+      else raise ApiError, response.body
+      end
+    end
+
+    private
+
+    def check_api_key!
+      raise AuthenticationError, "no api_key set" if api_key.nil?
+    end
+
+    def require_args!(args, required_args)
+      Array(required_args).each do |arg|
+        if args[arg].nil?
+          raise ArgumentError, "missing required argument '#{arg}'"
+        end
+      end
+    end
+
+    def api_url(path)
+      uri = URI(API_BASE_URL)
+      uri.path = path
+      uri
+    end
+  end
+end

data/lib/codecube/response.rb

@@ -0,0 +1,25 @@
+module CodeCube
+  class Response
+    def initialize(data)
+      @data = data
+    end
+
+    def duration
+      @data["duration_ms"]
+    end
+
+    def timed_out?
+      @data["timed_out"]
+    end
+
+    def output
+      @data["output"]
+    end
+
+    def text_output
+      @data["output"].select { |l| %w(stdout stderr).include?(l["stream"]) }
+                     .map { |l| l["body"] }
+                     .join("\n")
+    end
+  end
+end

data/lib/codecube/version.rb

@@ -0,0 +1,3 @@
+module Codecube
+  VERSION = "0.0.1"
+end

data/spec/cassettes/bad_auth.yml

@@ -0,0 +1,31 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.codecube.io/sync-run/
+    body:
+      encoding: UTF-8
+      string: '{"code":"puts 1","language":"ruby"}'
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+      Authorization:
+      - invalid-api-key
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      Content-Type:
+      - text/plain; charset=utf-8
+      Date:
+      - Wed, 16 Jul 2014 22:47:51 GMT
+      Content-Length:
+      - '34'
+    body:
+      encoding: UTF-8
+      string: |
+        invalid authorization credentials
+    http_version: 
+  recorded_at: Wed, 16 Jul 2014 22:47:47 GMT
+recorded_with: VCR 2.9.2

data/spec/cassettes/run_sync.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.codecube.io/sync-run/
+    body:
+      encoding: UTF-8
+      string: '{"code":"puts 1","language":"ruby"}'
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+      Authorization:
+      - valid-api-key
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Accept, Authorization, Content-Type, Origin
+      Access-Control-Allow-Methods:
+      - GET, POST
+      Access-Control-Allow-Origin:
+      - '*'
+      Cache-Control:
+      - no-cache
+      X-Quota-Remaining:
+      - '999'
+      Date:
+      - Wed, 16 Jul 2014 22:43:58 GMT
+      Content-Length:
+      - '96'
+      Content-Type:
+      - text/plain; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: |
+        {"output":[{"type":"output","body":"1","stream":"stdout"}],"timed_out":false,"duration_ms":156}
+    http_version:
+  recorded_at: Wed, 16 Jul 2014 22:43:54 GMT
+recorded_with: VCR 2.9.2

data/spec/codecube_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+describe "CodeCube" do
+  describe ".api_key=" do
+    it "sets the api key" do
+      expect { CodeCube.api_key = 'foo' }.to change { CodeCube.api_key }
+    end
+  end
+
+  describe ".run_sync" do
+    subject { CodeCube.run_sync }
+
+    context "when required args are missing" do
+      it "throws an exception" do
+        expect { CodeCube.run_sync }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "with valid params" do
+      let(:api_endpoint) { "http://api.codecube.io/sync-run/" }
+      let(:api_key) { "valid-api-key" }
+      let(:params) { { code: "puts 1", language: "ruby" } }
+      let(:run_code) do
+        VCR.use_cassette("run_sync", match_requests_on: [:headers]) do
+          CodeCube.run_sync(params)
+        end
+      end
+
+      before { CodeCube.api_key = api_key }
+
+      context "but no api key" do
+        let(:api_key) { nil }
+
+        it "throws an exception" do
+          expect { run_code }.to raise_error(CodeCube::AuthenticationError)
+        end
+      end
+
+      context "but an invalid api key" do
+        let(:api_key) { "invalid-api-key" }
+
+        it "throws an exception" do
+          expect {
+            VCR.use_cassette("bad_auth") do
+              CodeCube.run_sync(params)
+            end
+          }.to raise_error(CodeCube::AuthenticationError)
+        end
+      end
+
+      it "hits the codecube api" do
+        run_code
+        expect(WebMock).to have_requested(:post, api_endpoint)
+      end
+
+      it "sends a json body" do
+        run_code
+        expect(WebMock).to have_requested(:post, api_endpoint).with do |req|
+          JSON.parse(req.body, symbolize_names: true) == params
+        end
+      end
+
+      it "includes an auth header" do
+        run_code
+        expect(WebMock).to have_requested(:post, api_endpoint).
+          with(headers: { "Authorization" => /#{api_key}/ })
+      end
+
+      it "returns a Response object" do
+        response = run_code
+        expect(response).to be_a(CodeCube::Response)
+        expect(response.text_output).to eq("1")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require "codecube"
+require "webmock/rspec"
+require "vcr"
+
+VCR.configure do |c|
+  c.cassette_library_dir = "spec/cassettes"
+  c.hook_into :webmock
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: codecube
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Harry Marr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: 
+email:
+- harry.marr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- codecube-ruby.gemspec
+- lib/codecube.rb
+- lib/codecube/response.rb
+- lib/codecube/version.rb
+- spec/cassettes/bad_auth.yml
+- spec/cassettes/run_sync.yml
+- spec/codecube_spec.rb
+- spec/spec_helper.rb
+homepage: http://codecube.io
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby client library for codecube.io
+test_files:
+- spec/cassettes/bad_auth.yml
+- spec/cassettes/run_sync.yml
+- spec/codecube_spec.rb
+- spec/spec_helper.rb