codewars 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e4dddc1a09377085643f16eea71fce41a4a9d31
+  data.tar.gz: 3cd42b90f917e19b5fa4bb38fe278b218d723daa
+SHA512:
+  metadata.gz: 6695455d2851b69dcaceda15efb5c9b78d35c3c482c4f1da7ed05e97aa6571b30ee0148787836a06ba8dc0796e359b5320b526e8170b0cf0d6353491e995d5c5
+  data.tar.gz: 107cb38b4d340d68e81f3d141c71cc82a99b7b38b30eaaf6f5dfc10111c2537b31efc5ec639a619297474fa166e8ed5a637cdce48dc8f350d14523558bb77168

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Evgeny Morozov
+
+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,49 @@
+# Codewars command-line tool
+
+## Installation
+
+Execute `gem install codewars`
+
+## Usage
+
+Execute `codewars help` to see all available commands.
+
+1. Set an api-key from the codewars website `codewars config key your-secret-key`
+2. Set a language you want to use `codewars config language ruby|javascript|etc`
+3. Choose a kata which you want to solve `codewars train`
+4. Start solving the kata `codewars train name-of-kata`
+5. Go to created folder `cd name-of-kata/language/`
+6. Look at description.md (use a Markdown viewer)
+7. According to the description of the kata change or create tests using your favorite test framework
+8. Change the solution.* file so the tests become green
+9. Upload the solution and wait for a response of tests on the server `codewars attempt`
+10. If there are no mistakes finalize the previously attempted solution `codewars finalize`
+11. Look at results of other people, rest and pick up another kata or the same kata but using another language
+
+## Development
+
+### TO-DO
+
+- [ ] Refactor anything you can
+- [ ] Add travis, coveralls, etc
+- [ ] Change the name of commands: attempt and finalize (join them to one command?)
+- [ ] Rename 'config' command? Maybe to 'set'?
+- [ ] Add options to commands that can be added: --strategy=something, --language=something, etc.
+- [ ] Make 100% coverage in simplecov
+- [ ] Write RSpec module tests
+- [ ] Divide description.md to task.md + info.yml?
+- [ ] Refactor features so stubbing (mocking) become more obvious
+
+## Contributing
+
+Bug reports, pull requests and ideas are welcome!
+
+Steps to make a pull request:
+
+1. Fork it ( https://github.com/evmorov/codewars/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Make changes
+4. Add tests for it
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create a new Pull Request

data/bin/codewars

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+Signal.trap('INT') { abort }
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'codewars/runner'
+Codewars::Runner.new(ARGV.dup).execute!

data/codewars.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'codewars/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'codewars'
+  spec.version       = Codewars::VERSION
+  spec.authors       = ['Evgeny Morozov']
+  spec.email         = ['evmorov@gmail.com']
+
+  spec.summary       = 'A command-line tool for Codewars'
+  spec.homepage      = 'https://github.com/evmorov/codewars'
+
+  spec.files         = %w(LICENSE README.md codewars.gemspec) + Dir['bin/*'] +
+                       Dir['lib/**/*.rb'] + Dir['lib/**/*.erb']
+  spec.executables   = Dir['bin/*'].map { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.licenses      = ['MIT']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'webmock', '~> 1.21'
+  spec.add_development_dependency 'aruba', '~> 0.11'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'rubocop'
+
+  spec.add_dependency 'codewars_api', '~> 0.2'
+  spec.add_dependency 'thor', '~> 0.19'
+end

data/lib/codewars.rb

@@ -0,0 +1,14 @@
+CODEWARS_URL = 'http://www.codewars.com'
+
+require 'codewars_api'
+require 'thor'
+require 'codewars/version'
+require 'codewars/configuration'
+require 'codewars/config'
+require 'codewars/language_extensions'
+require 'codewars/description'
+require 'codewars/train_specific'
+require 'codewars/train_next'
+require 'codewars/attempt'
+require 'codewars/finalize'
+require 'codewars/cli'

data/lib/codewars/attempt.rb

@@ -0,0 +1,60 @@
+module Codewars
+  class Attempt < Thor
+    def initialize
+      api_key = Configuration.option('api_key')
+      fail Thor::Error, 'You should set an api-key to use this command' unless api_key
+
+      desc = Description.new
+      project_id = desc.take_value_from_file(/Project ID: (\w+)/, 'Project ID')
+      solution_id = desc.take_value_from_file(/Solution ID: (\w+)/, 'Solution ID')
+      solution = read_solution_file
+
+      client = CodewarsApi::Client.new(api_key: api_key)
+      attempt = client.attempt_solution(
+        project_id: project_id,
+        solution_id: solution_id,
+        code: solution
+      )
+
+      say 'Your solution has been uploaded. Waiting for a result of tests on the server.'
+
+      deferred_response = deferred_response(client, attempt)
+      handle_deferred_response(deferred_response)
+    end
+
+    private
+
+    def read_solution_file
+      file_name = 'solution.*'
+      solution_filename = Dir.glob(file_name).first
+      unless solution_filename
+        fail Thor::Error, "The file '#{file_name}' has not been found in the current directory."
+      end
+      File.read File.expand_path(solution_filename)
+    end
+
+    def deferred_response(client, attempt)
+      seconds = ENV['CHECK_TIMEOUT'] || 10
+      seconds.to_i.times do
+        deferred_response = client.deferred_response(dmid: attempt.dmid)
+        return deferred_response if deferred_response.success
+        sleep 1
+      end
+      nil
+    end
+
+    def handle_deferred_response(deferred_response)
+      if deferred_response.nil? || !deferred_response.success
+        fail Thor::Error, "Can't get a result of tests on the server. Try it again."
+      end
+
+      if deferred_response.valid
+        say 'The solution has passed all tests on the server.'
+        say 'Type to finalize the solution: ' + set_color('codewars finalize', :blue, true)
+      else
+        error 'The solution has not passed tests on the server. Response:'
+        fail Thor::Error, set_color(deferred_response.reason, :red)
+      end
+    end
+  end
+end

data/lib/codewars/cli.rb

@@ -0,0 +1,25 @@
+module Codewars
+  class CLI < Thor
+    desc 'config SUBCOMMAND ...ARGS', 'Write options to the configuration file'
+    subcommand 'config', Config
+
+    desc 'train', 'Train a next kata'
+    def train(id_or_slug = nil)
+      if id_or_slug
+        TrainSpecific.new(id_or_slug)
+      else
+        TrainNext.new
+      end
+    end
+
+    desc 'attempt', 'Send a solution and get a result'
+    def attempt
+      Attempt.new
+    end
+
+    desc 'finalize', 'Finalize the previously attempted solution'
+    def finalize
+      Finalize.new
+    end
+  end
+end

data/lib/codewars/config.rb

@@ -0,0 +1,15 @@
+module Codewars
+  class Config < Thor
+    desc 'key YOUR_SECRET_KEY', 'Your api key'
+    def key(secret_key)
+      Configuration.write_option_to_config('api_key', secret_key)
+      say "You've successefully added the api-key to the configuration file"
+    end
+
+    desc 'language DEFAULT_LANGUAGE', 'A default language to use'
+    def language(default_language)
+      Configuration.write_option_to_config('language', default_language)
+      say "You've successefully added the default language to the configuration file"
+    end
+  end
+end

data/lib/codewars/configuration.rb

@@ -0,0 +1,28 @@
+require 'yaml'
+
+module Codewars
+  class Configuration
+    CONFIG_NAME = '.codewarsrc'
+
+    def self.write_option_to_config(option, value)
+      config_hash = config
+      config_hash[option] = value
+
+      config_str = ''
+      config_hash.each { |k, v| config_str += "#{k}: #{v}\n" }
+      File.write(config_path, config_str)
+    end
+
+    def self.config
+      File.exist?(config_path) ? YAML.load_file(config_path) : {}
+    end
+
+    def self.config_path
+      "#{ENV['HOME']}/#{CONFIG_NAME}"
+    end
+
+    def self.option(option)
+      config[option]
+    end
+  end
+end

data/lib/codewars/description.rb

@@ -0,0 +1,39 @@
+module Codewars
+  class Description < Thor::Shell::Basic
+    DESCRIPTION_FILE_NAME = 'description.md'
+
+    def take_value_from_file(regex_with_group, param_key)
+      @data ||= read_file(DESCRIPTION_FILE_NAME)
+      param = @data.match(regex_with_group)
+      unless param
+        fail Thor::Error, "'#{param_key}' has not been found in the 'description.md' file."
+      end
+      param[1]
+    end
+
+    def print_kata_desc(kata)
+      print_parameter('Name', kata.name)
+      print_parameter('Link', "#{CODEWARS_URL}#{kata.href}")
+      print_parameter('Description', kata.description)
+      print_parameter('Tags', kata.tags.join(', ')) if kata.tags
+      print_parameter('Rank', kata.rank.to_s) if kata.rank
+      say ''
+      print_parameter('Type to start this kata',
+                      "codewars train #{kata.slug}", :blue, true)
+    end
+
+    private
+
+    def read_file(file_name)
+      desc_path = File.expand_path(file_name)
+      unless File.exist? desc_path
+        fail Thor::Error, "The file '#{file_name}' has not been found in the current directory."
+      end
+      File.read(desc_path)
+    end
+
+    def print_parameter(parameter, value, value_color = nil, value_bold = false)
+      say set_color("#{parameter}: ", :green) + set_color(value, value_color, value_bold)
+    end
+  end
+end

data/lib/codewars/description_template.erb

@@ -0,0 +1,34 @@
+## Description of the kata
+
+Name: <%= kata.name %>
+
+URL: <%= codewars_url %>/kata/<%= kata.slug %>
+
+Author: <%= kata.author %>
+
+Rank: <%= kata.rank %>
+
+Slug: <%= kata.slug %>
+
+Project ID: <%= kata.project_id %>
+
+Solution ID: <%= kata.solution_id %>
+
+Tags: <%= kata.tags.join(', ') %>
+
+### Task
+
+<%= kata.description %>
+
+### Code
+
+```<%= language %>
+<%= kata.code_setup %>
+```
+<% unless kata.tests_setup.to_s.empty? %>
+### Test
+
+```<%= language %>
+<%= kata.tests_setup %>
+```
+<% end %>

data/lib/codewars/finalize.rb

@@ -0,0 +1,31 @@
+module Codewars
+  class Finalize < Thor
+    def initialize
+      api_key = Configuration.option('api_key')
+      fail Thor::Error, 'You should set an api-key to use this command' unless api_key
+
+      desc = Description.new
+      slug = desc.take_value_from_file(/Slug: ([a-zA-Z_-]+)/, 'Slug')
+      project_id = desc.take_value_from_file(/Project ID: (\w+)/, 'Project ID')
+      solution_id = desc.take_value_from_file(/Solution ID: (\w+)/, 'Solution ID')
+
+      client = CodewarsApi::Client.new(api_key: api_key)
+      result = client.finalize_solution(
+        project_id: project_id,
+        solution_id: solution_id
+      )
+      handle_result(result, slug)
+    end
+
+    private
+
+    def handle_result(result, slug)
+      if result.success
+        say 'Your solution has been finalized.'
+        say "Other solutions can be found here: #{CODEWARS_URL}/kata/#{slug}/solutions/"
+      else
+        fail Thor::Error, 'Something went wrong. Try to sumbit the solution again.'
+      end
+    end
+  end
+end

data/lib/codewars/language_extensions.rb

@@ -0,0 +1,18 @@
+module Codewars
+  class LanguageExtensions
+    MAPPING = {
+      'ruby' => 'rb',
+      'coffeescript' => 'coffee',
+      'javascript' => 'js',
+      'python' => 'py',
+      'haskell' => 'hs',
+      'csharp' => 'cs',
+      'closure' => 'clj'
+    }
+
+    def self.get(language)
+      extension = MAPPING[language]
+      extension ? extension : language
+    end
+  end
+end

data/lib/codewars/runner.rb

@@ -0,0 +1,56 @@
+require 'codewars'
+
+# to use Webmock we need the Runner class
+# https://github.com/cucumber/aruba#testing-ruby-cli-programs-without-spawning-a-new-ruby-process
+module Codewars
+  class Runner
+    def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = Kernel)
+      init_pry
+      @argv = argv
+      @stdin = stdin
+      @stdout = stdout
+      @stderr = stderr
+      @kernel = kernel
+    end
+
+    def execute!
+      exit_code = run_cli
+      @kernel.exit(exit_code)
+    end
+
+    private
+
+    def init_pry
+      require 'pry'
+      Pry.config.output = STDOUT # without this Pry does't work properly
+    rescue LoadError
+      nil
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def run_cli
+      exit_code = begin
+        $stderr = @stderr
+        $stdin = @stdin
+        $stdout = @stdout
+
+        Codewars::CLI.start(@argv)
+
+        0
+      rescue StandardError => e
+        b = e.backtrace
+        @stderr.puts("#{b.shift}: #{e.message} (#{e.class})")
+        @stderr.puts(b.map { |s| "\tfrom #{s}" }.join("\n"))
+        1
+      rescue SystemExit => e
+        e.status
+      ensure
+        $stderr = STDERR
+        $stdin = STDIN
+        $stdout = STDOUT
+      end
+
+      @kernel.exit(exit_code)
+    end
+  end
+end

data/lib/codewars/train_next.rb

@@ -0,0 +1,29 @@
+module Codewars
+  class TrainNext < Thor::Shell::Basic
+    def initialize
+      message = []
+      api_key = Configuration.option('api_key')
+      message.push 'You should set an api-key to use this command' unless api_key
+      language = Configuration.option('language')
+      message.push 'You should set an default language to use this command' unless language
+      fail Thor::Error, message.join("\n") unless message.empty?
+
+      client = CodewarsApi::Client.new(api_key: api_key)
+      kata = client.train_next_kata(
+        language: language,
+        peek: 'true',
+        strategy: 'default'
+      )
+      handle_next_kata(kata)
+    end
+
+    private
+
+    def handle_next_kata(kata)
+      if !kata.success && (kata.reason.eql? 'unauthorized')
+        fail Thor::Error, 'Wrong api key'
+      end
+      Description.new.print_kata_desc(kata)
+    end
+  end
+end

data/lib/codewars/train_specific.rb

@@ -0,0 +1,56 @@
+require 'erb'
+
+module Codewars
+  class TrainSpecific < Thor
+    def initialize(id_or_slug)
+      message = []
+      api_key = Configuration.option('api_key')
+      message.push 'You should set an api-key to use this command' unless api_key
+      language = Configuration.option('language')
+      message.push 'You should set an default language to use this command' unless language
+      fail Thor::Error, message.join("\n") unless message.empty?
+
+      say "Starting the '#{id_or_slug}' kata."
+
+      client = CodewarsApi::Client.new(api_key: api_key)
+      kata = client.train_specific_kata(
+        language: language,
+        id_or_slug: id_or_slug
+      )
+      handle_specific_kata(kata, language)
+    end
+
+    private
+
+    def handle_specific_kata(kata, language)
+      slug = kata.slug
+      write_kata(slug, language, 'description.md', description(kata, language))
+      exten = LanguageExtensions.get(language)
+      unless kata.tests_setup.to_s.empty?
+        write_kata(slug, language, "test.#{exten}", kata.tests_setup)
+      end
+      write_kata(slug, language, "solution.#{exten}", kata.code_setup)
+    end
+
+    def write_kata(slug, language, file_name, content)
+      dir_to_write = File.expand_path(slug)
+      Dir.mkdir dir_to_write unless File.directory?(dir_to_write)
+      Dir.mkdir "#{dir_to_write}/#{language}" unless File.directory?("#{dir_to_write}/#{language}")
+      file_path = File.expand_path("#{dir_to_write}/#{language}/#{file_name}")
+      relative_path = "./#{slug}/#{language}/#{file_name}"
+      fail Thor::Error, "'#{relative_path}' already exists." if File.exist? file_path
+
+      File.write(file_path, content)
+      say "'#{relative_path}' has been created."
+    end
+
+    def description(kata, language)
+      b = binding
+      b.local_variable_set(:kata, kata)
+      b.local_variable_set(:language, language)
+      b.local_variable_set(:codewars_url, CODEWARS_URL)
+      template_path = File.expand_path("#{File.dirname(__FILE__)}/description_template.erb")
+      ERB.new(File.read template_path).result(b)
+    end
+  end
+end

data/lib/codewars/version.rb

@@ -0,0 +1,3 @@
+module Codewars
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: codewars
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Evgeny Morozov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-03 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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: simplecov
+  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: rubocop
+  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: codewars_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+description: 
+email:
+- evmorov@gmail.com
+executables:
+- codewars
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/codewars
+- codewars.gemspec
+- lib/codewars.rb
+- lib/codewars/attempt.rb
+- lib/codewars/cli.rb
+- lib/codewars/config.rb
+- lib/codewars/configuration.rb
+- lib/codewars/description.rb
+- lib/codewars/description_template.erb
+- lib/codewars/finalize.rb
+- lib/codewars/language_extensions.rb
+- lib/codewars/runner.rb
+- lib/codewars/train_next.rb
+- lib/codewars/train_specific.rb
+- lib/codewars/version.rb
+homepage: https://github.com/evmorov/codewars
+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.5
+signing_key: 
+specification_version: 4
+summary: A command-line tool for Codewars
+test_files: []
+has_rdoc: