aikido-ruby-client 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1aff36ac4f8ac9f17a073b5acfead422df83829a80e7f6f7ec3a8d68426214d
-  data.tar.gz: 7a84efa160d1e3701ab301d04a71eb967f24e7cda172c9b34f60c34bd277e467
+  metadata.gz: 2195bf014566aa0b80fbbf1412abce1996457bd8a93a126280689e00bdf19d72
+  data.tar.gz: 2904c3cd13469f36ef32e3d74daf4a1eef837286f5f71047fc3bb53b0c23b400
 SHA512:
-  metadata.gz: 5250c5726c5920423b88b31c982a792251fca565fca0996bee526a1e222e6dc38c27074482e93fa8752ef7a09ca89588e00f996bb4f85f3baf8369d884fc98bf
-  data.tar.gz: f74ecf9b1df49a4e84608ed68900ded1dfa8b672e8a00cbdd5d762214bf670be3ba6117d60a21dc44a8bc5792d42498d4a574c19a4e2d18ce715a72c296e50b9
+  metadata.gz: 3e1e0ced53c59664ba1b3eb53f1711bf82da26e244c4fb8a8b48f05456799639314bb6d625e140802b36dc7f8d13e0e2c23cef34677aacee1ebc443cc09bf40b
+  data.tar.gz: c5cc2da2ed92067ef28e7c5a5b9fc6af21c8fb96675dd085b219ba26e4aa59a1a165218610104b0fd8d68345987ce7eda7807f072aad74384d9541f310fd8cd4

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,13 @@
 # Changelog
 
+## [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

@@ -6,3 +6,4 @@ require 'aikido-ruby-client'
 client = Aikido::Client.new
 
 puts client.issues
+puts client.code_repositories.to_a

data/lib/aikido/client.rb

@@ -2,35 +2,68 @@
 
 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 issues(params: {})
-      authed_http.get('/public/v1/issues/export', params: params).json
+      get('/public/v1/issues/export', params: params).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 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 repositories
-      # TODO: Paginated response
-      authed_http.get('/public/v1/repositories/code', params: params).json
+    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("repositories/code/#{id.to_i}/licenses/export", params: { format: format }).body
     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 +80,23 @@ 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 401
+        raise Errors::UnauthorizedError, response
+      else
+        raise Errors::ApiError, response
+      end
+    end
   end
 end

data/lib/aikido/errors.rb

@@ -0,0 +1,25 @@
+# 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
+        if @response.json['error_description']
+          "#{super} - #{@response.json['error_description']}"
+        else
+          super
+        end
+      end
+    end
+    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.2'
 end

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.2
 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,8 @@ files:
 - exe/aikido
 - lib/aikido-ruby-client.rb
 - lib/aikido/client.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 +50,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.2/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []