apidragon 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38f447a14c74741ccc26b5d641ac6bf3be90315f
-  data.tar.gz: 6a320529e79a2f3e3816a1e3224629d2d5e38fc1
+  metadata.gz: 057fea4ff820d0007256be6ae77b2ad5f41af564
+  data.tar.gz: dff236d10ed490abbb2df35b7c0d1874b4f902ea
 SHA512:
-  metadata.gz: 1d403ce82e3d9a20be2837ed6b9b0dd2021008d3a7434a3d4e226dee06d8a30f6c122996d35d13149c1234cf060199f88e7804913e37ed853c837a63cf270e53
-  data.tar.gz: 761f6f6613eeca86d341b3ef4f478c26ba0c444f6118a2d130b6465a1ecbb79048486a66ad47246a0489a2aa7cbaba17741cf6f9d2ffd151ced1c715961cea6a
+  metadata.gz: 2037bb17194a23285ed05b67c3573e19c1500ae7dec6d3c5d1ce0778f9c90424007757234ec63882be0086b5a0eca8b990b32fe62df5aceb3186fbbeb6a7397f
+  data.tar.gz: 52cb232fd49bf6410c47ae7f4169f9df67a518f2b9e8fe16932417759f7b92804916fadec4b38cf9316fda85c035ee716ef1a5d93381f883c5afd59a412d2b03

data/README.md

@@ -50,23 +50,28 @@ Each macro can have `n` number of calls like `testcall` in the example, each req
 Currently supported modes:
 - `get`
 - `post`
-- `curl_get` (uses curl instead of the `rest-client` gem for special cases)
-
-Planned: `put`, `delete`, `curl_post`, `curl_put`, `curl_delete`
+- `put`
+- `delete`
+- `curl_get`, `curl_post` (uses curl instead of the `rest-client` gem for special cases)
+- `eval` (not yet stable)
+- Planned: `curl_put`, `curl_delete`
 
 # Further Options
+
+## `record`
 Each call can have a `record` option, where you can specify what output variables you want to record to your config.  
 
 - e.g.:
 ```yaml
 	testcall:
-	  output: 
+	  output:
 	  - id
 	  - userinfo
 	  record:
 	  - id
 ```
 
+## Qualifier variables
 Further, for more specific output parsing, you can specify a qualifier variable. As long as responses are returned as `xml` or `json`, output variables can be associated with one of your pre-defined values for cases like parsing lists of values that have several attribute fields.  
 
 - e.g.:
@@ -78,6 +83,43 @@ Further, for more specific output parsing, you can specify a qualifier variable.
 ```
 So if the call returns a list like this: `[{username => bob, id => 1234}, {username => alice, id => 5678}]`, you can always return the `id` associated with the `username` variable defined in the `vars` section.
 
+## `logging`
+For each call, set `logging` to `true` to enable or `false` to disable.
+
+- e.g.:
+```yaml
+  testcall:
+    logging: true
+```
+
+## `plugin` (unstable)
+apidragon will automatically `require_relative` any `.rb` files at `/tmp/apidragonplugins/`.
+Call the code in the plugin file like so:
+
+- e.g.:
+  - example.rb: (in `/tmp/apidragonplugins/`)
+  ```ruby
+  class Example
+    def initialize(message)
+      @message = message
+    end
+
+    def out
+      puts "#{@message}"
+    end
+  end
+  ```
+  - apidragonconf.yaml:
+  ```yaml
+    hellocall:
+      function: Example.new('hello').out
+      mode: eval
+      plugin: example
+  ```
+
+# Planned Features
+- The ability to include custom scripts at the end of a call for extensibility
+
 #License
 
 [MIT](https://tldrlegal.com/license/mit-license)

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/apidragon.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: apidragon 1.0.0 ruby lib
+# stub: apidragon 1.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "apidragon"
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["isaiah thiessen"]
-  s.date = "2015-11-27"
+  s.date = "2015-11-30"
   s.description = "Ruby based CLI for accessing veracode's api"
   s.email = "isaiah.thiessen@live.ca"
   s.executables = ["apidragon"]
@@ -34,6 +34,7 @@ Gem::Specification.new do |s|
     "lib/apidragon.rb",
     "lib/apidragon/api.rb",
     "lib/apidragon/argbucket.rb",
+    "lib/apidragon/log.rb",
     "lib/apidragon/macro.rb",
     "lib/apidragon/parser.rb",
     "test/helper.rb",

data/lib/apidragon/api.rb

@@ -6,6 +6,8 @@ require_relative 'macro'
 require_relative 'argbucket'
 
 CONFIG = '/tmp/apidragonconf.yaml'
+PLUGINS = '/tmp/apidragonplugins/'
+LOG = '/tmp/apidragon.log'
 
 class Api < ArgBucket
   # Uses the configuration data in config.yaml to run a sequence of api calls.
@@ -21,27 +23,19 @@ class Api < ArgBucket
     if @macro.nil? then fail "Command: '#{macro_name}' is not defined." end
   end
 
-  def macro_init
-    macro = @macro
-    @macro = []
-    macro.each_pair do |key, value|
-      @macro << Call.new(value['input'], value['output'], value['mode'], value['function'], @arg_bucket)
-    end
-  end
-
   def load_config
     YAML.load_file CONFIG
   end
 
   def go
     @macro.each_pair do |key, value|
-      call = Call.new(value['input'], value['output'], value['mode'], value['function'], @arg_bucket)
+      call = Call.new(value['input'], value['output'], value['mode'], value['function'], @arg_bucket, value['logging'], value['plugin'])
       @arg_bucket = call.run
       if !value['record'].nil?
         value['record'].each do |var|
           add_config_var var, get(var)
         end
-      end  
+      end
     end
   end
 

data/lib/apidragon/log.rb

@@ -0,0 +1,23 @@
+class ResponseLogger
+
+  def object_log(function, code, body)
+    log = File.open "#{LOG}", 'a+'
+    log.write "call @ #{timestamp}"
+    log.write "HTTP #{code}\n"
+    log.write body
+    log.write "\n"
+    log.close
+  end
+
+  def string_log(function, response)
+    log = File.open "#{LOG}", 'a+'
+    log.write "call @ #{timestamp}"
+    log.write response
+    log.write "\n"
+    log.close
+  end
+
+  def timestamp
+    `date`
+  end
+end

data/lib/apidragon/macro.rb

@@ -1,12 +1,12 @@
 require_relative 'parser'
 require_relative 'argbucket'
+require_relative 'log'
 
 class Call < ArgBucket
 
-  attr_accessor :input
-
-  def initialize(input, output, mode, function, args)
+  def initialize(input, output, mode, function, args, logging=false, plugin=nil)
     @arg_bucket = args
+    require_relative "#{PLUGINS}#{plugin}" unless plugin.nil?
     username = get 'username'
     password = get 'password'
     check_constraints mode, function
@@ -15,13 +15,14 @@ class Call < ArgBucket
     @mode = mode
     @output = output
     @input = input
+    @logging = logging
     set_call_args unless input.nil?
   end
 
   def check_constraints(mode, function)
     if mode.nil? then fail '"mode" not set. syntax= mode: get/post/put/delete.' end
     if function.nil? then fail '"function" not set. syntax= function: api-url.' end
-    puts "WARNING: 'function' should have basic auth. (example syntax= function: username:password@example.com/apicall)" unless function.include?('username') && function.include?('password')
+    puts "WARNING: 'function' should have basic auth. (example syntax= function: username:password@example.com/apicall)" unless function.include?('username') && function.include?('password') || @mode == 'eval'
   end
 
   def credential_sub(username, password)
@@ -55,17 +56,19 @@ class Call < ArgBucket
           puts "making a delete: #{@function} with #{@input}"
           @response = RestClient.delete @function, params: @input
         when 'curl_get'
-          command = "curl --url #{@function}"
+          command = "curl -v --url #{@function}"
           @input.each_pair do |key, value|
             command << " -F #{key}='#{value}'"
           end
           @response = `#{command}`
         when 'curl_post'
-          command = "curl -X POST --url #{@function}"
+          command = "curl -v -X POST --url #{@function}"
           @input.each_pair do |key, value|
             command << " -F #{key}='#{value}'"
           end
           @response = `#{command}`
+	when 'eval'
+          @response = eval(@function)
         else
           puts "#{@mode} not supported."
       end
@@ -74,15 +77,20 @@ class Call < ArgBucket
     rescue RestClient::Exception
       puts 'Internal Error or requested resource was not found.'
     end
-    log_response unless @response.nil?
-    parse_response unless @response.nil? || @output.nil?
+    if !@response.nil?
+      log_response unless @logging == false
+      parse_response unless @output.nil?
+    end
     return @arg_bucket
   end
 
   def log_response
-    # puts @response.code
-    # puts @response.body
-    puts @response
+    logger = ResponseLogger.new
+    if !@response.is_a? String
+      logger.object_log @function, @response.code, @response.body
+    else
+      logger.string_log @function, @response
+    end
   end
 
   def xml_to_json

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apidragon
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - isaiah thiessen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-27 00:00:00.000000000 Z
+date: 2015-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -257,6 +257,7 @@ files:
 - lib/apidragon.rb
 - lib/apidragon/api.rb
 - lib/apidragon/argbucket.rb
+- lib/apidragon/log.rb
 - lib/apidragon/macro.rb
 - lib/apidragon/parser.rb
 - test/helper.rb