rodzilla 0.1.3 → 0.3.0

data/lib/rodzilla/resource/bugzilla.rb

@@ -3,19 +3,19 @@ module Rodzilla
     class Bugzilla < Base
 
       def version
-        rpc_call( rpc_method: 'version' )
+        rpc_call :version
       end
 
       def time
-        rpc_call( rpc_method: 'time' )
+        rpc_call :time
       end
 
       def timezone
-        rpc_call( rpc_method: 'timezone' )
+        rpc_call :timezone
       end
 
       def extensions
-        rpc_call( rpc_method: 'extensions' )
+        rpc_call :extensions
       end
 
     end

data/lib/rodzilla/resource/group.rb

@@ -0,0 +1,7 @@
+module Rodzilla
+  module Resource
+    class Group < Base
+
+    end
+  end
+end

data/lib/rodzilla/resource/product.rb

@@ -6,19 +6,19 @@ module Rodzilla
 
       # Returns a list of the ids of the products the user can search on.
       def get_selectable_products
-        rpc_call( rpc_method: "get_selectable_products" )
+        rpc_call :get_selectable_products
       end
 
       def get_enterable_products
-        rpc_call( rpc_method: "get_enterable_products" )
+        rpc_call :get_selectable_products
       end
 
       def get_accessible_products
-        rpc_call( rpc_method: "get_accessible_products" )
+        rpc_call :get_accessible_products
       end
 
       def get_products(params={})
-        rpc_call( params.merge( rpc_method: 'get' ) )
+        rpc_call :get, params
       end
     end
   end

data/lib/rodzilla/resource/user.rb

@@ -0,0 +1,7 @@
+module Rodzilla
+  module Resource
+    class User < Base
+
+    end
+  end
+end

data/lib/rodzilla/util.rb

@@ -0,0 +1,22 @@
+module Rodzilla
+  module Util
+
+    # Extracts the class name from a module string
+    # 
+    # example:
+    #  demodulize( Rodzilla::WebService::Error ) => 'Error'
+    # 
+    # returns the String path argument
+    def demodulize(path)
+      path = path.to_s
+      if i = path.rindex('::')
+        path[(i+2)..-1]
+      else
+        path
+      end
+    end
+
+    module_function :demodulize
+
+  end
+end

data/lib/rodzilla/version.rb

@@ -1,8 +1,8 @@
 module Rodzilla
   module VERSION
     MAJOR   = 0
-    MINOR   = 1
-    PATCH   = 3
+    MINOR   = 3
+    PATCH   = 0
 
     STRING = [MAJOR,MINOR,PATCH].join('.')
   end

data/lib/rodzilla/web_service.rb

@@ -0,0 +1,67 @@
+module Rodzilla
+  class WebService
+
+    attr_accessor :base_url, :format, :resource
+
+    # base_url - The String full uri of the Bugzilla api server
+    # username - The String containing the bugzilla authorized users username
+    # password - The String containing the bugzilla authorized users password
+    # format - The request/response format which defaults to :json
+    def initialize(base_url, username, password, format=:json)
+      @base_url     = base_url
+      @username     = username
+      @password     = password
+      @format       = format
+    end
+
+    # Provide a shortcut for instantiation Bug objects
+    #
+    # Returns an instance of the Rodzilla::Resource::Bug class
+    def bugs
+      bugzilla_resource('Bug')
+    end
+
+    # Provide a shortcut for instantiation Bugzilla objects
+    #
+    # Returns an instance of the Rodzilla::Resource::Bugzilla class
+    def bugzilla
+      bugzilla_resource('Bugzilla')
+    end
+
+    # Provide a shortcut for instantiation Classification objects
+    #
+    # Returns an instance of the Rodzilla::Resource::Classification class
+    def classifications
+      bugzilla_resource('Classification')
+    end
+
+    # Provide a shortcut for instantiation Group objects
+    #
+    # Returns an instance of the Rodzilla::Resource::Group class
+    def groups
+      bugzilla_resource('Group')
+    end
+
+    # Provide a shortcut for instantiation Product objects
+    #
+    # Returns an instance of the Rodzilla::Resource::Product class
+    def products
+      bugzilla_resource('Product')
+    end
+
+    # Provide a shortcut for instantiation User objects
+    #
+    # Returns an instance of the Rodzilla::Resource::User class
+    def users
+      bugzilla_resource('User')
+    end
+
+    def bugzilla_resource(resource)
+      raise Rodzilla::Error::ResourceNotFoundError, "Error: Rodzilla::Resource::#{resource} does not exist." unless Rodzilla::Resource.constants.include?(resource.to_sym)
+      @resource = Object.module_eval("Rodzilla::Resource::#{resource}").new(@base_url, @username, @password, @format)
+    end
+
+    protected :bugzilla_resource
+
+  end
+end

data/rodzilla.gemspec

@@ -22,11 +22,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "httparty"
-  spec.add_dependency "libxml-ruby"
-  spec.add_dependency "yajl-ruby"
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "debugger", "~> 1.6.2"
 end

data/test/fixtures/methods/Bugzilla_extensions.json

@@ -0,0 +1 @@
+{"error":null,"id":1,"result":{"extensions":{"AutoComplete":{"version":"0.1"}}}}

data/test/fixtures/methods/Bugzilla_version.json

@@ -0,0 +1 @@
+{"error":null,"id":1,"result":{"version":"4.4"}}

data/test/rodzilla/json_rpc/error_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+describe Rodzilla::JsonRpc::Error do
+
+  describe "Exceptions" do
+    it "it should have a InvalidResponseId" do
+      Rodzilla::JsonRpc::Error.constants.must_include(:InvalidResponseId)
+    end
+
+    it "it should have a UnsupportedHttpMethod" do
+      Rodzilla::JsonRpc::Error.constants.must_include(:UnsupportedHttpMethod)
+    end
+
+    it "it should have a ResponseError" do
+      Rodzilla::JsonRpc::Error.constants.must_include(:ResponseError)
+    end
+
+    it "it should have a ClientError which inherits from ResponseError" do
+      Rodzilla::JsonRpc::Error.constants.must_include(:ClientError)
+      Rodzilla::JsonRpc::Error::ClientError.superclass.must_equal(Rodzilla::JsonRpc::Error::ResponseError)
+    end
+
+    it "it should have a ServerError which inherits from ResponseError" do
+      Rodzilla::JsonRpc::Error.constants.must_include(:ServerError)
+      Rodzilla::JsonRpc::Error::ServerError.superclass.must_equal(Rodzilla::JsonRpc::Error::ResponseError)
+    end
+
+    it "it should have a HttpError" do
+      Rodzilla::JsonRpc::Error.constants.must_include(:HttpError)
+    end
+
+  end
+
+end

data/test/rodzilla/json_rpc/request_test.rb

@@ -0,0 +1,65 @@
+require "test_helper"
+
+describe Rodzilla::JsonRpc::Request do
+  before do
+    @request = Rodzilla::JsonRpc::Request.new
+    def new_breq(&block)
+      Rodzilla::JsonRpc::Request.new(&block)
+    end
+  end
+
+  it "should yield itself if a block is given on initialize" do
+      r = new_breq { |req| req.id = 15 }
+      r.id.must_equal(15)
+  end
+
+  it "should have a method get_request_object" do
+      @request.must_respond_to(:get_request_object)
+  end
+
+  it "get_request_object should return a hash with id, method, and params" do
+    r = new_breq do |req|
+      req.id = 5
+      req.method = 'Test'
+      req.params = { name: 'nada' }
+    end
+    
+    obj = r.get_request_object
+    obj.must_be_kind_of(Hash)
+
+    obj.keys.must_include(:id)
+    obj.keys.must_include(:method)
+    obj.keys.must_include(:params)
+
+    obj[:params].must_be_kind_of(Array)
+
+  end
+
+  it "serialize should a valid JSON String" do
+    r = new_breq { |req| req.id = 5; req.method = "Hello" }
+    r.serialize.must_be_kind_of(String)
+  end
+
+  describe "attributes" do
+    it "should have methods 'method' and 'method='" do
+      @request.must_respond_to(:method)
+      @request.must_respond_to(:method=)
+    end
+
+    it "should have methods params and params=" do
+      @request.must_respond_to(:params)
+      @request.must_respond_to(:params=)
+    end
+
+    it "should have methods id and id=" do
+      @request.must_respond_to(:id)
+      @request.must_respond_to(:id=)
+    end
+
+    it "should have methods headers and headers=" do
+      @request.must_respond_to(:headers)
+      @request.must_respond_to(:headers=)
+    end
+  end
+
+end

data/test/rodzilla/json_rpc/response_test.rb

@@ -0,0 +1,42 @@
+require "test_helper"
+
+describe Rodzilla::JsonRpc::Response do
+  
+  before do
+    def new_response; Rodzilla::JsonRpc::Response.new; end
+    @response = Rodzilla::JsonRpc::Response.new
+  end
+
+  it "error should always be nil after initialization" do
+      new_response.error.must_be_nil
+  end
+
+  describe "read_http_response" do
+    it "should respond_to read_http_response" do
+       @response.must_respond_to(:read_http_response)
+    end
+
+    it "should raise an ArgumentError when no args" do
+      lambda {
+        @response.read_http_response
+      }.must_raise(ArgumentError)
+    end
+  end
+
+  describe "accessors" do
+    it "should have method id & id=" do
+      @response.must_respond_to(:id)
+      @response.must_respond_to(:id=)
+    end
+
+    it "should have methods error & error=" do
+      @response.must_respond_to(:error)
+      @response.must_respond_to(:error=)
+    end
+
+    it "should have methods result & result=" do
+      @response.must_respond_to(:result)
+      @response.must_respond_to(:result=)
+    end
+  end
+end

data/test/rodzilla/json_rpc/service_test.rb

@@ -0,0 +1,110 @@
+require 'test_helper'
+
+describe Rodzilla::JsonRpc::Service do
+  before do
+    def new_service;  Rodzilla::JsonRpc::Service.new('http://bugzilla.test.com/jsonrpc.cgi', 'user', 'passwd'); end
+    @service = Rodzilla::JsonRpc::Service.new('http://bugzilla.test.com/jsonrpc.cgi', 'user', 'passwd')
+    stub_bugzilla_request('Bugzilla.version')
+    @version_body = method_fixture('Bugzilla_version.json').read
+  end
+
+  it "must include HTTParty" do
+    @service.class.ancestors.must_include(HTTParty)
+  end
+
+  it "must set Bugzilla_login and Bugzilla_password on initialize" do
+    s = new_service
+    s.instance_variable_get(:@credentials).wont_be_nil
+    s.credentials.must_equal({ Bugzilla_login: "user", Bugzilla_password: "passwd" })
+  end
+
+  it "execute_request_and_response should return the Response#result" do
+    s = Rodzilla::JsonRpc::Service.new('http://bugzilla.test.com/jsonrpc.cgi', 'user', 'passwd')
+    res = s.execute_request_and_response(:post)
+    res.must_be_kind_of(Hash)
+    res.must_equal(s.rpc_response.result)
+  end
+
+  describe "cycle_id checks" do
+    
+    it "generate_cycle_id should return 1" do
+      @service.send(:generate_cycle_id).must_equal(1)
+    end
+
+    it "check_cycle_id should return false if request.id is not equal to response.id" do
+      s = new_service
+      s.send(:setup_request)
+      s.rpc_request.id = 5
+      s.rpc_response = Rodzilla::JsonRpc::Response.new
+      s.rpc_response.id = 4
+      s.send(:check_cycle_id).must_equal(false)
+    end
+
+    it "check_cycle_id should return true if request.id and response.id are equal" do
+      s = new_service
+      s.send(:setup_request)
+      s.rpc_request.id = 3
+      s.rpc_response = Rodzilla::JsonRpc::Response.new
+      s.rpc_response.id = 3
+      s.send(:check_cycle_id).must_equal(true)
+    end
+  end
+
+
+  describe "send_request!" do
+    it "should raise an ArgumentError when no rpc_method is supplied" do
+      lambda { @service.send_request! }.must_raise(ArgumentError)
+    end
+
+    it "should raise a UnsupportedHttpMethod error when a http_method besides GET or POST is used" do
+      lambda {
+        @service.send_request!('Bugzilla.version', {}, :put)
+      }.must_raise(Rodzilla::JsonRpc::Error::UnsupportedHttpMethod)
+    end
+
+    it "should return a JSON Hash for a successfull API call" do
+      @service.send_request!('Bugzilla.version').must_be_kind_of(Hash)
+    end
+  end
+
+  describe "setup request" do
+
+    it "should instantiate the request object" do
+      s = new_service
+      s.rpc_request = nil
+      s.send(:setup_request)
+      s.rpc_request.must_be_kind_of(Rodzilla::JsonRpc::Request)
+    end
+
+    it "should set the json-rpc header on request.headers object" do
+      s = new_service
+      s.rpc_request = nil
+      s.send(:setup_request)
+      s.rpc_request.headers.must_equal({ 'Content-Type' => 'application/json-rpc' })
+    end
+
+  end
+
+  describe "setup_request_data" do
+
+    it "should raise an ArgumentError when no rcp_method is supplied" do
+      lambda { @service.send(:setup_request_data) }.must_raise(ArgumentError)
+    end
+
+    it "should always include the credentials in the params" do
+      new_method = 'Bugzilla.version'
+      new_params = { ids: [1,2,3] }
+
+      orig_creds = @service.credentials.dup
+
+      @service.send(:setup_request_data, new_method, new_params )
+
+      
+      @service.rpc_request.method.must_equal(new_method)
+
+      @service.rpc_request.params[:Bugzilla_login].wont_be_nil
+      @service.rpc_request.params[:Bugzilla_password].wont_be_nil
+    end
+  end
+
+end