jiralicious 0.3.0 → 0.4.0

data/README.md

@@ -40,6 +40,9 @@ Finding a single issue:
 
 Default auth type is now Basic auth. Cookie auth will be deprecated in the next version.
 
+## Changes from 0.3.0
+
+* User and Avatars are now supported.
 
 ## Changes from 0.2.2
 

data/jiralicious.gemspec

@@ -17,8 +17,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'hashie', '>= 1.1'
   s.add_runtime_dependency 'json', '>= 1.6', '< 1.9.0'
   s.add_development_dependency 'rspec', '~> 2.6'
-  s.add_development_dependency 'gemcutter'
-
   s.add_development_dependency 'rake'
   s.add_development_dependency 'fakeweb', '~> 1.3.0'
 

data/lib/jiralicious.rb

@@ -15,12 +15,16 @@ require 'jiralicious/issue/comment'
 require 'jiralicious/issue/watchers'
 require 'jiralicious/issue/transitions'
 require 'jiralicious/project'
+require 'jiralicious/project/avatar'
 require 'jiralicious/search'
 require 'jiralicious/search_result'
 require 'jiralicious/session'
+require 'jiralicious/user'
+require 'jiralicious/user/avatar'
 require 'jiralicious/basic_session'
 require 'jiralicious/cookie_session'
 require 'jiralicious/configuration'
+require 'jiralicious/avatar'
 
 ##
 # The Jiralicious module standard options and methods

data/lib/jiralicious/avatar.rb

@@ -0,0 +1,101 @@
+# encoding: utf-8
+module Jiralicious
+	##
+	# Avatars in the Project class.
+	#
+	class Avatar < Jiralicious::Base
+
+		##
+		# Initialization Method
+		#
+		# [Arguments]
+		# :decoded_json    (optional)    decoded json object
+		#
+		def initialize(decoded_json = nil)
+			@loaded = false
+			if !decoded_json.nil?
+				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
+
+		class << self
+
+			##
+			# Gets a list of available avatars
+			#
+			# [Arguments]
+			# :key         (required)    avatar type = Project or User
+			#
+			def system(key, options = {})
+				response = fetch({:method => :get, :key => "#{key}/system", :body => options})
+				return self.new(response.parsed_response)
+			end
+
+			##
+			# Creates temporary avatar
+			#
+			# [Arguments]
+			# :key         (required)    avatar type = Project or User
+			#
+			# :filename    (required)    file to upload
+			#
+			# :size        (required)    size of the file
+			#
+			def temporary(key, options = {})
+				response = fetch({:method => :post, :key => "#{key}/temporary", :body => options})
+				return self.new(response.parsed_response)
+			end
+
+			##
+			# Updates the cropping on a temporary avatar
+			#
+			# [Arguments]
+			# :key         (required)    avatar type = Project or User
+			#
+			# :cropperWidth       (optional)    width of the image
+			#
+			# :cropperOffsetX     (optional)    X Offset on image
+			#
+			# :cropperOffsety     (optional)    Y Offset on image
+			#
+			# :needsCropping      (optional)    Boolean if needs cropping
+			#
+			def temporary_crop(key, options = {})
+				response = fetch({:method => :post, :key => "#{key}/temporaryCrop", :body => options})
+			end
+		end
+	end
+end

data/lib/jiralicious/base.rb

@@ -22,6 +22,9 @@ module Jiralicious
     # Adds an underscore (_) before a numeric field.
     # This ensures that numeric fields will be treated as strings.
     #
+    # [Arguments]
+    # :hash    (required)    hash to be added to properties
+    #
     def properties_from_hash(hash)
       hash.inject({}) do |newhash, (k, v)|
         k = k.gsub("-", "_")
@@ -34,8 +37,14 @@ module Jiralicious
 
     class << self
       ##
-      # Finds the specified key in relation to the current class. This is based on the
-      # inheritance and will create an error if called from the Base Class directly.
+      # Finds the specified key in relation to the current class.
+      # This is based on the inheritance and will create an error
+      # if called from the Base Class directly.
+      #
+      # [Arguments]
+      # :key    (required)    object key to find
+      #
+      # :reload (required)    is object reloading forced
       #
       def find(key, options = {})
         response = fetch({:key => key})
@@ -47,9 +56,10 @@ module Jiralicious
       end
 
       ##
-      # Searches for all objects of the inheritance class. This method can create very large
-      # datasets and is not recommended for any request that could slow down either Jira or
-      # the Ruby application.
+      # Searches for all objects of the inheritance class. This
+      # method can create very large datasets and is not recommended
+      # for any request that could slow down either Jira or the
+      # Ruby application.
       #
       def find_all
         response = fetch()
@@ -72,9 +82,27 @@ module Jiralicious
       end
 
       ##
-      # uses the options to build the URI options necessary to handle the request.
-      # Some options are defaulted if not explicit while others are only necessary
-      # under specific conditions.
+      # uses the options to build the URI options necessary to handle the
+      # request. Some options are defaulted if not explicit while others
+      # are only necessary under specific conditions.
+      #
+      #
+      # [Arguments]
+      # :key               (optional)    key of object to fetch
+      #
+      # :method            (optional)    limited to the standard request types default of :get
+      #
+      # :parent            (optional)    boolean will the parent object be used
+      #
+      # :parent_key        (optional)    parent's key (must set :parent to use)
+      #
+      # :body              (optional)    fields to be sent with the fetch
+      #
+      # :body_override     (optional)    corrects issues in :body if set
+      #
+      # :body_to_params    (optional)    forces body to be appended to URI
+      #
+      # :url               (optional)    overrides auto generated URI with custom URI
       #
       def fetch(options = {})
         options[:method] = :get unless [:get, :post, :put, :delete].include?(options[:method])
@@ -88,7 +116,7 @@ module Jiralicious
           options[:params_uri] = "?#{options[:body].to_params}" unless options[:body].nil? || options[:body].empty?
           options[:body_uri] = nil
         end
-        options[:url_uri] = options[:url].nil? ? "#{Jiralicious.rest_path}/#{options[:parent_uri]}#{endpoint_name}/#{options[:key]}#{options[:params_uri]}" : options[:url]
+        options[:url_uri] = options[:url].nil? ? "#{Jiralicious.rest_path}/#{options[:parent_uri]}#{endpoint_name}/#{options[:key]}#{options[:params_uri]}" : "#{options[:url]}#{options[:params_uri]}"
         Jiralicious.session.request(options[:method], options[:url_uri], :handler => handler, :body => options[:body_uri].to_json)
       end
 
@@ -102,11 +130,11 @@ module Jiralicious
           when 200..204
             response
           when 400
-            raise Jiralicious::TransitionError.new(response)
+            raise Jiralicious::TransitionError.new(response.inspect)
           when 404
-            raise Jiralicious::IssueNotFound.new(response)
+            raise Jiralicious::IssueNotFound.new(response.inspect)
           else
-            raise Jiralicious::JiraError.new(response)
+            raise Jiralicious::JiraError.new(response.inspect)
           end
         end
       end
@@ -129,9 +157,9 @@ module Jiralicious
     end
 
     ##
-    # Searches for all objects of the inheritance class. This method can create very large
-    # datasets and is not recommended for any request that could slow down either Jira or
-    # the Ruby application.
+    # Searches for all objects of the inheritance class. This method can
+    # create very large datasets and is not recommended for any request
+    # that could slow down either Jira or the Ruby application.
     #
     def all
       self.class.all
@@ -156,6 +184,13 @@ module Jiralicious
     # Overrides the default method_missing check. This override is used in lazy
     # loading to ensure that the requested field or method is truly unavailable.
     #
+    # [Arguments]
+    # :meth     (system)
+    #
+    # :args     (system)
+    #
+    # :block    (system)
+    #
     def method_missing(meth, *args, &block)
       if !loaded?
         self.loaded = true
@@ -169,6 +204,9 @@ module Jiralicious
     ##
     # Validates if the provided object is a numeric value
     #
+    # [Arguments]
+    # :object    (required)    object to be tested
+    #
     def numeric?(object)
       true if Float(object) rescue false
     end

data/lib/jiralicious/configuration.rb

@@ -1,9 +1,12 @@
 # encoding: utf-8
 require 'ostruct'
 module Jiralicious
+  ##
+  # Base configuration module for Jiralicious
+  #
   module Configuration
     # Array of available attributes
-    VALID_OPTIONS = [:username, :password, :uri, :api_version, :auth_type]
+    VALID_OPTIONS = [:username, :password, :uri, :api_version, :auth_type, :project]
     # Default user name set prior to login attempt
     DEFAULT_USERNAME = nil
     # Default password set prior to login attempt
@@ -15,7 +18,9 @@ module Jiralicious
     # Default API Version can be set any valid version or "latest"
     DEFAULT_API_VERSION = "latest"
 
+    ##
     # Enables block configuration mode
+    #
     def configure
       yield self
     end
@@ -23,19 +28,28 @@ module Jiralicious
     # Provides access to the array of attributes
     attr_accessor *VALID_OPTIONS
 
+    ##
     # Reset when extended into class
+    #
+    # [Arguments]
+    # :base    (required)
+    #
     def self.extended(base)
       base.reset
     end
 
+    ##
     # Pass options to set the values
+    #
     def options
       VALID_OPTIONS.inject({}) do |option, key|
         option.merge!(key => send(key))
       end
     end
 
+    ##
     # Resets all attributes to default values
+    #
     def reset
       self.username = DEFAULT_USERNAME
       self.password = DEFAULT_PASSWORD
@@ -47,8 +61,9 @@ module Jiralicious
     ##
     # Loads the provided YML file.
     #
-    # Can provide either direct or relational path to the file. It is recommended to send a direct path
-    # due to dynamic loading and/or different file locations due to different deployment methods.
+    # Can provide either direct or relational path to the file.
+    # It is recommended to send a direct path due to dynamic
+    # loading and/or different file locations due to different deployment methods.
     #
     # [Direct Path] /usr/project/somepath_to_file/jira.yml
     #
@@ -56,12 +71,23 @@ module Jiralicious
     #
     #                   "./config/jira.yml"
     #
-    def load_yml(yml_file)
+    # [Arguments]
+    # :yml_file    (required)    path to file to load
+    #
+    # :mode        (optional)    used to define environment type
+    #
+    def load_yml(yml_file, mode=nil)
       if File.exist?(yml_file)
         yml_cfg = OpenStruct.new(YAML.load_file(yml_file))
+      if mode.nil? || mode =~ /production/i
         yml_cfg.jira.each do |k, v|
           instance_variable_set("@#{k}", v)
         end
+      else
+        yml_cfg.send(mode).each do |k,v|
+        instance_variable_set("@#{k}", v)
+      end
+    end
       else
         reset
       end

data/lib/jiralicious/custom_field_option.rb

@@ -1,15 +1,19 @@
 # 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.
+  # 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
     #
-    def initialize(decoded_json, default = nil, &blk)
+    # [Arguments]
+    # :decoded_json    (optional)    rubyized json object
+    #
+    def initialize(decoded_json)
       @loaded = false
       if decoded_json.is_a? Hash
         properties_from_hash(decoded_json)

data/lib/jiralicious/errors.rb

@@ -1,17 +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

data/lib/jiralicious/field.rb

@@ -1,17 +1,23 @@
 # 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.
+  # 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.
+    # 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.
     #
-    def initialize(decoded_json, default = nil, &blk)
+    # [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)
@@ -31,15 +37,20 @@ module Jiralicious
         end
         @loaded = true
       else
+        i = 0;
         decoded_json.each do |list|
-          if numeric? list['id']
-            id =  :"id_#{list['id']}"
-          else
-            id = :"#{list['id']}"
-          end
+          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
-          out self.class.new(list)
-          self.merge!({id => out})
+         self[id] = self.class.new(list)
         end
       end
     end