jira-ruby-dmg 0.1.10

data/lib/jira/base.rb

@@ -0,0 +1,497 @@
+require 'active_support/core_ext/string'
+require 'active_support/inflector'
+require 'set'
+
+module JIRA
+
+  # This class provides the basic object <-> REST mapping for all JIRA::Resource subclasses,
+  # i.e. the Create, Retrieve, Update, Delete lifecycle methods.
+  #
+  # == Lifecycle methods
+  #
+  # Note that not all lifecycle
+  # methods are available for all resources, for example some resources cannot be updated
+  # or deleted.
+  #
+  # === Retrieving all resources
+  #
+  #   client.Resource.all
+  #
+  # === Retrieving a single resource
+  #
+  #   client.Resource.find(id)
+  #
+  # === Creating a resource
+  #
+  #   resource = client.Resource.build({'name' => '')
+  #   resource.save
+  #
+  # === Updating a resource
+  #
+  #   resource = client.Resource.find(id)
+  #   resource.save('updated_attribute' => 'new value')
+  #
+  # === Deleting a resource
+  #
+  #   resource = client.Resource.find(id)
+  #   resource.delete
+  #
+  # == Nested resources
+  #
+  # Some resources are not defined in the top level of the URL namespace
+  # within the JIRA API, but are always nested under the context of another
+  # resource.  For example, a JIRA::Resource::Comment always belongs to a
+  # JIRA::Resource::Issue.
+  #
+  # These resources must be indexed and built from an instance of the class
+  # they are nested under:
+  #
+  #   issue = client.Issue.find(id)
+  #   comments = issue.comments
+  #   new_comment = issue.comments.build
+  #
+  class Base
+    QUERY_PARAMS_FOR_SINGLE_FETCH = Set.new [:expand, :fields]
+    QUERY_PARAMS_FOR_SEARCH = Set.new [:expand, :fields, :startAt, :maxResults]
+
+    # A reference to the JIRA::Client used to initialize this resource.
+    attr_reader :client
+
+    # Returns true if this instance has been fetched from the server
+    attr_accessor :expanded
+
+    # Returns true if this instance has been deleted from the server
+    attr_accessor :deleted
+
+    # The hash of attributes belonging to this instance.  An exact
+    # representation of the JSON returned from the JIRA API
+    attr_accessor :attrs
+
+    alias :expanded? :expanded
+    alias :deleted? :deleted
+
+    def initialize(client, options = {})
+      @client   = client
+      @attrs    = options[:attrs] || {}
+      @expanded = options[:expanded] || false
+      @deleted  = false
+
+      # If this class has any belongs_to relationships, a value for
+      # each of them must be passed in to the initializer.
+      self.class.belongs_to_relationships.each do |relation|
+        if options[relation]
+          instance_variable_set("@#{relation.to_s}", options[relation])
+          instance_variable_set("@#{relation.to_s}_id", options[relation].key_value)
+        elsif options["#{relation}_id".to_sym]
+          instance_variable_set("@#{relation.to_s}_id", options["#{relation}_id".to_sym])
+        else
+          raise ArgumentError.new("Required option #{relation.inspect} missing") unless options[relation]
+        end
+      end
+    end
+
+    # The class methods are never called directly, they are always
+    # invoked from a BaseFactory subclass instance.
+    def self.all(client, options = {})
+      response = client.get(collection_path(client))
+      json = parse_json(response.body)
+      if collection_attributes_are_nested
+        json = json[endpoint_name.pluralize]
+      end
+      json.map do |attrs|
+        self.new(client, {:attrs => attrs}.merge(options))
+      end
+    end
+
+    # Finds and retrieves a resource with the given ID.
+    def self.find(client, key, options = {})
+      instance = self.new(client, options)
+      instance.attrs[key_attribute.to_s] = key
+      instance.fetch(false, query_params_for_single_fetch(options))
+      instance
+    end
+
+    # Builds a new instance of the resource with the given attributes.
+    # These attributes will be posted to the JIRA Api if save is called.
+    def self.build(client, attrs)
+      self.new(client, :attrs => attrs)
+    end
+
+    # Returns the name of this resource for use in URL components.
+    # E.g.
+    #   JIRA::Resource::Issue.endpoint_name
+    #     # => issue
+    def self.endpoint_name
+      self.name.split('::').last.downcase
+    end
+
+    # Returns the full path for a collection of this resource.
+    # E.g.
+    #   JIRA::Resource::Issue.collection_path
+    #     # => /jira/rest/api/2/issue
+    def self.collection_path(client, prefix = '/')
+      client.options[:rest_base_path] + prefix + self.endpoint_name
+    end
+
+    # Returns the singular path for the resource with the given key.
+    # E.g.
+    #   JIRA::Resource::Issue.singular_path('123')
+    #     # => /jira/rest/api/2/issue/123
+    #
+    # If a prefix parameter is provided it will be injected between the base
+    # path and the endpoint.
+    # E.g.
+    #   JIRA::Resource::Comment.singular_path('456','/issue/123/')
+    #     # => /jira/rest/api/2/issue/123/comment/456
+    def self.singular_path(client, key, prefix = '/')
+      collection_path(client, prefix) + '/' + key
+    end
+
+    # Returns the attribute name of the attribute used for find.
+    # Defaults to :id unless overridden.
+    def self.key_attribute
+      :id
+    end
+
+    def self.parse_json(string) # :nodoc:
+      JSON.parse(string)
+    end
+
+    # Declares that this class contains a singular instance of another resource
+    # within the JSON returned from the JIRA API.
+    #
+    #   class Example < JIRA::Base
+    #     has_one :child
+    #   end
+    #
+    #   example = client.Example.find(1)
+    #   example.child # Returns a JIRA::Resource::Child
+    #
+    # The following options can be used to override the default behaviour of the
+    # relationship:
+    #
+    # [:attribute_key]  The relationship will by default reference a JSON key on the
+    #                   object with the same name as the relationship.
+    #
+    #                     has_one :child # => {"id":"123",{"child":{"id":"456"}}}
+    #
+    #                   Use this option if the key in the JSON is named differently.
+    #
+    #                     # Respond to resource.child, but return the value of resource.attrs['kid']
+    #                     has_one :child, :attribute_key => 'kid' # => {"id":"123",{"kid":{"id":"456"}}}
+    #
+    # [:class]          The class of the child instance will be inferred from the name of the
+    #                   relationship. E.g. <tt>has_one :child</tt> will return a <tt>JIRA::Resource::Child</tt>.
+    #                   Use this option to override the inferred class.
+    #
+    #                     has_one :child, :class => JIRA::Resource::Kid
+    # [:nested_under]   In some cases, the JSON return from JIRA is nested deeply for particular
+    #                   relationships.  This option allows the nesting to be specified.
+    #
+    #                     # Specify a single depth of nesting.
+    #                     has_one :child, :nested_under => 'foo'
+    #                       # => Looks for {"foo":{"child":{}}}
+    #                     # Specify deeply nested JSON
+    #                     has_one :child, :nested_under => ['foo', 'bar', 'baz']
+    #                       # => Looks for {"foo":{"bar":{"baz":{"child":{}}}}}
+    def self.has_one(resource, options = {})
+      attribute_key = options[:attribute_key] || resource.to_s
+      child_class = options[:class] || ('JIRA::Resource::' + resource.to_s.classify).constantize
+      define_method(resource) do
+        attribute = maybe_nested_attribute(attribute_key, options[:nested_under])
+        return nil unless attribute
+        child_class.new(client, :attrs => attribute)
+      end
+    end
+
+    # Declares that this class contains a collection of another resource
+    # within the JSON returned from the JIRA API.
+    #
+    #   class Example < JIRA::Base
+    #     has_many :children
+    #   end
+    #
+    #   example = client.Example.find(1)
+    #   example.children # Returns an instance of Jira::Resource::HasManyProxy,
+    #                    # which behaves exactly like an array of
+    #                    # Jira::Resource::Child
+    #
+    # The following options can be used to override the default behaviour of the
+    # relationship:
+    #
+    # [:attribute_key]  The relationship will by default reference a JSON key on the
+    #                   object with the same name as the relationship.
+    #
+    #                     has_many :children # => {"id":"123",{"children":[{"id":"456"},{"id":"789"}]}}
+    #
+    #                   Use this option if the key in the JSON is named differently.
+    #
+    #                     # Respond to resource.children, but return the value of resource.attrs['kids']
+    #                     has_many :children, :attribute_key => 'kids' # => {"id":"123",{"kids":[{"id":"456"},{"id":"789"}]}}
+    #
+    # [:class]          The class of the child instance will be inferred from the name of the
+    #                   relationship. E.g. <tt>has_many :children</tt> will return an instance
+    #                   of <tt>JIRA::Resource::HasManyProxy</tt> containing the collection of
+    #                   <tt>JIRA::Resource::Child</tt>.
+    #                   Use this option to override the inferred class.
+    #
+    #                     has_many :children, :class => JIRA::Resource::Kid
+    # [:nested_under]   In some cases, the JSON return from JIRA is nested deeply for particular
+    #                   relationships.  This option allows the nesting to be specified.
+    #
+    #                     # Specify a single depth of nesting.
+    #                     has_many :children, :nested_under => 'foo'
+    #                       # => Looks for {"foo":{"children":{}}}
+    #                     # Specify deeply nested JSON
+    #                     has_many :children, :nested_under => ['foo', 'bar', 'baz']
+    #                       # => Looks for {"foo":{"bar":{"baz":{"children":{}}}}}
+    def self.has_many(collection, options = {})
+      attribute_key = options[:attribute_key] || collection.to_s
+      child_class = options[:class] || ('JIRA::Resource::' + collection.to_s.classify).constantize
+      self_class_basename = self.name.split('::').last.downcase.to_sym
+      define_method(collection) do
+        child_class_options = {self_class_basename => self}
+        attribute = maybe_nested_attribute(attribute_key, options[:nested_under]) || []
+        collection = attribute.map do |child_attributes|
+          child_class.new(client, child_class_options.merge(:attrs => child_attributes))
+        end
+        HasManyProxy.new(self, child_class, collection)
+      end
+    end
+
+    def self.belongs_to_relationships
+      @belongs_to_relationships ||= []
+    end
+
+    def self.belongs_to(resource)
+      belongs_to_relationships.push(resource)
+      attr_reader resource
+      attr_reader "#{resource}_id"
+    end
+
+    def self.collection_attributes_are_nested
+      @collection_attributes_are_nested ||= false
+    end
+
+    def self.nested_collections(value)
+      @collection_attributes_are_nested = value
+    end
+
+    def id
+      attrs['id']
+    end
+
+    # Returns a symbol for the given instance, for example
+    # JIRA::Resource::Issue returns :issue
+    def to_sym
+      self.class.endpoint_name.to_sym
+    end
+
+    # Checks if method_name is set in the attributes hash
+    # and returns true when found, otherwise proxies the
+    # call to the superclass.
+    def respond_to?(method_name)
+      if attrs.keys.include? method_name.to_s
+        true
+      else
+        super(method_name)
+      end
+    end
+
+    # Overrides method_missing to check the attribute hash
+    # for resources matching method_name and proxies the call
+    # to the superclass if no match is found.
+    def method_missing(method_name, *args, &block)
+      if attrs.keys.include? method_name.to_s
+        attrs[method_name.to_s]
+      else
+        super(method_name)
+      end
+    end
+
+    # Each resource has a unique key attribute, this method returns the value
+    # of that key for this instance.
+    def key_value
+      @attrs[self.class.key_attribute.to_s]
+    end
+
+    def collection_path(prefix = "/")
+      # Just proxy this to the class method
+      self.class.collection_path(client, prefix)
+    end
+
+    # This returns the URL path component that is specific to this instance,
+    # for example for Issue id 123 it returns '/issue/123'.  For an unsaved
+    # issue it returns '/issue'
+    def path_component
+      path_component = "/#{self.class.endpoint_name}"
+      if key_value
+        path_component += '/' + key_value
+      end
+      path_component
+    end
+
+    # Fetches the attributes for the specified resource from JIRA unless
+    # the resource is already expanded and the optional force reload flag
+    # is not set
+    def fetch(reload = false, query_params = {})
+      return if expanded? && !reload
+      response = client.get(url_with_query_params(url, query_params))
+      set_attrs_from_response(response)
+      @expanded = true
+    end
+
+    # Saves the specified resource attributes by sending either a POST or PUT
+    # request to JIRA, depending on resource.new_record?
+    #
+    # Accepts an attributes hash of the values to be saved.  Will throw a
+    # JIRA::HTTPError if the request fails (response is not HTTP 2xx).
+    def save!(attrs)
+      http_method = new_record? ? :post : :put
+      response = client.send(http_method, url, attrs.to_json)
+      set_attrs(attrs, false)
+      set_attrs_from_response(response)
+      @expanded = false
+      true
+    end
+
+    # Saves the specified resource attributes by sending either a POST or PUT
+    # request to JIRA, depending on resource.new_record?
+    #
+    # Accepts an attributes hash of the values to be saved. Will return false
+    # if the request fails.
+    def save(attrs)
+      begin
+        save_status = save!(attrs)
+      rescue JIRA::HTTPError => exception
+        set_attrs_from_response(exception.response) rescue JSON::ParserError  # Merge error status generated by JIRA REST API
+        save_status = false
+      end
+      save_status
+    end
+
+    # Sets the attributes hash from a HTTPResponse object from JIRA if it is
+    # not nil or is not a json response.
+    def set_attrs_from_response(response)
+      unless response.body.nil? or response.body.length < 2
+        json = self.class.parse_json(response.body)
+        set_attrs(json)
+      end
+    end
+
+    # Set the current attributes from a hash.  If clobber is true, any existing
+    # hash values will be clobbered by the new hash, otherwise the hash will
+    # be deeply merged into attrs.  The target paramater is for internal use only
+    # and should not be used.
+    def set_attrs(hash, clobber=true, target = nil)
+      target ||= @attrs
+      if clobber
+        target.merge!(hash)
+        hash
+      else
+        hash.each do |k, v|
+          if v.is_a?(Hash)
+            set_attrs(v, clobber, target[k])
+          else
+            target[k] = v
+          end
+        end
+      end
+    end
+
+    # Sends a delete request to the JIRA Api and sets the deleted instance
+    # variable on the object to true.
+    def delete
+      client.delete(url)
+      @deleted = true
+    end
+
+    def has_errors?
+      respond_to?('errors')
+    end
+
+    def url
+      prefix = '/'
+      unless self.class.belongs_to_relationships.empty?
+        prefix = self.class.belongs_to_relationships.inject(prefix) do |prefix_so_far, relationship|
+          prefix_so_far + relationship.to_s + "/" + self.send("#{relationship.to_s}_id") + '/'
+        end
+      end
+      if @attrs['self']
+        @attrs['self'].sub(@client.options[:site],'')
+      elsif key_value
+        self.class.singular_path(client, key_value.to_s, prefix)
+      else
+        self.class.collection_path(client, prefix)
+      end
+    end
+
+    def to_s
+      "#<#{self.class.name}:#{object_id} @attrs=#{@attrs.inspect}>"
+    end
+
+    # Returns a JSON representation of the current attributes hash.
+    def to_json
+      attrs.to_json
+    end
+
+    # Determines if the resource is newly created by checking whether its
+    # key_value is set. If it is nil, the record is new and the method
+    # will return true.
+    def new_record?
+      key_value.nil?
+    end
+
+    protected
+
+    # This allows conditional lookup of possibly nested attributes.  Example usage:
+    #
+    #   maybe_nested_attribute('foo')                 # => @attrs['foo']
+    #   maybe_nested_attribute('foo', 'bar')          # => @attrs['bar']['foo']
+    #   maybe_nested_attribute('foo', ['bar', 'baz']) # => @attrs['bar']['baz']['foo']
+    #
+    def maybe_nested_attribute(attribute_name, nested_under = nil)
+      self.class.maybe_nested_attribute(@attrs, attribute_name, nested_under)
+    end
+
+    def self.maybe_nested_attribute(attributes, attribute_name, nested_under = nil)
+      return attributes[attribute_name] if nested_under.nil?
+      if nested_under.instance_of? Array
+        final = nested_under.inject(attributes) do |parent, key|
+          break if parent.nil?
+          parent[key]
+        end
+        return nil if final.nil?
+        final[attribute_name]
+      else
+        return attributes[nested_under][attribute_name]
+      end
+    end
+
+    def url_with_query_params(url, query_params)
+      if not query_params.empty?
+        "#{url}?#{hash_to_query_string query_params}"
+      else
+        url
+      end
+    end
+
+    def hash_to_query_string(query_params)
+      query_params.map do |k,v|
+        CGI.escape(k.to_s) + "=" + CGI.escape(v.to_s)
+      end.join('&')
+    end
+
+    def self.query_params_for_single_fetch(options)
+      Hash[options.select do |k,v|
+        QUERY_PARAMS_FOR_SINGLE_FETCH.include? k
+      end]
+    end
+
+    def self.query_params_for_search(options)
+      Hash[options.select do |k,v|
+        QUERY_PARAMS_FOR_SEARCH.include? k
+      end]
+    end
+  end
+end

