jiralicious 0.0.6

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp
+*.swo
+TAGS
+*~
+\#*#
+*.#*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@jiralicious --create

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in jiralicious.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jason Stewart
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,21 @@
+= jiralicious
+
+Description goes here.
+
+TODO: Add something useful here.
+
+== 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
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 Jason Stewart. See LICENSE for
+further details.
+

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec

data/jiralicious.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jiralicious/version"
+
+Gem::Specification.new do |s|
+  s.name        = "jiralicious"
+  s.version     = Jiralicious::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.homepage = "http://github.com/jstewart/jiralicious"
+  s.license = "MIT"
+  s.summary = %Q{A Ruby library for interacting with JIRA's REST API}
+  s.description = %Q{A Ruby library for interacting with JIRA's REST API}
+  s.email = "jstewart@fusionary.com"
+  s.authors = ["Jason Stewart"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  s.add_runtime_dependency 'httparty', '~>0.7.8'
+  s.add_runtime_dependency 'hashie', '~>1.1.0'
+  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.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/jiralicious.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require 'hashie'
+require 'httparty'
+require 'json'
+
+
+require 'jiralicious/parsers/field_parser'
+require 'jiralicious/errors'
+require 'jiralicious/issue'
+require 'jiralicious/search'
+require 'jiralicious/search_result'
+require 'jiralicious/session'
+
+
+module Jiralicious
+  extend Configuration
+  extend self
+
+  def session
+    @session ||= Session.new
+  end
+
+  def rest_path
+    "#{self.uri}/rest/api/#{self.api_version}"
+  end
+end

data/lib/jiralicious/configuration.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module Jiralicious
+  module Configuration
+    VALID_OPTIONS = [:username, :password, :uri, :api_version]
+    DEFAULT_USERNAME = nil
+    DEFAULT_PASSWORD = nil
+    DEFAULT_URI = nil
+    DEFAULT_API_VERSION = "latest"
+
+    def configure
+      yield self
+    end
+
+    attr_accessor *VALID_OPTIONS
+
+    # Reset when extended into class
+    def self.extended(base)
+      base.reset
+    end
+
+    def options
+      VALID_OPTIONS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    def reset
+      self.username = DEFAULT_USERNAME
+      self.password = DEFAULT_PASSWORD
+      self.uri = DEFAULT_URI
+      self.api_version = DEFAULT_API_VERSION
+    end
+  end
+end

data/lib/jiralicious/errors.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module Jiralicious
+  class JiraError < StandardError; end
+  class AuthenticationError < StandardError; end
+  class NotLoggedIn < AuthenticationError; end
+  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
+  class CookieExpired < AuthenticationError; end
+  class CaptchaRequired < AuthenticationError; end
+  class IssueNotFound < StandardError; end
+  class JqlError < StandardError; end
+  class TransitionError < StandardError; end
+end

data/lib/jiralicious/issue.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+module Jiralicious
+  class Issue < Hashie::Trash
+    include Jiralicious::Parsers::FieldParser
+
+    property :jira_key, :from  => :key
+    property :expand
+    property :jira_self, :from => :self
+    property :fields
+    property :transitions
+
+    def initialize(decoded_json, default = nil, &blk)
+      super(decoded_json)
+      parse!(decoded_json["fields"])
+    end
+
+    def self.find(key, options = {})
+      response = Jiralicious.session.perform_request do
+        Jiralicious::Session.get("#{Jiralicious.rest_path}/issue/#{key}")
+      end
+
+      if response.code == 200
+        response = JSON.parse(response.body)
+      else
+        raise Jiralicious::IssueNotFound
+      end
+
+      new(response)
+    end
+
+    def self.get_transitions(transitions_url)
+      response = Jiralicious.session.perform_request do
+        Jiralicious::Session.get(transitions_url)
+      end
+      JSON.parse(response.body)
+    end
+
+    def self.transition(transitions_url, data)
+      response = Jiralicious.session.perform_request do
+        Jiralicious::Session.post(transitions_url, :body => data.to_json)
+      end
+
+      case response.code
+      when 204
+        response.body
+      when 400
+        error = JSON.parse(response.body)
+        raise Jiralicious::TransitionError.new(error['errorMessages'].join('\n'))
+      when 404
+        error = JSON.parse(response.body)
+        raise Jiralicious::IssueNotFound.new(error['errorMessages'].join('\n'))
+      end
+    end
+
+  end
+end

data/lib/jiralicious/parsers/field_parser.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+module Jiralicious
+  module Parsers
+    module FieldParser
+      def parse!(fields)
+        unless fields.is_a?(Hash)
+          raise ArgumentError
+        end
+        @jiralicious_field_parser_data = {}
+        singleton = class << self; self end
+
+        fields.each do |field, details|
+          next if details["name"].nil?
+          method_value = mashify(details["value"])
+          method_name  = details["name"].gsub(/(\w+)([A-Z].*)/, '\1_\2').
+            gsub(/\W/, "_").
+            downcase
+
+          if singleton.method_defined?(method_name)
+            method_name = "jira_#{method_name}"
+          end
+
+          @jiralicious_field_parser_data[method_name] = method_value
+          singleton.send :define_method, method_name do
+            @jiralicious_field_parser_data[method_name]
+          end
+        end
+      end
+
+      private
+
+      def mashify(data)
+        if data.is_a?(Array)
+          data.map { |d| mashify(d) }
+        elsif data.is_a?(Hash)
+          Hashie::Mash.new(data)
+        else
+          data
+        end
+      end
+    end
+  end
+end

data/lib/jiralicious/search.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module Jiralicious
+  def search(jql, options = {})
+    options[:start_at] ||= 0
+    options[:max_results] ||= 50
+
+    request_body = {
+      :jql => jql,
+      :startAt => options[:start_at],
+      :maxResults => options[:max_results]
+    }.to_json
+
+    response = Jiralicious.session.perform_request do
+      Jiralicious::Session.post(
+                                "#{Jiralicious.rest_path}/search",
+                                :body => request_body
+                                )
+    end
+
+    if response.code == 200
+      Jiralicious::SearchResult.new(JSON.parse(response.body))
+    else
+      raise Jiralicious::JqlError
+    end
+  end
+end

data/lib/jiralicious/search_result.rb

@@ -0,0 +1,17 @@
+module Jiralicious
+  class SearchResult
+    attr_reader :offset, :num_results
+
+    def initialize(search_data)
+      @issues      = search_data["issues"]
+      @offset      = search_data["startAt"]
+      @num_results = search_data["total"]
+    end
+
+    def issues
+      @issues.map do |issue|
+        Jiralicious::Issue.find(issue["key"])
+      end
+    end
+  end
+end

data/lib/jiralicious/session.rb

@@ -0,0 +1,100 @@
+# encoding: utf-8
+require 'jiralicious/configuration'
+
+module Jiralicious
+  class Session
+    include HTTParty
+    attr_accessor :session, :login_info
+    headers       'Content-Type' => 'application/json'
+
+    def alive?
+      @session && @login_info
+    end
+
+    def login
+      response = perform_request(:authenticating => true) do
+        self.class.post('/rest/auth/latest/session',
+                        :body => {
+                          :username => Jiralicious.username,
+                          :password => Jiralicious.password}.to_json)
+      end
+
+      if response.code == 200
+        response = JSON.parse(response.body)
+        @session = response["session"]
+        @login_info = response["loginInfo"]
+        self.class.cookies({self.session["name"] => self.session["value"]})
+      else
+        clear_session
+        case response.code
+        when 401 then
+          raise Jiralicious::InvalidLogin.new("Invalid login")
+        when 403
+          raise Jiralicious::CaptchaRequired.new("Captacha is required. Try logging into Jira via the web interface")
+        else
+          # Give Net::HTTP reason
+          raise Jiralicious::JiraError.new(response.response.message)
+        end
+      end
+    end
+
+    def logout
+      response = perform_request do
+        self.class.delete('/rest/auth/latest/session')
+      end
+
+      if response.code == 204
+        clear_session
+      else
+        case response.code
+        when 401 then
+          raise Jiralicious::NotLoggedIn.new("Not logged in")
+        else
+          # Give Net::HTTP reason
+          raise Jiralicious::JiraError.new(response.response.message)
+        end
+      end
+    end
+
+    def perform_request(options = {}, &block)
+      self.class.base_uri Jiralicious.uri
+      self.login if require_login? && !options[:authenticating]
+
+      response = block.call
+      unless options[:authenticating]
+        if captcha_required(response)
+          raise Jiralicious::CaptchaRequired.
+            new("Captacha is required. Try logging into Jira via the web interface")
+        elsif cookie_invalid(response)
+          # Can usually be fixed by logging in again
+          clear_session
+          self.login
+          response = block.call
+          raise Jiralicious::CookieExpired if cookie_invalid(response)
+        end
+      end
+      response
+    end
+
+    private
+
+    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")
+    end
+
+    def cookie_invalid(response)
+      response.code == 401 && response.body =~ /cookie/i
+    end
+
+    def require_login?
+      !(Jiralicious.username.empty? && Jiralicious.password.empty?) && !alive?
+    end
+
+    def clear_session
+      @session = @login_info = nil
+    end
+  end
+end