whowas 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23b13b6e3c208d2ed5d32406ee185c7d9042edb9
-  data.tar.gz: 6d5ebc269ba4ad75720d5b71fe80c7c85d2bb01d
+  metadata.gz: a92b53b7bef30819cd2501c2435b13b10be15708
+  data.tar.gz: 4f038b70ab9fd3bd78a3132a8d82f012737a4c48
 SHA512:
-  metadata.gz: 2d7885df76e22f2f4f4d3fe213387a001992ad446c43656971d19ffeeee67e1f2a8968294c8ffec0341926b4bc83456e24c1d4fd8732e851795a4beb21867606
-  data.tar.gz: 0354e38f5de7f29de16db613edc10ad9e2dcf83ace7e19135b88125bd9c2efbccda0d56d0aba34df1f2b666a6187e24c40671e07d02a389b18ce42635d051525
+  metadata.gz: 0ca98edc334537e9ead70ad1b847a7457d417535aa31179e71764e4f4414df0bb46b51a1388a3f161162a24b668f977078924e0371b0d346bbebf87bd90f4008
+  data.tar.gz: 35a057c905f6d486312239c80449473071138ebe17144845b3f47cfe0d7439563df2289d933b4d5aa4564990b781cb76e6fa54996dea555947d3f4b6b0f53806

data/lib/{apis → adapters}/splunk.rb

@@ -2,7 +2,7 @@ require "splunk-sdk-ruby"
 
 module Whowas
   class Splunk
-    include Whowas::Api
+    include Whowas::Adapter
     
     @@connection = nil
     
@@ -13,7 +13,7 @@ module Whowas
     def self.connection(config: Whowas.splunk_config)
       @@connection ||= ::Splunk::connect(config)
     rescue => e
-      raise Whowas::Errors::ServiceUnavailable, e
+      raise Whowas::Errors::ServiceUnavailable, "#{self.class.name}: #{e}"
     end
         
     def validate(input)
@@ -22,7 +22,7 @@ module Whowas
       input[:offset].is_a?(Integer) &&
       DateTime.parse(input[:timestamp]) &&
       true) ||
-      (raise Whowas::Errors::InvalidInput, "Invalid input for Splunk API")
+      (raise Whowas::Errors::InvalidInput, "Invalid input for Splunk")
     end
     
     def format(input)

data/lib/generators/whowas/adapter_generator.rb

@@ -0,0 +1,13 @@
+module Whowas
+  class AdapterGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("../templates", __FILE__)
+    
+    def create
+      copy_file "adapter.rb", "app/whowas/adapters/#{file_name}.rb"
+    end
+    
+    def rename_class
+      gsub_file "app/whowas/adapters/#{file_name}.rb", /MyAdapter/, name.camelize
+    end
+  end
+end

data/lib/generators/whowas/recipe_generator.rb

@@ -3,11 +3,11 @@ module Whowas
     source_root File.expand_path("../templates", __FILE__)
     
     def create
-      copy_file "recipe.rb", "app/recipes/#{file_name}.rb"
+      copy_file "recipe.rb", "app/whowas/recipes/#{file_name}.rb"
     end
     
     def rename_method
-      gsub_file "app/recipes/#{file_name}.rb", /name_this_recipe/, name.underscore
+      gsub_file "app/whowas/recipes/#{file_name}.rb", /name_this_recipe/, name.underscore
     end
   end
-end
+end

data/lib/generators/whowas/search_method_generator.rb

@@ -3,11 +3,11 @@ module Whowas
     source_root File.expand_path("../templates", __FILE__)
     
     def create
-      copy_file "search_method.rb", "app/search_methods/#{file_name}.rb"
+      copy_file "search_method.rb", "app/whowas/search_methods/#{file_name}.rb"
     end
     
     def rename_class
-      gsub_file "app/search_methods/#{file_name}.rb", /MySearchMethod/, name.camelize
+      gsub_file "app/whowas/search_methods/#{file_name}.rb", /MySearchMethod/, name.camelize
     end
   end
-end
+end

data/lib/generators/whowas/templates/{api.rb → adapter.rb}

@@ -1,17 +1,18 @@
 module Whowas
-  class MyApi
-    # Whowas::Api provides the public interface to your API, accessed through the
-    # "search" instance method.
-    include Whowas::Api
+  class MyAdapter
+    # Whowas::Adapter provides the public interface to your adapter, accessed 
+    # through the "search" instance method.
+    include Whowas::Adapter
   
