fisheye-crucible 0.0.1

data/History.txt

@@ -0,0 +1,15 @@
+=== 0.0.1 2010-07-15
+
+* Added support for Fisheye/Crucible's Legacy API.  Methods supported:
+  * login
+  * logout
+  * fisheye_version
+  * crucible_version
+  * repositories
+  * paths
+  * revision
+  * tags
+  * path_history
+  * changeset
+  * changesets
+  * query

data/Manifest.txt

@@ -0,0 +1,30 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+features/authenticate.feature
+features/client_legacy.feature
+features/development.feature
+features/step_definitions/authenticate_steps.rb
+features/step_definitions/client_legacy_steps.rb
+features/step_definitions/common_steps.rb
+features/support/common.rb
+features/support/config.yaml
+features/support/env.rb
+features/support/hooks.rb
+features/support/matchers.rb
+lib/fisheye-crucible.rb
+lib/fisheye-crucible/client.rb
+lib/fisheye-crucible/client/legacy.rb
+lib/fisheye-crucible/type_converter.rb
+lib/fisheye_crucible_exception.rb
+script/console
+script/destroy
+script/generate
+spec/client/legacy_spec.rb
+spec/client_spec.rb
+spec/fisheye-crucible_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,6 @@
+
+Thanks for installing fisheye-crucible, I hope you get some good use out of it.
+
+For more information on fisheye-crucible, see http://github.com/turboladen/fisheye-crucible
+
+

data/README.rdoc

@@ -0,0 +1,75 @@
+= fisheye-crucible
+
+* http://github.com/turboladen/fisheye-crucible
+
+== DESCRIPTION:
+
+This gem is a wrapper around the REST API for Atlassian's {Fisheye}[http://www.atlassian.com/software/fisheye/] and {Crucible}[http://www.atlassian.com/software/crucible/].  It currently only provides access to their {legacy API}[http://confluence.atlassian.com/display/FECRUDEV/FishEye+Legacy+Remote+API];  
+wrapping of the current API is in the works.
+
+I want to keep the dependency list low, so at this point XML parsing is all done
+with REXML.
+
+== FEATURES/PROBLEMS:
+
+* Legacy API (<=1.6.x) calls work
+* Current API (2.x) calls no workie (yet!), although 2.x installs with legacy support turned on can use the legacy API just fine.
+* Access methods via Ruby style method calls _or_ the API function name:
+
+Ruby style:
+
+  fc.repositories
+
+Fisheye/Crucible API style:
+
+  fc.listRepositories
+
+
+== SYNOPSIS:
+
+A quick example:
+
+  require 'fisheye-crucible/client/legacy'
+  
+  server = 'http://sandbox.fisheye.atlassian.com'
+  fc = FisheyeCrucible::Client::Legacy.new(server)
+  fc.login 'guy', 'smiley'
+  fc.fisheye_version      # => "2.2.4"
+  fc.repositories         # => ['antlr', 'google-guice', 'rails']
+  
+
+== REQUIREMENTS:
+
+* Ruby
+  * 1.8.7
+  * 1.9.1
+* rest-client
+
+== INSTALL:
+
+* (sudo) gem install fisheye-crucible
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Steve Loveless
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,124 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/fisheye-crucible'
+require 'metric_fu'
+
+Hoe.plugin :newgem
+Hoe.plugin :yard
+# Hoe.plugin :website
+Hoe.plugin :cucumberfeatures
+Hoe.plugin :rubyforge
+
+# Gets the description from the main README file
+def get_descr_from_readme
+  paragraph_count = 0
+  File.readlines('README.rdoc', '').each do |paragraph|
+    paragraph_count += 1
+    if paragraph_count == 4
+      return paragraph
+    end
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'fisheye-crucible' do
+  self.summary            = "REST wrapper around Atlassian's Fisheye/Crucible's API"
+  self.developer 'Steve Loveless', 'steve.loveless@gmail.com'
+  self.post_install_message = File.readlines 'PostInstall.txt'
+  self.rubyforge_name       = self.name
+  self.version              = FisheyeCrucible::VERSION
+  self.url                  = FisheyeCrucible::WWW
+  self.description          = get_descr_from_readme
+  self.readme_file          = 'README.rdoc'
+  self.history_file         = 'History.txt'
+  self.rspec_options        = ['--color', '--format', 'specdoc']
+  self.extra_deps           += [
+    ['rest-client']
+  ]
+  self.extra_dev_deps       += [
+    ['rspec'],
+    ['yard'],
+    ['hoe-yard'],
+    ['cucumber']
+  ]
+  self.test_globs           = 'spec/*.rb'
+
+  # Extra Yard options
+  self.yard_title   = "#{self.name} Documentation (#{self.version})"
+  self.yard_markup  = :rdoc
+  self.yard_opts    += ['--main', self.readme_file]
+  self.yard_opts    += ['--output-dir', 'doc']
+  self.yard_opts    += ['--private']
+  self.yard_opts    += ['--protected']
+  self.yard_opts    += ['--verbose']
+  self.yard_opts    += ['--files', 
+    ['Manifest.txt', 'History.txt']
+  ]    
+end
+
+#-------------------------------------------------------------------------------
+# Overwrite the :clobber_docs Rake task so that it doesn't destroy our docs
+#   directory.
+#-------------------------------------------------------------------------------
+class Rake::Task
+  def overwrite(&block)
+    @actions.clear
+    enhance(&block)
+  end
+end
+
+Rake::Task[:clobber_docs].overwrite do
+end
+
+# Now define the tasks
+require 'newgem/tasks'
+#Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]
+
+MetricFu::Configuration.run do |config|
+  #define which metrics you want to use
+  #config.metrics  = [:churn, :flog, :flay, :reek, :roodi, :rcov, :stats]
+  config.metrics  = [:churn, :flog, :reek, :roodi, :rcov, :stats]
+  #config.graphs   = [:flog, :flay, :reek, :roodi]
+  config.graphs   = [:flog, :reek, :roodi]
+  config.flay     = { :dirs_to_flay => ['lib/fisheye-crucible'],
+                      :minimum_score => 10  } 
+  config.flog     = { :dirs_to_flog => ['lib/fisheye-crucible']  }
+  config.reek     = { :dirs_to_reek => ['lib/fisheye-crucible']  }
+  config.roodi    = { :dirs_to_roodi => ['lib/fisheye-crucible'] }
+  config.churn    = { :start_date => "1 year ago", :minimum_churn_count => 10}
+  config.rcov     = { :environment => 'test',
+                      :test_files => ['spec/*_spec.rb',
+                                      'spec/**/*_spec.rb'],
+                      :rcov_opts => ["--sort coverage", 
+                                     "--no-html", 
+                                     "--text-coverage",
+                                     "--no-color",
+                                     "--profile",
+                                     "--exclude /gems/,/Library/"]}
+  config.graph_engine = :bluff
+end
+
+STATS_DIRECTORIES = [
+  %w(Library            lib/),
+  %w(Unit\ tests        spec/)
+].collect { |name, dir| [ name, "#{dir}" ] }.select { |name, dir| File.directory?(dir) }
+
+begin
+  gem 'rails'
+
+  desc "Report code statistics (KLOCs, etc) from the application"
+  task :stats do
+    require 'code_statistics'
+    CodeStatistics.new(*STATS_DIRECTORIES).to_s
+  end
+rescue LoadError
+  puts "Rails is needed in order to check stats."
+end
+

data/features/authenticate.feature

@@ -0,0 +1,28 @@
+Feature:  Authenticate as a Fisheye/Crucible user
+  As I Fisheye/Crucible user
+  I want to be able to login
+  So that I can programmatically interact with Fisheye and Crucible
+  
+  @negative
+  Scenario: Login with a bad password
+    Given a valid user, "gemtest" and password "gemtest1"
+    When I login with that user's credentials
+    Then I receive an authentication error
+
+  @positive
+  Scenario: Login as a valid user
+    Given a valid user, "gemtest" and password "gemtest"
+    When I login with that user's credentials
+    Then I receive a token back from the server
+
+  @positive
+  Scenario: Logout from valid session
+    Given I have logged in
+    When I logout
+    Then I receive confirmation that I have logged out
+
+  @negative
+  Scenario: Logout when not logged in
+    Given I have not logged in
+    When I logout
+    Then I receive an error telling me I'm not logged in

data/features/client_legacy.feature

@@ -0,0 +1,73 @@
+Feature: Client to the legacy API
+  As a user
+  I want to be able to call the legacy Fisheye/Crucible API
+  So that I can find out information on my server
+  
+  @positive
+  Scenario: fisheyeVersion (==fisheye_version)
+    Given I have logged in
+    When I call "fisheyeVersion"
+    Then I should receive a "String"
+      And that String should be in the form x.x.x  
+
+  @positive
+  Scenario: crucibleVersion (==crucible_version)
+    Given I have logged in
+    When I call "crucibleVersion"
+    Then I should receive a "String"
+      And that String should be in the form x.x.x
+
+  @positive
+  Scenario: listPaths (==list_paths_from)
+    Given I have logged in
+      And I have a list of repositories
+    When I call "listPaths" for the first repository
+    Then I should receive an "Array"
+      And that Array should contain Strings
+
+  Scenario Outline: Make method calls
+    Given I have logged in
+    When I call "<api_method>" with parameters "<parameters>"
+    Then I should receive a "<return_type>"
+
+  @positive
+  Scenarios: Calls return proper types
+    | api_method        | parameters                    | return_type   |
+    | fisheyeVersion    |                               | String        |
+    | crucibleVersion   |                               | String        |
+    | listRepositories  |                               | Array         |
+    | listPaths         | 'antlr'                       | Hash          |
+    | listPaths         | 'antlr','tool'                | Hash          |
+    | getRevision       | 'antlr','BUILD.txt',5847      | Hash          |
+    | pathHistory       | 'antlr','BUILD.txt'           | Array         |
+    | getChangeset      | 'antlr',5847                  | Hash          |
+    | listChangesets    | 'antlr'                       | Hash          |
+    | listChangesets    | 'antlr','tool'                | Hash          |
+    | listChangesets    | 'antlr','tool',1              | Hash          |
+    | listChangesets    | 'antlr','tool',1,'2008-07-05T07:08:16-07:00'| Hash|
+    | listChangesets    | 'antlr','tool',1,'2008-07-05T07:08:16-07:00', '2009-07-05T07:08:16-07:00'| Hash  |
+    | query             | 'antlr','select revisions from dir /tool' | Array |
+    | query             | 'antlr','select revisions from dir /tool return path' | Array |
+    | query             | 'antlr','select revisions from dir /tool return path as test' | Array |
+
+  @negative
+  Scenario Outline: Raise exceptions
+    Given I have logged in
+    When I call "<api_method>" with parameters "<parameters>"
+    Then I should receive an exception of type "<exception_type>"
+
+  Scenarios: Calls throw exception when passed invalid parameters
+    | api_method        | parameters                    | exception_type  |
+    | fisheyeVersion    | 'test'                        | ArgumentError   |
+    | crucibleVersion   | 'test'                        | ArgumentError   |
+    | listRepositories  | 'test'                        | ArgumentError   |
+    | listPaths         | 'blahblahblah'                | FisheyeCrucibleError |
+    | listPaths         | 'antlr','blahblahblah'        | FisheyeCrucibleError |
+    | getRevision       | 'blahblahblah','BUILD.txt',5847  | FisheyeCrucibleError |
+    | getRevision       | 'antlr','blahblahblah',5847   | FisheyeCrucibleError |
+    | getRevision       | 'antlr','BUILD.txt',9999999   | FisheyeCrucibleError |
+    | getRevision       | 'antlr','BUILD.txt','blahblahblah'   | RestClient::InternalServerError |
+    | pathHistory       | 'blahblahblah','BUILD.txt'    | FisheyeCrucibleError |
+    | pathHistory       | 'antlr','blahblahblah'        | FisheyeCrucibleError |
+    | pathHistory       | 'antlr',123456789             | FisheyeCrucibleError |
+

data/features/development.feature

@@ -0,0 +1,13 @@
+Feature: Development processes of newgem itself (rake tasks)
+
+  As a Newgem maintainer or contributor
+  I want rake tasks to maintain and release the gem
+  So that I can spend time on the tests and code, and not excessive time on maintenance processes
+    
+  Scenario: Generate RubyGem
+    Given this project is active project folder
+    And "pkg" folder is deleted
+    When I invoke task "rake gem"
+    Then folder "pkg" is created
+    And file with name matching "pkg/*.gem" is created else you should run "rake manifest" to fix this
+    And gem spec key "rdoc_options" contains /(--mainREADME.rdoc|\[\"--main\", \"README.rdoc\"\])/

data/features/step_definitions/authenticate_steps.rb

@@ -0,0 +1,35 @@
+require 'net/ping/tcp'
+
+Given /^a valid user, "(\w+)" and password "(.+)"$/ do |user, password|
+  @user = user
+  @password = password
+end
+
+When /^I login with that user\'s credentials$/ do
+  @login = lambda { @fc.login(@user, @password) }
+  @login.should_not be_nil
+end
+
+Then /^I receive a token back from the server$/ do
+  @token = @login.call
+  @token.class.should.eql? 'String'
+  @token.should match(/^\w+:\d{3,}:\w{32}$/)
+end
+
+Then /^I receive an authentication error$/ do
+  @login.should raise_error(FisheyeCrucibleError)
+end
+
+When /^I logout$/ do
+  @logout = lambda { @fc.logout }
+  @logout.should_not be_nil
+end
+
+Then /^I receive confirmation that I have logged out$/ do
+  result = @logout.call
+  result.should be_true
+end
+
+Then /^I receive an error telling me I'm not logged in$/ do
+  @logout.should raise_error(FisheyeCrucibleError)
+end

data/features/step_definitions/client_legacy_steps.rb

@@ -0,0 +1,28 @@
+When /^I call "([^"]*)" with parameters "([^"]*)"$/ do |api_method, parameters|
+  @method = lambda { eval("@fc.#{api_method}(#{parameters})") }
+  @method.should_not be_nil
+end
+
+Then /^I should receive an? "([^"]*)"$/ do |result_type|
+  result = @method.call
+  result.class.should == eval("#{result_type}")
+end
+
+Then /^I should receive an exception of type "([^"]*)"$/ do |exception_type|
+  result = @method.should raise_error(eval("#{exception_type}"))
+end
+
+Then /^that String should be in the form x\.x\.x$/ do
+  @result.should match(/\d\.\d(\.\d)?/)
+end
+
+Then /^that Array should contain Strings$/ do
+  @result.each do |r|
+    r.class.should == eval('String')
+  end
+end
+
+Given /^I have a list of repositories$/ do
+  @repos = @fc.repositories
+  @result.should_not be_empty
+end

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,168 @@
+Given /^this project is active project folder/ do
+  @active_project_folder = File.expand_path(File.dirname(__FILE__) + "/../..")
+end
+
+Given /^env variable \$([\w_]+) set to "(.*)"/ do |env_var, value|
+  ENV[env_var] = value
+end
+
+Given /"(.*)" folder is deleted/ do |folder|
+  in_project_folder { FileUtils.rm_rf folder }
+end
+
+When /^I invoke "(.*)" generator with arguments "(.*)"$/ do |generator, arguments|
+  @stdout = StringIO.new
+  in_project_folder do
+    if Object.const_defined?("APP_ROOT")
+      APP_ROOT.replace(FileUtils.pwd)
+    else 
+      APP_ROOT = FileUtils.pwd
+    end
+    run_generator(generator, arguments.split(' '), SOURCES, :stdout => @stdout)
+  end
+  File.open(File.join(@tmp_root, "generator.out"), "w") do |f|
+    @stdout.rewind
+    f << @stdout.read
+  end
+end
+
+When /^I run executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  in_project_folder do
+    system "#{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When /^I run project executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  in_project_folder do
+    system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When /^I run local executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  executable = File.expand_path(File.join(File.dirname(__FILE__), "/../../bin", executable))
+  in_project_folder do
+    system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When /^I invoke task "rake (.*)"/ do |task|
+  @stdout = File.expand_path(File.join(@tmp_root, "tests.out"))
+  in_project_folder do
+    system "rake #{task} --trace > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+Then /^folder "(.*)" (is|is not) created/ do |folder, is|
+  in_project_folder do
+    File.exists?(folder).should(is == 'is' ? be_true : be_false)
+  end
+end
+
+Then /^file "(.*)" (is|is not) created/ do |file, is|
+  in_project_folder do
+    File.exists?(file).should(is == 'is' ? be_true : be_false)
+  end
+end
+
+Then /^file with name matching "(.*)" is created/ do |pattern|
+  in_project_folder do
+    Dir[pattern].should_not be_empty
+  end
+end
+
+Then /^file "(.*)" contents (does|does not) match \/(.*)\// do |file, does, regex|
+  in_project_folder do
+    actual_output = File.read(file)
+    (does == 'does') ?
+      actual_output.should(match(/#{regex}/)) :
+      actual_output.should_not(match(/#{regex}/))
+  end
+end
+
+Then /gem file "(.*)" and generated file "(.*)" should be the same/ do |gem_file, project_file|
+  File.exists?(gem_file).should be_true
+  File.exists?(project_file).should be_true
+  gem_file_contents = File.read(File.dirname(__FILE__) + "/../../#{gem_file}")
+  project_file_contents = File.read(File.join(@active_project_folder, project_file))
+  project_file_contents.should == gem_file_contents
+end
+
+Then /^(does|does not) invoke generator "(.*)"$/ do |does_invoke, generator|
+  actual_output = File.read(@stdout)
+  does_invoke == "does" ?
+    actual_output.should(match(/dependency\s+#{generator}/)) :
+    actual_output.should_not(match(/dependency\s+#{generator}/))
+end
+
+Then /help options "(.*)" and "(.*)" are displayed/ do |opt1, opt2|
+  actual_output = File.read(@stdout)
+  actual_output.should match(/#{opt1}/)
+  actual_output.should match(/#{opt2}/)
+end
+
+Then /^I should see "([^\"]*)"$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should contain(text)
+end
+
+Then /^I should see$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should contain(text)
+end
+
+Then /^I should not see$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should_not contain(text)
+end
+
+Then /^I should see exactly$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should == text
+end
+
+Then /^I should see all (\d+) tests pass/ do |expected_test_count|
+  expected = %r{^#{expected_test_count} tests, \d+ assertions, 0 failures, 0 errors}
+  actual_output = File.read(@stdout)
+  actual_output.should match(expected)
+end
+
+Then /^I should see all (\d+) examples pass/ do |expected_test_count|
+  expected = %r{^#{expected_test_count} examples?, 0 failures}
+  actual_output = File.read(@stdout)
+  actual_output.should match(expected)
+end
+
+Then /^yaml file "(.*)" contains (\{.*\})/ do |file, yaml|
+  in_project_folder do
+    yaml = eval yaml
+    YAML.load(File.read(file)).should == yaml
+  end
+end
+
+Then /^Rakefile can display tasks successfully/ do
+  @stdout = File.expand_path(File.join(@tmp_root, "rakefile.out"))
+  in_project_folder do
+    system "rake -T > #{@stdout} 2> #{@stdout}"
+  end
+  actual_output = File.read(@stdout)
+  actual_output.should match(/^rake\s+\w+\s+#\s.*/)
+end
+
+Then /^task "rake (.*)" is executed successfully/ do |task|
+  @stdout.should_not be_nil
+  actual_output = File.read(@stdout)
+  actual_output.should_not match(/^Don't know how to build task '#{task}'/)
+  actual_output.should_not match(/Error/i)
+end
+
+Then /^gem spec key "(.*)" contains \/(.*)\// do |key, regex|
+  in_project_folder do
+    gem_file = Dir["pkg/*.gem"].first
+    gem_spec = Gem::Specification.from_yaml(`gem spec #{gem_file}`)
+    spec_value = gem_spec.send(key.to_sym)
+    spec_value.to_s.should match(/#{regex}/)
+  end
+end