jira-ruby 3.0.0.beta1 → 3.0.0.beta2

data/lib/jira/oauth_client.rb

@@ -5,7 +5,16 @@ require 'json'
 require 'forwardable'
 
 module JIRA
+  # Client using OAuth 1.0
+  #
+  # @!attribute [rw] consumer
+  #   @return [OAuth::Consumer] The oauth consumer object
+  # @!attribute [r] options
+  #   @return [Hash] The oauth connection options
+  # @!attribute [r] access_token
+  #   @return [OAuth::AccessToken] The oauth access token
   class OauthClient < RequestClient
+    # @private
     DEFAULT_OPTIONS = {
       signature_method: 'RSA-SHA1',
       request_token_path: '/plugins/servlet/oauth/request-token',
@@ -31,11 +40,29 @@ module JIRA
 
     def_instance_delegators :@consumer, :key, :secret, :get_request_token
 
+    # Generally not used directly, but through JIRA::Client.
+    # @param [Hash] options Options as passed from JIRA::Client constructor.
+    # @option options [String] :signature_method The signature method to use (defaults to 'RSA-SHA1')
+    # @option options [String] :request_token_path The path to request a token (defaults to '/plugins/servlet/oauth/request-token')
+    # @option options [String] :authorize_path The path to authorize a token (defaults to '/plugins/servlet/oauth/authorize')
+    # @option options [String] :access_token_path The path to access a token (defaults to '/plugins/servlet/oauth/access-token')
+    # @option options [String] :private_key_file The path to the private key file
+    # @option options [String] :consumer_key The OAuth 1.0 consumer key
+    # @option options [String] :consumer_secret The OAuth 1.0 consumer secret
+    # @option options [Hash] :default_headers Additional headers for requests
+    # @option options [String] :proxy_uri Proxy URI
+    # @option options [String] :proxy_user Proxy user
+    # @option options [String] :proxy_password Proxy Password
     def initialize(options)
       @options = DEFAULT_OPTIONS.merge(options)
       @consumer = init_oauth_consumer(@options)
     end
 
+    # @private
+    # Initialises the OAuth consumer object.
+    # Generally you should not call this method directly, it is called by the constructor.
+    # @param [Hash] _options The options hash
+    # @return [OAuth::Consumer] The OAuth consumer object
     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]
@@ -47,22 +74,31 @@ module JIRA
 
     # Returns the current request token if it is set, else it creates
     # and sets a new token.
+    # @param [Hash] options
     def request_token(options = {}, ...)
       @request_token ||= get_request_token(options, ...)
     end
 
     # Sets the request token from a given token and secret.
+    # @param [String] token The request token
+    # @param [String] secret The request token secret
+    # @return [OAuth::RequestToken] The request token object
     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.
+    # @param [Hash] params The params hash returned by the OAuth transaction
+    # @return [OAuth::AccessToken] The access token object
     def init_access_token(params)
       @access_token = request_token.get_access_token(params)
     end
 
     # Sets the access token from a preexisting token and secret.
+    # @param [String] token The access token
+    # @param [String] secret The access token secret
+    # @return [OAuth::AccessToken] The access token object
     def set_access_token(token, secret)
       @access_token = OAuth::AccessToken.new(@consumer, token, secret)
       @authenticated = true
@@ -71,12 +107,25 @@ module JIRA
 
     # Returns the current access token. Raises an
     # JIRA::Client::UninitializedAccessTokenError exception if it is not set.
+    # @return [OAuth::AccessToken] The access token object
     def access_token
       raise UninitializedAccessTokenError unless @access_token
 
       @access_token
     end
 
+    # Makes a request to the JIRA server using the oauth gem.
+    #
+    # Generally you should not call this method directly, but use the helper methods in JIRA::Client.
+    #
+    # File uploads are not supported with this method.  Use make_multipart_request instead.
+    #
+    # @param [Symbol] http_method The HTTP method to use
+    # @param [String] url The JIRA REST URL to call
+    # @param [String] body The body of the request
+    # @param [Hash] headers The headers to send with the request
+    # @return [Net::HTTPResponse] The response object
+    # @raise [JIRA::HTTPError] If the response is not an HTTP success code
     def make_request(http_method, url, body = '', headers = {})
       # When using oauth_2legged we need to add an empty oauth_token parameter to every request.
       if @options[:auth_type] == :oauth_2legged
@@ -100,6 +149,17 @@ module JIRA
       response
     end
 
