pho 0.0.1 → 0.1

data/Rakefile

@@ -5,12 +5,12 @@ require 'rake/testtask'
 require 'rake/clean'
 
 NAME = "pho"
-VER = "0.0.1"
+VER = "0.1"
 
 RDOC_OPTS = ['--quiet', '--title', 'Pho (Talis Platform Client) Reference', '--main', 'README']
 
 PKG_FILES = %w( README Rakefile ) + 
-  Dir.glob("{bin,doc,tests,lib}/**/*")
+  Dir.glob("{bin,doc,tests,examples,lib}/**/*")
 
 CLEAN.include ['*.gem', 'pkg']  
 SPEC =

data/examples/contentbox.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'pho'
+
+# Create the store object
+store = Pho::Store.new("http://api.talis.com/stores/ldodds-dev1", "ldodds", "XXXXXXX")
+
+# Using StringIO object here, but could more usually provide a File object
+data = StringIO.new("Some data to store")
+
+puts "Uploading item..."
+resp = store.upload_item(data, "text/plain", "/items/test.txt")
+
+puts "Status code after storage is: #{resp.status}"
+
+puts "Retrieving data..."
+resp = store.get_item("http://api.talis.com/stores/ldodds-dev1/items/test.txt")
+
+puts "Status code after retrieval is #{resp.status}"
+# Should output "Some data to store"
+puts "Retrieved data is: #{resp.content}"
+
+puts "Deleting item..."
+resp = store.delete_item("/items/test.txt")
+
+puts "Status code after deletion is #{resp.status}"
+
+puts "Retrieving data..."
+resp = store.get_item("http://api.talis.com/stores/ldodds-dev1/items/test.txt")
+
+puts "Status code after deletion is: #{resp.status}"

data/examples/sparql.rb

@@ -0,0 +1,84 @@
+require 'rubygems'
+require 'json'
+require 'pho'
+
+# Use the demonstration store containing NASA space flight data
+store = Pho::Store.new("http://api.talis.com/stores/space")
+
+#Retrieve simple RDF description for this resource (Apollo 11 Launch) as RDF/XML
+puts "Describe Apollo 11 Launch"
+response = store.describe("http://purl.org/net/schemas/space/launch/1969-059")
+
+# Dump to console
+puts response.content
+
+# SPARQL Query 
+SPARQL = <<-EOL
+PREFIX space: <http://purl.org/net/schemas/space/>
+PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>
+
+
+DESCRIBE ?spacecraft WHERE {
+
+     ?launch space:launched "1969-07-16"^^xsd:date.
+
+  ?spacecraft space:launch ?launch.
+
+}
+
+EOL
+puts "Describe spacecraft launched on 16th July 1969"
+response = store.sparql_describe(SPARQL)
+puts response.content
+
+SPARQL_CONSTRUCT = <<-EOL
+
+PREFIX space: <http://purl.org/net/schemas/space/>
+PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>
+PREFIX foaf: <http://xmlns.com/foaf/0.1/>
+
+CONSTRUCT {
+  ?spacecraft foaf:name ?name;
+              space:agency ?agency;
+              space:mass ?mass.          
+}
+WHERE {
+  ?launch space:launched "1969-07-16"^^xsd:date.
+
+  ?spacecraft space:launch ?launch;
+              foaf:name ?name;
+              space:agency ?agency;
+              space:mass ?mass.          
+}
+
+EOL
+
+puts "Get name, agency and mass for spacecraft launched on 16th July 1969"
+response = store.sparql_construct(SPARQL_CONSTRUCT)
+puts response.content
+
+SPARQL_SELECT = <<-EOL
+PREFIX space: <http://purl.org/net/schemas/space/>
+PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>
+PREFIX foaf: <http://xmlns.com/foaf/0.1/>
+
+SELECT ?name
+WHERE {
+
+  ?launch space:launched "1969-07-16"^^xsd:date.
+
+  ?spacecraft space:launch ?launch;
+              foaf:name ?name.      
+}
+
+EOL
+
+puts "Get name of spacecraft launched on 16th July 1969, as JSON"
+response = store.sparql_construct(SPARQL_SELECT, "application/sparql-results+json")
+json = JSON.parse( response.content )
+
+json["results"]["bindings"].each do |b|
+ 
+  puts b["name"]["value"]
+  
+end

data/examples/status.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'pho'
+
+# Create the store object
+store = Pho::Store.new("http://api.talis.com/stores/space")
+# Retrieve the store status as a simple hash
+status = store.status
+# Dump the hash to the console
+puts status.inspect

data/lib/pho.rb

@@ -4,6 +4,7 @@ require 'json'
 
 require 'pho/etags'
 require 'pho/store'
+require 'pho/snapshot'
 require 'pho/rdf_collection'
 
 module Pho
@@ -16,6 +17,9 @@ module Pho
   JOB_RESET = "http://schemas.talis.com/2006/bigfoot/configuration#ResetDataJob".freeze
   JOB_SNAPSHOT = "http://schemas.talis.com/2006/bigfoot/configuration#SnapshotJob".freeze
   JOB_REINDEX = "http://schemas.talis.com/2006/bigfoot/configuration#ReindexJob".freeze   
+  JOB_RESTORE = "http://schemas.talis.com/2006/bigfoot/configuration#RestoreJob".freeze
      
 
+  NAMESPACE_CONFIG = "http://schemas.talis.com/2006/bigfoot/configuration#"
+  
 end

data/lib/pho/job.rb

@@ -0,0 +1,17 @@
+module Pho
+  
+  # Captures information about a Platform Job   
+  class Job
+  
+    
+    # Parse out an array of Job objects from a response returned from the Platform
+    def Job.parse_jobs(resp)
+      if resp.status != 200
+        throw
+      end
+      return nil
+    end
+      
+  end
+    
+end

data/lib/pho/rdf_collection.rb

@@ -28,6 +28,7 @@ module Pho
       files_to_store.each do |filename|
         file = File.new(filename)
         response = @store.store_file(file)
+        #TODO error checking
       end    
     end
 

data/lib/pho/snapshot.rb

@@ -0,0 +1,95 @@
+module Pho
+
+  require 'digest/md5'
+  
+  #In the Talis Platform a "snapshot" is an backup of the contents of a Store
+  #
+  #A snapshot consists of a tar file that contains all data (contentbox and metabox) 
+  #in the store. The snapshot also contains the store configuration but this is encrypted
+  #and not intended for reuse.
+  #
+  #A snapshot can be generated (or scheduled) using the Store.snapshot method.
+  # 
+  class Snapshot
+    
+    #The URL from which the snapshot can be retrieved
+    attr_reader :url
+    
+    #The URL from which the MD5 for the snapshot can be retrieved
+    attr_reader :md5_url
+
+    #Size of the snapshot
+    attr_reader :size
+    
+    #Units for Size, e.g. KB
+    attr_reader :units
+        
+    #Class method to parse the HTML response from API, e.g. as produced by the Store.get_snapshots method 
+    #and create a new Snapshot object. At the moment the Platform only supports single snapshot.
+    #
+    #If the response was an error, then an exception will be thrown
+    #
+    # resp:: HTTP response generated by the Store.get_snapshots method
+    def Snapshot.parse(resp)
+      if (resp.status > 200)
+        raise "Response was not successful. Status code was: #{resp.status}"
+      end
+      content = resp.content
+      
+      snapshot_url = content.match("<a href=\"(http://api.talis.com/stores/\.+/snapshots/\.+tar)\">\.+</a>")[1]
+      
+      metadata = Regexp.new("<a href=\"(http://api.talis.com/stores/\.+/snapshots/\.+tar\.md5)\">\.+</a>\n\s+\-\s+([0-9]+) ([a-zA-Z]+)", "m")
+      snapshot_md5_url = metadata.match(content)[1]
+      snapshot_size = metadata.match(content)[2]
+      snapshot_units = metadata.match(content)[3]
+      
+      return Snapshot.new(snapshot_url, snapshot_md5_url, snapshot_size, snapshot_units)
+      
+    end
+        
+    def initialize(url, md5_url, size, units)
+      @url = url
+      @md5_url = md5_url
+      @size = size
+      @units = units      
+    end   
+    
+
+    #Read the published MD5 value
+    def read_md5(client=HttpClient.new())
+      return client.get_content(@md5_url)
+    end    
+    
+    # Download this snapshot to the specified directory. Will automatically calculate an MD5 checksum for  
+    # the download and compare it against the published value. If they don't match then a RuntimeError will 
+    # be raised
+    #
+    # dir:: directory in which snapshot will be stored
+    # client:: specify a preconfigured client, e.g. to configure proxy servers, etc
+    def download(dir, client=HTTPClient.new())
+      
+      published_md5 = read_md5(client)
+      
+      digest = Digest::MD5.new()
+
+      filename = @url.split("/").last
+      file = File.open( File.join(dir, filename), "w" ) do |file|
+
+        #FIXME: this is not efficient as the snapshot may be very large and this
+        #will just read all of the data into memory
+        content = client.get_content(@url)
+        puts content
+        file.print(content)
+        digest << content
+        
+      end
+      
+      calc_md5 = digest.hexdigest
+      if (calc_md5 != published_md5)
+        raise "Calculated digest of #{calc_md5} but does not match published md5 #{published_md5}"
+      end
+    end
+        
+  end
+      
+end

data/lib/pho/store.rb

@@ -4,12 +4,19 @@ module Pho
 #
 # Changesets
 # Multisparql
-#  
+#
+# Listing jobs
+# Retrieving single job
+# FP Map
+# Query Profile
+# List snapshots
+# Get snapshot
+#
+#
 # Conditional deletions
 # If-Modified-Since support
 # Robustness in uri fetching
-#
-# RDOC
+
   
   # The Store class acts as a lightweight client interface to the Talis Platform API  
   # (http://n2.talis.com/wiki/Platform_API). The class provides methods for interacting 
@@ -25,7 +32,8 @@ module Pho
   #   store.reset
   #
   # == Examples
-  # 
+  #
+  # See the examples directory in the distribution 
   class Store
   
     #Retrieve the HTTPClient instance being used by this object
@@ -330,7 +338,7 @@ module Pho
     #############
     # JOBS
     #############
-  
+      
     # Construct an RDF/XML document containing a job request for submitting to the Platform.
     #
     # t:: a Time object, specifying the time at which the request should be carried out
@@ -362,6 +370,27 @@ module Pho
       return submit_job(JOB_SNAPSHOT, "Snapshot my store", t)
     end  
   
+    #Restore this store from a previously generated Snapshot
+    #The Platform can restore from any snapshot that is web-accessible
+    #
+    #snapshot_url:: the URL of the snapshot
+    def restore(snapshot_url, t=Time.now)
+      time = t.strftime("%Y-%m-%dT%H:%M:%SZ")
+      data = "<rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\" "
+      data << " xmlns:rdfs=\"http://www.w3.org/2000/01/rdf-schema#\" " 
+      data << " xmlns:bf=\"http://schemas.talis.com/2006/bigfoot/configuration#\"> " 
+      data << " <bf:JobRequest>"
+      data << "   <rdfs:label>Restore my store</rdfs:label>"    
+      data << "   <bf:jobType rdf:resource=\"#{Pho::JOB_RESTORE}\"/>"
+      data << "   <bf:snapshotUri rdf:resource=\"#{snapshot_url}\"/>"
+      data << "   <bf:startTime>#{time}</bf:startTime>"
+      data << " </bf:JobRequest>"
+      data << "</rdf:RDF>"
+      u = build_uri("/jobs")
+      response = @client.post(u, data, RDF_XML )
+      return response          
+    end    
+    
     def submit_job(joburi, label, t=Time.now)
         u = build_uri("/jobs")
         data = build_job_request(t, joburi, label)
@@ -383,7 +412,17 @@ module Pho
       state["accessMode"] = json[u.to_s]["http:\/\/schemas.talis.com\/2006\/bigfoot\/configuration#accessMode"][0]["value"]
       return state
     end
-                 
+   
+    # Retrieve the list of snapshots for this store
+    #
+    # Currently the response will contain an HTML document. Use Snapshot.parse to turn this into
+    # a Snapshot object
+    def get_snapshots()
+      u = build_uri("/snapshots")
+      response = @client.get(u, nil, nil)
+      return response      
+    end              
+    
   end
 
 end

data/tests/tc_jobcontrol.rb

@@ -55,5 +55,11 @@ class JobControlTest < Test::Unit::TestCase
     store = Pho::Store.new("http://api.talis.com/stores/testing", "user", "pass", mc)
     job_req = store.snapshot()
   end
-            
+  
+  def test_restore
+    mc = mock()
+    set_expectations("http://api.talis.com/stores/testing", mc, Pho::JOB_RESTORE, "Restore my store" )    
+    store = Pho::Store.new("http://api.talis.com/stores/testing", "user", "pass", mc)
+    job_req = store.restore("http://www.example.com.tar")        
+  end          
 end

data/tests/tc_snapshots.rb

@@ -0,0 +1,77 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'pho'
+require 'test/unit'
+require 'mocha'
+require 'tmpdir'
+
+class SnapshotsTest < Test::Unit::TestCase
+
+  def setup()
+      @snapshot = <<-EOL
+    <?xml version="1.0" encoding="UTF-8"?><html xmlns:bf="http://schemas.talis.com/2006/bigfoot/configuration#" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns="http://www.w3.org/1999/xhtml" xmlns:dc="http://purl.org/dc/elements/1.1/"><head><meta http-equiv="content-type" content="text/html; charset=utf-8"/><title>Snapshots</title><style type="text/css">
+    
+            </style></head><body><div id="wrap"><div id="content"><div class="gutter"><h1>Snapshots for this store</h1><ul class="xoxo"><li><span class="field-name"><a href="http://api.talis.com/stores/test-store/snapshots/20090222113727.tar">http://api.talis.com/stores/test-store/snapshots/20090222113727.tar</a>
+                            - <a href="http://api.talis.com/stores/test-store/snapshots/20090222113727.tar.md5">MD5</a>
+                            -  30 KB
+                            -  11:37 22-February-2009</span></li></ul></div><ul id="footer"><li id="learn"><a href="http://n2.talis.com/wiki/Platform_API">learn more</a></li></ul></div></div></body></html>      
+EOL
+        
+  end
+  
+  def teardown()
+    
+    f = File.join(Dir.tmpdir, "2009022213727.tar")
+    if File.exists?(f)
+#      File.delete(f)
+    end
+    
+  end
+
+  def test_get_snapshots()
+    mc = mock()
+    mc.expects(:set_auth)
+    mc.expects(:get).with("http://api.talis.com/stores/testing/snapshots", nil, nil)
+    
+    store = Pho::Store.new("http://api.talis.com/stores/testing", "user", "pass", mc)
+    response = store.get_snapshots()        
+  end  
+  
+  def test_parse_snapshots()
+    
+    mc = mock()
+    mc.expects(:status).returns(200)
+    mc.expects(:content).returns(@snapshot)
+    
+    snapshot = Pho::Snapshot.parse(mc)
+    
+    assert_equal(true, snapshot != nil)
+    assert_equal("http://api.talis.com/stores/test-store/snapshots/20090222113727.tar", snapshot.url)
+    assert_equal("http://api.talis.com/stores/test-store/snapshots/20090222113727.tar.md5", snapshot.md5_url)
+    assert_equal("30", snapshot.size)
+    assert_equal("KB", snapshot.units)
+  end
+  
+  def test_parse_snapshots_raises_exception()
+    
+    mc = mock()
+    mc.expects(:status).at_least_once.returns(500)
+    
+    assert_raise RuntimeError do
+      Pho::Snapshot.parse(mc)
    end
+        
+  end  
+  
+  def test_download()
+    
+    mc = mock()
+    mc.expects(:get_content).with("http://api.talis.com/stores/test-store/snapshots/20090222113727.tar.md5").returns("4880c0340c65d142838ea33ace9b850a")
+    mc.expects(:get_content).with("http://api.talis.com/stores/test-store/snapshots/20090222113727.tar").returns("12345abcdef")    
+    
+    snapshot = Pho::Snapshot.new("http://api.talis.com/stores/test-store/snapshots/20090222113727.tar", "http://api.talis.com/stores/test-store/snapshots/20090222113727.tar.md5", "1", "KB")
+   
+    snapshot.download(Dir.tmpdir, mc)
+        
+    assert_equal(true, File.exists?( File.join(Dir.tmpdir, "20090222113727.tar" ) ) )        
+  end
+  
+end

data/tests/ts_pho.rb

@@ -5,6 +5,7 @@ require 'tc_etags.rb'
 require 'tc_contentbox.rb'
 require 'tc_metabox.rb'
 require 'tc_jobcontrol.rb'
+require 'tc_snapshots.rb'
 require 'tc_search.rb'
 require 'tc_sparql.rb'
 require 'tc_rdf_collection.rb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pho
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: "0.1"
 platform: ruby
 authors: 
 - Leigh Dodds
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-21 00:00:00 +00:00
+date: 2009-02-23 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,14 +60,19 @@ files:
 - tests/tc_rdf_collection.rb
 - tests/ts_pho.rb
 - tests/tc_jobcontrol.rb
+- tests/tc_snapshots.rb
 - tests/tc_search.rb
 - tests/tc_etags.rb
-- lib/test.rb
+- examples/status.rb
+- examples/sparql.rb
+- examples/contentbox.rb
 - lib/pho.rb
 - lib/pho
 - lib/pho/etags.rb
 - lib/pho/rdf_collection.rb
 - lib/pho/store.rb
+- lib/pho/job.rb
+- lib/pho/snapshot.rb
 has_rdoc: true
 homepage: http://pho.rubyforge.net
 post_install_message: 

data/lib/test.rb

@@ -1,29 +0,0 @@
-require 'pho'
-
-store = Pho::Store.new("http://api.talis.local/stores/space", "ldodds", "gwpjmv7z")
-
-state = store.status()
-puts state.inspect
-
-resp = store.store_file("/home/ldodds/data/space/nssdc/n3/1969-059A.rdf")
-puts resp
-puts resp.status
-
-resp = store.store_file(File.new("/home/ldodds/data/space/nssdc/n3/1969-059B.rdf") )
-puts resp.status
-
-resp = store.store_url("http://api.talis.local/stores/space/meta?about=http://purl.org/net/schemas/space/spacecraft/1969-059A")
-puts resp.status
-
-resp = store.store_url( URI.parse("http://api.talis.local/stores/space/meta?about=http://purl.org/net/schemas/space/spacecraft/1969-059A") )
-puts resp.status
-
-resp = store.describe("http://purl.org/net/schemas/space/spacecraft/1969-059A")
-puts resp
-
-resp = store.describe("http://purl.org/net/schemas/space/spacecraft/1969-059A", "application/json")
-puts resp
-
-store.snapshot
-store.reindex
-store.reset