jiralicious 0.4.3 → 0.5.0

data/lib/jiralicious/issue/watchers.rb

@@ -1,92 +1,92 @@
-# encoding: utf-8
-module Jiralicious
-  class Issue
-    ##
-    # The Watchers class is used to manage the
-    # watchers on an issue.
-    #
-    class Watchers < Jiralicious::Base
-      ##
-      # Holds the Issue Key
-      #
-      attr_accessor :jira_key
-
-      ##
-      # Initialization Method
-      #
-      def initialize(decoded_json = nil)
-        if (decoded_json != nil)
-          properties_from_hash(decoded_json)
-          super(decoded_json)
-          parse!(decoded_json)
-        end
-      end
-
-      class << self
-        ##
-        # Finds all watchers based on the provided Issue Key
-        #
-        # [Arguments]
-        # :key    (required)    issue key to find
-        #
-        def find_by_key(key)
-          issueKey_test(key)
-          response = fetch({:parent => parent_name, :parent_key => key})
-          a = new(response)
-          a.jira_key = key
-          return a
-        end
-
-        ##
-        # Adds a new Watcher to the Issue
-        #
-        # [Arguments]
-        # :name    (required)    name of the watcher
-        #
-        # :key     (required)    issue key
-        #
-        def add(name, key)
-          issueKey_test(key)
-          fetch({:method => :post, :body => name, :body_override => true, :parent => parent_name, :parent_key => key})
-        end
-
-        ##
-        # Removes/Deletes a Watcher from the Issue
-        #
-        # [Arguments]
-        # :name    (required)    name of the watcher
-        #
-        # :key     (required)    issue key
-        #
-        def remove(name, key)
-          issueKey_test(key)
-          fetch({:method => :delete, :body_to_params => true, :body => {:username => name}, :parent => parent_name, :parent_key => key})
-        end
-      end
-
-      ##
-      # Finds all watchers based on the provided Issue Key
-      #
-      def find
-        self.class.find_by_key(@jira_key)
-      end
-
-      ##
-      # Adds a new Watcher to the Issue
-      #
-      # [Arguments]
-      # :name    (required)    name of the watcher
-      #
-      def add(name)
-        self.class.add(name, @jira_key)
-      end
-
-      ##
-      # Removes/Deletes a Watcher from the Issue
-      #
-      def remove(name)
-        self.class.remove(name, @jira_key)
-      end
-    end
-  end
-end
+# encoding: utf-8
+module Jiralicious
+  class Issue
+    ##
+    # The Watchers class is used to manage the
+    # watchers on an issue.
+    #
+    class Watchers < Jiralicious::Base
+      ##
+      # Holds the Issue Key
+      #
+      attr_accessor :jira_key
+
+      ##
+      # Initialization Method
+      #
+      def initialize(decoded_json = nil)
+        if (decoded_json != nil)
+          properties_from_hash(decoded_json)
+          super(decoded_json)
+          parse!(decoded_json)
+        end
+      end
+
+      class << self
+        ##
+        # Finds all watchers based on the provided Issue Key
+        #
+        # [Arguments]
+        # :key    (required)    issue key to find
+        #
+        def find_by_key(key)
+          issueKey_test(key)
+          response = fetch({:parent => parent_name, :parent_key => key})
+          a = new(response)
+          a.jira_key = key
+          return a
+        end
+
+        ##
+        # Adds a new Watcher to the Issue
+        #
+        # [Arguments]
+        # :name    (required)    name of the watcher
+        #
+        # :key     (required)    issue key
+        #
+        def add(name, key)
+          issueKey_test(key)
+          fetch({:method => :post, :body => name, :body_override => true, :parent => parent_name, :parent_key => key})
+        end
+
+        ##
+        # Removes/Deletes a Watcher from the Issue
+        #
+        # [Arguments]
+        # :name    (required)    name of the watcher
+        #
+        # :key     (required)    issue key
+        #
+        def remove(name, key)
+          issueKey_test(key)
+          fetch({:method => :delete, :body_to_params => true, :body => {:username => name}, :parent => parent_name, :parent_key => key})
+        end
+      end
+
+      ##
+      # Finds all watchers based on the provided Issue Key
+      #
+      def find
+        self.class.find_by_key(@jira_key)
+      end
+
+      ##
+      # Adds a new Watcher to the Issue
+      #
+      # [Arguments]
+      # :name    (required)    name of the watcher
+      #
+      def add(name)
+        self.class.add(name, @jira_key)
+      end
+
+      ##
+      # Removes/Deletes a Watcher from the Issue
+      #
+      def remove(name)
+        self.class.remove(name, @jira_key)
+      end
+    end
+  end
+end

