trek-patrest 0.0.2

data/README.markdown

@@ -0,0 +1,46 @@
+# PatREST client for Ruby
+Client library for the [Ann Arbor District Library](http://www.aadl.org)'s [PatREST API](http://www.blyberg.net/downloads/patrest_1.3_overview.pdf).
+
+## Installing
+
+### Setup
+Start by setting your library API's base url. For AADL, it's 'http://www.aadl.org/rest/'
+
+    require 'patrest'
+    include PatRest
+    PatRest::OPTIONS = {'BASE_URI' => http://www.aadl.org/rest/}
+    
+### Finding Records
+You can find a specific record by it's id
+
+    Record.find(1250150).inspect
+    # =>  #<PatRest::Record:0x111fc28 @attributes={"xmlns:p"=>"http://www.aadl.org", "bibnum"=>"1250150", "pubinfo"=>"New York : Little, Brown and Co., 2005", "isbn"=>"0316160172", "recordlink"=>"http://www.aadl.org/cat/seek/record=1250150", "callnum"=>"Teen Fiction", "copies"=>"61", "xmlns:xlink"=>"http://www.w3.org/1999/xlink", "title"=>"Twilight", "price"=>"$17.99", "holds"=>"80", "author"=>"Meyer, Stephenie, 1973-", "catdate"=>"10-03-2005", "avail"=>"7 copies available at Malletts Adult, Traverwood Adult and West Adult", "series"=>"Twilight saga ; 1", "subject"=>["Vampires -- Fiction", "High schools -- Fiction", "Washington (State) -- Fiction"], "desc"=>"498 p", "summary"=>"When seventeen-year-old Bella leaves Phoenix to live with her father in Forks, Washington, she meets an exquisitely handsome boy at school for whom she feels an overwhelming attraction and who she comes to realize is not wholly human", "lang"=>"eng", "ccimglink"=>"http://www.aadl.org/cat/ccimg/1250150", "edition"=>"1st ed", "mattype"=>"a", "fulltitle"=>"Twilight / a novel by Stephenie Meyer", "coverimglink"=>"http://syndetics.com/hw7.pl?isbn=0316160172+A/SC.gif"}>
+    
+### Data access
+Access data with dot notation for attributes
+
+    record = Record.find(1250150)
+    record.title
+    #=> "Twilight"
+    record.subject
+    #=> ["Vampires -- Fiction", "High schools -- Fiction", "Washington (State) -- Fiction"]
+
+### Search
+You can perform any of the PatREST search types
+
+    search = Search.new(:title, 'twilight')
+    search.execute
+    search.first
+    # => <PatRest::Record:0x10a65a8 @attributes={"bibnum"=>"1286255", "recordlink"=>"http://www.aadl.org/cat/seek/record=1286255", "xlink:href"=>"http://www.aadl.org/rest/record/1286255/", "title"=>"Rapunzel, the one with all the hair", "xmlrecordlink"=>"http://www.aadl.org/rest/record/1286255/", "author"=>nil, "id"=>"1286255", "xlink:title"=>"Rapunzel, the one with all the hair / Wendy Mass", "fulltitle"=>"Rapunzel, the one with all the hair / Wendy Mass"}>
+    
+### Patron-specific data
+Patron data access requires the patron's token.
+
+    patron = Patron.new('1234567abcedef')
+    patron.holds
+    # => [#<PatRest::Record:0x1088530 @attributes=["Holds", {"xmlns:p"=>"http://www.aadl.org", "xmlns:xlink"=>"http://www.w3.org/1999/xlink", "Record"=>{"bibnum"=>"1067614", "isbn"=>"$48.00", "recordlink"=>"http://www.aadl.org/cat/seek/record=1067614", "xlink:href"=>"http://www.aadl.org/rest/record/1067614/", "title"=>"Envisioning information", "xmlrecordlink"=>"http://www.aadl.org/rest/record/1067614/", "author"=>"Tufte, Edward R., 1942-", "id"=>"1067614", "xlink:title"=>"Envisioning information / Edward R. Tufte", "imglink"=>"http://syndetics.com/hw7.pl?isbn=$48.00+A/SC.gif", "pickuploc"=>"Downtown Library", "canceldate"=>"2010-04-12", "fulltitle"=>"Envisioning information / Edward R. Tufte", "holdstatus"=>"2 of 4 holds"}}]>]
+    patron.items.first
+    # => #<PatRest::Record:0x1040a00 @attributes={"bibnum"=>"1277702", "recordlink"=>"http://www.aadl.org/cat/seek/record=1277702", "xlink:href"=>"http://www.aadl.org/rest/record/1277702/", "title"=>"Make [periodical]: technology on your time", "xmlrecordlink"=>"http://www.aadl.org/rest/record/1277702/", "author"=>nil, "id"=>"1277702", "xlink:title"=>"Make [periodical]: technology on your time", "duedate"=>"2009-05-02", "fulltitle"=>"Make [periodical]: technology on your time"}>
+    
+    
+    

data/lib/patrest.rb

@@ -0,0 +1,20 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'httparty'
+require 'uri'
+require 'patrest/patron'
+require 'patrest/record'
+require 'patrest/search'
+
+module PatRest
+  OPTIONS = {'BASE_URI' => ''}
+  class RecordNotFound < StandardError
+  end
+  
+  class InvalidSearchType < StandardError
+  end
+  
+  class InvalidPatronToken < StandardError
+  end
+end

data/lib/patrest/patron.rb

@@ -0,0 +1,30 @@
+module PatRest
+  class Patron
+    include HTTParty
+    format :xml
+    base_uri 'http://www.aadl.org/rest/'
+    
+    attr_reader :token
+    
+    def initialize(token)
+      @token = token
+    end
+    
+    def items
+      @items ||= parse_single_or_many_records(Patron.get("/checkouts/#{token}")['Checkouts'])
+    end
+    
+    def holds
+      @holds ||= parse_single_or_many_records(Patron.get("/holds/#{token}")['Holds'])
+    end
+    
+    private
+      def parse_single_or_many_records(query_result)
+        unless query_result['Record'].is_a? Array
+           [PatRest::Record.new(query_result['Record'])]
+        else
+          query_result['Record'].collect {|attrs| PatRest::Record.new(attrs) }
+        end
+      end
+  end
+end

data/lib/patrest/record.rb

@@ -0,0 +1,27 @@
+module PatRest
+  class Record
+    include HTTParty
+    format :xml
+    base_uri 'http://www.aadl.org/rest/record'
+    
+    attr_accessor :attributes
+    def self.find(record_number)
+      attrs = get("/#{record_number}")
+      raise PatRest::RecordNotFound if attrs['Record']['error']
+      self.new(attrs['Record'])
+    end
+    
+    def self.search(type, string, options = {:per_page => 10, :page => 1})
+      
+    end
+    
+    def initialize(attrs)
+      self.attributes = attrs
+    end
+    
+    def method_missing(method)
+      method = method.to_s
+      attributes.has_key?(method) ? attributes[method] : raise(NoMethodError)
+    end
+  end
+end

data/lib/patrest/search.rb

@@ -0,0 +1,56 @@
+module PatRest
+  class Search
+    FACETS = %w(title author callnum keyword subject gvtdocnum stdnum titlekey controlnum barcode record bibnum itemnum)
+    include HTTParty
+    format :xml
+    base_uri 'http://www.aadl.org/rest/search'
+    
+    attr_accessor :type, :query, :per_page, :current_page, :results
+    
+    def initialize(type, query, options = {:per_page => 10, :page => 1})
+      raise InvalidSearchType unless Search::FACETS.include?(type.to_s)
+      self.type     = type
+      self.query    = query
+      self.per_page = options[:per_page]
+      self.current_page = options[:page]
+    end
+    
+    def escaped_query
+      URI.escape(self.query)
+    end
+    
+    def execute
+      results = Search.get("/#{type}/#{escaped_query}/#{per_page}/#{current_page}")
+      @results  = results['SearchResult']['Records']['Record'].collect {|attrs| PatRest::Record.new(attrs)}
+      self
+    end
+    
+    def next
+      self.current_page += 1
+      self.execute
+    end
+    
+    def previous
+      self.current_page -= 1
+      self.current_page = 0 if self.current_page < 0 # cannot go into negative search results
+      self.execute
+    end
+    
+    def results
+      @results || []
+    end
+    
+    def method_missing(method, *args)
+      unless self.results.respond_to?(method)
+        message = "undefined method `#{method.to_s}' for \"#{@self}\":#{@self.class.to_s}"
+        raise NoMethodError, message
+      end
+
+      if block_given?
+        self.results.send(method, *args)  { |*block_args| yield(*block_args) }
+      else
+        self.results.send(method, *args)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: trek-patrest
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Trek Glowacki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-26 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.3
+    version: 
+description: patrest is a Ruby library for talking to libraries using the Ann Arbor District Library\'s PatREST API.'
+email: trek.glowacki@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- lib/patrest.rb
+- lib/patrest/patron.rb
+- lib/patrest/record.rb
+- lib/patrest/search.rb
+has_rdoc: false
+homepage: http://github.com/trek/patrest-ruby
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: patrest is a Ruby library for talking to libraries using the Ann Arbor District Library\'s PatREST API.'
+test_files: []
+