jira-ruby 0.0.3 → 0.0.4

data/Gemfile

@@ -2,4 +2,3 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in jira_api.gemspec
 gemspec
-gem 'rspec'

data/README.rdoc

@@ -76,8 +76,21 @@ The gem requires the consumer key and public certificate file (which
 are generated in their respective rake tasks) to initialize an access token for
 using the JIRA API.
 
+Note that currently the rake task which generates the public certificate
+requires OpenSSL to be installed on the machine.
+
 Below is an example for setting up a rails application for OAuth authorization.
 
+Ensure the JIRA gem is loaded correctly
+
+  # Gemfile
+  ...
+  gem 'jira-ruby', :require => 'jira'
+  ...
+
+Add common methods to your application controller and ensure access token
+errors are handled gracefully
+
   # app/controllers/application_controller.rb
   class ApplicationController < ActionController::Base
     protect_from_forgery
@@ -107,8 +120,6 @@ Below is an example for setting up a rails application for OAuth authorization.
 Create a controller for handling the OAuth conversation.
 
   # app/controllers/jira_sessions_controller.rb
-  require 'jira'
-
   class JiraSessionsController < ApplicationController
 
     before_filter :get_jira_client
@@ -173,12 +184,13 @@ Here's the same example as a Sinatra application:
     before do
       options = {
         :site               => 'http://localhost:2990',
+        :context_path       => '/jira',
         :signature_method   => 'RSA-SHA1',
-        :request_token_path => "/jira/plugins/servlet/oauth/request-token",
-        :authorize_path     => "/jira/plugins/servlet/oauth/authorize",
-        :access_token_path  => "/jira/plugins/servlet/oauth/access-token",
+        :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     => "/jira/rest/api/2"
+        :rest_base_path     => "/rest/api/2"
       }
 
       @jira_client = JIRA::Client.new('jira-ruby-example', '', options)

data/jira-ruby.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "activesupport"
   s.add_development_dependency "activesupport"
   s.add_development_dependency "webmock"
+  s.add_development_dependency "rspec"
 end

data/lib/jira.rb

@@ -24,3 +24,4 @@ require 'jira/resource/issue'
 
 require 'jira/client'
 
+require 'jira/railtie' if defined?(Rails)

data/lib/jira/base.rb

@@ -92,7 +92,6 @@ module JIRA
     def self.all(client, options = {})
       response = client.get(collection_path(client))
       json = parse_json(response.body)
-      puts collection_attributes_are_nested
       if collection_attributes_are_nested
         json = json[endpoint_name.pluralize]
       end
@@ -275,6 +274,10 @@ module JIRA
       @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

data/lib/jira/client.rb

@@ -11,12 +11,13 @@ module JIRA
   # are:
   #
   #   :site               => 'http://localhost:2990',
+  #   :context_path       => '/jira',
   #   :signature_method   => 'RSA-SHA1',
-  #   :request_token_path => "/jira/plugins/servlet/oauth/request-token",
-  #   :authorize_path     => "/jira/plugins/servlet/oauth/authorize",
-  #   :access_token_path  => "/jira/plugins/servlet/oauth/access-token",
+  #   :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     => "/jira/rest/api/2"
+  #   :rest_base_path     => "/rest/api/2"
   #
   #
   # See the JIRA::Base class methods for all of the available methods on these accessor
@@ -40,21 +41,28 @@ module JIRA
     # The configuration options for this client instance
     attr_reader :options
 
-    delegate [:key, :secret, :get_request_token] => :consumer
+    def_instance_delegators :@consumer, :key, :secret, :get_request_token
 
     DEFAULT_OPTIONS = {
       :site               => 'http://localhost:2990',
+      :context_path       => '/jira',
       :signature_method   => 'RSA-SHA1',
-      :request_token_path => "/jira/plugins/servlet/oauth/request-token",
-      :authorize_path     => "/jira/plugins/servlet/oauth/authorize",
-      :access_token_path  => "/jira/plugins/servlet/oauth/access-token",
+      :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     => "/jira/rest/api/2"
+      :rest_base_path     => "/rest/api/2"
     }
 
     def initialize(consumer_key, consumer_secret, options={})
       options = DEFAULT_OPTIONS.merge(options)
 
+      # prepend the context path to all authorization and rest paths
+      options[:request_token_path] = options[:context_path] + options[:request_token_path]
+      options[:authorize_path] = options[:context_path] + options[:authorize_path]
+      options[:access_token_path] = options[:context_path] + options[:access_token_path]
+      options[:rest_base_path] = options[:context_path] + options[:rest_base_path]
+
       @options = options
       @options.freeze
       @consumer = OAuth::Consumer.new(consumer_key,consumer_secret,options)

data/lib/jira/http_error.rb

@@ -4,7 +4,7 @@ module JIRA
   class HTTPError < StandardError
     extend Forwardable
 
-    delegate [:message, :code] => :response
+    def_instance_delegators :@response, :message, :code
     attr_reader :response
 
     def initialize(response)

data/lib/jira/railtie.rb

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

data/lib/jira/version.rb

@@ -1,3 +1,3 @@
 module JIRA
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/tasks/generate.rake

@@ -1,8 +1,10 @@
+require 'securerandom'
+
 namespace :jira do
   desc "Generate a consumer key for your application"
   task :generate_consumer_key do
-    #FIXME SERIOUSLY. THIS IS NOT A REAL SOLUTION. I FEEL SO UNCLEAN.
-    system("for i in {1..10}; do echo $RANDOM$RANDOM$RANDOM; done | md5 | awk '{ print \"You can use this as your consumer key: \" $0 }'")
+    key = SecureRandom.hex(16)
+    puts "You can use this as your consumer key: #{key}"
   end
 
   desc "Run the system call to generate a RSA public certificate"

data/spec/jira/base_spec.rb

@@ -358,7 +358,7 @@ describe JIRA::Base do
     subject.attrs['foo']  = 'bar'
     subject.attrs['dead'] = 'beef'
 
-    subject.to_s.should match(/#<JIRA::Resource::Deadbeef:\d+ @attrs=#{attrs.inspect}>/)
+    subject.to_s.should match(/#<JIRA::Resource::Deadbeef:\d+ @attrs=#{Regexp.quote(attrs.inspect)}>/)
   end
 
   it "returns the key attribute" do
@@ -373,7 +373,7 @@ describe JIRA::Base do
   it "converts to json" do
     subject.attrs = {"foo" => "bar","dead" => "beef"}
 
-    subject.to_json.should == '{"foo":"bar","dead":"beef"}'
+    subject.to_json.should == subject.attrs.to_json
   end
 
   describe "extract attrs from response" do

data/spec/jira/client_spec.rb

@@ -22,9 +22,10 @@ describe JIRA::Client do
     subject.secret.should == 'bar'
   end
 
-  it "sets the default options" do
-    JIRA::Client::DEFAULT_OPTIONS.each do |key, value|
-      subject.options[key].should == value
+  it "sets the non path default options" do
+    options = [:site, :signature_method, :private_key_file]
+    options.each do |key|
+      subject.options[key].should == JIRA::Client::DEFAULT_OPTIONS[key]
     end
   end
 
@@ -32,15 +33,15 @@ describe JIRA::Client do
     # Check it overrides a given option ...
     client = JIRA::Client.new('foo', 'bar', :site => 'http://foo.com/')
     client.options[:site].should == 'http://foo.com/'
+    JIRA::Client::DEFAULT_OPTIONS[:site].should_not == 'http://foo.com/'
+  end
 
-    # ... but leaves the rest intact
-    JIRA::Client::DEFAULT_OPTIONS.keys.reject do |key|
-      key == :site
-    end.each do |key|
-      client.options[key].should == JIRA::Client::DEFAULT_OPTIONS[key]
+  it "prepends the context path to all authorization and rest paths" do
+    options = [:request_token_path, :authorize_path, :access_token_path, :rest_base_path]
+    defaults = JIRA::Client::DEFAULT_OPTIONS
+    options.each do |key|
+      subject.options[key].should == defaults[:context_path] + defaults[key]
     end
-
-    JIRA::Client::DEFAULT_OPTIONS[:site].should_not == 'http://foo.com/'
   end
 
   # To avoid having to validate options after initialisation, e.g. setting

data/spec/jira/resource/issue_spec.rb

@@ -8,10 +8,10 @@ describe JIRA::Resource::Issue do
     response = mock()
     response.stub(:body).and_return('{"key":"foo","id":"101"}')
     JIRA::Resource::Issue.stub(:collection_path).and_return('/jira/rest/api/2/issue')
-    client.should_receive(:get).with('/jira/rest/api/2/issue/foo')
-    .and_return(response)
-    client.should_receive(:get).with('/jira/rest/api/2/issue/101')
-    .and_return(response)
+    client.should_receive(:get).with('/jira/rest/api/2/issue/foo').
+      and_return(response)
+    client.should_receive(:get).with('/jira/rest/api/2/issue/101').
+      and_return(response)
 
     issue_from_id = JIRA::Resource::Issue.find(client,101)
     issue_from_key = JIRA::Resource::Issue.find(client,'foo')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-30 00:00:00.000000000Z
+date: 2012-07-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70202332043180 !ruby/object:Gem::Requirement
+  requirement: &70194827879980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70202332043180
+  version_requirements: *70194827879980
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70202332042760 !ruby/object:Gem::Requirement
+  requirement: &70194827879560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70202332042760
+  version_requirements: *70194827879560
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &70202332042340 !ruby/object:Gem::Requirement
+  requirement: &70194827879140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70202332042340
+  version_requirements: *70194827879140
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &70202332041920 !ruby/object:Gem::Requirement
+  requirement: &70194827878720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70202332041920
+  version_requirements: *70194827878720
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70202332041500 !ruby/object:Gem::Requirement
+  requirement: &70194827878300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70202332041500
+  version_requirements: *70194827878300
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70202332041080 !ruby/object:Gem::Requirement
+  requirement: &70194827877880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70202332041080
+  version_requirements: *70194827877880
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70202332040660 !ruby/object:Gem::Requirement
+  requirement: &70194827877460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70202332040660
+  version_requirements: *70194827877460
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70194827877040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70194827877040
 description: API for JIRA 5
 email: 
 executables: []
@@ -106,6 +117,7 @@ files:
 - lib/jira/client.rb
 - lib/jira/has_many_proxy.rb
 - lib/jira/http_error.rb
+- lib/jira/railtie.rb
 - lib/jira/resource/attachment.rb
 - lib/jira/resource/comment.rb
 - lib/jira/resource/component.rb