kenna 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52fe805c8e85e972c6542f39aad60f8799ab90e4
-  data.tar.gz: b9a9eeff68bd477f2b7b005c6ee2f3d72bec7e26
+  metadata.gz: 2d071e0a36ec4b38496dcb448521391ef0fc4e3a
+  data.tar.gz: 3bd66aedf05f757749b938ca79cf293c91e272a1
 SHA512:
-  metadata.gz: 2a3b0a94a8151fcea25b057dac3881de8a206790443e7a51c609b09188e61a5b46800a230563ad2c107b9cca8785d425c20057b9b204504cc8b9285fa49cabe5
-  data.tar.gz: 838a99326682989c8aa473e8f02c76326b22873d965e6fe2e5fc04c4874538f57c965fccd3448ff71a5be7661c5cf2fe95f6906de2d23924a45935715f27fce1
+  metadata.gz: 04b2188185f14649980dd172a73a5c96d3bdcd42131ee90c5514f54e5dee550f47c87c8a4d81d085c15dba9c39f6a759f9d642b072bfb2348de70a4ed60b8b18
+  data.tar.gz: c0eba01ca79c079de4313da5f86176b3926fc8aa20e8baa60955cab1af65345947c11d236a3d6da4d27bc808c041cf247303759d19910d8b505b8976e1b3c3cb

data/Gemfile

@@ -5,4 +5,6 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in kenna.gemspec
 gemspec
 gem 'test-unit', '~> 3.2', '>= 3.2.7'
-gem 'pry', '~> 0.11.3'
+gem 'pry', '~> 0.11.3'
+gem 'rest-client', '~> 2.0', '>= 2.0.2'
+gem 'faker', '~> 1.8', '>= 1.8.7'

data/Gemfile.lock

@@ -1,19 +1,36 @@
 PATH
   remote: .
   specs:
-    kenna (0.1.0)
+    kenna (0.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.2)
+    concurrent-ruby (1.0.5)
     diff-lcs (1.3)
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    faker (1.8.7)
+      i18n (>= 0.7)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
     method_source (0.9.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    netrc (0.11.0)
     power_assert (0.4.1)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -29,15 +46,20 @@ GEM
     rspec-support (3.7.0)
     test-unit (3.2.7)
       power_assert
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.16)
+  faker (~> 1.8, >= 1.8.7)
   kenna!
   pry (~> 0.11.3)
   rake (~> 10.0)
+  rest-client (~> 2.0, >= 2.0.2)
   rspec (~> 3.0)
   test-unit (~> 3.2, >= 3.2.7)
 

data/README.md

@@ -19,22 +19,42 @@ Or install it yourself as:
 
 ## Usage
 
-# Get an Api Instance
+Get an Api Instance
 
-# Test token ty9hxcpmgdrvnuqe
-# @api = Kenna::Api.new("your_token")
+Test token ty9hxcpmgdrvnuqe
+@api = Kenna::Api.new("your_token")
 
-# Test token ty9hxcpmgdrvnuqe
+Test token ty9hxcpmgdrvnuqe
 @api = Kenna::Api.new("ty9hxcpmgdrvnuqe")
 
-# Get All Users (only up to 500)
+There are basic crud methods that return a Response Object, 
+    use .body to get the JSON 
+    use .code to get the response code
+    use .headers to get the headers
+    'resource' is the root name of the endpoint, such as 'users'
+TODO: Several methods are responding only with body and need to be refactored
+TODO: Address throttling issues
+
+@api.post(uri, body)
+@api.postByResource(resource, body)
+@api.get(uri)
+@api.getById(resource, id)
+@api.update(uri, body)
+@api.updateById(resource, id, body)
+@api.delete(uri)
+@api.deleteById(resource, id)
+
+The following are two examples of shortcut methods,
+I intend to provide these for all routes
+
+Get All Users (only up to 500 for now)
 @users = @api.getAllUsers()
 puts @users
 
-# Getting the first User ID (there should always be at least one)
+Getting the first User ID (there should always be at least one)
 @user_id = @users[0]['id']
 
-# Get A Single User by ID
+Get A Single User by ID
 @user = @api.getUserById(@user_id)
 puts @user
 

data/kenna.gemspec

@@ -25,4 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "test-unit", "~> 3.2"
+  spec.add_development_dependency "rest-client", "~> 2.0"
+  spec.add_development_dependency "faker", "~> 1.8"
 end

data/lib/kenna/version.rb

@@ -4,5 +4,5 @@
 # License:: Ruby license.
 
 module Kenna
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/kenna.rb

@@ -3,58 +3,180 @@
 # Copyright:: Copyright (c) 2018 Maynard Black. All rights reserved.
 # License:: Ruby license.
 
-require "kenna/version"
+require 'json'
+require 'kenna/version'
+require 'rest-client'
+require 'faker'
 
 module Kenna
-    class Api
-    
-        def initialize(token)
-          @token = token
-        end
-        
-        def getAllUsers()
-          callApi('GET', '/users', 'users', {})
-        end
-        
-        def getUserById(id)
-          path = '/users/' + id.to_s
-          callApi('GET', path, 'user', {})
-        end
-        
-        def callApi(meth, endpoint, base_key, body)
-            require 'net/https'
-            require 'uri'
-            require 'json'
-            
-            url = URI.parse("https://api.kennasecurity.com")
-            #base_url = 'https://api.kennasecurity.com'
-            #params = ''
-            #url = base_url + endpoint + params;
-            data = nil
-            data_str = nil
-            
-            http = Net::HTTP.new(url.host, 443)
-            http.use_ssl = true
-            http.start do |http|
-              request  =
-                Net::HTTP::Get.new(endpoint, {'X-Risk-Token' => @token, 'Content-Type' => 'application/json', 'Accept' => 'application/json'})
-              response = http.request(request)
-              #data_str = JSON.pretty_generate JSON.parse(response.body)[base_key]
-              if base_key
-                  data = JSON.parse(response.body)[base_key]
-              else
-                  data = JSON.parse(response.body)
-              end
-            end
-            data
-        end
+  class Api
+    
+    # Must have a token to continue
+    def initialize(token)
+      $token = token
+    end
+    
+    # TODO (Maynard Black): ask Kenna about API versioning
+    $base_url = "https://api.kennasecurity.com"
+    
+    # Here are some generic CRUD calls to the API
+    # The URI is the full resource path without the base URL
+    # 'Resource' would be the same as base_key or root of the endpoint
+    # TODO (Maynard Black): Confirm with Kenna if this is standard and can be depended upon
+    # TODO (Maynard Black): Use config to set base URL and Token, find out how Kenna plans to version the API
+    # TODO (Maynard Black): Ask Kenna if ID's are unique accross all endpoints and do they plan on offering
+    #       an endpoint to locate any resource by just the ID (they are not UUIDs so not likely)
+    # TODO (Important - Maynard Black): Refactor to return the whole response including headers
+    #        This means updating the tests first! Then the API Browser App!
+    #        I am currently only returning a JSON parsed body so there is no way to catch 404s and such
+    # UPDATE: the 2 get,delete and uppdate methods have been refactored as per above
+    # TODO (Maynard Black): Refactor the 2 post, put, getAllUsers, getUserById methods to return headers
+    # TODO (Maynard Black): Catch exceptions when hitting server, that is the only way to 
+    #       catch certain response codes (like 404) with the client I am using
+    
+    # Create
+    def post(uri, body)
+      body = body.to_json
+      @url = $base_url + uri
+      @response = RestClient.post(@url, body, headers={'X-Risk-Token' => $token, 'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+      JSON.parse(@response.body)
+    end
+    
+    def postByResource(resource, body)
+      body = body.to_json
+      @url = $base_url +'/'+ resource
+      @response = RestClient.post(@url, body, headers={'X-Risk-Token' => $token, 'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+      JSON.parse(@response.body)
+    end
+    
+    # Read
+    def get(uri)
+      @url = $base_url + uri
+      @response = RestClient.get(@url, headers={'X-Risk-Token' => $token, 'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+    end
+    
+    def getById(resource, id)
+      @url = $base_url +'/'+ resource +'/'+ id.to_s
+      @response = RestClient.get(@url, headers={'X-Risk-Token' => $token, 'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+    end
+    
+    # Update
+    def update(uri, body)
+      body = body.to_json
+      @url = $base_url + uri
+      @response = RestClient.put(@url, body, headers={'X-Risk-Token' => $token, 'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+    end
+    
+    def updateById(resource, id, body)
+      body = body.to_json
+      @url = $base_url +'/'+ resource +'/' + id.to_s
+      @response = RestClient.put(@url, body, headers={'X-Risk-Token' => $token, 'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+    end
+    
+    # Delete
+    def delete(uri)
+      @url = $base_url + uri
+      @response = RestClient.delete(@url, headers={'X-Risk-Token' => $token, 'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+    end
+    
+    def deleteById(resource, id)
+      @url = $base_url +'/'+ resource +'/' + id.to_s
+      @response = RestClient.delete(@url, headers={'X-Risk-Token' => $token, 'Content-Type' => 'application/json', 'Accept' => 'application/json'})
     end
+
+    # User specific methods 
+    # TODO (Maynard Black): Finish all User options
+    # TODO (Maynard Black): Do this for all other endpoints
+    # TODO (Maynard Black): Some endpoint calls will require an array of id's, the app can fill
+    #       in the rest
+    def getAllUsers()
+      @url = $base_url + '/users'
+      @response = RestClient.get(@url, headers={'X-Risk-Token' => $token, 'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+      JSON.parse(@response.body)["users"]
+    end
+    
+    def getUserById(id)
+      @url = $base_url + '/users/' + id.to_s
+      @response = RestClient.get(@url, headers={'X-Risk-Token' => $token, 'Content-Type' => 'application/json', 'Accept' => 'application/json'})
+      JSON.parse(@response.body)["user"]
+    end
+    
+    # Generate a unique fake user for testing 
+    # and for the API browser
+    def fakeUser
+      @roles = ['administrator', 'normal user', 'Linux Test Environment']
+      @role = @roles[rand(0..2)]
+      @fake_user = {
+                      "user":
+                        {
+                          "firstname": Faker::Name.first_name ,
+                          "lastname": Faker::Name.last_name ,
+                          "email": Faker::Internet.email,
+                          "role": @role
+                        }
+                    }
+    end
+      
+    # Pretty version for API Browser
+    def fakeUserPretty
+      JSON.pretty_generate JSON.parse(fakeUser)
+    end
+    
+  end
 end
 
-@api = Kenna::Api.new("ty9hxcpmgdrvnuqe")
-@users = @api.getAllUsers()
-@user_id = @users[0]['id']
-@user = @api.getUserById(@user_id)
+# BASIC MANUAL TESTS 
+# There are actual tests for some things (Written first believe it or not!)
+# But I wrote these local test to get a better idea of what was happening 
+# TODO (Maynard Black): Finish tests!
+# TODO (Maynard Black): The sample account Token will need to change! This is my free temp one
+
+# @api = Kenna::Api.new("ty9hxcpmgdrvnuqe")
+
+# @new_user = @api.post('/users', @api.fakeUser)
+# @id = @new_user["user"]["id"]
+# puts @id
+
+# @new_user = @api.postByResource('users', @api.fakeUser)
+# @id2 = @new_user["user"]["id"]
+# puts @id2
+
+# TODO (Maynard Black): Address throttling issues
+
+# @b = {"firstname":"JOE"}
+# @u = @api.update('/users/' + @id.to_s, @b)
+# puts @u.code
+# puts JSON.parse(@u.body)["user"]["firstname"]
+
+# @data = @api.getById('users', 35665)
+# puts @data['user']['id']
+
+# User Methods
+# @users = @api.getAllUsers()
+# puts @users
+ 
+# @users = JSON.parse(@users)
+# puts @users[@users.keys[0]]
+ 
+# @user_id = @users[0]['id']
+# @user = @api.getUserById(@user_id)
+# puts @user['id'] == 35665
+
+# @id = 35992
+# @body = {"firstname":"KERMIT"}
+# @api.update('/users/' + @id.to_s, @body)
+
+# @new_user = @api.get('/users/' + @id.to_s)
+# @new_name = @new_user["user"]["firstname"]
+# puts @new_user
+# puts @new_name
+
+# @id = @api.getAllUsers()[9]["id"]
+# puts @id
 
-#puts @user['id'] == 35665
+# @delete = @api.delete('/users/' + @id.to_s)
+#puts @delete.code != 200
 
+# @user = @api.get('/users/' + @id.to_s)
+# puts @user.class == 'RestClient::Response'
+# puts @user.code != 200

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kenna
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - maynard
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-23 00:00:00.000000000 Z
+date: 2018-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 description: Kenna is an API client that wraps the Kenna Security API (https://api.kennasecurity.com).
 email:
 - maynardblack@hotmail.com