jira-ruby 0.1.17 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ff744bcd9ad2d2787f07ecf627888484805cadf
-  data.tar.gz: ae9c78df7d9b0de9fb35bdfb0671119240211a91
+  metadata.gz: a295ea67b7236d11b1696c74e9491f80f694c698
+  data.tar.gz: c00568c1bba25ed92d64531df36539ba8d7d3d31
 SHA512:
-  metadata.gz: d118f8da88f23970bb406d4cfabec43eb19fc4178fddc4c9ec9e9c893933dff4b0aa6c3aa56fdcfc92a1ee43817f8ba39d1b03d2a1645c950528bf104eebcbcd
-  data.tar.gz: 4a9a20b2c3ecb34c7ff79c87cbf0546ec5bbb89700a3655066fd4060d5b9fa4e8dbaf68e66d40f7a8ec02b36c96712be8af4889d6618f50a603ed85f91611c6f
+  metadata.gz: 0e4c24dffaa5d308386ab2698391a8c0c73de5ac67582360c15df32c99775b07495776b6ab87637b0b4ccdb7d47e80508f868c5073391946ea199858fef0a12c
+  data.tar.gz: 89f26829c1937b26846e6557b0265e693e65ff22e764ebdfd05e06209d15034d42ca865846fc048907f06844896fa7b197b7bdd082b1acb564f3e6a969c20eb0

data/Gemfile

@@ -1,6 +1,11 @@
 source "http://rubygems.org"
 
-gem 'pry'
-
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'pry'   # this was in the original Gemfile - but only needed in development
+  gem 'wdm', '>= 0.1.0' if Gem.win_platform?
+end
+      
 # Specify your gem's dependencies in jira_api.gemspec
 gemspec

data/Guardfile

@@ -0,0 +1,14 @@
+gem 'wdm', '>= 0.1.0' if Gem.win_platform?
+gem 'rspec', '~> 3.0.0'
+
+guard 'rspec', cmd: 'bundle exec rspec --color --format doc' do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+ 
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/README.rdoc

@@ -76,6 +76,10 @@ defaults to HTTP Basic Auth.
 Using HTTP Basic Authentication, configure and connect a client to your instance
 of JIRA.
 
+Note: If your Jira install is hosted on {atlassian.net}[atlassian.net], it will have no context 
+path by default. If you're having issues connecting, try setting context_path 
+to an empty string in the options hash.
+
   require 'rubygems'
   require 'pp'
   require 'jira'
@@ -273,7 +277,8 @@ Here's the same example as a Sinatra application:
     # Initiates the OAuth dance by first requesting a token then redirecting to
     # http://<yourserver>/auth to get the @access_token
     get '/signin' do
-      request_token = @jira_client.request_token
+      callback_url = "#{request.base_url}/callback"
+      request_token = @jira_client.request_token(oauth_callback: callback_url)
       session[:request_token] = request_token.token
       session[:request_secret] = request_token.secret
 
@@ -283,7 +288,7 @@ Here's the same example as a Sinatra application:
     # http://<yourserver>/callback
     # Retrieves the @access_token then stores it inside a session cookie. In a real app,
     # you'll want to persist the token in a datastore associated with the user.
-    get "/callback/" do
+    get "/callback" do
       request_token = @jira_client.set_request_token(
         session[:request_token], session[:request_secret]
       )

data/Rakefile

@@ -19,7 +19,11 @@ task :prepare do
 end
 
 desc 'Run RSpec tests'
-RSpec::Core::RakeTask.new(:spec)
+#RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'doc']
+end
+
 
 Rake::RDocTask.new(:doc) do |rd|
   rd.main       = 'README.rdoc'

data/example.rb

@@ -42,6 +42,28 @@ end
 issue = client.Issue.find('SAMPLEPROJECT-1')
 pp issue
 
+# # Handling fields by name, rather than by id
+# # ------------------------------------------
+# Cache the Field list from the server
+client.Field.map_fields
+# This allows use of friendlier names for custom fields
+# Say that 'Special Field' is customfield_12345
+# It becomes mapped to Special_Field which is usable as a method call
+#
+# Say that there is a second 'Special Field' is customfield_54321
+# Names are deduplicated so the second 'Special Field' becomes Special_Field_54321
+#
+# Names are massaged to get rid of special characters, and spaces
+# So 'Special & @ Field' becomes Special_____Field - not perfect, but usable
+old_way = issue.customfield_12345
+new_way = issue.Special_Field
+(old_way == new_way) && puts 'much easier'
+#
+# Can also use this to specify fields to be returned in the response
+client.Issue.jql(a_normal_jql_search, fields:[:Special_Field])
+# Or you could always do it the old way - if you can remember the numbers...
+client.Issue.jql(a_normal_jql_search, fields:['customfield_12345'])
+
 # # Find a specific project by key
 # # ------------------------------
 # project = client.Project.find('SAMPLEPROJECT')
@@ -173,4 +195,4 @@ remote_link.save(
             :title => issue_1.key,
         }
     }
-)
+)

data/lib/jira.rb

@@ -30,6 +30,8 @@ require 'jira/resource/filter'
 require 'jira/resource/field'
 require 'jira/resource/rapidview'
 require 'jira/resource/serverinfo'
+require 'jira/resource/createmeta'
+require 'jira/resource/webhook'
 
 require 'jira/request_client'
 require 'jira/oauth_client'

data/lib/jira/base.rb

@@ -348,7 +348,7 @@ module JIRA
     # 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)
+      response = client.send(http_method, new_record? ? url : patched_url, attrs.to_json)
       set_attrs(attrs, false)
       set_attrs_from_response(response)
       @expanded = false
@@ -439,6 +439,7 @@ module JIRA
     end
 
     # This method fixes issue that there is no / prefix in url. It is happened when we call for instance
+    # Looks like this issue is actual only in case if you use atlassian sdk your app path is not root (like /jira in example below)
     # issue.save() for existing resource.
     # As a result we got error 400 from JIRA API:
     # [07/Jun/2015:15:32:19 +0400] "PUT jira/rest/api/2/issue/10111 HTTP/1.1" 400 -
@@ -446,7 +447,7 @@ module JIRA
     # [07/Jun/2015:15:17:18 +0400] "PUT /jira/rest/api/2/issue/10111 HTTP/1.1" 204 -
     def patched_url
       result = url
-      result if result.start_with?('/')
+      return result if result.start_with?('/')
       "/#{result}"
     end
 
@@ -455,8 +456,8 @@ module JIRA
     end
 
     # Returns a JSON representation of the current attributes hash.
-    def to_json
-      attrs.to_json
+    def to_json(options = {})
+      attrs.to_json(options)
     end
 
     # Determines if the resource is newly created by checking whether its

data/lib/jira/base_factory.rb

@@ -15,7 +15,7 @@ module JIRA
       # 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
+      # So create a method chain from the class components.  This code will
       # unroll to:
       #   Module.const_get('JIRA').const_get('Resource').const_get('Foo')
       #
@@ -35,7 +35,7 @@ module JIRA
       end
     end
 
-    # The priciple purpose of this class is to delegate methods to the corresponding
+    # The principle 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

data/lib/jira/client.rb

@@ -1,5 +1,6 @@
 require 'json'
 require 'forwardable'
+require 'ostruct'
 
 module JIRA
 
@@ -37,7 +38,7 @@ module JIRA
     #
     # The authenticated client instance returned by the respective client type
     # (Oauth, Basic)
-    attr_accessor :consumer, :request_client
+    attr_accessor :consumer, :request_client, :http_debug, :cache
 
     # The configuration options for this client instance
     attr_reader :options
@@ -50,7 +51,8 @@ module JIRA
       :rest_base_path     => "/rest/api/2",
       :ssl_verify_mode    => OpenSSL::SSL::VERIFY_PEER,
       :use_ssl            => true,
-      :auth_type          => :oauth
+      :auth_type          => :oauth,
+      :http_debug         => false
     }
 
     def initialize(options={})
@@ -64,9 +66,15 @@ module JIRA
         @consumer = @request_client.consumer
       when :basic
         @request_client = HttpClient.new(@options)
+      else
+        raise ArgumentError, 'Options: ":auth_type" must be ":oauth" or ":basic"'
       end
 
+      @http_debug = @options[:http_debug]
+
       @options.freeze
+
+      @cache = OpenStruct.new
     end
 
     def Project # :nodoc:
@@ -133,10 +141,18 @@ module JIRA
       JIRA::Resource::ServerInfoFactory.new(self)
     end
 
+    def Createmeta
+      JIRA::Resource::CreatemetaFactory.new(self)
+    end
+
     def ApplicationLink
       JIRA::Resource::ApplicationLinkFactory.new(self)
     end
 
+    def Webhook
+      JIRA::Resource::WebhookFactory.new(self)
+    end
+
     def Issuelink
       JIRA::Resource::IssuelinkFactory.new(self)
     end
@@ -176,6 +192,7 @@ module JIRA
     # Sends the specified HTTP request to the REST API through the
     # appropriate method (oauth, basic).
     def request(http_method, path, body = '', headers={})
+      puts "#{http_method}: #{path} - [#{body}]" if @http_debug
       @request_client.request(http_method, path, body, headers)
     end
 

data/lib/jira/resource/createmeta.rb

@@ -0,0 +1,52 @@
+module JIRA
+  module Resource
+
+    class CreatemetaFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Createmeta < JIRA::Base
+      def self.endpoint_name
+        '/issue/createmeta'
+      end
+
+      def self.all(client, params={})
+
+        if params.has_key?(:projectKeys)
+          values = Array(params[:projectKeys]).map{|i| (i.is_a?(JIRA::Resource::Project) ? i.key : i)}
+          params[:projectKeys] = values.join(',')
+        end
+
+        if params.has_key?(:projectIds)
+          values = Array(params[:projectIds]).map{|i| (i.is_a?(JIRA::Resource::Project) ? i.id : i)}
+          params[:projectIds] = values.join(',')
+        end
+
+        if params.has_key?(:issuetypeNames)
+          values = Array(params[:issuetypeNames]).map{|i| (i.is_a?(JIRA::Resource::Issuetype) ? i.name : i)}
+          params[:issuetypeNames] = values.join(',')
+        end
+
+        if params.has_key?(:issuetypeIds)
+          values = Array(params[:issuetypeIds]).map{|i| (i.is_a?(JIRA::Resource::Issuetype) ? i.id : i)}
+          params[:issuetypeIds] = values.join(',')
+        end
+
+        create_meta_url = client.options[:rest_base_path] + self.endpoint_name
+        params = hash_to_query_string(params)
+
+        response = params.empty? ? client.get("#{create_meta_url}") : client.get("#{create_meta_url}?#{params}")
+
+        json = parse_json(response.body)
+        self.new(client, {:attrs => json['projects']})
+      end
+
+      def self.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
+
+    end
+
+  end
+end

data/lib/jira/resource/field.rb

@@ -2,9 +2,82 @@ module JIRA
   module Resource
 
     class FieldFactory < JIRA::BaseFactory # :nodoc:
+       delegate_to_target_class :map_fields, :name_to_id, :field_map
     end
 
-    class Field < JIRA::Base ; end
+    class Field < JIRA::Base
 
+      #translate a custom field description to a method-safe name
+      def self.safe_name(description)
+        description.gsub(/[^a-zA-Z0-9]/,'_')
+      end
+
+      # safe_name plus disambiguation if it fails it uses the original jira id (customfield_#####)
+      def self.safer_name(description, jira_id)
+        "#{safe_name(description)}_#{jira_id.split('_')[1]}" rescue jira_id
+      end
+
+      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
+        # as a system field can't take precedence
+        fields.each do |f|
+          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
+
+        fields.each do |f|
+          next unless f.custom
+          name = if field_map.key? f.name
+            renamed = safer_name(f.name, f.id)
+            warn "Duplicate Field name #{f.name} #{f.id} - renaming as #{renamed}"
+            renamed
+          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
+      end
+
+      def self.field_map(client)
+        client.cache.field_map
+      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]
+        client.cache.field_map[field_name]
+      end
+
+      def respond_to?(method_name, include_all=false)
+        if [method_name.to_s, client.Field.name_to_id(method_name)].any? {|k| attrs.key?(k)}
+          true
+        else
+          super(method_name)
+        end
+      end
+
+      def method_missing(method_name, *args, &block)
+          if attrs.keys.include?(method_name.to_s)
+            attrs[method_name.to_s]
+          else
+            official_name=client.Field.name_to_id(method_name)
+            if attrs.keys.include?(official_name)
+              attrs[official_name]
+            else
+              super(method_name, *args, &block)
+            end
+          end
+      end
+    end
   end
 end

data/lib/jira/resource/issue.rb

@@ -51,7 +51,7 @@ module JIRA
       def self.jql(client, jql, options = {fields: nil, start_at: nil, max_results: nil, expand: nil})
         url = client.options[:rest_base_path] + "/search?jql=" + CGI.escape(jql)
 
-        url << "&fields=#{options[:fields].map{ |value| CGI.escape(value.to_s) }.join(',')}" if options[:fields]
+        url << "&fields=#{options[:fields].map{ |value| CGI.escape(client.Field.name_to_id(value)) }.join(',')}" if options[:fields]
         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]
 
@@ -67,8 +67,16 @@ module JIRA
         end
       end
 
+      def editmeta
+        editmeta_url = client.options[:rest_base_path] + "/#{self.class.endpoint_name}/#{key}/editmeta"
+
+        response = client.get(editmeta_url)
+        json = self.class.parse_json(response.body)
+        json['fields']
+      end
+
       def respond_to?(method_name, include_all=false)
-        if attrs.keys.include?('fields') && attrs['fields'].keys.include?(method_name.to_s)
+        if attrs.keys.include?('fields') && [method_name.to_s, client.Field.name_to_id(method_name)].any? {|k| attrs['fields'].key?(k)}
           true
         else
           super(method_name)
@@ -76,10 +84,19 @@ module JIRA
       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]
+        if attrs.keys.include?('fields')
+          if attrs['fields'].keys.include?(method_name.to_s)
+            attrs['fields'][method_name.to_s]
+          else
+            official_name=client.Field.name_to_id(method_name)
+            if attrs['fields'].keys.include?(official_name)
+              attrs['fields'][official_name]
+            else
+              super(method_name, *args, &block)
+            end
+          end
         else
-          super(method_name)
+          super(method_name, *args, &block)
         end
       end
 

data/lib/jira/resource/webhook.rb

@@ -0,0 +1,40 @@
+module JIRA
+  module Resource
+
+    class WebhookFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Webhook < JIRA::Base
+
+      REST_BASE_PATH = '/rest/webhooks/1.0/'
+
+      def self.endpoint_name
+        'webhook'
+      end
+
+      def self.full_url(client)
+        client.options[:context_path] + REST_BASE_PATH
+      end
+
+      def self.collection_path(client, prefix = '/')
+        self.full_url(client) + prefix + self.endpoint_name
+      end
+
+      def self.all(client, options = {})
+        response = client.get(collection_path(client))
+        json = parse_json(response.body)
+        json.map do |attrs|
+          self.new(client, {:attrs => attrs}.merge(options))
+        end
+      end
+
+      # def self.save(options={})
+      # end
+
+      # def self.delete(options={})
+
+      # end
+
+    end
+  end
+end

data/lib/jira/version.rb

@@ -1,3 +1,3 @@
 module JIRA
-  VERSION = "0.1.17"
+  VERSION = "0.1.18"
 end

data/spec/integration/webhook.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Webhook do
+
+  with_each_client do |site_url, client|
+    let(:client) { client }
+    let(:site_url) { site_url }
+
+
+    let(:key) { "2" }
+
+    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"=>1453306520188}
+    end
+
+    let(:expected_collection_length) { 1 }
+
+    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 "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'))
+
+
+      
+
+    end
+  end
+end

data/spec/jira/base_spec.rb

@@ -427,9 +427,12 @@ describe JIRA::Base do
   end
 
   it "converts to json" do
-    subject.attrs = {"foo" => "bar","dead" => "beef"}
-
+    subject.attrs = { 'foo' => 'bar', 'dead' => 'beef' }
     expect(subject.to_json).to eq(subject.attrs.to_json)
+
+    h       = { 'key' => subject }
+    h_attrs = { 'key' => subject.attrs }
+    expect(h.to_json).to eq(h_attrs.to_json)
   end
 
   describe "extract attrs from response" do

data/spec/jira/resource/createmeta_spec.rb

@@ -0,0 +1,253 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Createmeta do
+  let(:client) {
+    double(
+      'client',
+      :options => {
+        :rest_base_path => '/jira/rest/api/2'
+      }
+    )
+  }
+
+  let(:response) {
+    double(
+      'response',
+      :body => '{"expand":"projects","projects":[{"self":"http://localhost:2029/rest/api/2/project/TST"}]}'
+    )
+  }
+
+  describe 'general' do
+    it 'should query correct url without parameters' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta').and_return(response)
+      JIRA::Resource::Createmeta.all(client)
+    end
+
+    it 'should query correct url with `expand` parameter' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?expand=projects.issuetypes.fields').and_return(response)
+      JIRA::Resource::Createmeta.all(client, :expand => 'projects.issuetypes.fields')
+    end
+
+    it 'should query correct url with `foo` parameter' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?foo=bar').and_return(response)
+      JIRA::Resource::Createmeta.all(client, :foo => 'bar')
+    end
+
+  end
+
+
+  describe 'projectKeys' do
+    it 'should query correct url when only one `projectKeys` given as string' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectKeys=PROJECT_1').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :projectKeys => 'PROJECT_1',
+      )
+    end
+
+    it 'should query correct url when multiple `projectKeys` given as string' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectKeys=PROJECT_1%2CPROJECT_2').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :projectKeys => ['PROJECT_1', 'PROJECT_2'],
+      )
+    end
+
+    it 'should query correct url when only one `projectKeys` given as Project' do
+      prj = JIRA::Resource::Project.new(client)
+      allow(prj).to receive(:key).and_return('PRJ')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectKeys=PRJ').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :projectKeys => prj,
+      )
+    end
+
+    it 'should query correct url when multiple `projectKeys` given as Project' do
+      prj_1 = JIRA::Resource::Project.new(client)
+      allow(prj_1).to receive(:key).and_return('PRJ_1')
+      prj_2 = JIRA::Resource::Project.new(client)
+      allow(prj_2).to receive(:key).and_return('PRJ_2')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectKeys=PRJ_2%2CPRJ_1').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :projectKeys => [prj_2, prj_1],
+      )
+    end
+
+    it 'should query correct url when multiple `projectKeys` given as different types' do
+      prj_5 = JIRA::Resource::Project.new(client)
+      allow(prj_5).to receive(:key).and_return('PRJ_5')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectKeys=PROJECT_1%2CPRJ_5').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :projectKeys => ['PROJECT_1', prj_5],
+      )
+    end
+  end
+
+
+  describe 'projectIds' do
+    it 'should query correct url when only one `projectIds` given as string' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectIds=10101').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :projectIds => '10101',
+      )
+    end
+
+    it 'should query correct url when multiple `projectIds` given as string' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectIds=10101%2C20202').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :projectIds => ['10101', '20202'],
+      )
+    end
+
+    it 'should query correct url when only one `projectIds` given as Project' do
+      prj = JIRA::Resource::Project.new(client)
+      allow(prj).to receive(:id).and_return('30303')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectIds=30303').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :projectIds => prj,
+      )
+    end
+
+    it 'should query correct url when multiple `projectIds` given as Project' do
+      prj_1 = JIRA::Resource::Project.new(client)
+      allow(prj_1).to receive(:id).and_return('30303')
+      prj_2 = JIRA::Resource::Project.new(client)
+      allow(prj_2).to receive(:id).and_return('50505')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectIds=50505%2C30303').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :projectIds => [prj_2, prj_1],
+      )
+    end
+
+    it 'should query correct url when multiple `projectIds` given as different types' do
+      prj_5 = JIRA::Resource::Project.new(client)
+      allow(prj_5).to receive(:id).and_return('60606')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectIds=10101%2C60606').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :projectIds => ['10101', prj_5],
+      )
+    end
+  end
+
+
+  describe 'issuetypeNames' do
+    it 'should query correct url when only one `issuetypeNames` given as string' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeNames=Feature').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :issuetypeNames => 'Feature',
+      )
+    end
+
+    it 'should query correct url when multiple `issuetypeNames` given as string' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeNames=Feature%2CBug').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :issuetypeNames => ['Feature', 'Bug'],
+      )
+    end
+
+    it 'should query correct url when only one `issuetypeNames` given as Issuetype' do
+      issue_type = JIRA::Resource::Issuetype.new(client)
+      allow(issue_type).to receive(:name).and_return('Epic')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeNames=Epic').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :issuetypeNames => issue_type,
+      )
+    end
+
+    it 'should query correct url when multiple `issuetypeNames` given as Issuetype' do
+      issue_type_1 = JIRA::Resource::Issuetype.new(client)
+      allow(issue_type_1).to receive(:name).and_return('Epic')
+      issue_type_2 = JIRA::Resource::Issuetype.new(client)
+      allow(issue_type_2).to receive(:name).and_return('Sub-Task')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeNames=Sub-Task%2CEpic').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :issuetypeNames => [issue_type_2, issue_type_1],
+      )
+    end
+
+    it 'should query correct url when multiple `issuetypeNames` given as different types' do
+      issue_type = JIRA::Resource::Issuetype.new(client)
+      allow(issue_type).to receive(:name).and_return('Epic')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeNames=Feature%2CEpic').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :issuetypeNames => ['Feature', issue_type],
+      )
+    end
+  end
+
+
+  describe 'issuetypeIds' do
+    it 'should query correct url when only one `issuetypeIds` given as string' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeIds=10101').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :issuetypeIds => '10101',
+      )
+    end
+
+    it 'should query correct url when multiple `issuetypeIds` given as string' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeIds=10101%2C20202').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :issuetypeIds => ['10101', '20202'],
+      )
+    end
+
+    it 'should query correct url when only one `issuetypeIds` given as Issuetype' do
+      issue_type = JIRA::Resource::Issuetype.new(client)
+      allow(issue_type).to receive(:id).and_return('30303')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeIds=30303').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :issuetypeIds => issue_type,
+      )
+    end
+
+    it 'should query correct url when multiple `issuetypeIds` given as Issuetype' do
+      issue_type_1 = JIRA::Resource::Issuetype.new(client)
+      allow(issue_type_1).to receive(:id).and_return('30303')
+      issue_type_2 = JIRA::Resource::Issuetype.new(client)
+      allow(issue_type_2).to receive(:id).and_return('50505')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeIds=50505%2C30303').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :issuetypeIds => [issue_type_2, issue_type_1],
+      )
+    end
+
+    it 'should query correct url when multiple `issuetypeIds` given as different types' do
+      issue_type = JIRA::Resource::Issuetype.new(client)
+      allow(issue_type).to receive(:id).and_return('30303')
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?issuetypeIds=10101%2C30303').and_return(response)
+      JIRA::Resource::Createmeta.all(
+        client,
+        :issuetypeIds => ['10101', issue_type],
+      )
+    end
+  end
+end

data/spec/jira/resource/field_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Field do
+
+  let(:cache) { OpenStruct.new }
+
+  let(:client) do
+    client = double(options: {rest_base_path: '/jira/rest/api/2'}  )
+    field = JIRA::Resource::FieldFactory.new(client)
+    allow(client).to receive(:Field).and_return(field)
+    allow(client).to receive(:cache).and_return(cache)
+    # info about all fields on the client
+    allow(client.Field).to receive(:all).and_return([
+      JIRA::Resource::Field.new(client, :attrs => {'id' =>"customfield_10666", "name" => "Priority",   "custom" => true,  "orderable" => true,  "navigable" => true, "searchable" => true,  "clauseNames" => ["cf[10666]","Priority"],         "schema" =>{"type" => "string",    "custom" => "com.atlassian.jira.plugin.system.customfieldtypes:select","customId" => 10666}}),
+      JIRA::Resource::Field.new(client, :attrs => {'id' =>"issuekey",          "name" => "Key",        "custom" => false, "orderable" => false, "navigable" => true, "searchable" => false, "clauseNames" => ["id","issue","issuekey","key"]}),
+      JIRA::Resource::Field.new(client, :attrs => {"id" =>"priority",          "name" => "Priority",   "custom" => false, "orderable" => true,  "navigable" => true, "searchable" => true,  "clauseNames" => ["priority"],                     "schema" =>{"type" => "priority",  "system" => "priority"}}),
+      JIRA::Resource::Field.new(client, :attrs => {'id' =>"summary",           "name" => "Summary",    "custom" => false, "orderable" => true,  "navigable" => true, "searchable" => true,  "clauseNames" => ["summary"],                      "schema" =>{"type" => "string",    "system" => "summary"}}),
+      JIRA::Resource::Field.new(client, :attrs => {'id' =>"issuetype",         "name" => "Issue Type", "custom" => false, "orderable" => true,  "navigable" => true, "searchable" => true,  "clauseNames" => ["issuetype","type"],             "schema" =>{"type" => "issuetype", "system" => "issuetype"}}),
+      JIRA::Resource::Field.new(client, :attrs => {'id' =>"customfield_10111", "name" => "SingleWord", "custom" => true,  "orderable" => true,  "navigable" => true, "searchable" => true,  "clauseNames" => ["cf[10111]","SingleWord"],       "schema" =>{"type" => "string",    "custom" => "com.atlassian.jira.plugin.system.customfieldtypes:select","customId" => 10111}}),
+      JIRA::Resource::Field.new(client, :attrs => {'id' =>"customfield_10222", "name" => "Multi Word", "custom" => true,  "orderable" => true,  "navigable" => true, "searchable" => true,  "clauseNames" => ["cf[10222]","Multi Word"],       "schema" =>{"type" => "string",    "custom" => "com.atlassian.jira.plugin.system.customfieldtypes:select","customId" => 10222}}),
+      JIRA::Resource::Field.new(client, :attrs => {'id' =>"customfield_10333", "name" => "Why/N@t",    "custom" => true,  "orderable" => true,  "navigable" => true, "searchable" => true,  "clauseNames" => ["cf[10333]","Why/N@t"],          "schema" =>{"type" => "string",    "custom" => "com.atlassian.jira.plugin.system.customfieldtypes:select","customId" => 10333}}),
+      JIRA::Resource::Field.new(client, :attrs => {'id' =>"customfield_10444", "name" => "SingleWord", "custom" => true,  "orderable" => true,  "navigable" => true, "searchable" => true,  "clauseNames" => ["cf[10444]","SingleWord"],       "schema" =>{"type" => "string",    "custom" => "com.atlassian.jira.plugin.system.customfieldtypes:select","customId" => 10444}})
+    ])
+    client
+  end
+
+  describe "field_mappings" do
+
+    shared_context "mapped or not" do
+
+      subject {
+        JIRA::Resource::Field.new(client, :attrs => {
+          'priority' => 1,
+          'customfield_10111' => 'data_in_custom_field',
+          'customfield_10222' => 'multi word custom name',
+          'customfield_10333' => 'complex custom name',
+          'customfield_10444' => 'duplicated custom name',
+          'customfield_10666' => 'duplicate of a system name',
+        })
+      }
+
+      it "can find a standard field by id" do
+        expect(subject.priority).to eq(1)
+      end
+
+      it "can find a custom field by customfield_##### name" do
+        expect(subject.customfield_10111).to eq('data_in_custom_field')
+      end
+
+      it "is not confused by common attribute keys" do
+        expect{subject.name}.to raise_error(NoMethodError)
+        expect{subject.custom}.to raise_error(NoMethodError)
+        expect(subject.id).to eq(nil)   # picks up ID from the parent -
+      end
+    end
+
+    context "before fields are mapped" do
+
+      include_context "mapped or not"
+
+      it "can find a standard field by id" do
+        expect(subject.priority).to eq(1)
+      end
+
+      it "cannot find a standard field by name before mapping" do
+        expect{subject.Priority}.to raise_error(NoMethodError)
+      end
+
+      it "can find a custom field by customfield_##### name" do
+        expect(subject.customfield_10111).to eq('data_in_custom_field')
+      end
+
+      it "cannot find a mapped field before mapping and raises error" do
+        expect{subject.SingleWork}.to raise_error(NoMethodError)
+      end
+
+      it "is not confused by common attribute keys and raises error" do
+        expect{subject.name}.to raise_error(NoMethodError)
+        expect{subject.custom}.to raise_error(NoMethodError)
+        expect(subject.id).to eq(nil)   # picks up ID from the parent -
+      end
+    end
+
+    context "after fields are mapped" do
+
+      before do
+        silence_stream(STDERR) do
+          expect(client.Field.map_fields.class).to eq(Hash)
+        end
+      end
+
+      include_context "mapped or not"
+
+      it "warns of duplicate fields" do
+        expect{client.Field.map_fields}.to output(/renaming as Priority_10666/).to_stderr
+        expect{client.Field.map_fields}.to output(/renaming as SingleWord_10444/).to_stderr
+      end
+
+      it "can find a mapped field after mapping and returns results" do
+        expect{subject.SingleWord}.to_not raise_error
+        expect(subject.SingleWord).to eq subject.customfield_10111
+      end
+
+      it "handles duplicate names in a safe fashion" do
+        expect{subject.Multi_Word}.to_not raise_error
+        expect(subject.Multi_Word).to eq subject.customfield_10222
+      end
+
+      it "handles special characters in a safe fashion" do
+        expect{subject.Why_N_t}.to_not raise_error
+        expect(subject.Why_N_t).to eq subject.customfield_10333
+      end
+
+      it "handles duplicates in custom names" do
+        expect{subject.SingleWord_10444}.to_not raise_error
+        expect(subject.SingleWord_10444).to eq subject.customfield_10444
+      end
+
+      it "keeps custom names from overwriting system names" do
+        #expect(client.Field.map_fields.class).to eq(Hash)
+        expect{subject.Priority_10666}.to_not raise_error
+        expect(subject.Priority_10666).to eq subject.customfield_10666
+      end
+
+      it "can find a standard field by an expanded name" do
+        #expect(client.Field.map_fields.class).to eq(Hash)
+        expect(subject.priority).to eq(1)
+        expect(subject.Priority).to eq(1)
+      end
+    end
+  end
+end

data/spec/jira/resource/issue_spec.rb

@@ -5,7 +5,12 @@ describe JIRA::Resource::Issue do
   class JIRAResourceDelegation < SimpleDelegator # :nodoc:
   end
 
-  let(:client) { double(options: {rest_base_path: '/jira/rest/api/2'}) }
+  let(:client) do
+    client = double(options: {rest_base_path: '/jira/rest/api/2'}  )
+    allow(client).to receive(:Field).and_return(JIRA::Resource::FieldFactory.new(client))
+    allow(client).to receive(:cache).and_return(OpenStruct.new)
+    client
+  end
 
   describe "#respond_to?" do
     describe "when decorated by SimpleDelegator" do
@@ -128,6 +133,21 @@ describe JIRA::Resource::Issue do
     expect(JIRA::Resource::Issue.jql(client,'foo bar', expand: %w(transitions))).to eq([''])
   end
 
+  it 'should return meta data available for editing an issue' do
+    subject = JIRA::Resource::Issue.new(client, :attrs => {'fields' => {'key' =>'TST=123'}})
+    response = double()
+
+    allow(response).to receive(:body).and_return(
+      '{"fields":{"summary":{"required":true,"name":"Summary","operations":["set"]}}}'
+    )
+    expect(client).to receive(:get)
+      .with('/jira/rest/api/2/issue/TST=123/editmeta')
+      .and_return(response)
+
+    expect(subject.editmeta).to eq({'summary' => {'required' => true, 'name' => 'Summary', 'operations' => ['set']}})
+  end
+
+
   it "provides direct accessors to the fields" do
     subject = JIRA::Resource::Issue.new(client, :attrs => {'fields' => {'foo' =>'bar'}})
     expect(subject).to respond_to(:foo)

data/spec/mock_responses/jira/rest/webhooks/1.0/webhook.json

@@ -0,0 +1,11 @@
+[{"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":1453306520188
+ }]

data/spec/mock_responses/jira/rest/webhooks/1.0/webhook/2.json

@@ -0,0 +1,11 @@
+{"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":1453306520188
+ }

data/spec/mock_responses/webhook.json

@@ -0,0 +1,11 @@
+[{"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":1453306520188}
+]

data/spec/mock_responses/webhook/webhook.json

@@ -0,0 +1,11 @@
+{"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":1453306520188
+ }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.18
 platform: ruby
 authors:
 - SUMO Heavy Industries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-28 00:00:00.000000000 Z
+date: 2016-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -103,6 +103,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.rdoc
 - Rakefile
@@ -123,6 +124,7 @@ files:
 - lib/jira/resource/attachment.rb
 - lib/jira/resource/comment.rb
 - lib/jira/resource/component.rb
+- lib/jira/resource/createmeta.rb
 - lib/jira/resource/field.rb
 - lib/jira/resource/filter.rb
 - lib/jira/resource/issue.rb
@@ -138,6 +140,7 @@ files:
 - lib/jira/resource/transition.rb
 - lib/jira/resource/user.rb
 - lib/jira/resource/version.rb
+- lib/jira/resource/webhook.rb
 - lib/jira/resource/worklog.rb
 - lib/jira/tasks.rb
 - lib/jira/version.rb
@@ -156,6 +159,7 @@ files:
 - spec/integration/transition_spec.rb
 - spec/integration/user_spec.rb
 - spec/integration/version_spec.rb
+- spec/integration/webhook.rb
 - spec/integration/worklog_spec.rb
 - spec/jira/base_factory_spec.rb
 - spec/jira/base_spec.rb
@@ -166,6 +170,8 @@ files:
 - spec/jira/oauth_client_spec.rb
 - spec/jira/request_client_spec.rb
 - spec/jira/resource/attachment_spec.rb
+- spec/jira/resource/createmeta_spec.rb
+- spec/jira/resource/field_spec.rb
 - spec/jira/resource/filter_spec.rb
 - spec/jira/resource/issue_spec.rb
 - spec/jira/resource/issuelink_spec.rb
@@ -198,6 +204,8 @@ files:
 - spec/mock_responses/issueLinkType/10000.json
 - spec/mock_responses/issuetype.json
 - spec/mock_responses/issuetype/5.json
+- spec/mock_responses/jira/rest/webhooks/1.0/webhook.json
+- spec/mock_responses/jira/rest/webhooks/1.0/webhook/2.json
 - spec/mock_responses/priority.json
 - spec/mock_responses/priority/1.json
 - spec/mock_responses/project.json
@@ -214,6 +222,8 @@ files:
 - spec/mock_responses/version/10000.invalid.put.json
 - spec/mock_responses/version/10000.json
 - spec/mock_responses/version/10000.put.json
+- spec/mock_responses/webhook.json
+- spec/mock_responses/webhook/webhook.json
 - spec/spec_helper.rb
 - spec/support/clients_helper.rb
 - spec/support/matchers/have_attributes.rb
@@ -259,6 +269,7 @@ test_files:
 - spec/integration/transition_spec.rb
 - spec/integration/user_spec.rb
 - spec/integration/version_spec.rb
+- spec/integration/webhook.rb
 - spec/integration/worklog_spec.rb
 - spec/jira/base_factory_spec.rb
 - spec/jira/base_spec.rb
@@ -269,6 +280,8 @@ test_files:
 - spec/jira/oauth_client_spec.rb
 - spec/jira/request_client_spec.rb
 - spec/jira/resource/attachment_spec.rb
+- spec/jira/resource/createmeta_spec.rb
+- spec/jira/resource/field_spec.rb
 - spec/jira/resource/filter_spec.rb
 - spec/jira/resource/issue_spec.rb
 - spec/jira/resource/issuelink_spec.rb
@@ -301,6 +314,8 @@ test_files:
 - spec/mock_responses/issueLinkType/10000.json
 - spec/mock_responses/issuetype.json
 - spec/mock_responses/issuetype/5.json
+- spec/mock_responses/jira/rest/webhooks/1.0/webhook.json
+- spec/mock_responses/jira/rest/webhooks/1.0/webhook/2.json
 - spec/mock_responses/priority.json
 - spec/mock_responses/priority/1.json
 - spec/mock_responses/project.json
@@ -317,6 +332,8 @@ test_files:
 - spec/mock_responses/version/10000.invalid.put.json
 - spec/mock_responses/version/10000.json
 - spec/mock_responses/version/10000.put.json
+- spec/mock_responses/webhook.json
+- spec/mock_responses/webhook/webhook.json
 - spec/spec_helper.rb
 - spec/support/clients_helper.rb
 - spec/support/matchers/have_attributes.rb