jira-ruby 0.1.17 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ff744bcd9ad2d2787f07ecf627888484805cadf
-  data.tar.gz: ae9c78df7d9b0de9fb35bdfb0671119240211a91
+  metadata.gz: bb639c7a6da1d81ae6bb693c5891ee23ce1b1e9c
+  data.tar.gz: 331cd7e819faa9cc056045413d968793a238baa9
 SHA512:
-  metadata.gz: d118f8da88f23970bb406d4cfabec43eb19fc4178fddc4c9ec9e9c893933dff4b0aa6c3aa56fdcfc92a1ee43817f8ba39d1b03d2a1645c950528bf104eebcbcd
-  data.tar.gz: 4a9a20b2c3ecb34c7ff79c87cbf0546ec5bbb89700a3655066fd4060d5b9fa4e8dbaf68e66d40f7a8ec02b36c96712be8af4889d6618f50a603ed85f91611c6f
+  metadata.gz: e8e856bf2af0be3d9b40b300167117c263c6ffda85fb70001c7fd3c2c59b05eab6561ac2f684786175dcf707d6b5ab9a606b92a17a3278cde73f119fb047d4ff
+  data.tar.gz: cc19f33cb2c9455045ff0f1d8368a639963dee01c3c313a39e6e49b026d354dd8f0ef2586773b8153b78c51868466bafbd452aac77ba2641c4f697fd22e6d9d0

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
-    - 2.0.0
+    - 2.3.1
+    - ruby-head
 before_script:
     - rake jira:generate_public_cert
 script: bundle exec rake spec

data/Gemfile

@@ -1,6 +1,8 @@
 source "http://rubygems.org"
 
-gem 'pry'
+group :development do
+  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

@@ -6,7 +6,18 @@ This gem provides access to the Atlassian JIRA REST API.
 
 == Example usage
 
-  client = JIRA::Client.new({:consumer_key => CONSUMER_KEY, :consumer_secret => CONSUMER_SECRET})
+  require 'rubygems'
+  require 'jira-ruby'
+
+  options = {
+    :username     => 'username',
+    :password     => 'pass1234',
+    :site         => 'http://mydomain.atlassian.net:443/',
+    :context_path => '',
+    :auth_type    => :basic
+  }
+  
+  client = JIRA::Client.new(options)
 
   project = client.Project.find('SAMPLEPROJECT')
 
@@ -14,17 +25,18 @@ This gem provides access to the Atlassian JIRA REST API.
     puts "#{issue.id} - #{issue.summary}"
   end
 
-  issue.comments.each {|comment| ... }
-
-  comment = issue.comments.build
-  comment.save({'body':'My new comment'})
-  comment.delete
-
 == Links to JIRA REST API documentation
 
 * {Overview}[https://developer.atlassian.com/display/JIRADEV/JIRA+REST+APIs]
 * {Reference}[http://docs.atlassian.com/jira/REST/latest/]
 
+== Running tests
+
+Before running tests, you will need a public certificate generated.
+
+```
+rake jira:generate_public_cert
+```
 
 == Setting up the JIRA SDK
 
@@ -76,9 +88,13 @@ 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'
+  require 'jira-ruby'
 
   # Consider the use of :use_ssl and :ssl_verify_mode options if running locally
   # for tests.
@@ -119,7 +135,7 @@ Ensure the JIRA gem is loaded correctly
 
   # Gemfile
   ...
-  gem 'jira-ruby', :require => 'jira'
+  gem 'jira-ruby', :require => 'jira-ruby'
   ...
 
 Add common methods to your application controller and ensure access token
@@ -214,7 +230,7 @@ Create your own controllers for the JIRA resources you wish to access.
 
 Here's the same example as a Sinatra application:
 
-  require 'jira'
+  require 'jira-ruby'
   class App < Sinatra::Base
     enable :sessions
 
@@ -273,7 +289,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 +300,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

@@ -1,5 +1,5 @@
 require 'pp'
-require './lib/jira'
+require './lib/jira-ruby'
 
 CONSUMER_KEY = 'test'
 SITE         = 'https://test.jira.com'
@@ -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/http-basic-example.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 require 'pp'
-require 'jira'
+require 'jira-ruby'
 
 if ARGV.length == 0
   # If not passed any command line arguments, prompt the

data/jira-ruby.gemspec

@@ -1,27 +1,33 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "jira/version"
+$:.push File.expand_path('../lib', __FILE__)
+require 'jira/version'
 
 Gem::Specification.new do |s|
-  s.name        = "jira-ruby"
+  s.name        = 'jira-ruby'
   s.version     = JIRA::VERSION
-  s.authors     = ["SUMO Heavy Industries"]
-  s.homepage    = "http://www.sumoheavy.com"
+  s.authors     = ['SUMO Heavy Industries']
+  s.homepage    = 'http://www.sumoheavy.com'
   s.summary     = %q{Ruby Gem for use with the Atlassian JIRA REST API}
   s.description = %q{API for JIRA}
-  s.licenses    = ["OSL-3.0"]
+  s.licenses    = ['OSL-3.0']
 
-  s.rubyforge_project = "jira-ruby"
+  s.rubyforge_project = 'jira-ruby'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 
-  s.add_development_dependency "railties"
-  s.add_runtime_dependency "oauth", '~> 0.4.7'
-  s.add_runtime_dependency "activesupport"
-  s.add_development_dependency "webmock", '~> 1.18.0'
-  s.add_development_dependency "rspec", '~> 3.0.0'
-  s.add_development_dependency "rake", '~> 10.3.2'
+  # Rubtime Dependencies
+  s.add_runtime_dependency 'oauth', '~> 0.5', '>= 0.5.0'
+  s.add_runtime_dependency 'activesupport', '~> 4.2', '>= 4.2.0'
+
+  # Development Dependencies
+  s.add_development_dependency 'railties', '~> 4.2', '>= 4.2.0'
+  s.add_development_dependency 'webmock',  '~> 1.18', '>= 1.18.0'
+  s.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
+  s.add_development_dependency 'rake', '~> 10.3', '>= 10.3.2'
+  s.add_development_dependency 'guard', '~> 2.13', '>= 2.13.0'
+  s.add_development_dependency 'guard-rspec', '~> 4.6', '>= 4.6.5'
+  s.add_development_dependency 'pry', '~> 0.10', '>= 0.10.3'
 end

data/lib/{jira.rb → jira-ruby.rb}

@@ -2,7 +2,7 @@ $: << File.expand_path(File.dirname(__FILE__))
 
 require 'active_support/inflector'
 ActiveSupport::Inflector.inflections do |inflector|
-  inflector.singular 'status', 'status'
+  inflector.singular /status$/, 'status'
 end
 
 require 'jira/base'
@@ -29,8 +29,12 @@ require 'jira/resource/issue'
 require 'jira/resource/filter'
 require 'jira/resource/field'
 require 'jira/resource/rapidview'
+require 'jira/resource/resolution'
 require 'jira/resource/serverinfo'
-
+require 'jira/resource/createmeta'
+require 'jira/resource/webhook'
+require 'jira/resource/agile'
+require 'jira/resource/sprint'
 require 'jira/request_client'
 require 'jira/oauth_client'
 require 'jira/http_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,10 +35,10 @@ 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
+    delegate_to_target_class :all, :find, :collection_path, :singular_path, :jql, :get_backlog_issues, :get_sprints, :get_sprint_issues
 
     # This method needs special handling as it has a default argument value
     def build(attrs={})

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:
@@ -101,6 +109,10 @@ module JIRA
       JIRA::Resource::StatusFactory.new(self)
     end
 
+    def Resolution # :nodoc:
+      JIRA::Resource::ResolutionFactory.new(self)
+    end
+
     def Comment # :nodoc:
       JIRA::Resource::CommentFactory.new(self)
     end
@@ -133,10 +145,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
@@ -149,6 +169,14 @@ module JIRA
       JIRA::Resource::RemotelinkFactory.new(self)
     end
 
+    def Sprint
+      JIRA::Resource::SprintFactory.new(self)
+    end
+
+    def Agile
+      JIRA::Resource::AgileFactory.new(self)
+    end
+
     # HTTP methods without a body
     def delete(path, headers = {})
       request(:delete, path, nil, merge_default_headers(headers))
@@ -176,6 +204,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/agile.rb

@@ -0,0 +1,54 @@
+require 'cgi'
+
+module JIRA
+  module Resource
+
+    class AgileFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Agile < JIRA::Base
+
+      def self.all(client)
+        response = client.get(path_base(client) + '/board')
+        parse_json(response.body)
+      end
+
+      def self.get_backlog_issues(client, board_id, options = {})
+        options[:maxResults] ||= 100
+        response = client.get("/rest/agile/1.0/board/#{board_id}/backlog?maxResults=#{options[:maxResults]}")
+        parse_json(response.body)
+      end
+
+      def self.get_sprints(client, board_id, options = {})
+        options[:maxResults] ||= 100
+        response = client.get("/rest/agile/1.0/board/#{board_id}/sprint?maxResults=#{options[:maxResults]}")
+        parse_json(response.body)
+      end
+
+      def self.get_sprint_issues(client, sprint_id, options = {})
+        options[:maxResults] ||= 100
+        response = client.get("/rest/agile/1.0/sprint/#{sprint_id}/issue?maxResults=#{options[:maxResults]}")
+        parse_json(response.body)
+      end
+
+      # def self.find(client, key, options = {})
+      #   options[:maxResults] ||= 100
+      #   fields = options[:fields].join(',') unless options[:fields].nil?
+      #   response = client.get("/rest/api/latest/search?jql=sprint=#{key}&fields=#{fields}&maxResults=#{options[:maxResults]}")
+      #   parse_json(response.body)
+      # end
+
+      private
+
+      def self.path_base(client)
+        client.options[:context_path] + '/rest/agile/1.0'
+      end
+
+      def path_base(client)
+        self.class.path_base(client)
+      end
+
+    end
+
+  end
+end