aikido-ruby-client 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1aff36ac4f8ac9f17a073b5acfead422df83829a80e7f6f7ec3a8d68426214d
-  data.tar.gz: 7a84efa160d1e3701ab301d04a71eb967f24e7cda172c9b34f60c34bd277e467
+  metadata.gz: 6692ba6b0f697d0f69b840a95e96cbbca656863ed9c71af7c48fc2634678a659
+  data.tar.gz: 9997f0daca4a3e133a3d5e3c041f8ddf66bd6af56521d18d6c8bfbffbc323b40
 SHA512:
-  metadata.gz: 5250c5726c5920423b88b31c982a792251fca565fca0996bee526a1e222e6dc38c27074482e93fa8752ef7a09ca89588e00f996bb4f85f3baf8369d884fc98bf
-  data.tar.gz: f74ecf9b1df49a4e84608ed68900ded1dfa8b672e8a00cbdd5d762214bf670be3ba6117d60a21dc44a8bc5792d42498d4a574c19a4e2d18ce715a72c296e50b9
+  metadata.gz: 5597d2ddd0e6a518a078e6fa6d2b55e3c01a022ffadbb018fe76423f761f9c4381a4dc06bc647866b8bea5ea21cdb8230811c0e71cc60f9ef46e78ed2d4057c3
+  data.tar.gz: d1659f8a75fe77dbd4e60f8b74884b3354458c520482531b49d7b10e014ca1ccbbc8958743686814a5bc075ecbf03b176bb321055df6bc12145651e6aa5dae40

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -1,7 +1,12 @@
 AllCops:
   TargetRubyVersion: 2.7
   NewCops: enable
+  SuggestExtensions: false
 
 Naming/FileName:
   Exclude:
     - 'lib/aikido-ruby-client.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [v0.0.3](https://github.com/anakinj/aikido-ruby-client/tree/v0.0.3) (2024-03-10)
+
+**Features:**
+
+- Support for even more endpoints
+
+## [v0.0.2](https://github.com/anakinj/aikido-ruby-client/tree/v0.0.2) (2024-03-10)
+
+**Features:**
+
+- More api methods
+- Pagination support
+- Specs backed by VCR recordings
+
 ## [v0.0.1](https://github.com/anakinj/aikido-ruby-client/tree/v0.0.1) (2024-03-10)
 
 **Features:**

data/exe/aikido

@@ -5,4 +5,10 @@ require 'aikido-ruby-client'
 
 client = Aikido::Client.new
 
-puts client.issues
+result = client.public_send(ARGV[0], *ARGV[1..-1])
+
+if result.is_a?(Aikido::PaginatedResponse)
+  puts result.to_a
+else
+  puts result
+end

data/lib/aikido/client.rb

@@ -2,35 +2,93 @@
 
 require 'httpx'
 
+require_relative 'errors'
+require_relative 'paginated_response'
+
 module Aikido
   # HTTP Client to interact with the Aikido API
   # Official documentation: https://apidocs.aikido.dev/
   class Client
     def initialize(client_id: nil, client_secret: nil)
-      @client_id = client_id || ENV.fetch('AIKIDO_CLIENT_ID', nil)
+      @client_id     = client_id || ENV.fetch('AIKIDO_CLIENT_ID', nil)
       @client_secret = client_secret || ENV.fetch('AIKIDO_CLIENT_SECRET', nil)
     end
 
     def authorize
-      http.plugin(:basic_auth).basic_auth(@client_id, @client_secret).post('/oauth/token',
-                                                                           json: { grant_type: 'client_credentials' })
+      handle_response!(http.plugin(:basic_auth)
+                           .basic_auth(@client_id, @client_secret)
+                           .post('/oauth/token', json: { grant_type: 'client_credentials' }))
+    end
+
+    def workspace
+      get('/public/v1/workspace').json
+    end
+
+    def clouds
+      PaginatedResponse.new do |page|
+        get('/public/v1/clouds', params: { page: page }).json
+      end
+    end
+
+    def connect_aws_cloud(role_arn:, name:, environment:)
+      handle_response!(authed_http.post('/public/v1/clouds/aws',
+                                        json: { role_arn: role_arn,
+                                                name: name,
+                                                environment: environment })).json
     end
 
-    def issues(params: {})
-      authed_http.get('/public/v1/issues/export', params: params).json
+    def issues(options = {})
+      get('/public/v1/issues/export', params: options).json
     end
 
     def issue(id)
-      authed_http.get("/public/v1/issues/#{id.to_i}").json
+      get("/public/v1/issues/#{id.to_i}").json
     end
 
