fiddler 0.0.1alpha → 0.0.1

data/lib/fiddler.rb

@@ -1,6 +1,8 @@
 require 'fiddler/configuration'
-require 'fiddler/helper'
 require 'fiddler/errors'
 require 'fiddler/parsers'
+require 'fiddler/formatters'
 require 'fiddler/ticket'
-require 'fiddler/connection_manager'
+require 'fiddler/connection_manager'
+
+require 'active_support/all'

data/lib/fiddler/connection_manager.rb

@@ -16,10 +16,13 @@ module Fiddler
 
          def get(url,options)
             url = "#{base_url}#{url}"
-            @client.get(url,options_with_login(options)).content
+            options = options_with_login(options)
+            @client.get(url,options).content
          end
 
-         def post
+         def post(url,options)
+            url = "#{base_url}#{url}"
+            @client.post(url,options_with_login(options)).content
          end
 
          def options_with_login(options)
@@ -32,33 +35,37 @@ module Fiddler
       class << self
          attr_accessor :client_connection
 
-         def connection
-            self.client_connection ||= Connection.new
-         end
-
          def get(url,options={})
             check_config
-            connection.get(url,options)
+            response = connection.get(url,options)
+            debug(response)
+            response
          end
 
-         def post(url,data,options={})
+         def post(url,options={})
             check_config
-            connection.post(url,options)
+            response = connection.post(url,options)
+            debug(response)
+            response
          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 if config.server_url.blank?
+            if config.username.blank? or config.password.blank?
                raise InvalidConfigurationError unless config.use_cookies
             end
          end
 
-         def debug
+         def connection
+            self.client_connection ||= Connection.new
          end
 
+         def debug(response)
+            puts response.inspect if ENV['DEBUG']
+         end
       end # end class method definitions
    end # end ConnectionManager module definition
 end # end main module

data/lib/fiddler/errors.rb

@@ -3,4 +3,5 @@ module Fiddler
    class TicketNotFoundError < StandardError; end
    class InvalidConfigurationError < StandardError; end
    class TicketAccessDeniedError < StandardError; end
+   class RequestError < StandardError; end
 end

data/lib/fiddler/formatters.rb

@@ -0,0 +1,2 @@
+require 'fiddler/formatters/base_formatter'
+require 'fiddler/formatters/search_request_formatter'

data/lib/fiddler/formatters/base_formatter.rb

@@ -0,0 +1,6 @@
+module Fiddler
+   module Formatters
+      class BaseFormatter
+      end
+   end
+end

data/lib/fiddler/formatters/search_request_formatter.rb

@@ -0,0 +1,86 @@
+module Fiddler
+   module Formatters
+      class SearchRequestFormatter < BaseFormatter
+         class << self
+            def format(options={})
+               result = Hash.new
+               
+               unless options.empty?
+                  query = Array.new
+
+                  add_array_or_single(options, query, :queue)
+                  add_array_or_single(options, query, :status)
+                  add_text_search_fields(options,query)
+                  add_date_search_fields(options,query)
+
+                  query << options[:conditions].to_s.chomp if options[:conditions]
+
+                  result = { "query" => query.join(" AND "), :format => "l"}
+               end
+               result
+            end
+
+            protected
+
+            def add_array_or_single(options, query_array, key)
+               unless query_array and options and options.keys.include?(key)
+                  return false
+               end
+               value = options[key]
+               name = key.to_s.camelize
+               if value.is_a?(Array)
+                  sub_parts = Array.new
+                  value.each do |part|
+                     sub_parts << "#{name} = '#{part}'"
+                  end
+                  query_array << '( ' + sub_parts.join(' OR ') + ' )'
+               elsif value.is_a?(String) || value.is_a?(Symbol)
+                  query_array << "#{name} = '#{value.to_s}'"
+               end
+            end
+
+            def add_text_search_fields(options,query_array)
+               text_fields = %w( subject content content_type file_name owner requestors cc admin_cc)
+               options.each do |key, value|
+                  if text_fields.include?(key.to_s)
+                     key = key.to_s.camelize
+                     parts = Array.new
+                     if value.is_a?(Array)
+                        value.each do |v|
+                           parts << "#{key} LIKE '#{v}'"
+                        end
+                        query_array << '( ' + parts.join(" AND ") + ' )'
+                     elsif value.is_a?(String)
+                        # special case for when user is Nobody, like doesnt work there
+                        if key == "Owner" and value == "Nobody"
+                           query_array << "#{key} = '#{value}'"
+                        else
+                           query_array << "#{key} LIKE '#{value}'"
+                        end
+                     end
+                  end
+               end
+            end
+
+            def add_date_search_fields(options,query_array)
+               date_field = %w( created started resolved told last_updated starts due updated )
+               options.each do |key, value|
+                  if date_field.include?(key.to_s)
+                     key = key.to_s.camelize
+                     parts = Array.new
+                     if value.is_a?(Range) or value.is_a?(Array)
+                        parts << "#{key} > '#{value.first.is_a?(Time) ? value.first.strftime("%Y-%m-%d %H:%M:%S") : value.first.to_s}'"
+                        parts << "#{key} < '#{value.last.is_a?(Time) ? value.last.strftime("%Y-%m-%d %H:%M:%S") : value.last.to_s}'"
+                     elsif value.is_a?(String)
+                        parts << "#{key} > '#{value.to_s}'"
+                     elsif value.is_a?(Time)
+                        parts << "#{key} > '#{value.strftime("%Y-%m-%d %H:%M:%S")}'"
+                     end
+                     query_array << '( ' + parts.join(" AND ") + ' )'
+                  end
+               end
+            end
+         end
+      end
+   end
+end

data/lib/fiddler/parsers/base_parser.rb

@@ -1,13 +1,22 @@
 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
+         
+         SUCCESS_CODES = (200..299).to_a
+         ERROR_CODES = (400..499).to_a
+         
+         def self.check_response_code(response)
+            lines = response.split("\n").reject { |l| l.nil? or l == "" }
+            if lines.count == 0
+               raise RequestError, "Empty Response"
+            else
+               status_line = lines.shift
+               version, status_code, status_text = status_line.split(/\s+/,2)
+               unless SUCCESS_CODES.include?(status_code.to_i)
+                  raise RequestError, status_text
+               end
+               lines
+            end
          end
       end
    end

data/lib/fiddler/parsers/ticket_parser.rb

@@ -1,9 +1,57 @@
 module Fiddler
    module Parsers
       class TicketParser < BaseParser
-         def self.parse(response)
-            success = self.successful?(response)
-            puts success ? "Successful" : "Failed"
+         def self.parse_single(response)
+            response = check_response_code(response)
+            response = check_for_errors(response)
+            ticket_from_response(response)
+         end
+
+         def self.parse_multiple(response)
+            response = check_response_code(response)
+            response = check_for_errors(response)
+            ticket_token_responses = tokenize_response(response)
+            tickets = Array.new
+            ticket_token_responses.each do |token_response|
+               tickets << ticket_from_response(token_response)
+            end
+            tickets
+         end
+
+         protected
+
+         def self.check_for_errors(response)
+            message = response.first.strip
+            if message =~ /^#/
+               raise Fiddler::TicketNotFoundError, message
+            end
+            response
+         end
+
+         def self.ticket_from_response(response)
+            result = {}
+            response.each do |line|
+               matches = /^(.*?):\s(.*)/.match(line)
+               if(matches)
+                  key = matches[1].underscore
+                  result[key] = matches[2]
+               end
+            end
+            Fiddler::Ticket.new(result)
+         end
+
+         def self.tokenize_response(response)
+            tokens = Array.new
+            current = Array.new
+            response.each do |item|
+               if(item == "--")
+                  tokens << current
+                  current = Array.new
+                  next
+               end
+               current << item
+            end
+            tokens
          end
       end
    end

data/lib/fiddler/ticket.rb

@@ -1,16 +1,42 @@
 module Fiddler
    class Ticket
-      attr_accessor :id, :subject, :status, :queue, :owner, :creator, :histories, :content, :last_updated
 
+      DefaultAttributes = %w(queue owner creator subject status priority initial_priority final_priority requestors cc admin_cc created starts started due resolved told last_updated time_estimated time_worked time_left text).inject({}){|memo, k| memo[k] = nil; memo}
+      RequiredAttributes = %w(queue subject)
+
+      attr_reader :histories, :saved
+      
       # 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
+      def initialize(attributes={})
+         if attributes
+            @attributes = DefaultAttributes.merge(attributes)
+         else
+            @attributes = DefaultAttributes
+         end
+         @attributes.update(:id => 'ticket/new')
+         @saved = false
+         @histories = []  
+         @new_record = true
+         add_methods!
+      end
+
+      def add_methods!
+         @attributes.each do |key, value|
+            (class << self; self; end).send :define_method, key do
+               return @attributes[key]
+            end
+            (class << self; self; end).send :define_method, "#{key}=" do |new_val|
+               @attributes[key] = new_val
+            end
+         end
+      end
+
+      def description
+         @attributes.each do |key,value|
+            puts "#{key} = #{value}"
          end
-         @id = "ticket/new"
       end
 
       # Class methods
@@ -22,7 +48,17 @@ module Fiddler
          def get(id)
             url = "ticket/#{id}"
             response = Fiddler::ConnectionManager.get(url)
-            ticket = Fiddler::Parsers::TicketParser.parse(response)
+            ticket = Fiddler::Parsers::TicketParser.parse_single(response)
+         end
+
+         # Search the tickets with the given conditions
+         #
+         # @params [Hash] of conditions
+         # @returns [Array<Ticket>] of the tickets matching the criteria
+         def all(conditions={})
+            url = "search/ticket"
+            response = Fiddler::ConnectionManager.get(url,Fiddler::Formatters::SearchRequestFormatter.format(conditions))
+            ticket = Fiddler::Parsers::TicketParser.parse_multiple(response)
          end
 
          # Creates a new ticket with the given options, it will not save the ticket

data/lib/fiddler/version.rb

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

data/spec/configuration_spec.rb

@@ -3,8 +3,7 @@ require 'spec_helper'
 describe Fiddler::Configuration do
   describe 'when no options are given' do
     before do
-      Fiddler.configure do |config|
-      end
+      reset_config
     end
 
     it 'defaults to using no cookies' do

data/spec/connection_manager_spec.rb

@@ -1,22 +1,38 @@
 require 'spec_helper'
 
 describe Fiddler::ConnectionManager do
-   before do
-      reset_config
-   end
-   
    describe "without proper config" do
+      before do
+         reset_config
+      end
+
       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)
+         Fiddler.configuration.server_url = "https://some_server"
+         expect { Fiddler::ConnectionManager.get("/") }.to raise_error(Fiddler::InvalidConfigurationError)
+      end
+
+      it "should raise error for invalid server url" do
+         Fiddler.configuration.server_url = "https://some_server"
+         Fiddler.configuration.use_cookies = true
+         expect { Fiddler::ConnectionManager.get("/") }.to raise_error
+      end
+   end
+
+   describe "making request" do
+      before do
+         test_config
+      end
+
+      it "should not return nil response for get request" do
+         Fiddler::ConnectionManager.get("/").should_not be_nil
+      end
+
+      it "should not return nil response for post request" do
+         Fiddler::ConnectionManager.post("/").should_not be_nil
       end
    end
 end

data/spec/formatters/base_formatter_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Fiddler::Formatters::BaseFormatter do
+end

data/spec/formatters/search_request_formatter_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Fiddler::Formatters::SearchRequestFormatter do
+   it "should return a hash for the format" do
+      Fiddler::Formatters::SearchRequestFormatter.format( { :owner => "jais.cheema" }).should be_a_kind_of(Hash)
+   end
+
+   it "should return a query key in hash with the search options" do
+      search_hash = Fiddler::Formatters::SearchRequestFormatter.format( { :owner => "jais.cheema" })
+      search_hash.keys.should include("query")
+   end
+
+   it "should return a format key in hash with the long option" do
+      search_hash = Fiddler::Formatters::SearchRequestFormatter.format( { :owner => "jais.cheema" })
+      search_hash.keys.should include(:format)
+   end
+end 

data/spec/parsers/base_parser_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Fiddler::Parsers::BaseParser do
+   before do
+      test_config
+   end
+
+   it "should not raise error for valid request" do
+      response = Fiddler::ConnectionManager.get("/")
+      expect { Fiddler::Parsers::BaseParser.check_response_code(response) }.to_not raise_error
+   end
+
+   it "should return an array of lines after checking response" do
+      response = Fiddler::ConnectionManager.get("/")
+      Fiddler::Parsers::BaseParser.check_response_code(response).should be_a_kind_of(Array)
+   end
+
+   it "should strip the response line from return array" do
+      response = Fiddler::ConnectionManager.get("/")
+      response_array = response.split("\n").reject { |l| l.nil? or l == "" }
+
+      Fiddler::Parsers::BaseParser.check_response_code(response).length.should eql(response_array.length-1)
+   end
+end

data/spec/parsers/ticket_parser_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Fiddler::Parsers::TicketParser do
+   before do
+      test_config
+   end
+   
+   it "should return the response for proper request minus empty line" do
+      response = Fiddler::ConnectionManager.get("/ticket/4200")
+      response = Fiddler::Parsers::TicketParser.check_response_code(response)
+      desired_length = response.length
+      Fiddler::Parsers::TicketParser.check_for_errors(response).length.should eql(desired_length)
+   end
+
+   it "should raise TicketFetchError for invalid response" do
+      response = Fiddler::ConnectionManager.get("/ticket/asdsadasds")
+      response = Fiddler::Parsers::TicketParser.check_response_code(response)
+      expect { Fiddler::Parsers::TicketParser.check_for_errors(response) }.to raise_error
+   end
+
+   it "should give ticket object for parse single method" do
+      response = Fiddler::ConnectionManager.get("/ticket/4200")
+      Fiddler::Parsers::TicketParser.parse_single(response).should be_a_kind_of(Fiddler::Ticket)
+   end
+
+   it "should give array of ticket objects for parse multiple method" do
+      response = Fiddler::ConnectionManager.get("/search/ticket?query=Owner='jais.cheema'")
+      Fiddler::Parsers::TicketParser.parse_multiple(response).should be_a_kind_of(Array)
+   end
+end

data/spec/spec_helper.rb

@@ -1,13 +1,21 @@
+require 'rubygems'
+require 'spork'
+require 'rspec'
+
 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'
+Spork.prefork do
+   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
+   end
+end
+
+Spork.each_run do
 end
 
 # create a file named config.rb here with the two methods

data/spec/ticket_spec.rb

@@ -6,10 +6,16 @@ describe Fiddler::Ticket do
    end
    
    it "should find a ticket with given id" do
-      Fiddler::Ticket.get(4200).should_not be_nil
+      Fiddler::Ticket.get(4200).should be_a_kind_of(Fiddler::Ticket)
    end
 
    it "should raise exception for invalid id" do
       expect { Fiddler::Ticket.get(50000) }.to raise_error(Fiddler::TicketNotFoundError)
    end
+
+   describe "executing all method" do
+      it "should return all the user assigned tickets for empty conditions" do
+         Fiddler::Ticket.all.should be_a_kind_of(Array)
+      end
+   end
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: fiddler
 version: !ruby/object:Gem::Version 
-  prerelease: 5
-  version: 0.0.1alpha
+  prerelease: 
+  version: 0.0.1
 platform: ruby
 authors: 
   - Jais Cheema
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-03 00:00:00 Z
+date: 2012-10-04 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: httpclient
@@ -45,6 +45,28 @@ dependencies:
             version: "0"
     type: :development
     version_requirements: *id003
+  - !ruby/object:Gem::Dependency 
+    name: spork
+    prerelease: false
+    requirement: &id004 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id004
+  - !ruby/object:Gem::Dependency 
+    name: watchr
+    prerelease: false
+    requirement: &id005 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id005
 description: This is the interface to request tracker based on Roart Gem
 email: 
   - jaischeema@gmail.com
@@ -59,18 +81,24 @@ files:
   - lib/tasks/fiddler_tasks.rake
   - lib/fiddler/version.rb
   - lib/fiddler/errors.rb
+  - lib/fiddler/formatters.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
+  - lib/fiddler/formatters/search_request_formatter.rb
+  - lib/fiddler/formatters/base_formatter.rb
   - spec/spec_helper.rb
   - spec/ticket_spec.rb
   - spec/configuration_spec.rb
   - spec/config.rb
   - spec/connection_manager_spec.rb
+  - spec/formatters/search_request_formatter_spec.rb
+  - spec/formatters/base_formatter_spec.rb
+  - spec/parsers/base_parser_spec.rb
+  - spec/parsers/ticket_parser_spec.rb
   - Rakefile
   - README.md
 homepage: https://github.com/jaischeema/fiddler
@@ -90,9 +118,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.3.1
+        version: "0"
 requirements: []
 
 rubyforge_project: 
@@ -106,3 +134,7 @@ test_files:
   - spec/configuration_spec.rb
   - spec/config.rb
   - spec/connection_manager_spec.rb
+  - spec/formatters/search_request_formatter_spec.rb
+  - spec/formatters/base_formatter_spec.rb
+  - spec/parsers/base_parser_spec.rb
+  - spec/parsers/ticket_parser_spec.rb

data/lib/fiddler/helper.rb

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