sphere_engine 1.0.0.pre → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 185caad5c30c326c2f79277da956e55af856758f
-  data.tar.gz: 5933e7fec69efafa69742b16850ae0d8ca693f64
+  metadata.gz: bb4c0b4802e0142d313d57835ca9e61df92b74dd
+  data.tar.gz: 7faa61513560ef2f210603f7a8d08723b07eba2b
 SHA512:
-  metadata.gz: 34c6da695966cb319124d9f45262b8a06490ceb9be0800b46397dfcea8d37e06d74e04df2275832d90783ef0aaf8b1024ea9d281587296b91173cb7a4f28b506
-  data.tar.gz: e145e35337fe70f6dbf3522712f5f7b6574e2fdeef0c49ca2240eb2884077d61a802b5ac934800d9e9cfd1549be326e151628655960e448398f9e6ded399ca79
+  metadata.gz: 99ffaa5b7d41ffb32c1940e0e9af831bb5dcde4cc4eae54cbaff7f1d5bf3547b8dd1429e2e2a666bc0317dbb2a5883372b6f0e9569b28ef838a62e097dc5794e
+  data.tar.gz: 72d6196504a31309d15f0b97beb3932d167a54057d11c7e5cb3fa5ea70be088bb9ab328b84e7508841c5c0e9ad4c159209d1991c558430681953feaf714684d1

data/README.md

@@ -1,6 +1,15 @@
 # SphereEngine
 
-I'm working right now!
+A Ruby interface to SphereEngine API. This gem was made as an interface to the SphereEngine API. It abstract in the best way all his methods that SphereEngine give us. This gem separates the requests into two types (compilers and problems), according to the SphereEngine documentation. For more information about SphereEngine visit this [Link](http://sphere-engine.com)
+
+## Prerequisites
+
+You need the following tokens:
+
+* Token for Compilers API
+* Token for problems API
+
+[SphereEngine Tokens](http://sphere-engine.com/tokens)
 
 ## Installation
 
@@ -18,9 +27,153 @@ Or install it yourself as:
 
     $ gem install sphere_engine
 
-## Usage
+## Configuration
+
+SphereEngine provide two services, one for compilers and another for problems. To start using a SpherEengine client do the following:
+
+```ruby
+client = SphereEngine::REST::Client.new do |config|
+  config.access_token_compilers = "YOUR_ACCESS_TOKEN_COMPILERS"
+  config.access_token_problems  = "YOUR_ACCESS_TOKEN_PROBLEMS"
+end
+```
+
+## Usage Examples
+After configuring a client, you can do the following things:
+
+### Compilers Service
+
+#### Get languages
+```ruby
+client.all_languages
+```
+
+#### Get compilers
+```ruby
+client.all_compilers
+```
+
+#### Create a submission
+
+This method return a submission_id
+```ruby
+client.create_submission_compiler(
+    language: 11, #LanguageID
+    sourceCode: "#include <iostream>\n using namespace std;\n int main()\n {\n cout << \"Hello World\" << endl;\n return 0;\n }" #Code example
+)
+```
+
+*Other params: input [string]*
+
+#### Fetch a submission
+```ruby
+client.fetch_submission_compilers(submission_id)
+```
+
+### Problems service
+
+#### Create a problem
+
+This method return a "code" is like a problem_id
+```ruby
+client.create_problem(
+    code: "RUBY_001", # Unique problem code. consist of 3 up to 16 capital letters. numbers and underscore
+    name: "Problem_Name", #String
+    body: "Write the fibonacci sequence" #String
+)
+```
+
+#### Create testcase to problem
+
+```ruby
+client.create_problem_testcase(
+    "PROBLEM_ID",
+    input: "input content",
+    timelimit: 10,
+    output: "output content"
+)
+```
+
+#### Update a problem
+
+```ruby
+client.update_problem("PROBLEM_ID", name: "NEW_NAME")
+```
+
+*Other params: type [string], interactive [boolean], masterjudgeId [integer], activeTestcases [array]*
+
+#### Get a list testcases of a problem
 
-TODO: Write usage instructions here
+```ruby
+client.list_testcases("PROBLEM_ID")
+```
+
+#### Get a testcase of a problem
+
+```ruby
+client.get_testcase("PROBLEM_ID", "TESTCASE_ID")
+```
+
+#### Get a file testcases of a problem
+```ruby
+client.get_testcase_file("PROBLEM_ID", "TESTCASE_ID", "FILENAME")
+```
+
+*Filename is obtained from get_testcase request in uri params*
+
+#### Get judge list
+
+```ruby
+client.all_judges()
+```
+
+*Other params: limit [Integer], offset [Integer], type [String]*
+
+#### Create judge
+
+```ruby
+client.create_judge(
+  name: "NameJudge",
+  source: "<source code>"
+)
+```
+
+*Other params: type [String], compilerId [Integer]*
+
+#### Get judge details
+
+```ruby
+client..get_judge("JUDGE_ID")
+```
+
+#### Update judge
+
+```ruby
+client.update_judge(
+  "JUDGE_ID",
+  name: "NewNameJudge",
+)
+```
+
+*Other params: source [String], compilerId [Integer]*
+
+#### Create a submission
+
+```ruby
+client.create_submission_problem(
+  problemCode: "RUBY_001", #problem_id
+  compilerId: 1, # get of all_request
+  source: "#include <iostream>\n using namespace std;\n int main()\n {\n cout << \"Hello World\" << endl;\n return 0;\n }" #Example
+)
+```
+
+*Other params: userId [Integer]*
+
+#### Fetch a submission
+
+```ruby
+client.fetch_submission_problems("SUBMISSION_ID")
+```
 
 ## Development
 
@@ -32,8 +185,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/14tinchov/sphere_engine. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+    

data/bin/console

@@ -8,7 +8,7 @@ require "sphere_engine"
 
 # (If you use this, don't forget to add pry to your Gemfile!)
 require "pry"
-Pry.start
+# Pry.start
 
 require "irb"
 IRB.start(__FILE__)

data/lib/sphere_engine/client.rb

@@ -1,3 +1,5 @@
+require 'sphere_engine/error'
+
 module SphereEngine
   class Client
     attr_accessor :access_token_compilers, :access_token_problems
@@ -25,5 +27,15 @@ module SphereEngine
     def credentials?
       credentials.values.all?
     end
+
+    # @return[String]
+    def get_token(service)
+      return case service
+      when :compilers
+        access_token_compilers
+      when :problems
+        access_token_problems
+      end
+    end
   end
 end

data/lib/sphere_engine/error.rb

@@ -0,0 +1,52 @@
+module SphereEngine
+  # Custom error class for rescuing from all SphereEngine errors
+  class Error < StandardError
+    # @return [Integer]
+    attr_reader :code
+
+    # Initializes a new Error object
+    #
+    # @param message [Exception, String]
+    # @param code [Integer]
+    # @return [SphereEngine::Error]
+    def initialize(message = '', code = nil)
+      super(message)
+      @code = code
+    end
+
+    # ClientErrors(Raised when SphereEngine returns a 4xx HTTP status code)
+    #
+    # Raised when SphereEngine returns the HTTP status code 400
+    BadRequest = Class.new(self)
+
+    # Raised when SphereEngine returns the HTTP status code 401
+    Unauthorized  = Class.new(self)
+
+    ERRORS = {
+      400 => SphereEngine::Error::BadRequest,
+      401 => SphereEngine::Error::Unauthorized
+    }
+
+    class << self
+      # Create a new error from an HTTP response
+      #
+      # @param body [String]
+      # @param headers [Hash]
+      # @return [SphereEngine::Error]
+      def from_response(body)
+        message, code = parse_error(body)
+        new(message, code)
+      end
+
+    private
+
+      def parse_error(body)
+        if body.nil? || body.empty?
+          ['', nil]
+        elsif  body["message"] || body[:message]
+          [ body["message"] || body[:message], nil]
+        end
+      end
+    end
+  end
+end

data/lib/sphere_engine/rest/access.rb

@@ -5,8 +5,8 @@ module SphereEngine
     module Access
       include SphereEngine::REST::Utils
 
-      def all_compilers(options = {} )
-        perform_get('/compilers', options)
+      def test_method
+        perform_get_requests_of_problems_service('/test')
       end
     end
   end

data/lib/sphere_engine/rest/api.rb

@@ -1,10 +1,22 @@
 require 'sphere_engine/rest/access'
+require 'sphere_engine/rest/languages'
+require 'sphere_engine/rest/compilers'
+require 'sphere_engine/rest/submissions'
+require 'sphere_engine/rest/problems'
+require 'sphere_engine/rest/test_cases'
+require 'sphere_engine/rest/judges'
 
 module SphereEngine
   module REST
     # @note All methods have been separated into modules and follow the same grouping used in {http://sphere-engine.com/services the SphereEngine API Documentation}.
     module API
       include SphereEngine::REST::Access
+      include SphereEngine::REST::Languages
+      include SphereEngine::REST::Compilers
+      include SphereEngine::REST::Submissions
+      include SphereEngine::REST::Problems
+      include SphereEngine::REST::TestCases
+      include SphereEngine::REST::Judges
     end
   end
-end
+end

data/lib/sphere_engine/rest/compilers.rb

@@ -0,0 +1,11 @@
+module SphereEngine
+  module REST
+    module Compilers
+      include SphereEngine::REST::Utils
+
+      def all_compilers
+        perform_get_requests_of_problems_service('/compilers')
+      end
+    end
+  end
+end

data/lib/sphere_engine/rest/judges.rb

@@ -0,0 +1,28 @@
+module SphereEngine
+  module REST
+    module Judges
+      include SphereEngine::REST::Utils
+
+      # @options [Hash]
+      def all_judges(options = {})
+        perform_get_requests_of_problems_service("/judges", options)
+      end
+
+      # @options [Hash]
+      def create_judge(options = {})
+        perform_post_requests_of_problems_service("/judges", options)
+      end
+
+      # @judge_id [String]
+      def get_judge(judge_id)
+        perform_get_requests_of_problems_service("/judges/#{judge_id}")
+      end
+
+      # @judge_id [String]
+      # @options [Hash]
+      def update_judge(judge_id, options = {})
+        perform_put_requests_of_problems_service("/judges/#{judge_id}", options)
+      end
+    end
+  end
+end

data/lib/sphere_engine/rest/languages.rb

@@ -0,0 +1,11 @@
+module SphereEngine
+  module REST
+    module Languages
+      include SphereEngine::REST::Utils
+
+      def all_languages
+        perform_get_requests_of_compílers_service('/languages')
+      end
+    end
+  end
+end

data/lib/sphere_engine/rest/problems.rb

@@ -0,0 +1,30 @@
+module SphereEngine
+  module REST
+    module Problems
+      include SphereEngine::REST::Utils
+
+      # @param options [Hash]
+      # This request you could send a limit and offset
+      def all_problems(options = {})
+        perform_get_requests_of_problems_service('/problems', options)
+      end
+
+      # @param options [Hash]
+      # This request you could send a limit and offset
+      def create_problem(options = {})
+        perform_post_requests_of_problems_service('/problems', options)
+      end
+
+      # @param code [String]
+      def get_problem(code)
+        perform_get_requests_of_problems_service("/problems/#{code}")
+      end
+
+      # @param code [String]
+      # @param options [Hash]
+      def update_problem(code, options = {})
+        perform_put_requests_of_problems_service("/problems/#{code}", options)
+      end
+    end
+  end
+end

data/lib/sphere_engine/rest/request.rb

@@ -1,48 +1,81 @@
 require 'addressable/uri'
 require 'http'
+require 'json'
 
 module SphereEngine
   module REST
     class Request
-      BASE_URL = 'https://09de42b6.problems.sphere-engine.com/api/v3'.freeze
-      attr_accessor :client, :headers, :options, :path, :request_method, :uri
+      BASE_URL_COMPILERS_SERVICE = 'https://09de42b6.compilers.sphere-engine.com/api/V3'.freeze
+      BASE_URL_PROBLEMS_SERVICE  = 'https://09de42b6.problems.sphere-engine.com/api/v3'.freeze
+      attr_accessor :client, :headers, :options, :service, :path, :request_method, :uri
 
       # @param client [SphereEngine::Client]
       # @param request_method [String, Symbol]
       # @param path [String]
       # @param options [Hash]
       # @return [SphereEngine::REST::Request]
-      def initialize(client, request_method, path, options = {})
+      def initialize(client, request_method, service, path, options = {})
         @client = client
-        @uri = Addressable::URI.parse(path.start_with?('http') ? path : BASE_URL + path)
+        @token  = client.get_token(service)
+        @service = service
+        @request_method = request_method
+        @uri = Addressable::URI.parse(path.start_with?('http') ? path : build_base_url + path)
         @path = uri.path
         @options = options
       end
 
       # @return [Array, Hash]
       def perform
-        response = HTTP.get(uri, :params => {:access_token => "37fcd1a005858e2d20112a21116a56f9"})
-        response_body = response.body.empty? ? '' : symbolize_keys!(response.parse)
+        response = build_http_request
+        response_body = response.body.empty? ? '' : format_to_response(response)
         fail_or_return_response_body(response.code, response_body)
       end
 
+      def format_to_response(response)
+        begin
+          JSON.parse(response.to_s)
+        rescue JSON::ParserError
+          response.to_s
+        end
+      end
+
       def fail_or_return_response_body(code, body)
-        # error = error(code, body, headers)
-        # raise(error) if error
+        error = error(code, body)
+        raise(error) if error
         body
       end
 
-      def symbolize_keys!(object)
-        if object.is_a?(Array)
-          object.each_with_index do |val, index|
-            object[index] = symbolize_keys!(val)
-          end
-        elsif object.is_a?(Hash)
-          object.keys.each do |key|
-            object[key.to_sym] = symbolize_keys!(object.delete(key))
-          end
+      def error(code, body)
+        klass = SphereEngine::Error::ERRORS[code]
+        if klass
+          klass.from_response(body)
+        end
+      end
+
+      def build_base_url
+        return case @service
+        when :compilers
+          BASE_URL_COMPILERS_SERVICE
+        when :problems
+          BASE_URL_PROBLEMS_SERVICE
         end
-        object
+      end
+
+      def build_http_request
+        return case @request_method
+        when :get
+          HTTP.get(uri, params: build_request_params)
+        when :post
+          HTTP.post(uri, params: build_request_params)
+        when :put
+          HTTP.put(uri, params: build_request_params)
+        end
+      end
+
+      def build_request_params
+        {
+          access_token: @token
+        }.merge(options)
       end
     end
   end

data/lib/sphere_engine/rest/submissions.rb

@@ -0,0 +1,29 @@
+module SphereEngine
+  module REST
+    module Submissions
+      include SphereEngine::REST::Utils
+
+      # @param options [Hash]
+      # This request you should send a compilerId and source
+      def create_submission_compiler(options = {})
+        perform_post_requests_of_compílers_service('/submissions', options)
+      end
+
+      # @param options [Hash]
+      # This request you should send a submissionId
+      def fetch_submission_compilers(submission_id, options = {})
+        perform_get_requests_of_compílers_service("/submissions/#{submission_id}")
+      end
+
+      # @param options [Hash]
+      def create_submission_problem(options = {})
+        perform_post_requests_of_problems_service('/submissions', options)
+      end
+
+      # @param options [Hash]
+      def fetch_submission_problems(submission_id)
+        perform_get_requests_of_problems_service("/submissions/#{submission_id}")
+      end
+    end
+  end
+end

data/lib/sphere_engine/rest/test_cases.rb

@@ -0,0 +1,33 @@
+module SphereEngine
+  module REST
+    module TestCases
+      include SphereEngine::REST::Utils
+
+      # @param problem_id [String]
+      def list_testcases(problem_id)
+        perform_get_requests_of_problems_service("/problems/#{problem_id}/testcases")
+      end
+
+      # @param problem_id [String]
+      # @options [Hash]
+      def create_problem_testcase(problem_id, options = {})
+        perform_post_requests_of_problems_service("/problems/#{problem_id}/testcases", options)
+      end
+
+      # @param problem_id  [String]
+      # @param testcase_id [String]
+      def get_testcase(problem_id, testcase_id)
+        perform_get_requests_of_problems_service("/problems/#{problem_id}/testcases/#{testcase_id}")
+      end
+
+      # @param problem_id  [String]
+      # @param testcase_id [String]
+      # @param filename    [String]
+      def get_testcase_file(problem_id, testcase_id, filename)
+        perform_get_requests_of_problems_service(
+          "/problems/#{problem_id}/testcases/#{testcase_id}/#{filename}"
+        )
+      end
+    end
+  end
+end

data/lib/sphere_engine/rest/utils.rb

@@ -4,12 +4,28 @@ module SphereEngine
   module REST
     module Utils
     private
-      def perform_get(path, options = {})
-        perform_request(:get, path, options)
+      def perform_get_requests_of_problems_service(path, options = {})
+        perform_request(:get, :problems, path, options)
       end
 
-      def perform_request(request_method, path, options = {})
-        SphereEngine::REST::Request.new(self, request_method, path, options).perform
+      def perform_get_requests_of_compílers_service(path, options = {})
+        perform_request(:get, :compilers, path, options)
+      end
+
+      def perform_post_requests_of_problems_service(path, options = {})
+        perform_request(:post, :problems, path, options)
+      end
+
+      def perform_post_requests_of_compílers_service(path, options = {})
+        perform_request(:post, :compilers, path, options)
+      end
+
+      def perform_put_requests_of_problems_service(path, options = {})
+        perform_request(:put, :problems, path, options)
+      end
+
+      def perform_request(request_method, service, path, options = {})
+        SphereEngine::REST::Request.new(self, request_method, service, path, options).perform
       end
     end
   end

data/lib/sphere_engine/version.rb

@@ -1,5 +1,5 @@
 module SphereEngine
   unless defined?(SphereEngine::VERSION)
-    VERSION = "1.0.0.pre".freeze
+    VERSION = "1.0.0".freeze
   end
 end

data/sphere_engine.gemspec

@@ -15,9 +15,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Martin Villalba"]
   spec.email         = ["14tinchov@gmail.com"]
 
-  spec.description   = %q{A Ruby interface to the SphereEngine API.}
-  spec.summary       = spec.description
-  spec.homepage      = "https://github.com/14tinchov/sphere-engine.git"
+  spec.summary       = %q{A Ruby interface to the SphereEngine API.}
+  spec.description   = %q{This gem was made as an interface to the SphereEngine API. I try to abstract in the best way all his methods that SphereEngine give us.}
+  spec.homepage      = "https://github.com/14tinchov/sphere-engine"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sphere_engine
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre
+  version: 1.0.0
 platform: ruby
 authors:
 - Martin Villalba
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-12 00:00:00.000000000 Z
+date: 2017-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -80,7 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: A Ruby interface to the SphereEngine API.
+description: This gem was made as an interface to the SphereEngine API. I try to abstract
+  in the best way all his methods that SphereEngine give us.
 email:
 - 14tinchov@gmail.com
 executables: []
@@ -99,14 +100,21 @@ files:
 - bin/setup
 - lib/sphere_engine.rb
 - lib/sphere_engine/client.rb
+- lib/sphere_engine/error.rb
 - lib/sphere_engine/rest/access.rb
 - lib/sphere_engine/rest/api.rb
 - lib/sphere_engine/rest/client.rb
+- lib/sphere_engine/rest/compilers.rb
+- lib/sphere_engine/rest/judges.rb
+- lib/sphere_engine/rest/languages.rb
+- lib/sphere_engine/rest/problems.rb
 - lib/sphere_engine/rest/request.rb
+- lib/sphere_engine/rest/submissions.rb
+- lib/sphere_engine/rest/test_cases.rb
 - lib/sphere_engine/rest/utils.rb
 - lib/sphere_engine/version.rb
 - sphere_engine.gemspec
-homepage: https://github.com/14tinchov/sphere-engine.git
+homepage: https://github.com/14tinchov/sphere-engine
 licenses:
 - MIT
 metadata:
@@ -122,9 +130,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.10