ruby-fogbugz 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.md

@@ -0,0 +1,5 @@
+# ruby-fogbugz
+
+Readme coming soon to a repo near you.
+
+For now, check out [Foghub](https://github.com/firmafon/foghub) where this was extracted from for usage.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end

data/lib/fogbugz.rb

@@ -0,0 +1,14 @@
+require_relative 'ruby_fogbugz/adapters/http/typhoeus'
+require_relative 'ruby_fogbugz/adapters/xml/cracker'
+require_relative 'ruby_fogbugz/interface'
+
+module Fogbugz
+  class << self
+    attr_accessor :adapter
+  end
+
+  self.adapter = {
+    :xml  => Adapter::XML::Cracker,
+    :http => Adapter::HTTP::Typhoeuser
+  }
+end

data/lib/ruby_fogbugz/adapters/http/typhoeus.rb

@@ -0,0 +1,23 @@
+require 'typhoeus'
+
+module Fogbugz
+  module Adapter
+    module HTTP
+      class Typhoeuser
+        attr_accessor :uri, :requester
+
+        def initialize(options = {})
+          @uri = options[:uri]
+          @requester = Typhoeus::Request
+        end
+
+        def request(action, options)
+          params = {:cmd => action}.merge(options[:params])
+          query = @requester.get("#{uri}/api.asp",
+                                 :params => params)
+          query.body
+        end
+      end
+    end
+  end
+end

data/lib/ruby_fogbugz/adapters/xml/cracker.rb

@@ -0,0 +1,13 @@
+require 'crack/xml'
+
+module Fogbugz
+  module Adapter
+    module XML
+      class Cracker
+        def self.parse(xml)
+          Crack::XML.parse(xml)["response"]
+        end
+      end
+    end
+  end
+end

data/lib/ruby_fogbugz/interface.rb

@@ -0,0 +1,38 @@
+module Fogbugz
+  class Interface
+    class RequestError < StandardError; end
+    class InitializationError < StandardError; end
+    
+    attr_accessor :options, :http, :xml, :token
+
+    def initialize(options = {})
+      @options = {}.merge(options)
+
+      raise InitializationError, "Must supply URI (e.g. http://fogbugz.company.com)" unless options[:uri]
+      @http = Fogbugz.adapter[:http].new(:uri => options[:uri])
+      @xml = Fogbugz.adapter[:xml]
+    end
+
+    def authenticate
+      response = @http.request :logon, { 
+        :params => {
+          :email    => @options[:email],
+          :password => @options[:password]
+        }
+      }
+
+      @token ||= @xml.parse(response)["token"]
+    end
+
+    def command(action, parameters = {})
+      raise RequestError, 'No token available, #authenticate first' unless @token
+      parameters[:token] = @token
+
+      response = @http.request action, { 
+        :params => parameters.merge(options[:params] || {})
+      }
+
+      @xml.parse(response)
+    end
+  end
+end

data/lib/ruby_fogbugz/version.rb

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

data/ruby-fogbugz.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ruby_fogbugz/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ruby-fogbugz"
+  s.version     = Fogbugz::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Simon Hørup Eskildsen"]
+  s.email       = ["sirup@sirupsen.com"]
+  s.homepage    = ""
+  s.summary     = %q{Ruby wrapper for the Fogbugz API }
+  s.description = %q{A simple Ruby wrapper for the Fogbugz XML API}
+
+  s.rubyforge_project = "ruby-fogbugz"
+
+  s.add_dependency('typhoeus')
+  s.add_dependency('crack')
+
+  s.add_development_dependency('minitest')
+  s.add_development_dependency('mocha')
+
+  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/test/adapters/http/typhoeus_test.rb

@@ -0,0 +1,13 @@
+require_relative '../../test_helper.rb'
+require 'ruby_fogbugz/adapters/http/typhoeus'
+
+class Typhoeuser < FogTest
+  test '#request should order the params right' do
+    response = mock()
+    response.expects(:body)
+
+    t = Fogbugz::Adapter::HTTP::Typhoeuser.new(:uri => 'http://test.com')
+    t.requester.expects(:get).returns(response)
+    t.request(:action, :params => {:one => "two", :three => "four"})
+  end
+end

data/test/adapters/xml/crack_test.rb

@@ -0,0 +1,15 @@
+require_relative '../../test_helper.rb'
+require 'ruby_fogbugz/adapters/xml/cracker'
+
+class Cracker < FogTest
+  test 'should parse XML and get rid of the response namespace' do
+    XML = <<-xml
+      <?xml version="1.0" encoding="UTF-8"?>
+      <response>
+        <version>2</version>
+      </response>
+    xml
+
+    assert_equal({"version" => "2"}, Fogbugz::Adapter::XML::Cracker.parse(XML))
+  end
+end

data/test/interface_test.rb

@@ -0,0 +1,61 @@
+require_relative './test_helper.rb'
+
+class FogTest
+  CREDENTIALS = {
+    :email    => "test@test.com",
+    :password => 'seekrit',
+    :uri      => 'http://fogbugz.test.com'
+  }
+end
+
+class BasicInterface < FogTest
+  def setup
+    Fogbugz.adapter[:http] = mock()
+    Fogbugz.adapter[:http].expects(:new)
+
+    Fogbugz.adapter[:xml] = mock()
+
+    @fogbugz = Fogbugz::Interface.new(CREDENTIALS)
+  end
+
+  test 'when instantiating options should be overwriting and be publicly available' do
+    assert_equal CREDENTIALS, @fogbugz.options
+  end
+end
+
+class InterfaceRequests < FogTest
+  def setup
+    Fogbugz.adapter[:http].expects(:new)
+  end
+
+  test 'authentication should send correct parameters' do
+
+    fogbugz = Fogbugz::Interface.new(CREDENTIALS)
+    fogbugz.http.expects(:request).with(:logon, 
+                                        :params => {
+                                          :email => CREDENTIALS[:email],
+                                          :password => CREDENTIALS[:password]
+                                        }).returns("token")
+
+    fogbugz.xml.expects(:parse).with("token").returns({"token" => "22"})
+
+    fogbugz.authenticate
+  end
+
+  test 'requesting with an action should send along token and correct parameters' do
+    fogbugz = Fogbugz::Interface.new(CREDENTIALS)
+    fogbugz.token = 'token'
+    fogbugz.http.expects(:request).with(:search, {:params => {:q => 'case', :token => 'token'}}).returns("omgxml")
+    fogbugz.xml.expects(:parse).with("omgxml")
+    fogbugz.command(:search, :q => 'case')
+  end
+
+  test 'throws an exception if #command is requested with no token' do
+    fogbugz = Fogbugz::Interface.new(CREDENTIALS)
+    fogbugz.token = nil
+
+    assert_raises Fogbugz::Interface::RequestError do
+      fogbugz.command(:search, :q => 'case')
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+gem 'minitest' # ensures you're using the gem, and not the built in MT
+$: << File.expand_path(File.dirname(__FILE__) + "../lib")
+
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'mocha'
+
+require 'fogbugz'
+
+class FogTest < MiniTest::Unit::TestCase
+  def self.test(description, &block)
+    define_method("test_" + description.split.join('_').gsub(/\W/, ''), block)
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-fogbugz
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors: 
+- "Simon H\xC3\xB8rup Eskildsen"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-22 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: typhoeus
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: crack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: A simple Ruby wrapper for the Fogbugz XML API
+email: 
+- sirup@sirupsen.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/fogbugz.rb
+- lib/ruby_fogbugz/adapters/http/typhoeus.rb
+- lib/ruby_fogbugz/adapters/xml/cracker.rb
+- lib/ruby_fogbugz/interface.rb
+- lib/ruby_fogbugz/version.rb
+- ruby-fogbugz.gemspec
+- test/adapters/http/typhoeus_test.rb
+- test/adapters/xml/crack_test.rb
+- test/interface_test.rb
+- test/test_helper.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: ruby-fogbugz
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the Fogbugz API
+test_files: 
+- test/adapters/http/typhoeus_test.rb
+- test/adapters/xml/crack_test.rb
+- test/interface_test.rb
+- test/test_helper.rb