apidragon 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fec85c3dec05adc4610466d4cf18a88b786a6ac1
-  data.tar.gz: b4e3ab3c86cf633462cf87719c9b3adb19452de2
+  metadata.gz: 38f447a14c74741ccc26b5d641ac6bf3be90315f
+  data.tar.gz: 6a320529e79a2f3e3816a1e3224629d2d5e38fc1
 SHA512:
-  metadata.gz: 32167d48c82cac4d80741c6422a398767cc8d95e57b7b9cefade40205fa43a300c8c55c1a4dbe1838ab71f8f8f39a1987f1009d0cb54619e2f3f504185d4bd62
-  data.tar.gz: 2a72e5d923f58e0bdac9a77d4f69a06dc512fb658c99beb2eec50540c8ec147b09ed100f17eab94f0a87d3321cb7b720558ad4bf2b8a59d7b47030dd718026a7
+  metadata.gz: 1d403ce82e3d9a20be2837ed6b9b0dd2021008d3a7434a3d4e226dee06d8a30f6c122996d35d13149c1234cf060199f88e7804913e37ed853c837a63cf270e53
+  data.tar.gz: 761f6f6613eeca86d341b3ef4f478c26ba0c444f6118a2d130b6465a1ecbb79048486a66ad47246a0489a2aa7cbaba17741cf6f9d2ffd151ced1c715961cea6a

data/.gitignore

@@ -1,4 +1,10 @@
-unit_test_log.txt
 config.yaml
-api_structure.yaml
-logic.yaml
+.document
+apidragon.gemspec
+Gemfile
+Gemfile.lock
+README.rdoc
+Rakefile
+VERSION
+/test/*
+/pkg/*

data/README.md

@@ -1,8 +1,8 @@
-# apidragon: an Automated API Framework
+# apidragon: an Api Interaction Automation Framework
 
 These classes run a sequence of API calls using a configuration file.
-- config.yaml is read and vars are dumped into an `arg_bucket`
-- macros can specified in the config and run as commands
+- config file is read and `vars` are dumped into an `arg_bucket`
+- `macros` are specified in the config and can be run from the command line
 
 # Requirements:
 - Ruby > 2.0
@@ -10,36 +10,44 @@ These classes run a sequence of API calls using a configuration file.
 
 # How to Use:
 
-- Clone the Repo
-- Create `config.yaml` according to the examples below
-- Run from the command line with `./apidragon do [command]`  
-`command` is the name of a macro defined in the config file.  
+- `gem install apidragon`
+- Create `/tmp/apidragonconf.yaml` according to the examples below
+- Run from the command line with `apidragon do [command]`  
+`[command]` is the name of one of the `macros` defined in the config file. So if I was using the config in the example,  
+I could run `apidragon do macro_1`, which would then call `testcall` and `testcall2` in the order specified.
 
 # Configuration:
-Create `config.yaml`. Can contain any variable you need to access the API you are using.
-- config.yaml:
+Create `/tmp/apidragonconf.yaml`. It can contain any variables you need to access the API you are using, as well as `macros`.  
+- Example config:
 ```yaml
 ---
   vars:
     test: value
     username: bob
-    password: saget
+    password: mypassword
     id: 123456abcdef
   macros:
     macro_1:
       testcall:
-        function: username:password@test.net/api
+        function: username:password@test.net/api/test.do
         input:
           - id
         output:
-          - status
+          - tablename
+        mode: get  
+      testcall2:
+        function: username:password@test.net/api/test2.do
+        input:
+        - tablename
+        output:
+        - tablecontents
         mode: get
 ```
 
 Each macro can have `n` number of calls like `testcall` in the example, each requiring a `function`, the necessary `input` and `output` variables, and the request `mode`.
 
 # Request modes
-Currently support modes:
+Currently supported modes:
 - `get`
 - `post`
 - `curl_get` (uses curl instead of the `rest-client` gem for special cases)
@@ -49,21 +57,27 @@ Planned: `put`, `delete`, `curl_post`, `curl_put`, `curl_delete`
 # Further Options
 Each call can have a `record` option, where you can specify what output variables you want to record to your config.  
 
-e.g.:
+- e.g.:
 ```yaml
 	testcall:
 	  output: 
 	  - id
+	  - userinfo
 	  record:
 	  - id
 ```
 
 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.
+- e.g.:
 ```yaml
 	testcall:
 	  output:
 	  - id: username
+	  - userinfo
 ```
 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.
+
+#License
+
+[MIT](https://tldrlegal.com/license/mit-license)

data/README.rdoc

@@ -1,6 +1,6 @@
 = apidragon
 
-Description goes here.
+See main Github page for a description.
 
 == Contributing to apidragon
  
@@ -12,8 +12,4 @@ Description goes here.
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
-
-Copyright (c) 2015 isand3r. See LICENSE.txt for
-further details.
 

data/VERSION

@@ -1 +1 @@
-0.1.2
+1.0.0

data/apidragon.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: apidragon 0.1.2 ruby lib
+# stub: apidragon 1.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "apidragon"
-  s.version = "0.1.2"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
@@ -21,7 +21,6 @@ Gem::Specification.new do |s|
     "README.rdoc"
   ]
   s.files = [
-    ".document",
     ".gitignore",
     "Gemfile",
     "Gemfile.lock",

data/lib/apidragon/macro.rb

@@ -46,18 +46,26 @@ class Call < ArgBucket
           puts "making a get: #{@function} with #{@input}"
           @response = RestClient.get @function, params: @input
         when 'post'
-          puts 'making a post'
+          puts "making a post: #{@function} with #{@input}"
           @response = RestClient.post @function, params: @input
         when 'put'
-          puts 'making a put'
+          puts "making a put: #{@function} with #{@input}"
+          @response = RestClient.put @function, params: @input
         when 'delete'
-          puts 'making a delete'
+          puts "making a delete: #{@function} with #{@input}"
+          @response = RestClient.delete @function, params: @input
         when 'curl_get'
           command = "curl --url #{@function}"
           @input.each_pair do |key, value|
             command << " -F #{key}='#{value}'"
           end
           @response = `#{command}`
+        when 'curl_post'
+          command = "curl -X POST --url #{@function}"
+          @input.each_pair do |key, value|
+            command << " -F #{key}='#{value}'"
+          end
+          @response = `#{command}`
         else
           puts "#{@mode} not supported."
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apidragon
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - isaiah thiessen
@@ -244,7 +244,6 @@ extra_rdoc_files:
 - README.md
 - README.rdoc
 files:
-- ".document"
 - ".gitignore"
 - Gemfile
 - Gemfile.lock

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt