doppelserver 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bebf3fb70c994c0ecbba11d24a15bc3a7397d771df23f59822b977bb5314a790
-  data.tar.gz: 3f262e434afc3b66bcf9a88e293eeb2fa5dae4324190f7274dc2b2ff0bef9542
+  metadata.gz: c8ecd7f77f59921d42f9f6b3dc9a49f6209c4f315aa0325c8e6b266e58fa6f26
+  data.tar.gz: fe58b716b71ab2e73ae34441f020e850090f174952995daa6204f6e24801ea2e
 SHA512:
-  metadata.gz: e2e80557e1888337bad21d75fad14bbf50347878f5cfa23fd63d0d281f67525ff3b347cd2cf2b5411758ec47a42b9438396e0e9ca5fc9f931535f49a4b014332
-  data.tar.gz: 86ad1724ca9c4f4d4e3a2118350ec50fc4eca12655bf304e58523dfe0505a2c9a6de6d4bb7545cf41ff158df9083d38758a1b3fb9433244c370a9c36353f1a6c
+  metadata.gz: e74ec8e4724ad41eae0b1eef6f95abcfd500efd2656c72a92c64f11ec2ceb824e2112860d6e4ab8b8f1cde9e9105ec920546fbd4f08b6554101c2adec2e2f2f8
+  data.tar.gz: e4cf2ac4da81bd7af95cba53de81a1bfa6e2bc92f184ae5e75b65748a7ad13e93d004adf7f9ca986e2c369206f4e32ee729f775044a2a0850cbfd832d4d41a64

data/.gitignore

@@ -1,9 +1,10 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
+/.bundle/
+/*.gem
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -8,7 +8,7 @@ require: rubocop-rspec
 # That last one's my doing but I only get the spew when my gem is here, too.
 # Searching the web they're all more likely rubocop-rspec's fault than my code.
 # So I'll leave this as is and look into it later. TODO: Look into it.
-require: drewcoo-cops
+# require: drewcoo-cops
 
 AllCops:
   DefaultFormatter: progress

data/README.md

@@ -4,6 +4,7 @@
 [![CircleCI](https://circleci.com/gh/drewcoo/doppelserver.svg?style=shield)](https://circleci.com/gh/drewcoo/doppelserver)
 [![Coverage Status](https://coveralls.io/repos/github/drewcoo/doppelserver/badge.svg?branch=master)](https://coveralls.io/github/drewcoo/doppelserver?branch=master)
 [![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.
 
@@ -37,7 +38,22 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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.
+
 
 ## Development
 

data/Rakefile

@@ -1,6 +1,9 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
+RuboCop::RakeTask.new
+
 task default: :spec

data/lib/doppelserver/base_server.rb

@@ -8,27 +8,63 @@ module Doppelserver
 
   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
+    # another of next keys. (???)
+    #
     configure do
       @@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)
@@ -38,6 +74,12 @@ module Doppelserver
       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)
@@ -45,6 +87,14 @@ module Doppelserver
       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']
@@ -59,6 +109,15 @@ module Doppelserver
       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']
@@ -74,6 +133,12 @@ module Doppelserver
       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']

data/lib/doppelserver/data.rb

@@ -1,31 +1,58 @@
 module Doppelserver
+  #
+  # A glorified hash.
+  #
   class Data
+    #
+    # Initiallizes (cleared) all internal data.
+    #
     def initialize
       @data = {}
       @next_keys = {}
     end
 
+    #
+    # Clears all internal data.
+    #
     def clear
       @data = {}
       @next_keys = {}
     end
 
+    #
+    # Returns the collection called parameter name.
+    #
     def collection?(name)
       @data.key?(name)
     end
 
+    #
+    # Returns boolean, true if collection 1st param) exists
+    # and has key (2nd param).
+    #
     def collection_key?(collection, key)
       collection?(collection) && @data[collection].key?(key)
     end
 
+    #
+    # Returns collection named parameter name.
+    #
     def get_collection(name)
       @data[name]
     end
 
+    #
+    # Returns the value from the collection at first parameter
+    # at key of the second parameter.
+    #
     def get_value(collection, key)
       @data[collection][key]
     end
 
+    #
+    # Adds the collection if that name (1st param) doesn't exist.
+    # Adds data (2nd param) to the collection regardless.
+    #
     def add(collection, data)
       unless collection?(collection)
         @data[collection] = {}
@@ -37,6 +64,9 @@ module Doppelserver
       next_key.to_s
     end
 
+    #
+    # Updates collection[id] to new data.
+    #
     def update?(collection, id, data)
       data.each_key do |key|
         return false unless @data[collection][id].key?(key)
@@ -47,6 +77,9 @@ module Doppelserver
       true
     end
 
+    #
+    # Deletes the data at key (2nd param) from collection (1st param).
+    #
     def delete(collection, key)
       @data[collection].delete(key)
     end

data/lib/doppelserver/version.rb

@@ -1,3 +1,3 @@
 module Doppelserver
-  VERSION = '0.2.6'.freeze
+  VERSION = '0.2.7'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doppelserver
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Drew Cooper
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-27 00:00:00.000000000 Z
+date: 2018-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport