caido 0.0.0.pre.dev → 0.2.0

data/lib/caido/helpers/_example.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Caido
+  # Instance class
+  class Instance
+    def example_helper
+      'test'
+    end
+  end
+end

data/lib/caido/helpers/automate.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Caido
+  # Instance class
+  class Instance
+    def automate_session(id)
+      query("query{
+        automateSession(id: \"#{id}\"){
+          id
+          name
+          raw
+          createdAt
+        }
+      }")['automateSession']
+    end
+
+    def automate_sessions
+      query('query{
+        automateSessions{
+          nodes{
+            id
+            name
+            raw
+            createdAt
+          }
+        }
+      }')['automateSessions']
+    end
+  end
+end

data/lib/caido/helpers/export.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Caido
+  # Instance class
+  class Instance
+    def exports
+      query('query{
+        dataExports{
+          id
+          format
+          name
+          status
+          error
+          createdAt
+          path
+          size
+          downloadUri
+        }
+      }')['dataExports']
+    end
+
+    def export(id)
+      query("query{
+        dataExport(id: \"#{id}\"){
+          id
+          format
+          name
+          status
+          error
+          createdAt
+          path
+          size
+          downloadUri
+        }
+      }")['dataExport']
+    end
+  end
+end

data/lib/caido/helpers/hosted_file.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Caido
+  # Instance class
+  class Instance
+    def hosted_files
+      query('query {
+        hostedFiles {
+          id
+          name
+          createdAt
+          updatedAt
+          path
+          size
+        }
+      }')['hostedFiles']
+    end
+  end
+end

data/lib/caido/helpers/replay.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Caido
+  # Instance class
+  class Instance
+    def replay_collections
+      query('query {
+        replaySessionCollections{
+          nodes{
+            name
+            sessions{
+              name
+              id
+            }
+          }
+        }
+      }')['replaySessionCollections']['nodes']
+    end
+
+    def replay_session(id)
+      query("query{
+        replaySession(id: \"#{id}\"){
+          name
+          activeEntry{
+            request{
+            host
+            path
+            method
+            query
+            raw
+            isTls
+            fileExtension
+            source
+            port
+
+            }
+          }
+        }
+      }")['replaySession']
+    end
+
+    def replay_sessions
+      sessions_data = []
+      collections = query('query {
+        replaySessionCollections{
+          nodes{
+            name
+            sessions{
+              name
+              id
+            }
+          }
+        }
+      }')['replaySessionCollections']['nodes']
+
+      collections.each do |collection|
+        next unless collection
+
+        sessions = collection['sessions']
+
+        sessions.each do |session|
+          next unless session
+
+          sessions_data << query("query{
+              replaySession(id: \"#{session['id']}\"){
+                name
+                activeEntry{
+                  request{
+                  host
+                  path
+                  method
+                  query
+                  raw
+                  isTls
+                  fileExtension
+                  source
+                  port
+
+                  }
+                }
+              }
+            }")['replaySession']
+        end
+      end
+
+      sessions_data
+    end
+  end
+end

data/lib/caido/helpers/request.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Caido
+  # Instance class
+  class Instance
+    def request(id)
+      query("query{
+        request(id:\"#{id}\"){
+            id
+            host
+            method
+            query
+            length
+            port
+            isTls
+            fileExtension
+            source
+            alteration
+            edited
+            createdAt
+            raw
+            response{
+              id
+              statusCode
+              length
+              roundtripTime
+              edited
+              raw
+            }
+        }
+      }")['request']
+    end
+  end
+end

data/lib/caido/helpers/response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Caido
+  # Instance class
+  class Instance
+    def response(id)
+      query("query{
+        response(id:\"#{id}\"){
+          id
+          statusCode
+          length
+          roundtripTime
+          edited
+          raw
+        }
+      }")['response']
+    end
+  end
+end

data/lib/caido/helpers/runtime.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Caido
+  # Instance class
+  class Instance
+    def version
+      query('{runtime{version}}')['runtime']['version']
+    end
+
+    def platform
+      query('{runtime{platform}}')['runtime']['platform']
+    end
+  end
+end

data/lib/caido/helpers/sitemap.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Caido
+  # Instance class
+  class Instance
+    def sitemap_entiry(id)
+      query("query{
+        sitemapEntry(id: \"#{id}\"){
+          id
+          label
+          kind
+          parentId
+          request{
+            id
+            host
+            method
+            query
+            length
+            port
+            isTls
+            fileExtension
+            source
+            alteration
+            edited
+            createdAt
+            raw
+            response{
+              id
+              statusCode
+              length
+              roundtripTime
+              edited
+              raw
+            }
+          }
+        }
+      }")['sitemapEntry']
+    end
+  end
+end

data/lib/caido/helpers/workflow.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Caido
+  # Instance class
+  class Instance
+    def workflows
+      query('query{
+        workflows{
+          id
+          name
+          kind
+          enabled
+          global
+          definition
+          createdAt
+          updatedAt
+        }
+      }')['workflows']
+    end
+
+    def workflow(id)
+      query("query{
+        workflow(id: \"#{id}\"){
+          id
+          name
+          kind
+          enabled
+          global
+          definition
+          createdAt
+          updatedAt
+        }
+      }")['workflow']
+    end
+  end
+end

data/lib/caido/helpers/workspace.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Caido
+  # Instance class
+  class Instance
+    def projects
+      query('query {
+        projects{
+          id
+          name
+          version
+          updatedAt
+        }
+      }')['projects']
+    end
+
+    def backups
+      query('query{
+        backups{
+          id
+          name
+          status
+          updatedAt
+          createdAt
+          path
+          size
+          downloadUri
+        }
+      }')['backups']
+    end
+  end
+end

data/lib/caido/instance.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'json'
+
+# Assuming this code is at the top level of instance.rb and helplers directory is at the same level
+Dir[File.expand_path('helpers/*.rb', __dir__)].each { |file| require file }
+
+module Caido
+  # Instance class
+  class Instance
+    attr_reader :graphql_url, :authorization
+
+    def initialize(*args)
+      set_defaults
+      process_arguments(args)
+      auth_from_env
+    end
+
+    private
+
+    def set_defaults
+      @graphql_url = 'http://localhost:8080/graphql'
+      @authorization = nil
+    end
+
+    def process_arguments(args)
+      case args.size
+      when 1
+        @graphql_url = args[0]
+      when 2
+        @graphql_url, authorization = args
+        @authorization = format_authorization(authorization)
+      when args.size > 2
+        raise ArgumentError, 'Too many arguments provided'
+      end
+    end
+
+    def format_authorization(auth)
+      auth.include?('Bearer ') ? auth : "Bearer #{auth}"
+    end
+
+    def auth_from_env
+      @auth_from_env ||= ENV.fetch('CAIDO_AUTH_TOKEN', 'Bearer ')
+    end
+
+    def query(query)
+      res = HTTParty.post(
+        graphql_url,
+        body: { query: }.to_json,
+        headers: {
+          'Content-Type' => 'application/json',
+          'Authorization' => authorization
+        }
+      )
+
+      obj = JSON.parse(res.body)
+      obj['data']
+    end
+  end
+end

data/lib/caido/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Caido
-  VERSION = "0.0.0.pre.dev"
+  VERSION = '0.2.0'
 end

data/lib/caido.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "caido/version"
+require_relative 'caido/version'
+require_relative 'caido/instance'
 
 module Caido
   class Error < StandardError; end
-  # Your code goes here...
 end

metadata

@@ -1,34 +1,80 @@
 --- !ruby/object:Gem::Specification
 name: caido
 version: !ruby/object:Gem::Version
-  version: 0.0.0.pre.dev
+  version: 0.2.0
 platform: ruby
 authors:
 - HAHWUL
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
-dependencies: []
-description: Tuby implementation of Caido
+date: 2024-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+description: |-
+  The caido-ruby library simplifies using Caido's API in Ruby applications.
+                        Caido is lightweight web security auditing toolkit.
 email:
 - hahwul@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rubocop.yml"
 - LICENSE
 - README.md
 - Rakefile
 - caido.gemspec
+- caido_introspection_schema.json
 - lib/caido.rb
+- lib/caido/helpers/_example.rb
+- lib/caido/helpers/automate.rb
+- lib/caido/helpers/export.rb
+- lib/caido/helpers/hosted_file.rb
+- lib/caido/helpers/replay.rb
+- lib/caido/helpers/request.rb
+- lib/caido/helpers/response.rb
+- lib/caido/helpers/runtime.rb
+- lib/caido/helpers/sitemap.rb
+- lib/caido/helpers/workflow.rb
+- lib/caido/helpers/workspace.rb
+- lib/caido/instance.rb
 - lib/caido/version.rb
 - sig/caido.rbs
-homepage: https://github.com/caineers/caido-ruby
-licenses: []
+homepage: https://rubygems.org/gems/caido
+licenses:
+- MIT
 metadata:
-  homepage_uri: https://github.com/caineers/caido-ruby
+  homepage_uri: https://rubygems.org/gems/caido
   source_code_uri: https://github.com/caineers/caido-ruby
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -37,7 +83,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -47,5 +93,5 @@ requirements: []
 rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
-summary: Ruby implementation of Caido
+summary: The caido-ruby library simplifies using Caido's API in Ruby applications.
 test_files: []