data/lib/jiralicious/project.rb

@@ -1,64 +1,116 @@
-# encoding: utf-8
-module Jiralicious
-  ##
-  # The Project class rolls up the basic functionality for
-  # managing Projects within Jira through the Rest API.
-  #
-  class Project < 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
-      else
-        decoded_json.each do |list|
-          self.class.property :"#{list['key']}"
-          self.merge!({list['key'] => self.class.find(list['key'])})
-        end
-      end
-    end
-
-    class << self
-      ##
-      # Returns a list of issues within the project. The issue list is limited
-      # to only return the issue ID and KEY values to minimize the amount of
-      # data being returned This is used in lazy loading methodology.
-      #
-      # [Arguments]
-      # :key    (required)    project key
-      #
-      def issue_list(key)
-        response = Jiralicious.search("project=#{key}", {:fields => ["id", "key"]})
-        i_out = Issue.new
-        response.issues_raw.each do |issue|
-          i_out.class.property :"#{issue["key"].gsub("-", "_")}"
-          t = Issue.new
-          t.load(issue, true)
-          i_out[issue["key"].gsub("-", "_")] = t
-        end
-        i_out
-      end
-    end
-
-    ##
-    # Issues loads the issue list into the current Project.
-    # It also acts as a reference for lazy loading of issues.
-    #
-    attr_accessor :issues
-    def issues
-      if @issues == nil
-        @issues = self.class.issue_list(self.key)
-      end
-      return @issues
-    end
-  end
-end
+# encoding: utf-8
+module Jiralicious
+  ##
+  # The Project class rolls up the basic functionality for
+  # managing Projects within Jira through the Rest API.
+  #
+  class Project < Jiralicious::Base
+
+    # Contains the Fields Class
+    attr_accessor :components
+    # Contains the Fields Class
+    attr_accessor :versions
+
+    ##
+    # 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
+      else
+        decoded_json.each do |list|
+          self.class.property :"#{list['key']}"
+          self.merge!({list['key'] => self.class.find(list['key'])})
+        end
+      end
+    end
+
+    class << self
+      ##
+      # Returns a list of issues within the project. The issue list is limited
+      # to only return the issue ID and KEY values to minimize the amount of
+      # data being returned This is used in lazy loading methodology.
+      #
+      # [Arguments]
+      # :key    (required)    project key
+      #
+      def issue_list(key)
+        response = Jiralicious.search("project=#{key}", {:fields => ["id", "key"]})
+        i_out = Issue.new
+        response.issues_raw.each do |issue|
+          i_out.class.property :"#{issue["key"].gsub("-", "_")}"
+          t = Issue.new
+          t.load(issue, true)
+          i_out[issue["key"].gsub("-", "_")] = t
+        end
+        i_out
+      end
+
+      ##
+      # Retrieves the components associated with the project
+      #
+      # [Arguments]
+      # :key    (required)    project key to generate components
+      #
+      def components(key)
+        response = fetch({:key => "#{key}/components"})
+        Field.new(response.parsed_response)
+      end
+
+      ##
+      # Retrieves the versions associated with the project
+      #
+      # [Arguments]
+      # :key      (required)    project key to generate versions
+      #
+      # :expand   (optional)    expansion options.
+      #
+      def versions(key, expand = {})
+        response = fetch({:key => "#{key}/versions", :body => expand})
+        Field.new(response.parsed_response)
+      end
+    end
+
+    ##
+    # Issues loads the issue list into the current Project.
+    # It also acts as a reference for lazy loading of issues.
+    #
+    attr_accessor :issues
+    def issues
+      if @issues == nil
+        @issues = self.class.issue_list(self.key)
+      end
+      return @issues
+    end
+
+    ##
+    # Retrieves the components associated with the project
+    #
+    def components
+      if @components.nil?
+        @components = self.class.components(self.key)
+      end
+      @components
+    end
+
+    ##
+    # Retrieves the versions associated with the project
+    #
+    # [Arguments]
+    # :expand   (optional)    expansion options.
+    #
+    def versions(expand = {})
+      if @versions.nil? || !expand.empty?
+        @versions = self.class.verions(self.key, expand)
+      end
+      @versions
+    end
+  end
+end

