ragoon 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ef078868badd41e0917f2acdcf12767f0ac11a4
-  data.tar.gz: b08e7c4cac479050116f7148918e6d6f770ddff0
+  metadata.gz: fe814ed32bc7d13e09e6722ab67449e44461523a
+  data.tar.gz: eb5eb942bcc1ea59f4fb3791f9275b53dec50631
 SHA512:
-  metadata.gz: 091de10493e4dd054876f012d811f0d1b03f6539a8d3c0489df736ed6e7064383b979853863ae73dd6d15a3b96f5d8ed725fcce2d89b6d58d81c7c377f7397a0
-  data.tar.gz: d4c59ba3506d32c3d133d178aae91c95b87a8089d189ee8fcd4b6dcbb07d5e3ba3c539f5e4a5e4a14e40ba7f4a3602a378151985f096f53101555229b61fd7cb
+  metadata.gz: 725ee5d5a650f1ad84e7ee8472d6c007b0dbf42cea726d6bc4d79e8a849124f6bc78af048fe774ec7cb9e891d5486a0282299523b8d040e03086322cc1cb834e
+  data.tar.gz: 80d73ab6973c26567fb4549d022fa8fc0d2ee20ec5666a9271fb9edd5f99e501cd05df661a0a90864931ffebffab2257446b5f4c5ddc6da1200d034f4e57fbe6

data/README.md

@@ -75,6 +75,95 @@ notifications = service.retreive
 ]
 ```
 
+### Workflow
+
+```
+service = Ragoon::Services::Workflow.new
+service.workflow_get_requests(
+  request_form_id: 41,
+  filter: 'All',
+  start_request_date:  Time.new(2011,  6, 19, 13, 30),
+  end_request_date:    Time.new(2014, 12,  1, 19, 50),
+  start_approval_date: Time.new(2011,  6,  1, 19, 40),
+  end_approval_date:   Time.new(2014, 12, 31,  9, 45),
+  applicant:           14,
+  last_approval:       6,
+  start_to_get_information_from: 2,
+  maximum_request_amount_to_get: 10
+)
+
+=> [
+{:id=>"33",
+  :number=>"33",
+  :priority=>"0",
+  :subject=>"12月7日休日出勤",
+  :status=>"承認",
+  :applicant=>"14",
+  :last_approver=>"6",
+  :request_date=>2014-12-01 19:40:26 +0900}
+]
+
+service.workflow_get_requests_by_id([33])
+
+=> [
+ {:id=>"33",
+  :number=>"33",
+  :name=>"休日出勤申請（12月7日休日出勤）",
+  :processing_step=>"97",
+  :status=>"承認",
+  :urgent=>"false",
+  :version=>"1417430538",
+  :date=>2014-12-01 19:40:26 +0900,
+  :status_type=>"approved",
+  :applicant=>{:id=>"14", :name=>"松田 環奈"},
+  :items=>
+   [{:name=>"社員番号", :value=>"3110342"}],
+  :steps=>
+   [{:id=>"97",
+     :name=>"経理担当者",
+     :type=>"回覧",
+     :is_approval_step=>"0",
+     :processors=>
+      [{:id=>"13", :name=>"加藤 美咲", :comment=>nil}]}]}
+]
+
+service.workflow_get_sent_application_versions([
+    {id: 23, version: 1306486544},
+    {id: 20, version: 1306486544},
+    {id: 22, version: 1306486533},
+  ],
+  start_date: Time.new(2011, 5, 25, 18, 50),
+  end_date:   Time.new(2011, 6, 26, 18,  0)
+)
+
+=> [
+ {:id=>"22", :version=>"1306486534", :operation=>"modify"},
+ {:id=>"23", :version=>"0", :operation=>"remove"},
+ {:id=>"21", :version=>"1415185979", :operation=>"add"}
+]
+
+service.workflow_get_sent_applications_by_id([21])
+
+=> [{:id=>"21",
+  :number=>"21",
+  :name=>"休日出勤申請（休日出勤申請）",
+  :processing_step=>"65",
+  :status=>"承認",
+  :urgent=>"false",
+  :version=>"1415185979",
+  :date=>2011-05-27 16:10:41 +0900,
+  :status_type=>"approved",
+  :applicant=>{:id=>"6", :name=>"佐藤 昇"},
+  :items=>
+   [{:name=>"社員番号", :value=>"3110334"}],
+  :steps=>
+   [{:id=>"63",
+     :name=>"部長",
+     :type=>"承認（全員）",
+     :is_approval_step=>"1",
+     :processors=>[{:id=>"6", :name=>"佐藤 昇", :comment=>nil}]}]}]
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/ragoon.rb

