hackerone-client 0.22.1 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 684b59afaacb9acad9aba5a4a4e696535684c27ee3abb2d37b3a4c9e761c87a8
-  data.tar.gz: 50b813301fb053284ef490a8fad3fea66319881a569ec3acf53329963c4684aa
+  metadata.gz: b2fdab8aa46e47e1103a2fdb1dc78c42689e8c1c2635133bbf46a1dcec8ac039
+  data.tar.gz: 7326e1a37eda609ae45617ef9a100e3d6fa57bff8b6a40d77e622104b889e471
 SHA512:
-  metadata.gz: 7dfae7e6b2348b4a1ab6554fc5a440311fa6c583fbd196684908565395b2a3ad8f04eb5cfd4ed33838c4118a2615b400e3a3874578d2129adfd90791a38abc50
-  data.tar.gz: 2060b8258b6b48f7b0e444b17e87332495facc6a8da934add226c82d78e364f76831c0355da4a200684a1112b49d691adcc679d40bf71a50c6012666789a39b4
+  metadata.gz: 5e48cb154448b6cc74b3a2a9b57febe3b773ea49ad5e802617ad611a7fa5df4453ded6b708dddb418a478195eaba9064df0572a8227e1cfcc0adfe1dfe627dc3
+  data.tar.gz: 345710ef1635331f860ec6bc561ddaed4de35303983851c1f4d80077e665253a2e1465574e3d54c6b887a70e74b8f2b6fee3a4c1ff0317ccde24f2d345398b51

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.23.0] - 2024-08-09
+
+[Add Asset and Organization resources](https://github.com/github/hackerone-client/pull/10) (@jeffgran-dox)
+
 ## [0.22.0] - 2024-01-10
 
 [Update Faraday API call and deprecate support for Ruby <2.6](https://github.com/github/hackerone-client/pull/2) (@maclarel)

data/README.md

@@ -1,6 +1,6 @@
 # Hackerone::Client
 
-A limited client library for interacting with HackerOne in Ruby. Currently only supports a few operations:
+A limited client library for interacting with HackerOne in Ruby. Currently supports a few operations:
 
 ```ruby
 client = HackerOne::Client::Api.new("github")
@@ -57,6 +57,23 @@ program.update_policy(policy: "Please submit valid vulnerabilities")
 
 # Gets a program's balance
 program.balance
+
+# Gets a list of structured scopes
+program.structured_scopes
+
+# Gets an organization for a program
+program.organization
+
+# Gets assets for an organization
+program.organization.assets
+
+# Updates an asset for an organization
+asset = program.organization.assets[0]
+asset.update(
+  attributes: {
+    description: "This is the new description"
+  }
+)
 ```
 
 ## State change hooks

data/lib/hackerone/client/asset.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module HackerOne
+  module Client
+    class Asset
+      include ResourceHelper
+
+      DELEGATES = [
+        :asset_type,
+        :identifier,
+        :description,
+        :coverage,
+        :max_severity,
+        :confidentiality_requirement,
+        :integrity_requirement,
+        :availability_requirement,
+        :created_at,
+        :updated_at,
+        :archived_at,
+        :reference,
+        :state,
+      ]
+
+      delegate *DELEGATES, to: :attributes
+
+      attr_reader :organization
+
+      def initialize(asset, organization)
+        @asset = asset
+        @organization = organization
+      end
+
+      def id
+        @asset[:id]
+      end
+
+      def update(attributes:)
+        body = {
+          type: "asset",
+          attributes: attributes
+        }
+        make_put_request("organizations/#{organization.id}/assets/#{id}", request_body: body)
+      end
+
+      def programs
+        relationships.programs[:data].map { |p| Program.new(p) }
+      end
+
+      private
+
+      def relationships
+        OpenStruct.new(@asset[:relationships])
+      end
+
+      def attributes
+        OpenStruct.new(@asset[:attributes])
+      end
+    end
+  end
+end

data/lib/hackerone/client/organization.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module HackerOne
+  module Client
+    class Organization
+      include ResourceHelper
+
+      delegate :handle, :created_at, :updated_at, to: :attributes
+
+      def initialize(org)
+        @organization = org
+      end
+
+      def id
+        @organization[:id]
+      end
+
+      def assets(page_number: 1, page_size: 100)
+        make_get_request(
+          "organizations/#{id}/assets",
+          params: { page: { number: page_number, size: page_size } }
+        ).map do |asset_data|
+          Asset.new(asset_data, self)
+        end
+      end
+
+      private
+
+      def attributes
+        OpenStruct.new(@organization[:attributes])
+      end
+    end
+  end
+end

data/lib/hackerone/client/program.rb

@@ -51,6 +51,15 @@ module HackerOne
         groups.find { |group| group.name == groupname }
       end
 
+      def structured_scopes(page_number: 1, page_size: 100)
+        make_get_request(
+          "programs/#{id}/structured_scopes",
+          params: { page: { number: page_number, size: page_size } }
+        ).map do |data|
+          StructuredScope.new(data, self)
+        end
+      end
+
       def update_policy(policy:)
         body = {
           type: "program-policy",
@@ -83,8 +92,6 @@ module HackerOne
         BillingBalance.new(response_body).balance
       end
 
-      private
-
       def members
         @members ||= relationships.members[:data].map { |member_data| Member.new(member_data) }
       end
@@ -93,6 +100,12 @@ module HackerOne
         @groups ||= relationships.groups[:data].map { |group_data| Group.new(group_data) }
       end
 
+      def organization
+        @organization ||= Organization.new(relationships.organization[:data])
+      end
+
+      private
+
       def relationships
         # Relationships are only included in the /programs/:id call,
         # which is why we need to do a separate call here.

data/lib/hackerone/client/report.rb

@@ -108,7 +108,7 @@ module HackerOne
       end
 
       def structured_scope
-        StructuredScope.new(relationships[:structured_scope].fetch(:data, {}))
+        StructuredScope.new(relationships[:structured_scope].fetch(:data, {}), program)
       end
 
       # Excludes reports where the payout amount is 0 indicating swag-only or no

data/lib/hackerone/client/structured_scope.rb

@@ -3,17 +3,27 @@
 module HackerOne
   module Client
     class StructuredScope
+      include ResourceHelper
+
       DELEGATES = [
         :asset_identifier,
         :asset_type,
+        :availability_requirement,
+        :confidentiality_requirement,
         :eligible_for_bounty,
         :eligible_for_submission,
-        :instruction
+        :instruction,
+        :integrity_requirement,
+        :max_severity,
+        :reference
       ]
 
       delegate *DELEGATES, to: :attributes
 
-      def initialize(scope)
+      attr_reader :program
+
+      def initialize(scope, program = nil)
+        @program = program
         @scope = scope
       end
 
@@ -21,6 +31,14 @@ module HackerOne
         @scope[:id]
       end
 
+      def update(attributes:)
+        body = {
+          type: "structured-scope",
+          attributes: attributes
+        }
+        make_put_request("programs/#{program.id}/structured_scopes/#{id}", request_body: body)
+      end
+
       private
 
       def attributes

data/lib/hackerone/client/version.rb

@@ -2,6 +2,6 @@
 
 module Hackerone
   module Client
-    VERSION = "0.22.1"
+    VERSION = "0.23.0"
   end
 end

data/lib/hackerone/client.rb

@@ -4,10 +4,13 @@ require "faraday"
 require "json"
 require "active_support"
 require "active_support/core_ext/numeric/time"
+require "ostruct"
 require_relative "client/version"
 require_relative "client/report"
 require_relative "client/activity"
 require_relative "client/program"
+require_relative "client/organization"
+require_relative "client/asset"
 require_relative "client/reporter"
 require_relative "client/member"
 require_relative "client/user"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hackerone-client
 version: !ruby/object:Gem::Version
-  version: 0.22.1
+  version: 0.23.0
 platform: ruby
 authors:
 - Neil Matatall
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-16 00:00:00.000000000 Z
+date: 2024-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,7 +108,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - neil.matatall@gmail.com
 executables: []
@@ -172,12 +172,14 @@ files:
 - lib/hackerone/client.rb
 - lib/hackerone/client/activity.rb
 - lib/hackerone/client/address.rb
+- lib/hackerone/client/asset.rb
 - lib/hackerone/client/attachment.rb
 - lib/hackerone/client/billing_balance.rb
 - lib/hackerone/client/bounty.rb
 - lib/hackerone/client/group.rb
 - lib/hackerone/client/incremental/activities.rb
 - lib/hackerone/client/member.rb
+- lib/hackerone/client/organization.rb
 - lib/hackerone/client/program.rb
 - lib/hackerone/client/report.rb
 - lib/hackerone/client/reporter.rb
@@ -191,7 +193,7 @@ homepage: https://github.com/github/hackerone-client
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -206,8 +208,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: A limited client for the HackerOne API
 test_files: []