camundapi 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a7a3246cd575a30f5a2142fcb504e699196fc8c96d66131c42de2a452f61031
-  data.tar.gz: dda9db61d8f2511df983ce3e79199b99e60da0bb8f12371fb61d140ea0a34b88
+  metadata.gz: d67be7eac7a340b836de1b18fc330cf5a3571cb5aea64cb4f3e8ba3debe4600d
+  data.tar.gz: 5fc738ba1694020187ff91e141f617a9f6f8e66cd13053383ee3051330b56f4a
 SHA512:
-  metadata.gz: f278803330cc16f34cc60885e4ed01274ea5493b8dbdfd113762818751ff4c3eb436d746ccfda560533beaa15eabf8220bfb43504d3e56c29bbafea8c14ae687
-  data.tar.gz: a2f1895f23b9bbf33fe6798fe69dc07e3e0d8ca8456ca721bc5b54d81e14e0486f3fb59cb2d8ddfcbe054e1faea92df7c4929328dabf5d6ae65a353e7fbea443
+  metadata.gz: d3958d4885586cb5f754abf866ac55ebed79a60381be158a122b4529fd18d2c28a3bca242f45cb1e447f65d7886401e17d7c6310fa9d1b3e05005397485c499c
+  data.tar.gz: 6ed0efee18895f5be9c84290a059115572d9b35bf7d22f6a77881eca903659254cab6f7cdc47b9d1a275c6723aa9e69c1548090d04e1dfb44129753a9dbb42d1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    camundapi (0.1.4)
+    camundapi (0.1.5)
       json
       net-sftp
       rest-client (~> 2.0)

data/README.md

@@ -7,7 +7,7 @@ This ruby gem is a wrapper for the Camunda API's. You will need to create a clie
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'camunda'
+gem 'camundapi'
 ```
 
 And then execute:
@@ -16,12 +16,62 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install camunda
+    $ gem install camundapi
 
 ## Usage
 
 This library has an opinionated approach has how the API wrapper is implemented but it follows a very similar approach for every Camunda API. All the APIs are in their own module (`Camunda::Operate`, `Camunda::Zeebe`, ..). 
 
+Depending on which APIs you're going to use, you will have to set the right variables in the config:
+
+```ruby
+Camunda.configure do |config|
+  config.client_id = ENV['ZEEBE_CLIENT_ID']
+  config.client_secret = ENV['ZEEBE_CLIENT_SECRET']
+  config.zeebe_audience = ENV['ZEEBE_AUDIENCE']
+  config.authorization_url = ENV['ZEEBE_AUTHORIZATION_SERVER_URL']
+  config.operate_base_url = ENV['CAMUNDA_OPERATE_BASE_URL']
+  config.zeebe_url = ENV['ZEEBE_URL']
+  config.tasklist_base_url = ENV['CAMUNDA_TASKLIST_BASE_URL']
+end
+```
+
+In the `Configuarion` class you can see all the available variables and what it defaults to. 
+
+### Operate API
+Implements the API endpoints you can find [here](https://docs.camunda.io/docs/apis-clients/operate-api/). To use it with this gem, you can execute the following:
+
+```ruby
+instance = Camunda::Operate::ProcessInstances.find('key')
+```
+
+For all the endpoints here we use the similar approach of having its own class per entity (process definitions, incidents, ..) and the `search` and `find` method is always available.
+
+### Zeebe API
+Implements the API endpoints you can find [here](https://docs.camunda.io/docs/apis-clients/grpc/). It makes use of the already existing [Zeebe Ruby gem](https://github.com/zeebe-io/zeebe-client-ruby).
+This part is a work in progress but the foundations are here to add other classes/methods. It follows the same approach as how we've implemented the Operate API - that is that every entity gets its own class. Use as follows:
+
+```ruby
+Camunda::Zeebe::ProcessInstances.create({bpmnProcessId: 'id-of-a-process', version: -1})
+```
+
+### Console API
+Implements the API endpoints you can find [here](https://docs.camunda.io/docs/apis-clients/console-api-reference/). To use it with this gem, you can execute the following:
+
+```ruby
+clusters = Camunda::Console::Clusters.all
+```
+
+For all the endpoints here we use the similar approach of having its own class per entity (process definitions, incidents, ..) and the `search` and `find` method is always available.
+
+### Tasklist API
+Implements the API endpoints you can find [here](https://docs.camunda.io/docs/apis-clients/tasklist-api/tasklist-api-overview/).
+This part is a work in progress but the foundations are here to add other classes/methods. It follows the same approach as how we've implemented the Operate API - that is that every entity gets its own class. Use as follows:
+
+```ruby
+Camunda::Tasklist::UserTasks.all
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -30,7 +80,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/camunda. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/lienvdsteen/camunda/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/lienvdsteen/camunda. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/lienvdsteen/camunda/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/camunda/base_api.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+require 'json'
+require 'uri'
+require 'base64'
+
+module Camunda
+  class BaseAPI
+    def self.get(endpoint, params = {})
+      url = build_url(endpoint, params)
+      response = RestClient.get(url, headers)
+
+      JSON.parse(response.body)
+    end
+
+    def self.post(endpoint, params = {})
+      url = build_url(endpoint)
+      response = RestClient.post(
+        url,
+        params.to_json,
+        headers
+      )
+
+      JSON.parse(response.body) if response.code == 200
+    end
+
+    def self.build_url(endpoint, params = {})
+      url = "#{base_url}/#{Camunda.api_version}/#{endpoint}"
+      url += "?#{URI.encode_www_form(params)}" unless params.empty?
+
+      url
+    end
+
+    def self.headers
+      {
+        Authorization: "Bearer #{oauth_token}",
+        Accept: 'application/json',
+        'Content-Type': 'application/json'
+      }
+    end
+  end
+end

data/lib/camunda/console/api.rb

@@ -1,44 +1,10 @@
 # frozen_string_literal: true
 
-require 'rest-client'
-require 'json'
-require 'uri'
-require 'base64'
-require 'csv'
-
 module Camunda
   module Console
-    class API
-      def self.get(endpoint, params = {})
-        url = build_url(endpoint, params)
-        response = RestClient.get(url, headers)
-
-        JSON.parse(response.body)
-      end
-
-      def self.post(endpoint, params = {})
-        url = build_url(endpoint)
-        response = RestClient.post(
-          url,
-          params.to_json,
-          headers.merge({ 'Content-Type': 'application/json' })
-        )
-
-        JSON.parse(response.body) if response.code == 200
-      end
-
-      def self.build_url(endpoint, params = {})
-        url = "#{Camunda.console_base_url}/#{Camunda.api_version}/#{endpoint}"
-        url += "?#{URI.encode_www_form(params)}" unless params.empty?
-
-        url
-      end
-
-      def self.headers
-        {
-          Authorization: "Bearer #{oauth_token}",
-          Accept: 'application/json'
-        }
+    class API < ::Camunda::BaseAPI
+      def self.base_url
+        Camunda.console_base_url
       end
 
       def self.oauth_token

data/lib/camunda/operate/api.rb

@@ -1,43 +1,10 @@
 # frozen_string_literal: true
 
-require 'rest-client'
-require 'json'
-require 'uri'
-require 'base64'
-require 'csv'
-
 module Camunda
   module Operate
-    class API
-      def self.get(endpoint, params = {})
-        url = build_url(endpoint, params)
-        response = RestClient.get(url, headers)
-
-        JSON.parse(response.body)
-      end
-
-      def self.post(endpoint, params = {})
-        url = build_url(endpoint)
-        response = RestClient.post(
-          url,
-          params.to_json,
-          headers.merge({ 'Content-Type': 'application/json' })
-        )
-
-        JSON.parse(response.body) if response.code == 200
-      end
-
-      def self.build_url(endpoint, params = {})
-        url = "#{Camunda.operate_base_url}/#{Camunda.api_version}/#{endpoint}"
-        url += "?#{URI.encode_www_form(params)}" unless params.empty?
-
-        url
-      end
-
-      def self.headers
-        {
-          Authorization: "Bearer #{oauth_token}"
-        }
+    class API < ::Camunda::BaseAPI
+      def self.base_url
+        Camunda.operate_base_url
       end
 
       def self.oauth_token

data/lib/camunda/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Camunda
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/lib/camunda.rb

@@ -4,6 +4,7 @@ require_relative 'camunda/version'
 require_relative 'camunda/configuration'
 require_relative 'camunda/util'
 require_relative 'camunda/o_auth_resource'
+require_relative 'camunda/base_api'
 require_relative 'camunda/operate'
 require_relative 'camunda/console'
 require_relative 'camunda/zeebe'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camundapi
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Lien Van Den Steen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-25 00:00:00.000000000 Z
+date: 2022-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -85,6 +85,7 @@ files:
 - bin/console
 - bin/setup
 - lib/camunda.rb
+- lib/camunda/base_api.rb
 - lib/camunda/configuration.rb
 - lib/camunda/console.rb
 - lib/camunda/console/api.rb