gfobh_scorer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 080e26edf9074f022c3bd6612767c60f5bab2afd
+  data.tar.gz: cc72592bb673faf93e3b0fc7dc989e238b4afbf8
+SHA512:
+  metadata.gz: 5a2dde201e4cb2ca82a1736e7b0b5d5cc1147c74661320571b458b340ae0bf96c6d112431fb9852f413ab5736172e60b73ee06fd38ce84166607446ef157021f
+  data.tar.gz: 3ad564bfccebc15bf0e88b324935b12529733eb4a5cd838830567c4602130b92c36d6549631e24ec017e9f4e77c3aad9821c00346d8dc56afd85fb1b957804e2

data/.gitignore

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,81 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec feature)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), the you will want to move the Guardfile
+## to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  watch(%r{lib/gfobh_scorer/(.*)\.rb}) do |m|
+    rspec.spec.("lib/#{m[1]}_spec.rb")
+  end
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Dan Langevin
+
+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,29 @@
+# GfobhScorer
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gfobh_scorer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gfobh_scorer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/bin/gfobh_scorer

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require 'gfobh_scorer'
+require 'yaml'
+
+config = begin
+  YAML.load_file(".config.yml")
+rescue
+  {}
+end
+
+# symoblize_keys
+symbolized = {}
+config.each_pair do |k,v|
+  symbolized[k.to_sym] ||= v
+end
+
+config.merge!(symbolized)
+
+scorer = GfobhScorer::Scorer.new(ARGV[0], config: config)
+
+if scorer.run
+  Kernel.exit(0)
+else
+  Kernel.exit(1)
+end

data/gfobh_scorer.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gfobh_scorer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gfobh_scorer"
+  spec.version       = GfobhScorer::VERSION
+  spec.authors       = ["Dan Langevin"]
+  spec.email         = ["dan.langevin@gmail.com"]
+  spec.description   = %q{Scoring tool for Get Fit Or Be Hacking}
+  spec.summary       = %q{Scoring tool}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 'rest-client'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "guard-rspec"
+end

data/lib/gfobh_scorer.rb

@@ -0,0 +1,6 @@
+require "gfobh_scorer/version"
+require "gfobh_scorer/scorer"
+
+module GfobhScorer
+  # Your code goes here...
+end

data/lib/gfobh_scorer/scorer.rb