+    # Makes a multipart request to the JIRA server using the oauth gem.
+    #
+    # This is used for file uploads.
+    #
+    # Generally you should not call this method directly, but use the helper methods in JIRA::Client.
+    #
+    # @param [String] url The JIRA REST URL to call
+    # @param [Hash] data The Net::HTTP::Post::Multipart data to send with the request
+    # @param [Hash] headers The headers to send with the request
+    # @return [Net::HTTPResponse] The response object
+    # @raise [JIRA::HTTPError] If the response is not an HTTP success code
     def make_multipart_request(url, data, headers = {})
       request = Net::HTTP::Post::Multipart.new url, data, headers
 
@@ -110,6 +170,8 @@ module JIRA
       response
     end
 
+    # Returns true if the client is authenticated.
+    # @return [Boolean] True if the client is authenticated
     def authenticated?
       @authenticated
     end

data/lib/jira/request_client.rb

@@ -5,11 +5,21 @@ require 'json'
 require 'net/https'
 
 module JIRA
+  # Base class for request clients specific to a particular authentication method.
   class RequestClient
+    # Makes the JIRA REST API call.
+    #
     # Returns the response if the request was successful (HTTP::2xx) and
     # raises a JIRA::HTTPError if it was not successful, with the response
     # attached.
-
+    #
+    # Generally you should not call this method directly, but use derived classes.
+    #
+    # File uploads are not supported with this method.  Use request_multipart instead.
+    #
+    # @param [Array] args Arguments to pass to the request method
+    # @return [Net::HTTPResponse] The response from the server
+    # @raise [JIRA::HTTPError] if it was not successful
     def request(*args)
       response = make_request(*args)
       raise HTTPError, response unless response.is_a?(Net::HTTPSuccess)
@@ -17,6 +27,15 @@ module JIRA
       response
     end
 
+    # Makes a multipart request to the JIRA server.
+    #
+    # This is used for file uploads.
+    #
+    # Generally you should not call this method directly, but use derived classes.
+    #
+    # @param [Array] args Arguments to pass to the request method
+    # @return [Net::HTTPResponse] The response from the server
+    # @raise [JIRA::HTTPError] if it was not successful
     def request_multipart(*args)
       response = make_multipart_request(*args)
       raise HTTPError, response unless response.is_a?(Net::HTTPSuccess)
@@ -24,10 +43,16 @@ module JIRA
       response
     end
 
+    # Abstract method to make a request to the JIRA server.
+    # @abstract
+    # @param [Array] args Arguments to pass to the request method
     def make_request(*args)
       raise NotImplementedError
     end
 
+    # Abstract method to make a request to the JIRA server with a file upload.
+    # @abstract
+    # @param [Array] args Arguments to pass to the request method
     def make_multipart_request(*args)
       raise NotImplementedError
     end

data/lib/jira/resource/attachment.rb

@@ -9,14 +9,85 @@ module JIRA
       delegate_to_target_class :meta
     end
 
+    # This class provides the Attachment object <-> REST mapping for JIRA::Resource::Attachment derived class,
+    # i.e. the Create, Retrieve, Update, Delete lifecycle methods.
+    #
+    # == Lifecycle methods
+    #
+    # === Retrieving a single attachment by Issue and attachment id
+    #
+    #     # Find attachment with id 30076 on issue SUP-3000.
+    #     issue =  JIRA::Resource::Issue.find(client, 'SUP-3000', { fields: 'attachment' } )
+    #     attachment = issue.attachments.find do |attachment_curr|
+    #         30076 == attachment_curr.id.to_i
+    #     end
+    #
+    # === Retrieving meta information for an attachments
+    #
+    #     attachment.meta
+    #
+    # === Retrieving file contents of attachment
+    #
+    #     content = URI.open(attachment.content).read
+    #     content = attachment.download_contents
+    #     content = attachment.download_file { |file| file.read }
+    #
+    # === Adding an attachment to an issue
+    #
+    #     Dir.mktmpdir do |dir|
+    #       path = File.join(dir, filename)
+    #       IO.copy_stream(file.path, path)
+    #
+    #       issue =  JIRA::Resource::Issue.find(client, 'SUP-3000', { fields: 'attachment' } )
+    #       attachment = issue.attachments.build
+    #       attachment.save!( { file: path, mimeType: content_type } )
+    #     end
+    #
+    # === Deleting an attachment
+    #
+    #   attachment.delete
+    #
+    # @!method save(attrs, path = url)
+    #   Uploads a file as an attachment to its issue.
+    #
+    #   Filename used will be the basename of the given file.
+    #
+    #   @param [Hash] attrs the options to create a message with.
+    #   @option attrs [IO,String] :file The file to upload, either a file object or a file path to find the file.
+    #   @option attrs [String] :mimeType The MIME type of the file.
+    #   @return [Boolean] True if successful, false if failed.
+    #
+    # @!attribute [r] self
+    #   @return [String] URL to JSON of this attachment
+    # @!attribute [r] filename
+    #   @return [String] the filename
+    # @!attribute [r] author
+    #   @return [JIRA::Resource::User] the user who created the attachment
+    # @!attribute [r] created
+    #   @return [String] timestamp when the attachment was created
+    # @!attribute [r] size
+    #   @return [Integer] the file size
+    # @!attribute [r] mimeType
+    #   @return [String] MIME of the content type
+    # @!attribute [r] content
+    #   @return [String] URL (not the contents) to download the contents of the attachment
+    # @!attribute [r] thumbnail
+    #   @return [String] URL to download the thumbnail of the attachment
+    #
     class Attachment < JIRA::Base
       belongs_to :issue
       has_one :author, class: JIRA::Resource::User
 
+      # @private
       def self.endpoint_name
         'attachments'
       end
 
+      # Gets metadata about attachments on the server.
+      # @example Return metadata
+      #   Attachment.meta(client)
+      #   =>  { "enabled" => true, "uploadLimit" => 1000000 }
+      # @return [Hash] The metadata for attachments.  (See example.)
       def self.meta(client)
         response = client.get("#{client.options[:rest_base_path]}/attachment/meta")
         parse_json(response.body)
@@ -42,23 +113,37 @@ module JIRA
       # @param [Hash] headers Any additional headers to call Jira.
       # @yield |file|
       # @yieldparam [IO] file The IO object streaming the download.
-      def download_file(headers = {}, &block)
+      def download_file(headers = {}, &)
         default_headers = client.options[:default_headers]
-        URI.parse(content).open(default_headers.merge(headers), &block)
+        URI.parse(content).open(default_headers.merge(headers), &)
       end
 
       # Downloads the file contents as a string object.
       #
       # Note that this reads the contents into a ruby string in memory.
-      # A file might be very large so it is recommend to avoid this unless you are certain about doing so.
+      # A file might be very large so it is recommended to avoid this unless you are certain about doing so.
       # Use the download_file method instead and avoid calling the read method without a limit.
       #
+      # @example Save file contents to a string.
+      #   content = download_contents
       # @param [Hash] headers Any additional headers to call Jira.
       # @return [String,NilClass] The file contents.
       def download_contents(headers = {})
         download_file(headers, &:read)
       end
 
+      # Uploads a file as an attachment to its issue.
+      #
+      # Filename used will be the basename of the given file.
+      #
+      # @example Save a file as an attachment
+      #   issue =  JIRA::Resource::Issue.find(client, 'SUP-3000', { fields: 'attachment' } )
+      #   attachment = issue.attachments.build
+      #   attachment.save!( { file: path, mimeType: 'text/plain' } )
+      # @param [Hash] attrs the options to create a message with.
+      # @option attrs [IO,String] :file The file to upload, either a file object or a file path to find the file.
+      # @option attrs [String] :mimeType The MIME type of the file.
+      # @raise [JIRA::HTTPError] if failed
       def save!(attrs, path = url)
         file = attrs['file'] || attrs[:file] # Keep supporting 'file' parameter as a string for backward compatibility
         mime_type = attrs[:mimeType] || 'application/binary'

data/lib/jira/resource/field.rb

@@ -21,7 +21,6 @@ module JIRA
 
       def self.map_fields(client)
         field_map = {}
-        field_map_reverse = {}
         fields = client.Field.all
 
         # two pass approach, so that a custom field with the same name
@@ -30,7 +29,6 @@ module JIRA
           next if f.custom
 
           name = safe_name(f.name)
-          field_map_reverse[f.id] = [f.name, name] # capture both the official name, and the mapped name
           field_map[name] = f.id
         end
 
@@ -44,23 +42,21 @@ module JIRA
                  else
                    safe_name(f.name)
                  end
-          field_map_reverse[f.id] = [f.name, name] # capture both the official name, and the mapped name
           field_map[name] = f.id
         end
 
-        client.cache.field_map_reverse = field_map_reverse # not sure where this will be used yet, but sure to be useful
-        client.cache.field_map = field_map
+        client.field_map_cache = field_map
       end
 
       def self.field_map(client)
-        client.cache.field_map
+        client.field_map_cache
       end
 
       def self.name_to_id(client, field_name)
         field_name = field_name.to_s
-        return field_name unless client.cache.field_map && client.cache.field_map[field_name]
+        return field_name unless client.field_map_cache && client.field_map_cache[field_name]
 
-        client.cache.field_map[field_name]
+        client.field_map_cache[field_name]
       end
 
       def respond_to?(method_name, _include_all = false)

data/lib/jira/resource/issue.rb

@@ -8,6 +8,35 @@ module JIRA
     class IssueFactory < JIRA::BaseFactory # :nodoc:
     end
 
+    # This class provides the Issue object <-> REST mapping for JIRA::Resource::Issue derived class,
+    # i.e. the Create, Retrieve, Update, Delete lifecycle methods.
+    #
+    # == Lifecycle methods
+    #
+    # === Retrieving all issues
+    #
+    #   client.Issue.all
+    #
+    # === Retrieving a single issue
+    #
+    #   options = { expand: 'editmeta' }
+    #   issue = client.Issue.find("SUP-3000", options)
+    #
+    # === Creating a new issue
+    #
+    #   issue = client.Issue.build(fields: { summary: 'New issue', project: { key: 'SUP' }, issuetype: { name: 'Bug' } })
+    #   issue.save
+    #
+    # === Updating an issue
+    #
+    #   issue = client.Issue.find("SUP-3000")
+    #   issue.save(fields: { summary: 'Updated issue' })
+    #
+    # === Deleting an issue
+    #
+    #   issue = client.Issue.find("SUP-3000")
+    #   issue.delete
+    #
     class Issue < JIRA::Base
       has_one :reporter, class: JIRA::Resource::User, nested_under: 'fields'
       has_one :assignee, class: JIRA::Resource::User, nested_under: 'fields'
@@ -29,6 +58,9 @@ module JIRA
       has_many :remotelink, class: JIRA::Resource::Remotelink
       has_many :watchers, attribute_key: 'watches', nested_under: %w[fields watches]
 
+      # Get collection of issues.
+      # @param client [JIRA::Client]
+      # @return [Array<JIRA::Resource::Issue>]
       def self.all(client)
         start_at = 0
         max_results = 1000
@@ -48,8 +80,7 @@ module JIRA
         result
       end
 
-      def self.jql(client, jql, options = { fields: nil, start_at: nil, max_results: nil, expand: nil,
-validate_query: true })
+      def self.jql(client, jql, options = { fields: nil, start_at: nil, max_results: nil, expand: nil, validate_query: true })
         url = client.options[:rest_base_path] + "/search?jql=#{CGI.escape(jql)}"
 
         if options[:fields]
@@ -59,7 +90,7 @@ validate_query: true })
         end
         url << "&startAt=#{CGI.escape(options[:start_at].to_s)}" if options[:start_at]
         url << "&maxResults=#{CGI.escape(options[:max_results].to_s)}" if options[:max_results]
-        url << '&validateQuery=false' if options[:validate_query] === false
+        url << '&validateQuery=false' if options[:validate_query] === false # rubocop:disable Style/CaseEquality
 
         if options[:expand]
           options[:expand] = [options[:expand]] if options[:expand].is_a?(String)
@@ -68,7 +99,7 @@ validate_query: true })
 
         response = client.get(url)
         json = parse_json(response.body)
-        return json['total'] if options[:max_results] && (options[:max_results]).zero?
+        return json['total'] if options[:max_results]&.zero?
 
         json['issues'].map do |issue|
           client.Issue.build(issue)
@@ -78,6 +109,13 @@ validate_query: true })
       # Fetches the attributes for the specified resource from JIRA unless
       # the resource is already expanded and the optional force reload flag
       # is not set
+      # @param [Boolean] reload
+      # @param [Hash] query_params
+      # @option query_params [String] :fields
+      # @option query_params [String] :expand
+      # @option query_params [Integer] :startAt
+      # @option query_params [Integer] :maxResults
+      # @return [void]
       def fetch(reload = false, query_params = {})
         return if expanded? && !reload
 
@@ -101,6 +139,7 @@ validate_query: true })
         json['fields']
       end
 
+      # @private
       def respond_to?(method_name, _include_all = false)
         if attrs.key?('fields') && [method_name.to_s, client.Field.name_to_id(method_name)].any? do |k|
              attrs['fields'].key?(k)
@@ -111,6 +150,7 @@ validate_query: true })
         end
       end
 
+      # @private
       def method_missing(method_name, *args, &)
         if attrs.key?('fields')
           if attrs['fields'].key?(method_name.to_s)
@@ -127,6 +167,26 @@ validate_query: true })
           super
         end
       end
+
+      # @!method self.find(client, key, options = {})
+      #   Gets/fetches an issue from JIRA.
+      #
+      #   Note: attachments are not fetched by default.
+      #
+      #   @param [JIRA::Client] client
+      #   @param [String] key the key of the issue to find
+      #   @param [Hash] options the options to find the issue with
+      #   @option options [String] :fields the fields to include in the response
+      #   @return [JIRA::Resource::Issue] the found issue
+      #   @example Find an issue
+      #   JIRA::Resource::Issue.find(client, "SUP-3000", { fields: %w[summary description attachment created ] } )
+      #
+      # @!method self.build(attrs = {})
+      #   Constructs a new issue object.
+      #   @param [Hash] attrs the attributes to initialize the issue with
+      #   @return [JIRA::Resource::Issue] the new issue
+      #
+      # .
     end
   end
 end

data/lib/jira/resource/issue_picker_suggestions.rb

@@ -9,7 +9,7 @@ module JIRA
       has_many :sections, class: JIRA::Resource::IssuePickerSuggestionsIssue
 
       def self.all(client, query = '', options = { current_jql: nil, current_issue_key: nil, current_project_id: nil,
-show_sub_tasks: nil, show_sub_tasks_parent: nil })
+                                                   show_sub_tasks: nil, show_sub_tasks_parent: nil })
         url = client.options[:rest_base_path] + "/issue/picker?query=#{CGI.escape(query)}"
 
         url << "&currentJQL=#{CGI.escape(options[:current_jql])}" if options[:current_jql]

data/lib/jira/resource/issuelink.rb

@@ -5,9 +5,10 @@ module JIRA
     class IssuelinkFactory < JIRA::BaseFactory # :nodoc:
     end
 
-    # Because of circular dependency Issue->IssueLink->Issue
-    # we have to declare JIRA::Resource::Issue class.
-    class Issue < JIRA::Base; end
+    class Issue < JIRA::Base
+      # Because of circular dependency Issue->IssueLink->Issue
+      # we have to declare JIRA::Resource::Issue class.
+    end
 
     class Issuelink < JIRA::Base
       has_one :type, class: JIRA::Resource::Issuelinktype

data/lib/jira/resource/watcher.rb

@@ -28,7 +28,7 @@ module JIRA
 
       def save!(user_id, path = nil)
         path ||= new_record? ? url : patched_url
-        response = client.post(path, user_id.to_json)
+        client.post(path, user_id.to_json)
         true
       end
     end

data/lib/jira/resource/webhook.rb

@@ -16,8 +16,12 @@ module JIRA
         client.options[:context_path] + REST_BASE_PATH
       end
 
+      def self.singular_path(client, key, prefix = '/')
+        "#{full_url(client)}#{prefix}/#{endpoint_name}/#{key}"
+      end
+
       def self.collection_path(client, prefix = '/')
-        full_url(client) + prefix + endpoint_name
+        "#{full_url(client)}#{prefix}/#{endpoint_name}"
       end
 
       def self.all(client, options = {})

data/lib/jira/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JIRA
-  VERSION = '3.0.0.beta1'
+  VERSION = '3.0.0.beta2'
 end

data/lib/tasks/generate.rake

@@ -12,7 +12,7 @@ namespace :jira do
   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') # rubocop:disable Layout/LineLength
+    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')

data/spec/integration/project_spec.rb

@@ -30,7 +30,7 @@ describe JIRA::Resource::Project do
         expect(issues.length).to eq(11)
         issues.each do |issue|
           expect(issue.class).to eq(JIRA::Resource::Issue)
-          expect(issue.expanded?).to be_falsey
+          expect(issue).not_to be_expanded
         end
       end
     end

data/spec/integration/rapidview_spec.rb

@@ -66,7 +66,7 @@ describe JIRA::Resource::RapidView do
 
         issues.each do |issue|
           expect(issue.class).to eq(JIRA::Resource::Issue)
-          expect(issue.expanded?).to be_falsey
+          expect(issue).not_to be_expanded
         end
       end
     end

data/spec/integration/user_spec.rb

@@ -40,14 +40,23 @@ describe JIRA::Resource::User do
       end
 
       before do
+        user_factory = double('UserFactory')
+
         allow(client).to receive(:get)
-          .with('/rest/api/2/users/search?username=_&maxResults=1000') { OpenStruct.new(body: '["User1"]') }
-        allow(client).to receive_message_chain(:User, :build).with('users') { [] }
+          .with('/rest/api/2/users/search?username=_&maxResults=1000')
+          .and_return(double(body: '["User1"]'))
+        allow(client).to receive(:User).and_return(user_factory)
+        allow(user_factory).to receive(:build).with('users').and_return([])
       end
 
       it 'gets users with maxResults of 1000' do
+        user_factory = double('UserFactory')
+
         expect(client).to receive(:get).with('/rest/api/2/users/search?username=_&maxResults=1000')
-        expect(client).to receive_message_chain(:User, :build).with('User1')
+                                       .and_return(double(body: '["User1"]'))
+        expect(client).to receive(:User).and_return(user_factory)
+        expect(user_factory).to receive(:build).with('User1')
+
         described_class.all(client)
       end
     end

data/spec/integration/watcher_spec.rb

@@ -46,15 +46,19 @@ describe JIRA::Resource::Watcher do
 
       it 'returnses all the watchers' do
         issue = client.Issue.find('10002')
-        watchers = client.Watcher.all(options = { issue: })
+        watchers = client.Watcher.all({ issue: })
         expect(watchers.length).to eq(1)
       end
 
       it 'adds a watcher' do
         issue = client.Issue.find('10002')
-        watcher = described_class.new(client, issue:)
+        watcher = described_class.new(client, issue: issue)
         user_id = 'tester'
+
         watcher.save!(user_id)
+
+        expect(WebMock).to have_requested(:post, "#{site_url}/jira/rest/api/2/issue/10002/watchers")
+          .with(body: '"tester"')
       end
     end
   end

data/spec/integration/{webhook.rb → webhook_spec.rb}

@@ -9,7 +9,7 @@ describe JIRA::Resource::Webhook do
 
     let(:expected_attributes) do
       { 'name' => 'from API', 'url' => 'http://localhost:3000/webhooks/1', 'excludeBody' => false,
-'filters' => { 'issue-related-events-section' => '' }, 'events' => [], 'enabled' => true, 'self' => 'http://localhost:2990/jira/rest/webhooks/1.0/webhook/2', 'lastUpdatedUser' => 'admin', 'lastUpdatedDisplayName' => 'admin', 'lastUpdated' => 1_453_306_520_188 }
+        'filters' => { 'issue-related-events-section' => '' }, 'events' => [], 'enabled' => true, 'self' => 'http://localhost:2990/jira/rest/webhooks/1.0/webhook/2', 'lastUpdatedUser' => 'admin', 'lastUpdatedDisplayName' => 'admin', 'lastUpdated' => 1_453_306_520_188 }
     end
 
     let(:expected_collection_length) { 1 }
@@ -21,6 +21,13 @@ describe JIRA::Resource::Webhook do
     it 'returns a collection of components' do
       stub_request(:get, site_url + described_class.singular_path(client, key))
         .to_return(status: 200, body: get_mock_response('webhook/webhook.json'))
+
+      webhook = client.Webhook.find(key)
+
+      expect(webhook).to be_a described_class
+      expect(webhook.name).to eq 'from API'
+      expect(webhook.url).to eq '/jira/rest/webhooks/1.0/webhook/2'
+      expect(webhook.enabled).to be true
     end
   end
 end

data/spec/jira/base_factory_spec.rb

@@ -1,8 +1,17 @@
 require 'spec_helper'
 
 describe JIRA::BaseFactory do
-  class JIRA::Resource::FooFactory < JIRA::BaseFactory; end
-  class JIRA::Resource::Foo; end
+  module JIRA
+    module Resource
+      class FooFactory < JIRA::BaseFactory; end
+    end
+  end
+
+  module JIRA
+    module Resource
+      class Foo; end
+    end
+  end
 
   subject       { JIRA::Resource::FooFactory.new(client) }