cukebase 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cukebase.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Emil Loer
+
+MIT License
+
+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/README.md

@@ -0,0 +1,56 @@
+# Cukebase
+
+This gem provides integration betweeen Cucumber and the Codebase ticketing
+system. Whenever scenarios are run Cukebase will create tickets for any
+scenarios it encounters. It sets the ticket status to the test result of the
+scenario.
+
+When you run Cucumber again, these tickets are updated to reflect the new
+result status.
+
+## Usage
+
+Add this to your Gemfile:
+
+```ruby
+group :test do
+  gem 'cukebase'
+end
+```
+
+Then go to Codebase to find your API credentials and add the following to your
+`features/support/env.rb` file:
+
+```ruby
+Cukebase.config do |c|
+  c.project = "your-project-name"
+  c.username = "yourcompany/youruser"
+  c.api_key = "YOUR_API_KEY"
+end
+```
+
+And next time when you run Cucumber, there will be tickets made for every
+scenario.
+
+## Future work
+
+Here are some ideas you can send pull requests for:
+
+* Add an option to enable/disable Cukebase, e.g. to run it only on a CI server
+  but not on your development machine.
+* Add the ability to read credentials from a file.
+* Mark tickets as obsolete when a scenario is removed instead of being
+  completed.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Cukebase is MIT-licensed. I'm sure you can find a copy somewhere if you aren't
+able to recite it by heart.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/cukebase.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/cukebase/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Emil Loer"]
+  gem.email         = ["emil@bartune.nl"]
+  gem.description   = %q{Cukebase provides integration between Cucumber and the Codebase ticketing system}
+  gem.summary       = %q{Cukebase provides integration between Cucumber and the Codebase ticketing system}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "cukebase"
+  gem.require_paths = ["lib"]
+  gem.version       = Cukebase::VERSION
+
+  gem.add_dependency 'httparty'
+  gem.add_dependency 'activemodel'
+  gem.add_dependency 'active_attr'
+end

data/lib/cukebase.rb

@@ -0,0 +1,45 @@
+require "httparty"
+require "active_model"
+require "active_attr"
+require "cukebase/version"
+require "cukebase/config"
+require "cukebase/request"
+require "cukebase/project"
+require "cukebase/ticketing_category"
+require "cukebase/ticketing_status"
+require "cukebase/ticket"
+
+module Cukebase
+  def self.current_project
+    @current_project ||= Project.new Cukebase.config.project
+  end
+end
+
+if defined? Cucumber
+  Around do |scenario, block|
+    ticket_name = "#{scenario.title} (#{scenario.feature.title})"
+    project = Cukebase.current_project
+    ticket = project.ticket_for_name ticket_name
+
+    block.call
+
+    ticket.status_id = case scenario.status
+                       when :undefined
+                         project.undefined_status
+                       when :pending
+                         project.pending_status
+                       when :passed
+                         project.passed_status
+                       when :failed
+                         project.failed_status
+                       else
+                         project.invalid_status
+                       end
+
+    # We want empty features to be undefined instead of completed (which is
+    # what Cucumber tells us)
+    ticket.status_id = project.undefined_status if scenario.raw_steps.empty?
+
+    ticket.save
+  end
+end

data/lib/cukebase/config.rb

@@ -0,0 +1,43 @@
+module Cukebase
+  class Config
+    attr_accessor :host
+    attr_accessor :protocol
+
+    attr_accessor :username
+    attr_accessor :api_key
+
+    attr_accessor :project
+    attr_accessor :category
+
+    attr_accessor :normal_type
+    attr_accessor :regression_type
+
+    attr_accessor :undefined_status
+    attr_accessor :pending_status
+    attr_accessor :failed_status
+    attr_accessor :passed_status
+    attr_accessor :invalid_status
+
+    def initialize
+      @host = "api3.codebasehq.com"
+      @protocol = "https"
+
+      @category = "Cucumber"
+
+      @normal_type = "Feature"
+      @regression_type = "Regression"
+
+      @undefined_status = "Open (undefined steps)"
+      @pending_status = "Open (pending steps)"
+      @failed_status = "Open (failing steps)"
+      @passed_status = "Completed"
+      @invalid_status = "Invalid"
+    end
+  end
+
+  def self.config
+    @config ||= Config.new
+    yield @config if block_given?
+    @config
+  end
+end

data/lib/cukebase/project.rb

@@ -0,0 +1,55 @@
+module Cukebase
+  class Project
+    attr_reader :undefined_status
+    attr_reader :pending_status
+    attr_reader :failed_status
+    attr_reader :passed_status
+    attr_reader :invalid_status
+
+    def initialize name
+      @name = name
+
+      @category = ticketing_category_id_for_name Cukebase.config.category
+
+      @undefined_status = ticketing_status_id_for_name Cukebase.config.undefined_status
+      @pending_status = ticketing_status_id_for_name Cukebase.config.pending_status
+      @failed_status = ticketing_status_id_for_name Cukebase.config.failed_status
+      @passed_status = ticketing_status_id_for_name Cukebase.config.passed_status
+      @invalid_status = ticketing_status_id_for_name Cukebase.config.invalid_status
+    end
+
+    def ticketing_categories
+      @ticketing_categories ||= Request.get("#{@name}/tickets/categories").parsed_response["ticketing_categories"].map do |hash|
+        TicketingCategory.new hash
+      end
+    end
+
+    def ticketing_statuses
+      @ticketing_statuses ||= Request.get("#{@name}/tickets/statuses").parsed_response["ticketing_statuses"].map do |hash|
+        TicketingStatus.new hash
+      end
+    end
+
+    def ticket_for_name name
+      data = Request.get("#{@name}/tickets", query: { query: "subject:\"#{name}\" category:\"#{Cukebase.config.category}\"" }).parsed_response["tickets"].first
+
+      if data
+        Ticket.new data
+      else
+        Ticket.new summary: name, category_id: @category, ticket_type: Cukebase.config.normal_type
+      end
+    end
+
+    def ticketing_category_id_for_name name
+      ticketing_categories.find do |ticketing_category|
+        ticketing_category.name == name
+      end.try(:id) or raise "Could not find a Codebase ticket category with name \"#{name}\". Please create it first."
+    end
+
+    def ticketing_status_id_for_name name
+      ticketing_statuses.find do |ticketing_status|
+        ticketing_status.name == name
+      end.try(:id) or raise "Could not find a Codebase ticket status with name \"#{name}\". Please create it first."
+    end
+  end
+end

data/lib/cukebase/request.rb

@@ -0,0 +1,16 @@
+module Cukebase
+  class Request
+    include HTTParty
+
+    format :xml
+    headers 'Accept' => 'application/xml'
+    headers 'Content-type' => 'application/xml'
+
+    [:get, :post, :put, :delete].each do |method_name|
+      define_singleton_method method_name do |url, *args, &block|
+        basic_auth Cukebase.config.username, Cukebase.config.api_key
+        super "#{Cukebase.config.protocol}://#{Cukebase.config.host}/#{url}", *args, &block
+      end
+    end
+  end
+end

data/lib/cukebase/ticket.rb

@@ -0,0 +1,82 @@
+module Cukebase
+  class Ticket
+    include ActiveAttr::Model
+
+    attribute :ticket_id
+    attribute :summary
+    attribute :ticket_type
+    attribute :reporter_id
+    attribute :assignee_id
+    attribute :assignee
+    attribute :reporter
+    attribute :category_id
+    attribute :category
+    attribute :priority_id
+    attribute :priority
+    attribute :status_id
+    attribute :status
+    attribute :milestone_id
+    attribute :milestone
+    attribute :deadline
+    attribute :tags
+    attribute :estimated_time
+    attribute :project_id
+
+    attribute :created_at
+    attribute :updated_at
+
+    def self.wrap_setter name
+      define_method "#{name}=" do |value|
+        @changes[name] = value if @changes && value != send(name)
+        super value
+      end
+    end
+
+    def initialize *args, &block
+      super
+
+      @changes = {}
+    end
+
+    wrap_setter :status_id
+    wrap_setter :priority_id
+    wrap_setter :category_id
+    wrap_setter :assignee_id
+    wrap_setter :milestone_id
+    wrap_setter :summary
+    wrap_setter :tags
+
+    def update_ticket content
+      data = {}
+
+      data[:changes] = @changes if @changes.any?
+      data[:content] = content if content && self.content != content
+
+      if data.any?
+        Request.post "#{Cukebase.config.project}/tickets/#{ticket_id}/notes", body: data.to_xml(root: "ticket-note", skip_types: true, skip_instruct: true)
+      end
+    end
+
+    def create_ticket content
+      data = {}
+      data[:summary] = summary if summary?
+      data[:description] = content if content
+      data[:ticket_type] = ticket_type if ticket_type?
+      data[:category_id] = category_id if category_id?
+      data[:priority_id] = priority_id if priority_id?
+      data[:status_id] = status_id if status_id?
+      data[:assignee_id] = assignee_id if assignee_id?
+      data[:milestone_id] = milestone_id if milestone_id?
+
+      Request.post "#{Cukebase.config.project}/tickets", body: data.to_xml(root: "ticket", skip_types: true, skip_instruct: true)
+    end
+
+    def save content=nil
+      if ticket_id?
+        update_ticket content
+      else
+        create_ticket content
+      end
+    end
+  end
+end

data/lib/cukebase/ticketing_category.rb

@@ -0,0 +1,8 @@
+module Cukebase
+  class TicketingCategory
+    include ActiveAttr::Model
+
+    attribute :id
+    attribute :name
+  end
+end

data/lib/cukebase/ticketing_status.rb

@@ -0,0 +1,11 @@
+module Cukebase
+  class TicketingStatus
+    include ActiveAttr::Model
+
+    attribute :id
+    attribute :name
+    attribute :background_colour
+    attribute :order
+    attribute :treat_as_closed
+  end
+end

data/lib/cukebase/version.rb

@@ -0,0 +1,3 @@
+module Cukebase
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: cukebase
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Emil Loer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_attr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Cukebase provides integration between Cucumber and the Codebase ticketing
+  system
+email:
+- emil@bartune.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cukebase.gemspec
+- lib/cukebase.rb
+- lib/cukebase/config.rb
+- lib/cukebase/project.rb
+- lib/cukebase/request.rb
+- lib/cukebase/ticket.rb
+- lib/cukebase/ticketing_category.rb
+- lib/cukebase/ticketing_status.rb
+- lib/cukebase/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Cukebase provides integration between Cucumber and the Codebase ticketing
+  system
+test_files: []