cirro-ruby-client 1.6.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6890f4b343eb4c3efc64fe9f75c644c7d706e9c19bae033d367e4aa0fd99987
-  data.tar.gz: a84440266927041fc001db93c57c44bcf65ef0a2d16b87b2ccc443e1af041564
+  metadata.gz: 76097208caab26d55fe43bc4ca78e868d65c7fbd0aa0ab172cf76fbe51b769dc
+  data.tar.gz: 4e5db26e12fc65b9a8bb0da9a75ce846d9d8f5a0054f8cca47fe2ded2830a458
 SHA512:
-  metadata.gz: 6ed00bfa6f1d74f95338c6537b8da72754c6c48ecf8d93078891120f8f7be94fba74b0f929646594da35d79583aea4ff6f15ff31ac096dee6663037ebd953640
-  data.tar.gz: 1348492e075def7497a2734e170a3f8453fd1ef150b5473dc515e6dbcc0ede4c4612e0cf58edce08cdc65e293f31f7bf4f5e1a46f65155285a9f8514f77c0339
+  metadata.gz: c7af16a9900b76331bc9c248f8b22ca38f6e34b8affc1cbf54cf8d60eed55b915315b84e09bf654bc82b0a15ceb79cefbba8d88b3f1901739d87a57a0f000df8
+  data.tar.gz: 2299039507bef30f4bc613faf0107f2dec238c113903b92213f9f248d84ef276c6c4e5b31484c3b3839249de308afdabcb8e9ed8ffbfb173e03bc314aaaa31c8

data/.circleci/config.yml

@@ -1,9 +1,18 @@
 version: 2.1
+infra_container: &infra_container
+  eu.gcr.io/cirro-io/swissknife@sha256:1dceb221bfc058c4ba22fe4dcbf4f30dfdc10951bc2293d5c53aebc4f87037f3
+
+# Configure authentication in private registry
+infra_container_registry_auth:
+  &infra_container_registry_auth
+    auth:
+      username: _json_key # default username when using a JSON key file to authenticate
+      password: $GOOGLE_JSON_KEY
 
 jobs:
-  build:
+  test:
     docker:
-      - image: circleci/ruby:2.7.1-node
+      - image: cimg/ruby:2.7.1-node
         environment:
           - RAILS_ENV=test
           - RACK_ENV=test
@@ -25,9 +34,10 @@ jobs:
       - run:
           name: Check code style
           command: bundle exec rubocop
+
   deploy:
     docker:
-      - image: circleci/ruby:2.7.1-node
+      - image: cimg/ruby:2.7.1-node
     steps:
       - checkout
       - run:
@@ -56,14 +66,76 @@ jobs:
             gem push cirro-ruby-client-$version.gem
             shred -u ~/.gem/credentials
 
+  defectdojo:
+    docker:
+      - image: *infra_container
+        <<: *infra_container_registry_auth
+    environment:
+      - DEFECTDOJO_URL: defectdojo.testcloud.io
+      - DEFECTDOJO_PRODUCT: Cirro Ruby Client
+      - DEFECTDOJO_ENG_NAME: CircleCI Scan
+    steps:
+      - checkout
+      - run: 
+          name: Setup access to GCP
+          command: |
+            echo $GOOGLE_JSON_KEY > ${HOME}/gcloud-service-key.json && \
+            gcloud auth activate-service-account --key-file=${HOME}/gcloud-service-key.json
+            gcloud auth configure-docker
+      - run:
+          name: Scans
+          command: |
+            unset GITHUB_TOKEN && trivy fs --exit-code 0 --no-progress --ignorefile .trivyignore-fake --format json --output filesystem-scan.json .
+            gitleaks detect --no-git --exit-code 0 --report-format json --report-path gitleaks.json
+      - run:
+          name: Send data to DefectDojo
+          command: |
+            export DEFECTDOJO_TOKEN=$(gcloud secrets versions access latest \
+            --secret="defectdojo_token" \
+            --project=cirro-io \
+            --quiet)
+
+            # Send Trivy filesystem scan
+            curl --fail --request POST https://$DEFECTDOJO_URL/api/v2/reimport-scan/ \
+            --header "Authorization: Token $DEFECTDOJO_TOKEN" \
+            --form "active=true" \
+            --form "auto_create_context=true" \
+            --form "branch_tag=${CIRCLE_BRANCH}" \
+            --form "commit_hash=${CIRCLE_SHA1}" \
+            --form "close_old_findings=true" \
+            --form "scan_type=Trivy Scan" \
+            --form "test_title=Trivy application scan" \
+            --form "engagement_name=${DEFECTDOJO_ENG_NAME}" \
+            --form "product_name=${DEFECTDOJO_PRODUCT}" \
+            --form "file=@filesystem-scan.json"
+
+            # Send Gitleaks scan
+            curl --fail --request POST https://$DEFECTDOJO_URL/api/v2/reimport-scan/ \
+            --header "Authorization: Token $DEFECTDOJO_TOKEN" \
+            --form "active=true" \
+            --form "auto_create_context=true" \
+            --form "branch_tag=${CIRCLE_BRANCH}" \
+            --form "commit_hash=${CIRCLE_SHA1}" \
+            --form "close_old_findings=true" \
+            --form "scan_type=Gitleaks Scan" \
+            --form "test_title=Gitleaks Scan" \
+            --form "engagement_name=${DEFECTDOJO_ENG_NAME}" \
+            --form "product_name=${DEFECTDOJO_PRODUCT}" \
+            --form "file=@gitleaks.json"
+
 workflows:
   version: 2
   deploy_the_gem:
     jobs:
-      - build
+      - test
       - deploy:
           requires:
-            - build
+            - test
+          filters:
+            branches:
+              only:
+                - master
+      - defectdojo:
           filters:
             branches:
               only:

data/.gitignore

@@ -6,6 +6,11 @@
 /pkg/
 /spec/reports/
 /tmp/
+.idea/
 
 # rspec failure tracking
 .rspec_status
+
+# vim artifacts
+**.swp
+**.swo

data/.rubocop.yml

@@ -10,18 +10,26 @@ AllCops:
     - 'vendor/**/*'
     - 'spec/fixtures/**/*'
 
-Metrics/MethodLength:
-  Max: 25
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
 
 Layout/LineLength:
   Max: 160
 
-# Details:
-#   http://c2.com/cgi/wiki?AbcMetric
-Metrics/AbcSize:
-  # The ABC size is a calculated magnitude, so this number can be a Fixnum or
-  # a Float.
-  Max: 20
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
 
 Style/StringLiterals:
   EnforcedStyle: single_quotes
@@ -35,9 +43,6 @@ Style/NumericLiterals:
 Style/SignalException:
   EnforcedStyle: only_raise
 
-Metrics/ClassLength:
-  Max: 120
-
 # TODO: enable this when Ruby 3.0 is out.
 Style/FrozenStringLiteralComment:
   Enabled: false
@@ -107,6 +112,9 @@ Style/HashTransformValues:
 RSpec/FilePath:
   Enabled: true
   IgnoreMethods: true
+  Exclude:
+    - "spec/cirro_io_v2/**/*_spec.rb"
+
 
 Style/Documentation:
   Enabled: false
@@ -114,5 +122,14 @@ Style/Documentation:
 RSpec/ExampleLength:
   Enabled: false
 
+RSpec/EmptyExampleGroup:
+  Enabled: false
+
 RSpec/MultipleExpectations:
   Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/WordArray:
+  EnforcedStyle: brackets

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at singhinther@gmail.com. All
+reported by contacting the project team at devs@test.io. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    cirro-ruby-client (1.6.1)
+    cirro-ruby-client (2.0.1)
+      activesupport
       faraday (< 1.2.0)
       faraday_middleware
       json_api_client (>= 1.10.0)
