noclist 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3019687793e737569a76be4f7fa4473db1199d0
+  data.tar.gz: 399e5a84038e2b8f66d0c79ebaf20e6ded9b6f6c
+SHA512:
+  metadata.gz: 29d7d87f0ec0508bcd3ba1f4f8a57286f1d5a2969f4ac858762f0e7c02f4adedab421e7ec974877de802d49aeef688488c70038eee795d37356784de7df50783
+  data.tar.gz: 31b97ddd7458e1a66c0228b7ce4fcc303adc6d36937abb6299a0b0a087378adaed00921b3932671077906315e0f34785a4e91526260a44a3037c471b364350eb

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,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.17.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 noclist.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    noclist (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    artii (2.1.2)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    httparty (0.16.4)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    minitest (5.11.3)
+    multi_xml (0.6.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  artii
+  bundler (~> 1.17)
+  byebug
+  httparty
+  noclist!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  thor (= 0.20.0)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Write your name
+
+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,28 @@
+# Noclist 🌌 
+
+Put your Ruby code in the file `lib/noclist`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Assuming your machine is set up for the Ruby ecosystem:
+
+    $ gem install noclist
+    $ bin/setup
+
+## Usage
+
+- To run the test-suite, run `rspec spec`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Noclist project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [Contributor Covenant](http://contributor-covenant.org). 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.

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 "noclist"
+
+# 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/exe/noclist

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+require 'noclist/cli'

data/homework.md

@@ -0,0 +1,77 @@
+Retrieve the NOC List
+The Bureau of Adversarial Dossiers and Securely Encrypted Code (BADSEC) has asked you to retrieve a list of VIP users.
+
+Fortunately, BADSEC provides an API to the agency you've been working with. Unfortunately, it's not the best API in the world.
+
+Your job is to write a program that securely and politely asks the BADSEC server for this list of users and prints it to stdout in JSON format.
+
+As the server that your application will be hitting is not well written, you should seek to minimize the amount of communication it does. Furthermore, you should write a client that is resilient to errors in the server.
+
+We will want to build and run your code from source, so please include the complete instructions for doing so in a COMMENTS file.
+
+Output Format
+Your application should output a JSON-formatted list of user ids to stdout:
+
+["9757263792576857988", "7789651288773276582", "16283886502782682407", "...etc"]
+Your application should exit with a status code of zero on success, and nonzero on failure.
+
+Log as much as you want to stderr, but make sure that stdout includes only the JSON output of your program if there is any; otherwise the results won't parse properly.
+
+Running the Server
+Ensure that you have docker installed on your system.
+
+The BADSEC server will run on port 8888. You can start it with:
+
+  $ docker run --rm -p 8888:8888 adhocteam/noclist
+
+You should see Listening on http://0.0.0.0:8888.
+
+If you have any trouble getting the server running, or any other questions about this homework, use the chat button in the lower right to contact us.
+
+Handling Errors
+You may treat a dropped connection or any response code other than 200 as a failure.
+
+Keep in mind that both the /auth and /users endpoints may fail.
+
+If a call to an endpoint fails, you should retry up to 2 times. If the call fails 3 times in a row, your application should exit with a non-zero status code to indicate failure.
+
+Avoid off by one errors! The correct sequence is: try -> fail -> retry -> fail -> retry -> exit if fail
+
+The server you have been given is just a demonstration server; it should not throw any errors.
+
+The production server your code will run against after you submit it will return non-200 responses and randomly drop connections; your code should be able to handle those errors.
+
+Server API
+Authentication
+The BADSEC server requires you to authenticate yourself by signing all requests with a provided auth token.
+
+To get the token, the first thing your application should do is call /auth. This endpoint will return a token you can use to generate the checksum for the subsequent user list call.
+
+If you have any questions about authenticating, use the chat button in the lower right to contact us.
+
+Checksum
+To request the user list, you will need to provide a checksum in the X-Request-Checksum header. To calculate this checksum, you should compute:
+
+sha256(<auth_token> + <request path>)
+For example, if you had auth token 12345 and were requesting /users, the checksum would be:
+
+sha256("12345/users") = c20acb14a3d3339b9e92daebb173e41379f9f2fad4aa6a6326a696bd90c67419
+and you would include that value as the X-Request-Checksum header in your request.
+
+The Endpoints
+GET /auth
+Before making further calls to the server, you must first call /auth to get an authentication token. The token will be valid until the server stops or issues another token.
+
+The server will return the authentication token in the Badsec-Authentication-Token HTTP header.
+
+Calling /auth will invalidate all previous auth tokens you have acquired, so make sure you use the most recent one.
+
+Note that, for unclear reasons, this API call returns a large amount of useless data in the response body. You should ignore this useless data; you only need the data in the header.
+
+GET /users
+This endpoint will return a list of 64-bit newline-separated user IDs like this one:
+
+9757263792576857988
+7789651288773276582
+1628388650278268240
+Make sure you send the X-Request-Checksum header to the /users endpoint.

data/lib/noclist/badsec.rb

@@ -0,0 +1,62 @@
+require "active_support/all"
+require "byebug"
+require "HTTParty"
+require 'digest'
+
+module Badsec
+  class User
+    def self.get_auth_token
+      begin
+        retries ||= 0
+
+        response = HTTParty.get('http://0.0.0.0:8888/auth')
+
+        if response.code != 200
+          STDERR.puts "Response: #{response.code}, #{response.message}"
+        end
+
+        auth_token = response.headers["badsec-authentication-token"]
+      rescue => e
+        STDERR.puts "Exception: #{e.message}"
+
+        if (retries += 1) < 2
+          puts "Retrying..."
+          retry
+        else
+          STDERR.puts "Exiting with status code: 1"
+          exit
+        end
+      end
+    end
+
+    def self.calc_checksum(auth_token)
+      checksum = Digest::SHA256.hexdigest "#{auth_token}/users"
+    end
+
+    def self.get_users(checksum)
+      begin
+        retries ||= 0
+
+        users_response = HTTParty.get('http://0.0.0.0:8888/users',
+        :headers => { 'X-Request-Checksum' => "#{checksum.upcase}" })
+
+        if users_response.code != 200
+          STDERR.puts "Response: #{users_response.code}, #{users_response.message}"
+        else
+          print JSON.parse(users_response.body.split.to_json)
+        end
+
+        users_response
+      rescue => e
+        STDERR.puts "Exception: #{e.message}"
+        if (retries += 1) < 2
+          puts "Retrying..."
+          retry
+        else
+          STDERR.puts "Exiting with status code: 1"
+          exit
+        end
+      end
+    end
+  end
+end

data/lib/noclist/cli.rb

@@ -0,0 +1,8 @@
+require "byebug"
+require_relative "badsec"
+  class Cli
+    extend Badsec
+    auth_token = Badsec::User.get_auth_token
+    checksum = Badsec::User.calc_checksum(auth_token)
+    Badsec::User.get_users(checksum)
+  end

data/lib/noclist/version.rb

@@ -0,0 +1,3 @@
+module Noclist
+  VERSION = "0.1.1"
+end

data/lib/noclist.rb

@@ -0,0 +1,2 @@
+require "noclist/version"
+require "noclist/cli"

data/noclist.gemspec

@@ -0,0 +1,47 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "noclist/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "noclist"
+  spec.version       = Noclist::VERSION
+  spec.authors       = ["Marceline the Vampire Queen"]
+  spec.email         = ["example@example.com"]
+
+  spec.summary       = %q{Securely asks the BADSEC server for a list of users}
+  spec.description   = %q{Securely asks the BADSEC server for a list of users}
+  spec.homepage      = "https://adventuretime.fandom.com/wiki/Marceline"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://adventuretime.fandom.com/wiki/Marceline"
+    spec.metadata["changelog_uri"] = "https://adventuretime.fandom.com/wiki/Marceline"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "artii"
+  spec.add_development_dependency "thor", "0.20.0"
+  spec.add_development_dependency "httparty"
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: noclist
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Marceline the Vampire Queen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: activesupport
+  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: 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: artii
+  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: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: Securely asks the BADSEC server for a list of users
+email:
+- example@example.com
+executables:
+- noclist
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/noclist
+- homework.md
+- lib/noclist.rb
+- lib/noclist/badsec.rb
+- lib/noclist/cli.rb
+- lib/noclist/version.rb
+- noclist.gemspec
+homepage: https://adventuretime.fandom.com/wiki/Marceline
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://adventuretime.fandom.com/wiki/Marceline
+  source_code_uri: https://adventuretime.fandom.com/wiki/Marceline
+  changelog_uri: https://adventuretime.fandom.com/wiki/Marceline
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Securely asks the BADSEC server for a list of users
+test_files: []