hackerearth_api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5537254bf289c52e0db918429bb18a5aab7cc2d4be4bbc908fee5a5e976c0f23
+  data.tar.gz: 514b215aa77243bc71bb5722f687659aeb4653992e6b1098ae7daa8ba9f8ba1c
+SHA512:
+  metadata.gz: 549efd586ba13969c86551c9755c0c3c56e26990fe317854cce5c157dc4640d57c20217ca089683d8ae3f3df69218912087a9cbf2e9b6bd2a2061f48b45a90c2
+  data.tar.gz: 30706976ff1c5cdde6d13faec86d36242483a996cfbd7ba66a3795d5d458f7784007731f440873422fab4229da797424aa645c3404ab38f51f5c11f4f0592a4d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in hackerearth_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Amandeep Singh
+
+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,67 @@
+# HackerearthApi
+
+A Ruby client for the official [Hackerearth API](https://www.hackerearth.com/docs/wiki/developers/v3/). Supports both the API endpoints. Can be used to compile and run code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hackerearth_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hackerearth_api
+
+## Usage
+
+### Creating a Instance
+To start using gem, you can create a new client instance by passing the client_secret to the constructor as
+```ruby
+	hacker = HackerearthApi.new("[your-client-secret]")
+```
+
+### Setting Parameters
+Since, the instance already has the client_secret you only need to pass rest of the parameters to make a request. 'source'(source code) and 'lang'(language) are the required parameters for both the calls, not passing them will raise an ```ExceptionHandler::InvalidParameterException``` exception. 
+
+To view the list of languages supported you can do as follows
+```ruby
+	HackerearthApi.languages
+```
+
+'time_limit' and 'memory_limit' should be atmost 5 and 262144 respectively, any values greater than maximum value are set to the maximum value.  
+
+### Making a Request
+Now you can further make compile and run calls to the API as follows by passing the parameters mentioned in the API documentation, in the form of a hash.
+```ruby
+	hacker.compile({:source=>"puts('Hello World!')", :lang=>"RUBY"})
+
+	hacker.run({:source=>"puts('Hello World!')", :lang=>"RUBY"})	
+```
+
+### Response from API
+The result of both the calls is in the form of a ruby hash. 
+It will contain the response same as mentioned in the API documentation, along with another key in hash named "status", which will be the http status of the reponse.
+
+### Editing the Instance
+You can view or change the current objects client_secret
+```ruby
+	# To read
+	hacker.client_secret_key  
+	
+	# To change
+	hacker.client_secret= [new-client-secret]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/amandeep511997/hackerearth_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hackerearth_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hackerearth_api.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hackerearth_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hackerearth_api"
+  spec.version       = HackerearthApi::VERSION
+  spec.authors       = ["Amandeep Singh"]
+  spec.email         = ["amandeep511997@gmail.com"]
+
+  spec.summary       = %q{Ruby library for the Hackerearth API.}
+  spec.homepage      = "https://github.com/amandeep511997/hackerearth_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "httparty", "~> 0.15.6"
+end

data/lib/hackerearth_api.rb

@@ -0,0 +1,20 @@
+require_relative "hackerearth_api/version"
+require_relative "hackerearth_api/client"
+require_relative "hackerearth_api/exception_handler"
+require_relative "hackerearth_api/message"
+require_relative "hackerearth_api/validation"
+
+module HackerearthApi
+
+	def self.new(*args)
+  		if args.length > 1
+  			raise(ExceptionHandler::InvalidParameterException, Message.invalid_argument_length(1, args.length))
+  		end
+  		Client.new(args[0])
+  	end
+
+  	def self.languages
+  		return Validation.supported_languages
+  	end
+
+end

data/lib/hackerearth_api/client.rb

@@ -0,0 +1,34 @@
+require_relative 'exception_handler'
+require_relative 'message'
+require_relative 'compile_parameters'
+require_relative 'run_parameters'
+require_relative 'response'
+
+class Client
+	
+	attr_accessor :client_secret_key
+	
+	def initialize(client_secret_key)
+		if client_secret_key == nil
+			raise(ExceptionHandler::InvalidParameterException, Message.client_secret_nil)
+		end
+		@client_secret_key = client_secret_key
+	end
+	
+	# compiles the code of the current object
+	# params must be a hash
+	def compile(params)
+		filtered_parameters = CompileParameters.get_params(params)
+		filtered_parameters[:client_secret] = @client_secret_key
+		Response.compile(filtered_parameters)	
+	end
+
+	# run the code of the current object
+	# params must be a hash
+	def run(params)
+		filtered_parameters = RunParameters.get_params(params)
+		filtered_parameters[:client_secret] = @client_secret_key
+		Response.run(filtered_parameters)
+	end
+
+end

data/lib/hackerearth_api/compile_parameters.rb

@@ -0,0 +1,39 @@
+require_relative "validation"
+
+class CompileParameters
+
+	def self.get_params(params)
+
+		filtered_params = {}
+
+		# Required parameters
+		unless params.key?(:source)
+			raise(ExceptionHandler::InvalidParameterException, Message.source_nil)
+		end
+		filtered_params[:source] = params[:source]
+		
+		unless params.key?(:lang)
+			raise(ExceptionHandler::InvalidParameterException, Message.lang_nil)
+		end
+		unless Validation.on_language(params[:lang])
+			raise(ExceptionHandler::InvalidParameterException, Message.language_not_supported)
+		end
+		filtered_params[:lang] = params[:lang]
+	
+		# Optional Parameters
+		if params.key?(:async)
+			filtered_params[:async] = params[:async]
+		end
+
+		if params.key?(:id)
+			filtered_params[:id] = params[:id]
+		end
+		
+		if params.key?(:callback)
+			filtered_params[:callback] = params[:callback]
+		end
+
+		return filtered_params
+	end
+
+end

data/lib/hackerearth_api/exception_handler.rb

@@ -0,0 +1,4 @@
+module ExceptionHandler
+	class InvalidParameterException < StandardError; end
+	
+end

data/lib/hackerearth_api/message.rb

@@ -0,0 +1,22 @@
+module Message
+	def self.client_secret_nil
+		"client_secret is needed. If you do not have a valid client_secret, 
+		please register your client at 'https://www.hackerearth.com/api/register'"
+	end
+
+	def self.source_nil
+		"source code is a required parameter"
+	end
+
+	def self.lang_nil
+		"lang is a required parameter"
+	end
+
+	def self.language_not_supported
+		"lang is either invalid or not supported"
+	end
+
+	def self.invalid_argument_length(req, passed)
+		"wrong number of arguments passed, required #{req}, passed #{passed}"
+	end
+end

data/lib/hackerearth_api/response.rb

@@ -0,0 +1,28 @@
+require "httparty"
+
+module Response
+
+	def self.compile(params)
+		compile_endpoint = "https://api.hackerearth.com/v3/code/compile/"
+		api_response = HTTParty.post(compile_endpoint, body: params)
+		parsed(api_response)
+	end
+
+	def self.run(params)
+		run_endpoint = "https://api.hackerearth.com/v3/code/run/"
+		api_response = HTTParty.post(run_endpoint, body: params)
+		parsed(api_response)
+	end
+
+private 
+	
+	def self.parsed(api_response)
+		response = api_response.parsed_response
+		response["status"] = api_response.code
+		return response
+	end
+end
+
+=begin
+HTTParty.post("https://api.hackerearth.com/v3/code/compile/", body: { :client_secret=> "3905bf1332df91f3d9fc3b505dc18701ddae39a1", :source=> "puts('Hello World')", :lang=> "RUBY"})	
+=end

data/lib/hackerearth_api/run_parameters.rb

@@ -0,0 +1,29 @@
+require_relative "validation"
+require_relative "compile_parameters"
+
+class RunParameters
+
+	def self.get_params(params)		
+		filtered_params = CompileParameters.get_params(params)
+
+		if params.key?(:time_limit) and params[:time_limit] < 6 
+			filtered_params[:time_limit] = params[:time_limit]
+		else 
+			filtered_params[:time_limit] = 5
+		end
+
+		if params.key?(:memory_limit) and params[:memory_limit] < 262145 
+			filtered_params[:memory_limit] = params[:memory_limit]
+		else 
+			filtered_params[:memory_limit] = 262144
+		end
+	
+		if params.key?(:input)
+			filtered_params[:input] = params[:input]
+		end		
+		
+		return filtered_params
+	end
+
+end
+

data/lib/hackerearth_api/validation.rb

@@ -0,0 +1,25 @@
+class Validation
+	
+	@@supported_languages = [
+		'C', 
+		'CPP', 
+		'CPP11', 
+		'CLOJURE', 
+		'CSHARP', 
+		'JAVA', 
+		'JAVASCRIPT', 
+		'HASKELL', 
+		'PERL', 
+		'PHP', 
+		'PYTHON', 
+		'RUBY'
+	]
+
+	def self.supported_languages
+		@@supported_languages
+	end
+
+	def self.on_language(lang)
+		@@supported_languages.include? lang
+	end
+end

data/lib/hackerearth_api/version.rb

@@ -0,0 +1,3 @@
+module HackerearthApi
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: hackerearth_api
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Amandeep Singh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.6
+description: 
+email:
+- amandeep511997@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hackerearth_api.gemspec
+- lib/hackerearth_api.rb
+- lib/hackerearth_api/client.rb
+- lib/hackerearth_api/compile_parameters.rb
+- lib/hackerearth_api/exception_handler.rb
+- lib/hackerearth_api/message.rb
+- lib/hackerearth_api/response.rb
+- lib/hackerearth_api/run_parameters.rb
+- lib/hackerearth_api/validation.rb
+- lib/hackerearth_api/version.rb
+homepage: https://github.com/amandeep511997/hackerearth_api
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Ruby library for the Hackerearth API.
+test_files: []