angus-sdoc 0.0.6 → 0.0.7

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NTdmOTY0OWUwZGM0ZTU5ZGI2YTlkZWQ1NzhiMGQyNDc1YTc3ZWYzYw==
-  data.tar.gz: !binary |-
-    MjMwNmJkMTI4YTQ1NGQ0M2YxOTBjZjI3OGY4N2U0NjU5ZWJlYjY2Yw==
+SHA1:
+  metadata.gz: f1e789e1dbc54103d3e5a3c77dba6921a183c2e2
+  data.tar.gz: a7c9c1940257b319fdb7718d5bb0f600e7a38f88
 SHA512:
-  metadata.gz: !binary |-
-    NWI0NjE3NGZlNWZjN2Q0MzYyOTg1M2RhZjNlOWJlNmU4YTVlYWNlYmQ3NTc0
-    NGRjODY4YTY5NDU2OWQ5NmUwNTgzMzgxMWFkOGIzNzEwNWFiYWIxMzkwYTU1
-    MmI5ODg0NmY3OWFjNTU3MzM4ZDExYmRlMmZlNDA0Mzc2MGU3ZjY=
-  data.tar.gz: !binary |-
-    ZTE0NjM3NmQyMTJkOTk0MTJiYTk1MjYwYTQxNWVjNjAzZjMyMDY3OWRkMmQw
-    YzE3NDdlY2VlZDVjOWJjODg3YjAyOTM3YjVmYTQxMTQ2YmUwODU2ODZkZjQ1
-    ZDU4NzFjY2E5OTgyMjI3NDk1ZmJmMzk5NjYzNTQ1MzJiNjA4ODY=
+  metadata.gz: 489847ef042e704b7e2ede824a5780b6527497d0f99c3bca6e152e4fba9d09a458b9b4148e26d708a473b56d83dd70e5ee594704c76fab88356e64a6d2a716a6
+  data.tar.gz: b86b74e9d35be027ac08367b98288f88f2549ff4a6f39bc9122e4438e324d8b51cca318fbb4e9d21e10d7292e2404f32bde13fed2e174a172847aa0f1a56d594

data/lib/angus/definitions/base.rb

@@ -14,5 +14,6 @@ require_relative 'response_element'
 require_relative 'uri_element'
 require_relative 'operation'
 require_relative 'message'
+require_relative 'message_field'
 require_relative 'glossary'
 require_relative 'glossary_term'

data/lib/angus/definitions/message.rb

@@ -26,6 +26,11 @@ module Angus
       # @!attribute [rw] text
       #   @return [String] when set this text overrides all others and is set as the message description.
       attr_accessor :text
+
+      # @!attribute [rw] fields
+      #   @return [Array<Field>] the fields for the message.
+      attr_accessor :fields
+
     end
   end
 end

data/lib/angus/definitions/message_field.rb

@@ -0,0 +1,27 @@
+module Angus
+  module SDoc
+    class Definitions::MessageField
+
+      # @!attribute [rw] name
+      #   @return [String] the name of the message field.
+      attr_accessor :name
+
+      # @!attribute [rw] description
+      #   @return [String] the description of the message field.
+      attr_accessor :description
+
+      # @!attribute [rw] required
+      #   @return [Boolean] indicates if the message field. is required or not.
+      attr_accessor :required
+
+      # @!attribute [rw] type
+      #   @return [String] the type of the message field.
+      attr_accessor :type
+
+      # @!attribute [rw] elements_type
+      #   @return [String] the elements type of the message field.
+      attr_accessor :elements_type
+
+    end
+  end
+end

data/lib/angus/definitions_reader.rb

@@ -108,7 +108,7 @@ module Angus
 
           messages_hash.each do |key, attrs|
             messages[key] = build_message(key, attrs['level'], attrs['status_code'],
-                                          attrs['description'], attrs['text'])
+                                          attrs['description'], attrs['text'], attrs['fields'])
           end
 
           messages
@@ -127,7 +127,7 @@ module Angus
         #   was not specified.
         #
         # @return [Message] the message.
-        def build_message(key, level, status_code, description, text)
+        def build_message(key, level, status_code, description, text, fields)
           unless level
             raise Angus::SDoc::InvalidServiceMessage.new(key ,'Can not create message without level.')
           end
@@ -142,11 +142,40 @@ module Angus
           message.status_code = status_code
           message.description = description
           message.text = text
+          message.fields = (fields || []).map { |field| build_message_field(field['name'],
+                                                                            field['description'],
+                                                                            field['type'],
+                                                                            field['elements_type'],
+                                                                            field['required']) }
 
           message
         end
         private :build_message
 
+        # Builds Definitions::Field with the message data.
+        #
+        # @param [String] key The message key.
+        # @param [String] level The message level.
+        # @param [String] status_code The message status code.
+        # @param [String] description The message description.
+        # @param [String] text The message text.
+        #
+        # @raise [Angus::SDoc::InvalidServiceMessage] if the level or the status code
+        #   was not specified.
+        #
+        # @return [Message] the message.
+        def build_message_field(name, description, type, elements_type, required)
+          field = Angus::SDoc::Definitions::MessageField.new
+          field.name = name
+          field.description = description
+          field.type = type
+          field.elements_type = elements_type
+          field.required = required
+
+          field
+        end
+        private :build_message_field
+
         # Builds Definitions::ProxyOperation objects for each proxy operation metadata.
         #
         # @param [Hash] proxy_operations_hash The proxy operations metadata.

data/lib/angus/sdoc/version.rb

@@ -1,5 +1,5 @@
 module Angus
   module SDoc
-    VERSION = '0.0.6'
+    VERSION = '0.0.7'
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: angus-sdoc
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Pablo Ifran
@@ -10,20 +10,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-02 00:00:00.000000000 Z
+date: 2014-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -44,42 +44,42 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.12'
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json_expressions
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -128,19 +128,20 @@ dependencies:
   name: ci_reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "    Used to read the documentation of a service built in angus (but
-  also is able to read any kind\n    of documentation that follow the angus structure),
-  and generate an object representation of\n    that documentation.\n"
+description: |2
+      Used to read the documentation of a service built in angus (but also is able to read any kind
+      of documentation that follow the angus structure), and generate an object representation of
+      that documentation.
 email:
 - angus@moove-it.com
 executables: []
@@ -153,6 +154,7 @@ files:
 - lib/angus/definitions/glossary.rb
 - lib/angus/definitions/glossary_term.rb
 - lib/angus/definitions/message.rb
+- lib/angus/definitions/message_field.rb
 - lib/angus/definitions/operation.rb
 - lib/angus/definitions/proxy_operation.rb
 - lib/angus/definitions/representation.rb
@@ -182,12 +184,12 @@ 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: []
@@ -197,4 +199,3 @@ signing_key:
 specification_version: 4
 summary: Expose service API documentation.
 test_files: []
-has_rdoc: