processmaker 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0806dca8aa57f0804ff5cd941e26b2c3fc3126c
+  data.tar.gz: 48d4901da2be7771f9890562e32259e565337114
+SHA512:
+  metadata.gz: aa96bd6b71d647d97aa0f1495bb591117409ae33cd4d8e9ef9e464e0ad0f9a080670db14b3ed7f9fc8bb95a87bcd06d7e40e10f8c46edfc38f53a21cdad355aa
+  data.tar.gz: f113bb68e6bdb7ac38dc61e55e128fe5b74783efea00605fd9e16c121ea8dbd098a7f890cf7a8d28acbb887eebc6bd214b124c4045b9afe83b81979d99006207

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at contact@pierre-deville.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in processmaker-client.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,31 @@
+# Processmaker Client Ruby
+
+REST API Ruby Client for [ProcessMaker](http://www.processmaker.com/).
+
+** /!\ This gem is still a work in progress and is not ready for production use ! /!\ **
+
+## Installation
+
+```
+gem install processmaker
+```
+
+Or in your `Gemfile`
+
+```
+gem 'processmaker'
+```
+
+## Usage
+
+Before using the client you first need to generate an access token from the Processmaker admin interface (check their [wiki](http://wiki.processmaker.com/3.1/OAuth_2.0#Registering_an_external_application_to_use_REST))
+
+```ruby
+client = Processmaker::Client.new(access_token: 'YOUR_TOKEN')
+
+client.cases
+# => [Processmaker::CaseResource]
+
+client.cases.all
+# => [Processmaker::Case(app_uid: '123', app_name: 'my_case', ....), ...]
+```

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.2

data/bin/console

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

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/lib/processmaker.rb

@@ -0,0 +1,27 @@
+require 'active_support/all'
+require 'resource_kit'
+require 'kartograph'
+
+module Processmaker
+  autoload :Client, 'processmaker/client'
+
+  # Models
+  autoload :BaseModel, 'processmaker/models/base_model'
+  autoload :Case, 'processmaker/models/case'
+  autoload :Project, 'processmaker/models/project'
+  autoload :Activity, 'processmaker/models/activity'
+  autoload :User, 'processmaker/models/user'
+
+  # Resources
+  autoload :CaseResource, 'processmaker/resources/case_resource'
+  autoload :ProjectResource, 'processmaker/resources/project_resource'
+  autoload :UserResource, 'processmaker/resources/user_resource'
+
+  # JSON Maps
+  autoload :CaseMapping, 'processmaker/mappings/case_mapping'
+  autoload :ProjectMapping, 'processmaker/mappings/project_mapping'
+  autoload :ActivityMapping, 'processmaker/mappings/activity_mapping'
+  autoload :UserMapping, 'processmaker/mappings/user_mapping'
+
+  # Errors
+end

data/lib/processmaker/client.rb

@@ -0,0 +1,49 @@
+require 'faraday'
+
+module Processmaker
+  class Client
+
+    attr_reader :access_token
+
+    class << self
+      def resources
+        {
+          cases: CaseResource,
+          projects: ProjectResource,
+          users: UserResource,
+        }
+      end
+    end
+
+    self.resources.each do |k, v|
+      define_method(k) { v.new(connection: connection) }
+    end
+
+    def initialize(options = {})
+      @access_token = options.with_indifferent_access[:access_token]
+      @url          = options.with_indifferent_access[:url]
+    end
+
+    def connection
+      @faraday ||= Faraday.new connection_options do |req|
+        req.adapter :net_http
+      end
+    end
+
+    def resources
+      @resources ||= {}
+    end
+
+    private
+
+    def connection_options
+      {
+        url: @url,
+        headers: {
+          content_type: 'application/json',
+          authorization: "Bearer #{access_token}"
+        }
+      }
+    end
+  end
+end

data/lib/processmaker/mappings/activity_mapping.rb

@@ -0,0 +1,14 @@
+module Processmaker
+  class ActivityMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Activity
+
+      scoped :read do
+        property :act_uid
+        property :act_name
+      end
+    end
+  end
+end

data/lib/processmaker/mappings/case_mapping.rb

@@ -0,0 +1,18 @@
+module Processmaker
+  class CaseMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Case
+
+      property :pro_uid, scopes: [:create]
+      property :usr_uid, scopes: [:create]
+      property :tas_uid, scopes: [:create]
+      property :variables, scopes: [:create]
+      property :del_index, scopes:[:create]
+
+      property :app_uid, scopes: [:read]
+      property :app_number, scopes: [:read]
+    end
+  end
+end

data/lib/processmaker/mappings/project_mapping.rb

@@ -0,0 +1,18 @@
+module Processmaker
+  class ProjectMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Project
+
+      scoped :read do
+        property :prj_uid
+        property :prj_name
+        property :prj_description
+        property :prj_category
+        property :prj_create_date
+        property :prj_update_date
+      end
+    end
+  end
+end

data/lib/processmaker/mappings/user_mapping.rb

@@ -0,0 +1,38 @@
+module Processmaker
+  class UserMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping User
+
+      scoped :read do
+        property :usr_uid
+        property :usr_username
+        property :usr_password
+        property :usr_firstname
+        property :usr_lastname
+        property :usr_email
+        property :usr_due_date
+        property :usr_create_date
+        property :usr_update_date
+        property :usr_status
+        property :usr_country
+        property :usr_city
+        property :usr_location
+        property :usr_address
+        property :usr_phone
+        property :usr_fax
+        property :usr_cellular
+        property :usr_zip_code
+        property :dep_uid
+        property :usr_position
+        property :usr_resume
+        property :usr_birthday
+        property :usr_role
+        property :usr_reports_to
+        property :usr_replaced_by
+        property :usr_ux
+      end
+    end
+  end
+end

data/lib/processmaker/models/activity.rb

@@ -0,0 +1,6 @@
+module Processmaker
+  class Activity < BaseModel
+    attribute :act_uid
+    attribute :act_name
+  end
+end

data/lib/processmaker/models/base_model.rb

@@ -0,0 +1,13 @@
+require 'virtus'
+
+module Processmaker
+  class BaseModel
+    include Virtus.model
+    include Virtus::Equalizer.new(name || inspect)
+
+    def inspect
+      values = Hash[instance_variables.map { |name| [name, instance_variable_get(name)] } ]
+      "<#{self.class.name} #{values}>"
+    end
+  end
+end

data/lib/processmaker/models/case.rb

@@ -0,0 +1,10 @@
+module Processmaker
+  class Case < BaseModel
+    %i(app_uid app_number del_index).each { |key| attribute(key) }
+
+    attribute :pro_uid
+    attribute :tas_uid
+    attribute :usr_uid
+    attribute :variables
+  end
+end

data/lib/processmaker/models/project.rb

@@ -0,0 +1,10 @@
+module Processmaker
+  class Project < BaseModel
+    attribute :prj_uid
+    attribute :prj_name
+    attribute :prj_description
+    attribute :prj_category
+    attribute :prj_create_date
+    attribute :prj_update_date
+  end
+end

data/lib/processmaker/models/user.rb

@@ -0,0 +1,30 @@
+module Processmaker
+  class User < BaseModel
+    attribute :usr_uid
+    attribute :usr_username
+    attribute :usr_password
+    attribute :usr_firstname
+    attribute :usr_lastname
+    attribute :usr_email
+    attribute :usr_due_date
+    attribute :usr_create_date
+    attribute :usr_update_date
+    attribute :usr_status
+    attribute :usr_country
+    attribute :usr_city
+    attribute :usr_location
+    attribute :usr_address
+    attribute :usr_phone
+    attribute :usr_fax
+    attribute :usr_cellular
+    attribute :usr_zip_code
+    attribute :dep_uid
+    attribute :usr_position
+    attribute :usr_resume
+    attribute :usr_birthday
+    attribute :usr_role
+    attribute :usr_reports_to
+    attribute :usr_replaced_by
+    attribute :usr_ux
+  end
+end

data/lib/processmaker/resources/case_resource.rb

@@ -0,0 +1,34 @@
+module Processmaker
+  class CaseResource < ResourceKit::Resource
+
+    resources do
+
+      default_handler { |response| response }
+
+      # http://wiki.processmaker.com/3.1/REST_API_Cases#Get_To_Do_Cases:_GET_.2Fcases
+      action :all, 'GET /cases' do
+        path '/api/1.0/workflow/cases'
+        verb :get
+        body { |object| object }
+      end
+
+      # http://wiki.processmaker.com/3.1/REST_API_Cases#New_Case:_POST_.2Fcases
+      action :create, 'POST /cases/impersonate' do
+        path '/api/1.0/workflow/cases/impersonate'
+        verb :post
+        body { |object| CaseMapping.representation_for(:create, object) }
+        handler(:ok) { |response, object| CaseMapping.extract_into_object(object, response.body, :read)}
+      end
+
+      # http://wiki.processmaker.com/3.1/REST_API_Cases#Route_Case:_PUT_.2Fcases.2F.7Bapp_uid.7D.2Froute-case
+      action :route do
+        path '/api/1.0/workflow/cases/:app_uid/route-case'
+        verb :put
+        body { |request| request.to_json }
+        handler(:ok) { |response, object| CaseMapping.extract_into_object(object, response.body, :read)}
+      end
+    end
+
+
+  end
+end

data/lib/processmaker/resources/project_resource.rb

@@ -0,0 +1,26 @@
+module Processmaker
+  class ProjectResource < ResourceKit::Resource
+
+    resources do
+
+      default_handler { |response| response }
+
+      # http://wiki.processmaker.com/3.1/REST_API_Cases#Get_To_Do_Cases:_GET_.2Fcases
+      # @return [Array<Processmaker::Project>] a collection of of projects
+      action :all, 'GET /projects' do
+        path '/api/1.0/workflow/projects'
+        verb :get
+        handler(:ok) { |response| ProjectMapping.extract_collection(response.body, :read)}
+      end
+
+      # http://wiki.processmaker.com/3.0/REST_API_Designer#Get_starting_tasks
+      # @param prj_uid [String] the project unique identifier
+      # @return [Array<Processmaker::Activity>] A collection of activities
+      action :starting_tasks, 'GET /project/:prj_uid/starting-tasks' do
+        path '/api/1.0/workflow/project/:prj_uid/starting-tasks'
+        verb :get
+        handler(:ok) { |response| ActivityMapping.extract_collection(response.body, :read)}
+      end
+    end
+  end
+end

data/lib/processmaker/resources/user_resource.rb

@@ -0,0 +1,18 @@
+module Processmaker
+  class UserResource < ResourceKit::Resource
+
+    resources do
+
+      default_handler { |response| response }
+
+      # http://wiki.processmaker.com/3.1/REST_API_Administration#Get_Users_List:_GET_.2Fusers
+      # @return [Array<Processmaker::User>] a collection of of projects
+      action :all, 'GET /users' do
+        path '/api/1.0/workflow/users'
+        query_keys :filter, :start, :limit
+        verb :get
+        handler(:ok) { |response| UserMapping.extract_collection(response.body, :read) }
+      end
+    end
+  end
+end

data/lib/processmaker/version.rb

@@ -0,0 +1,5 @@
+module Processmaker
+  module Client
+    VERSION = "0.1.2"
+  end
+end

data/processmaker.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "processmaker"
+  spec.version       = File.read('VERSION')
+  spec.authors       = ["Pierre Deville"]
+  spec.email         = ["contact@pierre-deville.com"]
+
+  spec.summary       = %q{Unofficial ProcessMaker API client in Ruby}
+  spec.description   = %q{Unofficial ProcessMaker API client in Ruby}
+  spec.homepage      = "https://github.com/Effilab/processmaker"
+  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 { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  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 'virtus', '~> 1.0', '>= 1.0.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: processmaker
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Pierre Deville
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: resource_kit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+- !ruby/object:Gem::Dependency
+  name: kartograph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Unofficial ProcessMaker API client in Ruby
+email:
+- contact@pierre-deville.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/console
+- bin/setup
+- lib/processmaker.rb
+- lib/processmaker/client.rb
+- lib/processmaker/mappings/activity_mapping.rb
+- lib/processmaker/mappings/case_mapping.rb
+- lib/processmaker/mappings/project_mapping.rb
+- lib/processmaker/mappings/user_mapping.rb
+- lib/processmaker/models/activity.rb
+- lib/processmaker/models/base_model.rb
+- lib/processmaker/models/case.rb
+- lib/processmaker/models/project.rb
+- lib/processmaker/models/user.rb
+- lib/processmaker/resources/case_resource.rb
+- lib/processmaker/resources/project_resource.rb
+- lib/processmaker/resources/user_resource.rb
+- lib/processmaker/version.rb
+- processmaker.gemspec
+homepage: https://github.com/Effilab/processmaker
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Unofficial ProcessMaker API client in Ruby
+test_files: []