foggy_bottom 0.0.2

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc
+test.rb

data/Gemfile

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

data/README

@@ -0,0 +1,4 @@
+FoggyBottom is a Ruby wrapper around the FogBugz API.  It's not a direct match, so you don't 
+need to know how to use the FogBugz API to use this library.
+
+It's written in "normal" Ruby syntax and patterns, so no strange "port" of another library.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/foggy_bottom.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "foggy_bottom/version"
+
+Gem::Specification.new do |s|
+  s.name        = "foggy_bottom"
+  s.version     = FoggyBottom::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jon Moses"]
+  s.email       = ["jon@burningbush.us"]
+  s.homepage    = ""
+  s.summary     = %q{Ruby API wrapper for FogBugz}
+  s.description = %q{It wraps the FogBugz API.}
+
+  #s.rubyforge_project = "foggy_bottom"
+  s.add_dependency('nokogiri')
+  s.add_dependency('activemodel')
+  s.add_dependency('hirb')
+
+  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"]
+end

data/lib/foggy_bottom.rb

@@ -0,0 +1,15 @@
+require 'nokogiri'
+require 'open-uri'
+require 'digest/sha2'
+require 'cgi'
+require 'logger'
+require 'delegate'
+
+require 'active_support/core_ext/array'
+require 'active_model'
+require 'hirb'
+
+require 'foggy_bottom/api'
+require 'foggy_bottom/columns'
+require 'foggy_bottom/case'
+require 'foggy_bottom/console'

data/lib/foggy_bottom/api.rb

@@ -0,0 +1,76 @@
+module FoggyBottom
+  class Api
+    attr_accessor :token, :url, :endpoint
+    attr_reader :logger
+
+    def initialize( url, username, password )
+      @logger = Logger.new(STDOUT).tap {|l| l.level = Logger::DEBUG }
+      @url = url[-1] == '/' ? url : "#{url}/"
+
+      token_filename = File.expand_path( "~/.foggy_bottom_token_" + Digest::SHA2.hexdigest("#{username}_#{password}") )
+
+      if File.exists?(token_filename)
+        load_details(token_filename)
+      else
+        fetch_endpoint
+        fetch_token(username, password, token_filename)
+      end
+    end
+
+    def exec(cmd, args = {})
+      get(build_url(cmd, args))
+    end
+
+    def find( issue_id )
+      Case.find(issue_id, self)
+    end
+    alias :[] :find
+
+    def search( terms )
+      Case.search(terms, self)
+    end
+
+    protected
+      def fetch_token(username, password, token_filename)
+        @token ||= begin
+          logger.debug("Fetching token")
+          get(build_url(:logon, :email => username, :password => password)).at_css("response token").content.tap do |token|
+            logger.debug(" done.")
+            save_token(token, token_filename)
+          end
+        end  
+      end
+
+      def load_details(token_filename)
+        logger.debug("Loading cached credentials")
+
+        @endpoint, @token = File.read(token_filename).split("\n").map(&:strip)
+      end
+
+      def save_token(token, token_filename)
+        logger.debug("Caching token")
+
+        File.open(token_filename, 'w') do |out|
+          out << endpoint
+          out << "\n"
+          out << token
+        end
+      end
+
+      def fetch_endpoint
+        @endpoint ||= begin
+          logger.debug("Fetching endpoint")
+          Nokogiri.XML( open("#{url}/api.xml") {|f| f.read } ).at_css("response url").content
+        end
+      end
+
+      def get(path)
+        logger.debug("Attempting to access: #{path}")
+        Nokogiri.XML( open(path) {|f| f.read } )
+      end
+
+      def build_url(cmd, args)
+        url + endpoint + args.merge(:cmd => cmd.to_s, :token => token).inject([]) {|memo, (key, value)| memo << "#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+      end
+  end
+end

data/lib/foggy_bottom/case.rb

@@ -0,0 +1,83 @@
+class FoggyBottom::Case
+  include FoggyBottom::Columns::Case
+
+  include ActiveModel::AttributeMethods
+  include ActiveModel::Dirty
+  include ActiveModel::Serialization
+
+  define_attribute_methods ALL_COLUMNS
+
+  attr_accessor :api
+
+  delegate :logger, :to => :api
+
+  class << self
+    def find( case_id, api )
+      details = api.exec(:search, :q => case_id, :cols => FoggyBottom::Columns::Case::ALL_COLUMNS.join(',') ).at_css("case")
+
+      create_from_xml(details, api) if details
+    end
+
+    def search( terms, api )
+      api.exec(:search, :q => terms, :cols => FoggyBottom::Columns::Case::ALL_COLUMNS.join(',')).css('case').collect do |details|
+        create_from_xml(details, api)
+      end
+    end
+
+    def create_from_xml(xml, api)
+      new( {}.tap do |attributes|
+        (FoggyBottom::Columns::Case::ALL_COLUMNS - %w(tags)).each do |col|
+          attributes[col] = xml.at_css(col).content
+        end
+
+        attributes['tags'] = [].tap do |tags|
+          xml.css("tag").each {|t| tags << t.content }
+        end
+      end).tap do |instance|
+        instance.api = api
+      end
+
+    end
+  end
+
+  def initialize(attributes = {})
+    @attributes = attributes.stringify_keys
+  end
+
+  def attributes=(new_attributes)
+    new_attributes.each_pair {|k,v| send("#{k}=", v) }
+  end
+
+  def save( comment = nil )
+    return unless changed?
+    
+    save!(comment)
+  end
+
+  def resolve( comment = nil )
+    save!(comment, :resolve)
+  end
+
+  def to_s
+    "#{ixBug} - #{sTitle}"
+  end
+
+  protected
+    def attributes
+      @attributes
+    end
+
+    def save!(comment, action = :edit)
+      @previously_changed = changes
+
+      logger.debug("Saving changes for #{ixBug} columns #{changed.join(', ')} with action #{action}")
+      api.exec(action, parameters('sEvent' => comment))
+      logger.debug(" done")
+
+      @changed_attributes.clear
+    end
+
+    def parameters( extra = {} )
+      changed.inject({}) {|memo, key| memo.merge(key => send(key))}.merge(extra).merge('ixBug' => ixBug)
+    end
+end

data/lib/foggy_bottom/columns.rb

@@ -0,0 +1,80 @@
+module FoggyBottom
+  module Columns
+    module Case
+      def self.included(base)
+        base.class_eval do
+          ALL_COLUMNS.each do |column|
+            define_method(column) do
+              @attributes[column]
+            end
+
+            define_method("#{column}=") do |arg|
+              send("#{column}_will_change!") unless send(column) == arg
+
+              @attributes[column] = arg
+            end
+          end
+        end
+      end
+
+      ALL_COLUMNS = %w(
+        ixBug
+        ixBugParent
+        ixBugChildren
+        tags
+        fOpen
+        sTitle
+        sOriginalTitle
+        sLatestTextSummary
+        ixBugEventLatestText
+        ixProject
+        sProject
+        ixArea
+        sArea
+        ixGroup
+        ixPersonAssignedTo
+        sPersonAssignedTo
+        sEmailAssignedTo
+        ixPersonOpenedBy
+        ixPersonResolvedBy
+        ixPersonClosedBy
+        ixPersonLastEditedBy
+        ixStatus
+        sStatus
+        ixPriority
+        sPriority
+        ixFixFor
+        sFixFor
+        dtFixFor
+        sVersion
+        sComputer
+        hrsOrigEst
+        hrsCurrEst
+        hrsElapsed
+        c
+        sCustomerEmail
+        ixMailbox
+        ixCategory
+        sCategory
+        dtOpened
+        dtResolved
+        dtClosed
+        ixBugEventLatest
+        dtLastUpdated
+        fReplied
+        fForwarded
+        sTicket
+        ixDiscussTopic
+        dtDue
+        sReleaseNotes
+        ixBugEventLastView
+        dtLastView
+        ixRelatedBugs
+        sScoutDescription
+        sScoutMessage
+        fScoutStopReporting
+        fSubscribed
+      )
+    end
+  end
+end

data/lib/foggy_bottom/console.rb

@@ -0,0 +1,59 @@
+class FoggyBottom::Console
+  delegate :logger, :to => :api
+
+  attr_accessor :api
+  def initialize(api)
+    @api = api
+  end
+
+  def run
+    while( cmd = show_menu ) do
+      case cmd
+      when :search
+        search(get("Terms"))
+      when :resolve
+        resolve(get("Case ID"))
+      when :quit
+        exit 0
+      else
+        puts " Unknown choice"
+      end
+    end
+  end
+
+  protected
+    def show_menu
+      commands = %w( search resolve quit )
+      choice = (Hirb::Menu.render commands, :helper_class => false, :directions => false).first
+      choice ? choice.to_sym : :unknown 
+    end
+
+    def choose( arguments, options = {})
+      Hirb::Menu.render arguments, options.merge(:helper_class => false)
+    end
+
+    def get(prompt)
+      STDOUT.write "#{prompt}: "
+      STDOUT.flush
+      STDIN.gets.chomp
+    end
+
+    def search(terms)
+      unless terms
+        puts "Search terms are required."
+        return
+      end
+
+      cases = api.search(terms)
+      choose(cases.map(&:to_s))
+    end
+
+    def resolve( case_id )
+      bug = api.find(case_id)
+      if bug
+        bug.resolve
+      else
+        puts "Bug #{case_id} not found"
+      end
+    end
+end

data/lib/foggy_bottom/version.rb

@@ -0,0 +1,3 @@
+module FoggyBottom
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: foggy_bottom
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Jon Moses
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-03 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2152537960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152537960
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &2152537540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152537540
+- !ruby/object:Gem::Dependency
+  name: hirb
+  requirement: &2152537120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152537120
+description: It wraps the FogBugz API.
+email:
+- jon@burningbush.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- foggy_bottom.gemspec
+- lib/foggy_bottom.rb
+- lib/foggy_bottom/api.rb
+- lib/foggy_bottom/case.rb
+- lib/foggy_bottom/columns.rb
+- lib/foggy_bottom/console.rb
+- lib/foggy_bottom/version.rb
+has_rdoc: true
+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.6.2
+signing_key: 
+specification_version: 3
+summary: Ruby API wrapper for FogBugz
+test_files: []