@@ -4,6 +4,7 @@ require 'ragoon/client'
 require 'ragoon/services'
 require 'ragoon/services/schedule'
 require 'ragoon/services/notification'
+require 'ragoon/services/workflow'
 
 require 'nokogiri'
 require 'rest-client'
@@ -11,16 +12,12 @@ require 'rest-client'
 module Ragoon
   @@secret_options = {}
 
-  def self.garoon_endpoint
-    ENV['GAROON_ENDPOINT'] || secret_options[:garoon_endpoint] || raise_option_error('endpoint')
-  end
-
-  def self.garoon_username
-    ENV['GAROON_USERNAME'] || secret_options[:garoon_username] || raise_option_error('username')
-  end
-
-  def self.garoon_password
-    ENV['GAROON_PASSWORD'] || secret_options[:garoon_password] || raise_option_error('password')
+  def self.default_options
+    {
+      endpoint: ENV['GAROON_ENDPOINT'] || secret_options[:garoon_endpoint] || raise_option_error('endpoint'),
+      username: ENV['GAROON_USERNAME'] || secret_options[:garoon_username] || raise_option_error('username'),
+      password: ENV['GAROON_PASSWORD'] || secret_options[:garoon_password] || raise_option_error('password')
+    }
   end
 
   def self.raise_option_error(type)

data/lib/ragoon/client.rb

@@ -1,14 +1,15 @@
 class Ragoon::Client
   attr_reader :endpoint, :response
 
-  def initialize(endpoint)
+  def initialize(endpoint, options)
     @endpoint = endpoint
+    @options = options
   end
 
   def request(action_name, body_node)
     @action_name = action_name
     @body_node = body_node
-    @response = RestClient.post(endpoint, Ragoon::XML.render(action_name, body_node))
+    @response = RestClient.post(endpoint, Ragoon::XML.render(action_name, body_node, @options))
   end
 
   def result_set

data/lib/ragoon/services.rb

@@ -2,18 +2,19 @@ class Ragoon::Services
   SERVICE_LOCATIONS = {
     schedule:     '/cbpapi/schedule/api?',
     notification: '/cbpapi/notification/api?',
+    workflow:     '/cbpapi/workflow/api?',
   }.freeze
 
   attr_reader :client, :action_type
 
-  def initialize
+  def initialize(options = Ragoon.default_options)
+    @options = options
     @action_type = self.class.name.split('::').pop.downcase.to_sym
-    @client = Ragoon::Client.new(self.endpoint)
+    @client = Ragoon::Client.new(self.endpoint, options)
   end
 
   def endpoint
-    endpoint = URI(Ragoon.garoon_endpoint)
-    "#{endpoint.scheme}://#{endpoint.host}#{endpoint.path}#{SERVICE_LOCATIONS[action_type]}"
+    "#{base_endpoint}#{SERVICE_LOCATIONS[action_type]}"
   end
 
   def self.start_and_end(date = Date.today)
@@ -22,4 +23,12 @@ class Ragoon::Services
       end:   ((date + 1).to_time - 1).utc,
     }
   end
+
+  private
+
+  def base_endpoint
+    endpoint = URI(@options[:endpoint])
+    "#{endpoint.scheme}://#{endpoint.host}#{endpoint.path}"
+  end
+
 end

data/lib/ragoon/services/schedule.rb

@@ -106,7 +106,7 @@ class Ragoon::Services::Schedule < Ragoon::Services
   end
 
   def event_url(id)
-    "#{Ragoon::garoon_endpoint.gsub(/\?.*\Z/, '')}/schedule/view?event=#{id}"
+    "#{base_endpoint}/schedule/view?event=#{id}"
   end
 
   def facility_names(event)

data/lib/ragoon/services/workflow.rb

@@ -0,0 +1,220 @@
+#
+# Workflow API Service
+# https://cybozudev.zendesk.com/hc/ja/articles/202270284
+#
+class Ragoon::Services::Workflow < Ragoon::Services
+
+  #
+  # for admin only
+  #
+
+  def workflow_get_requests(request_form_id:, **options)
+    action_name = 'WorkflowGetRequests'
+
+    options[:request_form_id] = request_form_id
+    [ :start_request_date, :end_request_date,
+      :start_approval_date, :end_approval_date ].each do |key|
+      options[key] = to_datetime(options[key]) if options.has_key?(key)
+    end
+
+    body_node = Ragoon::XML.create_node(action_name)
+    parameter_node = Ragoon::XML.create_node('parameters')
+    body_node.add_child(parameter_node)
+
+    manage_parameter_node = Ragoon::XML.create_node(
+      'manage_request_parmeter', options)
+    parameter_node.add_child(manage_parameter_node)
+
+    client.request(action_name, body_node)
+
+    client.result_set.xpath('//manage_item_detail').map do |item|
+      {
+        id: item[:pid],
+        number: item[:number],
+        priority: item[:priority],
+        subject: item[:subject],
+        status: item[:status],
+        applicant: item[:applicant], # user_id
+        last_approver: item[:last_approver],
+        request_date: parse_time(item[:request_date]),
+      }
+    end
+  ensure
+    client.reset
+  end
+
+  def workflow_get_requests_by_id(ids)
+    action_name = 'WorkflowGetRequestById'
+
+    body_node = Ragoon::XML.create_node(action_name)
+    parameter_node = Ragoon::XML.create_node('parameters')
+    body_node.add_child(parameter_node)
+
+    ids.each do |id|
+      request_id_node = Ragoon::XML.create_node('request_id')
+      request_id_node.content = id
+      parameter_node.add_child(request_id_node)
+    end
+
+    client.request(action_name, body_node)
+
+    client.result_set.xpath('//application').map do |app|
+      parse_application(app)
+    end
+  ensure
+    client.reset
+  end
+
+  #
+  # unprocessed
+  #
+
+  def workflow_get_unprocessed_application_versions(id_versions = [])
+    get_application_versions(
+      'WorkflowGetUnprocessedApplicationVersions',
+      nil, nil,
+      id_versions
+    )
+  end
+
+  def workflow_get_unprocessed_applications_by_id(ids)
+    get_applications_by_id('WorkflowGetUnprocessedApplicationsById', ids)
+  end
+
+  #
+  # sent
+  #
+
+  def workflow_get_sent_application_versions(id_versions = [], start_date:, end_date: nil)
+    get_application_versions(
+      'WorkflowGetSentApplicationVersions',
+      start_date, end_date,
+      id_versions
+    )
+  end
+
+  def workflow_get_sent_applications_by_id(ids)
+    get_applications_by_id('WorkflowGetSentApplicationsById', ids)
+  end
+
+  #
+  # recieved
+  #
+
+  def workflow_get_received_application_versions(id_versions = [], start_date:, end_date: nil)
+    get_application_versions(
+      'WorkflowGetReceivedApplicationVersions',
+      start_date, end_date,
+      id_versions
+    )
+  end
+
+  def workflow_get_received_applications_by_id(ids)
+    get_applications_by_id('WorkflowGetReceivedApplicationsById', ids)
+  end
+
+  private
+
+  def get_application_versions(action_name, start_date, end_date, id_versions)
+    body_node = Ragoon::XML.create_node(action_name)
+
+    attributes = {}
+    attributes['start'] = to_datetime(start_date) unless start_date.nil?
+    attributes['end'] = to_datetime(end_date) unless end_date.nil?
+    parameter_node = Ragoon::XML.create_node('parameters', attributes)
+    body_node.add_child(parameter_node)
+
+    id_versions.each do |item|
+      parameter_node << Ragoon::XML.create_node(
+        'application_item',
+        id: item[:id], version: item[:version]
+      )
+    end
+
+    client.request(action_name, body_node)
+
+    client.result_set.xpath('//application_item').map do |item|
+      {
+        id: item['id'],
+        version: item['version'],
+        operation: item['operation']
+      }
+    end
+  ensure
+    client.reset
+  end
+
+  def get_applications_by_id(action_name, ids)
+    body_node = Ragoon::XML.create_node(action_name)
+
+    parameter_node = Ragoon::XML.create_node('parameters')
+    body_node.add_child(parameter_node)
+
+    ids.each do |id|
+      id_node = Ragoon::XML.create_node('application_id')
+      id_node.content = id
+      parameter_node.add_child(id_node)
+    end
+
+    client.request(action_name, body_node)
+
+    client.result_set.xpath('//application').map do |app|
+      parse_application(app)
+    end
+  ensure
+    client.reset
+  end
+
+  def parse_application(app)
+    {
+      id: app['id'],
+      number: app['number'],
+      name: app['name'],
+      processing_step: app['processing_step'],
+      status: app['status'],
+      urgent: app['urgent'],
+      version: app['version'],
+      date: parse_time(app['date']),
+      status_type: app['status_type'],
+
+      applicant: app.xpath('wf:applicant', wf: 'http://schemas.cybozu.co.jp/workflow/2008').map {|applicant|
+        {
+          id: applicant['id'],
+          name: applicant['name']
+        }
+      }.first,
+
+      items: app.xpath('wf:items/wf:item', wf: 'http://schemas.cybozu.co.jp/workflow/2008').map {|item|
+        {
+          name: item['name'],
+          value: item['value']
+        }
+      },
+
+      steps: app.xpath('wf:steps/wf:step', wf: 'http://schemas.cybozu.co.jp/workflow/2008').map {|step|
+        {
+          id: step['id'],
+          name: step['name'],
+          type: step['type'],
+          is_approval_step: step['is_approval_step'],
+          processors: step.xpath('wf:processor', wf: 'http://schemas.cybozu.co.jp/workflow/2008').map {|pro|
+            {
+              id: pro['id'],
+              name: pro['processor_name'],
+              comment: pro['comment']
+            }
+          }
+        }
+      }
+    }
+  end
+
+  def parse_time(time)
+    Time.parse(time).localtime
+  end
+
+  def to_datetime(str)
+    str.utc.strftime('%FT%TZ')
+  end
+
+end

data/lib/ragoon/version.rb

@@ -1,3 +1,3 @@
 module Ragoon
-  VERSION = '0.5.2'
+  VERSION = '0.6.0'
 end

data/lib/ragoon/xml.rb

@@ -2,8 +2,8 @@ module Ragoon::XML
   ACTION_PLACEHOLDER = '<!-- REQUEST_ACTION -->'.freeze
   BODY_PLACEHOLDER   = '<!-- REQUEST_BODY -->'.freeze
 
-  def self.render(action_name, body_node)
-    template.dup.
+  def self.render(action_name, body_node, options)
+    template(options).dup.
       gsub!(ACTION_PLACEHOLDER, action_name).
       gsub!(BODY_PLACEHOLDER,   body_node.to_xml)
   end
@@ -16,7 +16,7 @@ module Ragoon::XML
     node
   end
 
-  def self.template
+  def self.template(options)
     <<"XML"
 <?xml version="1.0" encoding="UTF-8"?>
 <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://www.w3.org/2003/05/soap-envelope"
@@ -33,8 +33,8 @@ module Ragoon::XML
               SOAP-ENV:mustUnderstand="1"
               xmlns="http://schemas.xmlsoap.org/ws/2002/12/secext">
       <UsernameToken wsu:Id="id">
-        <Username>#{Ragoon.garoon_username}</Username>
-        <Password>#{Ragoon.garoon_password}</Password>
+        <Username>#{options[:username]}</Username>
+        <Password>#{options[:password]}</Password>
       </UsernameToken>
     </Security>
     <Timestamp SOAP-ENV:mustUnderstand="1" Id="id"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ragoon
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - SHIOYA, Hiromu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2016-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -115,6 +115,7 @@ files:
 - lib/ragoon/services.rb
 - lib/ragoon/services/notification.rb
 - lib/ragoon/services/schedule.rb
+- lib/ragoon/services/workflow.rb
 - lib/ragoon/version.rb
 - lib/ragoon/xml.rb
 - ragoon.gemspec