bonita 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 572ccd6cb3b9400725507a810146bee1cd19c530
+  data.tar.gz: 31548ca22dd29800d89733b3adc6e9bff3d1a2ff
+SHA512:
+  metadata.gz: d44eddbc53c53afd5e42da0af36c7acd5f64e8893fa683476ae969163b23e7309291aa8767917941c8fb83cf0be55f94851894597c2a425dfebd8315033d2fb2
+  data.tar.gz: 073a5a847a94e5009b699b6ee2e1e23195de93ad03770584ef8564305d9fa5cefb0b2a93612d420edb10dbf79d43c01c47e956b9c9f639055f52b7cff6e2dab7

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+.rubocop-*
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+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 pierre.deville@effilab.com. 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.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bonita.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Pierre Deville
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# BonitaBPM Ruby API Client
+
+Unofficial API client for [Bonita API](https://effilab.atlassian.net/wiki/display/IT/Product+Launch+-+Overview)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bonita'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bonita
+
+## Usage
+
+Bonita API requires you to login to the portal URL, then logout when you're done.
+
+There is two way to handle this authentication logic.
+
+### With a block
+
+```ruby
+Bonita::Client.start(username: "YOUR_USERNAME", password: "YOUR_PASSWORD", url: "YOUR_BONITA_SERVER_URL") do |client|
+  # Perform your request while authenticated using the client object
+end # Logout seamlessly when closing the block_given
+```
+
+### With an instance
+```ruby
+client = Bonita::Client.new(username: "YOUR_USERNAME", password: "YOUR_PASSWORD", url: "YOUR_BONITA_SERVER_URL")
+client.login
+# perform request
+client.logout
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Pierre Deville/bonita. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bonita"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bonita.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bonita/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bonita"
+  spec.version       = Bonita::VERSION
+  spec.authors       = ["Pierre Deville"]
+  spec.email         = ["pierre.deville@effilab.com"]
+
+  spec.summary       = "Unofficial REST API client for Bonita BPM"
+  spec.description   = "Unofficial REST API client for Bonita BPM"
+  spec.homepage      = "http://example.com"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport', '> 3.0', '< 5.1'
+  spec.add_dependency 'resource_kit', '~> 0.1.6'
+  spec.add_dependency 'kartograph', '~> 0.2.4'
+  spec.add_dependency 'faraday-cookie_jar', '~> 0.0.6'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/bonita.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# 3rd party dependencies
+require 'resource_kit'
+require 'kartograph'
+require 'faraday'
+require 'faraday-cookie_jar'
+
+# Utils
+require 'bonita/utils'
+
+# Error Handling
+require 'bonita/mappings/error_mapping'
+require 'bonita/error'
+require 'bonita/error_handler'
+
+# Models
+require 'bonita/models/base_model'
+require 'bonita/models/bpm/process'
+require 'bonita/models/customuserinfo/definition'
+require 'bonita/models/customuserinfo/value'
+require 'bonita/models/customuserinfo/user'
+require 'bonita/models/identity/user'
+require 'bonita/models/identity/group'
+require 'bonita/models/identity/role'
+require 'bonita/models/identity/membership'
+
+# JSON Maps
+require 'bonita/mappings/bpm/process_mapping'
+require 'bonita/mappings/customuserinfo/definition_mapping'
+require 'bonita/mappings/customuserinfo/value_mapping'
+require 'bonita/mappings/customuserinfo/user_mapping'
+require 'bonita/mappings/identity/user_mapping'
+require 'bonita/mappings/identity/group_mapping'
+require 'bonita/mappings/identity/role_mapping'
+require 'bonita/mappings/identity/membership_mapping'
+
+# Resources
+require 'bonita/resources/bpm/process_resource'
+require 'bonita/resources/customuserinfo/definition_resource'
+require 'bonita/resources/customuserinfo/value_resource'
+require 'bonita/resources/customuserinfo/user_resource'
+require 'bonita/resources/identity/user_resource'
+require 'bonita/resources/identity/group_resource'
+require 'bonita/resources/identity/role_resource'
+require 'bonita/resources/identity/membership_resource'
+
+require 'bonita/middleware/csrf'
+require 'bonita/client'
+
+module Bonita
+end

data/lib/bonita/client.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+module Bonita
+  class Client
+    attr_reader :username, :password, :url, :redirect_url, :tenant
+
+    class << self
+      def resources
+        {
+          customuserinfo: {
+            definitions: Customuserinfo::DefinitionResource,
+            users: Customuserinfo::UserResource,
+            values: Customuserinfo::ValueResource,
+          },
+          bpm: {
+            processes: Bpm::ProcessResource,
+          },
+          identity: {
+            groups: Identity::GroupResource,
+            memberships: Identity::MembershipResource,
+            roles: Identity::RoleResource,
+            users: Identity::UserResource,
+          },
+        }
+      end
+
+      def start(options = {})
+        client = new(options)
+        client.login
+
+        yield(client)
+      ensure
+        client.logout
+      end
+    end
+
+    resources.each do |key, value|
+      if value.is_a? Hash
+        mod = Object.const_get("Bonita::#{key.capitalize}")
+        mod.module_eval do
+          value.each do |k, v|
+            define_singleton_method(k) { v.new(connection: connection) }
+          end
+        end
+
+        define_method(key) do
+          this = self
+          mod.define_singleton_method(:connection) { this.connection }
+          mod
+        end
+      else
+        define_method(key) { value.new(connection: connection) }
+      end
+    end
+
+    def initialize(options = {})
+      @url          = options[:url]
+      @username     = options[:username]
+      @password     = options[:password]
+      @tenant       = options[:tenant]
+    end
+
+    def login
+      response =
+        connection.post '/bonita/loginservice' do |req|
+          req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+          req.body = {
+            username:     @username,
+            password:     @password,
+            tenant:       @tenant,
+          }
+        end
+
+      raise Bonita::AuthError, 'Unable to log in' if response.body.include?('Unable to log in')
+      true
+    end
+
+    def logout
+      connection.get '/bonita/logoutservice?redirect=false'
+    end
+
+    def connection
+      @faraday ||=
+        Faraday.new connection_options do |conn|
+          conn.use :cookie_jar
+          conn.use Bonita::Middleware::CSRF
+          conn.use Faraday::Request::UrlEncoded
+          conn.adapter Faraday.default_adapter
+        end
+    end
+
+    private
+
+      def connection_options
+        {
+          url: @url,
+          request: {
+            params_encoder: Faraday::FlatParamsEncoder,
+          },
+          headers: {
+            content_type: 'application/json',
+          },
+        }
+      end
+  end
+end

data/lib/bonita/error.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module Bonita
+  class Error < StandardError
+    attr_reader :java_exception, :error_message, :explanations, :status
+
+    def initialize(status, body)
+      if body['exception']
+        mapping = Bonita::ErrorMapping.extract_single(body, :read)
+        @java_exception = mapping.exception
+        @error_message  = mapping.message
+        @explanations   = mapping.explanations
+        @status         = status
+        values = Hash[instance_variables.map { |name| [name, instance_variable_get(name)] }]
+      else
+        values = body
+      end
+
+      super(values)
+    end
+  end
+
+  AuthError         = Class.new(StandardError)
+  UnauthorizedError = Class.new(StandardError)
+  ForbiddenError    = Class.new(StandardError)
+end