codewars_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff9541500bfc61638385d9e2010d8fb36849ecfe
+  data.tar.gz: de43d5cb962ab2a6eb8413e8364fb11e1f7a46db
+SHA512:
+  metadata.gz: a985134a455432475598a36659db4eb8f54e1f5d1dbbabb43de1a5538ec8b4d603ef24c47a3a53815192b12e7809be14623258bf81a3b25defd64d08279f15e1
+  data.tar.gz: ece055184af36e895fd0ccbf1a781515845fa32e7b742c5d321d42333cff26dce2622b112fa80ba19c6414e9fecb179de82af9f6142568230c11de785fe37a27

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/config/secrets.yml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in codewars_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 GustavoCaso
+
+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,252 @@
+# CodewarsClient
+
+Simple Wrapper for the [Codewars](http://www.codewars.com/) site, where you can improve your coding skills by completing Katas.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'codewars_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install codewars_client
+
+## Configuration
+To use this gem you have to have an account with [Codewars](http://www.codewars.com/).
+
+Then get the Api key from the profile settings and added to the gem.
+
+There are to ways of configuration.
+
+1- Block
+
+```ruby
+  CodewarsClient.configure do |config|
+	  config.api_key = API_KEY
+  end
+```
+
+2- Inline
+
+```ruby
+CodewarsClient.api_key = API_KEY
+```
+
+## Endpoints
+
+### User
+
+```ruby
+CodewarsClient.user(username_or_id: USERNAME_OR_ID)
+```
+
+It will return a `CodewarsClient::User` object with all the information of the user.
+
+```json
+{
+    "username": "some_user",
+    "name": "Some Person",
+    "honor": 544,
+    "clan": "some clan",
+    "leaderboardPosition": 134,
+    "skills": [
+        "ruby",
+        "c#",
+        ".net",
+        "javascript",
+        "coffeescript",
+        "nodejs",
+        "rails"
+    ],
+    "ranks": {
+        "overall": {
+            "rank": -3,
+            "name": "3 kyu",
+            "color": "blue",
+            "score": 2116
+        },
+        "languages": {
+            "javascript": {
+                "rank": -3,
+                "name": "3 kyu",
+                "color": "blue",
+                "score": 1819
+            },
+            "ruby": {
+                "rank": -4,
+                "name": "4 kyu",
+                "color": "blue",
+                "score": 1005
+            },
+            "coffeescript": {
+                "rank": -4,
+                "name": "4 kyu",
+                "color": "blue",
+                "score": 870
+            }
+        }
+    },
+    "codeChallenges": {
+        "totalAuthored": 3,
+        "totalCompleted": 230
+    }
+}
+
+```
+
+### Next Kata
+
+```ruby
+CodewarsClient.next_kata(language: LANGUAGE)
+```
+
+#### Valid languages
+
+```
+clojure
+coffescript
+c
+haskell
+java
+javascript
+python
+ruby
+```
+
+It accept language as `symbol` and `string`
+
+It will return a `CodewarsClient::NextKata` object with all the information of the kata and start a new training session.
+
+```json
+{
+   "success":true,
+   "name":"Anything to integer",
+   "slug":"anything-to-integer",
+   "description":"Your task is to program a function which converts any input to an integer.\n\nDo not perform rounding, the fractional part should simply be discarded.\n\nIf converting the input to an integer does not make sense (with an object, for instance), the function should return 0 (zero).\n\nAlso, Math.floor(), parseInt() and parseFloat() are disabled for your unconvenience.\n\nOnegaishimasu!",
+   "author":"Jake Hoffner",
+   "rank":-6,
+   "averageCompletion":125.4,
+   "tags":[
+      "Fundamentals",
+      "Integers",
+      "Data Types",
+      "Numbers"
+   ],
+   "session":{
+       "projectId":"523f66fba0de5d94410001cb",
+       "solutionId":"53bc968d35fd2feefd000013",
+       "setup":"function toInteger(n) {\n  \n}",
+       "exampleFixture":"Test.expect(toInteger(\"4.55\") === 4)",
+       "code":null
+   }
+}
+```
+
+### Attemp Solution
+
+```ruby
+CodewarsClient.attempt_solution(kata: NEXT_KATA_OBJECT , code: YOUR_CODE)
+```
+
+The `NEXT_KATA_OBJECT` could be any kind of object at least it has te respond to `solution_id` and `project_id` and return valid data related with the kata.
+
+Will submit a solution to be validated, this will return a deferred message id (dmid) which will be use to poll for the response.
+
+```json
+{
+   "success":true,
+   "dmid":"4rsdaDf8d"
+}
+```
+
+### Deferred Response
+
+```ruby
+CodewarsClient.deferred_response(dmid: DMID)
+```
+
+This is use for polling the response from the server. It will return a `CodewarsClient::DeferredResponse` object with al the information.
+
+```json
+{
+   "success":true,
+   "dmid":"4rsdaDf8d",
+   "valid": false,
+   "reason":"-e: Value is not what was expected (Test::Error)\n",
+   "output":[
+      "<div class='console-failed'>Value is not what was expected</div>"
+   ],
+   "wall_time":45
+}
+```
+
+### Finalize Solution
+
+```ruby
+CodewarsClient.finalize(kata: NEXT_KATA_OBJECT)
+```
+
+The `NEXT_KATA_OBJECT` could be any kind of object at least it has te respond to `solution_id` and `project_id` and return valid data related with the kata.
+
+This endpoint is used to finalize the previously submitted solution. This endpoint will only return a success message if there has been a previously successful solution.
+
+```json
+{
+   "success":true
+}
+```
+
+## Practical Example
+
+```ruby
+CodewarsClient.api_key = 'fake_api_key'
+
+def client
+  CodewarsClient
+end
+
+kata = client.next_kata(language: :ruby)
+
+# Read the kata information and complete it with some code !!!
+
+code = File.read('./solution.rb')
+
+attempt_solution = client.attempt_solution(kata: kata, code: code)
+
+10.times do
+  deferred_response = client.deferred_response(dmid: attempt_solution.dmid)
+  break if deferred_response.success
+end
+
+if deferred_response.valid
+  client.finalize_solution(kata: kata)
+else
+  warn deferred_response.reason
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+To been able to run the test or to use the api with the interactive prompt you will have to create a `secrest.yml` file inside the `config` folder and store a valid api_key. `api_key: VALID_API_KEY`
+
+Then, run `rake spec` to run the tests. Run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/GustavoCaso/codewars_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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/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,19 @@
+#!/usr/bin/env ruby
+require 'yaml'
+require "bundler/setup"
+require "codewars_client"
+
+config_file = YAML.load(File.read(File.expand_path('../../config/secrets.yml', __FILE__)))
+CodewarsClient.configure do |config|
+  config.api_key = config_file['api_key']
+end
+
+# 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

data/bin/setup

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

data/codewars_client.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'codewars_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "codewars_client"
+  spec.version       = CodewarsClient::VERSION
+  spec.authors       = ["GustavoCaso"]
+  spec.email         = ["gustavocaso@gmail.com"]
+
+  spec.summary       = %q{Codewars API Wrapper made with ruby}
+  spec.description   = %q{Codewars API Wrapper made with ruby}
+  spec.homepage      = "https://github.com/GustavoCaso/codewars_client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+
+  spec.add_runtime_dependency "faraday"
+end

data/config/secrets.example.yml

@@ -0,0 +1 @@
+api_key:

data/lib/codewars_client.rb

@@ -0,0 +1,59 @@
+require "codewars_client/finalize"
+require "codewars_client/deferred_response"
+require "codewars_client/attempt_solution"
+require "codewars_client/next_kata"
+require "codewars_client/user"
+require "codewars_client/client"
+require "codewars_client/configuration"
+require "codewars_client/version"
+require 'json'
+
+module CodewarsClient
+  class InvalidLanguageSelection < StandardError; end
+  extend Configuration
+  extend Client
+
+  VALID_LANGUAGES = [
+    :clojure, :coffescript, :c, :haskell, :java, :javascript, :python, :ruby
+  ]
+
+  class << self
+    def user(username_or_id:)
+      status, response = get(path: User::PATH, params: username_or_id)
+      User.new(data: _parse_response(status, response))
+    end
+
+    def next_kata(language:)
+      fail InvalidLanguageSelection unless VALID_LANGUAGES.include?(language.to_sym)
+      status, response = post(path: NextKata::PATH, params: [language.to_s, 'train'])
+      NextKata.new(data: _parse_response(status, response))
+    end
+
+    def attemp_solution(kata:, code:)
+      status, response = post(path: NextKata::PATH,
+        params: ['projects', kata.project_id, 'solutions', kata.solution_id, 'attempt'],
+        body: code
+      )
+      AttemptSolution.new(data: _parse_response(status, response))
+    end
+
+    def deferred_response(dmid:)
+      status, response = get(path: DeferredResponse::PATH, params: dmid)
+      DeferredResponse.new(data: _parse_response(status, response))
+    end
+
+
+    def finalize(kata:)
+      status, response = post(path: NextKata::PATH,
+        params: ['projects', kata.project_id, 'solutions', kata.solution_id, 'finalize']
+      )
+      Finalize.new(data: _parse_response(status, response))
+    end
+
+    private
+
+    def _parse_response(status, response)
+      JSON.parse(response).merge({'status' => status})
+    end
+  end
+end

data/lib/codewars_client/attempt_solution.rb

@@ -0,0 +1,11 @@
+require 'codewars_client/object_builder'
+
+module CodewarsClient
+  class AttemptSolution
+    include ObjectBuilder
+
+    def initialize(data:)
+      _build_object(data)
+    end
+  end
+end

data/lib/codewars_client/client.rb

@@ -0,0 +1,35 @@
+require 'faraday'
+module CodewarsClient
+  module Client
+    PUBLIC_METHODS = [:get, :post]
+    class ApiKeyMissingError < StandardError; end
+
+    PUBLIC_METHODS.each do |method|
+      define_method(method) do |path:, params:, body: nil|
+        fail ApiKeyMissingError.new(api_key_message) if CodewarsClient.api_key.nil?
+        response = request method: method, path: path, params: params, body: body
+        [response.status, response.body]
+      end
+    end
+
+    private
+    def conn
+      Faraday.new(url: CodewarsClient::Configuration::DEFAULT_ENDPOINT) do |c|
+        c.request  :url_encoded
+        c.adapter  Faraday.default_adapter
+      end
+    end
+
+    def request(method:, path:, params:, body:)
+      conn.send(method) do |req|
+        req.url File.join(path, params)
+        req.headers['Authorization'] = CodewarsClient.api_key
+        req.body = { code: body } unless body.nil?
+      end
+    end
+
+    def api_key_message
+      'Please set up your api key'
+    end
+  end
+end

data/lib/codewars_client/configuration.rb

@@ -0,0 +1,16 @@
+module CodewarsClient
+  module Configuration
+    PUBLIC_METHODS = [:api_key]
+
+    API_VERSION = 'v1'
+    DEFAULT_ENDPOINT = "https://www.codewars.com/api/#{API_VERSION}"
+
+    API_KEY_DEFAULT = nil
+
+    attr_accessor *PUBLIC_METHODS
+
+    def configure
+      yield self
+    end
+  end
+end

data/lib/codewars_client/deferred_response.rb

@@ -0,0 +1,12 @@
+require 'codewars_client/object_builder'
+
+module CodewarsClient
+  class DeferredResponse
+    include ObjectBuilder
+    PATH = 'deferred'
+
+    def initialize(data:)
+      _build_object(data)
+    end
+  end
+end

data/lib/codewars_client/finalize.rb

@@ -0,0 +1,11 @@
+require 'codewars_client/object_builder'
+
+module CodewarsClient
+  class Finalize
+    include ObjectBuilder
+
+    def initialize(data:)
+      _build_object(data)
+    end
+  end
+end

data/lib/codewars_client/next_kata.rb

@@ -0,0 +1,12 @@
+require 'codewars_client/object_builder'
+
+module CodewarsClient
+  class NextKata
+    include ObjectBuilder
+    PATH = 'code-challenges'
+
+    def initialize(data:)
+      _build_object(data)
+    end
+  end
+end

data/lib/codewars_client/object_builder.rb

@@ -0,0 +1,39 @@
+module CodewarsClient
+  module ObjectBuilder
+    def _build_object(data)
+      data.each do |key, value|
+        if value.is_a? Hash
+          _build_methods(value)
+        else
+          _mount_values_and_methods(key, value)
+        end
+      end
+    end
+
+    def _build_methods(values)
+      values.each do |key, value|
+        _mount_values_and_methods(key, value)
+      end
+    end
+
+    def _mount_values_and_methods(key, value)
+      new_key = _underscore_key(key)
+      _build_attr_reader(new_key)
+      _set_attr_value(new_key, value)
+    end
+
+    def _build_attr_reader(key)
+      self.class.instance_eval("attr_reader :#{key}")
+    end
+
+    def _set_attr_value(key, value)
+      instance_variable_set("@#{key}", value)
+    end
+
+    def _underscore_key(key)
+      match = key.match(/^([a-z]*)([A-Z].*)/)
+      return key unless match
+      "#{match[1]}_#{match[2].downcase}"
+    end
+  end
+end

data/lib/codewars_client/user.rb

@@ -0,0 +1,12 @@
+require 'codewars_client/object_builder'
+
+module CodewarsClient
+  class User
+    include ObjectBuilder
+    PATH = 'users'
+
+    def initialize(data:)
+      _build_object(data)
+    end
+  end
+end

data/lib/codewars_client/version.rb

@@ -0,0 +1,3 @@
+module CodewarsClient
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: codewars_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- GustavoCaso
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Codewars API Wrapper made with ruby
+email:
+- gustavocaso@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- codewars_client.gemspec
+- config/secrets.example.yml
+- lib/codewars_client.rb
+- lib/codewars_client/attempt_solution.rb
+- lib/codewars_client/client.rb
+- lib/codewars_client/configuration.rb
+- lib/codewars_client/deferred_response.rb
+- lib/codewars_client/finalize.rb
+- lib/codewars_client/next_kata.rb
+- lib/codewars_client/object_builder.rb
+- lib/codewars_client/user.rb
+- lib/codewars_client/version.rb
+homepage: https://github.com/GustavoCaso/codewars_client
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Codewars API Wrapper made with ruby
+test_files: []