jiralicious 0.1.0 → 0.2.0

data/.gitignore

@@ -8,4 +8,5 @@ TAGS
 vendor/bundle
 *~
 \#*#
-*.#*
+*.#*
+/bin

data/.ruby-gemset

@@ -0,0 +1 @@
+jiralicious

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.2-p320

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7

data/README.md

@@ -1,5 +1,7 @@
 # jiralicious
 
+[![Build Status](https://travis-ci.org/jstewart/jiralicious.png)](https://travis-ci.org/jstewart/jiralicious)
+
 ## Examples:
 
 Before doing anything, you must configure your session:
@@ -13,10 +15,15 @@ Before doing anything, you must configure your session:
       config.auth_type = :basic
     end
 
-Default auth type is now Basic auth. Cookie auth is still available with the
-following option:
+Session configuration is also available via YAML:
+
+    jira:
+      username: youruser
+      password: yourpass
+      uri: https://example.com/
+
 
-    config.auth_type = :cookie
+    Jiralicious.load_yml(File.expand_path("/path/to/jira.yml"))
 
 Search for issues:
 
@@ -28,6 +35,27 @@ Finding a single issue:
     issue = Jiralicious::Issue.find("HSP-1")
     issue.key => "HSP-1"
 
+
+## Deprecation Warning
+
+Default auth type is now Basic auth. Cookie auth will be deprecated in the next version.
+
+
+## Changes from 0.1.0
+
+* Issues can be created, updated, or deleted as needed. This includes most components such as comments, transitions, and assignees.
+* Projects can now be accessed as well as related issues
+* A Field class has been added to allow proper access to the meta data for create, edit, and update requests. This data is searchable via Hash or dot notation
+* Some sections can now be lazy loaded
+* Configuration can be loaded via yaml
+
+
+## Contributors
+
+* Stanley Handschuh (dorack)
+* Mike Fiedler (miketheman)
+* Girish Sonawane (girishso)
+
 ## Contributing to jiralicious
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
@@ -40,5 +68,5 @@ Finding a single issue:
 
 ## Copyright
 
-Copyright (c) 2012 Jason Stewart. See LICENSE for
+Copyright (c) 2013 Jason Stewart. See LICENSE for
 further details.

data/jiralicious.gemspec

@@ -12,11 +12,13 @@ Gem::Specification.new do |s|
   s.description = %Q{A Ruby library for interacting with JIRA's REST API}
   s.email = "jstewart@fusionary.com"
   s.authors = ["Jason Stewart"]
-  s.add_runtime_dependency 'httparty', '~>0.7.8'
-  s.add_runtime_dependency 'hashie', '~>1.1'
-  s.add_runtime_dependency 'json', '~>1.6.3'
-  s.add_development_dependency 'rspec', '~>2.6.0'
-  s.add_development_dependency 'fakeweb', '~>1.3.0'
+  s.add_runtime_dependency 'crack', '~> 0.1.8'
+  s.add_runtime_dependency 'httparty', '~> 0.11.0'
+  s.add_runtime_dependency 'hashie', '>= 1.1'
+  s.add_runtime_dependency 'json', '~> 1.7.7'
+  s.add_development_dependency 'rspec', '~> 2.6'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'fakeweb', '~> 1.3.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/jiralicious.rb

@@ -1,19 +1,26 @@
 # encoding: utf-8
-
 require 'hashie'
+require 'crack'
 require 'httparty'
 require 'json'
 
-
 require 'jiralicious/parsers/field_parser'
 require 'jiralicious/errors'
+require 'jiralicious/base'
+require 'jiralicious/field'
+require 'jiralicious/custom_field_option'
 require 'jiralicious/issue'
+require 'jiralicious/issue/fields'
+require 'jiralicious/issue/comment'
+require 'jiralicious/issue/watchers'
+require 'jiralicious/issue/transitions'
+require 'jiralicious/project'
 require 'jiralicious/search'
 require 'jiralicious/search_result'
 require 'jiralicious/session'
 require 'jiralicious/basic_session'
 require 'jiralicious/cookie_session'
-
+require 'jiralicious/configuration'
 
 module Jiralicious
   extend Configuration

data/lib/jiralicious/base.rb

@@ -0,0 +1,114 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+require "uri"
+module Jiralicious
+  class Base < Hashie::Trash
+    include Jiralicious::Parsers::FieldParser
+
+    attr_accessor :loaded
+
+    ### Trash Extention Methods ###
+    def properties_from_hash(hash)
+      hash.inject({}) do |newhash, (k, v)|
+        k = k.gsub("-", "_")
+        k = "_#{k.to_s}" if k =~ /^\d/
+        self.class.property :"#{k}"
+        newhash[k] = v
+        newhash
+      end
+    end
+
+    ### Class Methods ###
+    class << self
+      def find(key, options = {})
+        response = fetch({:key => key})
+        if options[:reload] == true
+          response
+        else
+          new(response.parsed_response)
+        end
+      end
+
+      def find_all
+        response = fetch()
+        new(response)
+      end
+
+      def endpoint_name
+        self.name.split('::').last.downcase
+      end
+
+      def parent_name
+        arr = self.name.split('::')
+        arr[arr.length-2].downcase
+      end
+
+      def fetch(options = {})
+        options[:method] = :get unless [:get, :post, :put, :delete].include?(options[:method])
+        options[:parent_uri] = "#{parent_name}/#{options[:parent_key]}/" unless options[:parent].nil?
+        if !options[:body_override]
+          options[:body_uri] = (options[:body].is_a? Hash) ? options[:body] : {:body => options[:body]}
+        else
+          options[:body_uri] = options[:body]
+        end
+        if options[:body_to_params]
+          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]
+        Jiralicious.session.request(options[:method], options[:url_uri], :handler => handler, :body => options[:body_uri].to_json)
+      end
+
+      def handler
+        Proc.new do |response|
+          case response.code
+          when 200..204
+            response
+          when 400
+            raise Jiralicious::TransitionError.new(response['errorMessages'].join('\n'))
+          when 404
+            raise Jiralicious::IssueNotFound.new(response['errorMessages'].join('\n'))
+          else
+            raise Jiralicious::JiraError.new(response['errorMessages'].join('\n'))
+          end
+        end
+      end
+
+      alias :all :find_all
+    end
+
+    ### Instance Methods ###
+    def endpoint_name
+      self.class.endpoint_name
+    end
+
+    def parent_name
+      self.class.parent_name
+    end
+
+    def all
+      self.class.all
+    end
+
+    def loaded?
+      self.loaded
+    end
+
+    def reload
+    end
+
+    def method_missing(meth, *args, &block)
+      if !loaded?
+        self.loaded = true
+        reload
+        self.send(meth, *args, &block)
+      else
+        super
+      end
+    end
+
+    def numeric?(object)
+      true if Float(object) rescue false
+    end
+  end
+end

data/lib/jiralicious/configuration.rb

@@ -1,11 +1,11 @@
 # encoding: utf-8
-
+require 'ostruct'
 module Jiralicious
   module Configuration
     VALID_OPTIONS = [:username, :password, :uri, :api_version, :auth_type]
     DEFAULT_USERNAME = nil
-    DEFAULT_AUTH_TYPE = :basic
     DEFAULT_PASSWORD = nil
+    DEFAULT_AUTH_TYPE = :basic
     DEFAULT_URI = nil
     DEFAULT_API_VERSION = "latest"
 
@@ -33,5 +33,16 @@ module Jiralicious
       self.api_version = DEFAULT_API_VERSION
       self.auth_type = DEFAULT_AUTH_TYPE
     end
+
+    def load_yml(yml_file)
+      if File.exist?(yml_file)
+        yml_cfg = OpenStruct.new(YAML.load_file(yml_file))
+        yml_cfg.jira.each do |k, v|
+          instance_variable_set("@#{k}", v)
+        end
+      else
+        reset
+      end
+    end
   end
 end

data/lib/jiralicious/cookie_session.rb

@@ -48,9 +48,9 @@ module Jiralicious
       end
 
       self.request(:post, '/rest/auth/latest/session',
-                   :body => { :username => Jiralicious.username,
-                              :password => Jiralicious.password}.to_json,
-                   :handler => handler)
+        :body => { :username => Jiralicious.username,
+          :password => Jiralicious.password}.to_json,
+        :handler => handler)
 
     end
 
@@ -77,8 +77,8 @@ module Jiralicious
     def captcha_required(response)
       response.code == 401 &&
         # Fakeweb lowercases headers automatically. :(
-        (response.headers["X-Seraph-LoginReason"] == "AUTHENTICATION_DENIED" ||
-         response.headers["x-seraph-loginreason"] == "AUTHENTICATION_DENIED")
+      (response.headers["X-Seraph-LoginReason"] == "AUTHENTICATION_DENIED" ||
+          response.headers["x-seraph-loginreason"] == "AUTHENTICATION_DENIED")
     end
 
     def cookie_invalid(response)

data/lib/jiralicious/custom_field_option.rb

@@ -0,0 +1,27 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+module Jiralicious
+  class CustomFieldOption < Jiralicious::Base
+    def initialize(decoded_json, default = nil, &blk)
+      @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
+      def endpoint_name
+        "customFieldOption"
+      end
+
+      def find(id, options = {})
+        response = fetch({:key => id})
+        response.parsed_response['id'] = id
+        new(response.parsed_response)
+      end
+    end
+  end
+end

data/lib/jiralicious/field.rb

@@ -0,0 +1,39 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+module Jiralicious
+  class Field < Jiralicious::Base
+
+    def initialize(decoded_json, default = nil, &blk)
+      @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
+        decoded_json.each do |list|
+          if numeric? list['id']
+            id =  :"id_#{list['id']}"
+          else
+            id = :"#{list['id']}"
+          end
+          self.class.property id
+          out self.class.new(list)
+          self.merge!({id => out})
+        end
+      end
+    end
+  end
+end

data/lib/jiralicious/issue.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 module Jiralicious
-  class Issue < Hashie::Trash
-    include Jiralicious::Parsers::FieldParser
+  class Issue < Jiralicious::Base
 
     property :jira_key, :from  => :key
     property :expand
@@ -9,40 +8,126 @@ module Jiralicious
     property :fields
     property :transitions
     property :id
+    attr_accessor :fields
+    attr_accessor :comments
+    attr_accessor :watchers
+    attr_accessor :createmeta
+    attr_accessor :editmeta
 
-    def initialize(decoded_json, default = nil, &blk)
-      super(decoded_json)
-      parse!(decoded_json["fields"])
+    ### Initialization ###
+    def initialize(decoded_json = nil, default = nil, &blk)
+      @loaded = false
+      if (!decoded_json.nil?)
+        super(decoded_json)
+        parse!(decoded_json["fields"])
+        if default.nil?
+          @fields = Fields.new(self['fields']) if self['fields']
+          @comments = Comment.find_by_key(self.jira_key)
+          @watchers = Watchers.find_by_key(self.jira_key)
+          @loaded = true
+        end
+      end
+      @fields = Fields.new if @fields.nil?
+      @comments = Comment.new if @comments.nil?
+      @watchers = Watchers.new if @watchers.nil?
+      @createmeta = nil
+      @editmeta = nil
+    end
+
+    def load(decoded_hash, default = nil)
+      decoded_hash.each do |k,v|
+        self[:"#{k}"] = v
+      end
+      if default.nil?
+        parse!(self['fields'])
+        @fields = Fields.new(self['fields']) if self['fields']
+        @comments = Comment.find_by_key(self.jira_key)
+        @watchers = Watchers.find_by_key(self.jira_key)
+        @loaded = true
+      else
+        parse!(decoded_hash)
+      end
+    end
+
+    def reload
+      load(self.class.find(self.jira_key, {:reload => true}).parsed_response)
+    end
+
+
+    ### Class Methods ###
+    class << self
+      def assignee(name, key)
+        name = {"name" => name} if name.is_a? String
+        fetch({:method => :put, :key => "#{key}/assignee", :body => name})
+      end
+
+      def create(issue)
+        fetch({:method => :post, :body => issue})
+      end
+
+      def remove(key, options = {})
+        fetch({:method => :delete, :body_to_params => true, :key => key, :body => options})
+      end
+
+      def update(issue, key)
+        fetch({:method => :put, :key => key, :body => issue})
+      end
+
+      def createmeta(projectkeys, issuetypeids = nil)
+        response = fetch({:body_to_params => true, :key => "createmeta", :body => {:expand => "projects.issuetypes.fields.", :projectKeys => projectkeys, :issuetypeIds => issuetypeids}})
+        return Field.new(response.parsed_response)
+      end
+
+      def editmeta(key)
+        response = fetch({:key => "#{key}/editmeta"})
+        response.parsed_response["key"] = key
+        Field.new(response.parsed_response)
+      end
+
+      def get_transitions(transitions_url)
+        Jiralicious.session.request(:get, transitions_url, :handler => handler)
+      end
+
+      def transition(transitions_url, data)
+        Jiralicious.session.request(:post, transitions_url,
+          :handler => handler,
+          :body => data.to_json)
+      end
+    end
+
+    ### Public Classes ###
+
+    def set_assignee(name)
+      self.class.assignee(name, self.jira_key)
     end
 
-    def self.find(key, options = {})
-      response = Jiralicious.session.request(:get, "#{Jiralicious.rest_path}/issue/#{key}", :handler => handler)
-      new(response)
+    def remove(options = {})
+      self.class.remove(self.jira_key, options)
     end
 
-    def self.get_transitions(transitions_url)
-      Jiralicious.session.request(:get, transitions_url, :handler => handler)
+    def createmeta
+      if @createmeta.nil?
+        @createmeta = self.class.createmeta(self.jira_key.split("-")[0])
+      end
+      @createmeta
     end
 
-    def self.transition(transitions_url, data)
-      Jiralicious.session.request(:post, transitions_url,
-                                  :handler => handler,
-                                  :body => data.to_json)
+    def editmeta
+      if @editmeta.nil?
+        @editmeta = self.class.editmeta(self.jira_key)
+      end
+      @editmeta
     end
 
-    def self.handler
-      Proc.new do |response|
-        case response.code
-        when 200..204
-          response
-        when 400
-          raise Jiralicious::TransitionError.new(response['errorMessages'].join('\n'))
-        when 404
-          raise Jiralicious::IssueNotFound.new(response['errorMessages'].join('\n'))
-        else
-          raise Jiralicious::JiraError.new(response['errorMessages'].join('\n'))
-        end
+    def save
+      if loaded?
+        self.class.update(@fields.format_for_update, self.jira_key)
+        key = self.jira_key
+      else
+        response = self.class.create(@fields.format_for_create)
+        key = response.parsed_response['key']
       end
+      load(self.class.find(key, {:reload => true}).parsed_response)
     end
   end
 end