-    def repositories
-      # TODO: Paginated response
-      authed_http.get('/public/v1/repositories/code', params: params).json
+    def issue_groups
+      PaginatedResponse.new do |page|
+        get('/public/v1/open-issue-groups', params: { page: page }).json
+      end
+    end
+
+    def issue_group(id)
+      get("/public/v1/issues/groups/#{id.to_i}").json
+    end
+
+    def code_repositories
+      PaginatedResponse.new do |page|
+        get('/public/v1/repositories/code', params: { page: page }).json
+      end
+    end
+
+    def code_repository_sbom(id, format: 'csv')
+      get("/public/v1/repositories/code/#{id.to_i}/licenses/export", params: { format: format }).read
+    end
+
+    def teams
+      PaginatedResponse.new do |page|
+        get('/public/v1/teams', params: { page: page }).json
+      end
+    end
+
+    def create_team(name:)
+      handle_response!(authed_http.post('/public/v1/teams', json: { name: name })).json
+    end
+
+    def update_team(id)
+      raise NotImplementedError
+    end
+
+    def containers
+      get('/public/v1/containers').json
     end
 
     private
 
+    def get(path, params: {})
+      handle_response!(authed_http.get(path, params: params))
+    end
+
     def authed_http
       http.plugin(:auth).bearer_auth(auth_token)
     end
@@ -47,5 +105,25 @@ module Aikido
       # TODO: Handle token expiration
       @auth_token ||= authorize.json['access_token']
     end
+
+    def handle_response!(response)
+      case response.status
+      when 200..299
+        response
+      else
+        raise_response_error!(response)
+      end
+    end
+
+    def raise_response_error!(response)
+      case response.status
+      when 400
+        raise Errors::BadRequestError, response
+      when 401
+        raise Errors::UnauthorizedError, response
+      else
+        raise Errors::ApiError, response
+      end
+    end
   end
 end

data/lib/aikido/context.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Aikido
+  # Represents a context for interacting with the Aikido API
+  # Context will store data in memory for further processing
+  class Context
+    def initialize(client: nil)
+      @client = client || Aikido::Client.new
+    end
+
+    def issues_for_code_repository(external_repo_id:)
+      repo = code_repositories.find { |r| r['external_repo_id'] == external_repo_id }
+      return [] unless repo
+
+      issues.select do |issue|
+        issue['code_repo_id'] == repo['id']
+      end
+    end
+
+    def code_repositories
+      @code_repositories ||= @client.code_repositories
+    end
+
+    def issues
+      @issues ||= @client.issues
+    end
+  end
+end

data/lib/aikido/errors.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Aikido
+  module Errors
+    AikidoError = Class.new(StandardError)
+
+    # Represents an error that occurred while making an API request.
+    class ApiError < AikidoError
+      def initialize(response)
+        @response = response
+        super("API Error: #{response.status}")
+      end
+
+      def message
+        json = @response.json
+        if json.key?('error_description')
+          "#{super} - #{json['error_description']}"
+        elsif json.key?('reason_phrase')
+          "#{super} - #{json['reason_phrase']}"
+        else
+          super
+        end
+      end
+    end
+
+    BadRequestError   = Class.new(ApiError)
+    UnauthorizedError = Class.new(ApiError)
+    NotFoundError     = Class.new(ApiError)
+  end
+end

data/lib/aikido/paginated_response.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Aikido
+  # Represents a reponse that is paginated
+  class PaginatedResponse
+    include Enumerable
+
+    def initialize(&block)
+      @page_loader = block
+      @pages = []
+      load_page(0)
+    end
+
+    def each(&block)
+      return enum_for(:each) unless block_given?
+
+      loop.with_index do |_, index|
+        page = load_page(index)
+        break if page.empty?
+
+        page.each(&block)
+      end
+    end
+
+    private
+
+    def load_page(page)
+      @pages[page] ||= @page_loader.call(page)
+    end
+  end
+end

data/lib/aikido/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Aikido
-  VERSION = '0.0.1'
+  VERSION = '0.0.3'
 end

data/lib/aikido-ruby-client.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require 'aikido/client'
+require 'aikido/context'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aikido-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Joakim Antman
@@ -32,6 +32,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
 - LICENSE.txt
@@ -40,6 +41,9 @@ files:
 - exe/aikido
 - lib/aikido-ruby-client.rb
 - lib/aikido/client.rb
+- lib/aikido/context.rb
+- lib/aikido/errors.rb
+- lib/aikido/paginated_response.rb
 - lib/aikido/version.rb
 homepage: https://github.com/anakinj/aikido-ruby-client
 licenses:
@@ -47,7 +51,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/anakinj/aikido-ruby-client
   source_code_uri: https://github.com/anakinj
-  changelog_uri: https://github.com/anakinj/jwk-loader/blob/0.0.1/CHANGELOG.md
+  changelog_uri: https://github.com/anakinj/jwk-loader/blob/0.0.3/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []