koha 0.0.2 → 0.0.3

data/README.md

@@ -32,7 +32,7 @@ Here a quick irb walk-through...
 
 Make a Connection...  
 
-  > 1.9.3-p286 :002 > k = Koha.connect({:url => "http://my.library.se/cgi-bin/koha/rest.pl"} )  
+  > 1.9.3-p286 :002 > k = Koha.connect(:url => "http://my.library.se/cgi-bin/koha/rest.pl" )  
   > => #<Koha::Client:0x007fbcec9b6fd0 @uri=#<URI::HTTP:0x007fbcec9c3a00 URL:http://my.library.se/cgi-bin/koha/rest.pl/>, @proxy=nil, @connection=#<Koha::Connection:0x007fbcec9b6ff8>, @options={:url=>"http://my.library.se/cgi-bin/koha/rest.pl"}>  
 
 now get branch information...  
@@ -69,6 +69,11 @@ or get the user's issues
 
 
 
+## TODO
+
+Change to Farady? Worried about other libraries that some people cannot use?
+More tests. 
+
 ### Development
 
 Checkout the code. rake will run the tests. rake coverage will generate coverage. rake yard will generate documentation. 

data/lib/koha.rb

@@ -4,17 +4,18 @@ require 'rubygems'
 
 module Koha
   
-  %W(Client Error Connection Uri Version).each{|n| autoload n.to_sym, "koha/#{n.downcase}"}
+  require 'koha/version'
   
-  def self.version; "0.0.2" end
+  %W(Client Error Connection Uri ).each{|n| autoload n.to_sym, "koha/#{n.downcase}"}
+  %W(Info User Biblio ).each { |n| autoload n.to_sym, "koha/api_methods/#{n.downcase}"}
   
-  VERSION = self.version
+  class << self
+    def version; VERSION end
   
-  def self.connect *args
-    driver = Class === args[0] ? args[0] : Koha::Connection
-    opts = Hash === args[-1] ? args[-1] : {}
-    Client.new driver.new, opts
+    def connect *args
+      opts = Hash === args[-1] ? args[-1] : {}
+      Client.new  Koha::Connection.new, opts
+    end
   end
   
-  
 end

data/lib/koha/api_methods/biblio.rb

@@ -0,0 +1,60 @@
+module Koha::Biblio   
+  ### Biblio and Item Methods ###
+  
+  # This method will get the biblio record from koha given the biblionumber
+  def find_biblio biblionumber, opts = {}
+      biblionumber = biblionumber.to_s
+      JSON.parse(get "biblio/#{biblionumber}", opts)
+  end
+  
+  # This method will get the item records from koha given the biblionumber
+   def find_biblio_items biblionumber, opts = {}
+       biblionumber = biblionumber.to_s
+       JSON.parse(get "biblio/#{biblionumber}/items", opts)
+   end
+  
+  
+  # wrapper to check if a biblio is holdable
+  # take a koha biblio number and standard client opts
+  def biblio_holdable?(biblionumber, opts = {})
+    is_holdable?(:biblio, biblionumber, opts )
+  end
+  
+  # makes a hold on the title.
+  # takes a koha biblionumber and the client opts, which should include either a borrowernumber or user_name param.
+  # returns a hash of the pickup location and hold date.
+  def hold_biblio(biblionumber, opts = {})
+    JSON.parse(post  "biblio/#{biblionumber}/hold", opts )
+  end
+  
+  # wrapper to check a biblio items holdabale statues. 
+  # takes a koha bilionumber and standard client opts
+  # this returns just a hash of the items and their status, no need to evaulate.
+  def biblio_items_holdable?(biblionumber, opts = {} )
+    opts ||= {} 
+    opts[:holdable] = "items_holdable_status"
+    opts[:evaluate] ||= false
+    is_holdable?(:biblio, biblionumber, opts)
+  end
+  
+  # wrapper to check is an item is holdable
+  def item_holdable?(itemnumber, opts = {})
+    is_holdable?(:item, itemnumber, opts)
+  end
+  
+  # makes a hold on the title.
+  # takes a koha biblionumber and the client opts, which should include either a borrowernumber or user_name param.
+  # returns a hash of the pickup location and hold date.
+  def hold_item(itemnumber, opts = {})
+    JSON.parse( post  "item/#{itemnumber}/hold", opts )
+  end
+  
+  def is_holdable?(koha_type, identifier, opts = {} )
+    opts ||= {}
+    opts[:evaluate] = :is_holdable unless opts[:evaluate] == false
+    holdable = opts[:holdable] ? opts[:holdable] : "holdable" 
+    koha_type = koha_type.to_s == "item" ? "item" : "biblio"
+    identifier = identifier.to_s
+    get "#{koha_type}/#{identifier}/#{holdable}", opts
+  end
+end

data/lib/koha/api_methods/info.rb

@@ -0,0 +1,13 @@
+module Koha::Info
+  
+
+   ### Info Methods ###
+
+   # returns a hash of [ { :code => "1", :name => "Our Branch Name "}]
+   def branches opts= {}
+      JSON.parse(get "branches", opts)
+   end
+  
+  
+  
+end

data/lib/koha/api_methods/user.rb

@@ -0,0 +1,54 @@
+module Koha::User
+  ### USER Methods ###
+  
+  # get all the users
+  # @param opts [Hash] standard opts hash to pass to http client
+  def all_users opts= {}
+    JSON.parse(get "user/all", opts )
+  end
+  
+  # get all today's users
+  # @param opts [Hash] standard opts hash to pass to http client
+  def today_users opts= {}
+    JSON.parse(get "user/today", opts)
+  end
+  
+  # get all today's users
+  # @param opts [Hash] standard opts hash to pass to http client
+  def user_holds opts= {}
+    path, opts = build_user_path("holds", opts)
+    JSON.parse(get path, opts)
+  end
+  
+  def delete_hold opts= {}
+    opts[:evaluate] ||= "canceled"
+    opts[:prefix] = opts[:biblionumber] ? "biblio" : "item" #delete end-point is like :/user/byid/544/holds/biblio/1
+    path, opts = build_user_path("holds", opts)
+    return  delete(path, opts)
+  end
+    
+  def user_issues opts= {}
+    path, opts = build_user_path("issues", opts)
+    JSON.parse(get path, opts)
+  end
+  
+  def renew_issue opts={}
+    path, opts = build_user_path("issues", opts)
+    JSON.parse(put path, opts)
+  end
+  
+  private 
+  
+  def build_user_path koha_method, opts= {}
+    raise ArgumentError unless (  opts[:borrowernumber] or opts[:borrowername] ) #we have to be passed either a name or number
+    borrowernumber, borrowername = opts.delete(:borrowernumber), opts.delete(:borrowername)
+    biblionumber, itemnumber = opts.delete(:biblionumber), opts.delete(:itemnumber)
+    prefix = opts.delete(:prefix)
+    path = borrowernumber ? "user/byid/#{borrowernumber}/#{koha_method}/" : "user/#{borrowername}/#{koha_method}/" 
+    path << prefix if prefix 
+    path << "/#{itemnumber}/" if itemnumber
+    path << "/#{biblionumber}/" if ( biblionumber && itemnumber.nil?) 
+    return  path, opts
+  end
+  
+end

data/lib/koha/client.rb

@@ -2,6 +2,10 @@ require 'json'
 
 class Koha::Client
   
+  include Koha::Info
+  include Koha::User
+  include Koha::Biblio
+  
   attr_reader :connection, :uri, :proxy, :options
   
   def initialize connection, options = {}
@@ -9,11 +13,9 @@ class Koha::Client
     @connection = connection
     unless false === options[:url]
       url = options[:url] ? options[:url].dup : 'http://localhost/cgi-bin/koha/rest.pl/'
-      url << "/" unless url[-1] == ?/
       @uri = Koha::Uri.create url
       if options[:proxy]
         proxy_url = options[:proxy].dup
-        proxy_url << "/" unless proxy_url.nil? or proxy_url[-1] == ?/
         @proxy = Koha::Uri.create proxy_url if proxy_url
       end
     end
@@ -30,51 +32,31 @@ class Koha::Client
   %W(get post put delete).each do |meth|
      class_eval <<-RUBY
      def #{meth} path, opts = {}, &block
-       send_and_receive path, opts.merge(:method => :#{meth}), &block
+       send_request path, opts.merge(:method => :#{meth}), &block
      end
      RUBY
    end
  
   
-  # +send_and_receive+ is the main request method responsible for sending requests to the +connection+ object.
-  # 
-  # "path" : A string value that directs the client to the API REST method
-  # "opts" : A hash, which can contain the following keys:
-  #   :method : optional - the http method (:get, :post or :put)
-  #   :params : optional - the query string params in hash form
-  # All other options are passed right along to the connection's +send_and_receive+ method (:get, :post, or :put)
-  # 
-  #
-  # creates a request context hash,
-  # sends it to the connection's +execute+ method
-  # which returns a simple hash,
-  # then passes the request/response into +adapt_response+.
-  def send_and_receive path, opts
+  #  the main request method responsible for sending requests.
+  #  @param path [String]  the client's API REST method
+  #  @param opts [Hash] A hash which can contain the following keys: 
+  #       [:method] : optional - the http method (:get, :post or :put)
+  #       [:params] : optional - the query string params in hash form
+  #       All other options are passed to the execute method      
+  def send_request path, opts
     request_context = build_request path, opts
     [:open_timeout, :read_timeout].each do |k|
       request_context[k] = @options[k]
     end
-    execute request_context
-  end
-  
-  # send a request to the connection to be submitted
-  def execute request_context
-    raw_response = connection.execute self, request_context
-    adapt_response(request_context, raw_response) unless raw_response.nil?
+    request request_context
   end
-  
-  # +build_request+ accepts a path and options hash,
-  # then prepares a normalized hash to return for sending
-  # +build_request+ sets up the uri/query string
-  # and converts the +data+ arg to form-urlencoded,
-  # returns a hash with the following keys:
-  #   :method
-  #   :params
-  #   :data
-  #   :uri
-  #   :path
-  #   :query
-  
+   
+
+  # Sets up the uri/query string
+  #  @param path [String, Symbol]  the request path
+  #  @param opts [Hash] The options for the REST call. Can include:  
+  #     :method, :params, :data, :uri, :path, :query
   def build_request path, opts
     raise "path must be a string or symbol, not #{path.inspect}" unless [String,Symbol].include?(path.class)
     path = path.to_s
@@ -91,14 +73,7 @@ class Koha::Client
       opts[:data][:user_name] = opts[:borrowername] if opts[:borrowername]
     end
     query = Koha::Uri.to_params(opts[:params]) unless opts[:params].empty?
-    opts[:query] = query
-    
-    if opts[:data].is_a? Hash
-      opts[:data] = Koha::Uri.to_params opts[:data]
-      opts[:headers] ||= {}
-      opts[:headers]['Content-Type'] ||= 'application/x-www-form-urlencoded; charset=UTF-8'
-    end
-    
+    opts[:query] = query    
     opts[:path] = path
     if base_uri
       opts[:uri] = URI.join(base_uri, path.to_s)
@@ -106,151 +81,31 @@ class Koha::Client
     end
     opts
   end
-  
-  
-  #  A mixin for used by #adapt_response
-   module Context
+   
+  #  A simple mixin for process_response.
+   module Response
      attr_accessor :request, :response
    end
 
-   # This method will evaluate the :body value
-   # if the request has an :evaulte value, the response is send to
-   # the evaluate_json_response, which returns just the node. 
-   # this is a convience to simply return "false" or "true" and not a bunch of stupid
-   # json that has nothing that makes any god-damn sense. 
-   # ... otherwise, the json is simply returned.
-   def adapt_response request, response
+   # Recieves the request and response from the connection and format it. Returns an object with the response body and @request and @response.
+   def process_response request, response
      raise "The response does not have the correct keys => :body, :headers, :status" unless
        %W(body headers status) == response.keys.map{|k|k.to_s}.sort
      raise Koha::Error::Http.new request, response unless [200,302].include? response[:status]
      result = request[:evaluate] ? evaluate_json_response( response, request[:evaluate]) : response[:body]
-     result.extend Context
+     result.extend Response
      result.request, result.response = request, response
      result
    end
-  
-  
-  
-  ##### KOHA REST API METHODS #######
-  
-  ### Info Methods ###
-  
-  # returns a hash of [ { :code => "1", :name => "Our Branch Name "}]
-  def branches opts= {}
-     JSON.parse(get "branches", opts)
-  end
-  
-  
-  ### USER Methods ###
-  
-  # returns a hash of all the users
-  def all_users opts= {}
-    JSON.parse(get "user/all", opts )
-  end
-  
-  # returns a hash of patrons enrolled today
-  def today_users opts= {}
-    JSON.parse(get "user/today", opts)
-  end
-  
-  
-  def user_holds opts= {}
-    path, opts = build_user_path("holds", opts)
-    JSON.parse(get path, opts)
-  end
-  
-  def delete_hold opts= {}
-    opts[:evaluate] ||= "canceled"
-    opts[:prefix] = opts[:biblionumber] ? "biblio" : "item" #delete end-point is like :/user/byid/544/holds/biblio/1
-    path, opts = build_user_path("holds", opts)
-    return  delete(path, opts)
-  end
-    
-  def user_issues opts= {}
-    path, opts = build_user_path("issues", opts)
-    JSON.parse(get path, opts)
-  end
-  
-  def renew_issue opts={}
-    path, opts = build_user_path("issues", opts)
-    JSON.parse(put path, opts)
-  end
-  
-  
-  def build_user_path koha_method, opts= {}
-    raise ArgumentError unless (  opts[:borrowernumber] or opts[:borrowername] ) #we have to be passed either a name or number
-    borrowernumber, borrowername = opts.delete(:borrowernumber), opts.delete(:borrowername)
-    biblionumber, itemnumber = opts.delete(:biblionumber), opts.delete(:itemnumber)
-    prefix = opts.delete(:prefix)
-    path = borrowernumber ? "user/byid/#{borrowernumber}/#{koha_method}/" : "user/#{borrowername}/#{koha_method}/" 
-    path << prefix if prefix 
-    path << "/#{itemnumber}/" if itemnumber
-    path << "/#{biblionumber}/" if ( biblionumber && itemnumber.nil?) 
-    return  path, opts
-  end
-    
-      
-  ### Biblio and Item Methods ###
-  
-  # This method will get the biblio record from koha given the biblionumber
-  def find_biblio biblionumber, opts = {}
-      biblionumber = biblionumber.to_s
-      JSON.parse(get "biblio/#{biblionumber}", opts)
-  end
-  
-  # This method will get the item records from koha given the biblionumber
-   def find_biblio_items biblionumber, opts = {}
-       biblionumber = biblionumber.to_s
-       JSON.parse(get "biblio/#{biblionumber}/items", opts)
-   end
-  
-  
-  # wrapper to check if a biblio is holdable
-  # take a koha biblio number and standard client opts
-  def biblio_holdable?(biblionumber, opts = {})
-    is_holdable?(:biblio, biblionumber, opts )
-  end
-  
-  # makes a hold on the title.
-  # takes a koha biblionumber and the client opts, which should include either a borrowernumber or user_name param.
-  # returns a hash of the pickup location and hold date.
-  def hold_biblio(biblionumber, opts = {})
-    JSON.parse(post  "biblio/#{biblionumber}/hold", opts )
-  end
-  
-  # wrapper to check a biblio items holdabale statues. 
-  # takes a koha bilionumber and standard client opts
-  # this returns just a hash of the items and their status, no need to evaulate.
-  def biblio_items_holdable?(biblionumber, opts = {} )
-    opts ||= {} 
-    opts[:holdable] = "items_holdable_status"
-    opts[:evaluate] ||= false
-    is_holdable?(:biblio, biblionumber, opts)
-  end
-  
-  # wrapper to check is an item is holdable
-  def item_holdable?(itemnumber, opts = {})
-    is_holdable?(:item, itemnumber, opts)
-  end
-  
-  # makes a hold on the title.
-  # takes a koha biblionumber and the client opts, which should include either a borrowernumber or user_name param.
-  # returns a hash of the pickup location and hold date.
-  def hold_item(itemnumber, opts = {})
-    JSON.parse( post  "item/#{itemnumber}/hold", opts )
-  end
-  
-  def is_holdable?(koha_type, identifier, opts = {} )
-    opts ||= {}
-    opts[:evaluate] = :is_holdable unless opts[:evaluate] == false
-    holdable = opts[:holdable] ? opts[:holdable] : "holdable" 
-    koha_type = koha_type.to_s == "item" ? "item" : "biblio"
-    identifier = identifier.to_s
-    get "#{koha_type}/#{identifier}/#{holdable}", opts
-  end
-    
-    
+     
   protected
+  # process the request to the connection to be submitted
+  #  @param request_context [Hash]  A hash created by the build_request method 
+  def request request_context
+   raw_response = connection.request request_context
+   process_response(request_context, raw_response) unless raw_response.nil?
+  end
+
 
   # this is used to retrun a ruby primitive based on a json node. For example holdable returns { "is_holdable" : true, "reasons" : [] }
   # and we just want true. 

data/lib/koha/connection.rb

@@ -1,32 +1,24 @@
 require 'net/http'
 require 'net/https'
 
-
-# taken from RSOLR's http client
 class Koha::Connection
 
-  def execute client, request_context
-    h = http request_context[:uri], request_context[:proxy], request_context[:read_timeout], request_context[:open_timeout]
-    request = setup_raw_request request_context
+  def request request_context
+    hclient = http_client request_context[:uri], request_context[:proxy], request_context[:read_timeout], request_context[:open_timeout]
+    request = request_setup request_context
     request.body = request_context[:data] if request_context[:method] == :post and request_context[:data]
     begin
-      response = h.request request
+      response = hclient.request request
       charset = response.type_params["charset"]
-      {:status => response.code.to_i, :headers => response.to_hash, :body => force_charset(response.body, charset)}
+      {:status => response.code.to_i, :headers => response.to_hash, :body => response.body}
     rescue Errno::ECONNREFUSED => e
       raise(Errno::ECONNREFUSED.new(request_context.inspect))
-    # catch the undefined closed? exception -- this is a confirmed ruby bug
-    rescue NoMethodError
-      $!.message == "undefined method `closed?' for nil:NilClass" ?
-        raise(Errno::ECONNREFUSED.new) :
-        raise($!)
     end
   end
 
   protected
-
-  # This returns a singleton of a Net::HTTP or Net::HTTP.Proxy request object.
-  def http uri, proxy = nil, read_timeout = nil, open_timeout = nil
+  # This returns a singleton of a Net::HTTP or Net::HTTP.Proxy 
+  def http_client uri, proxy = nil, read_timeout = nil, open_timeout = nil
     @http ||= (
       http = if proxy
         proxy_user, proxy_pass = proxy.userinfo.split(/:/) if proxy.userinfo
@@ -41,8 +33,8 @@ class Koha::Connection
     )
   end
 
-  #
-   def setup_raw_request request_context
+  # takes the hash and sets up the basic params. 
+   def request_setup request_context
      http_method = case request_context[:method]
      when :get
        Net::HTTP::Get
@@ -56,17 +48,10 @@ class Koha::Connection
        raise "Only :get, :post and :delete http method types are allowed."
      end
      headers = request_context[:headers] || {}
-     raw_request = http_method.new request_context[:uri].request_uri
-     raw_request.initialize_http_header headers
-     raw_request.basic_auth(request_context[:uri].user, request_context[:uri].password) if request_context[:uri].user && request_context[:uri].password
-     raw_request
+     setup = http_method.new request_context[:uri].request_uri
+     setup.initialize_http_header headers
+     setup.basic_auth(request_context[:uri].user, request_context[:uri].password) if request_context[:uri].user && request_context[:uri].password
+     setup
    end
 
-  private
-
-  def force_charset body, charset
-    return body unless charset and body.respond_to?(:force_encoding)
-    body.force_encoding(charset)
-  end
-
 end

data/lib/koha/error.rb

@@ -25,10 +25,7 @@ module Koha::Error
   class Http < RuntimeError
     
     include KohaContext
-    # ripped right from ActionPack
-    # Defines the standard HTTP status codes, by integer, with their
-    # corresponding default message texts.
-    # Source: http://www.iana.org/assignments/http-status-codes
+    # stolen from ActionPack
     STATUS_CODES = {
       100 => "Continue",
       101 => "Switching Protocols",

data/lib/koha/uri.rb

@@ -1,21 +1,24 @@
 require 'uri'
 
 module Koha::Uri
+  extend self
+  
   
   def create url
     ::URI.parse url[-1] == ?/ ? url : "#{url}/"
   end
   
-  # Returns a query string param pair as a string.
-  # Both key and value are escaped.
+  # takes a key and value and returns it as a query string
+  # @param k [String] 
+  # @param v [String]
+  # @param escape [Boolean]
   def build_param(k,v, escape = true)
     escape ? 
       "#{escape_query_value(k)}=#{escape_query_value(v)}" :
       "#{k}=#{v}"
   end
 
-  # Return the bytesize of String; uses String#size under Ruby 1.8 and
-  # String#bytesize under 1.9.
+  # issue with ruby 1.8, which uses String#size. ruby 1.9 uses String#bytesize.
   if ''.respond_to?(:bytesize)
     def bytesize(string)
       string.bytesize
@@ -27,10 +30,6 @@ module Koha::Uri
   end
 
   # Creates a ILSDI based query string.
-    # Keys that have arrays values are set multiple times:
-    #   params_to_solr(:service => 'foo', :biblionumbers => ['1', '2'])
-    # is converted to:
-    #   ?service=foo&biblinumbers=1+2
     def to_params(params, escape = true)
       mapped = params.map do |k, v|
         next if v.to_s.empty?
@@ -45,8 +44,6 @@ module Koha::Uri
 
 
   # Performs URI escaping so that you can construct proper
-  # query strings faster.  Use this rather than the cgi.rb
-  # version since it's faster.
   # (Stolen from Rack).
   def escape_query_value(s)
     s.to_s.gsub(/([^ a-zA-Z0-9_.-]+)/u) {
@@ -54,6 +51,5 @@ module Koha::Uri
     }.tr(' ', '+')
   end
   
-  extend self
   
 end

data/lib/koha/version.rb

@@ -1,6 +1,6 @@
 module Koha
-
-  VERSION =  "0.0.1"
-  
-  
+  VERSION =  "0.0.3"  
+  CHANGELOG =<<-END
+    IMPORTANT CHANGES LATELY:
+  END
 end

data/spec/api/client_spec.rb

@@ -18,30 +18,30 @@ describe "Koha::Client" do
     
   end
   
-  context "send_and_receive" do
+  context "request" do
     include ClientHelper
     it "should forward these method calls the #connection object" do
       [:get, :post, :put].each do |meth|
-        client.connection.should_receive(:execute).
+        client.connection.should_receive(:request).
             and_return({:status => 200, :body => "{}", :headers => {}})
-        client.send_and_receive '', :method => meth, :params => {}, :data => nil, :headers => {}
+        client.send_request '', :method => meth, :params => {}, :data => nil, :headers => {}
       end
     end
 
     it "should be timeout aware" do
       [:get, :post, :put].each do |meth|
-        client.connection.should_receive(:execute).with(client, hash_including(:read_timeout => 42, :open_timeout=>43))
-        client.send_and_receive '', :method => meth, :params => {}, :data => nil, :headers => {}
+        client.connection.should_receive(:request).with( hash_including(:read_timeout => 42, :open_timeout=>43))
+        client.send_request '', :method => meth, :params => {}, :data => nil, :headers => {}
       end
     end
   end
 
   context "post" do
     include ClientHelper
-    it "should pass the expected params to the connection's #execute method" do
+    it "should pass the expected params to the connection's #request method" do
       request_opts = {:data => "the data", :method=>:post, :headers => {"Content-Type" => "text/plain"}}
-      client.connection.should_receive(:execute).
-        with(client, hash_including(request_opts)).
+      client.connection.should_receive(:request).
+        with(hash_including(request_opts)).
         and_return(
           :body => "",
           :status => 200,
@@ -53,7 +53,7 @@ describe "Koha::Client" do
   
  
   
-  context "adapt_response" do
+  context "process_respons" do
     include ClientHelper
   
     
@@ -108,35 +108,35 @@ describe "Koha::Client" do
       end
       
       it "should call the user holds method for #user_holds" do
-        stub_request(:get, "http://localhost/koha/user/byid/1/holds").to_return(:status => 200, :body => 
+        stub_request(:get, "http://localhost/koha/user/byid/1/holds/").to_return(:status => 200, :body => 
 "[{\"itemnumber\":null,\"branchname\":\"World Maritime University Library\",\"itemcallnumber\":null,\"hold_id\":null,\"reservedate\":\"2013-02-20\",\"barcode\":null,\"found\":null,\"biblionumber\":\"76356\",\"cancellationdate\":null,\"title\":\"Asian approaches to international law and the legacy of colonialism and imperialism :\",\"rank\":\"1\",\"branchcode\":\"WMU\"}]"         )
         client.user_holds(:borrowernumber => "1")
-        WebMock.should have_requested(:get, "http://localhost/koha/user/byid/1/holds")
+        WebMock.should have_requested(:get, "http://localhost/koha/user/byid/1/holds/")
       end
     
     
      it "should call the user issues method for #user_issues" do
-        stub_request(:get, "http://localhost/koha/user/cf/issues").to_return(:status => 200, :body => 
+        stub_request(:get, "http://localhost/koha/user/cf/issues/").to_return(:status => 200, :body => 
 "[{\"itemnumber\":\"42414\",\"itemcallnumber\":\"KD1819 .H54 2003\",\"barcode\":\"022593\",\"date_due\":\"2013-03-11T23:59:00\",\"renewable\":true,\"issuedate\":\"2012-11-21T00:00:00\",\"biblionumber\":\"17454\",\"title\":\"Maritime law\",\"borrowernumber\":\"544\",\"branchcode\":\"WMU\"}]"         )
         client.user_issues(:borrowername => "cf")
-        WebMock.should have_requested(:get, "http://localhost/koha/user/cf/issues")
+        WebMock.should have_requested(:get, "http://localhost/koha/user/cf/issues/")
       end
     
     
       # biblio and items
       
       it "should call the biblio items method for #find_biblio" do
-          stub_request(:get, "http://localhost/koha/biblio/1/items").to_return(:status => 200, :body => 
+          stub_request(:get, "http://localhost/koha/biblio/1").to_return(:status => 200, :body => 
 "[{\"withdrawn\":\"0\",\"biblioitemnumber\":\"1\",\"restricted\":null,\"wthdrawn\":\"0\",\"holdingbranchname\":\"World Maritime University Library\",\"notforloan\":\"0\",\"replacementpricedate\":\"2010-02-05\",\"itemnumber\":\"1\",\"ccode\":null,\"itemnotes\":null,\"location\":\"GEN\",\"itemcallnumber\":\"HD30.3 .A32 1989\",\"stack\":null,\"date_due\":\"\",\"barcode\":\"011376\",\"itemlost\":\"0\",\"uri\":null,\"materials\":null,\"datelastseen\":\"2010-02-05\",\"price\":null,\"issues\":null,\"homebranch\":\"WMU\",\"replacementprice\":null,\"more_subfields_xml\":null,\"cn_source\":\"lcc\",\"homebranchname\":\"World Maritime University Library\",\"booksellerid\":null,\"biblionumber\":\"1\",\"renewals\":null,\"holdingbranch\":\"WMU\",\"timestamp\":\"2012-11-28 07:47:23\",\"damaged\":\"0\",\"stocknumber\":null,\"cn_sort\":\"HD_00030_3_A32_1989\",\"reserves\":null,\"dateaccessioned\":\"2010-02-05\",\"datelastborrowed\":null,\"enumchron\":null,\"copynumber\":\"1\",\"permanent_location\":null,\"onloan\":null,\"paidfor\":null,\"itype\":\"BOOK\"}]" ) 
           client.find_biblio("1")
-          WebMock.should have_requested(:get, "http://localhost/koha/biblio/1/items")
+          WebMock.should have_requested(:get, "http://localhost/koha/biblio/1")
       end
     
     
      it "should call the biblio items method for #find_biblio" do
           stub_request(:get, "http://localhost/koha/biblio/1/items").to_return(:status => 200, :body => 
 "[{\"withdrawn\":\"0\",\"biblioitemnumber\":\"1\",\"restricted\":null,\"wthdrawn\":\"0\",\"holdingbranchname\":\"World Maritime University Library\",\"notforloan\":\"0\",\"replacementpricedate\":\"2010-02-05\",\"itemnumber\":\"1\",\"ccode\":null,\"itemnotes\":null,\"location\":\"GEN\",\"itemcallnumber\":\"HD30.3 .A32 1989\",\"stack\":null,\"date_due\":\"\",\"barcode\":\"011376\",\"itemlost\":\"0\",\"uri\":null,\"materials\":null,\"datelastseen\":\"2010-02-05\",\"price\":null,\"issues\":null,\"homebranch\":\"WMU\",\"replacementprice\":null,\"more_subfields_xml\":null,\"cn_source\":\"lcc\",\"homebranchname\":\"World Maritime University Library\",\"booksellerid\":null,\"biblionumber\":\"1\",\"renewals\":null,\"holdingbranch\":\"WMU\",\"timestamp\":\"2012-11-28 07:47:23\",\"damaged\":\"0\",\"stocknumber\":null,\"cn_sort\":\"HD_00030_3_A32_1989\",\"reserves\":null,\"dateaccessioned\":\"2010-02-05\",\"datelastborrowed\":null,\"enumchron\":null,\"copynumber\":\"1\",\"permanent_location\":null,\"onloan\":null,\"paidfor\":null,\"itype\":\"BOOK\"}]" ) 
-          client.find_biblio("1")
+          client.find_biblio_items("1")
           WebMock.should have_requested(:get, "http://localhost/koha/biblio/1/items")
       end
     

data/spec/api/connection_spec.rb

@@ -3,7 +3,7 @@ require 'base64'
 
 describe "Koha::Connection" do
   
-  context "setup_raw_request" do
+  context "request_setup" do
     
     before(:each) do 
       @c = Koha::Connection.new
@@ -12,15 +12,15 @@ describe "Koha::Connection" do
     end
        
     it "should set up a get request" do
-      req = @c.send :setup_raw_request, {:headers => {"content-type" => "application/json"}, :method => :get, :uri => URI.parse(@base_url + "/biblio/1/items?borrowername=cf")}
+      req = @c.send :request_setup, {:headers => {"content-type" => "application/json"}, :method => :get, :uri => URI.parse(@base_url + "/biblio/1/items?borrowername=cf")}
       headers = {}
-      req.each_header{|k,v| headers[k] = v}
+      req.each_header { |k,v| headers[k] = v }
       req.method.should == "GET"
       headers.should == {"content-type"=>"application/json"}
     end
     
      it "should set up a post request" do
-        req = @c.send :setup_raw_request, {:headers => {"content-type" => "application/json"}, :method => :post, :uri => URI.parse(@base_url + "/biblio/1/items?borrowername=cf")}
+        req = @c.send :request_setup, {:headers => {"content-type" => "application/json"}, :method => :post, :uri => URI.parse(@base_url + "/biblio/1/items?borrowername=cf")}
         headers = {}
         req.each_header{|k,v| headers[k] = v}
         req.method.should == "POST"
@@ -28,7 +28,7 @@ describe "Koha::Connection" do
     end
     
      it "should set up a post request" do
-        req = @c.send :setup_raw_request, {:headers => {"content-type" => "application/json"}, :method => :put, :uri => URI.parse(@base_url + "/biblio/1/items?borrowername=cf")}
+        req = @c.send :request_setup, {:headers => {"content-type" => "application/json"}, :method => :put, :uri => URI.parse(@base_url + "/biblio/1/items?borrowername=cf")}
         headers = {}
         req.each_header{|k,v| headers[k] = v}
         req.method.should == "PUT"
@@ -36,7 +36,8 @@ describe "Koha::Connection" do
     end
     
      it "should raise error if something weird is set as method" do
-        expect { @c.send :setup_raw_request, {:headers => {"content-type" => "application/json"}, :method => :head, :uri => URI.parse(@base_url + "/biblio/1/items?borrowername=cf")} }.to raise_error("Only :get, :post and :head http method types are allowed.")
+        expect { @c.send :request_setup, {:headers => {"content-type" => "application/json"}, :method => :head, :uri => URI.parse(@base_url + "/biblio/1/items?borrowername=cf")} } 
+        .to raise_error("Only :get, :post and :delete http method types are allowed.")
        
     end
     
@@ -55,12 +56,12 @@ describe "Koha::Connection" do
 
     it "should configure Net:HTTP read_timeout" do
       http.should_receive(:read_timeout=).with(42)
-      subject.execute client, {:uri => URI.parse("http://localhost/some_uri"), :method => :get, :read_timeout => 42}
+      subject.request :uri => URI.parse("http://localhost/some_uri"), :method => :get, :read_timeout => 42
     end
 
     it "should use Net:HTTP default read_timeout if not specified" do
       http.should_not_receive(:read_timeout=)
-      subject.execute client, {:uri => URI.parse("http://localhost/some_uri"), :method => :get}
+      subject.request  :uri => URI.parse("http://localhost/some_uri"), :method => :get
     end
   end
 
@@ -77,12 +78,12 @@ describe "Koha::Connection" do
 
     it "should configure Net:HTTP open_timeout" do
       http.should_receive(:open_timeout=).with(42)
-      subject.execute client, {:uri => URI.parse("http://localhost/some_uri"), :method => :get, :open_timeout => 42}
+      subject.request  :uri => URI.parse("http://localhost/some_uri"), :method => :get, :open_timeout => 42
     end
 
     it "should use Net:HTTP default open_timeout if not specified" do
       http.should_not_receive(:open_timeout=)
-      subject.execute client, {:uri => URI.parse("http://localhost/some_uri"), :method => :get}
+      subject.request  :uri => URI.parse("http://localhost/some_uri"), :method => :get
     end
   end
 
@@ -102,7 +103,7 @@ describe "Koha::Connection" do
     it "should configure Net:HTTP open_timeout" do
       http.should_receive(:request).and_raise(Errno::ECONNREFUSED)
       lambda {
-        subject.execute client, request_context
+        subject.request request_context
       }.should raise_error(Errno::ECONNREFUSED, /#{request_context}/)
     end
     
@@ -110,18 +111,10 @@ describe "Koha::Connection" do
      it "should raise NoMethodError if a non-method is called" do
         http.should_receive(:request).and_raise(NoMethodError)
         lambda {
-          subject.execute client, request_context
+          subject.request  request_context
         }.should raise_error(NoMethodError, /NoMethodError/)
       end
       
-      it "should raise NoMethodError if a non-method is called" do
-          error = NoMethodError.new("undefined method `closed?' for nil:NilClass")
-          http.should_receive(:request).and_raise(error) 
-          lambda {
-            subject.execute client, request_context
-          }.should raise_error(Errno::ECONNREFUSED)
-        end
-    
   end
   
   describe "basic auth support" do
@@ -136,7 +129,7 @@ describe "Koha::Connection" do
         request.fetch('authorization').should == "Basic #{Base64.encode64("joe:pass")}".strip
         mock(Net::HTTPResponse).as_null_object
       end
-      Koha::Connection.new.execute nil, :uri => URI.parse("http://joe:pass@localhost/koha/rest.pl"), :method => :get
+      Koha::Connection.new.request :uri => URI.parse("http://joe:pass@localhost/koha/rest.pl"), :method => :get
     end
   end
   
@@ -145,7 +138,7 @@ describe "Koha::Connection" do
       @mock_proxy = mock('Proxy')
       @mock_proxy.should_receive(:new).with("localhost", 80).and_return( mock(Net::HTTP).as_null_object)  
       Net::HTTP.should_receive(:Proxy).with("proxy", 80, nil, nil).and_return(@mock_proxy)
-      Koha::Connection.new.execute nil, :uri => URI.parse("http://localhost/koha/rest.pl"),  :method => :get, :proxy =>  URI.parse("http://proxy/pass.pl")
+      Koha::Connection.new.request :uri => URI.parse("http://localhost/koha/rest.pl"),  :method => :get, :proxy =>  URI.parse("http://proxy/pass.pl")
     end
   end
   

data/spec/spec_helper.rb

@@ -1,4 +1,6 @@
 require File.expand_path('../../lib/koha', __FILE__)
+#require File.expand_path('../../lib/koha/lib', __FILE__)
+
 require 'webmock/rspec'
 if ENV["COVERAGE"] == 'yes'
   require 'simplecov'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: koha
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-19 00:00:00.000000000 Z
+date: 2013-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -139,6 +139,9 @@ files:
 - Rakefile
 - koha.gemspec
 - lib/koha.rb
+- lib/koha/api_methods/biblio.rb
+- lib/koha/api_methods/info.rb
+- lib/koha/api_methods/user.rb
 - lib/koha/client.rb
 - lib/koha/connection.rb
 - lib/koha/error.rb
@@ -164,7 +167,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1777528153601572521
+      hash: -1026450662887779631
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -173,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1777528153601572521
+      hash: -1026450662887779631
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25