@@ -10,19 +11,19 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.3.2)
-      activesupport (= 6.1.3.2)
-    activesupport (6.1.3.2)
+    activemodel (6.1.5)
+      activesupport (= 6.1.5)
+    activesupport (6.1.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.1)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.10)
     crack (0.4.4)
     diff-lcs (1.4.4)
     faker (2.14.0)
@@ -30,21 +31,21 @@ GEM
     faraday (1.1.0)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords
-    faraday_middleware (1.0.0)
+    faraday_middleware (1.2.0)
       faraday (~> 1.0)
     hashdiff (1.0.1)
-    i18n (1.8.5)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    json_api_client (1.18.0)
+    json_api_client (1.21.0)
       activemodel (>= 3.2.0)
       activesupport (>= 3.2.0)
       addressable (~> 2.2)
-      faraday (>= 0.15.2, < 1.2.0)
-      faraday_middleware (>= 0.9.0, < 1.2.0)
+      faraday (>= 0.15.2, < 2.0)
+      faraday_middleware (>= 0.9.0, < 2.0)
       rack (>= 0.2)
-    jwt (2.2.3)
+    jwt (2.3.0)
     method_source (1.0.0)
-    minitest (5.14.4)
+    minitest (5.15.0)
     multipart-post (2.1.1)
     parallel (1.19.2)
     parser (2.7.2.0)
@@ -85,7 +86,7 @@ GEM
     rubocop-rspec (1.43.2)
       rubocop (~> 0.87)
     ruby-progressbar (1.10.1)
-    ruby2_keywords (0.0.4)
+    ruby2_keywords (0.0.5)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
@@ -93,7 +94,7 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   ruby
@@ -109,4 +110,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.1.4
+   2.3.4

data/README.md

@@ -55,3 +55,356 @@ invitation = CirroIO::Client::GigInvitation.new(gig: gig)
 
 invitation.bulk_create_with(filter, auto_accept: true) # by default auto_accept is false
 ```
+
+#### Creating Payouts for workers
+
+```ruby
+app_worker = CirroIO::Client::AppWorker.load(id: 1234)
+
+CirroIO::Client::Payout.create(
+  app_worker: app_worker,
+  amount: 100, # € 1.00
+  title: "Bonus for something",
+  description: "Description of the bonus.",
+  cost_center_key: "PROJECT-CODE",
+  billing_date: DateTime.now
+)
+```
+
+# CirroIOV2::Client
+
+## Configuration
+
+  ```ruby
+  # with key path
+  client = CirroIOV2::Client.new(private_key_path: "./storage/cirro_key.pem", client_id: "WULnc6Y0rlaTBCSiHAb0kGWKFuIxPWBXJysyZeG3Rtw", site: "https://api.staging.cirro.io")
+
+  # with key string
+  client = CirroIOV2::Client.new(private_key: Rails.application.credentials.cirro_private_key, client_id: "WULnc6Y0rlaTBCSiHAb0kGWKFuIxPWBXJysyZeG3Rtw", site: "https://api.staging.cirro.io")
+  ```
+
+# Usage
+
+## User
+### Get user info
+
+```ruby
+user = client.User.find(1)
+# => User object
+
+user.first_name
+# => 'Grazyna'
+
+user.worker
+# => { billable: false, document: {...} }
+```
+
+### Get notification preferences for a user
+
+```ruby
+preference = client.User.get_notification_preference(1)
+# => NotificationPreference object
+
+preference.id
+# => '1'
+
+preference.locale
+# => 'de'
+
+preference.channels
+# => Array of NotificationTopicPreference objects
+```
+
+### Update notification preferences for a user
+
+```ruby
+client.User.update_notification_preference({
+  locale: 'de',
+  channels: [
+    { id: '1', preferences: { email: 'immediately' } },
+    { id: '2', preferences: { email: 'digest_daily' } }
+  ]
+})
+```
+
+## Gig
+### Create a gig
+
+```ruby
+client.Gig.create(
+  title: "Favourite programming language?",
+  description: "Description of gig ...",
+  url: "http://heathcote.co/zina.gibson",
+  start_at: 1652285764,
+  end_at: 1653412329,
+  total_seats: 2,
+  invitation_mode: "auto",
+  filter_query: {
+  status: "active",
+  segment: "my_favorite_testers"
+  },
+  tasks: [
+    { title: "Ah, Wilderness!", base_price: 300 }
+  ],
+  notification_payload: {
+    project_title: "Corporate Tax",
+    task_title: "Add dataset",
+    task_type: "Review"
+  },
+  epam_options: {
+    extra_mile: true
+  }
+)
+# => Gig object
+```
+
+## GigInvitation
+### Get list of gig invitations
+
+By default the response is paginated with 10 per page. The `has_more` attribute indicates whether there're more records to be fetched or not.
+You can move from page to page using `after` or `before`.
+
+```ruby
+# return all with max limit
+client.GigInvitation.list(limit: 100)
+
+# return paginated after gig invitation ID 100
+client.GigInvitation.list(limit: 100, after: 100)
+
+# return paginated before gig invitation ID 100
+client.GigInvitation.list(limit: 100, before: 100)
+
+# filter by user with ID 1 and gig with ID 1
+client.GigInvitation.list(user_id: 1, gig_id: 1)
+
+# filter by status
+client.GigInvitation.list(status: ['pending', 'accepted'])
+client.GigInvitation.list(status: 'accepted')
+
+list = client.GigInvitation.list(limit: 100)
+# => ListObject
+
+list.has_more?
+# => true
+
+list.data
+# => Array of GigInvitation objects
+```
+
+### Accept a gig invitation
+
+```ruby
+client.GigInvitation.accept(1)
+```
+
+## Notification Locale
+### Create a notification locale
+
+```ruby
+locale = client.NotificationLocale.create(locale: 'de')
+# => NotificationLocale object
+
+locale.locale
+# => 'de'
+
+locale.configurations
+# => Array of NotificationConfiguration objects
+```
+
+### List all notification locales
+
+```ruby
+list = client.NotificationLocale.list
+# => ListObject
+
+list.has_more?
+# => true
+
+list.data
+# => Array of NotificationLocale objects
+
+client.NotificationLocale.list(default: true) # filter by default
+```
+
+## Notification Configuration
+### List all notification configurations
+
+```ruby
+list = client.NotificationConfiguration.list
+# => ListObject
+
+list.has_more?
+# => true
+
+list.data
+# => Array of NotificationConfiguration objects
+
+client.NotificationConfiguration.list(locale: 'de') # filter by locale
+
+client.NotificationConfiguration.list(limit: 100, after: 100) # pagination
+```
+
+## Notification Layout
+### Create a notification layout
+
+```ruby
+client.NotificationLayout.create(
+  name: 'custom_layout',
+  templates: [
+    { notification_configuration_id: '1', body: '<p>hello {{recipient}}</p>' },
+    { notification_configuration_id: '2', body: '<p>hallo {{recipient}}</p>' }
+  ]
+)
+```
+
+### Update a notification layout
+
+```ruby
+client.NotificationLayout.update('1', name: 'custom_layout')
+```
+
+### Create a new template
+
+```ruby
+client.NotificationLayout.create_template(
+  '1',
+  { notification_configuration_id: '1', body: '<p>hello {{recipient}}</p>' }
+)
+# => NotificationLayoutTemplate object
+```
+
+## Notification Layout Template
+### Update a notification layout template
+
+```ruby
+client.NotificationLayoutTemplate.update(
+  '1',
+  { notification_configuration_id: '1', body: '<p>hello {{recipient}}</p>' }
+)
+```
+### Delete a notification layout template
+
+```ruby
+client.NotificationLayoutTemplate.delete('1')
+```
+
+## Notification Topic
+### List all notification topics
+
+```ruby
+list = client.NotificationTopic
+# => ListObject
+
+list.has_more?
+# => true
+
+list.data
+# => Array of NotificationTopic objects
+
+# filter by layout_id
+client.NotificationTopic.list(notification_layout_id: 1)
+
+# pagination
+client.NotificationTopic.list(limit: 10, after: 10)
+```
+
+### Create a notification channel
+
+```ruby
+client.NotificationTopic.create(
+  name: 'new_bug_comment',
+  notification_layout_id: 1,
+  preferences: {
+    email: 'immediately'
+  },
+  templates: [
+    {
+      "notification_configuration_id": "1",
+      "subject": "New Bug Comment",
+      "body": "Hello {{recipient_first_name}}, you got {{pluralize count, 'new comment', 'new comments'}}"
+    },
+    {
+      "notification_configuration_id": "2",
+      "subject": "Neuer Kommentar",
+      "body": "Hallo {{recipient_first_name}}, Du hast {{pluralize count, 'neuen Kommentar', 'neue Kommentare'}}"
+    }
+  ]
+)
+```
+
+## Notification (Channel) Template
+### List all
+
+```ruby
+list = client.NotificationTemplate
+# => ListObject
+
+list.has_more?
+# => true
+
+list.data
+# => Array of NotificationTemplate objects
+
+# filter by channel id
+client.NotificationTemplate.list(notification_channel_id: 1)
+
+# filter by configuration id
+client.NotificationTemplate.list(notification_configuration_id: 1)
+
+# pagination
+client.NotificationTemplate.list(limit: 10, after: 10)
+```
+
+### Update a notification template
+
+```ruby
+client.NotificationTemplate.update(
+  '1',
+  "subject": "New Bug Comment",
+  "body": "Hello {{recipient_first_name}}, you got {{pluralize count, 'new comment', 'new comments'}}"
+)
+``` 
+
+### Delete a notification template
+
+```ruby
+client.NotificationTemplate.delete('1')
+``` 
+## Notifcation Channel Preference
+### List all
+
+```ruby
+list = client.NotificationTopicPreference.list
+# => ListObject
+
+list.has_more?
+# => true
+
+list.data
+# => Array of NotificationTopicPreference objects
+
+# filter by channel id
+client.NotificationTopicPreference.list(notification_channel_id: 1)
+
+# filter by user id
+client.NotificationTopicPreference.list(user_id: 1)
+
+# pagination
+client.NotificationTopicPreference.list(limit: 10, after: 10)
+```
+
+## Notifcation Broadcast
+### Create a notifcation broadcast
+
+```ruby
+client.NotificationBroadcast.create(
+  payload: {
+    foo: 'bar',
+    key: 'value'
+  },
+  recipients: {
+    user_ids: [1, 2, 3]
+  },
+  notification_channel_id: 1
+)
+```

data/bin/console

@@ -2,6 +2,7 @@
 
 require 'bundler/setup'
 require 'cirro_io/client'
+require 'cirro_io_v2/client'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/cirro-ruby-client.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'activesupport'
   spec.add_runtime_dependency 'jwt'
   spec.add_runtime_dependency 'faraday', '< 1.2.0'
   spec.add_runtime_dependency 'faraday_middleware'

data/lib/cirro_io/client/base.rb

@@ -28,6 +28,26 @@ module CirroIO
           conn.use JsonApiClient::Middleware::Status, {}
         end
       end
+
+      # HACK: https://github.com/JsonApiClient/json_api_client/issues/390
+      # waiting for json_api_client to release a new version with the fix
+      # https://github.com/JsonApiClient/json_api_client/pull/398
+      # rubocop:disable all
+      def initialize(params = {})
+        params = params.with_indifferent_access
+        @persisted = nil
+        @destroyed = nil
+        self.links = self.class.linker.new(params.delete(:links) || {})
+        self.relationships = self.class.relationship_linker.new(self.class, params.delete(:relationships) || {})
+        self.attributes = self.class.default_attributes.merge params.except(*self.class.prefix_params)
+        self.forget_change!(:type)
+        self.__belongs_to_params = params.slice(*self.class.prefix_params)
+
+        setup_default_properties
+
+        self.request_params = self.class.request_params_class.new(self.class)
+      end
+      # rubocop:enable all
     end
   end
 end