doppelserver 0.4.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4a3d986a23043595f710f3e936d015db53958202601dd8a609cc6c8734480ac
-  data.tar.gz: 790559c7e271aa596b2820009feed9d72f20cbab3767025b70f2692ec56e62c7
+  metadata.gz: 6b1b219ac52c0632c708b0187d92484a5a1c4881aa80b6cec2e59c317eb8ad7b
+  data.tar.gz: 4384f653e8558901121b2a47484a7677b4819dff7b1f5c9e1cc4d638a6b222b2
 SHA512:
-  metadata.gz: f46007a28857cde5ae9613b617b34d340edc5e074f5cb5e6db7e9a1e6407c9d7e729c299e1236ce4e9ae2b3f3f3c7bba04d6718512cc2287052d71bf6dc00de8
-  data.tar.gz: 43df8ba6f069df20bfa4f7a1730269f83b5d93f580691de116a711b34490f090c5df7c1aed6da4cd0cf0b01eb792febd4c7aec324d4d59083a7c6aedd8ea7477
+  metadata.gz: a4b89cf1685aff54633bfd56f0c70c415de73a9481f033b60a229bd76278f610c979e296823f716a1454fef1aae43a8b5dca285143e1bd81f2e5fce9b3c2561e
+  data.tar.gz: 1f4f8ee391a7431c4982143897d2be8c2df6754049c3a688e8f9496749c0caabfdfe52feedb3e7e20880c9da568e6792b56126e9322fd5e06b46c8d9de3034cd

data/.rubocop_todo.yml

@@ -1,77 +1,70 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-05-26 12:47:01 -0700 using RuboCop version 0.56.0.
+# on 2018-07-12 03:45:51 -0700 using RuboCop version 0.58.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 5
+# Offense count: 7
 # Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
 Metrics/BlockLength:
   Max: 116
 
-# Offense count: 2
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 82
-
 # Offense count: 1
-Style/ClassVars:
-  Exclude:
-    - 'lib/doppelserver/base_server.rb'
-
-# Offense count: 2
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/doppelserver/base_server.rb'
-    - 'lib/doppelserver/data.rb'
-
-# Offense count: 3
-# Cop supports --auto-correct.
-Style/ParallelAssignment:
+RSpec/DescribeClass:
   Exclude:
-    - 'lib/doppelserver/base_server.rb'
+    - 'spec/service_controller_console_spec.rb'
 
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: implicit, explicit
-Style/RescueStandardError:
+# Offense count: 5
+# Configuration parameters: Max.
+RSpec/ExampleLength:
   Exclude:
-    - 'lib/doppelserver/base_server.rb'
+    - 'spec/base_server_spec.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowIfMethodIsEmpty.
-Style/SingleLineMethods:
+# Offense count: 6
+RSpec/ExpectInHook:
   Exclude:
     - 'spec/base_server_spec.rb'
+    - 'spec/service_controller_console_spec.rb'
 
 # Offense count: 1
+# Configuration parameters: CustomTransform, IgnoreMethods.
 RSpec/FilePath:
   Exclude:
     - 'spec/base_server_spec.rb'
 
-# Offense count: 5
-RSpec/ExampleLength:
-  Exclude:
-    - 'spec/base_server_spec.rb'
+# Offense count: 14
+# Configuration parameters: AggregateFailuresByDefault.
+RSpec/MultipleExpectations:
+  Max: 4
 
-# Offense count: 5
-RSpec/ExpectInHook:
+# Offense count: 1
+RSpec/NestedGroups:
+  Max: 4
+
+# Offense count: 1
+Style/ClassVars:
   Exclude:
-    - 'spec/base_server_spec.rb'
+    - 'lib/doppelserver/base_server.rb'
 
-# Offense count: 7
-RSpec/MultipleExpectations:
+# Offense count: 1
+Style/Documentation:
   Exclude:
-    - 'spec/base_server_spec.rb'
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/doppelserver/base_server.rb'
 
-# Offense countL 1
-RSpec/NestedGroups:
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowIfMethodIsEmpty.
+Style/SingleLineMethods:
   Exclude:
     - 'spec/base_server_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 81

data/README.md

@@ -7,15 +7,22 @@
 [![Gem Version](https://badge.fury.io/rb/doppelserver.svg)](https://badge.fury.io/rb/doppelserver)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/dd50d7ee18ae46c38ad053cf3dc59794)](https://www.codacy.com/app/drewcoo/doppelserver?utm_source=github.com&utm_medium=referral&utm_content=drewcoo/doppelserver&utm_campaign=Badge_Grade)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/doppelserver`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
+## What's Doppelerver?
 
-## Why Doppelerver?
+Welcome to Doppelserver, the fake RESTful service gem, so named because all the cool names were already taken on RubyGems.
 
-TODO: Explain mocks, dups, and fakes. This is a fake. Explain why fakes.
+Chances are you're already using some kind of double in your testing. Test
+doubles fit into several categories:
+  - stubs - objects with values chosen to make tests pass
+  - mocks - objects with running code that's set to make tests pass
+  - spies - objects that can be queried for what happened to them
+  - fakes - actual running objects but incomplete and instrumented
+
+Martin Fowler [has a good explanation](https://martinfowler.com/articles/mocksArentStubs.html) but he separates what I'm calling stubs into "stubs" that respond with what a test needs and "dummies" that are passed but never accessed.
+
+In this case we're talking about a fake service, an actual running service intended to replace what you'd normally have in production for test purposes. It should respond as the actual service would but is instrumented so that you can both ask what happened like a spy and, more importantly, tell it how to respond differently because it's a fake.
 
-Also, all the cool names were taken on RubyGems.
 
 ## Installation
 
@@ -31,23 +38,114 @@ Or install it yourself as:
 
     $ gem install doppelserver
 
+
 ## Usage
 
-Scenarios this should cover:
-* Fake a server from your (integration) tests
-  * Default behaviors
-    * Imagine a really stupid CRUD database backing the test server,
-      one that auto-created schema as it went. That's pretty much it.
-      How? Easy. Instead of a db it's just a hash in memory. Dumb? Yup.
-  * Overrides
-    * Control endpoints
-* Run interactively (irb/pry console?) while debugging your code
-* Record endpoint usage?
-* Types of service:
-  * REST-ish
-  * GraphQL
-  * Others? (WSDL?)
-* Client bindings? Not sure that makes sense unless it's POROs or x-language.
+
+### Manually Exploring
+There's a command line tool, scc.rb, to explore what Doppelserver does:
+
+    $ bin/scc.rb help
+    Commands:
+      scc.rb data            # send/retreive all data
+      scc.rb help [COMMAND]  # Describe available commands or one specific command
+      scc.rb restart         # restart server, dumping all data
+      scc.rb start           # start server
+      scc.rb stop            # stop server
+
+    Options:
+      -p, [--port=PORT]  # port service runs on
+                         # Default: 7357
+
+
+#### Basics
+
+So let's just start it, defaulting to port 7357 (which is leet speak for "test").
+
+    $ bin/scc.rb start
+
+It's now running and you can use your favorite tool to run RESTful queries on it. I'll suggest [Postman](https://www.getpostman.com/) if you don't have anything. The fake service understands plural collections and items in them with (non-negative) integer ids. So you can get the initial things collection:
+
+    GET http://localhost:7357/things
+
+It returns a 200 but no data because it's currently empty. Let's put something in it.
+
+    POST http://localhost:7357/things
+and send this data:
+    { "name": "first", "another_value": "second" }
+
+Now we get a 200 back because we succeeded. Succeeded at what? Let's see:
+
+    GET http://localhost:7357/things
+
+That 200s and returns this:
+
+    {
+        "0": {
+            "name": "first",
+            "another_value": "second"
+        }
+    }
+
+You can also retrieve by index.
+
+    GET http://localhost:7357/things/0
+returns:
+    {
+        "name": "first",
+        "another_value": "second"
+    }
+
+In general, this will behave like an in-memory CRUD store. That starts and stops and restarts. So much for basics . . .
+
+    $ bin/scc.rb stop
+
+
+#### Controlling the Data
+
+There is a control endpoint that does more for us.
+
+
+##### Running
+
+Yes, this returns { "status": "running" } if running:
+
+    GET http://localhost:7537/control
+
+
+##### Data
+
+You can look at or change all of the data either with the /control/data endpoint or with the command line tool's data command.
+
+If you want to have the server not respond do this:
+  1. get data (optionally save somewhere)
+  2. stop service
+  3. run query-to-fail against service
+  4. start service
+  5. restore data
+
+
+##### Version Numbers Et Al.
+
+To support urls with things like version numbers the service already supports urls like this:
+
+    http://localhost/<ADDITONAL_STRING>/collection/1
+
+Where <ADDITIONAL_STRING> is any string. That means GETting and POSTing these is the same:
+
+    http://localhost/collection/0
+    http://localhost/FOO/collection/0
+    http://localhost/v1/BAR/BAZ/collection/0
+
+
+## TODO
+
+I should still add this functionality:
+  - return non-REST data (possibly non-HTTP)
+  - GraphQL? Some subset of it?
+  - Others? WSDL?
+  - Client bindings? POROs?
+
 
 ## Development
 
@@ -55,18 +153,19 @@ After checking out the repo, run `bundle` to install dependencies. Then, run `bu
 
 To install this gem onto your local machine, run
 
-    bundle exec rake install
+    $ bundle exec rake install
 
 To release a new version, update the version number in `version.rb` like so
 
-    bundle exec gem bump -v [major|minor|patch|pre|release]
+    $ bundle exec gem bump -v [major|minor|patch|pre|release]
 
 and then run
 
-    bundle exec rake release
+    $ 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/drewcoo/doppelserver.

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
-
+$LOAD_PATH.unshift File.expand_path 'lib', __dir__
 require 'bundler/setup'
-require 'fake_server'
+require 'doppelserver'
 
 # 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.

data/bin/scc.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path '../lib', __dir__
+require 'rubygems'
+require 'doppelserver'
+require 'thor'
+
+#
+# A command line tool to tell the Doppelserver service controller
+# what to do.
+#
+class ServiceControllerConsole < Thor
+  map %w[/? /h] => :help
+  map 'up' => :start
+  map 'down' => :stop
+
+  DEFAULT_PORT = '7357'.freeze
+  class_option :port, default: DEFAULT_PORT, aliases: '-p',
+                      desc: 'port service runs on'
+
+  desc 'helper: bail_out!', 'abort with a message', hide: true
+  def bail_out!
+    message = running? ? 'already' : 'not'
+    abort "ERROR #{message} running on port #{options.port}"
+  end
+
+  desc 'helper: running?', 'Bool am I running?', hide: true
+  def running?
+    # memoize this so that we don't call running? twice
+    # when we 'bail_out! if runnning?' and we exit this tool after each call
+    # so the memoization doesn't hurt x-call
+    #
+    # I used this, so left it commented in case I need it later:
+    # puts defined?(@running) ? 'defined' : 'not defined'
+    @running ||= service_controller.running?
+  end
+
+  desc 'helper: service controller', 'tell the service what to do', hide: true
+  def service_controller
+    @service_controller ||= ServiceController.new(options.port)
+  end
+
+  #
+  # Also hide this method. It's the one that starts the server
+  # as the current process. The start method starts a new process
+  # invoking this.
+  #
+  desc 'server', 'do not call directly', hide: true
+  def server
+    service_controller.serve
+  end
+
+  desc 'start', 'start server'
+  method_option :data, aliases: '-d',
+                       desc: 'text JSON data - remember to escape quotes'
+  def start
+    bail_out! if running?
+    service_controller.start
+    set unless options.data.nil?
+  end
+
+  desc 'stop', 'stop server'
+  method_option :data, aliases: '-d',
+                       desc: 'if passed, dumps data to console'
+  def stop
+    bail_out! unless running?
+    data if options.data
+    service_controller.stop
+  end
+
+  desc 'restart', 'restart server, dumping all data'
+  def restart
+    bail_out! unless running?
+    service_controller.restart
+  end
+
+  # Bad data zeroes everything out. Fix that or just doc it in help?
+  desc 'data', 'send/retreive all data'
+  method_option :set, aliases: '-s',
+                      desc: '-s <data> to send JSON; no args to get from server'
+  def data
+    bail_out! unless running?
+    if options.set
+      service_controller.set(options.set)
+    else
+      STDOUT.puts service_controller.get.gsub('"', '\"')
+    end
+  end
+end
+
+ServiceControllerConsole.start

data/doppelserver.gemspec

@@ -33,8 +33,8 @@ Gem::Specification.new do |spec|
   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.bindir = 'bin'
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'activesupport', '~> 5.0'

data/lib/doppelserver.rb

@@ -1,4 +1,3 @@
 require 'doppelserver/version'
-require 'sinatra'
-# require 'sinatra/contrib'
 require 'doppelserver/base_server'
+require 'doppelserver/service_controller'

data/lib/doppelserver/base_server.rb

@@ -1,35 +1,11 @@
 require 'sinatra'
-require 'sinatra/json'
-# require File.expand_path '../../lib/doppelserver/base_server.rb', __FILE__
-require_relative 'data'
+require 'doppelserver/data'
+# Most of the BaseServer class is in the routes below:
+require 'doppelserver/routes/control'
+require 'doppelserver/routes/rest'
 
 module Doppelserver
-  ENFORCE_PLURALS = true
-
   class BaseServer < Sinatra::Base
-    require 'active_support' # for singularization/pluralization
-
-    #
-    # Determines if
-    # word:: an input word
-    # is singular.
-    # Retutns truthy.
-    #
-    def singular?(word)
-      ActiveSupport::Inflector.singularize(word) == word
-    end
-
-    #
-    # If ENFORCE_PLURALS is true (default == true)
-    # This enforces plural names for all collections
-    # and returns 403 otherwise.
-    # word:: collection name
-    #
-    def enforce_plural(word)
-      return unless ENFORCE_PLURALS
-      halt 403, 'only plural collection names allowed' if singular?(word)
-    end
-
     #
     # Hold all of the data internally in the @@data.
     # It's the Data class, which holds a hash of data and
@@ -39,118 +15,6 @@ module Doppelserver
       @@data = Data.new
     end
 
-    #
-    # All meta-operations should happen through a /control endpoint.
-    #
-    # Deletes the internal data by clearing the @@data hash.
-    #
-    delete '/control/data' do
-      @@data.clear
-    end
-
-    #
-    # TODO:: Define this.
-    # Maybe make it a list of collections?
-    # Or all collections with all their data?
-    #
-    # For now, it returns a placeholder string.
-    #
-    get '/' do
-      'here i am' # TODO: Change this.
-    end
-
-    #
-    # Gets the data at:
-    # endpoint:: the collection
-    # id:: the instance identifier
-    # Or 404s when not found.
-    #
-    get '/:endpoint/:id' do
-      collection, id = params['endpoint'], params['id']
-      enforce_plural(collection)
-      halt 404 unless @@data.collection?(collection)
-      result = @@data.get_value(collection, id)
-      halt 404 if result.nil?
-      json(result)
-    end
-
-    #
-    # Returns the data at:
-    # endpoint:: collection name
-    # This is all of the data in that collection
-    # or 404 if no endpoint.
-    #
-    get '/:endpoint' do
-      collection = params[:endpoint]
-      enforce_plural(collection)
-      halt 404 unless @@data.collection?(collection)
-      json(@@data.get_collection(collection))
-    end
-
-    #
-    # No PUT, POST.
-    # Adds data to collection:
-    # endpoint:: is the name of the collection.
-    # If it doesn't exist, add new collection.
-    # If it does exist replaces (???) data.
-    # Also 403 on no data passed.
-    #
-    post '/:endpoint' do
-      request.body.rewind
-      collection = params['endpoint']
-      enforce_plural(collection)
-      raw_data = request.body.read
-      halt 403, 'NO DATA' if raw_data.empty?
-      data = begin
-               JSON.parse(raw_data)
-             rescue
-               halt 403, "BAD DATA:\n#{raw_data}"
-             end
-      json(id: @@data.add(collection, data))
-    end
-
-    #
-    # No PUT, POST.
-    # Add data with the id to the collection.
-    # endpoint:: collection name
-    # id:: unique identifier for the data
-    # Adds a collection if doesn't exist.
-    # Adds id and data at it if id doesn't exist.
-    # Otherwise, replaces data. Unless no data, then 403.
-    #
-    post '/:endpoint/:id' do
-      request.body.rewind
-      collection, id = params['endpoint'], params['id']
-      enforce_plural(collection)
-      halt 403 unless @@data.collection_key?(collection, id)
-      raw_data = request.body.read
-      halt 403, 'NO DATA' if raw_data.empty?
-      data = begin
-               JSON.parse(raw_data)
-             rescue
-               halt 403, "BAD DATA:\n#{raw_data}"
-             end
-      halt 403 unless @@data.update?(collection, id, data)
-    end
-
-    #
-    # Delete the data from
-    # endpoint:: collection name
-    # id:: with unique identifier
-    # Or 404 if one of those isn't found.
-    #
-    delete '/:endpoint/:id' do
-      request.body.rewind
-      collection, id = params['endpoint'], params['id']
-      enforce_plural(collection)
-      halt 404 unless @@data.collection?(collection)
-      if @@data.delete(collection, id)
-        status 200
-      else
-        halt 404
-      end
-    end
-
     run! if app_file == $PROGRAM_NAME
   end
 end

data/lib/doppelserver/data.rb

@@ -4,7 +4,12 @@ module Doppelserver
   #
   class Data
     #
-    # Initiallizes (cleared) all internal data.
+    # @data will be COLLECTION : { 0: { HASH }, 1: { HASH }, ... }
+    #       with the number autoincrementing by default
+    # @next_keys is the hash of COLLECTION names and the next auto-
+    #       incrementing value
+    #
+    # And now it's all empty.
     #
     def initialize
       @data = {}
@@ -34,6 +39,18 @@ module Doppelserver
       collection?(collection) && @data[collection].key?(key)
     end
 
+    def hash
+      { 'data' => @data,
+        'next_keys' => @next_keys }
+    end
+    alias export hash
+
+    def hash=(hash)
+      @data = hash['data']
+      @next_keys = hash['next_keys']
+    end
+    alias import hash=
+
     #
     # Returns collection named parameter name.
     #

data/lib/doppelserver/routes/control.rb

@@ -0,0 +1,59 @@
+require 'sinatra'
+require 'sinatra/json'
+require 'doppelserver/routes/helpers/request_parse_helper'
+
+module Doppelserver
+  #
+  # The control routes for BaseServer
+  #
+  class BaseServer < Sinatra::Base
+    include RequestParseHelper
+    #
+    # All meta-operations should happen through a /control endpoint.
+    #
+    # DELETEs the internal data by clearing the @@data hash.
+    #
+    delete '/control/data' do
+      @@data.clear
+    end
+
+    #
+    # GET all of the data.
+    #
+    get '/control/data' do
+      json(@@data.export)
+    end
+
+    #
+    # Replace all of the data.
+    # GET the data, stop the service, restart the service, and POST the data
+    # and we have the service in the same state as is was.
+    #
+    post '/control/data' do
+      request.body.rewind
+      @@data.hash = read_post_data(request.body)
+      status 200
+    end
+
+    #
+    # TODO:: Define this.
+    # Maybe make it a list of collections?
+    # Or all collections with all their data?
+    #
+    # For now, it returns a placeholder string.
+    #
+    get '/control' do
+      json('status': 'running')
+    end
+
+    #
+    # DELETE on the /control endpoint to stop the service
+    # and Kernel.exit! stops immedately, skipping even at_exit stuff.
+    #
+    delete '/control' do
+      # Save state first or count on caller to prep for the service
+      # losing all data?
+      exit!
+    end
+  end
+end

data/lib/doppelserver/routes/helpers/capture_helper.rb

@@ -0,0 +1,19 @@
+#
+# Capture helper - regexen.
+#
+module CaptureHelper
+  # Seems evil but it works. :-(
+  # these do pattern matching.
+  # They parse out what they say they do while allowing ANY prefix.
+  # So http://localhost/v3/myserver/route/id works just like
+  #    http://localhost/route/id
+  #
+  # Because this seems wrong, I'm leaving it notably ugly so that I'll notice
+  # and maybe improve it later.
+  #
+  MATCH_NONSLASH = /([^\/]+)/
+  MATCH_NUMBER = /([\d]+)/
+  # These start with optional everythingm followed bu slash-separated matches
+  COLLECTION_ONLY = /.*\/#{MATCH_NONSLASH}\/?/ # possible trailing slash
+  COLLECTION_AND_ID = /.*\/#{MATCH_NONSLASH}\/#{MATCH_NUMBER}/
+end

data/lib/doppelserver/routes/helpers/pluralize_helper.rb

@@ -0,0 +1,35 @@
+#
+# Like the name suggests, helper methods for pluralization.
+#
+module PluralizeHelper
+  require 'active_support'
+
+  ENFORCE_PLURALS = true
+
+  #
+  # Determines if
+  # word:: an input word
+  # is singular.
+  # Retutns truthy.
+  #
+  def singular?(word)
+    ActiveSupport::Inflector.singularize(word) == word
+  end
+
+  #
+  # If ENFORCE_PLURALS is true (default == true)
+  # This enforces plural names for all collections
+  # and returns 403 otherwise.
+  # word:: collection name
+  #
+  def enforce_plural(word)
+    # Mixing in the contol exclusion is strange here.
+    # This can still coexist with a /controls endpoint but may be confusing.
+    # I don't want to think about the possibility that we don't have plural
+    # collections and happen to have a collision with a control collection yet.
+    if word != 'control' && ENFORCE_PLURALS && singular?(word)
+      halt 403, 'only plural collection names allowed'
+    end
+    word
+  end
+end

data/lib/doppelserver/routes/helpers/request_parse_helper.rb

@@ -0,0 +1,37 @@
+require 'doppelserver/routes/helpers/pluralize_helper'
+#
+# Helper methods for web request parsing.
+#
+module RequestParseHelper
+  include PluralizeHelper
+  #
+  # Parses parameters and checks that collections are plural if needed.
+  #
+  def parse_params(params)
+    collection, id = params['captures']
+    enforce_plural(collection)
+    id ? [collection, id] : collection
+  end
+
+  #
+  # Also for non-POST, callers ask to check the collection against
+  # known collections and 404 if asking for an unknown one
+  #
+  def check_exists(collection, data)
+    halt 404 unless data.collection?(collection)
+  end
+
+  #
+  # Takes a request body and returns post data.
+  # Unless is errors out because of no data or a parse error.
+  #
+  def read_post_data(body)
+    raw_data = body.read
+    halt 403, 'NO DATA' if raw_data.empty?
+    begin
+      JSON.parse(raw_data)
+    rescue JSON::ParserError
+      halt 403, "BAD DATA:\n#{raw_data}"
+    end
+  end
+end

data/lib/doppelserver/routes/rest.rb

@@ -0,0 +1,89 @@
+require 'sinatra'
+require 'sinatra/json'
+require 'doppelserver/routes/helpers/capture_helper'
+require 'doppelserver/routes/helpers/request_parse_helper'
+
+module Doppelserver
+  #
+  # All of the REST routes for BaseServer are here.
+  #
+  class BaseServer < Sinatra::Base
+    include CaptureHelper
+    include RequestParseHelper
+
+    #
+    # Gets the data at:
+    # endpoint:: the collection
+    # id:: the instance identifier
+    # Or 404s when not found.
+    #
+    get COLLECTION_AND_ID do
+      collection, id = parse_params(params)
+      check_exists(collection, @@data)
+      result = @@data.get_value(collection, id)
+      halt 404 if result.nil?
+      json(result)
+    end
+
+    #
+    # Returns the data at:
+    # endpoint:: collection name
+    # This is all of the data in that collection
+    # or 404 if no endpoint.
+    #
+    get COLLECTION_ONLY do
+      collection = parse_params(params)
+      check_exists(collection, @@data)
+      json(@@data.get_collection(collection))
+    end
+
+    #
+    # No PUT, POST.
+    # Add data with the id to the collection.
+    # endpoint:: collection name
+    # id:: unique identifier for the data
+    # Adds a collection if doesn't exist.
+    # Adds id and data at it if id doesn't exist.
+    # Otherwise, replaces data. Unless no data, then 403.
+    #
+    post COLLECTION_AND_ID do
+      request.body.rewind
+      collection, id = parse_params(params)
+      halt 403 unless @@data.collection_key?(collection, id)
+      data = read_post_data(request.body)
+      halt 403 unless @@data.update?(collection, id, data)
+    end
+
+    #
+    # No PUT, POST.
+    # Adds data to collection:
+    # endpoint:: is the name of the collection.
+    # If it doesn't exist, add new collection.
+    # If it does exist replaces (???) data.
+    # Also 403 on no data passed.
+    #
+    post COLLECTION_ONLY do
+      request.body.rewind
+      collection = parse_params(params)
+      data = read_post_data(request.body)
+      json(id: @@data.add(collection, data))
+    end
+
+    #
+    # Delete the data from
+    # endpoint:: collection name
+    # id:: with unique identifier
+    # Or 404 if one of those isn't found.
+    #
+    delete COLLECTION_AND_ID do
+      request.body.rewind
+      collection, id = parse_params(params)
+      check_exists(collection, @@data)
+      if @@data.delete(collection, id)
+        status 200
+      else
+        halt 404
+      end
+    end
+  end
+end

data/lib/doppelserver/service_controller.rb

@@ -0,0 +1,75 @@
+$LOAD_PATH.unshift File.expand_path('..', __dir__)
+require 'doppelserver/base_server'
+require 'faraday'
+require 'json'
+
+#
+# Contains the commands to tell the service what to do.
+# All of the command line parsing and such is in a /bin/ that I haven't
+# decided what to name yet.
+#
+class ServiceController
+  SERVER = 'http://127.0.0.1'
+
+  attr_reader :port
+
+  def initialize(port)
+    @port = port
+  end
+
+  def start
+    command = "ruby #{__FILE__} server #{@port}"
+    command = if ENV['OS'] == 'Windows_NT'
+                "start \"doppelserver\" cmd /c #{command}"
+              else
+                "nohup #{command} &"
+              end
+    system command
+    sleep 0.1 until running?
+  end
+
+  def serve
+    system "title doppelserver - port #{@port}" if ENV['OS'] == 'Windows_NT'
+    server = Doppelserver::BaseServer
+    server.port = @port
+    server.run!
+  end
+
+  # rubocop:disable Lint/HandleExceptions
+  def stop
+    return unless running?
+    Faraday.delete "#{SERVER}:#{@port}/control"
+  rescue Faraday::ConnectionFailed
+    # return 0
+  end
+  # rubocop:enable Lint/HandleExceptions
+
+  def restart
+    stop
+    start
+  end
+
+  def running?
+    response = Faraday.get "#{SERVER}:#{@port}/control"
+    JSON.parse(response.body)['status'] == 'running'
+  rescue Faraday::ConnectionFailed
+    false
+  end
+
+  def get
+    response = Faraday.get "#{SERVER}:#{@port}/control/data"
+    response.body
+  end
+
+  def set(data)
+    Faraday.post "#{SERVER}:#{@port}/control/data", data
+  end
+end
+
+#
+# If this, then turn this process into a runnning service.
+#
+if $PROGRAM_NAME == __FILE__ && ARGV[0] == 'server'
+  server = ServiceController.new(ARGV[1])
+  server.serve
+end

data/lib/doppelserver/version.rb

@@ -1,3 +1,3 @@
 module Doppelserver
-  VERSION = '0.4.9'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doppelserver
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 1.0.0
 platform: ruby
 authors:
 - Drew Cooper
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-07-08 00:00:00.000000000 Z
+date: 2018-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -212,7 +212,10 @@ description: |-
   Unlike mocks and stubs, fake services are running processes that pretend to function as real ones would. This enables testing the software under test with more complete control of the surfaces it talks to (other services, faked). Beyond that, it makes application- and (http)protocol-level fault injection easy.
 email:
 - drewcoo@gmail.com
-executables: []
+executables:
+- console
+- scc.rb
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -229,12 +232,18 @@ files:
 - Rakefile
 - appveyor.yml
 - bin/console
-- bin/server
+- bin/scc.rb
 - bin/setup
 - doppelserver.gemspec
 - lib/doppelserver.rb
 - lib/doppelserver/base_server.rb
 - lib/doppelserver/data.rb
+- lib/doppelserver/routes/control.rb
+- lib/doppelserver/routes/helpers/capture_helper.rb
+- lib/doppelserver/routes/helpers/pluralize_helper.rb
+- lib/doppelserver/routes/helpers/request_parse_helper.rb
+- lib/doppelserver/routes/rest.rb
+- lib/doppelserver/service_controller.rb
 - lib/doppelserver/version.rb
 homepage: https://github.com/drewcoo/doppelserver
 licenses:

data/bin/server

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require 'doppelserver'
-Doppelserver::BaseServer.run!