@@ -0,0 +1,211 @@
+require 'json'
+require 'restclient'
+
+module GfobhScorer
+  class Scorer
+    BASE_URL = 'https://gfobh.herokuapp.com'
+
+    def initialize(track_name, opts = {})
+      @track_name = track_name
+      @stdout = opts[:stdout] || STDOUT
+      @stderr = opts[:stderr] || STDERR
+      @config = opts[:config] || {}
+      @current_example = 1
+    end
+
+    def run
+      # grab our inital seed value for this example se
+      curr = fetch_initial_seed
+
+      # loop through til we get a wrong answer (curr is false) or
+      # we have reached the end (curr is true)
+      while (curr = run_current_example(curr)) && is_seed_value(curr)
+        report_success
+        @current_example += 1
+      end
+
+      report_results(curr)
+      curr
+    end
+
+    private
+
+    attr_reader :config, :current_example, :stdout, :stderr, :track_name
+
+    def base_url
+      config[:base_url] || BASE_URL
+    end
+
+    #
+    # Run the current example script, benchmarking the
+    # amount of time it takes
+    #
+    # @param seed [String]
+    #
+    # @return [String] Result of the script
+    def benchmark_current_example(seed)
+      start = Time.now
+      log("running #{current_example_script} #{seed}")
+      ret = begin
+        `#{current_example_script} #{seed}`
+      rescue Errno::ENOENT
+        log("#{current_example_script} does not exist")
+        "" # blank output is considered a failure
+      end
+      timings[current_example] = (Time.now - start).to_f
+      ret.to_s.strip
+    end
+
+    #
+    # Get the name of the current example to run
+    #
+    # @return [type] [description]
+    def current_example_script
+      config["example_#{current_example}".to_sym] ||
+        "./bin/example_#{current_example}"
+    end
+
+
+    #
+    # alias for verify_current_answer with no args
+    #
+    # @return [String]
+    def fetch_initial_seed
+      verify_current_answer
+    end
+
+    def headers
+      { 'Accept' => 'application/json' }
+    end
+
+    def is_seed_value(curr)
+      ![true, false, nil].include?(curr)
+    end
+
+    #
+    # Log a message
+    # @param msg [String] The message
+    #
+    # @return [String] The message
+    def log(msg)
+      stdout.puts(msg) if config[:debug]
+    end
+
+    #
+    # Wrapper method to handle track-level reporting
+    #
+    # @param success [Boolean]
+    #
+    # @return [nil]
+    def report_results(success)
+      if success
+
+      else
+        report_failure
+      end
+
+      report_total_time
+
+      nil
+    end
+
+    #
+    # Helper function to print the total time it took
+    #
+    # @return [String]
+    def report_total_time
+      stdout.puts(
+        sprintf(
+          "Total time for all examples: %.4f seconds",
+          timings.values.reduce(0, :+)
+        )
+      )
+    end
+
+    #
+    # Helper function to print a failure message
+    #
+    # @return [nil]
+    def report_failure
+      stderr.puts(
+        "Your answer for example #{current_example} was incorrect"
+      )
+      nil
+    end
+
+    #
+    # Helper function to print a success message
+    #
+    # @return [nil]
+    def report_success
+      stdout.puts(
+        sprintf(
+          "Finished example #{current_example} in %.4f seconds.",
+          timings[current_example]
+        )
+      )
+      nil
+    end
+
+    #
+    # Runs current example and verifies the
+    # retsult
+    #
+    # @param seed [String] Seed value from the last example
+    #
+    # @return [Boolean, String] True if it was correct and this
+    # is the last example, false if incorrect, String value if there
+    # are more examples to run
+    def run_current_example(seed)
+      log("Running example #{current_example} with #{seed}")
+      answer = benchmark_current_example(seed)
+      return false if answer.empty?
+      verify_current_answer(answer)
+    end
+
+    #
+    # Hashmap of example timings
+    #
+    # @return [Hash]
+    def timings
+      @timings ||= {}
+    end
+
+
+    #
+    # Verify the answer from a script against our server
+    #
+    # @param answer = nil [String] Answer to the current example
+    #
+    # @return [Boolean, String] True if it was correct and this
+    # is the last example, false if incorrect, String value if there
+    # are more examples to run
+    def verify_current_answer(answer = nil)
+      full_url = [base_url, track_name, answer].compact.join('/')
+      log("Verifying #{full_url}")
+      RestClient.get(full_url, headers) do |response|
+        case response.code
+        # success
+        when 200
+          log(
+            "Retrieved new seed value #{JSON.parse(response.body)['seed']}"
+          )
+          JSON.parse(response.body)['seed']
+        # success and it's the last example
+        when 204
+          log("End of problem set")
+          true
+        # failure
+        when 404
+          log("Incorrect answer")
+          false
+        else
+          stderr.puts(
+            "Something has gone wrong.  Please try again"
+          )
+          Kernel.exit(1)
+        end
+      end
+    end
+  end
+end

data/lib/gfobh_scorer/version.rb

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

data/spec/lib/scorer_spec.rb

