mio-config 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffa8ff46bb173daec87410efdf09804467ce84af
-  data.tar.gz: 075426f4fa4607bd59a53b27c6c6b043659a0b05
+  metadata.gz: 28407f60a388f31bddba0f9a24b88db63c528e89
+  data.tar.gz: 6af9294987eb672ea0a8a7cdb179e5cf11b6fc7e
 SHA512:
-  metadata.gz: c5fe677351fe8a6de052dee690799b4a3a5f89ac6c92da1c46f08f1bd5a91b6139068019c6631f2ce4838a2f2e541a4d08adcce263a4ef9d7e695b740fffe1c0
-  data.tar.gz: 11d7b7ed2af6bc29bfb3851bd973f758be80b4b391a4efe39c16afbfab5049dab03e2af173c419f101c0e95078682c69947b35e53752b297a28d4b122db8ae50
+  metadata.gz: a74e724e2d92f5c35f80089b3da5ad52ac7340f916983e770338e53caf3f805fe55611b419afe9851d1bb64e8e2fcb96956134ec7e6d64641b0d9911626ff24a
+  data.tar.gz: 681151eaad94803edb5d756a3f1bae3943eb2ca1d2e9eee198927cad94d435ebf3e488469bcf4be9de0b8c207ddaa06a7f761e25090442f08610e2c0b779e895

data/README.md

@@ -1,6 +1,8 @@
 # Mio Config
 
-![build status](https://circleci.com/gh/Financial-Times/mio-config.png)
+[![Build Status](https://circleci.com/gh/Financial-Times/mio-config.png)](https://circleci.com/gh/Financial-Times/mio-config)
+
+[![Gem Version](https://badge.fury.io/rb/mio-config.svg)](https://badge.fury.io/rb/mio-config)
 
 This simple rubygem will allow for a codified build out of mio resources and configuration.
 

data/lib/mio/client.rb

@@ -50,7 +50,6 @@ class Mio
       make_object response.body
     end
 
-
     def configure resource, id, payload, opts={}
       url = path(resource, id, :configuration)
       response = put url, payload, opts
@@ -61,6 +60,16 @@ class Mio
       make_object response.body
     end
 
+    def definition resource, payload, opts={}
+      url = path(resource)
+      response = put url, payload, opts, 'application/vnd.nativ.mio.v1+xml'
+      unless response.success?
+        raise Mio::Client::LoadOfBollocks, "PUT on #{url}, with #{payload.inspect} returned #{response.status}"
+      end
+
+      make_object response.body
+    end
+
     def action resource, id, payload, opts={}
       url = path(resource, id, :actions)
       statuses = get url, opts
@@ -87,8 +96,8 @@ class Mio
       Mio::Requests.make_request :post, @agent, url, opts, payload
     end
 
-    def put url, payload, opts
-      Mio::Requests.make_request :put, @agent, url, opts, payload
+    def put url, payload, opts, content_type='application/vnd.nativ.mio.v1+json'
+      Mio::Requests.make_request :put, @agent, url, opts, payload, content_type
     end
 
     def make_object response

data/lib/mio/model/metadata_definition.rb

@@ -0,0 +1,97 @@
+require 'builder'
+
+class Mio
+  class Model
+    class MetadataDefinition < Model
+      set_resource :metadataDefinitions
+
+      field :name, String, 'Name of the metadata definition'
+      field :displayName, String, 'Display name'
+      field :visibility, Array,'IDs of accounts that may see this', [4]
+      field :searchable, Symbol, 'Searchable metadata'
+      field :required, Symbol, 'Required Metadata'
+      field :editable, Symbol, 'Editable within the workflow tool'
+      field :definitions, Array, 'List of definitions'
+
+      field :enable, Symbol, ':true or :false', :true
+      field :start, Symbol, ':true or :false', :true
+
+      def create_hash
+        {name: @args.name,
+        visibilityIds: @args.visibility}
+      end
+
+      def trim_xml_from_element xml, endTag='</metadata>'
+        endTagIdx = xml.index endTag
+        if (endTagIdx)
+          xmlEnd = endTagIdx + endTag.length
+          if (xmlEnd < xml.length)
+            xml = xml[0...-(xml.length-xmlEnd)]
+          end
+        end
+        xml
+      end
+
+      def definition_xml
+        builder = Builder::XmlMarkup.new
+        builder.metadata name: @args.name do |metadata|
+          metadata.searchable @args.searchable.to_s;
+          metadata.editable @args.editable.to_s;
+          metadata.required @args.required.to_s;
+          metadata.children do |children|
+             @args.definitions.each do |definition|
+               case definition.fetch :formType
+                 when "textarea"
+                   children.text(name: definition.fetch(:name), display_name: @args.displayName)  do |text|
+                     text.searchable definition.fetch(:searchable).to_s;
+                     text.editable definition.fetch(:editable).to_s;
+                     text.required definition.fetch(:required);
+                     text.validation(handler: definition.fetch(:validationHandler));
+                     text.tag! "form-type" do |x|
+                       x.text! definition.fetch(:formType);
+                     end
+                   end
+                 when "select"
+                   children.tag!("single-option", name: definition.fetch(:name)) do |singleOption|
+                     singleOption.searchable definition.fetch(:searchable).to_s;
+                     singleOption.editable definition.fetch(:editable).to_s;
+                     singleOption.required definition.fetch(:required);
+                     singleOption.children do |children|
+                       definition.fetch(:options).each do |option|
+                         children.tag!("option-child", name: option.fetch(:name),
+                                                       default: option.fetch(:default),
+                                                       value: option.fetch(:value),
+                                                       display_name: option.fetch(:displayName));
+                       end
+                     end
+                   end
+               end
+             end
+          end
+        end
+        trim_xml_from_element builder.target!
+      end
+
+      def go
+        if @args.definitions.empty?
+          raise Mio::Model::EmptyField, 'Field definitions to Mio::Model::MetadataDefinition must contain at least one definition'
+        end
+
+        unless look_up
+          @object = create
+        else
+          @object = look_up
+          set_start :stop
+        end
+        definition_path = "#{self.class.resource_name}/#{@object['id']}/definition"
+
+        @client.definition definition_path, definition_xml
+
+        set_enable
+        return @object
+      end
+
+    end
+  end
+end
+

data/lib/mio/model/metadatadefinition/definition.rb

@@ -0,0 +1,22 @@
+class Mio
+  class Model
+    class MetadataDefinition
+      class Definition < Model
+        set_resource :metadatadefinition
+
+        field :name, String, 'Metadata Definition Name'
+        field :description, String, 'Metadata Definition Description'
+        field :type, String, 'Metadata type'
+        field :searchable, Symbol, 'Indexed and searchable', :true
+        field :editable, Symbol, 'Editable field', :true
+        field :required, Symbol, 'Required mandatory metadata item', :true
+        field :formType, String, 'Form control type'
+        field :validationHandler, String, 'Validation handler', nil
+        field :options, Array, 'Array of options', nil
+
+        nested true
+
+      end
+    end
+  end
+end

data/lib/mio/model/metadatadefinition/option.rb

@@ -0,0 +1,17 @@
+class Mio
+  class Model
+    class MetadataDefinition
+      class Option < Model
+        set_resource :metadatadefinition
+
+        field :name, String, 'Metadata Definition Name'
+        field :displayName, String, 'Metadata Definition Description'
+        field :default, Symbol, 'Metadata type'
+        field :value, String, 'Indexed and searchable',
+
+        nested true
+
+      end
+    end
+  end
+end

data/lib/mio/requests.rb

@@ -1,14 +1,20 @@
 class Mio
   module Requests
-    @@content_type = 'application/vnd.nativ.mio.v1+json'
 
-    def self.make_request type, agent, url, opts, body=nil
+    def self.make_request type, agent, url, opts, body=nil, content_type='application/vnd.nativ.mio.v1+json'
+      if content_type.nil?
+        content_type = 'application/vnd.nativ.mio.v1+json'
+      end
       agent.method(type).call do |r|
         r.url url
         unless body.nil?
-          r.body = body.to_json
+          if content_type.include? 'json'
+            r.body = body.to_json
+          else
+            r.body = body
+          end
         end
-        r.headers[:content_type] = @@content_type
+        r.headers[:content_type] = content_type
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mio-config
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - jspc
@@ -11,6 +11,20 @@ bindir: bin
 cert_chain: []
 date: 2016-04-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +96,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Configure MIO
-email: james.condron@ft.com
+email: james.condron@ft.com, jem.rayfield@ft.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -99,6 +113,9 @@ files:
 - "./lib/mio/model/groovy_script_wait.rb"
 - "./lib/mio/model/hotfolder.rb"
 - "./lib/mio/model/import_action.rb"
+- "./lib/mio/model/metadata_definition.rb"
+- "./lib/mio/model/metadatadefinition/definition.rb"
+- "./lib/mio/model/metadatadefinition/option.rb"
 - "./lib/mio/model/s3.rb"
 - "./lib/mio/model/workflow.rb"
 - "./lib/mio/model/workflow/node.rb"