data/lib/jiralicious/session.rb

@@ -1,61 +1,61 @@
-# encoding: utf-8
-require 'jiralicious/configuration'
-
-module Jiralicious
-  ##
-  # The Session class handles the interactions with the Jira Rest API
-  # Through the HTTParty gem.
-  #
-  class Session
-    include HTTParty
-
-    # Sets the default format to JSON for send and return
-    format        :json
-    # Sets the default headers to application/json for send and return
-    headers       'Content-Type' => 'application/json'
-
-    ##
-    # Main access method to request data from the Jira API
-    #
-    # [Arguments]
-    # :method    (required)    http method type
-    #
-    # :options   (required)    request specific options
-    #
-    def request(method, *options)
-      if options.last.is_a?(Hash) && options.last[:handler]
-        response_handler = options.last.delete(:handler)
-      else
-        response_handler = handler
-      end
-
-      self.class.base_uri Jiralicious.uri
-      before_request if respond_to?(:before_request)
-      response = self.class.send(method, *options)
-      after_request(response) if respond_to?(:after_request)
-
-      response_handler.call(response)
-    end
-
-    private
-
-    ##
-    # Configures the default handler. This can be overridden in
-    # the child class to provide additional error handling.
-    #
-    def handler
-      Proc.new do |response|
-        case response
-        when 200..204
-          response.body
-        else
-          message = response.body
-          if message.is_a?(Hash)
-            message = message['errorMessages'].join('\n')
-          end
-          Jiralicious::JiraError.new(message)
-        end
-      end
-    end
-  end
-end
+# encoding: utf-8
+require 'jiralicious/configuration'
+
+module Jiralicious
+  ##
+  # The Session class handles the interactions with the Jira Rest API
+  # Through the HTTParty gem.
+  #
+  class Session
+    include HTTParty
+
+    # Sets the default format to JSON for send and return
+    format        :json
+    # Sets the default headers to application/json for send and return
+    headers       'Content-Type' => 'application/json'
+
+    ##
+    # Main access method to request data from the Jira API
+    #
+    # [Arguments]
+    # :method    (required)    http method type
+    #
+    # :options   (required)    request specific options
+    #
+    def request(method, *options)
+      if options.last.is_a?(Hash) && options.last[:handler]
+        response_handler = options.last.delete(:handler)
+      else
+        response_handler = handler
+      end
+
+      self.class.base_uri Jiralicious.uri
+      before_request if respond_to?(:before_request)
+      response = self.class.send(method, *options)
+      after_request(response) if respond_to?(:after_request)
+
+      response_handler.call(response)
+    end
+
+    private
+
+    ##
+    # Configures the default handler. This can be overridden in
+    # the child class to provide additional error handling.
+    #
+    def handler
+      Proc.new do |response|
+        case response
+        when 200..204
+          response.body
+        else
+          message = response.body
+          if message.is_a?(Hash)
+            message = message['errorMessages'].join('\n')
+          end
+          Jiralicious::JiraError.new(message)
+        end
+      end
+    end
+  end
+end