jira-ruby 0.0.4 → 0.1.0

data/spec/jira/http_client_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe JIRA::HttpClient do
+
+  let(:basic_client) do
+    options = JIRA::Client::DEFAULT_OPTIONS.merge(JIRA::HttpClient::DEFAULT_OPTIONS)
+    JIRA::HttpClient.new(options)
+  end
+
+  let(:response) do
+    response = mock("response")
+    response.stub(:kind_of?).with(Net::HTTPSuccess).and_return(true)
+    response
+  end
+
+  it "creates an instance of Net:HTTP for a basic auth client" do
+    basic_client.basic_auth_http_conn.class.should == Net::HTTP
+  end
+
+  it "responds to the http methods" do
+    body = ''
+    headers = mock()
+    basic_auth_http_conn = mock()
+    request = mock()
+    basic_client.stub(:basic_auth_http_conn => basic_auth_http_conn)
+    request.should_receive(:basic_auth)
+           .with(basic_client.options[:username], basic_client.options[:password])
+           .exactly(5).times.and_return(request)
+    basic_auth_http_conn.should_receive(:request).exactly(5).times.with(request).and_return(response)
+    [:delete, :get, :head].each do |method|
+      Net::HTTP.const_get(method.capitalize).should_receive(:new).with('/path', headers).and_return(request)
+      basic_client.make_request(method, '/path', nil, headers).should == response
+    end
+    [:post, :put].each do |method|
+      Net::HTTP.const_get(method.capitalize).should_receive(:new).with('/path', headers).and_return(request)
+      request.should_receive(:body=).with(body).and_return(request)
+      basic_client.make_request(method, '/path', body, headers).should == response
+    end
+  end
+
+  it "performs a basic http client request" do
+    body = nil
+    headers = mock()
+    basic_auth_http_conn = mock()
+    http_request = mock()
+    Net::HTTP::Get.should_receive(:new).with('/foo', headers).and_return(http_request)
+
+    basic_auth_http_conn.should_receive(:request).with(http_request).and_return(response)
+    http_request.should_receive(:basic_auth).with(basic_client.options[:username], basic_client.options[:password]).and_return(http_request)
+    basic_client.stub(:basic_auth_http_conn => basic_auth_http_conn)
+    basic_client.make_request(:get, '/foo', body, headers)
+  end
+
+  it "returns a URI" do
+    uri = URI.parse(basic_client.options[:site])
+    basic_client.uri.should == uri
+  end
+
+  it "sets up a http connection with options" do
+    http_conn = mock()
+    uri = mock()
+    host = mock()
+    port = mock()
+    uri.should_receive(:host).and_return(host)
+    uri.should_receive(:port).and_return(port)
+    Net::HTTP.should_receive(:new).with(host, port).and_return(http_conn)
+    http_conn.should_receive(:use_ssl=).with(basic_client.options[:use_ssl]).and_return(http_conn)
+    http_conn.should_receive(:verify_mode=).with(basic_client.options[:ssl_verify_mode]).and_return(http_conn)
+    basic_client.http_conn(uri).should == http_conn
+  end
+
+  it "returns a http connection" do
+    http_conn = mock()
+    uri = mock()
+    basic_client.should_receive(:uri).and_return(uri)
+    basic_client.should_receive(:http_conn).and_return(http_conn)
+    basic_client.basic_auth_http_conn.should == http_conn
+  end
+end

data/spec/jira/oauth_client_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe JIRA::OauthClient do
+
+  let(:oauth_client) do
+    options = { :consumer_key => 'foo', :consumer_secret => 'bar' }
+    options = JIRA::Client::DEFAULT_OPTIONS.merge(options)
+    JIRA::OauthClient.new(options)
+  end
+
+  let(:response) do
+    response = mock("response")
+    response.stub(:kind_of?).with(Net::HTTPSuccess).and_return(true)
+    response
+  end
+  
+  describe "authenticating with oauth" do
+    it "prepends the context path to all authorization and rest paths" do
+      options = [:request_token_path, :authorize_path, :access_token_path]
+      defaults = JIRA::Client::DEFAULT_OPTIONS.merge(JIRA::OauthClient::DEFAULT_OPTIONS)
+      options.each do |key|
+        oauth_client.options[key].should == defaults[:context_path] + defaults[key]
+      end
+    end
+
+    it "creates a Oauth::Consumer on initialize" do
+      oauth_client.consumer.class.should == OAuth::Consumer
+      oauth_client.consumer.key.should == oauth_client.key
+      oauth_client.consumer.secret.should == oauth_client.secret
+    end
+
+    it "returns an OAuth request_token" do
+      # Cannot just check for method delegation as http connection will be attempted
+      request_token = OAuth::RequestToken.new(oauth_client.consumer)
+      oauth_client.consumer.stub(:get_request_token => request_token)
+      oauth_client.get_request_token.should == request_token
+    end
+
+    it "allows setting the request token" do
+      token = mock()
+      OAuth::RequestToken.should_receive(:new).with(oauth_client.consumer, 'foo', 'bar').and_return(token)
+
+      request_token = oauth_client.set_request_token('foo', 'bar')
+
+      request_token.should == token
+      oauth_client.request_token.should == token
+    end
+
+    it "allows setting the consumer key" do
+      oauth_client.key.should == 'foo'
+    end
+
+    it "allows setting the consumer secret" do
+      oauth_client.secret.should == 'bar'
+    end
+
+    describe "the access token" do
+
+      it "initializes" do
+        request_token = OAuth::RequestToken.new(oauth_client.consumer)
+        oauth_client.consumer.stub(:get_request_token => request_token)
+        mock_access_token = mock()
+        request_token.should_receive(:get_access_token).with(:oauth_verifier => 'abc123').and_return(mock_access_token)
+        oauth_client.init_access_token(:oauth_verifier => 'abc123')
+        oauth_client.access_token.should == mock_access_token
+      end
+
+      it "raises an exception when accessing without initialisation" do
+        expect {
+          oauth_client.access_token
+        }.to raise_exception(JIRA::OauthClient::UninitializedAccessTokenError, 
+                             "init_access_token must be called before using the client")
+      end
+
+      it "allows setting the access token" do
+        token = mock()
+        OAuth::AccessToken.should_receive(:new).with(oauth_client.consumer, 'foo', 'bar').and_return(token)
+
+        access_token = oauth_client.set_access_token('foo', 'bar')
+
+        access_token.should         == token
+        oauth_client.access_token.should == token
+      end
+    end
+
+    describe "http" do
+      it "responds to the http methods" do
+        headers = mock()
+        mock_access_token = mock()
+        oauth_client.stub(:access_token => mock_access_token)
+        [:delete, :get, :head].each do |method|
+          mock_access_token.should_receive(method).with('/path', headers).and_return(response)
+          oauth_client.make_request(method, '/path', '', headers)
+        end
+        [:post, :put].each do |method|
+          mock_access_token.should_receive(method).with('/path', '', headers).and_return(response)
+          oauth_client.make_request(method, '/path', '', headers)
+        end
+      end
+
+      it "performs a request" do
+        body = nil
+        headers = mock()
+        access_token = mock()
+        access_token.should_receive(:send).with(:get, '/foo', headers).and_return(response)
+        oauth_client.stub(:access_token => access_token)
+        oauth_client.request(:get, '/foo', body, headers)
+      end
+    end
+  end
+end

data/spec/jira/request_client_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe JIRA::RequestClient do
+
+  it "raises an exception for non success responses" do
+    response = mock()
+    response.stub(:kind_of?).with(Net::HTTPSuccess).and_return(false)
+    rc = JIRA::RequestClient.new
+    rc.should_receive(:make_request).with(:get, '/foo', '', {}).and_return(response)
+    expect {
+      rc.request(:get, '/foo', '', {})
+    }.to raise_exception(JIRA::HTTPError)
+  end
+end

data/spec/spec_helper.rb

@@ -7,7 +7,7 @@ Dir["./spec/support/**/*.rb"].each {|f| require f}
 require 'jira'
 
 RSpec.configure do |config|
-
+  config.extend ClientsHelper
 end
 
 

data/spec/support/clients_helper.rb

@@ -0,0 +1,16 @@
+module ClientsHelper
+  def with_each_client
+    clients = {}
+
+    oauth_client = JIRA::Client.new({ :consumer_key => 'foo', :consumer_secret => 'bar' })
+    oauth_client.set_access_token('abc', '123')
+    clients["http://localhost:2990"] = oauth_client
+
+    basic_client = JIRA::Client.new({ :username => 'foo', :password => 'bar', :auth_type => :basic, :use_ssl => false })
+    clients["http://foo:bar@localhost:2990"] = basic_client
+
+    clients.each do |site_url, client|
+      yield site_url, client
+    end
+  end
+end

data/spec/support/shared_examples/integration.rb

@@ -55,7 +55,7 @@ shared_examples "a resource" do
     else
       subject = client.send(class_basename).build(described_class.key_attribute.to_s => '99999')
     end
-    stub_request(:put, 'http://localhost:2990' + subject.url).
+    stub_request(:put, site_url + subject.url).
                 to_return(:status => 405, :body => "<html><body>Some HTML</body></html>")
     subject.save('foo' => 'bar').should be_false
     lambda do
@@ -68,7 +68,7 @@ end
 shared_examples "a resource with a collection GET endpoint" do
 
   it "should get the collection" do
-    stub_request(:get, "http://localhost:2990" + described_class.collection_path(client)).
+    stub_request(:get, site_url + described_class.collection_path(client)).
                  to_return(:status => 200, :body => get_mock_from_path(:get))
     collection = build_receiver.all
     collection.length.should == expected_collection_length
@@ -84,7 +84,7 @@ shared_examples "a resource with a singular GET endpoint" do
   it "GETs a single resource" do
     # E.g., for JIRA::Resource::Project, we need to call
     # client.Project.find()
-    stub_request(:get, "http://localhost:2990" + described_class.singular_path(client, key, prefix)).
+    stub_request(:get, site_url + described_class.singular_path(client, key, prefix)).
                 to_return(:status => 200, :body => get_mock_from_path(:get, :key => key))
     subject = client.send(class_basename).find(key, options)
 
@@ -94,7 +94,7 @@ shared_examples "a resource with a singular GET endpoint" do
   it "builds and fetches a single resource" do
     # E.g., for JIRA::Resource::Project, we need to call
     # client.Project.build('key' => 'ABC123')
-    stub_request(:get, "http://localhost:2990" + described_class.singular_path(client, key, prefix)).
+    stub_request(:get, site_url + described_class.singular_path(client, key, prefix)).
                 to_return(:status => 200, :body => get_mock_from_path(:get, :key => key))
 
     subject = build_receiver.build(described_class.key_attribute.to_s => key)
@@ -104,7 +104,7 @@ shared_examples "a resource with a singular GET endpoint" do
   end
 
   it "handles a 404" do
-    stub_request(:get, "http://localhost:2990" + described_class.singular_path(client, '99999', prefix)).
+    stub_request(:get, site_url + described_class.singular_path(client, '99999', prefix)).
                 to_return(:status => 404, :body => '{"errorMessages":["'+class_basename+' Does Not Exist"],"errors": {}}')
     lambda do
       client.send(class_basename).find('99999', options)
@@ -116,7 +116,7 @@ shared_examples "a resource with a DELETE endpoint" do
   it "deletes a resource" do
     # E.g., for JIRA::Resource::Project, we need to call
     # client.Project.delete()
-    stub_request(:delete, "http://localhost:2990" + described_class.singular_path(client, key, prefix)).
+    stub_request(:delete, site_url + described_class.singular_path(client, key, prefix)).
                 to_return(:status => 204, :body => nil)
 
     subject = build_receiver.build(described_class.key_attribute.to_s => key)
@@ -127,7 +127,7 @@ end
 shared_examples "a resource with a POST endpoint" do
 
   it "saves a new resource" do
-    stub_request(:post, "http://localhost:2990" + described_class.collection_path(client, prefix)).
+    stub_request(:post, site_url + described_class.collection_path(client, prefix)).
                 to_return(:status => 201, :body => get_mock_from_path(:post))
     subject = build_receiver.build
     subject.save(attributes_for_post).should be_true
@@ -141,9 +141,9 @@ end
 shared_examples "a resource with a PUT endpoint" do
 
   it "saves an existing component" do
-    stub_request(:get, "http://localhost:2990" + described_class.singular_path(client, key, prefix)).
+    stub_request(:get, site_url + described_class.singular_path(client, key, prefix)).
                 to_return(:status => 200, :body => get_mock_from_path(:get, :key =>key))
-    stub_request(:put, "http://localhost:2990" + described_class.singular_path(client, key, prefix)).
+    stub_request(:put, site_url + described_class.singular_path(client, key, prefix)).
                   to_return(:status => 200, :body => get_mock_from_path(:put, :key => key, :value_if_not_found => nil))
     subject = build_receiver.build(described_class.key_attribute.to_s => key)
     subject.fetch
@@ -158,9 +158,9 @@ end
 shared_examples 'a resource with a PUT endpoint that rejects invalid fields' do
 
   it "fails to save with an invalid field" do
-    stub_request(:get, "http://localhost:2990" + described_class.singular_path(client, key)).
+    stub_request(:get, site_url + described_class.singular_path(client, key)).
                 to_return(:status => 200, :body => get_mock_from_path(:get, :key => key))
-    stub_request(:put, "http://localhost:2990" + described_class.singular_path(client, key)).
+    stub_request(:put, site_url + described_class.singular_path(client, key)).
                 to_return(:status => 400, :body => get_mock_from_path(:put, :key => key, :suffix => "invalid"))
     subject = client.send(class_basename).build(described_class.key_attribute.to_s => key)
     subject.fetch

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-15 00:00:00.000000000Z
+date: 2012-07-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70194827879980 !ruby/object:Gem::Requirement
+  requirement: &70203258317280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70194827879980
+  version_requirements: *70203258317280
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70194827879560 !ruby/object:Gem::Requirement
+  requirement: &70203258316860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70194827879560
+  version_requirements: *70203258316860
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &70194827879140 !ruby/object:Gem::Requirement
+  requirement: &70203258316440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70194827879140
+  version_requirements: *70203258316440
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &70194827878720 !ruby/object:Gem::Requirement
+  requirement: &70203258316020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70194827878720
+  version_requirements: *70203258316020
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70194827878300 !ruby/object:Gem::Requirement
+  requirement: &70203258315600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70194827878300
+  version_requirements: *70203258315600
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70194827877880 !ruby/object:Gem::Requirement
+  requirement: &70203258315180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70194827877880
+  version_requirements: *70203258315180
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70194827877460 !ruby/object:Gem::Requirement
+  requirement: &70203258314760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70194827877460
+  version_requirements: *70203258314760
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70194827877040 !ruby/object:Gem::Requirement
+  requirement: &70203258314340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70194827877040
+  version_requirements: *70203258314340
 description: API for JIRA 5
 email: 
 executables: []
@@ -110,14 +110,18 @@ files:
 - README.rdoc
 - Rakefile
 - example.rb
+- http-basic-example.rb
 - jira-ruby.gemspec
 - lib/jira.rb
 - lib/jira/base.rb
 - lib/jira/base_factory.rb
 - lib/jira/client.rb
 - lib/jira/has_many_proxy.rb
+- lib/jira/http_client.rb
 - lib/jira/http_error.rb
+- lib/jira/oauth_client.rb
 - lib/jira/railtie.rb
+- lib/jira/request_client.rb
 - lib/jira/resource/attachment.rb
 - lib/jira/resource/comment.rb
 - lib/jira/resource/component.rb
@@ -147,7 +151,10 @@ files:
 - spec/jira/base_spec.rb
 - spec/jira/client_spec.rb
 - spec/jira/has_many_proxy_spec.rb
+- spec/jira/http_client_spec.rb
 - spec/jira/http_error_spec.rb
+- spec/jira/oauth_client_spec.rb
+- spec/jira/request_client_spec.rb
 - spec/jira/resource/attachment_spec.rb
 - spec/jira/resource/issue_spec.rb
 - spec/jira/resource/project_factory_spec.rb
@@ -186,6 +193,7 @@ files:
 - spec/mock_responses/version/10000.json
 - spec/mock_responses/version/10000.put.json
 - spec/spec_helper.rb
+- spec/support/clients_helper.rb
 - spec/support/matchers/have_attributes.rb
 - spec/support/matchers/have_many.rb
 - spec/support/matchers/have_one.rb
@@ -230,7 +238,10 @@ test_files:
 - spec/jira/base_spec.rb
 - spec/jira/client_spec.rb
 - spec/jira/has_many_proxy_spec.rb
+- spec/jira/http_client_spec.rb
 - spec/jira/http_error_spec.rb
+- spec/jira/oauth_client_spec.rb
+- spec/jira/request_client_spec.rb
 - spec/jira/resource/attachment_spec.rb
 - spec/jira/resource/issue_spec.rb
 - spec/jira/resource/project_factory_spec.rb
@@ -269,6 +280,7 @@ test_files:
 - spec/mock_responses/version/10000.json
 - spec/mock_responses/version/10000.put.json
 - spec/spec_helper.rb
+- spec/support/clients_helper.rb
 - spec/support/matchers/have_attributes.rb
 - spec/support/matchers/have_many.rb
 - spec/support/matchers/have_one.rb