jira-ruby-dmg 0.1.10

data/lib/jira/has_many_proxy.rb

@@ -0,0 +1,43 @@
+#
+# Whenever a collection from a has_many relationship is accessed, an instance
+# of this class is returned.  This instance wraps the Array of instances in
+# the collection with an extra build method, which allows new instances to be
+# built on the collection with the correct properties.
+#
+# In practice, instances of this class behave exactly like an Array.
+#
+class JIRA::HasManyProxy
+
+  attr_reader :target_class, :parent
+  attr_accessor :collection
+
+  def initialize(parent, target_class, collection = [])
+    @parent       = parent
+    @target_class = target_class
+    @collection   = collection
+  end
+
+  # Builds an instance of this class with the correct parent.
+  # For example, issue.comments.build(attrs) will initialize a
+  # comment as follows:
+  #
+  #   JIRA::Resource::Comment.new(issue.client,
+  #                               :attrs => attrs,
+  #                               :issue => issue)
+  def build(attrs = {})
+    resource = target_class.new(parent.client, :attrs => attrs, parent.to_sym => parent)
+    collection << resource
+    resource
+  end
+
+  # Forces an HTTP request to fetch all instances of the target class that
+  # are associated with the parent
+  def all
+    target_class.all(parent.client, parent.to_sym => parent)
+  end
+
+  # Delegate any missing methods to the collection that this proxy wraps
+  def method_missing(method_name, *args, &block)
+    collection.send(method_name, *args, &block)
+  end
+end

data/lib/jira/http_client.rb

@@ -0,0 +1,69 @@
+require 'json'
+require 'net/https'
+require 'cgi/cookie'
+
+module JIRA
+  class HttpClient < RequestClient
+
+    DEFAULT_OPTIONS = {
+      :username           => '',
+      :password           => ''
+    }
+
+    attr_reader :options
+
+    def initialize(options)
+      @options = DEFAULT_OPTIONS.merge(options)
+      @cookies = {}
+    end
+
+    def make_request(http_method, path, body='', headers={})
+      request = Net::HTTP.const_get(http_method.to_s.capitalize).new(path, headers)
+      request.body = body unless body.nil?
+      add_cookies(request) if options[:use_cookies]
+      request.basic_auth(@options[:username], @options[:password])
+      response = basic_auth_http_conn.request(request)
+      store_cookies(response) if options[:use_cookies]
+      response
+    end
+
+    def basic_auth_http_conn
+      http_conn(uri)
+    end
+
+    def http_conn(uri)
+      if @options[:proxy_address]
+          http_class = Net::HTTP::Proxy(@options[:proxy_address], @options[:proxy_port] ? @options[:proxy_port] : 80)
+      else
+          http_class = Net::HTTP
+      end
+      http_conn = http_class.new(uri.host, uri.port)
+      http_conn.use_ssl = @options[:use_ssl]
+      http_conn.verify_mode = @options[:ssl_verify_mode]
+      http_conn
+    end
+
+    def uri
+      uri = URI.parse(@options[:site])
+    end
+
+    private
+
+    def store_cookies(response)
+      cookies = response.get_fields('set-cookie')
+      if cookies
+        cookies.each do |cookie|
+          data = CGI::Cookie.parse(cookie)
+          data.delete('Path')
+          @cookies.merge!(data)
+        end
+      end
+    end
+
+    def add_cookies(request)
+      cookie_array = @cookies.values.map { |cookie| cookie.to_s }
+      request.add_field('Cookie', cookie_array.join('; ')) if cookie_array.any?
+      request
+    end
+  end
+end

data/lib/jira/http_error.rb

@@ -0,0 +1,16 @@
+require 'forwardable'
+module JIRA
+
+  class HTTPError < StandardError
+    extend Forwardable
+
+    def_instance_delegators :@response, :message, :code
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
+  end
+
+end

data/lib/jira/oauth_client.rb

@@ -0,0 +1,84 @@
+require 'oauth'
+require 'json'
+require 'forwardable'
+
+module JIRA
+  class OauthClient < RequestClient
+
+    DEFAULT_OPTIONS = {
+      :signature_method   => 'RSA-SHA1',
+      :request_token_path => "/plugins/servlet/oauth/request-token",
+      :authorize_path     => "/plugins/servlet/oauth/authorize",
+      :access_token_path  => "/plugins/servlet/oauth/access-token",
+      :private_key_file   => "rsakey.pem",
+      :consumer_key       => nil,
+      :consumer_secret    => nil
+    }
+
+    # This exception is thrown when the client is used before the OAuth access token
+    # has been initialized.
+    class UninitializedAccessTokenError < StandardError
+      def message
+        "init_access_token must be called before using the client"
+      end
+    end
+
+    extend Forwardable
+
+    attr_accessor :consumer
+    attr_reader :options
+
+    def_instance_delegators :@consumer, :key, :secret, :get_request_token
+
+    def initialize(options)
+      @options = DEFAULT_OPTIONS.merge(options)
+      @consumer = init_oauth_consumer(@options)
+    end
+
+    def init_oauth_consumer(options)
+      @options[:request_token_path] = @options[:context_path] + @options[:request_token_path]
+      @options[:authorize_path] = @options[:context_path] + @options[:authorize_path]
+      @options[:access_token_path] = @options[:context_path] + @options[:access_token_path]
+      OAuth::Consumer.new(@options[:consumer_key],@options[:consumer_secret],@options)
+    end
+
+    # Returns the current request token if it is set, else it creates
+    # and sets a new token.
+    def request_token
+      @request_token ||= get_request_token
+    end
+
+    # Sets the request token from a given token and secret.
+    def set_request_token(token, secret)
+      @request_token = OAuth::RequestToken.new(@consumer, token, secret)
+    end
+
+    # Initialises and returns a new access token from the params hash
+    # returned by the OAuth transaction.
+    def init_access_token(params)
+      @access_token = request_token.get_access_token(params)
+    end
+
+    # Sets the access token from a preexisting token and secret.
+    def set_access_token(token, secret)
+      @access_token = OAuth::AccessToken.new(@consumer, token, secret)
+    end
+
+    # Returns the current access token. Raises an
+    # JIRA::Client::UninitializedAccessTokenError exception if it is not set.
+    def access_token
+      raise UninitializedAccessTokenError.new unless @access_token
+      @access_token
+    end
+
+    def make_request(http_method, path, body='', headers={})
+      case http_method
+      when :delete, :get, :head
+        response = access_token.send http_method, path, headers
+      when :post, :put
+        response = access_token.send http_method, path, body, headers
+      end
+      response
+    end
+  end
+end

data/lib/jira/railtie.rb

@@ -0,0 +1,10 @@
+require 'jira'
+require 'rails'
+
+module JIRA
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/generate.rake'
+    end
+  end
+end

data/lib/jira/request_client.rb

@@ -0,0 +1,18 @@
+require 'oauth'
+require 'json'
+require 'net/https'
+
+module JIRA
+  class RequestClient
+
+    # Returns the response if the request was successful (HTTP::2xx) and
+    # raises a JIRA::HTTPError if it was not successful, with the response
+    # attached.
+
+    def request(*args)
+      response = make_request(*args)
+      raise HTTPError.new(response) unless response.kind_of?(Net::HTTPSuccess)
+      response
+    end
+  end
+end

data/lib/jira/resource/attachment.rb

@@ -0,0 +1,12 @@
+module JIRA
+  module Resource
+
+    class AttachmentFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Attachment < JIRA::Base
+      has_one :author, :class => JIRA::Resource::User
+    end
+
+  end
+end

data/lib/jira/resource/comment.rb

@@ -0,0 +1,14 @@
+module JIRA
+  module Resource
+
+    class CommentFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Comment < JIRA::Base
+      belongs_to :issue
+
+      nested_collections true
+    end
+
+  end
+end

data/lib/jira/resource/component.rb

@@ -0,0 +1,10 @@
+module JIRA
+  module Resource
+
+    class ComponentFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Component < JIRA::Base ; end
+
+  end
+end

data/lib/jira/resource/field.rb

@@ -0,0 +1,10 @@
+module JIRA
+  module Resource
+
+    class FieldFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Field < JIRA::Base ; end
+
+  end
+end

data/lib/jira/resource/filter.rb

@@ -0,0 +1,15 @@
+module JIRA
+  module Resource
+    class FilterFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Filter < JIRA::Base
+      has_one :owner, :class => JIRA::Resource::User
+
+      # Returns all the issues for this filter
+      def issues
+        Issue.jql(self.client, self.jql)
+      end
+    end
+  end
+end

data/lib/jira/resource/issue.rb

@@ -0,0 +1,76 @@
+require 'cgi'
+
+module JIRA
+  module Resource
+
+    class IssueFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Issue < JIRA::Base
+
+      has_one :reporter,  :class => JIRA::Resource::User,
+                          :nested_under => 'fields'
+      has_one :assignee,  :class => JIRA::Resource::User,
+                          :nested_under => 'fields'
+      has_one :project,   :nested_under => 'fields'
+
+      has_one :issuetype, :nested_under => 'fields'
+
+      has_one :priority,  :nested_under => 'fields'
+
+      has_one :status,    :nested_under => 'fields'
+
+      has_many :transitions
+
+      has_many :components, :nested_under => 'fields'
+
+      has_many :comments, :nested_under => ['fields','comment']
+
+      has_many :attachments, :nested_under => 'fields',
+                          :attribute_key => 'attachment'
+
+      has_many :versions, :nested_under => 'fields'
+
+      has_many :worklogs, :nested_under => ['fields','worklog']
+
+      def self.all(client)
+        response = client.get(
+          client.options[:rest_base_path] + "/search",
+          :expand => 'transitions.fields'
+        )
+        json = parse_json(response.body)
+        json['issues'].map do |issue|
+          client.Issue.build(issue)
+        end
+      end
+
+      def self.jql(client, jql, fields = nil)
+        url = client.options[:rest_base_path] + "/search?jql=" + CGI.escape(jql)
+        url += CGI.escape("&fields=#{fields.join(",")}") if fields
+        response = client.get(url)
+        json = parse_json(response.body)
+        json['issues'].map do |issue|
+          client.Issue.build(issue)
+        end
+      end
+
+      def respond_to?(method_name)
+        if attrs.keys.include?('fields') && attrs['fields'].keys.include?(method_name.to_s)
+          true
+        else
+          super(method_name)
+        end
+      end
+
+      def method_missing(method_name, *args, &block)
+        if attrs.keys.include?('fields') && attrs['fields'].keys.include?(method_name.to_s)
+          attrs['fields'][method_name.to_s]
+        else
+          super(method_name)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/jira/resource/issuetype.rb

@@ -0,0 +1,10 @@
+module JIRA
+  module Resource
+
+    class IssuetypeFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Issuetype < JIRA::Base ; end
+
+  end
+end

data/lib/jira/resource/priority.rb

@@ -0,0 +1,10 @@
+module JIRA
+  module Resource
+
+    class PriorityFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Priority < JIRA::Base ; end
+
+  end
+end

data/lib/jira/resource/project.rb

@@ -0,0 +1,31 @@
+module JIRA
+  module Resource
+
+    class ProjectFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Project < JIRA::Base
+
+      has_one :lead, :class => JIRA::Resource::User
+      has_many :components
+      has_many :issuetypes, :attribute_key => 'issueTypes'
+      has_many :versions
+
+      def self.key_attribute
+        :key
+      end
+
+      # Returns all the issues for this project
+      def issues(options={})
+        search_url = client.options[:rest_base_path] + '/search'
+        query_params = {:jql => "project=\"#{key}\""}
+        query_params.update Base.query_params_for_search(options)
+        response = client.get(url_with_query_params(search_url, query_params))
+        json = self.class.parse_json(response.body)
+        json['issues'].map do |issue|
+          client.Issue.build(issue)
+        end
+      end
+    end
+  end
+end

data/lib/jira/resource/status.rb

@@ -0,0 +1,10 @@
+module JIRA
+  module Resource
+
+    class StatusFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Status < JIRA::Base ; end
+
+  end
+end

data/lib/jira/resource/transition.rb

@@ -0,0 +1,33 @@
+module JIRA
+  module Resource
+
+    class TransitionFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Transition < JIRA::Base
+      has_one :to, :class => JIRA::Resource::Status
+      belongs_to :issue
+
+      nested_collections true
+
+      def self.endpoint_name
+        'transitions'
+      end
+
+      def self.all(client, options = {})
+        issue = options[:issue]
+        unless issue
+          raise ArgumentError.new("parent issue is required")
+        end
+
+        path = "#{issue.self}/#{endpoint_name}?expand=transitions.fields"
+        response = client.get(path)
+        json = parse_json(response.body)
+        json['transitions'].map do |transition|
+          issue.transitions.build(transition)
+        end
+      end
+    end
+
+  end
+end

data/lib/jira/resource/user.rb

@@ -0,0 +1,14 @@
+module JIRA
+  module Resource
+
+    class UserFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class User < JIRA::Base
+      def self.singular_path(client, key, prefix = '/')
+        collection_path(client, prefix) + '?username=' + key
+      end
+    end
+
+  end
+end

data/lib/jira/resource/version.rb

@@ -0,0 +1,10 @@
+module JIRA
+  module Resource
+
+    class VersionFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Version < JIRA::Base ; end
+
+  end
+end

data/lib/jira/resource/worklog.rb

@@ -0,0 +1,16 @@
+module JIRA
+  module Resource
+
+    class WorklogFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Worklog < JIRA::Base
+      has_one :author, :class => JIRA::Resource::User
+      has_one :update_author, :class => JIRA::Resource::User,
+                              :attribute_key => "updateAuthor"
+      belongs_to :issue
+      nested_collections true
+    end
+
+  end
+end

