jiralicious 0.4.3 → 0.5.0

data/lib/jiralicious/custom_field_option.rb

@@ -1,45 +1,45 @@
-# encoding: utf-8
-module Jiralicious
-  ##
-  # The CustomFieldOption provides a list of available custom
-  # field options. This method is used in lazy loading and can
-  # be used to validate options prior to updating the issue.
-  #
-  class CustomFieldOption < Jiralicious::Base
-
-    ##
-    # Initialization Method
-    #
-    # [Arguments]
-    # :decoded_json    (optional)    rubyized json object
-    #
-    def initialize(decoded_json)
-      @loaded = false
-      if decoded_json.is_a? Hash
-        properties_from_hash(decoded_json)
-        super(decoded_json)
-        parse!(decoded_json)
-        @loaded = true
-      end
-    end
-
-    class << self
-      ##
-      # Overrides the auto-generated endpoint_name from Base.
-      # This is necessary due to lower camel case naming convention.
-      #
-      def endpoint_name
-        "customFieldOption"
-      end
-
-      ##
-      # Retrieves the options based on the ID
-      #
-      def find(id, options = {})
-        response = fetch({:key => id})
-        response.parsed_response['id'] = id
-        new(response.parsed_response)
-      end
-    end
-  end
-end
+# encoding: utf-8
+module Jiralicious
+  ##
+  # The CustomFieldOption provides a list of available custom
+  # field options. This method is used in lazy loading and can
+  # be used to validate options prior to updating the issue.
+  #
+  class CustomFieldOption < Jiralicious::Base
+
+    ##
+    # Initialization Method
+    #
+    # [Arguments]
+    # :decoded_json    (optional)    rubyized json object
+    #
+    def initialize(decoded_json)
+      @loaded = false
+      if decoded_json.is_a? Hash
+        properties_from_hash(decoded_json)
+        super(decoded_json)
+        parse!(decoded_json)
+        @loaded = true
+      end
+    end
+
+    class << self
+      ##
+      # Overrides the auto-generated endpoint_name from Base.
+      # This is necessary due to lower camel case naming convention.
+      #
+      def endpoint_name
+        "customFieldOption"
+      end
+
+      ##
+      # Retrieves the options based on the ID
+      #
+      def find(id, options = {})
+        response = fetch({:key => id})
+        response.parsed_response['id'] = id
+        new(response.parsed_response)
+      end
+    end
+  end
+end

data/lib/jiralicious/errors.rb

@@ -1,27 +1,27 @@
-# encoding: utf-8
-
-module Jiralicious
-  # General Jira error
-  class JiraError < StandardError; end
-  # AuthenticateError
-  class AuthenticationError < StandardError; end
-  # NotLoggedIn error
-  class NotLoggedIn < AuthenticationError; end
-  # InvalidLogin error
-  class InvalidLogin < AuthenticationError; end
-
-  # These are in the JIRA API docs. Not sure about specifics, as the docs don't
-  # mention them. Added here for completeness and future implementation.
-  # http://confluence.atlassian.com/display/JIRA/JIRA+REST+API+%28Alpha%29+Tutorial
-
-  # Cookie has Expired (depricated)
-  class CookieExpired < AuthenticationError; end
-  # Captcha is Required (not used)
-  class CaptchaRequired < AuthenticationError; end
-  # IssueNotFound error (any invalid object)
-  class IssueNotFound < StandardError; end
-  # JQL Error (error in JQL search(
-  class JqlError < StandardError; end
-  # Transition Error
-  class TransitionError < StandardError; end
-end
+# encoding: utf-8
+
+module Jiralicious
+  # General Jira error
+  class JiraError < StandardError; end
+  # AuthenticateError
+  class AuthenticationError < StandardError; end
+  # NotLoggedIn error
+  class NotLoggedIn < AuthenticationError; end
+  # InvalidLogin error
+  class InvalidLogin < AuthenticationError; end
+
+  # These are in the JIRA API docs. Not sure about specifics, as the docs don't
+  # mention them. Added here for completeness and future implementation.
+  # http://confluence.atlassian.com/display/JIRA/JIRA+REST+API+%28Alpha%29+Tutorial
+
+  # Cookie has Expired (depricated)
+  class CookieExpired < AuthenticationError; end
+  # Captcha is Required (not used)
+  class CaptchaRequired < AuthenticationError; end
+  # IssueNotFound error (any invalid object)
+  class IssueNotFound < StandardError; end
+  # JQL Error (error in JQL search(
+  class JqlError < StandardError; end
+  # Transition Error
+  class TransitionError < StandardError; end
+end

data/lib/jiralicious/field.rb

@@ -1,58 +1,58 @@
-# encoding: utf-8
-module Jiralicious
-  ##
-  # The Field class is used in multiple classes as a support
-  # object. This class is designed as a Object Oriented Method
-  # of viewing the Jira JSON/Hash.
-  #
-  class Field < Jiralicious::Base
-    ##
-    # Initialization Method
-    # 
-    # Builds the dynamic Field object from either a Hash or Array.
-    # The decoded JSON object can be nested as deep as necessary
-    # but it is recommended that JSON objects are no deeper then
-    # 5 levels maximum.
-    #
-    # [Arguments]
-    # :decoded_json    (optional)    rubyized json object
-    #
-    def initialize(decoded_json)
-      @loaded = false
-      if decoded_json.is_a? Hash
-        decoded_json = properties_from_hash(decoded_json)
-        super(decoded_json)
-        parse!(decoded_json)
-        self.each do |k, v|
-          if v.is_a? Hash
-            self[k] = self.class.new(v)
-          elsif v.is_a? Array
-            v.each_index do |i|
-              if v[i].is_a? Hash
-                v[i] = self.class.new(v[i])
-              end
-            end
-            self[k] = v
-          end
-        end
-        @loaded = true
-      else
-        i = 0;
-        decoded_json.each do |list|
-          if !list['id'].nil?
-            if numeric? list['id']
-              id =  :"id_#{list['id']}"
-            else
-              id = :"#{list['id']}"
-            end
-      else
-            id = :"_#{i}"
-            i += 1
-      end
-          self.class.property id
-         self[id] = self.class.new(list)
-        end
-      end
-    end
-  end
-end
+# encoding: utf-8
+module Jiralicious
+  ##
+  # The Field class is used in multiple classes as a support
+  # object. This class is designed as a Object Oriented Method
+  # of viewing the Jira JSON/Hash.
+  #
+  class Field < Jiralicious::Base
+    ##
+    # Initialization Method
+    # 
+    # Builds the dynamic Field object from either a Hash or Array.
+    # The decoded JSON object can be nested as deep as necessary
+    # but it is recommended that JSON objects are no deeper then
+    # 5 levels maximum.
+    #
+    # [Arguments]
+    # :decoded_json    (optional)    rubyized json object
+    #
+    def initialize(decoded_json)
+      @loaded = false
+      if decoded_json.is_a? Hash
+        decoded_json = properties_from_hash(decoded_json)
+        super(decoded_json)
+        parse!(decoded_json)
+        self.each do |k, v|
+          if v.is_a? Hash
+            self[k] = self.class.new(v)
+          elsif v.is_a? Array
+            v.each_index do |i|
+              if v[i].is_a? Hash
+                v[i] = self.class.new(v[i])
+              end
+            end
+            self[k] = v
+          end
+        end
+        @loaded = true
+      else
+        i = 0;
+        decoded_json.each do |list|
+          if !list['id'].nil?
+            if numeric? list['id']
+              id =  :"id_#{list['id']}"
+            else
+              id = :"#{list['id']}"
+            end
+      else
+            id = :"_#{i}"
+            i += 1
+      end
+          self.class.property id
+         self[id] = self.class.new(list)
+        end
+      end
+    end
+  end
+end

data/lib/jiralicious/issue/fields.rb

@@ -1,197 +1,197 @@
-# encoding: utf-8
-module Jiralicious
-  class Issue
-    ##
-    # The Fields class provides functionality to the Issue
-    # class that allows it to easily update or create issues.
-    # The class retains the original  and the proposed
-    # information which could be used for cross validation
-    # prior to posting an update.
-    #
-    class Fields
-      # The fields that will be updated or created
-      attr_accessor :fields_update
-      # The current fields when a ticket was loaded
-      attr_accessor :fields_current
-
-      ##
-      # Initialization Method
-      #
-      # [Arguments]
-      # :fc    (optional) fields to load
-      #
-      def initialize(fc = nil)
-        @fields_current = (fc == nil) ? Hash.new : fc
-        @fields_update = Hash.new
-      end
-
-      ##
-      # Returns the count of fields being updated.
-      #
-      def count
-        return @fields_update.count
-      end
-
-      ##
-      # Returns the length of fields being updated.
-      #
-      def length
-        return @fields_update.length
-      end
-
-      ##
-      # Adds a comment to the field list
-      #
-      # [Arguments]
-      # :comment   (required)    comment text
-      #
-      def add_comment(comment)
-        if !(@fields_update['comment'].is_a? Array)
-          @fields_update['comment'] = Array.new
-        end
-        @fields_update['comment'].push({"add" => {"body" => comment}})
-      end
-
-      ##
-      # Appends the current String with the provided value
-      #
-      # [Arguments]
-      # :field   (required)    field to update
-      #
-      # :value   (required)    value text
-      #
-      def append_s(field, value)
-        if (@fields_update[field] == nil)
-          @fields_update[field] = @fields_current[field] unless @fields_current.nil?
-          @fields_update[field] ||= ""
-        end
-        @fields_update[field] += " " + value.to_s
-      end
-
-      ##
-      # Appends the current Array with the provided value
-      #
-      # [Arguments]
-      # :field   (required)    field to update
-      #
-      # :value   (required)    value array
-      #
-      def append_a(field, value)
-        @fields_update[field] = @fields_current[field] if (@fields_update[field] == nil)
-        @fields_update[field] = Array.new if !(@fields_update[field].is_a? Array)
-        if value.is_a? String
-          @fields_update[field].push(value) unless @fields_update[field].include? value
-        else
-          @fields_update[field] |= value
-        end
-      end
-
-      ##
-      # Appends the current Hash with the provided value
-      #
-      # [Arguments]
-      # :field   (required)    field to update
-      #
-      # :value   (required)    value hash
-      #
-      def append_h(field, hash)
-        @fields_update[field] = @fields_current[field] if (@fields_update[field] == nil)
-        @fields_update[field] = Hash.new if !(@fields_update[field].is_a? Hash)
-        @fields_update[field].merge!(hash)
-      end
-
-      ##
-      # Merges current to updated to allow for a forced
-      # update request to process.
-      #
-      def force_update
-        @fields_update.merge!(@fields_current)
-      end
-
-      ##
-      # Sets the field key with the provided value.
-      #
-      # [Arguments]
-      # :field   (required)    field to update
-      #
-      # :value   (required)    value to add
-      #
-      def set(field, value)
-        @fields_update[field] = value
-      end
-
-      ##
-      # Sets the field with a name hash.
-      # This is necessary for some objects in Jira.
-      #
-      # [Arguments]
-      # :field   (required)    field to update
-      #
-      # :value   (required)    value text
-      #
-      def set_name(field, value)
-        @fields_update[field] = {"name" => value}
-      end
-
-      ##
-      # Sets the field with a id hash.
-      # This is necessary for some objects in Jira.
-      #
-      # [Arguments]
-      # :field   (required)    field to update
-      #
-      # :value   (required)    value text/int
-      #
-      def set_id(field, value)
-        @fields_update[field] = {"id" => value}
-      end
-      ##
-      # Fills the fields_current object with the provided Hash.
-      #
-      # [Arguments]
-      # :fc    (optional) fields to load
-      #
-      def set_current(fc)
-        @fields_current = fc if fc.type == Hash
-      end
-
-      ##
-      # Returns the current fields object
-      #
-      def current
-        return @fields_current
-      end
-
-      ##
-      # Returns the updated fields object
-      #
-      def updated
-        return @fields_update
-      end
-
-      ##
-      # Formats the fields_update object correctly
-      # for Jira to perform an update request.
-      #
-      def format_for_update
-        up = Hash.new
-        @fields_update.each do |k, v|
-          if k == "comment"
-            up[k] = v
-          else
-            up[k] = [{"set" => v}]
-          end
-        end
-        return {"update" => up}
-      end
-
-      ##
-      # Formats the fields_update object correctly
-      # for Jira to perform an create request.
-      #
-      def format_for_create
-        return {"fields" => @fields_update}
-      end
-    end
-  end
-end
+# encoding: utf-8
+module Jiralicious
+  class Issue
+    ##
+    # The Fields class provides functionality to the Issue
+    # class that allows it to easily update or create issues.
+    # The class retains the original  and the proposed
+    # information which could be used for cross validation
+    # prior to posting an update.
+    #
+    class Fields
+      # The fields that will be updated or created
+      attr_accessor :fields_update
+      # The current fields when a ticket was loaded
+      attr_accessor :fields_current
+
+      ##
+      # Initialization Method
+      #
+      # [Arguments]
+      # :fc    (optional) fields to load
+      #
+      def initialize(fc = nil)
+        @fields_current = (fc == nil) ? Hash.new : fc
+        @fields_update = Hash.new
+      end
+
+      ##
+      # Returns the count of fields being updated.
+      #
+      def count
+        return @fields_update.count
+      end
+
+      ##
+      # Returns the length of fields being updated.
+      #
+      def length
+        return @fields_update.length
+      end
+
+      ##
+      # Adds a comment to the field list
+      #
+      # [Arguments]
+      # :comment   (required)    comment text
+      #
+      def add_comment(comment)
+        if !(@fields_update['comment'].is_a? Array)
+          @fields_update['comment'] = Array.new
+        end
+        @fields_update['comment'].push({"add" => {"body" => comment}})
+      end
+
+      ##
+      # Appends the current String with the provided value
+      #
+      # [Arguments]
+      # :field   (required)    field to update
+      #
+      # :value   (required)    value text
+      #
+      def append_s(field, value)
+        if (@fields_update[field] == nil)
+          @fields_update[field] = @fields_current[field] unless @fields_current.nil?
+          @fields_update[field] ||= ""
+        end
+        @fields_update[field] += " " + value.to_s
+      end
+
+      ##
+      # Appends the current Array with the provided value
+      #
+      # [Arguments]
+      # :field   (required)    field to update
+      #
+      # :value   (required)    value array
+      #
+      def append_a(field, value)
+        @fields_update[field] = @fields_current[field] if (@fields_update[field] == nil)
+        @fields_update[field] = Array.new if !(@fields_update[field].is_a? Array)
+        if value.is_a? String
+          @fields_update[field].push(value) unless @fields_update[field].include? value
+        else
+          @fields_update[field] |= value
+        end
+      end
+
+      ##
+      # Appends the current Hash with the provided value
+      #
+      # [Arguments]
+      # :field   (required)    field to update
+      #
+      # :value   (required)    value hash
+      #
+      def append_h(field, hash)
+        @fields_update[field] = @fields_current[field] if (@fields_update[field] == nil)
+        @fields_update[field] = Hash.new if !(@fields_update[field].is_a? Hash)
+        @fields_update[field].merge!(hash)
+      end
+
+      ##
+      # Merges current to updated to allow for a forced
+      # update request to process.
+      #
+      def force_update
+        @fields_update.merge!(@fields_current)
+      end
+
+      ##
+      # Sets the field key with the provided value.
+      #
+      # [Arguments]
+      # :field   (required)    field to update
+      #
+      # :value   (required)    value to add
+      #
+      def set(field, value)
+        @fields_update[field] = value
+      end
+
+      ##
+      # Sets the field with a name hash.
+      # This is necessary for some objects in Jira.
+      #
+      # [Arguments]
+      # :field   (required)    field to update
+      #
+      # :value   (required)    value text
+      #
+      def set_name(field, value)
+        @fields_update[field] = {"name" => value}
+      end
+
+      ##
+      # Sets the field with a id hash.
+      # This is necessary for some objects in Jira.
+      #
+      # [Arguments]
+      # :field   (required)    field to update
+      #
+      # :value   (required)    value text/int
+      #
+      def set_id(field, value)
+        @fields_update[field] = {"id" => value}
+      end
+      ##
+      # Fills the fields_current object with the provided Hash.
+      #
+      # [Arguments]
+      # :fc    (optional) fields to load
+      #
+      def set_current(fc)
+        @fields_current = fc if fc.type == Hash
+      end
+
+      ##
+      # Returns the current fields object
+      #
+      def current
+        return @fields_current
+      end
+
+      ##
+      # Returns the updated fields object
+      #
+      def updated
+        return @fields_update
+      end
+
+      ##
+      # Formats the fields_update object correctly
+      # for Jira to perform an update request.
+      #
+      def format_for_update
+        up = Hash.new
+        @fields_update.each do |k, v|
+          if k == "comment"
+            up[k] = v
+          else
+            up[k] = [{"set" => v}]
+          end
+        end
+        return {"update" => up}
+      end
+
+      ##
+      # Formats the fields_update object correctly
+      # for Jira to perform an create request.
+      #
+      def format_for_create
+        return {"fields" => @fields_update}
+      end
+    end
+  end
+end