data/lib/jira/base_factory.rb

@@ -0,0 +1,49 @@
+module JIRA
+
+  # This is the base class for all the JIRA resource factory instances.
+  class BaseFactory
+
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Return the name of the class which this factory generates, i.e. 
+    # JIRA::Resource::FooFactory creates JIRA::Resource::Foo instances.
+    def target_class
+      # Need to do a little bit of work here as Module.const_get doesn't work
+      # with nested class names, i.e. JIRA::Resource::Foo.
+      #
+      # So create a method chain from the class componenets.  This code will
+      # unroll to:
+      #   Module.const_get('JIRA').const_get('Resource').const_get('Foo')
+      #
+      target_class_name = self.class.name.sub(/Factory$/, '')
+      class_components = target_class_name.split('::')
+
+      class_components.inject(Module) do |mod, const_name|
+        mod.const_get(const_name)
+      end
+    end
+
+    def self.delegate_to_target_class(*method_names)
+      method_names.each do |method_name|
+        define_method method_name do |*args|
+          target_class.send(method_name, @client, *args)
+        end
+      end
+    end
+
+    # The priciple purpose of this class is to delegate methods to the corresponding
+    # non-factory class and automatically prepend the client argument to the argument
+    # list.
+    delegate_to_target_class :all, :find, :collection_path, :singular_path, :jql
+
+    # This method needs special handling as it has a default argument value
+    def build(attrs={})
+      target_class.build(@client, attrs)
+    end
+
+  end
+end

data/lib/jira/client.rb

@@ -0,0 +1,165 @@
+require 'json'
+require 'forwardable'
+
+module JIRA
+
+  # This class is the main access point for all JIRA::Resource instances.
+  #
+  # The client must be initialized with an options hash containing
+  # configuration options.  The available options are:
+  #
+  #   :site               => 'http://localhost:2990',
+  #   :context_path       => '/jira',
+  #   :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",
+  #   :rest_base_path     => "/rest/api/2",
+  #   :consumer_key       => nil,
+  #   :consumer_secret    => nil,
+  #   :ssl_verify_mode    => OpenSSL::SSL::VERIFY_PEER,
+  #   :use_ssl            => true,
+  #   :username           => nil,
+  #   :password           => nil,
+  #   :auth_type          => :oauth
+  #   :proxy_address      => nil
+  #   :proxy_port         => nil
+  #
+  # See the JIRA::Base class methods for all of the available methods on these accessor
+  # objects.
+
+  class Client
+
+    extend Forwardable
+
+    # The OAuth::Consumer instance returned by the OauthClient
+    #
+    # The authenticated client instance returned by the respective client type
+    # (Oauth, Basic)
+    attr_accessor :consumer, :request_client
+
+    # The configuration options for this client instance
+    attr_reader :options
+
+    def_delegators :@request_client, :init_access_token, :set_access_token, :set_request_token, :request_token, :access_token
+
+    DEFAULT_OPTIONS = {
+      :site               => 'http://localhost:2990',
+      :context_path       => '/jira',
+      :rest_base_path     => "/rest/api/2",
+      :ssl_verify_mode    => OpenSSL::SSL::VERIFY_PEER,
+      :use_ssl            => true,
+      :auth_type          => :oauth
+    }
+
+    def initialize(options={})
+      options = DEFAULT_OPTIONS.merge(options)
+      @options = options
+      @options[:rest_base_path] = @options[:context_path] + @options[:rest_base_path]
+
+      case options[:auth_type]
+      when :oauth
+        @request_client = OauthClient.new(@options)
+        @consumer = @request_client.consumer
+      when :basic
+        @request_client = HttpClient.new(@options)
+      end
+
+      @options.freeze
+    end
+
+    def Project # :nodoc:
+      JIRA::Resource::ProjectFactory.new(self)
+    end
+
+    def Issue # :nodoc:
+      JIRA::Resource::IssueFactory.new(self)
+    end
+
+    def Filter # :nodoc:
+      JIRA::Resource::FilterFactory.new(self)
+    end
+
+    def Component # :nodoc:
+      JIRA::Resource::ComponentFactory.new(self)
+    end
+
+    def User # :nodoc:
+      JIRA::Resource::UserFactory.new(self)
+    end
+
+    def Issuetype # :nodoc:
+      JIRA::Resource::IssuetypeFactory.new(self)
+    end
+
+    def Priority # :nodoc:
+      JIRA::Resource::PriorityFactory.new(self)
+    end
+
+    def Status # :nodoc:
+      JIRA::Resource::StatusFactory.new(self)
+    end
+
+    def Comment # :nodoc:
+      JIRA::Resource::CommentFactory.new(self)
+    end
+
+    def Attachment # :nodoc:
+      JIRA::Resource::AttachmentFactory.new(self)
+    end
+
+    def Worklog # :nodoc:
+      JIRA::Resource::WorklogFactory.new(self)
+    end
+
+    def Version # :nodoc:
+      JIRA::Resource::VersionFactory.new(self)
+    end
+
+    def Transition # :nodoc:
+      JIRA::Resource::TransitionFactory.new(self)
+    end
+
+    def Field # :nodoc:
+      JIRA::Resource::FieldFactory.new(self)
+    end
+
+    # HTTP methods without a body
+    def delete(path, headers = {})
+      request(:delete, path, nil, merge_default_headers(headers))
+    end
+
+    def get(path, headers = {})
+      request(:get, path, nil, merge_default_headers(headers))
+    end
+
+    def head(path, headers = {})
+      request(:head, path, nil, merge_default_headers(headers))
+    end
+
+    # HTTP methods with a body
+    def post(path, body = '', headers = {})
+      headers = {'Content-Type' => 'application/json'}.merge(headers)
+      request(:post, path, body, merge_default_headers(headers))
+    end
+
+    def put(path, body = '', headers = {})
+      headers = {'Content-Type' => 'application/json'}.merge(headers)
+      request(:put, path, body, merge_default_headers(headers))
+    end
+
+    # Sends the specified HTTP request to the REST API through the
+    # appropriate method (oauth, basic).
+    def request(http_method, path, body = '', headers={})
+      @request_client.request(http_method, path, body, headers)
+    end
+
+    protected
+
+      def merge_default_headers(headers)
+        {'Accept' => 'application/json'}.merge(headers)
+      end
+
+  end
+end