data/lib/jira/version.rb

@@ -0,0 +1,3 @@
+module JIRA
+  VERSION = "0.1.10"
+end

data/lib/jira.rb

@@ -0,0 +1,33 @@
+$: << File.expand_path(File.dirname(__FILE__))
+
+require 'active_support/inflector'
+ActiveSupport::Inflector.inflections do |inflector|
+  inflector.singular 'status', 'status'
+end
+
+require 'jira/base'
+require 'jira/base_factory'
+require 'jira/has_many_proxy'
+require 'jira/http_error'
+
+require 'jira/resource/user'
+require 'jira/resource/attachment'
+require 'jira/resource/component'
+require 'jira/resource/issuetype'
+require 'jira/resource/version'
+require 'jira/resource/status'
+require 'jira/resource/transition'
+require 'jira/resource/project'
+require 'jira/resource/priority'
+require 'jira/resource/comment'
+require 'jira/resource/worklog'
+require 'jira/resource/issue'
+require 'jira/resource/filter'
+require 'jira/resource/field'
+
+require 'jira/request_client'
+require 'jira/oauth_client'
+require 'jira/http_client'
+require 'jira/client'
+
+require 'jira/railtie' if defined?(Rails)

data/lib/tasks/generate.rake

@@ -0,0 +1,18 @@
+require 'securerandom'
+
+namespace :jira do
+  desc "Generate a consumer key for your application"
+  task :generate_consumer_key do
+    key = SecureRandom.hex(16)
+    puts "You can use this as your consumer key: #{key}"
+  end
+
+  desc "Run the system call to generate a RSA public certificate"
+  task :generate_public_cert do
+    puts "Executing 'openssl req -x509 -nodes -newkey rsa:1024 -sha1 -keyout rsakey.pem -out rsacert.pem'"
+    system('openssl req -x509 -subj "/C=US/ST=New York/L=New York/O=SUMO Heavy Industries/CN=www.sumoheavy.com" -nodes -newkey rsa:1024 -sha1 -keyout rsakey.pem -out rsacert.pem')
+    puts "Done. The RSA-SHA1 private keyfile is in the current directory: \'rsakey.pem\'."
+    puts "You will need to copy the following certificate into your application link configuration in Jira:"
+    system("cat rsacert.pem")
+  end
+end

data/spec/integration/attachment_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Attachment do
+
+  with_each_client do |site_url, client|
+    let(:client) { client }
+    let(:site_url) { site_url }
+
+    let(:key) { "10000" }
+
+    let(:expected_attributes) do
+      {
+        'self' => "http://localhost:2990/jira/rest/api/2/attachment/10000",
+        'size' => 15360,
+        'filename' => "ballmer.png"
+      }
+    end
+
+    it_should_behave_like "a resource"
+    it_should_behave_like "a resource with a singular GET endpoint"
+    it_should_behave_like "a resource with a DELETE endpoint"
+  end
+end

data/spec/integration/comment_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Comment do
+
+  with_each_client do |site_url, client|
+    let(:client) { client }
+    let(:site_url) { site_url }
+
+    let(:key) { "10000" }
+
+    let(:target) { JIRA::Resource::Comment.new(client, :attrs => {'id' => '99999'}, :issue_id => '54321') }
+
+    let(:expected_collection_length) { 2 }
+
+    let(:belongs_to) {
+      JIRA::Resource::Issue.new(client, :attrs => {
+        'id' => '10002',
+        'fields' => {
+          'comment' => {'comments' => []}
+        }
+      })
+    }
+
+    let(:expected_attributes) do
+      {
+        'self' => "http://localhost:2990/jira/rest/api/2/issue/10002/comment/10000",
+        'id'   => key,
+        'body' => "This is a comment. Creative."
+      }
+    end
+
+    let(:attributes_for_post) {
+      { "body" => "new comment" }
+    }
+    let(:expected_attributes_from_post) {
+      { "id" => "10001", "body" => "new comment"}
+    }
+
+    let(:attributes_for_put) {
+      {"body" => "new body"}
+    }
+    let(:expected_attributes_from_put) {
+      { "id" => "10000", "body" => "new body" }
+    }
+
+    it_should_behave_like "a resource"
+    it_should_behave_like "a resource with a collection GET endpoint"
+    it_should_behave_like "a resource with a singular GET endpoint"
+    it_should_behave_like "a resource with a DELETE endpoint"
+    it_should_behave_like "a resource with a POST endpoint"
+    it_should_behave_like "a resource with a PUT endpoint"
+
+  end
+
+end