@@ -0,0 +1,180 @@
+require 'spec_helper'
+
+describe GfobhScorer::Scorer do
+  subject(:scorer) do
+    described_class.new(
+      track,
+      stdout: stdout,
+      stderr: stderr
+    )
+  end
+
+  let(:response1) do
+    double(
+      :response1,
+      code: 200,
+      body: JSON.unparse({
+        seed: 'seed-for-problem-1'
+      })
+    )
+  end
+
+  let(:response2) do
+    double(
+      :response2,
+      code: 200,
+      body: JSON.unparse({
+        seed: 'seed-for-problem-2'
+      })
+    )
+  end
+
+  let(:final_response) do
+    double(:final_response, code: 204)
+  end
+
+  let(:generic_response) do
+    double(
+      :generic_response,
+      code: 200,
+      body: JSON.unparse({ seed: 'foo' })
+    )
+  end
+
+  let(:headers) do
+    { 'Accept' => 'application/json' }
+  end
+
+  let(:not_found_response) do
+    double(
+      :not_found_response,
+      code: 404
+    )
+  end
+
+  let(:stderr) { StringIO.new }
+
+  let(:stdout) { StringIO.new }
+
+  let(:track) { 'problem_set_1' }
+
+  def make_url(seed = nil, base = GfobhScorer::Scorer::BASE_URL)
+    [base, track, seed]
+      .compact
+      .join('/')
+  end
+
+  describe 'When configuring a custom url and example path' do
+    subject(:scorer) do
+      described_class.new(
+        track,
+        stdout: stdout,
+        stderr: stderr,
+        config: {
+          base_url: 'http://foo.bar/baz',
+          example_1: '/path/to/example'
+        }
+      )
+    end
+
+    it 'hits the correct urls and scripts' do
+      expect(RestClient).to receive(:get)
+        .with(make_url(nil, 'http://foo.bar/baz'), headers)
+        .and_yield(response1)
+      expect(subject).to receive(:`)
+        .with('/path/to/example seed-for-problem-1')
+        .and_return('answer-for-problem-1')
+      expect(RestClient).to receive(:get)
+        .with(
+          make_url('answer-for-problem-1', 'http://foo.bar/baz'), headers
+        )
+        .and_yield(final_response)
+
+      expect(subject.run).to eql true
+    end
+  end
+
+  describe 'When fetching the initial example' do
+    before do
+      allow(RestClient).to receive(:get)
+        .and_yield(generic_response)
+      allow(subject).to receive(:`)
+        .and_return("")
+      expect(RestClient).to receive(:get)
+        .with(make_url, headers)
+        .and_yield(response1)
+      allow(stdout).to receive(:puts)
+      allow(stderr).to receive(:puts)
+
+      allow(subject).to receive(:`)
+        .with('./bin/example_1 seed-for-problem-1')
+        .and_return('answer-for-problem-1')
+    end
+
+    it 'loads the data based on the track of work' do
+      subject.run
+    end
+
+    describe 'with a correct first answer' do
+      before do
+        expect(RestClient).to receive(:get)
+          .with(make_url('answer-for-problem-1'), headers)
+          .and_yield(response2)
+      end
+
+      it 'hits the second url' do
+        subject.run
+      end
+
+      it 'reports the status of the first example' do
+        subject.run
+        expect(stdout).to have_received(:puts)
+          .with(/Finished example 1 in [\d\.]+ seconds/)
+      end
+
+      it 'reports the total elapsed time' do
+        subject.run
+        expect(stdout).to have_received(:puts)
+          .with(/Total time for all examples: [\d\.]+ seconds/)
+      end
+
+      describe 'with a correct second answer' do
+        before do
+          allow(subject).to receive(:`)
+            .with('./bin/example_2 seed-for-problem-2')
+            .and_return('answer-for-problem-2')
+        end
+
+        describe 'when the second example is the last one' do
+          before do
+            expect(RestClient).to receive(:get)
+              .with(make_url('answer-for-problem-2'), headers)
+              .and_yield(final_response)
+          end
+
+          it 'returns true' do
+            expect(subject.run).to eql true
+          end
+        end
+      end
+    end
+
+    describe 'with an incorrect first answer' do
+      before do
+        expect(RestClient).to receive(:get)
+          .with(make_url('answer-for-problem-1'), headers)
+          .and_yield(not_found_response)
+      end
+
+      it 'reports the error to stderr' do
+        subject.run
+        expect(stderr).to have_received(:puts)
+          .with("Your answer for example 1 was incorrect")
+      end
+
+      it 'returns false' do
+        expect(subject.run).to eql false
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'gfobh_scorer'

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: gfobh_scorer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dan Langevin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: guard-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'
+description: Scoring tool for Get Fit Or Be Hacking
+email:
+- dan.langevin@gmail.com
+executables:
+- gfobh_scorer
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/gfobh_scorer
+- gfobh_scorer.gemspec
+- lib/gfobh_scorer.rb
+- lib/gfobh_scorer/scorer.rb
+- lib/gfobh_scorer/version.rb
+- spec/lib/scorer_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Scoring tool
+test_files:
+- spec/lib/scorer_spec.rb
+- spec/spec_helper.rb
+has_rdoc: