fiddler 0.0.1alpha

data/README.md

@@ -0,0 +1,12 @@
+Fiddler
+=======
+
+Ruby gem to provide an easy interface to Request Tracker Installation.
+
+Supported Versions of Request Tracker
+-------------------------------------
+* 4.0.4
+
+License
+-------
+Do you what-ever you can with this product license.

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Fiddler'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/fiddler.rb

@@ -0,0 +1,6 @@
+require 'fiddler/configuration'
+require 'fiddler/helper'
+require 'fiddler/errors'
+require 'fiddler/parsers'
+require 'fiddler/ticket'
+require 'fiddler/connection_manager'

data/lib/fiddler/configuration.rb

@@ -0,0 +1,20 @@
+module Fiddler
+  # Based on the Clearance gem configuration - https://github.com/thoughtbot/clearance/blob/master/lib/clearance/configuration.rb
+  class Configuration
+    attr_accessor :server_url, :username, :password, :use_cookies, :cookie_domain, :ssl_verify
+
+    def initialize
+      @use_cookies = false
+      @ssl_verify = true
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield configuration
+  end
+end

data/lib/fiddler/connection_manager.rb

@@ -0,0 +1,64 @@
+require 'httpclient'
+
+module Fiddler
+   module ConnectionManager
+
+      class Connection
+         attr_accessor :client
+         def initialize
+            @client = HTTPClient.new
+            @client.set_cookie_store("cookies.dat")
+         end
+
+         def base_url
+            "#{Fiddler.configuration.server_url}/REST/1.0/"
+         end
+
+         def get(url,options)
+            url = "#{base_url}#{url}"
+            @client.get(url,options_with_login(options)).content
+         end
+
+         def post
+         end
+
+         def options_with_login(options)
+            unless Fiddler.configuration.use_cookies
+               options.merge({ :user => Fiddler.configuration.username, :pass => Fiddler.configuration.password })
+            end
+         end
+      end
+
+      class << self
+         attr_accessor :client_connection
+
+         def connection
+            self.client_connection ||= Connection.new
+         end
+
+         def get(url,options={})
+            check_config
+            connection.get(url,options)
+         end
+
+         def post(url,data,options={})
+            check_config
+            connection.post(url,options)
+         end
+
+         protected
+
+         def check_config
+            config = Fiddler.configuration
+            raise InvalidConfigurationError unless Helper.valid?(config.server_url)
+            unless Helper.valid?(config.username) and Helper.valid?(config.password)
+               raise InvalidConfigurationError unless config.use_cookies
+            end
+         end
+
+         def debug
+         end
+
+      end # end class method definitions
+   end # end ConnectionManager module definition
+end # end main module

data/lib/fiddler/errors.rb

@@ -0,0 +1,6 @@
+module Fiddler
+   class FiddlerError < StandardError; end
+   class TicketNotFoundError < StandardError; end
+   class InvalidConfigurationError < StandardError; end
+   class TicketAccessDeniedError < StandardError; end
+end

data/lib/fiddler/helper.rb

@@ -0,0 +1,9 @@
+module Fiddler
+   module Helper
+      class << self
+         def valid?(value)
+            ( value.nil? or value == "" ) ? false : true
+         end
+      end
+   end
+end

data/lib/fiddler/parsers.rb

@@ -0,0 +1,2 @@
+require 'fiddler/parsers/base_parser'
+require 'fiddler/parsers/ticket_parser'

data/lib/fiddler/parsers/base_parser.rb

@@ -0,0 +1,14 @@
+module Fiddler
+   module Parsers
+      class BaseParser
+         def self.successful?(response)
+            lines = response.split("\n")
+            lines.first =~ /200/ ? true : false
+         end
+
+         def self.message(response)
+            # strip out the message from the first line and return it
+         end
+      end
+   end
+end

data/lib/fiddler/parsers/ticket_parser.rb

@@ -0,0 +1,10 @@
+module Fiddler
+   module Parsers
+      class TicketParser < BaseParser
+         def self.parse(response)
+            success = self.successful?(response)
+            puts success ? "Successful" : "Failed"
+         end
+      end
+   end
+end

data/lib/fiddler/ticket.rb

@@ -0,0 +1,49 @@
+module Fiddler
+   class Ticket
+      attr_accessor :id, :subject, :status, :queue, :owner, :creator, :histories, :content, :last_updated
+
+      # Initializes a new instance of ticket object
+      #
+      # @params [Hash] of the initial options
+      def initialize(options={})
+         options = { :queue => "General", :owner => "Nobody", :status => "new"}.merge options
+         options.each do |key,value|
+            send "#{key}=", value
+         end
+         @id = "ticket/new"
+      end
+
+      # Class methods
+      class << self
+         # Gets the ticket with given id
+         #
+         # @params [int] id for the ticket
+         # @returns [Ticket] returns ticket the ticket object
+         def get(id)
+            url = "ticket/#{id}"
+            response = Fiddler::ConnectionManager.get(url)
+            ticket = Fiddler::Parsers::TicketParser.parse(response)
+         end
+
+         # Creates a new ticket with the given options, it will not save the ticket
+         #
+         # @params [Hash] of the options to be added to the new ticket
+         # @returns [Ticket] returns new ticket object
+         def create(options)
+         end
+
+         # Saves the changes to the ticket object
+         #
+         # @returns [boolean] save succcessful or not
+         def save
+         end
+
+         # Find the tickets with the given options
+         #
+         # @params [Hash] of options
+         # @returns [Array<Ticket>] of ticket matching the criteria
+         def find(options={})
+         end
+      end
+   end
+end

data/lib/fiddler/version.rb

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

data/lib/tasks/fiddler_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :fiddler do
+#   # Task goes here
+# end

data/spec/config.rb

@@ -0,0 +1,17 @@
+def test_config
+   Fiddler.configure do |config|
+      config.server_url = "http://ticketsdev.cybersecure.local/rt/"
+      config.username = "jais.cheema"
+      config.password = "killzone"
+   end
+end
+
+def reset_config
+   Fiddler.configure do |config|
+      config.server_url = nil
+      config.username = nil
+      config.password = nil
+      config.use_cookies = false
+      config.ssl_verify = true
+   end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Fiddler::Configuration do
+  describe 'when no options are given' do
+    before do
+      Fiddler.configure do |config|
+      end
+    end
+
+    it 'defaults to using no cookies' do
+      Fiddler.configuration.use_cookies.should be_false
+    end
+
+    it 'defaults to verifying the ssl connection' do
+      Fiddler.configuration.ssl_verify.should be_true
+    end
+  end
+end

data/spec/connection_manager_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Fiddler::ConnectionManager do
+   before do
+      reset_config
+   end
+   
+   describe "without proper config" do
+      it "should raise invalid Configuration error for missing configuration" do
+         Fiddler.configure do |config|
+         end
+         expect { Fiddler::ConnectionManager.get("https://www.google.com") }.to raise_error(Fiddler::InvalidConfigurationError)
+      end
+
+      it "should raise invalid Configuration error for missing credentials if cookies are not enabled" do
+         Fiddler.configure do |config|
+            config.server_url = "https://some_server"
+         end
+         expect { Fiddler::ConnectionManager.get("https://www.google.com") }.to raise_error(Fiddler::InvalidConfigurationError)
+      end
+   end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+PROJECT_ROOT = File.expand_path('../..', __FILE__)
+$LOAD_PATH << File.join(PROJECT_ROOT, 'lib')
+
+require 'fiddler'
+
+RSpec.configure do |config|
+   config.treat_symbols_as_metadata_keys_with_true_values = true
+   config.run_all_when_everything_filtered = true
+   config.filter_run :focus
+   config.order = 'random'
+end
+
+# create a file named config.rb here with the two methods
+# def test_config
+#    Fiddler.configure do |config|
+#       config.server_url = "some_url"
+#       config.username = "username"
+#       config.password = "password"
+#    end
+# end
+# def reset_config
+#    Fiddler.configure do |config|
+#       config.server_url = nil
+#       config.username = nil
+#       config.password = nil
+#       config.use_cookies = false
+#       config.ssl_verify = true
+#    end
+# end
+
+require 'config'

data/spec/ticket_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Fiddler::Ticket do
+   before do
+      test_config
+   end
+   
+   it "should find a ticket with given id" do
+      Fiddler::Ticket.get(4200).should_not be_nil
+   end
+
+   it "should raise exception for invalid id" do
+      expect { Fiddler::Ticket.get(50000) }.to raise_error(Fiddler::TicketNotFoundError)
+   end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: fiddler
+version: !ruby/object:Gem::Version 
+  prerelease: 5
+  version: 0.0.1alpha
+platform: ruby
+authors: 
+  - Jais Cheema
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-03 00:00:00 Z
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: httpclient
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - "="
+          - !ruby/object:Gem::Version 
+            version: 2.2.7
+    type: :runtime
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: activesupport
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - "="
+          - !ruby/object:Gem::Version 
+            version: 3.2.8
+    type: :runtime
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id003
+description: This is the interface to request tracker based on Roart Gem
+email: 
+  - jaischeema@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - lib/fiddler.rb
+  - lib/tasks/fiddler_tasks.rake
+  - lib/fiddler/version.rb
+  - lib/fiddler/errors.rb
+  - lib/fiddler/connection_manager.rb
+  - lib/fiddler/parsers.rb
+  - lib/fiddler/configuration.rb
+  - lib/fiddler/helper.rb
+  - lib/fiddler/ticket.rb
+  - lib/fiddler/parsers/ticket_parser.rb
+  - lib/fiddler/parsers/base_parser.rb
+  - spec/spec_helper.rb
+  - spec/ticket_spec.rb
+  - spec/configuration_spec.rb
+  - spec/config.rb
+  - spec/connection_manager_spec.rb
+  - Rakefile
+  - README.md
+homepage: https://github.com/jaischeema/fiddler
+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: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Interface to Request Tracker based on Roart Gem
+test_files: 
+  - spec/spec_helper.rb
+  - spec/ticket_spec.rb
+  - spec/configuration_spec.rb
+  - spec/config.rb
+  - spec/connection_manager_spec.rb