-    # All custom API code is defined in the private methods below.  Naturally,
-    # you can add private methods as needed for connecting to the API, etc. 
+    # All custom adapter code is defined in the private methods below.  
+    # Naturally, you can add private methods as needed for connecting to the 
+    # adapter, etc. 
     private
     
     ## Required
     
-    # Sends a search query with provided input to your API and returns results 
-    # as a string.
+    # Sends a search query with provided input to your third-party API and 
+    # returns results as a string.
     def search_api(input)
       ""
     end
@@ -27,7 +28,7 @@ module Whowas
     end
     
     # Transforms input one last time before API call.
-    # Will be called on input for all search_methods using this API.
+    # Will be called on input for all search_methods using this adapter.
     # For search_method-specific transformations, use the format_input method
     # in your search_method.
     def format(input)

data/lib/generators/whowas/templates/initializer.rb

@@ -3,16 +3,16 @@ Whowas.configuration do |config|
   ## Recipe Table
   # You MUST define your default recipe and any other recipes you may use
   # here.  Viable keys include "default", "ip_default", "mac_default", and
-  # valid IP addresses or CIDR blocks.
+  # valid IP addresses or CIDR blocks.  Recipes are messages sent to Whowas.
   #
   # An example of a full recipe table:
   #
   # config.recipe_table = {
-  #   "192.168.1.0/24": Whowas.home_wireless,
-  #   "10.0.0.0/8": Whowas.internal_wired,
-  #   ip_default: Whowas.other_ips,
-  #   mac_default: Whowas.search_by_mac,
-  #   default: Whowas.other_ips
+  #   "192.168.1.0/24": "home_wireless",
+  #   "10.0.0.0/8": "internal_wired",
+  #   ip_default: "other_ips",
+  #   mac_default: "search_by_mac",
+  #   default: "other_ips"
   # }
   config.recipe_table = {}
   
@@ -22,7 +22,7 @@ Whowas.configuration do |config|
   config.recipe_class = Whowas::Recipes
   
   ## API configuration and credentials
-  # If you are not using a bundled API, you can safely ignore this section.
+  # If you are not using a bundled adapter, you can safely ignore this section.
 
   # Splunk API configuration
   # The recommended method is to store your Splunk credentials in environment
@@ -37,4 +37,4 @@ Whowas.configuration do |config|
   # }
   #
   config.splunk_config = {}
-end
+end

data/lib/generators/whowas/templates/recipe.rb

@@ -5,10 +5,10 @@ module Whowas
     # All you have to do is specify the search method classes in the order
     # they should be called.  The output for each search method should match
     # the input of the next.
-    Middleware::Builder.new do
+    ::Middleware::Builder.new do
       # use MySearchMethod1
       # use MySearchMethod2
       # use MySearchMethod3
     end
   end
-end
+end

data/lib/generators/whowas/templates/search_method.rb

@@ -1,8 +1,9 @@
 module Whowas
   class MySearchMethod
     # All required public methods are contained in the Middleware package.  It 
-    # initializes the search method, calls search on the API with the provided 
-    # input, and returns the output to the next search method or the caller.
+    # initializes the search method, calls search on the adapter with the 
+    # provided input, and returns the output to the next search method or the 
+    # caller.
     #
     # The Searchable modules (Validatable, Formattable, and Parsable) are
     # technically optional but in practice necessary to ensure usable input and
@@ -10,9 +11,9 @@ module Whowas
     include Whowas::Middleware
     include Whowas::Searchable
       
-    ## API
-    # You MUST set this to the name of a bundled or custom API class.
-    @@api = API_CLASS_HERE
+    ## ADAPTER
+    # You MUST set this to the name of a bundled or custom adapter class.
+    @@adapter = ADAPTER_CLASS_HERE
     
     private
     
@@ -44,15 +45,16 @@ module Whowas
     # mac addresses given as input to this search method should use colons as 
     # separators, perform that transformation here.
     # 
-    # API-wide transformations to the input can be made in the API format method.
+    # Adapter-wide transformations to the input can be made in the adapter 
+    # format method.
     def format_input(input)
       input
     end
     
     ## Parsable
     
-    # Extract pieces of the results string from the API using regex to form the 
-    # input hash for the next search method or the final result.
+    # Extract pieces of the results string from the adapter using regex to form 
+    # the input hash for the next search method or the final result.
     def output_formats
       {
         # username: /User <\K\w*/

data/lib/whowas.rb

@@ -1,6 +1,6 @@
 require "middleware"
 
-require "whowas/api"
+require "whowas/adapter"
 require "whowas/configuration"
 require "whowas/errors"
 require "whowas/formattable"
@@ -11,8 +11,8 @@ require "whowas/searchable"
 require "whowas/validatable"
 require "whowas/version"
 
-# bundled apis
-require "apis/splunk"
+# bundled adapters
+require "adapters/splunk"
 
 
 module Whowas
@@ -45,7 +45,7 @@ module Whowas
   def self.search(input)
     recipe = recipe_class.select(input) || Whowas.recipe_table[:default]
     env = {input: input, results: []}
-    recipe.call(env)
+    self.send(recipe).call(env)
     env
   end
   

data/lib/whowas/{api.rb → adapter.rb}

@@ -1,6 +1,6 @@
 module Whowas
-  module Api
-    # All APIs use (api_instance).search as the only public method
+  module Adapter
+    # All adapters use (adapter_instance).search as the only public method
     # and follow the pattern below.
     # Validation and formatting are optional.
     # search_api must contain the core api search code and return the results.
@@ -12,7 +12,7 @@ module Whowas
   
     private
   
-    # default methods for APIs to use or override
+    # default methods for adapters to use or override
     #:nocov:
     def validate(input)
       true

data/lib/whowas/formattable.rb

@@ -7,15 +7,11 @@ module Whowas
     # :nocov:
     private
     # This is a hook for the including class to use to modify the input before
-    # the api gets it.
-    #
-    # For example, when searching in Splunk, the Firewall class (which includes
-    # Searchable) must create the query string from the ip and port, plus any
-    # other parameters like the Splunk index it wants to search.
+    # the adapter gets it.
     #
     # By default, this method just returns the arguments given, but note that
     # most classes _will have_ to modify the input to make it usable by the
-    # API modification method.
+    # adapter.
     def format_input(input)
       input
     end

data/lib/whowas/searchable.rb

@@ -1,10 +1,10 @@
 module Whowas
   module Searchable    
-    @@api = nil
+    @@adapter = nil
     
-    # The including class *must* set the api class in a class constant.
-    def api
-      @@api || (raise Errors::SubclassResponsibility)
+    # The including class *must* set the adapter class in a class constant.
+    def adapter
+      @@adapter || (raise Errors::SubclassResponsibility)
     end
 
     # extend the including class with the searchable sub-modules
@@ -19,7 +19,7 @@ module Whowas
     def search(input)
       validate(input)
       input = format(input)
-      result = api.new.search(input)
+      result = adapter.new.search(input)
       parse(result)
     end
   end

data/lib/whowas/validatable.rb

@@ -1,7 +1,7 @@
 module Whowas
   module Validatable 
     # Checks for required inputs and input formats
-    # that the API will need to process the search.
+    # that the adapter will need to process the search.
     #
     # It does *not* matter if there are other, non-required parameters
     # in the input hash; they will be ignored later.
@@ -32,7 +32,8 @@ module Whowas
       end
     end
     
-    # Format is a lambda defined in the api class which returns true or false.
+    # Format is a lambda defined in the search method class which returns 
+    # true or false.
     # This allows for flexible format checking:
     #    e.g. regex for ip addresses and DateTime.parse calls for timestamps
     def check_format(formats, input)

data/lib/whowas/version.rb

@@ -1,3 +1,3 @@
 module Whowas
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whowas
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Jess Frisch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-24 00:00:00.000000000 Z
+date: 2016-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleware
@@ -138,17 +138,17 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/apis/splunk.rb
-- lib/generators/whowas/api_generator.rb
+- lib/adapters/splunk.rb
+- lib/generators/whowas/adapter_generator.rb
 - lib/generators/whowas/install_generator.rb
 - lib/generators/whowas/recipe_generator.rb
 - lib/generators/whowas/search_method_generator.rb
-- lib/generators/whowas/templates/api.rb
+- lib/generators/whowas/templates/adapter.rb
 - lib/generators/whowas/templates/initializer.rb
 - lib/generators/whowas/templates/recipe.rb
 - lib/generators/whowas/templates/search_method.rb
 - lib/whowas.rb
-- lib/whowas/api.rb
+- lib/whowas/adapter.rb
 - lib/whowas/configuration.rb
 - lib/whowas/errors.rb
 - lib/whowas/formattable.rb

data/lib/generators/whowas/api_generator.rb

@@ -1,13 +0,0 @@
-module Whowas
-  class ApiGenerator < Rails::Generators::NamedBase
-    source_root File.expand_path("../templates", __FILE__)
-    
-    def create
-      copy_file "api.rb", "app/apis/#{file_name}.rb"
-    end
-    
-    def rename_class
-      gsub_file "app/apis/#{file_name}.rb", /MyApi/, name.camelize
-    end
-  end
-end