nifi_sdk_ruby 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01032e0711255ad4a4a189e1298ff17694276da4
-  data.tar.gz: f579d3be582ce5a2d4d24b33b9930b0ad7cc0042
+  metadata.gz: 7d01124b4fdb133022e3b6a135054b882354a056
+  data.tar.gz: f3f2f366976dec99ee29adc7000ffa1c65457efc
 SHA512:
-  metadata.gz: c640f80758ad0f6fca9beb8b8387b1bd93edfed2fa517f5651548af9e5e34086b54351a873377ea1ff248f5675ba898adcc0a79cc9af9fc36d110c0d2694dc94
-  data.tar.gz: 5e157bddbda327b4bfd59402bfba7cdd8485e627a53a115f94d55bc0282c2269910efd93ee12b0508d2b295a935b20a47f093d49e0a2dcf3051e12c4319e03a8
+  metadata.gz: 03517b738ecadf80fcbfb881631ab62db5483850fb8fba857ec0a75dab17dc7ff9913b257d2ebadaf0985484ef4bd3ba33d5905b7e03678d7d4043a448ed2144
+  data.tar.gz: 1146908cdbfb9a7c7f44f6fc4fa2defabaffdb95c7b977b9d8cd9357b82bc9eefbde78c0c54ec2f3b628b7cf371cb1ae13107e7073e947633d2b6fd76866c6c3

data/README.md

@@ -59,7 +59,7 @@ puts nifi_client.process_group_by_name? test
 ### Get all attrs a the Process Group by ID (PG Root's child)
 
 ```ruby
-puts  nifi_client.get_process_group(:id => new_pg['id'])
+puts  nifi_client.get_process_group(new_pg['id'])
 ```
 
 ### Get all attrs a the Process Group by Name (Root's childs)
@@ -107,6 +107,17 @@ puts t
 puts nifi_client.delete_template t['id']
 ```
 
+### Create template instance
+By id 
+```ruby
+puts nifi_client.create_template_instance(:id => '43fwe1s-asd2-sdf3-sfq3ev')
+```
+Or by name
+```ruby
+puts nifi_client.create_template_instance(:name => 'TemplateName')
+```
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/icalvete/nifi_sdk_ruby. 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.

data/examples/basic.rb

@@ -24,13 +24,13 @@ puts "\n"
 # Get all attrs of the Process Group by ID (PG Root's child)
 puts 'PG ' + new_pg['id'] + ' attrs.'
 puts "\n"
-puts nifi_client.get_process_group(:id => new_pg['id'])
+puts nifi_client.get_process_group(new_pg['id'])
 puts "\n"
 
 # Get a Process Group ID
 puts "PG ID"
 puts "\n"
-pg = nifi_client.get_process_group(:id => new_pg['id'])
+pg = nifi_client.get_process_group(new_pg['id'])
 puts pg['id']
 puts "\n"
 

data/lib/nifi_sdk_ruby.rb

@@ -46,59 +46,57 @@ class Nifi
 
   def set_debug(debug = nil)
     if debug.nil?
-      abort 'missing debug'
+      raise ArgumentError.new('missing debug')
     end
 
     if !(!!debug == debug)
-      abort 'debug must be a boolean'
+      raise TypeError.new('debug must be a boolean')
     end
 
     @@debug = debug
   end
 
-  def get_debug()
+  def get_debug
     @@debug
   end
 
   def set_async(async = nil)
     if async.nil?
-      abort 'missing async'
+      raise ArgumentError.new('missing async')
     end
 
     if !(!!async == async)
-      abort 'async must be a boolean'
+      raise TypeError.new('async must be a boolean')
     end
 
     @@async = async
   end
 
-  def get_async()
+  def get_async
     @@async
   end
 
-  def get_api_key()
+  def get_api_key
     @@api_key
   end
 
-  def get_schema()
+  def get_schema
     @@schema
   end
 
-  def get_host()
-   	@@host
+  def get_host
+    @@host
   end
 
-  def get_base_url()
-   	@@base_url
+  def get_base_url
+    @@base_url
   end
 
-  def get_process_group(*args)
+  def get_process_group(id = nil)
 
-    args = args.reduce Hash.new, :merge
-
-    process_group = args[:id] ? args[:id] : 'root'
+    process_group = id ? id : 'root'
 
-    base_url = @@base_url + "/process-groups/#{process_group}"
+    base_url = @@base_url + '/process-groups/' << process_group
     self.class.http_client(base_url)
   end
 
@@ -106,34 +104,35 @@ class Nifi
     args = args.reduce Hash.new, :merge
 
     if args[:name].nil?
-      abort 'name params is mandatory.'
+      raise ArgumentError.new('name params is mandatory.')
     end
-
-    if self.process_group_by_name? args[:name]
-      abort 'The process group ' + args[:name] + ' already exists'
+    name = args[:name].to_s
+    if self.process_group_by_name? name
+      raise ArgumentError.new('The process group ' << name << ' already exists')
     end
 
-    params = '{"revision":{"clientId":"' + @@client_id + '","version":0},"component":{"name":"' + args[:name] + '","position":{"x":274.54776144527517,"y":-28.886681059739686}}}'
+    params = '{"revision":{"clientId":"' << @@client_id + '","version":0},"component":{"name":"' << name <<
+        '","position":{"x":274.54776144527517,"y":-28.886681059739686}}}'
 
     process_group = args[:id] ? args[:id] : 'root'
-    base_url = @@base_url + "/process-groups/#{process_group}/process-groups"
+    base_url = @@base_url + '/process-groups/' << process_group << '/process-groups'
     self.class.http_client(base_url, 'POSTRAW', params)
   end
 
   def delete_process_group(id = nil)
 
     if id.nil?
-      abort 'id is mandatory.'
+      raise ArgumentError.new('id is mandatory.')
     end
 
-    base_url = @@base_url + '/process-groups/' + id + '?clientId=' + @@client_id + '&version=1'
+    base_url = @@base_url + '/process-groups/' << id << '?clientId=' << @@client_id + '&version=1'
     self.class.http_client(base_url, 'DELETE')
   end
 
   def get_process_group_by_name(name = nil)
 
     if name.nil?
-      abort 'name is mandatory.'
+      raise ArgumentError.new('name is mandatory.')
     end
 
     res = self.class.exists
@@ -145,53 +144,103 @@ class Nifi
     if pg.count == 1
       self.class.get pg[0]['identifier']
     else
-      abort 'Unable to locate group with name ' + name
+      raise ArgumentError.new('Unable to locate group with name ' << name)
     end
   end
 
   def get_process(id = nil)
     if id.nil?
-      abort 'id is mandatory.'
+      raise ArgumentError.new('id is mandatory.')
     end
 
-    url = @@base_url + '/processors/' + id
+    url = @@base_url + '/processors/' << id
     self.class.http_client(url)
   end
 
   def start_process(*args)
     args = args.reduce Hash.new, :merge
     if args[:id].nil? or args[:version].nil?
-      abort 'id and version params are mandatory'
+      raise ArgumentError.new('id and version params are mandatory')
     end
 
-    id = args[:id]
-    version = args[:version]
-
-    params = '{"revision":{"version":'+ version +'},"id":"'+ id +'","component":{"id":"'+ id +
-        '","state":"RUNNING"},"status":{"runStatus":"Running"}}'
-    base_url = @@base_url + '/processors/' + id
-    self.class.http_client(base_url, 'PUT', params)
+    id = args[:id].to_s
+    version = args[:version].to_s
+
+    params = {
+        revision:{
+            version: version
+        },
+        id: id,
+        component:{
+            id: id,
+            state: 'RUNNING'
+        },
+        status:{
+            runStatus: 'Running'
+        }
+    }
+    update_process(id: id, update_json: params)
   end
 
   def stop_process(*args)
     args = args.reduce Hash.new, :merge
     if args[:id].nil? or args[:version].nil?
-      abort 'id and version params are mandatory'
+      raise ArgumentError.new('id and version params are mandatory')
     end
 
-    id = args[:id]
-    version = args[:version]
+    id = args[:id].to_s
+    version = args[:version].to_s
+
+    params = {
+        revision:{
+            version: version
+        },
+        id: id,
+        component:{
+            id: id,
+            state: 'STOPPED'
+        },
+        status:{
+            runStatus: 'Stopped'
+        }
+    }
+    update_process(id: id, update_json: params)
+  end
 
-    params = '{"revision":{"version":'+ version +'},"id":"'+ id +'","component":{"id":"'+ id +
-        '","state":"STOPPED"},"status":{"runStatus": "Stopped"}}'
-    base_url = @@base_url + '/processors/' + id
+  ##
+  # NiFi has a classic Optimistic Locking pattern implementation which means that your call will only be
+  # accepted and processed as valid if you specify the right version of the component in the revision -> version field
+  #
+  # ArgumentError is raised if you haven't specified required arguments or they are invalid
+  #
+  # Updates the process by id using given JSON string or Hash
+  # Params:
+  # :id => the id of the process
+  # :update_json => json with updated values, could be either a JSON string or Ruby Hash
+  def update_process(*args)
+    args = args.reduce Hash.new, :merge
+    if args[:id].nil? or args[:update_json].nil?
+      raise ArgumentError.new('id and update_json params are mandatory')
+    end
+
+    id = args[:id].to_s
+    case args[:update_json]
+      when Hash
+        params = args[:update_json].to_json
+      when String
+        params = args[:update_json]
+      else
+        raise ArgumentError.new('update_json param must be either a Hash or a String')
+    end
+
+    base_url = @@base_url + '/processors/' << id
     self.class.http_client(base_url, 'PUT', params)
   end
 
   def process_group_by_name?(name = nil)
 
     if name.nil?
-      abort 'name is mandatory.'
+      raise ArgumentError.new('name is mandatory.')
     end
 
     res = self.class.exists
@@ -207,22 +256,22 @@ class Nifi
     args = args.reduce Hash.new, :merge
 
     if args[:id].nil? and args[:name].nil?
-      abort 'either specify id of the template or it\'s name '
+      raise ArgumentError.new('either specify id of the template or it\'s name ')
     end
 
     if args[:name]
-      abort "Could not find template called #{args[:name]}" unless template_by_name?(args[:name])
+      raise StandardError.new('Could not find template called ' << args[:name]) unless template_by_name?(args[:name])
       id = get_template_by_name(args[:name])[0][0]
     else
-      abort "Could not find template with id #{args[:id]}" unless template_by_id?(args[:id])
+      raise StandardError.new('Could not find template with id ' << args[:id]) unless template_by_id?(args[:id])
       id = args[:id]
     end
 
-    originX = args[:originX] ? args[:originX] : '0.0'
-    originY = args[:originY] ? args[:originY] : '0.0'
+    originX = args[:originX] ? args[:originX].to_s : '0.0'
+    originY = args[:originY] ? args[:originY].to_s : '0.0'
     process_group = args[:process_group_id] ? args[:process_group_id] : 'root'
-    params = '{"templateId": "'+ id +'", "originX": '+ originX +', "originY": '+ originY +'}'
-    base_url = @@base_url + "/process-groups/#{process_group}/template-instance"
+    params = '{"templateId": "' << id << '", "originX": ' << originX << ', "originY": ' << originY << '}'
+    base_url = @@base_url + '/process-groups/' << process_group << '/template-instance'
     self.class.http_client(base_url, 'POSTRAW', params)
   end
 
@@ -231,27 +280,27 @@ class Nifi
     args = args.reduce Hash.new, :merge
 
     if args[:path].nil?
-      abort 'path params is mandatory.'
+      raise ArgumentError.new('path params is mandatory.')
     end
     path = args[:path]
 
     if path =~ URI::regexp
 
       download_s = open(path)
-      download_t = "/tmp/#{download_s.base_uri.to_s.split('/')[-1]}"
+      download_t = '/tmp/' << download_s.base_uri.to_s.split('/')[-1]
       IO.copy_stream(download_s, download_t)
       path = download_t
     end
 
     if not File.file? path or not File.readable? path
-      abort "Access to #{path} failed"
+      raise IOError.new('Access to ' <<path << ' failed')
     end
 
     t = File.open(path) { |f| Nokogiri::XML(f) }
     name = t.xpath('//template/name').text
 
     if self.template_by_name? name
-      abort 'The template ' + name + ' already exists'
+      raise StandardError.new('The template ' << name << ' already exists')
     end
 
     params = Array.new
@@ -259,7 +308,7 @@ class Nifi
 
     process_group = args[:id] ? args[:id] : 'root'
 
-    base_url = @@base_url + "/process-groups/#{process_group}/templates/upload"
+    base_url = @@base_url + '/process-groups/' << process_group << '/templates/upload'
     res = self.class.http_client(base_url, 'POST', params)
 
     return res['templateEntity']['template']
@@ -268,17 +317,17 @@ class Nifi
   def delete_template(id = nil)
 
     if id.nil?
-      abort 'id is mandatory.'
+      raise ArgumentError.new('id is mandatory.')
     end
 
-    base_url = @@base_url + '/templates/' + id
+    base_url = @@base_url + '/templates/' << id
     self.class.http_client(base_url, 'DELETE')
   end
 
   def get_template_by_name(name = nil)
 
     if name.nil?
-      abort 'name is mandatory.'
+      raise ArgumentError.new('name is mandatory.')
     end
 
     res = self.class.exists
@@ -291,7 +340,7 @@ class Nifi
     if t.count == 1
       t[0]['identifier'].scan(/\/templates\/(.*)/)
     else
-      abort 'Unable to locate template with name ' + name
+      raise StandardError.new('Unable to locate template with name ' << name)
     end
 
   end
@@ -299,7 +348,7 @@ class Nifi
   def template_by_name?(name = nil)
 
     if name.nil?
-      abort 'name is mandatory.'
+      raise ArgumentError.new('name is mandatory.')
     end
 
     res = self.class.exists
@@ -314,13 +363,13 @@ class Nifi
   def template_by_id?(id = nil)
 
     if id.nil?
-      abort 'id is mandatory.'
+      raise ArgumentError.new('id is mandatory.')
     end
 
     res = self.class.exists
 
     pg = res.select do |r|
-      r['identifier'] == "/templates/#{id}"
+      r['identifier'] == '/templates/' << id
     end
 
     pg.count == 1 ? true : false
@@ -329,9 +378,8 @@ class Nifi
   private
 
   def self.exists
-    base_url = @@base_url + "/resources"
+    base_url = @@base_url + '/resources'
     res = self.http_client(base_url)
-
     return res['resources']
   end
 
@@ -346,7 +394,7 @@ class Nifi
     #c.username                     = @@api_key
     #c.password                     = ''
     c.url                         = url
-    c.useragent                   = @@sdk_name + '_' + @@sdk_version
+    c.useragent                   = @@sdk_name + '_' << @@sdk_version
     c.headers['NIFI-SDK-Name']    = @@sdk_name
     c.headers['NIFI-SDK-Version'] = @@sdk_version
     c.ssl_verify_peer             = false
@@ -367,7 +415,7 @@ class Nifi
       when 'DELETE'
         c.delete
       else
-        abort 'HTTP method not supported.'
+        raise ArgumentError.new('HTTP method ' << method << ' not supported.')
     end
 
     if c.response_code.to_s.match(/20./) and not c.body_str.empty?
@@ -379,8 +427,8 @@ class Nifi
         end
       end
     else
+      puts c.response_code.to_s
       puts c.body_str
     end
   end
-end
-
+end

data/lib/nifi_sdk_ruby/version.rb

@@ -1,3 +1,3 @@
 module NifiSdkRuby
-  VERSION = "0.0.4"
+  VERSION = '0.0.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nifi_sdk_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Israel Calvete
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-04 00:00:00.000000000 Z
+date: 2017-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -142,6 +142,7 @@ files:
 - lib/nifi_sdk_ruby.rb
 - lib/nifi_sdk_ruby/version.rb
 - nifi_sdk_ruby.gemspec
+- pkg/.gitkeep
 - release.md
 homepage: http://rubygems.org/gems/nifi-sdk-ruby
 licenses:
@@ -163,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A RUBY SDK to use APACHE NIFI API